@gx-design-vue/pro-utils 0.2.0-beta.8 → 0.2.0-beta.81

package/dist/base64/index.d.ts

@@ -0,0 +1,20 @@
+export default class Base64 {
+    _keyStr: string;
+    constructor();
+    _utf8_encode(string: string): string;
+    _utf8_decode(utftext: string): string;
+    /**
+     * @Author      gx12358
+     * @DateTime    2024/12/21
+     * @lastTime    2024/12/21
+     * @description 加密方法
+     */
+    encode(input: string): string;
+    /**
+     * @Author      gx12358
+     * @DateTime    2024/12/21
+     * @lastTime    2024/12/21
+     * @description 解密
+     */
+    decode(input: string): string;
+}

package/dist/cloneDeep/cloneDeepWith.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Deeply clones the given object.
+ *
+ * You can customize the deep cloning process using the `cloneValue` function.
+ * The function takes the current value `value`, the property name `key`, and the entire object `obj` as arguments.
+ * If the function returns a value, that value is used;
+ * if it returns `undefined`, the default cloning method is used.
+ *
+ * @template T - The type of the object.
+ * @param {T} obj - The object to clone.
+ * @param {Function} [cloneValue] - A function to customize the cloning process.
+ * @returns {T} - A deep clone of the given object.
+ *
+ * @example
+ * // Clone a primitive value
+ * const num = 29;
+ * const clonedNum = cloneDeepWith(num);
+ * console.log(clonedNum); // 29
+ * console.log(clonedNum === num); // true
+ *
+ * @example
+ * // Clone an object with a customizer
+ * const obj = { a: 1, b: 2 };
+ * const clonedObj = cloneDeepWith(obj, (value) => {
+ *   if (typeof value === 'number') {
+ *     return value * 2; // Double the number
+ *   }
+ * });
+ * console.log(clonedObj); // { a: 2, b: 4 }
+ * console.log(clonedObj === obj); // false
+ *
+ * @example
+ * // Clone an array with a customizer
+ * const arr = [1, 2, 3];
+ * const clonedArr = cloneDeepWith(arr, (value) => {
+ *   return value + 1; // Increment each value
+ * });
+ * console.log(clonedArr); // [2, 3, 4]
+ * console.log(clonedArr === arr); // false
+ */
+export declare function cloneDeepWith<T>(obj: T, cloneValue: (value: any, key: PropertyKey | undefined, obj: T, stack: Map<any, any>) => any): T;
+export declare function cloneDeepWithImpl<T>(valueToClone: any, keyToClone: PropertyKey | undefined, objectToClone: T, stack?: Map<any, any>, cloneValue?: ((value: any, key: PropertyKey | undefined, obj: T, stack: Map<any, any>) => any) | undefined): T;
+export declare function copyProperties<T>(target: any, source: any, objectToClone?: T, stack?: Map<any, any> | undefined, cloneValue?: ((value: any, key: PropertyKey | undefined, obj: T, stack: Map<any, any>) => any) | undefined): void;

package/dist/cloneDeep/index.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Creates a deep clone of the given object.
+ *
+ * @template T - The type of the object.
+ * @param {T} obj - The object to clone.
+ * @returns {T} - A deep clone of the given object.
+ *
+ * @example
+ * // Clone a primitive values
+ * const num = 29;
+ * const clonedNum = clone(num);
+ * console.log(clonedNum); // 29
+ * console.log(clonedNum === num); // true
+ *
+ * @example
+ * // Clone an array
+ * const arr = [1, 2, 3];
+ * const clonedArr = clone(arr);
+ * console.log(clonedArr); // [1, 2, 3]
+ * console.log(clonedArr === arr); // false
+ *
+ * @example
+ * // Clone an array with nested objects
+ * const arr = [1, { a: 1 }, [1, 2, 3]];
+ * const clonedArr = clone(arr);
+ * arr[1].a = 2;
+ * console.log(arr); // [2, { a: 2 }, [1, 2, 3]]
+ * console.log(clonedArr); // [1, { a: 1 }, [1, 2, 3]]
+ * console.log(clonedArr === arr); // false
+ *
+ * @example
+ * // Clone an object
+ * const obj = { a: 1, b: 'es-toolkit', c: [1, 2, 3] };
+ * const clonedObj = clone(obj);
+ * console.log(clonedObj); // { a: 1, b: 'es-toolkit', c: [1, 2, 3] }
+ * console.log(clonedObj === obj); // false
+ *
+ * @example
+ * // Clone an object with nested objects
+ * const obj = { a: 1, b: { c: 1 } };
+ * const clonedObj = clone(obj);
+ * obj.b.c = 2;
+ * console.log(obj); // { a: 1, b: { c: 2 } }
+ * console.log(clonedObj); // { a: 1, b: { c: 1 } }
+ * console.log(clonedObj === obj); // false
+ */
+export declare function cloneDeep<T>(obj: T): T;

