@ahoo-wang/fetcher 1.2.5 → 1.2.8

package/README.md

@@ -202,13 +202,7 @@ const success = fetcher.interceptors.request.use({
   name: 'auth-interceptor',
   order: 100,
   intercept(exchange) {
-    exchange.request = {
-      ...exchange.request,
-      headers: {
-        ...exchange.request.headers,
-        Authorization: 'Bearer ' + getAuthToken(),
-      },
-    };
+    exchange.request.headers.Authorization = 'Bearer ' + getAuthToken();
   },
 });
 

package/README.zh-CN.md

@@ -191,13 +191,7 @@ const success = fetcher.interceptors.request.use({
   name: 'auth-interceptor',
   order: 100,
   intercept(exchange) {
-    exchange.request = {
-      ...exchange.request,
-      headers: {
-        ...exchange.request.headers,
-        Authorization: 'Bearer ' + getAuthToken(),
-      },
-    };
+    exchange.request.headers.Authorization = 'Bearer ' + getAuthToken();
   },
 });
 

package/dist/fetchExchange.d.ts

@@ -1,5 +1,6 @@
 import { Fetcher } from './fetcher';
-import { FetchRequest } from './fetchRequest';
+import { FetchRequest, RequestHeaders } from './fetchRequest';
+import { UrlParams } from './urlBuilder';
 /**
  * Container for HTTP request/response data that flows through the interceptor chain.
  *
@@ -74,6 +75,28 @@ export declare class FetchExchange {
      */
     attributes: Record<string, any>;
     constructor(fetcher: Fetcher, request: FetchRequest, response?: Response, error?: Error | any);
