@vef-framework/shared 2.0.10 → 2.1.0

package/dist/types/utils/path.d.ts

@@ -1,76 +1,13 @@
 import { default as path } from 'path-browserify';
-declare const pathSeparator: string;
 export type PathObject = path.PathObject;
-/**
- * Get the base name from a path
- *
- * @param path The path
- * @param keepExt Whether to keep the extension
- * @returns The base name
- */
-export declare function getBaseName(path: string, keepExt?: boolean): string;
-/**
- * Get the extension name from a path
- *
- * @param path The path
- * @returns The extension name
- */
-export declare function getExtName(path: string): string;
-/**
- * Get the dir name from a path
- *
- * @param path The path
- * @returns The dir name
- */
-export declare function getDirName(path: string): string;
-/**
- * Joins paths
- *
- * @param paths The paths
- * @returns The joined path
- */
+export declare function getBaseName(filePath: string, keepExt?: boolean): string;
+export declare function getExtName(filePath: string): string;
+export declare function getDirName(filePath: string): string;
 export declare function joinPaths(...paths: string[]): string;
-/**
- * Checks if a path is absolute
- *
- * @param path The path
- * @returns Whether the path is absolute
- */
-export declare function isAbsolutePath(path: string): boolean;
-/**
- * Normalizes a path
- *
- * @param path The path
- * @returns The normalized path
- */
-export declare function normalizePath(path: string): string;
-/**
- * Parse a path
- *
- * @param path The path
- * @returns The parsed path
- */
-export declare function parsePath(path: string): PathObject;
-/**
- * Format a path object
- *
- * @param pathObject The path object
- * @returns The formatted path
- */
+export declare function isAbsolutePath(filePath: string): boolean;
+export declare function normalizePath(filePath: string): string;
+export declare function parsePath(filePath: string): PathObject;
 export declare function formatPath(pathObject: PathObject): string;
-/**
- * Get the relative path from one path to another
- *
- * @param from The starting path
- * @param to The destination path
- * @returns The relative path
- */
 export declare function getRelativePath(from: string, to: string): string;
-/**
- * Resolve a path
- *
- * @param pathSegments The path segments
- * @returns The resolved path
- */
 export declare function resolvePath(...pathSegments: string[]): string;
-export { pathSeparator };
+export declare const pathSeparator: string;

package/dist/types/utils/pinyin.d.ts

