@equinor/fusion-framework-react-app 9.0.8 → 10.0.0

package/dist/types/ag-grid/useTheme.d.ts

@@ -1,2 +1,9 @@
 import type { Theme } from '@equinor/fusion-framework-module-ag-grid/themes';
+/**
+ * React hook that returns the current AG Grid theme from the application-scoped
+ * AG Grid module.
+ *
+ * @returns The active {@link Theme} object.
+ * @throws If the AG Grid module is not registered in the application.
+ */
 export declare const useTheme: () => Theme;

package/dist/types/analytics/index.d.ts

@@ -1 +1,9 @@
+/**
+ * Analytics sub-path entry-point.
+ *
+ * Provides the {@link useTrackFeature} hook for tracking application-level
+ * analytics events through the Fusion analytics module.
+ *
+ * @packageDocumentation
+ */
 export { useTrackFeature } from './useTrackFeature';

package/dist/types/analytics/useTrackFeature.d.ts

@@ -1,5 +1,21 @@
 import type { AnyValueMap } from '@equinor/fusion-framework-module-analytics';
 /**
- * Hook for using analytics module configured in the framework.
+ * React hook that returns a callback for tracking application feature usage
+ * via the Fusion analytics module.
+ *
+ * The tracked event includes the current app key and context (if available)
+ * as attributes, enabling downstream analytics dashboards to group events
+ * by application and context.
+ *
+ * @returns A `trackFeature` callback: `(name: string, data?: AnyValueMap) => void`.
+ *
+ * @example
+ * ```tsx
+ * const trackFeature = useTrackFeature();
+ *
+ * const handleClick = useCallback(() => {
+ *   trackFeature('button-click', { section: 'header' });
+ * }, [trackFeature]);
+ * ```
  */
 export declare const useTrackFeature: () => (name: string, data?: AnyValueMap) => void;

package/dist/types/apploader/Apploader.d.ts

@@ -1,3 +1,4 @@
+import { type ReactElement } from 'react';
 export type ApploaderProps = {
     appKey: string;
 };
