@ticatec/restful_service_api 0.3.0 → 0.6.0

package/README-CN.md

@@ -18,6 +18,34 @@
 - 🌐 **浏览器优先**: 专为前端应用程序设计
 - ✨ **PATCH 支持**: 完整支持 HTTP PATCH 方法进行部分更新
 
+## ⚠️ v0.5.0 重大变更
+
+**从 0.5.0 版本开始，此包已迁移到 ESM (ECMAScript Modules) 格式。**
+
+### 对您的影响
+
+- 您的项目必须使用 ESM 格式（package.json 中包含 `"type": "module"` 或使用 `.mjs` 扩展名）
+- 不再支持 `require()`，请使用 `import` 语句
+
+### 迁移指南
+
+如果您正在从 0.5.0 之前的版本升级：
+
+**之前 (CommonJS):**
+```javascript
+const RestService = require('@ticatec/restful_service_api');
+```
+
+**之后 (ESM):**
+```typescript
+import RestService from '@ticatec/restful_service_api';
+```
+
+对于 CommonJS 项目，您可能需要使用动态导入：
+```javascript
+const { default: RestService } = await import('@ticatec/restful_service_api');
+```
+
 ## 安装
 
 ```bash

package/README.md

@@ -18,6 +18,33 @@ A lightweight TypeScript RESTful API client for browsers with comprehensive erro
 - 🌐 **Browser-First**: Designed specifically for frontend applications
 - ✨ **PATCH Support**: Full support for HTTP PATCH method for partial updates
 
+## ⚠️ Breaking Changes in v0.5.0
+
+**Starting from version 0.5.0, this package has migrated to ESM (ECMAScript Modules) format.**
+
+### What This Means for You
+
+- Your project must use ESM format (have `"type": "module"` in package.json or use `.mjs` extension)
+- `require()` is no longer supported. Use `import` statements instead
+### Migration Guide
+
+If you're upgrading from a version prior to 0.5.0:
+
+**Before (CommonJS):**
+```javascript
+const RestService = require('@ticatec/restful_service_api');
+```
+
+**After (ESM):**
+```typescript
+import RestService from '@ticatec/restful_service_api';
+```
+
+For CommonJS projects, you may need to use dynamic import:
+```javascript
+const { default: RestService } = await import('@ticatec/restful_service_api');
+```
+
 ## Installation
 
 ```bash

package/dist/ApiError.d.ts

@@ -8,19 +8,25 @@ export default class ApiError extends Error {
     /**
      * Error code from the API response
      */
-    get code(): any;
+    get code(): string;
     /**
      * Detailed error information from the API response
      */
-    get details(): any;
+    get details(): ApiErrorPayload;
     /**
      * HTTP status code of the error response
      */
-    get status(): any;
+    get status(): string | number;
     /**
      * Creates a new API error instance
      * @param status HTTP status code
      * @param err Error object containing code and details
      */
-    constructor(status: any, err: any);
+    constructor(status: number | string, err?: ApiErrorPayload | Error | string);
+}
+/** Error details returned by an API or produced by a request failure. */
+export interface ApiErrorPayload {
+    code?: string;
+    message?: string;
+    [key: string]: unknown;
 }

package/dist/ApiError.js

@@ -26,10 +26,22 @@ export default class ApiError extends Error {
      * @param err Error object containing code and details
      */
     constructor(status, err) {
-        super(err.code);
+        var _a, _b;
+        const details = normalizeError(err);
+        const code = (_b = (_a = details.code) !== null && _a !== void 0 ? _a : details.message) !== null && _b !== void 0 ? _b : 'UNKNOWN_ERROR';
+        super(code);
         this.name = this.constructor.name;
-        this._code = err.code;
+        this._code = code;
         this._status = status;
-        this._details = err;
+        this._details = details;
     }
 }
+const normalizeError = (err) => {
+    if (typeof err === 'string') {
+        return { code: err, message: err };
+    }
+    if (err instanceof Error) {
+        return { code: 'UNKNOWN_ERROR', message: err.message, cause: err };
+    }
+    return err !== null && err !== void 0 ? err : { code: 'UNKNOWN_ERROR' };
+};

package/dist/FileService.d.ts

@@ -1,5 +1,6 @@
-import UploadCallback from "./UploadCallback";
-import { DataProcessor } from "./RestService";
+import type UploadCallback from "./UploadCallback";
+import type { UploadProgress } from "./UploadCallback";
+import type { DataProcessor } from "./RestService";
 /**
  * File service interface for file upload and download operations
  */
