senza-sdk 4.2.64-70c0747.0 → 4.2.65-157c9bb.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.2.64-70c0747.0",
+    "version": "4.2.65-157c9bb.0",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",
@@ -11,13 +11,11 @@
     "homepage": "https://senza.synamedia.com",
     "scripts": {
         "clean": "rm -rf dist",
-        "prepublishOnly": "npm run build:interface",
+        "prepublish": "npm run build",
         "eslint": "eslint --max-warnings 0  src test",
-        "build": "npm run build:interface && npm run build:implementation",
-        "build:interface": "npx webpack --config interface.webpack.config.js",
-        "build:implementation": "npx webpack --config implementation.webpack.config.js",
+        "build": "npx webpack --config webpack.config.js",
         "test": "jest --coverage --verbose",
-        "testall": "npm run test && npm run eslint --fix"
+        "testall": "jest --coverage --verbose && npm run eslint --fix"
     },
     "devDependencies": {
         "@babel/cli": "^7.13.16",
@@ -45,15 +43,9 @@
         "coverageThreshold": {
             "global": {
                 "branches": 88,
-                "functions": 92.73,
-                "lines": 93.99,
-                "statements": 93.97
-            },
-            "src/interface": {
-                "branches": 69.38,
-                "functions": 52.72,
-                "lines": 71.95,
-                "statements": 72.16
+                "functions": 93,
+                "lines": 94,
+                "statements": 94
             }
         }
     },

package/src/{implementation/alarmManager.js → alarmManager.js}

@@ -1,9 +1,29 @@
-import { AlarmManager as AlarmManagerInterface } from "../interface/alarmManager";
 import { getFCID, sdkLogger } from "./utils";
 import { EventListenersManager } from "./eventListenersManager";
 import { lifecycle } from "./lifecycle";
 
