@equinor/fusion-framework-app 0.0.0-context-error-20240131144633

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@equinor/fusion-framework-app",
+  "version": "0.0.0-context-error-20240131144633",
+  "description": "",
+  "main": "dist/esm/index.js",
+  "exports": {
+    ".": "./dist/esm/index.js"
+  },
+  "types": "./dist/types/index.d.ts",
+  "keywords": [
+    "fusion",
+    "fusion-framework",
+    "utility"
+  ],
+  "homepage": "https://equinor.github.io/fusion-framework/",
+  "author": {
+    "name": "Odin thomas Rochmann",
+    "email": "oroc@equinor.com",
+    "url": "https://github.com/odinr"
+  },
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/equinor/fusion-framework.git",
+    "directory": "packages/app"
+  },
+  "dependencies": {
+    "@equinor/fusion-framework": "^0.0.0-context-error-20240131144633",
+    "@equinor/fusion-framework-module": "^4.2.6",
+    "@equinor/fusion-framework-module-app": "^5.2.12",
+    "@equinor/fusion-framework-module-event": "^4.0.7",
+    "@equinor/fusion-framework-module-http": "^5.1.5",
+    "@equinor/fusion-framework-module-msal": "^3.0.9"
+  },
+  "devDependencies": {
+    "typescript": "^5.1.3",
+    "@equinor/fusion-framework-module-feature-flag": "^1.0.0"
+  },
+  "peerDependencies": {
+    "@equinor/fusion-framework-module-feature-flag": "^1.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@equinor/fusion-framework-module-feature-flag": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsc -b"
+  }
+}

package/src/AppConfigurator.ts

