@signageos/front-applet 7.1.1 → 8.0.0

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

@@ -1,20 +1,46 @@
 import IPostMessage from '../../IPostMessage';
 import ITime, { DateTime, IGetTime } from './ITime';
+/**
+ * The `sos.management.time` API groups together methods for working with the system time.
+ */
 export default class Time implements ITime {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `get()` method returns currently set time info.
+     *
+     * @since 4.0.0
+     */
     get(): Promise<IGetTime>;
-    /** @deprecated use setManual instead */
+    /** @deprecated Use `setManual(dateTime, timezone)` instead. */
     set(currentDate: Date, timezone: string): Promise<void>;
-    /** @deprecated use setManual, where first argument is DateTime object */
+    /** @deprecated Use `setManual(dateTime, timezone)` instead. */
     setManual(currentDate: Date, timezone: string): Promise<void>;
     /**
-     * Set manual datetime and timezone
-     * @param dateTime
-     * @param timezone
+     * The `setManual()` method sets the system time and the system timezone.
+     *
+     * :::warning
+     *
+     * This method will disable NTP server settings.
+     *
+     * :::
+     *
+     * @param dateTime The date and time to set.
+     * @param timezone The timezone to set.
+     *
+     * @since 4.0.0
      */
     setManual(dateTime: DateTime, timezone: string): Promise<void>;
+    /**
+     * The `setNTP()` method sets the NTP server and the system timezone.
+     *
+     * @param ntpServer The NTP server to set.
+     * @param timezone The timezone to set.
+     *
+     * @since 4.0.0
+     */
     setNTP(ntpServer: string, timezone: string): Promise<void>;
     private getMessage;
 }

package/es6/FrontApplet/Management/Time/Time.js

@@ -1,59 +1,68 @@
 "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 Validate_1 = __importDefault(require("../../Validate/Validate"));
 const ITime_1 = require("./ITime");
