@gateweb/react-utils 1.14.2 → 1.14.4

package/dist/cjs/index.d.ts

@@ -373,18 +373,76 @@ declare const isEqual: (value1: unknown, value2: unknown) => boolean;
  * @param valueKey value 的 key
  *
  * @example
- *
- * ```js
  * const myObj = {
- *    A: { value: 'a' },
- *    B: { value: 'b', other: 'other' },
- * }
- *
+ *   A: { value: 'a' },
+ *   B: { value: 'b', other: 'other' },
+ * } as const;
  * const enumCode = extractEnumLikeObject(myObj, 'value');
- * console.log(enumCode); // { A: 'a', B: 'b' }
- * ```
+ * // => { A: 'a', B: 'b' }
  */
 declare const extractEnumLikeObject: <T extends Record<string, { [P in K]: any; }>, K extends string>(enumObject: T, valueKey: K) => { [key in keyof T]: T[key][K]; };
+type EnumMap<T extends Record<string, any>, VK extends string> = {
+    [K in keyof T]: T[K] extends Record<VK, infer R> ? R : never;
+};
+type NormalList<T extends Record<string, any>> = Array<{
+    key: string;
+} & T[keyof T]>;
+type ValueAtKey<T extends Record<string, any>, K extends string> = T[keyof T] extends infer U ? U extends Record<K, infer R> ? R : never : never;
+type ScenesList<T extends Record<string, {
+    scenes: Record<string, Record<string, any>>;
+}>, Scene extends keyof T[keyof T]['scenes'] & string, VK extends string> = Array<{
+    key: string;
+    value: ValueAtKey<T, VK>;
+} & T[keyof T]['scenes'][Scene]>;
+type NormalReturn<T extends Record<string, any>, VK extends string> = {
+    Enum: EnumMap<T, VK>;
+    List: NormalList<T>;
+    getLabel: (value: ValueAtKey<T, VK>) => string;
+};
+type ScenesReturn<T extends Record<string, {
+    scenes: Record<string, Record<string, any>>;
+}>, Scene extends keyof T[keyof T]['scenes'] & string, VK extends string> = {
+    Enum: EnumMap<T, VK>;
+    List: ScenesList<T, Scene, VK>;
+    getLabel: (value: ValueAtKey<T, VK>) => string;
+};
+type AsNamed<R, N extends string> = {
+    [K in keyof R as K extends 'Enum' ? `Enum${N}` : K extends 'List' ? `${N}List` : K extends 'getLabel' ? `get${N}Label` : never]: R[K];
+};
+/**
+ * 指定 value 欄位的鍵名選項。
+ * @template VK value 對應的鍵名型別
+ */
+type ValueKeyOption<VK extends string> = {
+    /**
+     * 指定 value 欄位的鍵名，當輸入物件的值欄位不是 `value` 時使用，預設為 `'value'`。
+     */
+    valueKey?: VK;
+};
+/**
+ * 命名選項，用於產生 `Enum${name}`、`${name}List`、`get${name}Label`。
+ * @template N 自訂名稱型別
+ */
+type NamedOption<N extends string> = {
+    /**
+     * 自訂輸出鍵名的名稱，用於產生 `Enum${name}`、`${name}List`、`get${name}Label`。
+     */
+    name: N;
+};
+/**
+ * 場景選項，指定要取用的場景 key。
+ * @template Scene 場景鍵名型別
+ */
+type SceneOption<Scene extends string> = {
+    /**
+     * 指定要取用的場景 key，會從 `scenes[scene]` 中取出 label 與其餘屬性。
+     */
+    scene: Scene;
+};
+type NormalNamedOptions<N extends string, VK extends string> = NamedOption<N> & ValueKeyOption<VK>;
+type NormalOptions<VK extends string> = ValueKeyOption<VK>;
+type ScenesNamedOptions<N extends string, Scene extends string, VK extends string> = NamedOption<N> & SceneOption<Scene> & ValueKeyOption<VK>;
+type ScenesOptions<Scene extends string, VK extends string> = SceneOption<Scene> & ValueKeyOption<VK>;
 /**
  * 將指定格式的物件生成 enum 物件、enum 列表、取得 label 的方法
  *
@@ -447,119 +505,18 @@ declare const extractEnumLikeObject: <T extends Record<string, { [P in K]: any;
  * ```
  *
  */
