@equinor/fusion-framework-module-widget 16.0.6 → 16.0.8

package/src/state/create-state.ts

@@ -1,33 +0,0 @@
-import { FlowSubject } from '@equinor/fusion-observable';
-
-import { createReducer } from './create-reducer';
-
-import { handleFetchManifest, handleImportWidget, handleFetchConfig } from './flows';
-
-import type { Actions } from './actions';
-import type { WidgetState, WidgetStateInitial } from '../types';
-import type WidgetModuleProvider from '../WidgetModuleProvider';
-
-/**
- * Creates and wires the RxJS-based `FlowSubject` state machine for a single
- * widget.
- *
- * Attaches the manifest-fetch, script-import, and config-fetch flows to the
- * subject so that dispatched actions trigger the corresponding side effects.
- *
- * @param value - Initial widget state (name and optional pre-loaded data).
- * @param provider - The {@link WidgetModuleProvider} used by flows to query
- *   the backend API.
- * @returns A `FlowSubject` managing {@link WidgetState} via {@link Actions}.
- */
-export const createState = (
-  value: WidgetStateInitial,
-  provider: WidgetModuleProvider,
-): FlowSubject<WidgetState, Actions> => {
-  const reducer = createReducer(value);
-  const state = new FlowSubject<WidgetState, Actions>(reducer);
-  state.addFlow(handleFetchManifest(provider));
-  state.addFlow(handleImportWidget());
-  state.addFlow(handleFetchConfig(provider));
-  return state;
-};

package/src/state/flows.ts

