@signageos/front-applet 7.2.0 → 8.0.0

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

@@ -2,17 +2,81 @@ import IPostMessage from '../../IPostMessage';
 import { TimerType, ITimer } from '../helpers/TimerHelper';
 import { IProprietaryTimer, ProprietaryTimerType } from '../helpers/ProprietaryTimerHelper';
 import IPower from './IPower';
+/**
+ * The `sos.management.power` API groups together methods related to the power state of the device. Such as rebooting, shutting down,
+ * setting timers.
+ */
 export default class Power implements IPower {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `systemReboot()` method initializes a system reboot.
+     *
+     * @since 3.0.0
+     */
     systemReboot(): Promise<void>;
+    /**
+     * The `appRestart()` method initializes a restart of the signageOS app.
+     *
+     * @since 3.0.0
+     */
     appRestart(): Promise<void>;
+    /**
+     * The `getTimers()` method returns a list of currently set native timers.
+     *
+     * @since 4.0.0
+     */
     getTimers(): Promise<ITimer[]>;
+    /**
+     * The `setTimers()` method creates or updates a native timer.
+     *
+     * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
+     * @param timeOn The time when the device should turn on.
+     * @param timeOff The time when the device should turn off.
+     * @param weekdays The days of the week when the timer should be active (`mon`, ..., `sun`).
+     * @param volume The volume level set when the device is turned on.
+     *
+     * @since 3.0.0
+     */
     setTimer(type: keyof typeof TimerType, timeOn: string | null, timeOff: string | null, weekdays: string[], volume: number): Promise<void>;
+    /**
+     * The `unsetTimer()` method removes the specified native timer.
+     *
+     * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
+     *
+     * @since 4.0.0
+     */
     unsetTimer(type: keyof typeof TimerType): Promise<void>;
+    /**
+     * The `getProprietaryTimers()` method returns a list of currently set
+     * [proprietary timers](https://docs.signageos.io/hc/en-us/articles/4416384202642-Timers#h_01HCD14GEDP96AZV58NRSN2HNQ).
+     *
+     * @since 5.10.0
+     */
     getProprietaryTimers(): Promise<IProprietaryTimer[]>;
+    /**
+     * The `setProprietaryTimer()` method creates or updates a
+     * [proprietary timer](https://docs.signageos.io/hc/en-us/articles/4416384202642-Timers#h_01HCD14GEDP96AZV58NRSN2HNQ).
+     *
+     * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
+     * @param timeOn The time when the device should turn on.
+     * @param timeOff The time when the device should turn off.
+     * @param weekdays The days of the week when the timer should be active (`mon`, ..., `sun`).
+     * @param keepAppletRunning If `true`, the applet will be kept running when the timer is active on certain devices.
+     *
+     * @since 5.10.0
+     */
     setProprietaryTimer(type: ProprietaryTimerType, timeOn: string | null, timeOff: string | null, weekdays: string[], keepAppletRunning?: boolean): Promise<void>;
+    /**
+     * The `unsetProprietaryTimer()` method removes the specified
+     * [proprietary timer](https://docs.signageos.io/hc/en-us/articles/4416384202642-Timers#h_01HCD14GEDP96AZV58NRSN2HNQ).
+     *
+     * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
+     *
+     * @since 5.10.0
+     */
     unsetProprietaryTimer(type: ProprietaryTimerType): Promise<void>;
     private getMessage;
 }

package/es6/FrontApplet/Management/Power/Power.js

@@ -1,142 +1,187 @@
 "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 TimerHelper_1 = require("../helpers/TimerHelper");
