@equinor/fusion-framework-react-module-context 7.0.0 → 7.0.2

package/dist/types/index.d.ts

@@ -1,4 +1,15 @@
+/**
+ * React integration for the Fusion context module.
+ *
+ * Provides hooks for reading the current context ({@link useCurrentContext},
+ * {@link useModuleCurrentContext}) and querying available contexts
+ * ({@link useQueryContext}, {@link useModuleQueryContext}).
+ *
+ * @packageDocumentation
+ */
 export { enableContext, ContextModule, ContextItem, ContextItemType, IContextProvider, IContextModuleConfigurator, } from '@equinor/fusion-framework-module-context';
 export { FusionContextSearchError } from '@equinor/fusion-framework-module-context/errors.js';
-export { useCurrentContext, useModuleCurrentContext } from './useCurrentContext';
-export { useQueryContext, useModuleQueryContext } from './useQueryContext';
+export { useCurrentContext } from './useCurrentContext';
+export { useModuleCurrentContext } from './useModuleCurrentContext';
+export { useQueryContext } from './useQueryContext';
+export { useModuleQueryContext } from './useModuleQueryContext';

package/dist/types/useCurrentContext.d.ts

@@ -1,14 +1,12 @@
 import type { ContextItem } from '@equinor/fusion-framework-module-context';
-import { type IContextProvider } from '@equinor/fusion-framework-module-context';
-export declare const useCurrentContext: (provider: IContextProvider) => {
-    currentContext: ContextItem | null | undefined;
-    setCurrentContext: (entry?: ContextItem | string | null) => void | Promise<ContextItem<Record<string, unknown>> | null>;
-};
+import type { IContextProvider } from '@equinor/fusion-framework-module-context';
 /**
- * uses context provider from closes module provider
+ * Hook for observing and updating the framework's current context.
+ *
+ * @param provider - The context provider to observe and update
+ * @returns The current context and a setter that clears, sets by id, or sets it directly
  */
