@taicode/common-base 1.4.0 → 1.5.1

package/output/error/error.d.ts

@@ -29,11 +29,23 @@
  *   value: 'invalid-email',
  *   rule: 'email-format'
  * })
+ * // 或者省略 message，直接使用 type 作为消息
+ * const userError2 = new UserError('validation-failed', undefined, {
+ *   field: 'email',
+ *   value: 'invalid-email',
+ *   rule: 'email-format'
+ * })
  * const systemError = new SystemError('database-error', '数据库连接失败', {
  *   table: 'users',
  *   query: 'SELECT * FROM users',
  *   operation: 'select'
  * })
+ * // 或者省略 message
+ * const systemError2 = new SystemError('database-error', undefined, {
+ *   table: 'users',
+ *   query: 'SELECT * FROM users',
+ *   operation: 'select'
+ * })
  * ```
  */
 interface ErrorContext {
@@ -49,20 +61,20 @@ type SystemErrorType = keyof SystemErrorTypes extends never ? string : Extract<k
 type UserErrorContext<T extends string> = T extends keyof UserErrorTypes ? UserErrorTypes[T] & ErrorContext : ErrorContext;
 type SystemErrorContext<T extends string> = T extends keyof SystemErrorTypes ? SystemErrorTypes[T] & ErrorContext : ErrorContext;
 /** 用户可见的错误 */
-export declare class UserError<T extends string = UserErrorType> extends Error {
+export declare class UserError<T extends UserErrorType = UserErrorType> extends Error {
     type: T;
     message: string;
     context?: UserErrorContext<T> | undefined;
-    constructor(type: T, message: string, context?: UserErrorContext<T> | undefined);
-    static is<T extends string = UserErrorType>(error: unknown): error is UserError<T>;
+    constructor(type: T, message?: string, context?: UserErrorContext<T> | undefined);
+    static is<T extends UserErrorType = UserErrorType>(error: unknown): error is UserError<T>;
 }
 /** 系统错误 */
-export declare class SystemError<T extends string = SystemErrorType> extends Error {
+export declare class SystemError<T extends SystemErrorType = SystemErrorType> extends Error {
     type: T;
     message: string;
     context?: SystemErrorContext<T> | undefined;
-    constructor(type: T, message: string, context?: SystemErrorContext<T> | undefined);
-    static is<T extends string = SystemErrorType>(error: unknown): error is SystemError<T>;
+    constructor(type: T, message?: string, context?: SystemErrorContext<T> | undefined);
+    static is<T extends SystemErrorType = SystemErrorType>(error: unknown): error is SystemError<T>;
 }
 export declare class UnknownError extends Error {
     context?: ErrorContext | undefined;

package/output/error/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../source/error/error.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,UAAU,YAAY;IACpB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAID,MAAM,WAAW,cAAc;CAAG;AAClC,MAAM,WAAW,gBAAgB;CAAG;AAGpC,KAAK,aAAa,GAAG,MAAM,cAAc,SAAS,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,cAAc,EAAE,MAAM,CAAC,CAAA;AACxG,KAAK,eAAe,GAAG,MAAM,gBAAgB,SAAS,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,gBAAgB,EAAE,MAAM,CAAC,CAAA;AAG9G,KAAK,gBAAgB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,cAAc,GACpE,cAAc,CAAC,CAAC,CAAC,GAAG,YAAY,GAChC,YAAY,CAAA;AAEhB,KAAK,kBAAkB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,gBAAgB,GACxE,gBAAgB,CAAC,CAAC,CAAC,GAAG,YAAY,GAClC,YAAY,CAAA;AAEhB,cAAc;AACd,qBAAa,SAAS,CAAC,CAAC,SAAS,MAAM,GAAG,aAAa,CAAE,SAAQ,KAAK;IACjD,IAAI,EAAE,CAAC;IAAS,OAAO,EAAE,MAAM;IAAS,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC;gBAArE,IAAI,EAAE,CAAC,EAAS,OAAO,EAAE,MAAM,EAAS,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,YAAA;IAKxF,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,MAAM,GAAG,aAAa,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC;CAGnF;AAED,WAAW;AACX,qBAAa,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,eAAe,CAAE,SAAQ,KAAK;IACrD,IAAI,EAAE,CAAC;IAAS,OAAO,EAAE,MAAM;IAAS,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC;gBAAvE,IAAI,EAAE,CAAC,EAAS,OAAO,EAAE,MAAM,EAAS,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,YAAA;IAK1F,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,MAAM,GAAG,eAAe,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAAC,CAAC,CAAC;CAGvF;AAED,qBAAa,YAAa,SAAQ,KAAK;IACD,OAAO,CAAC,EAAE,YAAY;gBAA9C,OAAO,EAAE,MAAM,EAAS,OAAO,CAAC,EAAE,YAAY,YAAA;IAK1D,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY;CAGjD"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../source/error/error.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AAEH,UAAU,YAAY;IACpB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAID,MAAM,WAAW,cAAc;CAAG;AAClC,MAAM,WAAW,gBAAgB;CAAG;AAGpC,KAAK,aAAa,GAAG,MAAM,cAAc,SAAS,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,cAAc,EAAE,MAAM,CAAC,CAAA;AACxG,KAAK,eAAe,GAAG,MAAM,gBAAgB,SAAS,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,gBAAgB,EAAE,MAAM,CAAC,CAAA;AAG9G,KAAK,gBAAgB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,cAAc,GACpE,cAAc,CAAC,CAAC,CAAC,GAAG,YAAY,GAChC,YAAY,CAAA;AAEhB,KAAK,kBAAkB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,gBAAgB,GACxE,gBAAgB,CAAC,CAAC,CAAC,GAAG,YAAY,GAClC,YAAY,CAAA;AAEhB,cAAc;AACd,qBAAa,SAAS,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,KAAK;IACxD,IAAI,EAAE,CAAC;IAAS,OAAO,EAAE,MAAM;IAAc,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC;gBAA1E,IAAI,EAAE,CAAC,EAAS,OAAO,GAAE,MAAW,EAAS,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,YAAA;IAK7F,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC;CAG1F;AAED,WAAW;AACX,qBAAa,WAAW,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,CAAE,SAAQ,KAAK;IAC9D,IAAI,EAAE,CAAC;IAAS,OAAO,EAAE,MAAM;IAAc,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC;gBAA5E,IAAI,EAAE,CAAC,EAAS,OAAO,GAAE,MAAW,EAAS,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,YAAA;IAK/F,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAAC,CAAC,CAAC;CAGhG;AAED,qBAAa,YAAa,SAAQ,KAAK;IACD,OAAO,CAAC,EAAE,YAAY;gBAA9C,OAAO,EAAE,MAAM,EAAS,OAAO,CAAC,EAAE,YAAY,YAAA;IAK1D,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY;CAGjD"}

package/output/error/error.js

@@ -29,11 +29,23 @@
  *   value: 'invalid-email',
  *   rule: 'email-format'
  * })
+ * // 或者省略 message，直接使用 type 作为消息
+ * const userError2 = new UserError('validation-failed', undefined, {
+ *   field: 'email',
+ *   value: 'invalid-email',
+ *   rule: 'email-format'
+ * })
  * const systemError = new SystemError('database-error', '数据库连接失败', {
  *   table: 'users',
  *   query: 'SELECT * FROM users',
  *   operation: 'select'
  * })
+ * // 或者省略 message
+ * const systemError2 = new SystemError('database-error', undefined, {
+ *   table: 'users',
+ *   query: 'SELECT * FROM users',
+ *   operation: 'select'
+ * })
  * ```
  */
 /** 用户可见的错误 */
