@equinor/fusion-framework-react-module-signalr 4.0.0-next.0 → 4.0.1

package/CHANGELOG.md

@@ -1,16 +1,37 @@
 # Change Log
 
-## 4.0.0-next.0
+## 4.0.1
+
+### Patch Changes
+
+- @equinor/fusion-framework-module-signalr@12.0.0
+
+## 4.0.0
 
 ### Major Changes
 
-- [#3820](https://github.com/equinor/fusion-framework/pull/3820) [`9f7597e`](https://github.com/equinor/fusion-framework/commit/9f7597ee237ef069dc24cbe39c73b5b26db157dd) Thanks [@odinr](https://github.com/odinr)! - Require React 18+ as peer dependency. React 17 is no longer supported.
+- abffa53: Major version bump for Fusion Framework React 19 release.
+
+  All packages are bumped to the next major version as part of the React 19 upgrade. This release drops support for React versions below 18 and includes breaking changes across the framework.
+
+  **Breaking changes:**
+  - Peer dependencies now require React 18 or 19 (`^18.0.0 || ^19.0.0`)
+  - React Router upgraded from v6 to v7
+  - Navigation module refactored with new history API
+  - `renderComponent` and `renderApp` now use `createRoot` API
+
+  **Migration:**
+  - Update your React version to 18.0.0 or higher before upgrading
+  - Replace `NavigationProvider.createRouter()` with `@equinor/fusion-framework-react-router`
+  - See individual package changelogs for package-specific migration steps
+
+- abffa53: Require React 18+ as peer dependency. React 17 is no longer supported.
 
   **Migration:** Update your application to React 18+ to continue using these packages.
 
   Closes https://github.com/equinor/fusion-framework/issues/3504
 
-- [#3820](https://github.com/equinor/fusion-framework/pull/3820) [`75c068f`](https://github.com/equinor/fusion-framework/commit/75c068fea13c32435ac26bd9043cc156482bfaf1) Thanks [@odinr](https://github.com/odinr)! - Upgrade to React 19 and remove support for React versions lower than 18.
+- abffa53: Upgrade to React 19 and remove support for React versions lower than 18.
 
   **Breaking changes:**
   - Peer dependencies now require React 18 or 19 (`^18.0.0 || ^19.0.0`)
@@ -21,13 +42,33 @@
   - Update your React version to 18.0.0 or higher before upgrading these packages
   - If using React 16 or 17, upgrade to React 18 or 19 first
 
+  Closes https://github.com/equinor/fusion-framework/issues/3504
+
+### Patch Changes
+
+- Updated dependencies [abffa53]
+- Updated dependencies [abffa53]
+- Updated dependencies [abffa53]
+- Updated dependencies [abffa53]
+  - @equinor/fusion-framework-module-signalr@11.0.0
+  - @equinor/fusion-framework-react-module@4.0.0
+
+## 3.0.37
+
 ### Patch Changes
 
-- [#3820](https://github.com/equinor/fusion-framework/pull/3820) [`265bb76`](https://github.com/equinor/fusion-framework/commit/265bb767249989eeb1971e83f3fba94879e0813b) Thanks [@odinr](https://github.com/odinr)! - relase next
+- [#4157](https://github.com/equinor/fusion-framework/pull/4157) [`6aa8e1f`](https://github.com/equinor/fusion-framework/commit/6aa8e1f5c9d852b25e97aa7d98a63008c64d4581) Thanks [@Noggling](https://github.com/Noggling)! - Internal: patch release to align TypeScript types across packages for consistent type compatibility.
 
-- Updated dependencies [[`265bb76`](https://github.com/equinor/fusion-framework/commit/265bb767249989eeb1971e83f3fba94879e0813b), [`d252b0d`](https://github.com/equinor/fusion-framework/commit/d252b0d442b7c8c1b50bf2768cf9ecbbb55a76f8), [`9f7597e`](https://github.com/equinor/fusion-framework/commit/9f7597ee237ef069dc24cbe39c73b5b26db157dd), [`75c068f`](https://github.com/equinor/fusion-framework/commit/75c068fea13c32435ac26bd9043cc156482bfaf1)]:
-  - @equinor/fusion-framework-react-module@4.0.0-next.0
-  - @equinor/fusion-framework-module-signalr@10.0.0-next.0
+- Updated dependencies [[`6aa8e1f`](https://github.com/equinor/fusion-framework/commit/6aa8e1f5c9d852b25e97aa7d98a63008c64d4581)]:
+  - @equinor/fusion-framework-module-signalr@10.0.1
+  - @equinor/fusion-framework-react-module@3.1.14
+
+## 3.0.36
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @equinor/fusion-framework-module-signalr@10.0.0
 
 ## 3.0.35
 

package/README.md

@@ -0,0 +1,57 @@
+# @equinor/fusion-framework-react-module-signalr
+
+React hooks for the Fusion SignalR module. Subscribe to real-time SignalR hub topics from React components with automatic connection management.
+
+**Import:**
+
+```ts
+import { useTopic, enableSignalR } from '@equinor/fusion-framework-react-module-signalr';
+```
+
+## Exports
+
+| Export                | Type     | Description                                               |
+| --------------------- | -------- | --------------------------------------------------------- |
+| `useTopic`            | Hook     | Subscribe to a SignalR topic using the closest module scope |
+| `useProviderTopic`    | Hook     | Subscribe to a SignalR topic with an explicit provider      |
+| `enableSignalR`       | Function | Enable the SignalR module in a configurator                |
+| `Topic`               | Class    | A SignalR topic instance for pub/sub messaging             |
+| `ISignalRConfigurator`| Type     | Configurator interface                                    |
+| `SignalRHubConfig`    | Type     | Hub connection configuration                              |
+| `SignalRModule`       | Type     | Module type definition                                    |
+
+## useTopic
+
+Subscribe to a SignalR hub topic. Returns a `Topic<T>` instance that exposes an observable message stream.
+
+```tsx
+import { useTopic } from '@equinor/fusion-framework-react-module-signalr';
+
+type NotificationPayload = { message: string; severity: 'info' | 'warning' };
+
+const Notifications = () => {
+  const topic = useTopic<NotificationPayload>('notifications-hub', 'alerts');
+
+  // topic.message$ is an Observable<NotificationPayload>
+  // topic.send(payload) publishes to the hub
+
+  return <div>Listening for alerts…</div>;
+};
+```
+
+## useProviderTopic
+
+Same as `useTopic`, but accepts an explicit `ISignalRProvider` instead of resolving from the module scope. Use this in libraries or when multiple providers are available.
+
+```ts
+import { useProviderTopic } from '@equinor/fusion-framework-react-module-signalr';
+import type { ISignalRProvider } from '@equinor/fusion-framework-module-signalr';
+
+declare const provider: ISignalRProvider;
+
+const topic = useProviderTopic<MyPayload>(provider, 'hub-id', 'topic-id');
+```
+
+## Related
+
+- [`@equinor/fusion-framework-module-signalr`](../../../modules/signalr/README.md) — the underlying SignalR module

package/dist/esm/index.js

@@ -1,3 +1,14 @@
+/**
+ * React integration for the Fusion SignalR module.
+ *
+ * Provides hooks for subscribing to SignalR hub topics from React components.
+ * Use {@link useTopic} for module-scoped access or {@link useProviderTopic}
+ * when injecting a provider explicitly.
+ *
+ * @see {@link enableSignalR} to enable the module in a configurator.
+ *
+ * @packageDocumentation
+ */
 export { useSignalRProvider as useProviderTopic } from './use-signalr-provider';
 export { useTopic } from './use-signalr';
 export { Topic, enableSignalR } from '@equinor/fusion-framework-module-signalr';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,kBAAkB,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '4.0.0-next.0';
+export const version = '4.0.1';
 //# sourceMappingURL=version.js.map

package/dist/esm/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,cAAc,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}