@equinor/fusion-framework-module-app 8.1.0 → 8.1.2

package/src/app/actions.ts

@@ -1,112 +0,0 @@
-import {
-  type ActionInstanceMap,
-  type ActionTypes,
-  createAction,
-  createAsyncAction,
-} from '@equinor/fusion-observable';
-import type {
-  AppConfig,
-  AppManifest,
-  AppModulesInstance,
-  AppScriptModule,
-  AppSettings,
-} from '../types';
-
-/**
- * Factory function that creates all action creators used by the {@link App}
- * state machine.
- *
- * Actions are grouped by domain:
- * - **Manifest** – `setManifest`, `fetchManifest` (async)
- * - **Config** – `setConfig`, `fetchConfig` (async)
- * - **Settings** – `setSettings`, `fetchSettings` (async), `updateSettings` (async)
- * - **Script module** – `setModule`, `importApp` (async)
- * - **Instance** – `setInstance`
- * - **Lifecycle** – `initialize` (async)
- */
-const createActions = () => ({
-  /** Manifest loading */
-  setManifest: createAction('set_manifest', (manifest: AppManifest, update?: boolean) => ({
-    payload: manifest,
-    meta: {
-      // TODO(#5129) when updating
-      created: Date.now(),
-      update,
-    },
-  })),
-
-  fetchManifest: createAsyncAction(
-    'fetch_manifest',
-    (key: string, tag?: string, update?: boolean) => ({ payload: { key, tag }, meta: { update } }),
-    (manifest: AppManifest) => ({ payload: manifest }),
-    (error: unknown) => ({ payload: error }),
-  ),
-  /** Config loading */
-  setConfig: createAction('set_config', (config: AppConfig) => ({ payload: config })),
-  fetchConfig: createAsyncAction(
-    'fetch_config',
-    (manifest: AppManifest) => ({ payload: manifest }),
-    (config: AppConfig) => ({ payload: config }),
-    (error: unknown) => ({ payload: error }),
-  ),
-  /** Settings loading */
-  setSettings: createAction('set_settings', (settings?: AppSettings) => ({
-    payload: settings,
-  })),
-  /** Fetching settings */
-  fetchSettings: createAsyncAction(
-    'fetch_settings',
-    (appKey: string) => ({ payload: { appKey } }),
-    (settings: AppSettings) => ({ payload: settings }),
-    (error: unknown) => ({ payload: error }),
-  ),
-  /** Updating settings */
-  updateSettings: createAsyncAction(
-    'update_settings',
-    (appKey: string, settings: AppSettings) => ({
-      payload: { appKey, settings },
-    }),
-    (settings: AppSettings) => ({
-      payload: settings,
-    }),
-    (error: unknown) => ({
-      payload: error,
-    }),
-  ),
-  updateSettingsAbort: createAction('update_settings::abort', (id: string) => ({
-    payload: id,
-  })),
-  /** App loading */
-  // biome-ignore lint/suspicious/noExplicitAny: module payload widens to accept any script module shape when set
-  setModule: createAction('set_module', (module: any) => ({ payload: module })),
-  importApp: createAsyncAction(
-    'import_app',
-    (entrypoint: string) => ({ payload: entrypoint }),
-    (module: AppScriptModule) => ({ payload: module }),
-    (error: unknown) => ({ payload: error }),
-  ),
-
-  // App Instance
-  setInstance: createAction('set_instance', (instance: AppModulesInstance) => ({
-    payload: instance,
-  })),
-
-  initialize: createAsyncAction(
-    'initialize_app',
-    () => ({ payload: null }),
-    () => ({ payload: null }),
-    (error: unknown) => ({ payload: error }),
-  ),
-});
-
-/** Singleton action creator map used by the app state machine. */
-export const actions = createActions();
-
-/** Record mapping action names to their creator functions. */
-export type ActionBuilder = ReturnType<typeof createActions>;
-
-/** Map of action names to their instantiated action shapes. */
-export type ActionMap = ActionInstanceMap<ActionBuilder>;
-
-/** Union of all action types dispatched by the app state machine. */
-export type Actions = ActionTypes<typeof actions>;

package/src/app/create-reducer.ts

