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

package/dist/esm/context.js

@@ -1,23 +1,13 @@
 import { createContext } from 'react';
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const context = createContext(null);
 /**
- * Component for providing framework.
+ * Internal React context that holds the current {@link Fusion} instance.
  *
  * @remarks
- * Should be created by {@link createFrameworkProvider}
+ * Consumers should not use this directly — prefer the {@link useFramework}
+ * hook or the {@link FrameworkProvider} component.
  *
- * @example
- * ```tsx
- * import {FrameworkProvider} from '@equinor/fusion-framework-react';
- * export const Component = (args: React.PropsWithChildren<{framework: Fusion}>) => {
- *   return (
- *      <FrameworkProvider value={args.framework}>
- *        {args.children}
- *      </FrameworkProvider>
- *   );
- * }
- * ```
+ * @internal
  */
-export const FrameworkProvider = context.Provider;
+// biome-ignore lint/suspicious/noExplicitAny: `Fusion<any>` widens the context to accept a Fusion instance with any concrete module set
+export const context = createContext(null);
 //# sourceMappingURL=context.js.map

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,wIAAwI;AACxI,MAAM,CAAC,MAAM,OAAO,GAAG,aAAa,CAAqB,IAAI,CAAC,CAAC"}

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

@@ -2,23 +2,44 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import { lazy } from 'react';
 import initFusion from '@equinor/fusion-framework';
 import { FrameworkConfigurator } from '@equinor/fusion-framework';
