@equinor/fusion-framework-module-http 5.2.3 → 6.0.1

package/dist/esm/configurator.js

@@ -1,18 +1,27 @@
 import { HttpRequestHandler } from './lib/operators';
+/** @inheritdoc */
 export class HttpClientConfigurator {
+    /** Get a clone of all configured clients */
     get clients() {
         return Object.assign({}, this._clients);
     }
+    /**
+     * Create a instance of http configuration
+     * @param client defaultHttpRequestHandler
+     */
     constructor(client) {
         this._clients = {};
+        /** default request handler for http clients, applied on creation */
         this.defaultHttpRequestHandler = new HttpRequestHandler();
         this.defaultHttpClientCtor = client;
     }
+    /** @inheritdoc */
     hasClient(name) {
         return Object.keys(this._clients).includes(name);
     }
+    /** @inheritdoc */
     configureClient(name, args) {
-        const argFn = typeof args === 'string' ? (x) => (x.uri = String(args)) : args;
+        const argFn = typeof args === 'string' ? { baseUri: args } : args;
         const options = typeof argFn === 'function' ? { onCreate: argFn } : argFn;
         this._clients[name] = Object.assign(Object.assign({}, this._clients[name]), options);
         return this;

package/dist/esm/configurator.js.map

@@ -1 +1 @@
-{"version":3,"file":"configurator.js","sourceRoot":"","sources":["../../src/configurator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAmFrD,MAAM,OAAO,sBAAsB;IAM/B,IAAW,OAAO;QACd,yBAAY,IAAI,CAAC,QAAQ,EAAG;IAChC,CAAC;IAcD,YAAY,MAAsC;QAnBxC,aAAQ,GAA+C,EAAE,CAAC;QAW3D,8BAAyB,GAAG,IAAI,kBAAkB,EAExD,CAAC;QAOA,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC;IACxC,CAAC;IAGD,SAAS,CAAC,IAAY;QAClB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAGD,eAAe,CACX,IAAY,EACZ,IAAsE;QAEtE,MAAM,KAAK,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACjF,MAAM,OAAO,GAAG,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC1E,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,mCACZ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAClB,OAAiD,CACxD,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAED,eAAe,sBAAsB,CAAC"}
+{"version":3,"file":"configurator.js","sourceRoot":"","sources":["../../src/configurator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAuHrD,kBAAkB;AAClB,MAAM,OAAO,sBAAsB;IAK/B,4CAA4C;IAC5C,IAAW,OAAO;QACd,yBAAY,IAAI,CAAC,QAAQ,EAAG;IAChC,CAAC;IAUD;;;OAGG;IACH,YAAY,MAAsC;QAnBxC,aAAQ,GAA+C,EAAE,CAAC;QAUpE,oEAAoE;QAC3D,8BAAyB,GAAG,IAAI,kBAAkB,EAExD,CAAC;QAOA,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC;IACxC,CAAC;IAED,kBAAkB;IAClB,SAAS,CAAC,IAAY;QAClB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,kBAAkB;IAClB,eAAe,CACX,IAAY,EACZ,IAAsE;QAEtE,MAAM,KAAK,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAE,EAAE,OAAO,EAAE,IAAI,EAA2B,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5F,MAAM,OAAO,GAAG,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC1E,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,mCACZ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAClB,OAAiD,CACxD,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAED,eAAe,sBAAsB,CAAC"}

package/dist/esm/errors.js

@@ -1,3 +1,7 @@
+/**
+ * Represents an error that occurs when handling an HTTP response.
+ * @template TResponse The type of the HTTP response.
+ */
 export class HttpResponseError extends Error {
     constructor(message, response, options) {
         super(message, options);
@@ -5,7 +9,21 @@ export class HttpResponseError extends Error {
     }
 }
 HttpResponseError.Name = 'HttpResponseError';
+/**
+ * Represents an error that occurs when handling a JSON response in an HTTP request.
+ * Extends the base `HttpResponseError` class.
+ *
+ * @template TType - The type of the data associated with the error.
+ * @template TResponse - The type of the HTTP response.
+ */
 export class HttpJsonResponseError extends HttpResponseError {
+    /**
+     * Creates a new instance of `HttpJsonResponseError`.
+     *
+     * @param message - The error message.
+     * @param response - The HTTP response associated with the error.
+     * @param options - Additional options for the error, including the associated data.
+     */
     constructor(message, response, options) {
         super(message, response, options);
         this.name = HttpJsonResponseError.Name;

package/dist/esm/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAIA,MAAM,OAAO,iBAAwC,SAAQ,KAAK;IAE9D,YACI,OAAe,EACC,QAAmB,EACnC,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAHR,aAAQ,GAAR,QAAQ,CAAW;IAIvC,CAAC;;AAPM,sBAAI,GAAG,mBAAmB,CAAC;AAetC,MAAM,OAAO,qBAGX,SAAQ,iBAA4B;IAGlC,YAAY,OAAe,EAAE,QAAmB,EAAE,OAAyC;QACvF,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC;IAC9B,CAAC;;AANM,0BAAI,GAAG,uBAAuB,CAAC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,iBAAwC,SAAQ,KAAK;IAE9D,YACI,OAAe,EACC,QAAmB,EACnC,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAHR,aAAQ,GAAR,QAAQ,CAAW;IAIvC,CAAC;;AAPM,sBAAI,GAAG,mBAAmB,CAAC;AAUtC;;;;;;GAMG;AACH,MAAM,OAAO,qBAGX,SAAQ,iBAA4B;IAIlC;;;;;;OAMG;IACH,YAAY,OAAe,EAAE,QAAmB,EAAE,OAAyC;QACvF,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC;IAC9B,CAAC;;AAdM,0BAAI,GAAG,uBAAuB,CAAC"}

package/dist/esm/index.js

@@ -1,3 +1,7 @@
+/**
+ * [[include:module-http/README.MD]]
+ * @module
+ */
 export * from './configurator';
 export * from './provider';
 export * from './module';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAKA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AAEzB,cAAc,UAAU,CAAC;AAIzB,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AAEzB,cAAc,UAAU,CAAC;AAIzB,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC"}

package/dist/esm/lib/client/client-msal.js

@@ -1,10 +1,45 @@
 import { HttpClient } from './client';
+/**
+ * Extends the `HttpClient` class to provide MSAL (Microsoft Authentication Library) authentication support.
+ *
+ * The `HttpClientMsal` class is responsible for handling requests that require authentication using the MSAL library.
+ * It extends the `HttpClient` class and adds the following functionality:
+ *
+ * - `defaultScopes`: An array of strings representing the default scopes to be used for all requests, unless overridden in the request object.
+ * - `fetch$`: Overrides the `fetch$` method of the `HttpClient` class to add MSAL authentication support. It takes an optional `MsalFetchRequestInit` object, which can include the `scopes` property to specify the scopes to be used for the request.
+ *   - If `scopes` is provided in the `MsalFetchRequestInit` object, it will be used in addition to the `defaultScopes`.
+ *   - If `scopes` is not provided, only the `defaultScopes` will be used.
+ *
+ * @template TRequest - The type of the request object. Defaults to `MsalFetchRequest`.
+ * @template TResponse - The type of the response object. Defaults to `FetchResponse`.
+ */
 export class HttpClientMsal extends HttpClient {
     constructor() {
         super(...arguments);
+        /**
+         * An array of default scopes to be used for all requests, unless overridden in the request object.
+         * This property is used by the `HttpClientMsal` class to add MSAL authentication support to requests.
+         */
         this.defaultScopes = [];
     }
+    /**
+     * Fetches a resource from the specified path, with optional MSAL authentication scopes.
+     *
+     * This method extends the `HttpClient.fetch$` method to add support for MSAL authentication.
+     * If `init.scopes` is provided, it will be used in addition to the `defaultScopes` defined in the `HttpClientMsal` class.
+     * If `init.scopes` is not provided, only the `defaultScopes` will be used for the request.
+     *
+     * @overrides HttpClient.fetch$
+     *
+     * @param path - The path to the resource to fetch.
+     * @param init - An optional `MsalFetchRequestInit` object that can include the `scopes` property.
+     * @returns An `Observable` that emits the fetched resource.
+     */
     fetch$(path, init) {
+        /**
+         * Merges the default scopes defined in the `HttpClientMsal` class with the scopes provided in the `init` parameter, if any.
+         * This ensures that the request includes the necessary scopes for MSAL authentication.
+         */
         const args = Object.assign(init || {}, {
             scopes: this.defaultScopes.concat((init === null || init === void 0 ? void 0 : init.scopes) || []),
         });

package/dist/esm/lib/client/client-msal.js.map

@@ -1 +1 @@
-{"version":3,"file":"client-msal.js","sourceRoot":"","sources":["../../../../src/lib/client/client-msal.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAWtC,MAAM,OAAO,cAGX,SAAQ,UAA+B;IAHzC;;QAKW,kBAAa,GAAa,EAAE,CAAC;IAYxC,CAAC;IATG,MAAM,CACF,IAAY,EACZ,IAAmD;QAEnD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,EAAE;YACnC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,KAAI,EAAE,CAAC;SACxD,CAA6C,CAAC;QAC/C,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;CACJ;AAED,eAAe,cAAc,CAAC"}
+{"version":3,"file":"client-msal.js","sourceRoot":"","sources":["../../../../src/lib/client/client-msal.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAsBtC;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,cAGX,SAAQ,UAA+B;IAHzC;;QAII;;;WAGG;QACI,kBAAa,GAAa,EAAE,CAAC;IA6BxC,CAAC;IA3BG;;;;;;;;;;;;OAYG;IACI,MAAM,CACT,IAAY,EACZ,IAAmD;QAEnD;;;WAGG;QACH,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,EAAE;YACnC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,KAAI,EAAE,CAAC;SACxD,CAA6C,CAAC;QAE/C,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;CACJ;AAED,eAAe,cAAc,CAAC"}

package/dist/esm/lib/client/client.js

@@ -15,33 +15,84 @@ import { fromFetch } from 'rxjs/fetch';
 import { HttpRequestHandler, HttpResponseHandler } from '../operators';
 import { blobSelector, jsonSelector } from '../selectors';
 import { HttpResponseError } from '../../errors';
+/** Base http client for executing requests */
 export class HttpClient {
+    /**
+     * A stream of requests that are about to be executed.
+     */
     get request$() {
         return this._request$.asObservable();
     }
+    /**
+     * A stream of responses that have been received.
+     */
     get response$() {
         return this._response$.asObservable();
     }
     constructor(uri, options) {
         this.uri = uri;
+        /**
+         * A stream of requests that are about to be executed.
+         * This property is used internally by the `HttpClient` class to manage the lifecycle of requests.
+         */
         this._request$ = new Subject();
+        /**
+         * A stream of responses that have been received.
+         * This property is used internally by the `HttpClient` class to manage the lifecycle of responses.
+         */
         this._response$ = new Subject();
+        /**
+         * A stream that is used to signal the abortion of requests.
+         * This property is used internally by the `HttpClient` class to manage the lifecycle of requests.
+         */
         this._abort$ = new Subject();
         this.requestHandler = new HttpRequestHandler(options === null || options === void 0 ? void 0 : options.requestHandler);
         this.responseHandler = new HttpResponseHandler(options === null || options === void 0 ? void 0 : options.responseHandler);
         this._init();
     }
+    /**
+     * Internal method called by child classes to perform initialization logic in the constructor.
+     * This method is intended to be overridden by child classes to add their own initialization logic.
+     * @protected
+     * @virtual
+     */
     _init() {
-    }
+        // called by children for constructor setup
+    }
+    /**
+     * Fetches data from the specified path and returns a stream response.
+     *
+     * @param path - The path to fetch data from.
+     * @param args - Optional request initialization options, including a custom selector function.
+     * @returns A stream response containing the fetched data.
+     */
     fetch$(path, args) {
         return this._fetch$(path, args);
     }
+    /**
+     * Fetches data from the specified path and returns a Promise containing the fetched data.
+     *
+     * @param path - The path to fetch data from.
+     * @param args - Optional request initialization options, including a custom selector function.
+     * @returns A Promise containing the fetched data.
+     */
     fetch(path, args) {
         return firstValueFrom(this.fetch$(path, args));
     }
+    /** @deprecated */
     fetchAsync(path, args) {
         return this.fetch(path, args);
     }
+    /**
+     * Fetches data from the specified path and returns a stream response containing the data in JSON format.
+     *
+     * @param path - The path to fetch the data from.
+     * @param args - Optional request initialization options, including a custom selector function and request body.
+     *   - `body`: The request body, which will be automatically serialized to JSON if it's an object.
+     *   - `selector`: A custom selector function to transform the response data. If not provided, the `jsonSelector` function will be used.
+     *   - `headers`: Additional headers to include in the request. The `Accept` and `Content-Type` headers will be automatically set to `application/json`.
+     * @returns A stream response containing the fetched data in JSON format.
+     */
     json$(path, args) {
         var _a;
         const body = typeof (args === null || args === void 0 ? void 0 : args.body) === 'object' ? JSON.stringify(args === null || args === void 0 ? void 0 : args.body) : args === null || args === void 0 ? void 0 : args.body;
@@ -53,32 +104,101 @@ export class HttpClient {
             selector,
             headers }));
     }
+    /**
+     * Fetches data from the specified path and returns a Promise containing the fetched data in JSON format.
+     *
+     * @param path - The path to fetch the data from.
+     * @param args - Optional request initialization options, including a custom selector function and request body.
+     *   - `body`: The request body, which will be automatically serialized to JSON if it's an object.
+     *   - `selector`: A custom selector function to transform the response data. If not provided, the `jsonSelector` function will be used.
+     *   - `headers`: Additional headers to include in the request. The `Accept` and `Content-Type` headers will be automatically set to `application/json`.
+     * @returns A Promise containing the fetched data in JSON format.
+     */
     json(path, args) {
         return firstValueFrom(this.json$(path, args));
     }
+    /**
+     * Fetches a blob resource from the specified path and returns a stream response.
+     *
+     * @param path - The path to the blob resource.
+     * @param args - Optional request initialization options, including a custom selector function.
+     * @returns A stream response containing the fetched blob data.
+     */
     blob$(path, args) {
         var _a;
+        // Get the selector value from the provided args, or use the default blobSelector
         const selector = (_a = args === null || args === void 0 ? void 0 : args.selector) !== null && _a !== void 0 ? _a : blobSelector;
-        return this.fetch$(path, Object.assign(Object.assign({}, args), { selector }));
-    }
+        // Create the FetchRequestInit object with the provided args and the selector
+        const init = Object.assign(Object.assign({}, args), { selector });
+        // Call the fetch$ method with the provided path and the constructed init object
+        return this.fetch$(path, init);
+    }
+    /**
+     * Fetches a blob from the specified path and returns a Promise that resolves to the blob result.
+     *
+     * @param path - The path to fetch the blob from.
+     * @param args - Optional arguments for the fetch request, including request body, headers, and response type.
+     * @returns A Promise that resolves to the blob result.
+     */
     blob(path, args) {
         return firstValueFrom(this.blob$(path, args));
     }
+    /** @deprecated */
     jsonAsync(path, args) {
         return this.json(path, args);
     }
+    /**
+     * Executes an HTTP request using the specified method and path.
+     *
+     * @param method - The HTTP method to use for the request, such as 'fetch', 'json', or 'blob'.
+     * @param path - The path to the resource to fetch.
+     * @param init - Optional request initialization options, including request body, headers, and response type.
+     * @returns The result of the HTTP request, which will be of the same type as the return value of the specified method.
+     */
     execute(method, path, init) {
         return this[method](path, init);
     }
+    /**
+     * Aborts any ongoing HTTP requests made by this `IHttpClient` instance.
+     * This will trigger the `takeUntil` operator in the `_fetch$` method,
+     * causing any in-flight requests to be cancelled.
+     */
     abort() {
         this._abort$.next();
     }
+    /**
+     * Fetches data from the specified path and returns an Observable that emits the response.
+     *
+     * @param path - The path to fetch the data from.
+     * @param args - Optional arguments for the fetch request, including a response selector function, request body, headers, and response type.
+     * @returns {Observable<T>} An Observable that emits the response data.
+     *
+     * This method handles the following steps:
+     * 1. Resolves the full URL by combining the base URI and the provided path.
+     * 2. Prepares the request by passing it through the `requestHandler.process()` method.
+     * 3. Executes the fetch request using the prepared request.
+     * 4. Prepares the response by passing it through the `responseHandler.process()` method.
+     * 5. Applies the optional response selector function to transform the response data.
+     * 6. Cancels the request if the `_abort$` observable emits.
+     */
     _fetch$(path, args) {
         const _a = args || {}, { selector } = _a, options = __rest(_a, ["selector"]);
-        const response$ = of(Object.assign(Object.assign({}, options), { uri: this._resolveUrl(path) })).pipe(switchMap((x) => this._prepareRequest(x)), tap((x) => this._request$.next(x)), switchMap((_a) => {
+        const response$ = of(Object.assign(Object.assign({}, options), { uri: this._resolveUrl(path) })).pipe(
+        /** prepare request, allow extensions to modify request  */
+        switchMap((x) => this._prepareRequest(x)), 
+        /** push request to event buss */
+        tap((x) => this._request$.next(x)), 
+        /** execute request */
+        switchMap((_a) => {
             var { uri, path: _path } = _a, init = __rest(_a, ["uri", "path"]);
             return fromFetch(uri, init);
-        }), switchMap((x) => this._prepareResponse(x)), tap((x) => this._response$.next(x)), switchMap((response) => {
+        }), 
+        /** prepare response, allow extensions to modify response  */
+        switchMap((x) => this._prepareResponse(x)), 
+        /** push response to event buss */
+        tap((x) => this._response$.next(x)), 
+        /** execute selector */
+        switchMap((response) => {
             if (selector) {
                 try {
                     return selector(response);
@@ -90,15 +210,42 @@ export class HttpClient {
                 }
             }
             return of(response);
-        }), takeUntil(this._abort$));
+        }), 
+        /** cancel request on abort signal */
+        takeUntil(this._abort$));
         return response$;
     }
+    /**
+     * Prepares the request by passing it through the `requestHandler.process()` method.
+     * This method is an implementation detail of the `_fetch$()` method, and is not part of the public API.
+     * It takes a `TRequest` object as input, which represents the request data, and returns an `ObservableInput<TRequest>`,
+     * which can be used to further process the request before it is executed.
+     *
+     * @param init The request data to be processed.
+     * @returns An `ObservableInput<TRequest>` that represents the processed request.
+     */
     _prepareRequest(init) {
         return this.requestHandler.process(init);
     }
+    /**
+     * Prepares the response by passing it through the `responseHandler.process()` method.
+     * This method is an implementation detail of the `_fetch$()` method, and is not part of the public API.
+     * It takes a `TResponse` object as input, which represents the response data, and returns an `ObservableInput<TResponse>`,
+     * which can be used to further process the response before it is returned.
+     *
+     * @param response The response data to be processed.
+     * @returns An `ObservableInput<TResponse>` that represents the processed response.
+     */
     _prepareResponse(response) {
         return this.responseHandler.process(response);
     }
+    /**
+     * Resolves the full URL for a given path by combining it with the base URL.
+     * This is a protected method and is an implementation detail of the `HttpClient` class.
+     *
+     * @param path - The path to be resolved.
+     * @returns The full URL for the given path.
+     */
     _resolveUrl(path) {
         const baseUrl = this.uri || window.location.origin;
         return new URL(path, baseUrl).href;

package/dist/esm/lib/client/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/lib/client/client.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAY1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAWjD,MAAM,OAAO,UAAU;IAiBnB,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IACzC,CAAC;IAED,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;IAC1C,CAAC;IAED,YACW,GAAW,EAClB,OAA+D;QADxD,QAAG,GAAH,GAAG,CAAQ;QAhBZ,cAAS,GAAG,IAAI,OAAO,EAAY,CAAC;QAGpC,eAAU,GAAG,IAAI,OAAO,EAAa,CAAC;QAEtC,YAAO,GAAG,IAAI,OAAO,EAAQ,CAAC;QAcpC,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAW,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC,CAAC;QAChF,IAAI,CAAC,eAAe,GAAG,IAAI,mBAAmB,CAAY,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,CAAC,CAAC;QACpF,IAAI,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC;IAGS,KAAK;IAEf,CAAC;IAEM,MAAM,CACT,IAAY,EACZ,IAA+C;QAE/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;IAEM,KAAK,CACR,IAAY,EACZ,IAA+C;QAE/C,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,CAAI,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACtD,CAAC;IAGM,UAAU,CACb,IAAY,EACZ,IAA+C;QAE/C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IAEM,KAAK,CACR,IAAY,EACZ,IAA4D;;QAE5D,MAAM,IAAI,GAAG,OAAO,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAC;QACtF,MAAM,QAAQ,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,mCAAI,YAAY,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QAC7C,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,gCAClB,IAAI,KACP,IAAI;YACJ,QAAQ;YACR,OAAO,GACkC,CAAC,CAAC;IACnD,CAAC;IAEM,IAAI,CACP,IAAY,EACZ,IAA4D;QAE5D,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,CAAI,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAEM,KAAK,CACR,IAAY,EACZ,IAAkD;;QAElD,MAAM,QAAQ,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,mCAAI,YAAY,CAAC;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,gCAClB,IAAI,KACP,QAAQ,GACoC,CAAC,CAAC;IACtD,CAAC;IAEM,IAAI,CAAC,IAAY,EAAE,IAAkD;QACxE,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAClD,CAAC;IAGM,SAAS,CACZ,IAAY,EACZ,IAA4D;QAE5D,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC;IAEM,OAAO,CACV,MAAe,EACf,IAAY,EACZ,IAA+C;QAE/C,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,CAAqC,CAAC;IACxE,CAAC;IAEM,KAAK;QACR,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC;IAES,OAAO,CACb,IAAY,EACZ,IAA+C;QAE/C,MAAM,KAA2B,IAAI,IAAI,EAAE,EAArC,EAAE,QAAQ,OAA2B,EAAtB,OAAO,cAAtB,YAAwB,CAAa,CAAC;QAC5C,MAAM,SAAS,GAAG,EAAE,CAAC,gCACd,OAAO,KACV,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAClB,CAAC,CAAC,IAAI,CAEf,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAEzC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAElC,SAAS,CAAC,CAAC,EAA6B,EAAE,EAAE;gBAAjC,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,OAAW,EAAN,IAAI,cAA3B,eAA6B,CAAF;YAAO,OAAA,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;SAAA,CAAC,EAElE,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAyB,CAAC,CAAC,EAElE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAGnC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;YACnB,IAAI,QAAQ,EAAE,CAAC;gBACX,IAAI,CAAC;oBACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAC9B,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACX,MAAM,IAAI,iBAAiB,CACvB,qCAAqC,EACrC,QAAoB,EACpB;wBACI,KAAK,EAAE,GAAG;qBACb,CACJ,CAAC;gBACN,CAAC;YACL,CAAC;YACD,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC,CAAC,EAEF,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAC1B,CAAC;QACF,OAAO,SAAqC,CAAC;IACjD,CAAC;IAES,eAAe,CAAC,IAAc;QACpC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAES,gBAAgB,CAAC,QAAmB;QAC1C,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAES,WAAW,CAAC,IAAY;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;QACnD,OAAO,IAAI,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;IACvC,CAAC;CACJ"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/lib/client/client.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAc1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAkBjD,8CAA8C;AAC9C,MAAM,OAAO,UAAU;IAmCnB;;OAEG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;IAC1C,CAAC;IAED,YACW,GAAW,EAClB,OAA+D;QADxD,QAAG,GAAH,GAAG,CAAQ;QAjCtB;;;WAGG;QACO,cAAS,GAAG,IAAI,OAAO,EAAY,CAAC;QAE9C;;;WAGG;QACO,eAAU,GAAG,IAAI,OAAO,EAAa,CAAC;QAEhD;;;WAGG;QACO,YAAO,GAAG,IAAI,OAAO,EAAQ,CAAC;QAoBpC,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAW,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC,CAAC;QAChF,IAAI,CAAC,eAAe,GAAG,IAAI,mBAAmB,CAAY,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,CAAC,CAAC;QACpF,IAAI,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACO,KAAK;QACX,2CAA2C;IAC/C,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CACT,IAAY,EACZ,IAA+C;QAE/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CACR,IAAY,EACZ,IAA+C;QAE/C,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,CAAI,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACtD,CAAC;IAED,kBAAkB;IACX,UAAU,CACb,IAAY,EACZ,IAA+C;QAE/C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CACR,IAAY,EACZ,IAA4D;;QAE5D,MAAM,IAAI,GAAG,OAAO,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAC;QACtF,MAAM,QAAQ,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,mCAAI,YAAY,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QAC7C,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,gCAClB,IAAI,KACP,IAAI;YACJ,QAAQ;YACR,OAAO,GACkC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;OASG;IACI,IAAI,CACP,IAAY,EACZ,IAA4D;QAE5D,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,CAAI,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CACR,IAAY,EACZ,IAA+C;;QAE/C,iFAAiF;QACjF,MAAM,QAAQ,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,mCAAI,YAAY,CAAC;QAEhD,6EAA6E;QAC7E,MAAM,IAAI,GAAG,gCACN,IAAI,KACP,QAAQ,GACiC,CAAC;QAE9C,gFAAgF;QAChF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CACP,IAAY,EACZ,IAA+C;QAE/C,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,kBAAkB;IACX,SAAS,CACZ,IAAY,EACZ,IAA4D;QAE5D,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;OAOG;IACI,OAAO,CACV,MAAe,EACf,IAAY,EACZ,IAA+C;QAE/C,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,CAAqC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACI,KAAK;QACR,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACO,OAAO,CACb,IAAY,EACZ,IAA+C;QAE/C,MAAM,KAA2B,IAAI,IAAI,EAAE,EAArC,EAAE,QAAQ,OAA2B,EAAtB,OAAO,cAAtB,YAAwB,CAAa,CAAC;QAC5C,MAAM,SAAS,GAAG,EAAE,CAAC,gCACd,OAAO,KACV,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAClB,CAAC,CAAC,IAAI;QACf,2DAA2D;QAC3D,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACzC,iCAAiC;QACjC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClC,sBAAsB;QACtB,SAAS,CAAC,CAAC,EAA6B,EAAE,EAAE;gBAAjC,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,OAAW,EAAN,IAAI,cAA3B,eAA6B,CAAF;YAAO,OAAA,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;SAAA,CAAC;QAClE,6DAA6D;QAC7D,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAyB,CAAC,CAAC;QAClE,kCAAkC;QAClC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEnC,uBAAuB;QACvB,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;YACnB,IAAI,QAAQ,EAAE,CAAC;gBACX,IAAI,CAAC;oBACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAC9B,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACX,MAAM,IAAI,iBAAiB,CACvB,qCAAqC,EACrC,QAAoB,EACpB;wBACI,KAAK,EAAE,GAAG;qBACb,CACJ,CAAC;gBACN,CAAC;YACL,CAAC;YACD,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC,CAAC;QACF,qCAAqC;QACrC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAC1B,CAAC;QACF,OAAO,SAAqC,CAAC;IACjD,CAAC;IAED;;;;;;;;OAQG;IACO,eAAe,CAAC,IAAc;QACpC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACO,gBAAgB,CAAC,QAAmB;QAC1C,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACO,WAAW,CAAC,IAAY;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;QACnD,OAAO,IAAI,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;IACvC,CAAC;CACJ"}

package/dist/esm/lib/operators/http-request-handler.js

@@ -1,6 +1,22 @@
 import { ProcessOperators } from './process-operators';
 import { requestOperatorHeader } from './request-operator-header';
+/**
+ * Extends the `ProcessOperators` class to handle HTTP requests.
+ *
+ * This class provides a method to set a header that will apply to all requests made by the `HttpClient`.
+ *
+ * @see {@link ProcessOperators}
+ *
+ * @template T - The type of the fetch request, which extends `FetchRequest`.
+ */
 export class HttpRequestHandler extends ProcessOperators {
+    /**
+     * Sets a header that will apply to all requests made by the `HttpClient`.
+     *
+     * @param key - The name of the header to set.
+     * @param value - The value of the header to set.
+     * @returns The current `HttpRequestHandler` instance, allowing for method chaining.
+     */
     setHeader(key, value) {
         const operator = requestOperatorHeader(key, value);
         return this.set('header-' + key, operator);

package/dist/esm/lib/operators/http-request-handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"http-request-handler.js","sourceRoot":"","sources":["../../../../src/lib/operators/http-request-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAOlE,MAAM,OAAO,kBAA0D,SAAQ,gBAAmB;IAM9F,SAAS,CAAC,GAAW,EAAE,KAAa;QAChC,MAAM,QAAQ,GAAG,qBAAqB,CAAI,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,GAAG,EAAE,QAAQ,CAA0B,CAAC;IACxE,CAAC;CACJ;AAED,eAAe,kBAAkB,CAAC"}
+{"version":3,"file":"http-request-handler.js","sourceRoot":"","sources":["../../../../src/lib/operators/http-request-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAIlE;;;;;;;;GAQG;AACH,MAAM,OAAO,kBAA0D,SAAQ,gBAAmB;IAC9F;;;;;;OAMG;IACH,SAAS,CAAC,GAAW,EAAE,KAAa;QAChC,MAAM,QAAQ,GAAG,qBAAqB,CAAI,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,GAAG,EAAE,QAAQ,CAA0B,CAAC;IACxE,CAAC;CACJ;AAED,eAAe,kBAAkB,CAAC"}

package/dist/esm/lib/operators/http-response-handler.js

@@ -1,4 +1,10 @@
 import { ProcessOperators } from './process-operators';
+/**
+ * The `HttpResponseHandler` class extends the `ProcessOperators` class and is responsible for handling HTTP responses.
+ * It provides a common interface for processing HTTP responses, allowing for consistent error handling and response transformation.
+ *
+ * @template T - The type of the HTTP response. Defaults to `Response`.
+ */
 export class HttpResponseHandler extends ProcessOperators {
 }
 export default HttpResponseHandler;

package/dist/esm/lib/operators/http-response-handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"http-response-handler.js","sourceRoot":"","sources":["../../../../src/lib/operators/http-response-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,MAAM,OAAO,mBAAkC,SAAQ,gBAAmB;CAAG;AAE7E,eAAe,mBAAmB,CAAC"}
+{"version":3,"file":"http-response-handler.js","sourceRoot":"","sources":["../../../../src/lib/operators/http-response-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,OAAO,mBAAkC,SAAQ,gBAAmB;CAAG;AAE7E,eAAe,mBAAmB,CAAC"}

package/dist/esm/lib/operators/process-operators.js

@@ -1,9 +1,25 @@
 import { from, of } from 'rxjs';
 import { last, mergeScan } from 'rxjs/operators';
+/**
+ * ProcessOperators class manages a collection of process operators
+ * and provides methods to add, set, get, and process these operators.
+ * It implements the IProcessOperators interface for type T.
+ *
+ * @template T The type of data that the process operators work with
+ */
 export class ProcessOperators {
+    /**
+     * Accessor for the collection of process operators.
+     * @returns The record of process operators.
+     */
     get operators() {
         return this._operators;
     }
+    /**
+     * Constructs a new instance of the ProcessOperators class.
+     * @param operators - An optional object containing process operators.
+     *                    It can be either an instance of IProcessOperators<T> or a record of string keys and ProcessOperator<T> values.
+     */
     constructor(operators) {
         if (operators && 'operators' in operators) {
             this._operators = Object.assign({}, operators.operators);
@@ -12,24 +28,56 @@ export class ProcessOperators {
             this._operators = operators !== null && operators !== void 0 ? operators : {};
         }
     }
+    /**
+     * Adds a new operator to the collection.
+     * @param key The key under which the operator is stored.
+     * @param operator The operator to be added.
+     * @returns The instance of ProcessOperators for chaining.
+     * @throws Error if an operator with the same key already exists.
+     */
     add(key, operator) {
         if (Object.keys(this._operators).includes(key))
             throw Error(`Operator [${key}] already defined`);
         return this.set(key, operator);
     }
+    /**
+     * Sets or updates an operator in the collection.
+     * @param key The key under which the operator is stored.
+     * @param operator The operator to be set.
+     * @returns The instance of ProcessOperators for chaining.
+     */
     set(key, operator) {
         this._operators[key] = operator;
         return this;
     }
+    /**
+     * Retrieves an operator from the collection by its key.
+     * @param key The key of the operator to retrieve.
+     * @returns The retrieved operator.
+     */
     get(key) {
         return this._operators[key];
     }
+    /**
+     * Processes an input request through the chain of operators.
+     * @param request The request to be processed.
+     * @returns An Observable of the processed request.
+     */
     process(request) {
         const operators = Object.values(this._operators);
+        /** if no operators registered, just return the observable value */
         if (!operators.length) {
             return of(request);
         }
-        return from(Object.values(this._operators)).pipe(mergeScan((value, operator) => Promise.resolve(operator(value)).then((x) => x !== null && x !== void 0 ? x : value), request, 1), last());
+        return from(Object.values(this._operators)).pipe(mergeScan(
+        // resolve current operator and return result or previous if void
+        (value, operator) => Promise.resolve(operator(value)).then((x) => x !== null && x !== void 0 ? x : value), 
+        // initial value
+        request, 
+        // only allow concurrency of one operator
+        1), 
+        // output result of last operator
+        last());
     }
 }
 //# sourceMappingURL=process-operators.js.map

package/dist/esm/lib/operators/process-operators.js.map

@@ -1 +1 @@
-{"version":3,"file":"process-operators.js","sourceRoot":"","sources":["../../../../src/lib/operators/process-operators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAOjD,MAAM,OAAO,gBAAgB;IAUzB,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAOD,YAAY,SAAqE;QAC7E,IAAI,SAAS,IAAI,WAAW,IAAI,SAAS,EAAE,CAAC;YACxC,IAAI,CAAC,UAAU,qBAAQ,SAAS,CAAC,SAAS,CAAE,CAAC;QACjD,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,UAAU,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,EAAE,CAAC;QACtC,CAAC;IACL,CAAC;IASD,GAAG,CAAC,GAAW,EAAE,QAA4B;QACzC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;YAC1C,MAAM,KAAK,CAAC,aAAa,GAAG,mBAAmB,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAQD,GAAG,CAAC,GAAW,EAAE,QAA4B;QACzC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;QAChC,OAAO,IAAI,CAAC;IAChB,CAAC;IAOD,GAAG,CAAC,GAAW;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAOD,OAAO,CAAC,OAAU;QACd,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAC5C,SAAS,CAEL,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAD,CAAC,cAAD,CAAC,GAAI,KAAK,CAAC,EAE7E,OAAO,EAEP,CAAC,CACJ,EAED,IAAI,EAAE,CACT,CAAC;IACN,CAAC;CACJ"}
+{"version":3,"file":"process-operators.js","sourceRoot":"","sources":["../../../../src/lib/operators/process-operators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGjD;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IAQzB;;;OAGG;IACH,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,YAAY,SAAqE;QAC7E,IAAI,SAAS,IAAI,WAAW,IAAI,SAAS,EAAE,CAAC;YACxC,IAAI,CAAC,UAAU,qBAAQ,SAAS,CAAC,SAAS,CAAE,CAAC;QACjD,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,UAAU,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,EAAE,CAAC;QACtC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,GAAW,EAAE,QAA4B;QACzC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;YAC1C,MAAM,KAAK,CAAC,aAAa,GAAG,mBAAmB,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,GAAW,EAAE,QAA4B;QACzC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;QAChC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,GAAW;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,OAAU;QACd,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjD,mEAAmE;QACnE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAC5C,SAAS;QACL,iEAAiE;QACjE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAD,CAAC,cAAD,CAAC,GAAI,KAAK,CAAC;QAC7E,gBAAgB;QAChB,OAAO;QACP,yCAAyC;QACzC,CAAC,CACJ;QACD,iCAAiC;QACjC,IAAI,EAAE,CACT,CAAC;IACN,CAAC;CACJ"}

package/dist/esm/lib/operators/request-operator-header.js

@@ -1,3 +1,10 @@
+/**
+ * Creates a process operator that adds a header to the request.
+ *
+ * @param key - The header key to add.
+ * @param value - The header value to add.
+ * @returns A process operator that adds the specified header to the request.
+ */
 export const requestOperatorHeader = (key, value) => (request) => {
     const headers = new Headers(request.headers);
     headers.append(key, value);

package/dist/esm/lib/operators/request-operator-header.js.map

@@ -1 +1 @@
-{"version":3,"file":"request-operator-header.js","sourceRoot":"","sources":["../../../../src/lib/operators/request-operator-header.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,qBAAqB,GAC9B,CAAwC,GAAW,EAAE,KAAa,EAAsB,EAAE,CAC1F,CAAC,OAAO,EAAE,EAAE;IACR,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3B,uCAAY,OAAO,KAAE,OAAO,IAAG;AACnC,CAAC,CAAC;AAEN,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"request-operator-header.js","sourceRoot":"","sources":["../../../../src/lib/operators/request-operator-header.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAC9B,CAAwC,GAAW,EAAE,KAAa,EAAsB,EAAE,CAC1F,CAAC,OAAO,EAAE,EAAE;IACR,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3B,uCAAY,OAAO,KAAE,OAAO,IAAG;AACnC,CAAC,CAAC;AAEN,eAAe,qBAAqB,CAAC"}

package/dist/esm/lib/selectors/blob-selector.js

@@ -1,16 +1,41 @@
-export const blobSelector = (response) => {
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/**
+ * Extracts a blob and filename from a successful HTTP response.
+ *
+ * @param response - The HTTP response to extract the blob and filename from.
+ * @returns A promise that resolves to an object containing the extracted blob and filename.
+ * @throws {Error} If the response is not successful or if there is an error parsing the response.
+ */
+export const blobSelector = (response) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c;
     if (!response.ok) {
+        // Throw an error if the network response is not successful
         throw new Error('network response was not OK');
     }
+    // Status code 204 indicates no content, so throw an error
     if (response.status === 204) {
         throw new Error('no content');
     }
+    // Extract the filename from the 'content-disposition' header
+    const filename = (_c = (_b = (_a = response.headers
+        .get('content-disposition')) === null || _a === void 0 ? void 0 : _a.split(';').find((n) => n.includes('filename='))) === null || _b === void 0 ? void 0 : _b.replace('filename=', '')) === null || _c === void 0 ? void 0 : _c.trim();
     try {
-        return response.blob();
+        // Convert the response to a Blob and return the filename and Blob
+        const blob = yield response.blob();
+        return { filename, blob };
     }
     catch (err) {
+        // Throw an error if there's a problem parsing the response
         throw Error('failed to parse response');
     }
-};
+});
 export default blobSelector;
 //# sourceMappingURL=blob-selector.js.map

package/dist/esm/lib/selectors/blob-selector.js.map

@@ -1 +1 @@
-{"version":3,"file":"blob-selector.js","sourceRoot":"","sources":["../../../../src/lib/selectors/blob-selector.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,YAAY,GAAG,CACxB,QAAmB,EACN,EAAE;IACf,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC5C,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,YAAY,CAAC"}
+{"version":3,"file":"blob-selector.js","sourceRoot":"","sources":["../../../../src/lib/selectors/blob-selector.ts"],"names":[],"mappings":";;;;;;;;;AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAqB,CAC1C,QAAmB,EACA,EAAE;;IACrB,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACf,2DAA2D;QAC3D,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACnD,CAAC;IAED,0DAA0D;IAC1D,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,6DAA6D;IAC7D,MAAM,QAAQ,GAAG,MAAA,MAAA,MAAA,QAAQ,CAAC,OAAO;SAC5B,GAAG,CAAC,qBAAqB,CAAC,0CACzB,KAAK,CAAC,GAAG,EACV,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,0CACnC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,0CACxB,IAAI,EAAE,CAAC;IAEb,IAAI,CAAC;QACD,kEAAkE;QAClE,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC9B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,2DAA2D;QAC3D,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC5C,CAAC;AACL,CAAC,CAAA,CAAC;AAEF,eAAe,YAAY,CAAC"}