@equinor/fusion-framework-module-http 8.0.3 → 8.0.4

package/dist/types/configurator.d.ts

@@ -117,7 +117,11 @@ export interface IHttpClientConfigurator<TClient extends IHttpClient = IHttpClie
 /** @inheritdoc */
 export declare class HttpClientConfigurator<TClient extends IHttpClient> implements IHttpClientConfigurator<TClient> {
     protected _clients: Record<string, HttpClientOptions<TClient>>;
-    /** Gets a shallow clone of all named client configurations. */
+    /**
+     * Gets a shallow clone of all named client configurations.
+     *
+     * @returns A shallow clone of the named client configurations.
+     */
     get clients(): Record<string, HttpClientOptions<TClient>>;
     /** Default constructor used when a client configuration does not provide `ctor`. */
     readonly defaultHttpClientCtor: HttpClientConstructor<TClient>;

package/dist/types/errors/ClientNotFoundException.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Thrown when `createClient(name)` is called with an unknown client key.
+ *
+ * This is only used when the provided string is neither a registered client name
+ * nor an absolute `http:` or `https:` URL.
+ */
+export declare class ClientNotFoundException extends Error {
+}
+export default ClientNotFoundException;

package/dist/types/errors/HttpJsonResponseError.d.ts

@@ -0,0 +1,23 @@
+import { HttpResponseError } from './HttpResponseError.js';
+/**
+ * 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 declare class HttpJsonResponseError<TType = unknown, TResponse = Response> extends HttpResponseError<TResponse> {
+    static Name: string;
+    readonly data?: TType;
+    /**
+     * 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: string, response: TResponse, options?: ErrorOptions & {
+        data?: TType;
+    });
+}
+export default HttpJsonResponseError;

package/dist/types/errors/HttpResponseError.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Represents an error that occurs when handling an HTTP response.
+ * @template TResponse The type of the HTTP response.
+ */
+export declare class HttpResponseError<TResponse = Response> extends Error {
+    readonly response: TResponse;
+    static Name: string;
+    /**
+     * @param message - The error message.
+     * @param response - The HTTP response associated with the error.
+     * @param options - Additional error options.
+     */
+    constructor(message: string, response: TResponse, options?: ErrorOptions);
+}
+export default HttpResponseError;

package/dist/types/errors/ServerSentEventResponseError.d.ts

@@ -0,0 +1,23 @@
+import { HttpResponseError } from './HttpResponseError.js';
+/**
+ * Represents an error that occurs when handling a server-sent event (SSE) HTTP response.
+ *
+ * @template TType - The type of additional data associated with the error.
+ * @template TResponse - The type of the HTTP response object.
+ *
+ * @extends HttpResponseError<TResponse>
+ */
+export declare class ServerSentEventResponseError<TType = unknown, TResponse = Response> extends HttpResponseError<TResponse> {
+    static Name: string;
+    /**
+     * Creates a new instance of the error.
+     *
+     * @param message - The error message describing the cause of the error.
+     * @param response - The HTTP response associated with the error.
+     * @param options - Optional error options, which may include additional data of type `TType`.
+     */
+    constructor(message: string, response: TResponse, options?: ErrorOptions & {
+        data?: TType;
+    });
+}
+export default ServerSentEventResponseError;

package/dist/types/errors/index.d.ts

@@ -0,0 +1,4 @@
+export * from './HttpResponseError.js';
+export * from './HttpJsonResponseError.js';
+export * from './ServerSentEventResponseError.js';
+export * from './ClientNotFoundException.js';

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@
 export * from './configurator';
 export * from './provider';
 export * from './module';
-export * from './errors';
+export * as Errors from './errors/index.js';
+export * from './errors/index.js';
 export type { IHttpClient, FetchResponse } from './lib/client';
 export { default } from './module';

package/dist/types/lib/client/client-msal.d.ts

@@ -46,6 +46,7 @@ export declare class HttpClientMsal<TRequest extends MsalFetchRequest = MsalFetc
      *
      * @overrides HttpClient.fetch$
      *
+     * @template T - The expected response type.
      * @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.

package/dist/types/lib/client/client.d.ts

@@ -2,7 +2,7 @@ import { Subject } from 'rxjs';
 import type { Observable, ObservableInput } from 'rxjs';
 import type { IHttpRequestHandler, IHttpResponseHandler } from '../operators';
 import type { BlobResult, FetchRequest, FetchRequestInit, FetchResponse, IHttpClient, JsonRequest, StreamResponse } from './types';
-import { type ServerSentEvent, type SseSelectorOptions } from '../selectors/sse-selector';
+import { type ServerSentEvent, type SseSelectorOptions } from '../selectors/create-sse-selector';
 /**
  * Configuration options for creating an `HttpClient` instance.
  *
@@ -45,12 +45,19 @@ export declare class HttpClient<TRequest extends FetchRequest = FetchRequest, TR
     protected _abort$: Subject<void>;
     /**
      * A stream of requests that are about to be executed.
+     * @returns An `Observable` that emits each request before it is executed.
      */
     get request$(): Observable<TRequest>;
     /**
      * A stream of responses that have been received.
+     * @returns An `Observable` that emits each response as it is received.
      */
     get response$(): Observable<TResponse>;
+    /**
+     * Creates a new `HttpClient`.
+     * @param uri - The base URI used to resolve relative request paths.
+     * @param options - Optional request and response handlers.
+     */
     constructor(uri: string, options?: Partial<HttpClientCreateOptions<TRequest, TResponse>>);
     /**
      * Internal method called by child classes to perform initialization logic in the constructor.
@@ -62,6 +69,7 @@ export declare class HttpClient<TRequest extends FetchRequest = FetchRequest, TR
     /**
      * Fetches data from the specified path and returns a stream response.
      *
+     * @template T - The expected shape of the fetched data.
      * @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.
@@ -70,16 +78,24 @@ export declare class HttpClient<TRequest extends FetchRequest = FetchRequest, TR
     /**
      * Fetches data from the specified path and returns a Promise containing the fetched data.
      *
+     * @template T - The expected shape of 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<T = TResponse>(path: string, args?: FetchRequestInit<T, TRequest, TResponse>): Promise<T>;
-    /** @deprecated */
+    /**
+     * @deprecated Use {@link fetch} instead.
+     * @template T - The expected shape of 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.
+     */
     fetchAsync<T = TResponse>(path: string, args?: FetchRequestInit<T, TRequest, TResponse>): Promise<T>;
     /**
      * Fetches data from the specified path and returns a stream response containing the data in JSON format.
      *
+     * @template T - The expected shape of the parsed JSON data.
      * @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.
@@ -91,6 +107,7 @@ export declare class HttpClient<TRequest extends FetchRequest = FetchRequest, TR
     /**
      * Fetches data from the specified path and returns a Promise containing the fetched data in JSON format.
      *
+     * @template T - The expected shape of the parsed JSON data.
      * @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.
@@ -102,6 +119,7 @@ export declare class HttpClient<TRequest extends FetchRequest = FetchRequest, TR
     /**
      * Fetches a blob resource from the specified path and returns a stream response.
      *
+     * @template T - The expected shape of the fetched blob data.
      * @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.
@@ -110,6 +128,7 @@ export declare class HttpClient<TRequest extends FetchRequest = FetchRequest, TR
     /**
      * Fetches a blob from the specified path and returns a Promise that resolves to the blob result.
      *
+     * @template T - The expected shape of the fetched blob data.
      * @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.
@@ -138,11 +157,19 @@ export declare class HttpClient<TRequest extends FetchRequest = FetchRequest, TR
      * });
      */
     sse$<T = unknown>(path: string, args?: FetchRequestInit<ServerSentEvent<T>, TRequest, TResponse> | null, options?: Omit<SseSelectorOptions<T>, 'abortSignal'>): StreamResponse<ServerSentEvent<T>>;
-    /** @deprecated */
+    /**
+     * @deprecated Use {@link json} instead.
+     * @template T - The expected shape of the parsed JSON data.
+     * @param path - The path to fetch the data from.
+     * @param args - Optional request initialization options, including a custom selector function and request body.
+     * @returns A Promise containing the fetched data in JSON format.
+     */
     jsonAsync<T = unknown>(path: string, args?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>): Promise<T>;
     /**
      * Executes an HTTP request using the specified method and path.
      *
+     * @template T - The expected shape of the result.
+     * @template TMethod - The name of the `IHttpClient` method to invoke.
      * @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.
@@ -158,10 +185,13 @@ export declare class HttpClient<TRequest extends FetchRequest = FetchRequest, TR
     /**
      * Fetches data from the specified path and returns an Observable that emits the response.
      *
+     * @template T - The expected shape of the emitted data.
      * @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.
      *
+     * @throws {HttpResponseError} When the optional `selector` throws while transforming the response.
+     *
      * 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.

package/dist/types/lib/operators/{http-request-handler.d.ts → HttpRequestHandler.d.ts}

@@ -1,4 +1,4 @@
-import { ProcessOperators } from './process-operators';
+import { ProcessOperators } from './ProcessOperators';
 import type { FetchRequest } from '../client';
 /**
  * Extends the `ProcessOperators` class to handle HTTP requests.

package/dist/types/lib/operators/{http-response-handler.d.ts → HttpResponseHandler.d.ts}

@@ -1,4 +1,4 @@
-import { ProcessOperators } from './process-operators';
+import { ProcessOperators } from './ProcessOperators';
 /**
  * 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.

package/dist/types/lib/operators/index.d.ts

@@ -1,7 +1,7 @@
-export { HttpRequestHandler } from './http-request-handler';
-export { HttpResponseHandler } from './http-response-handler';
-export { ProcessOperators } from './process-operators';
-export { capitalizeRequestMethodOperator } from './capitalize-request-method.operator';
-export { requestValidationOperator } from './request-validation.operator';
-export { sseMap } from './sse.operator';
+export { HttpRequestHandler } from './HttpRequestHandler';
+export { HttpResponseHandler } from './HttpResponseHandler';
+export { ProcessOperators } from './ProcessOperators';
+export { capitalizeRequestMethodOperator } from './capitalize-request-method-operator';
+export { requestValidationOperator } from './request-validation-operator';
+export { sseMap } from './sse-map.operator';
 export * from './types';

package/dist/types/lib/operators/{sse.operator.d.ts → sse-map.operator.d.ts}

@@ -1,5 +1,5 @@
 import type { OperatorFunction } from 'rxjs';
-import { type ServerSentEvent, type SseSelectorOptions } from '../selectors/sse-selector';
+import { type ServerSentEvent, type SseSelectorOptions } from '../selectors/create-sse-selector';
 /**
  * An operator function for handling Server-Sent Events (SSE) in an RxJS pipeline.
  *

package/dist/types/lib/selectors/index.d.ts

@@ -1,5 +1,5 @@
 export { jsonSelector } from './json-selector';
 export { blobSelector } from './blob-selector';
-export { createSseSelector } from './sse-selector';
+export { createSseSelector } from './create-sse-selector';
 export type { ResponseSelector } from '../client/types';
-export type { DataParser, ServerSentEvent, SseSelector, SseSelectorOptions, } from './sse-selector';
+export type { DataParser, ServerSentEvent, SseSelector, SseSelectorOptions, } from './create-sse-selector';

package/dist/types/provider.d.ts

@@ -3,14 +3,6 @@ import type { HttpClientOptions, HttpClientRequestInitType, IHttpClientConfigura
 import type { IHttpRequestHandler } from './lib/operators';
 import type { IHttpClient } from './lib/client';
 import { BaseModuleProvider } from '@equinor/fusion-framework-module/provider';
-/**
- * Thrown when `createClient(name)` is called with an unknown client key.
- *
- * This is only used when the provided string is neither a registered client name
- * nor an absolute `http:` or `https:` URL.
- */
-export declare class ClientNotFoundException extends Error {
-}
 /**
  * Creates fresh HTTP client instances from named or ad-hoc configuration.
  *
@@ -62,6 +54,10 @@ export declare class HttpClientProvider<TClient extends IHttpClient = IHttpClien
      * @returns The default HTTP request handler.
      */
     get defaultHttpRequestHandler(): IHttpRequestHandler<HttpClientRequestInitType<TClient>>;
+    /**
+     * Creates a new `HttpClientProvider`.
+     * @param config - The configurator providing client definitions and defaults.
+     */
     constructor(config: IHttpClientConfigurator<TClient>);
     /**
      * Checks if a client with the given key is configured in the `HttpClientProvider`.
@@ -89,6 +85,7 @@ export declare class HttpClientProvider<TClient extends IHttpClient = IHttpClien
     /**
      * Creates a client instance and returns it as the requested custom client type.
      *
+     * @template T - The custom `HttpClient` implementation type to cast the created instance to.
      * @param key - The key of the pre-configured HTTP client to create.
      * @returns The created HTTP client instance, cast to the specified type `T`.
      *
@@ -108,6 +105,8 @@ export declare class HttpClientProvider<TClient extends IHttpClient = IHttpClien
      *
      * @param keyOrConfig - The key or configuration object for the HTTP client.
      * @returns The resolved HTTP client configuration.
+     * @throws {ClientNotFoundException} When `keyOrConfig` is a string that is neither a registered
+     * client key nor a URL-like value.
      */
     protected _resolveConfig(keyOrConfig: string | HttpClientOptions<TClient>): HttpClientOptions<TClient>;
 }

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.0.3";
+export declare const version = "8.0.4";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-http",
-  "version": "8.0.3",
+  "version": "8.0.4",
   "description": "",
   "main": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -22,8 +22,8 @@
       "types": "./dist/types/lib/selectors/index.d.ts"
     },
     "./errors": {
-      "import": "./dist/esm/errors.js",
-      "types": "./dist/types/errors.d.ts"
+      "import": "./dist/esm/errors/index.js",
+      "types": "./dist/types/errors/index.d.ts"
     }
   },
   "typesVersions": {
@@ -41,7 +41,7 @@
         "dist/types/lib/selectors/index.d.ts"
       ],
       "errors": [
-        "dist/types/errors.d.ts"
+        "dist/types/errors/index.d.ts"
       ]
     }
   },
