@equinor/fusion-framework-app 9.3.0 → 9.3.2

package/dist/types/AppConfigurator.d.ts

@@ -1,7 +1,7 @@
-import { type FusionModulesInstance } from '@equinor/fusion-framework';
+import type { FusionModulesInstance } from '@equinor/fusion-framework';
 import { type AnyModule, type IModulesConfigurator, ModulesConfigurator } from '@equinor/fusion-framework-module';
 import { configureHttpClient, configureHttp, type HttpClientOptions } from '@equinor/fusion-framework-module-http';
-import { AppEnv, AppModules } from './types';
+import type { AppEnv, AppModules } from './types';
 /**
  * Configurator for configuring application modules
  *
@@ -15,19 +15,19 @@ export interface IAppConfigurator<TModules extends Array<AnyModule> | unknown =
      */
     configureHttp(...args: Parameters<typeof configureHttp>): void;
     /**
-     * [optional]
-     * Configure a named http client.
-     * @example
-     * ```ts
-     configurator.configureHttpClient(
-        'myClient',
-        {
-            baseUri: 'https://foo.bar',
-            defaultScopes: ['client-id/.default']
-        }
-    );
-     * ```
-     */
+       * [optional]
+       * Configure a named http client.
+       * @example
+       * ```ts
+       configurator.configureHttpClient(
+          'myClient',
+          {
+              baseUri: 'https://foo.bar',
+              defaultScopes: ['client-id/.default']
+          }
+      );
+       * ```
+       */
     configureHttpClient(...args: Parameters<typeof configureHttpClient>): void;
     /**
      * [optional]

package/dist/types/configure-modules.d.ts

@@ -1,4 +1,4 @@
-import { Fusion } from '@equinor/fusion-framework';
+import type { Fusion } from '@equinor/fusion-framework';
 import type { AnyModule } from '@equinor/fusion-framework-module';
 import type { AppModulesInstance, AppModuleInitiator, AppEnv } from './types';
 /**

package/dist/types/types.d.ts

@@ -2,7 +2,7 @@ import type { Fusion } from '@equinor/fusion-framework';
 import type { AnyModule } from '@equinor/fusion-framework-module';
 import type { AppConfig, AppManifest, AppModulesInstance, ComponentRenderArgs } from '@equinor/fusion-framework-module-app';
 import type { IAppConfigurator } from './AppConfigurator';
-import { ConfigEnvironment } from '@equinor/fusion-framework-module-app';
+import type { ConfigEnvironment } from '@equinor/fusion-framework-module-app';
 export type { AppModules, AppManifest, AppConfig, AppModulesInstance, } from '@equinor/fusion-framework-module-app';
 /**
  * Application environment args

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "9.3.0";
+export declare const version = "9.3.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-app",
-  "version": "9.3.0",
+  "version": "9.3.2",
   "description": "",
   "main": "dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -42,19 +42,19 @@
     "directory": "packages/app"
   },
   "dependencies": {
-    "@equinor/fusion-framework": "^7.3.0",
-    "@equinor/fusion-framework-module": "^4.3.5",
-    "@equinor/fusion-framework-module-app": "^6.1.4",
-    "@equinor/fusion-framework-module-event": "^4.3.0",
-    "@equinor/fusion-framework-module-http": "^6.2.1",
-    "@equinor/fusion-framework-module-msal": "^4.0.0"
+    "@equinor/fusion-framework": "^7.3.2",
+    "@equinor/fusion-framework-module": "^4.3.6",
+    "@equinor/fusion-framework-module-app": "^6.1.5",
+    "@equinor/fusion-framework-module-event": "^4.3.1",
+    "@equinor/fusion-framework-module-http": "^6.2.2",
+    "@equinor/fusion-framework-module-msal": "^4.0.1"
   },
   "devDependencies": {
-    "typescript": "^5.5.4",
-    "@equinor/fusion-framework-module-bookmark": "^2.1.1"
+    "typescript": "^5.7.3",
+    "@equinor/fusion-framework-module-bookmark": "^2.1.2"
   },
   "peerDependencies": {
-    "@equinor/fusion-framework-module-bookmark": "^2.1.1"
+    "@equinor/fusion-framework-module-bookmark": "^2.1.2"
   },
   "peerDependenciesMeta": {
     "@equinor/fusion-framework-module-bookmark": {

package/src/AppConfigurator.ts

@@ -1,23 +1,23 @@
-import { type FusionModulesInstance } from '@equinor/fusion-framework';
+import type { FusionModulesInstance } from '@equinor/fusion-framework';
 
 import {
-    type AnyModule,
-    type IModulesConfigurator,
-    ModuleConsoleLogger,
-    ModulesConfigurator,
+  type AnyModule,
+  type IModulesConfigurator,
+  ModuleConsoleLogger,
+  ModulesConfigurator,
 } from '@equinor/fusion-framework-module';
 
 import event from '@equinor/fusion-framework-module-event';
 
 import http, {
-    configureHttpClient,
-    configureHttp,
-    type HttpClientOptions,
+  configureHttpClient,
+  configureHttp,
+  type HttpClientOptions,
 } from '@equinor/fusion-framework-module-http';
 
 import auth from '@equinor/fusion-framework-module-msal';
 
-import { AppEnv, AppModules } from './types';
+import type { AppEnv, AppModules } from './types';
 
 /**
  * Configurator for configuring application modules
@@ -26,16 +26,16 @@ import { AppEnv, AppModules } from './types';
  * @template TRef usually undefined, optional references
  */
 export interface IAppConfigurator<
