@signageos/front-applet 8.1.1 → 8.1.3

package/docs/sos/index.md

@@ -4,11 +4,22 @@ sidebar_position: 0
 
 # sos
 
-<Admonition type="info" icon="" title="">
-  Learn more about using this API [here](https://developers.signageos.io/docs/applets/getting-started/#using-the-sos-sdk)
-</Admonition>
+The `sos` API groups together all functionality the \@signageos/front-applet offers. This is a basic object that provides you with access to
+all the applet functionality, such as device information, display control, video playback, and more.
 
-The `sos` API groups together all functionality the \@signageos/front-applet offers.
+:::warning
+All calls to the sos object need to happen after `sos.onReady()` is resolved. After the sOS object is ready, there are global properties available, which can be used for applet customization and device identification.
+:::
+
+```ts
+// Simple example of using the sos API to play a video.
+import sos from '@signageos/front-applet';
+
+sos.onReady().then(async function () {
+  startYourApplet(); // Example method to run
+  // Any other code
+}
+```
 
 ## Properties
 
@@ -23,7 +34,7 @@ readonly appletVersion: string;
 ### authHash
 
 <Admonition type="info" icon="" title="">
-  Learn more about using this API [here](https://developers.signageos.io/docs/applets/api-guides/device-identification)
+  Learn more about using this API [here](https://developers.signageos.io/docs/sos-guides/device-identification)
 </Admonition>
 
 The `authHash` property is an alternative device identifier, which is designed for secure pairing and locating devices through
@@ -39,11 +50,7 @@ readonly authHash: string;
 
 ### config
 
-<Admonition type="info" icon="" title="">
-  Learn more about using this API [here](https://developers.signageos.io/docs/applets/configuration/)
-</Admonition>
-
-The `config` property is a Key-value dictionary of the applet configuration.
+The `config` property is a Key-value dictionary of the applet configuration. It is assigned on the device with timing via Box or SDK/Rest API.
 
 ```ts expandable
 readonly config: Record<string, number | string | boolean>;
@@ -60,6 +67,16 @@ which is resolved at the same time as the listener.
 onReady(listener?: () => void): Promise<void>;
 ```
 
+#### Params
+
+| Name                    | Type         | Description                                                  |
+|-------------------------|--------------|--------------------------------------------------------------|
+| `listener` *(optional)* | `() => void` | Optional listener which is called when the sos API is ready. |
+
+#### Return value
+
+Promise which is resolved when the sos API is ready.
+
 #### Example
 
 ```ts
@@ -76,12 +93,16 @@ sos.onReady(async function () {
 
 ### refresh()
 
-The `refresh()` method initializes refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
+The `refresh()` method initializes the refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
 
 ```ts expandable
 refresh(): Promise<void>;
 ```
 
+#### Return value
+
+Promise that is resolved when the refresh is completed.
+
 #### Example
 
 ```ts
@@ -106,5 +127,8 @@ restore(): void;
 #### Example
 
 ```ts
-sos.restore();
+sos.onReady(async function () {
+  // Some function which is called when the applet is ready
+  sos.restore();
+});
 ```

package/docs/sos/input.md

@@ -4,25 +4,39 @@ sidebar_position: 0
 
 # input
 
+The `sos.input` API groups together all input-related functionality, such as remote control key events. With this API, you can
+listen to key events from the remote control and handle them in your application.
+
 ## Methods
 
 ### onKeyUp()
 
-The `onKeyUp` method sets up a listeners, which is called on every key stroke of the remote controller. For the specific logic of an
+The `onKeyUp` method sets up a listeners, which is called on every keystroke of the remote controller. For the specific logic of an
 application (games for example), binding the remote control inputs can be helpful. Only a subset of all remote control keys is
 supported on the specific device. Only numerical digits are guaranteed to be supported.
 
+:::note
 This feature must be tested by users on real devices.
+:::
 
 ```ts expandable
 onKeyUp(listener: (event: IKeyUpEvent) => void): void;
 // show-more
+/**
+ * KeyUp event interface for handling key release events.
+ */
 interface IKeyUpEvent {
     type: 'keyup';
     keyCode: KeyUpEventMap;
     keyName: keyof typeof KeyUpEventMap;
 }
 
+/**
+ * Enum of supported key codes for KeyUp events.
+ *
+ * @remarks
+ * If a key is not listed here, it will show warning in the console.
+ */
 enum KeyUpEventMap {
     UNKNOWN = 0,
     NUM_0 = 1,
@@ -56,6 +70,22 @@ enum KeyUpEventMap {
 
 ```
 
+#### Params
+
+| Name       | Type                           | Description                                                      |
+|------------|--------------------------------|------------------------------------------------------------------|
+| `listener` | `(event: IKeyUpEvent) => void` | The listener function that will be called on every key up event. |
+
+#### Return value
+
+Resolves when the listener is successfully set up.
+
+#### Possible errors
+
+
+- If listener is not valid function.
+- If listener is unregistered.
+
 <Separator />
 
 ### removeEventListener()
@@ -66,6 +96,17 @@ The `removeEventListener()` method removes all event listeners for a specific ev
 removeEventListener(event: 'keyup', listener: (...args: any[]) => void): void;
 ```
 
+#### Params
+
+| Name       | Type                       | Description                                                                             |
+|------------|----------------------------|-----------------------------------------------------------------------------------------|
+| `event`    | `"keyup"`                  | The name of the event to remove the listener for. Currently, only `keyup` is supported. |
+| `listener` | `(...args: any[]) => void` | The listener function to remove.                                                        |
+
+#### Return value
+
+Resolves when the listener is successfully removed.
+
 <Separator />
 
 ### removeEventListeners()

package/docs/sos/native/mdc.md

@@ -7,15 +7,11 @@ sidebar_position: 0
 The `sos.native.mdc` API groups together methods for controlling Tizen devices using MDC commands.
 
 :::warning
-
 This API is currently available on Tizen devices only.
-
 :::
 
 :::info
-
 You can ensure that the device supports MDC commands via `sos.management.supports("NATIVE_COMMANDS_MDC")`.
-
 :::
 
 ## Methods
@@ -27,6 +23,26 @@ The `sendOne()` method sends an MDC command to another Tizen device on the same
 ```ts expandable
 sendOne(ipAddress: IpAddressType, command: CodesMDC, data?: number[]): Promise<IMDCResponse>;
 // show-more
+/**
+ * Response object returned by Tizen Core App.
+ */
+interface IMDCResponse {
+    /**
+     * The type of the response, either 'ACK' for acknowledgment or 'NACK' for negative acknowledgment.
+     */
+    type: 'ACK' | 'NACK';
+    /**
+     * The command type that was executed, represented as a number.
+     * Should match the command number in {@link CodesMDC}.
+     */
+    commandType: number;
+    /**
+     * The result of the command execution, represented as a number.
+     * This value can vary depending on the command executed.
+     */
+    result: number;
+}
+
 /**
  * This enum contains valid command codes for Tizen MDC communication.
  */
@@ -177,12 +193,6 @@ enum CodesMDC {
     REPLY = 255
 }
 
-interface IMDCResponse {
-    type: 'ACK' | 'NACK';
-    commandType: number;
-    result: number;
-}
-
 ```
 
 #### Params
@@ -190,18 +200,29 @@ interface IMDCResponse {
 | Name                | Type       | Description                                          |
 |---------------------|------------|------------------------------------------------------|
 | `ipAddress`         | `string`   | The IP address of the device to send the command to. |
-| `command`           | `CodesMDC` | The MDC command to send.                             |
+| `command`           | `CodesMDC` | The MDC command to send                              |
 | `data` *(optional)* | `number[]` | The optional data to send with the command.          |
 
+#### Return value
+
+MDC response object containing the result of the command execution.
+
+#### Possible errors
+
+
+- If the `ipAddress` is not a valid string or if the `command` is not a valid number.
+- If the `data` is not an array of numbers.
+- If any error occurs during the command execution.
+
 #### Example
 
 ```ts
-await sos.native.mdc.sendOne('localhost', CodesMDC.BRIGHTNESS_CONTROL); // Promise<IMDCResponse>
-await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.VOLUME_CONTROL, [50]); // Promise<IMDCResponse>
-await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.PICTURE_CONTROL, [0x54, 0x03]); // Promise<IMDCResponse>
+await sos.native.mdc.sendOne('localhost', CodesMDC.BRIGHTNESS_CONTROL);
+await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.VOLUME_CONTROL, [50]);
+await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.PICTURE_CONTROL, [0x54, 0x03]);
 
 // You can also send custom number if we don't have predefined command in our enum