package/dist/getValueFromObjectByKey/index.d.ts

@@ -0,0 +1,3 @@
+type DeepValueOf<T, K> = K extends `${infer First}:${infer Rest}` ? First extends keyof T ? Rest extends '' ? T[First] : DeepValueOf<T[First], Rest> : undefined : K extends keyof T ? T[K] : undefined;
+export declare function getValueFromObjectByKey<T extends object, K extends string | string[] = string>(object: T, key: K): DeepValueOf<T, K extends string ? K : string> | undefined;
+export {};

package/dist/index.d.ts

@@ -1,17 +1,26 @@
-import isServer from './isServer';
-import { isScroll, getScrollContainer, isInContainer } from './scroll';
+import Base64 from './base64';
 import classNames from './classNames';
-import scrollTo from './scroll/scrollTo';
+import { getValueFromObjectByKey } from './getValueFromObjectByKey';
+import isServer from './isServer';
+import { getScrollContainer, isInContainer, isScroll } from './scroll';
 import getScroll from './scroll/getScroll';
+import scrollTo from './scroll/scrollTo';
 import throttleByAnimationFrame from './scroll/throttleByAnimationFrame';
-import globalConfig from './utils/config';
-export * from './merge';
-export * from './isDeepEqualReact';
+export * from './cloneDeep';
+export * from './cloneDeep/cloneDeepWith';
 export * from './isBrowser';
+export * from './isDeepEqualReact';
+export * from './isImg';
+export * from './isNil';
+export * from './isUrl';
+export * from './merge';
+export * from './merge/mergeWith';
+export * from './merge/useDeepMege';
+export * from './nanoid';
 export * from './omitBoolean';
 export * from './omitUndefined';
+export * from './omitUndefinedAndEmptyArr';
 export * from './slots';
-export * from './utils';
-export * from './utils/validate';
 export * from './typings';
-export { isServer, globalConfig, classNames, isScroll, isInContainer, getScrollContainer, scrollTo, getScroll, throttleByAnimationFrame };
+export * from './utils';
+export { Base64, classNames, getScroll, getScrollContainer, getValueFromObjectByKey, isInContainer, isScroll, isServer, scrollTo, throttleByAnimationFrame };

package/dist/isImg/index.d.ts

@@ -0,0 +1,2 @@
+/** 判断是否是图片链接 */
+export declare function isImg(path: string): boolean;

package/dist/isNil/index.d.ts

@@ -0,0 +1 @@
+export declare const isNil: (value: any) => value is null | undefined;

package/dist/isUrl/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 判断是不是一个 url
+ * @param  {string|undefined} path
+ * @returns boolean
+ */
+export declare const isUrl: (path: string | undefined) => boolean;

package/dist/merge/index.d.ts

@@ -3,5 +3,48 @@
  * @param  {any[]} ...rest
  * @returns T
  */
-declare const merge: <T>(...rest: any[]) => T;
-export { merge };
+declare const merge: <T = any>(...rest: any[]) => T;
+/**
+ * Merges the properties of the source object into a deep clone of the target object.
+ * Unlike `merge`, This function does not modify the original target object.
+ *
+ * This function performs a deep merge, meaning nested objects and arrays are merged recursively.
+ *
+ * - If a property in the source object is an array or object and the corresponding property in the target object is also an array or object, they will be merged.
+ * - If a property in the source object is undefined, it will not overwrite a defined property in the target object.
+ *
+ * Note that this function does not mutate the target object.
+ *
+ * @param {T} target - The target object to be cloned and merged into. This object is not modified directly.
+ * @param {S} source - The source object whose properties will be merged into the cloned target object.
+ * @returns {T & S} A new object with properties from the source object merged into a deep clone of the target object.
+ *
+ * @template T - Type of the target object.
+ * @template S - Type of the source object.
+ *
+ * @example
+ * const target = { a: 1, b: { x: 1, y: 2 } };
+ * const source = { b: { y: 3, z: 4 }, c: 5 };
+ *
+ * const result = toMerged(target, source);
+ * console.log(result);
+ * // Output: { a: 1, b: { x: 1, y: 3, z: 4 }, c: 5 }
+ *
+ * @example
+ * const target = { a: [1, 2], b: { x: 1 } };
+ * const source = { a: [3], b: { y: 2 } };
+ *
+ * const result = toMerged(target, source);
+ * console.log(result);
+ * // Output: { a: [3, 2], b: { x: 1, y: 2 } }
+ *
+ * @example
+ * const target = { a: null };
+ * const source = { a: [1, 2, 3] };
+ *
+ * const result = toMerged(target, source);
+ * console.log(result);
+ * // Output: { a: [1, 2, 3] }
+ */
+declare function deepMerge<T extends Record<PropertyKey, any>, S extends Record<PropertyKey, any>>(target: T, source: S): T & S;
+export { deepMerge, merge };

