@equinor/fusion-framework-module-app 2.1.5 → 2.2.0

package/src/types.ts

@@ -1,7 +1,20 @@
+import { AnyModule, CombinedModules, ModulesInstance } from '@equinor/fusion-framework-module';
 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';
 
+// TODO
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type Fusion = any;
+
+export type AppEnv<TConfig = unknown, TProps = unknown> = {
+    basename?: string;
+    manifest?: AppManifest;
+    config?: AppConfig<TConfig>;
+    props?: TProps;
+};
+
 // TODO: change to module-services when new app service is created
 export type ModuleDeps = [HttpModule, ServiceDiscoveryModule, EventModule];
 
@@ -20,7 +33,7 @@ type AppCategory = {
 };
 
 export type AppManifest = {
-    key: string;
+    appKey: string;
     name: string;
     shortName: string;
     version: string;
@@ -45,3 +58,31 @@ 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>;
+    module: TModule;
+};
+
+export type AppModules<TModules extends Array<AnyModule> | unknown = unknown> = CombinedModules<
+    TModules,
+    [EventModule, HttpModule, MsalModule]
+>;
+
+export type ComponentRenderArgs<TFusion extends Fusion = Fusion, TEnv = AppEnv> = {
+    fusion: TFusion;
+    env: TEnv;
+};
+
+export type AppScriptModule = {
+    default: (el: HTMLElement, args: ComponentRenderArgs) => VoidFunction;
+    renderApp: (el: HTMLElement, args: ComponentRenderArgs) => VoidFunction;
+};
+
+export type AppModulesInstance<TModules extends Array<AnyModule> | unknown = unknown> =
+    ModulesInstance<AppModules<TModules>>;

package/dist/esm/provider.js