-await sos.native.mdc.sendOne('192.168.0.10', 0x01, []); // Promise<IMDCResponse>
+await sos.native.mdc.sendOne('192.168.0.10', 0x01, []);
 ```
 
 <Separator />
@@ -215,9 +236,23 @@ but without explicitly specifying the command.
 sendOneRaw(ipAddress: IpAddressType, data: number[] | [
 ]): Promise<IMDCResponse>;
 // show-more
+/**
+ * Response object returned by Tizen Core App.
+ */
 interface IMDCResponse {
+    /**
+     * The type of the response, either 'ACK' for acknowledgment or 'NACK' for negative acknowledgment.
+     */
     type: 'ACK' | 'NACK';
+    /**
+     * The command type that was executed, represented as a number.
+     * Should match the command number in {@link CodesMDC}.
+     */
     commandType: number;
+    /**
+     * The result of the command execution, represented as a number.
+     * This value can vary depending on the command executed.
+     */
     result: number;
 }
 
@@ -225,10 +260,21 @@ interface IMDCResponse {
 
 #### Params
 
-| Name        | Type             | Description                                          |
-|-------------|------------------|------------------------------------------------------|
-| `ipAddress` | `string`         | The IP address of the device to send the command to. |
-| `data`      | `number[] \| []` | The data to send with the command.                   |
+| Name        | Type             | Description                                                                        |
+|-------------|------------------|------------------------------------------------------------------------------------|
+| `ipAddress` | `string`         | The IP address of the device to send the command to.                               |
+| `data`      | `number[] \| []` | The data as array of numbers to send with the command. It can be also empty array. |
+
+#### Return value
+
+MDC response object containing the result of the command execution.
+
+#### Possible errors
+
+
+- If the `ipAddress` is not a valid string or if the `command` is not a valid number.
+- If the `data` is not an array of numbers.
+- If any error occurs during the command execution.
 
 #### Example
 

package/docs/sos/offline/cache.md

@@ -28,7 +28,7 @@ decompressFile(uid: string, destinationUid: string, method: 'zip'): Promise<void
 
 #### Possible errors
 
-The method throws an error if the uid does not exist.
+If the uid does not exist.
 
 <Separator />
 
@@ -56,7 +56,7 @@ deleteFile(uid: string): Promise<void>;
 
 #### Possible errors
 
-The method throws an error if the uid does not exist.
+If the uid does not exist.
 
 <Separator />
 
@@ -67,7 +67,10 @@ The `getChecksumFile()` computes a checksum of the file specified by `uid`.
 ```ts expandable
 getChecksumFile(uid: string, hashType: HashAlgorithm): Promise<string>;
 // show-more
