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

package/CHANGELOG.md

@@ -1,16 +1,31 @@
 # Change Log
 
-## 8.0.0-next.0
+## 8.0.0
 
 ### Major Changes
 
-- [#3820](https://github.com/equinor/fusion-framework/pull/3820) [`9f7597e`](https://github.com/equinor/fusion-framework/commit/9f7597ee237ef069dc24cbe39c73b5b26db157dd) Thanks [@odinr](https://github.com/odinr)! - Require React 18+ as peer dependency. React 17 is no longer supported.
+- abffa53: Major version bump for Fusion Framework React 19 release.
+
+  All packages are bumped to the next major version as part of the React 19 upgrade. This release drops support for React versions below 18 and includes breaking changes across the framework.
+
+  **Breaking changes:**
+  - Peer dependencies now require React 18 or 19 (`^18.0.0 || ^19.0.0`)
+  - React Router upgraded from v6 to v7
+  - Navigation module refactored with new history API
+  - `renderComponent` and `renderApp` now use `createRoot` API
+
+  **Migration:**
+  - Update your React version to 18.0.0 or higher before upgrading
+  - Replace `NavigationProvider.createRouter()` with `@equinor/fusion-framework-react-router`
+  - See individual package changelogs for package-specific migration steps
+
+- abffa53: Require React 18+ as peer dependency. React 17 is no longer supported.
 
   **Migration:** Update your application to React 18+ to continue using these packages.
 
   Closes https://github.com/equinor/fusion-framework/issues/3504
 
-- [#3820](https://github.com/equinor/fusion-framework/pull/3820) [`75c068f`](https://github.com/equinor/fusion-framework/commit/75c068fea13c32435ac26bd9043cc156482bfaf1) Thanks [@odinr](https://github.com/odinr)! - Upgrade to React 19 and remove support for React versions lower than 18.
+- abffa53: Upgrade to React 19 and remove support for React versions lower than 18.
 
   **Breaking changes:**
   - Peer dependencies now require React 18 or 19 (`^18.0.0 || ^19.0.0`)
@@ -21,18 +36,39 @@
   - Update your React version to 18.0.0 or higher before upgrading these packages
   - If using React 16 or 17, upgrade to React 18 or 19 first
 
+  Closes https://github.com/equinor/fusion-framework/issues/3504
+
+### Patch Changes
+
+- Updated dependencies [abffa53]
+- Updated dependencies [abffa53]
+- Updated dependencies [abffa53]
+- Updated dependencies [abffa53]
+- Updated dependencies [abffa53]
+- Updated dependencies [abffa53]
+- Updated dependencies [aaa3f74]
+  - @equinor/fusion-framework@8.0.0
+  - @equinor/fusion-framework-module@6.0.0
+  - @equinor/fusion-framework-module-feature-flag@2.0.0
+  - @equinor/fusion-framework-react-module@4.0.0
+  - @equinor/fusion-framework-react-module-http@11.0.0
+  - @equinor/fusion-framework-react-module-signalr@4.0.0
+  - @equinor/fusion-observable@9.0.0
+
+## 7.4.20
+
 ### Patch Changes
 
-- [#3820](https://github.com/equinor/fusion-framework/pull/3820) [`265bb76`](https://github.com/equinor/fusion-framework/commit/265bb767249989eeb1971e83f3fba94879e0813b) Thanks [@odinr](https://github.com/odinr)! - relase next
+- [#4157](https://github.com/equinor/fusion-framework/pull/4157) [`6aa8e1f`](https://github.com/equinor/fusion-framework/commit/6aa8e1f5c9d852b25e97aa7d98a63008c64d4581) Thanks [@Noggling](https://github.com/Noggling)! - Internal: patch release to align TypeScript types across packages for consistent type compatibility.
 
-- Updated dependencies [[`265bb76`](https://github.com/equinor/fusion-framework/commit/265bb767249989eeb1971e83f3fba94879e0813b), [`d252b0d`](https://github.com/equinor/fusion-framework/commit/d252b0d442b7c8c1b50bf2768cf9ecbbb55a76f8), [`d252b0d`](https://github.com/equinor/fusion-framework/commit/d252b0d442b7c8c1b50bf2768cf9ecbbb55a76f8), [`d252b0d`](https://github.com/equinor/fusion-framework/commit/d252b0d442b7c8c1b50bf2768cf9ecbbb55a76f8), [`9f7597e`](https://github.com/equinor/fusion-framework/commit/9f7597ee237ef069dc24cbe39c73b5b26db157dd), [`75c068f`](https://github.com/equinor/fusion-framework/commit/75c068fea13c32435ac26bd9043cc156482bfaf1)]:
-  - @equinor/fusion-framework-react-module-signalr@4.0.0-next.0
-  - @equinor/fusion-framework-module-feature-flag@2.0.0-next.0
-  - @equinor/fusion-framework-react-module@4.0.0-next.0
-  - @equinor/fusion-framework-react-module-http@11.0.0-next.0
-  - @equinor/fusion-observable@9.0.0-next.0
-  - @equinor/fusion-framework@7.4.3-next.0
-  - @equinor/fusion-framework-module@5.0.6-next.0
+- Updated dependencies [[`6aa8e1f`](https://github.com/equinor/fusion-framework/commit/6aa8e1f5c9d852b25e97aa7d98a63008c64d4581)]:
+  - @equinor/fusion-framework@7.4.13
+  - @equinor/fusion-framework-module-feature-flag@1.1.28
+  - @equinor/fusion-framework-module@5.0.6
+  - @equinor/fusion-framework-react-module-http@10.0.1
+  - @equinor/fusion-framework-react-module@3.1.14
+  - @equinor/fusion-framework-react-module-signalr@3.0.37
+  - @equinor/fusion-observable@8.5.8
 
 ## 7.4.19
 

package/README.md

@@ -1,44 +1,177 @@
-# Fusion Framework React
+# @equinor/fusion-framework-react
 
-> Package for creating React provider for Fusion Framework
+React bindings for bootstrapping and consuming a [Fusion Framework](https://github.com/equinor/fusion-framework) instance inside a React application tree.
 
-use case:
+## Features
 
- * Initiatiting framework for hosting, aka portal.
- * consume framework internally in host
- * consume framework in child instance, aka app.
+- **Framework provider** — initialise and distribute the framework via React context with a single component or factory function.
+- **`useFramework` hook** — access the active `Fusion` instance from any descendant component.
+- **Module hooks** — retrieve individual framework modules (`useFrameworkModule`) without manual wiring.
+- **App hooks** — observe the currently active application, query app manifests, and access app-level modules.
+- **Context hook** — read the currently selected Fusion context.
+- **Feature-flag hooks** — read, toggle, and observe feature flags at the framework or application level.
+- **HTTP hook** — obtain pre-configured HTTP clients (`portal`, `people`) from the framework.
+- **Auth hook** — retrieve the currently authenticated user.
+- **SignalR hook** — subscribe to real-time SignalR hub topics.
+
+## Installation
+
+```sh
+pnpm add @equinor/fusion-framework-react
+```
+
+## Usage
+
+### Bootstrap the framework (declarative)
+
+```tsx
+import { Framework } from '@equinor/fusion-framework-react';
+
+const App = () => (
+  <Framework
+    configure={(configurator) => {
+      configurator.http.configureClient('my-api', {
+        baseUri: 'https://api.example.com',
+      });
+    }}
+    fallback={<span>Loading…</span>}
+  >
+    <MyApp />
+  </Framework>
+);
+```
+
+### Bootstrap the framework (factory)
 
 ```tsx
 import { createFrameworkProvider } from '@equinor/fusion-framework-react';
+import { Suspense, useMemo } from 'react';
 
-const Framework = () => {
-  /** Create and configure framework */
-  const FrameworkProvider = createFrameworkProvider(() => {
-    config.http.createClient('some_service', 'https://foo.bar')
-  });
+const Portal = () => {
+  const Provider = useMemo(
+    () =>
+      createFrameworkProvider((config) => {
+        config.http.configureClient('my-api', {
+          baseUri: 'https://api.example.com',
+        });
+      }),
+    [],
+  );
 
   return (
-      <Suspense fallback={<span>initializing framework...</span>}>
-          <FrameworkProvider>{children}</FrameworkProvider>
-      </Suspense>
+    <Suspense fallback={<span>Loading…</span>}>
+      <Provider>
+        <App />
+      </Provider>
+    </Suspense>
   );
-}
+};
+```
 
-const PortalComponent = () => {
-  const framework = useFramework();
-  const [foo, setFoo] = useState();
+### Consume the framework
 
-  useEffect(() => {
-    const client = framework.http.createClient('some_service');
-    client.fetch('/foobar').subscribe(x => setFoo(x.json()));
-  }, [framework.http])
-}
+```ts
+import { useFramework } from '@equinor/fusion-framework-react';
 
-const Portal = () => {
-  return (
-    <Framework>
-      <PortalComponent />
-    <Framework>
-  );
-}
-```
+const useMyService = () => {
+  const fusion = useFramework();
+  return fusion.modules.http.createClient('my-api');
+};
+```
+
+### Get a specific module
+
+```ts
+import { useFrameworkModule } from '@equinor/fusion-framework-react';
+import type { HttpModule } from '@equinor/fusion-framework-module-http';
+
+const http = useFrameworkModule<HttpModule>('http');
+```
+
+## API Reference
+
+### Components
+
+| Export | Description |
+| --- | --- |
+| `Framework` | Declarative component that initialises the framework and wraps children in providers. |
+| `FrameworkProvider` | Low-level React context provider for an existing `Fusion` instance. |
+
+### Factory
+
+| Export | Description |
+| --- | --- |
+| `createFrameworkProvider(cb, ref?)` | Creates a `React.lazy` component that initialises the framework asynchronously. Must be rendered inside `<Suspense>`. |
+
+### Core hooks
+
+| Hook | Description |
+| --- | --- |
+| `useFramework()` | Returns the active `Fusion` instance from context. |
+| `useFrameworkModule(name)` | Returns a specific module from the framework by key. |
+
+### App hooks (`/app`)
+
+| Hook | Description |
+| --- | --- |
+| `useApps(args?)` | Lists available app manifests. |
+| `useCurrentApp()` | Observes and returns the currently active app. |
+| `useCurrentAppModule(key)` | Retrieves a module from the current app. |
+| `useCurrentAppModules()` | Observes initialised modules of the current app. |
+| `useAppProvider()` | Returns the raw `AppModule` provider. |
+
+### Context hook (`/context`)
+
+| Hook | Description |
+| --- | --- |
+| `useCurrentContext()` | Returns the currently selected Fusion context. |
+
+### Feature-flag hooks (`/feature-flag`)
+
+| Hook | Description |
+| --- | --- |
+| `useFeature(provider, key)` | Reads and toggles a single feature flag. |
+| `useFeatures(provider, selector?)` | Returns all feature flags with optional filtering. |
+| `useFrameworkFeature(key)` | Reads a feature flag from the framework provider. |
+| `useFrameworkFeatures()` | Returns all framework-level feature flags. |
+| `useCurrentAppFeatures()` | Returns feature flags for the current app. |
+
+### HTTP hook (`/http`)
+
+| Hook | Description |
+| --- | --- |
+| `useFrameworkHttpClient(name)` | Returns a pre-configured HTTP client. |
+
+### Convenience hooks (`/hooks`)
+
+| Hook | Description |
+| --- | --- |
+| `useHttpClient(name)` | Returns a framework HTTP client (`'portal'` or `'people'`). |
+| `useCurrentUser()` | Returns the authenticated user's account info. |
+
+### SignalR hook (`/signalr`)
+
+| Hook | Description |
+| --- | --- |
+| `useSignalR(hubId, topicId)` | Subscribes to a SignalR hub topic. |
+
+### Re-exported types
+
+| Type | Source |
+| --- | --- |
+| `Fusion` | `@equinor/fusion-framework` |
+| `FusionConfigurator` | `@equinor/fusion-framework` |
+| `AppManifest`, `AppConfig`, `AppType`, `IApp` | `@equinor/fusion-framework-module-app` |
+| `IFeatureFlag`, `IFeatureFlagProvider` | `@equinor/fusion-framework-module-feature-flag` |
+
+## Sub-entry-points
+
+The package exposes several sub-entry-points for tree-shakeable imports:
+
+- `@equinor/fusion-framework-react` — core providers and hooks
+- `@equinor/fusion-framework-react/app` — application hooks
+- `@equinor/fusion-framework-react/context` — context hooks
+- `@equinor/fusion-framework-react/feature-flag` — feature-flag hooks
+- `@equinor/fusion-framework-react/hooks` — convenience hooks
+- `@equinor/fusion-framework-react/http` — HTTP hooks
+- `@equinor/fusion-framework-react/signalr` — SignalR hooks

package/dist/esm/Framework.js

@@ -2,6 +2,38 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import { createFrameworkProvider } from './create-framework-provider';
 import { Suspense, useMemo } from 'react';
 import { useModules } from '@equinor/fusion-framework-react-module';
+/**
+ * Declarative React component that initialises a Fusion Framework instance
+ * and provides it to descendant components via context.
+ *
+ * @remarks
+ * Internally calls {@link createFrameworkProvider} and wraps the lazy-loaded
+ * provider in a `<Suspense>` boundary. This is the recommended high-level
+ * component for portal / host applications that need to bootstrap the
+ * framework inside a React tree.
+ *
+ * @param props.configure - Callback that receives a {@link FrameworkConfigurator}
+ *   for registering modules and configuration.
+ * @param props.fallback - React node shown while the framework is initialising.
+ * @param props.parent - Optional parent module instance to inherit configuration from.
+ * @param props.children - Application content rendered after initialisation.
+ *
+ * @example
+ * ```tsx
+ * import { Framework } from '@equinor/fusion-framework-react';
+ *
+ * const App = () => (
+ *   <Framework
+ *     configure={(configurator) => {
+ *       configurator.http.configureClient('my-api', { baseUri: 'https://api.example.com' });
+ *     }}
+ *     fallback={<span>Loading…</span>}
+ *   >
+ *     <MyApp />
+ *   </Framework>
+ * );
+ * ```
+ */
 export const Framework = (props) => {
     const { configure, fallback, parent, children } = props;
     //import modules from parent context

package/dist/esm/Framework.js.map

@@ -1 +1 @@
-{"version":3,"file":"Framework.js","sourceRoot":"","sources":["../../src/Framework.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAA0C,QAAQ,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAClF,OAAO,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AAKpE,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,KAKE,EACF,EAAE;IACF,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IACxD,oCAAoC;IACpC,MAAM,GAAG,GAAG,UAAU,EAAM,CAAC;IAC7B,MAAM,SAAS,GAAG,OAAO,CACvB,GAAG,EAAE,CAAC,uBAAuB,CAAC,SAAS,EAAE,MAAM,IAAI,GAAG,CAAC,EACvD,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,CAAC,CACzB,CAAC;IACF,OAAO,CACL,KAAC,QAAQ,IAAC,QAAQ,EAAE,QAAQ,YAC1B,KAAC,SAAS,cAAE,QAAQ,GAAa,GACxB,CACZ,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,SAAS,CAAC"}
+{"version":3,"file":"Framework.js","sourceRoot":"","sources":["../../src/Framework.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAA0C,QAAQ,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAClF,OAAO,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AAUpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,KAKE,EACF,EAAE;IACF,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IACxD,oCAAoC;IACpC,MAAM,GAAG,GAAG,UAAU,EAAM,CAAC;IAC7B,MAAM,SAAS,GAAG,OAAO,CACvB,GAAG,EAAE,CAAC,uBAAuB,CAAC,SAAS,EAAE,MAAM,IAAI,GAAG,CAAC,EACvD,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,CAAC,CACzB,CAAC;IACF,OAAO,CACL,KAAC,QAAQ,IAAC,QAAQ,EAAE,QAAQ,YAC1B,KAAC,SAAS,cAAE,QAAQ,GAAa,GACxB,CACZ,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,SAAS,CAAC"}

package/dist/esm/app/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/esm/app/useAppProvider.js

@@ -1,7 +1,16 @@
 import { useFramework } from '../useFramework';
 /**
- * React Hook - get appProvider interface
- * @returns framework AppModule
+ * React hook that returns the App module provider from the framework.
+ *
+ * @returns The app module instance (`AppModule`) for querying and managing
+ *   application manifests and the currently active app.
+ * @throws {Error} If the `AppModule` is not configured in the framework.
+ *
+ * @example
+ * ```ts
+ * const provider = useAppProvider();
+ * provider.getAppManifests().subscribe(console.log);
+ * ```
  */
 export const useAppProvider = () => {
     const provider = useFramework().modules.app;

package/dist/esm/app/useAppProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAppProvider.js","sourceRoot":"","sources":["../../../src/app/useAppProvider.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAA8C,EAAE;IAC5E,MAAM,QAAQ,GAAG,YAAY,EAAe,CAAC,OAAO,CAAC,GAAG,CAAC;IACzD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,eAAe,cAAc,CAAC"}
+{"version":3,"file":"useAppProvider.js","sourceRoot":"","sources":["../../../src/app/useAppProvider.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAA8C,EAAE;IAC5E,MAAM,QAAQ,GAAG,YAAY,EAAe,CAAC,OAAO,CAAC,GAAG,CAAC;IACzD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/dist/esm/app/useApps.js

@@ -2,9 +2,23 @@ import { useObservableState } from '@equinor/fusion-observable/react';
 import { useMemo } from 'react';
 import { useAppProvider } from './useAppProvider';
 /**
- * React Hook - Get apps from framework
- * @param args Object with filterByCurrentUser: boolean
- * @returns Object {apps, isLoading, error} where apps is Array of ApplicationManifest, isLoading is a boolean on observable complete
+ * React hook that retrieves available application manifests from the framework.
+ *
+ * @param args - Optional filtering options.
+ * @param args.filterByCurrentUser - When `true`, only apps accessible to the
+ *   current user are returned.
+ * @returns An object containing:
+ *   - `apps` — Array of {@link AppManifest} objects, or `undefined` while loading.
+ *   - `isLoading` — `true` until the observable completes.
+ *   - `error` — Any error emitted by the underlying observable.
+ *
+ * @example
+ * ```tsx
+ * const { apps, isLoading, error } = useApps({ filterByCurrentUser: true });
+ * if (isLoading) return <Spinner />;
+ * return <AppList apps={apps} />;
+ * ```
+ *
  * @since 7.1.1
  */
 export const useApps = (args) => {

package/dist/esm/app/useApps.js.map

@@ -1 +1 @@
-{"version":3,"file":"useApps.js","sourceRoot":"","sources":["../../../src/app/useApps.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AASlD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,IAAkB,EACuD,EAAE;IAC3E,MAAM,QAAQ,GAAG,cAAc,EAAE,CAAC;IAElC,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IAE3C,MAAM,EACJ,KAAK,EAAE,IAAI,EACX,QAAQ,EACR,KAAK,GACN,GAAG,kBAAkB,CACpB,OAAO,CACL,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EACzF,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAChC,CACF,CAAC;IAEF,OAAO,EAAE,IAAI,EAAE,IAAiC,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC;AAClF,CAAC,CAAC;AAEF,eAAe,OAAO,CAAC"}
+{"version":3,"file":"useApps.js","sourceRoot":"","sources":["../../../src/app/useApps.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AASlD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,IAAkB,EACuD,EAAE;IAC3E,MAAM,QAAQ,GAAG,cAAc,EAAE,CAAC;IAElC,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IAE3C,MAAM,EACJ,KAAK,EAAE,IAAI,EACX,QAAQ,EACR,KAAK,GACN,GAAG,kBAAkB,CACpB,OAAO,CACL,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EACzF,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAChC,CACF,CAAC;IAEF,OAAO,EAAE,IAAI,EAAE,IAAiC,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC;AAClF,CAAC,CAAC;AAEF,eAAe,OAAO,CAAC"}

package/dist/esm/app/useCurrentApp.js

@@ -2,12 +2,33 @@ import { useMemo } from 'react';
 import { useObservableState } from '@equinor/fusion-observable/react';
 import { useFramework } from '../useFramework';
 /**
- * Observers the stream of current app and return the latest application
+ * React hook that observes and returns the currently active application.
  *
- * __Warning:__ type hint templates are only hints, this does not check if the modules are actually enabled!
+ * @remarks
+ * Subscribes to the `current$` stream on the App module and returns the
+ * latest value together with helpers to change or clear the active app.
  *
- * @template TModule type hint modules which the application has configured
- * @template TEnv type hint what kind of environment config the application has
+ * **Warning:** The template parameters are compile-time hints only — the
+ * hook does not validate that the specified modules are actually enabled.
+ *
+ * @template TModules - Tuple of module types the current app is expected to
+ *   have configured (type-hint only).
+ * @template TEnv - Expected environment configuration shape (type-hint only).
+ *
+ * @returns An object containing:
+ *   - `currentApp` — The current {@link CurrentApp} instance, `null` when
+ *     explicitly cleared, or `undefined` while loading.
+ *   - `setCurrentApp(appKey)` — Sets the active app by its key.
+ *   - `clearCurrentApp()` — Clears the currently active app.
+ *   - `error` — Any error emitted by the observable.
+ *
+ * @throws {Error} If the `AppModule` is not configured in the framework.
+ *
+ * @example
+ * ```tsx
+ * const { currentApp, setCurrentApp } = useCurrentApp();
+ * return <button onClick={() => setCurrentApp('my-app')}>{currentApp?.manifest?.name}</button>;
+ * ```
  */
 export const useCurrentApp = () => {
     const provider = useFramework().modules.app;

package/dist/esm/app/useCurrentApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"useCurrentApp.js","sourceRoot":"","sources":["../../../src/app/useCurrentApp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAStE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,GAQ3B,EAAE;IACF,MAAM,QAAQ,GAAG,YAAY,EAAe,CAAC,OAAO,CAAC,GAAG,CAAC;IACzD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACtE,CAAC;IACD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,kBAAkB,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACxF,OAAO;QACL,UAAU,EAAE,KAAmC;QAC/C,aAAa,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;QAC/E,eAAe,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;QACnF,KAAK;KACN,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC"}
+{"version":3,"file":"useCurrentApp.js","sourceRoot":"","sources":["../../../src/app/useCurrentApp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAStE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,GAQ3B,EAAE;IACF,MAAM,QAAQ,GAAG,YAAY,EAAe,CAAC,OAAO,CAAC,GAAG,CAAC;IACzD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACtE,CAAC;IACD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,kBAAkB,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACxF,OAAO;QACL,UAAU,EAAE,KAAmC;QAC/C,aAAa,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;QAC/E,eAAe,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;QACnF,KAAK;KACN,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/esm/app/useCurrentAppModule.js

@@ -1,13 +1,19 @@
 import useCurrentAppModules from './useCurrentAppModules';
 /**
- * Retrieves the current app module based on the provided module key.
- * @template TType - The type of the module.
- * @template TKey - The type of the module key.
- * @param {TKey} moduleKey - The key of the module to retrieve.
- * @returns {AnyModule | null | undefined} - The current app module or null if not found.
+ * React hook that retrieves a specific module from the current application.
+ *
+ * @template TType - The expected module type.
+ * @template TKey - The module key used for look-up.
+ * @param moduleKey - The key of the module to retrieve.
+ * @returns An object containing:
+ *   - `module` — The resolved module instance, `null` when no app is
+ *     selected, or `undefined` if the app does not enable the requested module.
+ *   - `error` — Any error emitted during initialisation.
+ *   - `complete` — `true` when the observable has completed.
+ *
  * @remarks
- *  - when module is null, there are no current selected application
- *  - when undefined is, the application has not enabled the requested module
+ * - A `null` value means no application is currently selected.
+ * - An `undefined` value means the application has not enabled the requested module.
  */
 export const useCurrentAppModule = (moduleKey) => {
     const { modules, error, complete } = useCurrentAppModules();

package/dist/esm/app/useCurrentAppModule.js.map

@@ -1 +1 @@
-{"version":3,"file":"useCurrentAppModule.js","sourceRoot":"","sources":["../../../src/app/useCurrentAppModule.ts"],"names":[],"mappings":"AAOA,OAAO,oBAAoB,MAAM,wBAAwB,CAAC;AAE1D;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAIjC,SAAe,EASf,EAAE;IACF,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,oBAAoB,EAAE,CAAC;IAC5D,MAAM,MAAM,GACV,OAAO,KAAK,IAAI;QACd,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,OAAO,KAAK,SAAS;YACrB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,8DAA8D;gBAC7D,OAAO,CAAC,SAAiC,CAAS,CAAC;IAC5D,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AACrC,CAAC,CAAC;AAEF,eAAe,mBAAmB,CAAC"}
+{"version":3,"file":"useCurrentAppModule.js","sourceRoot":"","sources":["../../../src/app/useCurrentAppModule.ts"],"names":[],"mappings":"AAOA,OAAO,oBAAoB,MAAM,wBAAwB,CAAC;AAE1D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAIjC,SAAe,EASf,EAAE;IACF,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,oBAAoB,EAAE,CAAC;IAC5D,MAAM,MAAM,GACV,OAAO,KAAK,IAAI;QACd,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,OAAO,KAAK,SAAS;YACrB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,8DAA8D;gBAC7D,OAAO,CAAC,SAAiC,CAAS,CAAC;IAC5D,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AACrC,CAAC,CAAC;AAEF,eAAe,mBAAmB,CAAC"}

package/dist/esm/app/useCurrentAppModules.js

@@ -3,12 +3,22 @@ import useCurrentApp from './useCurrentApp';
 import { of } from 'rxjs';
 import { useObservableState } from '@equinor/fusion-observable/react';
 /**
- * Observers the stream of current app initialized modules
+ * React hook that observes the initialised modules of the current application.
  *
- * __Warning:__ type hint templates are only hints, this does not check if the modules are actually enabled!
+ * @remarks
+ * Subscribes to the `instance$` stream of the current app and returns the
+ * resolved module instances.
  *
- * @template TModule type hint modules which the application has configured
- * @returns the observable instance of initialized modules of the application
+ * **Warning:** The template parameter is a compile-time hint only — the
+ * hook does not validate that the specified modules are actually enabled.
+ *
+ * @template TModules - Tuple of module types expected on the current app
+ *   (type-hint only).
+ * @returns An object containing:
+ *   - `modules` — The initialised {@link AppModulesInstance}, `null` when no
+ *     app is selected, or `undefined` while loading.
+ *   - `error` — Any error emitted during initialisation.
+ *   - `complete` — `true` when the observable has completed.
  */
 export const useCurrentAppModules = () => {
     const { currentApp, error: appError } = useCurrentApp();

package/dist/esm/app/useCurrentAppModules.js.map

@@ -1 +1 @@
-{"version":3,"file":"useCurrentAppModules.js","sourceRoot":"","sources":["../../../src/app/useCurrentAppModules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EAAmB,EAAE,EAAE,MAAM,MAAM,CAAC;AAE3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAEtE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAIlC,EAAE;IACF,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,aAAa,EAAY,CAAC;IAClE,MAAM,QAAQ,GAAG,OAAO,CACtB,GAAG,EAAE,CACH,UAAU,CAAC,CAAC,CAAE,UAAU,CAAC,SAAsD,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAC5F,CAAC,UAAU,CAAC,CACb,CAAC;IACF,MAAM,EACJ,KAAK,EAAE,OAAO,EACd,KAAK,EACL,QAAQ,GACT,GAAG,kBAAkB,CAAC,QAAQ,EAAE;QAC/B,OAAO,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,QAAQ,IAAI,IAAI,CAAC;KAC/E,CAAC,CAAC;IACH,OAAO;QACL,OAAO;QACP,KAAK,EAAE,KAAK,IAAI,QAAQ;QACxB,QAAQ;KACT,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"useCurrentAppModules.js","sourceRoot":"","sources":["../../../src/app/useCurrentAppModules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EAAmB,EAAE,EAAE,MAAM,MAAM,CAAC;AAE3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAEtE;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAIlC,EAAE;IACF,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,aAAa,EAAY,CAAC;IAClE,MAAM,QAAQ,GAAG,OAAO,CACtB,GAAG,EAAE,CACH,UAAU,CAAC,CAAC,CAAE,UAAU,CAAC,SAAsD,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAC5F,CAAC,UAAU,CAAC,CACb,CAAC;IACF,MAAM,EACJ,KAAK,EAAE,OAAO,EACd,KAAK,EACL,QAAQ,GACT,GAAG,kBAAkB,CAAC,QAAQ,EAAE;QAC/B,OAAO,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,QAAQ,IAAI,IAAI,CAAC;KAC/E,CAAC,CAAC;IACH,OAAO;QACL,OAAO;QACP,KAAK,EAAE,KAAK,IAAI,QAAQ;QACxB,QAAQ;KACT,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/esm/context/index.js

@@ -1,3 +1,13 @@
+/**
+ * Context React hooks.
+ *
+ * @remarks
+ * Available via the `@equinor/fusion-framework-react/context` sub-entry-point.
+ * Re-exports the context module’s React API and adds a convenience
+ * `useCurrentContext` hook that resolves the module from the framework.
+ *
+ * @module
+ */
 export * from '@equinor/fusion-framework-react-module-context';
 export { useCurrentContext } from './useCurrentContext';
 //# sourceMappingURL=index.js.map

package/dist/esm/context/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/context/index.ts"],"names":[],"mappings":"AAAA,cAAc,gDAAgD,CAAC;AAE/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/context/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,cAAc,gDAAgD,CAAC;AAE/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/esm/context/useCurrentContext.js

@@ -1,5 +1,21 @@
 import { useCurrentContext as _useCurrentContext } from '@equinor/fusion-framework-react-module-context';
 import { useFramework } from '../useFramework';
+/**
+ * React hook that returns the currently selected Fusion context.
+ *
+ * @remarks
+ * This is a convenience wrapper that resolves the context module from the
+ * framework instance and delegates to the underlying
+ * `useCurrentContext` hook from `@equinor/fusion-framework-react-module-context`.
+ *
+ * @returns The current context state as defined by the context module.
+ *
+ * @example
+ * ```ts
+ * const { currentContext } = useCurrentContext();
+ * console.log(currentContext?.id);
+ * ```
+ */
 export const useCurrentContext = () => _useCurrentContext(useFramework().modules.context);
 export default useCurrentContext;
 //# sourceMappingURL=useCurrentContext.js.map

package/dist/esm/context/useCurrentContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"useCurrentContext.js","sourceRoot":"","sources":["../../../src/context/useCurrentContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AACzG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAE1F,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"useCurrentContext.js","sourceRoot":"","sources":["../../../src/context/useCurrentContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AACzG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAE1F,eAAe,iBAAiB,CAAC"}

package/dist/esm/context.js

@@ -1,4 +1,13 @@
 import { createContext } from 'react';
+/**
+ * Internal React context that holds the current {@link Fusion} instance.
+ *
+ * @remarks
+ * Consumers should not use this directly — prefer the {@link useFramework}
+ * hook or the {@link FrameworkProvider} component.
+ *
+ * @internal
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const context = createContext(null);
 /**

package/dist/esm/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAGtC,8DAA8D;AAC9D,MAAM,CAAC,MAAM,OAAO,GAAG,aAAa,CAAqB,IAAI,CAAC,CAAC;AAE/D;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,OAAO,CAAC,QAAQ,CAAC"}
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAGtC;;;;;;;;GAQG;AACH,8DAA8D;AAC9D,MAAM,CAAC,MAAM,OAAO,GAAG,aAAa,CAAqB,IAAI,CAAC,CAAC;AAE/D;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,OAAO,CAAC,QAAQ,CAAC"}

package/dist/esm/create-framework-provider.js

@@ -5,20 +5,41 @@ import { FrameworkConfigurator } from '@equinor/fusion-framework';
 import { FrameworkProvider } from './context';
 import { ModuleProvider } from '@equinor/fusion-framework-react-module';
 /**
- * Create a framework provider for react.
+ * Creates a lazy-loaded React component that initialises a Fusion Framework
+ * instance and exposes it via context providers.
  *
- * This function is for providers of framework, like a portal.
+ * @remarks
+ * This is the low-level factory used by the {@link Framework} component.
+ * Call it when you need fine-grained control over memoisation or when you
+ * want to embed the provider in a custom `<Suspense>` boundary.
+ *
+ * The returned component is created with `React.lazy`, so it **must** be
+ * rendered inside a `<Suspense>` boundary.
+ *
+ * @template TModules - Tuple of additional module types to register.
+ * @template TRef - Type of the optional parent module-instance reference.
+ *
+ * @param cb - Callback that receives a {@link FrameworkConfigurator} (and an
+ *   optional parent ref) for registering modules and configuration.
+ * @param ref - Optional parent module instance to inherit configuration from.
+ * @returns A `React.lazy` component that provides the initialised framework
+ *   to its children.
  *
- * @param configurator - callback for configuring modules
  * @example
  * ```tsx
- * const config: FrameworkConfigurator = (config) => {}
+ * import { createFrameworkProvider } from '@equinor/fusion-framework-react';
+ *
  * const Portal = () => {
- *   const Framework = createFrameworkProvider(config);
+ *   const FrameworkProvider = createFrameworkProvider((config) => {
+ *     config.http.configureClient('my-api', { baseUri: 'https://api.example.com' });
+ *   });
+ *
  *   return (
- *      <Suspense fallback={<span>loading...</span>}>
- *          <Framework>{children}</Framework>
- *      </Suspense>
+ *     <Suspense fallback={<span>Loading…</span>}>
+ *       <FrameworkProvider>
+ *         <App />
+ *       </FrameworkProvider>
+ *     </Suspense>
  *   );
  * };
  * ```