@foundatiofx/fetchclient 0.47.0

package/types/src/DefaultHelpers.d.ts

@@ -0,0 +1,106 @@
+import type { FetchClient } from "./FetchClient.js";
+import type { FetchClientMiddleware } from "./FetchClientMiddleware.js";
+import type { FetchClientOptions } from "./FetchClientOptions.js";
+import { type FetchClientProvider } from "./FetchClientProvider.js";
+import type { FetchClientResponse } from "./FetchClientResponse.js";
+import type { ProblemDetails } from "./ProblemDetails.js";
+import type { RateLimitMiddlewareOptions } from "./RateLimitMiddleware.js";
+import type { GetRequestOptions, RequestOptions } from "./RequestOptions.js";
+/**
+ * Gets a FetchClient instance from the current provider.
+ * @returns The FetchClient instance.
+ */
+export declare function useFetchClient(options?: FetchClientOptions): FetchClient;
+/**
+ * Sends a GET request to the specified URL using the default client and provider and returns the response as JSON.
+ * @param url - The URL to send the GET request to.
+ * @param options - Optional request options.
+ * @returns A promise that resolves to the response as JSON.
+ */
+export declare function getJSON<T>(url: string, options?: GetRequestOptions): Promise<FetchClientResponse<T>>;
+/**
+ * Sends a POST request with JSON payload using the default client and provider to the specified URL.
+ *
+ * @template T - The type of the response data.
+ * @param {string} url - The URL to send the request to.
+ * @param {object | string | FormData} [body] - The JSON payload or form data to send with the request.
+ * @param {RequestOptions} [options] - Additional options for the request.
+ * @returns {Promise<FetchClientResponse<T>>} - A promise that resolves to the response data.
+ */
+export declare function postJSON<T>(url: string, body?: object | string | FormData, options?: RequestOptions): Promise<FetchClientResponse<T>>;
+/**
+ * Sends a PUT request with JSON payload using the default client and provider to the specified URL.
+ *
+ * @template T - The type of the response data.
+ * @param {string} url - The URL to send the request to.
+ * @param {object | string} [body] - The JSON payload to send with the request.
+ * @param {RequestOptions} [options] - Additional options for the request.
+ * @returns {Promise<FetchClientResponse<T>>} - A promise that resolves to the response data.
+ */
+export declare function putJSON<T>(url: string, body?: object | string, options?: RequestOptions): Promise<FetchClientResponse<T>>;
+/**
+ * Sends a PATCH request with JSON payload using the default client and provider to the specified URL.
+ *
+ * @template T - The type of the response data.
+ * @param {string} url - The URL to send the request to.
+ * @param {object | string} [body] - The JSON payload to send with the request.
+ * @param {RequestOptions} [options] - Additional options for the request.
+ * @returns {Promise<FetchClientResponse<T>>} - A promise that resolves to the response data.
+ */
+export declare function patchJSON<T>(url: string, body?: object | string, options?: RequestOptions): Promise<FetchClientResponse<T>>;
+/**
+ * Sends a DELETE request with JSON payload using the default client and provider to the specified URL.
+ *
+ * @template T - The type of the response data.
+ * @param {string} url - The URL to send the request to.
+ * @param {RequestOptions} [options] - Additional options for the request.
+ * @returns {Promise<FetchClientResponse<T>>} - A promise that resolves to the response data.
+ */
+export declare function deleteJSON<T>(url: string, options?: RequestOptions): Promise<FetchClientResponse<T>>;
+/**
+ * Gets the current FetchClientProvider.
+ * @returns The current FetchClientProvider.
+ */
+export declare function getCurrentProvider(): FetchClientProvider;
+/**
+ * Sets the function that retrieves the current FetchClientProvider using whatever scoping mechanism is available.
+ * @param getProviderFunc - The function that retrieves the current FetchClientProvider.
+ * @returns void
+ */
+export declare function setCurrentProviderFunc(getProviderFunc: () => FetchClientProvider | null): void;
+/**
+ * Sets the base URL for any FetchClient instances created by the current provider.
+ * @param baseUrl - The base URL to use for requests.
+ */
+export declare function setBaseUrl(baseUrl: string): void;
+/**
+ * Sets the access token function for any FetchClient instances created by the current provider.
+ * @param accessTokenFunc - The function that retrieves the access token.
+ */
+export declare function setAccessTokenFunc(accessTokenFunc: () => string | null): void;
+/**
+ * Sets the model validator function for any FetchClient instances created by the current provider.
+ * @param validate - The function that validates the model.
+ */
+export declare function setModelValidator(validate: (model: object | null) => Promise<ProblemDetails | null>): void;
+/**
+ * Adds a middleware to any FetchClient instances created by the current provider.
+ * @param middleware - The middleware function to be added.
+ */
+export declare function useMiddleware(middleware: FetchClientMiddleware): void;
+/**
+ * Sets the default request options for any FetchClient instances created by the current provider.
+ * @param options - The options to set as the default request options.
+ */
+export declare function setRequestOptions(options: RequestOptions): void;
+/**
+ * Enables rate limiting for any FetchClient instances created by the current provider.
+ * @param options - The rate limiting configuration options.
+ */
+export declare function useRateLimit(options: RateLimitMiddlewareOptions): void;
+/**
+ * Enables per-domain rate limiting for any FetchClient instances created by the current provider.
+ * @param options - The rate limiting configuration options.
+ */
+export declare function usePerDomainRateLimit(options: Omit<RateLimitMiddlewareOptions, "getGroupFunc">): void;
+//# sourceMappingURL=DefaultHelpers.d.ts.map