-declare function createEnumLikeObject<T extends Record<string, {
-    value: any;
-    label: string;
-}>, N extends string>(obj: T, options: {
-    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` ? Array<{
-        key: string;
-    } & T[keyof T]> : (value: T[keyof T]['value']) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, Record<VK, any> & {
-    label: string;
-}>, N extends string, VK extends keyof T[keyof T] & string>(obj: T, options: {
-    name: N;
-    valueKey: VK;
-}): {
-    [K in `Enum${N}` | `${N}List` | `get${N}Label`]: K extends `Enum${N}` ? {
-        [key in keyof T]: T[key][VK];
-    } : K extends `${N}List` ? Array<{
-        key: string;
-    } & Omit<T[keyof T], 'value'> & {
-        value: T[keyof T][VK];
-    }> : (value: T[keyof T][VK]) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, {
-    value: any;
-    label: string;
-}>>(obj: T, options?: {
-    name?: undefined;
-}): {
-    Enum: {
-        [key in keyof T]: T[key]['value'];
-    };
-    List: Array<{
-        key: string;
-    } & T[keyof T]>;
-    getLabel: (value: T[keyof T]['value']) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, Record<VK, any> & {
-    label: string;
-}>, VK extends keyof T[keyof T] & string>(obj: T, options: {
-    valueKey: VK;
-}): {
-    Enum: {
-        [key in keyof T]: T[key][VK];
-    };
-    List: Array<{
-        key: string;
-    } & Omit<T[keyof T], 'value'> & {
-        value: T[keyof T][VK];
-    }>;
-    getLabel: (value: T[keyof T][VK]) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, {
-    value: any;
-    scenes: Record<string, Record<string, any>>;
-}>, N extends string, Scene extends keyof T[keyof T]['scenes']>(obj: T, options: {
-    name: N;
-    scene: Scene;
-}): {
-    [K in `Enum${N}` | `${N}List` | `get${N}Label`]: K extends `Enum${N}` ? {
-        [key in keyof T]: T[key]['value'];
-    } : K extends `${N}List` ? Array<{
-        key: string;
-        value: T[keyof T]['value'];
-    } & T[keyof T]['scenes'][Scene]> : (value: T[keyof T]['value']) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, Record<VK, any> & {
+declare function createEnumLikeObject<T extends Record<string, Record<string, any> & {
     scenes: Record<string, Record<string, any>>;
-}>, N extends string, Scene extends keyof T[keyof T]['scenes'], VK extends keyof T[keyof T] & string>(obj: T, options: {
-    name: N;
-    scene: Scene;
-    valueKey: VK;
-}): {
-    [K in `Enum${N}` | `${N}List` | `get${N}Label`]: K extends `Enum${N}` ? {
-        [key in keyof T]: T[key][VK];
-    } : K extends `${N}List` ? Array<{
-        key: string;
-        value: T[keyof T][VK];
-    } & T[keyof T]['scenes'][Scene]> : (value: T[keyof T][VK]) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, {
-    value: any;
+}>, N extends string, Scene extends keyof T[keyof T]['scenes'] & string, VK extends string = 'value'>(obj: T, options: ScenesNamedOptions<N, Scene, VK>): AsNamed<ScenesReturn<T, Scene, VK>, N>;
+declare function createEnumLikeObject<T extends Record<string, Record<string, any> & {
     scenes: Record<string, Record<string, any>>;
-}>, Scene extends keyof T[keyof T]['scenes']>(obj: T, options: {
-    scene: Scene;
-}): {
-    Enum: {
-        [key in keyof T]: T[key]['value'];
-    };
-    List: Array<{
-        key: string;
-        value: T[keyof T]['value'];
-    } & T[keyof T]['scenes'][Scene]>;
-    getLabel: (value: T[keyof T]['value']) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, Record<VK, any> & {
-    scenes: Record<string, Record<string, any>>;
-}>, Scene extends keyof T[keyof T]['scenes'], VK extends keyof T[keyof T] & string>(obj: T, options: {
-    scene: Scene;
-    valueKey: VK;
-}): {
-    Enum: {
-        [key in keyof T]: T[key][VK];
-    };
-    List: Array<{
-        key: string;
-        value: T[keyof T][VK];
-    } & T[keyof T]['scenes'][Scene]>;
-    getLabel: (value: T[keyof T][VK]) => string;
-};
+}>, Scene extends keyof T[keyof T]['scenes'] & string, VK extends string = 'value'>(obj: T, options: ScenesOptions<Scene, VK>): ScenesReturn<T, Scene, VK>;
+declare function createEnumLikeObject<T extends Record<string, Record<string, any> & {
+    label: string;
+}>, N extends string, VK extends string = 'value'>(obj: T, options: NormalNamedOptions<N, VK>): AsNamed<NormalReturn<T, VK>, N>;
+declare function createEnumLikeObject<T extends Record<string, Record<string, any> & {
+    label: string;
+}>, VK extends string = 'value'>(obj: T, options?: NormalOptions<VK>): NormalReturn<T, VK>;
 
 /**
  * simulate a fake api request

package/dist/cjs/index.js

@@ -164,16 +164,12 @@ const FILE_SIZE_UNITS$1 = [
  * @param valueKey value 的 key
  *
  * @example
- *
- * ```js
  * const myObj = {
- *    A: { value: 'a' },
- *    B: { value: 'b', other: 'other' },
- * }
- *
+ *   A: { value: 'a' },
+ *   B: { value: 'b', other: 'other' },
+ * } as const;
  * const enumCode = extractEnumLikeObject(myObj, 'value');
- * console.log(enumCode); // { A: 'a', B: 'b' }
- * ```
+ * // => { A: 'a', B: 'b' }
  */ const extractEnumLikeObject = (enumObject, valueKey)=>Object.entries(enumObject).reduce((acc, [key, value])=>({
             ...acc,
             [key]: value[valueKey]

package/dist/es/index.d.mts

@@ -373,18 +373,76 @@ declare const isEqual: (value1: unknown, value2: unknown) => boolean;
  * @param valueKey value 的 key
  *
  * @example
- *
- * ```js
  * const myObj = {
- *    A: { value: 'a' },
- *    B: { value: 'b', other: 'other' },
- * }
- *
+ *   A: { value: 'a' },
+ *   B: { value: 'b', other: 'other' },
+ * } as const;
  * const enumCode = extractEnumLikeObject(myObj, 'value');
