@equinor/fusion-framework-app 13.0.3 → 13.1.1

package/src/enable-state.ts

@@ -1,49 +0,0 @@
-import { enableStateModule } from '@equinor/fusion-framework-module-state';
-import type { IStateModuleConfigurator } from '@equinor/fusion-framework-module-state';
-import type { IAppConfigurator } from './AppConfigurator';
-import type { AnyModule } from '@equinor/fusion-framework-module';
-import type { FusionModulesInstance } from '@equinor/fusion-framework';
-
-/**
- * Enables state management for the application with persistent storage.
- *
- * This is a thin, app-scoped convenience wrapper around `enableStateModule` — it registers
- * the state module on the app's configurator so app code can reach it via the app namespace,
- * and scopes the module's default storage to this app's own `manifest.appKey` (so unrelated
- * apps or widgets hosted alongside it never share its state). The state module resolves a
- * local PouchDB database, optionally synced with the Fusion App State backend when service
- * discovery and auth are configured; call `setStorage` on the configurator to override it.
- *
- * @warning Local storage is NOT encrypted. Do not store sensitive data such as passwords,
- * tokens, personal information, or any data that requires security protection.
- *
- * @see {@link https://github.com/equinor/fusion-framework/blob/main/packages/modules/state/README.md | State Module Documentation} for comprehensive usage examples and API reference.
- *
- * @template M - Array of modules to be configured.
- * @template R - The fusion modules instance type.
- * @param configurator - The application configurator to enable state management on.
- * @param configure - Optional config callback, receiving the module's `IStateModuleConfigurator`.
- *
- * @example
- * ```typescript
- * import { enableState } from '@equinor/fusion-framework-app';
- *
- * export const configure = (configurator) => {
- *   enableState(configurator);
- * };
- *
- * // Later in your app, access the state provider
- * const stateProvider = modules.state;
- * await stateProvider.storeItem({ key: 'user-preference', value: { theme: 'dark' } });
- * const item = await stateProvider.getItem('user-preference');
- * ```
- */
-export function enableState<M extends AnyModule[], R extends FusionModulesInstance>(
-  configurator: IAppConfigurator<M, R>,
-  configure?: (builder: IStateModuleConfigurator) => void | Promise<void>,
-): void {
-  enableStateModule(configurator, async (builder) => {
-    builder.setName(configurator.manifest.appKey);
-    await configure?.(builder);
-  });
-}

package/src/index.ts

@@ -1,34 +0,0 @@
-/**
- * @packageDocumentation
- *
- * `@equinor/fusion-framework-app` provides the configuration and initialization
- * layer for Fusion applications. Use this package to set up application modules,
- * configure HTTP clients, enable bookmarks, and integrate with telemetry and
- * service discovery.
- *
- * The main entry points are:
- *
- * - {@link configureModules} — factory that creates an application initializer
- * - {@link AppConfigurator} / {@link IAppConfigurator} — configurator for registering modules and HTTP clients
- * - Type aliases such as {@link AppModuleInitiator}, {@link AppEnv}, and {@link AppRenderFn}
- *
- * Bookmark support is available via the `@equinor/fusion-framework-app/enable-bookmark`
- * sub-path export.
- */
-
-export { AppConfigurator, IAppConfigurator, AppConfiguratorConstructor } from './AppConfigurator';
-
-export * from './types';
-
-export { configureModules, default } from './configure-modules';
-
-export { AppConfiguratorError } from './AppConfiguratorError';
-
-export { AppModulesConfiguredEvent } from './AppModulesConfiguredEvent';
-
-export { AppModulesInitializedEvent } from './AppModulesInitializedEvent';
-
-/**
- * @deprecated Use {@link configureModules} instead. This alias will be removed in a future major version.
- */
-export { configureModules as initAppModules } from './configure-modules';

package/src/types.ts

