@gateweb/react-utils 1.1.0 → 1.2.0

package/dist/cjs/index.d.ts

@@ -262,11 +262,9 @@ declare const extractEnumLikeObject: <T extends Record<string, { [P in K]: any;
 declare const createEnumLikeObject: <T extends Record<string, {
     value: any;
     label: string;
-}>, N extends string>(obj: T, name: N) => { [K in `Enum${N}` | `${N}List` | `get${N}Label`]: K extends `Enum${N}` ? { [key in keyof T]: T[key]["value"]; } : K extends `${N}List` ? {
-    value: any;
-    label: string;
-    key: string;
-}[] : (value: TExtractValueType<T, "value">) => string | TExtractValueType<T, "value">; };
+}>, N extends string>(obj: T, name: N) => { [K in `Enum${N}` | `${N}List` | `get${N}Label`]: K extends `Enum${N}` ? { [key in keyof T]: T[key]["value"]; } : K extends `${N}List` ? ({
+    key: keyof T;
+} & T[keyof T])[] : (value: TExtractValueType<T, "value">) => string | TExtractValueType<T, "value">; };
 
 /**
  * simulate a fake api request
@@ -374,6 +372,30 @@ declare const omit: <T extends object, K extends [...(keyof T)[]]>(object: T, ..
  * const b = omitByValue(a, undefined, null); // { c: 3, d: 4 }
  */
 declare const omitByValue: <T extends object, K extends any[]>(object: T, ...values: K) => Pick<T, { [K2 in keyof T]: T[K2] extends K[number] ? never : K2; }[keyof T]>;
+/**
+ * extract the object fields by the given keys
+ *
+ * @param object - the object to pick fields from
+ * @param keys - the keys to pick
+ *
+ * @example
+ *
+ * const a = { a: 1, b: 2, c: 3, d: 4 };
+ * const b = pick(a, 'a', 'b'); // { a: 1, b: 2 }
+ */
+declare const pick: <T extends object, K extends [...(keyof T)[]]>(object: T, ...keys: K) => { [K2 in K[number]]: T[K2]; };
+/**
+ * extract the object fields by the given values
+ *
+ * @param object - the object to pick fields from
+ * @param values - the values to pick
+ *
+ * @example
+ *
+ * const a = { a: 1, b: 2, c: 3, d: 4 };
+ * const b = pickByValue(a, 1, 2); // { a: 1, b: 2 }
+ */
+declare const pickByValue: <T extends object, K extends any[]>(object: T, ...values: K) => Pick<T, { [K2 in keyof T]: T[K2] extends K[number] ? K2 : never; }[keyof T]>;
 
 /**
  * debounce function
@@ -493,6 +515,61 @@ declare const isDateTimeString: (separator?: string) => RegExp;
  * isTimeString().test('12:00:00.123') // false
  */
 declare const isTimeString: () => RegExp;
+/**
+ * 密碼複雜度檢查
+ *
+ * 預設密碼長度為 8 位，且包含大寫英文、小寫英文、數字、特殊字元
+ *
+ * @param options - 選項
+ *
+ * @example
+ *
+ * isValidPassword().test('123') // false
+ * isValidPassword().test('12345678') // false
+ * isValidPassword().test('1234567A') // false
+ * isValidPassword().test('123456Aa') // false
+ * isValidPassword().test('12345Aa!') // true
+ * isValidPassword({ minLength: 6 }).test('12345Aa!') // true
+ * isValidPassword({ minLength: 6, uppercase: false }).test('12345a!') // true
+ * isValidPassword({ minLength: 6, lowercase: false }).test('12345A!') // true
+ * isValidPassword({ minLength: 6, number: false }).test('ABCDEa!') // true
+ * isValidPassword({ minLength: 6, special: false }).test('ABCDEa1') // true
+ */
+declare const isValidPassword: (options?: {
+    /**
+     * 包含大寫英文
+     *
+     * @default true
+     */
+    uppercase?: boolean;
+    /**
+     * 包含小寫英文
+     *
+     * @default true
+     */
+    lowercase?: boolean;
+    /**
+     * 包含數字
+     *
+     * @default true
+     *
+     */
+    number?: boolean;
+    /**
+     * 包含特殊字元
+     *
+     * @default true
+     *
+     */
+    special?: boolean;
+    /**
+     * 最小長度
+     *
+     * @default 8
+     *
+     */
+    minLength?: number;
+}) => RegExp;
 
 /**
  * 數字
@@ -706,4 +783,4 @@ declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefin
  */
 declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
 
-export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };
+export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };

package/dist/cjs/index.js

@@ -534,6 +534,39 @@ message) {
             [key]: value
         };
     }, {});