@@ -0,0 +1,192 @@
+import { type FusionModulesInstance } from '@equinor/fusion-framework';
+
+import {
+    type AnyModule,
+    type IModulesConfigurator,
+    ModuleConsoleLogger,
+    ModulesConfigurator,
+} from '@equinor/fusion-framework-module';
+
+import event from '@equinor/fusion-framework-module-event';
+
+import http, {
+    configureHttpClient,
+    configureHttp,
+    type HttpClientOptions,
+} from '@equinor/fusion-framework-module-http';
+
+import auth, { configureMsal } from '@equinor/fusion-framework-module-msal';
+
+import {
+    enableFeatureFlagging,
+    type IFeatureFlag,
+    type FeatureFlagBuilderCallback,
+} from '@equinor/fusion-framework-module-feature-flag';
+import {
+    createLocalStoragePlugin,
+    createUrlPlugin,
+} from '@equinor/fusion-framework-module-feature-flag/plugins';
+
+import { AppEnv, AppModules } from './types';
+
+/**
+ * Configurator for configuring application modules
+ *
+ * @template TModules Addition modules
+ * @template TRef usually undefined, optional references
+ */
+export interface IAppConfigurator<
+    TModules extends Array<AnyModule> | unknown = unknown,
+    TRef extends FusionModulesInstance = FusionModulesInstance,
+> extends IModulesConfigurator<AppModules<TModules>, TRef> {
+    /**
+     * [optional]
+     * enable/configure the http module
+     */
+    configureHttp(...args: Parameters<typeof configureHttp>): void;
+
+    /**
+     * [optional]
+     * Configure a named http client.
+     * @example
+     * ```ts
+     configurator.configureHttpClient(
+        'myClient', 
+        { 
+            baseUri: 'https://foo.bar', 
+            defaultScopes: ['client-id/.default'] 
+        }
+    );
+     * ```
+     */
+    configureHttpClient(...args: Parameters<typeof configureHttpClient>): void;
+
+    /**
+     * [required]
+     * Setup of MSAL auth module
+     * @example
+     * ```ts
+     configurator.configureMsal(
+        {
+            tenantId: '{TENANT_ID}',
+            clientId: '{CLIENT_ID}',
+            redirectUri: '/authentication/login-callback',
+        },
+        { requiresAuth: true }
+    );
+     * ```
+     */
+    configureMsal(...args: Parameters<typeof configureMsal>): void;
+
+    /**
+     * [optional]
+     *
+     * configure a http client which is resolved by service discovery
+     *
+     * @param serviceName - name of the service to use
+     */
+    // TODO - rename
+    useFrameworkServiceClient(serviceName: string): void;
+
+    /**
+     * enable feature flagging with predefined flags
+     * @param flags array of flags
+     * @remarks
+     * this will store defined flags in local storage
+     */
+    useFeatureFlags(flags: Array<IFeatureFlag & { allowUrl?: boolean }>): void;
+
+    /**
+     * enable feature flagging with callback
+     * @param cb callback for configuring module
+     */
+    useFeatureFlags(cb: FeatureFlagBuilderCallback): void;
+
+    /**
+     * enable feature flags
+     * @remarks
+     * this function does nothing atm since api is not implemented yet
+     */
+    useFeatureFlags(): void;
+}
+
+export class AppConfigurator<
+        TModules extends Array<AnyModule> | unknown = unknown,
+        TRef extends FusionModulesInstance = FusionModulesInstance,
+        TEnv extends AppEnv = AppEnv,
+    >
+    extends ModulesConfigurator<AppModules<TModules>, TRef>
+    implements IAppConfigurator<TModules, TRef>
+{
+    constructor(public readonly env: TEnv) {
+        super([event, http, auth]);
+        this.logger = new ModuleConsoleLogger('AppConfigurator');
+    }
+
+    public configureHttp(...args: Parameters<typeof configureHttp>) {
+        this.addConfig(configureHttp(...args));
+    }
+
+    public configureHttpClient(...args: Parameters<typeof configureHttpClient>) {
+        this.addConfig(configureHttpClient(...args));
+    }
+
+    public useFrameworkServiceClient(
+        serviceName: string,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        options?: Omit<HttpClientOptions<any>, 'baseUri' | 'defaultScopes'>,
+    ): void {
+        this.addConfig({
+            module: http,
+            configure: async (config, ref) => {
+                const service = await ref?.serviceDiscovery.resolveService(serviceName);
+                if (!service) {
+                    throw Error(`failed to configure service [${serviceName}]`);
+                }
+                config.configureClient(serviceName, {
+                    ...options,
+                    baseUri: service.uri,
+                    defaultScopes: service.defaultScopes,
+                });
+            },
+        });
+    }
+
+    public configureMsal(...args: Parameters<typeof configureMsal>) {
+        this.addConfig(configureMsal(...args));
+    }
+
+    useFeatureFlags(
+        flags_cb?:
+            | Array<IFeatureFlag<unknown> & { allowUrl?: boolean | undefined }>
+            | FeatureFlagBuilderCallback,
+    ): void {
+        switch (typeof flags_cb) {
+            case 'function': {
+                enableFeatureFlagging(this, flags_cb);
+                break;
+            }
+            case 'object': {
+                const urlFlags: IFeatureFlag[] = [];
+                const localFlags = (flags_cb ?? []).map((flag) => {
+                    const { allowUrl, ...localFlag } = flag;
+                    if (allowUrl) {
+                        urlFlags.push(flag);
+                    }
+                    return localFlag;
+                });
+                enableFeatureFlagging(this, async (builder) => {
+                    builder.addPlugin(
+                        createLocalStoragePlugin(localFlags, {
+                            name: this.env.manifest.key,
+                        }),
+                    );
+                    builder.addPlugin(createUrlPlugin(urlFlags));
+                });
+                break;
+            }
+        }
+    }
+}
+
+export default AppConfigurator;

package/src/configure-modules.ts