@@ -1,83 +0,0 @@
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _AppProvider_appClient, _AppProvider_appsClient, _AppProvider_configClient, _AppProvider_current$, _AppProvider_subscription;
-import { BehaviorSubject, catchError, distinctUntilChanged, filter, firstValueFrom, from, map, merge, Observable, pairwise, scan, Subscription, switchMap, takeWhile, throwIfEmpty, } from 'rxjs';
-import { Query } from '@equinor/fusion-query';
-import { compareAppManifest } from './helpers';
-export class AppProvider extends Observable {
-    get current() {
-        return __classPrivateFieldGet(this, _AppProvider_current$, "f").value;
-    }
-    get current$() {
-        return __classPrivateFieldGet(this, _AppProvider_current$, "f").pipe(distinctUntilChanged(compareAppManifest));
-    }
-    constructor(args) {
-        super((observer) => this.current$.subscribe(observer));
-        _AppProvider_appClient.set(this, void 0);
-        _AppProvider_appsClient.set(this, void 0);
-        _AppProvider_configClient.set(this, void 0);
-        _AppProvider_current$.set(this, void 0);
-        _AppProvider_subscription.set(this, new Subscription());
-        const { event, config } = args;
-        __classPrivateFieldSet(this, _AppProvider_current$, new BehaviorSubject(undefined), "f");
-        __classPrivateFieldSet(this, _AppProvider_appClient, new Query(config.getApp), "f");
-        __classPrivateFieldSet(this, _AppProvider_appsClient, new Query(config.getApps), "f");
-        __classPrivateFieldSet(this, _AppProvider_configClient, new Query(config.getConfig), "f");
-        __classPrivateFieldGet(this, _AppProvider_subscription, "f").add(__classPrivateFieldGet(this, _AppProvider_appClient, "f").complete);
-        __classPrivateFieldGet(this, _AppProvider_subscription, "f").add(__classPrivateFieldGet(this, _AppProvider_appsClient, "f").complete);
-        __classPrivateFieldGet(this, _AppProvider_subscription, "f").add(__classPrivateFieldGet(this, _AppProvider_configClient, "f").complete);
-        __classPrivateFieldGet(this, _AppProvider_subscription, "f").add(this.current$
-            .pipe(pairwise(), takeWhile(() => !!event))
-            .subscribe(([previous, next]) => {
-            event === null || event === void 0 ? void 0 : event.dispatchEvent('onCurrentAppChanged', {
-                source: this,
-                detail: { previous, next },
-            });
-        }));
-    }
-    getApp(appKey) {
-        return Query.extractQueryValue(__classPrivateFieldGet(this, _AppProvider_appClient, "f").query({ appKey }).pipe(catchError((cause) => {
-            throw Error('failed to load manifest', { cause });
-        })));
-    }
-    getAllApps() {
-        return Query.extractQueryValue(__classPrivateFieldGet(this, _AppProvider_appsClient, "f").query());
-    }
-    getAppConfig(appKey, tag) {
-        return Query.extractQueryValue(__classPrivateFieldGet(this, _AppProvider_configClient, "f").query({ appKey, tag }).pipe(catchError((cause) => {
-            throw Error('failed to load config', { cause });
-        })));
-    }
-    setCurrentApp(appKey) {
-        return new Promise((complete, error) => {
-            const query$ = __classPrivateFieldGet(this, _AppProvider_appClient, "f").query({ appKey });
-            __classPrivateFieldGet(this, _AppProvider_subscription, "f").add(Query.extractQueryValue(query$).subscribe({
-                next: (x) => __classPrivateFieldGet(this, _AppProvider_current$, "f").next(x),
-                error,
-                complete,
-            }));
-        });
-    }
-    loadApp(appKey) {
-        const loadApp$ = this.getApp(appKey).pipe(switchMap((manifest) => {
-            return firstValueFrom(from(import(manifest.entry)).pipe(map((module) => ({ manifest, module }))));
-        }));
-        const loadConfig$ = this.getAppConfig(appKey).pipe(map((config) => ({ config })));
-        return merge(loadApp$, loadConfig$).pipe(scan((acc, next) => Object.assign({}, acc, next), {}), filter((x) => ['manifest', 'module', 'config'].every((key) => !!x[key])), throwIfEmpty(() => 'failed to load application'));
-    }
-    dispose() {
-        __classPrivateFieldGet(this, _AppProvider_subscription, "f").unsubscribe();
-    }
-}
-_AppProvider_appClient = new WeakMap(), _AppProvider_appsClient = new WeakMap(), _AppProvider_configClient = new WeakMap(), _AppProvider_current$ = new WeakMap(), _AppProvider_subscription = new WeakMap();
-export default AppProvider;
-//# sourceMappingURL=provider.js.map