@@ -1,62 +0,0 @@
-import {
-  getBaseType,
-  createReducer as makeReducer,
-  isCompleteAction,
-  isRequestAction,
-} from '@equinor/fusion-observable';
-
-import { enableMapSet } from 'immer';
-
-enableMapSet();
-
-import { type Actions, actions } from './actions';
-
-import type { AppBundleState, AppBundleStateInitial } from './types';
-
-/**
- * Creates the Immer-powered reducer for the {@link App} state machine.
- *
- * Handles synchronous state updates (set manifest, config, settings, module, instance)
- * and tracks in-progress async operations via a `status` set.
- *
- * @param value - Initial state values (appKey, tag, and any pre-loaded data).
- * @returns A reducer function compatible with {@link FlowSubject}.
- */
-export const createReducer = (value: AppBundleStateInitial) =>
-  makeReducer<AppBundleState, Actions>(
-    { ...value, status: new Set() } as AppBundleState,
-    (builder) =>
-      builder
-        // update or set manifest
-        .addCase(actions.setManifest, (state, action) => {
-          // TODO(#5131): after legacy is removed, remove the update flag
-          if (action.meta.update) {
-            // Merge onto the existing manifest so partial updates don't clobber other fields.
-            state.manifest = Object.assign(state.manifest ?? {}, action.payload);
-          } else {
-            state.manifest = action.payload;
-          }
-        })
-        .addCase(actions.setConfig, (state, action) => {
-          state.config = action.payload;
-        })
-        .addCase(actions.setSettings, (state, action) => {
-          state.settings = action.payload;
-        })
-        .addCase(actions.setModule, (state, action) => {
-          state.modules = action.payload;
-        })
-        .addCase(actions.setInstance, (state, action) => {
-          state.instance = action.payload;
-        })
-        // add status which indicates that a request is in progress
-        .addMatcher(isRequestAction, (state, action) => {
-          state.status.add(getBaseType(action.type));
-        })
-        // remove status when a request is complete
-        .addMatcher(isCompleteAction, (state, action) => {
-          state.status.delete(getBaseType(action.type));
-        }),
-  );
-
-export default createReducer;

package/src/app/create-state.ts

@@ -1,52 +0,0 @@
-import { FlowSubject } from '@equinor/fusion-observable';
-
-import { createReducer } from './create-reducer';
-
-import {
-  handleFetchManifest,
-  handleFetchConfig,
-  handleFetchSettings,
-  handleUpdateSettings,
-  handleImportApplication,
-} from './flows';
-
-import type { Actions } from './actions';
-import type { AppBundleState, AppBundleStateInitial } from './types';
-import type { AppModuleProvider } from '../AppModuleProvider';
-
-/**
- * Creates and configures the reactive state machine ({@link FlowSubject}) for
- * an {@link App} instance.
- *
- * Registers flows for fetching manifests, configs, settings, and importing
- * the application script module.
- *
- * @param value - Initial state values (appKey, tag, and any pre-loaded data).
- * @param provider - The {@link AppModuleProvider} used by flows to fetch data.
- * @returns A configured `FlowSubject` ready for use by the App class.
- */
-export const createState = (
-  value: AppBundleStateInitial,
-  provider: AppModuleProvider,
-): FlowSubject<AppBundleState, Actions> => {
-  const reducer = createReducer(value);
-
-  // create state
-  const state = new FlowSubject<AppBundleState, Actions>(reducer);
-
-  // add handler for fetching manifest
-  state.addFlow(handleFetchManifest(provider));
-
-  // add handler for fetching config
-  state.addFlow(handleFetchConfig(provider));
-
-  // add handler for fetching settings
-  state.addFlow(handleFetchSettings(provider));
-
-  state.addFlow(handleUpdateSettings(provider));
-
-  // add handler for loading application script
-  state.addFlow(handleImportApplication(provider));
-
-  return state;
-};

package/src/app/events.ts

