@signageos/front-applet 7.2.0 → 8.0.1

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

@@ -1,28 +1,76 @@
 import IPostMessage from '../../IPostMessage';
 import INetworkInfo, { INetworkInterface, INetworkOptions, INetworkOptionsLegacy, NetworkInterface } from './INetworkInfo';
 import INetwork from './INetwork';
+/**
+ * The `sos.management.network` API groups together methods for networking.
+ *
+ * :::info
+ *
+ * Use `sos.management.supports('NETWORK_INFO')` to check if the device supports managing the network setup.
+ *
+ * :::
+ */
 export default class Network implements INetwork {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
-    /** @deprecated use sos.management.network.listInterfaces() instead */
+    /** @deprecated Use `sos.management.network.listInterfaces()` instead. */
     getActiveInfo(): Promise<INetworkInfo>;
+    /**
+     * The `listInterface()` method returns list of all network interfaces, and their information like MAC address, IP address, etc. Wifi
+     * connection strength is described as percentage in range from 0 to 100, linearly converted from dBm -90 to -30 respectively based on
+     * platform.
+     *
+     * @since 4.9.0
+     */
     listInterfaces(): Promise<INetworkInterface[]>;
-    /** @deprecated use sos.management.network.setManual2() instead */
+    /** @deprecated Use `sos.management.network.setManual(interfaceName, options)` instead. */
     setManual(options: INetworkOptionsLegacy): Promise<void>;
     /**
-     * Manually configure a network interface
-     * @param interfaceName can be retrieved from the list of interfaces returned by listInterfaces()
-     * @param options
+     * The `setManual()` method manually configures a network interface.
+     *
+     * :::warning
+     *
+     * Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](./wifi#enableClient).
+     *
+     * :::
+     *
+     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
+     * @param options The network configuration options.
+     *
+     * @since 4.0.0
      */
     setManual(interfaceName: string, options: INetworkOptions): Promise<void>;
-    /** @deprecated use sos.management.network.setDHCP2() instead */
+    /** @deprecated Use `sos.management.network.setDHCP(interfaceName)` instead. */
     setDHCP(networkInterface: NetworkInterface): Promise<void>;
     /**
-     * Configure a network interface to use DHCP
-     * @param interfaceName can be retrieved from the list of interfaces returned by listInterfaces()
+     * The `setDHCP()` method configures a network interface to use DHCP.
+     *
+     * :::warning
+     *
+     * Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](./wifi#enableClient).
+     *
+     * :::
+     *
+     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
+     *
+     * @since 4.0.0
      */
     setDHCP(interfaceName: string): Promise<void>;
+    /**
+     * The `disableInterface()` disables a network interface.
+     *
+     * :::warning
+     *
+     * Don't use this method to disable Wi-Fi. Use [Wi-Fi API](./wifi) to enable/disable Wi-Fi.
+     *
+     * :::
+     *
+     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
+     *
+     * @since 4.13.0
+     */
     disableInterface(interfaceName: string): Promise<void>;
     private getMessage;
 }

package/es6/FrontApplet/Management/Network/Network.js

@@ -1,87 +1,105 @@
 "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 INetworkInfo_1 = require("./INetworkInfo");
-const Validate_1 = require("../../Validate/Validate");
+const Validate_1 = __importDefault(require("../../Validate/Validate"));
+/**
+ * The `sos.management.network` API groups together methods for networking.
+ *
+ * :::info
+ *
+ * Use `sos.management.supports('NETWORK_INFO')` to check if the device supports managing the network setup.
+ *
+ * :::
+ */
 class Network {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    /** @deprecated use sos.management.network.listInterfaces() instead */
-    getActiveInfo() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { networkInfo } = yield this.postMessage({
-                type: this.getMessage('get_network_info'),
-            });
-            return networkInfo;
-        });
-    }
-    listInterfaces() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { interfaces } = yield this.postMessage({
-                type: this.getMessage('get_network_interfaces'),
-            });
-            return interfaces;
+    /** @deprecated Use `sos.management.network.listInterfaces()` instead. */
+    async getActiveInfo() {
+        const { networkInfo } = await this.postMessage({
+            type: this.getMessage('get_network_info'),
         });
+        return networkInfo;
     }
