@signageos/front-applet 8.1.1 → 8.1.3

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>;