antaeus.keycloak.react 2.4.0 → 2.6.0

package/dist/index.d.mts

@@ -5,6 +5,7 @@ export { User } from 'oidc-client-ts';
 import { useLocation } from 'react-router-dom';
 import * as react_oidc_context from 'react-oidc-context';
 export { AuthContextProps as UseAuthReturn } from 'react-oidc-context';
+import { LogLevel, HubConnection, HubConnectionState } from '@microsoft/signalr';
 
 /**
  * Main configuration interface for Keycloak integration
@@ -1434,6 +1435,118 @@ interface UseTokenLifecycleReturn {
  */
 declare function useTokenLifecycle(options: UseTokenLifecycleOptions): UseTokenLifecycleReturn;
 
+/**
+ * Options for configuring the SignalR connection
+ */
+interface UseSignalRConnectionOptions {
+    /**
+     * Additional query string parameters to include in the connection URL
+     */
+    queryParams?: Record<string, string>;
+    /**
+     * SignalR log level
+     * @default LogLevel.Warning
+     */
+    logLevel?: LogLevel;
+    /**
+     * Automatically connect when the hook mounts
+     * @default true
+     */
+    autoConnect?: boolean;
+    /**
+     * Automatically reconnect when authentication state changes
+     * @default true
+     */
+    reconnectOnAuth?: boolean;
+    /**
+     * Enable debug logging
+     * @default false
+     */
+    debug?: boolean;
+}
+/**
+ * Return type for useSignalRConnection hook
+ */
+interface UseSignalRConnectionReturn {
+    /**
+     * The SignalR hub connection instance
+     */
+    connection: HubConnection | null;
+    /**
+     * Current connection state
+     */
+    connectionState: HubConnectionState;
+    /**
+     * Whether the connection is established
+     */
+    isConnected: boolean;
+    /**
+     * Whether the connection is in the process of connecting
+     */
+    isConnecting: boolean;
+    /**
+     * Connection error, if any
+     */
+    error: Error | null;
+    /**
+     * Manually connect to the hub
+     */
+    connect: () => Promise<void>;
+    /**
+     * Manually disconnect from the hub
+     */
+    disconnect: () => Promise<void>;
+    /**
+     * Invoke a hub method
+     * @param methodName The name of the server method to invoke
+     * @param args Arguments to pass to the server method
+     */
+    invoke: <T = void>(methodName: string, ...args: any[]) => Promise<T>;
+    /**
+     * Register a handler for a hub method
+     * @param methodName The name of the hub method to listen for
+     * @param handler The callback function to invoke when the method is called
+     * @returns A function to unregister the handler
+     */
+    on: (methodName: string, handler: (...args: any[]) => void) => () => void;
+}
+/**
+ * React hook for managing SignalR connections with Keycloak authentication
+ *
+ * @param hubUrl - The URL of the SignalR hub (e.g., "/hubs/notifications")
+ * @param options - Optional configuration for the connection
+ *
+ * @example
+ * ```tsx
+ * function NotificationsComponent() {
+ *   const { connection, isConnected, invoke, on } = useSignalRConnection('/hubs/notifications');
+ *
+ *   useEffect(() => {
+ *     if (!connection) return;
+ *
+ *     // Register handler for receiving messages
+ *     const unsubscribe = on('ReceiveMessage', (user: string, message: string) => {
+ *       console.log(`${user}: ${message}`);
+ *     });
+ *
+ *     return unsubscribe;
+ *   }, [connection, on]);
+ *
+ *   const sendMessage = async (message: string) => {
+ *     await invoke('SendMessage', message);
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <p>Status: {isConnected ? 'Connected' : 'Disconnected'}</p>
+ *       <button onClick={() => sendMessage('Hello!')}>Send</button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useSignalRConnection(hubUrl: string, options?: UseSignalRConnectionOptions): UseSignalRConnectionReturn;
+
 /**
  * Default configuration values for Keycloak integration
  */
@@ -1602,4 +1715,4 @@ declare function pollForToken(apiBaseUrl: string, deviceCode: string): Promise<T
  */
 declare function fetchUserInfo(apiBaseUrl: string, accessToken: string): Promise<any>;
 
