senza-sdk 4.3.1-4a01fcf.0 → 4.3.1-ca3d96f.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.3.1-4a01fcf.0",
+    "version": "4.3.1-ca3d96f.0",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",
@@ -46,14 +46,14 @@
             "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": 66.83,
+                "statements": 67.14
             }
         }
     },

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/api.js

@@ -8,10 +8,6 @@ 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";

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();
@@ -112,7 +106,8 @@ class Lifecycle extends LifecycleInterface {
         });
     }
 
-    /** @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
@@ -209,14 +204,16 @@ class Lifecycle extends LifecycleInterface {
         }
     }
 
-    /** @private Checks if auto background is enabled including overrides.
+    /**
+     * @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 +224,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 +288,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,35 +1,8 @@
 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 {
 
-    /**
-     * @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
-     */
-
-    /**
-     * 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);
-     * });
-     *
-     */
     constructor() {
         super();
         typeof document !== "undefined" && document.addEventListener("hs/externalEvent", (e) => {
@@ -38,12 +11,6 @@ class MessageManager extends MessageManagerInterface {
         });
     }
 
-    /** 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" };

package/src/implementation/remotePlayer.js

@@ -1,4 +1,5 @@
-import { RemotePlayer as RemotePlayerInterface } from "../interface/remotePlayer";
+// eslint-disable-next-line no-unused-vars
+import { RemotePlayer as RemotePlayerInterface, RemotePlayerError as RemotePlayerErrorInterface, Config } from "../interface/remotePlayer";
 import {
     getFCID,
     isAudioSyncConfigured,
@@ -28,11 +29,7 @@ const cloneDeep = (element) => {
     return JSON.parse(JSON.stringify(element));
 };
 
-// TODO: check that the link below to the error list is working on dashreadme
-/** Error object to be thrown on remotePlayer api failures.
- * [See error list]{@link RemotePlayer#error}
- */
-export class RemotePlayerError extends Error {
+export class RemotePlayerError extends RemotePlayerErrorInterface {
     constructor(code, message) {
         super(message);
         this.code = code;
@@ -64,26 +61,6 @@ function setPlaybackInfo(playbackInfo) {
     }
 }
 
-
-/**
-* @typedef {Object} Config
-* @property {string} preferredAudioLanguage
-* @property {string} preferredSubtitlesLanguage
-* @property {number} minSuggestedPresentationDelay - minimal delay allowed for live playback in seconds
-* @property {boolean} autoPlay - (Not implemented yet) upon loading start playing automatically
-*/
-
-/**
- * RemotePlayer a singleton class to communicate with remote player
- * @fires timeupdate
- * @fires tracksupdate
- * @fires ended
- * @fires error
- * @fires onloadmodechange
- * @fires playing
- * @fires seeking (Not implemented yet)
- * @fires seeked (Not implemented yet)
- */
 class RemotePlayer extends RemotePlayerInterface {
     constructor() {
         super();
@@ -164,49 +141,11 @@ class RemotePlayer extends RemotePlayerInterface {
          */
         this._isPlaying = false;
 
-        /**
-         * @event RemotePlayer#canplay
-         * @description canplay event will be dispatched when the remote player can start play the event
-         * @example
-         * remotePlayer.addEventListener("canplay", () => {
-         *   console.info("remotePlayer canplay");
-         *   remotePlayer.play();
-         * });
-         * */
-
-        /**
-         * @event RemotePlayer#playing
-         * @description playing event will be dispatched when the remote player started playback of the first audio frame. This event can be used to synchronize the local player with the remote player.
-         * @example
-         * remotePlayer.addEventListener("playing", () => {
-         *   console.info("remotePlayer playing");
-         * });
-         * */
-
-        /**
-         * @event RemotePlayer#loadedmetadata
-         * @description loadedmetadata event will be dispatched when the remote player metadata is loaded
-         * and the audio/video tracks are available
-         * @example
-         * remotePlayer.addEventListener("loadedmetadata", () => {
-         *   console.info("remotePlayer loadedmetadata", remotePlayer.getAudioTracks(), remotePlayer.getTextTracks());
-         * });
-         * */
         typeof document !== "undefined" && document.addEventListener("hs/remotePlayerEvent", (e) => {
             sdkLogger.info("Got hs/remotePlayerEvent event with detail", JSON.stringify(e?.detail));
             this.dispatchEvent(new Event(e?.detail?.eventName));
         });
 
-        /**
-         *
-         * @event RemotePlayer#timeupdate
-         * @example
-         * remotePlayer.addEventListener("timeupdate", () => {
-         *   console.info("remotePlayer timeupdate", remotePlayer.currentTime);
-         *   localPlayer.getMediaElement().currentTime = remotePlayer.currentTime || 0;
-         * });
-         *
-         */
         typeof document !== "undefined" && document.addEventListener("hs/playbackInfoEvent", () => {
             sdkLogger.info("Got hs/playbackInfoEvent");
             // When attached, the sdk controls the synchronization between the local and remote player.
@@ -220,15 +159,6 @@ class RemotePlayer extends RemotePlayerInterface {
             }
         });
 
-        /**
-         *
-         * @event RemotePlayer#tracksupdate
-         * @example
-         * remotePlayer.addEventListener("tracksupdate", () => {
-         *   console.info("remotePlayer tracksupdate", remotePlayer.getAudioTracks(), remotePlayer.getTextTracks());
-         * });
-         *
-         */
         typeof document !== "undefined" && document.addEventListener("hs/playback", (e) => {
             sdkLogger.info("Got hs/playback event with detail", JSON.stringify(e?.detail));
             this._availabilityStartTime = e?.detail?.availabilityStartTime;
@@ -236,13 +166,6 @@ class RemotePlayer extends RemotePlayerInterface {
             this.dispatchEvent(new Event("tracksupdate"));
         });
 
-        /**
-         * @event RemotePlayer#ended
-         * @example
-         * remotePlayer.addEventListener("ended", () => {
-         *   console.info("remotePlayer ended");
-         * });
-         */
         typeof document !== "undefined" && document.addEventListener("hs/EOS", () => {
             sdkLogger.info("Got hs/EOS event");
             this.dispatchEvent(new Event("ended"));
@@ -275,72 +198,7 @@ class RemotePlayer extends RemotePlayerInterface {
             sdkLogger.info(`Adding ${event.detail} seconds, previousTime=${previousCurrentTime} currentTime=${this._videoElement.currentTime}`);
         });
 
-        /**
-         *
-         * @event RemotePlayer#error
-         * @type {object}
-         * @property {int} detail.errorCode
-         * @property {string} detail.message
-         *
-         * @see Possible error codes:
-         *
-         * | Code      | Domain            | Description                                                                                     |
-         * | :-------- | :---------------- | :-----------------------------------------------------------------------------------------------|
-         * | 23        | Player            | load() failed due to remote player initialization error                                         |
-         * | 98        | Player            | load() failed due to remote player failure to send message to the client                        |
-         * | 99        | Player            | load() failed due to remote player reporting invalid message                                    |
-         * | 1000      | Encrypted content | Failed to create or initialise the CDM                                                          |
-         * | 1001      | Encrypted content | Failed to create a CDM session                                                                  |
-         * | 1002      | Encrypted content | CDM failed to generate a license request                                                        |
-         * | 1003      | Encrypted content | The CDM rejected the license server response                                                    |
-         * | 1004      | Encrypted content | The CDM rejected the license server certificate                                                 |
-         * | 1005      | Encrypted content | All keys in the license have expired                                                            |
-         * | 1006      | Encrypted content | Output device is incompatible with the license requirements (HDCP)                              |
-         * | 1007      | Encrypted content | The device has been revoked                                                                     |
-         * | 1008      | Encrypted content | The device secrets aren't available                                                             |
-         * | 1009      | Encrypted content | Keys are loaded but the KID requested by playback isn't found. The app has likely issued a license for the wrong content or there is a mismatch between the KIDs in the license and the data plane |
-         * | 1010      | Encrypted content | The CDM failed to provision, therefore it is not possible to play encrypted content             |
-         * | 1100      | Encrypted content | The CDM session has already received a license response. The app has likely issued 2, or more, license responses for the same request. The subsequent licenses will be ignored so this error is informational only |
-         * | 1101      | Encrypted content | The license has been rejected since an error was received by the CDM. The app has likely sent a non-200 code to `WriteLicenseResponse` |
-         * | 1102      | Encrypted content | A license response wasn't received from the app within a pre-defined timeout                    |
-         * | 1103      | Encrypted content | The CDM session associated with this license response is in an invalid state. This is an internal Senza platform error |
-         * | 1104      | Encrypted content | The CDM failed to send a license request to the app. This is an internal Senza platform error   |
-         * | 1999      | Encrypted content | An unknown encrypted content error                                                              |
-         * | 2000      | Player            | Content makes reference to no or unsupported key system                                         |
-         * | 3000      | Player            | Unexpected problem with playback, only used if no more specific code in 3xxx range applies      |
-         * | 3001      | Player            | Problem accessing content manifest, only used if no more specific code in 8xxx range applies    |
-         * | 3002      | Player            | Unexpectedly stopped playback                                                                   |
-         * | 3100      | Player            | Problem parsing MP4 content                                                                     |
-         * | 3200      | Player            | Problem with decoder                                                                            |
-         * | 3300      | Player            | DRM keys unavailable, player waited for keys but none arrived                                   |
-         * | 3400      | Player            | Problem accessing segments, only used if no more specific code in 34xx range applies            |
-         * | 3401      | Player            | Problem accessing segments, connection issue or timeout                                         |
-         * | 3402      | Player            | Problem accessing segments, server returned HTTP error code                                     |
-         * | 3403      | Player            | Problem accessing segments, server authentication issue                                         |
-         * | 3404      | Player            | Problem accessing segments, server returned not found                                           |
-         * | 3900-3999 | Player            | Internal player error                                                                           |
-         * | 6000      | Player            | The remote player api call has reached the configurable timeout with no response from the remote player |
-         * | 6001      | Player            | play() was called while the remote player is not loaded                                         |
-         * | 6002      | Player            | load() was called while the application was in state 'background' or 'inTransitionToBackground' |
-         * | 6500      | Player            | remotePlayer api was called before initializing remotePlayer                                    |
-         * | 6501      | Player            | load() was called while previous load/unload was still in progress                              |
-         * | 6502      | Player            | unload() was called while previous unload/load was still in progress                            |
-         * | 8001      | Player            | Error pulling manifest. bad parameters                                                          |
-         * | 8002      | Player            | Error pulling manifest. filters returned no data                                                |
-         * | 8003      | Player            | Error pulling manifest. fetch error                                                             |
-         * | 8004      | Player            | Error pulling manifest. parse error                                                             |
-         * | 8005      | Player            | Error pulling manifest. stale manifest detected                                                 |
-         * | 8006      | Player            | Error updating manifest. internal cache error                                                   |
-         * | 8007      | Player            | Error updating manifest. internal error during backoff                                          |
-         * | 8008      | Player            | Error pulling manifest. sidx parsing error                                                      |
-         * | 8009      | Player            | Error pulling manifest. internal error                                                          |
-         *
-         * @example
-         * remotePlayer.addEventListener("error", (event) => {
-         *   console.error("received remotePlayer error:", event.detail.errorCode, event.detail.message);
-         * });
-         *
-         */
+
         typeof document !== "undefined" && document.addEventListener("hs/ERR", (event) => {
             sdkLogger.info("Got hs/ERR event");
             delete event?.detail?.type; // type is always videoPlaybackEvent, so no need to pass it
@@ -348,58 +206,6 @@ class RemotePlayer extends RemotePlayerInterface {
             this.dispatchEvent(new CustomEvent("error", event));
         });
 
-        /**
-         *
-         * @event RemotePlayer#license-request
-         * @description Fired whenever the platform requires a license to play encrypted content.
-         * The Web App is responsible for passing the (opaque) license request blob to the license server and passing the (opaque) license server response to the CDM by calling the `writeLicenseResponse` method on the event.
-         * @type {LicenseRequestEvent}
-         * @property {object} detail - Object containing ievent data
-         * @property {string} detail.licenseRequest - Base64 coded opaque license request. The app is responsible for decoding the request before sending to the license server. Note that after decoding, the request may still be in Base64 form and this form should be sent to the license server without further decoding
-         * @property {writeLicenseResponse} writeLicenseResponse - Write the license server response to the platform
-         * @example
-         * Whilst the payload structure and access controls are specific to each license server implementation, the Widevine UAT license server requires no authentication and minimal payload formatting and therefore serves as a useful case study that may be adapted.
-         *
-         *   remotePlayer.addEventListener("license-request", async (event) => {
-         *       console.log("Got license-request event");
-         *       const requestBuffer = event?.detail?.licenseRequest;
-         *       const requestBufferStr = String.fromCharCode.apply(null, new Uint8Array(requestBuffer));
-         *       console.log("License Request in base64:", requestBufferStr);
-         *       const decodedLicenseRequest = window.atob(requestBufferStr); // from base 64
-         *       const licenseRequestBytes = Uint8Array.from(decodedLicenseRequest, (l) => l.charCodeAt(0));
-         *       // call Google API
-         *       const res = await getLicenseFromServer(licenseRequestBytes.buffer);
-         *       console.log("Writing response to platform ", res.code, res.responseBody);
-         *       event.writeLicenseResponse(res.code, res.responseBody);
-         *   });
-
-         *   async function getLicenseFromServer(licenseRequest) {
-         *       console.log("Requesting License from Widevine server");
-         *       const response = await fetch("https://proxy.uat.widevine.com/proxy", {
-         *           "method": "POST",
-         *           "body": licenseRequest,
-         *           "headers" : {
-         *               "Content-Type": "application/octet-stream"
-         *           }
-         *       });
-         *       const code = response.status;
-         *       if (code !== 200) {
-         *           console.error("failed to to get response from widevine:", code);
-         *           const responseBody = await response.text();
-         *           console.error(responseBody);
-         *           return {code, responseBody};
-         *       }
-         *       const responseBody = await response.arrayBuffer();
-         *       console.info("Got response: ");
-         *       return {code, responseBody};
-         *   }
-         **/
-        /**
-         * @function writeLicenseResponse
-         * @param {number} statusCode - License server HTTP response code, e.g. 200, 401, etc. Must be 200 to indicate a successful license exchange.
-         * @param {string} response - License server response as opaque binary data in an ArrayBuffer.
-         *
-         * */
         typeof document !== "undefined" && document.addEventListener("hs/getLicense", (event) => {
             sdkLogger.info("Got hs/getLicense event");
             const getLicenseEventData = event?.detail;
@@ -419,20 +225,6 @@ class RemotePlayer extends RemotePlayerInterface {
         });
     }
 
-    /**
-     * @typedef {Object} LoadMode
-     * @property {string} NOT_LOADED
-     * @property {string} LOADING
-     * @property {string} LOADED
-     * @property {string} UNLOADING
-     */
-    LoadMode = Object.freeze({
-        NOT_LOADED: "notLoaded",
-        LOADING: "loading",
-        LOADED: "loaded",
-        UNLOADING: "unloading"
-    });
-
     /** @private Initialize the remote player
      * @param {Object} uiStreamerSettings ui-streamer portion of the settings taken from session info
      * */