ts-enum-next 1.0.7 → 1.0.9

package/README.md

@@ -98,7 +98,7 @@ console.log(statusMessages.get(HttpStatus.NOT_FOUND)); // "The resource does not
 - Generate options for Ant Design `Select`
 
 ```ts
-import { Enum, enumOptions } from "ts-enum-next";
+import { Enum } from "ts-enum-next";
 
 class HttpStatus extends Enum<number> {
   static readonly OK = new HttpStatus(200, "OK", "Request succeeded");
@@ -110,12 +110,12 @@ class HttpStatus extends Enum<number> {
   static readonly NOT_FOUND = new HttpStatus(404, "NOT_FOUND");
 }
 
-const options = enumOptions(HttpStatus);
+const options = HttpStatus.enumOptions();
 // options:
 // [
-//   { label: "OK", value: 200 },
-//   { label: "BAD_REQUEST", value: 400 },
-//   { label: "NOT_FOUND", value: 404 }
+//   { label: "OK", value: 200, name: "OK", description: "Request succeeded" },
+//   { label: "BAD_REQUEST", value: 400, name: "BAD_REQUEST", description: "Error request" },
+//   { label: "NOT_FOUND", value: 404, name: "NOT_FOUND" }
 // ]
 ```
 

package/README.zh-CN.md

@@ -163,7 +163,7 @@ console.log(statusMessages.get(HttpStatus.NOT_FOUND)); // “请求的资源不
 ### 场景 7：为 Ant Design `Select` 生成枚举下拉项
 
 ```ts
-import { Enum, enumOptions } from "ts-enum-next";
+import { Enum } from "ts-enum-next";
 
 class HttpStatus extends Enum<number> {
     static readonly OK = new HttpStatus(200, "OK", "请求成功");
@@ -171,12 +171,12 @@ class HttpStatus extends Enum<number> {
     static readonly NOT_FOUND = new HttpStatus(404, "NOT_FOUND", "资源未找到");
 }
 
-const options = enumOptions(HttpStatus);
+const options = HttpStatus.enumOptions();
 // options:
 // [
-//   { label: "OK", value: 200 },
-//   { label: "BAD_REQUEST", value: 400 },
-//   { label: "NOT_FOUND", value: 404 }
+//   { label: "OK", value: 200, name: "OK", description: "请求成功" },
+//   { label: "BAD_REQUEST", value: 400, name: "BAD_REQUEST", description: "错误请求" },
+//   { label: "NOT_FOUND", value: 404, name: "NOT_FOUND", description: "资源未找到" }
 // ]
 ```
 

package/dist/index.d.ts

@@ -15,10 +15,14 @@ declare abstract class Enum<T extends string | number = string | number> {
      */
     description?: unknown | undefined);
     static values<T extends Enum>(this: new (...args: any[]) => T): T[];
-    static fromValue<T extends Enum>(this: new (...args: any[]) => T, value: T['value']): T;
-    static fromName<T extends Enum>(this: new (...args: any[]) => T, name: string): T;
+    static fromValue<T extends Enum>(this: new (...args: any[]) => T, value: T['value']): T | undefined;
+    static fromName<T extends Enum>(this: new (...args: any[]) => T, name: string): T | undefined;
     static setOf<T extends Enum>(this: new (...args: any[]) => T, ...items: T[]): Set<T>;
     static enumMap<V, T extends Enum = Enum>(this: new (...args: any[]) => T, map: Record<string | number, V>): Map<T, V>;
+    static enumOptions<T extends Enum>(this: new (...args: any[]) => T): Array<T & {
+        label: string;
+        value: T['value'];
+    }>;
     toString(): string;
     valueOf(): string;
 }

package/dist/index.js

@@ -25,19 +25,21 @@ class Enum {
     }
     // 通过值获取枚举实例
     static fromValue(value) {
-        const enumInstance = Enum._valueMap.get(this)?.get(value);
-        if (!enumInstance) {
-            throw new Error(`No enum value ${value} found`);
-        }
-        return enumInstance;
+        if (value === undefined || value === null)
+            return undefined;
+        const valueMap = Enum._valueMap.get(this);
+        if (!valueMap)
+            return undefined;
+        return valueMap.get(value);
     }
     // 通过名称获取枚举实例
     static fromName(name) {
-        const enumInstance = Enum._nameMap.get(this)?.get(name);
-        if (!enumInstance) {
-            throw new Error(`No enum name ${name} found`);
-        }
-        return enumInstance;
+        if (name === undefined || name === null || name === '')
+            return undefined;
+        const nameMap = Enum._nameMap.get(this);
+        if (!nameMap)
+            return undefined;
+        return nameMap.get(name);
     }
     // 创建枚举集合
     static setOf(...items) {
@@ -65,6 +67,15 @@ class Enum {
         }
         return result;
     }
