@signageos/front-applet 7.0.0 → 7.1.1

package/es6/fpath.d.ts

@@ -0,0 +1,89 @@
+import * as path from 'path-browserify';
+import { IFilePath } from './FrontApplet/FileSystem/types';
+/**
+ * fpath utility mirrors node path module, but accepts IFilePath type instead of strings.
+ *
+ * Not implemented functions:
+ * - format
+ * - matchesGlob
+ * - parse
+ * - relative
+ */
+export declare const fpath: {
+    /**
+     * Return the last portion of path, since it is not a valid path, a string is returned.
+     *
+     * @example
+     * const path = { filePath: "images/picture.png", storageUnit: ... };
+     * fpath.basename(path); // "picture.png"
+     */
+    basename(filePath: IFilePath, suffix?: string | undefined): string;
+    /**
+     * Removes the last portion of path, returning the parent directory of the path. Ignores trailing slashes
+     *
+     * @example
+     * const path = { filePath: "images/picture.png", storageUnit: ... };
+     * fpath.dirname(path); // { filePath: "images", storageUnit: ... }
+     */
+    dirname(filePath: IFilePath): IFilePath;
+    /**
+     * Returns extension of the path, from the last period, including the period.
+     *
+     * @example
+     * const path = { filePath: "images/picture.png", storageUnit: ... };
+     * fpath.dirname(path); // .png
+     */
+    extname(filePath: IFilePath): string;
+    /**
+     * Always returns true, because all file paths are absolute
+     */
+    isAbsolute(_: IFilePath): boolean;
+    /**
+     * Returns new filePath with paths appended to it and normalized (resolved . and ..)
+     *
+     * @example
+     * const path = { filePath: "images", storageUnit: ... };
+     * fpath.join(path, "racoons", ".", "picture.png"); // { filePath: "images/racoons/picture.png", storageUnit: ... }
+     */
+    join(filePath: IFilePath, ...paths: string[]): IFilePath;
+    /**
+     * Similar to fpath.join, but resulting path will always be subdirectory of base
+     *
+     * @example
+     * const path = { filePath: "uploads/userA", storageUnit: ... };
+     * fpath.safeJoin(path, "..", "userB", "picture.png"); // { filePath: "uploads/userA/userB/picture.png", storageUnit: ... }
+     */
+    safeJoin(base: IFilePath, ...paths: string[]): IFilePath;
+    /**
+     * Resolves . and .. in the path and removes multiple slashes
+     *
+     * @example
+     * const path = { filePath: "images//test/../test2/./", storageUnit: ... };
+     * fpath.normalize(path); // { filePath: "images/test2/", storageUnit: ... }
+     */
+    normalize(filePath: IFilePath): IFilePath;
+    /**
+     * Same as fpath.join()
+     */
+    resolve(filePath: IFilePath, ...paths: string[]): IFilePath;
+    /**
+     * Separator used for joining path segments
+     */
+    sep: string;
+    /**
+     * Concatenate fp with paths without adding separator
+     *
+     * @example
+     * const path = { filePath: "uploads/archive.tar", storageUnit: ... };
+     * fpath.concat(path, "_extracted"); // { filePath: "uploads/archive.tar_extracted", storageUnit: ... }
+     */
+    concat(filePath: IFilePath, ...paths: string[]): IFilePath;
+    /**
+     * Convert filePath to string, this string is not guaranteed to be unique and should be only used for debugging/logging
+     */
+    stringify(filePath: IFilePath): string;
+    /**
+     * Underlying path polyfill
+     */
+    path: path.Path;
+};

