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

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 4.0.1
+
+### Patch Changes
+
+- @equinor/fusion-framework-module-signalr@12.0.0
+
 ## 4.0.0
 
 ### Major Changes

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';
+export const version = '4.0.1';
 //# sourceMappingURL=version.js.map