senza-sdk 4.4.7 → 4.4.8

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.4.7",
+    "version": "4.4.8",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",

package/src/implementation/api.js

@@ -20,6 +20,7 @@ let authToken;
 
 const API_VERSION = "1.0";
 let interfaceVersion;
+let uiReadyHasBeenCalled = false;
 
 /** @namespace auth
  *@example
@@ -262,6 +263,7 @@ export function isRunningE2E() {
 
 /** Call this API once after application startup, when the ui is ready to accept keys/events */
 export function uiReady() {
+    uiReadyHasBeenCalled = true;
     if (window.cefQuery) {
         window.cefQuery({
             request: "uiReady",
@@ -278,6 +280,13 @@ export function uiReady() {
     }
 }
 
+/**
+ * @private
+ */
+export function _isUiReady() {
+    return uiReadyHasBeenCalled;
+}
+
 import "./devHelper.js";
 
 /**

package/src/implementation/lifecycle.js

@@ -1,5 +1,5 @@
 import { Lifecycle as LifecycleInterface } from "../interface/lifecycle.js";
-import { getPlatformInfo } from "./api.js";
+import { getPlatformInfo, _isUiReady } from "./api.js";
 import { alarmManager } from "./alarmManager.js";
 import {
     getFCID,
@@ -108,6 +108,8 @@ class Lifecycle extends LifecycleInterface {
          */
         this._isSuspendTriggeredByTimer = false;
 
+        this._isInTransitionToSuspended = false;
+
     }
 
     /**
@@ -705,7 +707,6 @@ class Lifecycle extends LifecycleInterface {
         return this._inTransitionToForeground || this._inTransitionToBackground || this._inTransitionToStandby;
     }
 
-
     getState() {
         if (window.cefQuery) {
             return new Promise((resolve, reject) => {
@@ -727,6 +728,13 @@ class Lifecycle extends LifecycleInterface {
     }
 
     moveToForeground() {
+        if (!_isUiReady()) {
+            sdkLogger.warn("lifecycle moveToForeground: UI is not ready yet. Make sure to call senza.uiReady() before calling lifecycle.moveToForeground()");
+        }
+        if (this._isInTransitionToSuspended) {
+            sdkLogger.error("lifecycle moveToForeground: Currently in transition to suspend, cannot move to foreground");
+            return Promise.resolve(false);
+        }
         // Reset activity timestamp when moving to foreground
         this._lastActivityTimestamp = Date.now();
 
@@ -911,7 +919,10 @@ class Lifecycle extends LifecycleInterface {
     }
 
     moveToBackground(isTriggeredByTimer = false) {
-
+        if (this._isInTransitionToSuspended) {
+            sdkLogger.error("lifecycle moveToBackground: Currently in transition to suspend, cannot move to background");
+            return Promise.resolve(false);
+        }
         // If the background transition is triggered by the auto background timer, set the flag
         this._isBackgroundTriggeredByTimer = isTriggeredByTimer;
 
@@ -1073,6 +1084,7 @@ class Lifecycle extends LifecycleInterface {
             return Promise.reject(errorMsg);
         }
 
+        this._isInTransitionToSuspended = true;
         // Report metrics for time between background and suspend
         const duration = (Date.now() - this._backgroundTimestamp) / 1000;
 
@@ -1109,6 +1121,7 @@ class Lifecycle extends LifecycleInterface {
                         resolve(true);
                     },
                     onFailure: (code, msg) => {
+                        this._isInTransitionToSuspended = false;
                         logger.error(`moveToSuspended failed: ${code} ${msg}`);
                         reject(new SenzaError(code, msg));
                     }

package/src/implementation/remotePlayer.js

@@ -15,7 +15,7 @@ import {
     isAppVersionAboveOrEqual
 } from "./utils";
 import { lifecycle } from "./lifecycle";
-import { writeLicenseResponse } from "./api";
+import { writeLicenseResponse, _isUiReady } from "./api";
 import { mergeAutoTranslationLanguages } from "./subtitlesUtils";
 
 // This is the delay we wait for to detect if the web application is seeking multiple times
@@ -736,6 +736,9 @@ class RemotePlayer extends RemotePlayerInterface {
      *
      * */
     async load(url, position) {
+        if (!_isUiReady()) {
+            sdkLogger.warn("remotePlayer load: UI is not ready yet. Make sure to call senza.uiReady() before calling remotePlayer.load()");
+        }
         return this._load(url, position);
     }
 
@@ -942,6 +945,9 @@ class RemotePlayer extends RemotePlayerInterface {
      * @throws {RemotePlayerError} error object contains code & msg
      */
     play(autoTune = false) {
+        if (!_isUiReady()) {
+            sdkLogger.warn("remotePlayer play: UI is not ready yet. Make sure to call senza.uiReady() before calling remotePlayer.play()");
+        }
         if (!this._isInitialized) {
             throw new RemotePlayerError(6500, "Cannot call play() if remote player is not initialized");
         }

package/src/interface/lifecycle.js

@@ -16,9 +16,9 @@ import {
 /**
  * @event Lifecycle#beforestatechange
  * @description Fired before transitioning to a new state. This event is cancelable.<br>
- * Currently only fired when transitioning to BACKGROUND state (e.g., from autoBackground feature).<br>
+ * Currently only fired when transitioning to BACKGROUND and SUSPENDED state (e.g., from autoBackground feature).<br>
  * The actual state transition will occur after all event listeners have completed processing.
- * Can be used to prevent automatic transitions to background state when using autoBackground feature.
+ * Can be used to prevent automatic transitions to background state when using autoBackground feature, or for suspneded from autoSuspended feature .
  * @property {UiState} state - Indicates the target state the lifecycle is trying to transition to.
  * @property {boolean} cancelable - true, indicating the event can be cancelled using preventDefault()
  * @example
@@ -87,13 +87,15 @@ class Lifecycle extends EventTarget {
      * @property {string} IN_TRANSITION_TO_FOREGROUND - ui is about to be displayed
      * @property {string} BACKGROUND - remote player is playing (full screen playback is displayed)
      * @property {string} IN_TRANSITION_TO_BACKGROUND - remote player is about to be playing
+     * @property {string} SUSPENDED - application is suspended. This state is used for the beforestatechange event only.
      */
     UiState = Object.freeze({
         UNKNOWN: "unknown",
         FOREGROUND: "foreground",
         IN_TRANSITION_TO_FOREGROUND: "inTransitionToForeground",
         BACKGROUND: "background",
-        IN_TRANSITION_TO_BACKGROUND: "inTransitionToBackground"
+        IN_TRANSITION_TO_BACKGROUND: "inTransitionToBackground",
+        SUSPENDED: "suspended"
     });
 
     /**

package/src/interface/version.js

@@ -1 +1 @@
-export const version = "4.4.7";
+export const version = "4.4.8";