@equinor/fusion-framework-module-app 5.1.2 → 5.2.0

package/dist/types/AppModuleProvider.d.ts

@@ -3,7 +3,7 @@ import { ModuleType } from '@equinor/fusion-framework-module';
 import { EventModule } from '@equinor/fusion-framework-module-event';
 import { Query } from '@equinor/fusion-query';
 import type { AppConfig, AppManifest, CurrentApp } from './types';
-import { App } from './app/App';
+import { App, IApp } from './app/App';
 import { AppModuleConfig } from './AppConfigurator';
 import { AppBundleStateInitial } from './app/types';
 export declare class AppModuleProvider {
@@ -21,7 +21,7 @@ export declare class AppModuleProvider {
     getAppManifest(appKey: string): Observable<AppManifest>;
     getAllAppManifests(): Observable<AppManifest[]>;
     getAppConfig<TType = unknown>(appKey: string, tag?: string): Observable<AppConfig<TType>>;
-    setCurrentApp(appKeyOrApp: string | App): void;
+    setCurrentApp(appKeyOrApp: string | IApp): void;
     clearCurrentApp(): void;
     createApp(value: AppBundleStateInitial): App;
     dispose(): void;

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

@@ -7,7 +7,33 @@ 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>;
-export declare class App<TEnv = any, TModules extends Array<AnyModule> | unknown = unknown> {
+export interface IApp<TEnv = any, TModules extends Array<AnyModule> | unknown = unknown> {
+    get manifest$(): Observable<AppManifest>;
+    get config$(): Observable<AppConfig<TEnv>>;
+    get modules$(): Observable<AppScriptModule>;
+    get instance$(): Observable<AppModulesInstance<TModules>>;
+    get state(): AppBundleState;
+    get appKey(): string;
+    get manifest(): AppManifest | undefined;
+    get manifestAsync(): Promise<AppManifest>;
+    get config(): AppConfig<TEnv> | undefined;
+    get instance(): AppModulesInstance<TModules> | undefined;
+    initialize(): Observable<{
+        manifest: AppManifest;
+        script: AppScriptModule;
+        config: AppConfig;
+    }>;
+    loadConfig(): void;
+    loadManifest(): void;
+    loadAppModule(allow_cache?: boolean): void;
+    getConfig(force_refresh?: boolean): Observable<AppConfig>;
+    getConfigAsync(allow_cache?: boolean): Promise<AppConfig>;
+    getManifest(force_refresh?: boolean): Observable<AppManifest>;
+    getManifestAsync(allow_cache?: boolean): Promise<AppManifest>;
+    getAppModule(force_refresh?: boolean): Observable<AppScriptModule>;
+    getAppModuleAsync(allow_cache?: boolean): Promise<AppScriptModule>;
+}
+export declare class App<TEnv = any, TModules extends Array<AnyModule> | unknown = unknown> implements IApp<TEnv, TModules> {
     #private;
     get manifest$(): Observable<AppManifest>;
     get config$(): Observable<AppConfig<TEnv>>;
@@ -30,7 +56,8 @@ export declare class App<TEnv = any, TModules extends Array<AnyModule> | unknown
         config: AppConfig;
     }>;
     loadConfig(): void;
-    loadManifest(): void;
+    loadManifest(update?: boolean): void;
+    updateManifest(manifest: AppManifest, replace?: false): void;
     loadAppModule(allow_cache?: boolean): Promise<void>;
     getConfig(force_refresh?: boolean): Observable<AppConfig>;
     getConfigAsync(allow_cache?: boolean): Promise<AppConfig>;

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

@@ -1,16 +1,19 @@
 import { ActionInstanceMap, ActionTypes } from '@equinor/fusion-observable';
 import { AppConfig, AppManifest, AppModulesInstance, AppScriptModule } from '../types';
 declare const createActions: () => {
-    setManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[manifest: AppManifest], AppManifest, "set_manifest", never, {
+    setManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[manifest: AppManifest, update?: boolean | undefined], AppManifest, "set_manifest", never, {
         created: number;
+        update: boolean | undefined;
     }>;
-    fetchManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[key: string], string, "fetch_manifest::request", never, never> & {
+    fetchManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[key: string, update?: boolean | undefined], string, "fetch_manifest::request", never, {
+        update: boolean | undefined;
+    }> & {
         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>;
     };
-    setConfig: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[config: AppConfig<unknown>], AppConfig<unknown>, "set_config", never, never>;
+    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<unknown>], AppConfig<unknown>, "fetch_config::success", 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>;
     };
     setModule: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[module: any], any, "set_module", never, never>;
@@ -18,23 +21,26 @@ declare const createActions: () => {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[module: AppScriptModule], AppScriptModule, "import_app::success", never, never>;
         failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: unknown], unknown, "import_app::failure", never, never>;
     };
-    setInstance: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[instance: AppModulesInstance<unknown>], AppModulesInstance<unknown>, "set_instance", never, never>;
+    setInstance: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[instance: AppModulesInstance], AppModulesInstance, "set_instance", never, never>;
     initialize: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[], null, "initialize_app::request", never, never> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[], null, "initialize_app::success", never, never>;
         failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: unknown], unknown, "initialize_app::failure", never, never>;
     };
 };
 export declare const actions: {
-    setManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[manifest: AppManifest], AppManifest, "set_manifest", never, {
+    setManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[manifest: AppManifest, update?: boolean | undefined], AppManifest, "set_manifest", never, {
         created: number;
+        update: boolean | undefined;
     }>;
-    fetchManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[key: string], string, "fetch_manifest::request", never, never> & {
+    fetchManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[key: string, update?: boolean | undefined], string, "fetch_manifest::request", never, {
+        update: boolean | undefined;
+    }> & {
         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>;
     };
-    setConfig: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[config: AppConfig<unknown>], AppConfig<unknown>, "set_config", never, never>;
+    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<unknown>], AppConfig<unknown>, "fetch_config::success", 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>;
     };
     setModule: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[module: any], any, "set_module", never, never>;
@@ -42,7 +48,7 @@ export declare const actions: {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[module: AppScriptModule], AppScriptModule, "import_app::success", never, never>;
         failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: unknown], unknown, "import_app::failure", never, never>;
     };