package/dist/esm/provider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../src/provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACH,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,MAAM,EACN,cAAc,EACd,IAAI,EACJ,GAAG,EACH,KAAK,EACL,UAAU,EACV,QAAQ,EACR,IAAI,EACJ,YAAY,EACZ,SAAS,EACT,SAAS,EACT,YAAY,GACf,MAAM,MAAM,CAAC;AAId,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAS9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AA0B/C,MAAM,OAAO,WAAY,SAAQ,UAAmC;IAUhE,IAAI,OAAO;QACP,OAAO,uBAAA,IAAI,6BAAU,CAAC,KAAK,CAAC;IAChC,CAAC;IAED,IAAI,QAAQ;QACR,OAAO,uBAAA,IAAI,6BAAU,CAAC,IAAI,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,YAAY,IAAmE;QAC3E,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QAlB3D,yCAAmD;QACnD,0CAAwC;QAExC,4CAAuE;QAEvE,wCAAoD;QAEpD,oCAAgB,IAAI,YAAY,EAAE,EAAC;QAa/B,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAE/B,uBAAA,IAAI,yBAAa,IAAI,eAAe,CAA0B,SAAS,CAAC,MAAA,CAAC;QAEzE,uBAAA,IAAI,0BAAc,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAA,CAAC;QAC3C,uBAAA,IAAI,2BAAe,IAAI,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,MAAA,CAAC;QAC7C,uBAAA,IAAI,6BAAiB,IAAI,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,MAAA,CAAC;QAEjD,uBAAA,IAAI,iCAAc,CAAC,GAAG,CAAC,uBAAA,IAAI,8BAAW,CAAC,QAAQ,CAAC,CAAC;QACjD,uBAAA,IAAI,iCAAc,CAAC,GAAG,CAAC,uBAAA,IAAI,+BAAY,CAAC,QAAQ,CAAC,CAAC;QAClD,uBAAA,IAAI,iCAAc,CAAC,GAAG,CAAC,uBAAA,IAAI,iCAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,uBAAA,IAAI,iCAAc,CAAC,GAAG,CAClB,IAAI,CAAC,QAAQ;aACR,IAAI,CACD,QAAQ,EAAE,EACV,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAC3B;aACA,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;YAC5B,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,CAAC,qBAAqB,EAAE;gBACxC,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;aAC7B,CAAC,CAAC;QACP,CAAC,CAAC,CACT,CAAC;IACN,CAAC;IAEM,MAAM,CAAC,MAAc;QACxB,OAAO,KAAK,CAAC,iBAAiB,CAC1B,uBAAA,IAAI,8BAAW,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,CAClC,UAAU,CAAC,CAAC,KAAK,EAAE,EAAE;YACjB,MAAM,KAAK,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,CAAC,CAAC,CACL,CACJ,CAAC;IACN,CAAC;IAEM,UAAU;QACb,OAAO,KAAK,CAAC,iBAAiB,CAAC,uBAAA,IAAI,+BAAY,CAAC,KAAK,EAAE,CAAC,CAAC;IAC7D,CAAC;IAEM,YAAY,CACf,MAAc,EACd,GAAY;QAEZ,OAAO,KAAK,CAAC,iBAAiB,CAC1B,uBAAA,IAAI,iCAAc,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAC1C,UAAU,CAAC,CAAC,KAAK,EAAE,EAAE;YACjB,MAAM,KAAK,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACpD,CAAC,CAAC,CACL,CACJ,CAAC;IACN,CAAC;IAEM,aAAa,CAAC,MAAc;QAC/B,OAAO,IAAI,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;YACnC,MAAM,MAAM,GAAG,uBAAA,IAAI,8BAAW,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YACjD,uBAAA,IAAI,iCAAc,CAAC,GAAG,CAClB,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC;gBACtC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,uBAAA,IAAI,6BAAU,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnC,KAAK;gBACL,QAAQ;aACX,CAAC,CACL,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,OAAO,CACV,MAAc;QAEd,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACrC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;YACnB,OAAO,cAAc,CAGjB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAC7E,CAAC;QACN,CAAC,CAAC,CACL,CAAC;QAEF,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QAElF,OAAO,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,IAAI,CACpC,IAAI,CAAC,CAAC,GAAuB,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,EAEzE,MAAM,CAAC,CAAC,CAAC,EAAyC,EAAE,CAChD,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAsB,CAAC,CAAC,CAC/E,EACD,YAAY,CAAC,GAAG,EAAE,CAAC,4BAA4B,CAAC,CACnD,CAAC;IACN,CAAC;IAEM,OAAO;QACV,uBAAA,IAAI,iCAAc,CAAC,WAAW,EAAE,CAAC;IACrC,CAAC;CACJ;;AAUD,eAAe,WAAW,CAAC"}

package/dist/types/provider.d.ts

@@ -1,43 +0,0 @@
-import { Observable } from 'rxjs';
-import { ModuleType } from '@equinor/fusion-framework-module';
-import { EventModule, FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
-import { IAppModuleConfig } from './configurator';
-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>;
-    current: AppManifest | undefined;
-    loadApp<TEnvironment = unknown, TModule = any>(appKey: string): Observable<AppBundle<TEnvironment, TModule>>;
-}
-export type AppBundle<TEnvironment = unknown, TModule = unknown> = {
-    manifest: AppManifest;
-    config: AppConfig<TEnvironment>;
-    module: TModule;
-};
-export declare class AppProvider extends Observable<AppManifest | undefined> implements IAppProvider {
-    #private;
-    get current(): AppManifest | undefined;
-    get current$(): Observable<AppManifest | undefined>;
-    constructor(args: {
-        config: IAppModuleConfig;
-        event?: ModuleType<EventModule>;
-    });
-    getApp(appKey: string): Observable<AppManifest>;
-    getAllApps(): Observable<AppManifest[]>;
-    getAppConfig<TType = unknown>(appKey: string, tag?: string): Observable<AppConfig<TType>>;
-    setCurrentApp(appKey: string): Promise<void>;
-    loadApp<TEnvironment = unknown, TModule = unknown>(appKey: string): Observable<AppBundle<TEnvironment, TModule>>;
-    dispose(): void;
-}
-declare module '@equinor/fusion-framework-module-event' {
-    interface FrameworkEventMap {
-        onCurrentAppChanged: FrameworkEvent<FrameworkEventInit<{
-            next?: AppManifest;
-            previous?: AppManifest;
-        }, IAppProvider>>;
-    }
-}
-export default AppProvider;

