@signageos/front-applet 8.0.3 → 8.1.1

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

@@ -574,6 +574,21 @@ removeStorageUnitsChangedListener(listener: () => void): void;
 
 <Separator />
 
+### wipeout()
+
+The `wipeout()` method is used to wipe out all data from the file system, later when action is finished the device is rebooted.
+
+:::danger
+- Ensure that function is called only once, otherwise it will wipe out the file system again on applet start!
+- This function is clearing internal file system storage, cache storage and cookies. Local storage will not be cleared.
+:::
+
+```ts expandable
+wipeout(): Promise<void>;
+```
+
+<Separator />
+
 ### writeFile()
 
 The `writeFile()` method writes string content to the file specified by `filePath`. If the file does exist, it is created. If the directory

package/docs/sos_management/power.md

@@ -25,6 +25,22 @@ await sos.management.power.appRestart();
 
 <Separator />
 
+### clearScheduledReboots()
+
+Removes all scheduled reboot rules from the device.
+
+```ts expandable
+clearScheduledReboots(): Promise<void>;
+```
+
+#### Example
+
+```ts
+await sos.management.power.clearScheduledReboots();
+```
+
+<Separator />
+
 ### getProprietaryTimers()
 
 The `getProprietaryTimers()` method returns a list of currently set
@@ -50,6 +66,33 @@ const timers = await sos.management.power.getProprietaryTimers();
 
 <Separator />
 
+### getScheduledReboots()
+
+Returns all scheduled reboot rules on the device.
+
+```ts expandable
+getScheduledReboots(): Promise<IScheduledRebootActions[]>;
+// show-more
+interface IScheduledRebootActions {
+    id: string;
+    rule: IScheduledRebootRule;
+}
+
+interface IScheduledRebootRule {
+    weekdays: number[] | string[];
+    time: string;
+}
+
+```
+
+#### Example
+
+```ts
+await sos.management.power.getScheduledReboots();
+```
+
+<Separator />
+
 ### getTimers()
 
 The `getTimers()` method returns a list of currently set native timers.
@@ -75,6 +118,32 @@ const timers = await sos.management.power.getTimers();
 
 <Separator />
 
+### removeScheduledReboot()
+
+Removes scheduled reboot rule from the device.
+
+```ts expandable
+removeScheduledReboot(id: string): Promise<void>;
+```
+
+#### Params
+
+| Name | Type     | Description                     |
+|------|----------|---------------------------------|
+| `id` | `string` | - ID of the rule to be removed. |
+
+#### Example
+
+```ts
+// Get scheduled reboots
+const scheduledReboots = await sos.management.power.getScheduledReboots();
+
+// Remove scheduled reboot
+await sos.management.power.removeScheduledReboot(scheduledReboots[0].id);
+```
+
+<Separator />
+
 ### setProprietaryTimer()
 
 The `setProprietaryTimer()` method creates or updates a
@@ -102,6 +171,42 @@ await sos.management.power.setProprietaryTimer("TIMER_20", "08:00", "22:00", ["m
 
 <Separator />
 
+### setScheduledReboot()
+
+Schedule automatic reboot on the device. Calling this function will create one rule.
+It is possible to set multiple rules, which can be later obtained by `getScheduledReboots` function.
+
+:::note
+- Setting new scheduled reboot on device might take up to 10 minutes to show in Box.
+- Every new scheduled reboot rule gets unique identifier generated by device, it might be later returned by `getScheduledReboots()`.
+:::
+
+```ts expandable
+setScheduledReboot(weekdays: WeekdayType[], time: string): Promise<void>;
+// show-more
+type WeekdayType = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
+
+```
+
+#### Params
+
+| Name       | Type            | Description                                                      |
+|------------|-----------------|------------------------------------------------------------------|
+| `weekdays` | `WeekdayType[]` |                                                                  |
+| `time`     | `string`        | - Time when the reboot should be executed. Format is `HH:mm:ss`. |
+
+#### Example
+
+```ts
+// Schedule reboot every Monday at 3:00 AM
+await sos.management.power.setScheduledReboot(["MONDAY"], "03:00:00");
+
+// Schedule reboot every Monday and Friday at 7:30 PM / 19:30
+await sos.management.power.setScheduledReboot(["MONDAY", "FRIDAY"], "19:30:00");
+```
+
+<Separator />
+
 ### setTimer()
 
 The `setTimers()` method creates or updates a native timer.

package/docs/sos_management/screen.md

@@ -74,7 +74,7 @@ isPoweredOn(): Promise<boolean>;
 
 ### powerOff()
 
-The `powerOff()` method turn the screen off.
+The `powerOff()` method turn the screen off. It will turn off the display backlight and the panel, and it will also disable applet.
 
 :::warning
 
@@ -183,7 +183,7 @@ await sos.management.screen.setBrightness(
 
 <Separator />
 
-### takeAndUploadScreenshot()
+### takeAndUploadScreenshot(uploadBaseUrl, computeHash)
 
 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. Format in which the screenshot is uploaded may be
@@ -197,6 +197,39 @@ To implement a custom screenshot upload server, it needs to implement these endp
 signageOS provides standalone server which is implements all of those methods. It is provided to all of our partners through the
 [support ticketing system](https://box.signageos.io/support/).
 
+```ts expandable
+takeAndUploadScreenshot(uploadBaseUrl: string, computeHash?: boolean): Promise<{
+    screenshotUrl: string;
+    aHash?: string;
+}>;
+```
+
+#### Params
+
+| Name                       | Type      | Description                                                                                                   |
+|----------------------------|-----------|---------------------------------------------------------------------------------------------------------------|
+| `uploadBaseUrl`            | `string`  | URL to which the screenshot will be uploaded. It can be either a signageOS upload url or a custom server url. |
+| `computeHash` *(optional)* | `boolean` | Whether to compute a hash of the screenshot and return it in the response.                                    |
+
+#### Example
+
+```ts
+const { screenshotUrl, aHash } = await sos.management.screen.takeAndUploadScreenshot(
+   'https://your.upload.server/upload/file?prefix=screenshot/',
+   true,
+);
+```
+
+<Separator />
+
+### ~takeAndUploadScreenshot(uploadBaseUrl)~
+
+:::danger Deprecated
+
+This method was deprecated. Use `takeAndUploadScreenshot(uploadBaseUrl: string, computeHash?: boolean): Promise<{ screenshotUrl: string; aHash?: string }>` instead.
+
+:::
+
 ```ts expandable
 takeAndUploadScreenshot(uploadBaseUrl: string): Promise<string>;
 ```