@equinor/fusion-framework-react-app 5.2.2 → 5.2.3

package/dist/types/bookmark/useBookmark.d.ts

@@ -1,2 +1,18 @@
+/**
+ *  For application development the useCurrentBookmark should be sufficient enough
+ *
+ *  Functionality provided here is:
+ *  - addBookmarkCreator
+ *  - getAllBookmarks
+ *  - createBookmark
+ *  - updateBookmark
+ *  - deleteBookmarkById
+ *  - setCurrentBookmark
+ *  - currentBookmark
+ *  - bookmarks,
+ *
+ * @template TData - Current applications  bookmark type
+ * @return {*}  {Bookmarks<TData>} the full api fro handling bookmarks
+ */
 export declare const useBookmark: <TData>() => import("@equinor/fusion-framework-react-module-bookmark").Bookmarks<TData>;
 export default useBookmark;

package/dist/types/bookmark/useCurrentBookmark.d.ts

@@ -1,3 +1,15 @@
 import { CreateBookMarkFn } from '@equinor/fusion-framework-react-module-bookmark';
+/**
+ * By providing a CreateBookMarkFn bookmarks is enabled for the current application.
+ *
+ * @template TData - Type of data stored in bookmark
+ * @param {CreateBookMarkFn<TData>} [createBookmarkState] - Function for creating bookmark payload, this function should be wrapped in useCallback
+ *
+ * ```TS
+ * // Example
+ * const { currentBookmark } = useCurrentBookmark(useCallback(()=> someState, [someState]))
+ * ```
+ * @return {*}  {CurrentBookmark<TData>}
+ */
 export declare const useCurrentBookmark: <TData>(createBookmarkState?: CreateBookMarkFn<TData>) => import("@equinor/fusion-framework-react-module-bookmark").CurrentBookmark<TData>;
 export default useCurrentBookmark;

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/create-component.d.ts

@@ -9,7 +9,57 @@ export type ComponentRenderArgs<TFusion extends Fusion = Fusion, TEnv = AppEnv>
     env: TEnv;
 };
 export type ComponentRenderer<TFusion extends Fusion = Fusion, TEnv = AppEnv> = (fusion: TFusion, env: TEnv) => React.LazyExoticComponent<React.ComponentType>;
