@equinor/fusion-framework-module-signalr 5.0.0 → 5.0.2

package/dist/types/SignalRModule.d.ts

@@ -1,6 +1,6 @@
-import { Module } from '@equinor/fusion-framework-module';
-import { ISignalRConfigurator } from './SignalRModuleConfigurator';
-import { ISignalRProvider } from './SignalRModuleProvider';
+import type { Module } from '@equinor/fusion-framework-module';
+import { type ISignalRConfigurator } from './SignalRModuleConfigurator';
+import { type ISignalRProvider } from './SignalRModuleProvider';
 export type SignalRModuleKey = 'signalR';
 export declare const moduleKey: SignalRModuleKey;
 export type SignalRModule = Module<SignalRModuleKey, ISignalRProvider, ISignalRConfigurator>;

package/dist/types/SignalRModuleConfigurator.d.ts

@@ -1,6 +1,6 @@
-import { AnyModule, ModuleConfigBuilder, ModuleInitializerArgs } from '@equinor/fusion-framework-module';
-import { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
-import { IHttpConnectionOptions, LogLevel } from '@microsoft/signalr';
+import { type AnyModule, ModuleConfigBuilder, type ModuleInitializerArgs } from '@equinor/fusion-framework-module';
+import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
+import type { IHttpConnectionOptions, LogLevel } from '@microsoft/signalr';
 export interface ISignalRConfigurator {
     /** add configuration for hub connection */
     addHub(name: string, config: SignalRHubConfig | Promise<SignalRHubConfig>): void;

package/dist/types/SignalRModuleProvider.d.ts

@@ -1,6 +1,6 @@
-import { HubConnection } from '@microsoft/signalr';
+import { type HubConnection } from '@microsoft/signalr';
 import { Observable } from 'rxjs';
-import { SignalRConfig } from './SignalRModuleConfigurator';
+import type { SignalRConfig } from './SignalRModuleConfigurator';
 import { Topic } from './lib/Topic';
 export interface ISignalRProvider {
     /**

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

@@ -1,4 +1,4 @@
-import { HubConnection } from '@microsoft/signalr';
+import type { HubConnection } from '@microsoft/signalr';
 import { Observable } from 'rxjs';
 export declare class Topic<T> extends Observable<T> {
     topic: string;

package/dist/types/lib/utils/configure-from-framework.d.ts

@@ -1,6 +1,6 @@
-import { MsalModule } from '@equinor/fusion-framework-module-msal';
-import { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
-import { SignalRModuleConfigBuilder } from '../../SignalRModuleConfigurator';
+import type { MsalModule } from '@equinor/fusion-framework-module-msal';
+import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
+import type { SignalRModuleConfigBuilder } from '../../SignalRModuleConfigurator';
 export declare const configureFromFramework: (args: {
     name: string;
     service: string;

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

@@ -1,5 +1,5 @@
 import type { IModulesConfigurator } from '@equinor/fusion-framework-module';
-import { SignalRModuleConfigBuilderCallback } from '../../SignalRModuleConfigurator';
+import type { SignalRModuleConfigBuilderCallback } from '../../SignalRModuleConfigurator';
 export interface enableSignalR {
     (configurator: IModulesConfigurator<any, any>, name: string, cb: SignalRModuleConfigBuilderCallback): void;
     (configurator: IModulesConfigurator<any, any>, name: string, options: {

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.0.0";
+export declare const version = "5.0.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-signalr",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "description": "",
   "sideEffects": false,
   "main": "dist/esm/index.js",
@@ -35,14 +35,14 @@
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
-    "typescript": "^5.5.4",
-    "@equinor/fusion-framework-module": "^4.3.5",
-    "@equinor/fusion-framework-module-msal": "^4.0.0"
+    "typescript": "^5.8.2",
+    "@equinor/fusion-framework-module-msal": "^4.0.2",
+    "@equinor/fusion-framework-module": "^4.3.7"
   },
   "peerDependencies": {
-    "@equinor/fusion-framework-module-msal": "^4.0.0",
-    "@equinor/fusion-framework-module-service-discovery": "^8.0.6",
-    "@equinor/fusion-framework-module": "^4.3.5"
+    "@equinor/fusion-framework-module": "^4.3.7",
+    "@equinor/fusion-framework-module-service-discovery": "^8.0.8",
+    "@equinor/fusion-framework-module-msal": "^4.0.2"
   },
   "peerDependenciesMeta": {
     "@equinor/fusion-framework-module-service-discovery": {

package/src/SignalRModule.ts

@@ -1,7 +1,7 @@
-import { Module } from '@equinor/fusion-framework-module';
-import { ISignalRConfigurator, SignalRConfigurator } from './SignalRModuleConfigurator';
+import type { Module } from '@equinor/fusion-framework-module';
+import { type ISignalRConfigurator, SignalRConfigurator } from './SignalRModuleConfigurator';
 
-import { ISignalRProvider, SignalRModuleProvider } from './SignalRModuleProvider';
+import { type ISignalRProvider, SignalRModuleProvider } from './SignalRModuleProvider';
 
 export type SignalRModuleKey = 'signalR';
 
@@ -10,18 +10,18 @@ export const moduleKey: SignalRModuleKey = 'signalR';
 export type SignalRModule = Module<SignalRModuleKey, ISignalRProvider, ISignalRConfigurator>;
 
 export const module: SignalRModule = {
-    name: moduleKey,
-    configure: () => new SignalRConfigurator(),
-    initialize: async (init) => {
-        const config = await (init.config as SignalRConfigurator).createConfig(init);
-        return new SignalRModuleProvider(config);
-    },
+  name: moduleKey,
+  configure: () => new SignalRConfigurator(),
+  initialize: async (init) => {
+    const config = await (init.config as SignalRConfigurator).createConfig(init);
+    return new SignalRModuleProvider(config);
+  },
 };
 
 export default module;
 
 declare module '@equinor/fusion-framework-module' {
-    interface Modules {
-        signalR: SignalRModule;
-    }
+  interface Modules {
+    signalR: SignalRModule;
+  }
 }

package/src/SignalRModuleConfigurator.ts

@@ -1,94 +1,94 @@
 import {
-    AnyModule,
-    ModuleConfigBuilder,
-    ModuleInitializerArgs,
+  type AnyModule,
+  ModuleConfigBuilder,
+  type ModuleInitializerArgs,
 } from '@equinor/fusion-framework-module';
 
-import { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
-import { IHttpConnectionOptions, LogLevel } from '@microsoft/signalr';
+import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
+import type { IHttpConnectionOptions, LogLevel } from '@microsoft/signalr';
 
 export interface ISignalRConfigurator {
-    /** add configuration for hub connection */
-    addHub(name: string, config: SignalRHubConfig | Promise<SignalRHubConfig>): void;
+  /** add configuration for hub connection */
+  addHub(name: string, config: SignalRHubConfig | Promise<SignalRHubConfig>): void;
 
-    /** add callback for building config on init */
-    onCreateConfig(cb: SignalRModuleConfigBuilderCallback): void;
+  /** add callback for building config on init */
+  onCreateConfig(cb: SignalRModuleConfigBuilderCallback): void;
 }
 
 /** configuration callback */
 export type SignalRModuleConfigBuilderCallback<TDeps = unknown> = (
-    builder: SignalRModuleConfigBuilder<TDeps>,
+  builder: SignalRModuleConfigBuilder<TDeps>,
 ) => void | Promise<void>;
 
 /**
  * Configuration for hub connection
  */
 export type SignalRHubConfig = {
-    /** connection endpoint */
-    url: string;
+  /** connection endpoint */
+  url: string;
 
-    /** connection options */
-    options: Omit<IHttpConnectionOptions, 'httpClient'>;
+  /** connection options */
+  options: Omit<IHttpConnectionOptions, 'httpClient'>;
 
-    /** reconnect when connection lost */
-    automaticReconnect?: boolean;
-    logLevel?: LogLevel;
+  /** reconnect when connection lost */
+  automaticReconnect?: boolean;
+  logLevel?: LogLevel;
 };
 
 /**
  * Configuration for creating SignalR provider
  */
 export type SignalRConfig = {
-    hubs: Record<string, SignalRHubConfig>;
+  hubs: Record<string, SignalRHubConfig>;
 };
 
 /**
  * builder utility class for generating configuration
  */
 export class SignalRModuleConfigBuilder<
-    TDeps extends AnyModule[] | unknown = unknown,
-    // TODO - use BaseConfigBuilder
+  TDeps extends AnyModule[] | unknown = unknown,
+  // TODO - use BaseConfigBuilder
 > extends ModuleConfigBuilder<TDeps, ISignalRConfigurator> {
-    async addHub(name: string, config: SignalRHubConfig) {
-        this._config.addHub(name, config);
-    }
+  async addHub(name: string, config: SignalRHubConfig) {
+    this._config.addHub(name, config);
+  }
 }
 
 export class SignalRConfigurator implements ISignalRConfigurator {
-    #builderCallbacks: Array<SignalRModuleConfigBuilderCallback> = [];
+  #builderCallbacks: Array<SignalRModuleConfigBuilderCallback> = [];
 
-    #hubs: Record<string, SignalRHubConfig> = {};
+  #hubs: Record<string, SignalRHubConfig> = {};
 
-    /**
-     * register SignalR hub configuration.
-     */
-    public addHub(name: string, config: SignalRHubConfig) {
-        this.#hubs[name] = config;
-    }
+  /**
+   * register SignalR hub configuration.
+   */
+  public addHub(name: string, config: SignalRHubConfig) {
+    this.#hubs[name] = config;
+  }
 
-    /**
-     * add callback for building config on when configurator is creating config.
-     * {@link SignalRConfigurator.createConfig}
-     */
-    public onCreateConfig<T>(cb: SignalRModuleConfigBuilderCallback<T>): void {
-        this.#builderCallbacks.push(cb);
-    }
+  /**
+   * add callback for building config on when configurator is creating config.
+   * {@link SignalRConfigurator.createConfig}
+   */
+  public onCreateConfig<T>(cb: SignalRModuleConfigBuilderCallback<T>): void {
+    this.#builderCallbacks.push(cb);
+  }
 
-    /**
-     * normally executed in `init` phase of module, which creates configuration to the module provider.
-     * cycles threw all registered configuration builders.
-     * await all registered hub configurations.
-     */
-    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 };
+  /**
+   * normally executed in `init` phase of module, which creates configuration to the module provider.
+   * cycles threw all registered configuration builders.
+   * await all registered hub configurations.
+   */
+  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,83 +1,83 @@
-import { HubConnectionBuilder, HubConnection, AbortError } from '@microsoft/signalr';
+import { HubConnectionBuilder, type HubConnection, AbortError } from '@microsoft/signalr';
 import { Observable, shareReplay } from 'rxjs';
 
-import { SignalRConfig } from './SignalRModuleConfigurator';
+import type { SignalRConfig } from './SignalRModuleConfigurator';
 
 import { Topic } from './lib/Topic';
 
 export interface ISignalRProvider {
-    /**
-     * connect to SignalR hub
-     * re-use existing connections and close connection when nobody is listening
-     */
-    connect<T>(ubId: string, methodName: string): Topic<T>;
+  /**
+   * connect to SignalR hub
+   * re-use existing connections and close connection when nobody is listening
+   */
+  connect<T>(ubId: string, methodName: string): Topic<T>;
 }
 
 export class SignalRModuleProvider implements ISignalRProvider {
-    #config: SignalRConfig;
-    #hubConnections: Record<string, Observable<HubConnection>> = {};
+  #config: SignalRConfig;
+  #hubConnections: Record<string, Observable<HubConnection>> = {};
 
-    constructor(config: SignalRConfig) {
-        this.#config = config;
-    }
+  constructor(config: SignalRConfig) {
+    this.#config = config;
+  }
 
-    public connect<T>(hubId: string, methodName: string): Topic<T> {
-        return new Topic<T>(methodName, this._createHubConnection(hubId));
-    }
+  public connect<T>(hubId: string, methodName: string): Topic<T> {
+    return new Topic<T>(methodName, this._createHubConnection(hubId));
+  }
+
+  protected _createHubConnection(hubId: string): Observable<HubConnection> {
+    const LOG_LEVEL_CRITICAL = 5;
 
-    protected _createHubConnection(hubId: string): Observable<HubConnection> {
-        const LOG_LEVEL_CRITICAL = 5;
-
-        if (hubId in this.#hubConnections) {
-            return this.#hubConnections[hubId];
-        }
-        const config = this.#config.hubs[hubId];
-        if (!config) {
-            throw Error(`could not find any configuration for hub [${hubId}]`);
-        }
-
-        this.#hubConnections[hubId] = new Observable<HubConnection>((observer) => {
-            const builder = new HubConnectionBuilder().withUrl(config.url, {
-                ...config.options,
-            });
-
-            config.automaticReconnect && builder.withAutomaticReconnect();
-
-            builder.configureLogging(config.logLevel || LOG_LEVEL_CRITICAL);
-
-            const connection = builder.build();
-
-            connection
-                .start()
-                .then(() => {
-                    observer.next(connection);
-                })
-                .catch((error: unknown) => {
-                    if (error instanceof AbortError) {
-                        // Omit AbortError
-                    } else {
-                        throw error;
-                    }
-                });
-
-            const teardown = () => {
-                connection.stop();
-                observer.complete();
-                delete this.#hubConnections[hubId];
-            };
-
-            return teardown;
-        }).pipe(
-            shareReplay({
-                /** only emit last connection when new subscriber connects */
-                bufferSize: 1,
-                /** when no subscribers, teardown observable */
-                refCount: true,
-            }),
-        );
-
-        return this.#hubConnections[hubId];
+    if (hubId in this.#hubConnections) {
+      return this.#hubConnections[hubId];
     }
+    const config = this.#config.hubs[hubId];
+    if (!config) {
+      throw Error(`could not find any configuration for hub [${hubId}]`);
+    }
+
+    this.#hubConnections[hubId] = new Observable<HubConnection>((observer) => {
+      const builder = new HubConnectionBuilder().withUrl(config.url, {
+        ...config.options,
+      });
+
+      config.automaticReconnect && builder.withAutomaticReconnect();
+
+      builder.configureLogging(config.logLevel || LOG_LEVEL_CRITICAL);
+
+      const connection = builder.build();
+
+      connection
+        .start()
+        .then(() => {
+          observer.next(connection);
+        })
+        .catch((error: unknown) => {
+          if (error instanceof AbortError) {
+            // Omit AbortError
+          } else {
+            throw error;
+          }
+        });
+
+      const teardown = () => {
+        connection.stop();
+        observer.complete();
+        delete this.#hubConnections[hubId];
+      };
+
+      return teardown;
+    }).pipe(
+      shareReplay({
+        /** only emit last connection when new subscriber connects */
+        bufferSize: 1,
+        /** when no subscribers, teardown observable */
+        refCount: true,
+      }),
+    );
+
+    return this.#hubConnections[hubId];
+  }
 }
 
 export default SignalRModuleProvider;