+    // 获取枚举选项数组，用于 Ant Design Select 组件
+    static enumOptions() {
+        const values = this.values();
+        return values.map((i) => ({
+            ...i,
+            label: i.name,
+            value: i.value,
+        }));
+    }
     // 重写toString方法
     toString() {
         return this.name;

package/dist/index.test.js

@@ -88,11 +88,15 @@ describe('Enum', () => {
             expect(HttpStatus.fromValue(404)).toBe(HttpStatus.NOT_FOUND);
             expect(HttpStatus.fromValue(500)).toBe(HttpStatus.SERVER_ERROR);
         });
-        it('should throw error for non-existent numeric value', () => {
-            expect(() => HttpStatus.fromValue(999)).toThrow('No enum value 999 found');
+        it('should return undefined for non-existent numeric value', () => {
+            expect(HttpStatus.fromValue(999)).toBeUndefined();
         });
-        it('should throw error for non-existent string value', () => {
-            expect(() => OrderStatus.fromValue('INVALID')).toThrow('No enum value INVALID found');
+        it('should return undefined for non-existent string value', () => {
+            expect(OrderStatus.fromValue('INVALID')).toBeUndefined();
+        });
+        it('should return undefined when value is null or undefined', () => {
+            expect(HttpStatus.fromValue(undefined)).toBeUndefined();
+            expect(HttpStatus.fromValue(null)).toBeUndefined();
         });
     });
     describe('fromName()', () => {
@@ -111,11 +115,16 @@ describe('Enum', () => {
             expect(HttpStatus.fromName('NOT_FOUND')).toBe(HttpStatus.NOT_FOUND);
             expect(HttpStatus.fromName('SERVER_ERROR')).toBe(HttpStatus.SERVER_ERROR);
         });
-        it('should throw error for non-existent name', () => {
-            expect(() => HttpStatus.fromName('INVALID')).toThrow('No enum name INVALID found');
+        it('should return undefined for non-existent name', () => {
+            expect(HttpStatus.fromName('INVALID')).toBeUndefined();
         });
         it('should be case-sensitive', () => {
-            expect(() => HttpStatus.fromName('ok')).toThrow('No enum name ok found');
+            expect(HttpStatus.fromName('ok')).toBeUndefined();
+        });
+        it('should return undefined when name is null, undefined or empty string', () => {
+            expect(HttpStatus.fromName(undefined)).toBeUndefined();
+            expect(HttpStatus.fromName(null)).toBeUndefined();
+            expect(HttpStatus.fromName('')).toBeUndefined();
         });
     });
     describe('setOf()', () => {
@@ -208,6 +217,50 @@ describe('Enum', () => {
             expect(statusConfig.get(HttpStatus.NOT_FOUND)).toEqual({ color: 'red', icon: 'error' });
         });
     });
+    describe('enumOptions()', () => {
+        it('should return options array for numeric enum', () => {
+            const options = HttpStatus.enumOptions();
+            expect(options).toHaveLength(5);
+            expect(options[0]).toEqual({
+                value: 200,
+                name: 'OK',
+                description: 'Request succeeded',
+                label: 'OK'
+            });
+        });
+        it('should return options array for string enum', () => {
+            const options = OrderStatus.enumOptions();
+            expect(options).toHaveLength(4);
+            expect(options[0]).toEqual({
+                value: 'PENDING',
+                name: 'Pending',
+                description: 'Order is pending',
+                label: 'Pending'
+            });
+        });
+        it('should return options array for enum without description', () => {
+            const options = Priority.enumOptions();
+            expect(options).toHaveLength(3);
+            expect(options[0]).toEqual({
+                value: 1,
+                name: 'LOW',
+                description: undefined,
+                label: 'LOW'
+            });
+        });
+        it('should have correct label and value for each option', () => {
+            const options = HttpStatus.enumOptions();
+            const okOption = options.find(opt => opt.value === 200);
+            expect(okOption.label).toBe('OK');
+            expect(okOption.value).toBe(200);
+        });
+        it('should preserve all enum properties in options', () => {
+            const options = HttpStatus.enumOptions();
+            const notFoundOption = options.find(opt => opt.value === 404);
+            expect(notFoundOption.name).toBe('NOT_FOUND');
+            expect(notFoundOption.description).toBe('Resource not found');
+        });
+    });
     describe('toString()', () => {
         it('should return the name', () => {
             expect(HttpStatus.OK.toString()).toBe('OK');
@@ -240,12 +293,12 @@ describe('Enum', () => {
         });
         it('should not interfere with each other when querying by value', () => {
             // 虽然值相同，但是不同的枚举类
-            expect(() => HttpStatus.fromValue('PENDING')).toThrow();
-            expect(() => OrderStatus.fromValue(200)).toThrow();
+            expect(HttpStatus.fromValue('PENDING')).toBeUndefined();
+            expect(OrderStatus.fromValue(200)).toBeUndefined();
         });
         it('should not interfere with each other when querying by name', () => {
-            expect(() => HttpStatus.fromName('Pending')).toThrow();
-            expect(() => OrderStatus.fromName('OK')).toThrow();
+            expect(HttpStatus.fromName('Pending')).toBeUndefined();
+            expect(OrderStatus.fromName('OK')).toBeUndefined();
         });
     });
     describe('Edge cases', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-enum-next",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Ultimate Enum Enhancement for TypeScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",