@equinor/fusion-framework-module-app 2.3.0 → 2.5.0

package/dist/types/AppModuleProvider.d.ts

@@ -1,10 +1,11 @@
 import { Observable } from 'rxjs';
 import { ModuleType } from '@equinor/fusion-framework-module';
-import { Query } from '@equinor/fusion-query';
 import { EventModule } from '@equinor/fusion-framework-module-event';
+import { Query } from '@equinor/fusion-query';
 import type { AppConfig, AppManifest } from './types';
 import { App } from './app/App';
 import { AppModuleConfig } from './AppConfigurator';
+import { AppBundleStateInitial } from './app/types';
 export declare class AppModuleProvider {
     #private;
     static compareAppManifest<T extends AppManifest>(a?: T, b?: T): boolean;
@@ -20,7 +21,8 @@ export declare class AppModuleProvider {
     getAppManifest(appKey: string): Observable<AppManifest>;
     getAllAppManifests(): Observable<AppManifest[]>;
     getAppConfig<TType = unknown>(appKey: string, tag?: string): Observable<AppConfig<TType>>;
-    setCurrentApp(appKey: string): void;
+    setCurrentApp(appKeyOrApp: string | App): void;
+    createApp(value: AppBundleStateInitial): App;
     dispose(): void;
 }
 export default AppModuleProvider;

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

@@ -4,6 +4,7 @@ import type { AppModuleProvider } from '../AppModuleProvider';
 import { OperatorFunction } from 'rxjs';
 import { EventModule } from '@equinor/fusion-framework-module-event';
 import { AnyModule, ModuleType } from '@equinor/fusion-framework-module';
+import { 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> {
@@ -16,7 +17,7 @@ export declare class App<TEnv = any, TModules extends Array<AnyModule> | unknown
     get manifest(): Promise<AppManifest>;
     get config(): Promise<AppConfig<TEnv>>;
     get instance(): AppModulesInstance<TModules> | undefined;
-    constructor(appKey: string, args: {
+    constructor(value: AppBundleStateInitial, args: {
         provider: AppModuleProvider;
         event?: ModuleType<EventModule>;
     });
@@ -32,3 +33,4 @@ export declare class App<TEnv = any, TModules extends Array<AnyModule> | unknown
     getAppModuleAsync(allow_cache?: boolean): Promise<AppScriptModule>;
     dispose: VoidFunction;
 }
+export default App;

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

@@ -1,3 +1,3 @@
-import { AppBundleState } from './types';
-export declare const createReducer: (appKey: string) => import("@equinor/fusion-observable").ReducerWithInitialState<AppBundleState<any, any>, import("@equinor/fusion-observable").AnyAction>;
+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 default createReducer;

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

@@ -1,5 +1,5 @@
 import { FlowSubject } from '@equinor/fusion-observable';
 import type { Actions } from './actions';
-import type { AppBundleState } from './types';
+import type { AppBundleState, AppBundleStateInitial } from './types';
 import type { AppModuleProvider } from '../AppModuleProvider';
-export declare const createState: (appKey: string, provider: AppModuleProvider) => FlowSubject<AppBundleState, Actions>;
+export declare const createState: (value: AppBundleStateInitial, provider: AppModuleProvider) => FlowSubject<AppBundleState, Actions>;

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

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

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

@@ -7,3 +7,4 @@ export type AppBundleState<TConfig = any, TModules = any> = {
     modules?: AppScriptModule;
     instance?: AppModulesInstance<TModules>;
 };
+export type AppBundleStateInitial<TConfig = any, TModules = any> = Omit<AppBundleState<TConfig, TModules>, 'status'>;

package/dist/types/events.d.ts

@@ -1,7 +1,7 @@
 import { AnyModule } from '@equinor/fusion-framework-module';
 import { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
-import { App } from 'app/App';
-import AppModuleProvider from 'AppModuleProvider';
+import { App } from './app/App';
+import AppModuleProvider from './AppModuleProvider';
 import { AppModulesInstance } from './types';
 type AppModulesLoadedEventInit<TModules extends Array<AnyModule> | unknown = unknown> = FrameworkEventInit<{
     appKey: string;

package/dist/types/index.d.ts

@@ -3,4 +3,4 @@ export { AppModuleProvider } from './AppModuleProvider';
 export { App } from './app/App';
 export * from './events';
 export * from './types';
-export { default, AppModule, module, moduleKey } from './module';
+export { default, AppModule, module, moduleKey, enableAppModule } from './module';

package/dist/types/module.d.ts

@@ -5,7 +5,7 @@ import { AppModuleProvider } from './AppModuleProvider';
 export declare const moduleKey = "app";
 export type AppModule = Module<typeof moduleKey, AppModuleProvider, IAppConfigurator, ModuleDeps>;
 export declare const module: AppModule;
-export declare const enableAppModule: (configurator: IModulesConfigurator) => void;
+export declare const enableAppModule: (configurator: IModulesConfigurator<any, any>) => void;
 export default module;
 declare module '@equinor/fusion-framework-module' {
     interface Modules {

package/dist/types/types.d.ts

@@ -25,20 +25,20 @@ type AppCategory = {
 export type AppManifest = {
     appKey: string;
     name: string;
-    shortName: string;
+    entry: string;
     version: string;
-    description: string;
-    type: AppType;
-    tags: string[];
+    shortName?: string;
+    description?: string;
+    type?: AppType;
+    tags?: string[];
     auth?: AppAuth[];
     icon?: string;
-    order: number | null;
-    publishedDate: Date | null;
-    accentColor: string | null;
-    categoryId: string | null;
-    category: AppCategory | null;
+    order?: number;
+    publishedDate?: Date;
+    accentColor?: string;
+    categoryId?: string;
+    category?: AppCategory;
     hide?: boolean;
-    entry: string;
 };
 export type Endpoint = {
     name: string;

package/package.json

@@ -1,17 +1,21 @@
 {
     "name": "@equinor/fusion-framework-module-app",
-    "version": "2.3.0",
+    "version": "2.5.0",
     "description": "",
     "main": "dist/esm/index.js",
     "exports": {
         ".": "./dist/esm/index.js",
-        "./errors.js": "./dist/esm/errors.js"
+        "./errors.js": "./dist/esm/errors.js",
+        "./app": "./dist/esm/app/index.js"
     },
     "types": "dist/types/index.d.ts",
     "typesVersions": {
         "*": {
             "errors.js": [
                 "dist/types/errors.d.ts"
+            ],
+            "app": [
+                "dist/types/app/index.d.ts"
             ]
         }
     },
@@ -31,15 +35,15 @@
         "directory": "packages/module-app"
     },
     "dependencies": {
-        "@equinor/fusion-query": "^1.1.2",
+        "@equinor/fusion-query": "^1.1.3",
         "rxjs": "^7.5.7"
     },
     "devDependencies": {
         "@equinor/fusion-framework-module": "^1.2.10",
         "@equinor/fusion-framework-module-event": "^1.2.0",
         "@equinor/fusion-framework-module-http": "^2.2.1",
-        "@equinor/fusion-framework-module-service-discovery": "^4.0.7",
+        "@equinor/fusion-framework-module-service-discovery": "^4.0.8",
         "typescript": "^4.9.3"
     },
-    "gitHead": "4bc7a862d19921fc8801e5238d7013b8ece12917"
+    "gitHead": "e5668331df89b0ef6ef6175ea1908d4aeb772544"
 }

package/src/AppConfigurator.ts

@@ -80,7 +80,7 @@ export class AppConfigurator implements IAppConfigurator {
                         fn: () => httpClient.json$(`/api/apps`),
                     },
                     // TODO - might cast to checksum
-                    key: (args) => JSON.stringify(args),
+                    key: () => 'manifests',
                     expire: this.defaultExpireTime,
                 },
                 getAppConfig: {

package/src/AppModuleProvider.ts

@@ -10,17 +10,17 @@ import {
 } from 'rxjs';
 
 import { ModuleType } from '@equinor/fusion-framework-module';
+import { HttpResponseError } from '@equinor/fusion-framework-module-http';
+import { EventModule } from '@equinor/fusion-framework-module-event';
 
 import { Query } from '@equinor/fusion-query';
 
-import { EventModule } from '@equinor/fusion-framework-module-event';
-
 import type { AppConfig, AppManifest } from './types';
 
 import { App, filterEmpty } from './app/App';
 import { AppModuleConfig } from './AppConfigurator';
-import { HttpResponseError } from '@equinor/fusion-framework-module-http';
 import { AppConfigError, AppManifestError } from './errors';
+import { AppBundleStateInitial } from './app/types';
 
 export class AppModuleProvider {
     static compareAppManifest<T extends AppManifest>(a?: T, b?: T): boolean {
@@ -147,8 +147,16 @@ export class AppModuleProvider {
      * set the current application, will internally resolve manifest
      * @param appKey - application key
      */
-    public setCurrentApp(appKey: string): void {
-        this.#current$.next(new App(appKey, { provider: this, event: this.#event }));
+    public setCurrentApp(appKeyOrApp: string | App): void {
+        const app = typeof appKeyOrApp === 'string' ? this.createApp({ appKey: appKeyOrApp }) : App;
+        this.#current$.next(app as App);
+    }
+
+    /**
+     * This should not be used, only for legacy creation backdoor
+     */
+    public createApp(value: AppBundleStateInitial): App {
+        return new App(value, { provider: this, event: this.#event });
     }
 
     public dispose() {

package/src/app/App.ts

@@ -16,7 +16,7 @@ import { EventModule } from '@equinor/fusion-framework-module-event';
 import { AnyModule, ModuleType } from '@equinor/fusion-framework-module';
 import { createState } from './create-state';
 import { actions, Actions } from './actions';
-import { AppBundleState } from './types';
+import { AppBundleState, AppBundleStateInitial } from './types';
 
 import '../events';
 
@@ -78,10 +78,15 @@ export class App<TEnv = any, TModules extends Array<AnyModule> | unknown = unkno
     }
 
     constructor(
-        appKey: string,
-        args: { provider: AppModuleProvider; event?: ModuleType<EventModule> }
+        value: AppBundleStateInitial,
+        args: {
+            provider: AppModuleProvider;
+            event?: ModuleType<EventModule>;
+        }
     ) {
-        this.#state = createState(appKey, args.provider);
+        this.#state = createState(value, args.provider);
+
+        const { appKey } = value;
 
         const subscriptions = new Subscription();
 
@@ -241,3 +246,5 @@ export class App<TEnv = any, TModules extends Array<AnyModule> | unknown = unkno
 
     public dispose: VoidFunction;
 }
+
+export default App;

package/src/app/create-reducer.ts

@@ -11,10 +11,10 @@ enableMapSet();
 
 import { actions } from './actions';
 
-import { AppBundleState } from './types';
+import { AppBundleState, AppBundleStateInitial } from './types';
 
-export const createReducer = (appKey: string) =>
-    makeReducer({ appKey, status: new Set() } as AppBundleState, (builder) =>
+export const createReducer = (value: AppBundleStateInitial) =>
+    makeReducer({ ...value, status: new Set() } as AppBundleState, (builder) =>
         builder
             .addCase(actions.setManifest, (state, action) => {
                 state.manifest = action.payload;

package/src/app/create-state.ts

@@ -5,14 +5,14 @@ import { createReducer } from './create-reducer';
 import { handleFetchManifest, handleFetchConfig, handleImportApplication } from './flows';
 
 import type { Actions } from './actions';
-import type { AppBundleState } from './types';
+import type { AppBundleState, AppBundleStateInitial } from './types';
 import type { AppModuleProvider } from '../AppModuleProvider';
 
 export const createState = (
-    appKey: string,
+    value: AppBundleStateInitial,
     provider: AppModuleProvider
 ): FlowSubject<AppBundleState, Actions> => {
-    const reducer = createReducer(appKey);
+    const reducer = createReducer(value);
     const state = new FlowSubject<AppBundleState, Actions>(reducer);
     state.addFlow(handleFetchManifest(provider));
     state.addFlow(handleFetchConfig(provider));

package/src/app/index.ts

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

package/src/app/types.ts

@@ -9,3 +9,9 @@ export type AppBundleState<TConfig = any, TModules = any> = {
     modules?: AppScriptModule;
     instance?: AppModulesInstance<TModules>;
 };
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type AppBundleStateInitial<TConfig = any, TModules = any> = Omit<
+    AppBundleState<TConfig, TModules>,
+    'status'
+>;

package/src/events.ts

@@ -1,8 +1,8 @@
 import { AnyModule } from '@equinor/fusion-framework-module';
 
 import { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
-import { App } from 'app/App';
-import AppModuleProvider from 'AppModuleProvider';
+import { App } from './app/App';
+import AppModuleProvider from './AppModuleProvider';
 
 import { AppModulesInstance } from './types';
 

package/src/index.ts

@@ -11,4 +11,4 @@ export { App } from './app/App';
 export * from './events';
 export * from './types';
 
-export { default, AppModule, module, moduleKey } from './module';
+export { default, AppModule, module, moduleKey, enableAppModule } from './module';

package/src/module.ts

@@ -21,7 +21,8 @@ export const module: AppModule = {
     },
 };
 
-export const enableAppModule = (configurator: IModulesConfigurator) => {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const enableAppModule = (configurator: IModulesConfigurator<any, any>) => {
     configurator.addConfig({ module });
 };
 

package/src/types.ts

@@ -35,21 +35,21 @@ type AppCategory = {
 export type AppManifest = {
     appKey: string;
     name: string;
-    shortName: string;
+    entry: string;
     version: string;
-    description: string;
-    type: AppType;
-    tags: string[];
+    shortName?: string;
+    description?: string;
+    type?: AppType;
+    tags?: string[];
     // context?: ContextManifest;
     auth?: AppAuth[];
     icon?: string;
-    order: number | null;
-    publishedDate: Date | null;
-    accentColor: string | null;
-    categoryId: string | null;
-    category: AppCategory | null;
+    order?: number;
+    publishedDate?: Date;
+    accentColor?: string;
+    categoryId?: string;
+    category?: AppCategory;
     hide?: boolean;
-    entry: string;
 };
 
 export type Endpoint = { name: string; uri: string; scopes?: string[] };