@etsoo/shared 1.2.7 → 1.2.9

package/README.md

@@ -41,6 +41,9 @@ Content disposition of HTTP
 |Methods||
 |format|Format to standard output|
 
+## DataError
+Error with custom data
+
 ## EColor
 Etsoo implmented Color
 
@@ -284,6 +287,7 @@ String and other related utilities
 |objectEqual|Test two objects are equal or not|
 |objectKeys|Get two object's unqiue properties|
 |objectUpdated|Get the new object's updated fields contrast to the previous object|
+|parsePath|Parse path similar with node.js path.parse|
 |parseString|Parse string (JSON) to specific type|
 |removeNonLetters|Remove non letters (0-9, a-z, A-Z)|
 |replaceNullOrEmpty|Replace null or empty with default value|

package/__tests__/Utils.ts

@@ -245,6 +245,42 @@ test('Tests for getResult', () => {
     expect(valueResult).toBe(5);
 });
 
+test('Tests for parsePath, file only', () => {
+    const result = Utils.parsePath('a.jpg');
+    expect(result.root).toBe('');
+    expect(result.dir).toBe('');
+    expect(result.base).toBe('a.jpg');
+    expect(result.ext).toBe('.jpg');
+    expect(result.name).toBe('a');
+});
+
+test('Tests for parsePath, root file only', () => {
+    const result = Utils.parsePath('/a.JPG');
+    expect(result.root).toBe('/');
+    expect(result.dir).toBe('/');
+    expect(result.base).toBe('a.JPG');
+    expect(result.ext).toBe('.JPG');
+    expect(result.name).toBe('a');
+});
+
+test('Tests for parsePath, Linux path', () => {
+    const result = Utils.parsePath('/home/user/dir/file.txt');
+    expect(result.root).toBe('/');
+    expect(result.dir).toBe('/home/user/dir');
+    expect(result.base).toBe('file.txt');
+    expect(result.ext).toBe('.txt');
+    expect(result.name).toBe('file');
+});
+
+test('Tests for parsePath, Windows path', () => {
+    const result = Utils.parsePath('C:\\path\\dir\\file.txt');
+    expect(result.root).toBe('C:\\');
+    expect(result.dir).toBe('C:\\path\\dir');
+    expect(result.base).toBe('file.txt');
+    expect(result.ext).toBe('.txt');
+    expect(result.name).toBe('file');
+});
+
 test('Tests for sortByFavor', () => {
     const items = [1, 2, 3, 4, 5, 6, 7];
     expect(Utils.sortByFavor(items, [5, 1, 3])).toStrictEqual([

package/lib/cjs/NumberUtils.js

@@ -60,7 +60,7 @@ var NumberUtils;
         const i = size === 0 ? 0 : Math.floor(Math.log(size) / Math.log(1024));
         return ((size / Math.pow(1024, i)).toFixed(fractionDigits) +
             ' ' +
-            ['B', 'KB', 'MB', 'GB', 'TB'][i]);
+            ['B', 'KB', 'MB', 'GB', 'TB', 'PB'][i]);
     }
     NumberUtils.formatFileSize = formatFileSize;
     /**

package/lib/cjs/Utils.d.ts

@@ -1,4 +1,5 @@
 import { DataTypes } from './DataTypes';
+import { ParsedPath } from './types/ParsedPath';
 declare global {
     interface String {
         /**
@@ -247,6 +248,11 @@ export declare namespace Utils {
      * @param firstOnly Only convert the first word to upper case
      */
     const snakeNameToWord: (name: string, firstOnly?: boolean) => string;
+    /**
+     * Parse path similar with node.js path.parse
+     * @param path Input path
+     */
+    const parsePath: (path: string) => ParsedPath;
     /**
      * Sort array by favored values
      * @param items Items

package/lib/cjs/Utils.js

@@ -484,6 +484,44 @@ var Utils;
             return -1;
         return n1 - n2;
     }
+    /**
+     * Parse path similar with node.js path.parse
+     * @param path Input path
+     */
+    Utils.parsePath = (path) => {
+        // Two formats or mixed
+        // /home/user/dir/file.txt
+        // C:\\path\\dir\\file.txt
+        const lastIndex = Math.max(path.lastIndexOf('/'), path.lastIndexOf('\\'));
+        let root = '', dir = '', base, ext, name;
+        if (lastIndex === -1) {
+            base = path;
+        }
+        else {
+            base = path.substring(lastIndex + 1);
+            const index1 = path.indexOf('/');
+            const index2 = path.indexOf('\\');
+            const index = index1 === -1
+                ? index2
+                : index2 === -1
+                    ? index1
+                    : Math.min(index1, index2);
+            root = path.substring(0, index + 1);
+            dir = path.substring(0, lastIndex);
+            if (dir === '')
+                dir = root;
+        }
+        const extIndex = base.lastIndexOf('.');
+        if (extIndex === -1) {
+            name = base;
+            ext = '';
+        }
+        else {
+            name = base.substring(0, extIndex);
+            ext = base.substring(extIndex);
+        }
+        return { root, dir, base, ext, name };
+    };
     /**
      * Sort array by favored values
      * @param items Items

package/lib/cjs/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types/ContentDisposition';
+export * from './types/DataError';
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
 export * from './types/EHistory';

package/lib/cjs/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types/ContentDisposition"), exports);
+__exportStar(require("./types/DataError"), exports);
 __exportStar(require("./types/DelayedExecutorType"), exports);
 __exportStar(require("./types/EColor"), exports);
 __exportStar(require("./types/EHistory"), exports);

package/lib/cjs/types/DataError.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Error with custom data
+ * Other information can be hold by 'name', 'cause', and 'stack' property
+ *
+ */
+export declare class DataError<T = Record<string, unknown>> extends Error {
+    /**
+     * Custom data
+     */
+    readonly data: T;
+    /**
+     * Constructor
+     * @param message Error message
+     * @param data Custom data
+     */
+    constructor(message: string, data: T);
+}

package/lib/cjs/types/DataError.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataError = void 0;
+/**
+ * Error with custom data
+ * Other information can be hold by 'name', 'cause', and 'stack' property
+ *
+ */
+class DataError extends Error {
+    /**
+     * Constructor
+     * @param message Error message
+     * @param data Custom data
+     */
+    constructor(message, data) {
+        super(message);
+        this.data = data;
+        // Set the prototype explicitly to ensure instanceof works correctly
+        Object.setPrototypeOf(this, DataError.prototype);
+    }
+}
+exports.DataError = DataError;

package/lib/cjs/types/ParsedPath.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Similar result with node.js path.parse(path)
+ */
+export type ParsedPath = {
+    root: string;
+    dir: string;
+    base: string;
+    ext: string;
+    name: string;
+};

package/lib/cjs/types/ParsedPath.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/mjs/NumberUtils.js

@@ -57,7 +57,7 @@ export var NumberUtils;
         const i = size === 0 ? 0 : Math.floor(Math.log(size) / Math.log(1024));
         return ((size / Math.pow(1024, i)).toFixed(fractionDigits) +
             ' ' +
-            ['B', 'KB', 'MB', 'GB', 'TB'][i]);
+            ['B', 'KB', 'MB', 'GB', 'TB', 'PB'][i]);
     }
     NumberUtils.formatFileSize = formatFileSize;
     /**

package/lib/mjs/Utils.d.ts

@@ -1,4 +1,5 @@
 import { DataTypes } from './DataTypes';
+import { ParsedPath } from './types/ParsedPath';
 declare global {
     interface String {
         /**
@@ -247,6 +248,11 @@ export declare namespace Utils {
      * @param firstOnly Only convert the first word to upper case
      */
     const snakeNameToWord: (name: string, firstOnly?: boolean) => string;