-export { type AdvancedOidcOptions, CONFIG_PRESETS, type ConfigPreset, type DeviceAuthorizationResponse, type DeviceFlowError, DeviceLogin, type DeviceLoginProps, type EventCallbacks, type FeatureFlags, type KeycloakConfig, KeycloakConfigBuilder, type KeycloakDisabledReason, KeycloakProvider, type KeycloakProviderFullConfigProps, type KeycloakProviderProps, type KeycloakProviderZeroConfigProps, type KeycloakStatus, KeycloakStatusProvider, LoginButton, type LoginButtonProps, LogoutButton, type LogoutButtonProps, type PolicyContext, type PolicyFunction, ProtectedRoute, type ProtectedRouteProps, SessionMonitor, type SessionMonitorProps, type SilentRenewConfig, TokenBridge, type TokenBridgeProps, TokenBridgeSync, TokenLifecycleManager, type TokenLifecycleManagerProps, type TokenListener, type TokenResponse, type UseProtectedFetchOptions, type UseProtectedFetchReturn, type UseRolesReturn, type UseScopesReturn, type UseTokenLifecycleOptions, type UseTokenLifecycleReturn, UserProfile, type UserProfileProps, createTokenBridge, defaultConfig, defaultTokenBridge, fetchUserInfo, getConfigFromEnv, getConfigPreset, mergeWithPreset, pollForToken, requestDeviceCode, useAuth, useKeycloakStatus, useProtectedFetch, useRoles, useScopes, useTokenLifecycle };
+export { type AdvancedOidcOptions, CONFIG_PRESETS, type ConfigPreset, type DeviceAuthorizationResponse, type DeviceFlowError, DeviceLogin, type DeviceLoginProps, type EventCallbacks, type FeatureFlags, type KeycloakConfig, KeycloakConfigBuilder, type KeycloakDisabledReason, KeycloakProvider, type KeycloakProviderFullConfigProps, type KeycloakProviderProps, type KeycloakProviderZeroConfigProps, type KeycloakStatus, KeycloakStatusProvider, LoginButton, type LoginButtonProps, LogoutButton, type LogoutButtonProps, type PolicyContext, type PolicyFunction, ProtectedRoute, type ProtectedRouteProps, SessionMonitor, type SessionMonitorProps, type SilentRenewConfig, TokenBridge, type TokenBridgeProps, TokenBridgeSync, TokenLifecycleManager, type TokenLifecycleManagerProps, type TokenListener, type TokenResponse, type UseProtectedFetchOptions, type UseProtectedFetchReturn, type UseRolesReturn, type UseScopesReturn, type UseSignalRConnectionOptions, type UseSignalRConnectionReturn, type UseTokenLifecycleOptions, type UseTokenLifecycleReturn, UserProfile, type UserProfileProps, createTokenBridge, defaultConfig, defaultTokenBridge, fetchUserInfo, getConfigFromEnv, getConfigPreset, mergeWithPreset, pollForToken, requestDeviceCode, useAuth, useKeycloakStatus, useProtectedFetch, useRoles, useScopes, useSignalRConnection, useTokenLifecycle };

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export { User } from 'oidc-client-ts';
 import { useLocation } from 'react-router-dom';
 import * as react_oidc_context from 'react-oidc-context';
 export { AuthContextProps as UseAuthReturn } from 'react-oidc-context';
+import { LogLevel, HubConnection, HubConnectionState } from '@microsoft/signalr';
 
 /**
  * Main configuration interface for Keycloak integration
@@ -1434,6 +1435,118 @@ interface UseTokenLifecycleReturn {
  */
 declare function useTokenLifecycle(options: UseTokenLifecycleOptions): UseTokenLifecycleReturn;
 
+/**
+ * Options for configuring the SignalR connection
+ */
+interface UseSignalRConnectionOptions {
+    /**
+     * Additional query string parameters to include in the connection URL
+     */
+    queryParams?: Record<string, string>;
+    /**
+     * SignalR log level
+     * @default LogLevel.Warning
+     */
+    logLevel?: LogLevel;
+    /**
+     * Automatically connect when the hook mounts
+     * @default true
+     */
+    autoConnect?: boolean;
+    /**
+     * Automatically reconnect when authentication state changes
+     * @default true
+     */
+    reconnectOnAuth?: boolean;
+    /**
+     * Enable debug logging
+     * @default false
+     */
+    debug?: boolean;
+}
+/**
+ * Return type for useSignalRConnection hook
+ */
+interface UseSignalRConnectionReturn {
+    /**
+     * The SignalR hub connection instance
+     */
+    connection: HubConnection | null;
+    /**
+     * Current connection state
+     */
+    connectionState: HubConnectionState;
+    /**
+     * Whether the connection is established
+     */
+    isConnected: boolean;
+    /**
+     * Whether the connection is in the process of connecting
+     */
+    isConnecting: boolean;
+    /**
+     * Connection error, if any
+     */
+    error: Error | null;
+    /**
+     * Manually connect to the hub
+     */
+    connect: () => Promise<void>;
+    /**
+     * Manually disconnect from the hub
+     */
+    disconnect: () => Promise<void>;
+    /**
+     * Invoke a hub method
+     * @param methodName The name of the server method to invoke
+     * @param args Arguments to pass to the server method
+     */
+    invoke: <T = void>(methodName: string, ...args: any[]) => Promise<T>;
+    /**
+     * Register a handler for a hub method
+     * @param methodName The name of the hub method to listen for
+     * @param handler The callback function to invoke when the method is called
+     * @returns A function to unregister the handler
+     */
+    on: (methodName: string, handler: (...args: any[]) => void) => () => void;
+}
+/**
+ * React hook for managing SignalR connections with Keycloak authentication
+ *
+ * @param hubUrl - The URL of the SignalR hub (e.g., "/hubs/notifications")
+ * @param options - Optional configuration for the connection
+ *
+ * @example
+ * ```tsx
+ * function NotificationsComponent() {
+ *   const { connection, isConnected, invoke, on } = useSignalRConnection('/hubs/notifications');
+ *
+ *   useEffect(() => {
+ *     if (!connection) return;
+ *
+ *     // Register handler for receiving messages
+ *     const unsubscribe = on('ReceiveMessage', (user: string, message: string) => {
+ *       console.log(`${user}: ${message}`);
+ *     });
+ *
+ *     return unsubscribe;
+ *   }, [connection, on]);
+ *
+ *   const sendMessage = async (message: string) => {
+ *     await invoke('SendMessage', message);
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <p>Status: {isConnected ? 'Connected' : 'Disconnected'}</p>
+ *       <button onClick={() => sendMessage('Hello!')}>Send</button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useSignalRConnection(hubUrl: string, options?: UseSignalRConnectionOptions): UseSignalRConnectionReturn;
+
 /**
  * Default configuration values for Keycloak integration
  */
