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

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## 7.0.2
+
+### Patch Changes
+
+- 80c3e4a: Internal: added a missing intent comment for object-merge logic; no public API changes.
+- 80c3e4a: Internal: add intent comment to the `useCurrentContext` control-flow statement to satisfy the `require-intent-comment/flow` lint rule. No functional change.
+- 80c3e4a: Internal: add missing TSDoc comments to `useCurrentContext`, `useModuleQueryContext`, and `useQueryContext` to satisfy the `require-hook-tsdoc` lint rule. No functional change.
+- 80c3e4a: Internal: split multi-export files into one export per file and convert pure interop re-exports to `export { X } from 'y'` syntax, per `fusion-lint`'s `single-export-per-file` rule. Also removed `modules/event/src/EventProvider.tsx`, a fully dead duplicate of `eventContext.ts`/`useEventProvider.ts`/`useModulesEventProvider.ts` with no remaining consumers. No behavior changes.
+
+## 7.0.1
+
+### Patch Changes
+
+- 86a0599: Clarify the React context module README by documenting all package exports and linking to the existing app-scoped context wrapper documentation.
+
 ## 7.0.0
 
 ### Major Changes

package/README.md

@@ -0,0 +1,81 @@
+# @equinor/fusion-framework-react-module-context
+
+React hooks for the Fusion context module. Provides hooks to read the current context, set context, and query available contexts from React components.
+
+**Import:**
+
+```ts
+import { useCurrentContext, useQueryContext, enableContext } from '@equinor/fusion-framework-react-module-context';
+```
+
+## Exports
+
+| Export                      | Type     | Description                                                    |
+| --------------------------- | -------- | -------------------------------------------------------------- |
+| `useCurrentContext`         | Hook     | Read and set the current context (requires a provider argument) |
+| `useModuleCurrentContext`   | Hook     | Read and set the current context from the closest module scope |
+| `useQueryContext`           | Hook     | Search available contexts with debounce (requires a provider)  |
+| `useModuleQueryContext`     | Hook     | Search available contexts from the closest module scope        |
+| `enableContext`             | Function | Enable the context module in a configurator                    |
+| `ContextModule`             | Type     | Context module type definition                                 |
+| `ContextItem`               | Type     | A single context entry (project, facility, etc.)               |
+| `ContextItemType`           | Type     | Context item type discriminator                                |
+| `IContextProvider`          | Type     | Context provider interface                                     |
+| `IContextModuleConfigurator` | Type     | Configurator interface for enabling the context module         |
+| `FusionContextSearchError`  | Error    | Error thrown when context search fails                         |
+
+## This Package vs `react-app/context`
+
+| Scenario                                | Import from                                          |
+| --------------------------------------- | ---------------------------------------------------- |
+| Building a Fusion app (most common)     | `@equinor/fusion-framework-react-app/context`        |
+| Building a reusable library or module   | `@equinor/fusion-framework-react-module-context`     |
+| Building a portal or host application   | `@equinor/fusion-framework-react-module-context`     |
+
+The `react-app/context` sub-path wraps these hooks with app-scoped convenience. Use this package directly when building framework-level code or shared libraries that need explicit provider injection.
+
+## useCurrentContext / useModuleCurrentContext
+
+Returns the currently selected context and a setter function.
+
+```tsx
+import { useModuleCurrentContext } from '@equinor/fusion-framework-react-module-context';
+
+const ContextInfo = () => {
+  const { currentContext, setCurrentContext } = useModuleCurrentContext();
+
+  if (!currentContext) return <p>No context selected</p>;
+
+  return (
+    <div>
+      <p>{currentContext.title}</p>
+      <button onClick={() => setCurrentContext(null)}>Clear</button>
+    </div>
+  );
+};
+```
+
+## useQueryContext / useModuleQueryContext
+
+Search for available contexts with built-in debounce (default 500ms).
+
+```tsx
+import { useModuleQueryContext } from '@equinor/fusion-framework-react-module-context';
+
+const ContextSearch = () => {
+  const { value: results, querying, query } = useModuleQueryContext();
+
+  return (
+    <div>
+      <input onChange={(e) => query(e.target.value)} placeholder="Search contexts…" />
+      {querying && <span>Searching…</span>}
+      <ul>{results?.map((ctx) => <li key={ctx.id}>{ctx.title}</li>)}</ul>
+    </div>
+  );
+};
+```
+
+## Related
+
+- [`@equinor/fusion-framework-module-context`](../../modules/context/README.md) — the underlying context module
+- [`@equinor/fusion-framework-react-app/context`](../../app/README.md#context) — app-developer-facing wrapper

package/dist/esm/index.js

@@ -1,5 +1,16 @@
+/**
+ * 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, } 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';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,GAMd,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,oDAAoD,CAAC;AAE9F,OAAO,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EACL,aAAa,GAMd,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,oDAAoD,CAAC;AAE9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/esm/useCurrentContext.js

@@ -1,13 +1,18 @@
-import { contextModuleKey } from '@equinor/fusion-framework-module-context';
-import { useModule } from '@equinor/fusion-framework-react-module';
 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) => {
     const currentContext$ = useMemo(() => provider.currentContext$, [provider]);
     const { value: currentContext } = useObservableState(currentContext$, {
         initial: provider.currentContext,
     });
     const setCurrentContext = useCallback((entry) => {
+        // Clear the current context when no entry is provided
         if (!entry) {
             return provider.clearCurrentContext();
         }
@@ -18,12 +23,4 @@ export const useCurrentContext = (provider) => {
     }, [provider]);
     return { currentContext, setCurrentContext };
 };
-/**
- * uses context provider from closes module provider
- */
-export const useModuleCurrentContext = () => {
-    const provider = useModule(contextModuleKey);
-    return useCurrentContext(provider);
-};
-export default useModuleCurrentContext;
 //# sourceMappingURL=useCurrentContext.js.map

package/dist/esm/useCurrentContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"useCurrentContext.js","sourceRoot":"","sources":["../../src/useCurrentContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAyB,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AACnG,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAE7C,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,QAA0B,EAAE,EAAE;IAC9D,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5E,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,kBAAkB,CAAC,eAAe,EAAE;QACpE,OAAO,EAAE,QAAQ,CAAC,cAAc;KACjC,CAAC,CAAC;IACH,MAAM,iBAAiB,GAAG,WAAW,CACnC,CAAC,KAAmC,EAAE,EAAE;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,QAAQ,CAAC,mBAAmB,EAAE,CAAC;QACxC,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,OAAO,QAAQ,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,QAAQ,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IACF,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC;AAC/C,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE;IAC1C,MAAM,QAAQ,GAAG,SAAS,CAAgB,gBAAgB,CAAC,CAAC;IAC5D,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,eAAe,uBAAuB,CAAC"}
+{"version":3,"file":"useCurrentContext.js","sourceRoot":"","sources":["../../src/useCurrentContext.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,QAA0B,EAAE,EAAE;IAC9D,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5E,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,kBAAkB,CAAC,eAAe,EAAE;QACpE,OAAO,EAAE,QAAQ,CAAC,cAAc;KACjC,CAAC,CAAC;IACH,MAAM,iBAAiB,GAAG,WAAW,CACnC,CAAC,KAAmC,EAAE,EAAE;QACtC,sDAAsD;QACtD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,QAAQ,CAAC,mBAAmB,EAAE,CAAC;QACxC,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,OAAO,QAAQ,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,QAAQ,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IACF,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC;AAC/C,CAAC,CAAC"}

package/dist/esm/useModuleCurrentContext.js

@@ -0,0 +1,12 @@
+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(contextModuleKey);
+    return useCurrentContext(provider);
+};
+export default useModuleCurrentContext;
+//# sourceMappingURL=useModuleCurrentContext.js.map

package/dist/esm/useModuleCurrentContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useModuleCurrentContext.js","sourceRoot":"","sources":["../../src/useModuleCurrentContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AAEnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE;IAC1C,MAAM,QAAQ,GAAG,SAAS,CAAgB,gBAAgB,CAAC,CAAC;IAC5D,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,eAAe,uBAAuB,CAAC"}

package/dist/esm/useModuleQueryContext.js

@@ -0,0 +1,15 @@
+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) => {
+    const provider = useModule(contextModuleKey);
+    return useQueryContext(provider, options);
+};
+//# sourceMappingURL=useModuleQueryContext.js.map