package/types/src/DefaultHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultHelpers.d.ts","sourceRoot":"","sources":["../../src/src/DefaultHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAI7E;;;GAGG;AACH,wBAAgB,cAAc,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,WAAW,CAExE;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACxB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAC1B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,CAMxD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,MAAM,mBAAmB,GAAG,IAAI,QAGlD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,QAEzC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,MAAM,MAAM,GAAG,IAAI,QAGrC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,QAGnE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,qBAAqB,QAE9D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,cAAc,QAExD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,0BAA0B,QAGpC;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,IAAI,CAAC,0BAA0B,EAAE,cAAc,CAAC,QAG1D"}

package/types/src/FetchClient.d.ts

@@ -0,0 +1,156 @@
+import type { GetRequestOptions, RequestOptions } from "./RequestOptions.js";
+import type { FetchClientResponse } from "./FetchClientResponse.js";
+import type { FetchClientMiddleware } from "./FetchClientMiddleware.js";
+import type { FetchClientCache } from "./FetchClientCache.js";
+import { FetchClientProvider } from "./FetchClientProvider.js";
+import type { FetchClientOptions } from "./FetchClientOptions.js";
+import { type IObjectEvent } from "./ObjectEvent.js";
+type Fetch = typeof globalThis.fetch;
+/**
+ * Represents a client for making HTTP requests using the Fetch API.
+ */
+export declare class FetchClient {
+    #private;
+    /**
+     * Represents a FetchClient that handles HTTP requests using the Fetch API.
+     * @param options - The options to use for the FetchClient.
+     */
+    constructor(optionsOrProvider?: FetchClientOptions | FetchClientProvider);
+    /**
+     * Gets the provider used by this FetchClient instance. The provider contains shared options that can be used by multiple FetchClient instances.
+     */
+    get provider(): FetchClientProvider;
+    /**
+     * Gets the options used by this FetchClient instance.
+     */
+    get options(): FetchClientOptions;
+    /**
+     * Gets the cache used for storing HTTP responses.
+     */
+    get cache(): FetchClientCache;
+    /**
+     * Gets the fetch implementation used for making HTTP requests.
+     */
+    get fetch(): Fetch | undefined;
+    /**
+     * Gets the number of inflight requests for this FetchClient instance.
+     */
+    get requestCount(): number;
+    /**
+     * Gets a value indicating whether the client is currently loading.
+     * @returns {boolean} A boolean value indicating whether the client is loading.
+     */
+    get isLoading(): boolean;
+    /**
+     * Gets an event that is triggered when the loading state changes.
+     */
+    get loading(): IObjectEvent<boolean>;
+    /**
+     * Adds one or more middleware functions to the FetchClient's middleware pipeline.
+     * Middleware functions are executed in the order they are added.
+     *
+     * @param mw - The middleware functions to add.
+     */
+    use(...mw: FetchClientMiddleware[]): FetchClient;
+    /**
+     * Sends a GET request to the specified URL.
+     *
+     * @param url - The URL to send the GET request to.
+     * @param options - The optional request options.
+     * @returns A promise that resolves to the response of the GET request.
+     */
+    get(url: string, options?: GetRequestOptions): Promise<FetchClientResponse<unknown>>;
+    /**
+     * Sends a GET request to the specified URL and returns the response as JSON.
+     * @param url - The URL to send the GET request to.
+     * @param options - Optional request options.
+     * @returns A promise that resolves to the response as JSON.
+     */
+    getJSON<T>(url: string, options?: GetRequestOptions): Promise<FetchClientResponse<T>>;
+    /**
+     * Sends a POST request to the specified URL.
+     *
+     * @param url - The URL to send the request to.
+     * @param body - The request body, can be an object, a string, or FormData.
+     * @param options - Additional options for the request.
+     * @returns A promise that resolves to a FetchClientResponse object.
+     */
+    post(url: string, body?: object | string | FormData, options?: RequestOptions): Promise<FetchClientResponse<unknown>>;
+    /**
+     * Sends a POST request with JSON payload to the specified URL.
+     *
+     * @template T - The type of the response data.
+     * @param {string} url - The URL to send the request to.
+     * @param {object | string | FormData} [body] - The JSON payload or form data to send with the request.
+     * @param {RequestOptions} [options] - Additional options for the request.
+     * @returns {Promise<FetchClientResponse<T>>} - A promise that resolves to the response data.
+     */
+    postJSON<T>(url: string, body?: object | string | FormData, options?: RequestOptions): Promise<FetchClientResponse<T>>;
+    /**
+     * Sends a PUT request to the specified URL with the given body and options.
+     * @param url - The URL to send the request to.
+     * @param body - The request body, can be an object, a string, or FormData.
+     * @param options - The request options.
+     * @returns A promise that resolves to a FetchClientResponse object.
+     */
+    put(url: string, body?: object | string | FormData, options?: RequestOptions): Promise<FetchClientResponse<unknown>>;
+    /**
+     * Sends a PUT request with JSON payload to the specified URL.
+     *
+     * @template T - The type of the response data.
+     * @param {string} url - The URL to send the request to.
+     * @param {object | string} [body] - The JSON payload to send with the request.
+     * @param {RequestOptions} [options] - Additional options for the request.
+     * @returns {Promise<FetchClientResponse<T>>} - A promise that resolves to the response data.
+     */
+    putJSON<T>(url: string, body?: object | string, options?: RequestOptions): Promise<FetchClientResponse<T>>;
+    /**
+     * Sends a PATCH request to the specified URL with the provided body and options.
+     * @param url - The URL to send the PATCH request to.
+     * @param body - The body of the request. It can be an object, a string, or FormData.
+     * @param options - The options for the request.
+     * @returns A Promise that resolves to the response of the PATCH request.
+     */
+    patch(url: string, body?: object | string | FormData, options?: RequestOptions): Promise<Response>;
+    /**
+     * Sends a PATCH request with JSON payload to the specified URL.
+     *
+     * @template T - The type of the response data.
+     * @param {string} url - The URL to send the request to.
+     * @param {object | string} [body] - The JSON payload to send with the request.
+     * @param {RequestOptions} [options] - Additional options for the request.
+     * @returns {Promise<FetchClientResponse<T>>} - A promise that resolves to the response data.
+     */
+    patchJSON<T>(url: string, body?: object | string, options?: RequestOptions): Promise<FetchClientResponse<T>>;
+    /**
+     * Sends a DELETE request to the specified URL.
+     *
+     * @param url - The URL to send the DELETE request to.
+     * @param options - The options for the request.
+     * @returns A promise that resolves to a `FetchClientResponse` object.
+     */
+    delete(url: string, options?: RequestOptions): Promise<FetchClientResponse<unknown>>;
+    /**
+     * Sends a DELETE request with JSON payload to the specified URL.
+     *
+     * @template T - The type of the response data.
+     * @param {string} url - The URL to send the request to.
+     * @param {RequestOptions} [options] - Additional options for the request.
+     * @returns {Promise<FetchClientResponse<T>>} - A promise that resolves to the response data.
+     */
+    deleteJSON<T>(url: string, options?: RequestOptions): Promise<FetchClientResponse<T>>;
+    private validate;
+    private fetchInternal;
+    private invokeMiddleware;
+    private mergeAbortSignals;
+    private getJSONResponse;
+    private reviveJsonValue;
+    private tryParseDate;
+    private buildRequestInit;
+    private buildJsonRequestOptions;
+    private problemToResponse;
+    private buildUrl;
+    private validateResponse;
+}
+export {};
+//# sourceMappingURL=FetchClient.d.ts.map