@@ -1,5 +1,5 @@
-import { AnyObject, If, IsOptionalKeyOf, IsRequiredKeyOf, IsString, Prettify } from '../types';
-export type WithPinyin<T extends AnyObject, K extends keyof T & string> = Prettify<WithPinyinInternal<T, K>>;
+import { AnyObject, If, IsOptionalKeyOf, IsRequiredKeyOf, IsString, Simplify } from '../types';
+export type WithPinyin<T extends AnyObject, K extends keyof T & string> = Simplify<WithPinyinInternal<T, K>>;
 type WithPinyinInternal<T extends AnyObject, K extends keyof T & string> = T & {
     [Key in K as If<IsRequiredKeyOf<T, Key>, If<IsString<T[Key]>, `${Key}Pinyin`, never>, never>]: string;
 } & {
@@ -29,7 +29,6 @@ export declare function getPinyinInitials(text: string): string[];
  * @param obj - The source object
  * @param keys - The keys to add pinyin fields for
  * @returns A new object with additional pinyin and pinyin initials fields
- *
  * @example
  * ```ts
  * const user = { name: "张三", age: 25 };

package/dist/types/utils/security.d.ts

@@ -1,10 +1,52 @@
+/**
+ * Encode a string to XOR-encrypted byte array.
+ *
+ * @param plainText The plain text string to encode
+ * @returns The encrypted byte array
+ */
+export declare function obfuscateEncode(plainText: string): Uint8Array;
+/**
+ * Decode an XOR-encrypted byte array to string.
+ *
+ * @param encoded The encrypted byte array
+ * @returns The decoded string
+ */
+export declare function obfuscateDecode(encoded: Uint8Array | number[]): string;
+/**
+ * Encode a string to XOR-encrypted hex string.
+ *
+ * @param plainText The plain text string to encode
+ * @returns The encrypted hex string
+ */
+export declare function obfuscateEncodeToHex(plainText: string): string;
+/**
+ * Decode an XOR-encrypted hex string to plain text.
+ *
+ * @param hexString The encrypted hex string
+ * @returns The decoded string
+ */
+export declare function obfuscateDecodeFromHex(hexString: string): string;
+/**
+ * Encode a string to XOR-encrypted base64 string.
+ *
+ * @param plainText The plain text string to encode
+ * @returns The encrypted base64 string
+ */
+export declare function obfuscateEncodeToBase64(plainText: string): string;
+/**
+ * Decode an XOR-encrypted base64 string to plain text.
+ *
+ * @param base64String The encrypted base64 string
+ * @returns The decoded string
+ */
+export declare function obfuscateDecodeFromBase64(base64String: string): string;
 /**
  * Encrypts a given value using RSA encryption with the given public key.
  *
  * @param value The value to encrypt
  * @param publicKey The public key to use for encryption
  * @returns The encrypted value
- * @throws If the encryption fails
+ * @throws If the encryption fails or inputs are invalid
  */
 export declare function encryptUsingRSA(value: string, publicKey: string): string;
 /**
@@ -13,6 +55,6 @@ export declare function encryptUsingRSA(value: string, publicKey: string): strin
  * @param value The value to decrypt
  * @param privateKey The private key to use for decryption
  * @returns The decrypted value
- * @throws If the decryption fails
+ * @throws If the decryption fails or inputs are invalid
  */
 export declare function decryptUsingRSA(value: string, privateKey: string): string;

package/dist/types/utils/string.d.ts

@@ -5,3 +5,11 @@
  * @returns - The constant case string
  */
 export declare function constantCase(value: string): string;
+/**
+ * Convert an unknown value to string
+ *
+ * @param value - The value to stringify
+ * @param emptyForNullish - Whether to return empty string for null/undefined (default: true)
+ * @returns - The string representation
+ */
+export declare function stringify(value: unknown): string;

package/dist/types/utils/table.d.ts

@@ -0,0 +1,25 @@
+import { AnyObject } from '../types';
+/**
+ * Comparison mode for reference values
+ */
+export type CompareMode = "reference" | "shallow" | "deep";
+/**
+ * Options for shouldUpdateByKeys
+ */
+export interface ShouldUpdateByKeysOptions {
+    /**
+     * Comparison mode for reference values
+     * - "reference": Use strict equality (===)
+     * - "shallow": Use shallow comparison
+     * - "deep": Use deep comparison
+     *
+     * @default "reference"
+     */
+    compare?: CompareMode;
+}
+/**
+ * Creates a function that checks if any specified keys differ between two objects.
+ * Useful for Table's shouldCellUpdate prop to optimize re-renders.
+ */
+export declare function shouldUpdateByKeys<T = AnyObject, const K extends keyof T = keyof T>(options: ShouldUpdateByKeysOptions, ...keys: K[]): (next: T, prev: T) => boolean;
+export declare function shouldUpdateByKeys<T = AnyObject, const K extends keyof T = keyof T>(...keys: K[]): (next: T, prev: T) => boolean;

package/dist/types/utils/task.d.ts

@@ -1,6 +1,4 @@
 /**
- * Schedule a microtask.
- *
- * @param task - The task to schedule.
+ * Schedule a microtask with fallback for older environments.
  */
 export declare function scheduleMicrotask(task: () => void): void;

package/dist/types/utils/tree.d.ts

@@ -5,16 +5,19 @@ import { AnyObject, Except, MaybeUndefined, SetRequired } from '../types';
 export interface FlattenTreeOptions<TNode extends AnyObject = AnyObject, TTransformedNode = FlattenedNode<TNode>> {
     /**
      * The key name for children property
+     *
      * @default 'children'
      */
     childrenKey?: keyof TNode;
     /**
      * Whether to include parent node reference
+     *
      * @default false
      */
     includeParent?: boolean;
     /**
      * Whether to include level information
+     *
      * @default false
      */
     includeLevel?: boolean;
@@ -77,17 +80,20 @@ export interface BuildTreeOptions<TNode extends AnyObject = AnyObject, TTransfor
     /**
      * Accessor for node id
      * Can be a property name or a getter function
+     *
      * @default 'id'
      */
     idKey?: KeyAccessor<TNode>;
     /**
      * Accessor for parent id
      * Can be a property name or a getter function
+     *
      * @default 'parentId'
      */
     parentIdKey?: KeyAccessor<TNode>;
     /**
      * The key name for children property
+     *
      * @default 'children'
      */
     childrenKey?: TChildrenKey;
@@ -138,11 +144,13 @@ export interface TraverseTreeOptions<TNode extends AnyObject> {
      * Traversal strategy
      * - 'dfs': Depth-First Search - visit nodes depth-wise (parent -> children -> siblings)
      * - 'bfs': Breadth-First Search - visit nodes level-wise (all nodes at level N before level N+1)
+     *
      * @default 'dfs'
      */
     strategy?: "dfs" | "bfs";
     /**
      * The key name for children property
+     *
      * @default 'children'
      */
     childrenKey?: keyof TNode;

package/dist/types/utils/zod.d.ts

@@ -1 +1,2 @@
 export { z } from 'zod';
+export type { ZodError, ZodIssue, ZodSchema, ZodType } from 'zod';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vef-framework/shared",
   "type": "module",
-  "version": "2.0.10",
+  "version": "2.1.0",
   "private": false,
   "description": "Shared utilities for VEF framework",
   "author": {
@@ -20,7 +20,7 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "source": "./src/index.ts",
+      "vef": "./src/index.ts",
       "import": {
         "types": "./dist/types/index.d.ts",
         "default": "./dist/es/index.js"
@@ -45,26 +45,26 @@
     "access": "public"
   },
   "dependencies": {
-    "@fingerprintjs/fingerprintjs": "^5.0.1",
-    "@paralleldrive/cuid2": "^3.1.0",
-    "@pinyin-pro/data": "^1.2.0",
+    "@fingerprintjs/fingerprintjs": "^5.1.0",
+    "@paralleldrive/cuid2": "^3.3.0",
+    "@pinyin-pro/data": "^1.3.1",
     "colord": "^2.9.3",
-    "dayjs": "^1.11.19",
+    "dayjs": "^1.11.20",
     "jsencrypt": "^3.5.4",
     "klona": "^2.0.6",
     "mitt": "^3.0.1",
     "path-browserify": "^1.0.1",
-    "pinyin-pro": "^3.27.0",
-    "qs": "^6.14.0",
-    "radashi": "^12.7.1",
+    "pinyin-pro": "^3.28.0",
+    "qs": "^6.15.0",
+    "radashi": "^12.7.2",
     "stacktrace-js": "^2.0.2",
-    "tiny-lru": "^11.4.5",
-    "type-fest": "^5.2.0",
-    "zod": "^4.1.13"
+    "tiny-lru": "^11.4.7",
+    "type-fest": "^5.5.0",
+    "zod": "^4.3.6"
   },
   "devDependencies": {
     "@types/path-browserify": "^1.0.3",
-    "@types/qs": "^6.14.0"
+    "@types/qs": "^6.15.0"
   },
   "scripts": {
     "clean": "rimraf dist",