@equinor/fusion-framework-module-widget 16.0.2 → 16.0.3

package/src/state/flows.ts

@@ -20,6 +20,7 @@ import type WidgetModuleProvider from '../WidgetModuleProvider';
 export const handleFetchManifest =
   (provider: WidgetModuleProvider): Flow<Actions, WidgetState> =>
   (action$) =>
+    // React only to `fetchManifest` actions
     action$.pipe(
       filter(actions.fetchManifest.match),
       switchMap((action) => {
@@ -28,21 +29,30 @@ export const handleFetchManifest =
           meta: { update },
         } = action;
 
+        // Query the provider for the manifest, dropping falsy emissions, and share it
         const subject = from(provider.getWidgetManifest(key, args)).pipe(
           filter((x) => !!x),
           share(),
         );
-        return concat(
-          subject.pipe(map((manifest) => actions.setManifest(manifest, update))),
-          subject.pipe(
-            last(),
-            map((manifest) => actions.fetchManifest.success(manifest)),
-          ),
-        ).pipe(
-          catchError((err) => {
-            console.error(err, action.payload);
-            return of(actions.fetchManifest.failure(err));
-          }),
+        return (
+          concat(
+            subject
+              // Emit an intermediate `setManifest` for every value the query produces
+              .pipe(map((manifest) => actions.setManifest(manifest, update))),
+            subject
+              // Wait for the final emission and report it as the successful result
+              .pipe(
+                last(),
+                map((manifest) => actions.fetchManifest.success(manifest)),
+              ),
+          )
+            // Convert any error from the query/emission chain into a failure action
+            .pipe(
+              catchError((err) => {
+                console.error(err, action.payload);
+                return of(actions.fetchManifest.failure(err));
+              }),
+            )
         );
       }),
     );
@@ -55,26 +65,38 @@ export const handleFetchManifest =
  * @param provider - The widget module provider used for API queries.
  * @returns A `Flow` function for the widget state machine.
  */
+// Deliberately co-located with `handleFetchManifest` above
+// fusion-lint-disable-next-line single-export-per-file
 export const handleFetchConfig =
   (provider: WidgetModuleProvider): Flow<Actions, WidgetState> =>
   (action$) =>