package/types/src/FetchClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchClient.d.ts","sourceRoot":"","sources":["../../src/src/FetchClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE7E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,KAAK,YAAY,EAAe,MAAM,kBAAkB,CAAC;AAElE,KAAK,KAAK,GAAG,OAAO,UAAU,CAAC,KAAK,CAAC;AAKrC;;GAEG;AACH,qBAAa,WAAW;;IAOtB;;;OAGG;gBACS,iBAAiB,CAAC,EAAE,kBAAkB,GAAG,mBAAmB;IA0BxE;;OAEG;IACH,IAAW,QAAQ,IAAI,mBAAmB,CAEzC;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,kBAAkB,CAEvC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,gBAAgB,CAEnC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,KAAK,GAAG,SAAS,CAEpC;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAE1C;IAED;;;;;OAKG;IACI,GAAG,CAAC,GAAG,EAAE,EAAE,qBAAqB,EAAE,GAAG,WAAW;IAKvD;;;;;;OAMG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;OAKG;IACH,OAAO,CAAC,CAAC,EACP,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAMlC;;;;;;;OAOG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;;;;OAQG;IACH,QAAQ,CAAC,CAAC,EACR,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAUlC;;;;;;OAMG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;;;;OAQG;IACH,OAAO,CAAC,CAAC,EACP,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAUlC;;;;;;OAMG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,QAAQ,CAAC;IAepB;;;;;;;;OAQG;IACH,SAAS,CAAC,CAAC,EACT,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAUlC;;;;;;OAMG;IACG,MAAM,CACV,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;;;OAOG;IACH,UAAU,CAAC,CAAC,EACV,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;YAMpB,QAAQ;YAmBR,aAAa;YAwIb,gBAAgB;IAa9B,OAAO,CAAC,iBAAiB;YAuBX,eAAe;IA2C7B,OAAO,CAAC,eAAe;IAkBvB,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,gBAAgB;IAwBxB,OAAO,CAAC,uBAAuB;IAY/B,OAAO,CAAC,iBAAiB;IAiCzB,OAAO,CAAC,QAAQ;IAuDhB,OAAO,CAAC,gBAAgB;CAiCzB"}

