@equinor/fusion-framework-react-app 4.1.19 → 4.2.1

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

@@ -0,0 +1 @@
+export { useFeatureFlag, useFrameworkFeatureFlag, useFeatureFlags, 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 useFeatureFlag: (key: string) => {
+    feature: IFeatureFlag<unknown> | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+};
+export declare const useFeatureFlags: () => {
+    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/msal/index.d.ts

@@ -0,0 +1,3 @@
+export { useCurrentAccount } from './useCurrentAccount';
+export { useAccessToken } from './useAccessToken';
+export { useToken } from './useToken';

package/dist/types/msal/useAccessToken.d.ts

@@ -0,0 +1,6 @@
+import { AuthRequest } from '@equinor/fusion-framework-module-msal/client';
+export declare const useAccessToken: (req: AuthRequest) => {
+    token?: string | undefined;
+    pending: boolean;
+    error: unknown;
+};

package/dist/types/msal/useCurrentAccount.d.ts

@@ -0,0 +1,2 @@
+import { AccountInfo } from '@equinor/fusion-framework-module-msal';
+export declare const useCurrentAccount: () => AccountInfo | undefined;

package/dist/types/msal/useToken.d.ts

@@ -0,0 +1,7 @@
+import { AuthRequest, AuthenticationResult } from '@equinor/fusion-framework-module-msal/client';
+export declare const useToken: (req: AuthRequest) => {
+    token?: AuthenticationResult | undefined;
+    pending: boolean;
+    error: unknown;
+};
+export default useToken;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "4.1.19";
+export declare const version = "4.2.1";

package/package.json

@@ -1,33 +1,17 @@
 {
   "name": "@equinor/fusion-framework-react-app",
-  "version": "4.1.19",
+  "version": "4.2.1",
   "description": "",
   "main": "dist/esm/index.js",
   "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "types": "./dist/types/index.d.ts"
-    },
-    "./bookmark": {
-      "import": "./dist/esm/bookmark/index.js",
-      "types": "./dist/types/bookmark/index.d.ts"
-    },
-    "./context": {
-      "import": "./dist/esm/context/index.js",
-      "types": "./dist/types/context/index.d.ts"
-    },
-    "./framework": {
-      "import": "./dist/esm/framework/index.js",
-      "types": "./dist/types/framework/index.d.ts"
-    },
-    "./http": {
-      "import": "./dist/esm/http/index.js",
-      "types": "./dist/types/http/index.d.ts"
-    },
-    "./navigation": {
-      "import": "./dist/esm/navigation/index.js",
-      "types": "./dist/types/navigation/index.d.ts"
-    }
+    ".": "./dist/esm/index.js",
+    "./bookmark": "./dist/esm/bookmark/index.js",
+    "./context": "./dist/esm/context/index.js",
+    "./feature-flag": "./dist/esm/feature-flag/index.js",
+    "./framework": "./dist/esm/framework/index.js",
+    "./http": "./dist/esm/http/index.js",
+    "./msal": "./dist/esm/msal/index.js",
+    "./navigation": "./dist/esm/navigation/index.js"
   },
   "types": "./dist/types/index.d.ts",
   "typesVersions": {
@@ -38,12 +22,18 @@
       "context": [
         "dist/types/context/index.d.ts"
       ],
+      "feature-flag": [
+        "dist/types/feature-flag/index.d.ts"
+      ],
       "framework": [
         "dist/types/framework/index.d.ts"
       ],
       "http": [
         "dist/types/http/index.d.ts"
       ],
+      "msal": [
+        "dist/types/msal/index.d.ts"
+      ],
       "navigation": [
         "dist/types/navigation/index.d.ts"
       ]
@@ -61,28 +51,34 @@
     "directory": "packages/react"
   },
   "dependencies": {
-    "@equinor/fusion-framework-app": "^7.1.14",
-    "@equinor/fusion-framework-module-app": "^5.2.12",
+    "@equinor/fusion-framework-app": "^7.1.15",
     "@equinor/fusion-framework-module": "^4.2.6",
     "@equinor/fusion-framework-module-navigation": "^3.1.3",
-    "@equinor/fusion-framework-react": "^5.3.7",
+    "@equinor/fusion-framework-react": "^5.3.9",
     "@equinor/fusion-framework-react-module": "^3.0.7",
-    "@equinor/fusion-framework-react-module-http": "^4.0.4"
+    "@equinor/fusion-framework-module-app": "^5.2.12",
+    "@equinor/fusion-framework-react-module-http": "^4.0.5"
   },
   "devDependencies": {
     "@types/react": "^18.2.20",
     "@types/react-dom": "^18.2.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
+    "rxjs": "^7.8.1",
     "typescript": "^5.1.3",
     "@equinor/fusion-framework-module-event": "^4.0.7",
-    "@equinor/fusion-framework-react-module-bookmark": "^2.0.26",
-    "@equinor/fusion-framework-react-module-context": "^6.0.18"
+    "@equinor/fusion-framework-module-msal": "^3.0.9",
+    "@equinor/fusion-framework-module-feature-flag": "^0.0.1",
+    "@equinor/fusion-framework-react-module-context": "^6.0.18",
+    "@equinor/fusion-framework-react-module-bookmark": "^2.0.28",
+    "@equinor/fusion-observable": "^8.1.4"
   },
   "peerDependencies": {
     "@types/react": "^17.0.0 || ^18.0.0",
     "react": "^17.0.0 || ^18.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0"
+    "react-dom": "^17.0.0 || ^18.0.0",
+    "rxjs": "^7.8.1",
+    "@equinor/fusion-framework-module-msal": "^3.0.9"
   },
   "peerDependenciesMeta": {
     "@equinor/fusion-framework-react-module-context": {
@@ -94,11 +90,20 @@
     "@equinor/fusion-framework-react-module-bookmark": {
       "optional": true
     },
+    "@equinor/fusion-framework-module-feature-flag": {
+      "optional": true
+    },
+    "@equinor/fusion-observable": {
+      "optional": true
+    },
     "@types/react": {
       "optional": true
     },
     "react-dom": {
       "optional": true
+    },
+    "rxjs": {
+      "optional": true
     }
   },
   "scripts": {

package/src/feature-flag/index.ts

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

package/src/feature-flag/useFeatureFlags.ts

@@ -0,0 +1,110 @@
+import { useFramework } from '@equinor/fusion-framework-react';
+import { useAppModule } from '../useAppModule';
+import { useCallback, useMemo } from 'react';
+import { useObservableState } from '@equinor/fusion-observable/react';
+import {
+    FeatureFlagModule,
+    IFeatureFlagProvider,
+    IFeatureFlag,
+} from '@equinor/fusion-framework-module-feature-flag';
+import { EMPTY } from 'rxjs';
+
+/**
+ * useFeatureflag
+ *
+ * Hook for getting single featureflag from app.
+ *
+ * @param key string
+ */
+export const useFeatureFlag = (
+    key: string,
+): {
+    feature: IFeatureFlag<unknown> | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+} => {
+    const provider = useAppModule<FeatureFlagModule>('featureFlag');
+    const { value: feature, error } = useObservableState(_useFeatureFlag(key, provider));
+    const setFeatureEnabled = _useSetFeatureflag(provider);
+    return { feature, error, setFeatureEnabled };
+};
+
+/**
+ * useFeatureflags
+ *
+ * Hook for getting all featureflags from app.
+ *
+ * @param key string
+ */
+export const useFeatureFlags = (): {
+    features: IFeatureFlag<unknown>[] | undefined;
+    error: unknown;
+    setFeatureEnabled: (key: string, enabled: boolean) => void;
+} => {
+    const provider = useAppModule<FeatureFlagModule>('featureFlag');
+    const { value: features, error } = useObservableState(_useFeatureFlags(provider));
+    const setFeatureEnabled = _useSetFeatureflag(provider);
+    return { features, error, setFeatureEnabled };
+};
+
+/**
+ * useFrameworkFeatureflag
+ *
+ * Hook for getting single featureflag from portal.
+ *
+ * @param key string
+ */
+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 all featureflags from portal.
+ *
+ * @param key string
+ */
+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/msal/index.ts

@@ -0,0 +1,3 @@
+export { useCurrentAccount } from './useCurrentAccount';
+export { useAccessToken } from './useAccessToken';
+export { useToken } from './useToken';

package/src/msal/useAccessToken.ts

@@ -0,0 +1,15 @@
+import { AuthRequest } from '@equinor/fusion-framework-module-msal/client';
+import { useToken } from './useToken';
+
+/**
+ * Custom hook that retrieves an access token for the specified authentication request.
+ *
+ * @param req - The authentication request.
+ * @returns An object containing the access token, pending state, and error.
+ */
+export const useAccessToken = (
+    req: AuthRequest,
+): { token?: string; pending: boolean; error: unknown } => {
+    const { token, error, pending } = useToken(req);
+    return { token: token?.accessToken, pending, error };
+};

package/src/msal/useCurrentAccount.ts

@@ -0,0 +1,11 @@
+import { AccountInfo } from '@equinor/fusion-framework-module-msal';
+import useAppModule from '../useAppModule';
+
+/**
+ * Retrieves the current account information from the MSAL provider.
+ * @returns The current account information or undefined if no account is available.
+ */
+export const useCurrentAccount = (): AccountInfo | undefined => {
+    const msalProvider = useAppModule('auth');
+    return msalProvider.defaultAccount;
+};

package/src/msal/useToken.ts

@@ -0,0 +1,29 @@
+import { AuthRequest, AuthenticationResult } from '@equinor/fusion-framework-module-msal/client';
+import useAppModule from '../useAppModule';
+import { useEffect, useState } from 'react';
+
+/**
+ * Custom hook for acquiring an authentication token using MSAL.
+ * @param req - The authentication request.
+ * @returns An object containing the acquired token, pending state, and error.
+ */
+export const useToken = (
+    req: AuthRequest,
+): { token?: AuthenticationResult; pending: boolean; error: unknown } => {
+    const msalProvider = useAppModule('auth');
+    const [token, setToken] = useState<AuthenticationResult | undefined>(undefined);
+    const [pending, setPending] = useState<boolean>(false);
+    const [error, setError] = useState<unknown>(null);
+    useEffect(() => {
+        setPending(true);
+        setToken(undefined);
+        msalProvider
+            .acquireToken(req)
+            .then((token) => token && setToken(token))
+            .catch(setError)
+            .finally(() => setPending(false));
+    }, [msalProvider, req]);
+    return { token, pending, error };
+};
+
+export default useToken;

package/src/version.ts

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