-    setInstance: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[instance: AppModulesInstance<unknown>], AppModulesInstance<unknown>, "set_instance", never, never>;
+    setInstance: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[instance: AppModulesInstance], AppModulesInstance, "set_instance", never, never>;
     initialize: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[], null, "initialize_app::request", never, never> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[], null, "initialize_app::success", never, never>;
         failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: unknown], unknown, "initialize_app::failure", never, never>;

package/dist/types/app/create-reducer.d.ts

@@ -1,3 +1,3 @@
 import { AppBundleState, AppBundleStateInitial } from './types';
-export declare const createReducer: (value: AppBundleStateInitial) => import("@equinor/fusion-observable").ReducerWithInitialState<AppBundleState<any, any>, import("@equinor/fusion-observable").AnyAction>;
+export declare const createReducer: (value: AppBundleStateInitial) => import("@equinor/fusion-observable").ReducerWithInitialState<AppBundleState, import("@equinor/fusion-observable").AnyAction>;
 export default createReducer;

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

@@ -1,2 +1,2 @@
-export { App } from './App';
+export { App, IApp } from './App';
 export { default } from './App';

package/dist/types/index.d.ts

@@ -1,6 +1,6 @@
 export { AppModuleConfig, AppConfigurator, IAppConfigurator, AppModuleConfig as IAppModuleConfig, } from './AppConfigurator';
 export { AppModuleProvider } from './AppModuleProvider';
-export { App } from './app/App';
+export { IApp } from './app/App';
 export * from './events';
 export * from './types';
 export { enableAppModule } from './enable-app-module';

package/dist/types/types.d.ts

@@ -3,7 +3,7 @@ import type { EventModule } from '@equinor/fusion-framework-module-event';
 import type { HttpModule } from '@equinor/fusion-framework-module-http';
 import { MsalModule } from '@equinor/fusion-framework-module-msal';
 import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
