@equinor/fusion-framework-module-http 6.2.1 → 6.2.2

package/dist/types/lib/operators/process-operators.d.ts

@@ -1,5 +1,5 @@
 import type { Observable } from 'rxjs';
-import { IProcessOperators, ProcessOperator } from './types';
+import type { IProcessOperators, ProcessOperator } from './types';
 /**
  * ProcessOperators class manages a collection of process operators
  * and provides methods to add, set, get, and process these operators.

package/dist/types/module.d.ts

@@ -1,8 +1,8 @@
 import { HttpClientMsal } from './lib/client';
-import { IHttpClientConfigurator, HttpClientOptions } from './configurator';
-import { IHttpClientProvider } from './provider';
+import { type IHttpClientConfigurator, type HttpClientOptions } from './configurator';
+import { type IHttpClientProvider } from './provider';
 import type { Module, ModuleConfigType, IModuleConfigurator } from '@equinor/fusion-framework-module';
-import { MsalModule } from '@equinor/fusion-framework-module-msal';
+import type { MsalModule } from '@equinor/fusion-framework-module-msal';
 /**
  * Defines the type for the HTTP module, which includes:
  * - The module name: 'http'

package/dist/types/provider.d.ts

@@ -1,9 +1,16 @@
-import { HttpClient } from './lib/client';
-import { HttpClientOptions, HttpClientRequestInitType, IHttpClientConfigurator } from './configurator';
+import type { HttpClient } from './lib/client';
+import type { HttpClientOptions, HttpClientRequestInitType, IHttpClientConfigurator } from './configurator';
 import type { IHttpRequestHandler } from './lib/operators';
 import type { IHttpClient } from './lib/client';
+/**
+ * Exception thrown when a client cannot be found.
+ *
+ * This error is typically used to indicate that a requested client instance
+ * does not exist or cannot be located within the current context.
+ *
+ * @extends {Error}
+ */
 export declare class ClientNotFoundException extends Error {
-    constructor(message: string);
 }
 export interface IHttpClientProvider<TClient extends IHttpClient = IHttpClient> {
     /**

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "6.2.1";
+export declare const version = "6.2.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-http",
-  "version": "6.2.1",
+  "version": "6.2.2",
   "description": "",
   "main": "dist/esm/index.js",
   "types": "index.d.ts",
@@ -56,8 +56,8 @@
   "dependencies": {
     "rxjs": "^7.8.1",
     "zod": "^3.23.8",
-    "@equinor/fusion-framework-module": "^4.3.5",
-    "@equinor/fusion-framework-module-msal": "^4.0.0"
+    "@equinor/fusion-framework-module": "^4.3.6",
+    "@equinor/fusion-framework-module-msal": "^4.0.1"
   },
   "devDependencies": {
     "typescript": "^5.5.4",

package/src/configurator.ts

@@ -1,7 +1,7 @@
 import {
-    capitalizeRequestMethodOperator,
-    requestValidationOperator,
-    HttpRequestHandler,
+  capitalizeRequestMethodOperator,
+  requestValidationOperator,
+  HttpRequestHandler,
 } from './lib/operators';
 
 import type { FetchRequest, IHttpClient } from './lib/client';
@@ -14,7 +14,7 @@ import type { IHttpRequestHandler, IHttpResponseHandler } from './lib/operators'
  * @property {IHttpRequestHandler<TInit>} requestHandler - The request handler to be used by the `IHttpClient` instance.
  */
 interface HttpClientConstructorOptions<TInit extends FetchRequest> {
-    requestHandler: IHttpRequestHandler<TInit>;
+  requestHandler: IHttpRequestHandler<TInit>;
 }
 
 /**
@@ -26,10 +26,10 @@ interface HttpClientConstructorOptions<TInit extends FetchRequest> {
  * @returns A new instance of the `TClient` type.
  */
 interface HttpClientConstructor<TClient extends IHttpClient> {
-    new (
-        uri: string,
-        options: HttpClientConstructorOptions<HttpClientRequestInitType<TClient>>,
-    ): TClient;
+  new (
+    uri: string,
+    options: HttpClientConstructorOptions<HttpClientRequestInitType<TClient>>,
+  ): TClient;
 }
 
 /**
@@ -38,23 +38,23 @@ interface HttpClientConstructor<TClient extends IHttpClient> {
  * @template TClient - The type of the `IHttpClient` instance to be configured.
  */
 export interface HttpClientOptions<TClient extends IHttpClient = IHttpClient> {
-    /** The base URI for the `IHttpClient` instance. */
-    baseUri?: string;
+  /** The base URI for the `IHttpClient` instance. */
+  baseUri?: string;
 
-    /** The default scopes to be used by the `IHttpClient` instance. */
-    defaultScopes?: string[];
+  /** The default scopes to be used by the `IHttpClient` instance. */
+  defaultScopes?: string[];
 
-    /** The constructor for the `TClient` type. */
-    ctor?: HttpClientConstructor<TClient>;
+  /** The constructor for the `TClient` type. */
+  ctor?: HttpClientConstructor<TClient>;
 
-    /** A callback function that is called when a new `TClient` instance is created. */
-    onCreate?: (client: TClient) => void;
+  /** A callback function that is called when a new `TClient` instance is created. */
+  onCreate?: (client: TClient) => void;
 
-    /** The request handler to be used by the `IHttpClient` instance. */
-    requestHandler?: IHttpRequestHandler<HttpClientRequestInitType<TClient>>;
+  /** The request handler to be used by the `IHttpClient` instance. */
+  requestHandler?: IHttpRequestHandler<HttpClientRequestInitType<TClient>>;
 
-    /** The response handler to be used by the `IHttpClient` instance. */
-    responseHandler?: IHttpResponseHandler<HttpClientRequestInitType<TClient>>;
+  /** The response handler to be used by the `IHttpClient` instance. */
+  responseHandler?: IHttpResponseHandler<HttpClientRequestInitType<TClient>>;
 }
 
 /**
@@ -64,113 +64,112 @@ export interface HttpClientOptions<TClient extends IHttpClient = IHttpClient> {
  * @template T - The type of the `IHttpClient` implementation.
  * @returns The request init type for the `IHttpClient` implementation.
  */
-export type HttpClientRequestInitType<T extends IHttpClient> =
-    T extends IHttpClient<infer U> ? U : never;
+export type HttpClientRequestInitType<T extends IHttpClient> = T extends IHttpClient<infer U>
+  ? U
+  : never;
 
 /**
  * Instance for configuring http client
  * @template TClient base type of client that the provider will create
  */
 export interface IHttpClientConfigurator<TClient extends IHttpClient = IHttpClient> {
-    readonly clients: Record<string, HttpClientOptions<TClient>>;
-    readonly defaultHttpClientCtor: HttpClientConstructor<TClient>;
-    readonly defaultHttpRequestHandler: IHttpRequestHandler<HttpClientRequestInitType<TClient>>;
-
-    /**
-     * Configure a client with arguments
-     * @param name name of the client
-     * @param args option that are used cor creating a client
-     * @example
-     * ```ts
-     * configurator.http.configureClient('foo',{
-     *   baseUri: 'https://foo.bar',
-     *   defaultScopes: ['foobar/.default']
-     * });
-     * ```
-     */
-    configureClient<T extends TClient>(
-        name: string,
-        args: HttpClientOptions<T>,
-    ): IHttpClientConfigurator<TClient>;
-
-    /**
-     * Configure a simple client by name to an endpoint
-     * @param name name of the client
-     * @param uri base endpoint for the client
-     */
-    configureClient(name: string, uri: string): IHttpClientConfigurator<TClient>;
-
-    /**
-     * Creates a client with callback configuration
-     * @param name name of the client
-     * @param onCreate callback when a client is created
-     * ```ts
-     * configurator.http.configureClient('foo',(client) => {
-     *   client.requestHandler.add('logger', (request) => console.log(request));
-     * });
-     * ```
-     */
-    configureClient<T extends TClient>(
-        name: string,
-        onCreate: (client: T) => void,
-    ): HttpClientConfigurator<TClient>;
-
-    /**
-     * Check if there is a configuration for provided name
-     */
-    hasClient(name: string): boolean;
+  readonly clients: Record<string, HttpClientOptions<TClient>>;
+  readonly defaultHttpClientCtor: HttpClientConstructor<TClient>;
+  readonly defaultHttpRequestHandler: IHttpRequestHandler<HttpClientRequestInitType<TClient>>;
+
+  /**
+   * Configure a client with arguments
+   * @param name name of the client
+   * @param args option that are used cor creating a client
+   * @example
+   * ```ts
+   * configurator.http.configureClient('foo',{
+   *   baseUri: 'https://foo.bar',
+   *   defaultScopes: ['foobar/.default']
+   * });
+   * ```
+   */
+  configureClient<T extends TClient>(
+    name: string,
+    args: HttpClientOptions<T>,
+  ): IHttpClientConfigurator<TClient>;
+
+  /**
+   * Configure a simple client by name to an endpoint
+   * @param name name of the client
+   * @param uri base endpoint for the client
+   */
+  configureClient(name: string, uri: string): IHttpClientConfigurator<TClient>;
+
+  /**
+   * Creates a client with callback configuration
+   * @param name name of the client
+   * @param onCreate callback when a client is created
+   * ```ts
+   * configurator.http.configureClient('foo',(client) => {
+   *   client.requestHandler.add('logger', (request) => console.log(request));
+   * });
+   * ```
+   */
+  configureClient<T extends TClient>(
+    name: string,
+    onCreate: (client: T) => void,
+  ): HttpClientConfigurator<TClient>;
+
+  /**
+   * Check if there is a configuration for provided name
+   */
+  hasClient(name: string): boolean;
 }
 
 /** @inheritdoc */
 export class HttpClientConfigurator<TClient extends IHttpClient>
-    implements IHttpClientConfigurator<TClient>
+  implements IHttpClientConfigurator<TClient>
 {
-    protected _clients: Record<string, HttpClientOptions<TClient>> = {};
-
-    /** Get a clone of all configured clients */
-    public get clients(): Record<string, HttpClientOptions<TClient>> {
-        return { ...this._clients };
-    }
-
-    /** default class for creation of http clients */
-    readonly defaultHttpClientCtor: HttpClientConstructor<TClient>;
-
-    /** default request handler for http clients, applied on creation */
-    readonly defaultHttpRequestHandler = new HttpRequestHandler<HttpClientRequestInitType<TClient>>(
-        {
-            // convert all request methods to uppercase
-            ['capitalize-method']: capitalizeRequestMethodOperator(),
-            // validate the request object
-            ['request-validation']: requestValidationOperator(),
-        },
-    );
-
-    /**
-     * Create a instance of http configuration
-     * @param client defaultHttpRequestHandler
-     */
-    constructor(client: HttpClientConstructor<TClient>) {
-        this.defaultHttpClientCtor = client;
-    }
-
-    /** @inheritdoc */
-    hasClient(name: string): boolean {
-        return Object.keys(this._clients).includes(name);
-    }
-
-    /** @inheritdoc */
-    configureClient<T extends TClient>(
-        name: string,
-        args: string | HttpClientOptions<T> | HttpClientOptions<T>['onCreate'],
-    ): HttpClientConfigurator<TClient> {
-        const argFn = typeof args === 'string' ? ({ baseUri: args } as HttpClientOptions<T>) : args;
-        const options = typeof argFn === 'function' ? { onCreate: argFn } : argFn;
-        this._clients[name] = {
-            ...this._clients[name],
-            ...(options as unknown as HttpClientOptions<TClient>),
-        };
-        return this;
-    }
+  protected _clients: Record<string, HttpClientOptions<TClient>> = {};
+
+  /** Get a clone of all configured clients */
+  public get clients(): Record<string, HttpClientOptions<TClient>> {
+    return { ...this._clients };
+  }
+
+  /** default class for creation of http clients */
+  readonly defaultHttpClientCtor: HttpClientConstructor<TClient>;
+
+  /** default request handler for http clients, applied on creation */
+  readonly defaultHttpRequestHandler = new HttpRequestHandler<HttpClientRequestInitType<TClient>>({
+    // convert all request methods to uppercase
+    ['capitalize-method']: capitalizeRequestMethodOperator(),
+    // validate the request object
+    ['request-validation']: requestValidationOperator(),
+  });
+
+  /**
+   * Create a instance of http configuration
+   * @param client defaultHttpRequestHandler
+   */
+  constructor(client: HttpClientConstructor<TClient>) {
+    this.defaultHttpClientCtor = client;
+  }
+
+  /** @inheritdoc */
+  hasClient(name: string): boolean {
+    return Object.keys(this._clients).includes(name);
+  }
+
+  /** @inheritdoc */
+  configureClient<T extends TClient>(
+    name: string,
+    args: string | HttpClientOptions<T> | HttpClientOptions<T>['onCreate'],
+  ): HttpClientConfigurator<TClient> {
+    const argFn = typeof args === 'string' ? ({ baseUri: args } as HttpClientOptions<T>) : args;
+    const options = typeof argFn === 'function' ? { onCreate: argFn } : argFn;
+    this._clients[name] = {
+      ...this._clients[name],
+      ...(options as unknown as HttpClientOptions<TClient>),
+    };
+    return this;
+  }
 }
 
 export default HttpClientConfigurator;

package/src/errors.ts

@@ -3,14 +3,14 @@
  * @template TResponse The type of the HTTP response.
  */
 export class HttpResponseError<TResponse = Response> extends Error {
-    static Name = 'HttpResponseError';
-    constructor(
-        message: string,
-        public readonly response: TResponse,
-        options?: ErrorOptions,
-    ) {
-        super(message, options);
-    }
+  static Name = 'HttpResponseError';
+  constructor(
+    message: string,
+    public readonly response: TResponse,
+    options?: ErrorOptions,
+  ) {
+    super(message, options);
+  }
 }
 
 /**
@@ -21,22 +21,22 @@ export class HttpResponseError<TResponse = Response> extends Error {
  * @template TResponse - The type of the HTTP response.
  */
 export class HttpJsonResponseError<
-    TType = unknown,
-    TResponse = Response,
+  TType = unknown,
+  TResponse = Response,
 > extends HttpResponseError<TResponse> {
-    static Name = 'HttpJsonResponseError';
-    public readonly data?: TType;
+  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;
-    }
+  /**
+   * 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;
+  }
 }

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

@@ -17,9 +17,9 @@ type MsalFetchRequest = FetchRequest & { scopes?: string[] };
  * @template TResponse - The type of the response object. Defaults to `Response`.
  */
 type MsalFetchRequestInit<
-    TReturn = unknown,
-    TRequest = FetchRequest,
-    TResponse = FetchResponse,
+  TReturn = unknown,
+  TRequest = FetchRequest,
+  TResponse = FetchResponse,
 > = FetchRequestInit<TReturn, TRequest, TResponse> & Pick<MsalFetchRequest, 'scopes'>;
 
 /**
@@ -37,42 +37,42 @@ type MsalFetchRequestInit<
  * @template TResponse - The type of the response object. Defaults to `FetchResponse`.
  */
 export class HttpClientMsal<
-    TRequest extends MsalFetchRequest = MsalFetchRequest,
-    TResponse extends FetchResponse = FetchResponse,
+  TRequest extends MsalFetchRequest = MsalFetchRequest,
+  TResponse extends FetchResponse = FetchResponse,
 > extends HttpClient<TRequest, TResponse> {
-    /**
-     * 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.
-     */
-    public defaultScopes: string[] = [];
+  /**
+   * 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.
+   */
+  public defaultScopes: string[] = [];
 
+  /**
+   * 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.
+   */
+  public fetch$<T = TResponse>(
+    path: string,
+    init?: MsalFetchRequestInit<T, TRequest, TResponse>,
+  ): Observable<T> {
     /**
-     * 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.
+     * 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.
      */
-    public fetch$<T = TResponse>(
-        path: string,
-        init?: MsalFetchRequestInit<T, TRequest, TResponse>,
-    ): Observable<T> {
-        /**
-         * 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?.scopes || []),
-        }) as FetchRequestInit<T, TRequest, TResponse>;
+    const args = Object.assign(init || {}, {
+      scopes: this.defaultScopes.concat(init?.scopes || []),
+    }) as FetchRequestInit<T, TRequest, TResponse>;
 
-        return super._fetch$(path, args);
-    }
+    return super._fetch$(path, args);
+  }
 }
 
 export default HttpClientMsal;