@etsoo/shared 1.2.79 → 1.2.81

package/.github/workflows/main.yml

@@ -11,6 +11,10 @@ on:
   # release:
   #  types: [created]
 
+permissions:
+  id-token: write # Required for OIDC
+  contents: read
+
 jobs:
   # Publish to NPM
   publish-npm:
@@ -44,6 +48,4 @@ jobs:
 
       # Publish to npm
       # For scoped package, make it public for free service
-      - run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.ETSOONpmToken }}
+      - run: npm publish

package/README.md

@@ -324,6 +324,7 @@ String and other related utilities
 |         objectKeys | Get two object's unqiue properties                                  |
 |      objectUpdated | Get the new object's updated fields contrast to the previous object |
 |     parseJsonArray | Try to parse JSON input to array                                    |
+|          parseName | Parse name data                                                     |
 |          parsePath | Parse path similar with node.js path.parse                          |
 |        parseString | Parse string (JSON) to specific type                                |
 |  removeEmptyValues | Remove empty values (null, undefined, '') from the input object     |

package/__tests__/Utils.ts

@@ -328,6 +328,16 @@ test("Tests for mergeClasses", () => {
   expect(Utils.mergeClasses("a", "", "b ", undefined, "c")).toBe("a b c");
 });
 
+test("Tests for formatName", () => {
+  expect(Utils.formatName("青岛亿速思维网络科技有限公司", 6)).toBe(
+    "青岛亿速思维"
+  );
+  expect(Utils.formatName("亿速思维（中国）网络科技有限公司", 6)).toBe(
+    "亿速思维（中国）"
+  );
+  expect(Utils.formatName("John Smith", 6)).toBe("John Smith");
+});
+
 test("Tests for getNestedValue", () => {
   const obj = { jsonData: { photoSize: [200, 100], supportResizing: true } };
   expect(Utils.getNestedValue(obj, "jsonData.supportResizing")).toBeTruthy();
@@ -356,6 +366,20 @@ test("Tests for getResult", () => {
   expect(valueResult).toBe(5);
 });
 
+test("Tests for parseName", () => {
+  const nd = Utils.parseName("王小明");
+  expect(nd.familyName).toBe("王");
+  expect(nd.givenName).toBe("小明");
+
+  const nd2 = Utils.parseName("John  Smith");
+  expect(nd2.familyName).toBe("Smith");
+  expect(nd2.givenName).toBe("John");
+
+  const nd3 = Utils.parseName("单  名");
+  expect(nd3.familyName).toBe("单");
+  expect(nd3.givenName).toBe("名");
+});
+
 test("Tests for parsePath, file only", () => {
   const result = Utils.parsePath("a.jpg");
   expect(result.root).toBe("");

package/lib/cjs/Utils.d.ts

@@ -132,6 +132,14 @@ export declare namespace Utils {
     export function excludeAsync<T extends {
         [P in D]: IdType;
     }, D extends string = "id">(items: Promise<T[] | undefined>, field: D, ...excludedValues: T[D][]): Promise<T[] | undefined>;
+    /**
+     * Format name
+     * @param name Input name
+     * @param maxChars Max chars
+     * @param maxParts Max parts (optional)
+     * @returns Formatted name
+     */
+    export function formatName(name: string, maxChars: number, maxParts?: number): string;
     /**
      * Format inital character to lower case or upper case
      * @param input Input string
@@ -306,6 +314,15 @@ export declare namespace Utils {
      * @param keepNull Keep null value or not
      */
     export function setNestedValue(data: object, name: string, value: unknown, keepNull?: boolean): void;
+    /**
+     * Parse name
+     * @param name Name
+     * @returns Result
+     */
+    export function parseName(name: string): {
+        familyName: string | undefined;
+        givenName: string | undefined;
+    };
     /**
      * Parse path similar with node.js path.parse
      * @param path Input path

package/lib/cjs/Utils.js

@@ -207,6 +207,63 @@ var Utils;
         return exclude(result, field, ...excludedValues);
     }
     Utils.excludeAsync = excludeAsync;
+    /**
+     * Format name
+     * @param name Input name
+     * @param maxChars Max chars
+     * @param maxParts Max parts (optional)
+     * @returns Formatted name
+     */
+    function formatName(name, maxChars, maxParts) {
+        name = name.trim();
+        const parts = name.split(/\s+/);
+        const max = maxParts ?? Math.floor(maxChars / 3);
+        const effectiveMax = max < 2 ? 2 : max;
+        if (parts.length >= effectiveMax) {
+            return parts.slice(0, effectiveMax).join(" ");
+        }
+        else if (name.length > maxChars) {
+            let endIndex = maxChars;
+            const brackets = {
+                "(": ")",
+                "（": "）",
+                "[": "]"
+            };
+            // Count unmatched brackets for each type
+            for (const [start, end] of Object.entries(brackets)) {
+                let count = 0;
+                // Count opening and closing brackets in the substring
+                for (let i = 0; i < maxChars; i++) {
+                    if (name[i] === start)
+                        count++;
+                    else if (name[i] === end)
+                        count--;
+                }
+                if (count > 0) {
+                    // Find matching end brackets
+                    for (let i = maxChars; i < name.length && count > 0; i++) {
+                        if (name[i] === start) {
+                            count++;
+                        }
+                        else if (name[i] === end) {
+                            count--;
+                            if (count === 0) {
+                                endIndex = i + 1;
+                            }
+                        }
+                    }
+                    if (count === 0) {
+                        return name.substring(0, endIndex);
+                    }
+                }
+            }
+            return name.substring(0, endIndex);
+        }
+        else {
+            return name;
+        }
+    }
+    Utils.formatName = formatName;
     /**
      * Format inital character to lower case or upper case
      * @param input Input string
@@ -578,7 +635,7 @@ var Utils;
     Utils.setLabels = (source, labels, reference) => {
         Object.keys(source).forEach((key) => {
             // Reference key
-            const labelKey = reference == null ? key : reference[key] ?? key;
+            const labelKey = reference == null ? key : (reference[key] ?? key);
             // Label
             const label = labels[labelKey];
             if (label != null) {
@@ -647,6 +704,42 @@ var Utils;
         }
     }
     Utils.setNestedValue = setNestedValue;
+    /**
+     * Parse name
+     * @param name Name
+     * @returns Result
+     */
+    function parseName(name) {
+        // Trim
+        name = name.trim();
+        let familyName;
+        let givenName;
+        if (name.containChinese() ||
+            name.containJapanese() ||
+            name.containKorean()) {
+            // CJK characters
+            if (name.length >= 2) {
+                familyName = name[0];
+                givenName = name.substring(1).trim();
+            }
+            else {
+                familyName = name;
+            }
+        }
+        else {
+            const parts = name.split(/\s+/);
+            const len = parts.length;
+            if (len >= 2) {
+                familyName = parts[len - 1];
+                givenName = parts[0];
+            }
+            else {
+                givenName = name;
+            }
+        }
+        return { familyName, givenName };
+    }
+    Utils.parseName = parseName;
     /**
      * Parse path similar with node.js path.parse
      * @param path Input path

package/lib/cjs/storage/IStorage.d.ts

@@ -63,5 +63,5 @@ export interface IStorage {
      * @param key Key name
      * @param data  Data, null for removal
      */
-    setPersistedData(key: string, data: unknown): void;
+    setPersistedData<T>(key: string, data: T): void;
 }

package/lib/cjs/storage/WindowStorage.d.ts

@@ -65,5 +65,5 @@ export declare class WindowStorage implements IStorage {
      * @param key Key name
      * @param data  Data, null for removal
      */
-    setPersistedData(key: string, data: unknown): void;
+    setPersistedData<T>(key: string, data: T): void;
 }

package/lib/mjs/Utils.d.ts

@@ -132,6 +132,14 @@ export declare namespace Utils {
     export function excludeAsync<T extends {
         [P in D]: IdType;
     }, D extends string = "id">(items: Promise<T[] | undefined>, field: D, ...excludedValues: T[D][]): Promise<T[] | undefined>;
+    /**
+     * Format name
+     * @param name Input name
+     * @param maxChars Max chars
+     * @param maxParts Max parts (optional)
+     * @returns Formatted name
+     */
+    export function formatName(name: string, maxChars: number, maxParts?: number): string;
     /**
      * Format inital character to lower case or upper case
      * @param input Input string
@@ -306,6 +314,15 @@ export declare namespace Utils {
      * @param keepNull Keep null value or not
      */
     export function setNestedValue(data: object, name: string, value: unknown, keepNull?: boolean): void;
+    /**
+     * Parse name
+     * @param name Name
+     * @returns Result
+     */
+    export function parseName(name: string): {
+        familyName: string | undefined;
+        givenName: string | undefined;
+    };
     /**
      * Parse path similar with node.js path.parse
      * @param path Input path

package/lib/mjs/Utils.js

@@ -204,6 +204,63 @@ export var Utils;
         return exclude(result, field, ...excludedValues);
     }
     Utils.excludeAsync = excludeAsync;
+    /**
+     * Format name
+     * @param name Input name
+     * @param maxChars Max chars
+     * @param maxParts Max parts (optional)
+     * @returns Formatted name
+     */
+    function formatName(name, maxChars, maxParts) {
+        name = name.trim();
+        const parts = name.split(/\s+/);
+        const max = maxParts ?? Math.floor(maxChars / 3);
+        const effectiveMax = max < 2 ? 2 : max;
+        if (parts.length >= effectiveMax) {
+            return parts.slice(0, effectiveMax).join(" ");
+        }
+        else if (name.length > maxChars) {
+            let endIndex = maxChars;
+            const brackets = {
+                "(": ")",
+                "（": "）",
+                "[": "]"
+            };
+            // Count unmatched brackets for each type
+            for (const [start, end] of Object.entries(brackets)) {
+                let count = 0;
+                // Count opening and closing brackets in the substring
+                for (let i = 0; i < maxChars; i++) {
+                    if (name[i] === start)
+                        count++;
+                    else if (name[i] === end)
+                        count--;
+                }
+                if (count > 0) {
+                    // Find matching end brackets
+                    for (let i = maxChars; i < name.length && count > 0; i++) {
+                        if (name[i] === start) {
+                            count++;
+                        }
+                        else if (name[i] === end) {
+                            count--;
+                            if (count === 0) {
+                                endIndex = i + 1;
+                            }
+                        }
+                    }
+                    if (count === 0) {
+                        return name.substring(0, endIndex);
+                    }
+                }
+            }
+            return name.substring(0, endIndex);
+        }
+        else {
+            return name;
+        }
+    }
+    Utils.formatName = formatName;
     /**
      * Format inital character to lower case or upper case
      * @param input Input string
@@ -575,7 +632,7 @@ export var Utils;
     Utils.setLabels = (source, labels, reference) => {
         Object.keys(source).forEach((key) => {
             // Reference key
-            const labelKey = reference == null ? key : reference[key] ?? key;
+            const labelKey = reference == null ? key : (reference[key] ?? key);
             // Label
             const label = labels[labelKey];
             if (label != null) {
@@ -644,6 +701,42 @@ export var Utils;
         }
     }
     Utils.setNestedValue = setNestedValue;
+    /**
+     * Parse name
+     * @param name Name
+     * @returns Result
+     */
+    function parseName(name) {
+        // Trim
+        name = name.trim();
+        let familyName;
+        let givenName;
+        if (name.containChinese() ||
+            name.containJapanese() ||
+            name.containKorean()) {
+            // CJK characters
+            if (name.length >= 2) {
+                familyName = name[0];
+                givenName = name.substring(1).trim();
+            }
+            else {
+                familyName = name;
+            }
+        }
+        else {
+            const parts = name.split(/\s+/);
+            const len = parts.length;
+            if (len >= 2) {
+                familyName = parts[len - 1];
+                givenName = parts[0];
+            }
+            else {
+                givenName = name;
+            }
+        }
+        return { familyName, givenName };
+    }
+    Utils.parseName = parseName;
     /**
      * Parse path similar with node.js path.parse
      * @param path Input path

package/lib/mjs/storage/IStorage.d.ts

@@ -63,5 +63,5 @@ export interface IStorage {
      * @param key Key name
      * @param data  Data, null for removal
      */
-    setPersistedData(key: string, data: unknown): void;
+    setPersistedData<T>(key: string, data: T): void;
 }

package/lib/mjs/storage/WindowStorage.d.ts

@@ -65,5 +65,5 @@ export declare class WindowStorage implements IStorage {
      * @param key Key name
      * @param data  Data, null for removal
      */
-    setPersistedData(key: string, data: unknown): void;
+    setPersistedData<T>(key: string, data: T): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etsoo/shared",
-  "version": "1.2.79",
+  "version": "1.2.81",
   "description": "TypeScript shared utilities and functions",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",
@@ -36,10 +36,10 @@
   },
   "homepage": "https://github.com/ETSOO/Shared#readme",
   "devDependencies": {
-    "@types/node": "^24.10.0",
-    "@vitejs/plugin-react": "^5.1.0",
-    "jsdom": "^27.1.0",
+    "@types/node": "^25.5.0",
+    "@vitejs/plugin-react": "^6.0.1",
+    "jsdom": "^29.0.1",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.7"
+    "vitest": "^4.1.2"
   }
 }

package/src/Utils.ts

@@ -355,6 +355,70 @@ export namespace Utils {
     return exclude(result, field, ...excludedValues);
   }
 
+  /**
+   * Format name
+   * @param name Input name
+   * @param maxChars Max chars
+   * @param maxParts Max parts (optional)
+   * @returns Formatted name
+   */
+  export function formatName(
+    name: string,
+    maxChars: number,
+    maxParts?: number
+  ): string {
+    name = name.trim();
+
+    const parts = name.split(/\s+/);
+
+    const max = maxParts ?? Math.floor(maxChars / 3);
+    const effectiveMax = max < 2 ? 2 : max;
+
+    if (parts.length >= effectiveMax) {
+      return parts.slice(0, effectiveMax).join(" ");
+    } else if (name.length > maxChars) {
+      let endIndex = maxChars;
+      const brackets: Record<string, string> = {
+        "(": ")",
+        "（": "）",
+        "[": "]"
+      };
+
+      // Count unmatched brackets for each type
+      for (const [start, end] of Object.entries(brackets)) {
+        let count = 0;
+
+        // Count opening and closing brackets in the substring
+        for (let i = 0; i < maxChars; i++) {
+          if (name[i] === start) count++;
+          else if (name[i] === end) count--;
+        }
+
+        if (count > 0) {
+          // Find matching end brackets
+          for (let i = maxChars; i < name.length && count > 0; i++) {
+            if (name[i] === start) {
+              count++;
+            } else if (name[i] === end) {
+              count--;
+              if (count === 0) {
+                endIndex = i + 1;
+              }
+            }
+          }
+
+          if (count === 0) {
+            return name.substring(0, endIndex);
+          }
+        }
+      }
+
+      return name.substring(0, endIndex);
+    } else {
+      return name;
+    }
+  }
+
   /**
    * Format inital character to lower case or upper case
    * @param input Input string
@@ -823,7 +887,7 @@ export namespace Utils {
   ) => {
     Object.keys(source).forEach((key) => {
       // Reference key
-      const labelKey = reference == null ? key : reference[key] ?? key;
+      const labelKey = reference == null ? key : (reference[key] ?? key);
 
       // Label
       const label = labels[labelKey];
@@ -899,6 +963,44 @@ export namespace Utils {
     }
   }
 
+  /**
+   * Parse name
+   * @param name Name
+   * @returns Result
+   */
+  export function parseName(name: string) {
+    // Trim
+    name = name.trim();
+
+    let familyName: string | undefined;
+    let givenName: string | undefined;
+
+    if (
+      name.containChinese() ||
+      name.containJapanese() ||
+      name.containKorean()
+    ) {
+      // CJK characters
+      if (name.length >= 2) {
+        familyName = name[0];
+        givenName = name.substring(1).trim();
+      } else {
+        familyName = name;
+      }
+    } else {
+      const parts = name.split(/\s+/);
+      const len = parts.length;
+      if (len >= 2) {
+        familyName = parts[len - 1];
+        givenName = parts[0];
+      } else {
+        givenName = name;
+      }
+    }
+
+    return { familyName, givenName };
+  }
+
   /**
    * Parse path similar with node.js path.parse
    * @param path Input path
@@ -925,8 +1027,8 @@ export namespace Utils {
         index1 === -1
           ? index2
           : index2 === -1
-          ? index1
-          : Math.min(index1, index2);
+            ? index1
+            : Math.min(index1, index2);
       root = path.substring(0, index + 1);
       dir = path.substring(0, lastIndex);
       if (dir === "") dir = root;

package/src/storage/IStorage.ts

@@ -73,5 +73,5 @@ export interface IStorage {
    * @param key Key name
    * @param data  Data, null for removal
    */
-  setPersistedData(key: string, data: unknown): void;
+  setPersistedData<T>(key: string, data: T): void;
 }

package/src/storage/WindowStorage.ts

@@ -141,7 +141,7 @@ export class WindowStorage implements IStorage {
    * @param key Key name
    * @param data  Data, null for removal
    */
-  setPersistedData(key: string, data: unknown) {
+  setPersistedData<T>(key: string, data: T) {
     StorageUtils.setLocalData(key, data);
   }
 }