@equinor/fusion-framework-module-app 1.0.11 → 1.1.0

package/package.json

@@ -1,33 +1,37 @@
 {
-  "name": "@equinor/fusion-framework-module-app",
-  "version": "1.0.11",
-  "description": "",
-  "main": "dist/esm/index.js",
-  "exports": {
-    ".": "./dist/esm/index.js"
-  },
-  "types": "dist/types/index.d.ts",
-  "scripts": {
-    "build": "npm run build:typescript",
-    "build:typescript": "tsc -b --verbose"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/equinor/fusion-framework.git",
-    "directory": "packages/module-apps"
-  },
-  "dependencies": {
-    "@equinor/fusion-framework-module": "^1.2.5",
-    "rxjs": "^7.5.6"
-  },
-  "devDependencies": {
-    "typescript": "^4.8.4"
-  },
-  "gitHead": "4476578317fe48e58849be381144cdfa193c3248"
+    "name": "@equinor/fusion-framework-module-app",
+    "version": "1.1.0",
+    "description": "",
+    "main": "dist/esm/index.js",
+    "exports": {
+        ".": "./dist/esm/index.js"
+    },
+    "types": "dist/types/index.d.ts",
+    "scripts": {
+        "build": "npm run build:typescript",
+        "build:typescript": "tsc -b --verbose"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/equinor/fusion-framework.git",
+        "directory": "packages/module-app"
+    },
+    "dependencies": {
+        "@equinor/fusion-observable": "^1.3.0",
+        "rxjs": "^7.5.7"
+    },
+    "devDependencies": {
+        "@equinor/fusion-framework-module": "^1.2.6",
+        "typescript": "^4.8.4"
+    },
+    "peerDependencies": {
+        "@equinor/fusion-observable": "^1.2.1"
+    },
+    "gitHead": "21ae1ec0a760c03a0887eced5532de8443274916"
 }

package/src/configurator.ts

@@ -0,0 +1,75 @@
+import { AnyModule, ModuleInitializerArgs } from '@equinor/fusion-framework-module';
+import { IHttpClient } from '@equinor/fusion-framework-module-http';
+import { QueryCtorOptions } from '@equinor/fusion-observable/query';
+import { moduleKey } from './module';
+import type { AppConfig, AppManifest, ModuleDeps } from './types';
+
+export interface IAppModuleConfig {
+    getApp: QueryCtorOptions<AppManifest, { appKey: string }>;
+    // TODO: add filter
+    getApps: QueryCtorOptions<AppManifest[], void>;
+    getConfig: QueryCtorOptions<AppConfig, { appKey: string; tag?: string }>;
+}
+
+export interface IAppConfigurator<TDeps extends Array<AnyModule>> {
+    createConfig: (
+        args: ModuleInitializerArgs<IAppConfigurator<TDeps>, TDeps>
+    ) => Promise<IAppModuleConfig>;
+    processConfig: (config: IAppModuleConfig) => IAppModuleConfig;
+}
+
+export class AppConfigurator<TDeps extends ModuleDeps = ModuleDeps>
+    implements IAppConfigurator<TDeps>
+{
+    defaultExpireTime = 1 * 60 * 1000;
+
+    /**
+     * WARNING: this function will be remove in future
+     */
+    protected async _createHttpClient(
+        init: ModuleInitializerArgs<IAppConfigurator<TDeps>, TDeps>
+    ): Promise<IHttpClient> {
+        const http = await init.requireInstance('http');
+        /** check if the http provider has configure a client */
+        if (http.hasClient(moduleKey)) {
+            return http.createClient(moduleKey);
+        } else {
+            /** load service discovery module */
+            const serviceDiscovery = await init.requireInstance('serviceDiscovery');
+            /** resolve and create a client from discovery */
+            return await serviceDiscovery.createClient('portal');
+        }
+    }
+
+    public async createConfig(
+        args: ModuleInitializerArgs<IAppConfigurator<TDeps>, TDeps>
+    ): Promise<IAppModuleConfig> {
+        const httpClient = await this._createHttpClient(args);
+        const config: IAppModuleConfig = {
+            getApp: {
+                client: {
+                    fn: ({ appKey }) => httpClient.json$(`/api/apps/${appKey}`),
+                },
+                key: ({ appKey }) => appKey,
+            },
+            getApps: {
+                client: {
+                    fn: () => httpClient.json$(`/api/apps`),
+                },
+                key: () => 'apps',
+            },
+            getConfig: {
+                client: {
+                    fn: ({ appKey, tag }) =>
+                        httpClient.json$(`/api/apps/${appKey}/config${tag ? `?tag=${tag}` : ''}`),
+                },
+                key: (args) => JSON.stringify(args),
+            },
+        };
+        return this.processConfig(config);
+    }
+
+    public processConfig(config: IAppModuleConfig): IAppModuleConfig {
+        return config;
+    }
+}

