@signageos/front-applet 8.1.3 → 8.1.4

package/docs/sos/sync.md

@@ -21,9 +21,42 @@ broadcastValue({ groupName, key, value }: {
 }): Promise<void>;
 ```
 
+#### Params
+
+| Name        | Type     | Required         | Description                                                                     |
+|-------------|----------|------------------|---------------------------------------------------------------------------------|
+| `groupName` | `String` |  <div>Yes</div>  | The name of the group to broadcast the value to. Defaults to the default group. |
+| `key`       | `String` |  <div>Yes</div>  | The key to broadcast the value under.                                           |
+| `value`     | `any`    |  <div>Yes</div>  | The value to broadcast. It can be any valid type                                |
+
+#### Return value
+
+A promise that resolves when the value is broadcasted.
+
 #### Possible errors
 
-if the value can't be sent
+
+- Error If the group name is not a string.
+- Error If the key is not a string.
+- Error If the value is not a valid type (e.g. object, array, etc.).
+- Error If unable to broadcast the value.
+- Error If the value can't be sent
+
+#### Example
+
+```ts
+// broadcast a value to all devices in the group
+await sos.sync.broadcastValue({
+	groupName: 'my-group',
+	key: 'my-key',
+	value: 'my-value',
+});
+
+// Received on the other devices:
+sos.sync.onValue((key, value, groupName) => {
+	console.log(`Received value for key ${key} in group ${groupName}:`, value);
+});
+```
 
 <Separator />
 
@@ -31,20 +64,39 @@ if the value can't be sent
 
 The `cancelWait()` method aborts a wait on all devices in a group. Sometimes it's necessary to cancel a pending wait. One such
 situation would be when the group has to make a sudden change in content or another behavior but there's a risk that part of the group
-already called wait() and is waiting for the rest but the rest will never call it at this point. In order to gracefully cleanup any
+already called wait() and is waiting for the rest but the rest will never call it at this point. In order to gracefully clean up any
 pending activity, use this method.
 
+:::warning
 Any pending wait will be canceled and the promise will be rejected with an error.
+:::
 
 ```ts expandable
 cancelWait(groupName?: string): Promise<void>;
 ```
 
+#### Params
+
+| Name        | Type     | Required        | Description                                                                  |
+|-------------|----------|-----------------|------------------------------------------------------------------------------|
+| `groupName` | `string` |  <div>No</div>  | The name of the group to cancel the wait for. Defaults to the default group. |
+
+#### Return value
+
+A promise that resolves when the wait is canceled.
+
+#### Possible errors
+
+
+- Error If the group name is not a string.
+- Error If unable to cancel the wait.
+- Error If any other error occurs during canceling the wait.
+
 #### Example
 
 ```ts
 sos.sync.wait('someData', 'someRandomNameGroup').catch((err) => {
-    // this will happend once cancelWait is called
+    // this will happen once cancelWait is called
     console.error('wait failed', err);
 });
 
@@ -63,6 +115,14 @@ synchronization is not required any longer.
 close(): Promise<void>;
 ```
 
+#### Return value
+
+A promise that resolves when the connection is closed.
+
+#### Possible errors
+
+Error If unable to close the connection.
+
 <Separator />
 
 ### connect(options)
@@ -72,20 +132,27 @@ mandatory to call, since synchronization is an optional feature and doesn’t ge
 You can optionally specify a custom sync server URI in case you are running the sync server in a custom location.
 
 :::info
-
-All devices, that should be synchronized together, must select the same engine. Otherwise they won't be able to communicate with each
+All devices, that should be synchronized together, must select the same engine. Otherwise, they won't be able to communicate with each
 other.
-
 :::
 
 ```ts expandable
-connect(options?: ConnectSyncServerOptions | ConnectP2PLocalOptions | ConnectUdpOptions): Promise<void>;
+connect(options?: SynchronizationEngineOptions): Promise<void>;
 // show-more