@@ -1,145 +0,0 @@
-import type { Fusion } from '@equinor/fusion-framework';
-
-import type { AnyModule } from '@equinor/fusion-framework-module';
-
-import type {
-  AppConfig,
-  AppManifest,
-  AppModulesInstance,
-  ComponentRenderArgs,
-} from '@equinor/fusion-framework-module-app';
-
-import type { IAppConfigurator } from './AppConfigurator';
-import type { ConfigEnvironment } from '@equinor/fusion-framework-module-app';
-
-/**
- * Re-exported application module types from `@equinor/fusion-framework-module-app`.
- *
- * - `AppModules` — union of default application modules
- * - `AppManifest` — application manifest metadata (app key, version, etc.)
- * - `AppConfig` — environment-specific application configuration
- * - `AppModulesInstance` — resolved module instances after initialization
- */
-export type {
-  AppModules,
-  AppManifest,
-  AppConfig,
-  AppModulesInstance,
-} from '@equinor/fusion-framework-module-app';
-
-/**
- * Environment descriptor passed to the application during module initialization.
- *
- * Contains the application manifest, optional config (with endpoint definitions),
- * an optional base path for routing, and optional component props.
- *
- * @template TConfig - Shape of the environment-specific configuration object.
- * @template TProps - Additional properties forwarded to the application component (currently unused).
- */
-export type AppEnv<TConfig extends ConfigEnvironment = ConfigEnvironment, TProps = unknown> = {
-  /** Base routing path of the application (e.g. `/apps/my-app`). */
-  basename?: string;
-  /** Application manifest describing the app key, version, and build metadata. */
-  manifest: AppManifest;
-  /** Environment-specific configuration with optional endpoint definitions. */
-  config?: AppConfig<TConfig>;
-  /** Optional properties forwarded to the application component. */
-  props?: TProps;
-};
-
-/**
- * Configuration callback for setting up application modules.
- *
- * This is the function signature accepted by {@link configureModules}. Implement
- * this callback to register HTTP clients, enable bookmarks, and add custom modules
- * to the application’s module pipeline.
- *
- * @template TModules - Additional modules registered by the application.
- * @template TRef - The Fusion instance type used as a configuration reference.
- * @template TEnv - The application environment descriptor.
- *
- * @param configurator - The application configurator with HTTP and module helpers.
- * @param args - Object containing the Fusion instance and the application environment.
- * @returns `void` or a `Promise<void>` for async configuration steps.
- *
- * @example
- * ```ts
- * import type { AppModuleInitiator } from '@equinor/fusion-framework-app';
- *
- * const configure: AppModuleInitiator = (configurator, { fusion, env }) => {
- *   configurator.useFrameworkServiceClient('portal-api');
- * };
- * ```
- */
-export type AppModuleInitiator<
-  TModules extends Array<AnyModule> | unknown = unknown,
-  TRef extends Fusion = Fusion,
-  TEnv = AppEnv,
-> = (
-  configurator: IAppConfigurator<TModules, TRef['modules']>,
-  args: { fusion: TRef; env: TEnv },
-) => void | Promise<void>;
-
-/**
- * Factory type that wraps {@link AppModuleInitiator} into a complete initializer.
- *
- * Accepts a configuration callback and returns an async function that, given the
- * Fusion instance and environment, produces the initialized module instance.
- * This is the signature of the {@link configureModules} function itself.
- *
- * @template TModules - Additional modules registered by the application.
- * @template TRef - The Fusion instance type used as a configuration reference.
- * @template TEnv - The application environment descriptor.
- */
-export type AppModuleInit<
-  TModules extends Array<AnyModule> | unknown = [],
-  TRef extends Fusion = Fusion,
-  TEnv = AppEnv,
-> = (
-  cb: AppModuleInitiator<TModules, TRef, TEnv>,
-) => (args: AppModuleInitArgs<TRef, TEnv>) => Promise<AppModulesInstance<TModules>>;
-
-/**
- * Arguments passed to the async initializer returned by {@link configureModules}.
- *
- * @template TRef - The Fusion instance type.
- * @template TEnv - The application environment descriptor.
- */
-export type AppModuleInitArgs<TRef extends Fusion = Fusion, TEnv = AppEnv> = {
-  fusion: TRef;
-  env: TEnv;
-};
-
-/**
- * Render function signature for mounting a Fusion application into the DOM.
- *
- * Called by the Fusion portal or dev-server to render the application. The
- * function receives the root element and render arguments (Fusion instance,
- * environment, and modules) and optionally returns a cleanup function that
- * is invoked when the application is unmounted.
- *
- * @template TFusion - The Fusion instance type providing framework modules.
- * @template TEnv - The application environment descriptor.
- *
- * @param el - The root HTML element where the application will be rendered.
- * @param args - Render arguments including the Fusion instance, environment,
- *               and resolved modules.
- * @returns A cleanup / teardown function, or `void` if no cleanup is needed.
- *
- * @example
- * ```ts
- * import type { AppRenderFn } from '@equinor/fusion-framework-app';
- * import { createRoot } from 'react-dom/client';
- *
- * export const renderApp: AppRenderFn = (el, args) => {
- *   const root = createRoot(el);
- *   root.render(<App />);
- *   return () => root.unmount();
- * };
- * ```
- */
-export type AppRenderFn<TFusion extends Fusion = Fusion, TEnv = AppEnv> = (
-  el: HTMLHtmlElement,
-  args: ComponentRenderArgs<TFusion, TEnv>,
-  // biome-ignore lint/suspicious/noConfusingVoidType: `void` here relies on TypeScript's special-cased "void-returning callback accepts any return value" behavior \u2014 `undefined` would break assignability of render functions that return a cleanup function
-) => VoidFunction | void;