package/dist/esm/useModuleQueryContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useModuleQueryContext.js","sourceRoot":"","sources":["../../src/useModuleQueryContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AAEnE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAA+B,EAAE,EAAE;IACvE,MAAM,QAAQ,GAAG,SAAS,CAAgB,gBAAgB,CAAC,CAAC;IAC5D,OAAO,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAC5C,CAAC,CAAC"}

package/dist/esm/useQueryContext.js

@@ -1,16 +1,18 @@
-import { contextModuleKey, } from '@equinor/fusion-framework-module-context';
-import { useModule } from '@equinor/fusion-framework-react-module';
 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, options) => {
+    // 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) => {
-    const provider = useModule(contextModuleKey);
-    return useQueryContext(provider, options);
-};
 //# sourceMappingURL=useQueryContext.js.map

package/dist/esm/useQueryContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"useQueryContext.js","sourceRoot":"","sources":["../../src/useQueryContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,gBAAgB,GAEjB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAA0B,EAAE,OAA+B,EAAE,EAAE;IAC7F,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjF,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC3D,MAAM,EAAE,KAAK,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC7C,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAA+B,EAAE,EAAE;IACvE,MAAM,QAAQ,GAAG,SAAS,CAAgB,gBAAgB,CAAC,CAAC;IAC5D,OAAO,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAC5C,CAAC,CAAC"}
+{"version":3,"file":"useQueryContext.js","sourceRoot":"","sources":["../../src/useQueryContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAA0B,EAAE,OAA+B,EAAE,EAAE;IAC7F,qEAAqE;IACrE,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjF,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC3D,MAAM,EAAE,KAAK,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC7C,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACjD,CAAC,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '7.0.0';
+export const version = '7.0.2';
 //# sourceMappingURL=version.js.map