-export declare const createComponent: <TModules extends AnyModule[], TRef extends Fusion<unknown> = Fusion<unknown>, TEnv extends AppEnv = AppEnv>(Component: React.ElementType, configure?: AppModuleInitiator<TModules, TRef, TEnv>) => ComponentRenderer<TRef, TEnv>;
+/**
+ * @deprecated
+ * Creates an lazy loading Component which configures modules
+ * and provides context to framework and configured modules
+ *
+ *
+ * ```mermaid
+ * sequenceDiagram
+ * App ->>+Framework: createApp
+ * Framework->>-Framework: initializeModules
+ * Framework->>App: configure(modules, framework, args)
+ * App-->Framework: await configuration
+ * Framework->>App: React.LazyExoticComponent
+ * ```
+ *
+ * @example
+ * ```tsx
+ * const configCallback: AppConfigurator = (configurator) => {
+ *  configurator.http.configureClient(
+ *     'bar', {
+ *       baseUri: 'https://somewhere-test.com',
+ *       defaultScopes: ['foo/.default']
+ *     }
+ *   );
+ * };
+ *
+ * export const App = () => {
+ *   const client = useHttpClient('bar');
+ *   const [foo, setFoo] = useState('no value');
+ *   const onClick = useCallback(() => {
+ *     client.fetchAsync('api').then(x => x.json).then(setFoo);
+ *   }, [client]);
+ *   return <Button onClick={onClick}>{foo}</Button>
+ * }
+ *
+ * export const render = createApp(App, configCallback);
+ *
+ * export default render;
+ * ```
+ *
+ *
+ * __Exposed providers__
+ * @see {@link @equinor/fusion-framework-react.FrameworkProvider | FrameworkProvider}
+ * @see {@link ModuleProvider | ModuleProvider}
+ *
+ * @template TModules module types included in configuration.
+ * @param Component - React component to render
+ * @param configure - Callback for configuring application
+ * @param modules - required modules for application
+ */
+export declare const createComponent: <TModules extends Array<AnyModule>, TRef extends Fusion = Fusion<unknown>, TEnv extends AppEnv = AppEnv>(Component: React.ElementType, configure?: AppModuleInitiator<TModules, TRef, TEnv>) => ComponentRenderer<TRef, TEnv>;
 declare module '@equinor/fusion-framework-module-event' {
     interface FrameworkEventMap {
         onReactAppLoaded: FrameworkEvent<FrameworkEventInit<{

package/dist/types/create-legacy-app.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import type { AnyModule } from '@equinor/fusion-framework-module';
 import type { AppModuleInitiator } from '@equinor/fusion-framework-app';
-export declare const createLegacyApp: <TModules extends AnyModule[]>(Component: React.ElementType, configure?: AppModuleInitiator<TModules>) => () => JSX.Element;
+export declare const createLegacyApp: <TModules extends Array<AnyModule>>(Component: React.ElementType, configure?: AppModuleInitiator<TModules>) => () => JSX.Element;

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

@@ -1,13 +1,33 @@
 import { type IAppConfigurator } from '@equinor/fusion-framework-app';
 import { type FeatureFlagBuilderCallback, type IFeatureFlag } from '@equinor/fusion-framework-module-feature-flag';
+/**
+ * Enables the specified feature flags.
+ *
+ * @param configurator - The AppConfigurator instance.
+ * @param flags - An array of feature flags to enable.
+ */
 export interface enableFeatureFlag {
     (configurator: IAppConfigurator, flags: Array<IFeatureFlag<unknown> & {
         allowUrl?: boolean | undefined;
     }>): void;
 }
+/**
+ * Enables a feature flag by invoking the provided configurator and callback.
+ *
+ * @param configurator - The AppConfigurator responsible for configuring the feature flag.
+ * @param cb - The FeatureFlagBuilderCallback to be executed for the feature flag.
+ *
+ * @remarks
+ * Advance use __ONLY__
+ */
 export interface enableFeatureFlag {
     (configurator: IAppConfigurator, cb: FeatureFlagBuilderCallback): void;
 }
+/**
+ * Enables feature flagging based on the provided configurator and flags callback.
+ * @param configurator The AppConfigurator instance.
+ * @param flags_cb Optional flags callback that can be an array of feature flags or a callback function.
+ */
 export declare function enableFeatureFlag(configurator: IAppConfigurator, flags_cb: Array<IFeatureFlag<unknown> & {
     allowUrl?: boolean | undefined;
 }> | FeatureFlagBuilderCallback): void;

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

@@ -1,6 +1,12 @@
 import { type IFeatureFlag } from '@equinor/fusion-framework-module-feature-flag';
+/**
+ * Custom hook for accessing and manipulating feature flags.
+ * @template T - The type of the feature flag value.
+ * @param key - The key of the feature flag.
+ * @returns An object containing the feature flag, toggle function, and error (if any).
+ */
 export declare const useFeature: <T = unknown>(key: string) => {
-    feature?: IFeatureFlag<T> | undefined;
+    feature?: IFeatureFlag<T>;
     toggleFeature: (enabled?: boolean) => void;
     error?: unknown;
 };

package/dist/types/framework/useFrameworkCurrentContext.d.ts

@@ -1,5 +1,5 @@
 export declare const useFrameworkCurrentContext: () => {
     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 useFrameworkCurrentContext;

package/dist/types/make-component.d.ts

@@ -9,7 +9,28 @@ export type ComponentRenderArgs<TFusion extends Fusion = Fusion, TEnv = AppEnv>
     env: TEnv;
 };
 export type ComponentRenderer<TFusion extends Fusion = Fusion, TEnv = AppEnv> = (fusion: TFusion, env: TEnv) => React.LazyExoticComponent<React.ComponentType>;
-export declare const makeComponent: <TModules extends AnyModule[], TRef extends Fusion<unknown> = Fusion<unknown>, TEnv extends AppEnv = AppEnv>(Component: React.ReactNode, args: {
+/**
+ * Creates a lazy loading React Component that initializes and configures modules,
+ * then provides the necessary context to both the Fusion framework and the configured modules.
+ * This function is particularly useful for setting up a React application with modular architecture,
+ * allowing for lazy loading of components along with their dependencies.
+ *
+ * __Exposed providers__:
+ * - {@link @equinor/fusion-framework-react.FrameworkProvider | FrameworkProvider} to provide Fusion context.
+ * - {@link @equinor/fusion-framework-react-module.ModuleProvider | ModuleProvider} to provide module instances.
+ *
+ * @template TModules The types of modules included in the configuration.
+ * @template TRef The type of the Fusion instance.
+ * @template TEnv The environment type for the application.
+ * @param {React.ReactNode} Component - The React component to render lazily.
+ * @param {Object} args - The arguments required for module configuration and component rendering.
+ * @param {TRef} args.fusion - The Fusion instance to be used by the component and modules.
+ * @param {TEnv} args.env - The environment context for the application.
+ * @param {AppModuleInitiator<TModules, TRef, TEnv>} [configure] - Optional callback function for configuring application modules.
+ * @returns {React.LazyExoticComponent<React.ComponentType>} A lazy component that, when rendered,
+ * initializes the specified modules and provides the necessary Fusion and module context.
+ */
+export declare const makeComponent: <TModules extends Array<AnyModule>, TRef extends Fusion = Fusion<unknown>, TEnv extends AppEnv = AppEnv>(Component: React.ReactNode, args: {
     fusion: TRef;
     env: TEnv;
 }, configure?: AppModuleInitiator<TModules, TRef, TEnv>) => React.LazyExoticComponent<React.ComponentType>;

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

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

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

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

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

@@ -1,6 +1,11 @@
 import { AuthRequest, AuthenticationResult } from '@equinor/fusion-framework-module-msal/client';
+/**
+ * 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 declare const useToken: (req: AuthRequest) => {
-    token?: AuthenticationResult | undefined;
+    token?: AuthenticationResult;
     pending: boolean;
     error: unknown;
 };

package/dist/types/navigation/useNavigationModule.d.ts

@@ -1,2 +1,3 @@
 import { INavigationProvider } from '@equinor/fusion-framework-module-navigation';
+/** hook for getting the navigation provider (if enabled!) */
 export declare const useNavigationModule: () => INavigationProvider;

package/dist/types/navigation/useRouter.d.ts

@@ -1,2 +1,8 @@
 import { type INavigationProvider } from '@equinor/fusion-framework-module-navigation';
-export declare const useRouter: (routes: Parameters<INavigationProvider['createRouter']>[0]) => ReturnType<INavigationProvider['createRouter']>;
+/**
+ * create a router for react routing
+ * @see {@link [docs](https://equinor.github.io/fusion-framework/modules/navigation/)}
+ * @see {@link [react-router](https://reactrouter.com/en/main/routers/create-browser-router)}
+ * @param routes router objects __(must be static | memorized)__
+ */
+export declare const useRouter: (routes: Parameters<INavigationProvider["createRouter"]>[0]) => ReturnType<INavigationProvider["createRouter"]>;

package/dist/types/render-app.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="react" />
 import { RenderTeardown } from './render-component';
 import type { ComponentRenderArgs } from './create-component';
+/** @deprecated */
 export declare const renderApp: (Component: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements>, configure?: import("@equinor/fusion-framework-app").AppModuleInitiator<import("@equinor/fusion-framework-module").AnyModule[], import("@equinor/fusion-framework-react").Fusion<unknown>, import("@equinor/fusion-framework-app").AppEnv> | undefined) => (el: HTMLElement, args: ComponentRenderArgs) => RenderTeardown;
 export default renderApp;

package/dist/types/render-component.d.ts

@@ -1,4 +1,5 @@
 import type { ComponentRenderArgs, ComponentRenderer } from './create-component';
 export type RenderTeardown = VoidFunction;
+/** @deprecated */
 export declare const renderComponent: (renderer: ComponentRenderer) => (el: HTMLElement, args: ComponentRenderArgs) => RenderTeardown;
 export default renderComponent;

package/dist/types/useAppEnvironmentVariables.d.ts

@@ -1,2 +1,27 @@
 import { type ObservableStateReturnType } from '@equinor/fusion-observable/react';
+/**
+ * A React hook that provides access to the application's environment variables.
+ *
+ * This hook returns an observable state object that represents the current environment configuration.
+ * The environment configuration is retrieved from the app module provided by the framework.
+ *
+ * @note This hook is only available when the app module is loaded (should be always for applications).
+ * This hook in theory should always have a value if config was provided for the application, but is async by nature, hence the `complete` and `error` properties.
+ *
+ * @example
+ * ```typescript
+ * const MyComponent = () => {
+ *   const env = useAppEnvironmentVariables();
+ *   if(!env.complete) {
+ *     return <div>Loading environment variables...</div>;
+ *   }
+ *   if(env.error) {
+ *    return <div>Error loading environment variables</div>;
+ *   }
+ *   return <div>My environment variables: {JSON.stringify(env.value)}</div>;
+ * }
+ *
+ * @template TEnvironmentVariables - The type of the environment variables. Defaults to `unknown`.
+ * @returns An observable state object containing the current environment configuration.
+ */
 export declare const useAppEnvironmentVariables: <TEnvironmentVariables = unknown>() => ObservableStateReturnType<TEnvironmentVariables>;

package/dist/types/useAppModule.d.ts

@@ -1,4 +1,12 @@
 import type { AppModules, AppModulesInstance } from '@equinor/fusion-framework-app';
 import type { AnyModule, ModuleKey, ModuleType, ModuleTypes } from '@equinor/fusion-framework-module';
+/**
+ * Retrieves the specified app module from the app scope.
+ *
+ * @template TType - The type of the app module.
+ * @template TKey - The key of the app module.
+ * @param module - The key of the app module to retrieve.
+ * @returns The app module instance if found, otherwise throws an error.
+ */
 export declare function useAppModule<TType extends AnyModule | unknown = unknown, TKey extends string = ModuleKey<ModuleTypes<AppModules<[TType]>>>>(module: TKey): TType extends AnyModule ? ModuleType<TType> : AppModulesInstance[Extract<keyof AppModulesInstance, TKey>];
 export default useAppModule;

package/dist/types/useAppModules.d.ts

@@ -1,3 +1,10 @@
 import type { AppModulesInstance } from '@equinor/fusion-framework-app';
-export declare const useAppModules: <T extends unknown = unknown>() => AppModulesInstance<T>;
+import type { AnyModule } from '@equinor/fusion-framework-module';
+/**
+ * Custom hook that returns an instance of the app modules.
+ *
+ * @template T - The type of the app modules.
+ * @returns An instance of the app modules.
+ */
+export declare const useAppModules: <T extends Array<AnyModule> | unknown = unknown>() => AppModulesInstance<T>;
 export default useAppModules;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.2.2";
+export declare const version = "5.2.3";

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

@@ -1,3 +1,7 @@
+/**
+ * [[include:react-app/README.MD]]
+ * @module
+ */
 export type { WidgetModuleInitiator } from '@equinor/fusion-framework-react-widget';
 export type { WidgetProps, WidgetModule, WidgetRenderArgs, WidgetStateInitial, } from '@equinor/fusion-framework-react-widget';
 export { Widget } from '@equinor/fusion-framework-react-widget';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-react-app",
-  "version": "5.2.2",
+  "version": "5.2.3",
   "description": "",
   "main": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -82,13 +82,13 @@
     "directory": "packages/react"
   },
   "dependencies": {
-    "@equinor/fusion-framework-app": "^9.1.2",
-    "@equinor/fusion-framework-module": "^4.3.1",
-    "@equinor/fusion-framework-module-navigation": "^4.0.2",
-    "@equinor/fusion-framework-module-app": "^5.3.7",
-    "@equinor/fusion-framework-react": "^7.1.1",
-    "@equinor/fusion-framework-react-module": "^3.1.2",
-    "@equinor/fusion-framework-react-module-http": "^6.0.0"
+    "@equinor/fusion-framework-app": "^9.1.3",
+    "@equinor/fusion-framework-module-app": "^5.3.8",
+    "@equinor/fusion-framework-react": "^7.1.2",
+    "@equinor/fusion-framework-module": "^4.3.2",
+    "@equinor/fusion-framework-module-navigation": "^4.0.3",
+    "@equinor/fusion-framework-react-module": "^3.1.3",
+    "@equinor/fusion-framework-react-module-http": "^6.0.1"
   },
   "devDependencies": {
     "@types/react": "^18.2.50",
@@ -96,21 +96,21 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "rxjs": "^7.8.1",
-    "typescript": "^5.4.2",
-    "@equinor/fusion-framework-module-event": "^4.1.2",
-    "@equinor/fusion-framework-module-feature-flag": "^1.1.4",
-    "@equinor/fusion-framework-module-msal": "^3.1.1",
-    "@equinor/fusion-framework-react-module-bookmark": "^2.1.10",
-    "@equinor/fusion-framework-react-module-context": "^6.2.8",
-    "@equinor/fusion-framework-react-widget": "^1.1.10",
-    "@equinor/fusion-observable": "^8.3.2"
+    "typescript": "^5.5.3",
+    "@equinor/fusion-framework-module-event": "^4.2.0",
+    "@equinor/fusion-framework-module-feature-flag": "^1.1.5",
+    "@equinor/fusion-framework-module-msal": "^3.1.2",
+    "@equinor/fusion-framework-react-module-context": "^6.2.9",
+    "@equinor/fusion-framework-react-module-bookmark": "^2.1.11",
+    "@equinor/fusion-framework-react-widget": "^1.1.11",
+    "@equinor/fusion-observable": "^8.3.3"
   },
   "peerDependencies": {
     "@types/react": "^17.0.0 || ^18.0.0",
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0",
     "rxjs": "^7.8.1",
-    "@equinor/fusion-framework-module-msal": "^3.1.1"
+    "@equinor/fusion-framework-module-msal": "^3.1.2"
   },
   "peerDependenciesMeta": {
     "@equinor/fusion-framework-react-module-context": {

package/src/version.ts

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