-const Validate_1 = require("../../Validate/Validate");
+const Validate_1 = __importDefault(require("../../Validate/Validate"));
+// TODO: maybe a better description
+/**
+ * The `sos.management.power` API groups together methods related to the power state of the device. Such as rebooting, shutting down,
+ * setting timers.
+ */
 class Power {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    systemReboot() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.postMessage({
-                type: this.getMessage('reboot_system'),
-            });
+    /**
+     * The `systemReboot()` method initializes a system reboot.
+     *
+     * @since 3.0.0
+     */
+    async systemReboot() {
+        await this.postMessage({
+            type: this.getMessage('reboot_system'),
         });
     }
-    appRestart() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.postMessage({
-                type: this.getMessage('restart_app'),
-            });
+    /**
+     * The `appRestart()` method initializes a restart of the signageOS app.
+     *
+     * @since 3.0.0
+     */
+    async appRestart() {
+        await this.postMessage({
+            type: this.getMessage('restart_app'),
         });
     }
-    getTimers() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { timers } = yield this.postMessage({
-                type: this.getMessage('get_timers'),
-            });
-            return timers;
+    /**
+     * The `getTimers()` method returns a list of currently set native timers.
+     *
+     * @since 4.0.0
+     */
+    async getTimers() {
+        const { timers } = await this.postMessage({
+            type: this.getMessage('get_timers'),
         });
+        return timers;
     }
-    setTimer(type, timeOn, timeOff, weekdays, volume) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (typeof TimerHelper_1.TimerType[type] === 'undefined') {
-                throw new Error('Invalid timer type');
-            }
-            (0, Validate_1.default)({ timeOn })
-                .canBeNull()
-                .required()
-                .string()
-                .matchRegExp(/\d{2}:\d{2}:\d{2}/)
-                .timerTime();
-            (0, Validate_1.default)({ timeOff })
-                .canBeNull()
-                .required()
-                .string()
-                .matchRegExp(/\d{2}:\d{2}:\d{2}/)
-                .timerTime();
-            (0, Validate_1.default)({ weekdays }).required().array('string');
-            (0, Validate_1.default)({ volume }).required().number().min(0).max(100);
-            for (const weekday of weekdays) {
-                if (typeof TimerHelper_1.TimerWeekday[weekday] === 'undefined') {
-                    throw new Error('Invalid timer weekday');
-                }
+    /**
+     * The `setTimers()` method creates or updates a native timer.
+     *
+     * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
+     * @param timeOn The time when the device should turn on.
+     * @param timeOff The time when the device should turn off.
+     * @param weekdays The days of the week when the timer should be active (`mon`, ..., `sun`).
+     * @param volume The volume level set when the device is turned on.
+     *
+     * @since 3.0.0
+     */
+    async setTimer(type, timeOn, timeOff, weekdays, volume) {
+        if (typeof TimerHelper_1.TimerType[type] === 'undefined') {
+            throw new Error('Invalid timer type');
+        }
+        (0, Validate_1.default)({ timeOn })
+            .canBeNull()
+            .required()
+            .string()
+            .matchRegExp(/\d{2}:\d{2}:\d{2}/)
+            .timerTime();
+        (0, Validate_1.default)({ timeOff })
+            .canBeNull()
+            .required()
+            .string()
+            .matchRegExp(/\d{2}:\d{2}:\d{2}/)
+            .timerTime();
+        (0, Validate_1.default)({ weekdays }).required().array('string');
+        (0, Validate_1.default)({ volume }).required().number().min(0).max(100);
+        for (const weekday of weekdays) {
+            if (typeof TimerHelper_1.TimerWeekday[weekday] === 'undefined') {
+                throw new Error('Invalid timer weekday');
             }
-            yield this.postMessage({
-                type: this.getMessage('set_timer'),
-                timerType: type,
-                timeOn,
-                timeOff,
-                weekdays,
-                volume,
-            });
+        }
+        await this.postMessage({
+            type: this.getMessage('set_timer'),
+            timerType: type,
+            timeOn,
+            timeOff,
+            weekdays,
+            volume,
         });
     }
-    unsetTimer(type) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (typeof TimerHelper_1.TimerType[type] === 'undefined') {
-                console.warn('Invalid timer type');
-            }
-            yield this.setTimer(type, null, null, [], 0);
-        });
+    /**
+     * The `unsetTimer()` method removes the specified native timer.
+     *
+     * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
+     *
+     * @since 4.0.0
+     */
+    async unsetTimer(type) {
+        if (typeof TimerHelper_1.TimerType[type] === 'undefined') {
+            console.warn('Invalid timer type');
+        }
+        await this.setTimer(type, null, null, [], 0);
     }
