@equinor/fusion-framework-module-app 5.3.7 → 5.3.9

package/dist/types/AppConfigurator.d.ts

@@ -23,6 +23,9 @@ export declare class AppConfigurator implements IAppConfigurator {
     #private;
     defaultExpireTime: number;
     addConfigBuilder(init: AppConfigBuilderCallback): void;
+    /**
+     * WARNING: this function will be remove in future
+     */
     protected _createHttpClient(init: ModuleInitializerArgs<IAppConfigurator, [HttpModule, ServiceDiscoveryModule]>): Promise<IHttpClient>;
     createConfig(init: ModuleInitializerArgs<IAppConfigurator, [HttpModule, ServiceDiscoveryModule]>): Promise<AppModuleConfig>;
 }

package/dist/types/AppModuleProvider.d.ts

@@ -12,17 +12,43 @@ export declare class AppModuleProvider {
     appClient: Query<AppManifest, {
         appKey: string;
     }>;
+    /**
+     * fetch an application by key
+     * @param appKey - application key
+     * @remarks
+     * - null when current app is cleared
+     * - undefined if application never set
+     */
     get current(): CurrentApp | null | undefined;
     get current$(): Observable<CurrentApp | null>;
     constructor(args: {
         config: AppModuleConfig;
         event?: ModuleType<EventModule>;
     });
+    /**
+     * fetch an application by key
+     * @param appKey - application key
+     */
     getAppManifest(appKey: string): Observable<AppManifest>;
+    /**
+     * fetch all applications
+     */
     getAllAppManifests(): Observable<AppManifest[]>;
+    /**
+     * fetch configuration for an application
+     * @param appKey - application key
+     */
     getAppConfig<TType = unknown>(appKey: string, tag?: string): Observable<AppConfig<TType>>;
+    /**
+     * set the current application, will internally resolve manifest
+     * @param appKey - application key
+     */
     setCurrentApp(appKeyOrApp: string | IApp): void;
     clearCurrentApp(): void;
+    /**
+     * This should not be used, only for legacy creation backdoor
+     * @deprecated
+     */
     createApp(value: AppBundleStateInitial): App;
     dispose(): void;
 }

package/dist/types/app/App.d.ts

@@ -7,30 +7,130 @@ import { AnyModule, ModuleType } from '@equinor/fusion-framework-module';
 import { AppBundleState, AppBundleStateInitial } from './types';
 import './events';
 export declare function filterEmpty<T>(): OperatorFunction<T | null | undefined, T>;
