@signageos/front-applet 8.1.0 → 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/es6/bundle.d.ts

@@ -1,9 +1,22 @@
 import FrontApplet from './FrontApplet/FrontApplet';
 import Monitoring from './Monitoring/Monitoring';
-export * from './fpath';
 export declare const frontApplet: FrontApplet;
 export declare const sos: FrontApplet;
 export declare const monitoring: Monitoring;
+export declare const fpath: {
+    basename(filePath: import("./FrontApplet/FileSystem/types").IFilePath, suffix?: string): string;
+    dirname(filePath: import("./FrontApplet/FileSystem/types").IFilePath): import("./FrontApplet/FileSystem/types").IFilePath;
+    extname(filePath: import("./FrontApplet/FileSystem/types").IFilePath): string;
+    isAbsolute(_: import("./FrontApplet/FileSystem/types").IFilePath): boolean;
+    join(filePath: import("./FrontApplet/FileSystem/types").IFilePath, ...paths: string[]): import("./FrontApplet/FileSystem/types").IFilePath;
+    safeJoin(base: import("./FrontApplet/FileSystem/types").IFilePath, ...paths: string[]): import("./FrontApplet/FileSystem/types").IFilePath;
+    normalize(filePath: import("./FrontApplet/FileSystem/types").IFilePath): import("./FrontApplet/FileSystem/types").IFilePath;
+    resolve(filePath: import("./FrontApplet/FileSystem/types").IFilePath, ...paths: string[]): import("./FrontApplet/FileSystem/types").IFilePath;
+    sep: string;
+    concat(filePath: import("./FrontApplet/FileSystem/types").IFilePath, ...paths: string[]): import("./FrontApplet/FileSystem/types").IFilePath;
+    stringify(filePath: import("./FrontApplet/FileSystem/types").IFilePath): string;
+    path: import("path-browserify").Path;
+};
 declare global {
     interface Window {
         sos: FrontApplet;

package/es6/bundle.js

@@ -1,30 +1,17 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.monitoring = exports.sos = exports.frontApplet = void 0;
+exports.fpath = exports.monitoring = exports.sos = exports.frontApplet = void 0;
 const createFrontApplet_1 = __importDefault(require("./FrontApplet/createFrontApplet"));
 const Monitoring_1 = __importDefault(require("./Monitoring/Monitoring"));
-__exportStar(require("./fpath"), exports);
+const fpath_1 = require("./fpath");
 // fake exports for generating declarations which are overwritten by module.exports
 exports.frontApplet = (0, createFrontApplet_1.default)(window, 'hug');
 exports.sos = exports.frontApplet;
 exports.monitoring = new Monitoring_1.default(exports.frontApplet);
+exports.fpath = fpath_1.fpath;
 // add exports to the frontApplet, which is assigned to module.exports
 // @ts-ignore
 exports.frontApplet.sos = exports.frontApplet;
@@ -34,6 +21,8 @@ exports.frontApplet.frontApplet = exports.frontApplet;
 exports.frontApplet.monitoring = exports.monitoring;
 // @ts-ignore
 exports.frontApplet.default = exports.frontApplet;
+// @ts-ignore
+exports.frontApplet.fpath = exports.fpath;
 window.sos = exports.frontApplet;
 window.sosMonitoring = exports.monitoring;
 exports.default = exports.frontApplet;

package/es6/bundle.js.map

@@ -1 +1 @@
-{"version":3,"file":"bundle.js","sourceRoot":"","sources":["../src/bundle.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,wFAAgE;AAEhE,yEAAiD;AACjD,0CAAwB;AAExB,mFAAmF;AACtE,QAAA,WAAW,GAAG,IAAA,2BAAiB,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC/C,QAAA,GAAG,GAAG,mBAAW,CAAC;AAClB,QAAA,UAAU,GAAG,IAAI,oBAAU,CAAC,mBAAW,CAAC,CAAC;AAEtD,sEAAsE;AACtE,aAAa;AACb,mBAAW,CAAC,GAAG,GAAG,mBAAW,CAAC;AAC9B,aAAa;AACb,mBAAW,CAAC,WAAW,GAAG,mBAAW,CAAC;AACtC,aAAa;AACb,mBAAW,CAAC,UAAU,GAAG,kBAAU,CAAC;AACpC,aAAa;AACb,mBAAW,CAAC,OAAO,GAAG,mBAAW,CAAC;AASlC,MAAM,CAAC,GAAG,GAAG,mBAAW,CAAC;AACzB,MAAM,CAAC,aAAa,GAAG,kBAAU,CAAC;AAElC,kBAAe,mBAAW,CAAC;AAC3B,MAAM,CAAC,OAAO,GAAG,mBAAW,CAAC"}
+{"version":3,"file":"bundle.js","sourceRoot":"","sources":["../src/bundle.ts"],"names":[],"mappings":";;;;;;AAAA,wFAAgE;AAEhE,yEAAiD;AACjD,mCAA0C;AAE1C,mFAAmF;AACtE,QAAA,WAAW,GAAG,IAAA,2BAAiB,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC/C,QAAA,GAAG,GAAG,mBAAW,CAAC;AAClB,QAAA,UAAU,GAAG,IAAI,oBAAU,CAAC,mBAAW,CAAC,CAAC;AACzC,QAAA,KAAK,GAAG,aAAM,CAAC;AAE5B,sEAAsE;AACtE,aAAa;AACb,mBAAW,CAAC,GAAG,GAAG,mBAAW,CAAC;AAC9B,aAAa;AACb,mBAAW,CAAC,WAAW,GAAG,mBAAW,CAAC;AACtC,aAAa;AACb,mBAAW,CAAC,UAAU,GAAG,kBAAU,CAAC;AACpC,aAAa;AACb,mBAAW,CAAC,OAAO,GAAG,mBAAW,CAAC;AAClC,aAAa;AACb,mBAAW,CAAC,KAAK,GAAG,aAAK,CAAC;AAS1B,MAAM,CAAC,GAAG,GAAG,mBAAW,CAAC;AACzB,MAAM,CAAC,aAAa,GAAG,kBAAU,CAAC;AAElC,kBAAe,mBAAW,CAAC;AAC3B,MAAM,CAAC,OAAO,GAAG,mBAAW,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signageos/front-applet",
-  "version": "8.1.0",
+  "version": "8.1.1",
   "main": "dist/bundle.js",
   "types": "es6/bundle.d.ts",
   "files": [