package/es6/fpath.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fpath = void 0;
+const path = require("path-browserify");
+/**
+ * fpath utility mirrors node path module, but accepts IFilePath type instead of strings.
+ *
+ * Not implemented functions:
+ * - format
+ * - matchesGlob
+ * - parse
+ * - relative
+ */
+exports.fpath = {
+    /**
+     * Return the last portion of path, since it is not a valid path, a string is returned.
+     *
+     * @example
+     * const path = { filePath: "images/picture.png", storageUnit: ... };
+     * fpath.basename(path); // "picture.png"
+     */
+    basename(filePath, suffix) {
+        return path.basename(filePath.filePath, suffix);
+    },
+    /**
+     * Removes the last portion of path, returning the parent directory of the path. Ignores trailing slashes
+     *
+     * @example
+     * const path = { filePath: "images/picture.png", storageUnit: ... };
+     * fpath.dirname(path); // { filePath: "images", storageUnit: ... }
+     */
+    dirname(filePath) {
+        let parentPath = path.dirname(filePath.filePath);
+        if (parentPath === '.') {
+            // The top level file dirname is ".", but sos accepts empty string "" for root
+            parentPath = '';
+        }
+        return {
+            filePath: parentPath,
+            storageUnit: filePath.storageUnit,
+        };
+    },
+    /**
+     * Returns extension of the path, from the last period, including the period.
+     *
+     * @example
+     * const path = { filePath: "images/picture.png", storageUnit: ... };
+     * fpath.dirname(path); // .png
+     */
+    extname(filePath) {
+        return path.extname(filePath.filePath);
+    },
+    /**
+     * Always returns true, because all file paths are absolute
+     */
+    isAbsolute(_) {
+        return true;
+    },
+    /**
+     * Returns new filePath with paths appended to it and normalized (resolved . and ..)
+     *
+     * @example
+     * const path = { filePath: "images", storageUnit: ... };
+     * fpath.join(path, "racoons", ".", "picture.png"); // { filePath: "images/racoons/picture.png", storageUnit: ... }
+     */
+    join(filePath, ...paths) {
+        return {
+            filePath: path.join(filePath.filePath, ...paths),
+            storageUnit: filePath.storageUnit,
+        };
+    },
+    /**
+     * Similar to fpath.join, but resulting path will always be subdirectory of base
+     *
+     * @example
+     * const path = { filePath: "uploads/userA", storageUnit: ... };
+     * fpath.safeJoin(path, "..", "userB", "picture.png"); // { filePath: "uploads/userA/userB/picture.png", storageUnit: ... }
+     */
+    safeJoin(base, ...paths) {
+        return {
+            filePath: base.filePath + path.resolve('/', ...paths),
+            storageUnit: base.storageUnit,
+        };
+    },
+    /**
+     * Resolves . and .. in the path and removes multiple slashes
+     *
+     * @example
+     * const path = { filePath: "images//test/../test2/./", storageUnit: ... };
+     * fpath.normalize(path); // { filePath: "images/test2/", storageUnit: ... }
+     */
+    normalize(filePath) {
+        return {
+            filePath: path.normalize(filePath.filePath),
+            storageUnit: filePath.storageUnit,
+        };
+    },
+    /**
+     * Same as fpath.join()
+     */
+    resolve(filePath, ...paths) {
+        return exports.fpath.join(filePath, ...paths);
+    },
+    /**
+     * Separator used for joining path segments
+     */
+    sep: path.sep,
+    /**
+     * Concatenate fp with paths without adding separator
+     *
+     * @example
+     * const path = { filePath: "uploads/archive.tar", storageUnit: ... };
+     * fpath.concat(path, "_extracted"); // { filePath: "uploads/archive.tar_extracted", storageUnit: ... }
+     */
+    concat(filePath, ...paths) {
+        return {
+            filePath: filePath.filePath.concat(...paths),
+            storageUnit: filePath.storageUnit,
+        };
+    },
+    /**
+     * Convert filePath to string, this string is not guaranteed to be unique and should be only used for debugging/logging
+     */
+    stringify(filePath) {
+        return path.join(`[${filePath.storageUnit.type}]`, filePath.filePath);
+    },
+    /**
+     * Underlying path polyfill
+     */
+    path,
+};
+//# sourceMappingURL=fpath.js.map