-export declare const useModuleCurrentContext: () => {
+export declare const useCurrentContext: (provider: IContextProvider) => {
     currentContext: ContextItem | null | undefined;
     setCurrentContext: (entry?: ContextItem | string | null) => void | Promise<ContextItem<Record<string, unknown>> | null>;
 };
-export default useModuleCurrentContext;

package/dist/types/useModuleCurrentContext.d.ts

@@ -0,0 +1,8 @@
+/**
+ * uses context provider from closes module provider
+ */
+export declare const useModuleCurrentContext: () => {
+    currentContext: import("@equinor/fusion-framework-module-context").ContextItem | null | undefined;
+    setCurrentContext: (entry?: import("@equinor/fusion-framework-module-context").ContextItem | string | null) => void | Promise<import("@equinor/fusion-framework-module-context").ContextItem<Record<string, unknown>> | null>;
+};
+export default useModuleCurrentContext;

package/dist/types/useModuleQueryContext.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Hook for querying the context module's context items, resolving the provider from the
+ * framework automatically.
+ *
+ * @param options - Optional query options, such as a debounce delay in milliseconds
+ * @returns The current query result, whether a query is in progress, and a function to trigger a new query
+ */
+export declare const useModuleQueryContext: (options?: {
+    debounce?: number;
+}) => {
+    value: import("@equinor/fusion-framework-module-context").ContextItem[] | undefined;
+    querying: boolean;
+    query: (search: string) => void;
+};

package/dist/types/useQueryContext.d.ts

@@ -1,4 +1,11 @@
-import { type IContextProvider } from '@equinor/fusion-framework-module-context';
+import type { IContextProvider } from '@equinor/fusion-framework-module-context';
+/**
+ * Hook for querying context items via the given context provider, debouncing calls.
+ *
+ * @param provider - The context provider used to perform the query
+ * @param options - Optional query options, such as a debounce delay in milliseconds
+ * @returns The current query result, whether a query is in progress, and a function to trigger a new query
+ */
 export declare const useQueryContext: (provider: IContextProvider, options?: {
     debounce?: number;
 }) => {
@@ -6,10 +13,3 @@ export declare const useQueryContext: (provider: IContextProvider, options?: {
     querying: boolean;
     query: (search: string) => void;
 };
-export declare const useModuleQueryContext: (options?: {
-    debounce?: number;
-}) => {
-    value: import("@equinor/fusion-framework-module-context").ContextItem[] | undefined;
-    querying: boolean;
-    query: (search: string) => void;
-};

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "7.0.0";
+export declare const version = "7.0.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-react-module-context",
-  "version": "7.0.0",
+  "version": "7.0.2",
   "description": "",
   "main": "dist/esm/index.js",
   "exports": {
@@ -22,17 +22,17 @@
     "directory": "packages/react/modules/context"
   },
   "dependencies": {
-    "@equinor/fusion-framework-module-context": "^8.0.0",
-    "@equinor/fusion-framework-react-module": "^4.0.0",
-    "@equinor/fusion-query": "^7.0.0",
-    "@equinor/fusion-observable": "^9.0.0"
+    "@equinor/fusion-framework-module-context": "^8.0.1",
+    "@equinor/fusion-framework-react-module": "^4.0.2",
+    "@equinor/fusion-observable": "^9.1.1",
+    "@equinor/fusion-query": "^7.0.2"
   },
   "devDependencies": {
     "@types/react": "^19.2.7",
     "@types/react-dom": "^19.2.3",
     "react": "^19.2.1",
     "react-dom": "^19.2.1",
-    "typescript": "^5.9.3"
+    "typescript": "^7.0.2"
   },
   "peerDependencies": {
     "@types/react": "^18.0.0 || ^19.0.0",

package/src/index.ts

@@ -1,3 +1,12 @@
+/**
+ * React integration for the Fusion context module.
+ *
+ * Provides hooks for reading the current context ({@link useCurrentContext},
+ * {@link useModuleCurrentContext}) and querying available contexts
+ * ({@link useQueryContext}, {@link useModuleQueryContext}).
+ *
+ * @packageDocumentation
+ */
 export {
   enableContext,
   ContextModule,
@@ -8,5 +17,7 @@ export {
 } from '@equinor/fusion-framework-module-context';
 export { FusionContextSearchError } from '@equinor/fusion-framework-module-context/errors.js';
 
-export { useCurrentContext, useModuleCurrentContext } from './useCurrentContext';
-export { useQueryContext, useModuleQueryContext } from './useQueryContext';
+export { useCurrentContext } from './useCurrentContext';
+export { useModuleCurrentContext } from './useModuleCurrentContext';
+export { useQueryContext } from './useQueryContext';
+export { useModuleQueryContext } from './useModuleQueryContext';

package/src/useCurrentContext.ts

@@ -1,9 +1,14 @@
-import type { ContextItem, ContextModule } from '@equinor/fusion-framework-module-context';
-import { type IContextProvider, contextModuleKey } from '@equinor/fusion-framework-module-context';
-import { useModule } from '@equinor/fusion-framework-react-module';
+import type { ContextItem } from '@equinor/fusion-framework-module-context';
+import type { IContextProvider } from '@equinor/fusion-framework-module-context';
 import { useObservableState } from '@equinor/fusion-observable/react';
 import { useCallback, useMemo } from 'react';
 
+/**
+ * Hook for observing and updating the framework's current context.
+ *
+ * @param provider - The context provider to observe and update
+ * @returns The current context and a setter that clears, sets by id, or sets it directly
+ */
 export const useCurrentContext = (provider: IContextProvider) => {
   const currentContext$ = useMemo(() => provider.currentContext$, [provider]);
   const { value: currentContext } = useObservableState(currentContext$, {
@@ -11,6 +16,7 @@ export const useCurrentContext = (provider: IContextProvider) => {
   });
   const setCurrentContext = useCallback(
     (entry?: ContextItem | string | null) => {
+      // Clear the current context when no entry is provided
       if (!entry) {
         return provider.clearCurrentContext();
       } else if (typeof entry === 'string') {
@@ -22,13 +28,3 @@ export const useCurrentContext = (provider: IContextProvider) => {
   );
   return { currentContext, setCurrentContext };
 };
-
-/**
- * uses context provider from closes module provider
- */
-export const useModuleCurrentContext = () => {
-  const provider = useModule<ContextModule>(contextModuleKey);
-  return useCurrentContext(provider);
-};
-
-export default useModuleCurrentContext;

package/src/useModuleCurrentContext.ts

@@ -0,0 +1,15 @@
+import type { ContextModule } from '@equinor/fusion-framework-module-context';
+import { contextModuleKey } from '@equinor/fusion-framework-module-context';
+import { useModule } from '@equinor/fusion-framework-react-module';
+
+import { useCurrentContext } from './useCurrentContext.js';
+
+/**
+ * uses context provider from closes module provider
+ */
+export const useModuleCurrentContext = () => {
+  const provider = useModule<ContextModule>(contextModuleKey);
+  return useCurrentContext(provider);
+};
+
+export default useModuleCurrentContext;

package/src/useModuleQueryContext.ts

@@ -0,0 +1,17 @@
+import type { ContextModule } from '@equinor/fusion-framework-module-context';
+import { contextModuleKey } from '@equinor/fusion-framework-module-context';
+import { useModule } from '@equinor/fusion-framework-react-module';
+
+import { useQueryContext } from './useQueryContext.js';
+
+/**
+ * Hook for querying the context module's context items, resolving the provider from the
+ * framework automatically.
+ *
+ * @param options - Optional query options, such as a debounce delay in milliseconds
+ * @returns The current query result, whether a query is in progress, and a function to trigger a new query
+ */
+export const useModuleQueryContext = (options?: { debounce?: number }) => {
+  const provider = useModule<ContextModule>(contextModuleKey);
+  return useQueryContext(provider, options);
+};

package/src/useQueryContext.ts

@@ -1,21 +1,19 @@
-import {
-  type ContextModule,
-  contextModuleKey,
-  type IContextProvider,
-} from '@equinor/fusion-framework-module-context';
-import { useModule } from '@equinor/fusion-framework-react-module';
+import type { IContextProvider } from '@equinor/fusion-framework-module-context';
 import { useObservableState, useDebounce } from '@equinor/fusion-observable/react';
 import { useMemo } from 'react';
 
+/**
+ * Hook for querying context items via the given context provider, debouncing calls.
+ *
+ * @param provider - The context provider used to perform the query
+ * @param options - Optional query options, such as a debounce delay in milliseconds
+ * @returns The current query result, whether a query is in progress, and a function to trigger a new query
+ */
 export const useQueryContext = (provider: IContextProvider, options?: { debounce?: number }) => {
+  // Layer caller-supplied options on top of the default debounce delay
   const args = Object.assign({}, { debounce: 500 }, options);
   const searchFn = useMemo(() => provider.queryContext.bind(provider), [provider]);
   const { idle, next, value$ } = useDebounce(searchFn, args);
   const { value } = useObservableState(value$);
   return { value, querying: !idle, query: next };
 };
-
-export const useModuleQueryContext = (options?: { debounce?: number }) => {
-  const provider = useModule<ContextModule>(contextModuleKey);
-  return useQueryContext(provider, options);
-};

package/src/version.ts

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