+/**
+ * Represents an application in the framework.
+ * @template TEnv The type of the environment.
+ * @template TModules The type of the app modules.
+ */
 export interface IApp<TEnv = any, TModules extends Array<AnyModule> | unknown = unknown> {
+    /**
+     * Returns an observable that emits the app manifest.
+     * @returns An observable of type AppManifest.
+     */
     get manifest$(): Observable<AppManifest>;
+    /**
+     * Observable that emits the configuration of the app.
+     * @returns An Observable that emits the app configuration.
+     */
     get config$(): Observable<AppConfig<TEnv>>;
+    /**
+     * Returns an observable stream of the loaded app script instance.
+     * @returns {Observable<AppScriptModule>} The observable stream of app script modules.
+     */
     get modules$(): Observable<AppScriptModule>;
+    /**
+     * Returns an observable that emits the instance of the app modules.
+     * @returns An observable that emits the instance of the app modules.
+     */
     get instance$(): Observable<AppModulesInstance<TModules>>;
+    /**
+     * Gets the current state of the Application.
+     * @returns The current state of the Application.
+     */
     get state(): AppBundleState;
+    /**
+     * Gets the app key.
+     * @returns The app key.
+     */
     get appKey(): string;
+    /**
+     * Gets the manifest of the app.
+     * @returns The manifest of the app, or undefined if it doesn't exist.
+     */
     get manifest(): AppManifest | undefined;
+    /**
+     * Retrieves the manifest asynchronously.
+     * @returns A promise that resolves to the AppManifest.
+     */
     get manifestAsync(): Promise<AppManifest>;
+    /**
+     * Gets the configuration of the app.
+     * @returns The configuration object or undefined if no configuration is set.
+     */
     get config(): AppConfig<TEnv> | undefined;
+    /**
+     * Retrieves the configuration asynchronously.
+     * @returns A promise that resolves to the AppConfig.
+     */
     get instance(): AppModulesInstance<TModules> | undefined;
+    /**
+     * Initializes the application container.
+     * @returns An observable that emits an object containing the manifest, script, and config.
+     * @example
+     * ```typescript
+     * app.initialize().subscribe({
+     *   next: ({ manifest, script, config }) => {
+     *     // Use the manifest, script, and config to initialize the application
+     *     script.render(el, ...);
+     *   },
+     *   error: (err) => console.error('Failed to load application', err),
+     *   complete: () => setInitializingApp(false)
+     * });
+     * ```
+     */
     initialize(): Observable<{
         manifest: AppManifest;
         script: AppScriptModule;
         config: AppConfig;
     }>;
+    /**
+     * Loads the app configuration.
+     */
     loadConfig(): void;
+    /**
+     * Loads the app manifest.
+     */
     loadManifest(): void;
+    /**
+     * Loads the app module.
+     * @param allow_cache Whether to allow loading from cache.
+     */
     loadAppModule(allow_cache?: boolean): void;
+    /**
+     * Gets the app configuration.
+     * @param force_refresh Whether to force refreshing the configuration.
+     * @returns An observable that emits the app configuration.
+     */
     getConfig(force_refresh?: boolean): Observable<AppConfig>;
+    /**
+     * Retrieves the app configuration asynchronously.
+     * @param allow_cache Whether to allow loading from cache.
+     * @returns A promise that resolves to the AppConfig.
+     */
     getConfigAsync(allow_cache?: boolean): Promise<AppConfig>;
+    /**
+     * Gets the app manifest.
+     * @param force_refresh Whether to force refreshing the manifest.
+     * @returns An observable that emits the app manifest.
+     */
     getManifest(force_refresh?: boolean): Observable<AppManifest>;
+    /**
+     * Retrieves the app manifest asynchronously.
+     * @param allow_cache Whether to allow loading from cache.
+     * @returns A promise that resolves to the AppManifest.
+     */
     getManifestAsync(allow_cache?: boolean): Promise<AppManifest>;
+    /**
+     * Gets the app module.
+     * @param force_refresh Whether to force refreshing the app module.
+     * @returns An observable that emits the app module.
+     */
     getAppModule(force_refresh?: boolean): Observable<AppScriptModule>;
+    /**
+     * Retrieves the app module asynchronously.
+     * @param allow_cache Whether to allow loading from cache.
+     * @returns A promise that resolves to the AppScriptModule.
+     */
     getAppModuleAsync(allow_cache?: boolean): Promise<AppScriptModule>;
 }
 export declare class App<TEnv = any, TModules extends Array<AnyModule> | unknown = unknown> implements IApp<TEnv, TModules> {

package/dist/types/app/actions.d.ts

@@ -1,6 +1,7 @@
 import { ActionInstanceMap, ActionTypes } from '@equinor/fusion-observable';
 import { AppConfig, AppManifest, AppModulesInstance, AppScriptModule } from '../types';
 declare const createActions: () => {
+    /** Manifest loading */
     setManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[manifest: AppManifest, update?: boolean | undefined], AppManifest, "set_manifest", never, {
         created: number;
         update: boolean | undefined;
@@ -11,11 +12,13 @@ declare const createActions: () => {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[manifest: AppManifest], AppManifest, "fetch_manifest::success", never, never>;
         failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: unknown], unknown, "fetch_manifest::failure", never, never>;
     };
+    /** Config loading */
     setConfig: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[config: AppConfig], AppConfig, "set_config", never, never>;
     fetchConfig: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[key: string], string, "fetch_config::request", never, never> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[config: AppConfig], AppConfig, "fetch_config::success", never, never>;
         failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: unknown], unknown, "fetch_config::failure", never, never>;
     };
+    /** App loading */
     setModule: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[module: any], any, "set_module", never, never>;
     importApp: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[entrypoint: string], string, "import_app::request", never, never> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[module: AppScriptModule], AppScriptModule, "import_app::success", never, never>;
@@ -28,6 +31,7 @@ declare const createActions: () => {
     };
 };
 export declare const actions: {
+    /** Manifest loading */
     setManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[manifest: AppManifest, update?: boolean | undefined], AppManifest, "set_manifest", never, {
         created: number;
         update: boolean | undefined;
@@ -38,11 +42,13 @@ export declare const actions: {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[manifest: AppManifest], AppManifest, "fetch_manifest::success", never, never>;
         failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: unknown], unknown, "fetch_manifest::failure", never, never>;
     };
+    /** Config loading */
     setConfig: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[config: AppConfig], AppConfig, "set_config", never, never>;
     fetchConfig: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[key: string], string, "fetch_config::request", never, never> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[config: AppConfig], AppConfig, "fetch_config::success", never, never>;
         failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: unknown], unknown, "fetch_config::failure", never, never>;
     };
+    /** App loading */
     setModule: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[module: any], any, "set_module", never, never>;
     importApp: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[entrypoint: string], string, "import_app::request", never, never> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[module: AppScriptModule], AppScriptModule, "import_app::success", never, never>;

package/dist/types/app/events.d.ts