- * console.log(enumCode); // { A: 'a', B: 'b' }
- * ```
+ * // => { A: 'a', B: 'b' }
  */
 declare const extractEnumLikeObject: <T extends Record<string, { [P in K]: any; }>, K extends string>(enumObject: T, valueKey: K) => { [key in keyof T]: T[key][K]; };
+type EnumMap<T extends Record<string, any>, VK extends string> = {
+    [K in keyof T]: T[K] extends Record<VK, infer R> ? R : never;
+};
+type NormalList<T extends Record<string, any>> = Array<{
+    key: string;
+} & T[keyof T]>;
+type ValueAtKey<T extends Record<string, any>, K extends string> = T[keyof T] extends infer U ? U extends Record<K, infer R> ? R : never : never;
+type ScenesList<T extends Record<string, {
+    scenes: Record<string, Record<string, any>>;
+}>, Scene extends keyof T[keyof T]['scenes'] & string, VK extends string> = Array<{
+    key: string;
+    value: ValueAtKey<T, VK>;
+} & T[keyof T]['scenes'][Scene]>;
+type NormalReturn<T extends Record<string, any>, VK extends string> = {
+    Enum: EnumMap<T, VK>;
+    List: NormalList<T>;
+    getLabel: (value: ValueAtKey<T, VK>) => string;
+};
+type ScenesReturn<T extends Record<string, {
+    scenes: Record<string, Record<string, any>>;
+}>, Scene extends keyof T[keyof T]['scenes'] & string, VK extends string> = {
+    Enum: EnumMap<T, VK>;
+    List: ScenesList<T, Scene, VK>;
+    getLabel: (value: ValueAtKey<T, VK>) => string;
+};
+type AsNamed<R, N extends string> = {
+    [K in keyof R as K extends 'Enum' ? `Enum${N}` : K extends 'List' ? `${N}List` : K extends 'getLabel' ? `get${N}Label` : never]: R[K];
+};
+/**
+ * 指定 value 欄位的鍵名選項。
+ * @template VK value 對應的鍵名型別
+ */
+type ValueKeyOption<VK extends string> = {
+    /**
+     * 指定 value 欄位的鍵名，當輸入物件的值欄位不是 `value` 時使用，預設為 `'value'`。
+     */
+    valueKey?: VK;
+};
+/**
+ * 命名選項，用於產生 `Enum${name}`、`${name}List`、`get${name}Label`。
+ * @template N 自訂名稱型別
+ */
+type NamedOption<N extends string> = {
+    /**
+     * 自訂輸出鍵名的名稱，用於產生 `Enum${name}`、`${name}List`、`get${name}Label`。
+     */
+    name: N;
+};
+/**
+ * 場景選項，指定要取用的場景 key。
+ * @template Scene 場景鍵名型別
+ */
+type SceneOption<Scene extends string> = {
+    /**
+     * 指定要取用的場景 key，會從 `scenes[scene]` 中取出 label 與其餘屬性。
+     */
+    scene: Scene;
+};
+type NormalNamedOptions<N extends string, VK extends string> = NamedOption<N> & ValueKeyOption<VK>;
+type NormalOptions<VK extends string> = ValueKeyOption<VK>;
+type ScenesNamedOptions<N extends string, Scene extends string, VK extends string> = NamedOption<N> & SceneOption<Scene> & ValueKeyOption<VK>;
+type ScenesOptions<Scene extends string, VK extends string> = SceneOption<Scene> & ValueKeyOption<VK>;
 /**
  * 將指定格式的物件生成 enum 物件、enum 列表、取得 label 的方法
  *
@@ -447,119 +505,18 @@ declare const extractEnumLikeObject: <T extends Record<string, { [P in K]: any;
  * ```
  *
  */