package/types/src/FetchClient.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchClient.test.d.ts","sourceRoot":"","sources":["../../src/src/FetchClient.test.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,CAAC,EAAmB,MAAM,KAAK,CAAC;AAMzC,eAAO,MAAM,UAAU;;;;;;iBAMrB,CAAC"}

package/types/src/FetchClientCache.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Represents a cache key used in the FetchClientCache.
+ */
+export type CacheKey = string[] | string;
+/**
+ * Represents an entry in the FetchClientCache.
+ */
+type CacheEntry = {
+    key: CacheKey;
+    lastAccess: Date;
+    expires: Date;
+    response: Response;
+};
+/**
+ * Represents a cache for storing responses from the FetchClient.
+ */
+export declare class FetchClientCache {
+    private cache;
+    /**
+     * Sets a response in the cache with the specified key.
+     * @param key - The cache key.
+     * @param response - The response to be cached.
+     * @param cacheDuration - The duration for which the response should be cached (in milliseconds).
+     */
+    set(key: CacheKey, response: Response, cacheDuration?: number): void;
+    /**
+     * Retrieves a response from the cache with the specified key.
+     * @param key - The cache key.
+     * @returns The cached response, or null if the response is not found or has expired.
+     */
+    get(key: CacheKey): Response | null;
+    /**
+     * Deletes a response from the cache with the specified key.
+     * @param key - The cache key.
+     * @returns True if the response was successfully deleted, false otherwise.
+     */
+    delete(key: CacheKey): boolean;
+    /**
+     * Deletes all responses from the cache that have keys beginning with the specified key.
+     * @param prefix - The cache key prefix.
+     * @returns The number of responses that were deleted.
+     */
+    deleteAll(prefix: CacheKey): number;
+    /**
+     * Checks if a response exists in the cache with the specified key.
+     * @param key - The cache key.
+     * @returns True if the response exists in the cache, false otherwise.
+     */
+    has(key: CacheKey): boolean;
+    /**
+     * Returns an iterator for the cache entries.
+     * @returns An iterator for the cache entries.
+     */
+    values(): IterableIterator<CacheEntry>;
+    /**
+     * Clears all entries from the cache.
+     */
+    clear(): void;
+    private getHash;
+}
+export {};
+//# sourceMappingURL=FetchClientCache.d.ts.map