package/src/helpers.ts

@@ -0,0 +1,4 @@
+import { AppManifest } from './types';
+
+export const compareAppManifest = <T extends AppManifest>(a?: T, b?: T): boolean =>
+    JSON.stringify(a) === JSON.stringify(b);

package/src/index.ts

@@ -0,0 +1,6 @@
+export { AppConfigurator, IAppConfigurator, IAppModuleConfig } from './configurator';
+export { AppProvider, IAppProvider } from './provider';
+
+export * from './types';
+
+export { default, AppModule, module, moduleKey } from './module';

package/src/module.ts

@@ -0,0 +1,35 @@
+import { Module } from '@equinor/fusion-framework-module';
+import { ModuleDeps } from './types';
+
+import { IAppConfigurator, AppConfigurator } from './configurator';
+import { AppProvider, IAppProvider } from './provider';
+
+export const moduleKey = 'app';
+
+export type AppModule = Module<
+    typeof moduleKey,
+    IAppProvider,
+    IAppConfigurator<ModuleDeps>,
+    ModuleDeps
+>;
+
+export const module: AppModule = {
+    name: moduleKey,
+    configure: () => new AppConfigurator(),
+    initialize: async (args) => {
+        const config = await args.config.createConfig(args);
+        const event = await args.requireInstance('event').catch(() => undefined);
+        return new AppProvider({ config, event });
+    },
+    dispose: (args) => {
+        (args.instance as unknown as AppProvider).dispose();
+    },
+};
+
+export default module;
+
+declare module '@equinor/fusion-framework-module' {
+    interface Modules {
+        app: AppModule;
+    }
+}

package/src/provider.ts