@@ -59,11 +59,11 @@
   "dependencies": {
     "rxjs": "^7.8.1",
     "zod": "^4.4.3",
-    "@equinor/fusion-framework-module": "^6.1.0",
-    "@equinor/fusion-framework-module-msal": "^10.0.0"
+    "@equinor/fusion-framework-module": "^6.1.1",
+    "@equinor/fusion-framework-module-msal": "^10.0.2"
   },
   "devDependencies": {
-    "typescript": "^6.0.3",
+    "typescript": "^7.0.2",
     "vitest": "^4.1.0"
   },
   "scripts": {

package/src/configurator.ts

@@ -155,7 +155,11 @@ export class HttpClientConfigurator<TClient extends IHttpClient>
 {
   protected _clients: Record<string, HttpClientOptions<TClient>> = {};
 
-  /** Gets a shallow clone of all named client configurations. */
+  /**
+   * Gets a shallow clone of all named client configurations.
+   *
+   * @returns A shallow clone of the named client configurations.
+   */
   public get clients(): Record<string, HttpClientOptions<TClient>> {
     return { ...this._clients };
   }
@@ -191,6 +195,8 @@ export class HttpClientConfigurator<TClient extends IHttpClient>
   ): HttpClientConfigurator<TClient> {
     const argFn = typeof args === 'string' ? ({ baseUri: args } as HttpClientOptions<T>) : args;
     const options = typeof argFn === 'function' ? { onCreate: argFn } : argFn;
+    // `options` is `HttpClientOptions<T>` (this call's generic), but `_clients` is keyed by the
+    // configurator's own `TClient` — callers are expected to keep the two in sync.
     this._clients[name] = {
       ...this._clients[name],
       ...(options as unknown as HttpClientOptions<TClient>),

package/src/errors/ClientNotFoundException.ts

@@ -0,0 +1,9 @@
+/**
+ * Thrown when `createClient(name)` is called with an unknown client key.
+ *
+ * This is only used when the provided string is neither a registered client name
+ * nor an absolute `http:` or `https:` URL.
+ */
+export class ClientNotFoundException extends Error {}
+
+export default ClientNotFoundException;

package/src/errors/HttpJsonResponseError.ts

@@ -0,0 +1,31 @@
+import { HttpResponseError } from './HttpResponseError.js';
+
+/**
+ * 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<
+  TType = unknown,
+  TResponse = Response,
+> extends HttpResponseError<TResponse> {
+  static Name = 'HttpJsonResponseError';
+  public readonly data?: TType;
+
+  /**
+   * 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: string, response: TResponse, options?: ErrorOptions & { data?: TType }) {
+    super(message, response, options);
+    this.name = HttpJsonResponseError.Name;
+    this.data = options?.data;
+  }
+}
+
+export default HttpJsonResponseError;

package/src/errors/HttpResponseError.ts

@@ -0,0 +1,21 @@
+/**
+ * Represents an error that occurs when handling an HTTP response.
+ * @template TResponse The type of the HTTP response.
+ */
+export class HttpResponseError<TResponse = Response> extends Error {
+  static Name = 'HttpResponseError';
+  /**
+   * @param message - The error message.
+   * @param response - The HTTP response associated with the error.
+   * @param options - Additional error options.
+   */
+  constructor(
+    message: string,
+    public readonly response: TResponse,
+    options?: ErrorOptions,
+  ) {
+    super(message, options);
+  }
+}
+
+export default HttpResponseError;

package/src/errors/ServerSentEventResponseError.ts

@@ -0,0 +1,30 @@
+import { HttpResponseError } from './HttpResponseError.js';
+
+/**
+ * Represents an error that occurs when handling a server-sent event (SSE) HTTP response.
+ *
+ * @template TType - The type of additional data associated with the error.
+ * @template TResponse - The type of the HTTP response object.
+ *
+ * @extends HttpResponseError<TResponse>
+ */
+export class ServerSentEventResponseError<
+  TType = unknown,
+  TResponse = Response,
+> extends HttpResponseError<TResponse> {
+  static Name = 'ServerSentEventResponseError';
+
+  /**
+   * Creates a new instance of the error.
+   *
+   * @param message - The error message describing the cause of the error.
+   * @param response - The HTTP response associated with the error.
+   * @param options - Optional error options, which may include additional data of type `TType`.
+   */
+  constructor(message: string, response: TResponse, options?: ErrorOptions & { data?: TType }) {
+    super(message, response, options);
+    this.name = ServerSentEventResponseError.Name;
+  }
+}
+
+export default ServerSentEventResponseError;

package/src/errors/index.ts

@@ -0,0 +1,4 @@
+export * from './HttpResponseError.js';
+export * from './HttpJsonResponseError.js';
+export * from './ServerSentEventResponseError.js';
+export * from './ClientNotFoundException.js';

package/src/index.ts

@@ -7,7 +7,8 @@ export * from './configurator';
 export * from './provider';
 export * from './module';
 
-export * from './errors';
+export * as Errors from './errors/index.js';
+export * from './errors/index.js';
 
 export type { IHttpClient, FetchResponse } from './lib/client';
 

package/src/lib/client/client-msal.ts

@@ -55,6 +55,7 @@ export class HttpClientMsal<
    *
    * @overrides HttpClient.fetch$
    *
+   * @template T - The expected response type.
    * @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.