package/types/src/FetchClientCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchClientCache.d.ts","sourceRoot":"","sources":["../../src/src/FetchClientCache.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;AAEzC;;GAEG;AACH,KAAK,UAAU,GAAG;IAChB,GAAG,EAAE,QAAQ,CAAC;IACd,UAAU,EAAE,IAAI,CAAC;IACjB,OAAO,EAAE,IAAI,CAAC;IACd,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,KAAK,CAAiC;IAE9C;;;;;OAKG;IACI,GAAG,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;IAS3E;;;;OAIG;IACI,GAAG,CAAC,GAAG,EAAE,QAAQ,GAAG,QAAQ,GAAG,IAAI;IAgB1C;;;;OAIG;IACI,MAAM,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO;IAIrC;;;;OAIG;IACI,SAAS,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM;IAc1C;;;;OAIG;IACI,GAAG,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO;IAIlC;;;OAGG;IACI,MAAM,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAI7C;;OAEG;IACI,KAAK,IAAI,IAAI;IAIpB,OAAO,CAAC,OAAO;CAOhB"}

package/types/src/FetchClientContext.d.ts

@@ -0,0 +1,8 @@
+import type { FetchClientResponse } from "./FetchClientResponse.js";
+import type { RequestOptions } from "./RequestOptions.js";
+export type FetchClientContext = {
+    options: RequestOptions;
+    request: Request;
+    response: FetchClientResponse<unknown> | null;
+} & Record<string, unknown>;
+//# sourceMappingURL=FetchClientContext.d.ts.map

package/types/src/FetchClientContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchClientContext.d.ts","sourceRoot":"","sources":["../../src/src/FetchClientContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,cAAc,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;CAC/C,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}

package/types/src/FetchClientMiddleware.d.ts

@@ -0,0 +1,9 @@
+import type { FetchClientContext } from "./FetchClientContext.js";
+/**
+ * Represents a middleware function for the FetchClient.
+ * @param context - The context object containing information about the request.
+ * @param next - The next function to be called in the middleware chain.
+ * @returns A Promise that resolves when the middleware has completed its operation.
+ */
+export type FetchClientMiddleware = (context: FetchClientContext, next: () => Promise<void>) => Promise<void>;
+//# sourceMappingURL=FetchClientMiddleware.d.ts.map

package/types/src/FetchClientMiddleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchClientMiddleware.d.ts","sourceRoot":"","sources":["../../src/src/FetchClientMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAElE;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAClC,OAAO,EAAE,kBAAkB,EAC3B,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KACtB,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/types/src/FetchClientOptions.d.ts