-import { FrameworkProvider } from './context';
+import { FrameworkProvider } from './framework-provider';
 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>
  *   );
  * };
  * ```

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

@@ -1 +1 @@
-{"version":3,"file":"create-framework-provider.js","sourceRoot":"","sources":["../../src/create-framework-provider.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,UAAU,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAE9C,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AAExE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAKrC,EAAuF,EACvF,GAAU,EAC4E,EAAE,CACxF,IAAI,CAAC,KAAK,IAAI,EAAE;IACd,MAAM,YAAY,GAAG,IAAI,qBAAqB,EAAY,CAAC;IAC3D,MAAM,EAAE,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAC5B,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IACtD,OAAO;QACL,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAkC,EAAE,EAAE,CAAC,CACzD,KAAC,iBAAiB,IAAC,KAAK,EAAE,SAAS,YACjC,KAAC,cAAc,IAAC,KAAK,EAAE,SAAS,CAAC,OAAO,YAAG,QAAQ,GAAkB,GACnD,CACrB;KACF,CAAC;AACJ,CAAC,CAAC,CAAC"}
+{"version":3,"file":"create-framework-provider.js","sourceRoot":"","sources":["../../src/create-framework-provider.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,UAAU,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAKrC,EAAuF,EACvF,GAAU,EAC4E,EAAE,CACxF,IAAI,CAAC,KAAK,IAAI,EAAE;IACd,MAAM,YAAY,GAAG,IAAI,qBAAqB,EAAY,CAAC;IAC3D,MAAM,EAAE,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAC5B,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IACtD,OAAO;QACL,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAkC,EAAE,EAAE,CAAC,CACzD,KAAC,iBAAiB,IAAC,KAAK,EAAE,SAAS,YACjC,KAAC,cAAc,IAAC,KAAK,EAAE,SAAS,CAAC,OAAO,YAAG,QAAQ,GAAkB,GACnD,CACrB;KACF,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/esm/feature-flag/index.js

@@ -1,3 +1,13 @@
+/**
+ * Feature-flag React hooks.
+ *
+ * @remarks
+ * Available via the `@equinor/fusion-framework-react/feature-flag` sub-entry-point.
+ * Provides hooks to read, toggle, and observe feature flags at the
+ * framework or application level.
+ *
+ * @module
+ */
 export { useFeature } from './useFeature';
 export { useFeatures } from './useFeatures';
 export { useCurrentAppFeatures } from './useCurrentAppFeatures';

package/dist/esm/feature-flag/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/feature-flag/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/feature-flag/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/esm/feature-flag/useCurrentAppFeatures.js

@@ -1,8 +1,18 @@
 import { useCurrentAppModule } from '../app';
 import { useFeatures } from './useFeatures';
 /**
- * Custom hook that returns the current app features and provides a function to toggle a feature.
- * @returns An object containing the current app features, a function to toggle a feature, and any error that occurred.
+ * React hook that returns feature flags registered on the current application.
+ *
+ * @returns A {@link UseFeaturesResult} containing:
+ *   - `features` — Array of feature flags for the current app.
+ *   - `toggleFeature(key, enable?)` — Toggles a feature flag on or off.
+ *   - `error` — Any error from the feature-flag or app-module streams.
+ *
+ * @example
+ * ```ts
+ * const { features, toggleFeature } = useCurrentAppFeatures();
+ * toggleFeature('dark-mode', true);
+ * ```
  */
 export const useCurrentAppFeatures = () => {
     const { module, error: moduleError } = useCurrentAppModule('featureFlag');

package/dist/esm/feature-flag/useCurrentAppFeatures.js.map

@@ -1 +1 @@
-{"version":3,"file":"useCurrentAppFeatures.js","sourceRoot":"","sources":["../../../src/feature-flag/useCurrentAppFeatures.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EAAE,WAAW,EAA0B,MAAM,eAAe,CAAC;AAEpE;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAsB,EAAE;IAC3D,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,mBAAmB,CAAoB,aAAa,CAAC,CAAC;IAE7F,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAE/D,OAAO;QACL,QAAQ;QACR,aAAa;QACb,KAAK,EAAE,KAAK,IAAI,WAAW;KAC5B,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"useCurrentAppFeatures.js","sourceRoot":"","sources":["../../../src/feature-flag/useCurrentAppFeatures.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EAAE,WAAW,EAA0B,MAAM,eAAe,CAAC;AAEpE;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAsB,EAAE;IAC3D,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,mBAAmB,CAAoB,aAAa,CAAC,CAAC;IAE7F,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAE/D,OAAO;QACL,QAAQ;QACR,aAAa;QACb,KAAK,EAAE,KAAK,IAAI,WAAW;KAC5B,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/feature-flag/useFeature.js

@@ -3,15 +3,25 @@ import { EMPTY } from 'rxjs';
 import { useObservableState } from '@equinor/fusion-observable/react';
 import { findFeature } from '@equinor/fusion-framework-module-feature-flag/selectors';
 /**
- * Custom hook that retrieves a feature flag from a feature flag provider.
+ * React hook that retrieves and manages a single feature flag.
  *
- * @template T - The type of the feature flag value.
- * @param {IFeatureFlagProvider} provider - The feature flag provider.
- * @param {string} key - The key of the feature flag.
- * @returns {UseFeatureResult<T>} - An object containing the feature flag value, a function to toggle the feature flag, and any error that occurred.
+ * @template T - Value type carried by the feature flag.
+ * @param provider - The feature-flag provider instance.
+ * @param key - Unique key identifying the feature flag.
+ * @returns A {@link UseFeatureResult} with the flag value, toggle helper,
+ *   and any error.
+ *
+ * @example
+ * ```ts
+ * const { feature, toggleFeature } = useFeature(provider, 'dark-mode');
+ * console.log(feature?.enabled);
+ * ```
  */
 export const useFeature = (provider, key) => {
-    const feature$ = useMemo(() => provider.features$.pipe(findFeature(key)), [provider, key]);
+    // Narrow the features stream down to just the one matching feature by key.
+    const feature$ = useMemo(() => provider.features$
+        // Keep the observable scoped to the requested feature key.
+        .pipe(findFeature(key)), [provider, key]);
     const { value: feature, error } = useObservableState(feature$ ?? EMPTY);
     const toggleFeature = useCallback((enable) => {
         const enabled = enable === undefined ? !provider.getFeature(key)?.enabled : enable;

package/dist/esm/feature-flag/useFeature.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFeature.js","sourceRoot":"","sources":["../../../src/feature-flag/useFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAE7C,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAO7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAEtE,OAAO,EAAE,WAAW,EAAE,MAAM,yDAAyD,CAAC;AAWtF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,QAA8B,EAC9B,GAAW,EACU,EAAE;IACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAI,GAAG,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;IAC9F,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,kBAAkB,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC;IACxE,MAAM,aAAa,GAAG,WAAW,CAC/B,CAAC,MAAgB,EAAE,EAAE;QACnB,MAAM,OAAO,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QACnF,QAAQ,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3C,CAAC,EACD,CAAC,QAAQ,EAAE,GAAG,CAAC,CAChB,CAAC;IACF,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;AAC3C,CAAC,CAAC;AAEF,eAAe,UAAU,CAAC"}
+{"version":3,"file":"useFeature.js","sourceRoot":"","sources":["../../../src/feature-flag/useFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAE7C,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAO7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAEtE,OAAO,EAAE,WAAW,EAAE,MAAM,yDAAyD,CAAC;AAqBtF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,QAA8B,EAC9B,GAAW,EACU,EAAE;IACvB,2EAA2E;IAC3E,MAAM,QAAQ,GAAG,OAAO,CACtB,GAAG,EAAE,CACH,QAAQ,CAAC,SAAS;QAChB,2DAA2D;SAC1D,IAAI,CAAC,WAAW,CAAI,GAAG,CAAC,CAAC,EAC9B,CAAC,QAAQ,EAAE,GAAG,CAAC,CAChB,CAAC;IACF,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,kBAAkB,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC;IACxE,MAAM,aAAa,GAAG,WAAW,CAC/B,CAAC,MAAgB,EAAE,EAAE;QACnB,MAAM,OAAO,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QACnF,QAAQ,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3C,CAAC,EACD,CAAC,QAAQ,EAAE,GAAG,CAAC,CAChB,CAAC;IACF,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;AAC3C,CAAC,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/esm/feature-flag/useFeatures.js

@@ -3,12 +3,21 @@ import { of } from 'rxjs';
 import { map } from 'rxjs/operators';
 import { useObservableState } from '@equinor/fusion-observable/react';
 /**
- * Custom hook that provides access to the feature flags and their values.
+ * React hook that returns all feature flags from a provider, with optional
+ * filtering.
  *
- * @param provider - The feature flag provider.
- * @param selector - Optional function to filter the feature flags.
- * @returns An object containing the features, any error that occurred while retrieving them, and a function to set the enabled state of a feature flag.
- * @throws Error if the feature flag provider is missing.
+ * @param provider - The feature-flag provider instance, or `null`/`undefined`
+ *   when not yet available.
+ * @param selector - Optional predicate to filter the feature flags.
+ * @returns A {@link UseFeaturesResult} with the flags, a toggle helper,
+ *   and any error.
+ * @throws {Error} If `toggleFeature` is called when the provider is missing.
+ *
+ * @example
+ * ```ts
+ * const { features, toggleFeature } = useFeatures(provider);
+ * toggleFeature('beta', true);
+ * ```
  */
 export const useFeatures = (provider, selector) => {
     /**
@@ -17,10 +26,18 @@ export const useFeatures = (provider, selector) => {
      * @returns An object containing the features and any error that occurred while retrieving them.
      */
     const { value: features, error } = useObservableState(useMemo(() => {
+        // Only compute the feature list when a provider is available; otherwise there's nothing to observe
         if (provider) {
+            // Map the feature dictionary to a list, optionally narrowed by the caller-provided selector
             return provider?.features$.pipe(map((x) => {
                 const values = Object.values(x);
-                return selector ? values.filter(selector) : values;
+                // Return everything when no selector is provided
+                if (!selector) {
+                    return values;
+                }
+                // Apply the caller-provided selector to narrow down the feature list
+                const filtered = values.filter(selector);
+                return filtered;
             }));
         }
         return of([]);
@@ -33,6 +50,7 @@ export const useFeatures = (provider, selector) => {
      * @throws Error if IFeatureFlagProvider is missing.
      */
     const toggleFeature = useCallback((key, enable) => {
+        // Cannot toggle a feature without a provider to persist the change
         if (!provider) {
             throw new Error('Missing IFeatureFlagProvider.');
         }

package/dist/esm/feature-flag/useFeatures.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFeatures.js","sourceRoot":"","sources":["../../../src/feature-flag/useFeatures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAE7C,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAC1B,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AASrC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAYtE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,QAAsC,EACtC,QAA4B,EACT,EAAE;IACrB;;;;OAIG;IACH,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,kBAAkB,CACnD,OAAO,CAAC,GAAG,EAAE;QACX,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,QAAQ,EAAE,SAAS,CAAC,IAAI,CAC7B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACR,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAChC,OAAO,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YACrD,CAAC,CAAC,CACH,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EACxB,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,IAAI,EAAE,CAAC,EAAE,CACrD,CAAC;IACF;;;;;;OAMG;IACH,MAAM,aAAa,GAAG,WAAW,CAC/B,CAAC,GAAW,EAAE,MAAgB,EAAE,EAAE;QAChC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAEnF,QAAQ,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3C,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IACF,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;AAC5C,CAAC,CAAC;AAEF,eAAe,WAAW,CAAC"}
+{"version":3,"file":"useFeatures.js","sourceRoot":"","sources":["../../../src/feature-flag/useFeatures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAE7C,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAC1B,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AASrC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAoBtE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,QAAsC,EACtC,QAA4B,EACT,EAAE;IACrB;;;;OAIG;IACH,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,kBAAkB,CACnD,OAAO,CAAC,GAAG,EAAE;QACX,mGAAmG;QACnG,IAAI,QAAQ,EAAE,CAAC;YACb,4FAA4F;YAC5F,OAAO,QAAQ,EAAE,SAAS,CAAC,IAAI,CAC7B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACR,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAChC,iDAAiD;gBACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,OAAO,MAAM,CAAC;gBAChB,CAAC;gBACD,qEAAqE;gBACrE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACzC,OAAO,QAAQ,CAAC;YAClB,CAAC,CAAC,CACH,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EACxB,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,IAAI,EAAE,CAAC,EAAE,CACrD,CAAC;IACF;;;;;;OAMG;IACH,MAAM,aAAa,GAAG,WAAW,CAC/B,CAAC,GAAW,EAAE,MAAgB,EAAE,EAAE;QAChC,mEAAmE;QACnE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAEnF,QAAQ,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3C,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IACF,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;AAC5C,CAAC,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/dist/esm/feature-flag/useFrameworkFeature.js

@@ -1,15 +1,23 @@
 import { useFrameworkModule } from '../useFrameworkModule';
 import { useFeature } from './useFeature';
 /**
- * Custom hook that allows accessing a framework feature based on a given feature flag key.
+ * React hook that retrieves a single feature flag from the **framework-level**
+ * feature-flag provider.
  *
- * @template T - The type of the feature.
- * @param {string} key - The feature flag key.
- * @returns {ReturnType<typeof useFeature<T>>} - The result of the feature hook.
- * @throws {Error} - If feature flagging is not enabled in the framework.
+ * @template T - Value type carried by the feature flag.
+ * @param key - Unique key identifying the feature flag.
+ * @returns A {@link UseFeatureResult} with the flag value, toggle helper,
+ *   and any error.
+ * @throws {Error} If the `FeatureFlagModule` is not enabled in the framework.
+ *
+ * @example
+ * ```ts
+ * const { feature, toggleFeature } = useFrameworkFeature('experimental-ui');
+ * ```
  */
 export const useFrameworkFeature = (key) => {
     const provider = useFrameworkModule('featureFlag');
+    // Fail fast when the FeatureFlagModule has not been enabled on the framework
     if (!provider) {
         throw Error('Feature flagging is not enabled in the framework');
     }

package/dist/esm/feature-flag/useFrameworkFeature.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFrameworkFeature.js","sourceRoot":"","sources":["../../../src/feature-flag/useFrameworkFeature.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAI,GAAW,EAAoC,EAAE;IACtF,MAAM,QAAQ,GAAG,kBAAkB,CAAoB,aAAa,CAAC,CAAC;IACtE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,kDAAkD,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,eAAe,mBAAmB,CAAC"}
+{"version":3,"file":"useFrameworkFeature.js","sourceRoot":"","sources":["../../../src/feature-flag/useFrameworkFeature.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAI,GAAW,EAAoC,EAAE;IACtF,MAAM,QAAQ,GAAG,kBAAkB,CAAoB,aAAa,CAAC,CAAC;IACtE,6EAA6E;IAC7E,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,kDAAkD,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,eAAe,mBAAmB,CAAC"}

package/dist/esm/feature-flag/useFrameworkFeatures.js

@@ -1,13 +1,21 @@
 import { useFrameworkModule } from '../useFrameworkModule';
 import { useFeatures } from './useFeatures';
 /**
- * Custom hook that provides access to framework-specific feature flags.
- * It returns the result of the `useFeatures` hook from the `featureFlag` module.
- * @returns The result of the `useFeatures` hook.
- * @throws Error if feature flagging is not enabled in the framework.
+ * React hook that returns all feature flags from the **framework-level**
+ * feature-flag provider.
+ *
+ * @returns A {@link UseFeaturesResult} containing all framework feature flags,
+ *   a toggle helper, and any error.
+ * @throws {Error} If the `FeatureFlagModule` is not enabled in the framework.
+ *
+ * @example
+ * ```ts
+ * const { features, toggleFeature } = useFrameworkFeatures();
+ * ```
  */
 export const useFrameworkFeatures = () => {
     const provider = useFrameworkModule('featureFlag');
+    // Fail fast when the FeatureFlagModule has not been enabled on the framework
     if (!provider) {
         throw Error('Feature flagging is not enabled in the framework');
     }

package/dist/esm/feature-flag/useFrameworkFeatures.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFrameworkFeatures.js","sourceRoot":"","sources":["../../../src/feature-flag/useFrameworkFeatures.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAmC,EAAE;IACvE,MAAM,QAAQ,GAAG,kBAAkB,CAAoB,aAAa,CAAC,CAAC;IACtE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,kDAAkD,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"useFrameworkFeatures.js","sourceRoot":"","sources":["../../../src/feature-flag/useFrameworkFeatures.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAmC,EAAE;IACvE,MAAM,QAAQ,GAAG,kBAAkB,CAAoB,aAAa,CAAC,CAAC;IACtE,6EAA6E;IAC7E,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,kDAAkD,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/esm/framework-provider.js

@@ -0,0 +1,21 @@
+import { context } from './context';
+/**
+ * Component for providing framework.
+ *
+ * @remarks
+ * Should be created by {@link createFrameworkProvider}
+ *
+ * @example
+ * ```tsx
+ * import {FrameworkProvider} from '@equinor/fusion-framework-react';
+ * export const Component = (args: React.PropsWithChildren<{framework: Fusion}>) => {
+ *   return (
+ *      <FrameworkProvider value={args.framework}>
+ *        {args.children}
+ *      </FrameworkProvider>
+ *   );
+ * }
+ * ```
+ */
+export const FrameworkProvider = context.Provider;
+//# sourceMappingURL=framework-provider.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"framework-provider.js","sourceRoot":"","sources":["../../src/framework-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,OAAO,CAAC,QAAQ,CAAC"}

package/dist/esm/hooks/index.js

@@ -1,3 +1,11 @@
-export { useCurrentUser } from './use-current-user';
-export { useHttpClient } from './use-http-client';
+/**
+ * Convenience hooks for common framework operations.
+ *
+ * @remarks
+ * Available via the `@equinor/fusion-framework-react/hooks` sub-entry-point.
+ *
+ * @module
+ */
+export { useCurrentUser } from './useCurrentUser';
+export { useHttpClient } from './useHttpClient';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/esm/hooks/useCurrentUser.js

@@ -0,0 +1,20 @@
+import { useFramework } from '../useFramework';
+/**
+ * React hook that returns the currently authenticated user's account info.
+ *
+ * @returns The {@link AccountInfo} of the signed-in user, or `undefined` if
+ *   no user is authenticated.
+ *
+ * @example
+ * ```tsx
+ * const UserGreeting = () => {
+ *   const user = useCurrentUser();
+ *   return <span>Hello, {user?.name ?? 'Guest'}</span>;
+ * };
+ * ```
+ */
+export const useCurrentUser = () => {
+    const framework = useFramework();
+    return framework.modules.auth.account || undefined;
+};
+//# sourceMappingURL=useCurrentUser.js.map

package/dist/esm/hooks/useCurrentUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCurrentUser.js","sourceRoot":"","sources":["../../../src/hooks/useCurrentUser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAA4B,EAAE;IAC1D,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;IACjC,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,SAAS,CAAC;AACrD,CAAC,CAAC"}

package/dist/esm/hooks/useHttpClient.js

@@ -0,0 +1,28 @@
+import { useMemo } from 'react';
+import { useFramework } from '../useFramework';
+/**
+ * React hook that returns a pre-configured HTTP client from the framework.
+ *
+ * @param name - Key of the HTTP client to retrieve (e.g. `'portal'` or `'people'`).
+ * @returns The resolved {@link HttpClient} instance.
+ * @throws {Error} If no client is configured for the given key.
+ *
+ * @example
+ * ```ts
+ * const client = useHttpClient('portal');
+ * client.fetch('/api/data').subscribe(console.log);
+ * ```
+ */
+export const useHttpClient = (name) => {
+    const framework = useFramework();
+    const client = useMemo(() => {
+        // Reuse an already-configured client for this key when one exists
+        if (framework.modules.http.hasClient(name)) {
+            return framework.modules.http.createClient(name);
+        }
+        throw Error(`no configured client for key [${name}]`);
+    }, [framework, name]);
+    // TODO(#5085): abort on unmount?
+    return client;
+};
+//# sourceMappingURL=useHttpClient.js.map

package/dist/esm/hooks/useHttpClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHttpClient.js","sourceRoot":"","sources":["../../../src/hooks/useHttpClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAQ/C;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAyB,EAAc,EAAE;IACrE,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;IAEjC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE;QAC1B,kEAAkE;QAClE,IAAI,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,KAAK,CAAC,iCAAiC,IAAI,GAAG,CAAC,CAAC;IACxD,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IACtB,iCAAiC;IACjC,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/dist/esm/http/index.js

@@ -1,3 +1,13 @@
-export { useHttpClient as useFrameworkHttpClient } from '../hooks/use-http-client';
+/**
+ * HTTP sub-entry-point (`@equinor/fusion-framework-react/http`).
+ *
+ * @remarks
+ * Re-exports the framework-level {@link useHttpClient} hook as
+ * `useFrameworkHttpClient` together with all exports from the
+ * standalone HTTP React module.
+ *
+ * @module
+ */
+export { useHttpClient as useFrameworkHttpClient } from '../hooks/useHttpClient';
 export * from '@equinor/fusion-framework-react-module-http';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/http/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,IAAI,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEnF,cAAc,6CAA6C,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/http/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,aAAa,IAAI,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAEjF,cAAc,6CAA6C,CAAC"}

package/dist/esm/index.js

@@ -1,10 +1,18 @@
 /**
+ * React bindings for the Fusion Framework.
+ *
+ * @remarks
+ * This package provides React components, context providers, and hooks for
+ * initialising and consuming a Fusion Framework instance inside a React
+ * application tree. It is the main entry-point for portals and host
+ * applications that need to bootstrap the framework with React.
+ *
  * [[include:framework-react/README.MD]]
  * @module
  */
 export { FusionConfigurator } from '@equinor/fusion-framework';
 export { createFrameworkProvider } from './create-framework-provider';
-export { FrameworkProvider } from './context';
+export { FrameworkProvider } from './framework-provider';
 export { useFramework } from './useFramework';
 export { useFrameworkModule } from './useFrameworkModule';
 export { default, Framework } from './Framework';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/dist/esm/signalr/index.js

@@ -1,32 +1,2 @@
-import { useFramework } from '../useFramework';
-import { useProviderTopic, } from '@equinor/fusion-framework-react-module-signalr';
-/**
- * hook for subscribing to a topic of a SignalR hub
- *
- * @example
- ```ts
-// config.ts
-import {enableSignalR} from '@equinor/fusion-framework-react-module-signalr';
-(configurator) => enableSignalR(configurator, 'notifications');
-
-// myHook.ts
-const myHook = () => {
-    const topic = useSignalR('notifications', 'foo');
-    return useObservableState(topic).next;
-}
- ```
- *
- * @see {@link [module signalr](https://equinor.github.io/fusion-framework/modules/signalr)}
- *
- * @param hubId identifier of connection hub (must be configured)
- * @param topicId identifier of topic to connect to
- * @returns Topic
- */
-export const useSignalR = (hubId, topicId) => {
-    const provider = useFramework().modules.signalR;
-    if (!provider) {
-        throw Error('SignalR is not configured, see @equinor/fusion-framework-react-module-signalr');
-    }
-    return useProviderTopic(provider, hubId, topicId);
-};
+export { useSignalR } from './useSignalR.js';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/signalr/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,OAAO,EAEL,gBAAgB,GACjB,MAAM,gDAAgD,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,KAAa,EACb,OAAe,EACyB,EAAE;IAC1C,MAAM,QAAQ,GAAG,YAAY,EAAmB,CAAC,OAAO,CAAC,OAAO,CAAC;IACjE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,+EAA+E,CAAC,CAAC;IAC/F,CAAC;IACD,OAAO,gBAAgB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/signalr/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/esm/signalr/useSignalR.js

@@ -0,0 +1,33 @@
+import { useFramework } from '../useFramework';
+import { useProviderTopic, } from '@equinor/fusion-framework-react-module-signalr';
+/**
+ * hook for subscribing to a topic of a SignalR hub
+ *
+ * @example
+ ```ts
+// config.ts
+import {enableSignalR} from '@equinor/fusion-framework-react-module-signalr';
+(configurator) => enableSignalR(configurator, 'notifications');
+
+// myHook.ts
+const myHook = () => {
+    const topic = useSignalR('notifications', 'foo');
+    return useObservableState(topic).next;
+}
+ ```
+ *
+ * @see {@link [module signalr](https://equinor.github.io/fusion-framework/modules/signalr)}
+ *
+ * @param hubId identifier of connection hub (must be configured)
+ * @param topicId identifier of topic to connect to
+ * @returns Topic
+ */
+export const useSignalR = (hubId, topicId) => {
+    const provider = useFramework().modules.signalR;
+    // Fail fast when the SignalRModule has not been configured on the framework
+    if (!provider) {
+        throw Error('SignalR is not configured, see @equinor/fusion-framework-react-module-signalr');
+    }
+    return useProviderTopic(provider, hubId, topicId);
+};
+//# sourceMappingURL=useSignalR.js.map

package/dist/esm/signalr/useSignalR.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSignalR.js","sourceRoot":"","sources":["../../../src/signalr/useSignalR.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,OAAO,EAEL,gBAAgB,GACjB,MAAM,gDAAgD,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,KAAa,EACb,OAAe,EACyB,EAAE;IAC1C,MAAM,QAAQ,GAAG,YAAY,EAAmB,CAAC,OAAO,CAAC,OAAO,CAAC;IACjE,4EAA4E;IAC5E,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,+EAA+E,CAAC,CAAC;IAC/F,CAAC;IACD,OAAO,gBAAgB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC,CAAC"}

package/dist/esm/useFramework.js

@@ -1,20 +1,34 @@
 import { useContext } from 'react';
 import { context } from './context';
 /**
+ * React hook that returns the current Fusion Framework instance from context.
+ *
+ * @remarks
+ * The hook first looks for a framework instance provided via
+ * {@link FrameworkProvider}. If none is found it falls back to the global
+ * `window.Fusion` object. A console warning / error is emitted when the
+ * framework cannot be resolved.
+ *
+ * @template TModules - Tuple of additional module types expected on the
+ *   framework instance (used for type-narrowing only).
+ * @returns The active {@link Fusion} instance.
+ *
  * @example
  * ```ts