-    TModules extends Array<AnyModule> | unknown = unknown,
-    TRef extends FusionModulesInstance = FusionModulesInstance,
+  TModules extends Array<AnyModule> | unknown = unknown,
+  TRef extends FusionModulesInstance = FusionModulesInstance,
 > extends IModulesConfigurator<AppModules<TModules>, TRef> {
-    /**
-     * [optional]
-     * enable/configure the http module
-     */
-    configureHttp(...args: Parameters<typeof configureHttp>): void;
+  /**
+   * [optional]
+   * enable/configure the http module
+   */
+  configureHttp(...args: Parameters<typeof configureHttp>): void;
 
-    /**
+  /**
      * [optional]
      * Configure a named http client.
      * @example
@@ -49,64 +49,64 @@ export interface IAppConfigurator<
     );
      * ```
      */
-    configureHttpClient(...args: Parameters<typeof configureHttpClient>): void;
+  configureHttpClient(...args: Parameters<typeof configureHttpClient>): void;
 
-    /**
-     * [optional]
-     *
-     * configure a http client which is resolved by service discovery
-     *
-     * @param serviceName - name of the service to use
-     */
-    // TODO - rename
-    useFrameworkServiceClient(
-        serviceName: string,
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        options?: Omit<HttpClientOptions<any>, 'baseUri' | 'defaultScopes'>,
-    ): void;
+  /**
+   * [optional]
+   *
+   * configure a http client which is resolved by service discovery
+   *
+   * @param serviceName - name of the service to use
+   */
+  // TODO - rename
+  useFrameworkServiceClient(
+    serviceName: string,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    options?: Omit<HttpClientOptions<any>, 'baseUri' | 'defaultScopes'>,
+  ): void;
 }
 
 export class AppConfigurator<