@@ -0,0 +1,53 @@
+import type { Counter } from "./Counter.js";
+import type { FetchClientCache } from "./FetchClientCache.js";
+import type { FetchClientMiddleware } from "./FetchClientMiddleware.js";
+import type { FetchClientProvider } from "./FetchClientProvider.js";
+import type { ProblemDetails } from "./ProblemDetails.js";
+import type { RequestOptions } from "./RequestOptions.js";
+type Fetch = typeof globalThis.fetch;
+/**
+ * Fetch client options to use for making HTTP requests.
+ */
+export type FetchClientOptions = {
+    /**
+     * The fetch client provider to get shared options from. Any options specified in this options class will override the provider options.
+     */
+    provider?: FetchClientProvider;
+    /**
+     * The default request options to use for requests. If specified, these options will be merged with the
+     * options from the FetchClientProvider and the options provided in each request.
+     */
+    defaultRequestOptions?: RequestOptions;
+    /**
+     * The cache to use for storing HTTP responses.
+     */
+    cache?: FetchClientCache;
+    /**
+     * The fetch implementation to use for making HTTP requests.
+     * If not provided, the global fetch function will be used.
+     */
+    fetch?: Fetch;
+    /**
+     * An array of middleware functions to be applied to the request.
+     */
+    middleware?: FetchClientMiddleware[];
+    /**
+     * The base URL for making HTTP requests.
+     */
+    baseUrl?: string;
+    /**
+     * A function that validates the model before making the request.
+     * Returns a Promise that resolves to a ProblemDetails object if validation fails, or null if validation succeeds.
+     */
+    modelValidator?: (model: object | null) => Promise<ProblemDetails | null>;
+    /**
+     * A function that returns the access token to use for making requests.
+     */
+    accessTokenFunc?: () => string | null;
+    /**
+     * Counter for tracking the number of inflight requests at the provider level
+     */
+    providerCounter?: Counter;
+} & Record<string, unknown>;
+export {};
+//# sourceMappingURL=FetchClientOptions.d.ts.map

package/types/src/FetchClientOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchClientOptions.d.ts","sourceRoot":"","sources":["../../src/src/FetchClientOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,KAAK,KAAK,GAAG,OAAO,UAAU,CAAC,KAAK,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAE/B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,cAAc,CAAC;IAEvC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAErC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAE1E;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}

package/types/src/FetchClientProvider.d.ts