@@ -0,0 +1,121 @@
+import {
+    BehaviorSubject,
+    distinctUntilChanged,
+    Observable,
+    pairwise,
+    Subscription,
+    takeWhile,
+} from 'rxjs';
+
+import { ModuleType } from '@equinor/fusion-framework-module';
+
+import { Query, queryValue } from '@equinor/fusion-observable/query';
+
+import {
+    EventModule,
+    FrameworkEvent,
+    FrameworkEventInit,
+} from '@equinor/fusion-framework-module-event';
+
+import { IAppModuleConfig } from './configurator';
+import { compareAppManifest } from './helpers';
+
+import type { AppConfig, AppManifest } from './types';
+
+export interface IAppProvider {
+    getApp(appKey: string): Observable<AppManifest>;
+    getAllApps(): Observable<AppManifest[]>;
+    getAppConfig<TType = unknown>(appKey: string): Observable<AppConfig<TType>>;
+    setCurrentApp(appKey: string): void;
+    readonly current$: Observable<AppManifest | undefined>;
+}
+
+export class AppProvider extends Observable<AppManifest | undefined> implements IAppProvider {
+    #appClient: Query<AppManifest, { appKey: string }>;
+    #appsClient: Query<AppManifest[], void>;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    #configClient: Query<AppConfig<any>, { appKey: string; tag?: string }>;
+
+    #current$: BehaviorSubject<AppManifest | undefined>;
+
+    #subscription = new Subscription();
+
+    get current(): AppManifest | undefined {
+        return this.#current$.value;
+    }
+
+    get current$(): Observable<AppManifest | undefined> {
+        return this.#current$.pipe(distinctUntilChanged(compareAppManifest));
+    }
+
+    constructor(args: { config: IAppModuleConfig; event?: ModuleType<EventModule> }) {
+        super((observer) => this.current$.subscribe(observer));
+
+        const { event, config } = args;
+
+        this.#current$ = new BehaviorSubject<AppManifest | undefined>(undefined);
+
+        this.#appClient = new Query(config.getApp);
+        this.#appsClient = new Query(config.getApps);
+        this.#configClient = new Query(config.getConfig);
+
+        this.#subscription.add(this.#appClient.complete);
+        this.#subscription.add(this.#appsClient.complete);
+        this.#subscription.add(this.#configClient.complete);
+        this.#subscription.add(
+            this.current$
+                .pipe(
+                    pairwise(),
+                    takeWhile(() => !!event)
+                )
+                .subscribe(([previous, next]) => {
+                    event?.dispatchEvent('onCurrentAppChanged', {
+                        source: this,
+                        detail: { previous, next },
+                    });
+                })
+        );
+    }
+
+    public getApp(appKey: string): Observable<AppManifest> {
+        return queryValue(this.#appClient.query({ appKey }));
+    }
+
+    public getAllApps(): Observable<AppManifest[]> {
+        return queryValue(this.#appsClient.query());
+    }
+
+    public getAppConfig<TType = unknown>(
+        appKey: string,
+        tag?: string
+    ): Observable<AppConfig<TType>> {
+        return queryValue(this.#configClient.query({ appKey, tag }));
+    }
+
+    public setCurrentApp(appKey: string): Promise<void> {
+        return new Promise((complete, error) => {
+            const query$ = this.#appClient.query({ appKey }, { skipQueue: true });
+            this.#subscription.add(
+                queryValue(query$).subscribe({
+                    next: (x) => this.#current$.next(x),
+                    error,
+                    complete,
+                })
+            );
+        });
+    }
+
+    public dispose() {
+        this.#subscription.unsubscribe();
+    }
+}
+
+declare module '@equinor/fusion-framework-module-event' {
+    interface FrameworkEventMap {
+        onCurrentAppChanged: FrameworkEvent<
+            FrameworkEventInit<{ next?: AppManifest; previous?: AppManifest }, IAppProvider>
+        >;
+    }
+}
+
+export default AppProvider;

package/src/types.ts

@@ -1,47 +1,9 @@
-export enum ContextTypes {
-    Contract = 'Contract',
-    OrgChart = 'OrgChart',
-    PDP = 'PDP',
-    PimsDomain = 'PimsDomain',
-    Portfolio = 'Portfolio',
-    Project = 'Project',
-    ProjectMaster = 'ProjectMaster',
-    Facility = 'Facility',
-    TpdPortfolio = 'TpdPortfolio',
-}
+import type { EventModule } from '@equinor/fusion-framework-module-event';
+import type { HttpModule } from '@equinor/fusion-framework-module-http';
+import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
 
-export class ContextType {
-    constructor(
-        readonly id: ContextTypes,
-        readonly isChildType: boolean,
-        readonly parentTypeIds: string[] = []
-    ) {}
-}
-
-type ParentContext = {
-    id: string;
-    type: ContextType;
-};
-
-export type Context = {
-    id: string;
-    externalId: string | null;
-    type: ContextType;
-    title: string;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    value: any;
-    isActive: boolean;
-    parent: ParentContext;
-};
-
-export type ContextManifest = {
-    readonly types: ContextTypes[];
-    readonly placeholder?: string;
-    readonly nullable?: boolean;
-    filterContexts?: (contexts: Context[]) => Context[];
-    buildUrl?: (context: Context | null, url: string) => string;
-    getContextFromUrl?: (url: string) => string;
-};
+// TODO: change to module-services when new app service is created
+export type ModuleDeps = [HttpModule, ServiceDiscoveryModule, EventModule];
 
 export type AppType = 'standalone' | 'report' | 'launcher';
 
@@ -65,7 +27,7 @@ export type AppManifest = {
     description: string;
     type: AppType;
     tags: string[];
-    context?: ContextManifest;
+    // context?: ContextManifest;
     auth?: AppAuth[];
     icon?: string;
     order: number | null;
@@ -75,3 +37,10 @@ export type AppManifest = {
     category: AppCategory | null;
     hide?: boolean;
 };
+
+export type Endpoint = { name: string; uri: string; scopes?: string[] };
+
+export type AppConfig<TEnvironment = unknown> = {
+    environment: TEnvironment;
+    endpoints: Record<string, string | Endpoint>;
+};

package/tsconfig.json

@@ -9,6 +9,12 @@
   "references": [
     {
       "path": "../module"
+    },
+    {
+      "path": "../observable"
+    },
+    {
+      "path": "../module-http"
     }
   ],
   "include": [

package/yarn-error.log

@@ -0,0 +1,66 @@
+Arguments: 
+  /Users/odin.rochmann/.nvm/versions/node/v16.14.0/bin/node /Users/odin.rochmann/.yarn/bin/yarn.js
+
+PATH: 
+  /Users/odin.rochmann/.yarn/bin:/Users/odin.rochmann/.config/yarn/global/node_modules/.bin:/Users/odin.rochmann/.nvm/versions/node/v16.14.0/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/MacGPG2/bin:/usr/local/share/dotnet:~/.dotnet/tools:/Users/odin.rochmann/.yarn/bin:/Users/odin.rochmann/.config/yarn/global/node_modules/.bin:/Users/odin.rochmann/.nvm/versions/node/v16.14.0/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/Users/odin.rochmann/.dotnet/tools:/Users/odin.rochmann/.dotnet/tools
+
+Yarn version: 
+  1.22.19
+
+Node version: 
+  16.14.0
+
+Platform: 
+  darwin arm64
+
+Trace: 
+  SyntaxError: /Users/odin.rochmann/dev/fusion/fusion-framework/packages/module-app/package.json: Unexpected token } in JSON at position 979
+      at JSON.parse (<anonymous>)
+      at /Users/odin.rochmann/.yarn/lib/cli.js:1629:59
+      at Generator.next (<anonymous>)
+      at step (/Users/odin.rochmann/.yarn/lib/cli.js:310:30)
+      at /Users/odin.rochmann/.yarn/lib/cli.js:321:13
+
+npm manifest: 
+  {
+      "name": "@equinor/fusion-framework-module-app",
+      "version": "1.0.12",
+      "description": "",
+      "main": "dist/esm/index.js",
+      "exports": {
+          ".": "./dist/esm/index.js"
+      },
+      "types": "dist/types/index.d.ts",
+      "scripts": {
+          "build": "npm run build:typescript",
+          "build:typescript": "tsc -b --verbose"
+      },
+      "keywords": [],
+      "author": "",
+      "license": "ISC",
+      "publishConfig": {
+          "access": "public"
+      },
+      "repository": {
+          "type": "git",
+          "url": "git+https://github.com/equinor/fusion-framework.git",
+          "directory": "packages/module-app"
+      },
+      "devDependencies": {
+          "@equinor/fusion-observable": "^1.2.1",
+          "@equinor/fusion-framework-module": "^1.2.6",
+          "rxjs": "^7.5.7",
+          "typescript": "^4.8.4"
+      },
+      "peerDependencies": {
+          "@equinor/fusion-observable": "^1.2.1",
+          "@equinor/fusion-framework-module": "^1.2.6",
+          "rxjs": "^7.5.7"
+      },
+  }
+
+yarn manifest: 
+  No manifest
+
+Lockfile: 
+  No lockfile

package/TODO.md

@@ -1,5 +0,0 @@
-[ ] develope configurator
-[ ] develope provider
-[ ] develope module
-
-> awaiting new app frame-work

package/dist/esm/app-configurator.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=app-configurator.js.map

package/dist/esm/app-configurator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"app-configurator.js","sourceRoot":"","sources":["../../src/app-configurator.ts"],"names":[],"mappings":""}

package/dist/esm/app-provider.js

@@ -1,25 +0,0 @@
-import { BehaviorSubject } from 'rxjs';
-export class AppProvider {
-    constructor() {
-        this._app$ = new BehaviorSubject({});
-        this._currentApp$ = new BehaviorSubject(null);
-    }
-    get app$() {
-        return this._app$.asObservable();
-    }
-    get currentApp() {
-        return this._currentApp$.value;
-    }
-    setCurrentApp(app) {
-        if (typeof app === 'string') {
-            const next = this._app$.value[app];
-            if (!next) {
-                console.warn('could not find any app for key', app);
-            }
-            this._currentApp$.next(next);
-        }
-        this._currentApp$.next(app);
-    }
-}
-export default AppProvider;
-//# sourceMappingURL=app-provider.js.map

package/dist/esm/app-provider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"app-provider.js","sourceRoot":"","sources":["../../src/app-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAc,MAAM,MAAM,CAAC;AAGnD,MAAM,OAAO,WAAW;IAYpB;QACI,IAAI,CAAC,KAAK,GAAG,IAAI,eAAe,CAAC,EAAE,CAAC,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,IAAI,eAAe,CAAqB,IAAI,CAAC,CAAC;IACtE,CAAC;IAXD,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;IACrC,CAAC;IAED,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;IACnC,CAAC;IAOD,aAAa,CAAC,GAAyB;QACnC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YACzB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEnC,IAAI,CAAC,IAAI,EAAE;gBACP,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAC;aACvD;YACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAChC;QACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAkB,CAAC,CAAC;IAC/C,CAAC;CACJ;AAED,eAAe,WAAW,CAAC"}

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

@@ -1,11 +0,0 @@
-import { BehaviorSubject, Observable } from 'rxjs';
-import { AppManifest } from './types';
-export declare class AppProvider {
-    protected _app$: BehaviorSubject<Record<string, AppManifest>>;
-    protected _currentApp$: BehaviorSubject<AppManifest | null>;
-    get app$(): Observable<Record<string, AppManifest>>;
-    get currentApp(): AppManifest | null;
-    constructor();
-    setCurrentApp(app: string | AppManifest): void;
-}
-export default AppProvider;

package/src/app-provider.ts

@@ -1,34 +0,0 @@
-import { BehaviorSubject, Observable } from 'rxjs';
-import { AppManifest } from './types';
-
-export class AppProvider {
-    protected _app$: BehaviorSubject<Record<string, AppManifest>>;
-    protected _currentApp$: BehaviorSubject<AppManifest | null>;
-
-    get app$(): Observable<Record<string, AppManifest>> {
-        return this._app$.asObservable();
-    }
-
-    get currentApp(): AppManifest | null {
-        return this._currentApp$.value;
-    }
-
-    constructor() {
-        this._app$ = new BehaviorSubject({});
-        this._currentApp$ = new BehaviorSubject<AppManifest | null>(null);
-    }
-
-    setCurrentApp(app: string | AppManifest): void {
-        if (typeof app === 'string') {
-            const next = this._app$.value[app];
-            // TODO - better handling
-            if (!next) {
-                console.warn('could not find any app for key', app);
-            }
-            this._currentApp$.next(next);
-        }
-        this._currentApp$.next(app as AppManifest);
-    }
-}
-
-export default AppProvider;