@equinor/fusion-framework-react-module-signalr 4.0.2 → 4.0.3

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 4.0.3
+
+### Patch Changes
+
+- 80c3e4a: Internal: align source filenames with their exports (`use-signalr-provider.ts` → `useSignalRProvider.ts`, `use-signalr.ts` → `useTopic.ts`) while preserving existing public entrypoints; no public API changes.
+- 80c3e4a: Internal: add missing TSDoc comments to `useSignalRProvider` and `useTopic` to satisfy the `require-hook-tsdoc` lint rule. No functional change.
+
 ## 4.0.2
 
 ### Patch Changes

package/dist/esm/index.js

@@ -9,7 +9,7 @@
  *
  * @packageDocumentation
  */
-export { useSignalRProvider as useProviderTopic } from './use-signalr-provider';
-export { useTopic } from './use-signalr';
+export { useSignalRProvider as useProviderTopic } from './useSignalRProvider';
+export { useTopic } from './useTopic';
 export { Topic, enableSignalR } from '@equinor/fusion-framework-module-signalr';
 //# 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;;;;;;;;;;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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,kBAAkB,IAAI,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC"}

package/dist/esm/useSignalRProvider.js

@@ -0,0 +1,15 @@
+import { useMemo } from 'react';
+/**
+ * Hook for connecting to a SignalR hub topic via the given provider.
+ *
+ * @template T - The type of data emitted by the topic
+ * @param provider - The SignalR provider used to establish the connection
+ * @param hubId - The id of the hub to connect to
+ * @param topicId - The id of the topic within the hub to subscribe to
+ * @returns The connected topic
+ */
+export const useSignalRProvider = (provider, hubId, topicId) => {
+    const topic = useMemo(() => provider.connect(hubId, topicId), [provider, hubId, topicId]);
+    return topic;
+};
+//# sourceMappingURL=useSignalRProvider.js.map

package/dist/esm/useSignalRProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSignalRProvider.js","sourceRoot":"","sources":["../../src/useSignalRProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAGhC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,QAA0B,EAC1B,KAAa,EACb,OAAe,EACL,EAAE;IACZ,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAI,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7F,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}

package/dist/esm/useTopic.js

@@ -0,0 +1,14 @@
+import { useModule } from '@equinor/fusion-framework-react-module';
+import { moduleKey } from '@equinor/fusion-framework-module-signalr';
+import { useSignalRProvider } from './useSignalRProvider';
+/**
+ * Hook for connecting to a SignalR hub topic, resolving the provider from the framework automatically.
+ *
+ * @template T - The type of data emitted by the topic
+ * @param hubId - The id of the hub to connect to
+ * @param topicId - The id of the topic within the hub to subscribe to
+ * @returns The connected topic
+ */
+export const useTopic = (hubId, topicId) => useSignalRProvider(useModule(moduleKey), hubId, topicId);
+export default useTopic;
+//# sourceMappingURL=useTopic.js.map

package/dist/esm/useTopic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTopic.js","sourceRoot":"","sources":["../../src/useTopic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,KAAa,EACb,OAAe,EAC2B,EAAE,CAC5C,kBAAkB,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AAE3D,eAAe,QAAQ,CAAC"}

package/dist/esm/version.js

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