@signageos/front-applet 7.2.0 → 8.0.1

package/es6/FrontApplet/Offline/Offline.d.ts

@@ -1,10 +1,23 @@
+import IPostMessage from '../IPostMessage';
 import Cache from './Cache/Cache';
-import { ITypes } from './Types';
+import AppendFlagController from './Flags/AppendFlagController';
 import IFlags from './Flags/IFlags';
-import IPostMessage from '../IPostMessage';
+import { IAddFont } from './IAddFont';
 import ISaveFile from './ISaveFile';
 import ILoadFile from './LoadFile/ILoadFile';
-import { IAddFont } from './IAddFont';
+import { ITypes } from './Types';
+type FlagControllers = {
+    append: AppendFlagController;
+};
+/**
+ * The `sos.offline` API groups together methods for storing and using JS, CSS and font files.
+ *
+ * :::warning
+ *
+ * Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138)
+ *
+ * :::
+ */
 export default class Offline {
     private messagePrefix;
     private window;
@@ -13,15 +26,73 @@ export default class Offline {
     readonly cache: Cache;
     readonly types: ITypes;
     readonly loadFile: ILoadFile;
-    readonly flags: IFlags;
+    readonly flags: IFlags<FlagControllers>;
     private flagControllers;
     private FlagControllers;
     private LoadFileControllers;
+    /** @internal */
     constructor(messagePrefix: string, window: Window, postMessage: IPostMessage<any>);
+    /**
+     * The `addFiles()` method downloads the specified files and stores them locally. The order in which the files are downloaded and stored is **not** guaranteed.
+     *
+     * @since 1.0.0
+     *
+     * @example
+     * await sos.offline.addFile([{
+     * 	uri: 'https://unpkg.com/normalize.css@8.0.1/normalize.css',
+     * 	uid: 'normalize.css',
+     * 	type: sos.offline.types.css,
+     * 	flags: [sos.offline.flags.append(document.head)],
+     * }, {
+     * 	uri: 'https://code.jquery.com/jquery-3.7.1.slim.min.js',
+     * 	uid: 'jquery-3.7.1.slim.min.js',
+     * 	type: sos.offline.types.javascript,
+     * 	flags: [sos.offline.flags.append(document.body)],
+     * }]);
+     */
     addFiles(files: ISaveFile[]): Promise<void[]>;
+    /**
+     * The `addFilesSync()` method downloads the specified files and stores them locally. The order in which the files are downloaded and stored **is** guaranteed.
+     *
+     * @since 1.0.0
+     */
     addFilesSync(files: ISaveFile[]): Promise<void>;
+    /**
+     * The `addFile()` method downloads the specified file and stores it locally.
+     *
+     * @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)],
+     * });
+     */
     addFile(file: ISaveFile): Promise<void>;
+    /**
+     * The `addFont()` method downloads the specified file and stores it locally. You should use this method for loading fonts instead of
+     * using `addFile()`, because it also generates appropriate font-face definition.
+     *
+     * @param font.uid Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 and . characters.
+     * @param font.append Reference to HTMLElement where the generated font-face will resist.
+     * @param font.fontFamily Font family that can be referenced from your CSS.
+     * @param font.formats URI where these formats will be downloaded from.
+     * @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.formats Dictionary of supported formats with its files
+     *
+     * @since 2.0.0
+     */
     addFont(font: IAddFont): Promise<void>;
     private handleFileFlag;
     private getMessagePrefix;
 }
+export {};

package/es6/FrontApplet/Offline/Offline.js

@@ -1,30 +1,43 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Cache_1 = require("./Cache/Cache");
-const Types_1 = require("./Types");
-const AppendFlagController_1 = require("./Flags/AppendFlagController");
-const ISaveFile_1 = require("./ISaveFile");
-const JavascriptLoadFileController_1 = require("./LoadFile/JavascriptLoadFileController");
-const CssLoadFileController_1 = require("./LoadFile/CssLoadFileController");
-const IAddFont_1 = require("./IAddFont");
 const fontFaceGenerator_1 = require("../Font/fontFaceGenerator");
-const Validate_1 = require("../Validate/Validate");
+const Validate_1 = __importDefault(require("../Validate/Validate"));
+const Cache_1 = __importDefault(require("./Cache/Cache"));
+const AppendFlagController_1 = __importDefault(require("./Flags/AppendFlagController"));
+const IAddFont_1 = require("./IAddFont");
+const ISaveFile_1 = require("./ISaveFile");
+const CssLoadFileController_1 = __importDefault(require("./LoadFile/CssLoadFileController"));
+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.
+ *
+ * :::warning
+ *
+ * Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138)
+ *
+ * :::
+ */
 class Offline {
+    messagePrefix;
+    window;
+    postMessage;
+    static MESSAGE_PREFIX = 'offline';
+    cache;
+    types;
+    loadFile;
+    flags;
+    flagControllers;
+    FlagControllers = [AppendFlagController_1.default];
+    LoadFileControllers = [JavascriptLoadFileController_1.default, CssLoadFileController_1.default];
+    /** @internal */
     constructor(messagePrefix, window, postMessage) {
         this.messagePrefix = messagePrefix;
         this.window = window;
         this.postMessage = postMessage;
-        this.FlagControllers = [AppendFlagController_1.default];
-        this.LoadFileControllers = [JavascriptLoadFileController_1.default, CssLoadFileController_1.default];
         this.cache = new Cache_1.default(this.getMessagePrefix(), this.postMessage);
         this.types = Types_1.default;
         this.loadFile = this.LoadFileControllers.reduce((loadFile, LoadFileController) => {
@@ -39,62 +52,109 @@ class Offline {
         }, {});
         this.flags = Object.keys(this.flagControllers).reduce((flags, flagControllerName) => {
             const flagController = this.flagControllers[flagControllerName];
-            flags[flagController.name] = (...args) => flagController.create(...args);
+            flags[flagController.name] = flagController.create.bind(flagController);
             return flags;
         }, {
             append: null,
         });
     }
+    /**
+     * The `addFiles()` method downloads the specified files and stores them locally. The order in which the files are downloaded and stored is **not** guaranteed.
+     *
+     * @since 1.0.0
+     *
+     * @example
+     * await sos.offline.addFile([{
+     * 	uri: 'https://unpkg.com/normalize.css@8.0.1/normalize.css',
+     * 	uid: 'normalize.css',
+     * 	type: sos.offline.types.css,
+     * 	flags: [sos.offline.flags.append(document.head)],
+     * }, {
+     * 	uri: 'https://code.jquery.com/jquery-3.7.1.slim.min.js',
+     * 	uid: 'jquery-3.7.1.slim.min.js',
+     * 	type: sos.offline.types.javascript,
+     * 	flags: [sos.offline.flags.append(document.body)],
+     * }]);
+     */
     addFiles(files) {
         (0, Validate_1.default)({ addFiles: files }).required().array('object');
         const promises = files.map((addFile) => this.addFile(addFile));
         return Promise.all(promises);
     }
-    addFilesSync(files) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ addFiles: files }).required().array('object');
-            for (let file of files) {
-                yield this.addFile(file);
-            }
-        });
+    /**
+     * The `addFilesSync()` method downloads the specified files and stores them locally. The order in which the files are downloaded and stored **is** guaranteed.
+     *
+     * @since 1.0.0
+     */
+    async addFilesSync(files) {
+        (0, Validate_1.default)({ addFiles: files }).required().array('object');
+        for (let file of files) {
+            await this.addFile(file);
+        }
     }
