@taicode/common-base 1.5.0 → 1.6.0

package/output/catch/catch.d.ts

@@ -1,9 +1,21 @@
 type CatchType<F extends () => unknown> = F extends () => PromiseLike<infer R> ? R : F extends () => infer R ? R : never;
+/**
+ * 成功结果类型：[result, undefined]
+ */
+export type CatchSuccess<T> = [T, undefined];
+/**
+ * 失败结果类型：[undefined, error]
+ */
+export type CatchFailure = [undefined, unknown];
+/**
+ * 捕获结果联合类型，提供更好的类型判断
+ */
+export type CatchResult<T> = CatchSuccess<T> | CatchFailure;
 /**
  * 通用错误捕获函数，支持 PromiseLike 和函数执行
- * 将结果转换成 [result, error] 的形式
+ * 返回 [result, error] 的联合类型，便于类型判断
  */
-export declare function catchIt<T>(input: PromiseLike<T>): Promise<[T | undefined, unknown]>;
-export declare function catchIt<F extends () => unknown>(input: F): Promise<[CatchType<F> | undefined, unknown]>;
+export declare function catchIt<T>(input: PromiseLike<T>): Promise<CatchResult<T>>;
+export declare function catchIt<F extends () => unknown>(input: F): Promise<CatchResult<CatchType<F>>>;
 export {};
 //# sourceMappingURL=catch.d.ts.map

package/output/catch/catch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"catch.d.ts","sourceRoot":"","sources":["../../source/catch/catch.ts"],"names":[],"mappings":"AAKA,KAAK,SAAS,CAAC,CAAC,SAAS,MAAM,OAAO,IAAI,CAAC,SAAS,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;AAExH;;;GAGG;AACH,wBAAsB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,EAAE,OAAO,CAAC,CAAC,CAAA;AAC1F,wBAAsB,OAAO,CAAC,CAAC,SAAS,MAAM,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,EAAE,OAAO,CAAC,CAAC,CAAA"}
+{"version":3,"file":"catch.d.ts","sourceRoot":"","sources":["../../source/catch/catch.ts"],"names":[],"mappings":"AAKA,KAAK,SAAS,CAAC,CAAC,SAAS,MAAM,OAAO,IAAI,CAAC,SAAS,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;AAExH;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;AAE5C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;AAE/C;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAA;AAE3D;;;GAGG;AACH,wBAAsB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;AAChF,wBAAsB,OAAO,CAAC,CAAC,SAAS,MAAM,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA"}

package/output/catch/catch.js

@@ -3,13 +3,11 @@ function isPromiseLike(value) {
     return value != null && typeof value === 'object' && 'then' in value && typeof value.then === 'function';
 }
 export async function catchIt(input) {
-    const returned = [undefined, undefined];
     try {
         if (isPromiseLike(input)) {
             // 处理 PromiseLike
-            await Promise.resolve(input)
-                .then((result) => (returned[0] = result))
-                .catch((error) => (returned[1] = error));
+            const result = await Promise.resolve(input);
+            return [result, undefined];
         }
         else if (typeof input === 'function') {
             // 处理函数
@@ -19,12 +17,13 @@ export async function catchIt(input) {
                 return catchIt(result);
             }
             else {
-                returned[0] = result;
+                return [result, undefined];
             }
         }
     }
     catch (error) {
-        returned[1] = error;
+        return [undefined, error];
     }
-    return returned;
+    // 这里不应该到达，但为了类型安全
+    return [undefined, new Error('Unexpected input type')];
 }

package/output/catch/catch.test.js

@@ -360,4 +360,31 @@ describe('catchIt', () => {
             expect(error).toBeUndefined();
         });
     });
+    describe('类型判断优化', () => {
+        it('应该支持联合类型的类型判断', async () => {
+            // 成功情况的类型判断
+            const successResult = await catchIt(Promise.resolve('success'));
+            if (successResult[1] === undefined) {
+                // 在这个分支中，TypeScript 应该能够推断出 successResult[0] 是 string 类型
+                expect(typeof successResult[0]).toBe('string');
+                expect(successResult[0]).toBe('success');
+            }
+            // 失败情况的类型判断
+            const failureResult = await catchIt(Promise.reject(new Error('failed')));
+            if (failureResult[0] === undefined) {
+                // 在这个分支中，TypeScript 应该能够推断出 failureResult[1] 是 unknown 类型
+                expect(failureResult[1]).toBeInstanceOf(Error);
+                expect(failureResult[1].message).toBe('failed');
+            }
+        });
+        it('应该支持函数的类型判断', async () => {
+            const fn = () => 42;
+            const result = await catchIt(fn);
+            if (result[1] === undefined) {
+                // 成功情况下，result[0] 应该是 number 类型
+                expect(typeof result[0]).toBe('number');
+                expect(result[0]).toBe(42);
+            }
+        });
+    });
 });

package/output/error/error.d.ts

@@ -61,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>;
+    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>;
+    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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,MAAM,GAAG,aAAa,CAAE,SAAQ,KAAK;IACjD,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,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;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,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.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taicode/common-base",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "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": [