@equinor/fusion-framework-app 11.0.10 → 11.0.11

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "11.0.10";
+export declare const version = "11.0.11";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-app",
-  "version": "11.0.10",
+  "version": "11.0.11",
   "description": "",
   "main": "dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -46,20 +46,20 @@
   },
   "dependencies": {
     "rxjs": "^7.8.1",
-    "@equinor/fusion-framework": "8.0.10",
-    "@equinor/fusion-framework-module": "6.1.0",
-    "@equinor/fusion-framework-module-app": "8.0.2",
-    "@equinor/fusion-framework-module-http": "8.0.3",
-    "@equinor/fusion-framework-module-event": "6.0.0",
-    "@equinor/fusion-framework-module-telemetry": "7.0.0",
-    "@equinor/fusion-framework-module-msal": "10.0.1"
+    "@equinor/fusion-framework": "8.0.11",
+    "@equinor/fusion-framework-module": "6.1.1",
+    "@equinor/fusion-framework-module-app": "8.0.3",
+    "@equinor/fusion-framework-module-event": "6.0.1",
+    "@equinor/fusion-framework-module-msal": "10.0.2",
+    "@equinor/fusion-framework-module-telemetry": "7.0.1",
+    "@equinor/fusion-framework-module-http": "8.0.4"
   },
   "devDependencies": {
-    "typescript": "^6.0.3",
-    "@equinor/fusion-framework-module-bookmark": "^4.0.2"
+    "typescript": "^7.0.2",
+    "@equinor/fusion-framework-module-bookmark": "^4.0.3"
   },
   "peerDependencies": {
-    "@equinor/fusion-framework-module-bookmark": "^4.0.2"
+    "@equinor/fusion-framework-module-bookmark": "^4.0.3"
   },
   "peerDependenciesMeta": {
     "@equinor/fusion-framework-module-bookmark": {

package/src/AppConfigurator.ts

@@ -86,10 +86,10 @@ export interface IAppConfigurator<
    *                  `baseUri` and `defaultScopes` are excluded because they are
    *                  resolved from service discovery.
    */
-  // TODO - rename
+  // TODO(#5060): rename
   useFrameworkServiceClient(
     serviceName: string,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    // biome-ignore lint/suspicious/noExplicitAny: `HttpClientOptions<any>` widens to accept options for any request payload type
     options?: Omit<HttpClientOptions<any>, 'baseUri' | 'defaultScopes'>,
   ): void;
 }
@@ -153,6 +153,7 @@ export class AppConfigurator<
    */
   protected _configureHttpClientsFromAppConfig() {
     const { endpoints = {} } = this.env.config ?? {};
+    // Register an HTTP client for each endpoint defined in the app configuration.
     for (const [key, { url, scopes }] of Object.entries(endpoints)) {
       this.configureHttpClient(key, {
         baseUri: url,
@@ -196,7 +197,7 @@ export class AppConfigurator<
    */
   public useFrameworkServiceClient(
     serviceName: string,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    // biome-ignore lint/suspicious/noExplicitAny: `HttpClientOptions<any>` widens to accept options for any request payload type
     options?: Omit<HttpClientOptions<any>, 'baseUri' | 'defaultScopes'>,
   ): void {
     this.addConfig({
@@ -204,6 +205,7 @@ export class AppConfigurator<
       configure: async (config, ref) => {
         // Service from serviceDiscovery with potential session override.
         const service = await ref?.serviceDiscovery.resolveService(serviceName);
+        // Guard: service must resolve before the HTTP client can be configured.
         if (!service) {
           throw Error(`failed to configure service [${serviceName}]`);
         }

package/src/configure-modules.ts

@@ -92,13 +92,16 @@ export const configureModules =
     if (cb) {
       await Promise.resolve(cb(configurator, args));
     }
+    // Type cast is safe because AppConfigurator.initialize() returns the exact module
+    // instance that was registered and configured above. The intermediate 'unknown'
+    // cast is necessary due to TypeScript's generic inference limitations with the
+    // configurator's initialization chain, but the runtime value is guaranteed to match.
     const modules: AppModulesInstance<TModules> = (await configurator.initialize(
       args.fusion.modules,
-      // TODO: type cast to unknown should not be needed in future
     )) as unknown as AppModulesInstance<TModules>;
 
     // Dispatch app modules loaded event for app lifecycle tracking
-    // TODO - remove check after fusion-cli is updated (app module is not enabled in fusion-cli)
+    // TODO(#5061): remove check after fusion-cli is updated (app module is not enabled in fusion-cli)
     if (args.env.manifest?.appKey) {
       modules.event.dispatchEvent('onAppModulesLoaded', {
         detail: { appKey: args.env.manifest.appKey, manifest: args.env.manifest, modules },

package/src/enable-bookmark.ts

@@ -44,6 +44,7 @@ export const enableBookmark = (config: IAppConfigurator): void => {
       initialize(args) {
         // get the bookmark provider from the ref (portal)
         const provider = args.ref?.bookmark;
+        // Bail out early if the portal did not expose a bookmark provider.
         if (!provider) {
           console.error('Bookmark provider not found');
           return {};
@@ -51,6 +52,7 @@ export const enableBookmark = (config: IAppConfigurator): void => {
         // create a proxy to intercept the addPayloadGenerator method
         return new Proxy(provider, {
           get(target, prop) {
+            // Intercept specific property access to wrap bookmark lifecycle management.
             switch (prop) {
               case 'addPayloadGenerator':
                 return (generator: BookmarkPayloadGenerator) => {
@@ -82,6 +84,7 @@ export const enableBookmark = (config: IAppConfigurator): void => {
         });
       },
       dispose() {
+        // Run all registered cleanup functions to prevent memory leaks on module disposal.
         for (const teardown of cleanupFunctions) {
           teardown();
         }

package/src/types.ts

@@ -141,4 +141,5 @@ export type AppModuleInitArgs<TRef extends Fusion = Fusion, TEnv = AppEnv> = {
 export type AppRenderFn<TFusion extends Fusion = Fusion, TEnv = AppEnv> = (
   el: HTMLHtmlElement,
   args: ComponentRenderArgs<TFusion, TEnv>,
+  // biome-ignore lint/suspicious/noConfusingVoidType: `void` here relies on TypeScript's special-cased "void-returning callback accepts any return value" behavior \u2014 `undefined` would break assignability of render functions that return a cleanup function
 ) => VoidFunction | void;

package/src/version.ts

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