-    getProprietaryTimers() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { timers } = yield this.postMessage({
-                type: this.getMessage('get_proprietary_timers'),
-            });
-            return timers;
+    /**
+     * The `getProprietaryTimers()` method returns a list of currently set
+     * [proprietary timers](https://docs.signageos.io/hc/en-us/articles/4416384202642-Timers#h_01HCD14GEDP96AZV58NRSN2HNQ).
+     *
+     * @since 5.10.0
+     */
+    async getProprietaryTimers() {
+        const { timers } = await this.postMessage({
+            type: this.getMessage('get_proprietary_timers'),
         });
+        return timers;
     }
-    setProprietaryTimer(type, timeOn, timeOff, weekdays, keepAppletRunning = false) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ type })
-                .required()
-                .string()
-                .matchRegExp(/^TIMER_\d+$/);
-            (0, Validate_1.default)({ timeOn })
-                .canBeNull()
-                .required()
-                .string()
-                .matchRegExp(/\d{2}:\d{2}:\d{2}/)
-                .timerTime();
-            (0, Validate_1.default)({ timeOff })
-                .canBeNull()
-                .required()
-                .string()
-                .matchRegExp(/\d{2}:\d{2}:\d{2}/)
-                .timerTime();
-            (0, Validate_1.default)({ weekdays }).required().array('string');
-            (0, Validate_1.default)({ keepAppletRunning }).required().boolean();
-            for (const weekday of weekdays) {
-                if (typeof TimerHelper_1.TimerWeekday[weekday] === 'undefined') {
-                    throw new Error('Invalid timer weekday');
-                }
+    /**
+     * The `setProprietaryTimer()` method creates or updates a
+     * [proprietary timer](https://docs.signageos.io/hc/en-us/articles/4416384202642-Timers#h_01HCD14GEDP96AZV58NRSN2HNQ).
+     *
+     * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
+     * @param timeOn The time when the device should turn on.
+     * @param timeOff The time when the device should turn off.
+     * @param weekdays The days of the week when the timer should be active (`mon`, ..., `sun`).
+     * @param keepAppletRunning If `true`, the applet will be kept running when the timer is active on certain devices.
+     *
+     * @since 5.10.0
+     */
+    async setProprietaryTimer(type, timeOn, timeOff, weekdays, keepAppletRunning = false) {
+        (0, Validate_1.default)({ type })
+            .required()
+            .string()
+            .matchRegExp(/^TIMER_\d+$/);
+        (0, Validate_1.default)({ timeOn })
+            .canBeNull()
+            .required()
+            .string()
+            .matchRegExp(/\d{2}:\d{2}:\d{2}/)
+            .timerTime();
+        (0, Validate_1.default)({ timeOff })
+            .canBeNull()
+            .required()
+            .string()
+            .matchRegExp(/\d{2}:\d{2}:\d{2}/)
+            .timerTime();
+        (0, Validate_1.default)({ weekdays }).required().array('string');
+        (0, Validate_1.default)({ keepAppletRunning }).required().boolean();
+        for (const weekday of weekdays) {
+            if (typeof TimerHelper_1.TimerWeekday[weekday] === 'undefined') {
+                throw new Error('Invalid timer weekday');
             }
-            yield this.postMessage({
-                type: this.getMessage('set_proprietary_timer'),
-                timerType: type,
-                timeOn,
-                timeOff,
-                weekdays,
-                keepAppletRunning,
-            });
+        }
+        await this.postMessage({
+            type: this.getMessage('set_proprietary_timer'),
+            timerType: type,
+            timeOn,
+            timeOff,
+            weekdays,
+            keepAppletRunning,
         });
     }
-    unsetProprietaryTimer(type) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.postMessage({
-                    type: this.getMessage('delete_proprietary_timer'),
-                    timerType: type,
-                });
-            }
-            catch (error) {
-                // Use failover method if delete fails that is supported in older front-display versions
-                // It can be removed in some front-applet najor version
-                yield this.setProprietaryTimer(type, null, null, []);
-            }
-        });
+    /**
+     * The `unsetProprietaryTimer()` method removes the specified
+     * [proprietary timer](https://docs.signageos.io/hc/en-us/articles/4416384202642-Timers#h_01HCD14GEDP96AZV58NRSN2HNQ).
+     *
+     * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
+     *
+     * @since 5.10.0
+     */
+    async unsetProprietaryTimer(type) {
+        try {
+            await this.postMessage({
+                type: this.getMessage('delete_proprietary_timer'),
+                timerType: type,
+            });
+        }
+        catch (error) {
+            // Use failover method if delete fails that is supported in older front-display versions
+            // It can be removed in some front-applet najor version
+            await this.setProprietaryTimer(type, null, null, []);
+        }
     }
     getMessage(name) {
         return this.messagePrefix + '.' + name;

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

@@ -1 +1 @@
-{"version":3,"file":"Power.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Power/Power.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,wDAAyE;AACzE,sDAA+C;AAI/C,MAAqB,KAAK;IACzB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,YAAY;;YACxB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;aACtC,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,UAAU;;YACtB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;aACpC,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,SAAS;;YACrB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;aACnC,CAAC,CAAC;YACH,OAAO,MAAM,CAAC;QACf,CAAC;KAAA;IAEY,QAAQ,CACpB,IAA4B,EAC5B,MAAqB,EACrB,OAAsB,EACtB,QAAkB,EAClB,MAAc;;YAEd,IAAI,OAAO,uBAAS,CAAC,IAA8B,CAAC,KAAK,WAAW,EAAE;gBACrE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;aACtC;YACD,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC;iBAClB,SAAS,EAAE;iBACX,QAAQ,EAAE;iBACV,MAAM,EAAE;iBACR,WAAW,CAAC,mBAAmB,CAAC;iBAChC,SAAS,EAAE,CAAC;YACd,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC;iBACnB,SAAS,EAAE;iBACX,QAAQ,EAAE;iBACV,MAAM,EAAE;iBACR,WAAW,CAAC,mBAAmB,CAAC;iBAChC,SAAS,EAAE,CAAC;YACd,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAClD,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACzD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC/B,IAAI,OAAO,0BAAY,CAAC,OAAoC,CAAC,KAAK,WAAW,EAAE;oBAC9E,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;iBACzC;aACD;YAED,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;gBAClC,SAAS,EAAE,IAAI;gBACf,MAAM;gBACN,OAAO;gBACP,QAAQ;gBACR,MAAM;aACN,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,UAAU,CAAC,IAA4B;;YACnD,IAAI,OAAO,uBAAS,CAAC,IAA8B,CAAC,KAAK,WAAW,EAAE;gBACrE,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;aACnC;YACD,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAC9C,CAAC;KAAA;IAEY,oBAAoB;;YAChC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;aAC/C,CAAC,CAAC;YACH,OAAO,MAAM,CAAC;QACf,CAAC;KAAA;IAEY,mBAAmB,CAC/B,IAA0B,EAC1B,MAAqB,EACrB,OAAsB,EACtB,QAAkB,EAClB,oBAA6B,KAAK;;YAElC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;iBAChB,QAAQ,EAAE;iBACV,MAAM,EAAE;iBACR,WAAW,CAAC,aAAa,CAAC,CAAC;YAC7B,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC;iBAClB,SAAS,EAAE;iBACX,QAAQ,EAAE;iBACV,MAAM,EAAE;iBACR,WAAW,CAAC,mBAAmB,CAAC;iBAChC,SAAS,EAAE,CAAC;YACd,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC;iBACnB,SAAS,EAAE;iBACX,QAAQ,EAAE;iBACV,MAAM,EAAE;iBACR,WAAW,CAAC,mBAAmB,CAAC;iBAChC,SAAS,EAAE,CAAC;YACd,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAClD,IAAA,kBAAQ,EAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;YACrD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC/B,IAAI,OAAO,0BAAY,CAAC,OAAoC,CAAC,KAAK,WAAW,EAAE;oBAC9E,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;iBACzC;aACD;YAED,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;gBAC9C,SAAS,EAAE,IAAI;gBACf,MAAM;gBACN,OAAO;gBACP,QAAQ;gBACR,iBAAiB;aACjB,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,qBAAqB,CAAC,IAA0B;;YAC5D,IAAI;gBACH,MAAM,IAAI,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC;oBACjD,SAAS,EAAE,IAAI;iBACf,CAAC,CAAC;aACH;YAAC,OAAO,KAAK,EAAE;gBACf,wFAAwF;gBACxF,uDAAuD;gBACvD,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;aACrD;QACF,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAxID,wBAwIC"}
+{"version":3,"file":"Power.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Power/Power.ts"],"names":[],"mappings":";;;;;AACA,wDAAyE;AACzE,uEAA+C;AAI/C,mCAAmC;AACnC;;;GAGG;AACH,MAAqB,KAAK;IAGhB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;OAIG;IACI,KAAK,CAAC,YAAY;QACxB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;SACtC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU;QACtB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;SACpC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;SACnC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,QAAQ,CACpB,IAA4B,EAC5B,MAAqB,EACrB,OAAsB,EACtB,QAAkB,EAClB,MAAc;QAEd,IAAI,OAAO,uBAAS,CAAC,IAA8B,CAAC,KAAK,WAAW,EAAE,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACvC,CAAC;QACD,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC;aAClB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC;aACnB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAChC,IAAI,OAAO,0BAAY,CAAC,OAAoC,CAAC,KAAK,WAAW,EAAE,CAAC;gBAC/E,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC1C,CAAC;QACF,CAAC;QAED,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,SAAS,EAAE,IAAI;YACf,MAAM;YACN,OAAO;YACP,QAAQ;YACR,MAAM;SACN,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,IAA4B;QACnD,IAAI,OAAO,uBAAS,CAAC,IAA8B,CAAC,KAAK,WAAW,EAAE,CAAC;YACtE,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACpC,CAAC;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,oBAAoB;QAChC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC/C,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,mBAAmB,CAC/B,IAA0B,EAC1B,MAAqB,EACrB,OAAsB,EACtB,QAAkB,EAClB,oBAA6B,KAAK;QAElC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,aAAa,CAAC,CAAC;QAC7B,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC;aAClB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC;aACnB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAA,kBAAQ,EAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QACrD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAChC,IAAI,OAAO,0BAAY,CAAC,OAAoC,CAAC,KAAK,WAAW,EAAE,CAAC;gBAC/E,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC1C,CAAC;QACF,CAAC;QAED,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;YAC9C,SAAS,EAAE,IAAI;YACf,MAAM;YACN,OAAO;YACP,QAAQ;YACR,iBAAiB;SACjB,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,qBAAqB,CAAC,IAA0B;QAC5D,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC;gBACjD,SAAS,EAAE,IAAI;aACf,CAAC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,wFAAwF;YACxF,uDAAuD;YACvD,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACtD,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AApMD,wBAoMC"}

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