-    addFile(file) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ addFile: file }).required().object(ISaveFile_1.VISaveFile);
-            const savedFile = yield this.cache.loadOrSaveFile(file.uid, file.uri, file.headers);
-            const flags = file.flags || [];
-            for (let flag of flags) {
-                yield this.handleFileFlag(flag, savedFile, file.type);
-            }
-        });
+    /**
+     * The `addFile()` method downloads the specified file and stores it locally.
+     *
+     * @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)],
+     * });
+     */
+    async addFile(file) {
+        (0, Validate_1.default)({ addFile: file }).required().object(ISaveFile_1.VISaveFile);
+        const savedFile = await this.cache.loadOrSaveFile(file.uid, file.uri, file.headers);
+        const flags = file.flags || [];
+        for (let flag of flags) {
+            await this.handleFileFlag(flag, savedFile, file.type);
+        }
     }
-    addFont(font) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ addFont: font }).required().object(IAddFont_1.VIAddFont);
-            const fontGenerator = (0, fontFaceGenerator_1.fontFaceGenerator)(this.window, font);
-            const downloadingFonts = Object.keys(font.formats).map((fontExtension) => __awaiter(this, void 0, void 0, function* () {
-                const file = yield this.cache.loadOrSaveFile((0, fontFaceGenerator_1.generateFontUid)(font.uid, fontExtension), font.formats[fontExtension]);
-                fontGenerator.setFormat(fontExtension, file.filePath);
-            }));
-            yield Promise.all(downloadingFonts);
-            const styleElement = fontGenerator.generateStyleElement();
-            font.append.appendChild(styleElement);
+    /**
+     * The `addFont()` method downloads the specified file and stores it locally. You should use this method for loading fonts instead of
+     * using `addFile()`, because it also generates appropriate font-face definition.
+     *
+     * @param font.uid Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 and . characters.
+     * @param font.append Reference to HTMLElement where the generated font-face will resist.
+     * @param font.fontFamily Font family that can be referenced from your CSS.
+     * @param font.formats URI where these formats will be downloaded from.
+     * @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.formats Dictionary of supported formats with its files
+     *
+     * @since 2.0.0
+     */
+    async addFont(font) {
+        (0, Validate_1.default)({ addFont: font }).required().object(IAddFont_1.VIAddFont);
+        const fontGenerator = (0, fontFaceGenerator_1.fontFaceGenerator)(this.window, font);
+        const downloadingFonts = Object.keys(font.formats).map(async (fontExtension) => {
+            const file = await this.cache.loadOrSaveFile((0, fontFaceGenerator_1.generateFontUid)(font.uid, fontExtension), font.formats[fontExtension]);
+            fontGenerator.setFormat(fontExtension, file.filePath);
         });
+        await Promise.all(downloadingFonts);
+        const styleElement = fontGenerator.generateStyleElement();
+        font.append.appendChild(styleElement);
     }