@@ -0,0 +1,61 @@
+import { Fusion } from '@equinor/fusion-framework';
+import type { AnyModule } from '@equinor/fusion-framework-module';
+
+import { AppConfigurator } from './AppConfigurator';
+import type { AppModulesInstance, AppModuleInitiator, AppEnv } from './types';
+
+/**
+ * 
+ * Creates a callback for initializing configuration of application modules
+ * 
+ * @example
+ ```ts
+    const initialize =  configureModules((configurator, args) => {
+        configurator.configure(someModule);
+    });
+    await initialize({ fusion, { manifest, config }});
+ ```
+ * @template TModules Addition modules
+ * @template TRef usually undefined, optional references
+ * @template TEnv environment object for configuring modules
+ * 
+ * @param cb configuration callback
+ * 
+ * @returns initialize function, executes configurator
+ */
+export const configureModules =
+    <
+        TModules extends Array<AnyModule> | never,
+        TRef extends Fusion = Fusion,
+        TEnv extends AppEnv = AppEnv,
+    >(
+        cb?: AppModuleInitiator<TModules, TRef, TEnv>,
+    ): ((args: { fusion: TRef; env: TEnv }) => Promise<AppModulesInstance<TModules>>) =>
+    /**
+     *
+     * Callback for initializing application modules
+     *
+     * @param args - Fusion and application  environments (manifest, config ...)
+     * @returns initialized app modules
+     */
+    async (args: { fusion: TRef; env: TEnv }): Promise<AppModulesInstance<TModules>> => {
+        const configurator = new AppConfigurator<TModules, TRef['modules'], TEnv>(args.env);
+        if (cb) {
+            await Promise.resolve(cb(configurator, args));
+        }
+        const modules = (await configurator.initialize(
+            args.fusion.modules,
+            // TODO
+        )) as unknown as AppModulesInstance<TModules>;
+
+        // @eikeland
+        // TODO - remove check after fusion-cli is updated (app module is not enabled in fusion-cli)
+        if (args.env.manifest?.key) {
+            modules.event.dispatchEvent('onAppModulesLoaded', {
+                detail: { appKey: args.env.manifest.key, modules },
+            });
+        }
+        return modules;
+    };
+
+export default configureModules;

package/src/index.ts

@@ -0,0 +1,8 @@
+export { AppConfigurator, IAppConfigurator } from './AppConfigurator';
+
+export * from './types';
+
+export { configureModules, default } from './configure-modules';
+
+// TODO remove
+export { configureModules as initAppModules } from './configure-modules';

package/src/types.ts

@@ -0,0 +1,64 @@
+import type { Fusion } from '@equinor/fusion-framework';
+
+import type { AnyModule } from '@equinor/fusion-framework-module';
+
+import type {
+    AppConfig,
+    AppManifest,
+    AppModulesInstance,
+} from '@equinor/fusion-framework-module-app';
+
+import type { IAppConfigurator } from './AppConfigurator';
+
+export type {
+    AppModules,
+    AppManifest,
+    AppConfig,
+    AppModulesInstance,
+} from '@equinor/fusion-framework-module-app';
+
+/**
+ * Application environment args
+ * Arguments provided when initializing/configuring application modules
+ *
+ * @template TConfig config value type
+ * @template TProps [__not in use__] properties for application component
+ */
+export type AppEnv<TConfig = unknown, TProps = unknown> = {
+    /** base routing path of the application */
+    basename?: string;
+    manifest: AppManifest;
+    config?: AppConfig<TConfig>;
+    props?: TProps;
+};
+
+/**
+ * Blueprint for initializing application modules
+ *
+ * @template TModules Addition modules
+ * @template TRef usually undefined, optional references
+ * @template TEnv environment object for configuring modules
+ */
+export type AppModuleInitiator<
+    TModules extends Array<AnyModule> | unknown = unknown,
+    TRef extends Fusion = Fusion,
+    TEnv = AppEnv,
+> = (
+    configurator: IAppConfigurator<TModules, TRef['modules']>,
+    args: { fusion: TRef; env: TEnv },
+) => void | Promise<void>;
+
+/**
+ * Blueprint for creating application initialization
+ *
+ * @template TModules Addition modules
+ * @template TRef usually undefined, optional references
+ * @template TEnv environment object for configuring modules
+ */
+export type AppModuleInit<
+    TModules extends Array<AnyModule> | unknown,
+    TRef extends Fusion = Fusion,
+    TEnv = AppEnv,
+> = (
+    cb: AppModuleInitiator<TModules, TRef, TEnv>,
+) => (args: { fusion: TRef; env: TEnv }) => Promise<AppModulesInstance<TModules>>;

package/src/version.ts

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

package/tsconfig.json

@@ -0,0 +1,39 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist/esm",
+    "rootDir": "src",
+    "declarationDir": "./dist/types",
+    
+  },
+  "references": [
+    {
+      "path": "../modules/module"
+    },
+    {
+      "path": "../modules/http"
+    },
+    {
+      "path": "../modules/msal"
+    },
+    {
+      "path": "../modules/event"
+    },
+    {
+      "path": "../modules/app"
+    },
+    {
+      "path": "../modules/feature-flag"
+    },
+    {
+      "path": "../framework"
+    },
+  ],
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "lib"
+  ]
+}