@ahoo-wang/fetcher 0.8.3 → 0.8.6

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;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;QAChB;;;;WAIG;QACH,IAAI,CAAC,CAAC,GAAG,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;KAC7B;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAYA;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;QAChB;;;;WAIG;QACH,IAAI,CAAC,CAAC,GAAG,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;KAC7B;CACF"}

package/dist/urlBuilder.d.ts

@@ -1,48 +1,95 @@
-import { BaseURLCapable } from './types';
+import { BaseURLCapable, FetchRequest } from './fetchRequest';
 /**
- * UrlBuilder Class
+ * Interface for URL parameters including path and query parameters
+ */
+export interface UrlParams {
+    /**
+     * Path parameter object used to replace placeholders in the URL (e.g., {id})
+     *
+     * @example
+     * ```typescript
+     * // For URL template '/users/{id}/posts/{postId}'
+     * const path = { id: 123, postId: 456 };
+     * ```
+     */
+    path?: Record<string, any>;
+    /**
+     * Query parameter object to be added to the URL query string
+     *
+     * @example
+     * ```typescript
+     * const query = { filter: 'active', page: 1, limit: 10 };
+     * // Results in query string: ?filter=active&page=1&limit=10
+     * ```
+     */
+    query?: Record<string, any>;
+}
+/**
+ * URL Builder class for constructing complete URLs with path parameters and query parameters
  *
- * URL builder class for constructing complete URLs with path parameters and query parameters.
  * This class handles URL composition, path parameter interpolation, and query string generation.
+ * It combines a base URL with a path, replaces path placeholders with actual values, and appends
+ * query parameters to create a complete URL.
  *
  * @example
  * ```typescript
  * const urlBuilder = new UrlBuilder('https://api.example.com');
- * const url = urlBuilder.build('/users/{id}', { id: 123 }, { filter: 'active' });
+ * const url = urlBuilder.build('/users/{id}', {
+ *   urlParams: {
+ *     path: { id: 123 },
+ *     query: { filter: 'active' }
+ *   }
+ * });
  * // Result: https://api.example.com/users/123?filter=active
  * ```
  */
 export declare class UrlBuilder implements BaseURLCapable {
     /**
      * Base URL that all constructed URLs will be based on
+     *
+     * This is typically the root of your API endpoint (e.g., 'https://api.example.com')
      */
     baseURL: string;
     /**
      * Creates a UrlBuilder instance
      *
      * @param baseURL - Base URL that all constructed URLs will be based on
+     *
+     * @example
+     * ```typescript
+     * const urlBuilder = new UrlBuilder('https://api.example.com');
+     * ```
      */
     constructor(baseURL: string);
     /**
      * Builds a complete URL, including path parameter replacement and query parameter addition
      *
-     * @param url - URL path to build
-     * @param path - Path parameter object used to replace placeholders in the URL (e.g., {id})
-     * @param query - Query parameter object to be added to the URL query string
-     * @returns Complete URL string
+     * @param url - URL path to build (e.g., '/users/{id}/posts')
+     * @param params - URL parameters including path and query parameters
+     * @returns Complete URL string with base URL, path parameters interpolated, and query string appended
      * @throws Error when required path parameters are missing
      *
      * @example
      * ```typescript
      * const urlBuilder = new UrlBuilder('https://api.example.com');
-     * const url = urlBuilder.build('/users/{id}/posts/{postId}',
-     *   { id: 123, postId: 456 },
-     *   { filter: 'active', limit: 10 }
-     * );
+     * const url = urlBuilder.build('/users/{id}/posts/{postId}', {
+     *   path: { id: 123, postId: 456 },
+     *   query: { filter: 'active', limit: 10 }
+     * });
      * // Result: https://api.example.com/users/123/posts/456?filter=active&limit=10
      * ```
      */
-    build(url: string, path?: Record<string, any>, query?: Record<string, any>): string;
+    build(url: string, params?: UrlParams): string;
+    /**
+     * Resolves a complete URL from a FetchRequest
+     *
+     * This method is used internally by the Fetcher to build the final URL for a request
+     * by combining the request URL with its URL parameters using this UrlBuilder.
+     *
+     * @param request - The FetchRequest containing URL and URL parameters
+     * @returns Complete resolved URL string
+     */
+    resolveRequestUrl(request: FetchRequest): string;
     /**
      * Replaces placeholders in the URL with path parameters
      *
@@ -54,13 +101,31 @@ export declare class UrlBuilder implements BaseURLCapable {
      * @example
      * ```typescript
      * const urlBuilder = new UrlBuilder('https://api.example.com');
-     * const result = urlBuilder.interpolateUrl('/users/{id}/posts/{postId}', { id: 123, postId: 456 });
-     * // Result: /users/123/posts/456
+     * const result = urlBuilder.interpolateUrl('/users/{id}/posts/{postId}', {
+     *   path: { id: 123, postId: 456 }
+     * });
+     * // Result: https://api.example.com/users/123/posts/456
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Missing required parameter throws an error
+     * try {
+     *   urlBuilder.interpolateUrl('/users/{id}', { name: 'John' });
+     * } catch (error) {
+     *   console.error(error.message); // "Missing required path parameter: id"
+     * }
      * ```
      */
-    interpolateUrl(url: string, path?: Record<string, any>): string;
+    interpolateUrl(url: string, path?: Record<string, any> | null): string;
 }