package/src/provider.ts

@@ -1,181 +0,0 @@
-import {
-    BehaviorSubject,
-    catchError,
-    distinctUntilChanged,
-    filter,
-    firstValueFrom,
-    from,
-    map,
-    merge,
-    Observable,
-    pairwise,
-    scan,
-    Subscription,
-    switchMap,
-    takeWhile,
-    throwIfEmpty,
-} from 'rxjs';
-
-import { ModuleType } from '@equinor/fusion-framework-module';
-
-import { Query } from '@equinor/fusion-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>;
-    current: AppManifest | undefined;
-    loadApp<TEnvironment = unknown, TModule = any>(
-        appKey: string
-    ): Observable<AppBundle<TEnvironment, TModule>>;
-}
-
-/**
- * @template TModule - ES module type
- */
-export type AppBundle<TEnvironment = unknown, TModule = unknown> = {
-    manifest: AppManifest;
-    config: AppConfig<TEnvironment>;
-    /** ES module instance */
-    module: TModule;
-};
-
-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 Query.extractQueryValue(
-            this.#appClient.query({ appKey }).pipe(
-                catchError((cause) => {
-                    throw Error('failed to load manifest', { cause });
-                })
-            )
-        );
-    }
-
-    public getAllApps(): Observable<AppManifest[]> {
-        return Query.extractQueryValue(this.#appsClient.query());
-    }
-
-    public getAppConfig<TType = unknown>(
-        appKey: string,
-        tag?: string
-    ): Observable<AppConfig<TType>> {
-        return Query.extractQueryValue(
-            this.#configClient.query({ appKey, tag }).pipe(
-                catchError((cause) => {
-                    throw Error('failed to load config', { cause });
-                })
-            )
-        );
-    }
-
-    public setCurrentApp(appKey: string): Promise<void> {
-        return new Promise((complete, error) => {
-            const query$ = this.#appClient.query({ appKey });
-            this.#subscription.add(
-                Query.extractQueryValue(query$).subscribe({
-                    next: (x) => this.#current$.next(x),
-                    error,
-                    complete,
-                })
-            );
-        });
-    }
-
-    public loadApp<TEnvironment = unknown, TModule = unknown>(
-        appKey: string
-    ): Observable<AppBundle<TEnvironment, TModule>> {
-        const loadApp$ = this.getApp(appKey).pipe(
-            switchMap((manifest) => {
-                return firstValueFrom(
-                    // TODO: use source from manifest when service is ready!
-                    /* @vite-ignore */
-                    from(import(manifest.entry)).pipe(map((module) => ({ manifest, module })))
-                );
-            })
-        );
-
-        const loadConfig$ = this.getAppConfig(appKey).pipe(map((config) => ({ config })));
-
-        return merge(loadApp$, loadConfig$).pipe(
-            scan((acc: Partial<AppBundle>, next) => Object.assign({}, acc, next), {}),
-            /** only output when all attributes are filled */
-            filter((x): x is AppBundle<TEnvironment, TModule> =>
-                ['manifest', 'module', 'config'].every((key) => !!x[key as keyof AppBundle])
-            ),
-            throwIfEmpty(() => 'failed to load application')
-        );
-    }
-
-    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;