- * const useSometing = () => {
- *  const fusion = useFramework();
- *  return fusion.something;
- * }
+ * const useMyService = () => {
+ *   const fusion = useFramework();
+ *   return fusion.modules.http.createClient('my-service');
+ * };
  * ```
  */
 export const useFramework = () => {
     let framework = useContext(context);
+    // Warn loudly when the framework context is missing so integrators notice the misuse
     if (!framework) {
         console.warn('could not locate fusion in context!');
     }
     framework ??= window.Fusion;
+    // Surface an error when neither context nor the global fallback has the framework instance
     if (!framework) {
         console.error('Could not load framework, might not be initiated?');
     }

package/dist/esm/useFramework.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFramework.js","sourceRoot":"","sources":["../../src/useFramework.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAA6D,EAAE;IACzF,IAAI,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;IACtD,CAAC;IACD,SAAS,KAAK,MAAM,CAAC,MAAM,CAAC;IAC5B,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,eAAe,YAAY,CAAC"}
+{"version":3,"file":"useFramework.js","sourceRoot":"","sources":["../../src/useFramework.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAA6D,EAAE;IACzF,IAAI,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,qFAAqF;IACrF,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;IACtD,CAAC;IACD,SAAS,KAAK,MAAM,CAAC,MAAM,CAAC;IAC5B,2FAA2F;IAC3F,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,eAAe,YAAY,CAAC"}