@@ -0,0 +1,109 @@
+import { FetchClient } from "./FetchClient.js";
+import { Counter } from "./Counter.js";
+import type { FetchClientMiddleware } from "./FetchClientMiddleware.js";
+import type { ProblemDetails } from "./ProblemDetails.js";
+import { FetchClientCache } from "./FetchClientCache.js";
+import type { FetchClientOptions } from "./FetchClientOptions.js";
+import { type IObjectEvent } from "./ObjectEvent.js";
+import { type RateLimitMiddlewareOptions } from "./RateLimitMiddleware.js";
+import { type RateLimiter } from "./RateLimiter.js";
+type Fetch = typeof globalThis.fetch;
+/**
+ * Represents a provider for creating instances of the FetchClient class with shared default options and cache.
+ */
+export declare class FetchClientProvider {
+    #private;
+    /**
+     * Creates a new instance of FetchClientProvider.
+     * @param fetch - The fetch function to use. If not provided, the global fetch function will be used.
+     */
+    constructor(fetch?: Fetch);
+    /**
+     * Gets the fetch function used for making requests.
+     */
+    get fetch(): Fetch | undefined;
+    /**
+     * Sets the fetch function used for making requests.
+     */
+    set fetch(value: Fetch | undefined);
+    /**
+     * Gets a value indicating whether there are ongoing requests.
+     */
+    get isLoading(): boolean;
+    /**
+     * Gets an event that is triggered when the loading state changes.
+     */
+    get loading(): IObjectEvent<boolean>;
+    /**
+     * Gets the number of ongoing requests.
+     */
+    get requestCount(): number;
+    /**
+     * Gets the counter used for tracking ongoing requests.
+     */
+    get counter(): Counter;
+    /**
+     * Gets the options used for FetchClient instances.
+     */
+    get options(): FetchClientOptions;
+    /**
+     * Sets the options used for FetchClient instances.
+     */
+    set options(value: FetchClientOptions);
+    /**
+     * Gets the cache used for storing HTTP responses.
+     */
+    get cache(): FetchClientCache;
+    /**
+     * Creates a new instance of FetchClient using the current provider.
+     * @param options - The options to use for the FetchClient instance.
+     * @returns A new instance of FetchClient.
+     */
+    getFetchClient(options?: FetchClientOptions): FetchClient;
+    /**
+     * Applies the specified options by merging with the current options.
+     */
+    applyOptions(options: FetchClientOptions): void;
+    /**
+     * Sets the function used for retrieving the access token.
+     * @param accessTokenFunc - The function that retrieves the access token.
+     */
+    setAccessTokenFunc(accessTokenFunc: () => string | null): void;
+    /**
+     * Sets the default model validator function for all FetchClient instances created by this provider.
+     * @param validate - The function that validates the model.
+     */
+    setModelValidator(validate: (model: object | null) => Promise<ProblemDetails | null>): void;
+    /**
+     * Sets the default base URL for all FetchClient instances created by this provider.
+     * @param url - The URL to set as the default base URL.
+     */
+    setBaseUrl(url: string): void;
+    /**
+     * Adds a middleware to all FetchClient instances created by this provider.
+     * @param middleware - The middleware function to be added.
+     */
+    useMiddleware(middleware: FetchClientMiddleware): void;
+    /**
+     * Enables rate limiting for all FetchClient instances created by this provider.
+     * @param options - The rate limiting configuration options.
+     */
+    useRateLimit(options: RateLimitMiddlewareOptions): void;
+    /**
+     * Enables rate limiting for all FetchClient instances created by this provider.
+     * @param options - The rate limiting configuration options.
+     */
+    usePerDomainRateLimit(options: Omit<RateLimitMiddlewareOptions, "getGroupFunc">): void;
+    /**
+     * Gets the rate limiter instance used for rate limiting.
+     * @returns The rate limiter instance, or undefined if rate limiting is not enabled.
+     */
+    get rateLimiter(): RateLimiter | undefined;
+    /**
+     * Removes the rate limiting middleware from all FetchClient instances created by this provider.
+     */
+    removeRateLimit(): void;
+}
+export declare const defaultInstance: FetchClientProvider;
+export {};
+//# sourceMappingURL=FetchClientProvider.d.ts.map

package/types/src/FetchClientProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchClientProvider.d.ts","sourceRoot":"","sources":["../../src/src/FetchClientProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,KAAK,YAAY,EAAe,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAEL,KAAK,0BAA0B,EAChC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEnE,KAAK,KAAK,GAAG,OAAO,UAAU,CAAC,KAAK,CAAC;AAErC;;GAEG;AACH,qBAAa,mBAAmB;;IAQ9B;;;OAGG;gBACS,KAAK,CAAC,EAAE,KAAK;IAyBzB;;OAEG;IACH,IAAW,KAAK,IAAI,KAAK,GAAG,SAAS,CAEpC;IAED;;OAEG;IACH,IAAW,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,EAExC;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAE1C;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,kBAAkB,CAEvC;IAED;;OAEG;IACH,IAAW,OAAO,CAAC,KAAK,EAAE,kBAAkB,EAE3C;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,gBAAgB,CAEnC;IAED;;;;OAIG;IACI,cAAc,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,WAAW;IAchE;;OAEG;IACI,YAAY,CAAC,OAAO,EAAE,kBAAkB;IAO/C;;;OAGG;IACI,kBAAkB,CAAC,eAAe,EAAE,MAAM,MAAM,GAAG,IAAI;IAO9D;;;OAGG;IACI,iBAAiB,CACtB,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAQpE;;;OAGG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM;IAO7B;;;OAGG;IACI,aAAa,CAAC,UAAU,EAAE,qBAAqB;IAUtD;;;OAGG;IACI,YAAY,CAAC,OAAO,EAAE,0BAA0B;IAKvD;;;OAGG;IACI,qBAAqB,CAC1B,OAAO,EAAE,IAAI,CAAC,0BAA0B,EAAE,cAAc,CAAC;IAS3D;;;OAGG;IACH,IAAW,WAAW,IAAI,WAAW,GAAG,SAAS,CAEhD;IAED;;OAEG;IACI,eAAe;CAMvB;AAGD,eAAO,MAAM,eAAe,EAAE,mBAA8B,CAAC"}

