@signageos/front-applet 8.5.3 → 8.7.0

package/docs/fpath/index.md

@@ -57,43 +57,16 @@ Return the last portion of path, since it is not a valid path, a string is retur
 ```ts expandable
 basename(filePath: IFilePath, suffix?: string): string;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -126,43 +99,16 @@ Concatenate filePath with paths without adding separator.
 ```ts expandable
 concat(filePath: IFilePath, ...paths: string[]): IFilePath;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -195,43 +141,16 @@ Removes the last portion of path, returning the parent directory of the path. Ig
 ```ts expandable
 dirname(filePath: IFilePath): IFilePath;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -263,43 +182,16 @@ Returns extension of the path, from the last period, including the period.
 ```ts expandable
 extname(filePath: IFilePath): string;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -331,43 +223,16 @@ Always returns true, because all file paths are absolute
 ```ts expandable
 isAbsolute(_: IFilePath): boolean;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -388,43 +253,16 @@ Returns new filePath with paths appended to it and normalized (resolved . and ..
 ```ts expandable
 join(filePath: IFilePath, ...paths: string[]): IFilePath;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -457,43 +295,16 @@ Resolves `.` and `..` in the path and removes multiple slashes.
 ```ts expandable
 normalize(filePath: IFilePath): IFilePath;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -525,43 +336,16 @@ Works like `fpath.join()`, but if any of the paths is an absolute path, it will
 ```ts expandable
 resolve(filePath: IFilePath, ...paths: string[]): IFilePath;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -587,43 +371,16 @@ Similar to `fpath.join()`, but resulting path will always be subdirectory of bas
 ```ts expandable
 safeJoin(base: IFilePath, ...paths: string[]): IFilePath;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -656,43 +413,16 @@ Convert filePath to string, this string is not guaranteed to be unique and shoul
 ```ts expandable
 stringify(filePath: IFilePath): string;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 

package/docs/sos/browser.md

@@ -61,13 +61,7 @@ user request or after a timeout. This doesn't fire between `open` calls or on su
 ```ts expandable
 onClose(listener: (event: CloseEvent) => void): () => void;
 // show-more
-/**
- * Interface representing a close event in the browser.
- */
 interface CloseEvent extends Event<EventType.CLOSE> {
-    /**
-     * The reason for the browser being closed.
-     */
     reason: CloseReason;
 }
 
@@ -106,9 +100,6 @@ The `open()` method opens the specified url in a browser window.
 ```ts expandable
 open(uri: string, options?: IOpenLinkOptions): Promise<void>;
 // show-more
-/**
- * Interface defines the options for opening a link in the browser.
- */
 interface IOpenLinkOptions {
     aclDomains?: string[];
     aclMode?: 'blacklist' | 'whitelist';
@@ -124,10 +115,6 @@ interface IOpenLinkOptions {
     headlessMode?: boolean;
     clearData?: boolean;
     canUserClose?: boolean;
-    /**
-     * Method of opening the link.
-     * @default 'native'
-     */
     method?: 'native' | 'iframe';
 }
 
@@ -230,7 +217,6 @@ This method was deprecated. use `sos.browser.open()` instead
 ```ts expandable
 openLink(uri: string, options?: IDeprecatedOpenLinkOptions): Promise<void>;
 // show-more
-/** @deprecated */
 interface IDeprecatedOpenLinkOptions {
     acl?: RegExp[];
     aclMode?: 'blacklist' | 'whitelist';

package/docs/sos/command.md

@@ -23,14 +23,8 @@ exact limit.
 ```ts expandable
 dispatch<TCommand extends ICommand>(command: TCommand): Promise<void>;
 // show-more
-/**
- * Interface represents a command structure with a type and additional data.
- */
 interface ICommand {
     type: string;
-    /**
-     * The `data` property is an object that contains additional data related to the command.
-     */
     [key: string]: any;
 }
 
@@ -77,25 +71,13 @@ The `onCommand()` method sets up a listener, which is called whenever a new comm
 ```ts expandable
 onCommand(listener: (command: ICommandEvent) => void): void;
 // show-more
-/**
- * Received command event interface from signageOS.
- */
 interface ICommandEvent {
     type: 'command';
-    /**
-     * Command data received from occurred event.
-     */
     command: ICommand;
 }
 
-/**
- * Interface represents a command structure with a type and additional data.
- */
 interface ICommand {
     type: string;
-    /**
-     * The `data` property is an object that contains additional data related to the command.
-     */
     [key: string]: any;
 }
 

package/docs/sos/deviceInfo.md

@@ -47,16 +47,10 @@ Tags can be set only in CloudControl on Device Info page, or via [Rest API](http
 ```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;
 }
@@ -81,23 +75,13 @@ 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;
 }
@@ -121,7 +105,6 @@ This method was deprecated. Please use `getDeviceTags()` method instead.
 ```ts expandable
 getOrganizationTags(): Promise<IOrganizationTag[]>;
 // show-more
-/** @deprecated */
 interface IOrganizationTag {
     name: string;
 }

package/docs/sos/display.md

@@ -18,10 +18,6 @@ For more information what are capabilities, see the description of the `supports
 ```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 & {};
@@ -60,10 +56,6 @@ or check the **DisplayCapability** type in `supports()` methods. It has a list o
 ```ts expandable
 supports(capability: DisplayCapability): Promise<boolean>;
 // 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 & {};