+    /**
+     * Parse path similar with node.js path.parse
+     * @param path Input path
+     */
+    const parsePath: (path: string) => ParsedPath;
     /**
      * Sort array by favored values
      * @param items Items

package/lib/mjs/Utils.js

@@ -478,6 +478,44 @@ export var Utils;
             return -1;
         return n1 - n2;
     }
+    /**
+     * Parse path similar with node.js path.parse
+     * @param path Input path
+     */
+    Utils.parsePath = (path) => {
+        // Two formats or mixed
+        // /home/user/dir/file.txt
+        // C:\\path\\dir\\file.txt
+        const lastIndex = Math.max(path.lastIndexOf('/'), path.lastIndexOf('\\'));
+        let root = '', dir = '', base, ext, name;
+        if (lastIndex === -1) {
+            base = path;
+        }
+        else {
+            base = path.substring(lastIndex + 1);
+            const index1 = path.indexOf('/');
+            const index2 = path.indexOf('\\');
+            const index = index1 === -1
+                ? index2
+                : index2 === -1
+                    ? index1
+                    : Math.min(index1, index2);
+            root = path.substring(0, index + 1);
+            dir = path.substring(0, lastIndex);
+            if (dir === '')
+                dir = root;
+        }
+        const extIndex = base.lastIndexOf('.');
+        if (extIndex === -1) {
+            name = base;
+            ext = '';
+        }
+        else {
+            name = base.substring(0, extIndex);
+            ext = base.substring(extIndex);
+        }
+        return { root, dir, base, ext, name };
+    };
     /**
      * Sort array by favored values
      * @param items Items

package/lib/mjs/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types/ContentDisposition';
+export * from './types/DataError';
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
 export * from './types/EHistory';

package/lib/mjs/index.js

@@ -1,4 +1,5 @@
 export * from './types/ContentDisposition';
+export * from './types/DataError';
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
 export * from './types/EHistory';

package/lib/mjs/types/DataError.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Error with custom data
+ * Other information can be hold by 'name', 'cause', and 'stack' property
+ *
+ */
+export declare class DataError<T = Record<string, unknown>> extends Error {
+    /**
+     * Custom data
+     */
+    readonly data: T;
+    /**
+     * Constructor
+     * @param message Error message
+     * @param data Custom data
+     */
+    constructor(message: string, data: T);
+}

