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

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

@@ -1,7 +1,7 @@
 import { Subject } from 'rxjs';
 import type { Observable, ObservableInput } from 'rxjs';
 import type { IHttpRequestHandler, IHttpResponseHandler } from '../operators';
-import type { FetchRequest, FetchRequestInit, FetchResponse, IHttpClient, JsonRequest, StreamResponse } from '.';
+import type { BlobResult, FetchRequest, FetchRequestInit, FetchResponse, IHttpClient, JsonRequest, StreamResponse } from './types';
 export type HttpClientCreateOptions<TRequest extends FetchRequest = FetchRequest, TResponse = Response> = {
     requestHandler: IHttpRequestHandler<TRequest>;
     responseHandler: IHttpResponseHandler<TResponse>;
@@ -22,8 +22,8 @@ export declare class HttpClient<TRequest extends FetchRequest = FetchRequest, TR
     fetchAsync<T = TResponse>(path: string, args?: FetchRequestInit<T, TRequest, TResponse>): Promise<T>;
     json$<T = unknown>(path: string, args?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>): StreamResponse<T>;
     json<T = unknown>(path: string, args?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>): Promise<T>;
-    blob$(path: string, args?: FetchRequestInit<Blob, TRequest, TResponse>): StreamResponse<Blob>;
-    blob(path: string, args?: FetchRequestInit<Blob, TRequest, TResponse>): Promise<Blob>;
+    blob$<T = BlobResult>(path: string, args?: FetchRequestInit<T, TRequest, TResponse>): StreamResponse<T>;
+    blob<T = BlobResult>(path: string, args?: FetchRequestInit<T, TRequest, TResponse>): Promise<T>;
     jsonAsync<T = unknown>(path: string, args?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>): Promise<T>;
     execute<T = TResponse, TMethod extends 'fetch' | 'fetch$' | 'json' | 'json$' = 'fetch'>(method: TMethod, path: string, init?: FetchRequestInit<T, TRequest, TResponse>): ReturnType<IHttpClient[TMethod]>;
     abort(): void;

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

@@ -8,6 +8,10 @@ export type FetchRequest = RequestInit & {
 export type JsonRequest<TRequest extends FetchRequest = FetchRequest> = Omit<TRequest, 'body'> & {
     body?: object | string | null;
 };
+export type BlobResult = {
+    filename?: string;
+    blob: Blob;
+};
 export type FetchResponse<T = unknown> = Response & {
     json(): Promise<T>;
 };
@@ -30,7 +34,7 @@ export interface IHttpClient<TRequest extends FetchRequest = FetchRequest, TResp
     json$<T = unknown>(path: string, init?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>): StreamResponse<T>;
     json<T = unknown>(path: string, init?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>): Promise<T>;
     jsonAsync<T = unknown>(path: string, args?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>): Promise<T>;
-    blob(path: string, args?: FetchRequestInit<Blob, JsonRequest<TRequest>, TResponse>): Promise<Blob>;
-    blob$(path: string, args?: FetchRequestInit<Blob, JsonRequest<TRequest>, TResponse>): StreamResponse<Blob>;
+    blob<T = BlobResult>(path: string, args?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>): Promise<T>;
+    blob$<T = BlobResult>(path: string, args?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>): StreamResponse<T>;
     abort(): void;
 }

package/dist/types/lib/selectors/blob-selector.d.ts

@@ -1,2 +1,3 @@
-export declare const blobSelector: <TResponse extends Response = Response>(response: TResponse) => Promise<Blob>;
+import { type BlobResult } from '../client/types';
+export declare const blobSelector: <TResponse extends Response = Response>(response: TResponse) => Promise<BlobResult>;
 export default blobSelector;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.2.3";
+export declare const version = "6.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-http",
-  "version": "5.2.3",
+  "version": "6.0.0",
   "description": "",
   "main": "dist/esm/index.js",
   "types": "index.d.ts",

package/src/lib/client/client.ts

@@ -8,13 +8,14 @@ import { blobSelector, jsonSelector } from '../selectors';
 import type { Observable, ObservableInput } from 'rxjs';
 import type { IHttpRequestHandler, IHttpResponseHandler } from '../operators';
 import type {
+    BlobResult,
     FetchRequest,
     FetchRequestInit,
     FetchResponse,
     IHttpClient,
     JsonRequest,
     StreamResponse,
-} from '.';
+} from './types';
 import { HttpResponseError } from '../../errors';
 
 export type HttpClientCreateOptions<
@@ -111,18 +112,41 @@ export class HttpClient<
         return firstValueFrom(this.json$<T>(path, args));
     }
 
