@equinor/fusion-framework-module-signalr 13.0.0 → 13.0.1

package/dist/types/SignalRConfigurator.d.ts

@@ -0,0 +1,37 @@
+import type { ModuleInitializerArgs } from '@equinor/fusion-framework-module';
+import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
+import { type ISignalRConfigurator, type SignalRConfig, type SignalRHubConfig, type SignalRModuleConfigBuilderCallback } from './SignalRModuleConfigBuilder';
+/**
+ * Default {@link ISignalRConfigurator} implementation.
+ *
+ * Collects hub registrations and builder callbacks, then produces a
+ * {@link SignalRConfig} during the module initialization phase.
+ */
+export declare class SignalRConfigurator implements ISignalRConfigurator {
+    #private;
+    /**
+     * Register a named SignalR hub connection.
+     *
+     * @param name - Unique identifier for the hub
+     * @param config - Hub connection configuration
+     */
+    addHub(name: string, config: SignalRHubConfig): void;
+    /**
+     * Register a configuration builder callback that will run during
+     * {@link SignalRConfigurator.createConfig}.
+     *
+     * @param cb - Callback receiving a {@link SignalRModuleConfigBuilder}
+     * @template T - Type of module dependencies made available to the builder callback
+     */
+    onCreateConfig<T>(cb: SignalRModuleConfigBuilderCallback<T>): void;
+    /**
+     * Build the final {@link SignalRConfig} by executing all registered
+     * builder callbacks and collecting hub configurations.
+     *
+     * Normally called during the module `initialize` phase.
+     *
+     * @param init - Module initializer arguments providing access to resolved dependencies
+     * @returns Resolved configuration containing all registered hubs
+     */
+    createConfig(init: ModuleInitializerArgs<ISignalRConfigurator, [ServiceDiscoveryModule]>): Promise<SignalRConfig>;
+}

package/dist/types/SignalRModule.d.ts

@@ -1,5 +1,5 @@
 import type { Module } from '@equinor/fusion-framework-module';
-import { type ISignalRConfigurator } from './SignalRModuleConfigurator';
+import type { ISignalRConfigurator } from './SignalRModuleConfigBuilder';
 import { type ISignalRProvider } from './SignalRModuleProvider';
 /** String literal key used to register the SignalR module in the Fusion Framework module system. */
 export type SignalRModuleKey = 'signalR';

package/dist/types/{SignalRModuleConfigurator.d.ts → SignalRModuleConfigBuilder.d.ts}

@@ -1,5 +1,4 @@
-import { type AnyModule, ModuleConfigBuilder, type ModuleInitializerArgs } from '@equinor/fusion-framework-module';
-import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
+import { type AnyModule, ModuleConfigBuilder } from '@equinor/fusion-framework-module';
 import type { IHttpConnectionOptions, LogLevel } from '@microsoft/signalr';
 /**
  * Public configuration interface for the SignalR module.
@@ -94,36 +93,3 @@ export declare class SignalRModuleConfigBuilder<TDeps extends AnyModule[] | unkn
      */
     addHub(name: string, config: SignalRHubConfig): Promise<void>;
 }
-/**
- * Default {@link ISignalRConfigurator} implementation.
- *
- * Collects hub registrations and builder callbacks, then produces a
- * {@link SignalRConfig} during the module initialization phase.
- */
-export declare class SignalRConfigurator implements ISignalRConfigurator {
-    #private;
-    /**
-     * Register a named SignalR hub connection.
-     *
-     * @param name - Unique identifier for the hub
-     * @param config - Hub connection configuration
-     */
-    addHub(name: string, config: SignalRHubConfig): void;
-    /**
-     * Register a configuration builder callback that will run during
-     * {@link SignalRConfigurator.createConfig}.
-     *
-     * @param cb - Callback receiving a {@link SignalRModuleConfigBuilder}
-     */
-    onCreateConfig<T>(cb: SignalRModuleConfigBuilderCallback<T>): void;
-    /**
-     * Build the final {@link SignalRConfig} by executing all registered
-     * builder callbacks and collecting hub configurations.
-     *
-     * Normally called during the module `initialize` phase.
-     *
-     * @param init - Module initializer arguments providing access to resolved dependencies
-     * @returns Resolved configuration containing all registered hubs
-     */
-    createConfig(init: ModuleInitializerArgs<ISignalRConfigurator, [ServiceDiscoveryModule]>): Promise<SignalRConfig>;
-}

package/dist/types/SignalRModuleProvider.d.ts

