@equinor/fusion-framework-app 7.1.15 → 8.0.1

package/dist/types/AppConfigurator.d.ts

@@ -2,18 +2,28 @@ import { type FusionModulesInstance } from '@equinor/fusion-framework';
 import { type AnyModule, type IModulesConfigurator, ModulesConfigurator } from '@equinor/fusion-framework-module';
 import { configureHttpClient, configureHttp, type HttpClientOptions } from '@equinor/fusion-framework-module-http';
 import { configureMsal } from '@equinor/fusion-framework-module-msal';
-import { AppModules } from './types';
+import { type IFeatureFlag, type FeatureFlagBuilderCallback } from '@equinor/fusion-framework-module-feature-flag';
+import { AppEnv, AppModules } from './types';
 export interface IAppConfigurator<TModules extends Array<AnyModule> | unknown = unknown, TRef extends FusionModulesInstance = FusionModulesInstance> extends IModulesConfigurator<AppModules<TModules>, TRef> {
     configureHttp(...args: Parameters<typeof configureHttp>): void;
     configureHttpClient(...args: Parameters<typeof configureHttpClient>): void;
     configureMsal(...args: Parameters<typeof configureMsal>): void;
     useFrameworkServiceClient(serviceName: string): void;
+    useFeatureFlags(flags: Array<IFeatureFlag & {
+        allowUrl?: boolean;
+    }>): void;
+    useFeatureFlags(cb: FeatureFlagBuilderCallback): void;
+    useFeatureFlags(): void;
 }
-export declare class AppConfigurator<TModules extends Array<AnyModule> | unknown = unknown, TRef extends FusionModulesInstance = FusionModulesInstance> extends ModulesConfigurator<AppModules<TModules>, TRef> implements IAppConfigurator<TModules, TRef> {
-    constructor();
+export declare 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> {
+    readonly env: TEnv;
+    constructor(env: TEnv);
     configureHttp(...args: Parameters<typeof configureHttp>): void;
     configureHttpClient(...args: Parameters<typeof configureHttpClient>): void;
     useFrameworkServiceClient(serviceName: string, options?: Omit<HttpClientOptions<any>, 'baseUri' | 'defaultScopes'>): void;
     configureMsal(...args: Parameters<typeof configureMsal>): void;
+    useFeatureFlags(flags_cb?: Array<IFeatureFlag<unknown> & {
+        allowUrl?: boolean | undefined;
+    }> | FeatureFlagBuilderCallback): void;
 }
 export default AppConfigurator;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "7.1.15";
+export declare const version = "8.0.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-app",
-  "version": "7.1.15",
+  "version": "8.0.1",
   "description": "",
   "main": "dist/esm/index.js",
   "exports": {
@@ -28,15 +28,24 @@
     "directory": "packages/app"
   },
   "dependencies": {
-    "@equinor/fusion-framework": "^7.0.28",
+    "@equinor/fusion-framework": "^7.0.29",
     "@equinor/fusion-framework-module": "^4.2.6",
-    "@equinor/fusion-framework-module-app": "^5.2.12",
-    "@equinor/fusion-framework-module-http": "^5.1.5",
+    "@equinor/fusion-framework-module-app": "^5.2.13",
+    "@equinor/fusion-framework-module-event": "^4.0.7",
     "@equinor/fusion-framework-module-msal": "^3.0.9",
-    "@equinor/fusion-framework-module-event": "^4.0.7"
+    "@equinor/fusion-framework-module-http": "^5.1.5"
   },
   "devDependencies": {
-    "typescript": "^5.1.3"
+    "typescript": "^5.1.3",
+    "@equinor/fusion-framework-module-feature-flag": "^1.0.1"
+  },
+  "peerDependencies": {
+    "@equinor/fusion-framework-module-feature-flag": "^1.0.1"
+  },
+  "peerDependenciesMeta": {
+    "@equinor/fusion-framework-module-feature-flag": {
+      "optional": true
+    }
   },
   "scripts": {
     "build": "tsc -b"

package/src/AppConfigurator.ts

@@ -17,7 +17,17 @@ import http, {
 
 import auth, { configureMsal } from '@equinor/fusion-framework-module-msal';
 
-import { AppModules } from './types';
+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
@@ -77,16 +87,38 @@ export interface IAppConfigurator<
      */
     // 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() {
+    constructor(public readonly env: TEnv) {
         super([event, http, auth]);
         this.logger = new ModuleConsoleLogger('AppConfigurator');
     }
@@ -123,6 +155,38 @@ export class AppConfigurator<
     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

@@ -39,7 +39,7 @@ export const configureModules =
      * @returns initialized app modules
      */
     async (args: { fusion: TRef; env: TEnv }): Promise<AppModulesInstance<TModules>> => {
-        const configurator = new AppConfigurator<TModules, TRef['modules']>();
+        const configurator = new AppConfigurator<TModules, TRef['modules'], TEnv>(args.env);
         if (cb) {
             await Promise.resolve(cb(configurator, args));
         }

package/src/version.ts

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

package/tsconfig.json

@@ -22,6 +22,9 @@
     {
       "path": "../modules/app"
     },
+    {
+      "path": "../modules/feature-flag"
+    },
     {
       "path": "../framework"
     },