senza-sdk 4.3.1-e113d43.0 → 4.3.2-2e967be.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.3.1-e113d43.0",
+    "version": "4.3.2-2e967be.0",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",
@@ -46,18 +46,19 @@
             "global": {
                 "branches": 88,
                 "functions": 92.36,
-                "lines": 93.83,
-                "statements": 93.81
+                "lines": 93.47,
+                "statements": 93.46
             },
             "src/interface": {
-                "branches": 69.38,
-                "functions": 52.72,
-                "lines": 71.95,
-                "statements": 72.16
+                "branches": 68.42,
+                "functions": 40.74,
+                "lines": 65.96,
+                "statements": 66.32
             }
         }
     },
     "dependencies": {
-        "shaka-player": "^4.12.5"
+        "shaka-player": "^4.12.5",
+        "moment": "^2.30.1"
     }
 }

package/src/api.js

@@ -4,6 +4,11 @@ import { Lifecycle, RemotePlayer, DeviceManager, PlatformManager, AlarmManager,
 
 const { version } = pack;
 
+typeof document !== "undefined" && document.addEventListener("keydown", (event) => {
+    sdkLogger.log(`Got ${event.key} key`);
+});
+
+
 let authToken;
 
 /** @namespace auth
@@ -193,6 +198,7 @@ export function getClientAssertion() {
 
 /**
  * @module
+ * @private
  * @type {Lifecycle}
  * @example
  * import { lifecycle } from "senza-sdk";
@@ -203,6 +209,7 @@ let lifecycle;
 
 /**
  * @module
+ * @private
  * @type {RemotePlayer}
  * @example
  * import { init, remotePlayer } from "senza-sdk";
@@ -221,6 +228,7 @@ let remotePlayer;
 
 /**
  * @module
+ * @private
  * @type {AlarmManager}
  * @example
  * import { alarmManager } from "senza-sdk";
@@ -231,6 +239,7 @@ let alarmManager;
 
 /**
  * @module
+ * @private
  * @type {DeviceManager}
  * @example
  * import { deviceManager } from "senza-sdk";
@@ -246,6 +255,7 @@ let deviceManager;
 
 /**
  * @module
+ * @private
  * @type {PlatformManager}
  * @example
  * import { platformManager } from "senza-sdk";
@@ -254,11 +264,11 @@ let deviceManager;
  *
  * @return {PlatformManager} pointer to the PlatformManager singleton
  */
-
-
 let platformManager;
+
 /**
  * @module
+ * @private
  * @type {MessageManager}
  * @example
  * import { MessageManager } from "senza-sdk";
@@ -272,6 +282,7 @@ let messageManager;
  * ShakaPlayer subclass of Shaka that handles both local and remote playback.
  *
  * @class ShakaPlayer
+ * @private
  * @type {new|ShakaPlayer}
  * @example
  * import { ShakaPlayer } from "senza-sdk";
@@ -291,6 +302,7 @@ let ShakaPlayerImplementation;
 
 /**
  * @module
+ * @private
  * @type {shaka}
  */
 let shakaImplementation;

package/src/implementation/alarmManager.js

@@ -16,6 +16,27 @@ class AlarmManager extends AlarmManagerInterface {
             timeoutMs: 15000 // Default timeout of 15 seconds, can be overridden by _setDefaultTimeout
         });
 
+        /**
+         * @type {boolean}
+         * @private
+         */
+        this._isInitialized = false;
+    }
+
+    /**
+     * @private
+     */
+    _init() {
+        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) {

package/src/implementation/api.js

@@ -2,16 +2,22 @@ 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";
 let interfaceVersion;
 
-typeof document !== "undefined" && document.addEventListener("keydown", (event) => {
-    sdkLogger.log(`Got ${event.key} key`);
-});
-
 /** @namespace auth
  *@example
  * import { auth } from "senza-sdk";
@@ -28,8 +34,6 @@ export const auth = {
 
 };
 
-import { remotePlayer } from "./remotePlayer.js";
-export { remotePlayer };
 
 /** Should be called once to init the library
  *@example
@@ -127,6 +131,10 @@ 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();
+
 
         const devSequence = sessionInfoObj?.settings?.["ui-streamer"]?.devSequence;
         if (devSequence) {
@@ -259,13 +267,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/deviceManager.js

@@ -43,7 +43,27 @@ class DeviceManager extends DeviceManagerInterface {
         wifiInfo.quality = 0;
         wifiInfo.ssid = "unknown";
         wifiInfo.bssid = "unknown";
+        /**
+         * @type {boolean}
+         * @private
+         */
+        this._isInitialized = false;
+    }
 
+    /**
+     * @private
+     */
+    _init() {
+        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 +71,6 @@ class DeviceManager extends DeviceManagerInterface {
             wifiInfo.bssid = e.detail.bssid;
             this.dispatchEvent(new Event("wifiInfoUpdated"));
         });
-
     }
 
     get deviceInfo() {

package/src/implementation/lifecycle.js

@@ -20,12 +20,6 @@ const DEFAULT_AUTO_BACKGROUND_VIDEO_DELAY = 30;
 const DEFAULT_AUTO_BACKGROUND_UI_DELAY = -1;
 const DEFAULT_AUTO_BACKGROUND_ENABLED = false;
 
-/**
-  * Lifecycle is a singleton class that manages the application lifecycle states.<br>
-  * @fires onstatechange
-  * @fires userinactivity
-  * @fires userdisconnected
- */
 class Lifecycle extends LifecycleInterface {
     constructor() {
         super();
@@ -63,56 +57,10 @@ 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);
-            }
-        });
     }
 
