@ahoo-wang/fetcher 0.0.1 → 0.0.3

package/README.md

@@ -1,36 +1,68 @@
-# fetcher-core
+# @ahoo-wang/fetcher
 
-Fetcher-core 是一个基于现代 Fetch API 的 HTTP 客户端库，旨在简化和优化与后端 RESTful API 的交互。它提供了类似于 Axios 的 API，支持路径参数、查询参数、超时设置以及请求和响应拦截器。
+A modern HTTP client library based on the Fetch API, designed to simplify and optimize interactions with backend RESTful APIs. It provides an Axios-like API with support for path parameters, query parameters, timeout settings, and request/response interceptors.
 
-## 特性
+## Features
 
-- **兼容 Fetch API**: fetcher 的 API 完全兼容原生 Fetch API，易于上手。
-- **路径和查询参数**: 支持在请求中使用路径参数和查询参数，路径参数使用 `{}` 包裹。
-- **超时设置**: 可以为请求设置超时时间。
-- **请求拦截器**: 支持在请求发送前对请求进行修改。
-- **响应拦截器**: 支持在响应返回后对响应进行处理。
-- **模块化设计**: 代码结构清晰，易于维护和扩展。
+- **Fetch API Compatible**: Fetcher's API is fully compatible with the native Fetch API, making it easy to get started.
+- **Path and Query Parameters**: Supports path parameters and query parameters in requests, with path parameters wrapped in `{}`.
+- **Timeout Settings**: Request timeout can be configured.
+- **Request Interceptors**: Supports modifying requests before they are sent.
+- **Response Interceptors**: Supports processing responses after they are returned.
+- **Modular Design**: Clear code structure for easy maintenance and extension.
+- **TypeScript Support**: Complete TypeScript type definitions.
 
-## 安装
+## Installation
 
-使用 pnpm 安装：
+Using pnpm:
 
 ```bash
-pnpm add @fetcher/core
+pnpm add @ahoo-wang/fetcher
 ```
 
-## 使用示例
+Using npm:
+
+```bash
+npm install @ahoo-wang/fetcher
+```
+
+Using yarn:
+
+```bash
+yarn add @ahoo-wang/fetcher
+```
+
+## Usage
+
+### Basic Usage
 
 ```typescript
-import { Fetcher } from '@fetcher/core';
+import { Fetcher } from '@ahoo-wang/fetcher';
 
 const fetcher = new Fetcher({
   baseURL: 'https://api.example.com',
   timeout: 5000,
 });
 
+// GET request with path parameters and query parameters
+fetcher
+  .get('/users/{id}', {
+    pathParams: { id: 123 },
+    queryParams: { include: 'profile' },
+  })
+  .then(response => {
+    console.log(response.data);
+  })
+  .catch(error => {
+    console.error(error);
+  });
+
+// POST request with JSON body
 fetcher
-  .get('/users/{id}', { pathParams: { id: 123 } })
+  .post('/users', {
+    body: JSON.stringify({ name: 'John Doe', email: 'john@example.com' }),
+    headers: { 'Content-Type': 'application/json' },
+  })
   .then(response => {
     console.log(response.data);
   })
@@ -39,79 +71,181 @@ fetcher
   });
 ```
 