+/**
+ * extract the object fields by the given keys
+ *
+ * @param object - the object to pick fields from
+ * @param keys - the keys to pick
+ *
+ * @example
+ *
+ * const a = { a: 1, b: 2, c: 3, d: 4 };
+ * const b = pick(a, 'a', 'b'); // { a: 1, b: 2 }
+ */ const pick = (object, ...keys)=>keys.reduce((acc, cur)=>({
+            ...acc,
+            [cur]: object[cur]
+        }), {});
+/**
+ * extract the object fields by the given values
+ *
+ * @param object - the object to pick fields from
+ * @param values - the values to pick
+ *
+ * @example
+ *
+ * const a = { a: 1, b: 2, c: 3, d: 4 };
+ * const b = pickByValue(a, 1, 2); // { a: 1, b: 2 }
+ */ const pickByValue = (object, ...values)=>Object.entries(object).reduce((acc, [key, value])=>{
+        if (values.includes(value)) {
+            return {
+                ...acc,
+                [key]: value
+            };
+        }
+        return acc;
+    }, {});
 
 /**
  * debounce function
@@ -660,6 +693,26 @@ message) {
  * isTimeString().test('12:00:00') // true
  * isTimeString().test('12:00:00.123') // false
  */ const isTimeString = ()=>/^\d{2}:\d{2}:\d{2}$/;
+/**
+ * 密碼複雜度檢查
+ *
+ * 預設密碼長度為 8 位，且包含大寫英文、小寫英文、數字、特殊字元
+ *
+ * @param options - 選項
+ *
+ * @example
+ *
+ * isValidPassword().test('123') // false
+ * isValidPassword().test('12345678') // false
+ * isValidPassword().test('1234567A') // false
+ * isValidPassword().test('123456Aa') // false
+ * isValidPassword().test('12345Aa!') // true
+ * isValidPassword({ minLength: 6 }).test('12345Aa!') // true
+ * isValidPassword({ minLength: 6, uppercase: false }).test('12345a!') // true
+ * isValidPassword({ minLength: 6, lowercase: false }).test('12345A!') // true
+ * isValidPassword({ minLength: 6, number: false }).test('ABCDEa!') // true
+ * isValidPassword({ minLength: 6, special: false }).test('ABCDEa1') // true
+ */ const isValidPassword = (options)=>new RegExp(`^${options?.uppercase ?? true ? '(?=.*[A-Z])' : ''}${options?.lowercase ?? true ? '(?=.*[a-z])' : ''}${options?.number ?? true ? '(?=.*\\d)' : ''}${options?.special ?? true ? '(?=.*[\\p{P}\\p{S}])' : ''}${options?.minLength ? `.{${options.minLength},}` : '.{8,}$'}`, 'u');
 
 /**
  * 數字
@@ -839,12 +892,15 @@ exports.isServer = isServer;
 exports.isTWMobile = isTWMobile;
 exports.isTWPhone = isTWPhone;
 exports.isTimeString = isTimeString;
+exports.isValidPassword = isValidPassword;
 exports.omit = omit;
 exports.omitByValue = omitByValue;
 exports.pascalCase2CamelCase = pascalCase2CamelCase;
 exports.pascalCase2SnakeCase = pascalCase2SnakeCase;
 exports.pascalString2CamelString = pascalString2CamelString;
 exports.pascalString2SnakeString = pascalString2SnakeString;
+exports.pick = pick;
+exports.pickByValue = pickByValue;
 exports.rocEraToAd = rocEraToAd;
 exports.snakeCase2CamelCase = snakeCase2CamelCase;
 exports.snakeCase2PascalCase = snakeCase2PascalCase;

package/dist/cjs/types.d.ts

@@ -21,5 +21,34 @@
 type TExtractValueType<T, K extends string> = T extends Record<string, {
     [P in K]: infer R;
 }> ? R : never;
+/**
+ * A utility type that transforms an object type `T` into an array of its entries.
+ * Each entry is represented as a tuple where the first element is the key of type `K`
+ * and the second element is the corresponding value of type `T[K]`.
+ *
+ * @template T - The object type to transform into entries.
+ *
+ * @example
+ * type Example = { a: number; b: string };
+ * type ExampleEntries = Entries<Example>;
+ * // Result: ExampleEntries is [ ["a", number], ["b", string] ]
+ */
+type Entries<T> = {
+    [K in keyof T]: [K, T[K]];
+}[keyof T][];
+/**
+ * A utility type that transforms an object type `T` into another object type where each value type is a string.
+ *
+ * @template T - The object type to transform into keys.
+ *
+ * @example
+ *
+ * type Example = { a: number; b: string };
+ * type ExampleToString = MapToString<Example>;
+ * // Result: ExampleToString is { a: string; b: string; }
+ */
+type MapToString<T> = {
+    [K in keyof T]: string;
+};
 