-    handleFileFlag(flag, file, fileType) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const flagController = this.flagControllers[flag.type];
-            if (typeof flagController === 'undefined') {
-                throw new Error('Not implemented apply flag ' + flag.type);
-            }
-            const filePath = file.filePath;
-            yield flagController.applyFlag(flag, fileType, filePath);
-        });
+    async handleFileFlag(flag, file, fileType) {
+        const flagController = this.flagControllers[flag.type];
+        if (typeof flagController === 'undefined') {
+            throw new Error('Not implemented apply flag ' + flag.type);
+        }
+        const filePath = file.filePath;
+        await flagController.applyFlag(flag, fileType, filePath);
     }
     getMessagePrefix() {
         return this.messagePrefix + '.' + Offline.MESSAGE_PREFIX;
     }
 }
-Offline.MESSAGE_PREFIX = 'offline';
 exports.default = Offline;
 //# sourceMappingURL=Offline.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"Offline.js","sourceRoot":"","sources":["../../../src/FrontApplet/Offline/Offline.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,yCAAkC;AAClC,mCAAwC;AAExC,uEAAgE;AAIhE,2CAAoD;AAKpD,0FAAmF;AACnF,4EAAqE;AACrE,yCAA+D;AAC/D,iEAA+E;AAC/E,mDAA4C;AAE5C,MAAqB,OAAO;IAW3B,YACS,aAAqB,EACrB,MAAc,EACd,WAA8B;QAF9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,WAAM,GAAN,MAAM,CAAQ;QACd,gBAAW,GAAX,WAAW,CAAmB;QAN/B,oBAAe,GAA4B,CAAC,8BAAoB,CAAC,CAAC;QAClE,wBAAmB,GAAgC,CAAC,sCAA4B,EAAE,+BAAqB,CAAC,CAAC;QAOhH,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,CACjD,CAAC,eAAoD,EAAE,cAAqC,EAAE,EAAE;YAC/F,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,EACD,EAAE,CACF,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,CACpD,CAAC,KAAa,EAAE,kBAA0B,EAAE,EAAE;YAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;YAChE,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;YAChF,OAAO,KAAK,CAAC;QACd,CAAC,EACD;YACC,MAAM,EAAE,IAAW;SACnB,CACD,CAAC;IACH,CAAC;IAEM,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;IAEY,YAAY,CAAC,KAAkB;;YAC3C,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAEzD,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE;gBACvB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACzB;QACF,CAAC;KAAA;IAEY,OAAO,CAAC,IAAe;;YACnC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,sBAAU,CAAC,CAAC;YAE1D,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAEpF,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAC/B,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE;gBACvB,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;aACtD;QACF,CAAC;KAAA;IAEY,OAAO,CAAC,IAAc;;YAClC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,oBAAS,CAAC,CAAC;YACzD,MAAM,aAAa,GAAG,IAAA,qCAAiB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAE3D,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAO,aAAiC,EAAE,EAAE;gBAClG,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;gBACrH,aAAa,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvD,CAAC,CAAA,CAAC,CAAC;YACH,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YAEpC,MAAM,YAAY,GAAG,aAAa,CAAC,oBAAoB,EAAE,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACvC,CAAC;KAAA;IAEa,cAAc,CAAC,IAAW,EAAE,IAAW,EAAE,QAAmB;;YACzE,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvD,IAAI,OAAO,cAAc,KAAK,WAAW,EAAE;gBAC1C,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;aAC3D;YACD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YAC/B,MAAM,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC1D,CAAC;KAAA;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC;IAC1D,CAAC;;AA5Fa,sBAAc,GAAW,SAAS,AAApB,CAAqB;kBAD7B,OAAO"}