package/types/src/FetchClientResponse.d.ts

@@ -0,0 +1,29 @@
+import type { Link, Links } from "./LinkHeader.js";
+import type { ProblemDetails } from "./ProblemDetails.js";
+/**
+ * Represents a response from the FetchClient.
+ * @template T - The type of the response data.
+ */
+export type FetchClientResponse<T> = Response & {
+    /**
+     * The response data.
+     */
+    data: T | null;
+    /**
+     * Details about any problem that occurred during the request.
+     */
+    problem: ProblemDetails;
+    /**
+     * Additional metadata associated with the response.
+     */
+    meta: Record<string, unknown> & {
+        /**
+         * Links associated with the response.
+         */
+        links: Links & {
+            next?: Link;
+            previous?: Link;
+        };
+    };
+};
+//# sourceMappingURL=FetchClientResponse.d.ts.map

package/types/src/FetchClientResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchClientResponse.d.ts","sourceRoot":"","sources":["../../src/src/FetchClientResponse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,QAAQ,GAAG;IAC9C;;OAEG;IACH,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAC9B;;WAEG;QACH,KAAK,EAAE,KAAK,GAAG;YAAE,IAAI,CAAC,EAAE,IAAI,CAAC;YAAC,QAAQ,CAAC,EAAE,IAAI,CAAA;SAAE,CAAC;KACjD,CAAC;CACH,CAAC"}

package/types/src/LinkHeader.d.ts

@@ -0,0 +1,15 @@
+declare function parseLinkHeader(linkHeader: string | null | undefined, options?: Options): Links | null;
+export interface Link {
+    url: string;
+    rel: string;
+    [queryParam: string]: string;
+}
+export interface Links {
+    [rel: string]: Link;
+}
+export interface Options {
+    maxHeaderLength?: number;
+    throwOnMaxHeaderLengthExceeded?: boolean;
+}
+export { parseLinkHeader };
+//# sourceMappingURL=LinkHeader.d.ts.map

package/types/src/LinkHeader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LinkHeader.d.ts","sourceRoot":"","sources":["../../src/src/LinkHeader.ts"],"names":[],"mappings":"AA4EA,iBAAS,eAAe,CACtB,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,KAAK,GAAG,IAAI,CAOd;AAED,MAAM,WAAW,IAAI;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,KAAK;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,OAAO;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,8BAA8B,CAAC,EAAE,OAAO,CAAC;CAC1C;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/types/src/ObjectEvent.d.ts

@@ -0,0 +1,20 @@
+export interface IObjectEvent<T> {
+    on(handler: {
+        (data?: T): void;
+    }): void;
+    off(handler: {
+        (data?: T): void;
+    }): void;
+}
+export declare class ObjectEvent<T> implements IObjectEvent<T> {
+    private handlers;
+    on(handler: {
+        (data?: T): void;
+    }): void;
+    off(handler: {
+        (data?: T): void;
+    }): void;
+    trigger(data?: T): void;
+    expose(): IObjectEvent<T>;
+}
+//# sourceMappingURL=ObjectEvent.d.ts.map

package/types/src/ObjectEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectEvent.d.ts","sourceRoot":"","sources":["../../src/src/ObjectEvent.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,EAAE,CAAC,OAAO,EAAE;QAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;IACxC,GAAG,CAAC,OAAO,EAAE;QAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;CAC1C;AAED,qBAAa,WAAW,CAAC,CAAC,CAAE,YAAW,YAAY,CAAC,CAAC,CAAC;IACpD,OAAO,CAAC,QAAQ,CAA8B;IAEvC,EAAE,CAAC,OAAO,EAAE;QAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI;IAIvC,GAAG,CAAC,OAAO,EAAE;QAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI;IAIxC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;IAIhB,MAAM,IAAI,YAAY,CAAC,CAAC,CAAC;CAGjC"}