@signageos/front-applet 8.2.1 → 8.2.2

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

@@ -6,6 +6,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Validate_1 = __importDefault(require("../../Validate/Validate"));
 /**
  * The `sos.management.audio` API groups methods for managing audio settings.
+ *
+ * <details>
+ *     <summary>Volume Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `SET_VOLUME` | If device can set volume level |
+ * 		| `GET_VOLUME` | If device can get current volume level |
+ *
+ * 		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 Audio {
     messagePrefix;
@@ -16,9 +26,14 @@ class Audio {
         this.postMessage = postMessage;
     }
     /**
-     * The `getVolume()` method returns current volume level of the device.
+     * The `getVolume()` method returns the current volume level of the device.
      *
+     * @returns {Promise<number>} A promise that resolves to the current volume level, which is a value between 0 and 100.
      * @since 2.0.0
+     *
+     * @example
+     * const currentVolume = await sos.management.audio.getVolume();
+     * console.log(`Current volume level is: ${currentVolume}`); // e.g. 75
      */
     async getVolume() {
         const { volume } = await this.postMessage({
@@ -27,11 +42,17 @@ class Audio {
         return volume;
     }
     /**
-     * The `getVolume()` method set the volume level of the device.
+     * The `setVolume()` method sets the volume level of the device.
      *
      * @param volume Value between 0 and 100.
-     *
+     * @returns {Promise<void>} A promise that resolves when the volume is set.
+     * @throws {Error} If the volume is not a number or is outside the range of 0 to 100.
      * @since 2.0.0
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/volume | Example applet with setting volume}
+     *
+     * @example
+     * await sos.management.audio.setVolume(50);
      */
     async setVolume(volume) {
         (0, Validate_1.default)({ volume }).required().number().min(0).max(100);

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,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"}
+{"version":3,"file":"Audio.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Audio/Audio.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAG/C;;;;;;;;;;;;GAYG;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;;;;;;;;;OASG;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;;;;;;;;;;;;OAYG;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;AAhDD,wBAgDC"}

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

@@ -1,14 +1,60 @@
 import IPostMessage from '../../IPostMessage';
 import IAutoRecovery, { IAutoRecoveryConfiguration } from './IAutoRecovery';
-/** @todo */
+/**
+ * The `sos.management.autoRecovery` API provides methods for managing the auto-recovery feature of the signageOS app.
+ *
+ * The Auto Recovery feature is designed to automatically recover the signageOS app in case of a crash or unexpected shutdown
+ * or switching input to a different value, e.g., HDMI.
+ *
+ * <details>
+ *     <summary>Auto Recovery Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `AUTO_RECOVERY` | If the device can enable or disable the auto recovery function. |
+ *
+ * 		If you want to check if the device supports this capability, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
+ */
 export default class AutoRecovery implements IAutoRecovery {
     private messagePrefix;
     private postMessage;
     /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<IAutoRecoveryConfiguration>);
-    /** @internal */
+    /**
+     * The `get()` method retrieves the current auto-recovery configuration.
+     *
+     * @returns {Promise<IAutoRecoveryConfiguration>} A promise that resolves to the current auto-recovery configuration.
+     * @since 5.0.0
+     *
+     * @example
+     * const autoRecoveryConfig = await sos.management.autoRecovery.get();
+     * if (autoRecoveryConfig.enabled) {
+     *   console.log(`Auto-recovery is enabled with a healthcheck interval of ${autoRecoveryConfig.healthcheckIntervalMs} ms.`);
+     * }
+     */
     get(): Promise<IAutoRecoveryConfiguration>;
-    /** @internal */
+    /**
+     * The `set()` method allows to enable or disable the auto-recovery feature and configure its settings.
+     *
+     * :::note
+     * The configuration object has different properties depending on if enabled is true or false.
+     * :::
+     *
+     * @param configuration The configuration object for auto-recovery settings.
+     * @param configuration.enabled A boolean to set auto-recovery to enabled or disabled state.
+     * @param configuration.autoEnableTimeoutMs The timeout in milliseconds after which the auto-recovery will be automatically enabled if it was disabled.
+     * @param configuration.healthcheckIntervalMs The interval in milliseconds for the health check if application is running in foreground.
+     * @returns {Promise<void>} A promise that resolves when the auto-recovery settings are successfully set.
+     * @throws {Error} If the configuration is invalid.
+     * @since 5.0.0
+     *
+     * @example
+     * // Enable auto-recovery with a healthcheck interval of 5000 ms
+     * await sos.management.autoRecovery.set({
+     * 	enabled: true,
+     * 	healthcheckIntervalMs: 5000,
+     * });
+     */
     set(configuration: IAutoRecoveryConfiguration): Promise<void>;
     private getMessage;
 }

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

@@ -2,7 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const lodash_1 = require("lodash");
 const IAutoRecovery_1 = require("./IAutoRecovery");
-/** @todo */
+/**
+ * The `sos.management.autoRecovery` API provides methods for managing the auto-recovery feature of the signageOS app.
+ *
+ * The Auto Recovery feature is designed to automatically recover the signageOS app in case of a crash or unexpected shutdown
+ * or switching input to a different value, e.g., HDMI.
+ *
+ * <details>
+ *     <summary>Auto Recovery Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `AUTO_RECOVERY` | If the device can enable or disable the auto recovery function. |
+ *
+ * 		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 AutoRecovery {
     messagePrefix;
     postMessage;
@@ -11,7 +25,18 @@ class AutoRecovery {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    /** @internal */
+    /**
+     * The `get()` method retrieves the current auto-recovery configuration.
+     *
+     * @returns {Promise<IAutoRecoveryConfiguration>} A promise that resolves to the current auto-recovery configuration.
+     * @since 5.0.0
+     *
+     * @example
+     * const autoRecoveryConfig = await sos.management.autoRecovery.get();
+     * if (autoRecoveryConfig.enabled) {
+     *   console.log(`Auto-recovery is enabled with a healthcheck interval of ${autoRecoveryConfig.healthcheckIntervalMs} ms.`);
+     * }
+     */
     async get() {
         const settings = await this.postMessage({ type: this.getMessage('get_auto_recovery') });
         if (!settings.enabled) {
@@ -19,7 +44,28 @@ class AutoRecovery {
         }
         return (0, lodash_1.pick)(settings, ['enabled', 'healthcheckIntervalMs']);
     }
-    /** @internal */
+    /**
+     * The `set()` method allows to enable or disable the auto-recovery feature and configure its settings.
+     *
+     * :::note
+     * The configuration object has different properties depending on if enabled is true or false.
+     * :::
+     *
+     * @param configuration The configuration object for auto-recovery settings.
+     * @param configuration.enabled A boolean to set auto-recovery to enabled or disabled state.
+     * @param configuration.autoEnableTimeoutMs The timeout in milliseconds after which the auto-recovery will be automatically enabled if it was disabled.
+     * @param configuration.healthcheckIntervalMs The interval in milliseconds for the health check if application is running in foreground.
+     * @returns {Promise<void>} A promise that resolves when the auto-recovery settings are successfully set.
+     * @throws {Error} If the configuration is invalid.
+     * @since 5.0.0
+     *
+     * @example
+     * // Enable auto-recovery with a healthcheck interval of 5000 ms
+     * await sos.management.autoRecovery.set({
+     * 	enabled: true,
+     * 	healthcheckIntervalMs: 5000,
+     * });
+     */
     async set(configuration) {
         (0, IAutoRecovery_1.validateAutoRecoveryConfiguration)(configuration);
         await this.postMessage({ type: this.getMessage('set_auto_recovery'), ...configuration });

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,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"}
+{"version":3,"file":"AutoRecovery.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/AutoRecovery/AutoRecovery.ts"],"names":[],"mappings":";;AAAA,mCAA8B;AAE9B,mDAA+G;AAE/G;;;;;;;;;;;;;;GAcG;AACH,MAAqB,YAAY;IAGvB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAAqD;QADrD,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAA0C;IAC3D,CAAC;IAEJ;;;;;;;;;;;OAWG;IACI,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;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,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;AAzDD,+BAyDC"}

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

@@ -1,7 +1,20 @@
 import IPostMessage from '../../IPostMessage';
 import IDebug from './IDebug';
 /**
- * The `sos.management.debug` API groups together method for working with native debug mode.
+ * The `sos.management.debug` API groups together methods for working with native debug mode.
+ *
+ * :::note
+ * Some modern systems might require additional steps to enable the native debug mode. Please refer to the [native debug documentation](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) for more information.
+ * :::
+ *
+ * <details>
+ *     <summary>Debug Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `SET_DEBUG` | If the device can enable or disable the native debug mode. |
+ *
+ * 		If you want to check if the device supports this capability, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 export default class Debug implements IDebug {
     private messagePrefix;
@@ -11,21 +24,50 @@ export default class Debug implements IDebug {
     /**
      * The `enable()` method enables the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode.
      *
+     * @returns {Promise<void>} A promise that resolves when the debug mode is enabled.
      * @since 3.0.0
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/debug | Example applet with activating debug mode}
+     *
+     * @example
+     * await sos.management.debug.enable();
      */
     enable(): Promise<void>;
     /**
      * The `enable()` method disables the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode.
      *
+     * @returns {Promise<void>} A promise that resolves when the debug mode is disabled.
      * @since 3.0.0
+     *
+     * @example
+     * await sos.management.debug.disable();
      */
     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.
      *
+     * @returns {Promise<boolean>} A promise that resolves to `true` if the debug mode is enabled, otherwise `false`.
      * @since 4.1.0
+     *
+     * @example
+     * const isDebugEnabled = await sos.management.debug.isEnabled();
+     * console.log(`Native debug mode is ${isDebugEnabled ? 'enabled' : 'disabled'}.`);
      */
     isEnabled(): Promise<boolean>;
-    private setDebug;
+    /**
+     * The `setDebug(enabled)` method sets the native debug mode to the specified state.
+     *
+     * @param enabled `true` to enable the debug mode, `false` to disable it.
+     * @returns {Promise<void>} A promise that resolves when the debug mode is set.
+     * @throws {Error} If the `enabled` parameter is not a boolean.
+     * @since 4.1.0
+     *
+     * @example
+     * const enabled = await sos.management.debug.isEnabled();
+     * if (!enabled) {
+     *  await sos.management.debug.setDebug(true);
+     * }
+     */
+    setDebug(enabled: boolean): Promise<void>;
     private getMessage;
 }

package/es6/FrontApplet/Management/Debug/Debug.js

@@ -5,7 +5,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const Validate_1 = __importDefault(require("../../Validate/Validate"));
 /**
- * The `sos.management.debug` API groups together method for working with native debug mode.
+ * The `sos.management.debug` API groups together methods for working with native debug mode.
+ *
+ * :::note
+ * Some modern systems might require additional steps to enable the native debug mode. Please refer to the [native debug documentation](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) for more information.
+ * :::
+ *
+ * <details>
+ *     <summary>Debug Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `SET_DEBUG` | If the device can enable or disable the native debug mode. |
+ *
+ * 		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 Debug {
     messagePrefix;
@@ -18,7 +31,13 @@ class Debug {
     /**
      * The `enable()` method enables the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode.
      *
+     * @returns {Promise<void>} A promise that resolves when the debug mode is enabled.
      * @since 3.0.0
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/debug | Example applet with activating debug mode}
+     *
+     * @example
+     * await sos.management.debug.enable();
      */
     async enable() {
         await this.setDebug(true);
@@ -26,7 +45,11 @@ class Debug {
     /**
      * The `enable()` method disables the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode.
      *
+     * @returns {Promise<void>} A promise that resolves when the debug mode is disabled.
      * @since 3.0.0
+     *
+     * @example
+     * await sos.management.debug.disable();
      */
     async disable() {
         await this.setDebug(false);
@@ -34,7 +57,12 @@ class Debug {
     /**
      * The `isEnabled()` method returns whether the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode is enabled.
      *
+     * @returns {Promise<boolean>} A promise that resolves to `true` if the debug mode is enabled, otherwise `false`.
      * @since 4.1.0
+     *
+     * @example
+     * const isDebugEnabled = await sos.management.debug.isEnabled();
+     * console.log(`Native debug mode is ${isDebugEnabled ? 'enabled' : 'disabled'}.`);
      */
     async isEnabled() {
         const { isEnabled } = await this.postMessage({
@@ -42,6 +70,20 @@ class Debug {
         });
         return isEnabled;
     }
+    /**
+     * The `setDebug(enabled)` method sets the native debug mode to the specified state.
+     *
+     * @param enabled `true` to enable the debug mode, `false` to disable it.
+     * @returns {Promise<void>} A promise that resolves when the debug mode is set.
+     * @throws {Error} If the `enabled` parameter is not a boolean.
+     * @since 4.1.0
+     *
+     * @example
+     * const enabled = await sos.management.debug.isEnabled();
+     * if (!enabled) {
+     *  await sos.management.debug.setDebug(true);
+     * }
+     */
     async setDebug(enabled) {
         (0, Validate_1.default)({ enabled }).required().boolean();
         await this.postMessage({

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

@@ -1 +1 @@
-{"version":3,"file":"Debug.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Debug/Debug.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,MAAM;QAClB,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;SACnC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACtC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAjDD,wBAiDC"}
+{"version":3,"file":"Debug.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Debug/Debug.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;;;;;;;;;;OAUG;IACI,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;SACnC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACrC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA9ED,wBA8EC"}

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

@@ -2,6 +2,25 @@ import IPostMessage from '../../IPostMessage';
 import IFirmware from './IFirmware';
 /**
  * The `sos.management.firmware` API groups together methods for working with the firmware of the device.
+ *
+ * :::warning
+ * Always check if your absolute firmware URL ends with a firmware file. Example: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw`
+ * :::
+ *
+ * :::info
+ * For BrightSign firmware upgrade, please ensure that you have a text file with the SHA1 hash of that firmware file.
+ * - Firmware file path: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw`
+ * - SHA1 txt file: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw.sha1.txt`
+ * :::
+ *
+ * <details>
+ *     <summary>Firmware Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `FIRMWARE_UPGRADE` | If device can upgrade firmware version |
+ *
+ * 		If you want to check if the device supports this capability, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 export default class Firmware implements IFirmware {
     private messagePrefix;
@@ -15,18 +34,20 @@ export default class Firmware implements IFirmware {
      *
      * @param version The version of the firmware being installed.
      * @param [baseUrl='https://2.signageos.io'] Optional server URL where firmware files are located.
-     *
+     * @returns {Promise<void>} A promise that resolves when the firmware upgrade is initiated.
      * @since 4.0.0
+     *
+     * @example
+     * await sos.management.firmware.upgrade('T-HKMLAKUC-2080.4');
      */
     upgrade(version: string, baseUrl?: string): Promise<void>;
     /**
      * The `upgrade(baseUrl, version)` does the same as `upgrade(version, baseUrl)`.
      *
      * @alias upgrade(version: string, baseUrl?: string)
-     *
      * @param baseUrl The server URL where firmware files are located.
      * @param version The version of the firmware being installed.
-     *
+     * @returns {Promise<void>} A promise that resolves when the firmware upgrade is initiated.
      * @since 4.0.0
      *
      * @example
@@ -46,9 +67,11 @@ export default class Firmware implements IFirmware {
      * - Android: http://example.com/fw/FB-00.0.0.zip
      *
      * @param fwUri FQN uri where the firmware main file is located.
-     *
+     * @returns {Promise<void>} A promise that resolves when the firmware upgrade is initiated.
      * @since 4.0.0
      *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/firmware | Example applet with firmware upgrade}
+     *
      * @example
      * await sos.management.firmware.upgrade('https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem');
      */
@@ -56,6 +79,7 @@ export default class Firmware implements IFirmware {
     /**
      * The `getVersion()` method returns the version of the firmware currently installed on the device.
      *
+     * @returns {Promise<string>} A promise that resolves to the current firmware version.
      * @since 4.0.0
      *
      * @example
@@ -68,6 +92,19 @@ export default class Firmware implements IFirmware {
      *
      * This information, when combined with firmware version, can be used to identify a correct firmware image to install on the current device.
      *
+     * <details>
+     *     <summary>Linux and Android prefixes</summary>
+     * 		| Type | Description |
+     * 		|:------------|:-------------|
+     * 		| `rpi` | Any Raspberry Pi 3 or Compute Module 3 |
+     * 		| `rpi4` | Any Raspberry Pi 4 or Compute Module 4 |
+     * 		| `benq-` | Any Benq display |
+     * 		| `philips-` | Any Philips display |
+     * 		| `sharp-` | Any Sharp display |
+     * 		| `elo-` | Any Elo display |
+     * </details>
+     *
+     * @returns {Promise<string>} A promise that resolves to the current firmware type.
      * @since 4.8.0
      *
      * @example

package/es6/FrontApplet/Management/Firmware/Firmware.js

@@ -3,6 +3,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const UpgradeHelper_1 = require("../helpers/UpgradeHelper");
 /**
  * The `sos.management.firmware` API groups together methods for working with the firmware of the device.
+ *
+ * :::warning
+ * Always check if your absolute firmware URL ends with a firmware file. Example: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw`
+ * :::
+ *
+ * :::info
+ * For BrightSign firmware upgrade, please ensure that you have a text file with the SHA1 hash of that firmware file.
+ * - Firmware file path: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw`
+ * - SHA1 txt file: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw.sha1.txt`
+ * :::
+ *
+ * <details>
+ *     <summary>Firmware Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `FIRMWARE_UPGRADE` | If device can upgrade firmware version |
+ *
+ * 		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 Firmware {
     messagePrefix;
@@ -25,6 +44,7 @@ class Firmware {
     /**
      * The `getVersion()` method returns the version of the firmware currently installed on the device.
      *
+     * @returns {Promise<string>} A promise that resolves to the current firmware version.
      * @since 4.0.0
      *
      * @example
@@ -42,6 +62,19 @@ class Firmware {
      *
      * This information, when combined with firmware version, can be used to identify a correct firmware image to install on the current device.
      *
+     * <details>
+     *     <summary>Linux and Android prefixes</summary>
+     * 		| Type | Description |
+     * 		|:------------|:-------------|
+     * 		| `rpi` | Any Raspberry Pi 3 or Compute Module 3 |
+     * 		| `rpi4` | Any Raspberry Pi 4 or Compute Module 4 |
+     * 		| `benq-` | Any Benq display |
+     * 		| `philips-` | Any Philips display |
+     * 		| `sharp-` | Any Sharp display |
+     * 		| `elo-` | Any Elo display |
+     * </details>
+     *
+     * @returns {Promise<string>} A promise that resolves to the current firmware type.
      * @since 4.8.0
      *
      * @example

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

@@ -1 +1 @@
-{"version":3,"file":"Firmware.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Firmware/Firmware.ts"],"names":[],"mappings":";;AACA,4DAAiE;AAGjE;;GAEG;AACH,MAAqB,QAAQ;IAGnB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAkDJ,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,kBAAkB,CAAC;YACzC,OAAO;YACP,OAAO;YACP,SAAS;SACT,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,UAAU;QACtB,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;;;;;;;;;;OAUG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC/C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;QACH,OAAO,YAAY,CAAC;IACrB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAxGD,2BAwGC"}
+{"version":3,"file":"Firmware.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Firmware/Firmware.ts"],"names":[],"mappings":";;AACA,4DAAiE;AAGjE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAqB,QAAQ;IAGnB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAsDJ,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,kBAAkB,CAAC;YACzC,OAAO;YACP,OAAO;YACP,SAAS;SACT,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,UAAU;QACtB,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;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC/C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;QACH,OAAO,YAAY,CAAC;IACrB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA1HD,2BA0HC"}