@genesislcap/foundation-comms 14.306.1 → 14.306.2-alpha-7a2d723.0

package/dist/foundation-comms.d.ts

@@ -11,8 +11,8 @@ import { Listener } from '@genesislcap/foundation-utils';
 import { Logger } from '@genesislcap/foundation-logger';
 import type { LogLevel } from '@genesislcap/foundation-utils';
 import { Observable } from 'rxjs';
-import { Observer } from '@genesislcap/foundation-utils';
-import { Observer as Observer_2 } from 'rxjs';
+import { Observer } from 'rxjs';
+import { Observer as Observer_2 } from '@genesislcap/foundation-utils';
 import { SetUserProperties } from '@genesislcap/foundation-user';
 import { Subscription as SocketSubscription } from 'rxjs';
 import { Subject } from 'rxjs';
@@ -402,6 +402,11 @@ export declare interface Connect {
      * @returns A promise that resolves to a Message containing the server's response.
      */
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
+    /**
+     * Emits true when the session is detected as expired (e.g., IS_AUTHENTICATED is false in heartbeat pong).
+     * Consumers can subscribe to this to react to session expiration events.
+     */
+    readonly sessionExpired$?: Subject<boolean>;
     /**
      * @returns The host provided.
      */
@@ -586,6 +591,7 @@ export declare class ConnectMock implements Connect {
     nextMessage: Message;
     requestParams: RequestParams;
     nextListState: any[];
+    sessionExpired$: BehaviorSubject<boolean>;
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
     connect(host: string): Promise<boolean>;
     disconnect(): void;
@@ -1753,16 +1759,33 @@ export declare class DefaultAuth implements Auth {
     private messageBuilder;
     private credentialManager;
     currentUser: User_2;
+    private socket;
     isWorking: boolean;
     loggedUserResult: LoginResult;
     private loggedUserResultChanged;
     private isLoggedInSubject;
     get isLoggedIn$(): Observable<boolean>;
     get isLoggedIn(): boolean;
-    constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager, currentUser: User_2);
+    static REAUTH_ACTION_LOCK_KEY: string;
+    constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager, currentUser: User_2, socket: Socket);
     login(credentials: AuthInfo): Promise<LoginResult>;
     logout(): Promise<LogoutResult>;
     reAuthFromSession(): Promise<boolean>;
+    /**
+     * Handles an expired session by attempting to refresh the session using either refresh token or cookie-based reauth.
+     * @public
+     */
+    private handleExpiredSession;
+    /**
+     * Handles cookie-based reauthentication, including multi-tab lockout and page reload if necessary.
+     * @internal
+     */
+    private handleCookieBasedReauth;
+    /**
+     * Handles the storage event for multi-tab reauthentication lock.
+     * @internal
+     */
+    private onStorageEvent;
     /**
      * Ensures that the connection is active.
      * @internal
@@ -1796,12 +1819,18 @@ export declare class DefaultConnect implements Connect {
     private metaCache;
     private events;
     private config;
+    protected user: User_2;
     isWorking: boolean;
+    /**
+     * Emits true when the session is detected as expired (e.g., IS_AUTHENTICATED is false in heartbeat pong).
+     * Consumers can subscribe to this to react to session expiration events.
+     */
+    readonly sessionExpired$: BehaviorSubject<boolean>;
     get isConnected(): boolean;
     get isConnectedSubject(): BehaviorSubject<boolean>;
     get isConnected$(): Observable<boolean>;
     get host(): string;
-    constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
+    constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig, user: User_2);
     httpMode(): boolean;
     /**
      * @deprecated - Please reference `User` from `@genesislcap/foundation-user` instead.
@@ -1836,11 +1865,11 @@ export declare const defaultConnectConfig: ConnectConfig;
  */
 export declare class DefaultConnectEvents implements ConnectEventsEmitter {
     /** @internal */
-    protected streamListeners: Observer<StreamEvent>;
+    protected streamListeners: Observer_2<StreamEvent>;
     /** @internal */
-    protected streamCompleteListeners: Observer<StreamCompleteEvent>;
+    protected streamCompleteListeners: Observer_2<StreamCompleteEvent>;
     /** @internal */
-    protected streamErrorListeners: Observer<StreamErrorEvent>;
+    protected streamErrorListeners: Observer_2<StreamErrorEvent>;
     /** {@inheritDoc ConnectEvents.addStreamListener} */
     addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
     /** {@inheritDoc ConnectEventsEmitter.onStreamEvent} */
@@ -1850,19 +1879,19 @@ export declare class DefaultConnectEvents implements ConnectEventsEmitter {
     /** {@inheritDoc ConnectEventsEmitter.onStreamCompleteEvent} */
     onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
     /** @internal */
-    protected commitListeners: Observer<CommitEvent>;
+    protected commitListeners: Observer_2<CommitEvent>;
     /** {@inheritDoc ConnectEvents.addCommitListener} */
     addCommitListener(listener: Listener<CommitEvent>): () => void;
     /** {@inheritDoc ConnectEventsEmitter.onStreamEvent} */
     onCommitEvent(eventName: string, message: Message): void;
     /** @internal */
-    protected metadataListeners: Observer<MetadataEvent>;
+    protected metadataListeners: Observer_2<MetadataEvent>;
     /** {@inheritDoc ConnectEvents.addMetadataListener} */
     addMetadataListener(listener: Listener<MetadataEvent>): () => void;
     /** {@inheritDoc ConnectEventsEmitter.onMetadataEvent} */
     onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
     /** @internal */
-    protected commitResponseListeners: Observer<CommitResponseEvent>;
+    protected commitResponseListeners: Observer_2<CommitResponseEvent>;
     /** {@inheritDoc ConnectEvents.addCommitResponseListener} */
     addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
     /** {@inheritDoc ConnectEventsEmitter.onCommitResponseEvent} */
@@ -2504,17 +2533,7 @@ export declare class DefaultSocket implements Socket {
     private get heartbeatLoggingIsEnabled();
     private get messageLoggingIsEnabled();
     connect(host?: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
-    /**
-     *
-     * @remarks
-     * This is triggered after `sessionTimeoutMins` elapses and heartbeat would tell us that user is no longer authenticated
-     * more info here https://docs.genesis.global/docs/develop/server-capabilities/access-control/authentication/#sessiontimeoutmins
-     */
-    private handleExpiredSession;
-    private static REAUTH_ACTION_LOCK_KEY;
-    private handleCookieBasedReauth;
-    private onStorageEvent;
-    private updateSessionAndSubscriptions;
+    updateSessionAndSubscriptions(refreshTokenResult: string): void;
     private prepareHeartbeat;
     private reconnect;
     reset(): void;
@@ -3762,6 +3781,7 @@ export declare namespace MessageDetails {
         NOTIFY_EXPIRY?: boolean;
         PRODUCT?: any[];
         SYSTEM?: any;
+        SESSION_TIMEOUT_MINS?: number;
     };
 }
 
@@ -4127,6 +4147,7 @@ export declare type RawDataServerResult = {
     MORE_ROWS: boolean;
     ROWS_COUNT: number;
     SEQUENCE_ID: number;
+    LOGGED_OUT: boolean;
 };
 
 /**
@@ -4494,6 +4515,11 @@ export declare interface Socket extends Omit<SocketStatus, 'serialize' | 'onClos
     sendForStreamWithoutTeardown<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
     socketMessages(): SocketSubject<Message>;
     host: string;
+    /**
+     * Updates the session and subscriptions with the new session token.
+     * @param refreshTokenResult - The refresh token result.
+     */
+    updateSessionAndSubscriptions(refreshToken: string): void;
 }
 
 /**
@@ -4518,7 +4544,7 @@ export declare type SocketConnectOptions = {
     /**
      * An observer to receive notifications of incoming messages from the server.
      */
-    connectObserver?: Observer_2<Message>;
+    connectObserver?: Observer<Message>;
     /**
      * Enable sending heartbeat messages to the server to prevent the connection from timing out.
      */
@@ -4616,12 +4642,15 @@ export declare class SocketMock implements Socket {
     host: string;
     nextMessage: Message;
     socketMessagesSubject: SocketSubject<Message>;
+    sessionExpiredSubject: SocketSubject<PongMessage>;
     connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
     disconnect(): void;
     send<T>(message: Message<any>): Promise<Message | any>;
     sendForStream<T>(message: Message<any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
     sendForStreamWithoutTeardown<T>(message: Message<any>, onMessage: Function, onError: Function): Observable<Message>;
     socketMessages(): SocketSubject<Message>;
+    sessionExpired(): SocketObservable<PongMessage>;
+    updateSessionAndSubscriptions(refreshToken: string): void;
     reset(): void;
 }
 
@@ -4653,7 +4682,7 @@ export declare type SocketReconnectOptions = {
      * Observer to notify when reconnection occurs
      * @public
      */
-    reconnectObserver?: Observer_2<any>;
+    reconnectObserver?: Observer<any>;
     /**
      * Reconnect stream subscriptions on reconnection
      * @public

package/docs/api/foundation-comms.connect.md

@@ -133,6 +133,27 @@ boolean
 Indicates whether Connect is working or is idle.
 
 
+</td></tr>
+<tr><td>
+
+[sessionExpired$?](./foundation-comms.connect.sessionexpired_.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Subject&lt;boolean&gt;
+
+
+</td><td>
+
+_(Optional)_ Emits true when the session is detected as expired (e.g., IS\_AUTHENTICATED is false in heartbeat pong). Consumers can subscribe to this to react to session expiration events.
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.connect.sessionexpired_.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Connect](./foundation-comms.connect.md) &gt; [sessionExpired$](./foundation-comms.connect.sessionexpired_.md)
+
+## Connect.sessionExpired$ property
+
+Emits true when the session is detected as expired (e.g., IS\_AUTHENTICATED is false in heartbeat pong). Consumers can subscribe to this to react to session expiration events.
+
+**Signature:**
+
+```typescript
+readonly sessionExpired$?: Subject<boolean>;
+```

package/docs/api/foundation-comms.defaultauth._constructor_.md

@@ -9,7 +9,7 @@ Constructs a new instance of the `DefaultAuth` class
 **Signature:**
 
 ```typescript
-constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager, currentUser: User);
+constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager, currentUser: User, socket: Socket);
 ```
 
 ## Parameters
@@ -99,6 +99,20 @@ User
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+socket
+
+
+</td><td>
+
+[Socket](./foundation-comms.socket.md)
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.defaultauth.md

@@ -33,7 +33,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)(session, connect, messageBuilder, credentialManager, currentUser)](./foundation-comms.defaultauth._constructor_.md)
+[(constructor)(session, connect, messageBuilder, credentialManager, currentUser, socket)](./foundation-comms.defaultauth._constructor_.md)
 
 
 </td><td>
@@ -158,6 +158,25 @@ boolean
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[REAUTH\_ACTION\_LOCK\_KEY](./foundation-comms.defaultauth.reauth_action_lock_key.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.defaultauth.reauth_action_lock_key.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultAuth](./foundation-comms.defaultauth.md) &gt; [REAUTH\_ACTION\_LOCK\_KEY](./foundation-comms.defaultauth.reauth_action_lock_key.md)
+
+## DefaultAuth.REAUTH\_ACTION\_LOCK\_KEY property
+
+**Signature:**
+
+```typescript
+static REAUTH_ACTION_LOCK_KEY: string;
+```

package/docs/api/foundation-comms.defaultconnect._constructor_.md

@@ -9,7 +9,7 @@ Constructs a new instance of the `DefaultConnect` class
 **Signature:**
 
 ```typescript
-constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
+constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig, user: User);
 ```
 
 ## Parameters
@@ -99,6 +99,20 @@ config
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+user
+
+
+</td><td>
+
+User
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.defaultconnect.md

@@ -33,7 +33,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)(socket, messageBuilder, metaCache, events, config)](./foundation-comms.defaultconnect._constructor_.md)
+[(constructor)(socket, messageBuilder, metaCache, events, config, user)](./foundation-comms.defaultconnect._constructor_.md)
 
 
 </td><td>
@@ -162,6 +162,27 @@ boolean
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[sessionExpired$](./foundation-comms.defaultconnect.sessionexpired_.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+BehaviorSubject&lt;boolean&gt;
+
+
+</td><td>
+
+Emits true when the session is detected as expired (e.g., IS\_AUTHENTICATED is false in heartbeat pong). Consumers can subscribe to this to react to session expiration events.
+
+
 </td></tr>
 <tr><td>
 
@@ -179,6 +200,25 @@ boolean
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[user](./foundation-comms.defaultconnect.user.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+User
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.defaultconnect.sessionexpired_.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnect](./foundation-comms.defaultconnect.md) &gt; [sessionExpired$](./foundation-comms.defaultconnect.sessionexpired_.md)
+
+## DefaultConnect.sessionExpired$ property
+
+Emits true when the session is detected as expired (e.g., IS\_AUTHENTICATED is false in heartbeat pong). Consumers can subscribe to this to react to session expiration events.
+
+**Signature:**
+
+```typescript
+readonly sessionExpired$: BehaviorSubject<boolean>;
+```

package/docs/api/foundation-comms.defaultconnect.user.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnect](./foundation-comms.defaultconnect.md) &gt; [user](./foundation-comms.defaultconnect.user.md)
+
+## DefaultConnect.user property
+
+**Signature:**
+
+```typescript
+protected user: User;
+```

package/docs/api/foundation-comms.defaultsocket.md

@@ -392,6 +392,18 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[updateSessionAndSubscriptions(refreshTokenResult)](./foundation-comms.defaultsocket.updatesessionandsubscriptions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.defaultsocket.updatesessionandsubscriptions.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [updateSessionAndSubscriptions](./foundation-comms.defaultsocket.updatesessionandsubscriptions.md)
+
+## DefaultSocket.updateSessionAndSubscriptions() method
+
+**Signature:**
+
+```typescript
+updateSessionAndSubscriptions(refreshTokenResult: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+refreshTokenResult
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.messagedetails.loggedinsysteminfo.md

@@ -17,5 +17,6 @@ type LoggedInSystemInfo = {
         NOTIFY_EXPIRY?: boolean;
         PRODUCT?: any[];
         SYSTEM?: any;
+        SESSION_TIMEOUT_MINS?: number;
     };
 ```

package/docs/api/foundation-comms.rawdataserverresult.md

@@ -16,6 +16,7 @@ export type RawDataServerResult = {
     MORE_ROWS: boolean;
     ROWS_COUNT: number;
     SEQUENCE_ID: number;
+    LOGGED_OUT: boolean;
 };
 ```
 **References:** [ServerRow](./foundation-comms.serverrow.md)

package/docs/api/foundation-comms.socket.md

@@ -125,6 +125,17 @@ Disconnects the socket and clears all subscriptions
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[updateSessionAndSubscriptions(refreshToken)](./foundation-comms.socket.updatesessionandsubscriptions.md)
+
+
+</td><td>
+
+Updates the session and subscriptions with the new session token.
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.socket.updatesessionandsubscriptions.md

@@ -0,0 +1,52 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Socket](./foundation-comms.socket.md) &gt; [updateSessionAndSubscriptions](./foundation-comms.socket.updatesessionandsubscriptions.md)
+
+## Socket.updateSessionAndSubscriptions() method
+
+Updates the session and subscriptions with the new session token.
+
+**Signature:**
+
+```typescript
+updateSessionAndSubscriptions(refreshToken: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+refreshToken
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+