-        TModules extends Array<AnyModule> | unknown = unknown,
-        TRef extends FusionModulesInstance = FusionModulesInstance,
-        TEnv extends AppEnv = AppEnv,
-    >
-    extends ModulesConfigurator<AppModules<TModules>, TRef>
-    implements IAppConfigurator<TModules, TRef>
+    TModules extends Array<AnyModule> | unknown = unknown,
+    TRef extends FusionModulesInstance = FusionModulesInstance,
+    TEnv extends AppEnv = AppEnv,
+  >
+  extends ModulesConfigurator<AppModules<TModules>, TRef>
+  implements IAppConfigurator<TModules, TRef>
 {
-    constructor(public readonly env: TEnv) {
-        super([event, http, auth]);
-        this.logger = new ModuleConsoleLogger('AppConfigurator');
-    }
+  constructor(public readonly env: TEnv) {
+    super([event, http, auth]);
+    this.logger = new ModuleConsoleLogger('AppConfigurator');
+  }
 
-    public configureHttp(...args: Parameters<typeof configureHttp>) {
-        this.addConfig(configureHttp(...args));
-    }
+  public configureHttp(...args: Parameters<typeof configureHttp>) {
+    this.addConfig(configureHttp(...args));
+  }
 
-    public configureHttpClient(...args: Parameters<typeof configureHttpClient>) {
-        this.addConfig(configureHttpClient(...args));
-    }
+  public configureHttpClient(...args: Parameters<typeof configureHttpClient>) {
+    this.addConfig(configureHttpClient(...args));
+  }
 
-    public useFrameworkServiceClient(
-        serviceName: string,
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        options?: Omit<HttpClientOptions<any>, 'baseUri' | 'defaultScopes'>,
-    ): void {
-        this.addConfig({
-            module: http,
-            configure: async (config, ref) => {
-                const service = await ref?.serviceDiscovery.resolveService(serviceName);
-                if (!service) {
-                    throw Error(`failed to configure service [${serviceName}]`);
-                }
-                config.configureClient(serviceName, {
-                    ...options,
-                    baseUri: service.uri,
-                    defaultScopes: service.defaultScopes,
-                });
-            },
+  public useFrameworkServiceClient(
+    serviceName: string,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    options?: Omit<HttpClientOptions<any>, 'baseUri' | 'defaultScopes'>,
+  ): void {
+    this.addConfig({
+      module: http,
+      configure: async (config, ref) => {
+        const service = await ref?.serviceDiscovery.resolveService(serviceName);
+        if (!service) {
+          throw Error(`failed to configure service [${serviceName}]`);
+        }
+        config.configureClient(serviceName, {
+          ...options,
+          baseUri: service.uri,
+          defaultScopes: service.defaultScopes,
         });
-    }
+      },
+    });
+  }
 }
 
 export default AppConfigurator;

package/src/configure-modules.ts

@@ -1,4 +1,4 @@
-import { Fusion } from '@equinor/fusion-framework';
+import type { Fusion } from '@equinor/fusion-framework';
 import type { AnyModule } from '@equinor/fusion-framework-module';
 
 import { AppConfigurator } from './AppConfigurator';
@@ -24,38 +24,38 @@ import type { AppModulesInstance, AppModuleInitiator, AppEnv } from './types';
  * @returns initialize function, executes configurator
  */
 export const configureModules =
-    <
-        TModules extends Array<AnyModule> | never,
-        TRef extends Fusion = Fusion,
-        TEnv extends AppEnv = AppEnv,
-    >(
-        cb?: AppModuleInitiator<TModules, TRef, TEnv>,
-    ): ((args: { fusion: TRef; env: TEnv }) => Promise<AppModulesInstance<TModules>>) =>
-    /**
-     *
-     * Callback for initializing application modules
-     *
-     * @param args - Fusion and application  environments (manifest, config ...)
-     * @returns initialized app modules
-     */
-    async (args: { fusion: TRef; env: TEnv }): Promise<AppModulesInstance<TModules>> => {
-        const configurator = new AppConfigurator<TModules, TRef['modules'], TEnv>(args.env);
-        if (cb) {
-            await Promise.resolve(cb(configurator, args));
-        }
-        const modules = (await configurator.initialize(
-            args.fusion.modules,
-            // TODO
-        )) as unknown as AppModulesInstance<TModules>;
+  <
+    TModules extends Array<AnyModule> | never,
+    TRef extends Fusion = Fusion,
+    TEnv extends AppEnv = AppEnv,
+  >(
+    cb?: AppModuleInitiator<TModules, TRef, TEnv>,
+  ): ((args: { fusion: TRef; env: TEnv }) => Promise<AppModulesInstance<TModules>>) =>
+  /**
+   *
+   * Callback for initializing application modules
+   *
+   * @param args - Fusion and application  environments (manifest, config ...)
+   * @returns initialized app modules
+   */
+  async (args: { fusion: TRef; env: TEnv }): Promise<AppModulesInstance<TModules>> => {
+    const configurator = new AppConfigurator<TModules, TRef['modules'], TEnv>(args.env);
+    if (cb) {
+      await Promise.resolve(cb(configurator, args));
+    }
+    const modules = (await configurator.initialize(
+      args.fusion.modules,
+      // TODO
+    )) as unknown as AppModulesInstance<TModules>;
 
-        // @eikeland
-        // TODO - 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, modules },
-            });
-        }
-        return modules;
-    };
+    // @eikeland
+    // TODO - 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, modules },
+      });
+    }
+    return modules;
+  };
 
 export default configureModules;

