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

package/dist/types/index.d.ts

@@ -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';
 export type { ISignalRConfigurator, SignalRHubConfig, SignalRModule, } from '@equinor/fusion-framework-module-signalr';

package/dist/types/useSignalRProvider.d.ts

@@ -0,0 +1,11 @@
+import type { ISignalRProvider, Topic } from '@equinor/fusion-framework-module-signalr';
+/**
+ * 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 declare const useSignalRProvider: <T>(provider: ISignalRProvider, hubId: string, topicId: string) => Topic<T>;

package/dist/types/useTopic.d.ts

@@ -0,0 +1,11 @@
+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 declare const useTopic: <T>(hubId: string, topicId: string) => ReturnType<typeof useSignalRProvider<T>>;
+export default useTopic;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "4.0.2";
+export declare const version = "4.0.3";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-react-module-signalr",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "",
   "sideEffects": false,
   "main": "dist/esm/index.js",
@@ -23,18 +23,18 @@
     "directory": "packages/react/modules/signalr"
   },
   "dependencies": {
-    "@equinor/fusion-framework-module-signalr": "^13.0.0"
+    "@equinor/fusion-framework-module-signalr": "^13.0.1"
   },
   "devDependencies": {
     "@types/react": "^19.2.7",
     "react": "^19.2.1",
-    "typescript": "^6.0.3",
-    "@equinor/fusion-framework-react-module": "^4.0.1"
+    "typescript": "^7.0.2",
+    "@equinor/fusion-framework-react-module": "^4.0.2"
   },
   "peerDependencies": {
     "@types/react": "^18.0.0 || ^19.0.0",
     "react": "^18.0.0 || ^19.0.0",
-    "@equinor/fusion-framework-react-module": "^4.0.1"
+    "@equinor/fusion-framework-react-module": "^4.0.2"
   },
   "peerDependenciesMeta": {
     "@types/react": {

package/src/index.ts

@@ -9,8 +9,8 @@
  *
  * @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';
 

package/src/useSignalRProvider.ts

@@ -0,0 +1,20 @@
+import { useMemo } from 'react';
+import type { ISignalRProvider, Topic } from '@equinor/fusion-framework-module-signalr';
+
+/**
+ * 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 = <T>(
+  provider: ISignalRProvider,
+  hubId: string,
+  topicId: string,
+): Topic<T> => {
+  const topic = useMemo(() => provider.connect<T>(hubId, topicId), [provider, hubId, topicId]);
+  return topic;
+};

package/src/useTopic.ts

@@ -0,0 +1,20 @@
+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 = <T>(
+  hubId: string,
+  topicId: string,
+): ReturnType<typeof useSignalRProvider<T>> =>
+  useSignalRProvider(useModule(moduleKey), hubId, topicId);
+
+export default useTopic;

package/src/version.ts

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

package/dist/esm/use-signalr-provider.js

@@ -1,6 +0,0 @@
-import { useMemo } from 'react';
-export const useSignalRProvider = (provider, hubId, topicId) => {
-    const topic = useMemo(() => provider.connect(hubId, topicId), [provider, hubId, topicId]);
-    return topic;
-};
-//# sourceMappingURL=use-signalr-provider.js.map

package/dist/esm/use-signalr-provider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-signalr-provider.js","sourceRoot":"","sources":["../../src/use-signalr-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAGhC,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/use-signalr.js

@@ -1,6 +0,0 @@
-import { useModule } from '@equinor/fusion-framework-react-module';
-import { moduleKey } from '@equinor/fusion-framework-module-signalr';
-import { useSignalRProvider } from './use-signalr-provider';
-export const useTopic = (hubId, topicId) => useSignalRProvider(useModule(moduleKey), hubId, topicId);
-export default useTopic;
-//# sourceMappingURL=use-signalr.js.map

package/dist/esm/use-signalr.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-signalr.js","sourceRoot":"","sources":["../../src/use-signalr.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,wBAAwB,CAAC;AAE5D,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/types/use-signalr-provider.d.ts

@@ -1,2 +0,0 @@
-import type { ISignalRProvider, Topic } from '@equinor/fusion-framework-module-signalr';
-export declare const useSignalRProvider: <T>(provider: ISignalRProvider, hubId: string, topicId: string) => Topic<T>;

package/dist/types/use-signalr.d.ts

@@ -1,3 +0,0 @@
-import { useSignalRProvider } from './use-signalr-provider';
-export declare const useTopic: <T>(hubId: string, topicId: string) => ReturnType<typeof useSignalRProvider<T>>;
-export default useTopic;

package/src/use-signalr-provider.ts

@@ -1,11 +0,0 @@
-import { useMemo } from 'react';
-import type { ISignalRProvider, Topic } from '@equinor/fusion-framework-module-signalr';
-
-export const useSignalRProvider = <T>(
-  provider: ISignalRProvider,
-  hubId: string,
-  topicId: string,
-): Topic<T> => {
-  const topic = useMemo(() => provider.connect<T>(hubId, topicId), [provider, hubId, topicId]);
-  return topic;
-};

package/src/use-signalr.ts

@@ -1,12 +0,0 @@
-import { useModule } from '@equinor/fusion-framework-react-module';
-import { moduleKey } from '@equinor/fusion-framework-module-signalr';
-
-import { useSignalRProvider } from './use-signalr-provider';
-
-export const useTopic = <T>(
-  hubId: string,
-  topicId: string,
-): ReturnType<typeof useSignalRProvider<T>> =>
-  useSignalRProvider(useModule(moduleKey), hubId, topicId);
-
-export default useTopic;