@signageos/front-applet 8.2.1 → 8.2.2

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

@@ -2,6 +2,18 @@ import IPostMessage from '../../IPostMessage';
 import ITime, { DateTime, IGetTime } from './ITime';
 /**
  * The `sos.management.time` API groups together methods for working with the system time.
+ *
+ * <details>
+ *     <summary>Time Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `SET_TIME` | If the device can set the system time. |
+ * 		| `SET_TIMEZONE` | If the device can set the system timezone. |
+ * 		| `GET_TIMEZONE` | If the device can get the system timezone. |
+ * 		| `NTP_TIME` | If the device can set the NTP server and system timezone. |
+ *
+ * 		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 export default class Time implements ITime {
     private messagePrefix;
@@ -9,9 +21,15 @@ export default class Time implements ITime {
     /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     /**
-     * The `get()` method returns currently set time info.
+     * The `get()` method returns the currently set time from the device.
      *
+     * @returns {Promise<IGetTime>} A promise that resolves to the current time with timezone.
+     * @throws {Error} If the time cannot be retrieved.
      * @since 4.0.0
+     *
+     * @example
+     * const currentTime = await sos.management.time.get();
+     * console.log(`Current time is: ${currentTime.currentDate} in timezone ${currentTime.timezone}`);
      */
     get(): Promise<IGetTime>;
     /** @deprecated Use `setManual(dateTime, timezone)` instead. */
@@ -22,36 +40,54 @@ export default class Time implements ITime {
      * The `setManual()` method sets the system time and the system timezone and disables NTP server settings.
      *
      * :::warning Setting NTP server and timezone has side effects
-     *
      * - **Tizen**: After calling this API, display Reboots!
-     *   Tizen has limited set of available timezones. Read more here.
-     * - **RaspberryPi**: After calling this API, RPi Reboots backend server which can take up to 60 seconds! During the reboot no JS API is
+     *   Tizen has a limited set of available timezones. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405381271314-Tizen-Timezones-Limited-List-for-NTP).
+     * - **RaspberryPi**: After calling this API, RPi Reboots the backend server, which can take up to 60 seconds! During the reboot, no JS API is
      *   available. **Always wait for Promise resolution.**
-     *
      * :::
      *
      * @param dateTime The date and time to set.
      * @param timezone The timezone to set.
-     *
+     * @returns {Promise<void>} A promise that resolves when the time is successfully set.
+     * @throws {Error} If `dateTime` is not a valid Date or DateTime object.
+     * @throws {Error} If `timezone` is not a valid string.
+     * @throws {Error} If the time cannot be set.
      * @since 4.0.0
+     *
+     * @example
+     * // Set the system time to 2023-10-01T12:00:00 in Europe/Prague timezone
+     * const dateTime = {
+     *     year: 2023,
+     *     month: 10,
+     *     day: 1,
+     *     hour: 12,
+     *     minute: 0,
+     *     second: 0,
+     * }
+     * await sos.management.time.setManual(dateTime, 'Europe/Prague');
      */
     setManual(dateTime: DateTime, timezone: string): Promise<void>;
     /**
      * The `setNTP()` method sets the NTP server and the system timezone.
      *
      * :::warning Setting NTP server and timezone has side effects
-     *
      * - **Tizen / WebOS**: After calling this API, display Reboots!
-     *   Tizen has limited set of available timezones. Read more here.
-     * - **RaspberryPi**: After calling this API, RPi Reboots backend server which can take up to 60 seconds! During the reboot no JS API is
+     *   Tizen has a limited set of available timezones. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405381271314-Tizen-Timezones-Limited-List-for-NTP).
+     * - **RaspberryPi**: After calling this API, RPi Reboots the backend server, which can take up to 60 seconds! During the reboot, no JS API is
      *   available. **Always wait for Promise resolution.**
-     *
      * :::
      *
      * @param ntpServer The NTP server to set.
      * @param timezone The timezone to set.
-     *
+     * @return {Promise<void>} A promise that resolves when the NTP server and timezone are successfully set.
+     * @throws {Error} If `ntpServer` is not a valid string.
+     * @throws {Error} If `timezone` is not a valid string.
+     * @throws {Error} If the NTP server and timezone cannot be set.
      * @since 4.0.0
+     *
+     * @example
+     * // Set the NTP server to `pool.ntp.org` and timezone to `Europe/Prague`
+     * await sos.management.time.setNTP('pool.ntp.org', 'Europe/Prague');
      */
     setNTP(ntpServer: string, timezone: string): Promise<void>;
     private getMessage;

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