@@ -3,10 +3,31 @@ import IProxy from './IProxy';
 export default class Proxy implements IProxy {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `isEnabled()` method returns whether the proxy is enabled on the device.
+     *
+     * @since 5.4.0
+     */
     isEnabled(): Promise<boolean>;
+    /**
+     * The `setManual()` method sets the proxy on the device.
+     *
+     * @since 5.4.0
+     */
     setManual(uri: string, port: number, username?: string, password?: string): Promise<void>;
+    /**
+     * The `disable()` method disables the proxy on the device.
+     *
+     * @since 5.4.0
+     */
     disable(): Promise<void>;
+    /**
+     * The `getConnectedTo()` methods returns the current connected proxy server uri on the device.
+     *
+     * @since 5.4.0
+     */
     getConnectedTo(): Promise<string>;
     private getMessage;
 }

package/es6/FrontApplet/Management/Proxy/Proxy.js

@@ -1,52 +1,58 @@
 "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());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 class Proxy {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    isEnabled() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { isEnabled } = yield this.postMessage({
-                type: this.getMessage('proxy_is_enabled'),
-            });
-            return isEnabled;
+    /**
+     * The `isEnabled()` method returns whether the proxy is enabled on the device.
+     *
+     * @since 5.4.0
+     */
+    async isEnabled() {
+        const { isEnabled } = await this.postMessage({
+            type: this.getMessage('proxy_is_enabled'),
         });
+        return isEnabled;
     }