@@ -1,36 +1,54 @@
 import type { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
 import type { App } from './App';
 import type { AppConfig, AppManifest, AppModulesInstance, AppScriptModule } from '../types';
-export type AppEventEventInit<TDetail extends Record<string, unknown> | unknown = unknown> = FrameworkEventInit<TDetail & {
+/** base event type for applications */
+export type AppEventEventInit<TDetail extends Record<string, unknown> | unknown = unknown> = FrameworkEventInit<
+/** additional event details and key of target event */
+TDetail & {
     appKey: string;
-}, App>;
+}, 
+/** source of the event */
+App>;
 export type AppEvent<TDetail extends Record<string, unknown> | unknown = unknown> = FrameworkEvent<AppEventEventInit<TDetail>>;
 export type AppEventFailure = FrameworkEvent<AppEventEventInit<{
     error: AppConfig;
 }>>;
 declare module '@equinor/fusion-framework-module-event' {
     interface FrameworkEventMap {
+        /** fired when the application has initiated its modules */
         onAppModulesLoaded: AppEvent<{
+            /** initiated modules for application */
             modules: AppModulesInstance;
         }>;
         onAppManifestLoad: AppEvent;
+        /** fired when the application has loaded corresponding manifest */
         onAppManifestLoaded: AppEvent<{
             manifest: AppManifest;
         }>;
         onAppManifestFailure: AppEventFailure;
         onAppConfigLoad: AppEvent;
+        /** fired when the application has loaded corresponding config */
         onAppConfigLoaded: AppEvent<{
             config: AppConfig;
         }>;
         onAppConfigFailure: AppEventFailure;
+        /** fired when the application has loaded corresponding javascript module */
         onAppScriptLoad: AppEvent;
         onAppScriptLoaded: AppEvent<{
             script: AppScriptModule;
         }>;
         onAppScriptFailure: AppEventFailure;
+        /** fired before application loads manifest, config and script */
         onAppInitialize: AppEvent;
+        /**
+         * fired after application has loaded manifest, config and script
+         *
+         * __note:__ not fired until all loaders has settled (last emit)
+         */
         onAppInitialized: AppEvent;
+        /** fired when application fails to load either manifest, config and script */
         onAppInitializeFailure: AppEventFailure;
+        /** fired when the application is disposed (unmounts) */
         onAppDispose: FrameworkEvent<AppEventEventInit>;
     }
 }

package/dist/types/app/flows.d.ts

@@ -2,6 +2,24 @@ import type { Flow } from '@equinor/fusion-observable';
 import type { AppModuleProvider } from '../AppModuleProvider';
 import type { Actions } from './actions';
 import type { AppBundleState } from './types';
+/**
+ * Handles the fetch manifest action by fetching the app manifest from the provider,
+ * dispatching success or failure actions based on the result.
+ *
+ * @param provider The AppModuleProvider used to fetch the app manifest.
+ * @returns A Flow function that takes an Observable of actions and returns an Observable of actions.
+ */
 export declare const handleFetchManifest: (provider: AppModuleProvider) => Flow<Actions, AppBundleState>;
+/**
+ * Handles the fetch config action by fetching the app configuration from the provider,
+ * filtering out null values, and dispatching success or failure actions accordingly.
+ *
+ * @param provider The AppModuleProvider used to fetch the app configuration.
+ * @returns A Flow function that takes an Observable of actions and returns an Observable of actions.
+ */
 export declare const handleFetchConfig: (provider: AppModuleProvider) => Flow<Actions, AppBundleState>;
+/**
+ * Handles the import application flow.
+ * @returns A flow that takes in actions and returns an observable of AppBundleState.
+ */
 export declare const handleImportApplication: () => Flow<Actions, AppBundleState>;

package/dist/types/enable-app-module.d.ts

@@ -1,3 +1,7 @@
 import type { IModulesConfigurator } from '@equinor/fusion-framework-module';
 import type { AppConfigBuilderCallback } from './AppConfigBuilder';
+/**
+ * Method for enabling the Service module
+ * @param configurator - configuration object
+ */
 export declare const enableAppModule: (configurator: IModulesConfigurator<any, any>, builder?: AppConfigBuilderCallback) => void;

package/dist/types/errors.d.ts

@@ -1,16 +1,55 @@
 type AppErrorType = 'not_found' | 'unauthorized' | 'unknown';
+/**
+ * Represents an error that occurs when loading an application manifest.
+ */
 export declare class AppManifestError extends Error {
     readonly type: AppErrorType;
+    /**
+     * Creates an instance of AppManifestError based on the HTTP response status.
+     * @param response The HTTP response.
+     * @param options Optional error options.
+     * @returns An instance of AppManifestError.
+     */
     static fromHttpResponse(response: Response, options?: ErrorOptions): AppManifestError;
+    /**
+     * Creates an instance of AppManifestError.
+     * @param type The type of the error.
+     * @param message The error message.
+     * @param options Optional error options.
+     */
     constructor(type: AppErrorType, message?: string, options?: ErrorOptions);
 }
+/**
+ * Represents an error that occurs in the application configuration.
+ */
 export declare class AppConfigError extends Error {
     readonly type: AppErrorType;
+    /**
+     * Creates an instance of `AppConfigError` based on the HTTP response status.
+     * @param response The HTTP response.
+     * @param options Additional error options.
+     * @returns An instance of `AppConfigError` based on the HTTP response status.
+     */
     static fromHttpResponse(response: Response, options?: ErrorOptions): AppConfigError;
+    /**
+     * Creates an instance of `AppConfigError`.
+     * @param type The type of the application error.
+     * @param message The error message.
+     * @param options Additional error options.
+     */
     constructor(type: AppErrorType, message?: string, options?: ErrorOptions);
 }
+/**
+ * Represents an error that occurs when loading the application script.
+ */
 export declare class AppScriptModuleError extends Error {
     readonly type: AppErrorType;
+    /**
+     * Creates a new instance of the AppScriptModuleError class.
+     * @param type The type of the error.
+     * @param message The error message.
+     * @param options Additional options for the error.
+     */
     constructor(type: AppErrorType, message?: string, options?: ErrorOptions);
 }
 export {};

package/dist/types/events.d.ts

@@ -3,8 +3,11 @@ import { App } from './app/App';
 import './app/events';
 declare module '@equinor/fusion-framework-module-event' {
     interface FrameworkEventMap {
+        /** fired when the current selected application changes */
         onCurrentAppChanged: FrameworkEvent<FrameworkEventInit<{
+            /** current application  */
             next?: App;
+            /** previous application */
             previous?: App;
         }>>;
     }

package/dist/types/helpers.d.ts

@@ -1,2 +1,10 @@
 import { AppManifest } from './types';
+/**
+ * Compares two app manifests for equality.
+ *
+ * @template T - The type of the app manifest.
+ * @param a - The first app manifest.
+ * @param b - The second app manifest.
+ * @returns True if the app manifests are equal, false otherwise.
+ */
 export declare const compareAppManifest: <T extends AppManifest>(a?: T, b?: T) => boolean;

package/dist/types/module.d.ts

@@ -4,6 +4,11 @@ import { IAppConfigurator } from './AppConfigurator';
 import { AppModuleProvider } from './AppModuleProvider';
 export declare const moduleKey = "app";
 export type AppModule = Module<typeof moduleKey, AppModuleProvider, IAppConfigurator, ModuleDeps>;
+/**
+ * Represents a module for handling applications.
+ * Responsible for loading applications, configurations and manifests.
+ * @public
+ */
 export declare const module: AppModule;
 export default module;
 declare module '@equinor/fusion-framework-module' {

package/dist/types/types.d.ts

@@ -51,6 +51,10 @@ export type AppConfig<TEnvironment = unknown> = {
     environment: TEnvironment;
     endpoints: Record<string, string | Endpoint>;
 };
+/**
+ * @template TEnvironment - name of hosted environment
+ * @template TModule - ES module type (import return type)
+ */
 export type AppBundle<TEnvironment = unknown, TModule = unknown> = {
     manifest: AppManifest;
     config: AppConfig<TEnvironment>;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.3.7";
+export declare const version = "5.3.9";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-app",
-  "version": "5.3.7",
+  "version": "5.3.9",
   "description": "",
   "main": "dist/esm/index.js",
   "exports": {
@@ -48,16 +48,16 @@
   "dependencies": {
     "immer": "^9.0.16",
     "rxjs": "^7.8.1",
-    "@equinor/fusion-observable": "^8.3.2",
-    "@equinor/fusion-query": "^5.0.5"
+    "@equinor/fusion-observable": "^8.4.0",
+    "@equinor/fusion-query": "^5.1.1"
   },
   "devDependencies": {
-    "typescript": "^5.4.2",
-    "@equinor/fusion-framework-module": "^4.3.1",
-    "@equinor/fusion-framework-module-event": "^4.1.2",
-    "@equinor/fusion-framework-module-http": "^6.0.0",
-    "@equinor/fusion-framework-module-msal": "^3.1.1",
-    "@equinor/fusion-framework-module-service-discovery": "^7.1.9"
+    "typescript": "^5.5.3",
+    "@equinor/fusion-framework-module-event": "^4.2.2",
+    "@equinor/fusion-framework-module-http": "^6.0.2",
+    "@equinor/fusion-framework-module-msal": "^3.1.3",
+    "@equinor/fusion-framework-module-service-discovery": "^7.1.11",
+    "@equinor/fusion-framework-module": "^4.3.3"
   },
   "scripts": {
     "build": "tsc -b"

package/src/version.ts

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