feat: support enum item literals for array initialization format

Author: shijistar

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 # enum-plus Changelog
 
+## 2.3.2
+
+2025-6-10
+
+### Features
+
+- ✨ Improve type IntelliSense for array initialization Enums, allowing enum items to be listed as literals.
+
 ## 2.3.1
 
 2025-6-7

package.json

@@ -1,6 +1,6 @@
 {
   "name": "enum-plus",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "description": "A drop-in replacement for native enum. Like native enum but much better!",
   "keywords": [
     "enum",

src/enum.ts

@@ -1,12 +1,12 @@
 import { EnumCollectionClass, EnumExtensionClass } from './enum-collection';
 import type {
+  ArrayToMap,
   EnumInit,
   EnumInitOptions,
   EnumKey,
   EnumValue,
   IEnum,
   LabelOnlyEnumItemInit,
-  StandardEnumInit,
   ValueTypeFromSingleInit,
 } from './types';
 import { defaultLocalize } from './utils';
@@ -43,22 +43,20 @@ export function Enum<
  *   const Week = Enum([
  *     { value: 0, label: 'Sunday', key: 'Sun' },
  *     { value: 1, label: 'Monday', key: 'Mon' },
- *   ]);
+ *   ] as const);
  *
  * @param init Init objects array | 初始化对象数组
  * @param options Generate options | 生成选项
  *
  * @returns Enum collection | 枚举集合
  */
 export function Enum<
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  T extends Record<string, any>,
-  K extends EnumKey<T> = EnumKey<T>,
-  V extends EnumValue = ValueTypeFromSingleInit<T[K], K>,
->(
-  init: T[],
-  options?: EnumInitOptions<T, K, V>
-): IEnum<StandardEnumInit<string, V>, string, V> & EnumExtension<T, K, V>;
+  A extends Record<string, unknown>[] | readonly Record<string, unknown>[],
+  K extends EnumKey<ArrayToMap<A>> = EnumKey<ArrayToMap<A>>,
+  // @ts-expect-error: because no constraint on items of A, so ValueTypeFromSingleInit<ArrayToMap<A>[K], K> does not satisfy EnumValue
+  V extends EnumValue = ValueTypeFromSingleInit<ArrayToMap<A>[K], K>,
+  // @ts-expect-error: because no constraint on items of A, so ArrayToMap<A> does not satisfy EnumInit<K, V>
+>(init: A, options?: EnumInitOptions<A[number], K, V>): IEnum<ArrayToMap<A>, K, V> & EnumExtension<ArrayToMap<A>, K, V>;
 export function Enum<
   T extends EnumInit<K, V>,
   K extends EnumKey<T> = EnumKey<T>,

src/index.ts

@@ -14,6 +14,8 @@ export type {
   MenuItemOption,
   ColumnFilterItem,
   EnumInitOptions,
+  FindEnumKeyByValue,
+  ArrayToMap,
 } from './types';
 export type { EnumItemClass } from './enum-item';
 

src/types.ts

@@ -559,6 +559,14 @@ export type ValueTypeFromEnumInit<T, K extends EnumKey<T> = EnumKey<T>> =
                     ? K
                     : K; // Unknown format, use key as value
 
+/**
+ * **EN:** Find the key of the enumeration item by value
+ *
+ * **CN:** 通过值查找枚举项的key
+ *
+ * @template T Enum collection initialization data type | 枚举集合初始化数据的类型
+ * @template V Enum value type | 枚举值的类型
+ */
 export type FindEnumKeyByValue<T, V extends EnumValue> = {
   // ValueOnly { foo:1, bar:2 }
   [K in keyof T]: T[K] extends V
@@ -579,3 +587,16 @@ export type FindEnumKeyByValue<T, V extends EnumValue> = {
             : never
           : never;
 }[keyof T];
+
+/**
+ * **EN:** Convert an array of objects to a Map-like object, where the key is the `key` field of the
+ * object, and the value is the `value` field of the object
+ *
+ * **CN:** 将对象数组转换为类似Map的对象，其中key为对象的`key`字段，value为对象的`value`字段
+ *
+ * @template A Array type | 数组类型
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type ArrayToMap<A extends Record<string, any>[] | readonly Record<string, any>[]> = {
+  [K in A[number]['key']]: Extract<A[number], { key?: K }>;
+};