@signageos/front-applet 8.2.1 → 8.2.2

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

@@ -6,13 +6,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const INetworkInfo_1 = require("./INetworkInfo");
 const Validate_1 = __importDefault(require("../../Validate/Validate"));
 /**
- * The `sos.management.network` API groups together methods for networking.
+ * The `sos.management.network` API groups together networking methods. For Wi-Fi setup, use the [Wi-Fi API](https://developers.signageos.io/sdk/sos_management/wifi).
  *
- * :::info
+ * <details>
+ *     <summary>Network Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `NETWORK_INFO` | If device supports returning network information |
  *
- * Use `sos.management.supports('NETWORK_INFO')` to check if the device supports managing the network setup.
- *
- * :::
+ * 		If you want to check if the device supports this capability, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 class Network {
     messagePrefix;
@@ -30,11 +33,19 @@ class Network {
         return networkInfo;
     }
     /**
-     * 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.
+     * The `listInterface()` method returns a list of all network interfaces, and their information like MAC address, IP address, etc.
+     * Wi-Fi connection strength is described as a percentage in the range from 0 to 100, linearly converted from dBm -90 to -30, respectively, based on the platform.
      *
+     * @returns {Promise<INetworkInterface[]>} Resolves to an array of network interfaces with their information.
      * @since 4.9.0
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/network | Applet Example with Network Interfaces}
+     *
+     * @example
+     * const interfaces = await sos.management.network.listInterfaces();
+     * interfaces.forEach((iface) => {
+     *    console.log(`Interface: ${iface.name}, IP: ${iface.ipAddress}, MAC: ${iface.macAddress}`);
+     * });
      */
     async listInterfaces() {
         const { interfaces } = await this.postMessage({
@@ -83,17 +94,20 @@ class Network {
         }
     }
     /**
-     * The `disableInterface()` disables a network interface.
+     * The `disableInterface()` turns off a selected network interface.
      *
      * :::warning
-     *
-     * Don't use this method to disable Wi-Fi. Use [Wi-Fi API](./wifi) to enable/disable Wi-Fi.
-     *
+     * Don't use this method to disable Wi-Fi. Use [Wi-Fi API](https://developers.signageos.io/sdk/sos_management/wifi) to turn Wi-Fi on/off.
      * :::
      *
-     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
-     *
+     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by `listInterfaces()`
+     * @return {Promise<void>} A promise that resolves when the network interface is disabled.
+     * @throws {Error} If the interface name is invalid.
+     * @throws {Error} If the device does not support network management.
      * @since 4.13.0
+     *
+     * @example
+     * await sos.management.network.disableInterface('eth0');
      */
     async disableInterface(interfaceName) {
         (0, Validate_1.default)({ interfaceName }).required().string();

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,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"}
+{"version":3,"file":"Network.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Network/Network.ts"],"names":[],"mappings":";;;;;AACA,iDAQwB;AACxB,uEAA+C;AAG/C;;;;;;;;;;;GAWG;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;;;;;;;;;;;;;;OAcG;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;IAyBD,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;IAqBD,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;;;;;;;;;;;;;;;OAeG;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;AAnJD,0BAmJC"}

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

@@ -1,4 +1,7 @@
 import IOSInfo from './IOSInfo';
+/**
+ * Returned object from `getMemoryUsage()` method.
+ */
 export interface SystemMemoryInfo {
     used: number;
     total: number;

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

@@ -3,6 +3,17 @@ import IOSInfo from './IOSInfo';
 import IOS, { SystemMemoryInfo } from './IOS';
 /**
  * The `sos.management.os` API groups together methods for retrieving information about the system.
+ *
+ *
+ * <details>
+ *     <summary>OS Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `SYSTEM_CPU` | If device supports collecting CPU usage information |
+ * 		| `SYSTEM_MEMORY` | If device supports collecting memory usage information |
+ *
+ * 		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 export default class OS implements IOS {
     private messagePrefix;
@@ -10,22 +21,39 @@ export default class OS implements IOS {
     /** @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.
+     * The `getInfo()` method returns info about the system of the device, such as what current version of it is installed on the device. Major
+     * version of the current operating system. It's usually 1 or 2 digits, including or excluding dot notation.
      *
+     * @returns {Promise<IOSInfo>} Resolves to an object containing information about the operating system.
      * @since 5.0.0
+     *
+     * @example
+     * const osInfo = await sos.management.os.getInfo();
+     * console.log(`Current OS version is: ${osInfo.version}`);
      */
     getInfo(): Promise<IOSInfo>;
     /**
-     * The `getCpuUsage()` method returns current CPU usage (ranging 0-100).
+     * The `getCpuUsage()` method returns the current total CPU usage (ranging from 0 to 100%).
      *
+     * @throws {Error} If the CPU usage is not supported.
+     * @returns {Promise<number>} Resolves to the current CPU usage percentage.
      * @since 5.4.0
+     *
+     * @example
+     * const cpuUsage = await sos.management.os.getCpuUsage();
+     * console.log(`Current CPU usage is: ${cpuUsage}%`);
      */
     getCpuUsage(): Promise<number>;
     /**
-     * The `getMemoryUsage()` method returns total memory amount in bytes, currently used memory and remaining free memory.
+     * The `getMemoryUsage()` method returns the total memory amount in bytes, the currently used memory, and the remaining free memory.
      *
+     * @throws {Error} If the memory usage is not supported.
+     * @returns {Promise<SystemMemoryInfo>} Resolves to an object containing total, used, and free memory in bytes.
      * @since 5.4.0
+     *
+     * @example
+     * const memoryUsage = await sos.management.os.getMemoryUsage();
+     * console.log(`Memory usage: ${((memoryUsage.used / memoryUsage.total) * 100).toFixed(2)}%`);
      */
     getMemoryUsage(): Promise<SystemMemoryInfo>;
     private getMessage;

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

@@ -2,6 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * The `sos.management.os` API groups together methods for retrieving information about the system.
+ *
+ *
+ * <details>
+ *     <summary>OS Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `SYSTEM_CPU` | If device supports collecting CPU usage information |
+ * 		| `SYSTEM_MEMORY` | If device supports collecting memory usage information |
+ *
+ * 		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 class OS {
     messagePrefix;
@@ -12,10 +23,15 @@ class OS {
         this.postMessage = postMessage;
     }
     /**
-     * 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.
+     * The `getInfo()` method returns info about the system of the device, such as what current version of it is installed on the device. Major
+     * version of the current operating system. It's usually 1 or 2 digits, including or excluding dot notation.
      *
+     * @returns {Promise<IOSInfo>} Resolves to an object containing information about the operating system.
      * @since 5.0.0
+     *
+     * @example
+     * const osInfo = await sos.management.os.getInfo();
+     * console.log(`Current OS version is: ${osInfo.version}`);
      */
     async getInfo() {
         const { osInfo } = await this.postMessage({
@@ -24,9 +40,15 @@ class OS {
         return osInfo;
     }
     /**
-     * The `getCpuUsage()` method returns current CPU usage (ranging 0-100).
+     * The `getCpuUsage()` method returns the current total CPU usage (ranging from 0 to 100%).
      *
+     * @throws {Error} If the CPU usage is not supported.
+     * @returns {Promise<number>} Resolves to the current CPU usage percentage.
      * @since 5.4.0
+     *
+     * @example
+     * const cpuUsage = await sos.management.os.getCpuUsage();
+     * console.log(`Current CPU usage is: ${cpuUsage}%`);
      */
     async getCpuUsage() {
         const { cpuUsage } = await this.postMessage({
@@ -35,9 +57,15 @@ class OS {
         return cpuUsage;
     }
     /**
-     * The `getMemoryUsage()` method returns total memory amount in bytes, currently used memory and remaining free memory.
+     * The `getMemoryUsage()` method returns the total memory amount in bytes, the currently used memory, and the remaining free memory.
      *
+     * @throws {Error} If the memory usage is not supported.
+     * @returns {Promise<SystemMemoryInfo>} Resolves to an object containing total, used, and free memory in bytes.
      * @since 5.4.0
+     *
+     * @example
+     * const memoryUsage = await sos.management.os.getMemoryUsage();
+     * console.log(`Memory usage: ${((memoryUsage.used / memoryUsage.total) * 100).toFixed(2)}%`);
      */
     async getMemoryUsage() {
         const { memoryUsage } = await this.postMessage({

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;;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"}
+{"version":3,"file":"OS.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/OS/OS.ts"],"names":[],"mappings":";;AAIA;;;;;;;;;;;;;GAaG;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;;;;;;;;;;OAUG;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;;;;;;;;;;OAUG;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;;;;;;;;;;OAUG;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;AAnED,qBAmEC"}

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

@@ -1,7 +1,17 @@
 import IPostMessage from '../../IPostMessage';
 import IPackage from './IPackage';
 /**
- * The `sos.management.package` API groups together methods for installing and stopping custom Android packages.
+ * The `sos.management.package` API groups together methods for installing custom Android packages.
+ *
+ * <details>
+ *     <summary>Package Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `PACKAGE_INSTALL` | If device supports installing packages |
+ * 		| `STOP_PACKAGE` | If device supports stopping packages |
+ *
+ * 		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 export default class Package implements IPackage {
     private messagePrefix;
@@ -9,12 +19,17 @@ export default class Package implements IPackage {
     /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     /**
-     * The `install()` method installs a certain package from the specified url.
+     * The `install()` method installs a particular package from the specified URL.
      *
      * @param baseUrl URL where the package is available
-     * @param packageName Name of the android package
+     * @param packageName Name of the Android package
      * @param version Package version
      * @param build If relevant for your device
+     * @returns {Promise<void>} A promise that resolves when the package is successfully installed.
+     * @throws {Error} If `baseUrl` is not a valid URL
+     * @throws {Error} If `packageName` is not a string
+     * @throws {Error} If `version` is not a string
+     * @throws {Error} If `build` is not a string or null
      */
     install(baseUrl: string, packageName: string, version: string, build: string | null): Promise<void>;
     /**

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

@@ -5,7 +5,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const Validate_1 = __importDefault(require("../../Validate/Validate"));
 /**
- * The `sos.management.package` API groups together methods for installing and stopping custom Android packages.
+ * The `sos.management.package` API groups together methods for installing custom Android packages.
+ *
+ * <details>
+ *     <summary>Package Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `PACKAGE_INSTALL` | If device supports installing packages |
+ * 		| `STOP_PACKAGE` | If device supports stopping packages |
+ *
+ * 		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 class Package {
     messagePrefix;
@@ -15,14 +25,18 @@ class Package {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    // TODO: build param
     /**
-     * The `install()` method installs a certain package from the specified url.
+     * The `install()` method installs a particular package from the specified URL.
      *
      * @param baseUrl URL where the package is available
-     * @param packageName Name of the android package
+     * @param packageName Name of the Android package
      * @param version Package version
      * @param build If relevant for your device
+     * @returns {Promise<void>} A promise that resolves when the package is successfully installed.
+     * @throws {Error} If `baseUrl` is not a valid URL
+     * @throws {Error} If `packageName` is not a string
+     * @throws {Error} If `version` is not a string
+     * @throws {Error} If `build` is not a string or null
      */
     async install(baseUrl, packageName, version, build) {
         (0, Validate_1.default)({ baseUrl }).required().uri();

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,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;;;;;;;OAOG;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;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,IAAI,CAAC,WAAmB;QACpC,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC9C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;YACrC,WAAW;SACX,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IAChB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAnDD,0BAmDC"}
+{"version":3,"file":"Package.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Package/Package.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAG/C;;;;;;;;;;;;GAYG;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;;;;;;;;;;;;OAYG;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;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,IAAI,CAAC,WAAmB;QACpC,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC9C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;YACrC,WAAW;SACX,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IAChB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAvDD,0BAuDC"}

package/es6/FrontApplet/Management/Power/IPower.d.ts

@@ -1,5 +1,8 @@
 import { ITimer, TimerType } from '../helpers/TimerHelper';
 import { IProprietaryTimer, ProprietaryTimerType } from '../helpers/ProprietaryTimerHelper';
+/**
+ * Interface representing the scheduled reboot action.
+ */
 export interface IScheduledRebootActions {
     id: string;
     rule: IScheduledRebootRule;

package/es6/FrontApplet/Management/Power/IPower.js.map

@@ -1 +1 @@
-{"version":3,"file":"IPower.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Power/IPower.ts"],"names":[],"mappings":";;;AAeA;;;GAGG;AACH,IAAY,eAQX;AARD,WAAY,eAAe;IAC1B,yDAAU,CAAA;IACV,yDAAU,CAAA;IACV,2DAAW,CAAA;IACX,+DAAa,CAAA;IACb,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,6DAAY,CAAA;AACb,CAAC,EARW,eAAe,+BAAf,eAAe,QAQ1B;AAED,IAAY,YAQX;AARD,WAAY,YAAY;IACvB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;IACrB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;AACtB,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB"}
+{"version":3,"file":"IPower.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Power/IPower.ts"],"names":[],"mappings":";;;AAuBA;;;GAGG;AACH,IAAY,eAQX;AARD,WAAY,eAAe;IAC1B,yDAAU,CAAA;IACV,yDAAU,CAAA;IACV,2DAAW,CAAA;IACX,+DAAa,CAAA;IACb,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,6DAAY,CAAA;AACb,CAAC,EARW,eAAe,+BAAf,eAAe,QAQ1B;AAED,IAAY,YAQX;AARD,WAAY,YAAY;IACvB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;IACrB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;AACtB,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB"}

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

@@ -5,6 +5,19 @@ import IPower, { IScheduledRebootActions, WeekdayType } from './IPower';
 /**
  * The `sos.management.power` API groups together methods related to the power state of the device. Such as rebooting, shutting down,
  * setting timers.
+ *
+ * <details>
+ *     <summary>Power Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `SYSTEM_REBOOT` | If device supports system reboot power action |
+ * 		| `APP_RESTART` | If device supports app restart power action |
+ * 		| `TIMERS_PROPRIETARY` | If device supports proprietary timers |
+ * 		| `TIMERS_NATIVE` | If device supports native timers |
+ * 		| `SCHEDULE_POWER_ACTION` | If device supports scheduled power actions |
+ *
+ * 		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 export default class Power implements IPower {
     private messagePrefix;
@@ -14,8 +27,11 @@ export default class Power implements IPower {
     /**
      * The `systemReboot()` method initializes a system reboot.
      *
+     * @returns {Promise<void>} Resolves when the system reboot is initiated.
      * @since 3.0.0
      *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/system-reboot | Applet Example for System Reboot}
+     *
      * @example
      * await sos.management.power.systemReboot();
      */
@@ -23,6 +39,7 @@ export default class Power implements IPower {
     /**
      * The `appRestart()` method initializes a restart of the signageOS app.
      *
+     * @returns {Promise<void>} Resolves when the app restart is initiated.
      * @since 3.0.0
      *
      * @example
@@ -32,32 +49,43 @@ export default class Power implements IPower {
     /**
      * The `getTimers()` method returns a list of currently set native timers.
      *
+     * @returns {Promise<ITimer[]>} Resolves with an array of timers.
      * @since 4.0.0
      *
      * @example
-     * const timers = await sos.management.power.getTimers();
+     * await sos.management.power.getTimers();
      */
     getTimers(): Promise<ITimer[]>;
     /**
-     * The `setTimers()` method creates or updates a native timer.
+     * The `setTimer()` method creates or updates a native timer.
      *
      * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
      * @param timeOn The time when the device should turn on.
      * @param timeOff The time when the device should turn off.
      * @param weekdays The days of the week when the timer should be active (`mon`, ..., `sun`).
      * @param volume The volume level set when the device is turned on.
-     *
+     * @return {Promise<void>} Resolves when the timer is set.
+     * @throws {Error} If the timer type is invalid.
+     * @throws {Error} If the time format is incorrect.
+     * @throws {Error} If the weekdays array contains an invalid weekday.
+     * @throws {Error} If the `volume` parameter is not a number between 0 and 100.
+     * @throws {Error} If the `timeOn` or `timeOff` parameters do not match the expected time format (`HH:mm:ss`).
+     * @throws {Error} If the `weekdays` parameter is not an array of strings.
+     * @throws {Error} If the `type` parameter is not a valid timer type (e.g., `TIMER_1`, `TIMER_2`, ..., `TIMER_7`).
      * @since 3.0.0
      *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/timer | Applet Example for Native Timers}
+     *
      * @example
-     * await sos.management.power.setTimer("TIMER_1", "08:00", "22:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], 30);
+     * await sos.management.power.setTimer("TIMER_1", "08:00:00", "22:00:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], 30);
      */
     setTimer(type: keyof typeof TimerType, timeOn: string | null, timeOff: string | null, weekdays: string[], volume: number): Promise<void>;
     /**
      * The `unsetTimer()` method removes the specified native timer.
      *
      * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
-     *
+     * @returns {Promise<void>} Resolves when the timer is removed.
+     * @throws {Error} If the timer type is invalid.
      * @since 4.0.0
      *
      * @example
@@ -68,6 +96,8 @@ export default class Power implements IPower {
      * The `getProprietaryTimers()` method returns a list of currently set
      * [proprietary timers](https://docs.signageos.io/hc/en-us/articles/4416384202642-Timers#h_01HCD14GEDP96AZV58NRSN2HNQ).
      *
+     * @returns {Promise<IProprietaryTimer[]>} Resolves with an array of proprietary timers.
+     * @throws {Error} If the timers cannot be retrieved.
      * @since 5.10.0
      *
      * @example
@@ -83,11 +113,19 @@ export default class Power implements IPower {
      * @param timeOff The time when the device should turn off.
      * @param weekdays The days of the week when the timer should be active (`mon`, ..., `sun`).
      * @param keepAppletRunning If `true`, the applet will be kept running when the timer is active on certain devices.
-     *
+     * @return {Promise<void>} Resolves when the proprietary timer is set.
+     * @throws {Error} If the timer type is invalid or if the time format is incorrect.
+     * @throws {Error} If the weekdays array contains an invalid weekday.
+     * @throws {Error} If the `keepAppletRunning` parameter is not a boolean.
+     * @throws {Error} If the `timeOn` or `timeOff` parameters do not match the expected time format (`HH:mm:ss`).
+     * @throws {Error} If the `weekdays` parameter is not an array of strings.
+     * @throws {Error} If the `weekdays` array contains an invalid weekday.
+     * @throws {Error} If the `timeOn` or `timeOff` parameters do not match the expected time format (`HH:mm:ss`).
+     * @throws {Error} If the `type` parameter is not a valid timer type (e.g., `TIMER_1`, `TIMER_2`, ..., `TIMER_7`).
      * @since 5.10.0
      *
      * @example
-     * await sos.management.power.setProprietaryTimer("TIMER_20", "08:00", "22:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], 30);
+     * await sos.management.power.setProprietaryTimer("TIMER_2", "08:00:00", "22:00:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], false);
      */
     setProprietaryTimer(type: ProprietaryTimerType, timeOn: string | null, timeOff: string | null, weekdays: string[], keepAppletRunning?: boolean): Promise<void>;
     /**
@@ -95,7 +133,8 @@ export default class Power implements IPower {
      * [proprietary timer](https://docs.signageos.io/hc/en-us/articles/4416384202642-Timers#h_01HCD14GEDP96AZV58NRSN2HNQ).
      *
      * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
-     *
+     * @returns {Promise<void>} Resolves when the proprietary timer is removed.
+     * @throws {Error} If the timer type is invalid.
      * @since 5.10.0
      *
      * @example
@@ -105,6 +144,7 @@ export default class Power implements IPower {
     /**
      * Removes all scheduled reboot rules from the device.
      *
+     * @returns {Promise<void>} Resolves when all scheduled reboots are cleared.
      * @since 8.1.0
      *
      * @example
@@ -112,8 +152,9 @@ export default class Power implements IPower {
      */
     clearScheduledReboots(): Promise<void>;
     /**
-     * Returns all scheduled reboot rules on the device.
+     * Returns all scheduled reboot rules on the device set by the `setScheduledReboot()` method.
      *
+     * @returns {Promise<IScheduledRebootActions[]>} Resolves with an array of scheduled reboot actions.
      * @since 8.1.0
      *
      * @example
@@ -121,31 +162,37 @@ export default class Power implements IPower {
      */
     getScheduledReboots(): Promise<IScheduledRebootActions[]>;
     /**
-     * Removes scheduled reboot rule from the device.
-     * @param id {string} - ID of the rule to be removed.
-     *
+     * Removes scheduled reboot rule from the device (if it exists).
+     * @param id {string} ID of the rule to be removed.
+     * @throws {Error} If the `id` is not a string or is empty.
+     * @returns {Promise<void>} Resolves when the scheduled reboot is removed.
      * @since 8.1.0
      *
      * @example
      * // Get scheduled reboots
      * const scheduledReboots = await sos.management.power.getScheduledReboots();
      *
-     * // Remove scheduled reboot
+     * // Remove scheduled reboot on the first position
      * await sos.management.power.removeScheduledReboot(scheduledReboots[0].id);
      */
     removeScheduledReboot(id: string): Promise<void>;
     /**
-     * Schedule automatic reboot on the device. Calling this function will create one rule.
-     * It is possible to set multiple rules, which can be later obtained by `getScheduledReboots` function.
+     * Schedule an automatic reboot on the device. Calling this function will create one rule.
+     * It is possible to set multiple rules, which can be later obtained by the `getScheduledReboots` function.
      *
      * :::note
-     * - Setting new scheduled reboot on device might take up to 10 minutes to show in Box.
-     * - Every new scheduled reboot rule gets unique identifier generated by device, it might be later returned by `getScheduledReboots()`.
+     * - Setting a new scheduled reboot on the device might take up to 10 minutes to show in the Box.
+     * - Every new scheduled reboot rule gets a unique identifier generated by the device, which might be later returned by `getScheduledReboots()`.
      * :::
      *
-     * @param weekdays {@link WeekdayType[]} - Array of weekdays when the reboot should be executed.
-     * @param time {string} - Time when the reboot should be executed. Format is `HH:mm:ss`.
-     *
+     * @param weekdays {@link WeekdayType[]} Array of weekdays when the reboot should be executed.
+     * @param time {string} Time when the reboot should be executed. Format is `HH:mm:ss`.
+     * @throws {Error} If the `weekdays` parameter is not an array of strings.
+     * @throws {Error} If the `time` parameter does not match the expected time format (`HH:mm:ss`).
+     * @throws {Error} If the `weekdays` array contains an invalid weekday.
+     * @throws {Error} If the `time` parameter is not a string or does not match the expected format (`HH:mm:ss`).
+     * @throws {Error} If the `weekdays` array is empty or contains invalid values.
+     * @returns {Promise<void>} Resolves when the scheduled reboot is set.
      * @since 8.1.0
      *
      * @example