@signageos/front-applet 6.2.1 → 6.4.0

package/docs/applet-basics.md

@@ -167,7 +167,7 @@ window.addEventListener('sos.loaded',() => {
 
 ## Custom variables in Applet
 
-You can pass CUSTOM key-value variables to the Applet. To do that, add your values as a Timing configuration (over Box of [Timings API](/api/rest/timing/3-timing-post-one)). Then you can access your values via `sos.config` object.
+You can pass CUSTOM key-value variables to the Applet. To do that, add your values as a Timing configuration (over Box of [Timings API](https://docs.signageos.io/hc/en-us/articles/4405238989458)). Then you can access your values via `sos.config` object.
 
 ```javascript
 // Parsed JSON object passed to Timing for current applet & current device together
@@ -225,7 +225,7 @@ Management capabilities refer to the capabilities of the display's internal stat
 
 | Capability                     | Description                                                                               |
 | ------------------------------ | ----------------------------------------------------------------------------------------- |
-| `BATTERY_STATUS` | Device can [report its battery status](management/js-management#getbatterystatus). |
+| `BATTERY_STATUS` | Device can [report its battery status](management/js-management-management#getbatterystatus). |
 | `WIFI` | Device can [connect to a Wi-Fi](management/js-management-wifi#connect). |
 | `WIFI_SCAN` | Device can [scan surrounding Wi-Fi devices](management/js-management-wifi#scandevices). |
 | `WIFI_AP` | Device is capable of [becoming a Wi-Fi endpoint](management/js-management-wifi#enableap) that other devices can connect to. |
@@ -233,7 +233,7 @@ Management capabilities refer to the capabilities of the display's internal stat
 | `SET_TIME` | Device can change its [time settings](management/js-management-time). |
 | `NTP_TIME` | Device can [synchronize its time with an NTP server](management/js-management-time#setntp). |
 | `PACKAGE_INSTALL` | It's possible to [install additional packages](management/js-management-package) on the device, managed by signageOS application. |
-| `SET_VOLUME` | Device can change its [audio volume](management/js-management-volume). |
+| `SET_VOLUME` | Device can change its [audio volume](management/js-management-audio). |
 | `SET_REMOTE_CONTROL_ENABLED` | Device can [disable control via IR remote](management/js-management-remote-control) to increase security. 
 
 ```javascript

package/docs/{js-api → content}/js-browser.md

@@ -13,24 +13,24 @@ description: "[Content JS API] There are several use-cases when you need to open
 
 # 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. 
+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.
 
 ## All methods
 
 | Methods  | Description | Supported since |
 | ----------------- | ----------- | :---------------: |
 | `open()`        | Open page in integrated browser |      4.0.0    |
-| `close()`        | Open page in integrated browser |      4.4.0    
+| `close()`        | Open page in integrated browser |      4.4.0
 
 ## open()
 
 :::info
-**This API is currently available on:**  
+**This API is currently available on:**
 - Android devices with Android 5+ (Philips, Benq, Sharp, generic Android device)
 
-**With some limitation you can use this API also on**  
+**With some limitation you can use this API also on**
 - Samsung Tizen (SSSP 4 and above); where the website is just in fullscreen without an address bar or theme options (headless mode)
 - LG webOS (webOS 3.0 and above); where the website is just in fullscreen without an address bar or theme options (headless mode)
 - Raspberry Pi and NEC Compute Module; where the website is just in fullscreen without an address bar or theme options (headless mode)
@@ -51,12 +51,14 @@ Method `open()` also supports properties for browser. You can set height, width
 | `aclDomains` | Array | ? |
 | `aclMode` | String | Can be only **blacklist** or **whitelist**. |
 | `readOnlyAddressBar` | Boolean | Accessible address bar |
-| `coordinates` | Object | Size of browser screen (only Raspberry Pi) |
+| `coordinates` | Object | Size of browser screen (only Linux) |
 | `idleTimeout` | Number | Timeout in milliseconds for loading page |
 | `theme` | Object | Setting custom theme for Android |
 | `headlessMode` | Boolean | Headless mode hides the entire address bar (default) |
 | `canUserClose` | Boolean | Whether the user can manually close the browser. Default:<br/>**Headless:** `false`<br/>**With UI:** `true` |
-| `clearData` | Boolean | Clear cache after the browser closes. Default:<br/>**Headless:** `false`<br/>**With UI:** `true` 
+| `clearData` | Boolean | Clear cache after the browser closes. Default:<br/>**Headless:** `false`<br/>**With UI:** `true`
+| `method` | String | Can only be **native** (which opens a new, fully sandboxed fullscreen window) or **iframe** (which opens a configurable-sized window). (only Linux) |
+:::
 
 
 ```javascript
@@ -64,7 +66,7 @@ sos.browser.open('https://www.signageos.io', {
   aclDomains: ['google.com', 'yahoo.com'],
   aclMode: 'blacklist', // or 'whitelist'
   readOnlyAddressBar: true,
-  coordinates: { // Supported only on Raspberry Pi and Android
+  coordinates: { // Supported only on Linux and Android
     x: 0,
     y: 0,
     height: 500,
@@ -134,6 +136,7 @@ interface IOpenLinkOptions {
 	headlessMode?: boolean;
 	clearData?: boolean;
 	canUserClose?: boolean;
+	method?: 'native' | 'iframe'
 }
 
 open(uri: string, options?: IOpenLinkOptions): void;
@@ -157,5 +160,5 @@ Although we are doing our best, following errors may occur when opening a link.
 | Code | Type | Message |
 | ---- | ---- | ------- |
 | 40301 | AppletBrowserUriError | Property argument `uri` must be a string |
-| 50301 | InternalBrowserOpenLinkError | Unexpected error occurred when opening `$$LINK$$` 
+| 50301 | InternalBrowserOpenLinkError | Unexpected error occurred when opening `$$LINK$$`
 

package/docs/{js-api → content}/js-display.md

@@ -32,13 +32,23 @@ with a warning message like this one:
 
 :::warning
 * Before using this API, ensure that the display supports serial via `sos.display.supports("SERIAL")`.
-* More info [**HERE**](/api/js/content/latest/js-display#supports).
 :::
 
-
-| Param        | Type   | Required                   | Description     |
-| ------------ | ------ | :------------------------: | --------------- |
-| `capability` | string | <div class="red">Yes</div> | Capability name 
+### List of capabilities
+
+| Param        | Description     |
+| ------------ | --------------- |
+| `FILE_SYSTEM_INTERNAL_STORAGE` |  |
+| `FILE_SYSTEM_EXTERNAL_STORAGE` |  |
+| `FILE_SYSTEM_FILE_CHECKSUM` |  |
+| `FILE_SYSTEM_LINK` |  |
+| `TIMERS_PROPRIETARY` |  |
+| `VIDEO_4K` |  |
+| `SERIAL` |  |
+| `BARCODE_SCANNER` |  |
+| `FRONT_OSD` |  |
+| `FILE_SYSTEM_CREATE_ARCHIVE` |  |
+| `FILE_SYSTEM_ARCHIVE_EXTRACT_INFO` | Information about total size of all files when archive will be extracted |
 
 ### Javascript example
 ```javascript

package/docs/{js-api → content}/js-file-system.md

@@ -16,7 +16,7 @@ File System API allows **low level manipulation with files and directories** in
 File System API works with both in **internal and external storages** (USB flash drives, etc.).
 
 :::warning
-File System directory structure is **PERSISTENT** and is **NOT** automatically deleted through `Applet Reload` power action! Applet Reload only deletes `/data` directory which is reserved for simplified [Offline Cache API](/api/js/content/js-offline-cache-media-files). Use `deleteFile()` to clear the device storage file system.
+File System directory structure is **PERSISTENT** and is **NOT** automatically deleted through `Applet Reload` power action! Applet Reload only deletes `/data` directory which is reserved for simplified [Offline Cache API](js-offline-cache-media-files). Use `deleteFile()` to clear the device storage file system.
 :::
 
 <div class="row d-flex align-content-stretch force-padding-10">
@@ -35,21 +35,9 @@ File System directory structure is **PERSISTENT** and is **NOT** automatically d
     </div>
 </div>
 
-<div class="row d-flex align-content-stretch force-padding-20">
-    <div class="col-12 d-flex">
-        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" href="/api/js/content/js-offline-cache-media-files">
-            <div>
-                <div class="wide-box__image d-flex align-items-center">
-                    <i class="fas fa-medal svg-black"></i>
-                </div>
-            <div>
-                <h3 class="wide-box__title wide-box__title__small pl-85">Offline Cache for media files</h3>
-                <div class="wide-box__description">Working example on our Github</div>
-            </div>
-            </div>
-        </a>
-    </div>
-</div>
+:::note[Alternative file caching]
+[Offline Cache for media files](js-offline-cache-media-files)
+:::
 
 ## All methods
 

package/docs/{js-api → content}/js-offline-cache-simple-data.md

@@ -15,7 +15,7 @@ description: "[Content JS API] This API provides you with approach similar to th
 
 Use when you need to save some data into local memory. 
 This API provides you with approach similar to the HTML5's Local Storage, but implemented internally via native device API and completely device agnostic. 
-We do not recommend using a different storage type then Offline Cache or full featured [File System API](/api/js/content/js-file-system) that will provide you with more low-level methods.
+We do not recommend using a different storage type then Offline Cache or full featured [File System API](js-file-system) that will provide you with more low-level methods.
 
 ## All methods
 

package/docs/{js-api → content}/js-sensors.md

@@ -62,9 +62,9 @@ For more information read [this article](https://docs.signageos.io/hc/en-us/arti
 
 Sometimes you might want to use hardware that we don't support out of the box yet.
 
-Firstly, you will need to read the documentation for the [serial API](/api/js/content/js-hardware-serial).
+Firstly, you will need to read the documentation for the [serial API](js-serial).
 Most often, the hardware you will decide to use connects to the device via USB and internally uses a serial communication, like RS232.
 In that case you will use the serial API.
 
-You can approach this any way you like, but remember that you should always implement the [interfaces defined by us](/api/js/content/js-sensors#sensors-interfaces).
+You can approach this any way you like, but remember that you should always implement the [interfaces defined by us](js-sensors#sensors-interfaces).
 That will allow for greater code reusability and readability.

package/docs/{js-api → content}/js-serial.md

@@ -21,7 +21,7 @@ Such hardware could be, for example, printers, payment terminals or sensors.
 
 :::warning
 * Before using this API, ensure that the display supports serial via `sos.display.supports("SERIAL")`.
-* More info [**HERE**](/api/js/content/latest/js-display#supports).
+* More info [**HERE**](js-display#supports).
 * Samsung Kiosk serial connection only works over serial ports, not over USB ports
 :::
 

package/docs/{js-api → content}/js-video-inputs-internal-ports.md

@@ -22,7 +22,7 @@ Display content from another device over HDMI, Display Port, or other port. PIP
 | `stop()` | Method stops using the internal port. | 1.0.18 |
 
 ## play() 
-Method uses the same API as [video streams](/api/js/content/js-video-stream). Instead of URL (for stream), **specify an URI of the port** to display.
+Method uses the same API as [video streams](js-video-stream). Instead of URL (for stream), **specify an URI of the port** to display.
 
 ### Parameters