@@ -9,10 +10,10 @@ export type ApploaderProps = {
  *
  * @param { ApploaderProps } props - The props for the component.
  * @param { string } props.appKey - The key of the Fusion app to load and mount.
- * @returns { JSX.Element } The rendered component, which displays loading, error, or the embedded app.
+ * @returns { ReactElement } The rendered component, which displays loading, error, or the embedded app.
  *
  * @example
  * <Apploader appKey="my-app" />
  */
-export declare const Apploader: ({ appKey }: ApploaderProps) => JSX.Element;
+export declare const Apploader: ({ appKey }: ApploaderProps) => ReactElement;
 export default Apploader;

package/dist/types/apploader/index.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Apploader sub-path entry-point.
+ *
+ * Provides the {@link Apploader} component and {@link useApploader} hook
+ * for embedding Fusion child applications inside a parent Fusion application.
+ *
+ * @packageDocumentation
+ */
 export { Apploader, type ApploaderProps } from './Apploader';
 export { useApploader } from './useApploader';

package/dist/types/bookmark/index.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Bookmark sub-path entry-point.
+ *
+ * Provides helpers to enable and consume the Fusion bookmark module,
+ * allowing users to save and restore application state snapshots.
+ *
+ * @packageDocumentation
+ */
 export { enableBookmark } from '@equinor/fusion-framework-app/enable-bookmark';
 export { useCurrentBookmark } from './useCurrentBookmark';
 export { useBookmark } from './useBookmark';

package/dist/types/context/index.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Context sub-path entry-point.
+ *
+ * Provides hooks for reading and interacting with the Fusion context
+ * (project, facility, etc.) at both the application and framework level.
+ *
+ * @packageDocumentation
+ */
 export * from '@equinor/fusion-framework-react-module-context';
 export { useContextProvider } from './useContextProvider';
 export { useCurrentContext } from './useCurrentContext';

package/dist/types/context/useContextProvider.d.ts

@@ -1,2 +1,8 @@
+/**
+ * React hook that resolves the application-scoped context module provider.
+ *
+ * @returns The context module provider instance.
+ * @throws If the context module is not registered in the application scope.
+ */
 export declare const useContextProvider: () => import("@equinor/fusion-framework-module-context").IContextProvider;
 export default useContextProvider;

package/dist/types/context/useCurrentContext.d.ts

@@ -1,3 +1,17 @@
+/**
+ * React hook that returns the currently selected Fusion context from the
+ * **application-scoped** context module.
+ *
+ * @returns The current context object, or `undefined` if no context is selected.
+ *
+ * @example
+ * ```tsx
+ * const context = useCurrentContext();
+ * if (context) {
+ *   console.log('Selected:', context.title);
+ * }
+ * ```
+ */
 export declare const useCurrentContext: () => {
     currentContext: import("@equinor/fusion-framework-module-context").ContextItem | null | undefined;
     setCurrentContext: (entry?: import("@equinor/fusion-framework-module-context").ContextItem | string | null) => void | Promise<import("@equinor/fusion-framework-module-context").ContextItem<Record<string, unknown>> | null>;

package/dist/types/create-legacy-app.d.ts

@@ -1,4 +1,17 @@
 import { type ElementType } from 'react';
 import type { AnyModule } from '@equinor/fusion-framework-module';
 import type { AppModuleInitiator } from '@equinor/fusion-framework-app';
+/**
+ * Creates a legacy wrapper component that bootstraps a Fusion React app within
+ * the older Fusion CLI hosting model.
+ *
+ * @deprecated Prefer {@link renderApp} for new applications. This helper exists
+ * only for backward-compatibility with apps that must run inside the legacy
+ * Fusion CLI.
+ *
+ * @template TModules - Array of additional module types to initialise.
+ * @param Component - The root React element to render.
+ * @param configure - Optional callback to configure application modules.
+ * @returns A React function component that initialises modules and renders the app.
+ */
 export declare const createLegacyApp: <TModules extends Array<AnyModule>>(Component: ElementType, configure?: AppModuleInitiator<TModules>) => () => import("react/jsx-runtime").JSX.Element;

package/dist/types/feature-flag/index.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Feature-flag sub-path entry-point.
+ *
+ * Provides the {@link enableFeatureFlag} configurator helper and the
+ * {@link useFeature} hook for reading and toggling feature flags at runtime.
+ *
+ * @packageDocumentation
+ */
 export { IFeatureFlag, IFeatureFlagProvider, FeatureFlagModule, } from '@equinor/fusion-framework-module-feature-flag';
 export { enableFeatureFlag } from './enable-feature-flag';
 export { useFeature } from './useFeature';

package/dist/types/feature-flag/useFeature.d.ts

@@ -1,9 +1,25 @@
 import type { IFeatureFlag } from '@equinor/fusion-framework-module-feature-flag';
 /**
- * Custom hook for accessing and manipulating feature flags.
- * @template T - The type of the feature flag value.
- * @param key - The key of the feature flag.
- * @returns An object containing the feature flag, toggle function, and error (if any).
+ * React hook for reading and toggling a single feature flag.
+ *
+ * Merges feature flags from both the framework and the application scope,
+ * so framework-level flags are visible alongside app-specific ones.
+ *
+ * @template T - The type of the feature flag's value payload.
+ * @param key - The unique key identifying the feature flag.
+ * @returns An object with:
+ *   - `feature` – the resolved {@link IFeatureFlag}, or `undefined` if not found.
+ *   - `toggleFeature` – callback to toggle the flag; pass `true`/`false` to
+ *     set explicitly, or omit to invert the current state.
+ *   - `error` – any error from the feature-flag observable.
+ *
+ * @example
+ * ```tsx
+ * const { feature, toggleFeature } = useFeature('dark-mode');
+ * return (
+ *   <Switch checked={feature?.enabled} onChange={() => toggleFeature()} />
+ * );
+ * ```
  */
 export declare const useFeature: <T = unknown>(key: string) => {
     feature?: IFeatureFlag<T>;

package/dist/types/framework/index.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Framework sub-path entry-point.
+ *
+ * Re-exports framework-level hooks (as opposed to application-scoped ones)
+ * for accessing the Fusion instance, current user, and HTTP clients.
+ *
+ * @packageDocumentation
+ */
 export { useFramework } from '@equinor/fusion-framework-react';
 export { useCurrentUser, useHttpClient as useFrameworkHttpClient, } from '@equinor/fusion-framework-react/hooks';

package/dist/types/framework/useFrameworkCurrentContext.d.ts

@@ -1,3 +1,12 @@
+/**
+ * React hook that returns the currently selected context from the
+ * **framework-level** context module (as opposed to the application-scoped one).
+ *
+ * Use this when you need the portal/host context rather than the app's own
+ * context provider.
+ *
+ * @returns The current framework context, or `undefined` if none is selected.
+ */
 export declare const useFrameworkCurrentContext: () => {
     currentContext: import("@equinor/fusion-framework-module-context").ContextItem | null | undefined;
     setCurrentContext: (entry?: import("@equinor/fusion-framework-module-context").ContextItem | string | null) => void | Promise<import("@equinor/fusion-framework-module-context").ContextItem<Record<string, unknown>> | null>;

package/dist/types/help-center/useHelpCenter.d.ts

@@ -46,7 +46,18 @@ export interface HelpCenter {
     openReleaseNotes(): void;
 }
 /**
- * Hook for accessing help center.
+ * React hook that returns an API for opening the portal help-center sidesheet.
+ *
+ * Each method dispatches a framework event that the portal shell listens for
+ * and opens the corresponding help page.
+ *
+ * @returns A {@link HelpCenter} object with methods to open specific help pages.
+ *
+ * @example
+ * ```tsx
+ * const helpCenter = useHelpCenter();
+ * <Button onClick={() => helpCenter.openFaqs()}>FAQs</Button>
+ * ```
  */
 export declare const useHelpCenter: () => HelpCenter;
 export default useHelpCenter;

package/dist/types/http/index.d.ts

@@ -1 +1,10 @@
+/**
+ * HTTP sub-path entry-point.
+ *
+ * Re-exports hooks from `@equinor/fusion-framework-react-module-http`,
+ * including {@link useHttpClient} for making authenticated HTTP requests
+ * from within a Fusion application.
+ *
+ * @packageDocumentation
+ */
 export * from '@equinor/fusion-framework-react-module-http';

package/dist/types/http/selectors.d.ts

@@ -0,0 +1,9 @@
+/**
+ * HTTP selector utilities.
+ *
+ * Re-exports response-selector helpers (e.g. JSON, blob, text selectors)
+ * from `@equinor/fusion-framework-module-http/selectors`.
+ *
+ * @packageDocumentation
+ */
+export * from '@equinor/fusion-framework-module-http/selectors';

package/dist/types/index.d.ts

@@ -1,12 +1,29 @@
+/**
+ * @packageDocumentation
+ *
+ * React bindings for building Fusion Framework applications.
+ *
+ * Provides the main entry-point helpers (`renderApp`, `createComponent`, `makeComponent`)
+ * plus React hooks for accessing framework modules (HTTP, auth, context, navigation, etc.)
+ * from within a Fusion app.
+ *
+ * @remarks
+ * This is the primary package application developers depend on when building
+ * React-based Fusion apps. It re-exports core types from `@equinor/fusion-framework-app`
+ * and adds React-specific rendering, hooks, and sub-path entry-points for optional
+ * modules such as MSAL, feature flags, bookmarks, analytics, and settings.
+ */
 export type { AppConfig, AppEnv, AppModuleInitiator, AppModules, AppModulesInstance, AppRenderFn, IAppConfigurator, } from '@equinor/fusion-framework-app';
+export type { Fusion } from '@equinor/fusion-framework-react';
 export { AppManifest } from '@equinor/fusion-framework-module-app';
 export { useAppModule } from './useAppModule';
 export { useAppModules } from './useAppModules';
 export { useAppEnvironmentVariables } from './useAppEnvironmentVariables';
 export { makeComponent, ComponentRenderArgs } from './make-component';
 export { createLegacyApp } from './create-legacy-app';
-export { renderApp } from './render-app';
 export { createComponent } from './create-component';
+export { renderApp } from './render-app';
 export { renderComponent } from './render-component';
 export type { ComponentRenderer } from './create-component';
+export type { RenderTeardown } from './render-component';
 export { default } from './render-app';

package/dist/types/make-component.d.ts

@@ -4,10 +4,25 @@ import { type AppEnv } from '@equinor/fusion-framework-app';
 import type { AppModuleInitiator, AppModulesInstance } from '@equinor/fusion-framework-app';
 import type { AnyModule } from '@equinor/fusion-framework-module';
 import type { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
+/**
+ * Arguments supplied when rendering a Fusion app component.
+ *
+ * @template TFusion - The Fusion framework instance type.
+ * @template TEnv - The application environment type.
+ */
 export type ComponentRenderArgs<TFusion extends Fusion = Fusion, TEnv = AppEnv> = {
+    /** The Fusion framework instance. */
     fusion: TFusion;
+    /** The application environment (manifest, config, basename, etc.). */
     env: TEnv;
 };
+/**
+ * Factory function that receives a Fusion instance and environment and returns a
+ * lazy React component ready to be rendered.
+ *
+ * @template TFusion - The Fusion framework instance type.
+ * @template TEnv - The application environment type.
+ */
 export type ComponentRenderer<TFusion extends Fusion = Fusion, TEnv = AppEnv> = (fusion: TFusion, env: TEnv) => React.LazyExoticComponent<React.ComponentType>;
 /**
  * Creates a lazy loading React Component that initializes and configures modules,

package/dist/types/msal/index.d.ts

@@ -1,3 +1,16 @@
+/**
+ * MSAL authentication sub-path entry-point.
+ *
+ * Provides React hooks for accessing MSAL-based authentication state
+ * (current account, access tokens) from within a Fusion application.
+ *
+ * @remarks
+ * Requires `@equinor/fusion-framework-module-msal` to be installed and
+ * configured by the host/portal. Applications should **not** configure the
+ * MSAL module themselves.
+ *
+ * @packageDocumentation
+ */
 export { useCurrentAccount } from './useCurrentAccount';
 export { useAccessToken } from './useAccessToken';
 export { useToken } from './useToken';

package/dist/types/msal/useAccessToken.d.ts

@@ -1,8 +1,20 @@
 /**
- * Custom hook that retrieves an access token for the specified authentication request.
+ * React hook that acquires an OAuth 2.0 access token string via MSAL.
  *
- * @param req - The authentication request.
- * @returns An object containing the access token, pending state, and error.
+ * This is a convenience wrapper around {@link useToken} that extracts the
+ * `accessToken` property from the full `AuthenticationResult`.
+ *
+ * @param req - The token request containing the `scopes` to acquire.
+ * @param req.scopes - Array of scope strings (e.g. `['User.Read']`).
+ * @returns An object with:
+ *   - `token` – the access token string, or `undefined` while pending.
+ *   - `pending` – `true` while the token is being acquired.
+ *   - `error` – any error encountered during acquisition.
+ *
+ * @example
+ * ```tsx
+ * const { token, pending, error } = useAccessToken({ scopes: ['api://my-api/.default'] });
+ * ```
  */
 export declare const useAccessToken: (req: {
     scopes: string[];

package/dist/types/msal/useCurrentAccount.d.ts

@@ -1,6 +1,16 @@
 import type { AccountInfo } from '@equinor/fusion-framework-module-msal';
 /**
- * Retrieves the current account information from the MSAL provider.
- * @returns The current account information or undefined if no account is available.
+ * React hook that returns the currently signed-in user's MSAL account info.
+ *
+ * @returns The {@link AccountInfo} for the active account, or `undefined` if
+ *   no user is signed in.
+ *
+ * @example
+ * ```tsx
+ * const account = useCurrentAccount();
+ * if (account) {
+ *   console.log('Signed in as', account.name);
+ * }
+ * ```
  */
 export declare const useCurrentAccount: () => AccountInfo | undefined;

package/dist/types/msal/useToken.d.ts

@@ -1,8 +1,24 @@
 import type { AuthenticationResult } from '@equinor/fusion-framework-module-msal';
 /**
- * Custom hook for acquiring an authentication token using MSAL.
- * @param req - The authentication request.
- * @returns An object containing the acquired token, pending state, and error.
+ * React hook that acquires a full MSAL {@link AuthenticationResult} for the
+ * requested scopes.
+ *
+ * The hook attempts silent acquisition first and falls back to an interactive
+ * prompt when required by the MSAL provider.
+ *
+ * @param req - The token request containing the `scopes` to acquire.
+ * @param req.scopes - Array of scope strings (e.g. `['User.Read']`).
+ * @returns An object with:
+ *   - `token` – the full {@link AuthenticationResult}, or `undefined` while pending.
+ *   - `pending` – `true` while the token is being acquired.
+ *   - `error` – any error encountered during acquisition.
+ *
+ * @example
+ * ```tsx
+ * const { token, pending } = useToken({ scopes: ['User.Read'] });
+ * if (pending) return <Spinner />;
+ * console.log('ID token:', token?.idToken);
+ * ```
  */
 export declare const useToken: (req: {
     scopes: string[];

package/dist/types/navigation/index.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Navigation sub-path entry-point.
+ *
+ * Provides hooks for accessing the Fusion navigation module and creating
+ * client-side routers compatible with `react-router`.
+ *
+ * @packageDocumentation
+ */
 export { useNavigationModule } from './useNavigationModule';
 export { useRouter } from './useRouter';

package/dist/types/navigation/useNavigationModule.d.ts

@@ -1,3 +1,8 @@
 import type { INavigationProvider } from '@equinor/fusion-framework-module-navigation';
-/** hook for getting the navigation provider (if enabled!) */
+/**
+ * React hook that resolves the application-scoped navigation module provider.
+ *
+ * @returns The navigation provider instance.
+ * @throws If the navigation module has not been enabled for the application.
+ */
 export declare const useNavigationModule: () => INavigationProvider;

package/dist/types/navigation/useRouter.d.ts

@@ -1,8 +1,27 @@
 import type { INavigationProvider } from '@equinor/fusion-framework-module-navigation';
 /**
- * create a router for react routing
- * @see {@link [docs](https://equinor.github.io/fusion-framework/modules/navigation/)}
- * @see {@link [react-router](https://reactrouter.com/en/main/routers/create-browser-router)}
- * @param routes router objects __(must be static | memorized)__
+ * React hook that creates a router instance for client-side navigation.
+ *
+ * The `routes` argument **must** be static or memoised to avoid re-creating
+ * the router on every render.
+ *
+ * @param routes - An array of route objects compatible with
+ *   `INavigationProvider.createRouter`.
+ * @returns A router instance to pass to `<RouterProvider>`.
+ *
+ * @see {@link https://equinor.github.io/fusion-framework/modules/navigation/ | Fusion navigation docs}
+ * @see {@link https://reactrouter.com/en/main/routers/create-browser-router | react-router docs}
+ *
+ * @example
+ * ```tsx
+ * import { useRouter } from '@equinor/fusion-framework-react-app/navigation';
+ * import { RouterProvider } from 'react-router-dom';
+ *
+ * const routes = [{ path: '/', element: <Home /> }];
+ * const App = () => {
+ *   const router = useRouter(routes);
+ *   return <RouterProvider router={router} />;
+ * };
+ * ```
  */
 export declare const useRouter: (routes: Parameters<INavigationProvider["createRouter"]>[0]) => ReturnType<INavigationProvider["createRouter"]>;

package/dist/types/render-app.d.ts

@@ -1,6 +1,27 @@
 import { createComponent } from './create-component';
 import { type RenderTeardown } from './render-component';
 import type { ComponentRenderArgs } from './create-component';
-/** @deprecated */
+/**
+ * Creates a render function for a Fusion React application.
+ *
+ * Wraps {@link createComponent} and {@link renderComponent} into a single factory:
+ * call the returned function with an `HTMLElement` and `ComponentRenderArgs` to
+ * mount the app using React 18's `createRoot` API.
+ *
+ * @param componentArgs - Arguments forwarded to {@link createComponent} (the React
+ *   component to render and an optional module-configuration callback).
+ * @returns A mount function that accepts a DOM element and render args, and returns
+ *   a {@link RenderTeardown} callback to unmount the application.
+ *
+ * @example
+ * ```ts
+ * import { renderApp } from '@equinor/fusion-framework-react-app';
+ * import { App } from './App';
+ * import { configure } from './config';
+ *
+ * export const render = renderApp(App, configure);
+ * export default render;
+ * ```
+ */
 export declare const renderApp: (...componentArgs: Parameters<typeof createComponent>) => (el: HTMLElement, args: ComponentRenderArgs) => RenderTeardown;
 export default renderApp;

package/dist/types/render-component.d.ts

@@ -1,5 +1,20 @@
 import type { ComponentRenderArgs, ComponentRenderer } from './create-component';
+/**
+ * Callback returned after mounting an application; invoke it to unmount and clean
+ * up the React root.
+ */
 export type RenderTeardown = VoidFunction;
-/** @deprecated */
+/**
+ * Creates a mount function from a {@link ComponentRenderer}.
+ *
+ * The returned function accepts a target `HTMLElement` and
+ * {@link ComponentRenderArgs}, resolves the lazy component via the renderer,
+ * and mounts it with React 18's `createRoot`.
+ *
+ * @param renderer - A {@link ComponentRenderer} that produces a lazy component
+ *   from Fusion and environment arguments.
+ * @returns A function `(el, args) => RenderTeardown` that mounts the app and
+ *   returns a teardown callback.
+ */
 export declare const renderComponent: (renderer: ComponentRenderer) => (el: HTMLElement, args: ComponentRenderArgs) => RenderTeardown;
 export default renderComponent;

package/dist/types/settings/index.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Settings sub-path entry-point.
+ *
+ * Provides hooks for reading and updating per-application user settings
+ * that are persisted by the Fusion platform.
+ *
+ * @packageDocumentation
+ */
 export { useAppSetting } from './useAppSetting';
 export { useAppSettings } from './useAppSettings';
 export type { AppSettings } from '@equinor/fusion-framework-module-app';

package/dist/types/useAppModule.d.ts

@@ -1,12 +1,20 @@
 import type { AppModules, AppModulesInstance } from '@equinor/fusion-framework-app';
 import type { AnyModule, ModuleKey, ModuleType, ModuleTypes } from '@equinor/fusion-framework-module';
 /**
- * Retrieves the specified app module from the app scope.
+ * React hook that retrieves a single module instance from the application scope.
  *
- * @template TType - The type of the app module.
- * @template TKey - The key of the app module.
- * @param module - The key of the app module to retrieve.
- * @returns The app module instance if found, otherwise throws an error.
+ * @template TType - The concrete module type (e.g. `ContextModule`). Pass
+ *   `unknown` to infer the type from the key.
+ * @template TKey - The string key used to look up the module.
+ * @param module - The key identifying the module to retrieve.
+ * @returns The resolved module instance.
+ * @throws If the requested module is not registered in the application scope.
+ *
+ * @example
+ * ```tsx
+ * const auth = useAppModule('auth');
+ * auth.acquireAccessToken().then(console.log);
+ * ```
  */
 export declare function useAppModule<TType extends AnyModule | unknown = unknown, TKey extends string = ModuleKey<ModuleTypes<AppModules<[TType]>>>>(module: TKey): TType extends AnyModule ? ModuleType<TType> : AppModulesInstance[Extract<keyof AppModulesInstance, TKey>];
 export default useAppModule;

package/dist/types/useAppModules.d.ts

@@ -1,10 +1,16 @@
 import type { AppModulesInstance } from '@equinor/fusion-framework-app';
 import type { AnyModule } from '@equinor/fusion-framework-module';
 /**
- * Custom hook that returns an instance of the app modules.
+ * React hook that returns the full set of initialised application-scoped modules.
  *
- * @template T - The type of the app modules.
- * @returns An instance of the app modules.
+ * @template T - Optional array of additional module types beyond the defaults.
+ * @returns The {@link AppModulesInstance} containing all registered modules.
+ *
+ * @example
+ * ```tsx
+ * const modules = useAppModules();
+ * console.log(Object.keys(modules));
+ * ```
  */
 export declare const useAppModules: <T extends Array<AnyModule> | unknown = unknown>() => AppModulesInstance<T>;
 export default useAppModules;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "9.0.8";
+export declare const version = "10.0.0";