@ahoo-wang/fetcher 0.0.1 → 0.0.2

package/README.md

@@ -1,4 +1,4 @@
-# fetcher-core
+# @fetcher/core
 
 Fetcher-core 是一个基于现代 Fetch API 的 HTTP 客户端库，旨在简化和优化与后端 RESTful API 的交互。它提供了类似于 Axios 的 API，支持路径参数、查询参数、超时设置以及请求和响应拦截器。
 
@@ -10,6 +10,7 @@ Fetcher-core 是一个基于现代 Fetch API 的 HTTP 客户端库，旨在简
 - **请求拦截器**: 支持在请求发送前对请求进行修改。
 - **响应拦截器**: 支持在响应返回后对响应进行处理。
 - **模块化设计**: 代码结构清晰，易于维护和扩展。
+- **TypeScript 支持**: 完整的 TypeScript 类型定义。
 
 ## 安装
 
@@ -19,8 +20,22 @@ Fetcher-core 是一个基于现代 Fetch API 的 HTTP 客户端库，旨在简
 pnpm add @fetcher/core
 ```
 
+使用 npm 安装：
+
+```bash
+npm install @fetcher/core
+```
+
+使用 yarn 安装：
+
+```bash
+yarn add @fetcher/core
+```
+
 ## 使用示例
 
+### 基本用法
+
 ```typescript
 import { Fetcher } from '@fetcher/core';
 
@@ -29,8 +44,25 @@ const fetcher = new Fetcher({
   timeout: 5000,
 });
 
+// GET 请求带路径参数和查询参数
+fetcher
+  .get('/users/{id}', {
+    pathParams: { id: 123 },
+    queryParams: { include: 'profile' },
+  })
+  .then(response => {
+    console.log(response.data);
+  })
+  .catch(error => {
+    console.error(error);
+  });
+
+// POST 请求带 JSON 数据
 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,73 +71,175 @@ fetcher
   });
 ```
 
+### 拦截器用法
+
+```typescript
+import { Fetcher } from '@fetcher/core';
+
+const fetcher = new Fetcher({ baseURL: 'https://api.example.com' });
+
+// 添加请求拦截器
+const requestInterceptorId = fetcher.interceptors.request.use({
+  intercept(request) {
+    // 修改请求配置，例如添加认证头
+    return {
+      ...request,
+      headers: {
+        ...request.headers,
+        Authorization: 'Bearer token',
+      },
+    };
+  },
+});
+
+// 添加响应拦截器
+const responseInterceptorId = fetcher.interceptors.response.use({
+  intercept(response) {
+    // 处理响应数据，例如解析 JSON
+    return response;
+  },
+});
+
+// 添加错误拦截器
+const errorInterceptorId = fetcher.interceptors.error.use({
+  intercept(error) {
+    // 处理错误，例如记录日志
+    console.error('Request failed:', error);
+    return error;
+  },
+});
+```
+
 ## API 参考
 
-### Fetcher
+### Fetcher 类
+
+核心 HTTP 客户端类，提供各种 HTTP 方法。
+
+#### 构造函数
+
+```typescript
+new Fetcher(options?: FetcherOptions)
+```
 
-- `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>`
+**参数:**
 
-### UrlBuilder
+- `options.baseURL`: 基础 URL
+- `options.timeout`: 请求超时时间（毫秒）
+- `options.headers`: 默认请求头
 
-- `build(path: string, pathParams?: Record<string, any>, queryParams?: Record<string, any>): string`
+#### 方法
 
-### InterceptorManager
+- `fetch(url: string, request?: FetcherRequest): Promise<Response>` - 通用 HTTP 请求方法
+- `get(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - GET 请求
+- `post(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - POST 请求
+- `put(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - PUT 请求
+- `delete(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - DELETE 请求
+- `patch(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - PATCH 请求
+- `head(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - HEAD 请求
+- `options(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - OPTIONS 请求
 
-- `use(interceptor: T): number`
-- `eject(index: number): void`
-- `clear(): void`
-- `intercept(data: R): Promise<R>`
+### UrlBuilder 类
 
-### FetcherInterceptors
+URL 构建器，用于构建带参数的完整 URL。
 
-- `request: RequestInterceptorManager`
-- `response: ResponseInterceptorManager`
-- `error: ErrorInterceptorManager`
+#### 方法
 
-#### 使用示例
+- `build(path: string, pathParams?: Record<string, any>, queryParams?: Record<string, any>): string` - 构建完整 URL
+
+### InterceptorManager 类
+
+拦截器管理器，用于管理同一类型的多个拦截器。
+
+#### 方法
+
+- `use(interceptor: T): number` - 添加拦截器，返回拦截器 ID
+- `eject(index: number): void` - 根据 ID 移除拦截器
+- `clear(): void` - 清空所有拦截器
+- `intercept(data: R): Promise<R>` - 依次执行所有拦截器
+
+### FetcherInterceptors 类
+
+Fetcher 拦截器集合，包含请求、响应和错误拦截器管理器。
+
+#### 属性
+
+- `request: RequestInterceptorManager` - 请求拦截器管理器
+- `response: ResponseInterceptorManager` - 响应拦截器管理器
+- `error: ErrorInterceptorManager` - 错误拦截器管理器
+
+## 完整示例
 
 ```typescript
 import { Fetcher } from '@fetcher/core';
 
-const fetcher = new Fetcher({ baseURL: 'https://api.example.com' });
+// 创建 fetcher 实例
+const fetcher = new Fetcher({
+  baseURL: 'https://api.example.com',
+  timeout: 10000,
+  headers: {
+    'Content-Type': 'application/json',
+  },
+});
 
-// 添加请求拦截器
-const requestInterceptorId = fetcher.interceptors.request.use({
+// 添加请求拦截器 - 添加认证头
+fetcher.interceptors.request.use({
   intercept(request) {
-    // 修改请求配置
     return {
       ...request,
       headers: {
         ...request.headers,
-        Authorization: 'Bearer token',
+        Authorization: 'Bearer ' + getAuthToken(),
       },
     };
   },
 });
 
-// 添加响应拦截器
-const responseInterceptorId = fetcher.interceptors.response.use({
+// 添加响应拦截器 - 自动解析 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);
+// 添加错误拦截器 - 统一错误处理
+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;
+  },
+});
 
-// 清空所有拦截器
-fetcher.interceptors.request.clear();
-fetcher.interceptors.response.clear();
-fetcher.interceptors.error.clear();
+// 使用 fetcher 发起请求
+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);
+  });
+```
+
+## 测试
+
+运行测试：
+
+```bash
+pnpm test
 ```
 
 ## 贡献

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.2",
   "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"
   ],