-    setManual(uri, port, username, password) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.postMessage({
-                type: this.getMessage('proxy_set_manual'),
-                uri,
-                port,
-                username,
-                password,
-            });
+    /**
+     * The `setManual()` method sets the proxy on the device.
+     *
+     * @since 5.4.0
+     */
+    async setManual(uri, port, username, password) {
+        await this.postMessage({
+            type: this.getMessage('proxy_set_manual'),
+            uri,
+            port,
+            username,
+            password,
         });
     }
-    disable() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.postMessage({
-                type: this.getMessage('proxy_disable'),
-            });
+    /**
+     * The `disable()` method disables the proxy on the device.
+     *
+     * @since 5.4.0
+     */
+    async disable() {
+        await this.postMessage({
+            type: this.getMessage('proxy_disable'),
         });
     }
-    getConnectedTo() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { connectedTo } = yield this.postMessage({
-                type: this.getMessage('proxy_get_connected_to'),
-            });
-            return connectedTo;
+    /**
+     * The `getConnectedTo()` methods returns the current connected proxy server uri on the device.
+     *
+     * @since 5.4.0
+     */
+    async getConnectedTo() {
+        const { connectedTo } = await this.postMessage({
+            type: this.getMessage('proxy_get_connected_to'),
         });
+        return connectedTo;
     }
     getMessage(name) {
         return this.messagePrefix + '.' + name;

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

@@ -1 +1 @@
-{"version":3,"file":"Proxy.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Proxy/Proxy.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,MAAqB,KAAK;IACzB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,SAAS;;YACrB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;aACzC,CAAC,CAAC;YAEH,OAAO,SAAS,CAAC;QAClB,CAAC;KAAA;IAEY,SAAS,CAAC,GAAW,EAAE,IAAY,EAAE,QAAiB,EAAE,QAAiB;;YACrF,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBACzC,GAAG;gBACH,IAAI;gBACJ,QAAQ;gBACR,QAAQ;aACR,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,OAAO;;YACnB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;aACtC,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,cAAc;;YAC1B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC9C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;aAC/C,CAAC,CAAC;YACH,OAAO,WAAW,CAAC;QACpB,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAxCD,wBAwCC"}
+{"version":3,"file":"Proxy.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Proxy/Proxy.ts"],"names":[],"mappings":";;AAGA,MAAqB,KAAK;IAGhB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;OAIG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;SACzC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,IAAY,EAAE,QAAiB,EAAE,QAAiB;QACrF,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,GAAG;YACH,IAAI;YACJ,QAAQ;YACR,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;SACtC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc;QAC1B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC9C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC/C,CAAC,CAAC;QACH,OAAO,WAAW,CAAC;IACpB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA7DD,wBA6DC"}

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

