Merge pull request #947 from SteffoSpieler/fix/stream-elements-replay

fix: Stream Elements replay event not working

Author: hlxid

services/nodecg-io-streamelements/extension/StreamElements.ts

@@ -6,6 +6,7 @@ import {
     StreamElementsFollowEvent,
     StreamElementsHostEvent,
     StreamElementsRaidEvent,
+    StreamElementsReplayEvent,
     StreamElementsSubBombEvent,
     StreamElementsSubscriberEvent,
     StreamElementsTestCheerEvent,
@@ -188,6 +189,20 @@ export class StreamElementsServiceClient extends EventEmitter {
                 handler(data);
             }
         });
+
+        this.socket.on("event:update", (data: StreamElementsReplayEvent) => {
+            // event:update is all replays of previous real events.
+            // Because the structure is similar to the test events and just the keys in the root element
+            // are named differently we rename those to align with the naming in the test events
+            // and handle it as a test event from here on.
+            if (data) {
+                handler({
+                    event: data.data,
+                    listener: data.name,
+                    provider: data.provider,
+                } as unknown as StreamElementsTestEvent);
+            }
+        });
     }
 
     public onSubscriber(handler: (data: StreamElementsSubscriberEvent) => void, includeSubGifts = true): void {

services/nodecg-io-streamelements/extension/StreamElementsEvent.ts

@@ -1,3 +1,5 @@
+import { ObjectMap } from "nodecg-io-core";
+
 interface StreamElementsBaseEvent<TType, TData> {
     /**
      * StreamElements hexadecimal Event ID
@@ -158,7 +160,7 @@ interface StreamElementsBaseTestEvent<TListener, TEvent> {
     /**
      * Event provider
      */
-    provider: "twitch" | "youtube" | "facebook";
+    provider?: "twitch" | "youtube" | "facebook";
     listener: TListener;
     event: TEvent & StreamElementsTestDataBase;
 }
@@ -285,3 +287,15 @@ export type StreamElementsTestEvent =
     | StreamElementsTestRaidEvent
     | StreamElementsTestSubscriberEvent
     | StreamElementsTestTipEvent;
+
+/**
+ * When replaying real events the structure is similar to the test events
+ * except for the keys in the root object.
+ * This is a replay event general for all types.
+ * The data structure and name follows the same schema as the test events.
+ */
+export interface StreamElementsReplayEvent {
+    provider?: "twitch" | "youtube" | "facebook";
+    name: string;
+    data: ObjectMap<string | number>;
+}