@equinor/fusion-framework-react 7.4.0 → 7.4.2

package/src/feature-flag/useFeatures.ts

@@ -3,23 +3,23 @@ import { useCallback, useMemo } from 'react';
 import { of } from 'rxjs';
 import { map } from 'rxjs/operators';
 
-import {
-    type IFeatureFlagProvider,
-    type IFeatureFlag,
+import type {
+  IFeatureFlagProvider,
+  IFeatureFlag,
 } from '@equinor/fusion-framework-module-feature-flag';
 
-import { type FeatureSelectorFn } from '@equinor/fusion-framework-module-feature-flag/selectors';
+import type { FeatureSelectorFn } from '@equinor/fusion-framework-module-feature-flag/selectors';
 
 import { useObservableState } from '@equinor/fusion-observable/react';
 
 export interface UseFeaturesResult {
-    features: IFeatureFlag[];
-    error: unknown;
-    /**
-     * @param key - The key of the feature flag.
-     * @param enable - Optional provide new enabled state of the feature flag. _Defaults to inversion of current feature flag state_
-     */
-    toggleFeature: (key: string, enable?: boolean) => void;
+  features: IFeatureFlag[];
+  error: unknown;
+  /**
+   * @param key - The key of the feature flag.
+   * @param enable - Optional provide new enabled state of the feature flag. _Defaults to inversion of current feature flag state_
+   */
+  toggleFeature: (key: string, enable?: boolean) => void;
 }
 
 /**
@@ -31,47 +31,47 @@ export interface UseFeaturesResult {
  * @throws Error if the feature flag provider is missing.
  */
 export const useFeatures = (
-    provider?: IFeatureFlagProvider | null,
-    selector?: FeatureSelectorFn,
+  provider?: IFeatureFlagProvider | null,
+  selector?: FeatureSelectorFn,
 ): UseFeaturesResult => {
-    /**
-     * Custom hook that provides access to the feature flags and their values.
-     *
-     * @returns An object containing the features and any error that occurred while retrieving them.
-     */
-    const { value: features, error } = useObservableState(
-        useMemo(() => {
-            if (provider) {
-                return provider?.features$.pipe(
-                    map((x) => {
-                        const values = Object.values(x);
-                        return selector ? values.filter(selector) : values;
-                    }),
-                );
-            }
-            return of([]);
-        }, [provider, selector]),
-        { initial: Object.values(provider?.features ?? {}) },
-    );
-    /**
-     * Sets the enabled state of a feature flag.
-     *
-     * @param key - The key of the feature flag.
-     * @param enable - The new enabled state of the feature flag.
-     * @throws Error if IFeatureFlagProvider is missing.
-     */
-    const toggleFeature = useCallback(
-        (key: string, enable?: boolean) => {
-            if (!provider) {
-                throw new Error('Missing IFeatureFlagProvider.');
-            }
-            const enabled = enable === undefined ? !provider.getFeature(key)?.enabled : enable;
+  /**
+   * Custom hook that provides access to the feature flags and their values.
+   *
+   * @returns An object containing the features and any error that occurred while retrieving them.
+   */
+  const { value: features, error } = useObservableState(
+    useMemo(() => {
+      if (provider) {
+        return provider?.features$.pipe(
+          map((x) => {
+            const values = Object.values(x);
+            return selector ? values.filter(selector) : values;
+          }),
+        );
+      }
+      return of([]);
+    }, [provider, selector]),
+    { initial: Object.values(provider?.features ?? {}) },
+  );
+  /**
+   * Sets the enabled state of a feature flag.
+   *
+   * @param key - The key of the feature flag.
+   * @param enable - The new enabled state of the feature flag.
+   * @throws Error if IFeatureFlagProvider is missing.
+   */
+  const toggleFeature = useCallback(
+    (key: string, enable?: boolean) => {
+      if (!provider) {
+        throw new Error('Missing IFeatureFlagProvider.');
+      }
+      const enabled = enable === undefined ? !provider.getFeature(key)?.enabled : enable;
 
-            provider.toggleFeature({ key, enabled });
-        },
-        [provider],
-    );
-    return { features, error, toggleFeature };
+      provider.toggleFeature({ key, enabled });
+    },
+    [provider],
+  );
+  return { features, error, toggleFeature };
 };
 
 export default useFeatures;

package/src/feature-flag/useFrameworkFeature.ts

@@ -1,4 +1,4 @@
-import { type FeatureFlagModule } from '@equinor/fusion-framework-module-feature-flag';
+import type { FeatureFlagModule } from '@equinor/fusion-framework-module-feature-flag';
 
 import { useFrameworkModule } from '../useFrameworkModule';
 import { useFeature } from './useFeature';
@@ -12,11 +12,11 @@ import { useFeature } from './useFeature';
  * @throws {Error} - If feature flagging is not enabled in the framework.
  */
 export const useFrameworkFeature = <T>(key: string): ReturnType<typeof useFeature<T>> => {
-    const provider = useFrameworkModule<FeatureFlagModule>('featureFlag');
-    if (!provider) {
-        throw Error('Feature flagging is not enabled in the framework');
-    }
-    return useFeature(provider, key);
+  const provider = useFrameworkModule<FeatureFlagModule>('featureFlag');
+  if (!provider) {
+    throw Error('Feature flagging is not enabled in the framework');
+  }
+  return useFeature(provider, key);
 };
 
 export default useFrameworkFeature;

package/src/feature-flag/useFrameworkFeatures.ts

@@ -1,4 +1,4 @@
-import { type FeatureFlagModule } from '@equinor/fusion-framework-module-feature-flag';
+import type { FeatureFlagModule } from '@equinor/fusion-framework-module-feature-flag';
 
 import { useFrameworkModule } from '../useFrameworkModule';
 import { useFeatures } from './useFeatures';
@@ -10,11 +10,11 @@ import { useFeatures } from './useFeatures';
  * @throws Error if feature flagging is not enabled in the framework.
  */
 export const useFrameworkFeatures = (): ReturnType<typeof useFeatures> => {
-    const provider = useFrameworkModule<FeatureFlagModule>('featureFlag');
-    if (!provider) {
-        throw Error('Feature flagging is not enabled in the framework');
-    }
-    return useFeatures(provider);
+  const provider = useFrameworkModule<FeatureFlagModule>('featureFlag');
+  if (!provider) {
+    throw Error('Feature flagging is not enabled in the framework');
+  }
+  return useFeatures(provider);
 };
 
 export default useFrameworkFeatures;

package/src/hooks/use-current-user.ts

@@ -1,7 +1,7 @@
-import { AccountInfo } from '@equinor/fusion-framework-module-msal';
+import type { AccountInfo } from '@equinor/fusion-framework-module-msal';
 import { useFramework } from '../useFramework';
 
 export const useCurrentUser = (): AccountInfo | undefined => {
-    const framework = useFramework();
-    return framework.modules.auth.defaultAccount;
+  const framework = useFramework();
+  return framework.modules.auth.defaultAccount;
 };

package/src/hooks/use-http-client.ts

@@ -1,19 +1,19 @@
 import { useMemo } from 'react';
-import { Fusion } from '@equinor/fusion-framework';
+import type { Fusion } from '@equinor/fusion-framework';
 import { useFramework } from '../useFramework';
 
 type HttpClient = ReturnType<Fusion['modules']['http']['createClient']>;
 type FrameworkHttpClient = 'portal' | 'people';
 
 export const useHttpClient = (name: FrameworkHttpClient): HttpClient => {
-    const framework = useFramework();
+  const framework = useFramework();
 
-    const client = useMemo(() => {
-        if (framework.modules.http.hasClient(name)) {
-            return framework.modules.http.createClient(name);
-        }
-        throw Error(`no configured client for key [${name}]`);
-    }, [framework, name]);
-    // TODO - abort on unmount?
-    return client;
+  const client = useMemo(() => {
+    if (framework.modules.http.hasClient(name)) {
+      return framework.modules.http.createClient(name);
+    }
+    throw Error(`no configured client for key [${name}]`);
+  }, [framework, name]);
+  // TODO - abort on unmount?
+  return client;
 };

package/src/signalr/index.ts

@@ -1,6 +1,9 @@
 import { useFramework } from '../useFramework';
 
-import { SignalRModule, useProviderTopic } from '@equinor/fusion-framework-react-module-signalr';
+import {
+  type SignalRModule,
+  useProviderTopic,
+} from '@equinor/fusion-framework-react-module-signalr';
 
 /**
  * hook for subscribing to a topic of a SignalR hub
@@ -25,14 +28,12 @@ const myHook = () => {
  * @returns Topic
  */
 export const useSignalR = <T>(
-    hubId: string,
-    topicId: string,
+  hubId: string,
+  topicId: string,
 ): ReturnType<typeof useProviderTopic<T>> => {
-    const provider = useFramework<[SignalRModule]>().modules.signalR;
-    if (!provider) {
-        throw Error(
-            'SignalR is not configured, see @equinor/fusion-framework-react-module-signalr',
-        );
-    }
-    return useProviderTopic(provider, hubId, topicId);
+  const provider = useFramework<[SignalRModule]>().modules.signalR;
+  if (!provider) {
+    throw Error('SignalR is not configured, see @equinor/fusion-framework-react-module-signalr');
+  }
+  return useProviderTopic(provider, hubId, topicId);
 };

package/src/useFramework.ts

@@ -13,15 +13,15 @@ import { context } from './context';
  * ```
  */
 export const useFramework = <TModules extends Array<AnyModule> = []>(): Fusion<TModules> => {
-    let framework = useContext(context);
-    if (!framework) {
-        console.warn('could not locate fusion in context!');
-    }
-    framework ??= window.Fusion;
-    if (!framework) {
-        console.error('Could not load framework, might not be initiated?');
-    }
-    return framework;
+  let framework = useContext(context);
+  if (!framework) {
+    console.warn('could not locate fusion in context!');
+  }
+  framework ??= window.Fusion;
+  if (!framework) {
+    console.error('Could not load framework, might not be initiated?');
+  }
+  return framework;
 };
 
 export default useFramework;

package/src/useFrameworkModule.ts

@@ -1,6 +1,11 @@
 import type { FusionModules, FusionModulesInstance } from '@equinor/fusion-framework';
 import { useFramework } from './useFramework';
-import { AnyModule, ModuleKey, ModuleType, ModuleTypes } from '@equinor/fusion-framework-module';
+import type {
+  AnyModule,
+  ModuleKey,
+  ModuleType,
+  ModuleTypes,
+} from '@equinor/fusion-framework-module';
 
 /**
  * Retrieves a module from the framework instance based on its name.
@@ -12,20 +17,20 @@ import { AnyModule, ModuleKey, ModuleType, ModuleTypes } from '@equinor/fusion-f
  * @throws Error if the requested module is not included in the framework instance.
  */
 export const useFrameworkModule = <
-    TType extends AnyModule | unknown = unknown,
-    TKey extends string = ModuleKey<ModuleTypes<FusionModules<[TType]>>>,
+  TType extends AnyModule | unknown = unknown,
+  TKey extends string = ModuleKey<ModuleTypes<FusionModules<[TType]>>>,
 >(
-    name: TKey,
+  name: TKey,
 ): TType extends AnyModule
-    ? ModuleType<TType> | undefined
-    : FusionModulesInstance[Extract<keyof FusionModulesInstance, TKey>] | undefined => {
-    const framework = useFramework();
-    // TODO
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    const module = framework.modules[name];
-    if (!module) {
-        console.warn(`the requested module [${module}] is not included in the framework instance`);
-    }
-    return module;
+  ? ModuleType<TType> | undefined
+  : FusionModulesInstance[Extract<keyof FusionModulesInstance, TKey>] | undefined => {
+  const framework = useFramework();
+  // TODO
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const module = framework.modules[name];
+  if (!module) {
+    console.warn(`the requested module [${module}] is not included in the framework instance`);
+  }
+  return module;
 };

package/src/version.ts

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