package/lib/mjs/types/DataError.js

@@ -0,0 +1,18 @@
+/**
+ * Error with custom data
+ * Other information can be hold by 'name', 'cause', and 'stack' property
+ *
+ */
+export class DataError extends Error {
+    /**
+     * Constructor
+     * @param message Error message
+     * @param data Custom data
+     */
+    constructor(message, data) {
+        super(message);
+        this.data = data;
+        // Set the prototype explicitly to ensure instanceof works correctly
+        Object.setPrototypeOf(this, DataError.prototype);
+    }
+}

package/lib/mjs/types/ParsedPath.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Similar result with node.js path.parse(path)
+ */
+export type ParsedPath = {
+    root: string;
+    dir: string;
+    base: string;
+    ext: string;
+    name: string;
+};

package/lib/mjs/types/ParsedPath.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.2.7",
+    "version": "1.2.9",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -54,12 +54,12 @@
     },
     "homepage": "https://github.com/ETSOO/Shared#readme",
     "devDependencies": {
-        "@types/jest": "^29.5.2",
+        "@types/jest": "^29.5.4",
         "@types/lodash.isequal": "^4.5.6",
-        "jest": "^29.5.0",
-        "jest-environment-jsdom": "^29.5.0",
-        "ts-jest": "^29.1.0",
-        "typescript": "^5.1.3"
+        "jest": "^29.6.4",
+        "jest-environment-jsdom": "^29.6.4",
+        "ts-jest": "^29.1.1",
+        "typescript": "^5.2.2"
     },
     "dependencies": {
         "lodash.isequal": "^4.5.0"

package/src/NumberUtils.ts

@@ -77,7 +77,7 @@ export namespace NumberUtils {
         return (
             (size / Math.pow(1024, i)).toFixed(fractionDigits) +
             ' ' +
-            ['B', 'KB', 'MB', 'GB', 'TB'][i]
+            ['B', 'KB', 'MB', 'GB', 'TB', 'PB'][i]
         );
     }
 

package/src/Utils.ts

@@ -1,6 +1,7 @@
 import { DataTypes } from './DataTypes';
 import isEqual from 'lodash.isequal';
 import { DateUtils } from './DateUtils';
+import { ParsedPath } from './types/ParsedPath';
 
 declare global {
     interface String {
@@ -672,6 +673,54 @@ export namespace Utils {
         return n1 - n2;
     }
 
+    /**
+     * Parse path similar with node.js path.parse
+     * @param path Input path
+     */
+    export const parsePath = (path: string): ParsedPath => {
+        // Two formats or mixed
+        // /home/user/dir/file.txt
+        // C:\\path\\dir\\file.txt
+        const lastIndex = Math.max(
+            path.lastIndexOf('/'),
+            path.lastIndexOf('\\')
+        );
+
+        let root = '',
+            dir = '',
+            base: string,
+            ext: string,
+            name: string;
+
+        if (lastIndex === -1) {
+            base = path;
+        } else {
+            base = path.substring(lastIndex + 1);
+            const index1 = path.indexOf('/');
+            const index2 = path.indexOf('\\');
+            const index =
+                index1 === -1
+                    ? index2
+                    : index2 === -1
+                    ? index1
+                    : Math.min(index1, index2);
+            root = path.substring(0, index + 1);
+            dir = path.substring(0, lastIndex);
+            if (dir === '') dir = root;
+        }
+
+        const extIndex = base.lastIndexOf('.');
+        if (extIndex === -1) {
+            name = base;
+            ext = '';
+        } else {
+            name = base.substring(0, extIndex);
+            ext = base.substring(extIndex);
+        }
+
+        return { root, dir, base, ext, name };
+    };
+
     /**
      * Sort array by favored values
      * @param items Items

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from './types/ContentDisposition';
+export * from './types/DataError';
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
 export * from './types/EHistory';

package/src/types/DataError.ts

@@ -0,0 +1,25 @@
+/**
+ * Error with custom data
+ * Other information can be hold by 'name', 'cause', and 'stack' property
+ *
+ */
+export class DataError<T = Record<string, unknown>> extends Error {
+    /**
+     * Custom data
+     */
+    public readonly data: T;
+
+    /**
+     * Constructor
+     * @param message Error message
+     * @param data Custom data
+     */
+    constructor(message: string, data: T) {
+        super(message);
+
+        this.data = data;
+
+        // Set the prototype explicitly to ensure instanceof works correctly
+        Object.setPrototypeOf(this, DataError.prototype);
+    }
+}

package/src/types/ParsedPath.ts

@@ -0,0 +1,10 @@
+/**
+ * Similar result with node.js path.parse(path)
+ */
+export type ParsedPath = {
+    root: string;
+    dir: string;
+    base: string;
+    ext: string;
+    name: string;
+};