@equinor/fusion-framework-react-app 12.0.2 → 12.0.4

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

@@ -16,5 +16,5 @@ import { type useBookmarkResult } from '@equinor/fusion-framework-react-module-b
  * @template TData - Current applications  bookmark type
  * @return {*}  {Bookmarks<TData>} the full api fro handling bookmarks
  */
-export declare const useBookmark: <TData>() => useBookmarkResult;
+export declare const useBookmark: <_TData>() => useBookmarkResult;
 export default useBookmark;

package/dist/types/help-center/event-name.d.ts

@@ -0,0 +1 @@
+export declare const EVENT_NAME = "@Portal::FusionHelp::open";

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

@@ -1,7 +1,7 @@
 import type { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
 import type { HelpCenterOpenEventDetail } from './useHelpCenter';
 export { useHelpCenter } from './useHelpCenter';
-export type { HelpCenterOpenEventDetail };
+export type { HelpCenterOpenEventDetail } from './useHelpCenter';
 declare module '@equinor/fusion-framework-module-event' {
     interface FrameworkEventMap {
         '@Portal::FusionHelp::open': FrameworkEvent<FrameworkEventInit<HelpCenterOpenEventDetail>>;

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

@@ -11,7 +11,6 @@ type OpenSearchDetail = HelpCenterEventDetailBase<'search', {
 }>;
 type OpenGovernanceDetail = HelpCenterEventDetailBase<'governance'>;
 export type HelpCenterOpenEventDetail = OpenHelpDetail | OpenArticleDetail | OpenFaqsDetail | OpenSearchDetail | OpenGovernanceDetail;
-export declare const EVENT_NAME = "@Portal::FusionHelp::open";
 /**
  * Interface for requesting help features.
  */

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

@@ -24,4 +24,4 @@ import type { INavigationProvider } from '@equinor/fusion-framework-module-navig
  * };
  * ```
  */
-export declare const useRouter: (routes: Parameters<INavigationProvider["createRouter"]>[0]) => ReturnType<INavigationProvider["createRouter"]>;
+export declare const useRouter: (routes: Parameters<INavigationProvider['createRouter']>[0]) => ReturnType<INavigationProvider['createRouter']>;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "12.0.2";
+export declare const version = "12.0.4";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-react-app",
-  "version": "12.0.2",
+  "version": "12.0.4",
   "description": "",
   "main": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -124,14 +124,14 @@
     "directory": "packages/react"
   },
   "dependencies": {
-    "@equinor/fusion-framework-app": "11.0.10",
-    "@equinor/fusion-framework-module": "6.1.0",
-    "@equinor/fusion-framework-module-app": "8.0.2",
-    "@equinor/fusion-framework-module-navigation": "7.0.4",
-    "@equinor/fusion-framework-module-http": "8.0.3",
-    "@equinor/fusion-framework-react-module": "4.0.1",
-    "@equinor/fusion-framework-react-module-http": "11.0.0",
-    "@equinor/fusion-framework-react": "8.0.0"
+    "@equinor/fusion-framework-module": "6.1.1",
+    "@equinor/fusion-framework-module-http": "8.0.4",
+    "@equinor/fusion-framework-module-navigation": "7.0.6",
+    "@equinor/fusion-framework-react": "8.0.1",
+    "@equinor/fusion-framework-app": "11.0.11",
+    "@equinor/fusion-framework-react-module": "4.0.2",
+    "@equinor/fusion-framework-module-app": "8.0.3",
+    "@equinor/fusion-framework-react-module-http": "11.0.1"
   },
   "devDependencies": {
     "@types/react": "^19.2.7",
@@ -140,25 +140,25 @@
     "react": "^19.2.1",
     "react-dom": "^19.2.1",
     "rxjs": "^7.8.1",
-    "typescript": "^6.0.3",
+    "typescript": "^7.0.2",
     "vitest": "^4.1.0",
-    "@equinor/fusion-framework-module-ag-grid": "37.0.0",
-    "@equinor/fusion-framework-module-analytics": "3.0.1",
-    "@equinor/fusion-framework-module-event": "6.0.0",
-    "@equinor/fusion-framework-module-feature-flag": "2.0.1",
-    "@equinor/fusion-framework-module-msal": "10.0.1",
-    "@equinor/fusion-framework-react-module-bookmark": "6.0.0",
-    "@equinor/fusion-framework-react-module-context": "7.0.1",
-    "@equinor/fusion-framework-react-router": "2.2.0",
-    "@equinor/fusion-observable": "9.1.0"
+    "@equinor/fusion-framework-module-ag-grid": "37.0.1",
+    "@equinor/fusion-framework-module-analytics": "3.0.3",
+    "@equinor/fusion-framework-module-feature-flag": "2.0.2",
+    "@equinor/fusion-framework-module-msal": "10.0.2",
+    "@equinor/fusion-framework-react-module-bookmark": "6.0.1",
+    "@equinor/fusion-framework-module-event": "6.0.1",
+    "@equinor/fusion-framework-react-module-context": "7.0.2",
+    "@equinor/fusion-framework-react-router": "2.4.0",
+    "@equinor/fusion-observable": "9.1.1"
   },
   "peerDependencies": {
     "@types/react": "^18.0.0 || ^19.0.0",
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0",
     "rxjs": "^7.0.0",
-    "@equinor/fusion-framework-react-router": "^2.2.0",
-    "@equinor/fusion-framework-module-msal": "^10.0.1"
+    "@equinor/fusion-framework-module-msal": "^10.0.2",
+    "@equinor/fusion-framework-react-router": "^2.4.0"
   },
   "peerDependenciesMeta": {
     "@equinor/fusion-framework-react-module-ag-grid": {

package/src/ag-grid/useTheme.ts

@@ -12,6 +12,7 @@ import type { Theme } from '@equinor/fusion-framework-module-ag-grid/themes';
 export const useTheme = (): Theme => {
   const agGrid = useAppModule<AgGridModule>('agGrid');
 
+  // Fail fast when the AG Grid module has not been registered on the app
   if (!agGrid) {
     throw new Error('agGrid module is not available');
   }

package/src/analytics/useTrackFeature.ts

@@ -38,6 +38,7 @@ export const useTrackFeature = () => {
    */
   const trackFeature = useCallback(
     (name: string, data?: AnyValueMap) => {
+      // Report to telemetry when analytics tracking is not available so the gap is visible
       if (!analyticsProvider) {
         telemetryProvider?.trackException({
           name: 'AnalyticsProviderNotFound',

package/src/apploader/Apploader.tsx

@@ -23,6 +23,7 @@ export const Apploader = ({ appKey }: ApploaderProps): ReactElement => {
   const { loading, error, appRef } = useApploader({ appKey });
 
   useEffect(() => {
+    // Wait until both the wrapper element and the loaded app element are available
     if (!refWrapp.current || !appRef.current) {
       return;
     }
@@ -30,9 +31,11 @@ export const Apploader = ({ appKey }: ApploaderProps): ReactElement => {
     refWrapp.current.appendChild(appRef.current);
   }, [appRef.current]);
 
+  // Show a loading placeholder while the app is being fetched and initialized
   if (loading) {
     return <div>Loading {appKey}</div>;
   }
+  // Surface the load error instead of rendering the app
   if (error) {
     return (
       <div>

package/src/apploader/useApploader.ts

@@ -73,6 +73,7 @@ export const useApploader = ({
 
         try {
           const render = script.renderApp ?? script.default;
+          // Prefer the modern renderApp export, falling back to the default export
           if (render) {
             return render(appRef.current, {
               fusion,

package/src/bookmark/useBookmark.ts

@@ -20,7 +20,6 @@ import {
  * @template TData - Current applications  bookmark type
  * @return {*}  {Bookmarks<TData>} the full api fro handling bookmarks
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export const useBookmark = <TData>(): useBookmarkResult => _useBookmark();
+export const useBookmark = <_TData>(): useBookmarkResult => _useBookmark();
 
 export default useBookmark;

package/src/bookmark/useCurrentBookmark.ts

@@ -29,6 +29,7 @@ export const useCurrentBookmark = <TData extends BookmarkData>(
   const { currentApp } = useCurrentApp();
   const appBookmarkProvider = useAppModules<[BookmarkModule]>().bookmark;
   const frameworkBookmarkProvider = useFrameworkModule<BookmarkModule>('bookmark');
+  // Warn about the deprecated fallback to the framework-scoped bookmark provider
   if (!appBookmarkProvider) {
     console.warn(
       '@deprecation',

package/src/create-component.tsx

@@ -81,6 +81,8 @@ export const createComponent =
   (fusion, env) =>
     lazy(async () => {
       const init = configureModules<TModules, TRef, TEnv>(configure);
+      // configureModules returns a generic modules instance; narrow it to the
+      // app-specific shape expected by consumers of this component.
       const modules = (await init({
         fusion,
         env,
@@ -94,7 +96,7 @@ export const createComponent =
         default: () => (
           <FrameworkProvider value={fusion}>
             <AppModuleProvider value={modules}>
-              {/* TODO */}
+              {/* TODO(#5083): tighten generics so Component no longer needs @ts-ignore */}
               {/* eslint-disable-next-line @typescript-eslint/ban-ts-comment*/}
               {/* @ts-ignore */}
               <Component />

package/src/create-legacy-app.tsx

@@ -27,16 +27,18 @@ export const createLegacyApp = <TModules extends Array<AnyModule>>(
 ) => {
   const LegacyComponent = () => {
     const fusion = useFramework<[AppModule]>();
-    // biome-ignore lint/correctness/useExhaustiveDependencies: this will soon be removed
     const RenderComponent = useMemo(() => {
       const creator = createComponent(Component, configure);
       // @eikeland
-      // TODO - recheck when legacy fusion-cli is updated!
+      // TODO(#5084): recheck when legacy fusion-cli is updated!
       const appProvider = fusion.modules.app;
+      // Use the real app config/manifest once the provider has resolved them
       if (appProvider?.current) {
         const { config, manifest } = appProvider.current;
+        // Legacy app provider config/manifest predate the strict AppEnv shape; cast until legacy fusion-cli is updated.
         return creator(fusion, { config, manifest } as unknown as AppEnv);
       }
+      // No app provider available yet; pass an empty object cast to AppEnv as a placeholder.
       return creator(fusion, {} as unknown as AppEnv);
     }, [fusion]);
     return (

package/src/feature-flag/enable-feature-flag.ts

@@ -47,6 +47,7 @@ export function enableFeatureFlag(
     | Array<IFeatureFlag<unknown> & { allowUrl?: boolean | undefined }>
     | FeatureFlagBuilderCallback,
 ): void {
+  // Dispatch based on whether the caller passed an array of flags or a builder callback
   switch (typeof flags_cb) {
     case 'function': {
       enableFeatureFlagging(configurator, flags_cb);
@@ -54,15 +55,17 @@ export function enableFeatureFlag(
     }
     case 'object': {
       const urlFlags: IFeatureFlag[] = [];
+      // Split out flags marked allowUrl so they can be registered with the URL plugin
       const localFlags = (flags_cb ?? []).map((flag) => {
         const { allowUrl, ...localFlag } = flag;
+        // Track allowUrl flags separately; they still get registered locally too
         if (allowUrl) {
           urlFlags.push(flag);
         }
         return localFlag;
       });
       enableFeatureFlagging(configurator, async (builder) => {
-        // TODO: should unnamed application be allowed to use feature flags?
+        // TODO(#5086): should unnamed application be allowed to use feature flags?
         builder.addPlugin(
           createLocalStoragePlugin(localFlags, {
             name: (configurator as AppConfigurator).env?.manifest.appKey ?? undefined,

package/src/feature-flag/useFeature.ts

@@ -56,13 +56,21 @@ export const useFeature = <T = unknown>(
       app: appProvider.features$,
     }).pipe(
       map(({ framework, app }) => {
-        return { ...framework, ...app };
+        // Application feature flags override framework defaults with the same key.
+        const mergedFeatureFlags = { ...framework, ...app };
+        return mergedFeatureFlags;
       }),
     );
   }, [appProvider, frameworkProvider]);
 
   /** find feature flag by the provided key */
-  const feature$ = useMemo(() => features$.pipe(findFeature<T>(key)), [features$, key]);
+  const feature$ = useMemo(
+    () =>
+      features$
+        // Narrow the merged stream down to the requested feature key.
+        .pipe(findFeature<T>(key)),
+    [features$, key],
+  );
 
   const { value: feature, error } = useObservableState(feature$ ?? EMPTY);
 

package/src/help-center/event-name.ts

@@ -0,0 +1 @@
+export const EVENT_NAME = '@Portal::FusionHelp::open';

package/src/help-center/index.ts

@@ -2,7 +2,7 @@ import type { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framewo
 import type { HelpCenterOpenEventDetail } from './useHelpCenter';
 
 export { useHelpCenter } from './useHelpCenter';
-export type { HelpCenterOpenEventDetail };
+export type { HelpCenterOpenEventDetail } from './useHelpCenter';
 
 declare module '@equinor/fusion-framework-module-event' {
   interface FrameworkEventMap {

package/src/help-center/useHelpCenter.ts

@@ -1,6 +1,8 @@
 import { useCallback } from 'react';
 import useAppModule from '../useAppModule';
 
+import { EVENT_NAME } from './event-name.js';
+
 type HelpCenterEventDetailBase<
   T extends string,
   V extends Record<string, unknown> = Record<string, unknown>,
@@ -35,8 +37,6 @@ export type HelpCenterOpenEventDetail =
   | OpenSearchDetail
   | OpenGovernanceDetail;
 
-export const EVENT_NAME = '@Portal::FusionHelp::open';
-
 /**
  * Interface for requesting help features.
  */

package/src/msal/useToken.ts

@@ -38,6 +38,7 @@ export const useToken = (req: {
     msalProvider
       .acquireToken({ request: req })
       .then((result) => {
+        // Only update state when a token was actually acquired
         if (result) {
           setToken(result);
         }

package/src/settings/useAppSetting.ts

@@ -69,6 +69,7 @@ export const useAppSetting = <
   }, [currentApp]);
 
   useLayoutEffect(() => {
+    // Narrow the settings stream down to just this specific setting's value
     const sub = currentApp?.settings$
       .pipe(map((settings) => (settings as TSettings)[prop]))
       .subscribe(subject);
@@ -81,6 +82,7 @@ export const useAppSetting = <
   // update function
   const setSetting = useCallback(
     (update: TSettings[TProp] | UpdateSettingFunction<TSettings[TProp]>) => {
+      // Cannot persist a setting update without a current app to write it to
       if (!currentApp) {
         return onError?.(new Error('App is not available'));
       }

package/src/settings/useAppSettings.ts

@@ -63,8 +63,12 @@ export const useAppSettings = <TSettings extends Record<string, unknown> = AppSe
 
   // connect the subject to the current app settings stream
   useLayoutEffect(() => {
-    const sub = (currentApp?.settings$ as Observable<TSettings>).subscribe(subject);
-    return () => sub?.unsubscribe();
+    // Nothing to subscribe to until an app is resolved
+    if (!currentApp) {
+      return;
+    }
+    const sub = (currentApp.settings$ as Observable<TSettings>).subscribe(subject);
+    return () => sub.unsubscribe();
   }, [currentApp, subject]);
 
   // subscribe to the subject to get the latest settings
@@ -72,6 +76,7 @@ export const useAppSettings = <TSettings extends Record<string, unknown> = AppSe
 
   const setSettings = useCallback(
     (update: TSettings | UpdateSettingsFunction<TSettings>) => {
+      // Cannot persist settings updates without a current app to write them to
       if (!currentApp) {
         return onError?.(new Error('App is not available'));
       }

package/src/settings/useAppSettingsStatus.ts

@@ -29,7 +29,9 @@ export const useAppSettingsStatus = (app: IApp | null, hooks?: AppSettingsStatus
   const { onLoading, onUpdating } = hooks ?? {};
 
   useLayoutEffect(() => {
+    // Only subscribe once both an app and an onLoading callback are available
     if (app && onLoading) {
+      // Derive a boolean loading flag from whether 'fetch_settings' is an active status
       const subscription = app.status$
         .pipe(map((status) => status.has('fetch_settings')))
         .subscribe(onLoading);
@@ -38,7 +40,9 @@ export const useAppSettingsStatus = (app: IApp | null, hooks?: AppSettingsStatus
   }, [app, onLoading]);
 
   useLayoutEffect(() => {
+    // Only subscribe once both an app and an onUpdating callback are available
     if (app && onUpdating) {
+      // Derive a boolean updating flag from whether 'update_settings' is an active status
       const subscription = app.status$
         .pipe(map((status) => status.has('update_settings')))
         .subscribe(onUpdating);

package/src/useAppEnvironmentVariables.ts

@@ -44,6 +44,7 @@ export const useAppEnvironmentVariables = <
   }
 
   const env$ = useMemo(() => {
+    // Extract just the environment slice of the app's config for consumers
     return app.getConfig().pipe(
       map((config) => {
         return config.environment as TEnvironmentVariables;

package/src/useAppModule.ts

@@ -33,6 +33,7 @@ export function useAppModule<
   ? ModuleType<TType>
   : AppModulesInstance[Extract<keyof AppModulesInstance, TKey>] {
   const appModule = useAppModules()[module as keyof AppModulesInstance];
+  // Fail fast when the requested module was not registered on the app scope
   if (!appModule) {
     throw Error(`the requested module [${module}] is not included in the app scope`);
   }

package/src/version.ts

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