@@ -41,7 +53,7 @@ export class UserError extends Error {
     type;
     message;
     context;
-    constructor(type, message, context) {
+    constructor(type, message = '', context) {
         super(message, context);
         this.type = type;
         this.message = message;
@@ -57,7 +69,7 @@ export class SystemError extends Error {
     type;
     message;
     context;
-    constructor(type, message, context) {
+    constructor(type, message = '', context) {
         super(message, context);
         this.type = type;
         this.message = message;

package/output/error/error.test.d.ts

@@ -1,2 +1,19 @@
+declare module './error' {
+    interface UserErrorTypes {
+        VALIDATION_ERROR: unknown;
+        TEST_ERROR: unknown;
+        USER_ERROR: unknown;
+        REQUIRED_FIELD: unknown;
+        INVALID_FORMAT: unknown;
+        OUT_OF_RANGE: unknown;
+    }
+    interface SystemErrorTypes {
+        DATABASE_ERROR: unknown;
+        NETWORK_ERROR: unknown;
+        FILE_ERROR: unknown;
+        TEST_ERROR: unknown;
+        SYSTEM_ERROR: unknown;
+    }
+}
 export {};
 //# sourceMappingURL=error.test.d.ts.map

package/output/error/error.test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.test.d.ts","sourceRoot":"","sources":["../../source/error/error.test.ts"],"names":[],"mappings":""}
+{"version":3,"file":"error.test.d.ts","sourceRoot":"","sources":["../../source/error/error.test.ts"],"names":[],"mappings":"AAGA,OAAO,QAAQ,SAAS,CAAC;IACvB,UAAU,cAAc;QACtB,gBAAgB,EAAE,OAAO,CAAA;QACzB,UAAU,EAAE,OAAO,CAAA;QACnB,UAAU,EAAE,OAAO,CAAA;QACnB,cAAc,EAAE,OAAO,CAAA;QACvB,cAAc,EAAE,OAAO,CAAA;QACvB,YAAY,EAAE,OAAO,CAAA;KACtB;IAED,UAAU,gBAAgB;QACxB,cAAc,EAAE,OAAO,CAAA;QACvB,aAAa,EAAE,OAAO,CAAA;QACtB,UAAU,EAAE,OAAO,CAAA;QACnB,UAAU,EAAE,OAAO,CAAA;QACnB,YAAY,EAAE,OAAO,CAAA;KACtB;CACF"}

package/output/error/error.test.js

@@ -12,6 +12,33 @@ describe('UserError', () => {
             expect(error.type).toBe(type);
             expect(error.message).toBe(message);
         });
+        it('应该在未提供message时使用空字符串作为默认message', () => {
+            const type = 'VALIDATION_ERROR';
+            const error = new UserError(type);
+            expect(error).toBeInstanceOf(Error);
+            expect(error).toBeInstanceOf(UserError);
+            expect(error.name).toBe('UserError');
+            expect(error.type).toBe(type);
+            expect(error.message).toBe('');
+        });
+        it('应该在提供undefined message时使用空字符串作为默认message', () => {
+            const type = 'VALIDATION_ERROR';
+            const error = new UserError(type, undefined);
+            expect(error).toBeInstanceOf(Error);
+            expect(error).toBeInstanceOf(UserError);
+            expect(error.name).toBe('UserError');
+            expect(error.type).toBe(type);
+            expect(error.message).toBe('');
+        });
+        it('应该在提供空字符串message时保持空字符串', () => {
+            const type = 'VALIDATION_ERROR';
+            const error = new UserError(type, '');
+            expect(error).toBeInstanceOf(Error);
+            expect(error).toBeInstanceOf(UserError);
+            expect(error.name).toBe('UserError');
+            expect(error.type).toBe(type);
+            expect(error.message).toBe('');
+        });
         it('应该支持ErrorOptions参数', () => {
             const type = 'VALIDATION_ERROR';
             const message = '输入验证失败';
@@ -19,6 +46,13 @@ describe('UserError', () => {
             const error = new UserError(type, message, { cause });
             expect(error.cause).toBe(cause);
         });
+        it('应该支持ErrorOptions参数且message为可选', () => {
+            const type = 'VALIDATION_ERROR';
+            const cause = new Error('原始错误');
+            const error = new UserError(type, undefined, { cause });
+            expect(error.cause).toBe(cause);
+            expect(error.message).toBe('');
+        });
         it('应该正确设置错误堆栈信息', () => {
             const error = new UserError('TEST_ERROR', '测试错误');
             expect(error.stack).toBeDefined();
@@ -84,6 +118,33 @@ describe('SystemError', () => {
             expect(error.type).toBe(type);
             expect(error.message).toBe(message);
         });
+        it('应该在未提供message时使用空字符串作为默认message', () => {
+            const type = 'DATABASE_ERROR';
+            const error = new SystemError(type);
+            expect(error).toBeInstanceOf(Error);
+            expect(error).toBeInstanceOf(SystemError);
+            expect(error.name).toBe('SystemError');
+            expect(error.type).toBe(type);
+            expect(error.message).toBe('');
+        });
+        it('应该在提供undefined message时使用空字符串作为默认message', () => {
+            const type = 'DATABASE_ERROR';
+            const error = new SystemError(type, undefined);
+            expect(error).toBeInstanceOf(Error);
+            expect(error).toBeInstanceOf(SystemError);
+            expect(error.name).toBe('SystemError');
+            expect(error.type).toBe(type);
+            expect(error.message).toBe('');
+        });
+        it('应该在提供空字符串message时保持空字符串', () => {
+            const type = 'DATABASE_ERROR';
+            const error = new SystemError(type, '');
+            expect(error).toBeInstanceOf(Error);
+            expect(error).toBeInstanceOf(SystemError);
+            expect(error.name).toBe('SystemError');
+            expect(error.type).toBe(type);
+            expect(error.message).toBe('');
+        });
         it('应该支持ErrorOptions参数', () => {
             const type = 'NETWORK_ERROR';
             const message = '网络请求失败';
@@ -91,6 +152,13 @@ describe('SystemError', () => {
             const error = new SystemError(type, message, { cause });
             expect(error.cause).toBe(cause);
         });
+        it('应该支持ErrorOptions参数且message为可选', () => {
+            const type = 'NETWORK_ERROR';
+            const cause = new Error('连接超时');
+            const error = new SystemError(type, undefined, { cause });
+            expect(error.cause).toBe(cause);
+            expect(error.message).toBe('');
+        });
         it('应该正确设置错误堆栈信息', () => {
             const error = new SystemError('FILE_ERROR', '文件读取失败');
             expect(error.stack).toBeDefined();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taicode/common-base",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "author": "Alain",
   "license": "ISC",
   "description": "",
@@ -21,6 +21,7 @@
   "scripts": {
     "test": "vitest run",
     "build": "tsc -p tsconfig.json",
+    "prepublishOnly": "npm run build",
     "dev": "tsc -p tsconfig.json --watch"
   },
   "files": [