package/src/utils.ts

@@ -1,50 +0,0 @@
-export { default as deepClone } from 'lodash.clonedeep';
-
-/**
- * Utility type that makes all properties of an object deeply readonly.
- *
- * @typeParam T - The type to make deeply readonly.
- */
-export type DeepImmutable<T> = {
-  readonly [P in keyof T]: T[P] extends object ? DeepImmutable<T[P]> : T[P];
-};
-
-/**
- * Determines if the provided object is eligible to be frozen.
- *
- * Checks whether the input is a non-null object or array that is not already frozen.
- *
- * @param obj - The value to check for isMutable.
- * @returns True if the object is a non-null object or array and is not already frozen; otherwise, false.
- */
-function isMutable(obj: unknown): obj is Record<string, unknown> | Array<unknown> {
-  return typeof obj === 'object' && obj !== null && !Object.isFrozen(obj);
-}
-
-/**
- * Recursively applies Object.freeze to an object and all nested properties, making them immutable.
- *
- * @remarks
- * - Plain objects and arrays are deeply frozen.
- * - Does not handle circular references. Use with caution on complex object graphs.
- * - Symbol properties are not frozen.
- *
- * @template T - The type of the object to freeze.
- * @param obj - The object to deeply freeze.
- * @returns The deeply frozen (read-only) object.
- */
-export function deepFreeze<T>(source: T): DeepImmutable<T> {
-  // Skip primitives and objects already frozen to avoid unnecessary recursion.
-  if (isMutable(source)) {
-    // Arrays require traversing their values directly before freezing the container.
-    if (Array.isArray(source)) {
-      // Freeze every nested array value so the result is immutable at every depth.
-      source.forEach(deepFreeze);
-    } else {
-      // Freeze every nested object value so the result is immutable at every depth.
-      Object.values(source).forEach(deepFreeze);
-    }
-    Object.freeze(source);
-  }
-  return source;
-}

package/src/version.ts

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

package/tsconfig.json

@@ -1,42 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist/esm",
-    "rootDir": "src",
-    "declarationDir": "./dist/types"
-  },
-  "references": [
-    {
-      "path": "../modules/module"
-    },
-    {
-      "path": "../modules/http"
-    },
-    {
-      "path": "../modules/msal"
-    },
-    {
-      "path": "../modules/event"
-    },
-    {
-      "path": "../modules/telemetry"
-    },
-    {
-      "path": "../modules/bookmark"
-    },
-    {
-      "path": "../modules/state"
-    },
-    {
-      "path": "../modules/app"
-    },
-    {
-      "path": "../modules/feature-flag"
-    },
-    {
-      "path": "../framework"
-    }
-  ],
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "lib"]
-}

package/vitest.config.ts

@@ -1,10 +0,0 @@
-import { defineProject } from 'vitest/config';
-
-import { name, version } from './package.json';
-
-export default defineProject({
-  test: {
-    include: ['src/__tests__/**'],
-    name: `${name}@${version}`,
-  },
-});