@signageos/front-applet 5.0.0-beta.9 → 5.1.0

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

@@ -1,5 +1,5 @@
 ---
-title:  Api Home
+title:  JS SDK Home
 author: Josef Kral
 date:   4.2.2018
 type:   rest-api
@@ -9,25 +9,19 @@ tags:
 - api
 description: "[Content JS API] General introduction to signageOS JS API"
 ---
-# Applet Javascript API
+# Javascript SDK for Applet development
 
-Applet JS API gives you **full control over the devices** with a standardized interface. 
-You can use the same functions across all devices with the same result. Applet JS API is available automatically within your Applet out-of-the-box.
-
-Applet JS API supports content-playback features and device management features.
-
-### About signageOS APIs
-
-In signageOS there are 2 main groups of APIs:
-- `Client-side` - JS API available for both **signageOS Open** and signageOS Platform plans
-- `Server-side` - REST API available in **signageOS Platform plan only**
+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.
 
 ::: alert alert--tip
-All APIs are standardized and available across all [supported devices](/category/supported-devices-guides).
+All APIs are standardized and available across all [supported devices](https://docs.signageos.io/hc/en-us/sections/4405700629266-Supported-Devices).
 :::
 
-## Content-playback APIs
-Content-playback API is an API for managing content on screen. 
+## 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.
 
 ::: table-responsive
 | Domain | Description |
@@ -38,21 +32,25 @@ Content-playback API is an API for managing content on screen.
 | [Browser](/api/js/content/js-browser) | Opening managed web-browser on Android devices inc. whitelisting, blacklisting and other features |
 | [Command](/api/js/content/js-command) | Sending business or technical logs through signageOS in secured offline-ready way |
 | [File system](/api/js/content/js-file-system) | Full-featured file system API including ZIP and folder management |
+| [Fonts](/api/js/content/js-loading-fonts) | Make it easy to load additional fonts into SoC devices |
 | [Hardware](/api/js/content/js-hardware) | Hardware-specific APIs like LED lights on Philips 10BDL |
-| [Serial](/api/js/content/js-hardware-serial) | Control external devices via serial |
 | [Inputs](/api/js/content/js-input) | Controller inputs like IR remote unified under one API |
-| [Fonts](/api/js/content/js-loading-fonts) | Make it easy to load additional fonts into SoC devices |
+| [Monitors](/api/js/content/js-monitors) | Information about monitors |
+| [Sensors](/api/js/content/js-sensors) | Using sensors and IoT devices in your application  |
+| [Serial](/api/js/content/js-hardware-serial) | Control external devices via serial |
 | [Synchronized playback](/api/js/content/js-sync-playback) | API for creating synced playback and videowalls  |
-| [Timings](/api/js/content/js-timing) | Managing Timing/Applet switching from JS  |
 | [Video Inputs aka PiP](/api/js/content/js-video-inputs-internal-ports) | Show HDMI/DP/VGA as a part of your content via PiP feature |
 | [Video Playback](/api/js/content/js-video) | Playing accelerated gapless videos via native video player |
 | [Video Streams](/api/js/content/js-video-stream) | Playing video streams (RTSP, HLS, UDP) via native video player  |
-| [Sensors](/api/js/content/js-sensors) | Using sensors and IoT devices in your application  |
-| [Monitors](/api/js/content/js-monitors) | Information about monitors |
 :::
 
-## Device management APIs
-Device management API is for managing, updating firmware, and other settings on the device.
+## Device control JS APIs
+
+Device control features exposed via Javascript APIs.
+
+::: alert alert--tip
+For **Device Management** we strongly recommend using REST APIs. [See the REST API documentation here](https://api.docs.signageos.io).
+:::
 
 ::: table-responsive
 | Domain | Description |
@@ -71,3 +69,15 @@ Device management API is for managing, updating firmware, and other settings on
 | [Security](/api/js/management/12-js-management-security) | Control system security (PIN code) |
 | [Wi-Fi](/api/js/management/13-js-management-wifi) | Manage Wi-Fi |
 :::
+
+# 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-basics.md

@@ -16,12 +16,16 @@ description: "[Content JS API] This thread contains basic methods of every Apple
 This thread contains basic methods of every Applet used to load necessary configuration or device identifications and how to create Applet.
 
 ## 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 |
 | `restore()`         | Clear all previously played videos, streams, clear display view. | 1.0.0 |
 | `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`|
 :::
 
 ## Starting Applet
@@ -188,7 +192,8 @@ 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="/knowledge-base/applet-custom-config-on-device">
+        <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>

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

@@ -42,7 +42,7 @@ Every method above, accept single object or array of objects depending by type.
 
 ::: alert alert--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](knowledge-base/box-emulator-limitations). 
+* There are some limitations for [Emulator](https://docs.signageos.io/hc/en-us/articles/4405238997138). 
 :::
 
 ## addFile()
@@ -128,7 +128,7 @@ sos.offline.addFilesSync(files).then(() => {
 ```
 
 ## Usage with Typescript
-You can also use all these methods with [signageOS TypeScript](/knowledge-base/dev-tools-cli-typescript).
+You can also use all these methods with [signageOS TypeScript](https://docs.signageos.io/hc/en-us/articles/4405069154962#signageos-typescript).
 
 ```typescript
 interface ISaveFile {

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

@@ -21,7 +21,6 @@ Default URL can be opened and even the whitelisting/blacklisting of certain doma
 ::: table-responsive
 | Methods  | Description | Supported since |
 | ----------------- | ----------- | -----  | :---------------: |
-| `openLink()`        |   **Deprecated:** Use `open()` instead.          |    1.0.19       |
 | `open()`        | Open page in integrated browser |      4.0.0    |
 | `close()`        | Open page in integrated browser |      4.4.0    |
 :::
@@ -33,9 +32,9 @@ Default URL can be opened and even the whitelisting/blacklisting of certain doma
 - Android devices with Android 5+ (Philips, Benq, Sharp, generic Android device)
 
 **With some limitation you can use this API also on**  
-- Samsung Tizen (SSSP 4 and above); where the website is just in fullscreen without any addressbar or theme options
-- LG webOS (webOS 3.0 and above); where the website is just in fullscreen without any addressbar or theme options
-- Raspberry Pi and NEC Compute Module;  where the website is just in fullscreen without any addressbar or theme options
+- 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)
 :::
 
 ### Javascript
@@ -56,6 +55,9 @@ Method `open()` also supports properties for browser. You can set height, width
 | `coordinates` | Object | Size of browser screen (only Raspberry Pi) |
 | `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` |
 :::
 
 
@@ -64,13 +66,14 @@ sos.browser.open('https://www.signageos.io', {
   aclDomains: ['google.com', 'yahoo.com'],
   aclMode: 'blacklist', // or 'whitelist'
   readOnlyAddressBar: true,
-  coordinates: { // Supported only on Raspberry Pi
+  coordinates: { // Supported only on Raspberry Pi and Android
     x: 0,
     y: 0,
     height: 500,
     width: 500,
   },
   // theme: { ... } // supported only on Android
+  headlessMode: false, // supported only on Android
 ```
 
 <div class="row d-flex align-content-stretch force-padding-20">
@@ -90,7 +93,7 @@ sos.browser.open('https://www.signageos.io', {
 </div>
 
 ### Browser themes usage with Typescript
-You can also use all these methods with [signageOS TypeScript](/knowledge-base/dev-tools-cli-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
 Browser themes are only available on Android devices.
@@ -141,7 +144,10 @@ interface IOpenLinkOptions {
 		width: number;
 		height: number;
 	};
-	theme?: ITheme; // supported since 5.0.0
+	theme?: ITheme;
+	headlessMode?: boolean;
+	clearData?: boolean;
+	canUserClose?: boolean;
 }
 
 open(uri: string, options?: IOpenLinkOptions): void;

package/docs/js-api/js-file-system.md

@@ -69,10 +69,12 @@ File System directory structure is **PERSISTENT** and is **NOT** automatically d
 | `isDirectory()` | Returns true if existing path is directory | 2.1.0 |
 | `copyFile()` | Copy file or directory to a new location | 3.3.0 |
 | `writeFile()` | Write string to a file | 3.2.0 |
+| `appendFile()` | Write string to a file | 4.13.0 |
 | `readFile()` | Read a text file | 3.3.0 |
 :::
 
 ## listStorageUnits()
+
 Return list of storage units /internal, external/ from the device. Capacity values are in bytes.
 
 ::: alert alert--info
@@ -85,6 +87,7 @@ This is a mandatory method that is required for all the other File System APIs.
 
 
 ### Javascript Example
+
 ```javascript
 // Storage units are equivalent to disk volumes (C:, D: etc on Windows; /mnt/disc1, /mnt/disc2 on Unix)
 const storageUnits = await sos.fileSystem.listStorageUnits();
@@ -94,6 +97,7 @@ const internalStorageUnit = storageUnits.find((storageUnit) => !storageUnit.remo
 
 console.log(storageUnits);
 ```
+
 ### Returns
 
 ```json
@@ -115,14 +119,15 @@ console.log(storageUnits);
 ]
 ```
 
-
 ## listFiles()
+
 List files and folders located in the internal/external storage.
 * SUCCESS: Return list of files of existing directory
 * FAIL: When listing not existing directory
 * FAIL: When listing existing file (not a directory)
 
 ### Javascript Example
+
 ```javascript
 // Storage units are equivalent to disk volumes (C:, D: etc on Windows; /mnt/disc1, /mnt/disc2 on Unix)
 const storageUnits = await sos.fileSystem.listStorageUnits();
@@ -203,16 +208,19 @@ console.log(testDirDirectoryFilePaths);
 ```
 
 ## getFile()
+
 Return a file from an internal storage
 * OK: Returns local uri of existing file
 * OK: Returns NULL of not existing file
 
 ### Parameters
+
 | Param | Type | Required | Description |
 | -------------- | ------ | :-------: | ----- |
 | `filePath`    | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 // always pass storageUnit to tell the JS API where to look
 // get properties of file (at least localUri) or null when not exist
@@ -243,6 +251,7 @@ Return statement is a dynamic object! It has to be always generated and retrieve
 ```
 
 ## exists()
+
 * OK: Returns true of existing directory or file
 * OK: Returns false of not existing directory nor file
 
@@ -253,6 +262,7 @@ Return statement is a dynamic object! It has to be always generated and retrieve
 | `filePath` | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 // always pass storageUnit to tell the JS API where to look
 // check if there is such a file
@@ -262,9 +272,11 @@ console.log(fileExists);
 ```
 
 ### Returns
+
 Boolean value
 
 ## downloadFile()
+
 Download file to path within existing directory or **overrides existing file** in a path when successfully downloaded
 
 * OK: Download file to path within existing directory
@@ -285,6 +297,7 @@ Download file to path within existing directory or **overrides existing file** i
 :::
 
 ### Javascript Example
+
 ```javascript
 // You can download file to specific existing directory
 await sos.fileSystem.downloadFile(
@@ -294,7 +307,39 @@ await sos.fileSystem.downloadFile(
 );
 ```
 
+#### Encoding
+
+All downloads respect a standard of `Encoding` with optional compression of files. See [Mozilla standard Accept Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding) and [Content Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding).
+
+Download file method is always sending optional following headers:
+```
+Accept-Encoding: gzip
+Accept-Encoding: compress
+Accept-Encoding: deflate
+Accept-Encoding: br
+Accept-Encoding: identity
+Accept-Encoding: *
+```
+
+If the server understands the `Encoding` standard, it compresses files using `gzip` algorithm before the files are sent to the client. If so, the response will contain the following headers:
+```
+Content-Encoding: gzip
+Content-Encoding: compress
+Content-Encoding: deflate
+Content-Encoding: br
+```
+So the data communication is compressed under the hood. The client will automatically decompress data before it's saved to a specified location path. So from JS API point of view, there is no requirement to decompress data by itself.
+
+The standard is supported on all following platforms:
+
+- WebOS 3+
+- Tizen 2.4+
+- Brightsign
+- Raspberry Pi
+- Windows
+
 ## deleteFile()
+
 Delete a file or directory from the path.
 
 * OK: (not recursive) Deletes an existing file or existing empty directory
@@ -310,6 +355,7 @@ Delete a file or directory from the path.
 | `recursive`| boolean  | <div class="yellow">No</div> | `TRUE` for recursive delete of all content from a directory			|
 
 ### Javascript Example
+
 ```javascript
 // Delete directory and all files inside
 //// First check, if there is such a directory
@@ -327,7 +373,9 @@ if (await sos.fileSystem.exists({ storageUnit: internalStorageUnit, filePath: 't
 ```
 
 ## moveFile()
+
 Move file OR directory to destination path or Move directory to destination path.
+
 * OK: Move file to destination path
 * OK: Move directory to destination path
 * FAIL: When destination path exists (is file or directory)
@@ -341,6 +389,7 @@ Move file OR directory to destination path or Move directory to destination path
 | `filePath` | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 // Move file to a different directory
 //// First check, if there is such a file and directory
@@ -356,13 +405,14 @@ if (await sos.fileSystem.exists({ storageUnit: internalStorageUnit, filePath: 't
 ```
 
 ## getFileChecksum()
+
 Returns checksum of existing file in a path.
 * OK: Returns checksum of existing file in path
 * FAIL: When file path doesn't exist
 * FAIL: When file path is directory
 
 ::: alert alert--info
-Does not work on Samsung Tizen display - [read more here](knowledge-base/md5-tizen-not-available)
+Does not work on Samsung Tizen display - [read more here](https://docs.signageos.io/hc/en-us/articles/4416327809810)
 :::
 
 ### Parameters
@@ -373,17 +423,20 @@ Does not work on Samsung Tizen display - [read more here](knowledge-base/md5-tiz
 | `hashFunction`   | string | <div class="red">Yes</div> | Available function is `md5` |
 
 ### Javascript Example
+
 ```javascript
 const md5Checksum = await sos.fileSystem.getFileChecksum({ storageUnit: internalStorageUnit, filePath: 'test-dir/log.1.txt.backup' }, 'md5');
 console.log(md5Checksum);
 ```
 
 ### Returns
+
 ```json
 "b3c6930b9306b8e35a978d342cf5a01e" // string
 ```
 
 ## extractFile()
+
 Extract ZIPed all files (recursively) to destination path and override existing files or merge existing directories.
 
 * OK: Extract ZIPed all files (recursively) to destination path
@@ -405,6 +458,7 @@ The directory/folder you are extracting your ZIP file into has to be created BEF
 | `archiveMethod` | string | <div class="red">Yes</div> | Available method is `zip` |
 
 ### Javascript Example
+
 ```javascript
 // Create directory 'test-dir' in a root directory
 await sos.fileSystem.createDirectory({ storageUnit: internalStorageUnit, filePath: 'test-dir' });
@@ -418,6 +472,7 @@ await sos.fileSystem.extractFile(
 ```
 
 ## createDirectory()
+
 Creates a directory in a path.
 
 * OK: Creates directory in path
@@ -436,6 +491,7 @@ Creates a directory in a path.
 | `filePath` | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 // Create directory 'test-dir' in a root directory
 await sos.fileSystem.createDirectory({ storageUnit: internalStorageUnit, filePath: 'test-dir' });
@@ -458,6 +514,7 @@ await Promise.all(myDirs.map(async (dirname) => {
 ```
 
 ## isDirectory()
+
 Returns true if existing path is directory.
 
 * OK: Returns true if existing path is directory
@@ -471,11 +528,13 @@ Returns true if existing path is directory.
 | `filePath` | FilePath  | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 await sos.fileSystem.isDirectory({ storageUnit: internalStorageUnit, filePath: 'test-dir' });
 ```
 
 ## copyFile()
+
 Copy file OR directory to a new location.
 
 ### Parameters
@@ -486,6 +545,7 @@ Copy file OR directory to a new location.
 | `destinationFilePath` | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 await sos.fileSystem.copyFile(
    { storageUnit: internalStorageUnit, filePath: 'test-dir/log.1.txt' },
@@ -494,16 +554,13 @@ await sos.fileSystem.copyFile(
 ```
 
 ## writeFile()
+
 Write into file directly:
+
 - string support only
 - override only
 - no append
 
-::: alert alert--warning
-**LG webOS limitation**:  
-It's possible to handle only files up to **~10KB** on webOS devices. At the moment we are working on the solution regarding the file/s 'manipulation' on LG devices.
-:::
-
 ### Parameters
 
 | Param | Type | Required | Description |
@@ -513,6 +570,7 @@ It's possible to handle only files up to **~10KB** on webOS devices. At the mome
 
 
 ### Javascript Example
+
 ```javascript
 await sos.fileSystem.writeFile(
    { storageUnit: internalStorageUnit, filePath: 'test-dir/log.txt' },
@@ -520,6 +578,30 @@ await sos.fileSystem.writeFile(
 );
 ```
 
+## appendFile()
+
+Append content into file directly:
+
+- string support only
+- append only
+
+### Parameters
+
+| Param | Type | Required | Description |
+| ------ | -------- | :------: | ---- |
+| `filePath` | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
+| `content` | String | <div class="red">Yes</div> | Parsed content as string |
+
+
+### Javascript Example
+
+```javascript
+await sos.fileSystem.appendFile(
+   { storageUnit: internalStorageUnit, filePath: 'test-dir/log.txt' },
+   'My awesome log line\n',
+);
+```
+
 ## readFile()
 Read a text file.
 

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

@@ -53,7 +53,7 @@ await sos.input.onKeyUp((keyUpEvent) => {
 | ARROW_DOWN | 14 | | |
 
 ## Usage with Typescript
-You can also use all these methods with [signageOS TypeScript](/knowledge-base/dev-tools-cli-typescript).
+You can also use all these methods with [signageOS TypeScript](https://docs.signageos.io/hc/en-us/articles/4405069154962#signageos-typescript).
 
 ```typescript
 interface IKeyUpEvent {

package/docs/js-api/js-loading-fonts.md

@@ -102,7 +102,7 @@ await sos.offline.addFont({
 </div>
 
 ## Usage with Typescript
-You can also use all these methods with [signageOS TypeScript](/knowledge-base/dev-tools-cli-typescript).
+You can also use all these methods with [signageOS TypeScript](https://docs.signageos.io/hc/en-us/articles/4405069154962#signageos-typescript).
 
 ```typescript
 addFont(

package/docs/js-api/js-monitoring-commands.md

@@ -69,7 +69,7 @@ export interface ConsoleLogged {
 }
 ```
 
-To trigger some monitoring commands to be dispatched from a device. This REST API can be used to send monitoring [commands to the device](https://docs.signageos.io/api/device-monitoring-api/#Send_Device_Applet_Command_to_device). Following commands can be used:
+To trigger some monitoring commands to be dispatched from a device. This REST API can be used to send monitoring [commands to the device](https://sdk.docs.signageos.io/api/device-monitoring-api/#Send_Device_Applet_Command_to_device). Following commands can be used:
 
 ### Typescript
 ```typescript

package/docs/js-api/js-offline-cache-media-files.md

@@ -30,7 +30,7 @@ File API allows files (video files, media files etc.) to be stored for offline u
 :::
 
 ::: alert alert--warning
-Emulator has certain limitations while handling offline files. [Read more here](/knowledge-base/box-emulator-limitations)
+Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138)
 :::
 
 ## listFiles() 
@@ -66,10 +66,14 @@ Method `saveFile()` is used to save files from remote a destination into the dev
 `headers` has to be a JSON object. If you are passing the value, make sure you use `JSON.parse()`.
 :::
 
+::: alert alert--warning
+`uid` should have the same file extension (e.g.: mp4, svg, jpg) as the original file.
+:::
+
 ### Javascript example
 ```javascript
 // Example saving files into internal memory, unique id could be salted md5 hash, uri directs to our CDN
-await sos.offline.cache.saveFile('9d66725ba2105f1833731ade5b7f334e', 'https://cdn.my-cms.com/files/video.mp4', { "Authorization": "Basic Zm9vOmJhcg==" })
+await sos.offline.cache.saveFile('9d66725ba2105f1833731ade5b7f334e.mp4', 'https://cdn.my-cms.com/files/video.mp4', { "Authorization": "Basic Zm9vOmJhcg==" })
 .then(() => { console.log('Saved'); })
 .catch((error) => { console.error(error); });
 ```
@@ -87,15 +91,19 @@ Method `loadFile()` is used for individual file retrieval from internal memory.
 | --------- | ------------ | :---------: | --------------- |
 | `uid` | string | <div class="red">Yes</div> | Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 and . characters |
 
+::: alert alert--warning
+`uid` should have the same file extension (e.g.: mp4, svg, jpg) as the original file.
+:::
+
 ### Javascript Example
 ```javascript
-await sos.offline.cache.loadFile('9d66725ba2105f1833731ade5b7f334e')
+await sos.offline.cache.loadFile('9d66725ba2105f1833731ade5b7f334e.mp4')
 .then((file) => { console.log('Loaded', file); })
 .catch((error) => { console.error(error); });
  
 // Logs into console
 {
-  filePath: '/real/device/path/to/file/9d66725ba2105f1833731ade5b7f334e',
+  filePath: '/real/device/path/to/file/9d66725ba2105f1833731ade5b7f334e.mp4',
 }
 ```
 
@@ -113,7 +121,7 @@ To get file from internal memory & save it when not yet exists we prepared `load
 
 ::: alert alert--info
 * The file URI has to return the file. If your URI leads to a 303 redirect (e.g. from http to http**s**), the API will not work.
-* Emulator has certain limitations while handling offline files. [Read more here](knowledge-base/box-emulator-limitations) 
+* Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138) 
 :::
 
 ### Parameters
@@ -124,15 +132,19 @@ To get file from internal memory & save it when not yet exists we prepared `load
 | `uri`             | string         | <div class="red">Yes</div> | URL address where to get the file             |
 | `headers`        | object         | <div class="yellow">No</div> | Key, value pairs of HTTP headers to send along with the request. Used when the target file is protected by a password or if any other specific headers are needed to access it.                                   			|
 
+::: alert alert--warning
+`uid` should have the same file extension (e.g.: mp4, svg, jpg) as the original file.
+:::
+
 ### Javascript Example
 ```javascript
-await sos.offline.cache.loadOrSaveFile('9d66725ba2105f1833731ade5b7f334e', 'https://cdn.my-cms.com/files/video.mp4', { "Authorization": "Basic Zm9vOmJhcg==" })
+await sos.offline.cache.loadOrSaveFile('9d66725ba2105f1833731ade5b7f334e.mp4', 'https://cdn.my-cms.com/files/video.mp4', { "Authorization": "Basic Zm9vOmJhcg==" })
 .then((file) => { console.log('Loaded or Saved', file); })
 .catch((error) => { console.error(error); });
  
 // Logs into console
 {
-  filePath: '/real/device/path/to/file/9d66725ba2105f1833731ade5b7f334e',
+  filePath: '/real/device/path/to/file/9d66725ba2105f1833731ade5b7f334e.mp4',
 }
 ```
 
@@ -187,7 +199,7 @@ Method `deleteFile()` is used for deleting previously saved file from internal m
 
 ### Javascript example
 ```javascript
-await sos.offline.cache.deleteFile('9d66725ba2105f1833731ade5b7f334e')
+await sos.offline.cache.deleteFile('9d66725ba2105f1833731ade5b7f334e.mp4')
 .then(() => { console.log('Deleted'); })
 .catch((error) => { console.error(error); });
 ```
@@ -203,7 +215,7 @@ Method `getChecksumFile()` is used for getting the checksum of file from interna
 
 ### Javascript example
 ```javascript
-await sos.offline.cache.getChecksumFile('9d66725ba2105f1833731ade5b7f334e', 'md5')
+await sos.offline.cache.getChecksumFile('9d66725ba2105f1833731ade5b7f334e.mp4', 'md5')
 .then((checksum) => { console.log('MD5 checksum is ' + checksum); })
 .catch((error) => { console.error(error); });
 ```
@@ -282,7 +294,7 @@ await sos.offline.cache.decompressFile(zipUid, destinationDirectoryUid, 'zip')
 
 * [Managing files](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/file-system)
 * [Sample applet from Box](https://github.com/signageos/applet-examples/blob/master/index.html)
-* All other examples are available in Knowledge Base under [Applet Examples](/knowledge-base/applet-examples)
+* All other examples are available in Knowledge Base under [Applet Examples](https://github.com/signageos/applet-examples/)
 
 ## Errors
 Although we are doing our best, following errors may occur when working with the offline cache.

package/docs/js-api/js-offline-cache-simple-data.md

@@ -28,7 +28,7 @@ We do not recommend using a different storage type then Offline Cache or full fe
 :::
 
 ::: alert alert--warning
-Emulator has certain limitations while handling offline files. [Read more here](/knowledge-base/box-emulator-limitations)
+Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138)
 :::
 
 ## loadContent()
@@ -108,7 +108,7 @@ sos.offline.cache.saveContent('ApplicationSecret', '123SuperSecretHash')
 ```
 
 ## Usage with Typescript
-You can also use all these methods with [signageOS TypeScript](/knowledge-base/dev-tools-cli-typescript).
+You can also use all these methods with [signageOS TypeScript](https://docs.signageos.io/hc/en-us/articles/4405069154962#signageos-typescript).
 
 ```typescript
 loadContent(uid: string): Promise<string>;