-export type { TExtractValueType };
+export type { Entries, MapToString, TExtractValueType };

package/dist/es/index.d.mts

@@ -262,11 +262,9 @@ declare const extractEnumLikeObject: <T extends Record<string, { [P in K]: any;
 declare const createEnumLikeObject: <T extends Record<string, {
     value: any;
     label: string;
-}>, N extends string>(obj: T, name: N) => { [K in `Enum${N}` | `${N}List` | `get${N}Label`]: K extends `Enum${N}` ? { [key in keyof T]: T[key]["value"]; } : K extends `${N}List` ? {
-    value: any;
-    label: string;
-    key: string;
-}[] : (value: TExtractValueType<T, "value">) => string | TExtractValueType<T, "value">; };
+}>, N extends string>(obj: T, name: N) => { [K in `Enum${N}` | `${N}List` | `get${N}Label`]: K extends `Enum${N}` ? { [key in keyof T]: T[key]["value"]; } : K extends `${N}List` ? ({
+    key: keyof T;
+} & T[keyof T])[] : (value: TExtractValueType<T, "value">) => string | TExtractValueType<T, "value">; };
 
 /**
  * simulate a fake api request
@@ -374,6 +372,30 @@ declare const omit: <T extends object, K extends [...(keyof T)[]]>(object: T, ..
  * const b = omitByValue(a, undefined, null); // { c: 3, d: 4 }
  */
 declare const omitByValue: <T extends object, K extends any[]>(object: T, ...values: K) => Pick<T, { [K2 in keyof T]: T[K2] extends K[number] ? never : K2; }[keyof T]>;
+/**
+ * extract the object fields by the given keys
+ *
+ * @param object - the object to pick fields from
+ * @param keys - the keys to pick
+ *
+ * @example
+ *
+ * const a = { a: 1, b: 2, c: 3, d: 4 };
+ * const b = pick(a, 'a', 'b'); // { a: 1, b: 2 }
+ */
+declare const pick: <T extends object, K extends [...(keyof T)[]]>(object: T, ...keys: K) => { [K2 in K[number]]: T[K2]; };
+/**
+ * extract the object fields by the given values
+ *
+ * @param object - the object to pick fields from
+ * @param values - the values to pick
+ *
+ * @example
+ *
+ * const a = { a: 1, b: 2, c: 3, d: 4 };
+ * const b = pickByValue(a, 1, 2); // { a: 1, b: 2 }
+ */
+declare const pickByValue: <T extends object, K extends any[]>(object: T, ...values: K) => Pick<T, { [K2 in keyof T]: T[K2] extends K[number] ? K2 : never; }[keyof T]>;
 
 /**
  * debounce function
@@ -493,6 +515,61 @@ declare const isDateTimeString: (separator?: string) => RegExp;
  * isTimeString().test('12:00:00.123') // false
  */
 declare const isTimeString: () => RegExp;
+/**
+ * 密碼複雜度檢查
+ *
+ * 預設密碼長度為 8 位，且包含大寫英文、小寫英文、數字、特殊字元
+ *
+ * @param options - 選項
+ *
+ * @example
+ *
+ * isValidPassword().test('123') // false
+ * isValidPassword().test('12345678') // false
+ * isValidPassword().test('1234567A') // false
+ * isValidPassword().test('123456Aa') // false
+ * isValidPassword().test('12345Aa!') // true
+ * isValidPassword({ minLength: 6 }).test('12345Aa!') // true
+ * isValidPassword({ minLength: 6, uppercase: false }).test('12345a!') // true
+ * isValidPassword({ minLength: 6, lowercase: false }).test('12345A!') // true
+ * isValidPassword({ minLength: 6, number: false }).test('ABCDEa!') // true
+ * isValidPassword({ minLength: 6, special: false }).test('ABCDEa1') // true
+ */
+declare const isValidPassword: (options?: {
+    /**
+     * 包含大寫英文
+     *
+     * @default true
+     */
+    uppercase?: boolean;
+    /**
+     * 包含小寫英文
+     *
+     * @default true
+     */
+    lowercase?: boolean;
+    /**
+     * 包含數字
+     *
+     * @default true
+     *
+     */
+    number?: boolean;
+    /**
+     * 包含特殊字元
+     *
+     * @default true
+     *
+     */
+    special?: boolean;
+    /**
+     * 最小長度
+     *
+     * @default 8
+     *
+     */
+    minLength?: number;
+}) => RegExp;
 
 /**
  * 數字
@@ -706,4 +783,4 @@ declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefin
  */
 declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
 