+{"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;;;;;;;;GAQG;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"}

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

@@ -3,6 +3,24 @@ import IRecordItemOptions from './IRecordItemOptions';
 import IProofOfPlay from './IProofOfPlay';
 export default class ProofOfPlay implements IProofOfPlay {
     private commandApi;
+    /** @internal */
     constructor(commandApi: CommandApi);
-    recordItemPlayed({ name, customId, type, tags, fileName, playbackSuccess, errorMessage }: IRecordItemOptions): Promise<void>;
+    /**
+     * 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.
+     *
+     * @since 5.5.1
+     *
+     * @example
+     * await sos.proofOfPlay.recordItemPlayed({
+     *   name: 'generic-brand-christmas-coffee-ad',
+     *   customId: 'dBE43bFB3312VFfvd34bgGHJVV334cd2',
+     *   type: 'video',
+     *   tags: ['generic-brand', 'christmas'],
+     *   fileName: 'coffee.mp4',
+     *   playbackSuccess: false,
+     *   errorMessage: 'Unsupported framerate 60fps',
+     * });
+     */
+    recordItemPlayed(options: IRecordItemOptions): Promise<void>;
 }

package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js

@@ -1,39 +1,51 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Validate_1 = require("../Validate/Validate");
-const ProofOfPlayType_1 = require("./ProofOfPlayType");
+const Validate_1 = __importDefault(require("../Validate/Validate"));
+const ProofOfPlayType_1 = __importDefault(require("./ProofOfPlayType"));
 class ProofOfPlay {
+    commandApi;
+    /** @internal */
     constructor(commandApi) {
         this.commandApi = commandApi;
     }
-    recordItemPlayed({ name, customId, type, tags, fileName, playbackSuccess, errorMessage }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ name }).required().string();
-            (0, Validate_1.default)({ customId }).string();
-            (0, Validate_1.default)({ type }).string(['video', 'image', 'html', 'custom']);
-            (0, Validate_1.default)({ tags }).array('string');
-            (0, Validate_1.default)({ fileName }).string();
-            (0, Validate_1.default)({ playbackSuccess }).boolean();
-            (0, Validate_1.default)({ errorMessage }).string();
-            yield this.commandApi.dispatch({
-                type: ProofOfPlayType_1.default.ItemPlayed,
-                itemName: name,
-                customId,
-                itemType: type,
-                itemTags: tags,
-                fileName,
-                playbackSuccess,
-                errorMessage,
-            });
+    /**
+     * 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.
+     *
+     * @since 5.5.1
+     *
+     * @example
+     * await sos.proofOfPlay.recordItemPlayed({
+     *   name: 'generic-brand-christmas-coffee-ad',
+     *   customId: 'dBE43bFB3312VFfvd34bgGHJVV334cd2',
+     *   type: 'video',
+     *   tags: ['generic-brand', 'christmas'],
+     *   fileName: 'coffee.mp4',
+     *   playbackSuccess: false,
+     *   errorMessage: 'Unsupported framerate 60fps',
+     * });
+     */
+    async recordItemPlayed(options) {
+        const { name, customId, type, tags, fileName, playbackSuccess, errorMessage } = options;
+        (0, Validate_1.default)({ name }).required().string();
+        (0, Validate_1.default)({ customId }).string();
+        (0, Validate_1.default)({ type }).string(['video', 'image', 'html', 'custom']);
+        (0, Validate_1.default)({ tags }).array('string');
+        (0, Validate_1.default)({ fileName }).string();
+        (0, Validate_1.default)({ playbackSuccess }).boolean();
+        (0, Validate_1.default)({ errorMessage }).string();
+        await this.commandApi.dispatch({
+            type: ProofOfPlayType_1.default.ItemPlayed,
+            itemName: name,
+            customId,
+            itemType: type,
+            itemTags: tags,
+            fileName,
+            playbackSuccess,
+            errorMessage,
         });
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ProofOfPlay.js","sourceRoot":"","sources":["../../../src/FrontApplet/ProofOfPlay/ProofOfPlay.ts"],"names":[],"mappings":";;;;;;;;;;;AAEA,mDAA4C;AAC5C,uDAAgD;AAGhD,MAAqB,WAAW;IAC/B,YAAoB,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;IAEjC,gBAAgB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAsB;;YACxH,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YACvC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YAChC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;YAChE,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YAChC,IAAA,kBAAQ,EAAC,EAAE,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;YACxC,IAAA,kBAAQ,EAAC,EAAE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YAEpC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;gBAC9B,IAAI,EAAE,yBAAe,CAAC,UAAU;gBAChC,QAAQ,EAAE,IAAI;gBACd,QAAQ;gBACR,QAAQ,EAAE,IAAI;gBACd,QAAQ,EAAE,IAAI;gBACd,QAAQ;gBACR,eAAe;gBACf,YAAY;aACZ,CAAC,CAAC;QACJ,CAAC;KAAA;CACD;AAvBD,8BAuBC"}
+{"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;;;;;;;;;;;;;;;;OAgBG;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;AA1CD,8BA0CC"}

package/es6/FrontApplet/Sensors/Proximity.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
 import IMessage from '../IMessage';
 import IProximity from './IProximity';
 export interface IStateChangeMessage extends IMessage {
@@ -10,8 +8,11 @@ export default class Proximity implements IProximity {
     static MESSAGE_PREFIX: string;
     private eventEmitter;
     private lastDetected;
+    /** @internal */
     constructor(messagePrefix: string);
-    onStateChange(callback: (detected: boolean) => void): () => EventEmitter;
+    /** @internal */
+    onStateChange(callback: (detected: boolean) => void): () => void;
+    /** @internal */
     handleMessageData(data: IStateChangeMessage): void;
     private getMessage;
 }

package/es6/FrontApplet/Sensors/Proximity.js

@@ -1,21 +1,30 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const events_1 = require("events");
-const Validate_1 = require("../Validate/Validate");
+const Validate_1 = __importDefault(require("../Validate/Validate"));
 class Proximity {
+    messagePrefix;
+    static MESSAGE_PREFIX = 'proximity';
+    eventEmitter;
+    lastDetected = false;
+    /** @internal */
     constructor(messagePrefix) {
         this.messagePrefix = messagePrefix;
-        this.lastDetected = false;
         this.eventEmitter = new events_1.EventEmitter();
     }
+    /** @internal */
     onStateChange(callback) {
         (0, Validate_1.default)({ callback }).required().function();
         if (this.lastDetected) {
             callback(this.lastDetected);
         }
         this.eventEmitter.addListener('change', callback);
-        return () => this.eventEmitter.removeListener('change', callback);
+        return () => void this.eventEmitter.removeListener('change', callback);
     }
+    /** @internal */
     handleMessageData(data) {
         switch (data.type) {
             case this.getMessage('change'):
@@ -31,6 +40,5 @@ class Proximity {
         return this.messagePrefix + '.' + Proximity.MESSAGE_PREFIX + '.' + name;
     }
 }
-Proximity.MESSAGE_PREFIX = 'proximity';
 exports.default = Proximity;
 //# sourceMappingURL=Proximity.js.map

package/es6/FrontApplet/Sensors/Proximity.js.map

@@ -1 +1 @@
-{"version":3,"file":"Proximity.js","sourceRoot":"","sources":["../../../src/FrontApplet/Sensors/Proximity.ts"],"names":[],"mappings":";;AAAA,mCAAsC;AAEtC,mDAA4C;AAO5C,MAAqB,SAAS;IAM7B,YAAoB,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QAFjC,iBAAY,GAAY,KAAK,CAAC;QAGrC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IACxC,CAAC;IAEM,aAAa,CAAC,QAAqC;QACzD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,IAAI,CAAC,YAAY,EAAE;YACtB,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC5B;QACD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAClD,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACnE,CAAC;IAEM,iBAAiB,CAAC,IAAyB;QACjD,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClB,KAAK,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;gBAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,YAAY,EAAE;oBACxC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC;oBAClC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;iBAChD;gBACD,MAAM;YACP,QAAQ;SACR;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,SAAS,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACzE,CAAC;;AAhCa,wBAAc,GAAW,WAAW,AAAtB,CAAuB;kBAD/B,SAAS"}
+{"version":3,"file":"Proximity.js","sourceRoot":"","sources":["../../../src/FrontApplet/Sensors/Proximity.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,oEAA4C;AAO5C,MAAqB,SAAS;IAOT;IANb,MAAM,CAAC,cAAc,GAAW,WAAW,CAAC;IAE3C,YAAY,CAAe;IAC3B,YAAY,GAAY,KAAK,CAAC;IAEtC,gBAAgB;IAChB,YAAoB,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QACxC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IACxC,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,QAAqC;QACzD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAClD,OAAO,GAAG,EAAE,CAAC,KAAK,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAyB;QACjD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;gBAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC;oBACzC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC;oBAClC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACjD,CAAC;gBACD,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,SAAS,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACzE,CAAC;;AApCF,4BAqCC"}

package/es6/FrontApplet/Sensors/Sensors.d.ts

@@ -4,7 +4,9 @@ export default class Sensors {
     private messagePrefix;
     static MESSAGE_PREFIX: string;
     readonly proximity: Proximity;
+    /** @internal */
     constructor(messagePrefix: string);
+    /** @internal */
     handleMessageData(data: ISensorMessage): void;
     private getMessagePrefix;
 }

package/es6/FrontApplet/Sensors/Sensors.js

@@ -1,11 +1,19 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const Proximity_1 = require("./Proximity");
+const Proximity_1 = __importDefault(require("./Proximity"));
 class Sensors {
+    messagePrefix;
+    static MESSAGE_PREFIX = 'sensors';
+    proximity;
+    /** @internal */
     constructor(messagePrefix) {
         this.messagePrefix = messagePrefix;
         this.proximity = new Proximity_1.default(this.getMessagePrefix());
     }
+    /** @internal */
     handleMessageData(data) {
         this.proximity.handleMessageData(data);
     }
@@ -13,6 +21,5 @@ class Sensors {
         return this.messagePrefix + '.' + Sensors.MESSAGE_PREFIX;
     }
 }
-Sensors.MESSAGE_PREFIX = 'sensors';
 exports.default = Sensors;
 //# sourceMappingURL=Sensors.js.map

package/es6/FrontApplet/Sensors/Sensors.js.map

@@ -1 +1 @@
-{"version":3,"file":"Sensors.js","sourceRoot":"","sources":["../../../src/FrontApplet/Sensors/Sensors.ts"],"names":[],"mappings":";;AAAA,2CAA6F;AAI7F,MAAqB,OAAO;IAK3B,YAAoB,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QACxC,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACzD,CAAC;IAEM,iBAAiB,CAAC,IAAoB;QAC5C,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAoC,CAAC,CAAC;IACxE,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC;IAC1D,CAAC;;AAda,sBAAc,GAAW,SAAS,CAAC;kBAD7B,OAAO"}
+{"version":3,"file":"Sensors.js","sourceRoot":"","sources":["../../../src/FrontApplet/Sensors/Sensors.ts"],"names":[],"mappings":";;;;;AAAA,4DAA6F;AAI7F,MAAqB,OAAO;IAMP;IALb,MAAM,CAAC,cAAc,GAAW,SAAS,CAAC;IAEjC,SAAS,CAAY;IAErC,gBAAgB;IAChB,YAAoB,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QACxC,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAoB;QAC5C,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAoC,CAAC,CAAC;IACxE,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC;IAC1D,CAAC;;AAjBF,0BAkBC"}

package/es6/FrontApplet/Stream/IStream.d.ts

@@ -2,7 +2,7 @@ import { IStreamOptions, IStreamPrepareOptions } from '../Video/IOptions';
 import StreamProtocol from './StreamProtocol';
 import IVideoProperties from '../Video/IVideoProperties';
 import { ITrackInfo, TrackType } from './IStreamTrackInfo';
-import { IStreamErrorEventListener, IStreamEventListener, IStreamTracksChangedEventListener } from './streamListeners';
+import { IStreamErrorEvent, IStreamEvent, IStreamTracksChangedEvent } from './streamEvents';
 export default interface IStream {
     prepare(uri: string, x: number, y: number, width: number, height: number, options?: IStreamPrepareOptions | keyof typeof StreamProtocol): Promise<void>;
     play(uri: string, x: number, y: number, width: number, height: number, options?: IStreamOptions | keyof typeof StreamProtocol): Promise<void>;
@@ -12,13 +12,13 @@ export default interface IStream {
     getTracks(videoId: IVideoProperties): Promise<ITrackInfo[]>;
     selectTrack(videoId: IVideoProperties, trackType: TrackType, groupId: string, trackIndex: number): Promise<void>;
     resetTrack(videoId: IVideoProperties, trackType: TrackType, groupId?: string): Promise<void>;
-    onTracksChanged(listener: IStreamTracksChangedEventListener): void;
-    onError(listener: IStreamErrorEventListener): void;
-    onConnected(listener: IStreamEventListener<'connected'>): void;
-    onDisconnected(listener: IStreamEventListener<'disconnected'>): void;
-    onPrepare(listener: IStreamEventListener<'prepare'>): void;
-    onPlay(listener: IStreamEventListener<'play'>): void;
-    onStop(listener: IStreamEventListener<'stop'>): void;
-    onPause(listener: IStreamEventListener<'pause'>): void;
-    onResume(listener: IStreamEventListener<'resume'>): void;
+    onTracksChanged(listener: (event: IStreamTracksChangedEvent) => void): void;
+    onError(listener: (event: IStreamErrorEvent) => void): void;
+    onConnected(listener: (event: IStreamEvent<'connected'>) => void): void;
+    onDisconnected(listener: (event: IStreamEvent<'disconnected'>) => void): void;
+    onPrepare(listener: (event: IStreamEvent<'prepare'>) => void): void;
+    onPlay(listener: (event: IStreamEvent<'play'>) => void): void;
+    onStop(listener: (event: IStreamEvent<'stop'>) => void): void;
+    onPause(listener: (event: IStreamEvent<'pause'>) => void): void;
+    onResume(listener: (event: IStreamEvent<'resume'>) => void): void;
 }