@ahoo-wang/fetcher 0.3.5 → 0.3.6

package/README.md

@@ -127,6 +127,27 @@ try {
 }
 ```
 
+### Default Fetcher Usage
+
+The library also exports a pre-configured default fetcher instance that can be used directly:
+
+```typescript
+import { fetcher } from '@ahoo-wang/fetcher';
+
+// Use the default fetcher directly
+fetcher
+  .get('/users')
+  .then(response => response.json())
+  .then(data => console.log(data));
+
+// The default fetcher is also available through the registrar
+import { fetcherRegistrar } from '@ahoo-wang/fetcher';
+
+const defaultFetcher = fetcherRegistrar.default;
+// defaultFetcher is the same instance as fetcher
+console.log(defaultFetcher === fetcher); // true
+```
+
 ### Interceptor Usage
 
 ```typescript

package/README.zh-CN.md

@@ -127,6 +127,27 @@ try {
 }
 ```
 
+### 默认 Fetcher 用法
+
+该库还导出了一个预配置的默认 fetcher 实例，可以直接使用：
+
+```typescript
+import { fetcher } from '@ahoo-wang/fetcher';
+
+// 直接使用默认 fetcher
+fetcher
+  .get('/users')
+  .then(response => response.json())
+  .then(data => console.log(data));
+
+// 默认 fetcher 也可以通过注册器获取
+import { fetcherRegistrar } from '@ahoo-wang/fetcher';
+
+const defaultFetcher = fetcherRegistrar.default;
+// defaultFetcher 与 fetcher 是同一个实例
+console.log(defaultFetcher === fetcher); // true
+```
+
 ### 拦截器用法
 
 ```typescript

package/dist/index.es.js