@@ -1602,4 +1715,4 @@ declare function pollForToken(apiBaseUrl: string, deviceCode: string): Promise<T
  */
 declare function fetchUserInfo(apiBaseUrl: string, accessToken: string): Promise<any>;
 
-export { type AdvancedOidcOptions, CONFIG_PRESETS, type ConfigPreset, type DeviceAuthorizationResponse, type DeviceFlowError, DeviceLogin, type DeviceLoginProps, type EventCallbacks, type FeatureFlags, type KeycloakConfig, KeycloakConfigBuilder, type KeycloakDisabledReason, KeycloakProvider, type KeycloakProviderFullConfigProps, type KeycloakProviderProps, type KeycloakProviderZeroConfigProps, type KeycloakStatus, KeycloakStatusProvider, LoginButton, type LoginButtonProps, LogoutButton, type LogoutButtonProps, type PolicyContext, type PolicyFunction, ProtectedRoute, type ProtectedRouteProps, SessionMonitor, type SessionMonitorProps, type SilentRenewConfig, TokenBridge, type TokenBridgeProps, TokenBridgeSync, TokenLifecycleManager, type TokenLifecycleManagerProps, type TokenListener, type TokenResponse, type UseProtectedFetchOptions, type UseProtectedFetchReturn, type UseRolesReturn, type UseScopesReturn, type UseTokenLifecycleOptions, type UseTokenLifecycleReturn, UserProfile, type UserProfileProps, createTokenBridge, defaultConfig, defaultTokenBridge, fetchUserInfo, getConfigFromEnv, getConfigPreset, mergeWithPreset, pollForToken, requestDeviceCode, useAuth, useKeycloakStatus, useProtectedFetch, useRoles, useScopes, useTokenLifecycle };
+export { type AdvancedOidcOptions, CONFIG_PRESETS, type ConfigPreset, type DeviceAuthorizationResponse, type DeviceFlowError, DeviceLogin, type DeviceLoginProps, type EventCallbacks, type FeatureFlags, type KeycloakConfig, KeycloakConfigBuilder, type KeycloakDisabledReason, KeycloakProvider, type KeycloakProviderFullConfigProps, type KeycloakProviderProps, type KeycloakProviderZeroConfigProps, type KeycloakStatus, KeycloakStatusProvider, LoginButton, type LoginButtonProps, LogoutButton, type LogoutButtonProps, type PolicyContext, type PolicyFunction, ProtectedRoute, type ProtectedRouteProps, SessionMonitor, type SessionMonitorProps, type SilentRenewConfig, TokenBridge, type TokenBridgeProps, TokenBridgeSync, TokenLifecycleManager, type TokenLifecycleManagerProps, type TokenListener, type TokenResponse, type UseProtectedFetchOptions, type UseProtectedFetchReturn, type UseRolesReturn, type UseScopesReturn, type UseSignalRConnectionOptions, type UseSignalRConnectionReturn, type UseTokenLifecycleOptions, type UseTokenLifecycleReturn, UserProfile, type UserProfileProps, createTokenBridge, defaultConfig, defaultTokenBridge, fetchUserInfo, getConfigFromEnv, getConfigPreset, mergeWithPreset, pollForToken, requestDeviceCode, useAuth, useKeycloakStatus, useProtectedFetch, useRoles, useScopes, useSignalRConnection, useTokenLifecycle };