-    /** @private Initialize the lifecycle
+    /**
+     * @private Initialize the lifecycle
      * @param {Object} uiStreamerSettings - UI-streamer portion of the settings taken from session info
      * @param {Object} [uiStreamerSettings.autoBackground] - Auto background mode configuration
      * @param {boolean} [uiStreamerSettings.autoBackground.enabled=false] - Enable/disable auto background
@@ -191,6 +139,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;
@@ -209,14 +162,68 @@ class Lifecycle extends LifecycleInterface {
         }
     }
 
-    /** @private Checks if auto background is enabled including overrides.
+    /**
+     * @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);
+            }
+        });
+    }
+
+    /**
+     * @private Checks if auto background is enabled including overrides.
      * @returns {boolean}
      */
     _isAutoBackgroundEnabled() {
         return this._autoBackgroundOverrides?.enabled ?? this._autoBackground;
     }
 
-    /** @private Gets the auto background video delay including overrides.
+    /**
+     * @private Gets the auto background video delay including overrides.
      * @returns {number}
      */
     _getAutoBackgroundOnVideoDelay() {
@@ -227,7 +234,8 @@ class Lifecycle extends LifecycleInterface {
         return this._autoBackgroundOnVideoDelay;
     }
 
-    /** @private Gets the auto background UI delay including overrides.
+    /**
+     * @private Gets the auto background UI delay including overrides.
      * @returns {number}
      */
     _getAutoBackgroundOnUIDelay() {
@@ -290,6 +298,7 @@ class Lifecycle extends LifecycleInterface {
     }
 
     /**
+     * @private
      * This method moves the application into standby mode, i.e. last ui frame is displayed and ui resources are released.
      * It should be called whenever the application wishes to go into standby mode and release resources.
      * @example

package/src/implementation/messageManager.js

@@ -1,49 +1,36 @@
 import { MessageManager as MessageManagerInterface } from "../interface/messageManager";
 import { getFCID, sdkLogger } from "./utils";
 
-/**
- * MessageManager is a singleton class that manages the external messages received by the application. It fires custom events as "message" with the payload as the content
- * @fires MessageManager#message
- */
-
 class MessageManager extends MessageManagerInterface {
 
+    constructor() {
+        super();
+        /**
+         * @type {boolean}
+         * @private
+         */
+        this._isInitialized = false;
+    }
     /**
-     * @typedef {object} MessageDetails - object which contains the content of the message
-     * @property {string} eventName - The name of the event message, a property of MessageDetails
-     * @property {object} payload - The payload for this event, a property of MessageDetails
-     * @property {string} fcid - The flow context for this message, a property of MessageDetails
+     * @private
      */
+    _init() {
+        if (!this._isInitialized) {
+            this._isInitialized = true;
+            this._addSenzaEventListeners();
+        }
+    }
 
     /**
-     * message event
-     *
-     * @event MessageManager#message
-     * @type {CustomEvent}
-     * @property {MessageDetails} detail - object containing data related to the event:
-
-     *
-     * @description Fired when an external event arrives. This is a generic handler for all messages received for any registered group <br>
-     * @example
-     * messageManager.addEventListener("message", (e) => {
-     *     console.log("message arrived with data", e.detail);
-     * });
-     *
+     * @private Add event listeners for system events
      */
-    constructor() {
-        super();
+    _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 } }));
         });
     }
 
-    /** Register to specific group(s). This function replaces the previously registered groups
-     * @param {Array<String>} groups group events to receive messages.
-     * @return {Promise} Promise which is resolved when the registerGroups command has been successfully processed.
-     * Failure to process the registerGroups command will result in the promise being rejected.
-     * messageManager.registerGroups(["A","B"]);
-     * */
     async registerGroups(groups) {
         sdkLogger.log(`register called for ${groups}`);
         return new Promise((resolve, reject) => {

package/src/implementation/platformManager.js

@@ -2,24 +2,12 @@ import { PlatformManager as PlatformManagerInterface } from "../interface/platfo
 import { sdkLogger } from "./utils";
 import { sessionInfo } from "./SessionInfo";
 
-
-/**
- * PlatformManager is a singleton class that manages the platform
- */
 class PlatformManager extends PlatformManagerInterface {
 
     constructor() {
         super();
     }
 
-    /**
-     * @returns {Object} appConfig object
-     * @property {String[]} territories - a list of territories configured for the tenant.
-     * if the list is undefined or empty - there are no restrictions.
-     * @example
-     * import { platformManager } from "senza-sdk";
-     * const appConfig = platformManager.appConfig
-     * */
     get appConfig() {
         const sessionInfoObj = sessionInfo.sessionInfoObj;
         const appConfig = sessionInfoObj.homeSessionInfo?.["appConfig"] || {};
@@ -27,13 +15,6 @@ class PlatformManager extends PlatformManagerInterface {
         return appConfig;
     }
 
-    /**
-     *
-     * @param {string} timezone the timezone to set to
-     * the format of the timezone is according to the standard TZ identifier
-     * (e.g. America/Los_Angeles, Asia/Tokyo, Europe/Brussels)
-     * for a full list of TZ identifiers, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-     */
     setTimezone(timezone) {
         if (window.cefQuery) {
             const request = { message: JSON.stringify({ type: "setTimeZone", timezone }), waitForResponse: false, target: "UI-Streamer" };