-import App from './app';
+import IApp from './app';
 type Fusion = any;
 export type AppEnv<TConfig = unknown, TProps = unknown> = {
     basename?: string;
@@ -13,7 +13,7 @@ export type AppEnv<TConfig = unknown, TProps = unknown> = {
 };
 export type ModuleDeps = [HttpModule, ServiceDiscoveryModule, EventModule];
 export type AppType = 'standalone' | 'report' | 'launcher';
-export type CurrentApp<TModules extends Array<AnyModule> = [], TEnv = any> = App<TEnv, TModules> | null | undefined;
+export type CurrentApp<TModules extends Array<AnyModule> = [], TEnv = any> = IApp<TEnv, TModules> | null | undefined;
 export type AppAuth = {
     clientId: string;
     resources: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@equinor/fusion-framework-module-app",
-    "version": "5.1.2",
+    "version": "5.2.0",
     "description": "",
     "main": "dist/esm/index.js",
     "exports": {
@@ -39,11 +39,10 @@
         "rxjs": "^7.5.7"
     },
     "devDependencies": {
-        "@equinor/fusion-framework-module": "^4.1.0",
+        "@equinor/fusion-framework-module": "^4.2.0",
         "@equinor/fusion-framework-module-event": "^4.0.1",
-        "@equinor/fusion-framework-module-http": "^5.0.2",
-        "@equinor/fusion-framework-module-service-discovery": "^7.0.3",
-        "typescript": "^4.9.3"
-    },
-    "gitHead": "753d04a18764d5a16d9491ec189df90089534879"
+        "@equinor/fusion-framework-module-http": "^5.0.3",
+        "@equinor/fusion-framework-module-service-discovery": "^7.0.4",
+        "typescript": "^5.0.4"
+    }
 }

package/src/AppModuleProvider.ts

@@ -17,7 +17,7 @@ import { Query } from '@equinor/fusion-query';
 
 import type { AppConfig, AppManifest, CurrentApp } from './types';
 
-import { App, filterEmpty } from './app/App';
+import { App, filterEmpty, IApp } from './app/App';
 import { AppModuleConfig } from './AppConfigurator';
 import { AppConfigError, AppManifestError } from './errors';
 import { AppBundleStateInitial } from './app/types';
