@equinor/fusion-framework-react 7.1.1 → 7.1.3

package/dist/types/app/useAppProvider.d.ts

@@ -1,4 +1,8 @@
 import { FusionModulesInstance } from '@equinor/fusion-framework';
 import { AppModule } from '@equinor/fusion-framework-module-app';
-export declare const useAppProvider: () => FusionModulesInstance<[AppModule]>['app'];
+/**
+ * React Hook - get appProvider interface
+ * @returns framework AppModule
+ */
+export declare const useAppProvider: () => FusionModulesInstance<[AppModule]>["app"];
 export default useAppProvider;

package/dist/types/app/useApps.d.ts

@@ -1,4 +1,9 @@
 import { AppManifest } from '@equinor/fusion-framework-module-app';
+/**
+ * React Hook - Get apps from framework
+ * @param args Object with boolean  member includeHidden
+ * @returns Object {apps, isLoading} where apps is Array of AppManifest, isLoading is a boolean on observable complete
+ */
 export declare const useApps: (args?: {
     includeHidden: boolean;
 }) => {

package/dist/types/app/useCurrentApp.d.ts

@@ -1,6 +1,14 @@
 import { type AnyModule } from '@equinor/fusion-framework-module';
 import { type CurrentApp } from '@equinor/fusion-framework-module-app';
-export declare const useCurrentApp: <TModules extends AnyModule[] = [], TEnv = unknown>() => {
+/**
+ * Observers the stream of current app and return the latest application
+ *
+ * __Warning:__ type hint templates are only hints, this does not check if the modules are actually enabled!
+ *
+ * @template TModule type hint modules which the application has configured
+ * @template TEnv type hint what kind of environment config the application has
+ */
+export declare const useCurrentApp: <TModules extends Array<AnyModule> = [], TEnv = unknown>() => {
     currentApp?: CurrentApp<TModules, TEnv> | null;
     setCurrentApp: (appKey: string) => void;
     clearCurrentApp: () => void;

package/dist/types/app/useCurrentAppModule.d.ts

@@ -1,7 +1,17 @@
 import { AppModules, AppModulesInstance } from '@equinor/fusion-framework-module-app';
 import { ModuleKey, type AnyModule, ModuleTypes, ModuleType } from '@equinor/fusion-framework-module';
-export declare const useCurrentAppModule: <TType extends unknown = unknown, TKey extends string = ModuleKey<ModuleTypes<AppModules<[TType]>>>>(moduleKey: TKey) => {
-    module?: (TType extends AnyModule ? ModuleType<TType> : AppModulesInstance[Extract<"event", TKey> | Extract<"http", TKey> | Extract<"auth", TKey> | Extract<"dispose", TKey>]) | null | undefined;
+/**
+ * Retrieves the current app module based on the provided module key.
+ * @template TType - The type of the module.
+ * @template TKey - The type of the module key.
+ * @param {TKey} moduleKey - The key of the module to retrieve.
+ * @returns {AnyModule | null | undefined} - The current app module or null if not found.
+ * @remarks
+ *  - when module is null, there are no current selected application
+ *  - when undefined is, the application has not enabled the requested module
+ */
+export declare const useCurrentAppModule: <TType extends AnyModule | unknown = unknown, TKey extends string = ModuleKey<ModuleTypes<AppModules<[TType]>>>>(moduleKey: TKey) => {
+    module?: (TType extends AnyModule ? ModuleType<TType> : AppModulesInstance[Extract<keyof AppModulesInstance, TKey>]) | null;
     error?: unknown;
     complete: boolean;
 };

package/dist/types/app/useCurrentAppModules.d.ts

@@ -1,7 +1,15 @@
 import { AppModulesInstance } from '@equinor/fusion-framework-module-app';
 import { type AnyModule } from '@equinor/fusion-framework-module';
-export declare const useCurrentAppModules: <TModules extends AnyModule[] = []>() => {
-    modules?: AppModulesInstance<TModules> | null | undefined;
+/**
+ * Observers the stream of current app initialized modules
+ *
+ * __Warning:__ type hint templates are only hints, this does not check if the modules are actually enabled!
+ *
+ * @template TModule type hint modules which the application has configured
+ * @returns the observable instance of initialized modules of the application
+ */
+export declare const useCurrentAppModules: <TModules extends Array<AnyModule> = []>() => {
+    modules?: AppModulesInstance<TModules> | null;
     error?: unknown;
     complete: boolean;
 };

package/dist/types/context/useCurrentContext.d.ts

@@ -1,5 +1,5 @@
 export declare const useCurrentContext: () => {
     currentContext: import("@equinor/fusion-framework-react-module-context").ContextItem | null | undefined;
-    setCurrentContext: (entry?: string | import("@equinor/fusion-framework-react-module-context").ContextItem | null | undefined) => void | Promise<import("@equinor/fusion-framework-react-module-context").ContextItem<Record<string, unknown>> | null>;
+    setCurrentContext: (entry?: import("@equinor/fusion-framework-react-module-context").ContextItem | string | null) => void | Promise<import("@equinor/fusion-framework-react-module-context").ContextItem<Record<string, unknown>> | null>;
 };
 export default useCurrentContext;

package/dist/types/context.d.ts

@@ -1,4 +1,21 @@
-/// <reference types="react" />
 import type { Fusion } from '@equinor/fusion-framework';
 export declare const context: import("react").Context<Fusion<any> | null>;
+/**
+ * Component for providing framework.
+ *
+ * @remarks
+ * Should be created by {@link createFrameworkProvider}
+ *
+ * @example
+ * ```tsx
+ * import {FrameworkProvider} from '@equinor/fusion-framework-react';
+ * export const Component = (args: React.PropsWithChildren<{framework: Fusion}>) => {
+ *   return (
+ *      <FrameworkProvider value={args.framework}>
+ *        {args.children}
+ *      </FrameworkProvider>
+ *   );
+ * }
+ * ```
+ */
 export declare const FrameworkProvider: import("react").Provider<Fusion<any> | null>;

package/dist/types/create-framework-provider.d.ts

@@ -1,4 +1,23 @@
 import React from 'react';
 import { FusionConfigurator } from '@equinor/fusion-framework';
 import type { AnyModule } from '@equinor/fusion-framework-module';
-export declare const createFrameworkProvider: <TModules extends AnyModule[] = []>(cb: (configurator: FusionConfigurator<TModules>) => void | Promise<void>) => React.LazyExoticComponent<React.FunctionComponent<React.PropsWithChildren<unknown>>>;
+/**
+ * Create a framework provider for react.
+ *
+ * This function is for providers of framework, like a portal.
+ *
+ * @param configurator - callback for configuring modules
+ * @example
+ * ```tsx
+ * const config: FusionConfigurator = (config) => {}
+ * const Portal = () => {
+ *   const Framework = createFrameworkProvider(config);
+ *   return (
+ *      <Suspense fallback={<span>loading...</span>}>
+ *          <Framework>{children}</Framework>
+ *      </Suspense>
+ *   );
+ * };
+ * ```
+ */
+export declare const createFrameworkProvider: <TModules extends Array<AnyModule> = []>(cb: (configurator: FusionConfigurator<TModules>) => void | Promise<void>) => React.LazyExoticComponent<React.FunctionComponent<React.PropsWithChildren<unknown>>>;

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

@@ -1,2 +1,6 @@
 import { type UseFeaturesResult } from './useFeatures';
+/**
+ * Custom hook that returns the current app features and provides a function to toggle a feature.
+ * @returns An object containing the current app features, a function to toggle a feature, and any error that occurred.
+ */
 export declare const useCurrentAppFeatures: () => UseFeaturesResult;

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

@@ -2,7 +2,18 @@ import { type IFeatureFlag, type IFeatureFlagProvider } from '@equinor/fusion-fr
 export interface UseFeatureResult<T> {
     feature?: IFeatureFlag<T>;
     error?: unknown;
+    /**
+     * @param enable - Optional provide new enabled state of the feature flag. _Defaults to inversion of current feature flag state_
+     */
     toggleFeature: (enable?: boolean) => void;
 }
+/**
+ * Custom hook that retrieves a feature flag from a feature flag provider.
+ *
+ * @template T - The type of the feature flag value.
+ * @param {IFeatureFlagProvider} provider - The feature flag provider.
+ * @param {string} key - The key of the feature flag.
+ * @returns {UseFeatureResult<T>} - An object containing the feature flag value, a function to toggle the feature flag, and any error that occurred.
+ */
 export declare const useFeature: <T = unknown>(provider: IFeatureFlagProvider, key: string) => UseFeatureResult<T>;
 export default useFeature;

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

@@ -3,7 +3,19 @@ import { type FeatureSelectorFn } from '@equinor/fusion-framework-module-feature
 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;
 }
+/**
+ * Custom hook that provides access to the feature flags and their values.
+ *
+ * @param provider - The feature flag provider.
+ * @param selector - Optional function to filter the feature flags.
+ * @returns An object containing the features, any error that occurred while retrieving them, and a function to set the enabled state of a feature flag.
+ * @throws Error if the feature flag provider is missing.
+ */
 export declare const useFeatures: (provider?: IFeatureFlagProvider | null, selector?: FeatureSelectorFn) => UseFeaturesResult;
 export default useFeatures;

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

@@ -1,3 +1,11 @@
 import { useFeature } from './useFeature';
+/**
+ * Custom hook that allows accessing a framework feature based on a given feature flag key.
+ *
+ * @template T - The type of the feature.
+ * @param {string} key - The feature flag key.
+ * @returns {ReturnType<typeof useFeature<T>>} - The result of the feature hook.
+ * @throws {Error} - If feature flagging is not enabled in the framework.
+ */
 export declare const useFrameworkFeature: <T>(key: string) => ReturnType<typeof useFeature<T>>;
 export default useFrameworkFeature;

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

@@ -1,3 +1,9 @@
 import { useFeatures } from './useFeatures';
+/**
+ * Custom hook that provides access to framework-specific feature flags.
+ * It returns the result of the `useFeatures` hook from the `featureFlag` module.
+ * @returns The result of the `useFeatures` hook.
+ * @throws Error if feature flagging is not enabled in the framework.
+ */
 export declare const useFrameworkFeatures: () => ReturnType<typeof useFeatures>;
 export default useFrameworkFeatures;

package/dist/types/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * [[include:framework-react/README.MD]]
+ * @module
+ */
 export type { Fusion } from '@equinor/fusion-framework';
 export { FusionConfigurator } from '@equinor/fusion-framework';
 export { createFrameworkProvider } from './create-framework-provider';

package/dist/types/signalr/index.d.ts

@@ -1,2 +1,24 @@
 import { useProviderTopic } from '@equinor/fusion-framework-react-module-signalr';
+/**
+ * hook for subscribing to a topic of a SignalR hub
+ *
+ * @example
+ ```ts
+// config.ts
+import {enableSignalR} from '@equinor/fusion-framework-react-module-signalr';
+(configurator) => enableSignalR(configurator, 'notifications');
+
+// myHook.ts
+const myHook = () => {
+    const topic = useSignalR('notifications', 'foo');
+    return useObservableState(topic).next;
+}
+ ```
+ *
+ * @see {@link [module signalr](https://equinor.github.io/fusion-framework/modules/signalr)}
+ *
+ * @param hubId identifier of connection hub (must be configured)
+ * @param topicId identifier of topic to connect to
+ * @returns Topic
+ */
 export declare const useSignalR: <T>(hubId: string, topicId: string) => ReturnType<typeof useProviderTopic<T>>;

package/dist/types/useFramework.d.ts

@@ -1,4 +1,13 @@
 import type { Fusion } from '@equinor/fusion-framework';
 import type { AnyModule } from '@equinor/fusion-framework-module';
-export declare const useFramework: <TModules extends AnyModule[] = []>() => Fusion<TModules>;
+/**
+ * @example
+ * ```ts
+ * const useSometing = () => {
+ *  const fusion = useFramework();
+ *  return fusion.something;
+ * }
+ * ```
+ */
+export declare const useFramework: <TModules extends Array<AnyModule> = []>() => Fusion<TModules>;
 export default useFramework;

package/dist/types/useFrameworkModule.d.ts

@@ -1,3 +1,12 @@
 import type { FusionModules, FusionModulesInstance } from '@equinor/fusion-framework';
 import { AnyModule, ModuleKey, ModuleType, ModuleTypes } from '@equinor/fusion-framework-module';
-export declare const useFrameworkModule: <TType extends unknown = unknown, TKey extends string = ModuleKey<ModuleTypes<FusionModules<[TType]>>>>(name: TKey) => TType extends AnyModule ? ModuleType<TType> | undefined : FusionModulesInstance[Extract<keyof FusionModulesInstance, TKey>] | undefined;
+/**
+ * Retrieves a module from the framework instance based on its name.
+ *
+ * @template TType - The type of the module to retrieve.
+ * @template TKey - The type of the module name.
+ * @param name - The name of the module to retrieve.
+ * @returns The requested module from the framework instance.
+ * @throws Error if the requested module is not included in the framework instance.
+ */
+export declare const useFrameworkModule: <TType extends AnyModule | unknown = unknown, TKey extends string = ModuleKey<ModuleTypes<FusionModules<[TType]>>>>(name: TKey) => TType extends AnyModule ? ModuleType<TType> | undefined : FusionModulesInstance[Extract<keyof FusionModulesInstance, TKey>] | undefined;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "7.1.1";
+export declare const version = "7.1.3";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-react",
-  "version": "7.1.1",
+  "version": "7.1.3",
   "description": "",
   "main": "dist/esm/index.js",
   "exports": {
@@ -69,29 +69,29 @@
   },
   "dependencies": {
     "rxjs": "^7.8.1",
-    "@equinor/fusion-framework": "^7.2.1",
-    "@equinor/fusion-framework-react-module": "^3.1.2",
-    "@equinor/fusion-observable": "^8.3.2",
-    "@equinor/fusion-framework-react-module-http": "^6.0.0",
-    "@equinor/fusion-framework-module": "^4.3.1"
+    "@equinor/fusion-framework": "^7.2.3",
+    "@equinor/fusion-framework-react-module": "^3.1.3",
+    "@equinor/fusion-framework-module": "^4.3.2",
+    "@equinor/fusion-observable": "^8.3.3",
+    "@equinor/fusion-framework-react-module-http": "^6.0.1"
   },
   "devDependencies": {
     "@types/react": "^18.2.50",
     "@types/react-dom": "^18.2.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "typescript": "^5.4.2",
-    "@equinor/fusion-framework-module-event": "^4.1.2",
-    "@equinor/fusion-framework-module-app": "^5.3.7",
-    "@equinor/fusion-framework-module-feature-flag": "^1.1.4",
-    "@equinor/fusion-framework-react-module-context": "^6.2.8"
+    "typescript": "^5.5.3",
+    "@equinor/fusion-framework-module-app": "^5.3.8",
+    "@equinor/fusion-framework-module-feature-flag": "^1.1.5",
+    "@equinor/fusion-framework-module-event": "^4.2.1",
+    "@equinor/fusion-framework-react-module-context": "^6.2.9"
   },
   "peerDependencies": {
     "@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": "^1.1.4",
-    "@equinor/fusion-framework-react-module-signalr": "^3.0.10"
+    "@equinor/fusion-framework-module-feature-flag": "^1.1.5",
+    "@equinor/fusion-framework-react-module-signalr": "^3.0.11"
   },
   "peerDependenciesMeta": {
     "@equinor/fusion-framework-module-event": {

package/src/version.ts

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