-    setManual(...args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (typeof args[0] === 'string') {
-                const [interfaceName, options] = args;
-                (0, Validate_1.default)({ interfaceName }).required().string();
-                (0, Validate_1.default)({ options }).required().object(INetworkInfo_1.VINetworkOptions);
-                yield this.postMessage({
-                    type: this.getMessage('set_network_manual_v2'),
-                    interfaceName,
-                    options,
-                });
-            }
-            else {
-                const [options] = args;
-                (0, Validate_1.default)({ options }).required().object(INetworkInfo_1.VINetworkOptionsLegacy);
-                yield this.postMessage({
-                    type: this.getMessage('set_network_manual'),
-                    options,
-                });
-            }
+    /**
+     * The `listInterface()` method returns list of all network interfaces, and their information like MAC address, IP address, etc. Wifi
+     * connection strength is described as percentage in range from 0 to 100, linearly converted from dBm -90 to -30 respectively based on
+     * platform.
+     *
+     * @since 4.9.0
+     */
+    async listInterfaces() {
+        const { interfaces } = await this.postMessage({
+            type: this.getMessage('get_network_interfaces'),
         });
+        return interfaces;
     }
-    setDHCP(...args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (args[0] === 'ethernet' || args[0] === 'wifi') {
-                const [networkInterface] = args;
-                (0, Validate_1.default)({ networkInterface }).required().string(INetworkInfo_1.VNetworkInterface);
-                yield this.postMessage({
-                    type: this.getMessage('set_network_dhcp'),
-                    networkInterface,
-                });
-            }
-            else {
-                const [interfaceName] = args;
-                (0, Validate_1.default)({ interfaceName }).required().string();
-                yield this.postMessage({
-                    type: this.getMessage('set_network_dhcp_v2'),
-                    interfaceName,
-                });
-            }
-        });
+    /** @internal */
+    async setManual(...args) {
+        if (typeof args[0] === 'string') {
+            const [interfaceName, options] = args;
+            (0, Validate_1.default)({ interfaceName }).required().string();
+            (0, Validate_1.default)({ options }).required().object(INetworkInfo_1.VINetworkOptions);
+            await this.postMessage({
+                type: this.getMessage('set_network_manual_v2'),
+                interfaceName,
+                options,
+            });
+        }
+        else {
+            const [options] = args;
+            (0, Validate_1.default)({ options }).required().object(INetworkInfo_1.VINetworkOptionsLegacy);
+            await this.postMessage({
+                type: this.getMessage('set_network_manual'),
+                options,
+            });
+        }
     }
