senza-sdk 4.3.2-f445d5d.0 → 4.3.3-13bd44c.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.3.2-f445d5d.0",
+    "version": "4.3.3-13bd44c.0",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",
@@ -14,10 +14,13 @@
         "prepublishOnly": "npm run build:interface",
         "eslint": "eslint --max-warnings 0  src test",
         "build": "npm run build:interface && npm run build:implementation",
+        "prebuild:interface": "npm run version:output",
         "build:interface": "npx webpack --config interface.webpack.config.js",
+        "prebuild:implementation": "npm run version:output",
         "build:implementation": "npx webpack --config implementation.webpack.config.js",
         "test": "jest --coverage --verbose",
-        "testall": "npm run test && npm run eslint --fix"
+        "testall": "npm run test && npm run eslint --fix",
+        "version:output": "echo 'export const version = \"'$npm_package_version'\";' > src/interface/version.js"
     },
     "devDependencies": {
         "@babel/cli": "^7.13.16",

package/src/api.js

@@ -1,8 +1,8 @@
 import { sdkLogger, noop } from "./interface/utils.js";
-import pack from "../package.json";
+
 import { Lifecycle, RemotePlayer, DeviceManager, PlatformManager, AlarmManager, MessageManager, ShakaPlayer, shaka, showSequence, initSequence } from "./interface/api.js";
 
-const { version } = pack;
+import { version } from "./interface/version.js";
 
 typeof document !== "undefined" && document.addEventListener("keydown", (event) => {
     sdkLogger.log(`Got ${event.key} key`);

package/src/implementation/alarmManager.js

@@ -1,7 +1,7 @@
-import { AlarmManager as AlarmManagerInterface } from "../interface/alarmManager";
-import { getFCID, sdkLogger } from "./utils";
-import { EventListenersManager } from "./eventListenersManager";
-import { lifecycle } from "./lifecycle";
+import { AlarmManager as AlarmManagerInterface } from "../interface/alarmManager.js";
+import { getFCID, sdkLogger } from "./utils.js";
+import { EventListenersManager } from "./eventListenersManager.js";
+import { lifecycle } from "./lifecycle.js";
 
 class AlarmManager extends AlarmManagerInterface {
     constructor() {
@@ -16,6 +16,28 @@ class AlarmManager extends AlarmManagerInterface {
             timeoutMs: 15000 // Default timeout of 15 seconds, can be overridden by _setDefaultTimeout
         });
 
+        /**
+         * @type {boolean}
+         * @private
+         */
+        this._isInitialized = false;
+    }
+
+    /**
+     * @private
+     */
+    _init() {
+        sdkLogger.log("Initializing AlarmManager");
+        if (!this._isInitialized) {
+            this._isInitialized = true;
+            this._addSenzaEventListeners();
+        }
+    }
+
+    /**
+     * @private Add event listeners for system events
+     */
+    _addSenzaEventListeners() {
         typeof document !== "undefined" && document.addEventListener("hs/alarmFiredEvent", async (e) => {
 
             if (e.detail?.alarmName) {
@@ -73,6 +95,7 @@ class AlarmManager extends AlarmManagerInterface {
             }
         }
         );
+        sdkLogger.log("[AlarmManager] Added event listeners for system events");
     }
 
     /**

package/src/implementation/api.js

@@ -2,7 +2,17 @@ import { getFCID, sdkLogger, getVersion } from "./utils.js";
 import { sessionInfo } from "./SessionInfo.js";
 import { lifecycle } from "./lifecycle.js";
 import { alarmManager } from "./alarmManager.js";
+import { remotePlayer } from "./remotePlayer.js";
+import { deviceManager } from "./deviceManager.js";
+import { messageManager } from "./messageManager.js";
 
+export { remotePlayer };
+export { lifecycle } from "./lifecycle.js";
+export { deviceManager };
+export { platformManager } from "./platformManager.js";
+export { alarmManager };
+export { messageManager };
+export { SenzaShakaPlayer as ShakaPlayer, shaka } from "./senzaShakaPlayer.js";
 let authToken;
 
 const API_VERSION = "1.0";
@@ -24,8 +34,6 @@ export const auth = {
 
 };
 
-import { remotePlayer } from "./remotePlayer.js";
-export { remotePlayer };
 
 /** Should be called once to init the library
  *@example
@@ -123,6 +131,11 @@ export async function init(interfaceApiVersion, showSequenceFunc, initSequenceFu
         // Initialize lifecycle first to make sure the state is updated.
         await lifecycle._init(sessionInfoObj?.settings?.["ui-streamer"], triggerEvent);
         await remotePlayer._init(sessionInfoObj?.settings?.["ui-streamer"], triggerEvent);
+        alarmManager._init();
+        deviceManager._init();
+        messageManager._init();
+        sdkLogger.log("All submodules initialized");
+
 
         const devSequence = sessionInfoObj?.settings?.["ui-streamer"]?.devSequence;
         if (devSequence) {
@@ -255,13 +268,6 @@ export function uiReady() {
     }
 }
 
-export { lifecycle } from "./lifecycle.js";
-export { deviceManager } from "./deviceManager.js";
-export { platformManager } from "./platformManager.js";
-export { alarmManager };
-export { messageManager } from "./messageManager.js";
-export { SenzaShakaPlayer as ShakaPlayer, shaka } from "./senzaShakaPlayer.js";
-
 import "./devHelper.js";
 
 /**

package/src/implementation/devHelper.js

@@ -1,5 +1,5 @@
-import { lifecycle, remotePlayer } from "./api";
-import { sdkLogger } from "./utils";
+import { lifecycle, remotePlayer } from "./api.js";
+import { sdkLogger } from "./utils.js";
 
 const timeout = 500;
 let timerId;

package/src/implementation/deviceManager.js

@@ -43,7 +43,28 @@ class DeviceManager extends DeviceManagerInterface {
         wifiInfo.quality = 0;
         wifiInfo.ssid = "unknown";
         wifiInfo.bssid = "unknown";
+        /**
+         * @type {boolean}
+         * @private
+         */
+        this._isInitialized = false;
+    }
 
+    /**
+     * @private
+     */
+    _init() {
+        sdkLogger.log("Initializing DeviceManager");
+        if (!this._isInitialized) {
+            this._isInitialized = true;
+            this._addSenzaEventListeners();
+        }
+    }
+
+    /**
+     * @private Add event listeners for system events
+     */
+    _addSenzaEventListeners() {
         typeof document !== "undefined" && document.addEventListener("wifiSignalReport", (e) => {
             wifiInfo.level = e.detail.level;
             wifiInfo.quality = e.detail.quality;
@@ -51,7 +72,7 @@ class DeviceManager extends DeviceManagerInterface {
             wifiInfo.bssid = e.detail.bssid;
             this.dispatchEvent(new Event("wifiInfoUpdated"));
         });
-
+        sdkLogger.log("[DeviceManager] Added event listeners for system events");
     }
 
     get deviceInfo() {

package/src/implementation/lifecycle.js

@@ -1,6 +1,6 @@
-import { Lifecycle as LifecycleInterface } from "../interface/lifecycle";
-import { getPlatformInfo } from "./api";
-import { alarmManager } from "./alarmManager";
+import { Lifecycle as LifecycleInterface } from "../interface/lifecycle.js";
+import { getPlatformInfo } from "./api.js";
+import { alarmManager } from "./alarmManager.js";
 import {
     getFCID,
     isAudioSyncConfigured,
@@ -11,9 +11,9 @@ import {
     SenzaError,
     TargetPlayingState
 } from "./utils";
-import { EventListenersManager } from "./eventListenersManager";
-import { sessionInfo } from "./SessionInfo";
-import { DEFAULT_REMOTE_PLAYER_CONFIRMATION_TIMEOUT, remotePlayer } from "./remotePlayer";
+import { EventListenersManager } from "./eventListenersManager.js";
+import { sessionInfo } from "./SessionInfo.js";
+import { DEFAULT_REMOTE_PLAYER_CONFIRMATION_TIMEOUT, remotePlayer } from "./remotePlayer.js";
 
 // Default values for autoBackground settings. These values are used if the UIStreamer settings are not provided.
 const DEFAULT_AUTO_BACKGROUND_VIDEO_DELAY = 30;
@@ -57,53 +57,6 @@ class Lifecycle extends LifecycleInterface {
          * @private
          */
         this._autoBackgroundOnUIDelay = DEFAULT_AUTO_BACKGROUND_UI_DELAY;
-
-        typeof document !== "undefined" && document.addEventListener("hs/uistatechange", (e) => {
-            sdkLogger.log("Got hs/uistatechange", e.detail);
-            const event = new Event("onstatechange");
-            event.state = e.detail;
-            this._state = event.state;
-            if (this._isAutoBackgroundEnabled() && this.state === this.UiState.FOREGROUND) {
-                this._startCountdown();
-            }
-            this.dispatchEvent(event);
-        });
-
-        typeof document !== "undefined" && document.addEventListener("hs/systemInactivity", (e) => {
-            sdkLogger.log("Got hs/systemInactivity", e.detail);
-            const event = new Event("userinactivity");
-            event.timeout = e.detail.timeout;
-            this.dispatchEvent(event);
-        });
-
-        typeof document !== "undefined" && document.addEventListener("hs/endOfSession", async () => {
-            // Create the event
-            const event = new Event("userdisconnected");
-
-            // Use the event manager to dispatch the event and wait for all listeners
-            await this._eventManager.dispatch("userdisconnected", event);
-
-            this._sendTerminatingMessage();
-        });
-
-        typeof document !== "undefined" && document.addEventListener("keydown", () => {
-            if (this._isAutoBackgroundEnabled()) {
-                if (this.state === this.UiState.BACKGROUND ||
-                    this.state === this.UiState.IN_TRANSITION_TO_BACKGROUND) {
-                    this.moveToForeground();
-                } else {
-                    this._startCountdown();
-                }
-            }
-        });
-
-        // Add playModeChange listener
-        remotePlayer.addEventListener("playModeChange", (event) => {
-            if (this._isAutoBackgroundEnabled() && this.state === this.UiState.FOREGROUND) {
-                sdkLogger.log("Resetting auto background timer due to play mode change", event.detail.isPlaying);
-                this._startCountdown(event.detail.isPlaying);
-            }
-        });
     }
 
     /**
@@ -118,6 +71,7 @@ class Lifecycle extends LifecycleInterface {
      * @param {number} [uiStreamerSettings.remotePlayerApiVersion=1] - Remote player API version
      */
     async _init(uiStreamerSettings, triggerEvent) {
+        sdkLogger.log("Initializing Lifecycle");
         if (window.cefQuery) {
 
             // Get UI state
@@ -186,6 +140,11 @@ class Lifecycle extends LifecycleInterface {
                 this._triggerEventFcid = triggerEvent.fcid;
             }
 
+            // Make sure that the event listeners are registered only once
+            if (!this._isInitialized) {
+                this._addSenzaEventListeners();
+            }
+
             this._isInitialized = true;
             this._remotePlayerConfirmationTimeout = uiStreamerSettings?.remotePlayerConfirmationTimeout ?? DEFAULT_REMOTE_PLAYER_CONFIRMATION_TIMEOUT;
             this._remotePlayerApiVersion = uiStreamerSettings?.remotePlayerApiVersion || 1;
@@ -204,6 +163,59 @@ class Lifecycle extends LifecycleInterface {
         }
     }
 
+    /**
+     * @private Add event listeners for system events
+     */
+    _addSenzaEventListeners() {
+        typeof document !== "undefined" && document.addEventListener("hs/uistatechange", (e) => {
+            sdkLogger.log("Got hs/uistatechange", e.detail);
+            const event = new Event("onstatechange");
+            event.state = e.detail;
+            this._state = event.state;
+            if (this._isAutoBackgroundEnabled() && this.state === this.UiState.FOREGROUND) {
+                this._startCountdown();
+            }
+            this.dispatchEvent(event);
+        });
+
+        typeof document !== "undefined" && document.addEventListener("hs/systemInactivity", (e) => {
+            sdkLogger.log("Got hs/systemInactivity", e.detail);
+            const event = new Event("userinactivity");
+            event.timeout = e.detail.timeout;
+            this.dispatchEvent(event);
+        });
+
+        typeof document !== "undefined" && document.addEventListener("hs/endOfSession", async () => {
+            // Create the event
+            const event = new Event("userdisconnected");
+
+            // Use the event manager to dispatch the event and wait for all listeners
+            await this._eventManager.dispatch("userdisconnected", event);
+
+            this._sendTerminatingMessage();
+        });
+
+        typeof document !== "undefined" && document.addEventListener("keydown", () => {
+            if (this._isAutoBackgroundEnabled()) {
+                if (this.state === this.UiState.BACKGROUND ||
+                    this.state === this.UiState.IN_TRANSITION_TO_BACKGROUND) {
+                    this.moveToForeground();
+                } else {
+                    this._startCountdown();
+                }
+            }
+        });
+
+        // Add playModeChange listener
+        remotePlayer.addEventListener("playModeChange", (event) => {
+            if (this._isAutoBackgroundEnabled() && this.state === this.UiState.FOREGROUND) {
+                sdkLogger.log("Resetting auto background timer due to play mode change", event.detail.isPlaying);
+                this._startCountdown(event.detail.isPlaying);
+            }
+        });
+        sdkLogger.log("[Lifecycle] Added event listeners for system events");
+    }
+
     /**
      * @private Checks if auto background is enabled including overrides.
      * @returns {boolean}
@@ -623,7 +635,6 @@ class Lifecycle extends LifecycleInterface {
             }
 
             // TODO: Need to discuss checking for a valid tenantId in the Senza platform
-            remotePlayer._blackoutTime = 0;
             const contentHubTenantId = getPlatformInfo().sessionInfo?.homeSessionInfo?.tenantInfo?.contentHubTenantId;
             const homeTenantId = getPlatformInfo().sessionInfo?.homeSessionInfo?.tenantId;
             sdkLogger.log(`SwitchTenant for ${tenantId}`);
@@ -636,6 +647,7 @@ class Lifecycle extends LifecycleInterface {
                         fcid: FCID,
                         session: btoa(JSON.stringify({
                             tenantId,
+                            tenantSwitchInfo: { startTime: new Date().toISOString(), tenantOrigin: getPlatformInfo().sessionInfo?.tenant },
                             ...getPlatformInfo().sessionInfo?.tenantId === contentHubTenantId && tenantId !== homeTenantId && { returnToTenantId: contentHubTenantId }
                         }))
                     };
@@ -676,12 +688,14 @@ class Lifecycle extends LifecycleInterface {
                         splashUrl: sessionInfoObj?.homeSessionInfo.tenantInfo.tenantSettings.applicationSwitchSplashUrl,
                         fcid: FCID
                     };
+                    const session = { tenantSwitchInfo: { startTime: new Date().toISOString(), tenantOrigin: getPlatformInfo().sessionInfo?.tenant } };
                     if (sessionInfoObj?.returnToTenantId) {
                         if (sessionInfoObj?.returnToTenantId === sessionInfoObj?.homeSessionInfo.tenantInfo.contentHubTenantId) {
                             message.splashUrl = sessionInfoObj?.homeSessionInfo.contentHubTenantInfo.tenantSettings.applicationSwitchSplashUrl;
                         }
-                        message.session = btoa(JSON.stringify({ tenantId: sessionInfoObj?.returnToTenantId }));
+                        session.tenantId = sessionInfoObj?.returnToTenantId;
                     }
+                    message.session = btoa(JSON.stringify(session));
                     request = { target: "TC", waitForResponse: false, message: JSON.stringify(message) };
                 } else {
                     message = {

package/src/implementation/messageManager.js

@@ -5,10 +5,32 @@ class MessageManager extends MessageManagerInterface {
 
     constructor() {
         super();
+        /**
+         * @type {boolean}
+         * @private
+         */
+        this._isInitialized = false;
+    }
+    /**
+     * @private
+     */
+    _init() {
+        sdkLogger.log("Initializing MessageManager");
+        if (!this._isInitialized) {
+            this._isInitialized = true;
+            this._addSenzaEventListeners();
+        }
+    }
+
+    /**
+     * @private Add event listeners for system events
+     */
+    _addSenzaEventListeners() {
         typeof document !== "undefined" && document.addEventListener("hs/externalEvent", (e) => {
             sdkLogger.log("Got hs/externalEvent", JSON.stringify(e.detail));
             this.dispatchEvent(new CustomEvent("message", { detail: { eventName: e.detail.eventName, payload: e.detail.payload, fcid: e.detail.fcid } }));
         });
+        sdkLogger.log("[MessageManager] Added event listeners for system events");
     }
 
     async registerGroups(groups) {