@signageos/front-applet 8.1.2 → 8.1.4

package/es6/FrontApplet/Command/Command.d.ts

@@ -3,7 +3,9 @@ import IPostMessage from '../IPostMessage';
 import ICommandDispatchToAppletMessage from './ICommandDispatchToAppletMessage';
 import ICommandEvent from './ICommandEvent';
 /**
- * The `sos.command` API groups together methods for sending logs and receiving commands from signageOS.
+ * In some cases, you might be interested in a complete log of what the device was doing during its operation. All of your business or technical logs can be stored in our storage for later usage. You can identify which events happened or even trigger self-repairing logic.
+ *
+ * All commands will be available in [Applet Command REST API](https://developers.signageos.io/api/#tag/DeviceApplet-Command) and can be downloaded historically as [CSV export](https://developers.signageos.io/api/#tag/DeviceMonitoring/paths/~1v1~1device~1%7BdeviceUid%7D~1report/get).
  */
 export default class Command {
     private messagePrefix;
@@ -16,16 +18,21 @@ export default class Command {
      * The `dispatch()` method dispatches a new log record to the signageOS.
      *
      * :::warning[Dispatch throttling]
-     *
      * Sending commands from an applet is throttled, this means that after if the dispatch frequency is too high, some commands may be
-     * discarded. Currently the limit is 30 commands per 30 seconds, although this may not be fully accurate and it's not possible to know the
+     * discarded. Currently, the limit is 30 commands per 30 seconds, although this may not be fully accurate, and it's not possible to know the
      * exact limit.
-     *
      * :::
      *
+     * @param command The command to be dispatched.
+     * @throws {AppletCommandError} If type contains invalid characters, allowed to are `/^[a-zA-Z0-9\.\-_]+$/g`
+     * @throws {AppletCommandError} If the command type is longer then 100 characters limit.
+     * @throws {AppletCommandError} If the command is not an object or is missing required properties.
      * @since 1.0.3
      *
-     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/sending/ |Sending commands}
+     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/sending/ | Sending commands in Applet}
+     * @example // {@link https://developers.signageos.io/api/#tag/DeviceApplet-Command/paths/~1v1~1device~1%7BdeviceUid%7D~1applet~1%7BappletUid%7D~1command/post | Rest API - Dispatching commands}
+     * @example // {@link https://developers.signageos.io/api/#tag/DeviceApplet-Command/paths/~1v1~1device~1%7BdeviceUid%7D~1applet~1command/get | Rest API - Get commands}
+     * @example // {@link https://developers.signageos.io/api/#tag/DeviceMonitoring/paths/~1v1~1device~1%7BdeviceUid%7D~1report/get | Rest API - Receiving historical data}
      *
      * @example
      * await sos.command.dispatch({
@@ -38,9 +45,11 @@ export default class Command {
     /**
      * The `onCommand()` method sets up a listener, which is called whenever a new command from signageOS is received.
      *
+     * @param listener The listener to be called when a new command is received.
+     * @returns {void} Resolves when the listener is successfully set up.
      * @since 1.0.3
      *
-     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/receiving |Receiving commands}
+     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/receiving | Receiving commands in Applet}
      */
     onCommand(listener: (command: ICommandEvent) => void): void;
     /** @internal */

package/es6/FrontApplet/Command/Command.js

@@ -9,7 +9,9 @@ const ErrorCodes_1 = __importDefault(require("../Error/ErrorCodes"));
 const ErrorSuggestions_1 = __importDefault(require("../Error/ErrorSuggestions"));
 const Validate_1 = __importDefault(require("../Validate/Validate"));
 /**
- * The `sos.command` API groups together methods for sending logs and receiving commands from signageOS.
+ * In some cases, you might be interested in a complete log of what the device was doing during its operation. All of your business or technical logs can be stored in our storage for later usage. You can identify which events happened or even trigger self-repairing logic.
+ *
+ * All commands will be available in [Applet Command REST API](https://developers.signageos.io/api/#tag/DeviceApplet-Command) and can be downloaded historically as [CSV export](https://developers.signageos.io/api/#tag/DeviceMonitoring/paths/~1v1~1device~1%7BdeviceUid%7D~1report/get).
  */
 class Command {
     messagePrefix;
@@ -26,16 +28,21 @@ class Command {
      * The `dispatch()` method dispatches a new log record to the signageOS.
      *
      * :::warning[Dispatch throttling]
-     *
      * Sending commands from an applet is throttled, this means that after if the dispatch frequency is too high, some commands may be
-     * discarded. Currently the limit is 30 commands per 30 seconds, although this may not be fully accurate and it's not possible to know the
+     * discarded. Currently, the limit is 30 commands per 30 seconds, although this may not be fully accurate, and it's not possible to know the
      * exact limit.
-     *
      * :::
      *
+     * @param command The command to be dispatched.
+     * @throws {AppletCommandError} If type contains invalid characters, allowed to are `/^[a-zA-Z0-9\.\-_]+$/g`
+     * @throws {AppletCommandError} If the command type is longer then 100 characters limit.
+     * @throws {AppletCommandError} If the command is not an object or is missing required properties.
      * @since 1.0.3
      *
-     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/sending/ |Sending commands}
+     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/sending/ | Sending commands in Applet}
+     * @example // {@link https://developers.signageos.io/api/#tag/DeviceApplet-Command/paths/~1v1~1device~1%7BdeviceUid%7D~1applet~1%7BappletUid%7D~1command/post | Rest API - Dispatching commands}
+     * @example // {@link https://developers.signageos.io/api/#tag/DeviceApplet-Command/paths/~1v1~1device~1%7BdeviceUid%7D~1applet~1command/get | Rest API - Get commands}
+     * @example // {@link https://developers.signageos.io/api/#tag/DeviceMonitoring/paths/~1v1~1device~1%7BdeviceUid%7D~1report/get | Rest API - Receiving historical data}
      *
      * @example
      * await sos.command.dispatch({
@@ -54,9 +61,11 @@ class Command {
     /**
      * The `onCommand()` method sets up a listener, which is called whenever a new command from signageOS is received.
      *
+     * @param listener The listener to be called when a new command is received.
+     * @returns {void} Resolves when the listener is successfully set up.
      * @since 1.0.3
      *
-     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/receiving |Receiving commands}
+     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/receiving | Receiving commands in Applet}
      */
     onCommand(listener) {
         (0, Validate_1.default)({ listener }).required().function();

package/es6/FrontApplet/Command/Command.js.map

@@ -1 +1 @@
-{"version":3,"file":"Command.js","sourceRoot":"","sources":["../../../src/FrontApplet/Command/Command.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAItC,qFAA6D;AAC7D,qEAA6C;AAC7C,iFAAyD;AACzD,oEAA4C;AAG5C;;GAEG;AACH,MAAqB,OAAO;IAOlB;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,SAAS,CAAC;IAEzC,YAAY,CAAe;IAEnC,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA+B;QAD/B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAoB;QAEvC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,QAAQ,CAA4B,OAAiB;QACjE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CAAC,QAA0C;QAC1D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAqC;QAC7D,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;gBACzC,MAAM,YAAY,GAAG;oBACpB,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC;gBACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;gBAChD,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACvE,CAAC;IAEO,iBAAiB,CAAC,IAAY;QACrC,MAAM,KAAK,GAAG,sBAAsB,CAAC;QAErC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,CACR,IAAI,4BAAkB,CAAC;YACtB,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,mCAAmC;YAC5C,IAAI,EAAE,oBAAU,CAAC,sBAAsB;YACvC,UAAU,EAAE,0BAAgB,CAAC,sBAAsB;SACnD,CAAC,CACF;aACA,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,KAAK,CAAC,CAAC;QAErB,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,CACR,IAAI,4BAAkB,CAAC;YACtB,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,qCAAqC;YAC9C,IAAI,EAAE,oBAAU,CAAC,wBAAwB;SACzC,CAAC,CACF;aACA,SAAS,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC;;AAlGF,0BAmGC"}
+{"version":3,"file":"Command.js","sourceRoot":"","sources":["../../../src/FrontApplet/Command/Command.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAItC,qFAA6D;AAC7D,qEAA6C;AAC7C,iFAAyD;AACzD,oEAA4C;AAG5C;;;;GAIG;AACH,MAAqB,OAAO;IAOlB;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,SAAS,CAAC;IAEzC,YAAY,CAAe;IAEnC,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA+B;QAD/B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAoB;QAEvC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,QAAQ,CAA4B,OAAiB;QACjE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,SAAS,CAAC,QAA0C;QAC1D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAqC;QAC7D,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;gBACzC,MAAM,YAAY,GAAG;oBACpB,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC;gBACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;gBAChD,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACvE,CAAC;IAEO,iBAAiB,CAAC,IAAY;QACrC,MAAM,KAAK,GAAG,sBAAsB,CAAC;QAErC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,CACR,IAAI,4BAAkB,CAAC;YACtB,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,mCAAmC;YAC5C,IAAI,EAAE,oBAAU,CAAC,sBAAsB;YACvC,UAAU,EAAE,0BAAgB,CAAC,sBAAsB;SACnD,CAAC,CACF;aACA,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,KAAK,CAAC,CAAC;QAErB,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,CACR,IAAI,4BAAkB,CAAC;YACtB,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,qCAAqC;YAC9C,IAAI,EAAE,oBAAU,CAAC,wBAAwB;SACzC,CAAC,CACF;aACA,SAAS,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC;;AAzGF,0BA0GC"}

package/es6/FrontApplet/Command/ICommand.d.ts

@@ -1,4 +1,11 @@
+/**
+ * Interface represents a command structure with a type and additional data.
+ */
 interface ICommand {
     type: string;
+    /**
+     * The `data` property is an object that contains additional data related to the command.
+     */
+    [key: string]: any;
 }
 export default ICommand;

package/es6/FrontApplet/Command/ICommandEvent.d.ts

@@ -1,6 +1,12 @@
 import ICommand from './ICommand';
+/**
+ * Received command event interface from signageOS.
+ */
 interface ICommandEvent {
     type: 'command';
+    /**
+     * Command data received from occurred event.
+     */
     command: ICommand;
 }
 export default ICommandEvent;

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

@@ -3,6 +3,11 @@ import IPostMessage from '../IPostMessage';
 import IDebug, { IDebugSetWeinreMessage, WeinreData } from './IDebug';
 /**
  * The `sos.debug` API groups together methods for checking the state of remote debug mode.
+ *
+ * :::note
+ * - This debug is not the "native debug" of the device, but rather a remote debug mode that allows you to connect to the device using Weinre.
+ * - State of the remote debug mode or native debug mode can be changed via Cloud Control or [Rest API](https://developers-staging.signageos.io/api/#tag/DeviceDebug/paths/~1v1~1device~1%7BdeviceUid%7D~1debug/put).
+ * :::
  */
 export default class Debug extends EventEmitter implements IDebug {
     readonly window: Window & WeinreData;
@@ -13,15 +18,18 @@ export default class Debug extends EventEmitter implements IDebug {
     /** @internal */
     constructor(window: Window & WeinreData, messagePrefix: string, postMessage: IPostMessage<any>);
     /**
-     * The `isRemoteDebugEnabled()` method returns the state of the [Device debug](https://docs.signageos.io/hc/en-us/articles/4416366711442-Device-debug).
+     * The `isRemoteDebugEnabled()` method returns the state of the Device debug mode.
      *
+     * @returns {Promise<boolean>} Resolves to `true` if the remote debug mode is enabled, otherwise `false`.
      * @since 5.8.0
      */
     isRemoteDebugEnabled(): Promise<boolean>;
     /**
-     * The `onRemoteDebugChanged()` method sets up a listener, which is called whenever the state of the [Device debug](https://docs.signageos.io/hc/en-us/articles/4416366711442-Device-debug) is changed.
+     * The `onRemoteDebugChanged()` method sets up a listener, which is called whenever the state of the Device debug mode is changed.
      *
-     * @since
+     * @param listener The listener to be called when the state of the remote debug mode is changed.
+     * @returns {void} Resolves when the listener is successfully set up.
+     * @since 5.8.0
      */
     onRemoteDebugChanged(listener: (data: {
         enabled: boolean;

package/es6/FrontApplet/Debug/Debug.js

@@ -7,6 +7,11 @@ const events_1 = require("events");
 const Validate_1 = __importDefault(require("../Validate/Validate"));
 /**
  * The `sos.debug` API groups together methods for checking the state of remote debug mode.
+ *
+ * :::note
+ * - This debug is not the "native debug" of the device, but rather a remote debug mode that allows you to connect to the device using Weinre.
+ * - State of the remote debug mode or native debug mode can be changed via Cloud Control or [Rest API](https://developers-staging.signageos.io/api/#tag/DeviceDebug/paths/~1v1~1device~1%7BdeviceUid%7D~1debug/put).
+ * :::
  */
 class Debug extends events_1.EventEmitter {
     window;
@@ -22,8 +27,9 @@ class Debug extends events_1.EventEmitter {
         this.postMessage = postMessage;
     }
     /**
-     * The `isRemoteDebugEnabled()` method returns the state of the [Device debug](https://docs.signageos.io/hc/en-us/articles/4416366711442-Device-debug).
+     * The `isRemoteDebugEnabled()` method returns the state of the Device debug mode.
      *
+     * @returns {Promise<boolean>} Resolves to `true` if the remote debug mode is enabled, otherwise `false`.
      * @since 5.8.0
      */
     async isRemoteDebugEnabled() {
@@ -33,9 +39,11 @@ class Debug extends events_1.EventEmitter {
         return isEnabled;
     }
     /**
-     * The `onRemoteDebugChanged()` method sets up a listener, which is called whenever the state of the [Device debug](https://docs.signageos.io/hc/en-us/articles/4416366711442-Device-debug) is changed.
+     * The `onRemoteDebugChanged()` method sets up a listener, which is called whenever the state of the Device debug mode is changed.
      *
-     * @since
+     * @param listener The listener to be called when the state of the remote debug mode is changed.
+     * @returns {void} Resolves when the listener is successfully set up.
+     * @since 5.8.0
      */
     onRemoteDebugChanged(listener) {
         (0, Validate_1.default)({ listener }).required().function();

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

@@ -1 +1 @@
-{"version":3,"file":"Debug.js","sourceRoot":"","sources":["../../../src/FrontApplet/Debug/Debug.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,oEAA4C;AAG5C;;GAEG;AACH,MAAqB,KAAM,SAAQ,qBAAY;IAM7B;IACR;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,OAAO,CAAC;IACxC,MAAM,CAAC,aAAa,GAAW,eAAe,CAAC;IAEtD,gBAAgB;IAChB,YACiB,MAA2B,EACnC,aAAqB,EACrB,WAA8B;QAEtC,KAAK,EAAE,CAAC;QAJQ,WAAM,GAAN,MAAM,CAAqB;QACnC,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IAGvC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB;QAChC,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,QAA8C;QACzE,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAA4B;QACpD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE;oBAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC,CAAC;gBACH,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBAClB,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC;oBACvC,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,EAAE,CAAC;oBACrC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;wBACjC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;wBAC5D,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,8BAA8B,CAAC;wBACvD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;wBAE9C,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;oBACnC,CAAC;gBACF,CAAC;qBAAM,CAAC;oBACP,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,SAAS,CAAC;oBACxC,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,SAAS,CAAC;gBACxC,CAAC;gBACD,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACrE,CAAC;;AAhEF,wBAiEC"}
+{"version":3,"file":"Debug.js","sourceRoot":"","sources":["../../../src/FrontApplet/Debug/Debug.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,oEAA4C;AAG5C;;;;;;;GAOG;AACH,MAAqB,KAAM,SAAQ,qBAAY;IAM7B;IACR;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,OAAO,CAAC;IACxC,MAAM,CAAC,aAAa,GAAW,eAAe,CAAC;IAEtD,gBAAgB;IAChB,YACiB,MAA2B,EACnC,aAAqB,EACrB,WAA8B;QAEtC,KAAK,EAAE,CAAC;QAJQ,WAAM,GAAN,MAAM,CAAqB;QACnC,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IAGvC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,oBAAoB;QAChC,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,oBAAoB,CAAC,QAA8C;QACzE,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAA4B;QACpD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE;oBAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC,CAAC;gBACH,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBAClB,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC;oBACvC,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,EAAE,CAAC;oBACrC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;wBACjC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;wBAC5D,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,8BAA8B,CAAC;wBACvD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;wBAE9C,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;oBACnC,CAAC;gBACF,CAAC;qBAAM,CAAC;oBACP,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,SAAS,CAAC;oBACxC,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,SAAS,CAAC;gBACxC,CAAC;gBACD,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACrE,CAAC;;AAnEF,wBAoEC"}

package/es6/FrontApplet/DeviceInfo/DeviceInfo.d.ts

@@ -14,6 +14,11 @@ export default class DeviceInfo implements IDeviceInfo {
      * The `getLocation()` method returns location of the device. Location is requested from server on application start, automatically
      * updated when changed and persisted in local storage.
      *
+     * :::note
+     * Location can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceLocation/paths/~1v1~1device~1%7BdeviceUid%7D~1location~1%7BlocationUid%7D/get).
+     * :::
+     *
+     * @returns {Promise<IDeviceLocation | null>} A promise that resolves to the device location or `null` if not set.
      * @since 5.2.0
      */
     getLocation(): Promise<IDeviceLocation | null>;
@@ -21,6 +26,11 @@ export default class DeviceInfo implements IDeviceInfo {
      * The `getOrganizationTags()` method returns all tags assigned to the device. Tags are requested from server on application start, automatically
      * updated when changed and persisted in local storage.
      *
+     * :::note
+     * Tags can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceTag-(Device-Tags)).
+     * :::
+     *
+     * @returns {Promise<IOrganizationTag[]>} A promise that resolves to an array of organization tags.
      * @since 5.2.0
      */
     getOrganizationTags(): Promise<IOrganizationTag[]>;
@@ -28,7 +38,16 @@ export default class DeviceInfo implements IDeviceInfo {
      * The `getDeviceName()` method returns a name of the device. Name is requested from server on application start, automatically
      * updated when changed and persisted in local storage.
      *
+     * :::note
+     * Device name can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/Device/paths/~1v2~1device~1%7BdeviceUid%7D/get).
+     * :::
+     *
+     * @returns {Promise<string>} A promise that resolves to the device name.
      * @since 6.6.0
+     *
+     * @example
+     * const deviceName = await sos.deviceInfo.getDeviceName();
+     * console.log(`Device name is: ${deviceName}`);
      */
     getDeviceName(): Promise<string>;
     private getMessage;

package/es6/FrontApplet/DeviceInfo/DeviceInfo.js

@@ -17,6 +17,11 @@ class DeviceInfo {
      * The `getLocation()` method returns location of the device. Location is requested from server on application start, automatically
      * updated when changed and persisted in local storage.
      *
+     * :::note
+     * Location can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceLocation/paths/~1v1~1device~1%7BdeviceUid%7D~1location~1%7BlocationUid%7D/get).
+     * :::
+     *
+     * @returns {Promise<IDeviceLocation | null>} A promise that resolves to the device location or `null` if not set.
      * @since 5.2.0
      */
     async getLocation() {
@@ -27,6 +32,11 @@ class DeviceInfo {
      * The `getOrganizationTags()` method returns all tags assigned to the device. Tags are requested from server on application start, automatically
      * updated when changed and persisted in local storage.
      *
+     * :::note
+     * Tags can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceTag-(Device-Tags)).
+     * :::
+     *
+     * @returns {Promise<IOrganizationTag[]>} A promise that resolves to an array of organization tags.
      * @since 5.2.0
      */
     async getOrganizationTags() {
@@ -37,11 +47,19 @@ class DeviceInfo {
      * The `getDeviceName()` method returns a name of the device. Name is requested from server on application start, automatically
      * updated when changed and persisted in local storage.
      *
+     * :::note
+     * Device name can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/Device/paths/~1v2~1device~1%7BdeviceUid%7D/get).
+     * :::
+     *
+     * @returns {Promise<string>} A promise that resolves to the device name.
      * @since 6.6.0
+     *
+     * @example
+     * const deviceName = await sos.deviceInfo.getDeviceName();
+     * console.log(`Device name is: ${deviceName}`);
      */
     async getDeviceName() {
-        const deviceName = this.geDeviceNameFromTittle();
-        return deviceName;
+        return this.geDeviceNameFromTittle();
     }
     getMessage(name) {
         return [this.messagePrefix, DeviceInfo.MESSAGE_PREFIX, name].join('.');

package/es6/FrontApplet/DeviceInfo/DeviceInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeviceInfo.js","sourceRoot":"","sources":["../../../src/FrontApplet/DeviceInfo/DeviceInfo.ts"],"names":[],"mappings":";;AAGA;;;GAGG;AACH,MAAqB,UAAU;IAKrB;IACA;IALF,MAAM,CAAC,cAAc,GAAW,aAAa,CAAC;IAErD,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;OAKG;IACI,KAAK,CAAC,WAAW;QACvB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QACvF,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,mBAAmB;QAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;QAC5F,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa;QACzB,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QACjD,OAAO,UAAU,CAAC;IACnB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxE,CAAC;IAEO,sBAAsB;QAC7B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC5C,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,aAAa,GAAG,YAAY,CAAC,aAAc,CAAC;QAClD,OAAO,aAAa,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC;IACvE,CAAC;;AAnDF,6BAoDC"}
+{"version":3,"file":"DeviceInfo.js","sourceRoot":"","sources":["../../../src/FrontApplet/DeviceInfo/DeviceInfo.ts"],"names":[],"mappings":";;AAGA;;;GAGG;AACH,MAAqB,UAAU;IAKrB;IACA;IALF,MAAM,CAAC,cAAc,GAAW,aAAa,CAAC;IAErD,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;OAUG;IACI,KAAK,CAAC,WAAW;QACvB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QACvF,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,mBAAmB;QAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;QAC5F,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,aAAa;QACzB,OAAO,IAAI,CAAC,sBAAsB,EAAE,CAAC;IACtC,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxE,CAAC;IAEO,sBAAsB;QAC7B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC5C,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,aAAa,GAAG,YAAY,CAAC,aAAc,CAAC;QAClD,OAAO,aAAa,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC;IACvE,CAAC;;AArEF,6BAsEC"}

package/es6/FrontApplet/Display/Display.d.ts

@@ -3,6 +3,25 @@ import IDisplay, { DisplayCapability } from './IDisplay';
 /**
  * The `sos.display` API groups together methods for getting information about the device. Primarily to find out which
  * features it supports.
+ *
+ * <details>
+ *     <summary>List of all display capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `FILE_SYSTEM_INTERNAL_STORAGE` | If device supports internal storage |
+ * 		| `FILE_SYSTEM_EXTERNAL_STORAGE` | If device supports external storage |
+ * 		| `FILE_SYSTEM_FILE_CHECKSUM` | If device supports file checksum calculation |
+ * 		| `FILE_SYSTEM_LINK` | If device supports file system `link()` |
+ * 		| `FILE_SYSTEM_CREATE_ARCHIVE` | If device supports creating archives in the file system |
+ * 		| `FILE_SYSTEM_ARCHIVE_EXTRACT_INFO` | If device can determine a total size of a potentially extracted archive |
+ * 		| `TIMERS_PROPRIETARY` | If device supports proprietary timers |
+ * 		| `VIDEO_4K` | If device supports 4K video playback |
+ * 		| `BROWSER` | If device supports opening browser |
+ * 		| `SERIAL` | If device supports serial port communication |
+ * 		| `BARCODE_SCANNER` | If device supports barcode scanner setup |
+ * 		| `FRONT_OSD` | If device supports Front OSD (our on-screen display) |
+ * 		| `PROXIMITY_SENSOR` | If device supports proximity sensor |
+ * </details>
  */
 declare class Display implements IDisplay {
     private messagePrefix;
@@ -12,20 +31,9 @@ declare class Display implements IDisplay {
     /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     /**
-     * The `supports()` method determines whether a queried capability is supported.
-     *
-     * - 'FILE_SYSTEM_INTERNAL_STORAGE' - @todo
-     * - 'FILE_SYSTEM_EXTERNAL_STORAGE' - @todo
-     * - 'FILE_SYSTEM_FILE_CHECKSUM' - @todo
-     * - 'FILE_SYSTEM_LINK' - @todo
-     * - 'TIMERS_PROPRIETARY' - @todo
-     * - 'VIDEO_4K' - @todo
-     * - 'SERIAL' - @todo
-     * - 'BARCODE_SCANNER' - @todo
-     * - 'FRONT_OSD' - @todo
-     * - 'FILE_SYSTEM_CREATE_ARCHIVE' - @todo
-     * - 'FILE_SYSTEM_ARCHIVE_EXTRACT_INFO' - Device can determine a total size of a potentially extracted archive
-     *
+     * The `supports()` method determines whether a queried capability is supported by the device.
+     * @param capability The capability to check for support.
+     * @returns {Promise<boolean>} Resolves to `true` if the capability is supported, otherwise `false`.
      * @since 3.1.0
      */
     supports(capability: DisplayCapability): Promise<boolean>;

package/es6/FrontApplet/Display/Display.js

@@ -7,6 +7,25 @@ const Validate_1 = __importDefault(require("../Validate/Validate"));
 /**
  * The `sos.display` API groups together methods for getting information about the device. Primarily to find out which
  * features it supports.
+ *
+ * <details>
+ *     <summary>List of all display capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `FILE_SYSTEM_INTERNAL_STORAGE` | If device supports internal storage |
+ * 		| `FILE_SYSTEM_EXTERNAL_STORAGE` | If device supports external storage |
+ * 		| `FILE_SYSTEM_FILE_CHECKSUM` | If device supports file checksum calculation |
+ * 		| `FILE_SYSTEM_LINK` | If device supports file system `link()` |
+ * 		| `FILE_SYSTEM_CREATE_ARCHIVE` | If device supports creating archives in the file system |
+ * 		| `FILE_SYSTEM_ARCHIVE_EXTRACT_INFO` | If device can determine a total size of a potentially extracted archive |
+ * 		| `TIMERS_PROPRIETARY` | If device supports proprietary timers |
+ * 		| `VIDEO_4K` | If device supports 4K video playback |
+ * 		| `BROWSER` | If device supports opening browser |
+ * 		| `SERIAL` | If device supports serial port communication |
+ * 		| `BARCODE_SCANNER` | If device supports barcode scanner setup |
+ * 		| `FRONT_OSD` | If device supports Front OSD (our on-screen display) |
+ * 		| `PROXIMITY_SENSOR` | If device supports proximity sensor |
+ * </details>
  */
 class Display {
     messagePrefix;
@@ -19,20 +38,9 @@ class Display {
         this.postMessage = postMessage;
     }
     /**
-     * The `supports()` method determines whether a queried capability is supported.
-     *
-     * - 'FILE_SYSTEM_INTERNAL_STORAGE' - @todo
-     * - 'FILE_SYSTEM_EXTERNAL_STORAGE' - @todo
-     * - 'FILE_SYSTEM_FILE_CHECKSUM' - @todo
-     * - 'FILE_SYSTEM_LINK' - @todo
-     * - 'TIMERS_PROPRIETARY' - @todo
-     * - 'VIDEO_4K' - @todo
-     * - 'SERIAL' - @todo
-     * - 'BARCODE_SCANNER' - @todo
-     * - 'FRONT_OSD' - @todo
-     * - 'FILE_SYSTEM_CREATE_ARCHIVE' - @todo
-     * - 'FILE_SYSTEM_ARCHIVE_EXTRACT_INFO' - Device can determine a total size of a potentially extracted archive
-     *
+     * The `supports()` method determines whether a queried capability is supported by the device.
+     * @param capability The capability to check for support.
+     * @returns {Promise<boolean>} Resolves to `true` if the capability is supported, otherwise `false`.
      * @since 3.1.0
      */
     async supports(capability) {

package/es6/FrontApplet/Display/Display.js.map

@@ -1 +1 @@
-{"version":3,"file":"Display.js","sourceRoot":"","sources":["../../../src/FrontApplet/Display/Display.ts"],"names":[],"mappings":";;;;;AACA,oEAA4C;AAG5C;;;GAGG;AACH,MAAM,OAAO;IAOH;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,SAAS,CAAC;IAE1C,OAAO,GAAW,SAAU,CAAC;IAEpC,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,QAAQ,CAAC,UAA6B;QAClD,IAAA,kBAAQ,EAAC,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,UAAU;SACV,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACvE,CAAC;;AAGF,kBAAe,OAAO,CAAC"}
+{"version":3,"file":"Display.js","sourceRoot":"","sources":["../../../src/FrontApplet/Display/Display.ts"],"names":[],"mappings":";;;;;AACA,oEAA4C;AAG5C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO;IAOH;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,SAAS,CAAC;IAE1C,OAAO,GAAW,SAAU,CAAC;IAEpC,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,UAA6B;QAClD,IAAA,kBAAQ,EAAC,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,UAAU;SACV,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACvE,CAAC;;AAGF,kBAAe,OAAO,CAAC"}

package/es6/FrontApplet/Display/IDisplay.d.ts

@@ -1,4 +1,8 @@
 import { AnyString } from '../../utils/types';
+/**
+ * Represents the capabilities that a display can support.
+ * These capabilities are used to determine if a specific feature is available on the display.
+ */
 export type DisplayCapability = 'FILE_SYSTEM_INTERNAL_STORAGE' | 'FILE_SYSTEM_EXTERNAL_STORAGE' | 'FILE_SYSTEM_FILE_CHECKSUM' | 'FILE_SYSTEM_LINK' | 'TIMERS_PROPRIETARY' | 'VIDEO_4K' | 'SERIAL' | 'BARCODE_SCANNER' | 'FRONT_OSD' | 'FILE_SYSTEM_CREATE_ARCHIVE' | 'FILE_SYSTEM_ARCHIVE_EXTRACT_INFO' | 'BROWSER' | 'PROXIMITY_SENSOR' | AnyString;
 export default interface IDisplay {
     supports(capability: DisplayCapability): Promise<boolean>;