@signageos/front-applet 8.1.0 → 8.1.2

package/docs/fpath/index.md

@@ -1,48 +1,19 @@
 ---
-sidebar_position: 99
+sidebar_position: 0
 ---
 
 # fpath
 
-fpath utility mirrors node [path](https://nodejs.org/docs/latest/api/path.html)
-module, but accepts IFilePath type instead of strings. It is useful when
-working with [sos.fileSystem](/sdk/sos/fileSystem).
-
-Not implemented functions:
-- format
-- matchesGlob
-- parse
-- relative
-
-```ts
-import { sos, fpath } from "@signageos/front-applet";
-
-const [internal] = await sos.fileSystem.listInternalStorageUnits();
-const rootPath = {
-	filePath: '', // Empty string is used as an absolute path instead of "/"
-	storageUnit: internal
-};
-
-// list saved files in videos/2025-05-19/ directory
-const videos = await sos.fileSystem.listFiles(
- fpath.join(rootPath, "videos", "2025-05-19"),
-);
-```
-
 ## Properties
 
 ### path
 
-Underlying path polyfill
-
 ```ts expandable
-path: path.Path;
+path: import("path-browserify").Path;
 ```
 
 ### sep
 
-Separator used for joining path segments
-
 ```ts expandable
 sep: string;
 ```
@@ -51,287 +22,78 @@ sep: string;
 
 ### basename()
 
-Return the last portion of path, since it is not a valid path, a string is returned.
-
 ```ts expandable
-basename(filePath: IFilePath, suffix?: string): string;
-// show-more
-interface IFilePath {
-    storageUnit: IStorageUnit;
-    filePath: string;
-}
-
-interface IStorageUnit {
-    type: string;
-    capacity: number;
-    freeSpace: number;
-    usableSpace: number;
-    removable: boolean;
-}
-
-```
-
-#### Example
-
-```ts
-const path = { filePath: "images/picture.png", storageUnit: ... };
-fpath.basename(path); // "picture.png"
+basename(filePath: import("./FrontApplet/FileSystem/types").IFilePath, suffix?: string): string;
 ```
 
 <Separator />
 
 ### concat()
 
-Concatenate fp with paths without adding separator
-
 ```ts expandable
-concat(filePath: IFilePath, ...paths: string[]): IFilePath;
-// show-more
-interface IFilePath {
-    storageUnit: IStorageUnit;
-    filePath: string;
-}
-
-interface IStorageUnit {
-    type: string;
-    capacity: number;
-    freeSpace: number;
-    usableSpace: number;
-    removable: boolean;
-}
-
-```
-
-#### Example
-
-```ts
-const path = { filePath: "uploads/archive.tar", storageUnit: ... };
-fpath.concat(path, "_extracted"); // { filePath: "uploads/archive.tar_extracted", storageUnit: ... }
+concat(filePath: import("./FrontApplet/FileSystem/types").IFilePath, ...paths: string[]): import("./FrontApplet/FileSystem/types").IFilePath;
 ```
 
 <Separator />
 
 ### dirname()
 
-Removes the last portion of path, returning the parent directory of the path. Ignores trailing slashes
-
 ```ts expandable
-dirname(filePath: IFilePath): IFilePath;
-// show-more
-interface IFilePath {
-    storageUnit: IStorageUnit;
-    filePath: string;
-}
-
-interface IStorageUnit {
-    type: string;
-    capacity: number;
-    freeSpace: number;
-    usableSpace: number;
-    removable: boolean;
-}
-
-```
-
-#### Example
-
-```ts
-const path = { filePath: "images/picture.png", storageUnit: ... };
-fpath.dirname(path); // { filePath: "images", storageUnit: ... }
+dirname(filePath: import("./FrontApplet/FileSystem/types").IFilePath): import("./FrontApplet/FileSystem/types").IFilePath;
 ```
 
 <Separator />
 
 ### extname()
 
-Returns extension of the path, from the last period, including the period.
-
 ```ts expandable
-extname(filePath: IFilePath): string;
-// show-more
-interface IFilePath {
-    storageUnit: IStorageUnit;
-    filePath: string;
-}
-
-interface IStorageUnit {
-    type: string;
-    capacity: number;
-    freeSpace: number;
-    usableSpace: number;
-    removable: boolean;
-}
-
-```
-
-#### Example
-
-```ts
-const path = { filePath: "images/picture.png", storageUnit: ... };
-fpath.dirname(path); // .png
+extname(filePath: import("./FrontApplet/FileSystem/types").IFilePath): string;
 ```
 
 <Separator />
 
 ### isAbsolute()
 
-Always returns true, because all file paths are absolute
-
 ```ts expandable
-isAbsolute(_: IFilePath): boolean;
-// show-more
-interface IFilePath {
-    storageUnit: IStorageUnit;
-    filePath: string;
-}
-
-interface IStorageUnit {
-    type: string;
-    capacity: number;
-    freeSpace: number;
-    usableSpace: number;
-    removable: boolean;
-}
-
+isAbsolute(_: import("./FrontApplet/FileSystem/types").IFilePath): boolean;
 ```
 
 <Separator />
 
 ### join()
 
-Returns new filePath with paths appended to it and normalized (resolved . and ..)
-
 ```ts expandable
-join(filePath: IFilePath, ...paths: string[]): IFilePath;
-// show-more
-interface IFilePath {
-    storageUnit: IStorageUnit;
-    filePath: string;
-}
-
-interface IStorageUnit {
-    type: string;
-    capacity: number;
-    freeSpace: number;
-    usableSpace: number;
-    removable: boolean;
-}
-
-```
-
-#### Example
-
-```ts
-const path = { filePath: "images", storageUnit: ... };
-fpath.join(path, "racoons", ".", "picture.png"); // { filePath: "images/racoons/picture.png", storageUnit: ... }
+join(filePath: import("./FrontApplet/FileSystem/types").IFilePath, ...paths: string[]): import("./FrontApplet/FileSystem/types").IFilePath;
 ```
 
 <Separator />
 
 ### normalize()
 
-Resolves . and .. in the path and removes multiple slashes
-
 ```ts expandable
-normalize(filePath: IFilePath): IFilePath;
-// show-more
-interface IFilePath {
-    storageUnit: IStorageUnit;
-    filePath: string;
-}
-
-interface IStorageUnit {
-    type: string;
-    capacity: number;
-    freeSpace: number;
-    usableSpace: number;
-    removable: boolean;
-}
-
-```
-
-#### Example
-
-```ts
-const path = { filePath: "images//test/../test2/./", storageUnit: ... };
-fpath.normalize(path); // { filePath: "images/test2/", storageUnit: ... }
+normalize(filePath: import("./FrontApplet/FileSystem/types").IFilePath): import("./FrontApplet/FileSystem/types").IFilePath;
 ```
 
 <Separator />
 
 ### resolve()
 
-Same as fpath.join()
-
 ```ts expandable
-resolve(filePath: IFilePath, ...paths: string[]): IFilePath;
-// show-more
-interface IFilePath {
-    storageUnit: IStorageUnit;
-    filePath: string;
-}
-
-interface IStorageUnit {
-    type: string;
-    capacity: number;
-    freeSpace: number;
-    usableSpace: number;
-    removable: boolean;
-}
-
+resolve(filePath: import("./FrontApplet/FileSystem/types").IFilePath, ...paths: string[]): import("./FrontApplet/FileSystem/types").IFilePath;
 ```
 
 <Separator />
 
 ### safeJoin()
 
-Similar to fpath.join, but resulting path will always be subdirectory of base
-
 ```ts expandable
-safeJoin(base: IFilePath, ...paths: string[]): IFilePath;
-// show-more
-interface IFilePath {
-    storageUnit: IStorageUnit;
-    filePath: string;
-}
-
-interface IStorageUnit {
-    type: string;
-    capacity: number;
-    freeSpace: number;
-    usableSpace: number;
-    removable: boolean;
-}
-
-```
-
-#### Example
-
-```ts
-const path = { filePath: "uploads/userA", storageUnit: ... };
-fpath.safeJoin(path, "..", "userB", "picture.png"); // { filePath: "uploads/userA/userB/picture.png", storageUnit: ... }
+safeJoin(base: import("./FrontApplet/FileSystem/types").IFilePath, ...paths: string[]): import("./FrontApplet/FileSystem/types").IFilePath;
 ```
 
 <Separator />
 
 ### stringify()
 
-Convert filePath to string, this string is not guaranteed to be unique and should be only used for debugging/logging
-
 ```ts expandable
-stringify(filePath: IFilePath): string;
-// show-more
-interface IFilePath {
-    storageUnit: IStorageUnit;
-    filePath: string;
-}
-
-interface IStorageUnit {
-    type: string;
-    capacity: number;
-    freeSpace: number;
-    usableSpace: number;
-    removable: boolean;
-}
-
+stringify(filePath: import("./FrontApplet/FileSystem/types").IFilePath): string;
 ```

package/docs/sos/fileSystem.md

@@ -46,7 +46,7 @@ interface IStorageUnit {
 
 #### Possible errors
 
-The method throws an error if the parent directory does not exist or the `filePath` is a directory.
+If the parent directory does not exist or the `filePath` is a directory.
 
 <Separator />
 
@@ -84,7 +84,7 @@ interface ICopyFileOptions {
 
 #### Possible errors
 
-The method throws an error if the source file does not exists or parent of the destination file path does not exists. It also throws if the
+If the source file does not exists or parent of the destination file path does not exists. It also throws if the
 `options.overwrite` is not set and the destination file path already exists.
 
 <Separator />
@@ -143,7 +143,7 @@ interface IStorageUnit {
 
 #### Possible errors
 
-The method throws an error if the directory already exists or its parent directory does not exist.
+If the directory already exists or its parent directory does not exist.
 
 <Separator />
 
@@ -171,7 +171,7 @@ interface IStorageUnit {
 
 #### Possible errors
 
-The method throws an error if the file does not exists or if `recursive` is set to false and the file path is a directory.
+If the file does not exists or if `recursive` is set to false and the file path is a directory.
 
 <Separator />
 
@@ -241,7 +241,7 @@ interface IHeaders {
 
 #### Possible errors
 
-The method throws an error if the network request fails, parent directory does not exist, or the file path is a directory.
+If the network request fails, parent directory does not exist, or the file path is a directory.
 
 <Separator />
 
@@ -293,7 +293,7 @@ interface IStorageUnit {
 
 #### Possible errors
 
-The method throws an error if the archive file path does not exist, it is not a valid archive file or the destination directory does not exist.
+If the archive file path does not exist, it is not a valid archive file or the destination directory does not exist.
 
 <Separator />
 
@@ -359,7 +359,7 @@ type AnyString = string & {};
 
 #### Possible errors
 
-The method throws an error if the file does not exist or it is a directory.
+If the file does not exist or it is a directory.
 
 <Separator />
 
@@ -387,7 +387,7 @@ interface IStorageUnit {
 
 #### Possible errors
 
-The method throws an error if the file path does not exist.
+If the file path does not exist.
 
 <Separator />
 
@@ -439,7 +439,7 @@ interface IStorageUnit {
 
 #### Possible errors
 
-The method throws an error if the path does not exist or it is a file.
+If the path does not exist or it is a file.
 
 <Separator />
 
@@ -510,7 +510,7 @@ interface IMoveFileOptions {
 
 #### Possible errors
 
-The method throws an error if the source file does not exists or parent of the destination file path does not exists. It also throws if the
+If the source file does not exists or parent of the destination file path does not exists. It also throws if the
 `options.overwrite` is not set and the destination file path already exists.
 
 <Separator />
@@ -550,7 +550,7 @@ interface IStorageUnit {
 
 #### Possible errors
 
-The method throws an error if the file does not exist.
+If the file does not exist.
 
 <Separator />
 
@@ -614,7 +614,7 @@ interface IStorageUnit {
 
 #### Possible errors
 
-The method throws an error if the parent directory does not exist or the `filePath` is a directory.
+If the parent directory does not exist or the `filePath` is a directory.
 
 ## API Example
 

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/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 />
 
@@ -75,7 +75,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 +132,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 +185,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 />
 
@@ -204,4 +204,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.