@equinor/fusion-framework-react 5.3.8 → 5.3.9

package/dist/types/feature-flag/index.d.ts

@@ -0,0 +1 @@
+export { useCurrentAppFeatureFlag, useCurrentAppFeatureFlags, useFrameworkFeatureFlag, useFrameworkFeatureFlags, } from './useFeatureFlags';

package/dist/types/feature-flag/useFeatureFlags.d.ts

@@ -0,0 +1,21 @@
+import { IFeatureFlag } from '@equinor/fusion-framework-module-feature-flag';
+export declare const useCurrentAppFeatureFlag: (key: string) => {
+    feature: IFeatureFlag<unknown> | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+};
+export declare const useCurrentAppFeatureFlags: () => {
+    features: IFeatureFlag<unknown>[] | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+};
+export declare const useFrameworkFeatureFlag: (key: string) => {
+    feature: IFeatureFlag<unknown> | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+};
+export declare const useFrameworkFeatureFlags: () => {
+    features: IFeatureFlag<unknown>[] | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+};

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.3.8";
+export declare const version = "5.3.9";

package/package.json

@@ -1,33 +1,16 @@
 {
   "name": "@equinor/fusion-framework-react",
-  "version": "5.3.8",
+  "version": "5.3.9",
   "description": "",
   "main": "dist/esm/index.js",
   "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "types": "./dist/types/index.d.ts"
-    },
-    "./app": {
-      "import": "./dist/esm/app/index.js",
-      "types": "./dist/types/app/index.d.ts"
-    },
-    "./context": {
-      "import": "./dist/esm/context/index.js",
-      "types": "./dist/types/context/index.d.ts"
-    },
-    "./hooks": {
-      "import": "./dist/esm/hooks/index.js",
-      "types": "./dist/types/hooks/index.d.ts"
-    },
-    "./http": {
-      "import": "./dist/esm/http/index.js",
-      "types": "./dist/types/http/index.d.ts"
-    },
-    "./signalr": {
-      "import": "./dist/esm/signalr/index.js",
-      "types": "./dist/types/signalr/index.d.ts"
-    }
+    ".": "./dist/esm/index.js",
+    "./app": "./dist/esm/app/index.js",
+    "./feature-flag": "./dist/esm/feature-flag/index.js",
+    "./context": "./dist/esm/context/index.js",
+    "./hooks": "./dist/esm/hooks/index.js",
+    "./http": "./dist/esm/http/index.js",
+    "./signalr": "./dist/esm/signalr/index.js"
   },
   "types": "dist/types/index.d.ts",
   "typesVersions": {
@@ -35,6 +18,9 @@
       "app": [
         "dist/types/app/index.d.ts"
       ],
+      "feature-flag": [
+        "dist/types/feature-flag/index.d.ts"
+      ],
       "context": [
         "dist/types/context/index.d.ts"
       ],
@@ -62,11 +48,11 @@
   },
   "dependencies": {
     "rxjs": "^7.8.1",
-    "@equinor/fusion-framework-module": "^4.2.6",
-    "@equinor/fusion-framework-react-module-http": "^4.0.5",
-    "@equinor/fusion-framework-react-module": "^3.0.7",
     "@equinor/fusion-framework": "^7.0.28",
-    "@equinor/fusion-observable": "^8.1.4"
+    "@equinor/fusion-framework-react-module": "^3.0.7",
+    "@equinor/fusion-framework-react-module-http": "^4.0.5",
+    "@equinor/fusion-observable": "^8.1.4",
+    "@equinor/fusion-framework-module": "^4.2.6"
   },
   "devDependencies": {
     "@types/react": "^18.2.20",
@@ -75,12 +61,14 @@
     "react-dom": "^18.2.0",
     "typescript": "^5.1.3",
     "@equinor/fusion-framework-module-app": "^5.2.12",
-    "@equinor/fusion-framework-react-module-context": "^6.0.18"
+    "@equinor/fusion-framework-react-module-context": "^6.0.18",
+    "@equinor/fusion-framework-module-feature-flag": "^0.0.1"
   },
   "peerDependencies": {
-    "@types/react": "^17.0.0 || ^18.0.0",
-    "react": "^17.0.0 || ^18.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0",
+    "@types/react": "^17.0.0 || ^18.0.0",
+    "react": "^17.0.0 || ^18.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0",
+    "@equinor/fusion-framework-module-feature-flag": "^0.0.1",
     "@equinor/fusion-framework-react-module-signalr": "^2.0.16"
   },
   "peerDependenciesMeta": {
@@ -90,6 +78,9 @@
     "@equinor/fusion-framework-react-module-signalr": {
       "optional": true
     },
+    "@equinor/fusion-framework-module-feature-flag": {
+      "optional": true
+    },
     "@types/react": {
       "optional": true
     },

package/src/feature-flag/index.ts

@@ -0,0 +1,6 @@
+export {
+    useCurrentAppFeatureFlag,
+    useCurrentAppFeatureFlags,
+    useFrameworkFeatureFlag,
+    useFrameworkFeatureFlags,
+} from './useFeatureFlags';

package/src/feature-flag/useFeatureFlags.ts

@@ -0,0 +1,113 @@
+import { useCallback, useMemo } from 'react';
+import { useObservableState } from '@equinor/fusion-observable/react';
+import {
+    FeatureFlagModule,
+    IFeatureFlagProvider,
+    IFeatureFlag,
+} from '@equinor/fusion-framework-module-feature-flag';
+
+import { useCurrentAppModules } from '../app/useCurrentAppModules';
+import { EMPTY, map } from 'rxjs';
+import { useFramework } from '../useFramework';
+
+/**
+ * useCurrentAppFeatureFlag.
+ *
+ * Hook for getting current app's featureFlag from framework/portal.
+ *
+ * if in an app setting use hook "useFeatureFlag" from \@equinor/fusion-framework-react-app/feature-flag package.
+ */
+export const useCurrentAppFeatureFlag = (
+    key: string,
+): {
+    feature: IFeatureFlag<unknown> | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+} => {
+    const provider$ = useCurrentAppModules<[FeatureFlagModule]>().modules$.pipe(
+        map((val) => val?.featureFlag),
+    );
+    const { value: provider } = useObservableState(provider$);
+    const { value: feature, error } = useObservableState(_useFeatureFlag(key, provider));
+    const setFeatureEnabled = _useSetFeatureflag(provider);
+    return { feature, error, setFeatureEnabled };
+};
+
+/**
+ * useCurrentAppFeatureFlags.
+ *
+ * Hook for getting current app's featureFlags from framework/portal.
+ *
+ * if in an app setting use hook "useFeatureFlags" from \@equinor/fusion-framework-react-app/feature-flag package.
+ */
+export const useCurrentAppFeatureFlags = (): {
+    features: IFeatureFlag<unknown>[] | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+} => {
+    const provider$ = useCurrentAppModules<[FeatureFlagModule]>().modules$.pipe(
+        map((val) => val?.featureFlag),
+    );
+    const { value: provider } = useObservableState(provider$);
+    const { value: features, error } = useObservableState(_useFeatureFlags(provider));
+    const setFeatureEnabled = _useSetFeatureflag(provider);
+    return { features, error, setFeatureEnabled };
+};
+
+/**
+ * useFrameworkFeatureFlag.
+ *
+ * Hook for getting single featureFlag from framework/portal.
+ */
+export const useFrameworkFeatureFlag = (
+    key: string,
+): {
+    feature: IFeatureFlag<unknown> | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+} => {
+    const provider = useFramework<[FeatureFlagModule]>().modules.featureFlag;
+    const { value: feature, error } = useObservableState(_useFeatureFlag(key, provider));
+    const setFeatureEnabled = _useSetFeatureflag(provider);
+    return { feature, error, setFeatureEnabled };
+};
+
+/**
+ * useFrameworkFeatureFlags.
+ *
+ * Hook for getting featureFlags from framework/portal.
+ */
+export const useFrameworkFeatureFlags = (): {
+    features: IFeatureFlag<unknown>[] | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+} => {
+    const provider = useFramework<[FeatureFlagModule]>().modules.featureFlag;
+    const { value: features, error } = useObservableState(_useFeatureFlags(provider));
+    const setFeatureEnabled = _useSetFeatureflag(provider);
+    return { features, error, setFeatureEnabled };
+};
+
+const _useFeatureFlag = (key: string, provider?: IFeatureFlagProvider) => {
+    return useMemo(() => {
+        return provider ? provider.getFeature(key) : EMPTY;
+    }, [provider, key]);
+};
+
+const _useFeatureFlags = (provider?: IFeatureFlagProvider) => {
+    return useMemo(() => {
+        return provider ? provider.getFeatures((_) => true) : EMPTY;
+    }, [provider]);
+};
+
+const _useSetFeatureflag = (provider?: IFeatureFlagProvider) => {
+    return useCallback(
+        (key: string, enabled: boolean) => {
+            if (!provider) {
+                throw new Error('Missing IFeatureFlagProvider.');
+            }
+            provider.toggleFeature({ key, enabled });
+        },
+        [provider],
+    );
+};

package/src/version.ts

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