+type SynchronizationEngineOptions = ConnectSyncServerOptions | ConnectP2PLocalOptions | ConnectUdpOptions;
+
+/**
+ * Options for sync-server synchronization.
+ */
 interface ConnectSyncServerOptions {
     engine?: SyncEngine.SyncServer;
     uri?: string;
 }
 
+/**
+ * The `SyncEngine` enum defines the available synchronization engines that can be used to synchronize devices.
+ * Each engine has its own method of connecting devices and synchronizing data.
+ */
 enum SyncEngine {
     /** Use external sync server. Device will connect to the server via websocket. */
     SyncServer = "sync-server",
@@ -98,6 +165,9 @@ enum SyncEngine {
     Udp = "udp"
 }
 
+/**
+ * Options for P2P local synchronization.
+ */
 interface ConnectP2PLocalOptions {
     engine: SyncEngine.P2PLocal;
 }
@@ -111,14 +181,22 @@ interface ConnectUdpOptions {
 
 #### Params
 
-| Name                       | Type             | Description                                                                                                    |
-|----------------------------|------------------|----------------------------------------------------------------------------------------------------------------|
-| `options.engine`           | `SyncEngine.Udp` | Synchronization engine to use.                                                                                 |
-| `options.uri` *(optional)* | `string`         | Address of the sync server engine. Only relevant for sync-server. If omitted, the default server will be used. |
+| Name             | Type                           | Required         | Description                                                                                                    |
+|------------------|--------------------------------|------------------|----------------------------------------------------------------------------------------------------------------|
+| `options.engine` | `SynchronizationEngineOptions` |  <div>Yes</div>  | Synchronization engine to use.                                                                                 |
+| `options.uri`    | `string`                       |  <div>No</div>   | Address of the sync server engine. Only relevant for sync-server. If omitted, the default server will be used. |
+
+#### Return value
+
+A promise that resolves when the connection is established.
 
 #### Possible errors
 
-if unable to connect.
+
+- Error If unable to connect.
+- Error If the `uri` is not a valid URL when using the sync-server engine.
+- Error If the `engine` is not a valid synchronization engine.
+- Error If any other error occurs during connection.
 
 #### Example
 
@@ -136,6 +214,13 @@ await sos.sync.connect({ engine: 'sync-server', uri: syncServerUri });
 await sos.sync.connect({ engine: 'p2p-local' });
 ```
 
+:::note[GitHub Example]
+
+- [ How to use synchronizer in applet](https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/sync-video)
+- [ How to synchronize mixed content](https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/sync-mixed-content)
+
+:::
+
 <Separator />
 
 ### isMaster()
@@ -148,9 +233,13 @@ isMaster(groupName?: string): Promise<boolean>;
 
 #### Params
 
-| Name                     | Type     | Description                                                               |
-|--------------------------|----------|---------------------------------------------------------------------------|
-| `groupName` *(optional)* | `string` | The group name to check for master status. Defaults to the default group. |
+| Name        | Type     | Required        | Description                                                               |
+|-------------|----------|-----------------|---------------------------------------------------------------------------|
+| `groupName` | `string` |  <div>No</div>  | The group name to check for master status. Defaults to the default group. |
+
+#### Return value
+
+A promise that resolves with true if the device is the master, false otherwise.
 
 <Separator />
 
@@ -168,11 +257,34 @@ joinGroup(options: {
 
 #### Params
 
-| Name                                        | Type     | Description                                                                                                                      |
-|---------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------|
-| `options.groupName` *(optional)*            | `string` | By default, all devices will be synced together. To create groups of devices, independent from each other,
-specify a group name. |
-| `options.deviceIdentification` *(optional)* | `string` | Identification of a device connected to `groupName` group.                                                                       |
+| Name      | Type                                                                               | Required         | Description                  |
+|-----------|------------------------------------------------------------------------------------|------------------|------------------------------|
+| `options` | `{ groupName?: string \| undefined; deviceIdentification?: string \| undefined; }` |  <div>Yes</div>  | Options for joining a group. |
+
+#### Return value
+
+A promise that resolves when the device joins the group.
+
+#### Possible errors
+
+
+- Error If the group name is not a string.
+- Error If the device identification is not a string.
+- Error If unable to join the group.
+- Error If any other error occurs during joining the group.
+
+#### Example
+
+```ts
+await sos.sync.connect();
+await sos.sync.joinGroup({ groupName: 'my-group', deviceIdentification: 'my-device-id' });
+```
+
+:::note[GitHub Example]
+
+- [ How to use synchronizer in applet](https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/sync-video)
+
+:::
 
 <Separator />
 
@@ -184,11 +296,34 @@ The `leaveMethod` method leaves a group of devices.
 leaveGroup(groupName?: string): Promise<void>;
 ```
 
+#### Params
+
+| Name        | Type     | Required        | Description                                                    |
+|-------------|----------|-----------------|----------------------------------------------------------------|
+| `groupName` | `string` |  <div>No</div>  | The name of the group to leave. Defaults to the default group. |
+
+#### Return value
+
+A promise that resolves when the device leaves the group.
+
+#### Possible errors
+
+
+- Error If the group name is not a string.
+- Error If unable to leave the group.
+- Error If any other error occurs during leaving the group.
+
+#### Example
+
+```ts
+await sos.sync.leaveGroup('my-group');
+```
+
 <Separator />
 
 ### onClosed()
 
-The `onStatus()` method sets up a listener, which is called whenever the device is disconnected from the sync. If it closed because
+The `onClosed()` method sets up a listener, which is called whenever the device is disconnected from the sync. If it closed because
 `close()` was called, it will emit without any arguments. if it closed because of an error, it will emit with an error object as the
 first argument.
 
@@ -196,6 +331,20 @@ first argument.
 onClosed(listener: (error?: Error) => void): void;
 ```
 
+#### Params
+
+| Name       | Type                                   | Required         | Description                                            |
+|------------|----------------------------------------|------------------|--------------------------------------------------------|
+| `listener` | `(error?: Error \| undefined) => void` |  <div>Yes</div>  | The listener function to call when the sync is closed. |
+
+#### Return value
+
+Returns when listener is set up.
+
+#### Possible errors
+
+Error If the listener is not a function.
+
 <Separator />
 
 ### onStatus()
@@ -216,6 +365,20 @@ interface StatusEvent {
 
 ```
 
+#### Params
+
+| Name       | Type                            | Required         | Description                                            |
+|------------|---------------------------------|------------------|--------------------------------------------------------|
+| `listener` | `(status: StatusEvent) => void` |  <div>Yes</div>  | The listener function to call when the status changes. |
+
+#### Return value
+
+Returns when listener is set up.
+
+#### Possible errors
+
+Error If the listener is not a function.
+
 <Separator />
 
 ### onValue()
@@ -226,6 +389,20 @@ The `onValue()` method sets up a listener, which is called whenever the device r
 onValue(listener: (key: string, value: any, groupName?: string) => void): void;
 ```
 
+#### Params
+
+| Name       | Type                                                                 | Required         | Description                                                |
+|------------|----------------------------------------------------------------------|------------------|------------------------------------------------------------|
+| `listener` | `(key: string, value: any, groupName?: string \| undefined) => void` |  <div>Yes</div>  | The listener function to call when a value is broadcasted. |
+
+#### Return value
+
+Returns when listener is set up.
+
+#### Possible errors
+
+Error If the listener is not a function.
+
 <Separator />
 
 ### removeEventListeners()
@@ -259,6 +436,36 @@ argument.
 wait(data?: any, groupName?: string, timeout?: number): Promise<any>;
 ```
 
+#### Params
+
+| Name        | Type     | Required        | Description                                                                   |
+|-------------|----------|-----------------|-------------------------------------------------------------------------------|
+| `data`      | `any`    |  <div>No</div>  | Optional data to pass to the group.                                           |
+| `groupName` | `string` |  <div>No</div>  | The name of the group to wait for. Defaults to the default group.             |
+| `timeout`   | `number` |  <div>No</div>  | Timeout in milliseconds. If not specified, the default timeout is 30 seconds. |
+
+#### Return value
+
+A promise that resolves with the data from the master device when all devices are ready to continue.
+
+#### Possible errors
+
+
+- Error If the group name is not a string.
+- Error If the timeout is not a number.
+- Error If unable to wait for the group.
+- Error If any other error occurs during waiting for the group.
+
+#### Example
+
+```ts
+// wait for all devices in the group to be ready
+await sos.sync.wait('someData', 'someRandomNameGroup').then((data) => {
+    // this will be called once all devices are ready
+    console.log('All devices are ready with data:', data);
+});
+```
+
 <Separator />
 
 ### ~connect(options)~

package/docs/sos/video.md

@@ -54,13 +54,13 @@ onceEnded(uri: string, x: number, y: number, width: number, height: number): Pro
 
 #### Params
 
-| Name     | Type     | Description                                    |
-|----------|----------|------------------------------------------------|
-| `uri`    | `string` | Address to remote (online) or local video file |
-| `x`      | `number` | x-position for video on screen                 |
-| `y`      | `number` | y-position for video on screen                 |
-| `width`  | `number` | Video width on screen                          |
-| `height` | `number` | Video height on screen                         |
+| Name     | Type     | Required         | Description                                    |
+|----------|----------|------------------|------------------------------------------------|
+| `uri`    | `string` |  <div>Yes</div>  | Address to remote (online) or local video file |
+| `x`      | `number` |  <div>Yes</div>  | x-position for video on screen                 |
+| `y`      | `number` |  <div>Yes</div>  | y-position for video on screen                 |
+| `width`  | `number` |  <div>Yes</div>  | Video width on screen                          |
+| `height` | `number` |  <div>Yes</div>  | Video height on screen                         |
 
 #### Return value
 
@@ -96,13 +96,13 @@ onceStop(uri: string, x: number, y: number, width: number, height: number): Prom
 
 #### Params
 
-| Name     | Type     | Description                                    |
-|----------|----------|------------------------------------------------|
-| `uri`    | `string` | Address to remote (online) or local video file |
-| `x`      | `number` | x-position for video on screen                 |
-| `y`      | `number` | y-position for video on screen                 |
-| `width`  | `number` | Video width on screen                          |
-| `height` | `number` | Video height on screen                         |
+| Name     | Type     | Required         | Description                                    |
+|----------|----------|------------------|------------------------------------------------|
+| `uri`    | `string` |  <div>Yes</div>  | Address to remote (online) or local video file |
+| `x`      | `number` |  <div>Yes</div>  | x-position for video on screen                 |
+| `y`      | `number` |  <div>Yes</div>  | y-position for video on screen                 |
+| `width`  | `number` |  <div>Yes</div>  | Video width on screen                          |
+| `height` | `number` |  <div>Yes</div>  | Video height on screen                         |
 
 #### Return value
 
@@ -169,9 +169,9 @@ interface IVideoProperties {
 
 #### Params
 
-| Name       | Type                           | Description                                                    |
-|------------|--------------------------------|----------------------------------------------------------------|
-| `listener` | `(event: IVideoEvent) => void` | The listener function to be called when an ended event occurs. |
+| Name       | Type                           | Required         | Description                                                    |
+|------------|--------------------------------|------------------|----------------------------------------------------------------|
+| `listener` | `(event: IVideoEvent) => void` |  <div>Yes</div>  | The listener function to be called when an ended event occurs. |
 
 #### Return value
 
@@ -226,9 +226,9 @@ interface IVideoProperties {
 
 #### Params
 
-| Name       | Type                           | Description                                              |
-|------------|--------------------------------|----------------------------------------------------------|
-| `listener` | `(event: IVideoEvent) => void` | The listener function to be called when an error occurs. |
+| Name       | Type                           | Required         | Description                                              |
+|------------|--------------------------------|------------------|----------------------------------------------------------|
+| `listener` | `(event: IVideoEvent) => void` |  <div>Yes</div>  | The listener function to be called when an error occurs. |
 
 #### Return value
 
@@ -283,9 +283,9 @@ interface IVideoProperties {
 
 #### Params
 
-| Name       | Type                           | Description                                                   |
-|------------|--------------------------------|---------------------------------------------------------------|
-| `listener` | `(event: IVideoEvent) => void` | The listener function to be called when a pause event occurs. |
+| Name       | Type                           | Required         | Description                                                   |
+|------------|--------------------------------|------------------|---------------------------------------------------------------|
+| `listener` | `(event: IVideoEvent) => void` |  <div>Yes</div>  | The listener function to be called when a pause event occurs. |
 
 #### Return value
 
@@ -340,9 +340,9 @@ interface IVideoProperties {
 
 #### Params
 
-| Name       | Type                           | Description                                                  |
-|------------|--------------------------------|--------------------------------------------------------------|
-| `listener` | `(event: IVideoEvent) => void` | The listener function to be called when a play event occurs. |
+| Name       | Type                           | Required         | Description                                                  |
+|------------|--------------------------------|------------------|--------------------------------------------------------------|
+| `listener` | `(event: IVideoEvent) => void` |  <div>Yes</div>  | The listener function to be called when a play event occurs. |
 
 #### Return value
 
@@ -398,9 +398,9 @@ interface IVideoProperties {
 
 #### Params
 
-| Name       | Type                           | Description                                                     |
-|------------|--------------------------------|-----------------------------------------------------------------|
-| `listener` | `(event: IVideoEvent) => void` | The listener function to be called when a prepare event occurs. |
+| Name       | Type                           | Required         | Description                                                     |
+|------------|--------------------------------|------------------|-----------------------------------------------------------------|
+| `listener` | `(event: IVideoEvent) => void` |  <div>Yes</div>  | The listener function to be called when a prepare event occurs. |
 
 #### Return value
 
@@ -455,9 +455,9 @@ interface IVideoProperties {
 
 #### Params
 
-| Name       | Type                           | Description                                                    |
-|------------|--------------------------------|----------------------------------------------------------------|
-| `listener` | `(event: IVideoEvent) => void` | The listener function to be called when a resume event occurs. |
+| Name       | Type                           | Required         | Description                                                    |
+|------------|--------------------------------|------------------|----------------------------------------------------------------|
+| `listener` | `(event: IVideoEvent) => void` |  <div>Yes</div>  | The listener function to be called when a resume event occurs. |
 
 #### Return value
 
@@ -514,9 +514,9 @@ interface IVideoProperties {
 
 #### Params
 
-| Name       | Type                           | Description                                                  |
-|------------|--------------------------------|--------------------------------------------------------------|
-| `listener` | `(event: IVideoEvent) => void` | The listener function to be called when a stop event occurs. |
+| Name       | Type                           | Required         | Description                                                  |
+|------------|--------------------------------|------------------|--------------------------------------------------------------|
+| `listener` | `(event: IVideoEvent) => void` |  <div>Yes</div>  | The listener function to be called when a stop event occurs. |
 
 #### Return value
 
@@ -546,13 +546,13 @@ pause(uri: string, x: number, y: number, width: number, height: number): Promise
 
 #### Params
 
-| Name     | Type     | Description                                    |
-|----------|----------|------------------------------------------------|
-| `uri`    | `string` | Address to remote (online) or local video file |
-| `x`      | `number` | x-position for video on screen                 |
-| `y`      | `number` | y-position for video on screen                 |
-| `width`  | `number` | Video width on screen                          |
-| `height` | `number` | Video height on screen                         |
+| Name     | Type     | Required         | Description                                    |
+|----------|----------|------------------|------------------------------------------------|
+| `uri`    | `string` |  <div>Yes</div>  | Address to remote (online) or local video file |
+| `x`      | `number` |  <div>Yes</div>  | x-position for video on screen                 |
+| `y`      | `number` |  <div>Yes</div>  | y-position for video on screen                 |
+| `width`  | `number` |  <div>Yes</div>  | Video width on screen                          |
+| `height` | `number` |  <div>Yes</div>  | Video height on screen                         |
 
 #### Return value
 
@@ -590,13 +590,13 @@ play(uri: string, x: number, y: number, width: number, height: number): Promise<
 
 #### Params
 
-| Name     | Type     | Description                                    |
-|----------|----------|------------------------------------------------|
-| `uri`    | `string` | Address to remote (online) or local video file |
-| `x`      | `number` | x-position for video on screen                 |
-| `y`      | `number` | y-position for video on screen                 |
-| `width`  | `number` | Video width on screen                          |
-| `height` | `number` | Video height on screen                         |
+| Name     | Type     | Required         | Description                                    |
+|----------|----------|------------------|------------------------------------------------|
+| `uri`    | `string` |  <div>Yes</div>  | Address to remote (online) or local video file |
+| `x`      | `number` |  <div>Yes</div>  | x-position for video on screen                 |
+| `y`      | `number` |  <div>Yes</div>  | y-position for video on screen                 |
+| `width`  | `number` |  <div>Yes</div>  | Video width on screen                          |
+| `height` | `number` |  <div>Yes</div>  | Video height on screen                         |
 
 #### Return value
 
@@ -653,16 +653,16 @@ interface IOptions {
 
 #### Params
 
-| Name                              | Type       | Description                                    |
-|-----------------------------------|------------|------------------------------------------------|
-| `uri`                             | `string`   | Address to remote (online) or local video file |
-| `x`                               | `number`   | x-position for video on screen                 |
-| `y`                               | `number`   | y-position for video on screen                 |
-| `width`                           | `number`   | Video width on screen                          |
-| `height`                          | `number`   | Video height on screen                         |
-| `options` *(optional)*            | `IOptions` | Optional options for preparing the video.      |
-| `options.background` *(optional)* | `boolean`  | If view should be prepared in background.      |
-| `options.volume` *(optional)*     | `number`   | Initial volume value of the video.             |
+| Name                 | Type       | Required         | Description                                    |
+|----------------------|------------|------------------|------------------------------------------------|
+| `uri`                | `string`   |  <div>Yes</div>  | Address to remote (online) or local video file |
+| `x`                  | `number`   |  <div>Yes</div>  | x-position for video on screen                 |
+| `y`                  | `number`   |  <div>Yes</div>  | y-position for video on screen                 |
+| `width`              | `number`   |  <div>Yes</div>  | Video width on screen                          |
+| `height`             | `number`   |  <div>Yes</div>  | Video height on screen                         |
+| `options`            | `IOptions` |  <div>No</div>   | Optional options for preparing the video.      |
+| `options.background` | `boolean`  |  <div>No</div>   | If view should be prepared in background.      |
+| `options.volume`     | `number`   |  <div>No</div>   | Initial volume value of the video.             |
 
 #### Return value
 
@@ -708,13 +708,13 @@ resume(uri: string, x: number, y: number, width: number, height: number): Promis
 
 #### Params
 
-| Name     | Type     | Description                                    |
-|----------|----------|------------------------------------------------|
-| `uri`    | `string` | Address to remote (online) or local video file |
-| `x`      | `number` | x-position for video on screen                 |
-| `y`      | `number` | y-position for video on screen                 |
-| `width`  | `number` | Video width on screen                          |
-| `height` | `number` | Video height on screen                         |
+| Name     | Type     | Required         | Description                                    |
+|----------|----------|------------------|------------------------------------------------|
+| `uri`    | `string` |  <div>Yes</div>  | Address to remote (online) or local video file |
+| `x`      | `number` |  <div>Yes</div>  | x-position for video on screen                 |
+| `y`      | `number` |  <div>Yes</div>  | y-position for video on screen                 |
+| `width`  | `number` |  <div>Yes</div>  | Video width on screen                          |
+| `height` | `number` |  <div>Yes</div>  | Video height on screen                         |
 
 #### Return value
 
@@ -754,13 +754,13 @@ stop(uri: string, x: number, y: number, width: number, height: number): Promise<
 
 #### Params
 
-| Name     | Type     | Description                                    |
-|----------|----------|------------------------------------------------|
-| `uri`    | `string` | Address to remote (online) or local video file |
-| `x`      | `number` | x-position for video on screen                 |
-| `y`      | `number` | y-position for video on screen                 |
-| `width`  | `number` | Video width on screen                          |
-| `height` | `number` | Video height on screen                         |
+| Name     | Type     | Required         | Description                                    |
+|----------|----------|------------------|------------------------------------------------|
+| `uri`    | `string` |  <div>Yes</div>  | Address to remote (online) or local video file |
+| `x`      | `number` |  <div>Yes</div>  | x-position for video on screen                 |
+| `y`      | `number` |  <div>Yes</div>  | y-position for video on screen                 |
+| `width`  | `number` |  <div>Yes</div>  | Video width on screen                          |
+| `height` | `number` |  <div>Yes</div>  | Video height on screen                         |
 
 #### Return value
 

package/docs/sos_management/app.md

@@ -65,9 +65,9 @@ upgrade(appUri: string): Promise<void>;
 
 #### Params
 
-| Name     | Type     | Description                                         |
-|----------|----------|-----------------------------------------------------|
-| `appUri` | `string` | FQN uri where the application main file is located. |
+| Name     | Type     | Required         | Description                                         |
+|----------|----------|------------------|-----------------------------------------------------|
+| `appUri` | `string` |  <div>Yes</div>  | FQN uri where the application main file is located. |
 
 <Separator />
 
@@ -81,10 +81,10 @@ upgrade(baseUrl: string, version: string): Promise<void>;
 
 #### Params
 
-| Name      | Type     | Description                                         |
-|-----------|----------|-----------------------------------------------------|
-| `baseUrl` | `string` | The server URL where application files are located. |
-| `version` | `string` | The version of the application being installed.     |
+| Name      | Type     | Required         | Description                                         |
+|-----------|----------|------------------|-----------------------------------------------------|
+| `baseUrl` | `string` |  <div>Yes</div>  | The server URL where application files are located. |
+| `version` | `string` |  <div>Yes</div>  | The version of the application being installed.     |
 
 <Separator />
 
@@ -100,7 +100,7 @@ upgrade(version: string, baseUrl?: string): Promise<void>;
 
 #### Params
 
-| Name                   | Type     | Description                                                                                              |
-|------------------------|----------|----------------------------------------------------------------------------------------------------------|
-| `version`              | `string` | The version of the application being installed.                                                          |
-| `baseUrl` *(optional)* | `string` | Optional server URL where application files are located.<br/>(Default value: `"https://2.signageos.io"`) |
+| Name      | Type     | Required         | Description                                                                                              |
+|-----------|----------|------------------|----------------------------------------------------------------------------------------------------------|
+| `version` | `string` |  <div>Yes</div>  | The version of the application being installed.                                                          |
+| `baseUrl` | `string` |  <div>No</div>   | Optional server URL where application files are located.<br/>(Default value: `"https://2.signageos.io"`) |