@@ -1,108 +0,0 @@
-import type { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
-
-import type { App } from './App';
-
-import type {
-  AppConfig,
-  AppManifest,
-  AppModulesInstance,
-  AppScriptModule,
-  AppSettings,
-} from '../types';
-
-/**
- * Base event initialization type for application lifecycle events.
- *
- * Extends {@link FrameworkEventInit} with a mandatory `appKey` field and
- * the {@link App} as the event source.
- *
- * @template TDetail - Additional detail properties carried by the event.
- */
-export type AppEventEventInit<TDetail extends Record<string, unknown> | unknown = unknown> =
-  FrameworkEventInit<
-    /** additional event details and key of target event */
-    TDetail & { appKey: string },
-    /** source of the event */
-    App
-  >;
-
-/**
- * Framework event carrying application-scoped detail and an {@link App} source.
- *
- * @template TDetail - Additional detail properties carried by the event.
- */
-export type AppEvent<TDetail extends Record<string, unknown> | unknown = unknown> = FrameworkEvent<
-  AppEventEventInit<TDetail>
->;
-
-/**
- * Framework event emitted when an application lifecycle operation fails.
- * The `error` detail carries the underlying failure.
- */
-export type AppEventFailure = FrameworkEvent<
-  AppEventEventInit<{
-    error: AppConfig;
-  }>
->;
-
-declare module '@equinor/fusion-framework-module-event' {
-  interface FrameworkEventMap {
-    /** fired when the application has initiated its modules */
-    onAppModulesLoaded: AppEvent<{
-      /** initiated modules for application */
-      appKey: string;
-      manifest: AppManifest;
-      modules: AppModulesInstance;
-    }>;
-
-    onAppManifestLoad: AppEvent;
-    /** fired when the application has loaded corresponding manifest */
-    onAppManifestLoaded: AppEvent<{
-      manifest: AppManifest;
-    }>;
-    onAppManifestFailure: AppEventFailure;
-
-    onAppConfigLoad: AppEvent;
-    /** fired when the application has loaded corresponding config */
-    onAppConfigLoaded: AppEvent<{
-      config: AppConfig;
-    }>;
-    onAppConfigFailure: AppEventFailure;
-
-    onAppSettingsLoad: AppEvent;
-    /** fired when the application has loaded corresponding settings */
-    onAppSettingsLoaded: AppEvent<{
-      settings: AppSettings;
-    }>;
-    onAppSettingsFailure: AppEventFailure;
-
-    onAppSettingsUpdate: AppEvent;
-    onAppSettingsUpdated: AppEvent<{
-      settings: AppSettings;
-    }>;
-    onAppSettingsUpdateFailure: AppEventFailure;
-
-    /** fired when the application has loaded corresponding javascript module */
-    onAppScriptLoad: AppEvent;
-    onAppScriptLoaded: AppEvent<{
-      script: AppScriptModule;
-    }>;
-    onAppScriptFailure: AppEventFailure;
-
-    /** fired before application loads manifest, config and script */
-    onAppInitialize: AppEvent;
-
-    /**
-     * fired after application has loaded manifest, config and script
-     *
-     * __note:__ not fired until all loaders has settled (last emit)
-     */
-    onAppInitialized: AppEvent;
-
-    /** fired when application fails to load either manifest, config and script */
-    onAppInitializeFailure: AppEventFailure;
-
-    /** fired when the application is disposed (unmounts) */
-    onAppDispose: FrameworkEvent<AppEventEventInit>;
-  }
-}

package/src/app/filter-empty.ts

@@ -1,11 +0,0 @@
-import { filter, type OperatorFunction } from 'rxjs';
-
-/**
- * RxJS operator that filters out `null` and `undefined` emissions.
- *
- * @template T - The non-nullable value type.
- * @returns An operator that only passes through non-nullable values.
- */
-export function filterEmpty<T>(): OperatorFunction<T | null | undefined, T> {
-  return filter((value): value is T => value !== undefined && value !== null);
-}

package/src/app/flows/handle-fetch-config.ts

@@ -1,48 +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 { AppModuleProvider } from '../../AppModuleProvider';
-import type { Actions } from '../actions';
-import type { AppBundleState } from '../types';
-
-/**
- * Handles the fetch config action by fetching the app configuration from the provider,
- * filtering out null values, and dispatching success or failure actions accordingly.
- *
- * @param provider The AppModuleProvider used to fetch the app configuration.
- * @returns A Flow function that takes an Observable of actions and returns an Observable of actions.
- */
-export const handleFetchConfig =
-  (provider: AppModuleProvider): Flow<Actions, AppBundleState> =>
-  (action$) =>
-    // only handle fetch config request actions
-    action$.pipe(
-      filter(actions.fetchConfig.match),
-      // when request is received, abort any ongoing request and start new
-      switchMap(({ payload }) => {
-        // TODO(#5127) - use the configUrl directly from the manifest
-        // fetch config from provider
-        const subject = from(provider.getAppConfig(payload.appKey, payload.build?.version)).pipe(
-          // filter out null values
-          filter((x) => !!x),
-          // allow multiple subscriptions
-          share(),
-        );
-        // first load config and then dispatch success action
-        return concat(
-          subject.pipe(map((config) => actions.setConfig(config))),
-          subject.pipe(
-            last(),
-            map((config) => actions.fetchConfig.success(config)),
-          ),
-        ).pipe(
-          // catch any error and dispatch failure action
-          catchError((err) => {
-            return of(actions.fetchConfig.failure(err));
-          }),
-        );
-      }),
-    );

package/src/app/flows/handle-fetch-manifest.ts

@@ -1,53 +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 { AppModuleProvider } from '../../AppModuleProvider';
-import type { Actions } from '../actions';
-import type { AppBundleState } from '../types';
-
-/**
- * Handles the fetch manifest action by fetching the app manifest from the provider,
- * dispatching success or failure actions based on the result.
- *
- * @param provider The AppModuleProvider used to fetch the app manifest.
- * @returns A Flow function that takes an Observable of actions and returns an Observable of actions.
- */
-export const handleFetchManifest =
-  (provider: AppModuleProvider): Flow<Actions, AppBundleState> =>
-  (action$) =>
-    // only handle fetch manifest request actions
-    action$.pipe(
-      filter(actions.fetchManifest.match),
-      // when request is received, abort any ongoing request and start new
-      switchMap((action) => {
-        const {
-          payload: { key, tag },
-          meta: { update },
-        } = action;
-
-        // fetch manifest from provider
-        const subject = from(provider.getAppManifest(key, tag)).pipe(
-          // filter out null values
-          filter((x) => !!x),
-          // allow multiple subscriptions
-          share(),
-        );
-
-        // first load manifest and then dispatch success action
-        return concat(
-          subject.pipe(map((manifest) => actions.setManifest(manifest, update))),
-          subject.pipe(
-            last(),
-            map((manifest) => actions.fetchManifest.success(manifest)),
-          ),
-        ).pipe(
-          // catch any error and dispatch failure action
-          catchError((err) => {
-            return of(actions.fetchManifest.failure(err));
-          }),
-        );
-      }),
-    );

package/src/app/flows/handle-fetch-settings.ts

@@ -1,50 +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 { AppModuleProvider } from '../../AppModuleProvider';
-import type { Actions } from '../actions';
-import type { AppBundleState } from '../types';
-
-/**
- * Handles the fetch settings action by fetching the app settings from the provider,
- * filtering out null values, and dispatching success or failure actions accordingly.
- *
- * @param provider The AppModuleProvider used to fetch the app settings.
- * @returns A Flow function that takes an Observable of actions and returns an Observable of actions.
- */
-export const handleFetchSettings =
-  (provider: AppModuleProvider): Flow<Actions, AppBundleState> =>
-  (action$) =>
-    // only handle fetch settings request actions
-    action$.pipe(
-      filter(actions.fetchSettings.match),
-      // when request is received, abort any ongoing request and start new
-      switchMap(({ payload }) => {
-        const { appKey } = payload;
-
-        // fetch settings from provider
-        const subject = from(provider.getAppSettings(appKey)).pipe(
-          // filter out null values
-          filter((x) => !!x),
-          // allow multiple subscriptions
-          share(),
-        );
-
-        // first load settings and then dispatch success action
-        return concat(
-          subject.pipe(map((settings) => actions.setSettings(settings))),
-          subject.pipe(
-            last(),
-            map((settings) => actions.fetchSettings.success(settings)),
-          ),
-        ).pipe(
-          // catch any error and dispatch failure action
-          catchError((err) => {
-            return of(actions.fetchSettings.failure(err));
-          }),
-        );
-      }),
-    );

package/src/app/flows/handle-import-application.ts

@@ -1,37 +0,0 @@
-import { from, of } from 'rxjs';
-import { catchError, filter, map, switchMap } from 'rxjs/operators';
-
-import { actions } from '../actions';
-
-import type { Flow } from '@equinor/fusion-observable';
-import type { AppModuleProvider } from '../../AppModuleProvider';
-import type { Actions } from '../actions';
-import type { AppBundleState } from '../types';
-
-/**
- * Handles the import application flow.
- * @param provider The AppModuleProvider used to resolve the application asset URI.
- * @returns A flow that takes in actions and returns an observable of AppBundleState.
- */
-export const handleImportApplication =
-  (provider: AppModuleProvider): Flow<Actions, AppBundleState> =>
-  (action$) =>
-    // only handle import script request actions
-    action$.pipe(
-      filter(actions.importApp.match),
-      // when request is received, abort any ongoing request and start new
-      switchMap(({ payload }) => {
-        // dynamically import the application script
-        return from(
-          import(
-            /* @vite-ignore */ /* webpackIgnore: true */
-            [provider.assetUri, payload].join('/').replace(/\/{2,}/g, '/')
-          ),
-        ).pipe(
-          // dispatch success action
-          map(actions.importApp.success),
-          // catch any error and dispatch failure action
-          catchError((err) => of(actions.importApp.failure(err))),
-        );
-      }),
-    );

package/src/app/flows/handle-update-settings.ts

@@ -1,39 +0,0 @@
-import { from, of } from 'rxjs';
-import { catchError, concatMap, filter, last, switchMap } from 'rxjs/operators';
-
-import { actions } from '../actions';
-
-import type { Flow } from '@equinor/fusion-observable';
-import type { AppModuleProvider } from '../../AppModuleProvider';
-import type { Actions } from '../actions';
-import type { AppBundleState } from '../types';
-
-/**
- * Handles the set settings action by setting the app settings from the provider,
- * filtering out null values, and dispatching success or failure actions accordingly.
- *
- * @param provider The AppModuleProvider used to fetch the app settings.
- * @returns A Flow function that takes an Observable of actions and returns an Observable of actions.
- */
-export const handleUpdateSettings =
-  (provider: AppModuleProvider): Flow<Actions, AppBundleState> =>
-  (action$) => {
-    // only handle update settings request actions
-    return action$.pipe(
-      filter(actions.updateSettings.match),
-      switchMap(({ payload }) => {
-        const { appKey, settings } = payload;
-        // take the last value, then request updating of settings and dispatch success or failure
-        return provider.updateAppSettings(appKey, settings).pipe(
-          last(),
-          concatMap((updatedSettings) =>
-            from([
-              actions.setSettings(updatedSettings),
-              actions.updateSettings.success(updatedSettings),
-            ]),
-          ),
-          catchError((err) => of(actions.updateSettings.failure(err))),
-        );
-      }),
-    );
-  };

package/src/app/flows/index.ts

@@ -1,5 +0,0 @@
-export { handleFetchManifest } from './handle-fetch-manifest';
-export { handleFetchConfig } from './handle-fetch-config';
-export { handleFetchSettings } from './handle-fetch-settings';
-export { handleUpdateSettings } from './handle-update-settings';
-export { handleImportApplication } from './handle-import-application';

package/src/app/index.ts

@@ -1,10 +0,0 @@
-/**
- * Re-exports for the app sub-module.
- *
- * - {@link App} – Concrete application class managing reactive state.
- * - {@link IApp} – Public interface for an application instance.
- * - {@link AppInitializeResult} – Shape emitted by `App.initialize()`.
- */
-export { App, IApp, type AppInitializeResult } from './App';
-
-export { default } from './App';

package/src/app/types.ts

@@ -1,51 +0,0 @@
-import type { ActionBaseType } from '@equinor/fusion-observable';
-import type {
-  AppManifest,
-  AppConfig,
-  AppModulesInstance,
-  AppScriptModule,
-  ConfigEnvironment,
-  AppSettings,
-} from '../types';
-import type { Actions } from './actions';
-
-/**
- * Represents the state of an application bundle.
- *
- * @template TConfig - The type of the configuration environment, defaults to `ConfigEnvironment`.
- * @template TModules - The type of the modules, defaults to `any`.
- *
- * @property {string} appKey - A unique key identifying the application.
- * @property {Set<string>} status - A set of strings representing the status of the application.
- * @property {AppManifest} [manifest] - An optional manifest describing the application.
- * @property {AppConfig<TConfig>} [config] - An optional configuration object for the application.
- * @property {AppSettings} [settings] - An optional application settings object.
- * @property {AppScriptModule} [modules] - An optional script module for the application.
- * @property {AppModulesInstance<TModules>} [instance] - An optional instance of the application modules.
- */
-export type AppBundleState<
-  TConfig extends ConfigEnvironment = ConfigEnvironment,
-  // biome-ignore lint/suspicious/noExplicitAny: default must be bivariant `any`, not `unknown` — `unknown` breaks assignability when a concrete `AppBundleState<TConfig, TModules>` is used where the default-typed generic is expected
-  TModules = any,
-> = {
-  appKey: string;
-  tag?: string;
-  status: Set<ActionBaseType<Actions>>;
-  manifest?: AppManifest;
-  config?: AppConfig<TConfig>;
-  settings?: AppSettings;
-  modules?: AppScriptModule;
-  instance?: AppModulesInstance<TModules>;
-};
-
-/**
- * Represents the initial state of an application bundle, excluding the 'status' property.
- *
- * @template TConfig - The configuration environment type, defaults to `ConfigEnvironment`.
- * @template TModules - The type of modules included in the application bundle, defaults to `any`.
- */
-export type AppBundleStateInitial<
-  TConfig extends ConfigEnvironment = ConfigEnvironment,
-  // biome-ignore lint/suspicious/noExplicitAny: see AppBundleState above — default must be bivariant `any`
-  TModules = any,
-> = Omit<AppBundleState<TConfig, TModules>, 'status'>;