@@ -1,123 +0,0 @@
-import { from, of, concat } from 'rxjs';
-import { catchError, filter, last, map, share, switchMap } from 'rxjs/operators';
-
-import { actions } from './actions';
-
-import type { Flow } from '@equinor/fusion-observable';
-
-import type { Actions } from './actions';
-import type { WidgetState } from '../types';
-import type WidgetModuleProvider from '../WidgetModuleProvider';
-
-/**
- * RxJS flow that reacts to `fetchManifest` actions by querying the
- * {@link WidgetModuleProvider} for the manifest, emitting intermediate
- * `setManifest` actions, and completing with a success or failure action.
- *
- * @param provider - The widget module provider used for API queries.
- * @returns A `Flow` function for the widget state machine.
- */
-export const handleFetchManifest =
-  (provider: WidgetModuleProvider): Flow<Actions, WidgetState> =>
-  (action$) =>
-    // React only to `fetchManifest` actions
-    action$.pipe(
-      filter(actions.fetchManifest.match),
-      switchMap((action) => {
-        const {
-          payload: { key, args },
-          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
-              // 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));
-              }),
-            )
-        );
-      }),
-    );
-
-/**
- * RxJS flow that reacts to `fetchConfig` actions by querying the
- * {@link WidgetModuleProvider} for the widget config, emitting intermediate
- * `setConfig` actions, and completing with a success or failure action.
- *
- * @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
-              // 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));
-              }),
-            )
-        );
-      }),
-    );
-
-/**
- * RxJS flow that reacts to `importWidget` actions by dynamically importing
- * the widget’s JavaScript entry point URL and emitting success or failure.
- *
- * @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

@@ -1,203 +0,0 @@
-import type { AnyModule, CombinedModules, ModulesInstance } from '@equinor/fusion-framework-module';
-import type { EventModule } from '@equinor/fusion-framework-module-event';
-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';
-
-// biome-ignore lint/suspicious/noExplicitAny: `Fusion` is a placeholder widening type for the framework instance shape used across widget script modules
-type Fusion = any;
-
-/**
- * Environment descriptor passed to widget render functions.
- *
- * @template TProps - Custom props type forwarded to the widget.
- */
-export type WidgetEnv<TProps = unknown> = {
-  /** Base URL path the widget should use for routing (if applicable). */
-  basename?: string;
-  /** The resolved widget manifest. */
-  manifest?: WidgetManifest;
-  /** Arbitrary props forwarded from the host application. */
-  props?: TProps;
-};
-
-/**
- * HTTP client abstraction used by the widget module to fetch manifests
- * and configurations from the backend API.
- */
-export type IClient = {
-  /** API version string appended as a query parameter to widget endpoints. */
-  apiVersion: string;
-  /** Base URL used to construct full import URLs for widget scripts. */
-  baseImportUrl: string;
-  /** Query constructor options for fetching a {@link WidgetManifest}. */
-  getWidgetManifest: QueryCtorOptions<WidgetManifest, GetWidgetParameters>;
-  /** Query constructor options for fetching a {@link WidgetConfig}. */
-  getWidgetConfig: QueryCtorOptions<WidgetConfig, GetWidgetParameters>;
-};
-
-/**
- * Peer-dependency module tuple required by the widget module.
- *
- * Includes {@link HttpModule}, {@link ServiceDiscoveryModule}, and
- * {@link EventModule} (the latter two are optional at runtime).
- */
-export type ModuleDeps = [HttpModule, ServiceDiscoveryModule, EventModule];
-
-/**
- * Parameters for fetching a widget manifest or configuration.
- */
-export type GetWidgetParameters = {
-  /** Unique key (name) identifying the widget. */
-  widgetKey: string;
-  /** Optional version or tag selector for the widget. */
-  args?: { type: 'version' | 'tag'; value: string };
-};
-
-/**
- * Function that builds a widget API endpoint URL from {@link GetWidgetParameters}.
- */
-export type WidgetEndpointBuilder = (args: GetWidgetParameters) => string;
-
-/**
- * Metadata manifest describing a widget’s identity, version, and entry point.
- *
- * Fetched from the backend API during widget initialization.
- */
-export type WidgetManifest = {
-  /** Unique backend identifier for the widget. */
-  id: string;
-  /** Human-readable widget name (also used as lookup key). */
-  name: string;
-  /** Semantic version of the widget. */
-  version: string;
-  /** Brief description of the widget’s purpose. */
-  description: string;
-  /** Optional list of maintainer identifiers. */
-  maintainers?: string[];
-  /** Relative path to the JavaScript entry point (e.g., `index.js`). */
-  entryPoint: string;
-  /** Base path for widget assets (combined with `entryPoint` to build the import URL). */
-  assetPath: string;
-};
-
-/**
- * Describes a named endpoint with a URI and optional OAuth scopes.
- */
-export type Endpoint = {
-  /** Endpoint name. */
-  name: string;
-  /** Endpoint URI. */
-  uri: string;
-  /** Optional OAuth scopes required for the endpoint. */
-  scopes?: string[];
-};
-
-/**
- * Runtime configuration for a widget, including environment variables and
- * backend endpoint mappings.
- *
- * @template TEnvironment - Custom environment shape.
- */
-export type WidgetConfig<TEnvironment = unknown> = {
-  /** Widget-specific environment variables. */
-  environment: TEnvironment;
-  /** Map of endpoint names to URIs or structured {@link Endpoint} objects. */
-  endpoints: Record<string, string | Endpoint>;
-};
-
-/**
- * Combined module set available inside a widget, merging custom modules with
- * the standard {@link EventModule} and {@link ServiceDiscoveryModule}.
- *
- * @template TModules - Additional modules to combine.
- */
-export type WidgetModules<TModules extends Array<AnyModule> | unknown = unknown> = CombinedModules<
-  TModules,
-  [EventModule, ServiceDiscoveryModule]
->;
-
-/**
- * Generic property bag passed from the host application to a widget render
- * function.
- */
-export type WidgetProps = Record<PropertyKey, unknown>;
-
-/**
- * Arguments passed to a widget’s render functions (`renderWidget`, `render`,
- * `renderIcon`, and the default export).
- *
- * @template TFusion - Fusion instance type.
- * @template TEnv - Environment descriptor type.
- * @template TProps - Custom props type.
- */
-
-export type WidgetRenderArgs<
-  TFusion extends Fusion = Fusion,
-  TEnv = WidgetEnv,
-  TProps extends WidgetProps = WidgetProps,
-> = {
-  fusion: TFusion;
-  env: TEnv;
-  props?: TProps;
-};
-
-/**
- * Describes the interface a widget script module must export.
- *
- * A dynamically imported widget entry point is expected to expose render
- * functions that mount the widget into a given DOM element and return a
- * cleanup function.
- *
- * @template TProps - Custom props type.
- */
-export type WidgetScriptModule<TProps extends WidgetProps = WidgetProps> = {
-  /** Default render function (fallback entry point). */
-  default: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
-  /** Primary render function for the widget body. */
-  renderWidget: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
-  /** Render function for the widget’s icon representation. */
-  renderIcon: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
-  /** Generic render function. */
-  render: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
-};
-
-/**
- * Resolved module instances available inside a running widget.
- *
- * @template TModules - Additional custom modules.
- */
-export type WidgetModulesInstance<TModules extends Array<AnyModule> | unknown = unknown> =
-  ModulesInstance<WidgetModules<TModules>>;
-
-/**
- * Internal state managed by a {@link Widget}’s `FlowSubject` state machine.
- *
- * Tracks manifest, config, imported script, framework module instances, and
- * a set of in-flight status markers.
- *
- * @template TModules - Custom module types.
- */
-// 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;
-  /** Set of in-flight action base types (e.g., `'fetch_manifest'`). */
-  status: Set<string>;
-  /** Resolved widget configuration (when loaded). */
-  config?: WidgetConfig;
-  /** Resolved widget manifest (when loaded). */
-  manifest?: WidgetManifest;
-  /** Imported widget script module (when loaded). */
-  modules?: WidgetScriptModule;
-  /** Framework module instances created for the widget. */
-  instance?: WidgetModulesInstance<TModules>;
-};
-
-/**
- * Initial widget state shape passed to the `Widget` constructor.
- *
- * Same as {@link WidgetState} but without the `status` set, which is
- * initialized internally by the reducer.
- */
-export type WidgetStateInitial = Omit<WidgetState, 'status'>;

