@signageos/front-applet 5.0.1 → 5.1.0

package/CHANGELOG.md

@@ -4,6 +4,13 @@ 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).
 
+## [5.1.0] - 2022-01-27
+### Added
+- Update firmware guide with new methods
+
+### Fixed
+- fix backlinks from old to new Docs
+
 ## [5.0.1] - 2022-01-25
 ### Fixed
 - adjusted documentation to better reflect naming of JS SDK
@@ -142,7 +149,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - File System API supports copyFile, writeFile, readFile
 - File System moveFile supports optional overwrite destination
-- New Management JS API (https://docs.signageos.io/api/js/management/1-js-management)
+- New Management JS API (https://sdk.docs.signageos.io/api/js/management/1-js-management)
 - Video API supports video playing in the background with HTML content in the foreground
 - Video API supports 4K video
 - getTimers and unsetTimer of management power API
@@ -195,7 +202,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [2.1.0] - 2018-12-04
 ### Added
-- New API for decompress (extract) ZIP (or other formats) files: https://docs.signageos.io/api/sos-applet-api/#Decompress_file_ZIP
+- New API for decompress (extract) ZIP (or other formats) files: https://sdk.docs.signageos.io/api/sos-applet-api/#Decompress_file_ZIP
 
 ### Fixed
 - import lib in typescript using `import * as sos from '@signageos/front-applet';`
@@ -203,13 +210,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [2.0.0] - 2018-09-17
 ### Added
-- List offline files/contents (https://docs.signageos.io/api/sos-applet-api/#List_all_files)
-- Delete offline files/contents (https://docs.signageos.io/api/sos-applet-api/#Delete_file)
+- List offline files/contents (https://sdk.docs.signageos.io/api/sos-applet-api/#List_all_files)
+- Delete offline files/contents (https://sdk.docs.signageos.io/api/sos-applet-api/#Delete_file)
 - Allow use any npm module file imported as ES6 module (ex.: `import Video from '@signageos/front-applet/dist/FrontApplet/Video/Video'`)
-- Binding of dispatched commands to REST API (https://docs.signageos.io/api/sos-applet-api/#Command_Receiving)
-- New monitoring applet commands dispatching about `timing loaded`, `html snapshot`, `console logs`, `offline cache changes`, `video state changes` when monitoring is enabled by timing configuration `sos.config.sosMonitoring = true` or by dispatching command to device `sos.Monitoring.EnableMonitoring` (https://docs.signageos.io/api/sos-applet-api/#Monitoring_Commands)
-- Methods for getting file checksum MD5: https://docs.signageos.io/api/sos-applet-api/#Checksum_file_md5
-- Font face generator (https://docs.signageos.io/api/sos-applet-api/#Loading_fonts)
+- Binding of dispatched commands to REST API (https://sdk.docs.signageos.io/api/sos-applet-api/#Command_Receiving)
+- New monitoring applet commands dispatching about `timing loaded`, `html snapshot`, `console logs`, `offline cache changes`, `video state changes` when monitoring is enabled by timing configuration `sos.config.sosMonitoring = true` or by dispatching command to device `sos.Monitoring.EnableMonitoring` (https://sdk.docs.signageos.io/api/sos-applet-api/#Monitoring_Commands)
+- Methods for getting file checksum MD5: https://sdk.docs.signageos.io/api/sos-applet-api/#Checksum_file_md5
+- Font face generator (https://sdk.docs.signageos.io/api/sos-applet-api/#Loading_fonts)
 
 ### Fixed
 - Applet Commands type can has length 100 characters now
@@ -228,9 +235,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [1.3.0] - 2018-05-30
 ### Added
-- Remote control Key UP binding (https://docs.signageos.io/api/sos-applet-api/#input)
+- Remote control Key UP binding (https://sdk.docs.signageos.io/api/sos-applet-api/#input)
 
 ## [1.2.0] - 2018-05-09
 ### Added
 - Changelog file containing all changes in current project
-- @signageos/front-applet library is also published to public npm registry registry.npmjs.org https://docs.signageos.io/api/sos-applet-api/
+- @signageos/front-applet library is also published to public npm registry registry.npmjs.org https://sdk.docs.signageos.io/api/sos-applet-api/

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

@@ -14,7 +14,7 @@ description: "[Content JS API] General introduction to signageOS JS API"
 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](https://signageos.zendesk.com/hc/en-us/sections/4405700629266-Supported-Devices).
+All APIs are standardized and available across all [supported devices](https://docs.signageos.io/hc/en-us/sections/4405700629266-Supported-Devices).
 :::
 
 ## Content-related JS APIs

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

@@ -192,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

@@ -93,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.

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

@@ -412,7 +412,7 @@ Returns checksum of existing file in a path.
 * 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

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() 
@@ -121,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
@@ -294,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>;

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

@@ -56,7 +56,7 @@ interface IRfidAntenna {
 ## Ready to use integrations
 
 We already did the hard work for you and implemented some of the popular hardware. All you have to do is use it in your project.
-For more information read [this article](/knowledge-base/sensors-supported-sensors).
+For more information read [this article](https://docs.signageos.io/hc/en-us/articles/4405231196946-Supported-devices-for-Sensors-usage).
 
 ## Writing your own implementation
 

package/docs/js-api/js-sync-playback.md

@@ -166,7 +166,7 @@ Since you never know which device is the master at the moment, you should always
 :::
 
 ## 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
 connect(syncServerUri?: string): Promise<void>;

package/docs/js-api/js-video-inputs-internal-ports.md

@@ -103,7 +103,7 @@ API reacts to events related to changes in internal port status. Events are only
 :::
 
 ## 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
 onDisconnected(listener: (event: {
 	type: 'disconnected';

package/docs/js-api/js-video-stream.md

@@ -27,7 +27,7 @@ Methods to play or stop video streams.
 :::
 
 ::: alert alert--warning
-Are you using **Samsung Tizen** to play streams? [Read more about limitation and Tizen-specific details](knowledge-base/stream-playback-on-tizen).
+Are you using **Samsung Tizen** to play streams? [Read more about limitation and Tizen-specific details](https://docs.signageos.io/hc/en-us/articles/4405387373458).
 :::
 
 ## prepare()
@@ -185,7 +185,7 @@ Example event:
 ```
 
 ## 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 StreamEvent {
     type: 'connected' | 'disconnected' | 'error',

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

@@ -222,7 +222,7 @@ await sos.video.onError((event) => { console.log(event); });
 ```
 
 ## 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
 play(

package/docs/management-api/10-js-management-application.md

@@ -55,7 +55,7 @@ await sos.management.app.getVersion(); // Returns ex. 2.0.0
 ```
 
 ## upgrade()
-Method `upgrade()` will upgrade the [Core App](knowledge-base/application-version-and-release-policy) on the device.
+Method `upgrade()` will upgrade the [Core App](https://docs.signageos.io/hc/en-us/articles/4405381466898) on the device.
 
 
 ### A) Upgrading signageOS Core App
@@ -92,7 +92,7 @@ await sos.management.app.upgrade('https://example.com/signageos-core-app.zip', '
 <br>
 
 ### B) Upgrading Open Core App with built-in Applet
-If you are [building your own Core App](/knowledge-base/open-standalone-signageos-provisioning) with the built-in Applet, use only one parameter `absolutePathUrl`.
+If you are [building your own Core App](https://docs.signageos.io/hc/en-us/articles/4405245195666) with the built-in Applet, use only one parameter `absolutePathUrl`.
 
 The `absolutePathUrl` should point to the application file, e.g. `https://cdn.your-cms.com/rpi/linux_202006100815_1.0.1_779c303408.zip`.
 

package/docs/management-api/2-js-management-firmware.md

@@ -31,21 +31,35 @@ Method `upgrade()` will upgrade current firmware version to a specified one.
 | -------------- | ----------------------| :-------: | -------------------- |
 | `baseUrl`     | string                 | <div class="red">Yes</div> | Location of the FW package for specific device |
 |^^|^^|^^| `https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem` |
-| `version`     | string                 | <div class="red">Yes</div> | FW version |
+| `version`     | string                 | <div class="yellow">No</div> | FW version |
 |^^|^^|^^| `T-HKMLAKUC-2080.4` |
+| `(progress: number)` | callback | <div class="yellow">No</div> | FW progress upgrade |
 :::
 
 ### Javascript example
 ```javascript
 await sos.management.firmware.upgrade(
-	'`https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem`',
-	'`T-HKMLAKUC-2080.4`',
+	'https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem',
+	'T-HKMLAKUC-2080.4',
 	(progress: number) => {
 	    console.log(progress + "%");
     }
 );
+
+await sos.management.firmware.upgrade('https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem');
 ```
 
+::: alert alert--warning
+Always check if your absolute firmware URL ends with firmware file.
+Example: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw`
+:::
+
+::: alert alert--info
+For BrightSign firmware upgrade please ensure that you have txt file with SHA1 hash of that firmware file.
+- Firmware file path: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw`
+- SHA1 txt file: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw.sha1.txt`
+:::
+
 <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/firmware/">

package/docs/management-api/5-js-management-screen.md

@@ -54,7 +54,7 @@ Method `resize()` helps you manipulate with several aspects of your displays scr
 :::
 
 ::: alert alert--info
-For Tizen, you have to provide `baseUrl` which points to your server where you uploaded previously built Core App for Tizen with your buiult-in Applet. [Read more how to upload your Core Apps here.](https://docs.signageos.io/knowledge-base/open-standalone-signageos-provisioning#tizen-specific-installation-url).
+For Tizen, you have to provide `baseUrl` which points to your server where you uploaded previously built Core App for Tizen with your buiult-in Applet. [Read more how to upload your Core Apps here.](https://docs.signageos.io/hc/en-us/articles/4405245195666).
 :::
 
 ### Javascript example

package/docs/management-api/6-js-management-time.md

@@ -177,6 +177,6 @@ Setting NTP server and timezone has side effects:
 
 | Platform    | Side effect                                  |
 | ----------- | -------------------------------------------- |
-| Tizen       | After calling this API, display **Reboots**!<br/><br/> Tizen has [**limited set of available timezones**. Read more here.](knowledge-base/debugging-guides-tizen-timezones) |
+| Tizen       | After calling this API, display **Reboots**!<br/><br/> Tizen has [**limited set of available timezones**. Read more here.](https://docs.signageos.io/hc/en-us/articles/4405381271314) |
 | RaspberryPi | After calling this API, RPi **Reboots backend server which can take up to 60 seconds**!<br /> During the reboot no JS API is available.<br />Always wait for Promise resolution. |
 :::

package/docs/management-api/9-js-management-debug.md

@@ -24,7 +24,7 @@ Management API debug lets you enable and disable debug mode.
 :::
 
 ## enable()
-Method `enable()` enable the [Native debug](knowledge-base/using-weinre-for-debuging) on the device.
+Method `enable()` enable the [Native debug](https://docs.signageos.io/hc/en-us/articles/4405238849938) on the device.
 
 ```javascript
 await sos.management.debug.enable();
@@ -47,7 +47,7 @@ await sos.management.debug.enable();
 </div>
 
 ## disable()
-Method `disable()` disable the [Native debug](knowledge-base/using-weinre-for-debuging) on the device.
+Method `disable()` disable the [Native debug](https://docs.signageos.io/hc/en-us/articles/4405238849938) on the device.
 
 ```javascript
 await sos.management.debug.disable();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signageos/front-applet",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "main": "dist/bundle.js",
   "types": "es6/bundle.d.ts",
   "files": [