@@ -1,14 +1,57 @@
 import IPostMessage from '../../IPostMessage';
 import IRemoteControl from './IRemoteControl';
+/**
+ * The `sos.management.remoteControl` groups together methods for enabling or disabling control of the device using IR remote controller (TV controller).
+ */
 export default class RemoteControl implements IRemoteControl {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `enable()` method enables remote control.
+     *
+     * :::warning
+     *
+     * **Android:** In order to prevent Android from displaying Android homepage and thus not showing your content, you
+     * must Enable Kiosk Mode (or Lock Remote Control) either through Box device settings or through API.
+     *
+     * Always set the Remote Control Lock to `enable` after the deployment.
+     *
+     * :::
+     *
+     * @since 3.0.0
+     */
     enable(): Promise<void>;
+    /**
+     * The `disable()` method disables remote control.
+     *
+     * @since 3.0.0
+     */
     disable(): Promise<void>;
+    /**
+     * The `isEnabled()` method returns whether the remote control is enabled.
+     *
+     * @since 4.0.0
+     */
     isEnabled(): Promise<boolean>;
+    /**
+     * The `lock()` method is an alias for the `disable()` method.
+     *
+     * @since 4.0.0
+     */
     lock(): Promise<void>;
+    /**
+     * The `unlock()` method is an alias for the `enable()` method.
+     *
+     * @since 4.0.0
+     */
     unlock(): Promise<void>;
+    /**
+     * The `isLocked()` method returns whether the remote control is locked (disabled).
+     *
+     * @since 4.0.0
+     */
     isLocked(): Promise<boolean>;
     private setEnabled;
     private getMessage;