@signageos/front-applet 6.2.0 → 6.2.1

package/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [6.2.1] - 2024-01-15
+### Fixed
+- Docs markdowns
+
 ## [6.2.0] - 2024-01-15
 ### Added
 - Add `keepAppletRunning` parameter in `sos.management.power.setProprietaryTimer`

package/docs/{js-api/js-applet-basics.md → applet-basics.md}

@@ -17,7 +17,7 @@ This thread contains basic methods of every Applet used to load necessary config
 
 ## All methods and properties
 
-::: table-responsive
+
 | Methods/Property  | Description | Supported since |
 | ----------------- | ----------- | :---------------: |
 | `onReady()`         | This method will wait until sOS object library and all dependencies are ready to be used. | 1.0.0 |
@@ -26,8 +26,7 @@ This thread contains basic methods of every Applet used to load necessary config
 | `appletVersion`  | Returns current Applet version | JS API `4.5.0`, Front-display `7.8.0`|
 | `config` object  | Returns object with key-values set via Timing or as a bundled config| JS API `1.5.0`, Front-display `6.8.0`|
 | `config` object  | Returns object with key-values set via Timing or as a bundled config| `1.0.0`|
-| `capabilities`  | Enum of device-specific capabilities and features | `1.0.0`|
-:::
+| `capabilities`  | Enum of device-specific capabilities and features | `1.0.0`
 
 ## Starting Applet
 
@@ -77,7 +76,7 @@ console.log(sos.config);
 ## onReady()
 This method will wait until sOS object library and all dependencies are ready to be used.
 
-::: alert alert--danger
+:::danger
 Every Applet must contain this method, otherwise it won't work.
 :::
 
@@ -102,21 +101,9 @@ window.addEventListener('sos.loaded',() => {
 });
 ```
 
-<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" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/restore">
-            <div>
-                <div class="wide-box__image d-flex align-items-center">
-                    <i class="fab fa-github svg-black"></i>
-                </div>
-            <div>
-                <h3 class="wide-box__title wide-box__title__small pl-85">Example of Applet for basic start</h3>
-                <div class="wide-box__description">Working example on our Github</div>
-            </div>
-            </div>
-        </a>
-    </div>
-</div>
+:::note[GitHub Example]
+[Example of Applet for basic start](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/restore)
+:::
 
 ## restore()
 The typical case of usage for digital signage is playing a loop with some specified duration. This method should be called always when the loop is changed. It will clear all previously played videos, streams, clear display views, and notify for garbage collection.  
@@ -145,21 +132,9 @@ window.addEventListener('sos.loaded', () => {
 });
 ```
 
-<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" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/restore">
-            <div>
-                <div class="wide-box__image d-flex align-items-center">
-                    <i class="fab fa-github svg-black"></i>
-                </div>
-            <div>
-                <h3 class="wide-box__title wide-box__title__small pl-85">Example of Applet with restore() method</h3>
-                <div class="wide-box__description">Working example on our Github</div>
-            </div>
-            </div>
-        </a>
-    </div>
-</div>
+:::note[GitHub Example]
+[Example of Applet with restore() method](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/restore)
+:::
 
 ## refresh()
 AFter calling this method applet is freshly launched.
