@signageos/front-applet 8.1.2 → 8.1.4

package/es6/FrontApplet/Offline/Offline.js

@@ -13,15 +13,23 @@ const CssLoadFileController_1 = __importDefault(require("./LoadFile/CssLoadFileC
 const JavascriptLoadFileController_1 = __importDefault(require("./LoadFile/JavascriptLoadFileController"));
 const Types_1 = __importDefault(require("./Types"));
 /**
- * The `sos.offline` API groups together methods for storing and using JS, CSS and font files.
+ * Web-based applications often require additional assets to function, but downloading them every time is undesirable. The JS Applet SDK offers a wide range of APIs for storing different kinds of assets.
  *
- * :::warning
+ * Generally, there are four types of assets:
+ * - CSS & JavaScript files
+ * - Fonts
+ * - Audio-visual content (image, video, and audio files)
+ * - Arbitrary data (e.g., JSON files, plain text, binary data)
  *
- * Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138)
+ * And the SDK also provides two different APIs:
+ * - `sos.offline` & `sos.offline.cache`: A file system abstraction for caching files that are removed when the applet configuration is changed or the applet is reloaded. This method is usually preferred if the files can be re-downloaded.
+ * - `sos.fileSystem`: Direct access to the file system. All files are stored permanently and are not removed when the applet configuration changes.
  *
- * :::
+ * Using the `sos.offline` and `sos.offline.cache` APIs allows you to ship an applet without content, including only basic bootstrapping code, and load the content dynamically. The content will then be available even when the device is offline.
  *
- * @tutorial https://developers.signageos.io/docs/applets/api-guides/offline-content#caching-css--javascript-sosoffline
+ * :::warning
+ * Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138)
+ * :::
  */
 class Offline {
     messagePrefix;
@@ -61,10 +69,17 @@ class Offline {
         });
     }
     /**
-     * The `addFiles()` method downloads the specified files and stores them locally. The order in which the files are downloaded and stored is **not** guaranteed.
+     * The `addFiles()` method downloads the specified files and stores them locally.
+     * The order in which the files are downloaded and stored is **not** guaranteed.
      *
+     * CSS and JavaScript files are specific because they must be loaded with an HTML tag. The `sos.offline` API methods download, save, and append the resource to the web page. When adding a file, choose a unique identifier (`uid`) that should not change for the resource. The file will be overwritten if another file is added with the same `uid`.
+     *
+     * @param files Array of files to be downloaded and stored locally.
+     * @returns {Promise<Awaited<void>>} Resolves when all files are added.
+     * @throws {Error} If the `files` parameter is not an array of objects.
      * @since 1.0.0
      *
+     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/offline-resources | Example of Applet that save files and load them in one file}
      * @example
      * await sos.offline.addFile([{
      * 	uri: 'https://unpkg.com/normalize.css@8.0.1/normalize.css',
@@ -84,9 +99,24 @@ class Offline {
         return Promise.all(promises);
     }
     /**
-     * The `addFilesSync()` method downloads the specified files and stores them locally. The order in which the files are downloaded and stored **is** guaranteed.
+     * Method `addFile()` will allow you to load single resource into applet. If you want to load more resource, use `addFiles()`.
+     *
+     * The order in which the files are downloaded and stored **is** guaranteed.
      *
+     * @param files Array of files to be downloaded and stored locally.
+     * @returns {Promise<void>} Resolves when all files are added and the files are appended to the document when flags are used.
+     * @throws {Error} If the `files` parameter is not an array of objects
      * @since 1.0.0
+     *
+     * @example
+     * const file = { // File that will be loaded into an applet
+     *     "uri": "https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js",
+     *     "uid": "jquery-2.2.4.min.js",
+     *     "type": sos.offline.types.javascript,
+     *     "flags": [sos.offline.flags.append(document.body)]
+     * }
+     *
+     * await sos.offline.addFile(file); // And finally load file
      */
     async addFilesSync(files) {
         (0, Validate_1.default)({ addFiles: files }).required().array('object');
@@ -97,17 +127,27 @@ class Offline {
     /**
      * The `addFile()` method downloads the specified file and stores it locally.
      *
+     * CSS and JavaScript files are specific because they must be loaded with an HTML tag. The `sos.offline` API methods download, save, and append the resource to the web page. When adding a file, choose a unique identifier (`uid`) that should not change for the resource. The file will be overwritten if another file is added with the same `uid`.
+     *
+     * :::info
+     * The file URL must point to a file. If your URI leads to a redirect (e.g. from http to https), the API will not work.
+     * :::
+     *
+     * @param file URI of the file to be downloaded.
+     * @param file.uid Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 characters.
+     * @param file.type Type of the file, e.g. 'javascript', 'css', etc.
+     * @param file.headers HTTP headers to be sent with the request for the file.
+     * @param file.flags Additional flags for appending stored files to the DOM or other operations
+     * @returns {Promise<void>} Resolves when the file is added and the file is appended to the document when flags are used.
+     * @throws {Error} If the `file` parameter is not an object.
+     * @throws {Error} If the `file` parameter does not contain a valid parameters.
      * @since 1.0.0
      *
      * @example
      * await sos.offline.addFile({
-     * 	// Source URL
      * 	uri: 'https://code.jquery.com/jquery-3.7.1.slim.min.js',
-     * 	// Unique identifier of the resource
      * 	uid: 'jquery-3.7.1.slim.min.js',
-     * 	// Indicate that the downloaded file is a JavaScript file
      * 	type: sos.offline.types.javascript,
-     * 	// After the file is downloaded, it will be appended to document.body
      * 	flags: [sos.offline.flags.append(document.body)],
      * });
      */
@@ -130,10 +170,13 @@ class Offline {
      * @param font.fontStretch Allows you to make text wider or narrower.
      * @param font.fontStyle Specifies the font style for a text. (Either `normal`, `italic`, `oblique`, `initial` or `inherit`)
      * @param font.fontWeight Sets how thick or thin characters in text should be displayed
-     * @param font.unicodeRange Defines the range of unicode characters the font supports, default value is "U+0-10FFFF"
+     * @param font.unicodeRange Defines the range of Unicode characters the font supports, default value is "U+0-10FFFF"
      * @param font.formats Dictionary of supported formats with its files
-     *
+     * @throws {Error} If the `font` parameter is not an object.
+     * @returns {Promise<void>} Resolves when the font is added and the style element is appended to the document.
      * @since 2.0.0
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/fonts | Example of Applet that loads custom font}
      */
     async addFont(font) {
         (0, Validate_1.default)({ addFont: font }).required().object(IAddFont_1.VIAddFont);

package/es6/FrontApplet/Offline/Offline.js.map

@@ -1 +1 @@
-{"version":3,"file":"Offline.js","sourceRoot":"","sources":["../../../src/FrontApplet/Offline/Offline.ts"],"names":[],"mappings":";;;;;AAAA,iEAA+E;AAE/E,oEAA4C;AAC5C,0DAAkC;AAElC,wFAAgE;AAGhE,yCAA+D;AAE/D,2CAAoD;AACpD,6FAAqE;AAGrE,2GAAmF;AACnF,oDAAwC;AAMxC;;;;;;;;;;GAUG;AACH,MAAqB,OAAO;IAalB;IACA;IACA;IAdF,MAAM,CAAC,cAAc,GAAW,SAAS,CAAC;IAEjC,KAAK,CAAQ;IACb,KAAK,CAAS;IACd,QAAQ,CAAY;IACpB,KAAK,CAA0B;IACvC,eAAe,CAAkB;IACjC,eAAe,GAAkC,CAAC,8BAAoB,CAAC,CAAC;IACxE,mBAAmB,GAAgC,CAAC,sCAA4B,EAAE,+BAAqB,CAAC,CAAC;IAEjH,gBAAgB;IAChB,YACS,aAAqB,EACrB,MAAc,EACd,WAA8B;QAF9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,WAAM,GAAN,MAAM,CAAQ;QACd,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,GAAG,eAAK,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,QAAmB,EAAE,kBAA6C,EAAE,EAAE;YACtH,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC/D,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC;YACvD,OAAO,QAAQ,CAAC;QACjB,CAAC,EAAE,EAAE,CAAC,CAAC;QACP,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE;YACtF,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzD,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC;YACtD,OAAO,eAAe,CAAC;QACxB,CAAC,EAAE,EAAqB,CAAC,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAA+B,CAAC,MAAM,CACnF,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE;YAC7B,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAE,CAAC;YACjE,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACxE,OAAO,KAAK,CAAC;QACd,CAAC,EACD;YACC,MAAM,EAAE,IAAa;SACM,CAC5B,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,QAAQ,CAAC,KAAkB;QACjC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,OAAkB,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1E,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,KAAkB;QAC3C,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEzD,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,OAAO,CAAC,IAAe;QACnC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,sBAAU,CAAC,CAAC;QAE1D,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAEpF,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QAC/B,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,OAAO,CAAC,IAAc;QAClC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,oBAAS,CAAC,CAAC;QACzD,MAAM,aAAa,GAAG,IAAA,qCAAiB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAE3D,MAAM,gBAAgB,GAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAA4B,CAAC,GAAG,CAAC,KAAK,EAAE,aAAiC,EAAE,EAAE;YAC9H,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAA,mCAAe,EAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAE,CAAC,CAAC;YACrH,aAAa,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAEpC,MAAM,YAAY,GAAG,aAAa,CAAC,oBAAoB,EAAE,CAAC;QAC1D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,IAAW,EAAE,IAAW,EAAE,QAAmB;QACzE,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,OAAO,cAAc,KAAK,WAAW,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,MAAM,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC;IAC1D,CAAC;;AAnJF,0BAoJC"}
+{"version":3,"file":"Offline.js","sourceRoot":"","sources":["../../../src/FrontApplet/Offline/Offline.ts"],"names":[],"mappings":";;;;;AAAA,iEAA+E;AAE/E,oEAA4C;AAC5C,0DAAkC;AAElC,wFAAgE;AAGhE,yCAA+D;AAE/D,2CAAoD;AACpD,6FAAqE;AAGrE,2GAAmF;AACnF,oDAAwC;AAMxC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAqB,OAAO;IAalB;IACA;IACA;IAdF,MAAM,CAAC,cAAc,GAAW,SAAS,CAAC;IAEjC,KAAK,CAAQ;IACb,KAAK,CAAS;IACd,QAAQ,CAAY;IACpB,KAAK,CAA0B;IAC9B,eAAe,CAAkB;IAC1C,eAAe,GAAkC,CAAC,8BAAoB,CAAC,CAAC;IACxE,mBAAmB,GAAgC,CAAC,sCAA4B,EAAE,+BAAqB,CAAC,CAAC;IAEjH,gBAAgB;IAChB,YACS,aAAqB,EACrB,MAAc,EACd,WAA8B;QAF9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,WAAM,GAAN,MAAM,CAAQ;QACd,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,GAAG,eAAK,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,QAAmB,EAAE,kBAA6C,EAAE,EAAE;YACtH,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC/D,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC;YACvD,OAAO,QAAQ,CAAC;QACjB,CAAC,EAAE,EAAE,CAAC,CAAC;QACP,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE;YACtF,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzD,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC;YACtD,OAAO,eAAe,CAAC;QACxB,CAAC,EAAE,EAAqB,CAAC,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAA+B,CAAC,MAAM,CACnF,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE;YAC7B,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAE,CAAC;YACjE,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACxE,OAAO,KAAK,CAAC;QACd,CAAC,EACD;YACC,MAAM,EAAE,IAAa;SACM,CAC5B,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,QAAQ,CAAC,KAAkB;QACjC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,OAAkB,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1E,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,YAAY,CAAC,KAAkB;QAC3C,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEzD,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,OAAO,CAAC,IAAe;QACnC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,sBAAU,CAAC,CAAC;QAE1D,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAEpF,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QAC/B,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,KAAK,CAAC,OAAO,CAAC,IAAc;QAClC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,oBAAS,CAAC,CAAC;QACzD,MAAM,aAAa,GAAG,IAAA,qCAAiB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAE3D,MAAM,gBAAgB,GAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAA4B,CAAC,GAAG,CAAC,KAAK,EAAE,aAAiC,EAAE,EAAE;YAC9H,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAA,mCAAe,EAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAE,CAAC,CAAC;YACrH,aAAa,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAEpC,MAAM,YAAY,GAAG,aAAa,CAAC,oBAAoB,EAAE,CAAC;QAC1D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,IAAW,EAAE,IAAW,EAAE,QAAmB;QACzE,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,OAAO,cAAc,KAAK,WAAW,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,MAAM,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC;IAC1D,CAAC;;AAtLF,0BAuLC"}

package/es6/FrontApplet/ProofOfPlay/IRecordItemOptions.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Interface representing options for a record item in the Proof of Play applet.
+ */
 interface IRecordItemOptions {
     name: string;
     customId?: string;

package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.d.ts

@@ -1,6 +1,11 @@
 import CommandApi from '../Command/Command';
 import IRecordItemOptions from './IRecordItemOptions';
 import IProofOfPlay from './IProofOfPlay';
+/**
+ * The `sos.proofOfPlay` API provides methods for recording information about played content on the device.
+ *
+ * Can be useful for tracking the playback of content, which can be used for analytics, reporting, or debugging purposes.
+ */
 export default class ProofOfPlay implements IProofOfPlay {
     private commandApi;
     /** @internal */
@@ -9,8 +14,17 @@ export default class ProofOfPlay implements IProofOfPlay {
      * The `recordItemPlayed()` method dispatches a `sos.command.dispatch()` command. It sends provided information about played content along
      * with additional metadata about current applet and device to signageOS.
      *
+     * @param options The options for recording the played item.
+     * @param options.name The name of the item that was played.
+     * @param options.customId An optional custom identifier for the item.
+     * @param options.type The type of the item that was played. It can be one of the following: `video`, `image`, `html`, or `custom`.
+     * @param options.tags An array of tags associated with the item.
+     * @param options.fileName The name of the file that was played.
+     * @param options.playbackSuccess A boolean indicating whether the playback was successful.
+     * @param options.errorMessage An optional error message if the playback was not successful.
+     * @returns {Promise<void>} A promise that resolves when the item has been recorded.
+     * @throws {Error} If any of the provided options are invalid.
      * @since 5.5.1
-     *
      */
     recordItemPlayed(options: IRecordItemOptions): Promise<void>;
 }

package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js

@@ -5,6 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const Validate_1 = __importDefault(require("../Validate/Validate"));
 const ProofOfPlayType_1 = __importDefault(require("./ProofOfPlayType"));
+/**
+ * The `sos.proofOfPlay` API provides methods for recording information about played content on the device.
+ *
+ * Can be useful for tracking the playback of content, which can be used for analytics, reporting, or debugging purposes.
+ */
 class ProofOfPlay {
     commandApi;
     /** @internal */
@@ -15,8 +20,17 @@ class ProofOfPlay {
      * The `recordItemPlayed()` method dispatches a `sos.command.dispatch()` command. It sends provided information about played content along
      * with additional metadata about current applet and device to signageOS.
      *
+     * @param options The options for recording the played item.
+     * @param options.name The name of the item that was played.
+     * @param options.customId An optional custom identifier for the item.
+     * @param options.type The type of the item that was played. It can be one of the following: `video`, `image`, `html`, or `custom`.
+     * @param options.tags An array of tags associated with the item.
+     * @param options.fileName The name of the file that was played.
+     * @param options.playbackSuccess A boolean indicating whether the playback was successful.
+     * @param options.errorMessage An optional error message if the playback was not successful.
+     * @returns {Promise<void>} A promise that resolves when the item has been recorded.
+     * @throws {Error} If any of the provided options are invalid.
      * @since 5.5.1
-     *
      */
     async recordItemPlayed(options) {
         const { name, customId, type, tags, fileName, playbackSuccess, errorMessage } = options;

package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js.map

@@ -1 +1 @@
-{"version":3,"file":"ProofOfPlay.js","sourceRoot":"","sources":["../../../src/FrontApplet/ProofOfPlay/ProofOfPlay.ts"],"names":[],"mappings":";;;;;AAEA,oEAA4C;AAC5C,wEAAgD;AAGhD,MAAqB,WAAW;IAEX;IADpB,gBAAgB;IAChB,YAAoB,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;IAE9C;;;;;;OAMG;IACI,KAAK,CAAC,gBAAgB,CAAC,OAA2B;QACxD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QACxF,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QACvC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAChC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAChE,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAChC,IAAA,kBAAQ,EAAC,EAAE,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QACxC,IAAA,kBAAQ,EAAC,EAAE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAEpC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC9B,IAAI,EAAE,yBAAe,CAAC,UAAU;YAChC,QAAQ,EAAE,IAAI;YACd,QAAQ;YACR,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI;YACd,QAAQ;YACR,eAAe;YACf,YAAY;SACZ,CAAC,CAAC;IACJ,CAAC;CACD;AAhCD,8BAgCC"}
+{"version":3,"file":"ProofOfPlay.js","sourceRoot":"","sources":["../../../src/FrontApplet/ProofOfPlay/ProofOfPlay.ts"],"names":[],"mappings":";;;;;AAEA,oEAA4C;AAC5C,wEAAgD;AAGhD;;;;GAIG;AACH,MAAqB,WAAW;IAEX;IADpB,gBAAgB;IAChB,YAAoB,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;IAE9C;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,gBAAgB,CAAC,OAA2B;QACxD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QACxF,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QACvC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAChC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAChE,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAChC,IAAA,kBAAQ,EAAC,EAAE,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QACxC,IAAA,kBAAQ,EAAC,EAAE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAEpC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC9B,IAAI,EAAE,yBAAe,CAAC,UAAU;YAChC,QAAQ,EAAE,IAAI;YACd,QAAQ;YACR,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI;YACd,QAAQ;YACR,eAAe;YACf,YAAY;SACZ,CAAC,CAAC;IACJ,CAAC;CACD;AAzCD,8BAyCC"}

package/es6/FrontApplet/Sync/Sync.d.ts

@@ -2,6 +2,10 @@ import IPostMessage from '../IPostMessage';
 import { BroadcastedValueMessage, ClosedMessage, StatusMessage } from './syncMessages';
 import { StatusEvent } from './syncEvents';
 import ISync from './ISync';
+/**
+ * The `SyncEngine` enum defines the available synchronization engines that can be used to synchronize devices.
+ * Each engine has its own method of connecting devices and synchronizing data.
+ */
 export declare enum SyncEngine {
     /** Use external sync server. Device will connect to the server via websocket. */
     SyncServer = "sync-server",
@@ -13,10 +17,16 @@ export declare enum SyncEngine {
      */
     Udp = "udp"
 }
+/**
+ * Options for sync-server synchronization.
+ */
 export interface ConnectSyncServerOptions {
     engine?: SyncEngine.SyncServer;
     uri?: string;
 }
+/**
+ * Options for P2P local synchronization.
+ */
 export interface ConnectP2PLocalOptions {
     engine: SyncEngine.P2PLocal;
 }
@@ -24,6 +34,7 @@ export interface ConnectP2PLocalOptions {
 export interface ConnectUdpOptions {
     engine: SyncEngine.Udp;
 }
+type SynchronizationEngineOptions = ConnectSyncServerOptions | ConnectP2PLocalOptions | ConnectUdpOptions;
 /**
  * The `sos.sync` API groups together methods for synchronization of multiple devices. Devices are synchronized either through an external
  * server or one of the devices becomes a master device.
@@ -42,19 +53,21 @@ export default class Sync implements ISync {
      * You can optionally specify a custom sync server URI in case you are running the sync server in a custom location.
      *
      * :::info
-     *
-     * All devices, that should be synchronized together, must select the same engine. Otherwise they won't be able to communicate with each
+     * All devices, that should be synchronized together, must select the same engine. Otherwise, they won't be able to communicate with each
      * other.
-     *
      * :::
      *
-     * @param options.engine Synchronization engine to use.
+     * @param options.engine {SynchronizationEngineOptions} Synchronization engine to use.
      * @param options.uri Address of the sync server engine. Only relevant for sync-server. If omitted, the default server will be used.
-     *
-     * @throws if unable to connect.
-     *
+     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @throws Error If unable to connect.
+     * @throws Error If the `uri` is not a valid URL when using the sync-server engine.
+     * @throws Error If the `engine` is not a valid synchronization engine.
+     * @throws Error If any other error occurs during connection.
      * @since 5.7.0
      *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/sync-video | How to use synchronizer in applet}
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/sync-mixed-content | How to synchronize mixed content}
      * @example
      * // use default engine
      * await sos.sync.connect();
@@ -68,7 +81,7 @@ export default class Sync implements ISync {
      * // use p2p-local engine
      * await sos.sync.connect({ engine: 'p2p-local' });
      */
-    connect(options?: ConnectSyncServerOptions | ConnectP2PLocalOptions | ConnectUdpOptions): Promise<void>;
+    connect(options?: SynchronizationEngineOptions): Promise<void>;
     /**
      * @internal
      * @deprecated Use `connect({ engine: 'sync-server' })` instead.
@@ -80,6 +93,8 @@ export default class Sync implements ISync {
      * The `close()` method disconnects the device from synchronization server and other devices. Recommended to call this method after the
      * synchronization is not required any longer.
      *
+     * @returns {Promise<void>} A promise that resolves when the connection is closed.
+     * @throws Error If unable to close the connection.
      * @since 1.0.32
      */
     close(): Promise<void>;
@@ -92,11 +107,18 @@ export default class Sync implements ISync {
      * The `joinGroup()` method joins a group of other devices. This method has to be called after `connect()` call. Before any communication
      * takes place, all participating devices have to be connected and recognize one another. Recommended to call this method early.
      *
-     * @param options.groupName By default, all devices will be synced together. To create groups of devices, independent from each other,
-     * specify a group name.
-     * @param options.deviceIdentification Identification of a device connected to `groupName` group.
-     *
+     * @param options Options for joining a group.
+     * @returns {Promise<void>} A promise that resolves when the device joins the group.
+     * @throws Error If the group name is not a string.
+     * @throws Error If the device identification is not a string.
+     * @throws Error If unable to join the group.
+     * @throws Error If any other error occurs during joining the group.
      * @since 5.7.0
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/sync-video | How to use synchronizer in applet}
+     * @example
+     * await sos.sync.connect();
+     * await sos.sync.joinGroup({ groupName: 'my-group', deviceIdentification: 'my-device-id' });
      */
     joinGroup(options: {
         groupName?: string;
@@ -105,7 +127,15 @@ export default class Sync implements ISync {
     /**
      * The `leaveMethod` method leaves a group of devices.
      *
+     * @param groupName The name of the group to leave. Defaults to the default group.
+     * @returns {Promise<void>} A promise that resolves when the device leaves the group.
+     * @throws Error If the group name is not a string.
+     * @throws Error If unable to leave the group.
+     * @throws Error If any other error occurs during leaving the group.
      * @since 5.7.0
+     *
+     * @example
+     * await sos.sync.leaveGroup('my-group');
      */
     leaveGroup(groupName?: string): Promise<void>;
     /**
@@ -124,22 +154,44 @@ export default class Sync implements ISync {
      * Therefore, when implementing your applet you should rely on the result data and not the data that is passed to the wait method as an
      * argument.
      *
+     * @param data Optional data to pass to the group.
+     * @param groupName The name of the group to wait for. Defaults to the default group.
+     * @param timeout Timeout in milliseconds. If not specified, the default timeout is 30 seconds.
+     * @returns {Promise<any>} A promise that resolves with the data from the master device when all devices are ready to continue.
+     * @throws Error If the group name is not a string.
+     * @throws Error If the timeout is not a number.
+     * @throws Error If unable to wait for the group.
+     * @throws Error If any other error occurs during waiting for the group.
      * @since 1.0.32
+     *
+     * @example
+     * // wait for all devices in the group to be ready
+     * await sos.sync.wait('someData', 'someRandomNameGroup').then((data) => {
+     *     // this will be called once all devices are ready
+     *     console.log('All devices are ready with data:', data);
+     * });
      */
     wait(data?: any, groupName?: string, timeout?: number): Promise<any>;
     /**
      * The `cancelWait()` method aborts a wait on all devices in a group. Sometimes it's necessary to cancel a pending wait. One such
      * situation would be when the group has to make a sudden change in content or another behavior but there's a risk that part of the group
-     * already called wait() and is waiting for the rest but the rest will never call it at this point. In order to gracefully cleanup any
+     * already called wait() and is waiting for the rest but the rest will never call it at this point. In order to gracefully clean up any
      * pending activity, use this method.
      *
+     * :::warning
      * Any pending wait will be canceled and the promise will be rejected with an error.
+     * :::
      *
+     * @param groupName The name of the group to cancel the wait for. Defaults to the default group.
+     * @returns {Promise<void>} A promise that resolves when the wait is canceled.
+     * @throws Error If the group name is not a string.
+     * @throws Error If unable to cancel the wait.
+     * @throws Error If any other error occurs during canceling the wait.
      * @since 5.12.0
      *
      * @example
      * sos.sync.wait('someData', 'someRandomNameGroup').catch((err) => {
-     *     // this will happend once cancelWait is called
+     *     // this will happen once cancelWait is called
      *     console.error('wait failed', err);
      * });
      *
@@ -155,9 +207,30 @@ export default class Sync implements ISync {
     /**
      * The `broadcastValue()` method sends a key-value pair to all other devices in a specified group.
      *
-     * @throws if the value can't be sent
-     *
+     * @param groupName {String} The name of the group to broadcast the value to. Defaults to the default group.
+     * @param key {String} The key to broadcast the value under.
+     * @param value {any} The value to broadcast. It can be any valid type
+     * @returns {Promise<void>} A promise that resolves when the value is broadcasted.
+     * @throws Error If the group name is not a string.
+     * @throws Error If the key is not a string.
+     * @throws Error If the value is not a valid type (e.g. object, array, etc.).
+     * @throws Error If unable to broadcast the value.
+     * @throws Error If the value can't be sent
      * @since 5.7.0
+     *
+     * @example
+     * // broadcast a value to all devices in the group
+     * await sos.sync.broadcastValue({
+     * 	groupName: 'my-group',
+     * 	key: 'my-key',
+     * 	value: 'my-value',
+     * });
+     *
+     * // Received on the other devices:
+     * sos.sync.onValue((key, value, groupName) => {
+     * 	console.log(`Received value for key ${key} in group ${groupName}:`, value);
+     * });
+     *
      */
     broadcastValue({ groupName, key, value }: {
         groupName?: string;
@@ -168,13 +241,16 @@ export default class Sync implements ISync {
      * Returns true if the device is currently the master of the group.
      *
      * @param groupName The group name to check for master status. Defaults to the default group.
-     *
+     * @return {Promise<boolean>} A promise that resolves with true if the device is the master, false otherwise.
      * @since 6.7.0
      */
     isMaster(groupName?: string): Promise<boolean>;
     /**
      * The `onValue()` method sets up a listener, which is called whenever the device receives a broadcasted message.
      *
+     * @param listener The listener function to call when a value is broadcasted.
+     * @returns {void} Returns when listener is set up.
+     * @throws Error If the listener is not a function.
      * @since 2.0.0
      */
     onValue(listener: (key: string, value: any, groupName?: string) => void): void;
@@ -182,14 +258,20 @@ export default class Sync implements ISync {
      * The `onStatus()` method sets up a listener, which is called periodically or whenever there is a change (i.e. new device
      * connects/disconnects to/from the group).
      *
+     * @param listener The listener function to call when the status changes.
+     * @returns {void} Returns when listener is set up.
+     * @throws Error If the listener is not a function.
      * @since 2.1.0
      */
     onStatus(listener: (status: StatusEvent) => void): void;
     /**
-     * The `onStatus()` method sets up a listener, which is called whenever the device is disconnected from the sync. If it closed because
+     * The `onClosed()` method sets up a listener, which is called whenever the device is disconnected from the sync. If it closed because
      * `close()` was called, it will emit without any arguments. if it closed because of an error, it will emit with an error object as the
      * first argument.
      *
+     * @param listener The listener function to call when the sync is closed.
+     * @returns {void} Returns when listener is set up.
+     * @throws Error If the listener is not a function.
      * @since 5.12.0
      */
     onClosed(listener: (error?: Error) => void): void;
@@ -203,3 +285,4 @@ export default class Sync implements ISync {
     handleMessageData(data: BroadcastedValueMessage | StatusMessage | ClosedMessage): void;
     private getMessage;
 }
+export {};

package/es6/FrontApplet/Sync/Sync.js

@@ -7,6 +7,10 @@ exports.SyncEngine = void 0;
 const events_1 = require("events");
 const syncMessages_1 = require("./syncMessages");
 const Validate_1 = __importDefault(require("../Validate/Validate"));
+/**
+ * The `SyncEngine` enum defines the available synchronization engines that can be used to synchronize devices.
+ * Each engine has its own method of connecting devices and synchronizing data.
+ */
 var SyncEngine;
 (function (SyncEngine) {
     /** Use external sync server. Device will connect to the server via websocket. */
@@ -72,6 +76,8 @@ class Sync {
      * The `close()` method disconnects the device from synchronization server and other devices. Recommended to call this method after the
      * synchronization is not required any longer.
      *
+     * @returns {Promise<void>} A promise that resolves when the connection is closed.
+     * @throws Error If unable to close the connection.
      * @since 1.0.32
      */
     async close() {
@@ -90,11 +96,18 @@ class Sync {
      * The `joinGroup()` method joins a group of other devices. This method has to be called after `connect()` call. Before any communication
      * takes place, all participating devices have to be connected and recognize one another. Recommended to call this method early.
      *
-     * @param options.groupName By default, all devices will be synced together. To create groups of devices, independent from each other,
-     * specify a group name.
-     * @param options.deviceIdentification Identification of a device connected to `groupName` group.
-     *
+     * @param options Options for joining a group.
+     * @returns {Promise<void>} A promise that resolves when the device joins the group.
+     * @throws Error If the group name is not a string.
+     * @throws Error If the device identification is not a string.
+     * @throws Error If unable to join the group.
+     * @throws Error If any other error occurs during joining the group.
      * @since 5.7.0
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/sync-video | How to use synchronizer in applet}
+     * @example
+     * await sos.sync.connect();
+     * await sos.sync.joinGroup({ groupName: 'my-group', deviceIdentification: 'my-device-id' });
      */
     async joinGroup(options) {
         const { groupName = Sync.DEFAULT_GROUP_NAME, deviceIdentification } = options;
@@ -109,7 +122,15 @@ class Sync {
     /**
      * The `leaveMethod` method leaves a group of devices.
      *
+     * @param groupName The name of the group to leave. Defaults to the default group.
+     * @returns {Promise<void>} A promise that resolves when the device leaves the group.
+     * @throws Error If the group name is not a string.
+     * @throws Error If unable to leave the group.
+     * @throws Error If any other error occurs during leaving the group.
      * @since 5.7.0
+     *
+     * @example
+     * await sos.sync.leaveGroup('my-group');
      */
     async leaveGroup(groupName = Sync.DEFAULT_GROUP_NAME) {
         (0, Validate_1.default)({ groupName }).required().string();
@@ -134,7 +155,22 @@ class Sync {
      * Therefore, when implementing your applet you should rely on the result data and not the data that is passed to the wait method as an
      * argument.
      *
+     * @param data Optional data to pass to the group.
+     * @param groupName The name of the group to wait for. Defaults to the default group.
+     * @param timeout Timeout in milliseconds. If not specified, the default timeout is 30 seconds.
+     * @returns {Promise<any>} A promise that resolves with the data from the master device when all devices are ready to continue.
+     * @throws Error If the group name is not a string.
+     * @throws Error If the timeout is not a number.
+     * @throws Error If unable to wait for the group.
+     * @throws Error If any other error occurs during waiting for the group.
      * @since 1.0.32
+     *
+     * @example
+     * // wait for all devices in the group to be ready
+     * await sos.sync.wait('someData', 'someRandomNameGroup').then((data) => {
+     *     // this will be called once all devices are ready
+     *     console.log('All devices are ready with data:', data);
+     * });
      */
     async wait(data, groupName = Sync.DEFAULT_GROUP_NAME, timeout) {
         (0, Validate_1.default)({ groupName }).required().string();
@@ -150,16 +186,23 @@ class Sync {
     /**
      * The `cancelWait()` method aborts a wait on all devices in a group. Sometimes it's necessary to cancel a pending wait. One such
      * situation would be when the group has to make a sudden change in content or another behavior but there's a risk that part of the group
-     * already called wait() and is waiting for the rest but the rest will never call it at this point. In order to gracefully cleanup any
+     * already called wait() and is waiting for the rest but the rest will never call it at this point. In order to gracefully clean up any
      * pending activity, use this method.
      *
+     * :::warning
      * Any pending wait will be canceled and the promise will be rejected with an error.
+     * :::
      *
+     * @param groupName The name of the group to cancel the wait for. Defaults to the default group.
+     * @returns {Promise<void>} A promise that resolves when the wait is canceled.
+     * @throws Error If the group name is not a string.
+     * @throws Error If unable to cancel the wait.
+     * @throws Error If any other error occurs during canceling the wait.
      * @since 5.12.0
      *
      * @example
      * sos.sync.wait('someData', 'someRandomNameGroup').catch((err) => {
-     *     // this will happend once cancelWait is called
+     *     // this will happen once cancelWait is called
      *     console.error('wait failed', err);
      * });
      *
@@ -183,9 +226,30 @@ class Sync {
     /**
      * The `broadcastValue()` method sends a key-value pair to all other devices in a specified group.
      *
-     * @throws if the value can't be sent
-     *
+     * @param groupName {String} The name of the group to broadcast the value to. Defaults to the default group.
+     * @param key {String} The key to broadcast the value under.
+     * @param value {any} The value to broadcast. It can be any valid type
+     * @returns {Promise<void>} A promise that resolves when the value is broadcasted.
+     * @throws Error If the group name is not a string.
+     * @throws Error If the key is not a string.
+     * @throws Error If the value is not a valid type (e.g. object, array, etc.).
+     * @throws Error If unable to broadcast the value.
+     * @throws Error If the value can't be sent
      * @since 5.7.0
+     *
+     * @example
+     * // broadcast a value to all devices in the group
+     * await sos.sync.broadcastValue({
+     * 	groupName: 'my-group',
+     * 	key: 'my-key',
+     * 	value: 'my-value',
+     * });
+     *
+     * // Received on the other devices:
+     * sos.sync.onValue((key, value, groupName) => {
+     * 	console.log(`Received value for key ${key} in group ${groupName}:`, value);
+     * });
+     *
      */
     async broadcastValue({ groupName, key, value }) {
         groupName = groupName ?? Sync.DEFAULT_GROUP_NAME;
@@ -202,7 +266,7 @@ class Sync {
      * Returns true if the device is currently the master of the group.
      *
      * @param groupName The group name to check for master status. Defaults to the default group.
-     *
+     * @return {Promise<boolean>} A promise that resolves with true if the device is the master, false otherwise.
      * @since 6.7.0
      */
     async isMaster(groupName) {
@@ -215,6 +279,9 @@ class Sync {
     /**
      * The `onValue()` method sets up a listener, which is called whenever the device receives a broadcasted message.
      *
+     * @param listener The listener function to call when a value is broadcasted.
+     * @returns {void} Returns when listener is set up.
+     * @throws Error If the listener is not a function.
      * @since 2.0.0
      */
     onValue(listener) {
@@ -227,6 +294,9 @@ class Sync {
      * The `onStatus()` method sets up a listener, which is called periodically or whenever there is a change (i.e. new device
      * connects/disconnects to/from the group).
      *
+     * @param listener The listener function to call when the status changes.
+     * @returns {void} Returns when listener is set up.
+     * @throws Error If the listener is not a function.
      * @since 2.1.0
      */
     onStatus(listener) {
@@ -240,10 +310,13 @@ class Sync {
         });
     }
     /**
-     * The `onStatus()` method sets up a listener, which is called whenever the device is disconnected from the sync. If it closed because
+     * The `onClosed()` method sets up a listener, which is called whenever the device is disconnected from the sync. If it closed because
      * `close()` was called, it will emit without any arguments. if it closed because of an error, it will emit with an error object as the
      * first argument.
      *
+     * @param listener The listener function to call when the sync is closed.
+     * @returns {void} Returns when listener is set up.
+     * @throws Error If the listener is not a function.
      * @since 5.12.0
      */
     onClosed(listener) {
@@ -283,6 +356,7 @@ class Sync {
                 const closedMessage = data;
                 const closedEvent = closedMessage.error ? new Error(closedMessage.error) : undefined;
                 this.eventEmitter.emit(SyncEvent.Closed, closedEvent);
+                break;
             default:
         }
     }