-export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };
+export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };

package/dist/es/index.mjs

@@ -528,6 +528,39 @@ message) {
             [key]: value
         };
     }, {});
+/**
+ * extract the object fields by the given keys
+ *
+ * @param object - the object to pick fields from
+ * @param keys - the keys to pick
+ *
+ * @example
+ *
+ * const a = { a: 1, b: 2, c: 3, d: 4 };
+ * const b = pick(a, 'a', 'b'); // { a: 1, b: 2 }
+ */ const pick = (object, ...keys)=>keys.reduce((acc, cur)=>({
+            ...acc,
+            [cur]: object[cur]
+        }), {});
+/**
+ * extract the object fields by the given values
+ *
+ * @param object - the object to pick fields from
+ * @param values - the values to pick
+ *
+ * @example
+ *
+ * const a = { a: 1, b: 2, c: 3, d: 4 };
+ * const b = pickByValue(a, 1, 2); // { a: 1, b: 2 }
+ */ const pickByValue = (object, ...values)=>Object.entries(object).reduce((acc, [key, value])=>{
+        if (values.includes(value)) {
+            return {
+                ...acc,
+                [key]: value
+            };
+        }
+        return acc;
+    }, {});
 
 /**
  * debounce function
@@ -654,6 +687,26 @@ message) {
  * isTimeString().test('12:00:00') // true
  * isTimeString().test('12:00:00.123') // false
  */ const isTimeString = ()=>/^\d{2}:\d{2}:\d{2}$/;
+/**
+ * 密碼複雜度檢查
+ *
+ * 預設密碼長度為 8 位，且包含大寫英文、小寫英文、數字、特殊字元
+ *
+ * @param options - 選項
+ *
+ * @example
+ *
+ * isValidPassword().test('123') // false
+ * isValidPassword().test('12345678') // false
+ * isValidPassword().test('1234567A') // false
+ * isValidPassword().test('123456Aa') // false
+ * isValidPassword().test('12345Aa!') // true
+ * isValidPassword({ minLength: 6 }).test('12345Aa!') // true
+ * isValidPassword({ minLength: 6, uppercase: false }).test('12345a!') // true
+ * isValidPassword({ minLength: 6, lowercase: false }).test('12345A!') // true
+ * isValidPassword({ minLength: 6, number: false }).test('ABCDEa!') // true
+ * isValidPassword({ minLength: 6, special: false }).test('ABCDEa1') // true
+ */ const isValidPassword = (options)=>new RegExp(`^${options?.uppercase ?? true ? '(?=.*[A-Z])' : ''}${options?.lowercase ?? true ? '(?=.*[a-z])' : ''}${options?.number ?? true ? '(?=.*\\d)' : ''}${options?.special ?? true ? '(?=.*[\\p{P}\\p{S}])' : ''}${options?.minLength ? `.{${options.minLength},}` : '.{8,}$'}`, 'u');
 
 /**
  * 數字
@@ -799,4 +852,4 @@ message) {
  */ const wait = (ms)=>{
 };
 
-export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, validTaxId, validateDateString, validateFileType, wait };
+export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, validTaxId, validateDateString, validateFileType, wait };

package/dist/es/types.d.mts

@@ -21,5 +21,34 @@
 type TExtractValueType<T, K extends string> = T extends Record<string, {
     [P in K]: infer R;
 }> ? R : never;
+/**
+ * A utility type that transforms an object type `T` into an array of its entries.
+ * Each entry is represented as a tuple where the first element is the key of type `K`
+ * and the second element is the corresponding value of type `T[K]`.
+ *
+ * @template T - The object type to transform into entries.
+ *
+ * @example
+ * type Example = { a: number; b: string };
+ * type ExampleEntries = Entries<Example>;
+ * // Result: ExampleEntries is [ ["a", number], ["b", string] ]
+ */
+type Entries<T> = {
+    [K in keyof T]: [K, T[K]];
+}[keyof T][];
+/**
+ * A utility type that transforms an object type `T` into another object type where each value type is a string.
+ *
+ * @template T - The object type to transform into keys.
+ *
+ * @example
+ *
+ * type Example = { a: number; b: string };
+ * type ExampleToString = MapToString<Example>;
+ * // Result: ExampleToString is { a: string; b: string; }
+ */
+type MapToString<T> = {
+    [K in keyof T]: string;
+};
 
-export type { TExtractValueType };
+export type { Entries, MapToString, TExtractValueType };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gateweb/react-utils",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "React Utils for GateWeb",
   "homepage": "https://github.com/GatewebSolutions/react-utils",
   "files": [