-    public blob$(
+    /**
+     * 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.
+     */
+    public blob$<T = BlobResult>(
         path: string,
-        args?: FetchRequestInit<Blob, TRequest, TResponse>,
-    ): StreamResponse<Blob> {
+        args?: FetchRequestInit<T, TRequest, TResponse>,
+    ): StreamResponse<T> {
+        // Get the selector value from the provided args, or use the default blobSelector
         const selector = args?.selector ?? blobSelector;
-        return this.fetch$(path, {
+
+        // Create the FetchRequestInit object with the provided args and the selector
+        const init = {
             ...args,
             selector,
-        } as FetchRequestInit<Blob, TRequest, TResponse>);
+        } as FetchRequestInit<T, TRequest, TResponse>;
+
+        // Call the fetch$ method with the provided path and the constructed init object
+        return this.fetch$(path, init);
     }
 
-    public blob(path: string, args?: FetchRequestInit<Blob, TRequest, TResponse>): Promise<Blob> {
+    /**
+     * 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.
+     */
+    public blob<T = BlobResult>(
+        path: string,
+        args?: FetchRequestInit<T, TRequest, TResponse>,
+    ): Promise<T> {
         return firstValueFrom(this.blob$(path, args));
     }
 

package/src/lib/client/types.ts

@@ -12,6 +12,13 @@ export type JsonRequest<TRequest extends FetchRequest = FetchRequest> = Omit<TRe
     body?: object | string | null;
 };
 
+/**
+ * Represents the result of a blob operation, including the filename (if available) and the blob itself.
+ * @property {string} [filename] - The filename of the blob, if available.
+ * @property {Blob} blob - The blob data.
+ */
+export type BlobResult = { filename?: string; blob: Blob };
+
 export type FetchResponse<T = unknown> = Response & {
     json(): Promise<T>;
 };
@@ -149,15 +156,29 @@ export interface IHttpClient<TRequest extends FetchRequest = FetchRequest, TResp
         args?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>,
     ): Promise<T>;
 
-    blob(
+    /**
+     * Fetches a blob resource from the specified path.
+     *
+     * @param path - The path to the blob resource.
+     * @param args - Optional arguments for the fetch request, including the request body, headers, and response type.
+     * @returns A Promise that resolves to the fetched blob data.
+     */
+    blob<T = BlobResult>(
         path: string,
-        args?: FetchRequestInit<Blob, JsonRequest<TRequest>, TResponse>,
-    ): Promise<Blob>;
+        args?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>,
+    ): Promise<T>;
 
-    blob$(
+    /**
+     * Fetches a blob from the specified path and returns a stream response.
+     *
+     * @param path - The path to fetch the blob from.
+     * @param args - Optional arguments for the fetch request, including the request body, headers, and response type.
+     * @returns A stream response containing the fetched blob.
+     */
+    blob$<T = BlobResult>(
         path: string,
-        args?: FetchRequestInit<Blob, JsonRequest<TRequest>, TResponse>,
-    ): StreamResponse<Blob>;
+        args?: FetchRequestInit<T, JsonRequest<TRequest>, TResponse>,
+    ): StreamResponse<T>;
 
     /**
      * Abort all ongoing request for current client

package/src/lib/selectors/blob-selector.ts

@@ -1,17 +1,39 @@
-export const blobSelector = <TResponse extends Response = Response>(
+import { type BlobResult } from '../client/types';
+
+/**
+ * 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 = async <TResponse extends Response = Response>(
     response: TResponse,
-): Promise<Blob> => {
+): Promise<BlobResult> => {
     if (!response.ok) {
+        // Throw an error if the network response is not successful
         throw new Error('network response was not OK');
     }
-    //Status code 204 is no content
+
+    // 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 = response.headers
+        .get('content-disposition')
+        ?.split(';')
+        .find((n) => n.includes('filename='))
+        ?.replace('filename=', '')
+        ?.trim();
+
     try {
-        return response.blob();
+        // Convert the response to a Blob and return the filename and Blob
+        const blob = await response.blob();
+        return { filename, blob };
     } catch (err) {
+        // Throw an error if there's a problem parsing the response
         throw Error('failed to parse response');
     }
 };

package/src/lib/selectors/json-selector.ts

@@ -1,30 +1,46 @@
 import { HttpJsonResponseError } from '../../errors';
 
 /**
- * Converts the JSON response from an HTTP request into the specified type.
- * If the response is not OK or if there is an error parsing the response, an error is thrown.
- * If the response has a status code of 204 (No Content), a resolved Promise is returned.
+ * Asynchronously parses the JSON data from a given HTTP response.
  *
- * @param response The HTTP response object.
- * @returns A Promise that resolves to the parsed JSON data.
- * @throws {Error} If the network response is not OK.
- * @throws {HttpJsonResponseError} If there is an error parsing the response.
+ * If the response has a status code of 204 (No Content), this function will resolve with `undefined`.
+ *
+ * If the response is not successful (i.e. `response.ok` is `false`), this function will throw an `HttpJsonResponseError` with the response details and the parsed data (if any).
+ *
+ * If there is an error parsing the JSON data, this function will throw an `HttpJsonResponseError` with the parsing error and the original response.
+ *
+ * @template TType - The expected type of the parsed JSON data.
+ * @template TResponse - The type of the HTTP response object.
+ * @param response - The HTTP response to parse.
+ * @returns A promise that resolves with the parsed JSON data, or rejects with an `HttpJsonResponseError`.
  */
 export const jsonSelector = async <TType = unknown, TResponse extends Response = Response>(
     response: TResponse,
 ): Promise<TType> => {
-    /** Status code 204 is no content */
+    /** Status code 204 indicates no content in the response */
     if (response.status === 204) {
         return Promise.resolve() as Promise<TType>;
     }
 
     try {
+        // Parse the response JSON data
         const data = await response.json();
+
+        // Check if the response was successful
         if (!response.ok) {
+            // Throw an error with the response details
             throw new HttpJsonResponseError('network response was not OK', response, { data });
         }
+
+        // Return the parsed data
         return data;
     } catch (cause) {
+        // If the cause is an HttpJsonResponseError, rethrow it
+        if (cause instanceof HttpJsonResponseError) {
+            throw cause;
+        }
+
+        // Otherwise, throw a new HttpJsonResponseError with the parsing error
         throw new HttpJsonResponseError('failed to parse response', response, { cause });
     }
 };

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '5.2.3';
+export const version = '6.0.0';