@signageos/front-applet 8.3.0 → 8.5.0

package/docs/index.md

@@ -21,7 +21,7 @@ sos.onReady(async () => {
 ## Getting started
 This section refers to the JS SDK API reference and provides detailed information for every function, including rich examples.
 
-To develop an applet using the Applet JS SDK, you need to install our [CLI](https://developers.signageos.io/docs/cli-setup) and follow our guide [Getting started with Applets](https://developers-staging.signageos.io/docs/applets/getting-started/).
+To develop an applet using the Applet JS SDK, you need to install our [CLI](https://developers.signageos.io/docs/cli-setup) and follow our guide [Getting started with Applets](https://developers.signageos.io/docs/applets/getting-started/).
 
 ## API Reference
 The JS API reference is divided into two main sections:

package/docs/sos/command.md

@@ -123,7 +123,7 @@ Resolves when the listener is successfully set up.
 import { sos } from '@signageos/front-applet';
 
 void sos.onReady(async () => {
-	/* Example of dispatching information about file download */
+	/** 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

package/docs/sos/deviceInfo.md

@@ -35,9 +35,43 @@ console.log(`Device name is: ${deviceName}`);
 
 <Separator />
 
+### getDeviceTags()
+
+The `getDeviceTags()` method returns all organization tags assigned to the device including parent tags, if available.
+Tags are requested from server on application start, automatically updated when changed and persisted in local storage.
+
+:::note
+Tags can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceTag-(Device-Tags)).
+:::
+
+```ts expandable
+getDeviceTags(): Promise<IDeviceTag[]>;
+// show-more
+/**
+ * Represents a device tag which may have a parent (organization) tag.
+ */
+interface IDeviceTag extends ITag {
+    parentTag?: ITag;
+}
+
+/**
+ * Represents organization tags assigned to a device.
+ */
+interface ITag {
+    name: string;
+}
+
+```
+
+#### Return value
+
+A promise that returns the device tags.
+
+<Separator />
+
 ### getLocation()
 
-The `getLocation()` method returns location of the device. Location is requested from server on application start, automatically
+The `getLocation()` method returns location of the device with child tags if available. Location is requested from server on application start, automatically
 updated when changed and persisted in local storage.
 
 :::note
@@ -47,10 +81,25 @@ Location can be set only in CloudControl on Device Info page, or via [Rest API](
 ```ts expandable
 getLocation(): Promise<IDeviceLocation | null>;
 // show-more
+/**
+ * Represents device location information set via Rest API.
+ */
 interface IDeviceLocation {
+    /** Name of the location. */
     name: string;
+    /** Optional custom identifier for the location. */
     customId?: string;
+    /** Optional description of the location. */
     description?: string;
+    /** Optional child array of tags associated with the location. */
+    tags?: ITag[];
+}
+
+/**
+ * Represents organization tags assigned to a device.
+ */
+interface ITag {
+    name: string;
 }
 
 ```
@@ -61,28 +110,24 @@ A promise that resolves to the device location or `null` if not set.
 
 <Separator />
 
-### getOrganizationTags()
+### ~getOrganizationTags()~
 
-The `getOrganizationTags()` method returns all tags assigned to the device. Tags are requested from server on application start, automatically
-updated when changed and persisted in local storage.
+:::danger Deprecated
+
+This method was deprecated. Please use `getDeviceTags()` method instead.
 
-:::note
-Tags can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceTag-(Device-Tags)).
 :::
 
 ```ts expandable
 getOrganizationTags(): Promise<IOrganizationTag[]>;
 // show-more
+/** @deprecated */
 interface IOrganizationTag {
     name: string;
 }
 
 ```
 
-#### Return value
-
-A promise that resolves to an array of organization tags.
-
 ## API Example
 
 ```ts
@@ -95,15 +140,16 @@ void sos.onReady(async () => {
 
 const printLocation = async () => {
 	const { name, customId, description } = (await sos.deviceInfo.getLocation()) ?? {};
-
 	console.log('Location: ', { name, customId, description });
 };
 
 const printTags = async () => {
-	const tags = await sos.deviceInfo.getOrganizationTags();
-
-	for (const { name } of tags) {
+	const tags = await sos.deviceInfo.getDeviceTags();
+	for (const { name, parentTag } of tags) {
 		console.log('Tag: ', name);
+		if (parentTag) {
+			console.log(' Parent Tag: ', parentTag.name);
+		}
 	}
 };
 

package/docs/sos/display.md

@@ -9,6 +9,38 @@ features it supports.
 
 ## Methods
 
+### getCapabilities()
+
+The `getCapabilities()` method returns a list of all supported front capabilities of the device.
+
+For more information what are capabilities, see the description of the `supports()` method.
+
+```ts expandable
+getCapabilities(): Promise<DisplayCapability[]>;
+// show-more
+/**
+ * Represents the capabilities that a display can support.
+ * These capabilities are used to determine if a specific feature is available on the display.
+ */
+type DisplayCapability = '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' | 'BROWSER' | 'PROXIMITY_SENSOR' | AnyString;
+
+type AnyString = string & {};
+
+```
+
+#### Return value
+
+Resolves to an array of supported capabilities.
+
+#### Example
+
+```ts
+const capabilities = await sos.display.getCapabilities();
+console.log('Supported display capabilities:', capabilities.join(', '));
+```
+
+<Separator />
+
 ### supports()
 
 The `supports()` method determines whether the device supports a queried capability.

package/docs/sos/hardware/index.md

@@ -47,14 +47,23 @@ openSerialPort(options: ISerialPortOptions): Promise<ISerialPort>;
  * All properties are optional except `baudRate`.
  */
 interface ISerialPortOptions {
+    /** Unique address of the external device. */
     device?: string;
+    /** Data transmission speed in bits per second. */
     baudRate: number;
+    /** Form of error checking, whether (or what) extra bits are added to a byte. */
     parity?: Parity;
+    /** Number of bits in a byte. */
     databits?: number;
+    /** Number of bits used to signal the end of a communication packet. */
     stopbits?: number;
+    /** Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign. */
     rtscts?: boolean;
 }
 
+/**
+ * Available parity options for the serial port.
+ */
 enum Parity {
     NONE = "none",
     EVEN = "even",

package/docs/sos/input.md

@@ -26,8 +26,11 @@ onKeyUp(listener: (event: IKeyUpEvent) => void): void;
  * KeyUp event interface for handling key release events.
  */
 interface IKeyUpEvent {
+    /** KeyUp event type */
     type: 'keyup';
+    /** Key code representing the key that was released */
     keyCode: KeyUpEventMap;
+    /** Key name representing the key that was released */
     keyName: keyof typeof KeyUpEventMap;
 }
 

package/docs/sos/offline/index.md

@@ -41,12 +41,17 @@ addFile(file: ISaveFile): Promise<void>;
  * Interface represents a file that can be saved to cache and loaded into applet resources.
  */
 interface ISaveFile {
+    /** Unique identifier for the file. This is used to reference the file in the applet. */
     uid: string;
+    /** URI of the file to be saved. */
     uri: string;
+    /** Type of the file, e.g. 'javascript', 'css', etc. */
     type: IFileType;
+    /** HTTP headers to be sent with the request for the file. */
     headers?: {
         [key: string]: string;
     };
+    /** Additional flags for appending stored files to the DOM or other operations. */
     flags?: IFlag[];
 }
 
@@ -110,12 +115,17 @@ addFiles(files: ISaveFile[]): Promise<Awaited<void>[]>;
  * Interface represents a file that can be saved to cache and loaded into applet resources.
  */
 interface ISaveFile {
+    /** Unique identifier for the file. This is used to reference the file in the applet. */
     uid: string;
+    /** URI of the file to be saved. */
     uri: string;
+    /** Type of the file, e.g. 'javascript', 'css', etc. */
     type: IFileType;
+    /** HTTP headers to be sent with the request for the file. */
     headers?: {
         [key: string]: string;
     };
+    /** Additional flags for appending stored files to the DOM or other operations. */
     flags?: IFlag[];
 }
 
@@ -183,12 +193,17 @@ addFilesSync(files: ISaveFile[]): Promise<void>;
  * Interface represents a file that can be saved to cache and loaded into applet resources.
  */
 interface ISaveFile {
+    /** Unique identifier for the file. This is used to reference the file in the applet. */
     uid: string;
+    /** URI of the file to be saved. */
     uri: string;
+    /** Type of the file, e.g. 'javascript', 'css', etc. */
     type: IFileType;
+    /** HTTP headers to be sent with the request for the file. */
     headers?: {
         [key: string]: string;
     };
+    /** Additional flags for appending stored files to the DOM or other operations. */
     flags?: IFlag[];
 }
 
@@ -243,8 +258,11 @@ using `addFile()`, because it also generates appropriate font-face definition.
 addFont(font: IAddFont): Promise<void>;
 // show-more
 interface IAddFont extends IFontFaceProperties {
+    /** Unique identifier for the font face. This is used to reference the font in the applet. */
     uid: string;
+    /** Element to which the font face will be appended. */
     append: HTMLElement;
+    /** Available formats for the font. */
     formats: IFontFormats;
 }
 

package/docs/sos/proofOfPlay.md

@@ -22,12 +22,19 @@ recordItemPlayed(options: IRecordItemOptions): Promise<void>;
  * Interface representing options for a record item in the Proof of Play applet.
  */
 interface IRecordItemOptions {
+    /** The name of the item that was played. */
     name: string;
+    /** An optional custom identifier for the item. */
     customId?: string;
+    /** The type of the item that was played. */
     type?: 'video' | 'image' | 'html' | 'custom';
+    /** An array of tags associated with the item. */
     tags?: string[];
+    /** The name of the file that was played. */
     fileName?: string;
+    /** A boolean indicating whether the playback was successful. */
     playbackSuccess?: boolean;
+    /** An optional error message if the playback was not successful. */
     errorMessage?: string;
 }
 

package/docs/sos/sync.md

@@ -139,6 +139,7 @@ other.
 ```ts expandable
 connect(options?: SynchronizationEngineOptions): Promise<void>;
 // show-more
+/** Options for the `connect()` method based selected synchronization type. */
 type SynchronizationEngineOptions = ConnectSyncServerOptions | ConnectP2PLocalOptions | ConnectUdpOptions;
 
 /**
@@ -146,6 +147,7 @@ type SynchronizationEngineOptions = ConnectSyncServerOptions | ConnectP2PLocalOp
  */
 interface ConnectSyncServerOptions {
     engine?: SyncEngine.SyncServer;
+    /** Address of the sync server engine. If omitted, the default server from device configuration will be used. */
     uri?: string;
 }
 

package/docs/sos_management/index.md

@@ -112,6 +112,34 @@ console.log(`Device brand is: ${brand}`); // e.g., 'Samsung', 'LG', BrightSign,
 
 <Separator />
 
+### getCapabilities()
+
+The `getCapabilities()` method returns a list of all supported management capabilities of the device.
+
+For more information what are capabilities, see the description of the `supports()` method.
+
+```ts expandable
+getCapabilities(): Promise<ManagementCapability[]>;
+// show-more
+type ManagementCapability = 'MODEL' | 'SERIAL_NUMBER' | 'BRAND' | 'OS_VERSION' | 'BATTERY_STATUS' | 'STORAGE_UNITS' | 'TEMPERATURE' | 'SCREENSHOT_UPLOAD' | 'NETWORK_INFO' | 'WIFI' | 'WIFI_SCAN' | 'WIFI_AP' | 'WIFI_STRENGTH' | 'TIMERS_PROPRIETARY' | 'BRIGHTNESS_SCHEDULING' | 'TIMERS_NATIVE' | 'SET_BRIGHTNESS' | 'GET_BRIGHTNESS' | 'SCREEN_RESIZE' | 'SET_TIME' | 'SET_TIMEZONE' | 'GET_TIMEZONE' | 'NTP_TIME' | 'APP_UPGRADE' | 'FIRMWARE_UPGRADE' | 'PACKAGE_INSTALL' | 'SET_VOLUME' | 'GET_VOLUME' | 'SET_REMOTE_CONTROL_ENABLED' | 'SET_DEBUG' | 'SYSTEM_REBOOT' | 'APP_RESTART' | 'DISPLAY_POWER' | 'SERVLET' | 'HARDWARE_LED_SET_COLOR' | 'PROXIMITY_SENSOR' | 'FACTORY_RESET' | 'ORIENTATION_LANDSCAPE' | 'ORIENTATION_PORTRAIT' | 'ORIENTATION_LANDSCAPE_FLIPPED' | 'ORIENTATION_PORTRAIT_FLIPPED' | 'ORIENTATION_AUTO' | 'SCHEDULE_POWER_ACTION' | 'EXTENDED_MANAGEMENT' | 'SYSTEM_CPU' | 'SYSTEM_MEMORY' | 'PROXY' | 'AUTO_RECOVERY' | 'PEER_RECOVERY' | 'FILE_SYSTEM_WIPEOUT' | 'REMOTE_DESKTOP' | 'HOTEL_MODE' | 'VPN' | 'CUSTOM_SCRIPTS' | 'NATIVE_COMMANDS_MDC' | 'DEVICE_OWNER' | 'ACCESSIBILITY_SERVICE' | 'DISPLAY_MANAGER' | 'SECRETS' | 'HARDWARE_ACCELERATION' | 'WIFI_COUNTRY' | 'STOP_PACKAGE' | AnyString;
+
+type AnyString = string & {};
+
+```
+
+#### Return value
+
+A promise that resolves to an array of supported management capabilities.
+
+#### Example
+
+```ts
+const capabilities = await sos.management.getCapabilities();
+console.log('Supported management capabilities:', capabilities.join(', '));
+```
+
+<Separator />
+
 ### getExtendedManagementUrl()
 
 The `getExtendedManagementUrl()` method returns the management URL of the device.

package/docs/sos_management/network.md

@@ -65,14 +65,21 @@ The `importCertificate()` method imports a certificate to the device. The certif
 ```ts expandable
 importCertificate(details: CertificateEapDetails): Promise<void>;
 // show-more
+/** Details for importing a certificate for EAP authentication. */
 interface CertificateEapDetails {
+    /** Type of EAP authentication */
     type: EAPType;
+    /** CA certificate */
     caCertificate?: string;
+    /** Client certificate for EAP-TLS */
     clientCertificate?: string;
+    /** Private key for client certificate for EAP-TLS */
     clientKey?: string;
+    /** Password for the private key, if it's encrypted */
     clientCertificatePassword?: string;
 }
 
+/** Allowed types of EAP authentication */
 type EAPType = 'EAP-TLS' | 'PEAP' | 'EAP-TTLS';
 
 ```

package/docs/sos_management/power.md

@@ -106,12 +106,16 @@ getScheduledReboots(): Promise<IScheduledRebootActions[]>;
  * Interface representing the scheduled reboot action.
  */
 interface IScheduledRebootActions {
+    /** Random generated ID for the scheduled reboot action */
     id: string;
+    /** The rule of the scheduled reboot */
     rule: IScheduledRebootRule;
 }
 
 interface IScheduledRebootRule {
+    /** Weekdays as numbers or strings. Number types are received from server. */
     weekdays: number[] | string[];
+    /** Time in HH:mm:ss format */
     time: string;
 }
 
@@ -248,6 +252,7 @@ It is possible to set multiple rules, which can be later obtained by the `getSch
 ```ts expandable
 setScheduledReboot(weekdays: WeekdayType[], time: string): Promise<void>;
 // show-more
+/** Allowed scheduled action weekday types */
 type WeekdayType = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
 
 ```

package/docs/sos_management/screen.md

@@ -277,7 +277,7 @@ await sos.management.screen.setBrightness(
 
 <Separator />
 
-### takeAndUploadScreenshot(uploadBaseUrl, computeHash)
+### takeAndUploadScreenshot(uploadBaseUrl, options)
 
 The `takeAndUploadScreenshot()` method takes a screenshot and uploads it to a specified URL. This can be either a signageOS upload URL
 (`https://upload.signageos.io`) or a dedicated server URL for uploading screenshots. The format in which the screenshot is uploaded may be
@@ -292,18 +292,33 @@ signageOS provides a standalone server that implements all of those methods. It
 [support ticketing system](https://box.signageos.io/support/).
 
 ```ts expandable
-takeAndUploadScreenshot(uploadBaseUrl: string, computeHash?: boolean): Promise<{
+takeAndUploadScreenshot(uploadBaseUrl: string, options?: TakeAndUploadScreenshotOptions): Promise<TakeAndUploadScreenshotResult>;
+// show-more
+interface TakeAndUploadScreenshotResult {
+    /** URL of the uploaded screenshot. */
     screenshotUrl: string;
+    /** aHash of the screenshot, if computed. */
     aHash?: string;
-}>;
+}
+
+/** Options for taking and uploading a screenshot. */
+interface TakeAndUploadScreenshotOptions {
+    /** Whether to compute the hash of the screenshot. Default is false. */
+    computeHash?: boolean;
+    /** Additional headers to include in the upload request. */
+    headers?: Record<string, string>;
+}
+
 ```
 
 #### Params
 
-| Name            | Type      | Required         | Description                                                                                                   |
-|-----------------|-----------|------------------|---------------------------------------------------------------------------------------------------------------|
-| `uploadBaseUrl` | `string`  |  <div>Yes</div>  | URL to which the screenshot will be uploaded. It can be either a signageOS upload URL or a custom server URL. |
-| `computeHash`   | `boolean` |  <div>No</div>   | Whether to compute a hash of the screenshot and return it in the response.                                    |
+| Name                  | Type                             | Required         | Description                                                                                                   |
+|-----------------------|----------------------------------|------------------|---------------------------------------------------------------------------------------------------------------|
+| `uploadBaseUrl`       | `string`                         |  <div>Yes</div>  | URL to which the screenshot will be uploaded. It can be either a signageOS upload URL or a custom server URL. |
+| `options`             | `TakeAndUploadScreenshotOptions` |  <div>No</div>   | Optional parameters for taking and uploading the screenshot.                                                  |
+| `options.computeHash` | `boolean`                        |  <div>No</div>   | Whether to compute a hash of the screenshot and return it in the response.                                    |
+| `options.headers`     | `Record<string, string>`         |  <div>No</div>   | Additional headers to include in the upload request for POST requests.                                        |
 
 #### Return value
 
@@ -314,14 +329,28 @@ A promise that resolves to an object containing the screenshot URL and optionall
 
 - If `uploadBaseUrl` is not a valid URL
 - If `computeHash` is not a boolean
+- If `headers` is not a valid object
 - If the screenshot cannot be taken or uploaded.
 
 #### Example
 
 ```ts
 const { screenshotUrl, aHash } = await sos.management.screen.takeAndUploadScreenshot(
+  'https://your.upload.server/upload/file?prefix=screenshot/',
+  { computeHash: true },
+);
+console.log(`Screenshot uploaded to: ${screenshotUrl} with aHash: ${aHash}`);
+
+// Upload screenshot with custom headers
+const { screenshotUrl } = await sos.management.screen.takeAndUploadScreenshot(
    'https://your.upload.server/upload/file?prefix=screenshot/',
-   true,
+   {
+       computeHash: false,
+       headers: {
+       	'Authorization': 'Bearer yourTokenHere',
+         'Custom-Header': 'CustomValue'
+       }
+   },
 );
 ```
 
@@ -333,6 +362,28 @@ const { screenshotUrl, aHash } = await sos.management.screen.takeAndUploadScreen
 
 <Separator />
 
+### ~takeAndUploadScreenshot(uploadBaseUrl, computeHash)~
+
+:::danger Deprecated
+
+This method was deprecated. Use `takeAndUploadScreenshot(uploadBaseUrl: string, options: TakeAndUploadScreenshotOptions): Promise<TakeAndUploadScreenshotResult>` instead.
+
+:::
+
+```ts expandable
+takeAndUploadScreenshot(uploadBaseUrl: string, computeHash?: boolean): Promise<TakeAndUploadScreenshotResult>;
+// show-more
+interface TakeAndUploadScreenshotResult {
+    /** URL of the uploaded screenshot. */
+    screenshotUrl: string;
+    /** aHash of the screenshot, if computed. */
+    aHash?: string;
+}
+
+```
+
+<Separator />
+
 ### ~takeAndUploadScreenshot(uploadBaseUrl)~
 
 :::danger Deprecated

package/docs/sos_management/wifi.md

@@ -42,12 +42,6 @@ On Tizen, make sure that the connection credentials are correct. If the device f
 Make sure that you have a backup script or a checking mechanism in place, which will allow you to recover from the situation if the connection fails.
 :::
 
-:::warning
-Connecting to an OPEN Wi-Fi network for Tizen and WebOS is different.
-- For Tizen, make sure that the `password` is an empty string (`''`) and in the options you have selected `OPEN` as encryption type.
-- For WebOS, you can pass `undefined` as the `password` parameter.
-:::
-
 :::info
 The security type of Wi-Fi is mandatory for Tizen.
 :::
@@ -55,15 +49,27 @@ The security type of Wi-Fi is mandatory for Tizen.
 ```ts expandable
 connect(ssid: string, password?: string, options?: IWifiConnectOptions): Promise<void>;
 // show-more
+/**
+ * Options for connecting to a Wi-Fi network.
+ */
 interface IWifiConnectOptions {
+    /** Whether the network is hidden. */
     hidden?: boolean;
+    /** The type of security/encryption used by the network. */
     securityType?: WifiEncryptionType;
+    /** Authentication details for networks that require EAP. */
     eap?: {
+        /** The type of EAP authentication to use. */
         method: EAPMethod;
+        /** Username or identity for authentication. */
         identity: string;
+        /** Anonymous identity for authentication. */
         anonymousIdentity?: string;
+        /** Password or passphrase for authentication. */
         passphrase: string;
+        /** Secondary authentication method. Not needed for TLS. */
         phase2Auth?: EAPPhase2Auth;
+        /** Whether to use a CA certificate for authentication. Not needed for TLS. */
         useCACert?: boolean;
     };
 }
@@ -101,21 +107,18 @@ A promise that resolves when the connection is established or if the connection
 
 - Error If the Wi-Fi state is not in the `client` state.
 - Error If the `ssid` is not a string or is empty.
-- Error If the `password` is not a string or is empty (if required).
+- Error If the `password` is not a string
 - Error If the `options` is not an object or does not match the expected schema.
 - Error If the `securityType` is not one of the allowed values.
 
 #### Example
 
 ```ts
-// To connect to an open Wi-Fi network, e.g., WebOS
-await sos.management.wifi.connect('MyOpenNetwork');
-
-// To connect an open Wi-Fi network with an empty password (Tizen)
-await sos.management.wifi.connect('MyOpenNetwork', '', { securityType: 'OPEN' });
+// To connect an open Wi-Fi network with an empty password
+await sos.management.wifi.connect('MyOpenNetwork', undefined, { securityType: 'OPEN' });
 
 // If the network is hidden
-await sos.management.wifi.connect('MyOpenNetwork', undefined, { hidden: true });
+await sos.management.wifi.connect('MyOpenNetwork', undefined, { hidden: true, securityType: 'WPA2' });
 
 // To connect to an encrypted Wi-Fi network with WPA2 security
 await sos.management.wifi.connect('MyEncryptedNetwork', 'my-password', { securityType: 'WPA2' });
@@ -565,7 +568,9 @@ scanDevices(): Promise<IScannedDevice[]>;
  * Interface representing a scanned Wi-Fi device.
  */
 interface IScannedDevice {
+    /** SSID of the Wi-Fi network */
     ssid: string;
+    /** If Wi-Fi SSID is encrypted */
     encrypted: boolean;
 }
 

package/es6/FrontApplet/DeviceInfo/DeviceInfo.d.ts

@@ -1,5 +1,5 @@
 import IPostMessage from '../IPostMessage';
-import { IDeviceInfo, IDeviceLocation, IOrganizationTag } from './IDeviceInfo';
+import { IDeviceInfo, IDeviceLocation, IDeviceTag, IOrganizationTag } from './IDeviceInfo';
 /**
  * The `sos.deviceInfo` API groups together methods for retrieving information about the device set in the CloudControl, such as location or
  * tags.
@@ -11,7 +11,7 @@ export default class DeviceInfo implements IDeviceInfo {
     /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     /**
-     * The `getLocation()` method returns location of the device. Location is requested from server on application start, automatically
+     * The `getLocation()` method returns location of the device with child tags if available. Location is requested from server on application start, automatically
      * updated when changed and persisted in local storage.
      *
      * :::note
@@ -23,15 +23,7 @@ export default class DeviceInfo implements IDeviceInfo {
      */
     getLocation(): Promise<IDeviceLocation | null>;
     /**
-     * The `getOrganizationTags()` method returns all tags assigned to the device. Tags are requested from server on application start, automatically
-     * updated when changed and persisted in local storage.
-     *
-     * :::note
-     * Tags can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceTag-(Device-Tags)).
-     * :::
-     *
-     * @returns {Promise<IOrganizationTag[]>} A promise that resolves to an array of organization tags.
-     * @since 5.2.0
+     * @deprecated Please use `getDeviceTags()` method instead.
      */
     getOrganizationTags(): Promise<IOrganizationTag[]>;
     /**
@@ -50,6 +42,18 @@ export default class DeviceInfo implements IDeviceInfo {
      * console.log(`Device name is: ${deviceName}`);
      */
     getDeviceName(): Promise<string | null>;
+    /**
+     * The `getDeviceTags()` method returns all organization tags assigned to the device including parent tags, if available.
+     * Tags are requested from server on application start, automatically updated when changed and persisted in local storage.
+     *
+     * :::note
+     * Tags can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceTag-(Device-Tags)).
+     * :::
+     *
+     * @returns {Promise<IDeviceTag[]>} A promise that returns the device tags.
+     * @since 8.5.0
+     */
+    getDeviceTags(): Promise<IDeviceTag[]>;
     private getMessage;
     private geDeviceNameFromTittle;
 }