-    disableInterface(interfaceName) {
-        return __awaiter(this, void 0, void 0, function* () {
+    /** @internal */
+    async setDHCP(...args) {
+        if (args[0] === 'ethernet' || args[0] === 'wifi') {
+            const [networkInterface] = args;
+            (0, Validate_1.default)({ networkInterface }).required().string(INetworkInfo_1.VNetworkInterface);
+            await this.postMessage({
+                type: this.getMessage('set_network_dhcp'),
+                networkInterface,
+            });
+        }
+        else {
+            const [interfaceName] = args;
             (0, Validate_1.default)({ interfaceName }).required().string();
-            yield this.postMessage({
-                type: this.getMessage('disable_network_interface'),
+            await this.postMessage({
+                type: this.getMessage('set_network_dhcp_v2'),
                 interfaceName,
             });
+        }
+    }
+    /**
+     * The `disableInterface()` disables a network interface.
+     *
+     * :::warning
+     *
+     * Don't use this method to disable Wi-Fi. Use [Wi-Fi API](./wifi) to enable/disable Wi-Fi.
+     *
+     * :::
+     *
+     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
+     *
+     * @since 4.13.0
+     */
+    async disableInterface(interfaceName) {
+        (0, Validate_1.default)({ interfaceName }).required().string();
+        await this.postMessage({
+            type: this.getMessage('disable_network_interface'),
+            interfaceName,
         });
     }
     getMessage(name) {

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

@@ -1 +1 @@
-{"version":3,"file":"Network.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Network/Network.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,iDAQwB;AACxB,sDAA+C;AAG/C,MAAqB,OAAO;IAC3B,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ,sEAAsE;IACzD,aAAa;;YACzB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC9C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;aACzC,CAAC,CAAC;YAEH,OAAO,WAAW,CAAC;QACpB,CAAC;KAAA;IAEY,cAAc;;YAC1B,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC7C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;aAC/C,CAAC,CAAC;YACH,OAAO,UAAU,CAAC;QACnB,CAAC;KAAA;IAYY,SAAS,CAAC,GAAG,IAAyD;;YAClF,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;gBAChC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;gBACtC,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;gBAChD,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,+BAAgB,CAAC,CAAC;gBAC1D,MAAM,IAAI,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;oBAC9C,aAAa;oBACb,OAAO;iBACP,CAAC,CAAC;aACH;iBAAM;gBACN,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;gBACvB,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,qCAAsB,CAAC,CAAC;gBAChE,MAAM,IAAI,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;oBAC3C,OAAO;iBACP,CAAC,CAAC;aACH;QACF,CAAC;KAAA;IAWY,OAAO,CAAC,GAAG,IAAmC;;YAC1D,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;gBACjD,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;gBAChC,IAAA,kBAAQ,EAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,gCAAiB,CAAC,CAAC;gBACpE,MAAM,IAAI,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;oBACzC,gBAAgB;iBAChB,CAAC,CAAC;aACH;iBAAM;gBACN,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;gBAC7B,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;gBAChD,MAAM,IAAI,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;oBAC5C,aAAa;iBACb,CAAC,CAAC;aACH;QACF,CAAC;KAAA;IAEY,gBAAgB,CAAC,aAAqB;;YAClD,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAChD,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;gBAClD,aAAa;aACb,CAAC,CAAC;QACJ,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA1FD,0BA0FC"}
+{"version":3,"file":"Network.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Network/Network.ts"],"names":[],"mappings":";;;;;AACA,iDAQwB;AACxB,uEAA+C;AAG/C;;;;;;;;GAQG;AACH,MAAqB,OAAO;IAGlB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ,yEAAyE;IAClE,KAAK,CAAC,aAAa;QACzB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC9C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;SACzC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc;QAC1B,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC7C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC/C,CAAC,CAAC;QACH,OAAO,UAAU,CAAC;IACnB,CAAC;IAqBD,gBAAgB;IACT,KAAK,CAAC,SAAS,CAAC,GAAG,IAAyD;QAClF,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YACjC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;YACtC,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAChD,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,+BAAgB,CAAC,CAAC;YAC1D,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;gBAC9C,aAAa;gBACb,OAAO;aACP,CAAC,CAAC;QACJ,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;YACvB,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,qCAAsB,CAAC,CAAC;YAChE,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;gBAC3C,OAAO;aACP,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAoBD,gBAAgB;IACT,KAAK,CAAC,OAAO,CAAC,GAAG,IAAmC;QAC1D,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;YAChC,IAAA,kBAAQ,EAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,gCAAiB,CAAC,CAAC;YACpE,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBACzC,gBAAgB;aAChB,CAAC,CAAC;QACJ,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;YAC7B,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAChD,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;gBAC5C,aAAa;aACb,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,gBAAgB,CAAC,aAAqB;QAClD,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAChD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;YAClD,aAAa;SACb,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAnID,0BAmIC"}

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

@@ -1,12 +1,32 @@
 import IPostMessage from '../../IPostMessage';
 import IOSInfo from './IOSInfo';
 import IOS, { SystemMemoryInfo } from './IOS';
+/**
+ * The `sos.management.os` API groups together methods for retrieving information about the system.
+ */
 export default class OS implements IOS {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `getInfo()` method returns info about the system of the device, such as what current version of it is installed on a device. Major
+     * version of current operating system. It's usually 1 or 2 digits including or excluding dot notation.
+     *
+     * @since 5.0.0
+     */
     getInfo(): Promise<IOSInfo>;
+    /**
+     * The `getCpuUsage()` method returns current CPU usage (ranging 0-100).
+     *
+     * @since 5.4.0
+     */
     getCpuUsage(): Promise<number>;
+    /**
+     * The `getMemoryUsage()` method returns total memory amount in bytes, currently used memory and remaining free memory.
+     *
+     * @since 5.4.0
+     */
     getMemoryUsage(): Promise<SystemMemoryInfo>;
     private getMessage;
 }

package/es6/FrontApplet/Management/OS/OS.js

@@ -1,42 +1,49 @@
 "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 });
+/**
+ * The `sos.management.os` API groups together methods for retrieving information about the system.
+ */
 class OS {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    getInfo() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { osInfo } = yield this.postMessage({
-                type: this.getMessage('get_os_info'),
-            });
-            return osInfo;
+    /**
+     * The `getInfo()` method returns info about the system of the device, such as what current version of it is installed on a device. Major
+     * version of current operating system. It's usually 1 or 2 digits including or excluding dot notation.
+     *
+     * @since 5.0.0
+     */
+    async getInfo() {
+        const { osInfo } = await this.postMessage({
+            type: this.getMessage('get_os_info'),
         });
+        return osInfo;
     }
-    getCpuUsage() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { cpuUsage } = yield this.postMessage({
-                type: this.getMessage('get_cpu_usage'),
-            });
-            return cpuUsage;
+    /**
+     * The `getCpuUsage()` method returns current CPU usage (ranging 0-100).
+     *
+     * @since 5.4.0
+     */
+    async getCpuUsage() {
+        const { cpuUsage } = await this.postMessage({
+            type: this.getMessage('get_cpu_usage'),
         });
+        return cpuUsage;
     }
-    getMemoryUsage() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { memoryUsage } = yield this.postMessage({
-                type: this.getMessage('get_memory_usage'),
-            });
-            return memoryUsage;
+    /**
+     * The `getMemoryUsage()` method returns total memory amount in bytes, currently used memory and remaining free memory.
+     *
+     * @since 5.4.0
+     */
+    async getMemoryUsage() {
+        const { memoryUsage } = await this.postMessage({
+            type: this.getMessage('get_memory_usage'),
         });
+        return memoryUsage;
     }
     getMessage(name) {
         return this.messagePrefix + '.' + name;

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

@@ -1 +1 @@
-{"version":3,"file":"OS.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/OS/OS.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,MAAqB,EAAE;IACtB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,OAAO;;YACnB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;aACpC,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QACf,CAAC;KAAA;IAEY,WAAW;;YACvB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;aACtC,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC;QACjB,CAAC;KAAA;IAEY,cAAc;;YAC1B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC9C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;aACzC,CAAC,CAAC;YAEH,OAAO,WAAW,CAAC;QACpB,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAjCD,qBAiCC"}
+{"version":3,"file":"OS.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/OS/OS.ts"],"names":[],"mappings":";;AAIA;;GAEG;AACH,MAAqB,EAAE;IAGb;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;OAKG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;SACpC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACvB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;SACtC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc;QAC1B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC9C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;SACzC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACpB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAlDD,qBAkDC"}

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

@@ -1,9 +1,29 @@
 import IPostMessage from '../../IPostMessage';
 import IPackage from './IPackage';
+/**
+ * The `sos.management.package` API groups together methods for installing custom Android packages.
+ */
 export default class Package implements IPackage {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `install()` method installs a certain package from the specified url.
+     *
+     * @param baseUrl URL where the package is available
+     * @param packageName Name of the android package
+     * @param version Package version
+     * @param build If relevant for your device
+     *
+     * @example
+     * await sos.management.package.install(
+     *   'https://cdn.your-cms.com',
+     *   'io.signageosWebView.app.ota',
+     *   '2.4.0',
+     *   'benq'
+     * );
+     */
     install(baseUrl: string, packageName: string, version: string, build: string | null): Promise<void>;
     private getMessage;
 }

package/es6/FrontApplet/Management/Package/Package.js

@@ -1,33 +1,48 @@
 "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.package` API groups together methods for installing custom Android packages.
+ */
 class Package {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    install(baseUrl, packageName, version, build) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ baseUrl }).required().uri();
-            (0, Validate_1.default)({ packageName }).required().string();
-            (0, Validate_1.default)({ version }).required().string();
-            (0, Validate_1.default)({ build }).canBeNull().required().string();
-            yield this.postMessage({
-                type: this.getMessage('install_package'),
-                baseUrl,
-                packageName,
-                version,
-                build,
-            });
+    // TODO: build param
+    /**
+     * The `install()` method installs a certain package from the specified url.
+     *
+     * @param baseUrl URL where the package is available
+     * @param packageName Name of the android package
+     * @param version Package version
+     * @param build If relevant for your device
+     *
+     * @example
+     * await sos.management.package.install(
+     *   'https://cdn.your-cms.com',
+     *   'io.signageosWebView.app.ota',
+     *   '2.4.0',
+     *   'benq'
+     * );
+     */
+    async install(baseUrl, packageName, version, build) {
+        (0, Validate_1.default)({ baseUrl }).required().uri();
+        (0, Validate_1.default)({ packageName }).required().string();
+        (0, Validate_1.default)({ version }).required().string();
+        (0, Validate_1.default)({ build }).canBeNull().required().string();
+        await this.postMessage({
+            type: this.getMessage('install_package'),
+            baseUrl,
+            packageName,
+            version,
+            build,
         });
     }
     getMessage(name) {

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

@@ -1 +1 @@
-{"version":3,"file":"Package.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Package/Package.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,sDAA+C;AAG/C,MAAqB,OAAO;IAC3B,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,OAAO,CAAC,OAAe,EAAE,WAAmB,EAAE,OAAe,EAAE,KAAoB;;YAC/F,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;YACvC,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAC9C,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAC1C,IAAA,kBAAQ,EAAC,EAAE,KAAK,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YACpD,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;gBACxC,OAAO;gBACP,WAAW;gBACX,OAAO;gBACP,KAAK;aACL,CAAC,CAAC;QACJ,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAvBD,0BAuBC"}
+{"version":3,"file":"Package.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Package/Package.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAG/C;;GAEG;AACH,MAAqB,OAAO;IAGlB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ,oBAAoB;IACpB;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,OAAO,CAAC,OAAe,EAAE,WAAmB,EAAE,OAAe,EAAE,KAAoB;QAC/F,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QACvC,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC9C,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAA,kBAAQ,EAAC,EAAE,KAAK,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QACpD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;YACxC,OAAO;YACP,WAAW;YACX,OAAO;YACP,KAAK;SACL,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAzCD,0BAyCC"}

package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.js

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

package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.js.map

@@ -1 +1 @@
-{"version":3,"file":"IPeerRecovery.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/PeerRecovery/IPeerRecovery.ts"],"names":[],"mappings":";;;AAAA,sDAA+C;AASxC,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;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,kBAAkB,EAAE,QAAQ,EAAE,CAAC,CAAC;KACxE;AACF,CAAC,CAAC;AARW,QAAA,iCAAiC,qCAQ5C"}
+{"version":3,"file":"IPeerRecovery.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/PeerRecovery/IPeerRecovery.ts"],"names":[],"mappings":";;;;;;AAAA,uEAA+C;AASxC,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,kBAAkB,EAAE,QAAQ,EAAE,CAAC,CAAC;IACzE,CAAC;AACF,CAAC,CAAC;AARW,QAAA,iCAAiC,qCAQ5C"}

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

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

package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.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 IPeerRecovery_1 = require("./IPeerRecovery");
+/** @todo */
 class PeerRecovery {
+    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_peer_recovery') });
-            if (!settings.enabled) {
-                return (0, lodash_1.pick)(settings, ['enabled', 'autoEnableTimeoutMs']);
-            }
-            return (0, lodash_1.pick)(settings, ['enabled', 'urlLauncherAddress']);
-        });
+    /** @internal */
+    async get() {
+        const settings = await this.postMessage({ type: this.getMessage('get_peer_recovery') });
+        if (!settings.enabled) {
+            return (0, lodash_1.pick)(settings, ['enabled', 'autoEnableTimeoutMs']);
+        }
+        return (0, lodash_1.pick)(settings, ['enabled', 'urlLauncherAddress']);
     }
-    set(configuration) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, IPeerRecovery_1.validatePeerRecoveryConfiguration)(configuration);
-            yield this.postMessage(Object.assign({ type: this.getMessage('set_peer_recovery') }, configuration));
-        });
+    /** @internal */
+    async set(configuration) {
+        (0, IPeerRecovery_1.validatePeerRecoveryConfiguration)(configuration);
+        await this.postMessage({ type: this.getMessage('set_peer_recovery'), ...configuration });
     }
     getMessage(name) {
         return this.messagePrefix + '.' + name;

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

@@ -1 +1 @@
-{"version":3,"file":"PeerRecovery.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/PeerRecovery/PeerRecovery.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,IAAA,aAAI,EAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC,CAAC;aAC1D;YACD,OAAO,IAAA,aAAI,EAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC,CAAC;QAC1D,CAAC;KAAA;IAEY,GAAG,CAAC,aAAyC;;YACzD,IAAA,iDAAiC,EAAC,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":"PeerRecovery.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/PeerRecovery/PeerRecovery.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,oBAAoB,CAAC,CAAC,CAAC;IAC1D,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"}