+// TODO: add warnings from the old docs, but AFAIK it's not possible to change time in the JS runtime, so the applet has to be always rebooted.
+/**
+ * The `sos.management.time` API groups together methods for working with the system time.
+ */
 class Time {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    get() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { currentTimeWithTimezone } = yield this.postMessage({
-                type: this.getMessage('get_current_time_with_timezone'),
-            });
-            return currentTimeWithTimezone;
+    /**
+     * The `get()` method returns currently set time info.
+     *
+     * @since 4.0.0
+     */
+    async get() {
+        const { currentTimeWithTimezone } = await this.postMessage({
+            type: this.getMessage('get_current_time_with_timezone'),
         });
+        return currentTimeWithTimezone;
     }
-    /** @deprecated use setManual instead */
+    /** @deprecated Use `setManual(dateTime, timezone)` instead. */
     set(currentDate, timezone) {
         return this.setManual(currentDate, timezone);
     }
-    setManual(...args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const [currentDate, timezone] = args;
-            if (currentDate instanceof Date) {
-                Validate_1.default({ currentDate }).required().date();
-            }
-            else {
-                Validate_1.default({ currentDate }).required().object(ITime_1.VDateTime);
-            }
-            Validate_1.default({ timezone }).required().string();
-            yield this.postMessage({
-                type: this.getMessage('set_current_time_with_timezone'),
-                currentDate,
-                timezone,
-            });
+    /** @internal */
+    async setManual(...args) {
+        const [currentDate, timezone] = args;
+        if (currentDate instanceof Date) {
+            (0, Validate_1.default)({ currentDate }).required().date();
+        }
+        else {
+            (0, Validate_1.default)({ currentDate }).required().object(ITime_1.VDateTime);
+        }
+        (0, Validate_1.default)({ timezone }).required().string();
+        await this.postMessage({
+            type: this.getMessage('set_current_time_with_timezone'),
+            currentDate,
+            timezone,
         });
     }
-    setNTP(ntpServer, timezone) {
-        return __awaiter(this, void 0, void 0, function* () {
-            Validate_1.default({ ntpServer }).required().string();
-            Validate_1.default({ timezone }).required().string();
-            yield this.postMessage({
-                type: this.getMessage('set_ntp_time_with_timezone'),
-                ntpServer,
-                timezone,
-            });
+    /**
+     * The `setNTP()` method sets the NTP server and the system timezone.
+     *
+     * @param ntpServer The NTP server to set.
+     * @param timezone The timezone to set.
+     *
+     * @since 4.0.0
+     */
+    async setNTP(ntpServer, timezone) {
+        (0, Validate_1.default)({ ntpServer }).required().string();
+        (0, Validate_1.default)({ timezone }).required().string();
+        await this.postMessage({
+            type: this.getMessage('set_ntp_time_with_timezone'),
+            ntpServer,
+            timezone,
         });
     }
     getMessage(name) {

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

@@ -1 +1 @@
-{"version":3,"file":"Time.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Time/Time.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,sDAA+C;AAC/C,mCAA+D;AAE/D,MAAqB,IAAI;IACxB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,GAAG;;YACf,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC1D,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;aACvD,CAAC,CAAC;YAEH,OAAO,uBAAuB,CAAC;QAChC,CAAC;KAAA;IAED,wCAAwC;IACjC,GAAG,CAAC,WAAiB,EAAE,QAAgB;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAYY,SAAS,CAAC,GAAG,IAA+B;;YACxD,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;YAErC,IAAI,WAAW,YAAY,IAAI,EAAE;gBAChC,kBAAQ,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;aAC5C;iBAAM;gBACN,kBAAQ,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,iBAAS,CAAC,CAAC;aACvD;YACD,kBAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAE3C,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;gBACvD,WAAW;gBACX,QAAQ;aACR,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,MAAM,CAAC,SAAiB,EAAE,QAAgB;;YACtD,kBAAQ,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAC5C,kBAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;gBACnD,SAAS;gBACT,QAAQ;aACR,CAAC,CAAC;QACJ,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA3DD,uBA2DC"}
+{"version":3,"file":"Time.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Time/Time.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAC/C,mCAA+D;AAE/D,+IAA+I;AAC/I;;GAEG;AACH,MAAqB,IAAI;IAGf;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,GAAG;QACf,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC1D,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;SACvD,CAAC,CAAC;QAEH,OAAO,uBAAuB,CAAC;IAChC,CAAC;IAED,+DAA+D;IACxD,GAAG,CAAC,WAAiB,EAAE,QAAgB;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAsBD,gBAAgB;IACT,KAAK,CAAC,SAAS,CAAC,GAAG,IAA+B;QACxD,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;QAErC,IAAI,WAAW,YAAY,IAAI,EAAE,CAAC;YACjC,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;QAC7C,CAAC;aAAM,CAAC;YACP,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,iBAAS,CAAC,CAAC;QACxD,CAAC;QACD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAE3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;YACvD,WAAW;YACX,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,QAAgB;QACtD,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC5C,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;YACnD,SAAS;YACT,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AApFD,uBAoFC"}

package/es6/FrontApplet/Management/Wifi/IWifiEvent.d.ts

@@ -1,11 +1,29 @@
 import IMessage from '../../IMessage';
 export declare enum WifiEvent {
+    /**
+     * Wi-Fi was set to CLIENT state.
+     */
     CLIENT_ENABLED = "client_enabled",
+    /**
+     * Wi-Fi is in CLIENT state and have connected to a network.
+     */
     CLIENT_CONNECTED = "client_connected",
+    /**
+     * Wi-Fi is in CLIENT state and failed to connect to a network.
+     */
     CLIENT_CONNECT_REJECTED = "client_connect_rejected",
+    /**
+     * Wi-Fi is in CLIENT state and disconnected from a network.
+     */
     CLIENT_DISCONNECTED = "client_disconnected",
+    /**
+     * Wi-Fi was set to AP state.
+     */
     AP_ENABLED = "ap_enabled",
+    /**
+     * Wi-Fi was set to DISABLED state.
+     */
     DISABLED = "disabled"
 }
-declare type IWifiMessage = IMessage;
+type IWifiMessage = IMessage;
 export default IWifiMessage;

package/es6/FrontApplet/Management/Wifi/IWifiEvent.js

@@ -3,11 +3,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WifiEvent = void 0;
 var WifiEvent;
 (function (WifiEvent) {
+    /**
+     * Wi-Fi was set to CLIENT state.
+     */
     WifiEvent["CLIENT_ENABLED"] = "client_enabled";
+    /**
+     * Wi-Fi is in CLIENT state and have connected to a network.
+     */
     WifiEvent["CLIENT_CONNECTED"] = "client_connected";
+    /**
+     * Wi-Fi is in CLIENT state and failed to connect to a network.
+     */
     WifiEvent["CLIENT_CONNECT_REJECTED"] = "client_connect_rejected";
+    /**
+     * Wi-Fi is in CLIENT state and disconnected from a network.
+     */
     WifiEvent["CLIENT_DISCONNECTED"] = "client_disconnected";
+    /**
+     * Wi-Fi was set to AP state.
+     */
     WifiEvent["AP_ENABLED"] = "ap_enabled";
+    /**
+     * Wi-Fi was set to DISABLED state.
+     */
     WifiEvent["DISABLED"] = "disabled";
-})(WifiEvent = exports.WifiEvent || (exports.WifiEvent = {}));
+})(WifiEvent || (exports.WifiEvent = WifiEvent = {}));
 //# sourceMappingURL=IWifiEvent.js.map

package/es6/FrontApplet/Management/Wifi/IWifiEvent.js.map

@@ -1 +1 @@
-{"version":3,"file":"IWifiEvent.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Wifi/IWifiEvent.ts"],"names":[],"mappings":";;;AAEA,IAAY,SAOX;AAPD,WAAY,SAAS;IACpB,8CAAiC,CAAA;IACjC,kDAAqC,CAAA;IACrC,gEAAmD,CAAA;IACnD,wDAA2C,CAAA;IAC3C,sCAAyB,CAAA;IACzB,kCAAqB,CAAA;AACtB,CAAC,EAPW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAOpB"}
+{"version":3,"file":"IWifiEvent.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Wifi/IWifiEvent.ts"],"names":[],"mappings":";;;AAEA,IAAY,SA8BX;AA9BD,WAAY,SAAS;IACpB;;OAEG;IACH,8CAAiC,CAAA;IAEjC;;OAEG;IACH,kDAAqC,CAAA;IAErC;;OAEG;IACH,gEAAmD,CAAA;IAEnD;;OAEG;IACH,wDAA2C,CAAA;IAE3C;;OAEG;IACH,sCAAyB,CAAA;IAEzB;;OAEG;IACH,kCAAqB,CAAA;AACtB,CAAC,EA9BW,SAAS,yBAAT,SAAS,QA8BpB"}

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

@@ -2,33 +2,134 @@ import IPostMessage from '../../IPostMessage';
 import IWifiMessage, { WifiEvent } from './IWifiEvent';
 import { IWifiDevice } from '../Network/INetworkInfo';
 import IWifi, { IScannedDevice, IWifiConnectOptions } from './IWifi';
+/**
+ * The `sos.management.wifi` API groups together methods for managing WIFI.
+ *
+ * :::info
+ *
+ * Use `sos.management.supports('WIFI')` to check if the device supports managing WIFI setup.
+ *
+ * :::
+ *
+ * #### Internal state
+ *
+ * The `sos.management.wifi` API may be in 3 states:
+ *
+ * - `disabled` - Wi-Fi is disabled. This state is persistent between reboots.
+ * - `client` - Wi-Fi is in the client state, i.e. it is capable of connecting to a network, similarly to a phone or laptop. This state is persistent between reboots with all of its configuration.
+ * - `ap` - Wi-Fi is in access point state, i.e. it itself becomes a Wi-Fi network that others can connect to. This state is persistent between reboots and will be switched to DISABLED state.
+ *
+ * You can use `enableClient()`/`disableClient()` method to enable
+ * or disable the `client` state or you can use `enableAP()`/`disableAP()` to enable or disable the `ap` state. It is **not** possible to go
+ * from `client` state to `ap` state directly, the state has to be `disabled` first.
+ */
 export default class Wifi implements IWifi {
     private messagePrefix;
     private postMessage;
     static MESSAGE_PREFIX: string;
     private eventEmitter;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `isClientEnabled()` method checks whether the Wi-Fi is in `client` state.
+     *
+     * @throws If the Wi-Fi state is in the `ap` state.
+     */
     isClientEnabled(): Promise<boolean>;
+    /**
+     * The `enabledClient()` method switches the Wi-Fi state from `disabled` to `client` state.
+     *
+     * @throws If the Wi-Fi state is in the `ap` state.
+     */
     enableClient(): Promise<void>;
+    /**
+     * The `isClientEnabled()` method checks whether the Wi-Fi is in `ap` state.
+     */
     isAPEnabled(): Promise<boolean>;
+    /**
+     * The `enabledClient()` method switches the Wi-Fi state from `disabled` to `ap` state.
+     *
+     * :::info
+     *
+     * Use `sos.management.supports('WIFI_AP')` to check if the device is able to be in the `ap` mode.
+     *
+     * :::
+     *
+     * @param ssid Name of the network, max. allowed length is 32 characters.
+     * @param password Password of the device, must be between 8 and 32 characters.
+     *
+     * @throws If the Wi-Fi state is in the `client` state.
+     */
     enableAP(ssid: string, password: string): Promise<void>;
+    /**
+     * The `disable()` method switches the Wi-Fi state to `disabled`. All previously configured networks will be forgotten.
+     */
     disable(): Promise<void>;
+    /**
+     * The `getConnectedTo()` method returns a network the device is currently connected to.
+     *
+     * @throws If the Wi-Fi state is not in the `client` state.
+     */
     getConnectedTo(): Promise<IWifiDevice | null>;
     /**
-     * Connect to a Wi-Fi network
-     * @param ssid
-     * @param password
-     * @param options
+     * The `connect()` method connects the device to a specified network.
+     *
+     * @throws If the Wi-Fi state is not in the `client` state.
      */
     connect(ssid: string, password?: string, options?: IWifiConnectOptions): Promise<void>;
+    /**
+     * The `disconnect()` method disconnects the device from Wi-Fi network.
+     *
+     * @throws If the Wi-Fi state is not in the `client` state.
+     */
     disconnect(): Promise<void>;
+    /**
+     * The `getCountry()` method returns the 2-letter country code to which Wi-Fi regulations the device adheres to. Different countries may
+     * have different regulations, when it comes to the Wi-Fi networks. Under normal circumstances, everything should work with default
+     * settings. However, if you experience any problems, you might want to try changing Wi-Fi country configuration to your country.
+     *
+     * @throws If the Wi-Fi state is not in the `client` state.
+     */
     getCountry(): Promise<string | null>;
+    /**
+     * The `getCountry()` method sets the 2-letter country code for the Wi-Fi settings. Different countries may
+     * have different regulations, when it comes to the Wi-Fi networks. Under normal circumstances, everything should work with default
+     * settings. However, if you experience any problems, you might want to try changing Wi-Fi country configuration to your country.
+     *
+     * @param countryCode 2-letter country code from the ISO 3166 standard.
+     *
+     * @throws If the Wi-Fi state is not in the `client` state.
+     */
     setCountry(countryCode: string): Promise<void>;
+    /**
+     * The `scanDevices()` method initializes a new network scan and available networks.
+     *
+     * :::info
+     *
+     * Use `sos.management.supports('WIFI_SCAN')` to check if the device supports scanning for devices.
+     *
+     * :::
+     *
+     * @throws If the Wi-Fi state is not in the `client` state.
+     */
     scanDevices(): Promise<IScannedDevice[]>;
-    on(event: WifiEvent, listener: (...args: []) => void): void;
-    once(event: WifiEvent, listener: (...args: []) => void): void;
-    removeListener(event: WifiEvent, listener: (...args: []) => void): void;
+    /**
+     * The `on()` method sets up a listener, which is called whenever the specified event occurs.
+     */
+    on(event: WifiEvent, listener: () => void): void;
+    /**
+     * The `on()` method sets up a **one-time** listener, which is called whenever the specified event occurs.
+     */
+    once(event: WifiEvent, listener: () => void): void;
+    /**
+     * The `removeListener()` method removes a listener previously set up by `on()` or `once()` methods.
+     */
+    removeListener(event: WifiEvent, listener: () => void): void;
+    /**
+     * The `removeAllListeners()` method removes all listeners for a specified event or for all events.
+     */
     removeAllListeners(event?: WifiEvent): void;
+    /** @internal */
     handleMessageData(data: IWifiMessage): void;
     private getMessage;
 }