@@ -154,10 +154,10 @@ export class AppModuleProvider {
      * set the current application, will internally resolve manifest
      * @param appKey - application key
      */
-    public setCurrentApp(appKeyOrApp: string | App): void {
+    public setCurrentApp(appKeyOrApp: string | IApp): void {
         const app =
             typeof appKeyOrApp === 'string' ? this.createApp({ appKey: appKeyOrApp }) : appKeyOrApp;
-        this.#current$.next(app as App);
+        this.#current$.next(app as CurrentApp);
     }
 
     public clearCurrentApp(): void {
@@ -166,8 +166,10 @@ export class AppModuleProvider {
 
     /**
      * This should not be used, only for legacy creation backdoor
+     * @deprecated
      */
     public createApp(value: AppBundleStateInitial): App {
+        console.warn();
         return new App(value, { provider: this, event: this.#event });
     }
 

package/src/app/App.ts

@@ -25,8 +25,47 @@ export function filterEmpty<T>(): OperatorFunction<T | null | undefined, T> {
     return filter((value): value is T => value !== undefined && value !== null);
 }
 
+// TODO add comments!
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export class App<TEnv = any, TModules extends Array<AnyModule> | unknown = unknown> {
+export interface IApp<TEnv = any, TModules extends Array<AnyModule> | unknown = unknown> {
+    get manifest$(): Observable<AppManifest>;
+    get config$(): Observable<AppConfig<TEnv>>;
+    get modules$(): Observable<AppScriptModule>;
+    get instance$(): Observable<AppModulesInstance<TModules>>;
+    get state(): AppBundleState;
+    get appKey(): string;
+    get manifest(): AppManifest | undefined;
+    get manifestAsync(): Promise<AppManifest>;
+    get config(): AppConfig<TEnv> | undefined;
+    get instance(): AppModulesInstance<TModules> | undefined;
+
+    initialize(): Observable<{
+        manifest: AppManifest;
+        script: AppScriptModule;
+        config: AppConfig;
+    }>;
+
+    loadConfig(): void;
+
+    loadManifest(): void;
+
+    loadAppModule(allow_cache?: boolean): void;
+
+    getConfig(force_refresh?: boolean): Observable<AppConfig>;
+    getConfigAsync(allow_cache?: boolean): Promise<AppConfig>;
+
+    getManifest(force_refresh?: boolean): Observable<AppManifest>;
+    getManifestAsync(allow_cache?: boolean): Promise<AppManifest>;
+
+    getAppModule(force_refresh?: boolean): Observable<AppScriptModule>;
+    getAppModuleAsync(allow_cache?: boolean): Promise<AppScriptModule>;
+}
+
+// TODO make streams distinct until changed from state
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export class App<TEnv = any, TModules extends Array<AnyModule> | unknown = unknown>
+    implements IApp<TEnv, TModules>
+{
     #state: FlowSubject<AppBundleState, Actions>;
 
     //#region === streams ===
@@ -223,8 +262,12 @@ export class App<TEnv = any, TModules extends Array<AnyModule> | unknown = unkno
         this.#state.next(actions.fetchConfig(this.appKey));
     }
 
-    public loadManifest() {
-        this.#state.next(actions.fetchManifest(this.appKey));
+    public loadManifest(update?: boolean) {
+        this.#state.next(actions.fetchManifest(this.appKey, update));
+    }
+
+    public updateManifest(manifest: AppManifest, replace?: false) {
+        this.#state.next(actions.setManifest(manifest, !replace));
     }
 
     public async loadAppModule(allow_cache = true) {

package/src/app/actions.ts

@@ -8,13 +8,18 @@ import { AppConfig, AppManifest, AppModulesInstance, AppScriptModule } from '../
 
 const createActions = () => ({
     /** Manifest loading */
-    setManifest: createAction('set_manifest', (manifest: AppManifest) => ({
+    setManifest: createAction('set_manifest', (manifest: AppManifest, update?: boolean) => ({
         payload: manifest,
-        meta: { created: Date.now() },
+        meta: {
+            // TODO when updating
+            created: Date.now(),
+            update,
+        },
     })),
+
     fetchManifest: createAsyncAction(
         'fetch_manifest',
-        (key: string) => ({ payload: key }),
+        (key: string, update?: boolean) => ({ payload: key, meta: { update } }),
         (manifest: AppManifest) => ({ payload: manifest }),
         (error: unknown) => ({ payload: error })
     ),

package/src/app/create-reducer.ts

@@ -17,7 +17,11 @@ export const createReducer = (value: AppBundleStateInitial) =>
     makeReducer({ ...value, status: new Set() } as AppBundleState, (builder) =>
         builder
             .addCase(actions.setManifest, (state, action) => {
-                state.manifest = action.payload;
+                if (action.meta.update) {
+                    state.manifest = { ...state.manifest, ...action.payload };
+                } else {
+                    state.manifest = action.payload;
+                }
             })
             .addCase(actions.setConfig, (state, action) => {
                 state.config = action.payload;

package/src/app/flows.ts

@@ -13,10 +13,10 @@ export const handleFetchManifest =
     (action$) =>
         action$.pipe(
             filter(actions.fetchManifest.match),
-            switchMap(({ payload: appKey }) => {
+            switchMap(({ payload: appKey, meta: { update } }) => {
                 const fetch$ = from(provider.getAppManifest(appKey)).pipe(
                     filter((x) => !!x),
-                    map(actions.setManifest)
+                    map((manifest) => actions.setManifest(manifest, update))
                 );
                 return merge(
                     fetch$,

package/src/app/index.ts

@@ -1,3 +1,3 @@
-export { App } from './App';
+export { App, IApp } from './App';
 
 export { default } from './App';

package/src/index.ts

@@ -6,7 +6,7 @@ export {
 } from './AppConfigurator';
 export { AppModuleProvider } from './AppModuleProvider';
 
-export { App } from './app/App';
+export { IApp } from './app/App';
 
 export * from './events';
 export * from './types';

package/src/types.ts

@@ -3,7 +3,7 @@ import type { EventModule } from '@equinor/fusion-framework-module-event';
 import type { HttpModule } from '@equinor/fusion-framework-module-http';
 import { MsalModule } from '@equinor/fusion-framework-module-msal';
 import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
-import App from './app';
+import IApp from './app';
 
 // TODO
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -21,8 +21,9 @@ export type ModuleDeps = [HttpModule, ServiceDiscoveryModule, EventModule];
 
 export type AppType = 'standalone' | 'report' | 'launcher';
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type CurrentApp<TModules extends Array<AnyModule> = [], TEnv = any> =
-    | App<TEnv, TModules>
+    | IApp<TEnv, TModules>
     | null
     | undefined;
 

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Equinor
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.