@@ -50,15 +50,15 @@ class P {
 function O(r, e) {
   return typeof r < "u" ? r : e;
 }
-class l extends Error {
+class f extends Error {
   constructor(e, t) {
     const s = e.request?.method || "GET", i = `Request timeout of ${t}ms exceeded for ${s} ${e.url}`;
-    super(i), this.name = "FetchTimeoutError", this.exchange = e, Object.setPrototypeOf(this, l.prototype);
+    super(i), this.name = "FetchTimeoutError", this.exchange = e, Object.setPrototypeOf(this, f.prototype);
   }
 }
 var c = /* @__PURE__ */ ((r) => (r.GET = "GET", r.POST = "POST", r.PUT = "PUT", r.DELETE = "DELETE", r.PATCH = "PATCH", r.HEAD = "HEAD", r.OPTIONS = "OPTIONS", r))(c || {}), q = /* @__PURE__ */ ((r) => (r.METHOD = "method", r.BODY = "body", r))(q || {});
 const d = "Content-Type";
-var f = /* @__PURE__ */ ((r) => (r.APPLICATION_JSON = "application/json", r.TEXT_EVENT_STREAM = "text/event-stream", r))(f || {});
+var p = /* @__PURE__ */ ((r) => (r.APPLICATION_JSON = "application/json", r.TEXT_EVENT_STREAM = "text/event-stream", r))(p || {});
 class h {
   constructor() {
     this.interceptors = [];
@@ -133,11 +133,11 @@ class A {
     const s = { ...t };
     s.body = JSON.stringify(t.body), s.headers || (s.headers = {});
     const i = s.headers;
-    return i[d] || (i[d] = f.APPLICATION_JSON), { ...e, request: s };
+    return i[d] || (i[d] = p.APPLICATION_JSON), { ...e, request: s };
   }
 }
 const y = {
-  [d]: f.APPLICATION_JSON
+  [d]: p.APPLICATION_JSON
 }, T = {
   baseURL: "",
   headers: y
@@ -227,11 +227,11 @@ class S {
       signal: n.signal
     };
     let a = null;
-    const w = new Promise((N, E) => {
+    const w = new Promise((U, E) => {
       a = setTimeout(() => {
         a && clearTimeout(a);
-        const p = new l(e, o);
-        n.abort(p), E(p);
+        const m = new f(e, o);
+        n.abort(m), E(m);
       }, o);
     });
     try {
@@ -328,7 +328,7 @@ class S {
     return this.methodFetch(c.OPTIONS, e, t);
   }
 }
-const m = "default";
+const l = "default";
 class R {
   constructor() {
     this.registrar = /* @__PURE__ */ new Map();
@@ -402,7 +402,7 @@ class R {
    * const defaultFetcher = fetcherRegistrar.default;
    */
   get default() {
-    return this.requiredGet(m);
+    return this.requiredGet(l);
   }
   /**
    * Set the default Fetcher instance
@@ -413,7 +413,7 @@ class R {
    * fetcherRegistrar.default = fetcher;
    */
   set default(e) {
-    this.register(m, e);
+    this.register(l, e);
   }
   /**
    * Get a copy of all registered fetchers
@@ -430,7 +430,7 @@ class R {
   }
 }
 const I = new R();
-class U extends S {
+class N extends S {
   /**
    * Create a NamedFetcher instance and automatically register it with the global fetcherRegistrar
    *
@@ -452,21 +452,23 @@ class U extends S {
     super(t), this.name = e, I.register(e, this);
   }
 }
+const L = new N(l);
 export {
   d as ContentTypeHeader,
-  f as ContentTypeValues,
-  l as FetchTimeoutError,
+  p as ContentTypeValues,
+  f as FetchTimeoutError,
   S as Fetcher,
   F as FetcherInterceptors,
   R as FetcherRegistrar,
   c as HttpMethod,
   h as InterceptorManager,
-  U as NamedFetcher,
+  N as NamedFetcher,
   q as RequestField,
   P as UrlBuilder,
   g as combineURLs,
-  m as defaultFetcherName,
+  l as defaultFetcherName,
   T as defaultOptions,
+  L as fetcher,
   I as fetcherRegistrar,
   b as isAbsoluteURL,
   O as resolveTimeout

package/dist/index.umd.js

@@ -1 +1 @@
-(function(n,h){typeof exports=="object"&&typeof module<"u"?h(exports):typeof define=="function"&&define.amd?define(["exports"],h):(n=typeof globalThis<"u"?globalThis:n||self,h(n.Fetcher={}))})(this,(function(n){"use strict";function h(r){return/^([a-z][a-z\d+\-.]*:)?\/\//i.test(r)}function b(r,e){return h(e)?e:e?r.replace(/\/?\/$/,"")+"/"+e.replace(/^\/+/,""):r}class g{constructor(e){this.baseURL=e}build(e,t,s){let o=b(this.baseURL,e),c=this.interpolateUrl(o,t);if(s){const i=new URLSearchParams(s).toString();i&&(c+="?"+i)}return c}interpolateUrl(e,t){return t?e.replace(/{([^}]+)}/g,(s,o)=>{const c=t[o];if(c===void 0)throw new Error(`Missing required path parameter: ${o}`);return String(c)}):e}}function E(r,e){return typeof r<"u"?r:e}class l extends Error{constructor(e,t){const s=e.request?.method||"GET",o=`Request timeout of ${t}ms exceeded for ${s} ${e.url}`;super(o),this.name="FetchTimeoutError",this.exchange=e,Object.setPrototypeOf(this,l.prototype)}}var u=(r=>(r.GET="GET",r.POST="POST",r.PUT="PUT",r.DELETE="DELETE",r.PATCH="PATCH",r.HEAD="HEAD",r.OPTIONS="OPTIONS",r))(u||{}),w=(r=>(r.METHOD="method",r.BODY="body",r))(w||{});const f="Content-Type";var m=(r=>(r.APPLICATION_JSON="application/json",r.TEXT_EVENT_STREAM="text/event-stream",r))(m||{});class p{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 F{constructor(){this.request=new p,this.response=new p,this.error=new p}}class A{intercept(e){const t=e.request;if(t.body===void 0||t.body===null||typeof t.body!="object"||t.body instanceof ArrayBuffer||ArrayBuffer.isView(t.body)||t.body instanceof Blob||t.body instanceof File||t.body instanceof URLSearchParams||t.body instanceof FormData||t.body instanceof ReadableStream)return e;const s={...t};s.body=JSON.stringify(t.body),s.headers||(s.headers={});const o=s.headers;return o[f]||(o[f]=m.APPLICATION_JSON),{...e,request:s}}}const P={[f]:m.APPLICATION_JSON},y={baseURL:"",headers:P};class O{constructor(e=y){this.headers=P,this.interceptors=new F,this.urlBuilder=new g(e.baseURL),e.headers!==void 0&&(this.headers=e.headers),this.timeout=e.timeout,this.interceptors.request.use(new A)}async fetch(e,t={}){const s=await this.request(e,t);if(!s.response)throw new Error(`Request to ${s.url} failed with no response`);return s.response}async request(e,t={}){const s={...this.headers||{},...t.headers||{}},o={...t,headers:Object.keys(s).length>0?s:void 0},c=this.urlBuilder.build(e,t.pathParams,t.queryParams);let i={fetcher:this,url:c,request:o,response:void 0,error:void 0};try{const d={...i};i=await this.interceptors.request.intercept(d),i.response=await this.timeoutFetch(i);const a={...i};return i=await this.interceptors.response.intercept(a),i}catch(d){if(i.error=d,i=await this.interceptors.error.intercept(i),i.response)return i;throw i.error}}async timeoutFetch(e){const t=e.url,s=e.request,o=s.timeout,c=E(o,this.timeout);if(!c)return fetch(t,s);const i=new AbortController,d={...s,signal:i.signal};let a=null;const I=new Promise((L,N)=>{a=setTimeout(()=>{a&&clearTimeout(a);const S=new l(e,c);i.abort(S),N(S)},c)});try{return await Promise.race([fetch(t,d),I])}finally{a&&clearTimeout(a)}}async methodFetch(e,t,s={}){return this.fetch(t,{...s,method:e})}async get(e,t={}){return this.methodFetch(u.GET,e,t)}async post(e,t={}){return this.methodFetch(u.POST,e,t)}async put(e,t={}){return this.methodFetch(u.PUT,e,t)}async delete(e,t={}){return this.methodFetch(u.DELETE,e,t)}async patch(e,t={}){return this.methodFetch(u.PATCH,e,t)}async head(e,t={}){return this.methodFetch(u.HEAD,e,t)}async options(e,t={}){return this.methodFetch(u.OPTIONS,e,t)}}const T="default";class q{constructor(){this.registrar=new Map}register(e,t){this.registrar.set(e,t)}unregister(e){return this.registrar.delete(e)}get(e){return this.registrar.get(e)}requiredGet(e){const t=this.get(e);if(!t)throw new Error(`Fetcher ${e} not found`);return t}get default(){return this.requiredGet(T)}set default(e){this.register(T,e)}get fetchers(){return new Map(this.registrar)}}const R=new q;class U extends O{constructor(e,t=y){super(t),this.name=e,R.register(e,this)}}n.ContentTypeHeader=f,n.ContentTypeValues=m,n.FetchTimeoutError=l,n.Fetcher=O,n.FetcherInterceptors=F,n.FetcherRegistrar=q,n.HttpMethod=u,n.InterceptorManager=p,n.NamedFetcher=U,n.RequestField=w,n.UrlBuilder=g,n.combineURLs=b,n.defaultFetcherName=T,n.defaultOptions=y,n.fetcherRegistrar=R,n.isAbsoluteURL=h,n.resolveTimeout=E,Object.defineProperty(n,Symbol.toStringTag,{value:"Module"})}));
+(function(n,h){typeof exports=="object"&&typeof module<"u"?h(exports):typeof define=="function"&&define.amd?define(["exports"],h):(n=typeof globalThis<"u"?globalThis:n||self,h(n.Fetcher={}))})(this,(function(n){"use strict";function h(r){return/^([a-z][a-z\d+\-.]*:)?\/\//i.test(r)}function b(r,e){return h(e)?e:e?r.replace(/\/?\/$/,"")+"/"+e.replace(/^\/+/,""):r}class g{constructor(e){this.baseURL=e}build(e,t,s){let o=b(this.baseURL,e),c=this.interpolateUrl(o,t);if(s){const i=new URLSearchParams(s).toString();i&&(c+="?"+i)}return c}interpolateUrl(e,t){return t?e.replace(/{([^}]+)}/g,(s,o)=>{const c=t[o];if(c===void 0)throw new Error(`Missing required path parameter: ${o}`);return String(c)}):e}}function w(r,e){return typeof r<"u"?r:e}class f extends Error{constructor(e,t){const s=e.request?.method||"GET",o=`Request timeout of ${t}ms exceeded for ${s} ${e.url}`;super(o),this.name="FetchTimeoutError",this.exchange=e,Object.setPrototypeOf(this,f.prototype)}}var u=(r=>(r.GET="GET",r.POST="POST",r.PUT="PUT",r.DELETE="DELETE",r.PATCH="PATCH",r.HEAD="HEAD",r.OPTIONS="OPTIONS",r))(u||{}),E=(r=>(r.METHOD="method",r.BODY="body",r))(E||{});const l="Content-Type";var m=(r=>(r.APPLICATION_JSON="application/json",r.TEXT_EVENT_STREAM="text/event-stream",r))(m||{});class p{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 F{constructor(){this.request=new p,this.response=new p,this.error=new p}}class U{intercept(e){const t=e.request;if(t.body===void 0||t.body===null||typeof t.body!="object"||t.body instanceof ArrayBuffer||ArrayBuffer.isView(t.body)||t.body instanceof Blob||t.body instanceof File||t.body instanceof URLSearchParams||t.body instanceof FormData||t.body instanceof ReadableStream)return e;const s={...t};s.body=JSON.stringify(t.body),s.headers||(s.headers={});const o=s.headers;return o[l]||(o[l]=m.APPLICATION_JSON),{...e,request:s}}}const P={[l]:m.APPLICATION_JSON},T={baseURL:"",headers:P};class O{constructor(e=T){this.headers=P,this.interceptors=new F,this.urlBuilder=new g(e.baseURL),e.headers!==void 0&&(this.headers=e.headers),this.timeout=e.timeout,this.interceptors.request.use(new U)}async fetch(e,t={}){const s=await this.request(e,t);if(!s.response)throw new Error(`Request to ${s.url} failed with no response`);return s.response}async request(e,t={}){const s={...this.headers||{},...t.headers||{}},o={...t,headers:Object.keys(s).length>0?s:void 0},c=this.urlBuilder.build(e,t.pathParams,t.queryParams);let i={fetcher:this,url:c,request:o,response:void 0,error:void 0};try{const d={...i};i=await this.interceptors.request.intercept(d),i.response=await this.timeoutFetch(i);const a={...i};return i=await this.interceptors.response.intercept(a),i}catch(d){if(i.error=d,i=await this.interceptors.error.intercept(i),i.response)return i;throw i.error}}async timeoutFetch(e){const t=e.url,s=e.request,o=s.timeout,c=w(o,this.timeout);if(!c)return fetch(t,s);const i=new AbortController,d={...s,signal:i.signal};let a=null;const N=new Promise((v,L)=>{a=setTimeout(()=>{a&&clearTimeout(a);const A=new f(e,c);i.abort(A),L(A)},c)});try{return await Promise.race([fetch(t,d),N])}finally{a&&clearTimeout(a)}}async methodFetch(e,t,s={}){return this.fetch(t,{...s,method:e})}async get(e,t={}){return this.methodFetch(u.GET,e,t)}async post(e,t={}){return this.methodFetch(u.POST,e,t)}async put(e,t={}){return this.methodFetch(u.PUT,e,t)}async delete(e,t={}){return this.methodFetch(u.DELETE,e,t)}async patch(e,t={}){return this.methodFetch(u.PATCH,e,t)}async head(e,t={}){return this.methodFetch(u.HEAD,e,t)}async options(e,t={}){return this.methodFetch(u.OPTIONS,e,t)}}const y="default";class q{constructor(){this.registrar=new Map}register(e,t){this.registrar.set(e,t)}unregister(e){return this.registrar.delete(e)}get(e){return this.registrar.get(e)}requiredGet(e){const t=this.get(e);if(!t)throw new Error(`Fetcher ${e} not found`);return t}get default(){return this.requiredGet(y)}set default(e){this.register(y,e)}get fetchers(){return new Map(this.registrar)}}const R=new q;class S extends O{constructor(e,t=T){super(t),this.name=e,R.register(e,this)}}const I=new S(y);n.ContentTypeHeader=l,n.ContentTypeValues=m,n.FetchTimeoutError=f,n.Fetcher=O,n.FetcherInterceptors=F,n.FetcherRegistrar=q,n.HttpMethod=u,n.InterceptorManager=p,n.NamedFetcher=S,n.RequestField=E,n.UrlBuilder=g,n.combineURLs=b,n.defaultFetcherName=y,n.defaultOptions=T,n.fetcher=I,n.fetcherRegistrar=R,n.isAbsoluteURL=h,n.resolveTimeout=w,Object.defineProperty(n,Symbol.toStringTag,{value:"Module"})}));

package/dist/namedFetcher.d.ts

@@ -44,4 +44,26 @@ export declare class NamedFetcher extends Fetcher implements NamedCapable {
      */
     constructor(name: string, options?: FetcherOptions);
 }
+/**
+ * Default named fetcher instance registered with the name 'default'.
+ * This provides a convenient way to use a pre-configured fetcher instance
+ * without having to create and register one manually.
+ *
+ * @example
+ * // Use the default fetcher directly
+ * import { fetcher } from '@ahoo-wang/fetcher';
+ *
+ * fetcher.get('/users')
+ *   .then(response => response.json())
+ *   .then(data => console.log(data));
+ *
+ * // Or retrieve it from the registrar
+ * import { fetcherRegistrar } from '@ahoo-wang/fetcher';
+ *
+ * const defaultFetcher = fetcherRegistrar.default;
+ * defaultFetcher.get('/users')
+ *   .then(response => response.json())
+ *   .then(data => console.log(data));
+ */
+export declare const fetcher: NamedFetcher;
 //# sourceMappingURL=namedFetcher.d.ts.map

package/dist/namedFetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"namedFetcher.d.ts","sourceRoot":"","sources":["../src/namedFetcher.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAkB,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAGpE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,YAAa,SAAQ,OAAQ,YAAW,YAAY;IAC/D;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;;;;;;OAgBG;gBACS,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,cAA+B;CAKnE"}
+{"version":3,"file":"namedFetcher.d.ts","sourceRoot":"","sources":["../src/namedFetcher.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAkB,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAGpE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,YAAa,SAAQ,OAAQ,YAAW,YAAY;IAC/D;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;;;;;;OAgBG;gBACS,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,cAA+B;CAKnE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,OAAO,cAAuC,CAAC"}

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAaA,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED,oBAAY,YAAY;IACtB,MAAM,WAAW;IACjB,IAAI,SAAS;CACd;AAED,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD,oBAAY,iBAAiB;IAC3B,gBAAgB,qBAAqB;IACrC,iBAAiB,sBAAsB;CACxC;AAGD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAaA,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED,oBAAY,YAAY;IACtB,MAAM,WAAW;IACjB,IAAI,SAAS;CACd;AAED,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD,oBAAY,iBAAiB;IAC3B,gBAAgB,qBAAqB;IACrC,iBAAiB,sBAAsB;CACxC;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;CACd"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "description": "Core library providing basic HTTP client functionality for Fetcher",
   "keywords": [
     "fetch",