@equinor/fusion-framework-app 9.1.2 → 9.1.4

package/dist/types/AppConfigurator.d.ts

@@ -3,10 +3,56 @@ import { type AnyModule, type IModulesConfigurator, ModulesConfigurator } from '
 import { configureHttpClient, configureHttp, type HttpClientOptions } from '@equinor/fusion-framework-module-http';
 import { configureMsal } from '@equinor/fusion-framework-module-msal';
 import { AppEnv, AppModules } from './types';
+/**
+ * Configurator for configuring application modules
+ *
+ * @template TModules Addition modules
+ * @template TRef usually undefined, optional references
+ */
 export interface IAppConfigurator<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]
+     * Configure a named http client.
+     * @example
+     * ```ts
+     configurator.configureHttpClient(
+        'myClient',
+        {
+            baseUri: 'https://foo.bar',
+            defaultScopes: ['client-id/.default']
+        }
+    );
+     * ```
+     */
     configureHttpClient(...args: Parameters<typeof configureHttpClient>): void;
+    /**
+     * [required]
+     * Setup of MSAL auth module
+     * @example
+     * ```ts
+     configurator.configureMsal(
+        {
+            tenantId: '{TENANT_ID}',
+            clientId: '{CLIENT_ID}',
+            redirectUri: '/authentication/login-callback',
+        },
+        { requiresAuth: true }
+    );
+     * ```
+     */
     configureMsal(...args: Parameters<typeof configureMsal>): void;
+    /**
+     * [optional]
+     *
+     * configure a http client which is resolved by service discovery
+     *
+     * @param serviceName - name of the service to use
+     */
     useFrameworkServiceClient(serviceName: string, options?: Omit<HttpClientOptions<any>, 'baseUri' | 'defaultScopes'>): void;
 }
 export declare 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> {

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

@@ -1,8 +1,27 @@
 import { Fusion } from '@equinor/fusion-framework';
 import type { AnyModule } from '@equinor/fusion-framework-module';
 import type { AppModulesInstance, AppModuleInitiator, AppEnv } from './types';
-export declare const configureModules: <TModules extends AnyModule[], TRef extends Fusion<unknown> = Fusion<unknown>, TEnv extends AppEnv = AppEnv>(cb?: AppModuleInitiator<TModules, TRef, TEnv>) => (args: {
+/**
+ *
+ * Creates a callback for initializing configuration of application modules
+ *
+ * @example
+ ```ts
+    const initialize =  configureModules((configurator, args) => {
+        configurator.configure(someModule);
+    });
+    await initialize({ fusion, { manifest, config }});
+ ```
+ * @template TModules Addition modules
+ * @template TRef usually undefined, optional references
+ * @template TEnv environment object for configuring modules
+ *
+ * @param cb configuration callback
+ *
+ * @returns initialize function, executes configurator
+ */
+export declare const configureModules: <TModules extends Array<AnyModule> | never, TRef extends Fusion = Fusion<unknown>, TEnv extends AppEnv = AppEnv>(cb?: AppModuleInitiator<TModules, TRef, TEnv>) => ((args: {
     fusion: TRef;
     env: TEnv;
-}) => Promise<AppModulesInstance<TModules>>;
+}) => Promise<AppModulesInstance<TModules>>);
 export default configureModules;

package/dist/types/types.d.ts

@@ -3,19 +3,57 @@ 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';
 export type { AppModules, AppManifest, AppConfig, AppModulesInstance, } from '@equinor/fusion-framework-module-app';
+/**
+ * Application environment args
+ * Arguments provided when initializing/configuring application modules
+ *
+ * @template TConfig config value type
+ * @template TProps [__not in use__] properties for application component
+ */
 export type AppEnv<TConfig = unknown, TProps = unknown> = {
+    /** base routing path of the application */
     basename?: string;
     manifest: AppManifest;
     config?: AppConfig<TConfig>;
     props?: TProps;
 };
+/**
+ * Blueprint for initializing application modules
+ *
+ * @template TModules Addition modules
+ * @template TRef usually undefined, optional references
+ * @template TEnv environment object for configuring modules
+ */
 export type AppModuleInitiator<TModules extends Array<AnyModule> | unknown = unknown, TRef extends Fusion = Fusion, TEnv = AppEnv> = (configurator: IAppConfigurator<TModules, TRef['modules']>, args: {
     fusion: TRef;
     env: TEnv;
 }) => void | Promise<void>;
+/**
+ * Blueprint for creating application initialization
+ *
+ * @template TModules Addition modules
+ * @template TRef usually undefined, optional references
+ * @template TEnv environment object for configuring modules
+ */
 export type AppModuleInit<TModules extends Array<AnyModule> | unknown = [], TRef extends Fusion = Fusion, TEnv = AppEnv> = (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;
 };
+/**
+ * Type definition for AppRenderFn.
+ * This type is responsible for rendering the application within a given environment.
+ * It takes a generic `TFusion` type parameter extending `Fusion` for the Fusion instance,
+ * and an optional `TEnv` type parameter for the application environment, defaulting to `AppEnv`.
+ *
+ * @param el - The root document element where the application will be rendered.
+ * @param args - An object containing arguments required for component rendering, including the Fusion instance and environment-specific configurations.
+ * @returns A function that can be invoked to perform cleanup operations, or `void` if no cleanup is necessary.
+ *
+ * @example
+ * const renderMyApp: AppRenderFn = (el, args) => {
+ *   // Implementation for rendering the application
+ *   // Optionally return a cleanup function
+ * };
+ */
 export type AppRenderFn<TFusion extends Fusion = Fusion, TEnv = AppEnv> = (el: HTMLHtmlElement, args: ComponentRenderArgs<TFusion, TEnv>) => VoidFunction | void;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "9.1.2";
+export declare const version = "9.1.4";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-app",
-  "version": "9.1.2",
+  "version": "9.1.4",
   "description": "",
   "main": "dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -31,18 +31,18 @@
     "directory": "packages/app"
   },
   "dependencies": {
-    "@equinor/fusion-framework": "^7.2.1",
-    "@equinor/fusion-framework-module": "^4.3.1",
-    "@equinor/fusion-framework-module-app": "^5.3.7",
-    "@equinor/fusion-framework-module-event": "^4.1.2",
-    "@equinor/fusion-framework-module-msal": "^3.1.1",
-    "@equinor/fusion-framework-module-http": "^6.0.0"
+    "@equinor/fusion-framework": "^7.2.3",
+    "@equinor/fusion-framework-module-app": "^5.3.8",
+    "@equinor/fusion-framework-module": "^4.3.2",
+    "@equinor/fusion-framework-module-event": "^4.2.1",
+    "@equinor/fusion-framework-module-http": "^6.0.1",
+    "@equinor/fusion-framework-module-msal": "^3.1.2"
   },
   "devDependencies": {
-    "typescript": "^5.4.2"
+    "typescript": "^5.5.3"
   },
   "peerDependencies": {
-    "@equinor/fusion-framework-module-feature-flag": "^1.1.4"
+    "@equinor/fusion-framework-module-feature-flag": "^1.1.5"
   },
   "peerDependenciesMeta": {
     "@equinor/fusion-framework-module-feature-flag": {

package/src/version.ts

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