@equinor/fusion-framework-react 8.0.0-next.0 → 8.0.0

package/src/useFramework.ts

@@ -4,12 +4,24 @@ import type { AnyModule } from '@equinor/fusion-framework-module';
 import { useContext } from 'react';
 import { context } from './context';
 /**
+ * React hook that returns the current Fusion Framework instance from context.
+ *
+ * @remarks
+ * The hook first looks for a framework instance provided via
+ * {@link FrameworkProvider}. If none is found it falls back to the global
+ * `window.Fusion` object. A console warning / error is emitted when the
+ * framework cannot be resolved.
+ *
+ * @template TModules - Tuple of additional module types expected on the
+ *   framework instance (used for type-narrowing only).
+ * @returns The active {@link Fusion} instance.
+ *
  * @example
  * ```ts
- * const useSometing = () => {
- *  const fusion = useFramework();
- *  return fusion.something;
- * }
+ * const useMyService = () => {
+ *   const fusion = useFramework();
+ *   return fusion.modules.http.createClient('my-service');
+ * };
  * ```
  */
 export const useFramework = <TModules extends Array<AnyModule> = []>(): Fusion<TModules> => {

package/src/useFrameworkModule.ts

@@ -8,13 +8,20 @@ import type {
 } from '@equinor/fusion-framework-module';
 
 /**
- * Retrieves a module from the framework instance based on its name.
+ * React hook that retrieves a module from the Fusion Framework by 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.
+ * @template TType - The expected module type (used for type-narrowing).
+ * @template TKey - The module key string.
+ * @param name - The registered name of the module to retrieve.
+ * @returns The resolved module instance, or `undefined` if the module is
+ *   not registered.
+ *
+ * @example
+ * ```ts
+ * import type { HttpModule } from '@equinor/fusion-framework-module-http';
+ *
+ * const http = useFrameworkModule<HttpModule>('http');
+ * ```
  */
 export const useFrameworkModule = <
   TType extends AnyModule | unknown = unknown,

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '8.0.0-next.0';
+export const version = '8.0.0';