@signageos/front-applet 7.1.1 → 8.0.0

package/es6/FrontApplet/Input/Input.js

@@ -1,34 +1,27 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const events_1 = require("events");
-const Validate_1 = require("../Validate/Validate");
+const Validate_1 = __importDefault(require("../Validate/Validate"));
 class Input {
+    window;
+    messagePrefix;
+    static MESSAGE_PREFIX = 'input';
+    eventEmitter = new events_1.EventEmitter();
+    hasWindowEventListener = false;
+    alive = true;
+    /** @internal */
     constructor(window, messagePrefix) {
         this.window = window;
         this.messagePrefix = messagePrefix;
-        this.eventEmitter = new events_1.EventEmitter();
-        this.hasWindowEventListener = false;
-        this.alive = true;
-        this.dispatchEventToParent = (event) => {
-            try {
-                this.window.parent.document.dispatchEvent(new KeyboardEvent('keyup', event));
-            }
-            catch (e) {
-                if (e instanceof ReferenceError) {
-                    // KeyboardEvent constructor isn't available during tests.
-                    // TODO Mock KeyboardEvent constructor during tests.
-                    this.window.parent.document.dispatchEvent(event);
-                }
-                else {
-                    throw e;
-                }
-            }
-        };
         if (!this.isTopLevelFrame() && this.canAccessParentOrigin()) {
             this.hasWindowEventListener = true;
             this.window.addEventListener('keyup', this.dispatchEventToParent);
         }
     }
+    /** @internal */
     destroy() {
         if (this.alive) {
             this.alive = false;
@@ -38,11 +31,19 @@ class Input {
             }
         }
     }
+    /**
+     * The `onKeyUp` method sets up a listeners, which is called on every key stroke of the remote controller. For the specific logic of an
+     * application (games for example), binding the remote control inputs can be helpful. Only a subset of all remote control keys is
+     * supported on the specific device. Only numerical digits are guaranteed to be supported.
+     *
+     * This feature must be tested by users on real devices.
+     */
     onKeyUp(listener) {
         this.checkAlive();
-        Validate_1.default({ listener }).required().function();
+        (0, Validate_1.default)({ listener }).required().function();
         this.eventEmitter.addListener('keyup', listener);
     }
+    /** @internal */
     handleMessageData(data) {
         switch (data.type) {
             case this.getMessage('keyup'):
@@ -56,12 +57,19 @@ class Input {
             default:
         }
     }
+    /**
+     * The `removeEventListeners()` method removes all event listeners bind on `sos.input` object.
+     */
     removeEventListeners() {
         this.eventEmitter.removeAllListeners();
     }
+    /**
+     * The `removeEventListener()` method removes all event listeners for a specific event (only `keyup` is supported).
+     */
     removeEventListener(event, listener) {
         this.eventEmitter.removeListener(event, listener);
     }
+    /** @internal */
     emitKeyUpEvent(event) {
         this.checkAlive();
         this.eventEmitter.emit('keyup', event);
@@ -70,9 +78,8 @@ class Input {
         return this.window === this.window.parent;
     }
     canAccessParentOrigin() {
-        var _a, _b;
         try {
-            const hasParent = !!((_b = (_a = this.window) === null || _a === void 0 ? void 0 : _a.parent) === null || _b === void 0 ? void 0 : _b.document);
+            const hasParent = !!this.window?.parent?.document;
             if (!hasParent) {
                 console.warn('Parent window or document is not defined');
             }
@@ -91,6 +98,21 @@ class Input {
             }
         }
     }
+    dispatchEventToParent = (event) => {
+        try {
+            this.window.parent.document.dispatchEvent(new KeyboardEvent('keyup', event));
+        }
+        catch (e) {
+            if (e instanceof ReferenceError) {
+                // KeyboardEvent constructor isn't available during tests.
+                // TODO Mock KeyboardEvent constructor during tests.
+                this.window.parent.document.dispatchEvent(event);
+            }
+            else {
+                throw e;
+            }
+        }
+    };
     getMessage(name) {
         return this.messagePrefix + '.' + Input.MESSAGE_PREFIX + '.' + name;
     }
@@ -101,5 +123,4 @@ class Input {
     }
 }
 exports.default = Input;
-Input.MESSAGE_PREFIX = 'input';
 //# sourceMappingURL=Input.js.map

package/es6/FrontApplet/Input/Input.js.map

@@ -1 +1 @@
-{"version":3,"file":"Input.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/Input.ts"],"names":[],"mappings":";;AAAA,mCAAsC;AAItC,mDAA4C;AAG5C,MAAqB,KAAK;IAQzB,YACiB,MAAc,EACb,aAAqB;QADtB,WAAM,GAAN,MAAM,CAAQ;QACb,kBAAa,GAAb,aAAa,CAAQ;QAPtB,iBAAY,GAAiB,IAAI,qBAAY,EAAE,CAAC;QAChD,2BAAsB,GAAY,KAAK,CAAC;QAEjD,UAAK,GAAY,IAAI,CAAC;QA+EtB,0BAAqB,GAAG,CAAC,KAAoB,EAAE,EAAE;YACxD,IAAI;gBACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;aAC7E;YAAC,OAAO,CAAC,EAAE;gBACX,IAAI,CAAC,YAAY,cAAc,EAAE;oBAChC,0DAA0D;oBAC1D,oDAAoD;oBACpD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;iBACjD;qBAAM;oBACN,MAAM,CAAC,CAAC;iBACR;aACD;QACF,CAAC,CAAC;QArFD,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE;YAC5D,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;SAClE;IACF,CAAC;IAEM,OAAO;QACb,IAAI,IAAI,CAAC,KAAK,EAAE;YACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,sBAAsB,EAAE;gBAChC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;aACrE;SACD;IACF,CAAC;IAEM,OAAO,CAAC,QAA6B;QAC3C,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,kBAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAEM,iBAAiB,CAAC,IAAsB;QAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClB,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBAC5B,MAAM,UAAU,GAAgB;oBAC/B,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC;gBACF,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;gBAChC,MAAM;YACP,QAAQ;SACR;IACF,CAAC;IAEM,oBAAoB;QAC1B,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,CAAC;IACxC,CAAC;IAEM,mBAAmB,CAAC,KAAa,EAAE,QAAkC;QAC3E,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEM,cAAc,CAAC,KAAkB;QACvC,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAEO,eAAe;QACtB,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC3C,CAAC;IAEO,qBAAqB;;QAC5B,IAAI;YACH,MAAM,SAAS,GAAG,CAAC,CAAC,CAAA,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,MAAM,0CAAE,QAAQ,CAAA,CAAC;YAClD,IAAI,CAAC,SAAS,EAAE;gBACf,OAAO,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;aACzD;YACD,OAAO,SAAS,CAAC;SACjB;QAAC,OAAO,CAAC,EAAE;YACX,IAAI,CAAC,YAAY,YAAY,EAAE;gBAC9B,yEAAyE;gBACzE,8FAA8F;gBAC9F,yFAAyF;gBACzF,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBAClD,OAAO,KAAK,CAAC;aACb;iBAAM;gBACN,MAAM,CAAC,CAAC;aACR;SACD;IACF,CAAC;IAgBO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACrE,CAAC;IAEO,UAAU;QACjB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;SAC7B;IACF,CAAC;;AA3GF,wBA4GC;AA3GuB,oBAAc,GAAW,OAAO,CAAC"}
+{"version":3,"file":"Input.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/Input.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAGtC,oEAA4C;AAG5C,MAAqB,KAAK;IAUR;IACC;IAVX,MAAM,CAAU,cAAc,GAAW,OAAO,CAAC;IAEvC,YAAY,GAAiB,IAAI,qBAAY,EAAE,CAAC;IAChD,sBAAsB,GAAY,KAAK,CAAC;IAEjD,KAAK,GAAY,IAAI,CAAC;IAE9B,gBAAgB;IAChB,YACiB,MAAc,EACb,aAAqB;QADtB,WAAM,GAAN,MAAM,CAAQ;QACb,kBAAa,GAAb,aAAa,CAAQ;QAEtC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;YAC7D,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACnE,CAAC;IACF,CAAC;IAED,gBAAgB;IACT,OAAO;QACb,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBACjC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACtE,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,QAAsC;QACpD,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAsB;QAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBAC5B,MAAM,UAAU,GAAgB;oBAC/B,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,OAAO,EAAE,IAAI,CAAC,OAAqC;iBACnD,CAAC;gBACF,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;gBAChC,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAED;;OAEG;IACI,oBAAoB;QAC1B,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,KAAc,EAAE,QAAkC;QAC5E,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAAkB;QACvC,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAEO,eAAe;QACtB,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC3C,CAAC;IAEO,qBAAqB;QAC5B,IAAI,CAAC;YACJ,MAAM,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC;YAClD,IAAI,CAAC,SAAS,EAAE,CAAC;gBAChB,OAAO,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;YAC1D,CAAC;YACD,OAAO,SAAS,CAAC;QAClB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,IAAI,CAAC,YAAY,YAAY,EAAE,CAAC;gBAC/B,yEAAyE;gBACzE,8FAA8F;gBAC9F,yFAAyF;gBACzF,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBAClD,OAAO,KAAK,CAAC;YACd,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,CAAC;YACT,CAAC;QACF,CAAC;IACF,CAAC;IAEO,qBAAqB,GAAG,CAAC,KAAoB,EAAE,EAAE;QACxD,IAAI,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9E,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,IAAI,CAAC,YAAY,cAAc,EAAE,CAAC;gBACjC,0DAA0D;gBAC1D,oDAAoD;gBACpD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,CAAC;YACT,CAAC;QACF,CAAC;IACF,CAAC,CAAC;IAEM,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACrE,CAAC;IAEO,UAAU;QACjB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;QAC9B,CAAC;IACF,CAAC;;AA5HF,wBA6HC"}

package/es6/FrontApplet/Management/App/App.d.ts

@@ -1,28 +1,63 @@
 import IPostMessage from '../../IPostMessage';
-import IApp from './IApp';
+import IApp, { AppType } from './IApp';
+/**
+ * The `sos.management.app` API groups together methods for managing the signageOS application installed on the system.
+ */
 export default class App implements IApp {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
-    getType(): Promise<string>;
+    /**
+     * The `getType()` method returns type of the platform the application is running on.
+     *
+     * :::info
+     *
+     * If you need to get specific Android brand or Raspberry Pi model, use the `sos.management.firmware.getType()`.
+     *
+     * :::
+     *
+     * @since 4.0.0
+     */
+    getType(): Promise<AppType>;
+    /**
+     * The `getVersion()` method returns version of the application currently running.
+     *
+     * :::info
+     *
+     * This API is only available for Applets deployed via Timing from Box or REST API.
+     *
+     * :::
+     *
+     * @since 4.0.0
+     */
     getVersion(): Promise<string>;
     /**
-     * Platform users can install general application version directly with passing just version number.
-     * Optionally, the baseUrl can be passed as argument to specify server where the application files are accessible.
+     * The `upgrade(version, baseUrl?)` method upgrades the signageOS application using version and baseUrl. Platform users can install general
+     * application version directly with passing just version number. Optionally, the baseUrl can be passed as argument to specify server
+     * where the application files are accessible.
+     *
+     * @param version The version of the application being installed.
+     * @param [baseUrl='https://2.signageos.io'] Optional server URL where application files are located.
      *
-     * @param version of installing application
-     * @param baseUrl server URL where app files are located (default: https://2.signageos.io)
+     * @since 4.0.0
      */
     upgrade(version: string, baseUrl?: string): Promise<void>;
     /**
-     * Alias for method with swapped arguments
+     * The `upgrade(baseUrl, version)` does the same as `upgrade(version, baseUrl)`.
+     *
      * @alias upgrade(version: string, baseUrl?: string)
-     * @param baseUrl server URL where app files are located
-     * @param version of installing application
+     *
+     * @param baseUrl The server URL where application files are located.
+     * @param version The version of the application being installed.
+     *
+     * @since 4.0.0
      */
     upgrade(baseUrl: string, version: string): Promise<void>;
     /**
-     * Open users can upgrade app passing FQN uri where the application main file is located.
+     * The `upgrade(appUri)` method upgrades the signageOS application with provided appUri. Open users can upgrade app passing FQN
+     * uri where the application main file is located.
+     *
      * This file type/extension differs for every platform. E.g.:
      * - SSSP: http://example.com/apps/sssp_config.xml or http://example.com/apps/ApplicationName.zip
      * - Tizen: http://example.com/apps/sssp_config.xml or http://example.com/apps/ApplicationName.wgt
@@ -31,7 +66,10 @@ export default class App implements IApp {
      * - Brightsign: http://example.com/apps/ApplicationName.zip
      * - Linux: http://example.com/apps/ApplicationName.apk
      * - Android: http://example.com/apps/ApplicationName.apk
+     *
      * @param appUri FQN uri where the application main file is located.
+     *
+     * @since 4.0.0
      */
     upgrade(appUri: string): Promise<void>;
     private getMessage;

package/es6/FrontApplet/Management/App/App.js

@@ -1,45 +1,60 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const UpgradeHelper_1 = require("../helpers/UpgradeHelper");
+/**
+ * The `sos.management.app` API groups together methods for managing the signageOS application installed on the system.
+ */
 class App {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    getType() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { applicationType } = yield this.postMessage({
-                type: this.getMessage('get_application_type'),
-            });
-            return applicationType;
+    /**
+     * The `getType()` method returns type of the platform the application is running on.
+     *
+     * :::info
+     *
+     * If you need to get specific Android brand or Raspberry Pi model, use the `sos.management.firmware.getType()`.
+     *
+     * :::
+     *
+     * @since 4.0.0
+     */
+    async getType() {
+        const { applicationType } = await this.postMessage({
+            type: this.getMessage('get_application_type'),
         });
+        return applicationType;
     }
-    getVersion() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { applicationVersion } = yield this.postMessage({
-                type: this.getMessage('get_application_version'),
-            });
-            return applicationVersion;
+    // TODO: unify box/cloud control
+    /**
+     * The `getVersion()` method returns version of the application currently running.
+     *
+     * :::info
+     *
+     * This API is only available for Applets deployed via Timing from Box or REST API.
+     *
+     * :::
+     *
+     * @since 4.0.0
+     */
+    async getVersion() {
+        const { applicationVersion } = await this.postMessage({
+            type: this.getMessage('get_application_version'),
         });
+        return applicationVersion;
     }
-    upgrade(arg1, arg2) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { baseUrl, version, directUri } = UpgradeHelper_1.parseUpgradeArguments(arg1, arg2);
-            yield this.postMessage({
-                type: this.getMessage('app_upgrade'),
-                baseUrl,
-                version,
-                directUri,
-            });
+    /** @internal */
+    async upgrade(arg1, arg2) {
+        const { baseUrl, version, directUri } = (0, UpgradeHelper_1.parseUpgradeArguments)(arg1, arg2);
+        await this.postMessage({
+            type: this.getMessage('app_upgrade'),
+            baseUrl,
+            version,
+            directUri,
         });
     }
     getMessage(name) {

package/es6/FrontApplet/Management/App/App.js.map

@@ -1 +1 @@
-{"version":3,"file":"App.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/App/App.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,4DAAiE;AAGjE,MAAqB,GAAG;IACvB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,OAAO;;YACnB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;aAC7C,CAAC,CAAC;YAEH,OAAO,eAAe,CAAC;QACxB,CAAC;KAAA;IAEY,UAAU;;YACtB,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACrD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;aAChD,CAAC,CAAC;YAEH,OAAO,kBAAkB,CAAC;QAC3B,CAAC;KAAA;IA+BY,OAAO,CAAC,IAAY,EAAE,IAAa;;YAC/C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,qCAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1E,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;gBACpC,OAAO;gBACP,OAAO;gBACP,SAAS;aACT,CAAC,CAAC;QACJ,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAhED,sBAgEC"}
+{"version":3,"file":"App.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/App/App.ts"],"names":[],"mappings":";;AACA,4DAAiE;AAGjE;;GAEG;AACH,MAAqB,GAAG;IAGd;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;OAUG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;SAC7C,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACxB,CAAC;IAED,gCAAgC;IAChC;;;;;;;;;;OAUG;IACI,KAAK,CAAC,UAAU;QACtB,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACrD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;SAChD,CAAC,CAAC;QAEH,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IA6CD,gBAAgB;IACT,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,IAAa;QAC/C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAA,qCAAqB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1E,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;YACpC,OAAO;YACP,OAAO;YACP,SAAS;SACT,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAvGD,sBAuGC"}

package/es6/FrontApplet/Management/App/IApp.d.ts

@@ -1,5 +1,7 @@
+import { AnyString } from '../../../utils/types';
+export type AppType = 'android' | 'brightsign' | 'default' | 'linux' | 'sssp' | 'tizen' | 'webos' | 'windows' | 'chromeos' | AnyString;
 export default interface IApp {
-    getType(): Promise<string>;
+    getType(): Promise<AppType>;
     getVersion(): Promise<string>;
     upgrade(version: string, baseUrl?: string): Promise<void>;
     upgrade(baseUrl: string, version: string): Promise<void>;

package/es6/FrontApplet/Management/Audio/Audio.d.ts

@@ -1,10 +1,26 @@
 import IPostMessage from '../../IPostMessage';
 import IAudio from './IAudio';
+/**
+ * The `sos.management.audio` API groups methods for managing audio settings.
+ */
 export default class Audio implements IAudio {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `getVolume()` method returns current volume level of the device.
+     *
+     * @since 2.0.0
+     */
     getVolume(): Promise<number>;
+    /**
+     * The `getVolume()` method set the volume level of the device.
+     *
+     * @param volume Value between 0 and 100.
+     *
+     * @since 2.0.0
+     */
     setVolume(volume: number): Promise<void>;
     private getMessage;
 }

package/es6/FrontApplet/Management/Audio/Audio.js

@@ -1,35 +1,43 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Validate_1 = require("../../Validate/Validate");
+const Validate_1 = __importDefault(require("../../Validate/Validate"));
+/**
+ * The `sos.management.audio` API groups methods for managing audio settings.
+ */
 class Audio {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    getVolume() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { volume } = yield this.postMessage({
-                type: this.getMessage('get_volume'),
-            });
-            return volume;
+    /**
+     * The `getVolume()` method returns current volume level of the device.
+     *
+     * @since 2.0.0
+     */
+    async getVolume() {
+        const { volume } = await this.postMessage({
+            type: this.getMessage('get_volume'),
         });
+        return volume;
     }
-    setVolume(volume) {
-        return __awaiter(this, void 0, void 0, function* () {
-            Validate_1.default({ volume }).required().number().min(0).max(100);
-            yield this.postMessage({
-                type: this.getMessage('set_volume'),
-                volume,
-            });
+    /**
+     * The `getVolume()` method set the volume level of the device.
+     *
+     * @param volume Value between 0 and 100.
+     *
+     * @since 2.0.0
+     */
+    async setVolume(volume) {
+        (0, Validate_1.default)({ volume }).required().number().min(0).max(100);
+        await this.postMessage({
+            type: this.getMessage('set_volume'),
+            volume,
         });
     }
     getMessage(name) {

package/es6/FrontApplet/Management/Audio/Audio.js.map

@@ -1 +1 @@
-{"version":3,"file":"Audio.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Audio/Audio.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,sDAA+C;AAG/C,MAAqB,KAAK;IACzB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IACS,SAAS;;YACrB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;aACnC,CAAC,CAAC;YACH,OAAO,MAAM,CAAC;QACf,CAAC;KAAA;IACY,SAAS,CAAC,MAAc;;YACpC,kBAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACzD,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;gBACnC,MAAM;aACN,CAAC,CAAC;QACJ,CAAC;KAAA;IACO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AArBD,wBAqBC"}
+{"version":3,"file":"Audio.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Audio/Audio.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAG/C;;GAEG;AACH,MAAqB,KAAK;IAGhB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;OAIG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;SACnC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,MAAc;QACpC,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YACnC,MAAM;SACN,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AArCD,wBAqCC"}

package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.d.ts

@@ -1,10 +1,14 @@
 import IPostMessage from '../../IPostMessage';
 import IAutoRecovery, { IAutoRecoveryConfiguration } from './IAutoRecovery';
+/** @todo */
 export default class AutoRecovery implements IAutoRecovery {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<IAutoRecoveryConfiguration>);
+    /** @internal */
     get(): Promise<IAutoRecoveryConfiguration>;
+    /** @internal */
     set(configuration: IAutoRecoveryConfiguration): Promise<void>;
     private getMessage;
 }

package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js

@@ -1,35 +1,28 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const lodash_1 = require("lodash");
 const IAutoRecovery_1 = require("./IAutoRecovery");
+/** @todo */
 class AutoRecovery {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    get() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const settings = yield this.postMessage({ type: this.getMessage('get_auto_recovery') });
-            if (!settings.enabled) {
-                return lodash_1.pick(settings, ['enabled', 'autoEnableTimeoutMs']);
-            }
-            return lodash_1.pick(settings, ['enabled', 'healthcheckIntervalMs']);
-        });
+    /** @internal */
+    async get() {
+        const settings = await this.postMessage({ type: this.getMessage('get_auto_recovery') });
+        if (!settings.enabled) {
+            return (0, lodash_1.pick)(settings, ['enabled', 'autoEnableTimeoutMs']);
+        }
+        return (0, lodash_1.pick)(settings, ['enabled', 'healthcheckIntervalMs']);
     }
-    set(configuration) {
-        return __awaiter(this, void 0, void 0, function* () {
-            IAutoRecovery_1.validateAutoRecoveryConfiguration(configuration);
-            yield this.postMessage(Object.assign({ type: this.getMessage('set_auto_recovery') }, configuration));
-        });
+    /** @internal */
+    async set(configuration) {
+        (0, IAutoRecovery_1.validateAutoRecoveryConfiguration)(configuration);
+        await this.postMessage({ type: this.getMessage('set_auto_recovery'), ...configuration });
     }
     getMessage(name) {
         return this.messagePrefix + '.' + name;

package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js.map

@@ -1 +1 @@
-{"version":3,"file":"AutoRecovery.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/AutoRecovery/AutoRecovery.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,mCAA8B;AAE9B,mDAA+G;AAE/G,MAAqB,YAAY;IAChC,YACS,aAAqB,EACrB,WAAqD;QADrD,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAA0C;IAC3D,CAAC;IAES,GAAG;;YACf,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;YACxF,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;gBACtB,OAAO,aAAI,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC,CAAC;aAC1D;YACD,OAAO,aAAI,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC,CAAC;QAC7D,CAAC;KAAA;IAEY,GAAG,CAAC,aAAyC;;YACzD,iDAAiC,CAAC,aAAa,CAAC,CAAC;YACjD,MAAM,IAAI,CAAC,WAAW,iBAAG,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,IAAK,aAAa,EAAG,CAAC;QAC1F,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAtBD,+BAsBC"}
+{"version":3,"file":"AutoRecovery.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/AutoRecovery/AutoRecovery.ts"],"names":[],"mappings":";;AAAA,mCAA8B;AAE9B,mDAA+G;AAE/G,YAAY;AACZ,MAAqB,YAAY;IAGvB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAAqD;QADrD,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAA0C;IAC3D,CAAC;IAEJ,gBAAgB;IACT,KAAK,CAAC,GAAG;QACf,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;QACxF,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACvB,OAAO,IAAA,aAAI,EAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,IAAA,aAAI,EAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,GAAG,CAAC,aAAyC;QACzD,IAAA,iDAAiC,EAAC,aAAa,CAAC,CAAC;QACjD,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,GAAG,aAAa,EAAE,CAAC,CAAC;IAC1F,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAzBD,+BAyBC"}

package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.d.ts

@@ -2,7 +2,7 @@ export default interface IAutoRecovery {
     get(): Promise<IAutoRecoveryConfiguration>;
     set(configuration: IAutoRecoveryConfiguration): Promise<void>;
 }
-export declare type IAutoRecoveryConfiguration = {
+export type IAutoRecoveryConfiguration = {
     enabled: false;
     autoEnableTimeoutMs?: number;
 } | {

package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.js

@@ -1,9 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateAutoRecoveryConfiguration = void 0;
-const Validate_1 = require("../../Validate/Validate");
+const Validate_1 = __importDefault(require("../../Validate/Validate"));
 const validateAutoRecoveryConfiguration = (configuration) => {
-    const validation = Validate_1.default({ configuration }).setError(new Error('Invalid auto recovery configuration')).required();
+    const validation = (0, Validate_1.default)({ configuration }).setError(new Error('Invalid auto recovery configuration')).required();
     if (!configuration.enabled) {
         validation.object({ enabled: 'boolean', autoEnableTimeoutMs: '?number' });
     }

package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAutoRecovery.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/AutoRecovery/IAutoRecovery.ts"],"names":[],"mappings":";;;AAAA,sDAA+C;AAWxC,MAAM,iCAAiC,GAAG,CAAC,aAAyC,EAAE,EAAE;IAC9F,MAAM,UAAU,GAAG,kBAAQ,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAErH,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE;QAC3B,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC,CAAC;KAC1E;SAAM;QACN,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,CAAC;KAC3E;AACF,CAAC,CAAC;AARW,QAAA,iCAAiC,qCAQ5C"}
+{"version":3,"file":"IAutoRecovery.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/AutoRecovery/IAutoRecovery.ts"],"names":[],"mappings":";;;;;;AAAA,uEAA+C;AAWxC,MAAM,iCAAiC,GAAG,CAAC,aAAyC,EAAE,EAAE;IAC9F,MAAM,UAAU,GAAG,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAErH,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;QAC5B,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC,CAAC;IAC3E,CAAC;SAAM,CAAC;QACP,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC5E,CAAC;AACF,CAAC,CAAC;AARW,QAAA,iCAAiC,qCAQ5C"}

package/es6/FrontApplet/Management/Debug/Debug.d.ts

@@ -1,11 +1,30 @@
 import IPostMessage from '../../IPostMessage';
 import IDebug from './IDebug';
+/**
+ * The `sos.management.debug` API groups together method for working with native debug mode.
+ */
 export default class Debug implements IDebug {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `enable()` method enables the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode.
+     *
+     * @since 3.0.0
+     */
     enable(): Promise<void>;
+    /**
+     * The `enable()` method disables the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode.
+     *
+     * @since 3.0.0
+     */
     disable(): Promise<void>;
+    /**
+     * The `isEnabled()` method returns whether the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode is enabled.
+     *
+     * @since 4.1.0
+     */
     isEnabled(): Promise<boolean>;
     private setDebug;
     private getMessage;