package/src/enable-bookmark.ts

@@ -1,6 +1,6 @@
 import type {
-    BookmarkModule,
-    BookmarkPayloadGenerator,
+  BookmarkModule,
+  BookmarkPayloadGenerator,
 } from '@equinor/fusion-framework-module-bookmark';
 import type { IAppConfigurator } from './AppConfigurator';
 
@@ -16,57 +16,57 @@ import type { IAppConfigurator } from './AppConfigurator';
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const enableBookmark = (config: IAppConfigurator): void => {
-    // collection of cleanup functions
-    const cleanupFunctions = new Set<VoidFunction>();
-    config.addConfig({
-        module: {
-            name: 'bookmark',
-            initialize(args) {
-                // get the bookmark provider from the ref (portal)
-                const provider = args.ref?.bookmark;
-                if (!provider) {
-                    console.error('Bookmark provider not found');
-                    return {};
-                }
-                // create a proxy to intercept the addPayloadGenerator method
-                return new Proxy(provider, {
-                    get(target, prop) {
-                        switch (prop) {
-                            case 'addPayloadGenerator':
-                                return (generator: BookmarkPayloadGenerator) => {
-                                    // catch the teardown function and add it to the cleanup functions
-                                    const cleanupHandler = target.addPayloadGenerator(generator);
-                                    cleanupFunctions.add(cleanupHandler);
-                                    // wrap the teardown function to remove it from the cleanup functions
-                                    return () => {
-                                        cleanupFunctions.delete(cleanupHandler);
-                                        cleanupHandler();
-                                    };
-                                };
-                        }
-                        /**
-                         * If the property is not addPayloadGenerator, we want to access the property on the provider
-                         *
-                         * @note we can not use the Reflect API to access the property, as the provider is a proxy
-                         * and the Reflect API will not work as expected (can not access private properties)
-                         */
-                        if (prop in target) {
-                            // if the property is a function, bind it to the provider
-                            if (typeof target[prop] === 'function') {
-                                return target[prop].bind(target);
-                            }
-                            // access the property
-                            return target[prop];
-                        }
-                    },
-                });
-            },
-            dispose() {
-                for (const teardown of cleanupFunctions) {
-                    teardown();
-                }
-                cleanupFunctions.clear();
-            },
-        } satisfies BookmarkModule,
-    });
+  // collection of cleanup functions
+  const cleanupFunctions = new Set<VoidFunction>();
+  config.addConfig({
+    module: {
+      name: 'bookmark',
+      initialize(args) {
+        // get the bookmark provider from the ref (portal)
+        const provider = args.ref?.bookmark;
+        if (!provider) {
+          console.error('Bookmark provider not found');
+          return {};
+        }
+        // create a proxy to intercept the addPayloadGenerator method
+        return new Proxy(provider, {
+          get(target, prop) {
+            switch (prop) {
+              case 'addPayloadGenerator':
+                return (generator: BookmarkPayloadGenerator) => {
+                  // catch the teardown function and add it to the cleanup functions
+                  const cleanupHandler = target.addPayloadGenerator(generator);
+                  cleanupFunctions.add(cleanupHandler);
+                  // wrap the teardown function to remove it from the cleanup functions
+                  return () => {
+                    cleanupFunctions.delete(cleanupHandler);
+                    cleanupHandler();
+                  };
+                };
+            }
+            /**
+             * If the property is not addPayloadGenerator, we want to access the property on the provider
+             *
+             * @note we can not use the Reflect API to access the property, as the provider is a proxy
+             * and the Reflect API will not work as expected (can not access private properties)
+             */
+            if (prop in target) {
+              // if the property is a function, bind it to the provider
+              if (typeof target[prop] === 'function') {
+                return target[prop].bind(target);
+              }
+              // access the property
+              return target[prop];
+            }
+          },
+        });
+      },
+      dispose() {
+        for (const teardown of cleanupFunctions) {
+          teardown();
+        }
+        cleanupFunctions.clear();
+      },
+    } satisfies BookmarkModule,
+  });
 };