@@ -1,6 +1,6 @@
 import { type HubConnection } from '@microsoft/signalr';
 import { Observable } from 'rxjs';
-import type { SignalRConfig } from './SignalRModuleConfigurator';
+import type { SignalRConfig } from './SignalRModuleConfigBuilder';
 import { Topic } from './lib/Topic';
 /**
  * Public interface for the SignalR module provider.

package/dist/types/index.d.ts

@@ -11,7 +11,8 @@
  * @see {@link enableSignalR} for the quickest way to register the module.
  * @see {@link ISignalRProvider.connect} for subscribing to hub methods at runtime.
  */
-export { ISignalRConfigurator, SignalRConfigurator, SignalRConfig, SignalRHubConfig, SignalRModuleConfigBuilder, SignalRModuleConfigBuilderCallback, } from './SignalRModuleConfigurator';
+export { ISignalRConfigurator, SignalRConfig, SignalRHubConfig, SignalRModuleConfigBuilder, SignalRModuleConfigBuilderCallback, } from './SignalRModuleConfigBuilder';
+export { SignalRConfigurator } from './SignalRConfigurator';
 export { ISignalRProvider, SignalRModuleProvider } from './SignalRModuleProvider';
 export { Topic } from './lib/Topic';
 export { enableSignalR } from './lib/utils/enable-signalr';

package/dist/types/lib/Topic.d.ts

@@ -37,7 +37,7 @@ export declare class Topic<T> extends Observable<T> {
      * @param args - Arguments forwarded to `HubConnection.send()`
      * @throws {Error} When the hub connection has not been established yet
      */
-    send(...args: any[]): void;
+    send(...args: unknown[]): void;
     /**
      * Invoke a server method on this topic and wait for a response.
      *
@@ -46,5 +46,5 @@ export declare class Topic<T> extends Observable<T> {
      * @returns Promise resolving with the server's response
      * @throws {Error} When the hub connection has not been established yet
      */
-    invoke<T>(...args: any[]): Promise<T>;
+    invoke<T>(...args: unknown[]): Promise<T>;
 }

package/dist/types/lib/utils/enable-signalr.d.ts

@@ -1,5 +1,5 @@
 import type { IModulesConfigurator } from '@equinor/fusion-framework-module';
-import type { SignalRModuleConfigBuilderCallback } from '../../SignalRModuleConfigurator';
+import type { SignalRModuleConfigBuilderCallback } from '../../SignalRModuleConfigBuilder';
 /**
  * Call-signature overloads for {@link enableSignalR}.
  */

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "13.0.0";
+export declare const version = "13.0.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-signalr",
-  "version": "13.0.0",
+  "version": "13.0.1",
   "description": "",
   "sideEffects": false,
   "main": "dist/esm/index.js",
