@equinor/fusion-framework 7.4.14-next.0 → 8.0.0

package/dist/types/FrameworkConfigurator.d.ts

@@ -6,9 +6,37 @@ import { enableTelemetry } from '@equinor/fusion-framework-module-telemetry';
 import type { FusionModules } from './types.js';
 import type { MsalClientConfig } from '@equinor/fusion-framework-module-msal';
 /**
- * Module configurator for Framework modules
- * @template TModules - Addition modules
- * @template TRef - usually undefined, optional references
+ * Configurator that registers and wires the core Fusion Framework modules.
+ *
+ * Extend `FrameworkConfigurator` to declare which modules (authentication,
+ * HTTP, service-discovery, telemetry, context, …) the framework instance
+ * should contain and how each module is configured before the framework
+ * starts.
+ *
+ * Typical workflow:
+ * 1. Create a `FrameworkConfigurator` instance.
+ * 2. Call configuration helpers such as {@link configureMsal},
+ *    {@link configureHttp}, {@link configureHttpClient}, and
+ *    {@link configureServiceDiscovery}.
+ * 3. Pass the configurator to {@link init} to bootstrap the framework.
+ *
+ * @template TModules - Additional module descriptors to merge with the
+ *   built-in Fusion modules.
+ * @template TRef - Optional reference object forwarded to module
+ *   initialization (e.g. a parent framework instance).
+ *
+ * @example
+ * ```typescript
+ * import { FrameworkConfigurator, init } from '@equinor/fusion-framework';
+ *
+ * const configurator = new FrameworkConfigurator();
+ * configurator.configureMsal({ clientId: 'my-client-id', authority: '…' });
+ * configurator.configureServiceDiscovery({
+ *   client: { baseUri: 'https://service-registry.example.com' },
+ * });
+ *
+ * const fusion = await init(configurator);
+ * ```
  */
 export declare class FrameworkConfigurator<TModules extends Array<AnyModule> = [], TRef = any> extends ModulesConfigurator<FusionModules<TModules>, TRef> {
     /**

package/dist/types/index.d.ts

@@ -1,18 +1,35 @@
+/**
+ * Entry point for `@equinor/fusion-framework` — the core initialization
+ * package of Fusion Framework.
+ *
+ * @remarks
+ * Re-exports the {@link FrameworkConfigurator} (used to configure framework
+ * modules before initialization), the {@link init} function (used to
+ * bootstrap the framework), and all public type aliases that describe
+ * the resulting module graph.
+ *
+ * @packageDocumentation
+ */
 import type { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
 import type { Fusion } from './types.js';
 declare module '@equinor/fusion-framework-module-event' {
     interface FrameworkEventMap {
+        /**
+         * Dispatched after all framework modules have been initialized and the
+         * global `window.Fusion` reference has been set.
+         */
         onFrameworkLoaded: FrameworkEvent<FrameworkEventInit<Fusion>>;
     }
 }
 declare global {
     interface Window {
+        /** Global Fusion instance, set during {@link init}. */
         Fusion: Fusion;
     }
 }
 export { FrameworkConfigurator, 
 /**
- * @deprecated use FrameworkConfigurator
+ * @deprecated Use {@link FrameworkConfigurator} instead.
  */
 FrameworkConfigurator as FusionConfigurator, } from './FrameworkConfigurator';
 export type { FusionModules, FusionModulesInstance, Fusion, FusionRenderFn } from './types';

package/dist/types/init.d.ts

@@ -2,13 +2,38 @@ import type { AnyModule } from '@equinor/fusion-framework-module';
 import type { FrameworkConfigurator } from './FrameworkConfigurator.js';
 import type { Fusion } from './types.js';
 /**
+ * Initialize Fusion Framework from a fully-configured
+ * {@link FrameworkConfigurator}.
  *
- * @template TModules addition modules
- * @template TRef optional reference
+ * This is the main bootstrap entry point. It resolves all module
+ * configurations, instantiates every registered module, assigns the
+ * resulting {@link Fusion} object to `window.Fusion`, and dispatches
+ * the `onFrameworkLoaded` event.
  *
- * @param configurator config builder instance
- * @param ref optional references
- * @returns instance of framework modules
+ * @template TModules - Additional module descriptors beyond the built-in
+ *   Fusion modules.
+ * @template TRef - Reference object forwarded to modules during
+ *   initialization (e.g. a parent framework instance).
+ *
+ * @param configurator - A {@link FrameworkConfigurator} that has been set up
+ *   with the desired module configurations (MSAL, HTTP, service discovery,
+ *   etc.).
+ * @param ref - Optional reference object passed through to each module's
+ *   initializer, typically used when an application framework is initialized
+ *   within an outer host framework.
+ * @returns A promise that resolves to the initialized {@link Fusion}
+ *   instance containing all configured module instances.
+ *
+ * @example
+ * ```typescript
+ * import { FrameworkConfigurator, init } from '@equinor/fusion-framework';
+ *
+ * const configurator = new FrameworkConfigurator();
+ * configurator.configureMsal({ clientId: '…', authority: '…' });
+ *
+ * const fusion = await init(configurator);
+ * console.log(fusion.modules); // all instantiated modules
+ * ```
  */
 export declare const init: <TModules extends Array<AnyModule>, TRef extends object>(configurator: FrameworkConfigurator<TModules>, ref?: TRef) => Promise<Fusion<TModules>>;
 export default init;

package/dist/types/types.d.ts

@@ -8,7 +8,21 @@ import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-se
 import type { ServicesModule } from '@equinor/fusion-framework-module-services';
 import type { TelemetryModule } from '@equinor/fusion-framework-module-telemetry';
 /**
- * interface of the modules provided by Fusion Framework
+ * Union of all built-in Fusion Framework module descriptors, optionally
+ * combined with additional custom modules.
+ *
+ * Use this type to describe the full set of modules the framework
+ * configurator will manage. The built-in set includes:
+ * - {@link ContextModule} — application/project context selection
+ * - {@link EventModule} — cross-module event bus
+ * - {@link HttpModule} — HTTP client factory
+ * - {@link MsalModule} — Microsoft Authentication Library integration
+ * - {@link ServicesModule} — typed service clients
+ * - {@link ServiceDiscoveryModule} — runtime service endpoint resolution
+ * - {@link TelemetryModule} — telemetry and logging
+ *
+ * @template TModules - Additional module descriptors to merge with the
+ *   built-in modules. Defaults to `unknown` (no extra modules).
  */
 export type FusionModules<TModules extends Array<AnyModule> | unknown = unknown> = CombinedModules<TModules, [
     ContextModule,
@@ -20,15 +34,42 @@ export type FusionModules<TModules extends Array<AnyModule> | unknown = unknown>
     TelemetryModule
 ]>;
 /**
- * Blueprint of instance of framework modules
+ * Resolved instance map for all Fusion Framework modules.
+ *
+ * This is the runtime counterpart of {@link FusionModules}: after the
+ * framework has been initialized with {@link init}, every module
+ * descriptor is replaced by its live instance (clients, providers,
+ * managers, etc.).
+ *
+ * @template TModules - Additional module descriptors whose instances
+ *   should be included. Defaults to `unknown`.
  */
 export type FusionModulesInstance<TModules extends Array<AnyModule> | unknown = unknown> = ModulesInstance<FusionModules<TModules>>;
+/**
+ * Root object returned by {@link init} after bootstrapping the framework.
+ *
+ * The `Fusion` object is also assigned to `window.Fusion` so that portal
+ * shells, micro-frontends, and widgets can access the running framework
+ * instance globally.
+ *
+ * @template TModules - Additional module descriptors beyond the built-in
+ *   set. Defaults to `unknown`.
+ */
 export interface Fusion<TModules extends Array<AnyModule> | unknown = unknown> {
-    /**
-     * Configured services for Fusion
-     */
+    /** Map of all initialized module instances keyed by module name. */
     modules: FusionModulesInstance<TModules>;
 }
+/**
+ * Callback signature for rendering a Fusion application into a DOM element.
+ *
+ * Portal hosts call this function when mounting an application, passing the
+ * root element and a reference to the host's module instances so the
+ * application can share authentication, HTTP clients, and other services.
+ *
+ * @param el - The DOM element into which the application should render.
+ * @param args - Initialization arguments containing a reference to the
+ *   host framework's module instances.
+ */
 export type FusionRenderFn = (el: HTMLElement, args: {
     ref: ModulesInstance<AnyModule[]>;
 }) => void;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "7.4.14-next.0";
+export declare const version = "8.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework",
-  "version": "7.4.14-next.0",
+  "version": "8.0.0",
   "description": "",
   "main": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -32,18 +32,18 @@
   },
   "dependencies": {
     "rxjs": "^7.8.1",
-    "@equinor/fusion-framework-module": "5.0.7-next.0",
-    "@equinor/fusion-framework-module-context": "7.0.4-next.0",
-    "@equinor/fusion-framework-module-event": "5.0.2-next.0",
-    "@equinor/fusion-framework-module-http": "7.0.9-next.0",
-    "@equinor/fusion-framework-module-msal": "7.3.2-next.0",
-    "@equinor/fusion-framework-module-services": "7.2.2-next.0",
-    "@equinor/fusion-framework-module-service-discovery": "9.1.2-next.0",
-    "@equinor/fusion-framework-module-telemetry": "4.6.5-next.0"
+    "@equinor/fusion-framework-module": "6.0.0",
+    "@equinor/fusion-framework-module-context": "8.0.0",
+    "@equinor/fusion-framework-module-event": "6.0.0",
+    "@equinor/fusion-framework-module-msal": "8.0.0",
+    "@equinor/fusion-framework-module-http": "8.0.0",
+    "@equinor/fusion-framework-module-service-discovery": "10.0.0",
+    "@equinor/fusion-framework-module-services": "8.0.0",
+    "@equinor/fusion-framework-module-telemetry": "5.0.0"
   },
   "devDependencies": {
-    "typescript": "^5.8.2",
-    "vitest": "^4.0.18"
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.0"
   },
   "scripts": {
     "build": "tsc -b",

package/src/FrameworkConfigurator.ts

@@ -22,9 +22,37 @@ import type { MsalClientConfig } from '@equinor/fusion-framework-module-msal';
 import { version } from './version.js';
 
 /**
- * Module configurator for Framework modules
- * @template TModules - Addition modules
- * @template TRef - usually undefined, optional references
+ * Configurator that registers and wires the core Fusion Framework modules.
+ *
+ * Extend `FrameworkConfigurator` to declare which modules (authentication,
+ * HTTP, service-discovery, telemetry, context, …) the framework instance
+ * should contain and how each module is configured before the framework
+ * starts.
+ *
+ * Typical workflow:
+ * 1. Create a `FrameworkConfigurator` instance.
+ * 2. Call configuration helpers such as {@link configureMsal},
+ *    {@link configureHttp}, {@link configureHttpClient}, and
+ *    {@link configureServiceDiscovery}.
+ * 3. Pass the configurator to {@link init} to bootstrap the framework.
+ *
+ * @template TModules - Additional module descriptors to merge with the
+ *   built-in Fusion modules.
+ * @template TRef - Optional reference object forwarded to module
+ *   initialization (e.g. a parent framework instance).
+ *
+ * @example
+ * ```typescript
+ * import { FrameworkConfigurator, init } from '@equinor/fusion-framework';
+ *
+ * const configurator = new FrameworkConfigurator();
+ * configurator.configureMsal({ clientId: 'my-client-id', authority: '…' });
+ * configurator.configureServiceDiscovery({
+ *   client: { baseUri: 'https://service-registry.example.com' },
+ * });
+ *
+ * const fusion = await init(configurator);
+ * ```
  */
 export class FrameworkConfigurator<
   TModules extends Array<AnyModule> = [],

package/src/index.ts

@@ -1,14 +1,32 @@
+/**
+ * Entry point for `@equinor/fusion-framework` — the core initialization
+ * package of Fusion Framework.
+ *
+ * @remarks
+ * Re-exports the {@link FrameworkConfigurator} (used to configure framework
+ * modules before initialization), the {@link init} function (used to
+ * bootstrap the framework), and all public type aliases that describe
+ * the resulting module graph.
+ *
+ * @packageDocumentation
+ */
+
 import type { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
 import type { Fusion } from './types.js';
 
 declare module '@equinor/fusion-framework-module-event' {
   interface FrameworkEventMap {
+    /**
+     * Dispatched after all framework modules have been initialized and the
+     * global `window.Fusion` reference has been set.
+     */
     onFrameworkLoaded: FrameworkEvent<FrameworkEventInit<Fusion>>;
   }
 }
 
 declare global {
   interface Window {
+    /** Global Fusion instance, set during {@link init}. */
     Fusion: Fusion;
   }
 }
@@ -16,7 +34,7 @@ declare global {
 export {
   FrameworkConfigurator,
   /**
-   * @deprecated use FrameworkConfigurator
+   * @deprecated Use {@link FrameworkConfigurator} instead.
    */
   FrameworkConfigurator as FusionConfigurator,
 } from './FrameworkConfigurator';

package/src/init.ts

@@ -4,13 +4,38 @@ import type { FrameworkConfigurator } from './FrameworkConfigurator.js';
 import type { Fusion, FusionModules } from './types.js';
 
 /**
+ * Initialize Fusion Framework from a fully-configured
+ * {@link FrameworkConfigurator}.
  *
- * @template TModules addition modules
- * @template TRef optional reference
+ * This is the main bootstrap entry point. It resolves all module
+ * configurations, instantiates every registered module, assigns the
+ * resulting {@link Fusion} object to `window.Fusion`, and dispatches
+ * the `onFrameworkLoaded` event.
  *
- * @param configurator config builder instance
- * @param ref optional references
- * @returns instance of framework modules
+ * @template TModules - Additional module descriptors beyond the built-in
+ *   Fusion modules.
+ * @template TRef - Reference object forwarded to modules during
+ *   initialization (e.g. a parent framework instance).
+ *
+ * @param configurator - A {@link FrameworkConfigurator} that has been set up
+ *   with the desired module configurations (MSAL, HTTP, service discovery,
+ *   etc.).
+ * @param ref - Optional reference object passed through to each module's
+ *   initializer, typically used when an application framework is initialized
+ *   within an outer host framework.
+ * @returns A promise that resolves to the initialized {@link Fusion}
+ *   instance containing all configured module instances.
+ *
+ * @example
+ * ```typescript
+ * import { FrameworkConfigurator, init } from '@equinor/fusion-framework';
+ *
+ * const configurator = new FrameworkConfigurator();
+ * configurator.configureMsal({ clientId: '…', authority: '…' });
+ *
+ * const fusion = await init(configurator);
+ * console.log(fusion.modules); // all instantiated modules
+ * ```
  */
 export const init = async <TModules extends Array<AnyModule>, TRef extends object>(
   configurator: FrameworkConfigurator<TModules>,
@@ -20,6 +45,7 @@ export const init = async <TModules extends Array<AnyModule>, TRef extends objec
   const fusion = {
     modules,
   };
+  // Expose globally so portal shells and widgets can access the running instance
   window.Fusion = fusion as unknown as Fusion;
   modules.event.dispatchEvent('onFrameworkLoaded', { detail: fusion });
 

package/src/types.ts

@@ -10,7 +10,21 @@ import type { ServicesModule } from '@equinor/fusion-framework-module-services';
 import type { TelemetryModule } from '@equinor/fusion-framework-module-telemetry';
 
 /**
- * interface of the modules provided by Fusion Framework
+ * Union of all built-in Fusion Framework module descriptors, optionally
+ * combined with additional custom modules.
+ *
+ * Use this type to describe the full set of modules the framework
+ * configurator will manage. The built-in set includes:
+ * - {@link ContextModule} — application/project context selection
+ * - {@link EventModule} — cross-module event bus
+ * - {@link HttpModule} — HTTP client factory
+ * - {@link MsalModule} — Microsoft Authentication Library integration
+ * - {@link ServicesModule} — typed service clients
+ * - {@link ServiceDiscoveryModule} — runtime service endpoint resolution
+ * - {@link TelemetryModule} — telemetry and logging
+ *
+ * @template TModules - Additional module descriptors to merge with the
+ *   built-in modules. Defaults to `unknown` (no extra modules).
  */
 export type FusionModules<TModules extends Array<AnyModule> | unknown = unknown> = CombinedModules<
   TModules,
@@ -26,16 +40,43 @@ export type FusionModules<TModules extends Array<AnyModule> | unknown = unknown>
 >;
 
 /**
- * Blueprint of instance of framework modules
+ * Resolved instance map for all Fusion Framework modules.
+ *
+ * This is the runtime counterpart of {@link FusionModules}: after the
+ * framework has been initialized with {@link init}, every module
+ * descriptor is replaced by its live instance (clients, providers,
+ * managers, etc.).
+ *
+ * @template TModules - Additional module descriptors whose instances
+ *   should be included. Defaults to `unknown`.
  */
 export type FusionModulesInstance<TModules extends Array<AnyModule> | unknown = unknown> =
   ModulesInstance<FusionModules<TModules>>;
 
+/**
+ * Root object returned by {@link init} after bootstrapping the framework.
+ *
+ * The `Fusion` object is also assigned to `window.Fusion` so that portal
+ * shells, micro-frontends, and widgets can access the running framework
+ * instance globally.
+ *
+ * @template TModules - Additional module descriptors beyond the built-in
+ *   set. Defaults to `unknown`.
+ */
 export interface Fusion<TModules extends Array<AnyModule> | unknown = unknown> {
-  /**
-   * Configured services for Fusion
-   */
+  /** Map of all initialized module instances keyed by module name. */
   modules: FusionModulesInstance<TModules>;
 }
 
+/**
+ * Callback signature for rendering a Fusion application into a DOM element.
+ *
+ * Portal hosts call this function when mounting an application, passing the
+ * root element and a reference to the host's module instances so the
+ * application can share authentication, HTTP clients, and other services.
+ *
+ * @param el - The DOM element into which the application should render.
+ * @param args - Initialization arguments containing a reference to the
+ *   host framework's module instances.
+ */
 export type FusionRenderFn = (el: HTMLElement, args: { ref: ModulesInstance<AnyModule[]> }) => void;

package/src/version.ts

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