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

package/CHANGELOG.md

@@ -1,5 +1,167 @@
 # Change Log
 
+## 6.0.1
+
+### Patch Changes
+
+-   [#2324](https://github.com/equinor/fusion-framework/pull/2324) [`788d0b9`](https://github.com/equinor/fusion-framework/commit/788d0b93edc25e5b682d88c58614560c204c1af9) Thanks [@odinr](https://github.com/odinr)! - Updated documentation in `README.md` for http module.
+
+    -   added introduction to http module
+    -   added concepts section which highlights the key concepts of http module
+    -   added sequence diagram for http request execution
+    -   added examples for http module
+    -   improved documentation for configuring http module
+    -   improved documentation for working with http clients
+    -   improved the formatting of the documentation
+
+-   [#2333](https://github.com/equinor/fusion-framework/pull/2333) [`86d55b8`](https://github.com/equinor/fusion-framework/commit/86d55b8d27a572f3f62170b1e72aceda54f955e1) Thanks [@odinr](https://github.com/odinr)! - Updated `TypeScript` to 5.5.3
+
+-   [#2324](https://github.com/equinor/fusion-framework/pull/2324) [`788d0b9`](https://github.com/equinor/fusion-framework/commit/788d0b93edc25e5b682d88c58614560c204c1af9) Thanks [@odinr](https://github.com/odinr)! - Updated TsDoc for http module
+
+-   [#2324](https://github.com/equinor/fusion-framework/pull/2324) [`788d0b9`](https://github.com/equinor/fusion-framework/commit/788d0b93edc25e5b682d88c58614560c204c1af9) Thanks [@odinr](https://github.com/odinr)! - - Added a new type `ResponseSelector<TResult, TResponse>`: a function that takes a `Response` object and returns an observable stream of type `TResult`. The `ResponseSelector` type has two template parameters: `TResult` and `TResponse`.
+
+    -   Updated the `FetchRequestInit` type to include a new property `selector` of type `ResponseSelector<TReturn, TResponse>`, which allows specifying a response selector function.
+    -   Updated the blob-selector and json-selector functions to use the new `ResponseSelector` type.
+
+-   [#2320](https://github.com/equinor/fusion-framework/pull/2320) [`1dd85f3`](https://github.com/equinor/fusion-framework/commit/1dd85f3a408a73df556d1812a5f280945cc100ee) Thanks [@odinr](https://github.com/odinr)! - Removed the `removeComments` option from the `tsconfig.base.json` file.
+
+    Removing the `removeComments` option allows TypeScript to preserve comments in the compiled JavaScript output. This can be beneficial for several reasons:
+
+    1. Improved debugging: Preserved comments can help developers understand the code better during debugging sessions.
+    2. Documentation: JSDoc comments and other important code documentation will be retained in the compiled output.
+    3. Source map accuracy: Keeping comments can lead to more accurate source maps, which is crucial for debugging and error tracking.
+
+    No action is required from consumers of the library. This change affects the build process and doesn't introduce any breaking changes or new features.
+
+    Before:
+
+    ```json
+    {
+        "compilerOptions": {
+            "module": "ES2022",
+            "target": "ES6",
+            "incremental": true,
+            "removeComments": true,
+            "preserveConstEnums": true,
+            "sourceMap": true,
+            "moduleResolution": "node"
+        }
+    }
+    ```
+
+    After:
+
+    ```json
+    {
+        "compilerOptions": {
+            "module": "ES2022",
+            "target": "ES6",
+            "incremental": true,
+            "preserveConstEnums": true,
+            "sourceMap": true,
+            "moduleResolution": "node"
+        }
+    }
+    ```
+
+    This change ensures that comments are preserved in the compiled output, potentially improving the development and debugging experience for users of the Fusion Framework.
+
+-   Updated dependencies [[`2f74edc`](https://github.com/equinor/fusion-framework/commit/2f74edcd4a3ea2b87d69f0fd63492145c3c01663), [`86d55b8`](https://github.com/equinor/fusion-framework/commit/86d55b8d27a572f3f62170b1e72aceda54f955e1), [`1dd85f3`](https://github.com/equinor/fusion-framework/commit/1dd85f3a408a73df556d1812a5f280945cc100ee)]:
+    -   @equinor/fusion-framework-module@4.3.2
+    -   @equinor/fusion-framework-module-msal@3.1.2
+
+## 6.0.0
+
+### Major Changes
+
+-   [#2181](https://github.com/equinor/fusion-framework/pull/2181) [`ba2379b`](https://github.com/equinor/fusion-framework/commit/ba2379b177f23ccc023894e36e50d7fc56c929c8) Thanks [@odinr](https://github.com/odinr)! - The `blob` and `blob# Change Log methods in the `HttpClient` class have been updated to provide a more robust and flexible API for fetching blob resources.
+
+    1. The `blob` and `blob# Change Log methods now accept an optional `args`parameter of type`FetchRequestInit<T, TRequest, TResponse>`, where `T` is the type of the expected blob result. This allows consumers to customize the fetch request and response handling.
+    2. The `blob` and `blob# Change Log methods now return a `Promise<T>`and`StreamResponse<T>`respectively, where`T` is the type of the expected blob result. This allows consumers to handle the blob data in a more type-safe manner.
+    3. The `blobSelector` function has been updated to extract the filename (if available) from the `content-disposition` header and return it along with the blob data in a `BlobResult` object.
+    4. If you were previously using the `blob` or `blob# Change Log methods and expecting a `Blob`result, you must now use the new`BlobResult` type, which includes the filename (if available) and the blob data.
+
+    > [!WARNING]
+    > This alters the return type of the `blob` and `blob# Change Log methods, which is a **breaking change**.
+
+    Example:
+
+    ```typescript
+    const blobResult = await httpClient.blob('/path/to/blob');
+    console.log(blobResult.filename); // 'example.pdf'
+    console.log(blobResult.blob); // Blob instance
+    ```
+
+    1. If you were providing a custom selector function to the `blob` or `blob# Change Log methods, you can now use the new `BlobResult` type in your selector function.
+
+    Example:
+
+    ```typescript
+    const customBlobSelector = async (
+        response: Response,
+    ): Promise<{ filename: string; blob: Blob }> => {
+        // Extract filename and blob from the response
+        const { filename, blob } = await blobSelector(response);
+        return { filename, blob };
+    };
+
+    const blobResult = await httpClient.blob('/path/to/blob', { selector: customBlobSelector });
+    console.log(blobResult.filename); // 'example.pdf'
+    console.log(blobResult.blob); // Blob instance
+    ```
+
+    3. If you were using the `blob# Change Log method and expecting a `StreamResponse<Blob>`, you can now use the new `StreamResponse<T>`type, where`T` is the type of the expected blob result.
+
+    Example:
+
+    ```typescript
+    const blobStream = httpClient.blob$('/path/to/blob');
+    blobStream.subscribe((blobResult) => {
+        console.log(blobResult.filename); // 'example.pdf'
+        console.log(blobResult.blob); // Blob instance
+    });
+    ```
+
+### Patch Changes
+
+-   [#2196](https://github.com/equinor/fusion-framework/pull/2196) [`1e60919`](https://github.com/equinor/fusion-framework/commit/1e60919e83fb65528c88f604d7bd43299ec412e1) Thanks [@odinr](https://github.com/odinr)! - The `jsonSelector` function was not checking the error type in the `catch` block.
+    This lead to not throwing the error with parsed data, but always throwing a parser error, where the correct error was `cause` in the `ErrorOptions`
+
+    **BREAKING CHANGE:**
+
+    If for some reason developers has catched the error and assumed the `cause` property would give the proper error data, this will no longer be the case.
+
+    ```ts
+    try {
+        await jsonSelector(response);
+    } catch (error) {
+        if (error instanceof HttpJsonResponseError) {
+            const { data, cause } = error;
+            if (data) {
+                console.error('the request was not `ok`, see provided error data', data);
+            } else {
+                console.error('failed to parse data from response, see provided cause', cause);
+            }
+        }
+    }
+    ```
+
+    ```diff
+    try {
+      await jsonSelector(response);
+    } catch (error) {
+      if(error instanceof HttpJsonResponseError) {
+    -    const data = error.cause instanceof HttpJsonResponseError ? err.cause.data : null;
+    +    const data = error instanceof HttpJsonResponseError ? error.data : null;
+        if(data) {
+          console.error('the request was not `ok`, see provided error data', data);
+        } else {
+          console.error('failed to parse data from response, see provided cause', error.cause);
+        }
+      }
+    }
+    ```
+
 ## 5.2.3
 
 ### Patch Changes