@signageos/front-applet 8.1.2 → 8.1.4

package/docs/sos_management/audio.md

@@ -28,9 +28,9 @@ setVolume(volume: number): Promise<void>;
 
 #### Params
 
-| Name     | Type     | Description              |
-|----------|----------|--------------------------|
-| `volume` | `number` | Value between 0 and 100. |
+| Name     | Type     | Required         | Description              |
+|----------|----------|------------------|--------------------------|
+| `volume` | `number` |  <div>Yes</div>  | Value between 0 and 100. |
 
 ## API Example
 

package/docs/sos_management/firmware.md

@@ -54,10 +54,10 @@ upgrade(baseUrl: string, version: string): Promise<void>;
 
 #### Params
 
-| Name      | Type     | Description                                      |
-|-----------|----------|--------------------------------------------------|
-| `baseUrl` | `string` | The server URL where firmware files are located. |
-| `version` | `string` | The version of the firmware being installed.     |
+| Name      | Type     | Required         | Description                                      |
+|-----------|----------|------------------|--------------------------------------------------|
+| `baseUrl` | `string` |  <div>Yes</div>  | The server URL where firmware files are located. |
+| `version` | `string` |  <div>Yes</div>  | The version of the firmware being installed.     |
 
 #### Example
 
@@ -86,9 +86,9 @@ upgrade(fwUri: string): Promise<void>;
 
 #### Params
 
-| Name    | Type     | Description                                      |
-|---------|----------|--------------------------------------------------|
-| `fwUri` | `string` | FQN uri where the firmware main file is located. |
+| Name    | Type     | Required         | Description                                      |
+|---------|----------|------------------|--------------------------------------------------|
+| `fwUri` | `string` |  <div>Yes</div>  | FQN uri where the firmware main file is located. |
 
 #### Example
 
@@ -110,7 +110,7 @@ upgrade(version: string, baseUrl?: string): Promise<void>;
 
 #### Params
 
-| Name                   | Type     | Description                                                                                           |
-|------------------------|----------|-------------------------------------------------------------------------------------------------------|
-| `version`              | `string` | The version of the firmware being installed.                                                          |
-| `baseUrl` *(optional)* | `string` | Optional server URL where firmware files are located.<br/>(Default value: `"https://2.signageos.io"`) |
+| Name      | Type     | Required         | Description                                                                                           |
+|-----------|----------|------------------|-------------------------------------------------------------------------------------------------------|
+| `version` | `string` |  <div>Yes</div>  | The version of the firmware being installed.                                                          |
+| `baseUrl` | `string` |  <div>No</div>   | Optional server URL where firmware files are located.<br/>(Default value: `"https://2.signageos.io"`) |

package/docs/sos_management/index.md

@@ -136,9 +136,9 @@ setExtendedManagementUrl(url: string | null): Promise<void>;
 
 #### Params
 
-| Name  | Type             | Description                |
-|-------|------------------|----------------------------|
-| `url` | `string \| null` | The management URL to set. |
+| Name  | Type             | Required         | Description                |
+|-------|------------------|------------------|----------------------------|
+| `url` | `string \| null` |  <div>Yes</div>  | The management URL to set. |
 
 <Separator />
 
@@ -152,9 +152,9 @@ setHardwareAcceleration(enabled: boolean): Promise<void>;
 
 #### Params
 
-| Name      | Type      | Description                                      |
-|-----------|-----------|--------------------------------------------------|
-| `enabled` | `boolean` | Whether hardware acceleration should be enabled. |
+| Name      | Type      | Required         | Description                                      |
+|-----------|-----------|------------------|--------------------------------------------------|
+| `enabled` | `boolean` |  <div>Yes</div>  | Whether hardware acceleration should be enabled. |
 
 <Separator />
 
@@ -173,9 +173,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name         | Type                   | Description                          |
-|--------------|------------------------|--------------------------------------|
-| `capability` | `ManagementCapability` | The capability to check for support. |
+| Name         | Type                   | Required         | Description                          |
+|--------------|------------------------|------------------|--------------------------------------|
+| `capability` | `ManagementCapability` |  <div>Yes</div>  | The capability to check for support. |
 
 <Separator />
 

package/docs/sos_management/network.md

@@ -30,9 +30,9 @@ disableInterface(interfaceName: string): Promise<void>;
 
 #### Params
 
-| Name            | Type     | Description                                                                                        |
-|-----------------|----------|----------------------------------------------------------------------------------------------------|
-| `interfaceName` | `string` | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+| Name            | Type     | Required         | Description                                                                                        |
+|-----------------|----------|------------------|----------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string` |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
 
 <Separator />
 
@@ -85,9 +85,9 @@ setDHCP(interfaceName: string): Promise<void>;
 
 #### Params
 
-| Name            | Type     | Description                                                                                        |
-|-----------------|----------|----------------------------------------------------------------------------------------------------|
-| `interfaceName` | `string` | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+| Name            | Type     | Required         | Description                                                                                        |
+|-----------------|----------|------------------|----------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string` |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
 
 <Separator />
 