-class AlarmManager extends AlarmManagerInterface {
+/**
+ * AlarmManager is a singleton class that manages the alarms in the application. It fires events whose types are the names of the alarms.
+ * @fires MyAlarm
+ */
+class AlarmManager extends EventTarget {
+
+    /**
+     * alarm event
+     *
+     * @event AlarmManager#MyAlarm
+     * @description Fired when time of 'MyAlarm' arrives. If this alarm triggers the application load and the application doesn't call
+     * lifecycle.moveToForeground() in the alarm callback (i.e. the application remains in the background after the callback is completed),
+     * the application will be unloaded.
+     * NOTE: If you perform async operations in the callback (without moving to foreground), you must wait for the async
+     * operation to finish before returning from the callback, otherwise the application will be unloaded before the async operation is finished.<br>
+     * @example
+     * alarmManager.addEventListener("MyAlarm", async (e) => {
+     *     console.log("alarm MyAlarm arrived with data", e.detail);
+     *     await fetch("http://www.example.com");
+     * });
+     * alarmManager.addAlarm("MyAlarm", Date.now() + 60*60*1000, "MyData");
+     */
     constructor() {
         super();
 
@@ -16,10 +36,10 @@ class AlarmManager extends AlarmManagerInterface {
             timeoutMs: 15000 // Default timeout of 15 seconds, can be overridden by _setDefaultTimeout
         });
 
-        typeof document !== "undefined" && document.addEventListener("hs/alarmFiredEvent", async (e) => {
+        typeof document !== "undefined" && document.addEventListener("hs/alarmFiredEvent",async (e) => {
 
             if (e.detail?.alarmName) {
-                const logger = sdkLogger.withFields({ alarmName: e.detail?.alarmName });
+                const logger = sdkLogger.withFields({alarmName: e.detail?.alarmName});
                 logger.log("Got hs/alarmFiredEvent", JSON.stringify(e.detail));
 
                 const timeBeforeAlarmHandling = Date.now();
@@ -33,7 +53,7 @@ class AlarmManager extends AlarmManagerInterface {
                 this._targetState = sourceState;
 
                 // Create the custom event with payload
-                const event = new CustomEvent(e.detail.alarmName, { detail: e.detail.payload });
+                const event = new CustomEvent(e.detail.alarmName, {detail: e.detail.payload});
 
                 // Dispatch the event and wait for all listeners
                 await this._eventManager.dispatch(e.detail.alarmName, event);
@@ -47,7 +67,7 @@ class AlarmManager extends AlarmManagerInterface {
                     if (!this._moveToForegroundHasBeenCalled && window.cefQuery) {
                         logger.log("Application is about to be terminated since didn't move to foreground");
                         const message = { type: "terminating" };
-                        const request = { target: "TC", waitForResponse: false, message: JSON.stringify(message) };
+                        const request = { target:"TC", waitForResponse: false, message: JSON.stringify(message) };
                         window.cefQuery({
                             request: JSON.stringify(request),
                             persistent: false,
@@ -93,7 +113,7 @@ class AlarmManager extends AlarmManagerInterface {
         this._eventManager.addEventListener(type, callback);
     }
 
-    removeEventListener(type, callback) {
+    removeEventListener(type, callback){
         this._eventManager.removeEventListener(type, callback);
     }
 
@@ -106,12 +126,17 @@ class AlarmManager extends AlarmManagerInterface {
         this._targetState = "background";
     }
 
+    /** Set alarm to be fired at the specified time, event when ui is released
+     * @param {string} alarmName unique name for the alarm
+     * @param {number} alarmTime target time for the alarm to be fired, represented by the number of milliseconds elapsed since the epoch
+     * @param {string} [data] data to be passed back when the alarm is fired
+     * */
     addAlarm(alarmName, alarmTime, data = "", toleranceBefore = 0, toleranceAfter = 0) {
         if (typeof data !== "string") {
             throw Error("data must be a string");
         }
         const FCID = getFCID();
-        const logger = sdkLogger.withFields({ alarmName, FCID });
+        const logger = sdkLogger.withFields({alarmName, FCID});
         logger.log(`addAlarm called for ${alarmName} to be fired at ${alarmTime} with tolerance of ${toleranceBefore} minutes before and ${toleranceAfter} minutes after`);
         if (window.cefQuery) {
             const message = {
@@ -119,11 +144,11 @@ class AlarmManager extends AlarmManagerInterface {
                 fcid: FCID,
                 alarmName,
                 alarmTime,
-                toleranceBefore: Math.trunc(toleranceBefore * 60 * 1000),
-                toleranceAfter: Math.trunc(toleranceAfter * 60 * 1000),
+                toleranceBefore: Math.trunc(toleranceBefore*60*1000),
+                toleranceAfter: Math.trunc(toleranceAfter*60*1000),
                 payload: data
             };
-            const request = { target: "TC", waitForResponse: false, message: JSON.stringify(message) };
+            const request = { target:"TC", waitForResponse: false, message: JSON.stringify(message) };
             window.cefQuery({
                 request: JSON.stringify(request),
                 persistent: false,
@@ -139,9 +164,13 @@ class AlarmManager extends AlarmManagerInterface {
         }
     }
 
+    /** Delete the specified alarm
+     * @param {string} alarmName name of alarm to be deleted
+     *
+     * */
     deleteAlarm(alarmName) {
         const FCID = getFCID();
-        const logger = sdkLogger.withFields({ alarmName, FCID });
+        const logger = sdkLogger.withFields({alarmName, FCID});
         logger.log(`deleteAlarm called for ${alarmName}`);
         if (window.cefQuery) {
             const message = {
@@ -149,7 +178,7 @@ class AlarmManager extends AlarmManagerInterface {
                 fcid: FCID,
                 alarmName
             };
-            const request = { target: "TC", waitForResponse: false, message: JSON.stringify(message) };
+            const request = { target:"TC", waitForResponse: false, message: JSON.stringify(message) };
             window.cefQuery({
                 request: JSON.stringify(request),
                 persistent: false,
@@ -165,15 +194,18 @@ class AlarmManager extends AlarmManagerInterface {
         }
     }
 
+    /** Delete all alarms
+     *
+     * */
     deleteAllAlarms() {
         if (window.cefQuery) {
             const FCID = getFCID();
-            const logger = sdkLogger.withFields({ FCID });
+            const logger = sdkLogger.withFields({FCID});
             const message = {
                 type: "deleteAllAlarms",
                 fcid: FCID
             };
-            const request = { target: "TC", waitForResponse: false, message: JSON.stringify(message) };
+            const request = { target:"TC", waitForResponse: false, message: JSON.stringify(message) };
             window.cefQuery({
                 request: JSON.stringify(request),
                 persistent: false,
@@ -189,6 +221,11 @@ class AlarmManager extends AlarmManagerInterface {
         }
     }
 
+    /** Async function that asks for all active alarms
+     * @returns {Promise} when resolved, returns an array of objects containing alarmName and alarmTime fields
+     * @throws {string} error string in case of an error
+     *
+     * */
     getActiveAlarms() {
         throw Error("NOT IMPLEMENTED");
         // if (window.cefQuery) {