@@ -199,22 +174,12 @@ You can pass CUSTOM key-value variables to the Applet. To do that, add your valu
 console.log(sos.config.mySecretID);
 console.log(sos.config.imgUrl);
 ```
-<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" target="_blank" 
-        href="https://docs.signageos.io/hc/en-us/articles/4405238989458">
-            <div>
-                <div class="wide-box__image d-flex align-items-center">
-                    <i class="fas fa-hand-point-right svg-black"></i>
-                </div>
-            <div>
-                <h3 class="wide-box__title wide-box__title__small pl-85">Custom variables in Applet</h3>
-                <div class="wide-box__description">How to pass custom variables and cofiguration to your Applet</div>
-            </div>
-            </div>
-        </a>
-    </div>
-</div>
+
+:::note[Guide]
+[Custom variables in Applet](https://docs.signageos.io/hc/en-us/articles/4405238989458)
+
+How to pass custom variables and cofiguration to your Applet
+:::
 
 ## Applet JS API version
 
@@ -232,14 +197,13 @@ There are two kinds of capabilities - display and management.
 
 Display capabilities refer to the capabilities of the display in terms of content, playback, peripherals, etc.
 
-::: table-responsive
+
 | Capability                     | Description                                                                               |
 | ------------------------------ | ----------------------------------------------------------------------------------------- |
-| `FILE_SYSTEM_EXTERNAL_STORAGE` | Device file system supports [external storage](/api/js/content/js-file-system) (i.e. flash drives)                          |
-| `FILE_SYSTEM_FILE_CHECKSUM`    | Device is can [calculate a file checksum](/api/js/content/js-file-system#getfilechecksum) |
-| `VIDEO_4K`                     | Device is capable of [playing 4K video](/api/js/content/js-video)                                                     |
-| `SERIAL`                       | Device supports communication with peripherals over [serial](/api/js/content/js-hardware-serial)                                |
-:::
+| `FILE_SYSTEM_EXTERNAL_STORAGE` | Device file system supports [external storage](content/js-file-system) (i.e. flash drives)                          |
+| `FILE_SYSTEM_FILE_CHECKSUM`    | Device is can [calculate a file checksum](content/js-file-system#getfilechecksum) |
+| `VIDEO_4K`                     | Device is capable of [playing 4K video](content/js-video)                                                     |
+| `SERIAL`                       | Device supports communication with peripherals over [serial](content/js-serial)                                
 
 #### Javascript example:
 
@@ -249,41 +213,28 @@ if (await sos.display.supports('VIDEO_4K')) {
 }
 ```
 
-<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" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/capabilities-content">
-            <div>
-                <div class="wide-box__image d-flex align-items-center">
-                    <i class="fab fa-github svg-black"></i>
-                </div>
-            <div>
-                <h3 class="wide-box__title wide-box__title__small pl-85">Example of Content Capabilities</h3>
-                <div class="wide-box__description">Working example on our Github</div>
-            </div>
-            </div>
-        </a>
-    </div>
-</div>
+:::note[GitHub Example]
+[Example of Content Capabilities](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/capabilities-content)
+:::
 
 
 ### Management capabilities
 
 Management capabilities refer to the capabilities of the display's internal state management.
 
-::: table-responsive
+
 | Capability                     | Description                                                                               |
 | ------------------------------ | ----------------------------------------------------------------------------------------- |