-## API 参考
+### Interceptor Usage
+
+```typescript
+import { Fetcher } from '@ahoo-wang/fetcher';
+
+const fetcher = new Fetcher({ baseURL: 'https://api.example.com' });
+
+// Add request interceptor
+const requestInterceptorId = fetcher.interceptors.request.use({
+  intercept(request) {
+    // Modify request configuration, e.g., add auth header
+    return {
+      ...request,
+      headers: {
+        ...request.headers,
+        Authorization: 'Bearer token',
+      },
+    };
+  },
+});
+
+// Add response interceptor
+const responseInterceptorId = fetcher.interceptors.response.use({
+  intercept(response) {
+    // Process response data, e.g., parse JSON
+    return response;
+  },
+});
+
+// Add error interceptor
+const errorInterceptorId = fetcher.interceptors.error.use({
+  intercept(error) {
+    // Handle errors, e.g., log them
+    console.error('Request failed:', error);
+    return error;
+  },
+});
+```
+
+## API Reference
+
+### Fetcher Class
+
+Core HTTP client class that provides various HTTP methods.
+
+#### Constructor
+
+```typescript
+new Fetcher(options?: FetcherOptions)
+```
+
+**Parameters:**
+
+- `options.baseURL`: Base URL
+- `options.timeout`: Request timeout in milliseconds
+- `options.headers`: Default request headers
+
+#### Methods
+
+- `fetch(url: string, request?: FetcherRequest): Promise<Response>` - Generic HTTP request method
+- `get(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - GET request
+- `post(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - POST request
+- `put(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - PUT request
+- `delete(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - DELETE request
+- `patch(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - PATCH request
+- `head(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - HEAD request
+- `options(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - OPTIONS request
+
+### UrlBuilder Class
+
+URL builder for constructing complete URLs with parameters.
+
+#### Methods
+
+- `build(path: string, pathParams?: Record<string, any>, queryParams?: Record<string, any>): string` - Build complete URL
 
-### Fetcher
+### InterceptorManager Class
 
-- `fetch(url: string, request?: FetcherRequest): Promise<Response>`
-- `get(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>`
-- `post(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>`
-- `put(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>`
-- `delete(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>`
-- `patch(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>`
-- `head(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>`
-- `options(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>`
+Interceptor manager for managing multiple interceptors of the same type.
 
-### UrlBuilder
+#### Methods
 
-- `build(path: string, pathParams?: Record<string, any>, queryParams?: Record<string, any>): string`
+- `use(interceptor: T): number` - Add interceptor, returns interceptor ID
+- `eject(index: number): void` - Remove interceptor by ID
+- `clear(): void` - Clear all interceptors
+- `intercept(data: R): Promise<R>` - Execute all interceptors sequentially
 
-### InterceptorManager
+### FetcherInterceptors Class
 
-- `use(interceptor: T): number`
-- `eject(index: number): void`
-- `clear(): void`
-- `intercept(data: R): Promise<R>`
+Fetcher interceptor collection, including request, response, and error interceptor managers.
 
-### FetcherInterceptors
+#### Properties
 
-- `request: RequestInterceptorManager`
-- `response: ResponseInterceptorManager`
-- `error: ErrorInterceptorManager`
+- `request: RequestInterceptorManager` - Request interceptor manager
+- `response: ResponseInterceptorManager` - Response interceptor manager
+- `error: ErrorInterceptorManager` - Error interceptor manager
 
-#### 使用示例
+## Complete Example
 
 ```typescript
-import { Fetcher } from '@fetcher/core';
+import { Fetcher } from '@ahoo-wang/fetcher';
 
-const fetcher = new Fetcher({ baseURL: 'https://api.example.com' });
+// Create fetcher instance
+const fetcher = new Fetcher({
+  baseURL: 'https://api.example.com',
+  timeout: 10000,
+  headers: {
+    'Content-Type': 'application/json',
+  },
+});
 
-// 添加请求拦截器
-const requestInterceptorId = fetcher.interceptors.request.use({
+// Add request interceptor - Add auth header
+fetcher.interceptors.request.use({
   intercept(request) {
-    // 修改请求配置
     return {
       ...request,
       headers: {
         ...request.headers,
-        Authorization: 'Bearer token',
+        Authorization: 'Bearer ' + getAuthToken(),
       },
     };
   },
 });
 
-// 添加响应拦截器
-const responseInterceptorId = fetcher.interceptors.response.use({
+// Add response interceptor - Auto-parse JSON
+fetcher.interceptors.response.use({
   intercept(response) {
-    // 处理响应数据
+    if (response.headers.get('content-type')?.includes('application/json')) {
+      return response.json().then(data => {
+        return new Response(JSON.stringify(data), response);
+      });
+    }
     return response;
   },
 });
 
-// 移除拦截器
-fetcher.interceptors.request.eject(requestInterceptorId);
-fetcher.interceptors.response.eject(responseInterceptorId);
+// Add error interceptor - Unified error handling
+fetcher.interceptors.error.use({
+  intercept(error) {
+    if (error.name === 'FetchTimeoutError') {
+      console.error('Request timeout:', error.message);
+    } else {
+      console.error('Network error:', error.message);
+    }
+    return error;
+  },
+});
+
+// Use fetcher to make requests
+fetcher
+  .get('/users/{id}', {
+    pathParams: { id: 123 },
+    queryParams: { include: 'profile,posts' },
+  })
+  .then(response => response.json())
+  .then(data => {
+    console.log('User data:', data);
+  })
+  .catch(error => {
+    console.error('Failed to fetch user:', error);
+  });
+```
+
+## Testing
 
-// 清空所有拦截器
-fetcher.interceptors.request.clear();
-fetcher.interceptors.response.clear();
-fetcher.interceptors.error.clear();
+Run tests:
+
+```bash
+pnpm test
 ```
 
-## 贡献
+## Contributing
 
-欢迎任何形式的贡献！请查看 [贡献指南](https://github.com/Ahoo-Wang/fetcher/blob/main/CONTRIBUTING.md) 了解更多信息。
+Contributions of any kind are welcome! Please see the [contributing guide](https://github.com/Ahoo-Wang/fetcher/blob/main/CONTRIBUTING.md) for more details.
 
-## 许可证
+## License
 
-本项目采用 [Apache-2.0](https://opensource.org/licenses/Apache-2.0) 许可证。
+This project is licensed under the [Apache-2.0 License](https://opensource.org/licenses/Apache-2.0).

package/dist/index.umd.js

@@ -1 +1 @@
-(function(i,u){typeof exports=="object"&&typeof module<"u"?u(exports):typeof define=="function"&&define.amd?define(["exports"],u):(i=typeof globalThis<"u"?globalThis:i||self,u(i.FetcherCore={}))})(this,(function(i){"use strict";function u(r){return/^([a-z][a-z\d+\-.]*:)?\/\//i.test(r)}function f(r,e){return u(e)?e:e?r.replace(/\/?\/$/,"")+"/"+e.replace(/^\/+/,""):r}class d{constructor(e){this.baseURL=e}build(e,t,s){let n=f(this.baseURL,e),h=this.interpolateUrl(n,t);if(s){const o=new URLSearchParams(s).toString();o&&(h+="?"+o)}return h}interpolateUrl(e,t){return t?e.replace(/{([^}]+)}/g,(s,n)=>{const h=t[n];if(h===void 0)throw new Error(`Missing required path parameter: ${n}`);return String(h)}):e}}function m(r,e){return typeof r<"u"?r:e}class a extends Error{constructor(e,t,s){const n=`Request timeout of ${s}ms exceeded for ${t?.method||"GET"} ${e}`;super(n),this.name="FetchTimeoutError",this.url=e,this.request=t,Object.setPrototypeOf(this,a.prototype)}}var c=(r=>(r.GET="GET",r.POST="POST",r.PUT="PUT",r.DELETE="DELETE",r.PATCH="PATCH",r.HEAD="HEAD",r.OPTIONS="OPTIONS",r))(c||{}),p=(r=>(r.METHOD="method",r.BODY="body",r))(p||{});class l{constructor(){this.interceptors=[]}use(e){const t=this.interceptors.length;return this.interceptors.push(e),t}eject(e){this.interceptors[e]&&(this.interceptors[e]=null)}clear(){this.interceptors=[]}async intercept(e){let t=e;for(let s of this.interceptors)s&&(t=await s.intercept(t));return t}}class E{constructor(){this.request=new l,this.response=new l,this.error=new l}}const y={baseURL:""};class b{constructor(e=y){this.interceptors=new E,this.urlBuilder=new d(e.baseURL),this.headers=e.headers,this.timeout=e.timeout}async fetch(e,t={}){const s={...this.headers||{},...t.headers||{}};let n={...t,headers:Object.keys(s).length>0?s:void 0};const h=this.urlBuilder.build(e,t.pathParams,t.queryParams);n=await this.interceptors.request.intercept(n);try{let o=await this.timeoutFetch(h,n);return o=await this.interceptors.response.intercept(o),o}catch(o){throw await this.interceptors.error.intercept(o)}}async timeoutFetch(e,t){const s=m(t.timeout,this.timeout);if(!s)return fetch(e,t);const n=new AbortController,h={...t,signal:n.signal};let o=null;const T=new Promise((P,w)=>{o=setTimeout(()=>{n.abort(),w(new a(e,t,s))},s)});try{return await Promise.race([fetch(e,h),T])}finally{o&&clearTimeout(o)}}async get(e,t={}){return this.fetch(e,{...t,method:c.GET})}async post(e,t={}){return this.fetch(e,{...t,method:c.POST})}async put(e,t={}){return this.fetch(e,{...t,method:c.PUT})}async delete(e,t={}){return this.fetch(e,{...t,method:c.DELETE})}async patch(e,t={}){return this.fetch(e,{...t,method:c.PATCH})}async head(e,t={}){return this.fetch(e,{...t,method:c.HEAD})}async options(e,t={}){return this.fetch(e,{...t,method:c.OPTIONS})}}i.FetchTimeoutError=a,i.Fetcher=b,i.HttpMethod=c,i.RequestField=p,i.UrlBuilder=d,i.combineURLs=f,i.isAbsoluteURL=u,i.resolveTimeout=m,Object.defineProperty(i,Symbol.toStringTag,{value:"Module"})}));
+(function(i,u){typeof exports=="object"&&typeof module<"u"?u(exports):typeof define=="function"&&define.amd?define(["exports"],u):(i=typeof globalThis<"u"?globalThis:i||self,u(i.Fetcher={}))})(this,(function(i){"use strict";function u(r){return/^([a-z][a-z\d+\-.]*:)?\/\//i.test(r)}function f(r,e){return u(e)?e:e?r.replace(/\/?\/$/,"")+"/"+e.replace(/^\/+/,""):r}class d{constructor(e){this.baseURL=e}build(e,t,s){let n=f(this.baseURL,e),h=this.interpolateUrl(n,t);if(s){const o=new URLSearchParams(s).toString();o&&(h+="?"+o)}return h}interpolateUrl(e,t){return t?e.replace(/{([^}]+)}/g,(s,n)=>{const h=t[n];if(h===void 0)throw new Error(`Missing required path parameter: ${n}`);return String(h)}):e}}function m(r,e){return typeof r<"u"?r:e}class a extends Error{constructor(e,t,s){const n=`Request timeout of ${s}ms exceeded for ${t?.method||"GET"} ${e}`;super(n),this.name="FetchTimeoutError",this.url=e,this.request=t,Object.setPrototypeOf(this,a.prototype)}}var c=(r=>(r.GET="GET",r.POST="POST",r.PUT="PUT",r.DELETE="DELETE",r.PATCH="PATCH",r.HEAD="HEAD",r.OPTIONS="OPTIONS",r))(c||{}),p=(r=>(r.METHOD="method",r.BODY="body",r))(p||{});class l{constructor(){this.interceptors=[]}use(e){const t=this.interceptors.length;return this.interceptors.push(e),t}eject(e){this.interceptors[e]&&(this.interceptors[e]=null)}clear(){this.interceptors=[]}async intercept(e){let t=e;for(let s of this.interceptors)s&&(t=await s.intercept(t));return t}}class E{constructor(){this.request=new l,this.response=new l,this.error=new l}}const y={baseURL:""};class b{constructor(e=y){this.interceptors=new E,this.urlBuilder=new d(e.baseURL),this.headers=e.headers,this.timeout=e.timeout}async fetch(e,t={}){const s={...this.headers||{},...t.headers||{}};let n={...t,headers:Object.keys(s).length>0?s:void 0};const h=this.urlBuilder.build(e,t.pathParams,t.queryParams);n=await this.interceptors.request.intercept(n);try{let o=await this.timeoutFetch(h,n);return o=await this.interceptors.response.intercept(o),o}catch(o){throw await this.interceptors.error.intercept(o)}}async timeoutFetch(e,t){const s=m(t.timeout,this.timeout);if(!s)return fetch(e,t);const n=new AbortController,h={...t,signal:n.signal};let o=null;const T=new Promise((P,w)=>{o=setTimeout(()=>{n.abort(),w(new a(e,t,s))},s)});try{return await Promise.race([fetch(e,h),T])}finally{o&&clearTimeout(o)}}async get(e,t={}){return this.fetch(e,{...t,method:c.GET})}async post(e,t={}){return this.fetch(e,{...t,method:c.POST})}async put(e,t={}){return this.fetch(e,{...t,method:c.PUT})}async delete(e,t={}){return this.fetch(e,{...t,method:c.DELETE})}async patch(e,t={}){return this.fetch(e,{...t,method:c.PATCH})}async head(e,t={}){return this.fetch(e,{...t,method:c.HEAD})}async options(e,t={}){return this.fetch(e,{...t,method:c.OPTIONS})}}i.FetchTimeoutError=a,i.Fetcher=b,i.HttpMethod=c,i.RequestField=p,i.UrlBuilder=d,i.combineURLs=f,i.isAbsoluteURL=u,i.resolveTimeout=m,Object.defineProperty(i,Symbol.toStringTag,{value:"Module"})}));

package/dist/urls.d.ts

@@ -1,3 +1,16 @@
+/**
+ * 检查给定的 URL 是否为绝对 URL
+ *
+ * @param url - 需要检查的 URL 字符串
+ * @returns boolean - 如果是绝对 URL 返回 true，否则返回 false
+ */
 export declare function isAbsoluteURL(url: string): boolean;
+/**
+ * 将基础 URL 和相对 URL 组合成完整的 URL
+ *
+ * @param baseURL - 基础 URL
+ * @param relativeURL - 相对 URL
+ * @returns string - 组合后的完整 URL
+ */
 export declare function combineURLs(baseURL: string, relativeURL: string): string;
 //# sourceMappingURL=urls.d.ts.map

package/dist/urls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"urls.d.ts","sourceRoot":"","sources":["../src/urls.ts"],"names":[],"mappings":"AAAA,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,WAExC;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,UAQ/D"}
+{"version":3,"file":"urls.d.ts","sourceRoot":"","sources":["../src/urls.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,WAExC;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,UAQ/D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Core library providing basic HTTP client functionality for Fetcher",
   "keywords": [
     "fetch",
@@ -22,6 +22,12 @@
   "main": "./dist/index.umd.js",
   "module": "./dist/index.es.js",
   "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.umd.js"
+    }
+  },
   "files": [
     "dist"
   ],