@signageos/front-applet 7.2.0 → 8.0.0

package/docs/content/js-command.md

@@ -1,154 +0,0 @@
----
-title:  Command
-author: Miroslav Behina
-date:   22.11.2018
-type:   js-api
-tags:
-- applet
-- applet_api
-- api
-- js_api
-description: "[Content JS API] In some cases, you might be interested in a complete log of what the device was doing during its operation. All of your business or technical logs can be stored in our storage for later usage. You can identify which events happened or even trigger self-repairing logic."
----
-
-# Command
-
-In some cases, you might be interested in a complete log of what the device was doing during its operation. All of your business or technical logs can be stored in our storage for later usage. You can identify which events happened or even trigger self-repairing logic.
-
-All commands will be available in [Applet Command REST API](https://developers.signageos.io/api/#tag/DeviceApplet-Command) and can be downloaded [historically as CSV export](https://developers.signageos.io/api/#tag/DeviceMonitoring/paths/~1v1~1device~1%7BdeviceUid%7D~1report/get).
-
-## All methods
-
-| Methods  | Description | Supported since |
-| ----------------- | ----------- | -----  |
-| `dispatch()`  | Dispatch method for sending logs and data from device | 1.0.3 |
-| `onCommand()`  | Event listener for incoming commands from server | 1.0.3 |
-
-## dispatch()
-
-Dispatch() is used for sending your custom logs or data from device to signageOS.
-
-:::warning[Throttling in place]
-The maximum allowed frequency for dispatching commands is 30 commands per 30 seconds. Any commands sent that exceed this frequency will be discarded.
-:::
-
-### Parameters
-
-|   Parameter    | Type | Required |  Description  |
-| -------------- | -------------| :----------------: | ------------- |
-| `type`     | String  | <div class="red">Yes</div> | Event type; can be any string **up to 100 characters**|
-| custom `parameter` | String  | No | Custom parameters and values that you need to be dispatched  
-
-### Javascript example
-```javascript
-
-/*
-Example of dispatching information about file download
-*/
-await sos.command.dispatch({
-  type: 'Files.StartLoading', // mandatory *type* with custom value
-  fileName: 'my-file', // custom parameter and value
-  fileType: 'txt' // custom parameter and value
-});
-
-/*
-Example of dispatching applet heartbeat
-*/
-await sos.command.dispatch({
-  type: 'Heartbeat' // mandatory *type* with custom value
-});
-
-/*
-Example of dispatching applet new data
-*/
-const myCMSJSON = {playlist: "myPlaylist", items: [...]};
-
-await sos.command.dispatch({
-  type: 'Content.update', // mandatory *type* with custom value
-  content: JSON.stringify(myCMSJSON) // custom parameter and value
-});
-
-
-```
-
-:::note[GitHub Example]
-[Sending commands](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/sending/)
-:::
-
-### Errors
-
-| Code | Type | Message |
-| ---- | ---- | ------- |
-| 40401 | AppletCommandTypeError | Type contains invalid characters. |
-| 40402 | AppletCommandTypeError | Type is longer then 100 characters. |
-| 40403 | AppletCommandTypeError | Command type must be a string. 
-
-
-### Usage with Typescript
-```typescript
-interface ICommand {
-  type: string;
-}
-dispatch(command: ICommand): void;
-```
-
-:::note[GitHub Example]
-[Rest API: Get Commands](https://developers.signageos.io/api/#tag/DeviceApplet-Command/paths/~1v1~1device~1%7BdeviceUid%7D~1applet~1command/get)
-
-Receiving your data dispatched from devices
-
-:::
-
-:::note[GitHub Example]
-[Rest API: Monitoring/Device Reports](https://developers.signageos.io/api/#tag/DeviceMonitoring/paths/~1v1~1device~1%7BdeviceUid%7D~1report/get)
-
-Receiving historical data
-
-:::
-
-## onCommand()
-Used for sending custom messages to online connected devices. 
-This can be done through the REST API by [POST new applet command](https://developers.signageos.io/api/#tag/DeviceApplet-Command/paths/~1v1~1device~1%7BdeviceUid%7D~1applet~1%7BappletUid%7D~1command/post). 
-The command will be dispatched to the device & the applet can set up the logic by subscribing `onCommand` method.
-
-**Parameters:**
-
-|      Param     | Type   | Required | Description  |
-| -------------- | ---------- | :-------: | ---------------------- |
-| `command`        | object      | <div class="red">Yes</div> | Any JS object with required property type. |
-| `append`         | HTMLElement  | <div class="red">Yes</div> | Type property must be string not longer then 50 characters and must contain only characters a-zA-Z0-9_- and .	
-
-### Javascript
-```javascript
-sos.command.onCommand((command) => {
-   // ... logic
-});
-```
-
-:::note[GitHub Example]
-[Receiving commands](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/receiving)
-:::
-
-### Usage with Typescript
-```typescript
-interface ICommand {
-  type: string;
-}
-onCommand(listener: (command: ICommand) => void): void;
-```
-
-:::note[GitHub Example]
-[Rest API: Monitoring](https://developers.signageos.io/api/#tag/DeviceMonitoring)
-
-Creating monitoring data
-:::
-
-## Errors
-Although we are doing our best, following errors may occur when working with the commands.
-
-
-| Code | Type | Message |
-| ---- | ---- | ------- |
-| 40401 | AppletCommandTypeError | Type contains invalid characters, allowed are `/^[a-zA-Z0-9\.\-_]+$/g`|
-| 40402 | AppletCommandTypeError | Type is longer then 100 characters. |
-| 40403 | AppletCommandTypeError | Command type must be a string. 

package/docs/content/js-debug.md

@@ -1,36 +0,0 @@
----
-title:  Debug
-author: Patrik Bily
-date:   13.3.2023
-type:   js-api
-tags:
-- applet
-- applet_api
-- api
-- js_api
-description: "[JS API] JS API debug lets you information about remote debug mode."
----
-
-# Debug
-JS API debug lets you information about remote debug mode.
-
-## All methods
-
-
-| Method  | Description | Supported since |
-| ------ | -------- | :-------------: |
-| `isRemoteDebugEnabled()` | Returns information about remote debug settings | 5.8 |
-| `onRemoteDebugChanged()` | Accept function which is called after remote debug settings is changed | 5.8 
-
-## isRemoteDebugEnabled()
-Method `isRemoteDebugEnabled()` returns the state of the [Device debug](https://docs.signageos.io/hc/en-us/articles/4416366711442-Device-debug) (**true** or **false**).
-```javascript
-await sos.debug.isRemoteDebugEnabled();
-```
-
-
-## onRemoteDebugChanged()
-Method `onRemoteDebugChanged()` accepts a function that is executed as a callback.
-```javascript
-await sos.debug.onRemoteDebugChanged((enabled) => { console.log("Weinre debug is", { enabled: true })});
-```

package/docs/content/js-device-info.md

@@ -1,56 +0,0 @@
----
-title:  Device Info
-author: Robert Pecha
-date:   13.4.2022
-type:   js-api
-tags:
-- applet
-- applet_api
-- api
-- js_api
-description: "Information set to the device using the CloudControl - e.g. Location and Tags."
----
-
-# Device Info
-Information set to the device using the CloudControl - e.g. Location and Tags.
-
-## All methods
-
-
-| Method            | Description        | Supported since   |
-| ----------------- | ------------------ | :---------------: |
-| `getLocation()` | Returns location when assigned to device  | 5.2.0 |
-| `getOrganizationTags()` | Returns list of organization tags when some assigned to device  | 5.2.0 
-| `getDeviceName()` | Returns name of device  | 6.6.0 |
-
-## getLocation()
-Location is requested from server on application start, automatically updated when changed and persists in local storage.
-
-### Javascript
-```javascript
-sos.deviceInfo.getLocation();
-```
-
-```typescript
-interface IDeviceLocation {
-	name: string;
-	customId?: string;
-	description?: string;
-}
-
-getLocation(): Promise<IDeviceLocation | null>;
-```
-
-## getOrganizationTags()
-Location is requested from server on application start, automatically updated when assigned or unassigned and persists in local storage.
-```javascript
-sos.deviceInfo.getOrganizationTags()
-```
-
-```typescript
-interface IOrganizationTag {
-	name: string;
-}
-
-getOrganizationTags(): Promise<IOrganizationTag[]>;
-```

package/docs/content/js-display.md

@@ -1,56 +0,0 @@
----
-title:  Display
-author: Michal Artazov
-date:   12.4.2021
-type:   js-api
-tags:
-- applet
-- applet_api
-- api
-- display
-- js_api
-description: "[Content JS API] Display API allows you to query the display to find out, which features it supports."
----
-
-# Display
-
-Display API allows you to query the display to find out, which features it supports.
-That way your applet can handle cases, when a certain feature isn't supported by a particular display.
-
-## All methods
-
-
-| Method             | Description            | Supported since |
-| ------------------ | ---------------------- | :-------------: |
-| `supports()` | Query, whether a certain feature is supported by the display | 3.1.0 
-
-## supports()
-
-Query the display to find out, whether a certain feature is supported.
-To let you know, when you should call this method, we will warn you throughout the content JS API documentation
-with a warning message like this one:
-
-:::warning
-* Before using this API, ensure that the display supports serial via `sos.display.supports("SERIAL")`.
-:::
-
-### 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
-const serialPort = await sos.display.supports("SERIAL");
-```