+    // React only to `fetchConfig` actions
     action$.pipe(
       filter(actions.fetchConfig.match),
       switchMap(({ payload: { key, args } }) => {
+        // Query the provider for the config, dropping falsy emissions, and share it
         const subject = from(provider.getWidgetConfig(key, args)).pipe(
           filter((x) => !!x),
           share(),
         );
-        return concat(
-          subject.pipe(map((manifest) => actions.setConfig(manifest))),
-          subject.pipe(
-            last(),
-            map((manifest) => actions.fetchConfig.success(manifest)),
-          ),
-        ).pipe(
-          catchError((err) => {
-            return of(actions.fetchConfig.failure(err));
-          }),
+        return (
+          concat(
+            subject
+              // Emit an intermediate `setConfig` for every value the query produces
+              .pipe(map((manifest) => actions.setConfig(manifest))),
+            subject
+              // Wait for the final emission and report it as the successful result
+              .pipe(
+                last(),
+                map((manifest) => actions.fetchConfig.success(manifest)),
+              ),
+          )
+            // Convert any error from the query/emission chain into a failure action
+            .pipe(
+              catchError((err) => {
+                return of(actions.fetchConfig.failure(err));
+              }),
+            )
         );
       }),
     );
@@ -85,10 +107,14 @@ export const handleFetchConfig =
  *
  * @returns A `Flow` function for the widget state machine.
  */
+// Deliberately co-located with the other flow handlers above
+// fusion-lint-disable-next-line single-export-per-file
 export const handleImportWidget = (): Flow<Actions, WidgetState> => (action$) =>
+  // React only to `importWidget` actions
   action$.pipe(
     filter(actions.importWidget.match),
     switchMap(({ payload }) => {
+      // Dynamically import the widget's script entry point and report success/failure
       return from(import(/* @vite-ignore */ payload)).pipe(
         map(actions.importWidget.success),
         catchError((err) => of(actions.importWidget.failure(err))),

package/src/types.ts

@@ -4,7 +4,7 @@ import type { HttpModule } from '@equinor/fusion-framework-module-http';
 import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
 import type { QueryCtorOptions } from '@equinor/fusion-query';
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+// biome-ignore lint/suspicious/noExplicitAny: `Fusion` is a placeholder widening type for the framework instance shape used across widget script modules
 type Fusion = any;
 
 /**
@@ -178,7 +178,7 @@ export type WidgetModulesInstance<TModules extends Array<AnyModule> | unknown =
  *
  * @template TModules - Custom module types.
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+// biome-ignore lint/suspicious/noExplicitAny: default must be bivariant `any`, not `unknown` — `unknown` breaks assignability when a concrete `WidgetState<TModules>` is used where the default-typed generic is expected
 export type WidgetState<TModules = any> = {
   /** Widget name (lookup key). */
   name: string;

package/src/utils.ts

@@ -15,6 +15,7 @@ export const defaultManifestEndpointBuilder =
   (params: GetWidgetParameters) => {
     const { widgetKey, args } = params;
     const { type, value } = args ?? {};
+    // Route versioned/tagged lookups differently from the unversioned default
     switch (type) {
       case 'tag':
       case 'version':
@@ -33,12 +34,14 @@ export const defaultManifestEndpointBuilder =
  * @param apiVersion - API version string appended as a query parameter.
  * @returns A function that maps {@link GetWidgetParameters} to a URL path.
  */
+// Deliberately co-located with `defaultManifestEndpointBuilder` above
+// fusion-lint-disable-next-line single-export-per-file
 export const defaultConfigEndpointBuilder =
   (apiVersion: string): WidgetEndpointBuilder =>
   (params: GetWidgetParameters) => {
     const { widgetKey, args } = params;
     const { type, value } = args ?? {};
-    // Todo Align endpoints with backend when its done!
+    // TODO(#5099): Align endpoints with backend when its done!
     switch (type) {
       case 'tag':
       case 'version':
@@ -59,6 +62,8 @@ export const defaultConfigEndpointBuilder =
  *   `apps` service-discovery key).
  * @returns A fully configured `IClient`.
  */
+// Deliberately co-located with the endpoint builders it composes
+// fusion-lint-disable-next-line single-export-per-file
 export const createDefaultClient = (httpClient: IHttpClient): IClient => {
   const apiVersion = '1.0-preview';
   return {

package/src/version.ts

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

package/dist/esm/errors.js

@@ -1,93 +0,0 @@
-/**
- * Error thrown when a widget manifest cannot be loaded from the backend API.
- *
- * Use the static {@link fromHttpResponse} factory to create instances from
- * HTTP responses with appropriate type mapping.
- */
-export class WidgetManifestLoadError extends Error {
-    type;
-    /**
-     * Creates a `WidgetManifestLoadError` from an HTTP `Response`.
-     *
-     * Maps HTTP 401 to `'unauthorized'`, 404 to `'not_found'`, and all other
-     * status codes to `'unknown'`.
-     *
-     * @param response - The failing HTTP response.
-     * @param options - Standard `ErrorOptions` (e.g., `cause`).
-     * @returns A typed `WidgetManifestLoadError`.
-     */
-    static fromHttpResponse(response, options) {
-        switch (response.status) {
-            case 401:
-                return new WidgetManifestLoadError('unauthorized', 'failed to load widget manifest, request not authorized', options);
-            case 404:
-                return new WidgetManifestLoadError('not_found', 'widget manifest not found', options);
-        }
-        return new WidgetManifestLoadError('unknown', `failed to load widget manifest, status code ${response.status}`, options);
-    }
-    /**
-     * @param type - Error category discriminator.
-     * @param message - Human-readable error description.
-     * @param options - Standard `ErrorOptions` (e.g., `cause`).
-     */
-    constructor(type, message, options) {
-        super(message, options);
-        this.type = type;
-        this.name = 'GetWidgetLoadManifestErrors';
-    }
-}
-/**
- * Error thrown when a widget configuration cannot be loaded from the backend API.
- *
- * Use the static {@link fromHttpResponse} factory to create instances from
- * HTTP responses with appropriate type mapping.
- */
-export class WidgetConfigLoadError extends Error {
-    type;
-    /**
-     * Creates a `WidgetConfigLoadError` from an HTTP `Response`.
-     *
-     * Maps HTTP 401 to `'unauthorized'`, 404 to `'not_found'`, and all other
-     * status codes to `'unknown'`.
-     *
-     * @param response - The failing HTTP response.
-     * @param options - Standard `ErrorOptions` (e.g., `cause`).
-     * @returns A typed `WidgetConfigLoadError`.
-     */
-    static fromHttpResponse(response, options) {
-        switch (response.status) {
-            case 401:
-                return new WidgetConfigLoadError('unauthorized', 'failed to load widget config, request not authorized', options);
-            case 404:
-                return new WidgetConfigLoadError('not_found', 'widget config not found', options);
-        }
-        return new WidgetConfigLoadError('unknown', `failed to load widget config, status code ${response.status}`, options);
-    }
-    /**
-     * @param type - Error category discriminator.
-     * @param message - Human-readable error description.
-     * @param options - Standard `ErrorOptions` (e.g., `cause`).
-     */
-    constructor(type, message, options) {
-        super(message, options);
-        this.type = type;
-        this.name = 'GetWidgetLoadConfigError';
-    }
-}
-/**
- * Error thrown when a widget script module cannot be dynamically imported.
- */
-export class WidgetScriptModuleError extends Error {
-    type;
-    /**
-     * @param type - Error category discriminator.
-     * @param message - Human-readable error description.
-     * @param options - Standard `ErrorOptions` (e.g., `cause`).
-     */
-    constructor(type, message, options) {
-        super(message, options);
-        this.type = type;
-        this.name = 'WidgetScriptModuleError';
-    }
-}
-//# sourceMappingURL=errors.js.map

package/dist/esm/errors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AASA;;;;;GAKG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAkC9B;IAjClB;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CAAC,QAAkB,EAAE,OAAsB;QAChE,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,GAAG;gBACN,OAAO,IAAI,uBAAuB,CAChC,cAAc,EACd,wDAAwD,EACxD,OAAO,CACR,CAAC;YACJ,KAAK,GAAG;gBACN,OAAO,IAAI,uBAAuB,CAAC,WAAW,EAAE,2BAA2B,EAAE,OAAO,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO,IAAI,uBAAuB,CAChC,SAAS,EACT,+CAA+C,QAAQ,CAAC,MAAM,EAAE,EAChE,OAAO,CACR,CAAC;IACJ,CAAC;IACD;;;;OAIG;IACH,YACkB,IAAqB,EACrC,OAAgB,EAChB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAJR,SAAI,GAAJ,IAAI,CAAiB;QAKrC,IAAI,CAAC,IAAI,GAAG,6BAA6B,CAAC;IAC5C,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAkC5B;IAjClB;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CAAC,QAAkB,EAAE,OAAsB;QAChE,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,GAAG;gBACN,OAAO,IAAI,qBAAqB,CAC9B,cAAc,EACd,sDAAsD,EACtD,OAAO,CACR,CAAC;YACJ,KAAK,GAAG;gBACN,OAAO,IAAI,qBAAqB,CAAC,WAAW,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;QACtF,CAAC;QACD,OAAO,IAAI,qBAAqB,CAC9B,SAAS,EACT,6CAA6C,QAAQ,CAAC,MAAM,EAAE,EAC9D,OAAO,CACR,CAAC;IACJ,CAAC;IACD;;;;OAIG;IACH,YACkB,IAAqB,EACrC,OAAgB,EAChB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAJR,SAAI,GAAJ,IAAI,CAAiB;QAKrC,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;IACzC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAO9B;IANlB;;;;OAIG;IACH,YACkB,IAAqB,EACrC,OAAgB,EAChB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAJR,SAAI,GAAJ,IAAI,CAAiB;QAKrC,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;IACxC,CAAC;CACF"}

package/dist/types/errors.d.ts

@@ -1,73 +0,0 @@
-/**
- * Discriminator for categorizing widget HTTP errors.
- *
- * - `'not_found'` — HTTP 404
- * - `'unauthorized'` — HTTP 401
- * - `'unknown'` — any other error
- */
-type WidgetErrorType = 'not_found' | 'unauthorized' | 'unknown';
-/**
- * Error thrown when a widget manifest cannot be loaded from the backend API.
- *
- * Use the static {@link fromHttpResponse} factory to create instances from
- * HTTP responses with appropriate type mapping.
- */
-export declare class WidgetManifestLoadError extends Error {
-    readonly type: WidgetErrorType;
-    /**
-     * Creates a `WidgetManifestLoadError` from an HTTP `Response`.
-     *
-     * Maps HTTP 401 to `'unauthorized'`, 404 to `'not_found'`, and all other
-     * status codes to `'unknown'`.
-     *
-     * @param response - The failing HTTP response.
-     * @param options - Standard `ErrorOptions` (e.g., `cause`).
-     * @returns A typed `WidgetManifestLoadError`.
-     */
-    static fromHttpResponse(response: Response, options?: ErrorOptions): WidgetManifestLoadError;
-    /**
-     * @param type - Error category discriminator.
-     * @param message - Human-readable error description.
-     * @param options - Standard `ErrorOptions` (e.g., `cause`).
-     */
-    constructor(type: WidgetErrorType, message?: string, options?: ErrorOptions);
-}
-/**
- * Error thrown when a widget configuration cannot be loaded from the backend API.
- *
- * Use the static {@link fromHttpResponse} factory to create instances from
- * HTTP responses with appropriate type mapping.
- */
-export declare class WidgetConfigLoadError extends Error {
-    readonly type: WidgetErrorType;
-    /**
-     * Creates a `WidgetConfigLoadError` from an HTTP `Response`.
-     *
-     * Maps HTTP 401 to `'unauthorized'`, 404 to `'not_found'`, and all other
-     * status codes to `'unknown'`.
-     *
-     * @param response - The failing HTTP response.
-     * @param options - Standard `ErrorOptions` (e.g., `cause`).
-     * @returns A typed `WidgetConfigLoadError`.
-     */
-    static fromHttpResponse(response: Response, options?: ErrorOptions): WidgetConfigLoadError;
-    /**
-     * @param type - Error category discriminator.
-     * @param message - Human-readable error description.
-     * @param options - Standard `ErrorOptions` (e.g., `cause`).
-     */
-    constructor(type: WidgetErrorType, message?: string, options?: ErrorOptions);
-}
-/**
- * Error thrown when a widget script module cannot be dynamically imported.
- */
-export declare class WidgetScriptModuleError extends Error {
-    readonly type: WidgetErrorType;
-    /**
-     * @param type - Error category discriminator.
-     * @param message - Human-readable error description.
-     * @param options - Standard `ErrorOptions` (e.g., `cause`).
-     */
-    constructor(type: WidgetErrorType, message?: string, options?: ErrorOptions);
-}
-export {};

package/src/errors.ts

@@ -1,125 +0,0 @@
-/**
- * Discriminator for categorizing widget HTTP errors.
- *
- * - `'not_found'` — HTTP 404
- * - `'unauthorized'` — HTTP 401
- * - `'unknown'` — any other error
- */
-type WidgetErrorType = 'not_found' | 'unauthorized' | 'unknown';
-
-/**
- * Error thrown when a widget manifest cannot be loaded from the backend API.
- *
- * Use the static {@link fromHttpResponse} factory to create instances from
- * HTTP responses with appropriate type mapping.
- */
-export class WidgetManifestLoadError extends Error {
-  /**
-   * Creates a `WidgetManifestLoadError` from an HTTP `Response`.
-   *
-   * Maps HTTP 401 to `'unauthorized'`, 404 to `'not_found'`, and all other
-   * status codes to `'unknown'`.
-   *
-   * @param response - The failing HTTP response.
-   * @param options - Standard `ErrorOptions` (e.g., `cause`).
-   * @returns A typed `WidgetManifestLoadError`.
-   */
-  static fromHttpResponse(response: Response, options?: ErrorOptions) {
-    switch (response.status) {
-      case 401:
-        return new WidgetManifestLoadError(
-          'unauthorized',
-          'failed to load widget manifest, request not authorized',
-          options,
-        );
-      case 404:
-        return new WidgetManifestLoadError('not_found', 'widget manifest not found', options);
-    }
-    return new WidgetManifestLoadError(
-      'unknown',
-      `failed to load widget manifest, status code ${response.status}`,
-      options,
-    );
-  }
-  /**
-   * @param type - Error category discriminator.
-   * @param message - Human-readable error description.
-   * @param options - Standard `ErrorOptions` (e.g., `cause`).
-   */
-  constructor(
-    public readonly type: WidgetErrorType,
-    message?: string,
-    options?: ErrorOptions,
-  ) {
-    super(message, options);
-    this.name = 'GetWidgetLoadManifestErrors';
-  }
-}
-
-/**
- * Error thrown when a widget configuration cannot be loaded from the backend API.
- *
- * Use the static {@link fromHttpResponse} factory to create instances from
- * HTTP responses with appropriate type mapping.
- */
-export class WidgetConfigLoadError extends Error {
-  /**
-   * Creates a `WidgetConfigLoadError` from an HTTP `Response`.
-   *
-   * Maps HTTP 401 to `'unauthorized'`, 404 to `'not_found'`, and all other
-   * status codes to `'unknown'`.
-   *
-   * @param response - The failing HTTP response.
-   * @param options - Standard `ErrorOptions` (e.g., `cause`).
-   * @returns A typed `WidgetConfigLoadError`.
-   */
-  static fromHttpResponse(response: Response, options?: ErrorOptions) {
-    switch (response.status) {
-      case 401:
-        return new WidgetConfigLoadError(
-          'unauthorized',
-          'failed to load widget config, request not authorized',
-          options,
-        );
-      case 404:
-        return new WidgetConfigLoadError('not_found', 'widget config not found', options);
-    }
-    return new WidgetConfigLoadError(
-      'unknown',
-      `failed to load widget config, status code ${response.status}`,
-      options,
-    );
-  }
-  /**
-   * @param type - Error category discriminator.
-   * @param message - Human-readable error description.
-   * @param options - Standard `ErrorOptions` (e.g., `cause`).
-   */
-  constructor(
-    public readonly type: WidgetErrorType,
-    message?: string,
-    options?: ErrorOptions,
-  ) {
-    super(message, options);
-    this.name = 'GetWidgetLoadConfigError';
-  }
-}
-
-/**
- * Error thrown when a widget script module cannot be dynamically imported.
- */
-export class WidgetScriptModuleError extends Error {
-  /**
-   * @param type - Error category discriminator.
-   * @param message - Human-readable error description.
-   * @param options - Standard `ErrorOptions` (e.g., `cause`).
-   */
-  constructor(
-    public readonly type: WidgetErrorType,
-    message?: string,
-    options?: ErrorOptions,
-  ) {
-    super(message, options);
-    this.name = 'WidgetScriptModuleError';
-  }
-}