@@ -60,7 +61,7 @@ export default interface FileService {
      * progress.abort();
      * ```
      */
-    asyncUpload(url: string, params: any, file: File, callback: UploadCallback, fileKey?: string): Promise<import("./UploadCallback").UploadProgress>;
+    asyncUpload(url: string, params: any, file: File, callback: UploadCallback, fileKey?: string): Promise<UploadProgress>;
     /**
      * Performs file download operation
      * @param url The URL path to download the file

package/dist/RestService.d.ts

@@ -14,7 +14,7 @@ export interface PreInterceptorResult {
 /**
  * Data processor function type for transforming response data
  */
-export type DataProcessor = (data: any) => any;
+export type DataProcessor<T = any> = (data: any) => T;
 /**
  * Pre-interceptor function type for modifying requests before sending
  * @param method HTTP method (GET, POST, etc.)
@@ -37,7 +37,7 @@ export type ErrorHandler = (ex: Error) => boolean;
 /**
  * RESTful API request options
  */
-export type RestfulOptions = {
+export type RestfulOptions<T = any> = {
     /**
      * Optional Content-Type header, defaults to 'application/json'
      */
@@ -45,7 +45,7 @@ export type RestfulOptions = {
     /**
      * Optional data processing function to transform response data before returning
      */
-    dataProcessor?: DataProcessor;
+    dataProcessor?: DataProcessor<T>;
     /**
      * Optional query parameters object that will be converted to URL query string
      */
@@ -90,7 +90,7 @@ export default interface RestService {
      * const users = await restService.get('/api/users', null, (data) => data.items);
      * ```
      */
-    get(url: string, params?: any, dataProcessor?: DataProcessor): Promise<any>;
+    get<T = any>(url: string, params?: any, dataProcessor?: DataProcessor<T>): Promise<T>;
     /**
      * Performs an HTTP POST request to create a new resource
      * @param url The target URL path for the request
@@ -114,7 +114,7 @@ export default interface RestService {
      * });
      * ```
      */
-    post(url: string, data?: any, options?: RestfulOptions): Promise<any>;
+    post<T = any>(url: string, data?: any, options?: RestfulOptions<T>): Promise<T>;
     /**
      * Performs an HTTP PUT request to update an existing resource
      * @param url The target URL path for the request
@@ -131,7 +131,7 @@ export default interface RestService {
      * const result = await restService.put('/api/users/123/toggle-status');
      * ```
      */
-    put(url: string, data?: any, options?: RestfulOptions): Promise<any>;
+    put<T = any>(url: string, data?: any, options?: RestfulOptions<T>): Promise<T>;
     /**
      * Performs an HTTP DELETE request to delete a resource
      * @param url The target URL path for the request
@@ -148,7 +148,7 @@ export default interface RestService {
      * await restService.del('/api/users/batch', { ids: [1, 2, 3] });
      * ```
      */
-    del(url: string, data?: any, options?: RestfulOptions): Promise<any>;
+    del<T = any>(url: string, data?: any, options?: RestfulOptions<T>): Promise<T>;
     /**
      * Performs an HTTP PATCH request to partially update a resource
      * @param url The target URL path for the request
@@ -167,5 +167,5 @@ export default interface RestService {
      * });
      * ```
      */
-    patch(url: string, data?: any, options?: RestfulOptions): Promise<any>;
+    patch<T = any>(url: string, data?: any, options?: RestfulOptions<T>): Promise<T>;
 }

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import ApiError from "./ApiError";
+import type { ApiErrorPayload } from "./ApiError";
 import RestService from "./RestService";
 import FileService from "./FileService";
 import { ErrorHandler, PostInterceptor, PreInterceptor, DataProcessor } from "./RestService";
@@ -8,6 +9,7 @@ import UploadCallback, { UploadProgress, ProgressUpdate, OnCompleted, OnUploaded
 import { RestfulOptions } from "./RestService";
 export default RestService;
 export { ApiError };
+export type { ApiErrorPayload };
 export { RestService };
 export { FileService };
 export type { ErrorHandler, PostInterceptor, PreInterceptor, DataProcessor };

package/package.json

@@ -1,7 +1,8 @@
 {
+  "type": "module",
   "name": "@ticatec/restful_service_api",
-  "version": "0.3.0",
-  "description": "A lightweight TypeScript RESTful API client for browsers with error handling.",
+  "version": "0.6.0",
+  "description": "A lightweight TypeScript RESTful API client for browsers with error handling. (ESM only, v0.6.0+)",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,23 +13,24 @@
   ],
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "default": "./dist/index.js"
     },
     "./ApiError": {
+      "types": "./dist/ApiError.d.ts",
       "import": "./dist/ApiError.js",
-      "require": "./dist/ApiError.js",
-      "types": "./dist/ApiError.d.ts"
+      "default": "./dist/ApiError.js"
     },
     "./utils": {
+      "types": "./dist/utils.d.ts",
       "import": "./dist/utils.js",
-      "require": "./dist/utils.js",
-      "types": "./dist/utils.d.ts"
+      "default": "./dist/utils.js"
     }
   },
   "scripts": {
     "build": "tsc",
+    "test": "vitest run",
     "clean": "rm -rf dist",
     "prepare": "npm run clean && npm run build",
     "publish:public": "npm publish --access public"
@@ -54,6 +56,7 @@
   "dependencies": {
   },
   "devDependencies": {
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "vitest": "^3.2.4"
   }
 }