package/es6/fpath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fpath.js","sourceRoot":"","sources":["../src/fpath.ts"],"names":[],"mappings":";;;AAAA,wCAAwC;AAGxC;;;;;;;;GAQG;AACU,QAAA,KAAK,GAAG;IACpB;;;;;;OAMG;IACH,QAAQ,CAAC,QAAmB,EAAE,MAAe;QAC5C,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,QAAmB;QAC1B,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,UAAU,KAAK,GAAG,EAAE;YACvB,8EAA8E;YAC9E,UAAU,GAAG,EAAE,CAAC;SAChB;QACD,OAAO;YACN,QAAQ,EAAE,UAAU;YACpB,WAAW,EAAE,QAAQ,CAAC,WAAW;SACjC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,QAAmB;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,CAAY;QACtB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,QAAmB,EAAE,GAAG,KAAe;QAC3C,OAAO;YACN,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC;YAChD,WAAW,EAAE,QAAQ,CAAC,WAAW;SACjC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,IAAe,EAAE,GAAG,KAAe;QAC3C,OAAO;YACN,QAAQ,EAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACrD,WAAW,EAAE,IAAI,CAAC,WAAW;SAC7B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,QAAmB;QAC5B,OAAO;YACN,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC3C,WAAW,EAAE,QAAQ,CAAC,WAAW;SACjC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,QAAmB,EAAE,GAAG,KAAe;QAC9C,OAAO,aAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,GAAG,EAAE,IAAI,CAAC,GAAG;IAEb;;;;;;OAMG;IACH,MAAM,CAAC,QAAmB,EAAE,GAAG,KAAe;QAC7C,OAAO;YACN,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;YAC5C,WAAW,EAAE,QAAQ,CAAC,WAAW;SACjC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,QAAmB;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,IAAI;CACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signageos/front-applet",
-  "version": "7.0.0",
+  "version": "7.1.1",
   "main": "dist/bundle.js",
   "types": "es6/bundle.d.ts",
   "files": [
@@ -20,13 +20,13 @@
     "lint:prettier:fix": "prettier  \"**/*.+(ts|tsx|json|js)\" --write",
     "lint:staged": "npx lint-staged",
     "prebuild": "rm -rf dist/*",
-    "prepare": "npm run build && npm run generate-declarations && npx husky install",
+    "clean-build": "npm run build && npm run generate-declarations && npx husky install",
     "test": "env NODE_ENV=test ./node_modules/mocha/bin/mocha --config .mocha/default.js",
     "test:coverage": "npm run test:coverage:runtime && npm run test:coverage:types",
     "test:coverage:runtime": "env NODE_ENV=test c8 ./node_modules/mocha/bin/mocha --config .mocha/transpile-only.js",
     "test:coverage:types": "tsc --noEmit -p tsconfig.json",
     "escheck": "es-check --module es5 dist/*.js",
-    "check": "npm run depcheck && npx --userconfig ./.npmrc @signageos/lib check-deps '.+' 'weinre'",
+    "check": "npm run depcheck && npx --userconfig ./.npmrc @signageos/lib check-deps",
     "depcheck": "depcheck --specials=tslint,webpack,mocha --parsers='*.ts:typescript,*.js:es6' --detectors='requireCallExpression,importDeclaration' --ignore-dirs='dist,packages' --ignores='@types/*,@signageos/codestyle,ts-node,source-map-support,mocha,depcheck,webpack-cli,@babel/polyfill,@babel/preset-env,es-check,debug,husky,lint-staged,c8,should-sinon,faker,should,sinon'"
   },
   "repository": {
@@ -44,6 +44,7 @@
     "@types/lodash": "4.14.137",
     "@types/mocha": "5.2.7",
     "@types/node": "12.7.2",
+    "@types/path-browserify": "1.0.3",
     "@types/should": "13.0.0",
     "@types/sinon": "7.0.13",
     "babel-loader": "8.0.6",
@@ -56,6 +57,7 @@
     "lint-staged": "12.5.0",
     "lodash": "4.17.21",
     "mocha": "6.2.3",
+    "path-browserify": "1.0.1",
     "should": "13.2.3",
     "should-sinon": "0.0.6",
     "sinon": "7.4.1",
@@ -64,8 +66,7 @@
     "tslint": "5.4.3",
     "typescript": "4.3.5",
     "webpack": "4.39.2",
-    "webpack-cli": "3.3.7",
-    "weinre": "2.0.0-pre-I0Z7U9OV"
+    "webpack-cli": "3.3.7"
   },
   "engines": {
     "node": ">=12.0.0",