package/src/utils.ts

@@ -1,85 +0,0 @@
-import type { GetWidgetParameters, IClient, WidgetEndpointBuilder } from './types';
-import type { IHttpClient } from '@equinor/fusion-framework-module-http';
-
-/**
- * Creates a {@link WidgetEndpointBuilder} that produces manifest endpoint URLs.
- *
- * Routes versioned or tagged lookups to `/widgets/{key}/versions/{value}` and
- * unversioned lookups to `/widgets/{key}`.
- *
- * @param apiVersion - API version string appended as a query parameter.
- * @returns A function that maps {@link GetWidgetParameters} to a URL path.
- */
-export const defaultManifestEndpointBuilder =
-  (apiVersion: string): WidgetEndpointBuilder =>
-  (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':
-        return `/widgets/${widgetKey}/versions/${value}?api-version=${apiVersion}`;
-      default:
-        return `/widgets/${widgetKey}?api-version=${apiVersion}`;
-    }
-  };
-
-/**
- * Creates a {@link WidgetEndpointBuilder} that produces config endpoint URLs.
- *
- * Routes versioned or tagged lookups to `/widgets/{key}/versions/{value}/config`
- * and unversioned lookups to `/widgets/{key}/config`.
- *
- * @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(#5099): Align endpoints with backend when its done!
-    switch (type) {
-      case 'tag':
-      case 'version':
-        return `/widgets/${widgetKey}/versions/${value}/config?api-version=${apiVersion}`;
-      default:
-        return `/widgets/${widgetKey}/config?api-version=${apiVersion}`;
-    }
-  };
-
-/**
- * Creates the default {@link IClient} that uses the given HTTP client to
- * fetch widget manifests and configurations.
- *
- * Uses `api-version=1.0-preview` and the default manifest/config endpoint
- * builders.
- *
- * @param httpClient - An `IHttpClient` instance (typically resolved from the
- *   `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 {
-    apiVersion,
-    baseImportUrl: httpClient.uri,
-    getWidgetManifest: {
-      client: {
-        fn: (args) => httpClient.json$(defaultManifestEndpointBuilder(apiVersion)(args)),
-      },
-      key: (args) => JSON.stringify(args),
-    },
-    getWidgetConfig: {
-      client: {
-        fn: (args) => httpClient.json$(defaultConfigEndpointBuilder(apiVersion)(args)),
-      },
-      key: (args) => JSON.stringify(args),
-    },
-  };
-};

package/src/version.ts

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

package/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist/esm",
-    "rootDir": "src",
-    "declarationDir": "./dist/types",
-    "removeComments": false
-  },
-  "references": [
-    {
-      "path": "../../utils/query"
-    },
-    {
-      "path": "../module"
-    },
-    {
-      "path": "../event"
-    },
-    {
-      "path": "../service-discovery"
-    }
-  ],
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "lib"]
-}