@@ -5,9 +5,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 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.
+ *
+ * <details>
+ *     <summary>Time Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `SET_TIME` | If the device can set the system time. |
+ * 		| `SET_TIMEZONE` | If the device can set the system timezone. |
+ * 		| `GET_TIMEZONE` | If the device can get the system timezone. |
+ * 		| `NTP_TIME` | If the device can set the NTP server and system timezone. |
+ *
+ * 		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 class Time {
     messagePrefix;
@@ -18,9 +29,15 @@ class Time {
         this.postMessage = postMessage;
     }
     /**
-     * The `get()` method returns currently set time info.
+     * The `get()` method returns the currently set time from the device.
      *
+     * @returns {Promise<IGetTime>} A promise that resolves to the current time with timezone.
+     * @throws {Error} If the time cannot be retrieved.
      * @since 4.0.0
+     *
+     * @example
+     * const currentTime = await sos.management.time.get();
+     * console.log(`Current time is: ${currentTime.currentDate} in timezone ${currentTime.timezone}`);
      */
     async get() {
         const { currentTimeWithTimezone } = await this.postMessage({
@@ -52,18 +69,23 @@ class Time {
      * The `setNTP()` method sets the NTP server and the system timezone.
      *
      * :::warning Setting NTP server and timezone has side effects
-     *
      * - **Tizen / WebOS**: After calling this API, display Reboots!
-     *   Tizen has limited set of available timezones. Read more here.
-     * - **RaspberryPi**: After calling this API, RPi Reboots backend server which can take up to 60 seconds! During the reboot no JS API is
+     *   Tizen has a limited set of available timezones. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405381271314-Tizen-Timezones-Limited-List-for-NTP).
+     * - **RaspberryPi**: After calling this API, RPi Reboots the backend server, which can take up to 60 seconds! During the reboot, no JS API is
      *   available. **Always wait for Promise resolution.**
-     *
      * :::
      *
      * @param ntpServer The NTP server to set.
      * @param timezone The timezone to set.
-     *
+     * @return {Promise<void>} A promise that resolves when the NTP server and timezone are successfully set.
+     * @throws {Error} If `ntpServer` is not a valid string.
+     * @throws {Error} If `timezone` is not a valid string.
+     * @throws {Error} If the NTP server and timezone cannot be set.
      * @since 4.0.0
+     *
+     * @example
+     * // Set the NTP server to `pool.ntp.org` and timezone to `Europe/Prague`
+     * await sos.management.time.setNTP('pool.ntp.org', 'Europe/Prague');
      */
     async setNTP(ntpServer, timezone) {
         (0, Validate_1.default)({ ntpServer }).required().string();

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,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;IAwBD,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;;;;;;;;;;;;;;;;OAgBG;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;AA/FD,uBA+FC"}
+{"version":3,"file":"Time.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Time/Time.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAC/C,mCAA+D;AAE/D;;;;;;;;;;;;;;GAcG;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;;;;;;;;;;OAUG;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;IAqCD,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;;;;;;;;;;;;;;;;;;;;;OAqBG;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;AAvHD,uBAuHC"}

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

@@ -17,6 +17,9 @@ export default interface IWifi {
     removeListener(event: WifiEvent, listener: (...args: []) => void): void;
     removeAllListeners(event?: WifiEvent): void;
 }
+/**
+ * Interface representing a scanned Wi-Fi device.
+ */
 export interface IScannedDevice {
     ssid: string;
     encrypted: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"IWifi.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Wifi/IWifi.ts"],"names":[],"mappings":";;;AAiCa,QAAA,oBAAoB,GAAG;IACnC,MAAM,EAAE,UAAU;IAClB,YAAY,EAAE,SAAS;CACvB,CAAC"}
+{"version":3,"file":"IWifi.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Wifi/IWifi.ts"],"names":[],"mappings":";;;AAsCa,QAAA,oBAAoB,GAAG;IACnC,MAAM,EAAE,UAAU;IAClB,YAAY,EAAE,SAAS;CACvB,CAAC"}

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

@@ -3,25 +3,32 @@ 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 Wi-Fi.
- *
- * :::info
- *
- * Use `sos.management.supports('WIFI')` to check if the device supports managing Wi-Fi setup.
- *
- * :::
+ * The `sos.management.wifi` API groups together methods for managing Wi-Fi setup on the device.
  *
  * #### 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.
+ * - `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 persists between reboots and will be switched to the 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
+ * You can use `enableClient()`/`disable()` method to enable
+ * or disable the `client` state, or you can use `enableAP()`/`disableAP()` to turn on or off the `ap` state. It is **not** possible to go
  * from `client` state to `ap` state directly, the state has to be `disabled` first.
+ *
+ * <details>
+ *     <summary>Wi-Fi Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `WIFI` | If device supports Wi-Fi setup connection |
+ * 		| `WIFI_SCAN` | If device supports Wi-Fi scanning |
+ * 		| `WIFI_AP` | If device supports Wi-Fi Access Point setup |
+ * 		| `WIFI_STRENGTH` | If device supports Wi-Fi signal strength measurement |
+ * 		| `WIFI_COUNTRY` | If device supports Wi-Fi country code configuration |
+ *
+ * 		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 export default class Wifi implements IWifi {
     private messagePrefix;
@@ -35,46 +42,68 @@ export default class Wifi implements IWifi {
      *
      * @throws Error If the Wi-Fi state is in the `ap` state.
      * @returns {Boolean} if client mode is enabled.
+     * @since 4.3.0
+     *
+     * @example
+     * const isClientEnabled = await sos.management.wifi.isClientEnabled();
+     * if (!isClientEnabled) {
+     * 	await sos.management.wifi.enableClient();
+     * }
      */
     isClientEnabled(): Promise<boolean>;
     /**
      * The `enabledClient()` method switches the Wi-Fi state from `disabled` to `client` state.
      *
+     * @returns {Promise<void>} A promise that resolves when the Wi-Fi is enabled in client mode.
      * @throws Error If the Wi-Fi state is in the `ap` state.
+     * @since 4.3.0
      */
     enableClient(): Promise<void>;
     /**
      * The `isAPEnabled()` method checks whether the Wi-Fi is in `ap` state.
      *
-     * @returns {Boolean} if AP mode is enabled.
+     * @returns {Boolean} If AP mode is enabled.
+     * @since 4.3.0
      */
     isAPEnabled(): Promise<boolean>;
     /**
-     * The `enableAP()` method switches the Wi-Fi state from `disabled` to `ap` state.
+     * Sets Wi-Fi to AP state, meaning the device will become a Wi-Fi network that other devices can connect to. It will run in WPA-Personal mode. As such, it requires an SSID (network name) and a password that different devices will use to connect.
      *
-     * :::info
-     * Use `sos.management.supports('WIFI_AP')` to check if the device is able to be in the `ap` mode.
+     * :::note
+     * - This method is only available on the Linux platform.
+     * - It is not allowed to call this method when in the CLIENT state. You must first switch to the **DISABLED** state.
+     * - Before calling this method, make sure the device supports Wi-Fi AP via `sos.management.supports("WIFI_AP")`
      * :::
      *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/wifi-access-point | Example applet with Wi-Fi access point}
+     *
      * @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.
-     *
+     * @returns {Promise<void>} A promise that resolves when the Wi-Fi is enabled in AP mode.
      * @throws Error If the Wi-Fi state is in the `client` state.
+     * @since 4.3.0
      */
     enableAP(ssid: string, password: string): Promise<void>;
     /**
-     * The `disable()` method switches the Wi-Fi state to `disabled` and disconnect from connected Wi-Fi.
+     * The `disable()` method switches the Wi-Fi state to `disabled` and disconnects from the connected Wi-Fi.
      *
      * All previously configured networks will be forgotten.
+     *
+     * @returns {Promise<void>} A promise that resolves when the Wi-Fi is disabled.
+     * @throws Error If the Wi-Fi state is in the `client` or `ap` state.
+     * @since 4.3.0
+     *
+     * @example
+     * await sos.management.wifi.disable();
      */
     disable(): Promise<void>;
     /**
-     * The `getConnectedTo()` method returns a network the device is currently connected to.
-     *
-     * @throws Error If the Wi-Fi state is not in the `client` state.
+     * The `getConnectedTo()` method returns the network the device is currently connected to.
      *
      * @returns An object containing the SSID, whether the network is encrypted, and the signal strength.
      * If the device is not connected to any network, it returns `null`.
+     * @throws Error If the Wi-Fi state is not in the `client` state.
+     * @since 4.3.0
      *
      * @example
      * // To get the network the device is currently connected to
@@ -83,87 +112,153 @@ export default class Wifi implements IWifi {
      */
     getConnectedTo(): Promise<IWifiDevice | null>;
     /**
-     * The `connect()` method connects the device to a specified network.
+     * The `connect()` method connects the device to a specified Wi-Fi network.
+     *
+     * :::danger
+     * On Tizen, make sure that the connection credentials are correct. If the device fails to connect, it will not retry automatically.
+     * Make sure that you have a backup script or a checking mechanism in place, which will allow you to recover from the situation if the connection fails.
+     * :::
      *
      * :::warning
-     * Connecting to a OPEN Wi-Fi network for Tizen and WebOS is different.
-     * - For Tizen, make sure that the `password` is an empty string (`''`) and in options you have selected `OPEN` as encryption type.
+     * Connecting to an OPEN Wi-Fi network for Tizen and WebOS is different.
+     * - For Tizen, make sure that the `password` is an empty string (`''`) and in the options you have selected `OPEN` as encryption type.
      * - For WebOS, you can pass `undefined` as the `password` parameter.
      * :::
      *
      * :::info
-     * Security type of Wi-Fi is mandatory for Tizen.
+     * The security type of Wi-Fi is mandatory for Tizen.
      * :::
      *
      * @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.
-     * @param options Additional options for the connection, such as `hidden` or `securityType`.
+     * @param options Additional options for the connection.
+     * @param options.hidden If the network is hidden, defaults to `false`.
+     * @param options.securityType The security type of the network.
      *
      * @throws Error If the Wi-Fi state is not in the `client` state.
-     * @returns A promise that resolves when the connection is established or if connection fails.
+     * @throws Error If the `ssid` is not a string or is empty.
+     * @throws Error If the `password` is not a string or is empty (if required).
+     * @throws Error If the `options` is not an object or does not match the expected schema.
+     * @throws Error If the `securityType` is not one of the allowed values.
+     * @returns {Promise<void>} A promise that resolves when the connection is established or if the connection fails.
+     * @since 4.3.0
      *
      * @example
-     * // To connect on open Wi-Fi network ex. WebOS
+     * // To connect to an open Wi-Fi network, e.g., WebOS
      * await sos.management.wifi.connect('MyOpenNetwork');
      *
-     * // To connect on open Wi-Fi network with empty password (Tizen)
+     * // To connect an open Wi-Fi network with an empty password (Tizen)
      * await sos.management.wifi.connect('MyOpenNetwork', '', { securityType: 'OPEN' });
      *
      * // If the network is hidden
      * await sos.management.wifi.connect('MyOpenNetwork', undefined, { hidden: true });
      *
-     * // To connect on encrypted Wi-Fi network with WPA2 security
+     * // To connect to an encrypted Wi-Fi network with WPA2 security
      * await sos.management.wifi.connect('MyEncryptedNetwork', 'my-password', { securityType: 'WPA2' });
      */
     connect(ssid: string, password?: string, options?: IWifiConnectOptions): Promise<void>;
     /**
-     * The `disconnect()` method disconnects the device from Wi-Fi network.
+     * The `disconnect()` method disconnects the device from the Wi-Fi network.
+     * This method will not disable the Wi-Fi client; it will just disconnect from the currently connected network.
      *
+     * @returns {Promise<void>} A promise that resolves when the device is disconnected from the network.
      * @throws Error If the Wi-Fi state is not in the `client` state.
+     * @since 4.3.0
+     *
+     * @example
+     * await sos.management.wifi.disconnect();
      */
     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.
+     * The `getCountry()` method returns the 2-letter country code to which Wi-Fi regulations the device adheres. Different countries may
+     * have different regulations when it comes to the Wi-Fi networks. Under normal circumstances, everything should work with the default
+     * settings. However, if you experience any problems, you might want to try changing the Wi-Fi country configuration to your country.
      *
      * @throws Error If the Wi-Fi state is not in the `client` state.
-     * @returns The 2-letter country code from the ISO 3166 standard, or `null` if not set.
+     * @returns {Promise<string | null>} A promise that resolves to the 2-letter country code from the ISO 3166 standard, or `null` if not set.
+     * @since 4.3.0
+     *
+     * @example
+     * const countryCode = await sos.management.wifi.getCountry();
+     * console.log(`Current Wi-Fi country code is: ${countryCode}`); // e.g. 'US', 'CZ', etc.
      */
     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.
+     * The `setCountry()` 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 the default
+     * settings. However, if you experience any problems, you might want to try changing the Wi-Fi country configuration to your country.
+     *
+     * :::note
+     * This method is only available on the Linux platform.
+     * :::
      *
      * @param countryCode 2-letter country code from the ISO 3166 standard.
+     * @returns {Promise<void>} A promise that resolves when the country code is set.
      * @throws Error If the Wi-Fi state is not in the `client` state.
+     * @since 4.3.0
+     *
+     * @example
+     * // To set the country code to the United States
+     * await sos.management.wifi.setCountry('US');
      */
     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.
-     * :::
-     *
+     * @returns {Promise<IScannedDevice[]>} A promise that resolves to an array of scanned devices.
      * @throws Error If the Wi-Fi state is not in the `client` state.
+     * @since 4.3.0
+     *
+     * @example
+     * const scannedDevices = await sos.management.wifi.scanDevices();
+     * scannedDevices.forEach(device => {
+     * 	console.log(`Found Wi-Fi network: ${device.ssid}, Encrypted: ${device.encrypted}`);
+     * });
      */
     scanDevices(): Promise<IScannedDevice[]>;
     /**
      * The `on()` method sets up a listener, which is called whenever the specified event occurs.
+     *
+     * @param event The event for which to set up the listener.
+     * @param listener The listener function to call when the event occurs.
+     * @returns {void} Resolves when the listener is set up.
+     * @since 4.3.0
+     *
+     * @example
+     * sos.management.wifi.on(WifiEvent.CLIENT_ENABLED, () => {
+     *   console.log('Wi-Fi client is enabled');
+     * });
      */
     on(event: WifiEvent, listener: () => void): void;
     /**
      * The `on()` method sets up a **one-time** listener, which is called whenever the specified event occurs.
+     *
+     * @param event The event for which to set up the listener.
+     * @param listener The listener function to call when the event occurs.
+     * @returns {void} Resolves when the listener is set up.
+     * @since 4.3.0
+     *
+     * @example
+     * sos.management.wifi.once(WifiEvent.CLIENT_CONNECTED, () => {
+     * 	console.log('Wi-Fi client is connected');
+     * });
      */
     once(event: WifiEvent, listener: () => void): void;
     /**
      * The `removeListener()` method removes a listener previously set up by `on()` or `once()` methods.
+     *
+     * @param event The event for which to remove the listener.
+     * @param listener The listener function to remove.
+     * @returns {void} Resolves when the listener is removed.
+     * @since 4.3.0
      */
     removeListener(event: WifiEvent, listener: () => void): void;
     /**
-     * The `removeAllListeners()` method removes all listeners for a specified event or for all events.
+     * The `removeAllListeners()` method removes all listeners for a specified event or all events.
+     *
+     * @param event The event for which to remove all listeners. If not specified, all listeners for all events will be removed.
+     * @returns {void} Resolves when all listeners are removed.
+     * @since 4.3.0
      */
     removeAllListeners(event?: WifiEvent): void;
     /** @internal */