@@ -27,15 +27,15 @@
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
-    "typescript": "^6.0.3",
-    "@equinor/fusion-framework-module": "^6.1.0",
-    "@equinor/fusion-framework-module-service-discovery": "^10.0.1",
-    "@equinor/fusion-framework-module-msal": "^10.0.0"
+    "typescript": "^7.0.2",
+    "@equinor/fusion-framework-module": "^6.1.1",
+    "@equinor/fusion-framework-module-msal": "^10.0.2",
+    "@equinor/fusion-framework-module-service-discovery": "^10.0.2"
   },
   "peerDependencies": {
-    "@equinor/fusion-framework-module-service-discovery": "^10.0.1",
-    "@equinor/fusion-framework-module": "^6.1.0",
-    "@equinor/fusion-framework-module-msal": "^10.0.0"
+    "@equinor/fusion-framework-module-msal": "^10.0.2",
+    "@equinor/fusion-framework-module-service-discovery": "^10.0.2",
+    "@equinor/fusion-framework-module": "^6.1.1"
   },
   "peerDependenciesMeta": {
     "@equinor/fusion-framework-module-service-discovery": {

package/src/SignalRConfigurator.ts

@@ -0,0 +1,66 @@
+import type { ModuleInitializerArgs } from '@equinor/fusion-framework-module';
+
+import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
+
+import {
+  type ISignalRConfigurator,
+  SignalRModuleConfigBuilder,
+  type SignalRConfig,
+  type SignalRHubConfig,
+  type SignalRModuleConfigBuilderCallback,
+} from './SignalRModuleConfigBuilder';
+
+/**
+ * Default {@link ISignalRConfigurator} implementation.
+ *
+ * Collects hub registrations and builder callbacks, then produces a
+ * {@link SignalRConfig} during the module initialization phase.
+ */
+export class SignalRConfigurator implements ISignalRConfigurator {
+  #builderCallbacks: Array<SignalRModuleConfigBuilderCallback> = [];
+
+  #hubs: Record<string, SignalRHubConfig> = {};
+
+  /**
+   * Register a named SignalR hub connection.
+   *
+   * @param name - Unique identifier for the hub
+   * @param config - Hub connection configuration
+   */
+  public addHub(name: string, config: SignalRHubConfig) {
+    this.#hubs[name] = config;
+  }
+
+  /**
+   * Register a configuration builder callback that will run during
+   * {@link SignalRConfigurator.createConfig}.
+   *
+   * @param cb - Callback receiving a {@link SignalRModuleConfigBuilder}
+   * @template T - Type of module dependencies made available to the builder callback
+   */
+  public onCreateConfig<T>(cb: SignalRModuleConfigBuilderCallback<T>): void {
+    this.#builderCallbacks.push(cb);
+  }
+
+  /**
+   * Build the final {@link SignalRConfig} by executing all registered
+   * builder callbacks and collecting hub configurations.
+   *
+   * Normally called during the module `initialize` phase.
+   *
+   * @param init - Module initializer arguments providing access to resolved dependencies
+   * @returns Resolved configuration containing all registered hubs
+   */
+  public async createConfig(
+    init: ModuleInitializerArgs<ISignalRConfigurator, [ServiceDiscoveryModule]>,
+  ): Promise<SignalRConfig> {
+    /** trigger all builder callbacks */
+    for (const cb of this.#builderCallbacks) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const builder = new SignalRModuleConfigBuilder<[ServiceDiscoveryModule]>(init, this);
+      await Promise.resolve(cb(builder));
+    }
+
+    return { hubs: this.#hubs };
+  }
+}

package/src/SignalRModule.ts

@@ -1,5 +1,6 @@
 import type { Module } from '@equinor/fusion-framework-module';
-import { type ISignalRConfigurator, SignalRConfigurator } from './SignalRModuleConfigurator';
+import type { ISignalRConfigurator } from './SignalRModuleConfigBuilder';
+import { SignalRConfigurator } from './SignalRConfigurator';
 
 import { type ISignalRProvider, SignalRModuleProvider } from './SignalRModuleProvider';
 
@@ -33,6 +34,8 @@ export type SignalRModule = Module<SignalRModuleKey, ISignalRProvider, ISignalRC
  * configurator.addConfig({ module: signalR });
  * ```
  */
+// Deliberately co-located with the `moduleKey` constant it references
+// fusion-lint-disable-next-line single-export-per-file
 export const module: SignalRModule = {
   name: moduleKey,
   configure: () => new SignalRConfigurator(),

package/src/{SignalRModuleConfigurator.ts → SignalRModuleConfigBuilder.ts}

@@ -1,10 +1,5 @@
-import {
-  type AnyModule,
-  ModuleConfigBuilder,
-  type ModuleInitializerArgs,
-} from '@equinor/fusion-framework-module';
+import { type AnyModule, ModuleConfigBuilder } from '@equinor/fusion-framework-module';
 
-import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
 import type { IHttpConnectionOptions, LogLevel } from '@microsoft/signalr';
 
 /**
@@ -103,7 +98,7 @@ export type SignalRConfig = {
  */
 export class SignalRModuleConfigBuilder<
   TDeps extends AnyModule[] | unknown = unknown,
-  // TODO - use BaseConfigBuilder
+  // TODO(#5096): use BaseConfigBuilder
 > extends ModuleConfigBuilder<TDeps, ISignalRConfigurator> {
   /**
    * Register a named hub connection through the underlying configurator.
@@ -115,57 +110,3 @@ export class SignalRModuleConfigBuilder<
     this._config.addHub(name, config);
   }
 }
-
-/**
- * Default {@link ISignalRConfigurator} implementation.
- *
- * Collects hub registrations and builder callbacks, then produces a
- * {@link SignalRConfig} during the module initialization phase.
- */
-export class SignalRConfigurator implements ISignalRConfigurator {
-  #builderCallbacks: Array<SignalRModuleConfigBuilderCallback> = [];
-
-  #hubs: Record<string, SignalRHubConfig> = {};
-
-  /**
-   * Register a named SignalR hub connection.
-   *
-   * @param name - Unique identifier for the hub
-   * @param config - Hub connection configuration
-   */
-  public addHub(name: string, config: SignalRHubConfig) {
-    this.#hubs[name] = config;
-  }
-
-  /**
-   * Register a configuration builder callback that will run during
-   * {@link SignalRConfigurator.createConfig}.
-   *
-   * @param cb - Callback receiving a {@link SignalRModuleConfigBuilder}
-   */
-  public onCreateConfig<T>(cb: SignalRModuleConfigBuilderCallback<T>): void {
-    this.#builderCallbacks.push(cb);
-  }
-
-  /**
-   * Build the final {@link SignalRConfig} by executing all registered
-   * builder callbacks and collecting hub configurations.
-   *
-   * Normally called during the module `initialize` phase.
-   *
-   * @param init - Module initializer arguments providing access to resolved dependencies
-   * @returns Resolved configuration containing all registered hubs
-   */
-  public async createConfig(
-    init: ModuleInitializerArgs<ISignalRConfigurator, [ServiceDiscoveryModule]>,
-  ): Promise<SignalRConfig> {
-    /** trigger all builder callbacks */
-    for (const cb of this.#builderCallbacks) {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const builder = new SignalRModuleConfigBuilder<[ServiceDiscoveryModule]>(init, this);
-      await Promise.resolve(cb(builder));
-    }
-
-    return { hubs: this.#hubs };
-  }
-}

package/src/SignalRModuleProvider.ts

@@ -1,7 +1,7 @@
 import { HubConnectionBuilder, type HubConnection, AbortError } from '@microsoft/signalr';
 import { Observable, shareReplay } from 'rxjs';
 
-import type { SignalRConfig } from './SignalRModuleConfigurator';
+import type { SignalRConfig } from './SignalRModuleConfigBuilder';
 
 import { Topic } from './lib/Topic';
 
@@ -81,10 +81,12 @@ export class SignalRModuleProvider implements ISignalRProvider {
   protected _createHubConnection(hubId: string): Observable<HubConnection> {
     const LOG_LEVEL_CRITICAL = 5;
 
+    // Reuse an already-established connection observable for this hub
     if (hubId in this.#hubConnections) {
       return this.#hubConnections[hubId];
     }
     const config = this.#config.hubs[hubId];
+    // Fail loudly when the hub was never registered with the configurator
     if (!config) {
       throw Error(`could not find any configuration for hub [${hubId}]`);
     }
@@ -106,6 +108,7 @@ export class SignalRModuleProvider implements ISignalRProvider {
           observer.next(connection);
         })
         .catch((error: unknown) => {
+          // Swallow expected teardown aborts; re-throw anything else
           if (error instanceof AbortError) {
             // AbortError is expected during teardown — safe to ignore
           } else {
@@ -121,14 +124,16 @@ export class SignalRModuleProvider implements ISignalRProvider {
       };
 
       return teardown;
-    }).pipe(
-      shareReplay({
-        /** only emit last connection when new subscriber connects */
-        bufferSize: 1,
-        /** when no subscribers, teardown observable */
-        refCount: true,
-      }),
-    );
+    })
+      // Share a single connection across subscribers and tear it down when unused
+      .pipe(
+        shareReplay({
+          /** only emit last connection when new subscriber connects */
+          bufferSize: 1,
+          /** when no subscribers, teardown observable */
+          refCount: true,
+        }),
+      );
 
     return this.#hubConnections[hubId];
   }

package/src/index.ts

@@ -14,12 +14,13 @@
 
 export {
   ISignalRConfigurator,
-  SignalRConfigurator,
   SignalRConfig,
   SignalRHubConfig,
   SignalRModuleConfigBuilder,
   SignalRModuleConfigBuilderCallback,
-} from './SignalRModuleConfigurator';
+} from './SignalRModuleConfigBuilder';
+
+export { SignalRConfigurator } from './SignalRConfigurator';
 
 export { ISignalRProvider, SignalRModuleProvider } from './SignalRModuleProvider';
 

package/src/lib/Topic.ts

@@ -53,8 +53,8 @@ export class Topic<T> extends Observable<T> {
    * @param args - Arguments forwarded to `HubConnection.send()`
    * @throws {Error} When the hub connection has not been established yet
    */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  public send(...args: any[]): void {
+  public send(...args: unknown[]): void {
+    // A connection must have been established before sending is possible
     if (!this.connection) {
       throw new Error('No hub connection awaitable');
     }
@@ -69,8 +69,8 @@ export class Topic<T> extends Observable<T> {
    * @returns Promise resolving with the server's response
    * @throws {Error} When the hub connection has not been established yet
    */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  public invoke<T>(...args: any[]): Promise<T> {
+  public invoke<T>(...args: unknown[]): Promise<T> {
+    // A connection must have been established before invoking is possible
     if (!this.connection) {
       throw new Error('No hub connection awaitable');
     }

package/src/lib/utils/configure-from-framework.ts

@@ -1,7 +1,7 @@
 import type { MsalModule } from '@equinor/fusion-framework-module-msal';
 import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
 
-import type { SignalRModuleConfigBuilder } from '../../SignalRModuleConfigurator';
+import type { SignalRModuleConfigBuilder } from '../../SignalRModuleConfigBuilder';
 
 /**
  * Configure a SignalR hub connection using Fusion Framework service-discovery
@@ -26,6 +26,7 @@ export const configureFromFramework = async (
     url: new URL(args.path, service.uri).toString(),
     options: {
       accessTokenFactory: async () => {
+        // Scopes are required to acquire a token for this service
         if (!service.scopes) {
           throw Error(
             `service [${service.name}] does not have authentication scopes, please configure an endpoint with scopes`,
@@ -34,6 +35,7 @@ export const configureFromFramework = async (
         const token = await authProvider.acquireAccessToken({
           request: { scopes: service.scopes ?? service.defaultScopes },
         });
+        // Fail loudly rather than connecting the hub without a valid token
         if (!token) {
           throw Error('failed to acquire access token');
         }

package/src/lib/utils/enable-signalr.ts

@@ -1,5 +1,5 @@
 import type { IModulesConfigurator } from '@equinor/fusion-framework-module';
-import type { SignalRModuleConfigBuilderCallback } from '../../SignalRModuleConfigurator';
+import type { SignalRModuleConfigBuilderCallback } from '../../SignalRModuleConfigBuilder';
 import { module } from '../../SignalRModule';
 import { configureFromFramework } from './configure-from-framework';
 
@@ -15,7 +15,7 @@ export interface enableSignalR {
    * @param cb - Builder callback for manual hub configuration
    */
   (
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    // biome-ignore lint/suspicious/noExplicitAny: IModulesConfigurator<any, any> widens to accept a configurator for any concrete module set
     configurator: IModulesConfigurator<any, any>,
     name: string,
     cb: SignalRModuleConfigBuilderCallback,
@@ -29,7 +29,7 @@ export interface enableSignalR {
    * @param options - Service name and path used to resolve the hub endpoint
    */
   (
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    // biome-ignore lint/suspicious/noExplicitAny: IModulesConfigurator<any, any> widens to accept a configurator for any concrete module set
     configurator: IModulesConfigurator<any, any>,
     name: string,
     options: { service: string; path: string },
@@ -69,11 +69,12 @@ export interface enableSignalR {
  * ```
  */
 export function enableSignalR(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  // biome-ignore lint/suspicious/noExplicitAny: IModulesConfigurator<any, any> widens to accept a configurator for any concrete module set
   configurator: IModulesConfigurator<any, any>,
   name: string,
   optionsOrCallback: SignalRModuleConfigBuilderCallback | { service: string; path: string },
 ) {
+  // Callback form configures the hub directly against the resolved builder
   if (typeof optionsOrCallback === 'function') {
     configurator.addConfig({
       module,

package/src/version.ts

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

package/dist/esm/SignalRModuleConfigurator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SignalRModuleConfigurator.js","sourceRoot":"","sources":["../../src/SignalRModuleConfigurator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,mBAAmB,GAEpB,MAAM,kCAAkC,CAAC;AAyF1C;;;;;;;;;GASG;AACH,MAAM,OAAO,0BAGX,SAAQ,mBAAgD;IACxD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,MAAwB;QACjD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,mBAAmB;IAC9B,iBAAiB,GAA8C,EAAE,CAAC;IAElE,KAAK,GAAqC,EAAE,CAAC;IAE7C;;;;;OAKG;IACI,MAAM,CAAC,IAAY,EAAE,MAAwB;QAClD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAI,EAAyC;QAChE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CACvB,IAA2E;QAE3E,oCAAoC;QACpC,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACxC,8DAA8D;YAC9D,MAAM,OAAO,GAAG,IAAI,0BAA0B,CAA2B,IAAI,EAAE,IAAI,CAAC,CAAC;YACrF,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;CACF"}