@etsoo/shared 1.2.8 → 1.2.10

package/README.md

@@ -136,13 +136,16 @@ Data type definitions and type safe functions. ListItemType, ListItemType1 and L
 |Func<R>|Function type, R is return type|
 |HAlign|Horizontal align|
 |HAlignEnum|Horizontal align enum|
+|IdDefaultType|Id default type|
 |IdType|Number and string combination id type|
 |IdItem|Item with id or id generator|
 |IdLabelItem|Item with id and label|
 |IdLabelType|Item with id and label dynamic type|
 |IdNameItem|Item with id and name|
+|IdTitleItem|Item with id and title|
 |KeyCollection|Key collection, like { key1: {}, key2: {} }|
 |Keys|Get specific type keys|
+|LabelDefaultType|Label default type|
 |MConstructor|Mixins constructor|
 |ObjType|Generic object type|
 |Optional|Make properties optional|
@@ -155,6 +158,7 @@ Data type definitions and type safe functions. ListItemType, ListItemType1 and L
 |SimpleObject|Simple object, string key, simple type and null value Record|
 |StringDictionary|String key, string value Record|
 |StringRecord|String key, unknown value Record|
+|TitleDefaultType|Title default type|
 |VAlign|Vertical align|
 |VAlignEnum|Vertical align enum|
 |Methods||
@@ -287,6 +291,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/DataTypes.d.ts

@@ -224,6 +224,15 @@ export declare namespace DataTypes {
          */
         name: string;
     };
+    /**
+     * Item with id and title property
+     */
+    type IdTitleItem<T extends IdType = number> = IdItem<T> & {
+        /**
+         * title field
+         */
+        title: string;
+    };
     /**
      * Item with id and label dynamic type
      */
@@ -396,7 +405,7 @@ export type ListType = DataTypes.IdLabelItem<number>;
  */
 export type ListType1 = DataTypes.IdLabelItem<string>;
 /**
- * List item with compatible id and name / label
+ * List item with compatible id and name / label / title
  */
 export type ListType2 = {
     id: DataTypes.IdType;
@@ -404,6 +413,8 @@ export type ListType2 = {
     label: string;
 } | {
     name: string;
+} | {
+    title: string;
 });
 /**
  * Id default type
@@ -417,3 +428,9 @@ export type IdDefaultType<T extends object> = T extends {
 export type LabelDefaultType<T extends object> = T extends {
     label: string;
 } ? DataTypes.Keys<T, string> & 'label' : DataTypes.Keys<T, string>;
+/**
+ * Title default type
+ */
+export type TitleDefaultType<T extends object> = T extends {
+    title: string;
+} ? DataTypes.Keys<T, string> & 'title' : DataTypes.Keys<T, string>;

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/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/DataTypes.d.ts

@@ -224,6 +224,15 @@ export declare namespace DataTypes {
          */
         name: string;
     };
+    /**
+     * Item with id and title property
+     */
+    type IdTitleItem<T extends IdType = number> = IdItem<T> & {
+        /**
+         * title field
+         */
+        title: string;
+    };
     /**
      * Item with id and label dynamic type
      */
@@ -396,7 +405,7 @@ export type ListType = DataTypes.IdLabelItem<number>;
  */
 export type ListType1 = DataTypes.IdLabelItem<string>;
 /**
- * List item with compatible id and name / label
+ * List item with compatible id and name / label / title
  */
 export type ListType2 = {
     id: DataTypes.IdType;
@@ -404,6 +413,8 @@ export type ListType2 = {
     label: string;
 } | {
     name: string;
+} | {
+    title: string;
 });
 /**
  * Id default type
@@ -417,3 +428,9 @@ export type IdDefaultType<T extends object> = T extends {
 export type LabelDefaultType<T extends object> = T extends {
     label: string;
 } ? DataTypes.Keys<T, string> & 'label' : DataTypes.Keys<T, string>;
+/**
+ * Title default type
+ */
+export type TitleDefaultType<T extends object> = T extends {
+    title: string;
+} ? DataTypes.Keys<T, string> & 'title' : DataTypes.Keys<T, string>;

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/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.8",
+    "version": "1.2.10",
     "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.3",
+        "@types/jest": "^29.5.4",
         "@types/lodash.isequal": "^4.5.6",
-        "jest": "^29.6.1",
-        "jest-environment-jsdom": "^29.6.1",
+        "jest": "^29.6.4",
+        "jest-environment-jsdom": "^29.6.4",
         "ts-jest": "^29.1.1",
-        "typescript": "^5.1.6"
+        "typescript": "^5.2.2"
     },
     "dependencies": {
         "lodash.isequal": "^4.5.0"

package/src/DataTypes.ts

@@ -278,6 +278,16 @@ export namespace DataTypes {
         name: string;
     };
 
+    /**
+     * Item with id and title property
+     */
+    export type IdTitleItem<T extends IdType = number> = IdItem<T> & {
+        /**
+         * title field
+         */
+        title: string;
+    };
+
     /**
      * Item with id and label dynamic type
      */
@@ -751,11 +761,11 @@ export type ListType = DataTypes.IdLabelItem<number>;
 export type ListType1 = DataTypes.IdLabelItem<string>;
 
 /**
- * List item with compatible id and name / label
+ * List item with compatible id and name / label / title
  */
 export type ListType2 = {
     id: DataTypes.IdType;
-} & ({ label: string } | { name: string });
+} & ({ label: string } | { name: string } | { title: string });
 
 /**
  * Id default type
@@ -770,3 +780,10 @@ export type IdDefaultType<T extends object> = T extends { id: number | string }
 export type LabelDefaultType<T extends object> = T extends { label: string }
     ? DataTypes.Keys<T, string> & 'label'
     : DataTypes.Keys<T, string>;
+
+/**
+ * Title default type
+ */
+export type TitleDefaultType<T extends object> = T extends { title: string }
+    ? DataTypes.Keys<T, string> & 'title'
+    : DataTypes.Keys<T, string>;

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/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;
+};