-| `BATTERY_STATUS` | Device can [report its battery status](/api/js/management/1-js-management#getbatterystatus). |
-| `WIFI` | Device can [connect to a Wi-Fi](/api/js/management/13-js-management-wifi#connect). |
-| `WIFI_SCAN` | Device can [scan surrounding Wi-Fi devices](/api/js/management/13-js-management-wifi#scandevices). |
-| `WIFI_AP` | Device is capable of [becoming a Wi-Fi endpoint](/api/js/management/13-js-management-wifi#enableap) that other devices can connect to. |
-| `SET_BRIGHTNESS` | Device can change its [screen brightness](/api/js/management/5-js-management-screen#setbrightness). |
-| `SET_TIME` | Device can change its [time settings](/api/js/management/6-js-management-time). |
-| `NTP_TIME` | Device can [synchronize its time with an NTP server](/api/js/management/6-js-management-time#setntp). |
-| `PACKAGE_INSTALL` | It's possible to [install additional packages](/api/js/management/8-js-management-package) on the device, managed by signageOS application. |
-| `SET_VOLUME` | Device can change its [audio volume](/api/js/management/7-js-management-volume). |
-| `SET_REMOTE_CONTROL_ENABLED` | Device can [disable control via IR remote](/api/js/management/3-js-management-remote-control) to increase security. |
-:::
+| `BATTERY_STATUS` | Device can [report its battery status](management/js-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. |
+| `SET_BRIGHTNESS` | Device can change its [screen brightness](management/js-management-screen#setbrightness). |
+| `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_REMOTE_CONTROL_ENABLED` | Device can [disable control via IR remote](management/js-management-remote-control) to increase security. 
 
 ```javascript
 if (await sos.management.supports('WIFI')) {
@@ -291,18 +242,6 @@ if (await sos.management.supports('WIFI')) {
 }
 ```
 
-<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" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/capabilities-management">
-            <div>
-                <div class="wide-box__image d-flex align-items-center">
-                    <i class="fab fa-github svg-black"></i>
-                </div>
-            <div>
-                <h3 class="wide-box__title wide-box__title__small pl-85">Example of Management Capabilities</h3>
-                <div class="wide-box__description">Working example on our Github</div>
-            </div>
-            </div>
-        </a>
-    </div>
-</div>
+:::note[GitHub Example]
+[Example of Management Capabilities](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/capabilities-management)
+:::

package/docs/index.md

@@ -0,0 +1,97 @@
+---
+title:  JS SDK Home
+author: Josef Kral
+date:   4.2.2018
+type:   rest-api
+tags:
+- rest_api
+- js_api
+- api
+description: "[Content JS API] General introduction to signageOS JS API"
+---
+# Javascript SDK for Applet development
+
+Javascript SDK gives you access to device's native features and functionalities. You can use the same functions across all devices with the same result.
+
+:::tip
+All APIs are standardized and available across all [supported devices](https://docs.signageos.io/hc/en-us/sections/4405700629266-Supported-Devices).
+:::
+
+:::info[Start here]
+[Basic information about Applets](/sdk/applet-basics)
+
+General information required to use the signageOS JS API
+:::
+
+## Content-related JS APIs
+
+Content-related APIs help you with content part of your application /Applet/. 
+
+Universal APIs for File system, access to accelerated video playback, sensor management and more provide you with robust tool set for creating extensive experiences.
+
+| Domain | Description |
+| ------ | ----------- |
+| [Applet Resources](content/js-applet-resources) | Pre-load necessary files required by your HTML5 player/Applet |
+| [Browser](content/js-browser) | Opening managed web-browser on Android devices inc. whitelisting, blacklisting and other features |
+| [Command](content/js-command) | Sending business or technical logs through signageOS in secured offline-ready way |
+| [Debug](content/js-debug) | Start debug session |
+| [Device Info](content/js-device-info) | Device-related informations  |
+| [Display](content/js-display) | Query features supported by the display |
+| [File system](content/js-file-system) | Full-featured file system API including ZIP and folder management |
+| [Fonts](content/js-loading-fonts) | Make it easy to load additional fonts into SoC devices |
+| [Hardware](content/js-hardware) | Hardware-specific APIs like LED lights on Philips 10BDL |
+| [Inputs](content/js-input) | Controller inputs like IR remote unified under one API |
+| [iFrames](content/js-iframes) | Using JS SDK in iFrames |
+| [Proof of Play](content/js-proof-of-play) | Proof of Play API |
+| [Sensors](content/js-sensors) | Using sensors and IoT devices in your application  |
+| [Serial Port](content/js-hardware-serial) | Control external devices via serial |
+| [Synchronized playback](content/js-sync-playback) | API for creating synced playback and videowalls  |
+| [Video Inputs aka PiP](content/js-video-inputs-internal-ports) | Show HDMI/DP/VGA as a part of your content via PiP feature |
+| [Video Playback](content/js-video) | Playing accelerated gapless videos via native video player |
+| [Video Streams](content/js-video-stream) | Playing video streams (RTSP, HLS, UDP) via native video player  
+
+## Device control JS APIs
+
+Device control features exposed via Javascript APIs.
+
+:::tip
+For **Device Management** we strongly recommend using REST APIs. [See the REST API documentation here](https://api.docs.signageos.io).
+:::
+
+
+| Domain | Description |
+| ------ | ----------- |
+| [Application](management/js-management-application) | Get application version and upgrade application from remote location |
+| [Audio](management/js-management-audio) | Control system volume level |
+| [Debug](management/js-management-debug) | Enable/disable debug mode |
+| [Firmware](management/js-management-firmware) | Get FW version and upgrade FW from remote location |
+| [Management](management/js-management-management) | Information about the device and power action like Reboot, Restart,.. |
+| [Monitors](management/js-management-monitors) | Information about monitors |
+| [Network](management/js-management-network) | Manage network settings |
+| [OS](management/js-management-os) | Get system information like CPU and Memory usage |
+| [Package](management/js-management-package) | Install and manage packages |
+| [Power](management/js-management-power) | Manage display power - timers, restart and reboot |
+| [Proxy](management/js-management-proxy) | Manage display network proxy setup |
+| [IR Remote Control](management/js-management-remote-control) | Manage IR Remote control functionality |
+| [Screen](management/js-management-screen) | Manage brightness, orientation and resolution, display on/off |
+| [Security](management/js-management-security) | Control system security (PIN code) |
+| [Time](management/js-management-time) | Set time, timezone and get current settings |
+| [Wi-Fi](management/js-management-wifi) | Manage Wi-Fi 
+
+# Testing Framework SDK
+
+Write and then run **automated tests** for your applet on physical devices, streamlining your development and QA efforts.
+
+See full [documentation on GitHub](https://github.com/signageos/test-framework)
+
+# Node.JS SDK
+
+Library which allows you to fully manage signageOS applets, devices, management & monitoring using Node.JS and REST API.
+
+See full [documentation on GitHub](https://github.com/signageos/sdk)
+
+# REST API
+
+Large collection of REST API endpoints for device management and monitoring.
+
+See full [documentation on Postman](https://api.docs.signageos.io)

package/docs/js-api/js-applet-resources.md

@@ -16,20 +16,16 @@ description: "[Content JS API] Often there are some JavaScripts and CSS styles n
 Often there are some JavaScripts and CSS styles necessary to be loaded for your Applet. 
 It can be libraries like jQuery or even your whole application code. For these necessities offline API for saving, storing & loading files are ready.
 
-
-## All methods
-::: table-responsive
 | Methods | Description | Supported since |
-| ------- | ----------- | ------ | :---------------: |
+| ------- | ----------- | ------ |
 | `addFile()` | Add single file to Applet before starting it. | 1.0.0 |
 | `addFiles()` | Add files to Applet before starting it. | 1.0.0 |
-| `addFilesSync()` | Add files to Applet before starting it in the set order to prevent race condition. | 1.0.0 |
-:::
+| `addFilesSync()` | Add files to Applet before starting it in the set order to prevent race condition. | 1.0.0 
 
 ### File object
 Every method above, accept single object or array of objects depending by type. Every object **must have** these keys.
 
-::: table-responsive
+
 | Key | Type | Required | Description |
 | :-----: | :-----: | :----: | ------- |
 | `uri` | String | <div class="red">Yes</div> | URL of file |
@@ -37,10 +33,9 @@ Every method above, accept single object or array of objects depending by type.
 | `type` | String | <div class="red">Yes</div> | Type of file. Example: `sos.offline.types.javascript`, `sos.offline.types.css`, `sos.offline.types.video` |
 |||| ^^ |
 | `flags` | Array | <div class="red">Yes</div> | Special flag for file |
-| `headers` | Array | <div class="yellow">No</div> |  Authorization headers |
-:::
+| `headers` | Array | <div class="yellow">No</div> |  Authorization headers 
 
-::: alert alert--info
+:::info
 * The file URL must point to a file. If your URI leads to a 303 redirect (e.g. from http to http**s**), the API will not work.
 * There are some limitations for [Emulator](https://docs.signageos.io/hc/en-us/articles/4405238997138). 
 :::
@@ -84,21 +79,9 @@ const files = [ // Array of files
 await sos.offline.addFiles(files);
 ```
 
-<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" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/offline-resources">
-            <div>
-                <div class="wide-box__image d-flex align-items-center">
-                    <i class="fab fa-github svg-black"></i>
-                </div>
-            <div>
-                <h3 class="wide-box__title wide-box__title__small pl-85">Example of Applet that save files and load them in one file</h3>
-                <div class="wide-box__description">Working example on our Github</div>
-            </div>
-            </div>
-        </a>
-    </div>
-</div>
+:::note[GitHub Example]
+[Example of Applet that save files and load them in one file](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/offline-resources)
+:::
 
 ## addFilesSync()
 Method `addFilesSync()` works same as method above, but all files are loaded in correct order. Otherwise, files are loaded in random order by file size.
@@ -156,7 +139,7 @@ interface IFlag {
 ## Errors
 Although we are doing our best, following errors may occur when working with the Applet Resources.
 
-::: table-responsive
+
 | Code | Type | Message |
 | ---- | ---- | ------- |
 | 40101 | AppletResourcesError | File needs to be object |
@@ -168,5 +151,4 @@ Although we are doing our best, following errors may occur when working with the
 | 40106 | AppletResourcesError | Already existing file: `FILE_NAME` |
 |^^|^^| File is already loaded or exists in Applet |
 | 49901 | FileNotFoundError    | File `FILE_ID` was not found |
-|^^|^^| Applet can not get file. URL is invalid. |
-:::
+|^^|^^| Applet can not get file. URL is invalid. 

package/docs/js-api/js-browser.md

@@ -18,16 +18,15 @@ 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
-::: table-responsive
+
 | 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()
 
-::: alert alert--info
+:::info
 **This API is currently available on:**  
 - Android devices with Android 5+ (Philips, Benq, Sharp, generic Android device)
 
@@ -42,11 +41,11 @@ Simple opening some page ex. our main company page.
 ```javascript
 sos.browser.open('https://www.signageos.io'); // Open link in the browser
 ```
-<br>
+<br/>
 
 Method `open()` also supports properties for browser. You can set height, width or CORS domains. All properties are optional.
 
-::: table-responsive
+
 | Property | Type | Description |
 | -------- | ------ | -------- |
 | `aclDomains` | Array | ? |
@@ -56,9 +55,8 @@ Method `open()` also supports properties for browser. You can set height, width
 | `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` |
-:::
+| `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` 
 
 
 ```javascript
@@ -76,26 +74,14 @@ sos.browser.open('https://www.signageos.io', {
   headlessMode: false, // supported only on Android
 ```
 
-<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" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/browser">
-            <div>
-                <div class="wide-box__image d-flex align-items-center">
-                    <i class="fab fa-github svg-black"></i>
-                </div>
-            <div>
-                <h3 class="wide-box__title wide-box__title__small pl-85">Example of Applet for using browser on Android</h3>
-                <div class="wide-box__description">Working example on our Github</div>
-            </div>
-            </div>
-        </a>
-    </div>
-</div>
+:::note[GitHub Example]
+[Example of Applet for using browser on Android](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/browser)
+:::
 
 ### Browser themes usage with Typescript
 You can also use all these methods with [signageOS TypeScript](https://docs.signageos.io/hc/en-us/articles/4405069154962#signageos-typescript).
 
-::: alert alert--info
+:::info
 Browser themes are only available on Android devices.
 :::
 
@@ -162,15 +148,14 @@ Simple opening some page ex. our main company page.
 ```javascript
 sos.browser.close(); // Close the browser
 ```
-<br>
+<br/>
 
 ## Errors
 Although we are doing our best, following errors may occur when opening a link.
 
-::: table-responsive
+
 | 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$$`