package/src/types.ts

@@ -3,20 +3,20 @@ import type { Fusion } from '@equinor/fusion-framework';
 import type { AnyModule } from '@equinor/fusion-framework-module';
 
 import type {
-    AppConfig,
-    AppManifest,
-    AppModulesInstance,
-    ComponentRenderArgs,
+  AppConfig,
+  AppManifest,
+  AppModulesInstance,
+  ComponentRenderArgs,
 } from '@equinor/fusion-framework-module-app';
 
 import type { IAppConfigurator } from './AppConfigurator';
-import { ConfigEnvironment } from '@equinor/fusion-framework-module-app';
+import type { ConfigEnvironment } from '@equinor/fusion-framework-module-app';
 
 export type {
-    AppModules,
-    AppManifest,
-    AppConfig,
-    AppModulesInstance,
+  AppModules,
+  AppManifest,
+  AppConfig,
+  AppModulesInstance,
 } from '@equinor/fusion-framework-module-app';
 
 /**
@@ -27,11 +27,11 @@ export type {
  * @template TProps [__not in use__] properties for application component
  */
 export type AppEnv<TConfig extends ConfigEnvironment = ConfigEnvironment, TProps = unknown> = {
-    /** base routing path of the application */
-    basename?: string;
-    manifest: AppManifest;
-    config?: AppConfig<TConfig>;
-    props?: TProps;
+  /** base routing path of the application */
+  basename?: string;
+  manifest: AppManifest;
+  config?: AppConfig<TConfig>;
+  props?: TProps;
 };
 
 /**
@@ -42,12 +42,12 @@ export type AppEnv<TConfig extends ConfigEnvironment = ConfigEnvironment, TProps
  * @template TEnv environment object for configuring modules
  */
 export type AppModuleInitiator<
-    TModules extends Array<AnyModule> | unknown = unknown,
-    TRef extends Fusion = Fusion,
-    TEnv = AppEnv,
+  TModules extends Array<AnyModule> | unknown = unknown,
+  TRef extends Fusion = Fusion,
+  TEnv = AppEnv,
 > = (
-    configurator: IAppConfigurator<TModules, TRef['modules']>,
-    args: { fusion: TRef; env: TEnv },
+  configurator: IAppConfigurator<TModules, TRef['modules']>,
+  args: { fusion: TRef; env: TEnv },
 ) => void | Promise<void>;
 
 /**
@@ -58,16 +58,16 @@ export type AppModuleInitiator<
  * @template TEnv environment object for configuring modules
  */
 export type AppModuleInit<
-    TModules extends Array<AnyModule> | unknown = [],
-    TRef extends Fusion = Fusion,
-    TEnv = AppEnv,
+  TModules extends Array<AnyModule> | unknown = [],
+  TRef extends Fusion = Fusion,
+  TEnv = AppEnv,
 > = (
-    cb: AppModuleInitiator<TModules, TRef, TEnv>,
+  cb: AppModuleInitiator<TModules, TRef, TEnv>,
 ) => (args: AppModuleInitArgs<TRef, TEnv>) => Promise<AppModulesInstance<TModules>>;
 
 export type AppModuleInitArgs<TRef extends Fusion = Fusion, TEnv = AppEnv> = {
-    fusion: TRef;
-    env: TEnv;
+  fusion: TRef;
+  env: TEnv;
 };
 
 /**
@@ -87,6 +87,6 @@ export type AppModuleInitArgs<TRef extends Fusion = Fusion, TEnv = AppEnv> = {
  * };
  */
 export type AppRenderFn<TFusion extends Fusion = Fusion, TEnv = AppEnv> = (
-    el: HTMLHtmlElement,
-    args: ComponentRenderArgs<TFusion, TEnv>,
+  el: HTMLHtmlElement,
+  args: ComponentRenderArgs<TFusion, TEnv>,
 ) => VoidFunction | void;

package/src/version.ts

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