package/dist/merge/mergeWith.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Merges the properties of the source object into the target object.
+ *
+ * You can provide a custom `merge` function to control how properties are merged. It should return the value to be set in the target object.
+ *
+ * If it returns `undefined`, a default deep merge will be applied for arrays and objects:
+ *
+ * - If a property in the source object is an array or an object and the corresponding property in the target object is also an array or object, they will be merged.
+ * - If a property in the source object is undefined, it will not overwrite a defined property in the target object.
+ *
+ * Note that this function mutates the target object.
+ *
+ * @param {T} target - The target object into which the source object properties will be merged. This object is modified in place.
+ * @param {S} source - The source object whose properties will be merged into the target object.
+ * @param {(targetValue: any, sourceValue: any, key: string, target: T, source: S) => any} merge - A custom merge function that defines how properties should be combined. It receives the following arguments:
+ *   - `targetValue`: The current value of the property in the target object.
+ *   - `sourceValue`: The value of the property in the source object.
+ *   - `key`: The key of the property being merged.
+ *   - `target`: The target object.
+ *   - `source`: The source object.
+ *
+ * @returns {T & S} The updated target object with properties from the source object merged in.
+ *
+ * @template T - Type of the target object.
+ * @template S - Type of the source object.
+ *
+ * @example
+ * const target = { a: 1, b: 2 };
+ * const source = { b: 3, c: 4 };
+ *
+ * mergeWith(target, source, (targetValue, sourceValue) => {
+ *   if (typeof targetValue === 'number' && typeof sourceValue === 'number') {
+ *     return targetValue + sourceValue;
+ *   }
+ * });
+ * // Returns { a: 1, b: 5, c: 4 }
+ * @example
+ * const target = { a: [1], b: [2] };
+ * const source = { a: [3], b: [4] };
+ *
+ * const result = mergeWith(target, source, (objValue, srcValue) => {
+ *   if (Array.isArray(objValue)) {
+ *     return objValue.concat(srcValue);
+ *   }
+ * });
+ *
+ * expect(result).toEqual({ a: [1, 3], b: [2, 4] });
+ */
+export declare function mergeWith<T extends Record<PropertyKey, any>, S extends Record<PropertyKey, any>>(target: T, source: S, merge: (targetValue: any, sourceValue: any, key: string, target: T, source: S) => any): T & S;

package/dist/merge/useDeepMege.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Merges the properties of the source object into a deep clone of the target object.
+ * Unlike `merge`, This function does not modify the original target object.
+ *
+ * This function performs a deep merge, meaning nested objects and arrays are merged recursively.
+ *
+ * - If a property in the source object is an array or object and the corresponding property in the target object is also an array or object, they will be merged.
+ * - If a property in the source object is undefined, it will not overwrite a defined property in the target object.
+ *
+ * Note that this function does not mutate the target object.
+ *
+ * @param {T} target - The target object to be cloned and merged into. This object is not modified directly.
+ * @param {S} source - The source object whose properties will be merged into the cloned target object.
+ * @returns {T & S} A new object with properties from the source object merged into a deep clone of the target object.
+ *
+ * @template T - Type of the target object.
+ * @template S - Type of the source object.
+ *
+ * @example
+ * const target = { a: 1, b: { x: 1, y: 2 } };
+ * const source = { b: { y: 3, z: 4 }, c: 5 };
+ *
+ * const result = toMerged(target, source);
+ * console.log(result);
+ * // Output: { a: 1, b: { x: 1, y: 3, z: 4 }, c: 5 }
+ *
+ * @example
+ * const target = { a: [1, 2], b: { x: 1 } };
+ * const source = { a: [3], b: { y: 2 } };
+ *
+ * const result = toMerged(target, source);
+ * console.log(result);
+ * // Output: { a: [3, 2], b: { x: 1, y: 2 } }
+ *
+ * @example
+ * const target = { a: null };
+ * const source = { a: [1, 2, 3] };
+ *
+ * const result = toMerged(target, source);
+ * console.log(result);
+ * // Output: { a: [1, 2, 3] }
+ */
+export declare function useDeepMerge<T extends Record<PropertyKey, any>, S extends Record<PropertyKey, any>>(target: T, source: S): T & S;

package/dist/nanoid/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 生成uuid，如果不支持 randomUUID，就用 genNanoid
+ *
+ * @returns string
+ */
+export declare const nanoid: () => string;

package/dist/omitUndefined/index.d.ts

@@ -1,5 +1,2 @@
-type OmitUndefined<T> = {
-    [P in keyof T]: NonNullable<T[P]>;
-};
-export declare const omitUndefined: <T>(obj: T) => OmitUndefined<T>;
-export {};
+import type { OmitUndefined } from '../typings';
+export declare const omitUndefined: <T extends Record<string, any>>(obj: T) => OmitUndefined<T>;

package/dist/omitUndefinedAndEmptyArr/index.d.ts

@@ -0,0 +1 @@
+export declare const omitUndefinedAndEmptyArr: <T extends Record<string, any>>(obj: T) => T;