package/src/index.ts

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

package/src/lib/Topic.ts

@@ -1,39 +1,39 @@
-import { HubConnection } from '@microsoft/signalr';
+import type { HubConnection } from '@microsoft/signalr';
 import { Observable } from 'rxjs';
 
 export class Topic<T> extends Observable<T> {
-    connection: HubConnection | undefined;
+  connection: HubConnection | undefined;
 
-    constructor(
-        public topic: string,
-        public hubConnection: Observable<HubConnection>,
-    ) {
-        super((subscriber) => {
-            const hubConnectionSubscription = hubConnection.subscribe((connection) => {
-                const cb = subscriber.next.bind(subscriber);
-                connection.on(topic, cb);
-                subscriber.add(() => connection.off(topic, cb));
-                this.connection = connection;
-            });
-            subscriber.add(() => {
-                hubConnectionSubscription.unsubscribe();
-            });
-        });
-    }
+  constructor(
+    public topic: string,
+    public hubConnection: Observable<HubConnection>,
+  ) {
+    super((subscriber) => {
+      const hubConnectionSubscription = hubConnection.subscribe((connection) => {
+        const cb = subscriber.next.bind(subscriber);
+        connection.on(topic, cb);
+        subscriber.add(() => connection.off(topic, cb));
+        this.connection = connection;
+      });
+      subscriber.add(() => {
+        hubConnectionSubscription.unsubscribe();
+      });
+    });
+  }
 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    public send(...args: any[]): void {
-        if (!this.connection) {
-            throw new Error('No hub connection awaitable');
-        }
-        this.connection.send(this.topic, args);
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  public send(...args: any[]): void {
+    if (!this.connection) {
+      throw new Error('No hub connection awaitable');
     }
+    this.connection.send(this.topic, args);
+  }
 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    public invoke<T>(...args: any[]): Promise<T> {
-        if (!this.connection) {
-            throw new Error('No hub connection awaitable');
-        }
-        return this.connection?.invoke(this.topic, args);
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  public invoke<T>(...args: any[]): Promise<T> {
+    if (!this.connection) {
+      throw new Error('No hub connection awaitable');
     }
+    return this.connection?.invoke(this.topic, args);
+  }
 }

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

@@ -1,33 +1,33 @@
-import { MsalModule } from '@equinor/fusion-framework-module-msal';
-import { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
+import type { MsalModule } from '@equinor/fusion-framework-module-msal';
+import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
 
-import { SignalRModuleConfigBuilder } from '../../SignalRModuleConfigurator';
+import type { SignalRModuleConfigBuilder } from '../../SignalRModuleConfigurator';
 
 export const configureFromFramework = async (
-    args: { name: string; service: string; path: string },
-    builder: SignalRModuleConfigBuilder<[MsalModule, ServiceDiscoveryModule]>,
+  args: { name: string; service: string; path: string },
+  builder: SignalRModuleConfigBuilder<[MsalModule, ServiceDiscoveryModule]>,
 ) => {
-    const authProvider = await builder.requireInstance('auth');
-    const serviceDiscovery = await builder.requireInstance('serviceDiscovery');
-    const service = await serviceDiscovery.resolveService(args.name);
-    builder.addHub(args.name, {
-        url: new URL(args.path, service.uri).toString(),
-        options: {
-            accessTokenFactory: async () => {
-                if (!service.scopes) {
-                    throw Error(
-                        `service [${service.name}] does not have authentication scopes, please configure an endpoint with scopes`,
-                    );
-                }
-                const token = await authProvider.acquireAccessToken({
-                    scopes: service.scopes ?? service.defaultScopes,
-                });
-                if (!token) {
-                    throw Error('failed to acquire access token');
-                }
-                return token;
-            },
-        },
-        automaticReconnect: true,
-    });
+  const authProvider = await builder.requireInstance('auth');
+  const serviceDiscovery = await builder.requireInstance('serviceDiscovery');
+  const service = await serviceDiscovery.resolveService(args.name);
+  builder.addHub(args.name, {
+    url: new URL(args.path, service.uri).toString(),
+    options: {
+      accessTokenFactory: async () => {
+        if (!service.scopes) {
+          throw Error(
+            `service [${service.name}] does not have authentication scopes, please configure an endpoint with scopes`,
+          );
+        }
+        const token = await authProvider.acquireAccessToken({
+          scopes: service.scopes ?? service.defaultScopes,
+        });
+        if (!token) {
+          throw Error('failed to acquire access token');
+        }
+        return token;
+      },
+    },
+    automaticReconnect: true,
+  });
 };