+/**
+ * Interface for objects that have a UrlBuilder capability
+ */
 export interface UrlBuilderCapable {
+    /**
+     * The UrlBuilder instance
+     */
     urlBuilder: UrlBuilder;
 }
 //# sourceMappingURL=urlBuilder.d.ts.map

package/dist/urlBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"urlBuilder.d.ts","sourceRoot":"","sources":["../src/urlBuilder.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC;;;;;;;;;;;;GAYG;AACH,qBAAa,UAAW,YAAW,cAAc;IAC/C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;gBACS,OAAO,EAAE,MAAM;IAI3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CACH,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC1B,MAAM;IAYT;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM;CAWhE;AAED,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,UAAU,CAAC;CACxB"}
+{"version":3,"file":"urlBuilder.d.ts","sourceRoot":"","sources":["../src/urlBuilder.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE3B;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,UAAW,YAAW,cAAc;IAC/C;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;OASG;gBACS,OAAO,EAAE,MAAM;IAI3B;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM;IAc9C;;;;;;;;OAQG;IACH,iBAAiB,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM;IAIhD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,GAAG,MAAM;CAWvE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CACxB"}

package/dist/urlResolveInterceptor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"urlResolveInterceptor.d.ts","sourceRoot":"","sources":["../src/urlResolveInterceptor.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,qBAAsB,YAAW,WAAW;IACvD;;OAEG;IACH,IAAI,SAA2B;IAE/B;;;;;;;;OAQG;IACH,KAAK,SAAiC;IAEtC;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,aAAa,GAAG,aAAa;CAQlD"}
+{"version":3,"file":"urlResolveInterceptor.d.ts","sourceRoot":"","sources":["../src/urlResolveInterceptor.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,qBAAsB,YAAW,WAAW;IACvD;;OAEG;IACH,IAAI,SAA2B;IAE/B;;;;;;;;OAQG;IACH,KAAK,SAAiC;IAEtC;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,aAAa,GAAG,aAAa;CAKlD"}

package/dist/utils.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Merges two record objects, giving precedence to the second record for overlapping keys.
+ *
+ * This utility function is used to merge configuration objects where the second object
+ * takes precedence over the first when there are conflicting keys.
+ *
+ * @template V - The type of values in the records
+ * @param first - The first record to merge (lower precedence)
+ * @param second - The second record to merge (higher precedence)
+ * @returns A new merged record, or undefined if both inputs are undefined
+ *
+ * @example
+ * ```typescript
+ * // Merge two objects
+ * const defaults = { timeout: 5000, retries: 3 };
+ * const overrides = { timeout: 10000 };
+ * const result = mergeRecords(defaults, overrides);
+ * // Result: { timeout: 10000, retries: 3 }
+ *
+ * // Handle undefined values
+ * const result2 = mergeRecords(undefined, { timeout: 5000 });
+ * // Result: { timeout: 5000 }
+ *
+ * // Return undefined when both are undefined
+ * const result3 = mergeRecords(undefined, undefined);
+ * // Result: undefined
+ * ```
+ */
+export declare function mergeRecords<V>(first?: Record<string, V>, second?: Record<string, V>): Record<string, V> | undefined;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EACzB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GACzB,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAkB/B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher",
-  "version": "0.8.3",
+  "version": "0.8.6",
   "description": "Ultra-lightweight (1.9kB) HTTP client with built-in path parameters and Axios-like API",
   "keywords": [
     "fetch",