-type HashAlgorithm = 'md5' | 'sha1' | 'sha256' | 'sha384' | 'sha512' | 'crc32' | AnyString;
+/**
+ * Represents the supported hash algorithms by Core Apps.
+ */
+type HashAlgorithm = 'md5' | 'crc32' | AnyString;
 
 type AnyString = string & {};
 
@@ -75,7 +78,7 @@ type AnyString = string & {};
 
 #### Possible errors
 
-The method throws an error if the uid does not exist or the hashing algorithm is not supported.
+If the uid does not exist or the hashing algorithm is not supported.
 
 <Separator />
 
@@ -132,7 +135,7 @@ interface IFile {
 
 #### Possible errors
 
-The method throws an error if the uid does not exists
+If the uid does not exists
 
 <Separator />
 
@@ -185,7 +188,7 @@ saveFile(uid: string, uri: string, headers?: {
 
 #### Possible errors
 
-The method throws an error if the network request fails or a file with the same uid is already cached
+If the network request fails or a file with the same uid is already cached
 
 <Separator />
 
@@ -196,7 +199,10 @@ The `validateChecksumFile()` method validates whether the file, specified by `ui
 ```ts expandable
 validateChecksumFile(uid: string, hash: string, hashType: HashAlgorithm): Promise<boolean>;
 // show-more
-type HashAlgorithm = 'md5' | 'sha1' | 'sha256' | 'sha384' | 'sha512' | 'crc32' | AnyString;
+/**
+ * Represents the supported hash algorithms by Core Apps.
+ */
+type HashAlgorithm = 'md5' | 'crc32' | AnyString;
 
 type AnyString = string & {};
 
@@ -204,4 +210,4 @@ type AnyString = string & {};
 
 #### Possible errors
 
-The method throws an error if the uid does not exist or the hashing algorithm is not supported.
+If the uid does not exist or the hashing algorithm is not supported.