+    /**
+     * Ensures that request headers object exists, creating it if necessary.
+     *
+     * This method checks if the request headers object is present and initializes
+     * it as an empty object if it's missing. This guarantees that headers can
+     * be safely accessed and modified after calling this method.
+     *
+     * @returns The request headers object, guaranteed to be non-null
+     */
+    ensureRequestHeaders(): RequestHeaders;
+    /**
+     * Ensures that request URL parameters object exists with all required properties,
+     * creating them if necessary.
+     *
+     * This method checks if the request URL parameters object is present and initializes
+     * it with empty path and query objects if it's missing. It also ensures that both
+     * path and query sub-objects exist. This guarantees that URL parameters can be
+     * safely accessed and modified after calling this method.
+     *
+     * @returns The request URL parameters object with guaranteed non-null path and query properties
+     */
+    ensureRequestUrlParams(): Required<UrlParams>;
     /**
      * Checks if the exchange has an error.
      *

package/dist/fetchExchange.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetchExchange.d.ts","sourceRoot":"","sources":["../src/fetchExchange.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,aAAa;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAE/B;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,GAAG,GAAG,SAAS,CAAC;IAE/B;;;;;;;;;;;;;OAaG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;gBAGnC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,YAAY,EACrB,QAAQ,CAAC,EAAE,QAAQ,EACnB,KAAK,CAAC,EAAE,KAAK,GAAG,GAAG;IAQrB;;;;OAIG;IACH,QAAQ,IAAI,OAAO;IAInB;;;;OAIG;IACH,WAAW,IAAI,OAAO;IAItB;;;;;;;;;OASG;IACH,IAAI,gBAAgB,IAAI,QAAQ,CAQ/B;CACF"}
+{"version":3,"file":"fetchExchange.d.ts","sourceRoot":"","sources":["../src/fetchExchange.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE9D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,aAAa;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAE/B;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,GAAG,GAAG,SAAS,CAAC;IAE/B;;;;;;;;;;;;;OAaG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;gBAGnC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,YAAY,EACrB,QAAQ,CAAC,EAAE,QAAQ,EACnB,KAAK,CAAC,EAAE,KAAK,GAAG,GAAG;IAQrB;;;;;;;;OAQG;IACH,oBAAoB,IAAI,cAAc;IAOtC;;;;;;;;;;OAUG;IACH,sBAAsB,IAAI,QAAQ,CAAC,SAAS,CAAC;IAgB7C;;;;OAIG;IACH,QAAQ,IAAI,OAAO;IAInB;;;;OAIG;IACH,WAAW,IAAI,OAAO;IAItB;;;;;;;;;OASG;IACH,IAAI,gBAAgB,IAAI,QAAQ,CAQ/B;CACF"}

package/dist/index.es.js

@@ -1,22 +1,22 @@
-function F(r) {
+function S(r) {
   return /^([a-z][a-z\d+\-.]*:)?\/\//i.test(r);
 }
-function q(r, e) {
-  return F(e) ? e : e ? r.replace(/\/?\/$/, "") + "/" + e.replace(/^\/+/, "") : r;
+function F(r, e) {
+  return S(e) ? e : e ? r.replace(/\/?\/$/, "") + "/" + e.replace(/^\/+/, "") : r;
 }
 var U = /* @__PURE__ */ ((r) => (r[r.UriTemplate = 0] = "UriTemplate", r[r.Express = 1] = "Express", r))(U || {});
 function D(r) {
   return r === 1 ? C : L;
 }
 function _(r, e, t) {
-  return t ? r.replace(e, (s, o) => {
-    const i = t[o];
+  return t ? r.replace(e, (s, n) => {
+    const i = t[n];
     if (i === void 0)
-      throw new Error(`Missing required path parameter: ${o}`);
+      throw new Error(`Missing required path parameter: ${n}`);
     return encodeURIComponent(i);
   }) : r;
 }
-function w(r, e) {
+function g(r, e) {
   const t = [];
   let s;
   for (; (s = e.exec(r)) !== null; )
@@ -48,7 +48,7 @@ const a = class a {
    * ```
    */
   extractPathParams(e) {
-    return w(e, a.PATH_PARAM_REGEX);
+    return g(e, a.PATH_PARAM_REGEX);
   }
   /**
    * Replaces placeholders in the URL with path parameters.
@@ -91,8 +91,8 @@ const a = class a {
   }
 };
 a.PATH_PARAM_REGEX = /{([^}]+)}/g;
-let m = a;
-const L = new m(), h = class h {
+let T = a;
+const L = new T(), h = class h {
   /**
    * Extracts path parameters from an Express-style URL string.
    *
@@ -113,7 +113,7 @@ const L = new m(), h = class h {
    * ```
    */
   extractPathParams(e) {
-    return w(e, h.PATH_PARAM_REGEX);
+    return g(e, h.PATH_PARAM_REGEX);
   }
   /**
    * Replaces Express-style placeholders in the URL with path parameters.
@@ -194,13 +194,13 @@ class v {
    * ```
    */
   build(e, t) {
-    const s = t?.path, o = t?.query, i = q(this.baseURL, e);
-    let n = this.urlTemplateResolver.resolve(i, s);
-    if (o) {
-      const u = new URLSearchParams(o).toString();
-      u && (n += "?" + u);
+    const s = t?.path, n = t?.query, i = F(this.baseURL, e);
+    let o = this.urlTemplateResolver.resolve(i, s);
+    if (n) {
+      const c = new URLSearchParams(n).toString();
+      c && (o += "?" + c);
     }
-    return n;
+    return o;
   }
   /**
    * Resolves a complete URL from a FetchRequest.
@@ -245,28 +245,28 @@ async function M(r) {
   const e = r.url, t = r.timeout, s = r;
   if (!t)
     return fetch(e, s);
-  const o = new AbortController(), i = {
+  const n = new AbortController(), i = {
     ...s,
-    signal: o.signal
+    signal: n.signal
   };
-  let n = null;
-  const u = new Promise((se, S) => {
-    n = setTimeout(() => {
-      n && clearTimeout(n);
-      const g = new y(r);
-      o.abort(g), S(g);
+  let o = null;
+  const c = new Promise((se, N) => {
+    o = setTimeout(() => {
+      o && clearTimeout(o);
+      const q = new y(r);
+      n.abort(q), N(q);
     }, t);
   });
   try {
-    return await Promise.race([fetch(e, i), u]);
+    return await Promise.race([fetch(e, i), c]);
   } finally {
-    n && clearTimeout(n);
+    o && clearTimeout(o);
   }
 }
-const H = "UrlResolveInterceptor", b = Number.MIN_SAFE_INTEGER + 1e3;
+const H = "UrlResolveInterceptor", w = Number.MIN_SAFE_INTEGER + 1e3;
 class B {
   constructor() {
-    this.name = H, this.order = b;
+    this.name = H, this.order = w;
   }
   /**
    * Resolves the final URL by combining the base URL, path parameters, and query parameters.
@@ -278,12 +278,12 @@ class B {
     t.url = e.fetcher.urlBuilder.resolveRequestUrl(t);
   }
 }
-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 || {});
-const oe = "Content-Type", E = class E {
+var u = /* @__PURE__ */ ((r) => (r.GET = "GET", r.POST = "POST", r.PUT = "PUT", r.DELETE = "DELETE", r.PATCH = "PATCH", r.HEAD = "HEAD", r.OPTIONS = "OPTIONS", r))(u || {});
+const ne = "Content-Type", E = class E {
 };
 E.APPLICATION_JSON = "application/json", E.TEXT_EVENT_STREAM = "text/event-stream";
 let d = E;
-const $ = "RequestBodyInterceptor", j = b + 1e3;
+const $ = "RequestBodyInterceptor", j = w + 1e3;
 class X {
   constructor() {
     this.name = $, this.order = j;
@@ -330,10 +330,9 @@ class X {
     if (t.body === void 0 || t.body === null || typeof t.body != "object" || t.body instanceof ArrayBuffer || ArrayBuffer.isView(t.body) || // Includes TypedArray and DataView
     t.body instanceof Blob || t.body instanceof File || t.body instanceof URLSearchParams || t.body instanceof FormData || t.body instanceof ReadableStream)
       return;
-    const s = { ...t };
-    s.body = JSON.stringify(t.body), s.headers || (s.headers = {});
-    const o = s.headers;
-    o["Content-Type"] || (o["Content-Type"] = d.APPLICATION_JSON), e.request = s;
+    e.request.body = JSON.stringify(t.body);
+    const s = e.ensureRequestHeaders();
+    s["Content-Type"] || (s["Content-Type"] = d.APPLICATION_JSON);
   }
 }
 const x = "FetchInterceptor", V = Number.MAX_SAFE_INTEGER - 1e3;
@@ -373,7 +372,7 @@ class k {
 function p(r, e) {
   return e ? r.filter(e).sort((t, s) => t.order - s.order) : [...r].sort((t, s) => t.order - s.order);
 }
-class T {
+class R {
   /**
    * Initializes a new InterceptorRegistry instance.
    *
@@ -520,7 +519,7 @@ class Q {
       throw new I(e);
   }
 }
-class R extends l {
+class m extends l {
   /**
    * Creates a new ExchangeError instance.
    *
@@ -529,18 +528,18 @@ class R extends l {
    */
   constructor(e, t) {
     const s = t || e.error?.message || e.response?.statusText || `Request to ${e.request.url} failed during exchange`;
-    super(s, e.error), this.exchange = e, this.name = "ExchangeError", Object.setPrototypeOf(this, R.prototype);
+    super(s, e.error), this.exchange = e, this.name = "ExchangeError", Object.setPrototypeOf(this, m.prototype);
   }
 }
 class K {
   constructor() {
-    this.request = new T([
+    this.request = new R([
       new B(),
       new X(),
       new k()
-    ]), this.response = new T([
+    ]), this.response = new R([
       new Q()
-    ]), this.error = new T();
+    ]), this.error = new R();
   }
   /**
    * Processes a FetchExchange through the interceptor pipeline.
@@ -634,13 +633,42 @@ class K {
     } catch (t) {
       if (e.error = t, await this.error.intercept(e), !e.hasError())
         return e;
-      throw new R(e);
+      throw new m(e);
     }
   }
 }
 class W {
-  constructor(e, t, s, o) {
-    this.attributes = {}, this.fetcher = e, this.request = t, this.response = s, this.error = o;
+  constructor(e, t, s, n) {
+    this.attributes = {}, this.fetcher = e, this.request = t, this.response = s, this.error = n;
+  }
+  /**
+   * Ensures that request headers object exists, creating it if necessary.
+   *
+   * This method checks if the request headers object is present and initializes
+   * it as an empty object if it's missing. This guarantees that headers can
+   * be safely accessed and modified after calling this method.
+   *
+   * @returns The request headers object, guaranteed to be non-null
+   */
+  ensureRequestHeaders() {
+    return this.request.headers || (this.request.headers = {}), this.request.headers;
+  }
+  /**
+   * Ensures that request URL parameters object exists with all required properties,
+   * creating them if necessary.
+   *
+   * This method checks if the request URL parameters object is present and initializes
+   * it with empty path and query objects if it's missing. It also ensures that both
+   * path and query sub-objects exist. This guarantees that URL parameters can be
+   * safely accessed and modified after calling this method.
+   *
+   * @returns The request URL parameters object with guaranteed non-null path and query properties
+   */
+  ensureRequestUrlParams() {
+    return this.request.urlParams || (this.request.urlParams = {
+      path: {},
+      query: {}
+    }), this.request.urlParams.path || (this.request.urlParams.path = {}), this.request.urlParams.query || (this.request.urlParams.query = {}), this.request.urlParams;
   }
   /**
    * Checks if the exchange has an error.
@@ -670,18 +698,18 @@ class W {
    */
   get requiredResponse() {
     if (!this.response)
-      throw new R(
+      throw new m(
         this,
         `Request to ${this.request.url} failed with no response`
       );
     return this.response;
   }
 }
-const A = {
+const P = {
   "Content-Type": d.APPLICATION_JSON
-}, N = {
+}, b = {
   baseURL: "",
-  headers: A
+  headers: P
 };
 class Z {
   /**
@@ -692,8 +720,8 @@ class Z {
    *
    * @param options - Configuration options for the Fetcher instance
    */
-  constructor(e = N) {
-    this.headers = A, this.urlBuilder = new v(e.baseURL, e.urlTemplateStyle), this.headers = e.headers ?? A, this.timeout = e.timeout, this.interceptors = e.interceptors ?? new K();
+  constructor(e = b) {
+    this.headers = P, this.urlBuilder = new v(e.baseURL, e.urlTemplateStyle), this.headers = e.headers ?? P, this.timeout = e.timeout, this.interceptors = e.interceptors ?? new K();
   }
   /**
    * Executes an HTTP request with the specified URL and options.
@@ -729,8 +757,8 @@ class Z {
       ...e,
       headers: t,
       timeout: G(e.timeout, this.timeout)
-    }, o = new W(this, s);
-    return this.interceptors.exchange(o);
+    }, n = new W(this, s);
+    return this.interceptors.exchange(n);
   }
   /**
    * Internal helper method for making HTTP requests with a specific method.
@@ -760,7 +788,7 @@ class Z {
    * @returns Promise that resolves to the HTTP response
    */
   async get(e, t = {}) {
-    return this.methodFetch(c.GET, e, t);
+    return this.methodFetch(u.GET, e, t);
   }
   /**
    * Makes a POST HTTP request.
@@ -772,7 +800,7 @@ class Z {
    * @returns Promise that resolves to the HTTP response
    */
   async post(e, t = {}) {
-    return this.methodFetch(c.POST, e, t);
+    return this.methodFetch(u.POST, e, t);
   }
   /**
    * Makes a PUT HTTP request.
@@ -784,7 +812,7 @@ class Z {
    * @returns Promise that resolves to the HTTP response
    */
   async put(e, t = {}) {
-    return this.methodFetch(c.PUT, e, t);
+    return this.methodFetch(u.PUT, e, t);
   }
   /**
    * Makes a DELETE HTTP request.
@@ -796,7 +824,7 @@ class Z {
    * @returns Promise that resolves to the HTTP response
    */
   async delete(e, t = {}) {
-    return this.methodFetch(c.DELETE, e, t);
+    return this.methodFetch(u.DELETE, e, t);
   }
   /**
    * Makes a PATCH HTTP request.
@@ -808,7 +836,7 @@ class Z {
    * @returns Promise that resolves to the HTTP response
    */
   async patch(e, t = {}) {
-    return this.methodFetch(c.PATCH, e, t);
+    return this.methodFetch(u.PATCH, e, t);
   }
   /**
    * Makes a HEAD HTTP request.
@@ -821,7 +849,7 @@ class Z {
    * @returns Promise that resolves to the HTTP response
    */
   async head(e, t = {}) {
-    return this.methodFetch(c.HEAD, e, t);
+    return this.methodFetch(u.HEAD, e, t);
   }
   /**
    * Makes an OPTIONS HTTP request.
@@ -834,10 +862,10 @@ class Z {
    * @returns Promise that resolves to the HTTP response
    */
   async options(e, t = {}) {
-    return this.methodFetch(c.OPTIONS, e, t);
+    return this.methodFetch(u.OPTIONS, e, t);
   }
 }
-const P = "default";
+const A = "default";
 class ee {
   constructor() {
     this.registrar = /* @__PURE__ */ new Map();
@@ -911,7 +939,7 @@ class ee {
    * const defaultFetcher = fetcherRegistrar.default;
    */
   get default() {
-    return this.requiredGet(P);
+    return this.requiredGet(A);
   }
   /**
    * Set the default Fetcher instance
@@ -922,7 +950,7 @@ class ee {
    * fetcherRegistrar.default = fetcher;
    */
   set default(e) {
-    this.register(P, e);
+    this.register(A, e);
   }
   /**
    * Get a copy of all registered fetchers
@@ -943,7 +971,7 @@ function O(r, e) {
   if (!(r === void 0 && e === void 0))
     return e === void 0 ? r : r === void 0 ? e : { ...r, ...e };
 }
-function ne(r, e) {
+function oe(r, e) {
   if (Object.keys(r).length === 0)
     return e;
   if (Object.keys(e).length === 0)
@@ -954,16 +982,16 @@ function ne(r, e) {
   }, s = {
     ...r.headers,
     ...e.headers
-  }, o = e.method ?? r.method, i = e.body ?? r.body, n = e.timeout ?? r.timeout, u = e.signal ?? r.signal;
+  }, n = e.method ?? r.method, i = e.body ?? r.body, o = e.timeout ?? r.timeout, c = e.signal ?? r.signal;
   return {
     ...r,
     ...e,
-    method: o,
+    method: n,
     urlParams: t,
     headers: s,
     body: i,
-    timeout: n,
-    signal: u
+    timeout: o,
+    signal: c
   };
 }
 class re extends Z {
@@ -984,17 +1012,17 @@ class re extends Z {
    *   headers: { 'Authorization': 'Bearer token' }
    * });
    */
-  constructor(e, t = N) {
+  constructor(e, t = b) {
     super(t), this.name = e, te.register(e, this);
   }
 }
-const ie = new re(P);
+const ie = new re(A);
 export {
-  oe as CONTENT_TYPE_HEADER,
+  ne as CONTENT_TYPE_HEADER,
   d as ContentTypeValues,
-  P as DEFAULT_FETCHER_NAME,
-  N as DEFAULT_OPTIONS,
-  R as ExchangeError,
+  A as DEFAULT_FETCHER_NAME,
+  b as DEFAULT_OPTIONS,
+  m as ExchangeError,
   f as ExpressUrlTemplateResolver,
   x as FETCH_INTERCEPTOR_NAME,
   V as FETCH_INTERCEPTOR_ORDER,
@@ -1004,36 +1032,36 @@ export {
   Z as Fetcher,
   l as FetcherError,
   ee as FetcherRegistrar,
-  c as HttpMethod,
+  u as HttpMethod,
   I as HttpStatusValidationError,
   K as InterceptorManager,
-  T as InterceptorRegistry,
+  R as InterceptorRegistry,
   re as NamedFetcher,
   $ as REQUEST_BODY_INTERCEPTOR_NAME,
   j as REQUEST_BODY_INTERCEPTOR_ORDER,
   X as RequestBodyInterceptor,
   H as URL_RESOLVE_INTERCEPTOR_NAME,
-  b as URL_RESOLVE_INTERCEPTOR_ORDER,
-  m as UriTemplateResolver,
+  w as URL_RESOLVE_INTERCEPTOR_ORDER,
+  T as UriTemplateResolver,
   v as UrlBuilder,
   B as UrlResolveInterceptor,
   U as UrlTemplateStyle,
   Y as VALIDATE_STATUS_INTERCEPTOR_NAME,
   z as VALIDATE_STATUS_INTERCEPTOR_ORDER,
   Q as ValidateStatusInterceptor,
-  q as combineURLs,
+  F as combineURLs,
   C as expressUrlTemplateResolver,
   ie as fetcher,
   te as fetcherRegistrar,
   D as getUrlTemplateResolver,
-  F as isAbsoluteURL,
+  S as isAbsoluteURL,
   O as mergeRecords,
-  ne as mergeRequest,
+  oe as mergeRequest,
   G as resolveTimeout,
   M as timeoutFetch,
   p as toSorted,
   L as uriTemplateResolver,
-  w as urlTemplateRegexExtract,
+  g as urlTemplateRegexExtract,
   _ as urlTemplateRegexResolve
 };
 //# sourceMappingURL=index.es.js.map