-declare function createEnumLikeObject<T extends Record<string, {
-    value: any;
-    label: string;
-}>, N extends string>(obj: T, options: {
-    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` ? Array<{
-        key: string;
-    } & T[keyof T]> : (value: T[keyof T]['value']) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, Record<VK, any> & {
-    label: string;
-}>, N extends string, VK extends keyof T[keyof T] & string>(obj: T, options: {
-    name: N;
-    valueKey: VK;
-}): {
-    [K in `Enum${N}` | `${N}List` | `get${N}Label`]: K extends `Enum${N}` ? {
-        [key in keyof T]: T[key][VK];
-    } : K extends `${N}List` ? Array<{
-        key: string;
-    } & Omit<T[keyof T], 'value'> & {
-        value: T[keyof T][VK];
-    }> : (value: T[keyof T][VK]) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, {
-    value: any;
-    label: string;
-}>>(obj: T, options?: {
-    name?: undefined;
-}): {
-    Enum: {
-        [key in keyof T]: T[key]['value'];
-    };
-    List: Array<{
-        key: string;
-    } & T[keyof T]>;
-    getLabel: (value: T[keyof T]['value']) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, Record<VK, any> & {
-    label: string;
-}>, VK extends keyof T[keyof T] & string>(obj: T, options: {
-    valueKey: VK;
-}): {
-    Enum: {
-        [key in keyof T]: T[key][VK];
-    };
-    List: Array<{
-        key: string;
-    } & Omit<T[keyof T], 'value'> & {
-        value: T[keyof T][VK];
-    }>;
-    getLabel: (value: T[keyof T][VK]) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, {
-    value: any;
-    scenes: Record<string, Record<string, any>>;
-}>, N extends string, Scene extends keyof T[keyof T]['scenes']>(obj: T, options: {
-    name: N;
-    scene: Scene;
-}): {
-    [K in `Enum${N}` | `${N}List` | `get${N}Label`]: K extends `Enum${N}` ? {
-        [key in keyof T]: T[key]['value'];
-    } : K extends `${N}List` ? Array<{
-        key: string;
-        value: T[keyof T]['value'];
-    } & T[keyof T]['scenes'][Scene]> : (value: T[keyof T]['value']) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, Record<VK, any> & {
+declare function createEnumLikeObject<T extends Record<string, Record<string, any> & {
     scenes: Record<string, Record<string, any>>;
-}>, N extends string, Scene extends keyof T[keyof T]['scenes'], VK extends keyof T[keyof T] & string>(obj: T, options: {
-    name: N;
-    scene: Scene;
-    valueKey: VK;
-}): {
-    [K in `Enum${N}` | `${N}List` | `get${N}Label`]: K extends `Enum${N}` ? {
-        [key in keyof T]: T[key][VK];
-    } : K extends `${N}List` ? Array<{
-        key: string;
-        value: T[keyof T][VK];
-    } & T[keyof T]['scenes'][Scene]> : (value: T[keyof T][VK]) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, {
-    value: any;
+}>, N extends string, Scene extends keyof T[keyof T]['scenes'] & string, VK extends string = 'value'>(obj: T, options: ScenesNamedOptions<N, Scene, VK>): AsNamed<ScenesReturn<T, Scene, VK>, N>;
+declare function createEnumLikeObject<T extends Record<string, Record<string, any> & {
     scenes: Record<string, Record<string, any>>;
-}>, Scene extends keyof T[keyof T]['scenes']>(obj: T, options: {
-    scene: Scene;
-}): {
-    Enum: {
-        [key in keyof T]: T[key]['value'];
-    };
-    List: Array<{
-        key: string;
-        value: T[keyof T]['value'];
-    } & T[keyof T]['scenes'][Scene]>;
-    getLabel: (value: T[keyof T]['value']) => string;
-};
-declare function createEnumLikeObject<T extends Record<string, Record<VK, any> & {
-    scenes: Record<string, Record<string, any>>;
-}>, Scene extends keyof T[keyof T]['scenes'], VK extends keyof T[keyof T] & string>(obj: T, options: {
-    scene: Scene;
-    valueKey: VK;
-}): {
-    Enum: {
-        [key in keyof T]: T[key][VK];
-    };
-    List: Array<{
-        key: string;
-        value: T[keyof T][VK];
-    } & T[keyof T]['scenes'][Scene]>;
-    getLabel: (value: T[keyof T][VK]) => string;
-};
+}>, Scene extends keyof T[keyof T]['scenes'] & string, VK extends string = 'value'>(obj: T, options: ScenesOptions<Scene, VK>): ScenesReturn<T, Scene, VK>;
+declare function createEnumLikeObject<T extends Record<string, Record<string, any> & {
+    label: string;
+}>, N extends string, VK extends string = 'value'>(obj: T, options: NormalNamedOptions<N, VK>): AsNamed<NormalReturn<T, VK>, N>;
+declare function createEnumLikeObject<T extends Record<string, Record<string, any> & {
+    label: string;
+}>, VK extends string = 'value'>(obj: T, options?: NormalOptions<VK>): NormalReturn<T, VK>;
 
 /**
  * simulate a fake api request

package/dist/es/index.mjs

@@ -157,16 +157,12 @@ const FILE_SIZE_UNITS$1 = [
  * @param valueKey value 的 key
  *
  * @example
- *
- * ```js
  * const myObj = {
- *    A: { value: 'a' },
- *    B: { value: 'b', other: 'other' },
- * }
- *
+ *   A: { value: 'a' },
+ *   B: { value: 'b', other: 'other' },
+ * } as const;
  * const enumCode = extractEnumLikeObject(myObj, 'value');
- * console.log(enumCode); // { A: 'a', B: 'b' }
- * ```
+ * // => { A: 'a', B: 'b' }
  */ const extractEnumLikeObject = (enumObject, valueKey)=>Object.entries(enumObject).reduce((acc, [key, value])=>({
             ...acc,
             [key]: value[valueKey]

package/package.json

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