@@ -115,10 +115,10 @@ interface INetworkOptions {
 
 #### Params
 
-| Name            | Type              | Description                                                                                        |
-|-----------------|-------------------|----------------------------------------------------------------------------------------------------|
-| `interfaceName` | `string`          | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
-| `options`       | `INetworkOptions` | The network configuration options.                                                                 |
+| Name            | Type              | Required         | Description                                                                                        |
+|-----------------|-------------------|------------------|----------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string`          |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+| `options`       | `INetworkOptions` |  <div>Yes</div>  | The network configuration options.                                                                 |
 
 <Separator />
 

package/docs/sos_management/package.md

@@ -18,12 +18,12 @@ install(baseUrl: string, packageName: string, version: string, build: string | n
 
 #### Params
 
-| Name          | Type             | Description                        |
-|---------------|------------------|------------------------------------|
-| `baseUrl`     | `string`         | URL where the package is available |
-| `packageName` | `string`         | Name of the android package        |
-| `version`     | `string`         | Package version                    |
-| `build`       | `string \| null` | If relevant for your device        |
+| Name          | Type             | Required         | Description                        |
+|---------------|------------------|------------------|------------------------------------|
+| `baseUrl`     | `string`         |  <div>Yes</div>  | URL where the package is available |
+| `packageName` | `string`         |  <div>Yes</div>  | Name of the android package        |
+| `version`     | `string`         |  <div>Yes</div>  | Package version                    |
+| `build`       | `string \| null` |  <div>Yes</div>  | If relevant for your device        |
 
 ## API Example
 

package/docs/sos_management/power.md

@@ -128,9 +128,9 @@ removeScheduledReboot(id: string): Promise<void>;
 
 #### Params
 
-| Name | Type     | Description                     |
-|------|----------|---------------------------------|
-| `id` | `string` | - ID of the rule to be removed. |
+| Name | Type     | Required         | Description                     |
+|------|----------|------------------|---------------------------------|
+| `id` | `string` |  <div>Yes</div>  | - ID of the rule to be removed. |
 
 #### Example
 
@@ -155,13 +155,13 @@ setProprietaryTimer(type: ProprietaryTimerType, timeOn: string | null, timeOff:
 
 #### Params
 
-| Name                             | Type                | Description                                                                             |
-|----------------------------------|---------------------|-----------------------------------------------------------------------------------------|
-| `type`                           | ``TIMER_${number}`` | The type of the timer (`TIMER_1`, ..., `TIMER_7`).                                      |
-| `timeOn`                         | `string \| null`    | The time when the device should turn on.                                                |
-| `timeOff`                        | `string \| null`    | The time when the device should turn off.                                               |
-| `weekdays`                       | `string[]`          | The days of the week when the timer should be active (`mon`, ..., `sun`).               |
-| `keepAppletRunning` *(optional)* | `boolean`           | If `true`, the applet will be kept running when the timer is active on certain devices. |
+| Name                | Type                | Required         | Description                                                                             |
+|---------------------|---------------------|------------------|-----------------------------------------------------------------------------------------|
+| `type`              | ``TIMER_${number}`` |  <div>Yes</div>  | The type of the timer (`TIMER_1`, ..., `TIMER_7`).                                      |
+| `timeOn`            | `string \| null`    |  <div>Yes</div>  | The time when the device should turn on.                                                |
+| `timeOff`           | `string \| null`    |  <div>Yes</div>  | The time when the device should turn off.                                               |
+| `weekdays`          | `string[]`          |  <div>Yes</div>  | The days of the week when the timer should be active (`mon`, ..., `sun`).               |
+| `keepAppletRunning` | `boolean`           |  <div>No</div>   | If `true`, the applet will be kept running when the timer is active on certain devices. |
 
 #### Example
 
@@ -190,10 +190,10 @@ type WeekdayType = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' |
 
 #### Params
 
-| Name       | Type            | Description                                                      |
-|------------|-----------------|------------------------------------------------------------------|
-| `weekdays` | `WeekdayType[]` |                                                                  |
-| `time`     | `string`        | - Time when the reboot should be executed. Format is `HH:mm:ss`. |
+| Name       | Type            | Required         | Description                                                      |
+|------------|-----------------|------------------|------------------------------------------------------------------|
+| `weekdays` | `WeekdayType[]` |  <div>Yes</div>  |                                                                  |
+| `time`     | `string`        |  <div>Yes</div>  | - Time when the reboot should be executed. Format is `HH:mm:ss`. |
 
 #### Example
 
@@ -217,13 +217,13 @@ setTimer(type: keyof typeof TimerType, timeOn: string | null, timeOff: string |
 
 #### Params
 
-| Name       | Type                                                                                      | Description                                                               |
-|------------|-------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
-| `type`     | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` | The type of the timer (`TIMER_1`, ..., `TIMER_7`).                        |
-| `timeOn`   | `string \| null`                                                                          | The time when the device should turn on.                                  |
-| `timeOff`  | `string \| null`                                                                          | The time when the device should turn off.                                 |
-| `weekdays` | `string[]`                                                                                | The days of the week when the timer should be active (`mon`, ..., `sun`). |
-| `volume`   | `number`                                                                                  | The volume level set when the device is turned on.                        |
+| Name       | Type                                                                                      | Required         | Description                                                               |
+|------------|-------------------------------------------------------------------------------------------|------------------|---------------------------------------------------------------------------|
+| `type`     | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` |  <div>Yes</div>  | The type of the timer (`TIMER_1`, ..., `TIMER_7`).                        |
+| `timeOn`   | `string \| null`                                                                          |  <div>Yes</div>  | The time when the device should turn on.                                  |
+| `timeOff`  | `string \| null`                                                                          |  <div>Yes</div>  | The time when the device should turn off.                                 |
+| `weekdays` | `string[]`                                                                                |  <div>Yes</div>  | The days of the week when the timer should be active (`mon`, ..., `sun`). |
+| `volume`   | `number`                                                                                  |  <div>Yes</div>  | The volume level set when the device is turned on.                        |
 
 #### Example
 
@@ -260,9 +260,9 @@ unsetProprietaryTimer(type: ProprietaryTimerType): Promise<void>;
 
 #### Params
 
-| Name   | Type                | Description                                        |
-|--------|---------------------|----------------------------------------------------|
-| `type` | ``TIMER_${number}`` | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
+| Name   | Type                | Required         | Description                                        |
+|--------|---------------------|------------------|----------------------------------------------------|
+| `type` | ``TIMER_${number}`` |  <div>Yes</div>  | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
 
 #### Example
 
@@ -282,9 +282,9 @@ unsetTimer(type: keyof typeof TimerType): Promise<void>;
 
 #### Params
 
-| Name   | Type                                                                                      | Description                                        |
-|--------|-------------------------------------------------------------------------------------------|----------------------------------------------------|
-| `type` | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
+| Name   | Type                                                                                      | Required         | Description                                        |
+|--------|-------------------------------------------------------------------------------------------|------------------|----------------------------------------------------|
+| `type` | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` |  <div>Yes</div>  | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
 
 #### Example
 

package/docs/sos_management/screen.md

@@ -117,13 +117,13 @@ resize(baseUrl: string, orientation: string, resolution: string, currentVersion:
 
 #### Params
 
-| Name                            | Type     | Description                                                                                                                          |
-|---------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------|
-| `baseUrl`                       | `string` | SSSP & Tizen devices requires to install a orientation-specific Core App if you want to switch orientation to portrait or landscape. |
-| `orientation`                   | `string` | Screen orientation                                                                                                                   |
-| `resolution`                    | `string` | Where it applies (mainly SSSP 2/3)                                                                                                   |
-| `currentVersion`                | `string` | Core App version                                                                                                                     |
-| `videoOrientation` *(optional)* | `string` | If the video has different orientation than the HTML5 content                                                                        |
+| Name               | Type     | Required         | Description                                                                                                                          |
+|--------------------|----------|------------------|--------------------------------------------------------------------------------------------------------------------------------------|
+| `baseUrl`          | `string` |  <div>Yes</div>  | SSSP & Tizen devices requires to install a orientation-specific Core App if you want to switch orientation to portrait or landscape. |
+| `orientation`      | `string` |  <div>Yes</div>  | Screen orientation                                                                                                                   |
+| `resolution`       | `string` |  <div>Yes</div>  | Where it applies (mainly SSSP 2/3)                                                                                                   |
+| `currentVersion`   | `string` |  <div>Yes</div>  | Core App version                                                                                                                     |
+| `videoOrientation` | `string` |  <div>No</div>   | If the video has different orientation than the HTML5 content                                                                        |
 
 #### Example
 
@@ -163,12 +163,12 @@ setBrightness(timeFrom1: string, brightness1: number, timeFrom2: string, brightn
 
 #### Params
 
-| Name          | Type     | Description                        |
-|---------------|----------|------------------------------------|
-| `timeFrom1`   | `string` | Time in the XX:XX format           |
-| `brightness1` | `number` | Brightness value between 0 and 100 |
-| `timeFrom2`   | `string` | Time in the XX:XX format           |
-| `brightness2` | `number` | Brightness value between 0 and 100 |
+| Name          | Type     | Required         | Description                        |
+|---------------|----------|------------------|------------------------------------|
+| `timeFrom1`   | `string` |  <div>Yes</div>  | Time in the XX:XX format           |
+| `brightness1` | `number` |  <div>Yes</div>  | Brightness value between 0 and 100 |
+| `timeFrom2`   | `string` |  <div>Yes</div>  | Time in the XX:XX format           |
+| `brightness2` | `number` |  <div>Yes</div>  | Brightness value between 0 and 100 |
 
 #### Example
 
@@ -206,10 +206,10 @@ takeAndUploadScreenshot(uploadBaseUrl: string, computeHash?: boolean): Promise<{
 
 #### Params
 
-| Name                       | Type      | Description                                                                                                   |
-|----------------------------|-----------|---------------------------------------------------------------------------------------------------------------|
-| `uploadBaseUrl`            | `string`  | URL to which the screenshot will be uploaded. It can be either a signageOS upload url or a custom server url. |
-| `computeHash` *(optional)* | `boolean` | Whether to compute a hash of the screenshot and return it in the response.                                    |
+| Name            | Type      | Required         | Description                                                                                                   |
+|-----------------|-----------|------------------|---------------------------------------------------------------------------------------------------------------|
+| `uploadBaseUrl` | `string`  |  <div>Yes</div>  | URL to which the screenshot will be uploaded. It can be either a signageOS upload url or a custom server url. |
+| `computeHash`   | `boolean` |  <div>No</div>   | Whether to compute a hash of the screenshot and return it in the response.                                    |
 
 #### Example
 

package/docs/sos_management/security.md

@@ -42,9 +42,9 @@ setPinCode(pinCode: string): Promise<void>;
 
 #### Params
 
-| Name      | Type     | Description             |
-|-----------|----------|-------------------------|
-| `pinCode` | `string` | The PIN code to be set. |
+| Name      | Type     | Required         | Description             |
+|-----------|----------|------------------|-------------------------|
+| `pinCode` | `string` |  <div>Yes</div>  | The PIN code to be set. |
 
 #### Possible errors
 

package/docs/sos_management/time.md

@@ -57,10 +57,10 @@ interface DateTime {
 
 #### Params
 
-| Name       | Type       | Description               |
-|------------|------------|---------------------------|
-| `dateTime` | `DateTime` | The date and time to set. |
-| `timezone` | `string`   | The timezone to set.      |
+| Name       | Type       | Required         | Description               |
+|------------|------------|------------------|---------------------------|
+| `dateTime` | `DateTime` |  <div>Yes</div>  | The date and time to set. |
+| `timezone` | `string`   |  <div>Yes</div>  | The timezone to set.      |
 
 <Separator />
 
@@ -83,10 +83,10 @@ setNTP(ntpServer: string, timezone: string): Promise<void>;
 
 #### Params
 
-| Name        | Type     | Description            |
-|-------------|----------|------------------------|
-| `ntpServer` | `string` | The NTP server to set. |
-| `timezone`  | `string` | The timezone to set.   |
+| Name        | Type     | Required         | Description            |
+|-------------|----------|------------------|------------------------|
+| `ntpServer` | `string` |  <div>Yes</div>  | The NTP server to set. |
+| `timezone`  | `string` |  <div>Yes</div>  | The timezone to set.   |
 
 <Separator />
 

package/docs/sos_management/wifi.md

@@ -54,11 +54,11 @@ type WifiEncryptionType = 'OPEN' | 'WEP' | 'WPA2' | 'WPA2_WPA_MIXED' | 'WPA3' |
 
 #### Params
 
-| Name                    | Type                  | Description                                                                |
-|-------------------------|-----------------------|----------------------------------------------------------------------------|
-| `ssid`                  | `string`              | Name of the network, max. allowed length is 32 characters.                 |
-| `password` *(optional)* | `string`              | Password of the device, must be between 8 and 32 characters.               |
-| `options` *(optional)*  | `IWifiConnectOptions` | Additional options for the connection, such as `hidden` or `securityType`. |
+| Name       | Type                  | Required         | Description                                                                |
+|------------|-----------------------|------------------|----------------------------------------------------------------------------|
+| `ssid`     | `string`              |  <div>Yes</div>  | Name of the network, max. allowed length is 32 characters.                 |
+| `password` | `string`              |  <div>No</div>   | Password of the device, must be between 8 and 32 characters.               |
+| `options`  | `IWifiConnectOptions` |  <div>No</div>   | Additional options for the connection, such as `hidden` or `securityType`. |
 
 #### Return value
 
@@ -126,10 +126,10 @@ enableAP(ssid: string, password: string): Promise<void>;
 
 #### Params
 
-| Name       | Type     | Description                                                  |
-|------------|----------|--------------------------------------------------------------|
-| `ssid`     | `string` | Name of the network, max. allowed length is 32 characters.   |
-| `password` | `string` | Password of the device, must be between 8 and 32 characters. |
+| Name       | Type     | Required         | Description                                                  |
+|------------|----------|------------------|--------------------------------------------------------------|
+| `ssid`     | `string` |  <div>Yes</div>  | Name of the network, max. allowed length is 32 characters.   |
+| `password` | `string` |  <div>Yes</div>  | Password of the device, must be between 8 and 32 characters. |
 
 #### Possible errors
 
@@ -425,9 +425,9 @@ setCountry(countryCode: string): Promise<void>;
 
 #### Params
 
-| Name          | Type     | Description                                       |
-|---------------|----------|---------------------------------------------------|
-| `countryCode` | `string` | 2-letter country code from the ISO 3166 standard. |
+| Name          | Type     | Required         | Description                                       |
+|---------------|----------|------------------|---------------------------------------------------|
+| `countryCode` | `string` |  <div>Yes</div>  | 2-letter country code from the ISO 3166 standard. |
 
 #### Possible errors
 

package/es6/FrontApplet/Browser/Browser.d.ts

@@ -4,7 +4,7 @@ import IOpenLinkOptions, { IDeprecatedOpenLinkOptions } from './IOpenLinkOptions
 import { IBrowserMessage } from './messages';
 import IBrowser from './IBrowser';
 /**
- * The `sos.browser` API groups together methods for working with the integrated web browser.
+ * There are several use-cases when you need to open a web browser on a touch-enabled device (also known as a tablet). For these cases, you can use a custom web browser we built. Default URL can be opened and even the whitelisting/blacklisting of certain domains is supported.
  *
  * :::info
  *
@@ -27,21 +27,28 @@ export default class Browser implements IBrowser {
     /**
      * The `open()` method opens the specified url in a browser window.
      *
-     * @param options.aclDomains List of domains to be interpreted according to `aclMode`.
-     * @param options.aclMode Either "blacklist" or "whitelist".
-     * @param options.readOnlyAddressBar Should the address bar be readonly.
-     * @param options.idleTimeout Close browser after specified period if idle.
+     * @param uri The URL to open in the browser.
+     * @param options Optional parameters to configure the browser window.
+     * @param options.aclDomains List of domains to be interpreted according to `aclMode`. Example: `signageos.io`, `www.example.com`
+     * @param options.aclMode `blacklist` – Allow access to all domains except those in aclDomains and their subdomains, `whitelist` – Allow access only to domains in aclDomains and their subdomains.
+     * @param options.readOnlyAddressBar If `true`, the address bar is read-only, if `false` the user can navigate away by entering a URL in the address bar.
+     * @param options.idleTimeout The browser will automatically close after a specified period of inactivity (in milliseconds).
      * @param options.coordinates Size and position of the browser window. Defaults to fullscreen.
      * @param options.theme Specify custom UI theme. (Android only)
      * @param options.headlessMode Headless mode hides the entire address bar. (Android only)
      * @param options.canUserClose Whether the user can manually close the browser. (default if headless false, else true)
      * @param options.clearData Clear cache after the browser closes. (default if headless false, else true)
-     * @param options.method Either "native" or "iframe"
-     *
+     * @param options.method Can only be native (which opens a new, fully sandboxed fullscreen window) or iframe (which opens a configurable-sized window). (only Linux)
+     * @returns {Promise<void>} A promise that resolves when the browser is opened.
+     * @throws {Error} If the `uri` is not a valid URL or string.
+     * @throws {Error} If the `options` are not valid.
+     * @throws {Error} If unexpected error occurred when opening link.
      * @since 4.0.0
      *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/browser | Example of Applet for using browser on Android }
+     *
      * @example
-     * sos.browser.open('https://www.signageos.io', {
+     * await sos.browser.open('https://www.signageos.io', {
      * 	aclDomains: ['google.com', 'yahoo.com'],
      * 	aclMode: 'blacklist', // or 'whitelist'
      * 	readOnlyAddressBar: true,
@@ -59,14 +66,23 @@ export default class Browser implements IBrowser {
     /**
      * The `close()` method closes the browser window opened by the `open()` method.
      *
+     * @returns {Promise<void>} A promise that resolves when the browser is closed.
      * @since 4.0.0
+     *
+     * @example
+     * await sos.browser.open('https://www.signageos.io', {
+     * 	readOnlyAddressBar: true,
+     * });
+     * // some time later
+     * await sos.browser.close();
      */
     close(): Promise<void>;
     /**
      * The `onClose()` method sets up a listener, which is called whenever a browser window is closed. This can happen by an API call, by a
      * user request or after a timeout. This doesn't fire between `open` calls or on subsequent `close` calls.
      *
-     * @returns A callback which removes the listener.
+     * @param listener The listener to be called when the browser is closed.
+     * @returns {void} A callback which removes the listener.
      */
     onClose(listener: (event: CloseEvent) => void): () => void;
     /** @internal */

package/es6/FrontApplet/Browser/Browser.js

@@ -8,7 +8,7 @@ const Validate_1 = __importDefault(require("../Validate/Validate"));
 const events_2 = require("./events");
 const IOpenLinkOptions_1 = require("./IOpenLinkOptions");
 /**
- * The `sos.browser` API groups together methods for working with the integrated web browser.
+ * There are several use-cases when you need to open a web browser on a touch-enabled device (also known as a tablet). For these cases, you can use a custom web browser we built. Default URL can be opened and even the whitelisting/blacklisting of certain domains is supported.
  *
  * :::info
  *
@@ -33,21 +33,28 @@ class Browser {
     /**
      * The `open()` method opens the specified url in a browser window.
      *
-     * @param options.aclDomains List of domains to be interpreted according to `aclMode`.
-     * @param options.aclMode Either "blacklist" or "whitelist".
-     * @param options.readOnlyAddressBar Should the address bar be readonly.
-     * @param options.idleTimeout Close browser after specified period if idle.
+     * @param uri The URL to open in the browser.
+     * @param options Optional parameters to configure the browser window.
+     * @param options.aclDomains List of domains to be interpreted according to `aclMode`. Example: `signageos.io`, `www.example.com`
+     * @param options.aclMode `blacklist` – Allow access to all domains except those in aclDomains and their subdomains, `whitelist` – Allow access only to domains in aclDomains and their subdomains.
+     * @param options.readOnlyAddressBar If `true`, the address bar is read-only, if `false` the user can navigate away by entering a URL in the address bar.
+     * @param options.idleTimeout The browser will automatically close after a specified period of inactivity (in milliseconds).
      * @param options.coordinates Size and position of the browser window. Defaults to fullscreen.
      * @param options.theme Specify custom UI theme. (Android only)
      * @param options.headlessMode Headless mode hides the entire address bar. (Android only)
      * @param options.canUserClose Whether the user can manually close the browser. (default if headless false, else true)
      * @param options.clearData Clear cache after the browser closes. (default if headless false, else true)
-     * @param options.method Either "native" or "iframe"
-     *
+     * @param options.method Can only be native (which opens a new, fully sandboxed fullscreen window) or iframe (which opens a configurable-sized window). (only Linux)
+     * @returns {Promise<void>} A promise that resolves when the browser is opened.
+     * @throws {Error} If the `uri` is not a valid URL or string.
+     * @throws {Error} If the `options` are not valid.
+     * @throws {Error} If unexpected error occurred when opening link.
      * @since 4.0.0
      *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/browser | Example of Applet for using browser on Android }
+     *
      * @example
-     * sos.browser.open('https://www.signageos.io', {
+     * await sos.browser.open('https://www.signageos.io', {
      * 	aclDomains: ['google.com', 'yahoo.com'],
      * 	aclMode: 'blacklist', // or 'whitelist'
      * 	readOnlyAddressBar: true,
@@ -75,7 +82,15 @@ class Browser {
     /**
      * The `close()` method closes the browser window opened by the `open()` method.
      *
+     * @returns {Promise<void>} A promise that resolves when the browser is closed.
      * @since 4.0.0
+     *
+     * @example
+     * await sos.browser.open('https://www.signageos.io', {
+     * 	readOnlyAddressBar: true,
+     * });
+     * // some time later
+     * await sos.browser.close();
      */
     async close() {
         await this.exchange.postMessage({
@@ -86,7 +101,8 @@ class Browser {
      * The `onClose()` method sets up a listener, which is called whenever a browser window is closed. This can happen by an API call, by a
      * user request or after a timeout. This doesn't fire between `open` calls or on subsequent `close` calls.
      *
-     * @returns A callback which removes the listener.
+     * @param listener The listener to be called when the browser is closed.
+     * @returns {void} A callback which removes the listener.
      */
     onClose(listener) {
         (0, Validate_1.default)({ listener }).required().function();

package/es6/FrontApplet/Browser/Browser.js.map

@@ -1 +1 @@
-{"version":3,"file":"Browser.js","sourceRoot":"","sources":["../../../src/FrontApplet/Browser/Browser.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,oEAA4C;AAC5C,qCAA8D;AAC9D,yDAAqG;AAIrG;;;;;;;;;;;;;;;GAeG;AACH,MAAqB,OAAO;IAIE;IAHZ,MAAM,GAAiB,IAAI,qBAAY,EAAE,CAAC;IAE3D,gBAAgB;IAChB,YAA6B,QAAwB;QAAxB,aAAQ,GAAR,QAAQ,CAAgB;IAAG,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACI,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,UAA4B,EAAE;QAC5D,IAAA,kBAAQ,EAAC,EAAE,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QACnC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,oCAAiB,CAAC,CAAC;QAE3D,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC;QAClD,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC/B,GAAG;YACH,GAAG,OAAO;YACV,YAAY;YACZ,IAAI,EAAE,MAAM;SACZ,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK;QACjB,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC/B,IAAI,EAAE,OAAO;SACb,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,QAAqC;QACnD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAE7C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,kBAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACnD,OAAO,GAAG,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,kBAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAqB;QAC7C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC;gBAC7C,MAAM,KAAK,GAAe;oBACzB,IAAI,EAAE,kBAAS,CAAC,KAAK;oBACrB,MAAM,EAAE,IAAI,CAAC,MAAqB;iBAClC,CAAC;gBACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBACzC,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,UAAsC,EAAE;QAC1E,OAAO,CAAC,IAAI,CAAC,kHAAkH,CAAC,CAAC;QAEjI,IAAA,kBAAQ,EAAC,EAAE,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QACnC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAE1C,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC/B,GAAG;YACH,GAAG,OAAO;YACV,YAAY,EAAE,KAAK;YACnB,IAAI,EAAE,WAAW;SACjB,CAAC,CAAC;IACJ,CAAC;CACD;AA1GD,0BA0GC"}
+{"version":3,"file":"Browser.js","sourceRoot":"","sources":["../../../src/FrontApplet/Browser/Browser.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,oEAA4C;AAC5C,qCAA8D;AAC9D,yDAAqG;AAIrG;;;;;;;;;;;;;;;GAeG;AACH,MAAqB,OAAO;IAIE;IAHZ,MAAM,GAAiB,IAAI,qBAAY,EAAE,CAAC;IAE3D,gBAAgB;IAChB,YAA6B,QAAwB;QAAxB,aAAQ,GAAR,QAAQ,CAAgB;IAAG,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACI,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,UAA4B,EAAE;QAC5D,IAAA,kBAAQ,EAAC,EAAE,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QACnC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,oCAAiB,CAAC,CAAC;QAE3D,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC;QAClD,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC/B,GAAG;YACH,GAAG,OAAO;YACV,YAAY;YACZ,IAAI,EAAE,MAAM;SACZ,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,KAAK;QACjB,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC/B,IAAI,EAAE,OAAO;SACb,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,QAAqC;QACnD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAE7C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,kBAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACnD,OAAO,GAAG,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,kBAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAqB;QAC7C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC;gBAC7C,MAAM,KAAK,GAAe;oBACzB,IAAI,EAAE,kBAAS,CAAC,KAAK;oBACrB,MAAM,EAAE,IAAI,CAAC,MAAqB;iBAClC,CAAC;gBACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBACzC,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,UAAsC,EAAE;QAC1E,OAAO,CAAC,IAAI,CAAC,kHAAkH,CAAC,CAAC;QAEjI,IAAA,kBAAQ,EAAC,EAAE,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QACnC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAE1C,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC/B,GAAG;YACH,GAAG,OAAO;YACV,YAAY,EAAE,KAAK;YACnB,IAAI,EAAE,WAAW;SACjB,CAAC,CAAC;IACJ,CAAC;CACD;AA1HD,0BA0HC"}

package/es6/FrontApplet/Browser/IOpenLinkOptions.d.ts

@@ -89,6 +89,9 @@ export interface IDeprecatedOpenLinkOptions {
     idleTimeout?: number;
     theme?: ITheme;
 }
+/**
+ * Interface defines the options for opening a link in the browser.
+ */
 interface IOpenLinkOptions {
     aclDomains?: string[];
     aclMode?: 'blacklist' | 'whitelist';
@@ -104,6 +107,10 @@ interface IOpenLinkOptions {
     headlessMode?: boolean;
     clearData?: boolean;
     canUserClose?: boolean;
+    /**
+     * Method of opening the link.
+     * @default 'native'
+     */
     method?: 'native' | 'iframe';
 }
 export default IOpenLinkOptions;

package/es6/FrontApplet/Browser/IOpenLinkOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"IOpenLinkOptions.js","sourceRoot":"","sources":["../../../src/FrontApplet/Browser/IOpenLinkOptions.ts"],"names":[],"mappings":";;;AAkCa,QAAA,OAAO,GAAG;IACtB,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;IACtC,KAAK,EAAE;QACN,SAAS,EAAE;YACV,UAAU,EAAE,SAAS;SACrB;KACD;IACD,MAAM,EAAE;QACP,SAAS,EAAE;YACV,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,SAAS;YACrB,OAAO,EAAE,SAAS;SAClB;KACD;IACD,OAAO,EAAE;QACR,SAAS,EAAE;YACV,WAAW,EAAE;gBACZ,SAAS,EAAE;oBACV,MAAM,EAAE;wBACP,SAAS,EAAE;4BACV,UAAU,EAAE,SAAS;4BACrB,IAAI,EAAE,SAAS;yBACf;qBACD;iBACD;aACD;YACD,WAAW,EAAE;gBACZ,SAAS,EAAE;oBACV,MAAM,EAAE;wBACP,SAAS,EAAE;4BACV,UAAU,EAAE,SAAS;4BACrB,IAAI,EAAE,SAAS;4BACf,IAAI,EAAE,SAAS;yBACf;qBACD;oBACD,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE;oBAC/D,IAAI,EAAE,SAAS;iBACf;aACD;YACD,QAAQ,EAAE;gBACT,SAAS,EAAE;oBACV,KAAK,EAAE,SAAS;iBAChB;aACD;SACD;KACD;CACD,CAAC;AA+BW,QAAA,iBAAiB,GAAG;IAChC,UAAU,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE;IAClC,OAAO,EAAE,EAAE,SAAS,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE;IAClD,kBAAkB,EAAE,UAAU;IAC9B,WAAW,EAAE,SAAS;IACtB,WAAW,EAAE;QACZ,SAAS,EAAE;YACV,CAAC,EAAE,QAAQ;YACX,CAAC,EAAE,QAAQ;YACX,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;SAChB;KACD;IACD,KAAK,EAAE,EAAE,SAAS,EAAE,eAAO,EAAE;IAC7B,YAAY,EAAE,UAAU;IACxB,SAAS,EAAE,UAAU;IACrB,YAAY,EAAE,UAAU;IACxB,MAAM,EAAE,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE;CAC3C,CAAC"}
+{"version":3,"file":"IOpenLinkOptions.js","sourceRoot":"","sources":["../../../src/FrontApplet/Browser/IOpenLinkOptions.ts"],"names":[],"mappings":";;;AAkCa,QAAA,OAAO,GAAG;IACtB,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;IACtC,KAAK,EAAE;QACN,SAAS,EAAE;YACV,UAAU,EAAE,SAAS;SACrB;KACD;IACD,MAAM,EAAE;QACP,SAAS,EAAE;YACV,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,SAAS;YACrB,OAAO,EAAE,SAAS;SAClB;KACD;IACD,OAAO,EAAE;QACR,SAAS,EAAE;YACV,WAAW,EAAE;gBACZ,SAAS,EAAE;oBACV,MAAM,EAAE;wBACP,SAAS,EAAE;4BACV,UAAU,EAAE,SAAS;4BACrB,IAAI,EAAE,SAAS;yBACf;qBACD;iBACD;aACD;YACD,WAAW,EAAE;gBACZ,SAAS,EAAE;oBACV,MAAM,EAAE;wBACP,SAAS,EAAE;4BACV,UAAU,EAAE,SAAS;4BACrB,IAAI,EAAE,SAAS;4BACf,IAAI,EAAE,SAAS;yBACf;qBACD;oBACD,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE;oBAC/D,IAAI,EAAE,SAAS;iBACf;aACD;YACD,QAAQ,EAAE;gBACT,SAAS,EAAE;oBACV,KAAK,EAAE,SAAS;iBAChB;aACD;SACD;KACD;CACD,CAAC;AAwEW,QAAA,iBAAiB,GAAG;IAChC,UAAU,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE;IAClC,OAAO,EAAE,EAAE,SAAS,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE;IAClD,kBAAkB,EAAE,UAAU;IAC9B,WAAW,EAAE,SAAS;IACtB,WAAW,EAAE;QACZ,SAAS,EAAE;YACV,CAAC,EAAE,QAAQ;YACX,CAAC,EAAE,QAAQ;YACX,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;SAChB;KACD;IACD,KAAK,EAAE,EAAE,SAAS,EAAE,eAAO,EAAE;IAC7B,YAAY,EAAE,UAAU;IACxB,SAAS,EAAE,UAAU;IACrB,YAAY,EAAE,UAAU;IACxB,MAAM,EAAE,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE;CAC3C,CAAC"}

package/es6/FrontApplet/Browser/events.d.ts

@@ -5,7 +5,13 @@ export declare const VIEventType: string[];
 export type Event<TType extends EventType = EventType> = {
     type: TType;
 };
+/**
+ * Interface representing a close event in the browser.
+ */
 export interface CloseEvent extends Event<EventType.CLOSE> {
+    /**
+     * The reason for the browser being closed.
+     */
     reason: CloseReason;
 }
 export declare enum CloseReason {

package/es6/FrontApplet/Browser/events.js.map

@@ -1 +1 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/FrontApplet/Browser/events.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAEX;AAFD,WAAY,SAAS;IACpB,4BAAe,CAAA;AAChB,CAAC,EAFW,SAAS,yBAAT,SAAS,QAEpB;AAEY,QAAA,WAAW,GAAG,CAAC,OAAO,CAAC,CAAC;AAUrC,IAAY,WAIX;AAJD,WAAY,WAAW;IACtB,0BAAW,CAAA;IACX,4BAAa,CAAA;IACb,kCAAmB,CAAA;AACpB,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB"}
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/FrontApplet/Browser/events.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAEX;AAFD,WAAY,SAAS;IACpB,4BAAe,CAAA;AAChB,CAAC,EAFW,SAAS,yBAAT,SAAS,QAEpB;AAEY,QAAA,WAAW,GAAG,CAAC,OAAO,CAAC,CAAC;AAgBrC,IAAY,WAIX;AAJD,WAAY,WAAW;IACtB,0BAAW,CAAA;IACX,4BAAa,CAAA;IACb,kCAAmB,CAAA;AACpB,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB"}