@genesislcap/foundation-comms 14.176.1-alpha-ed9e3d4.0 → 14.177.0

package/dist/foundation-comms.d.ts

@@ -2,17 +2,20 @@
 
 import { BehaviorSubject } from 'rxjs';
 import { default as Bowser_2 } from 'bowser';
+import { DefaultUser } from '@genesislcap/foundation-user';
 import type { DTOMapper } from '@genesislcap/foundation-utils';
 import { InterfaceSymbol } from '@microsoft/fast-foundation';
 import { JSONSchema7 } from 'json-schema';
 import { JSONSerializer } from '@genesislcap/foundation-utils';
 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 { Subscription as SocketSubscription } from 'rxjs';
 import { Subject } from 'rxjs';
+import { User as User_2 } from '@genesislcap/foundation-user';
 import { UUID } from '@genesislcap/foundation-utils';
 
 /**
@@ -42,10 +45,10 @@ export declare interface Auth {
      */
     readonly isLoggedIn$?: Observable<boolean>;
     /**
-     * The currently logged-in user, if any.
+     * The current user
      * @internal
      */
-    readonly currentUser: User;
+    readonly currentUser: User_2;
     /**
      * Logs in the user with the specified credentials.
      * @public
@@ -105,7 +108,7 @@ export declare type AuthInfo = BasicAuthInfo | SsoAuthInfo | JwtAuthInfo | Refre
 export declare class AuthMock implements Auth {
     isWorking: boolean;
     loggedUserResult: LoginResult;
-    currentUser: User;
+    currentUser: User_2;
     isLoggedIn: boolean;
     nextLoginResult: LoginResult;
     nextLogoutResult: LogoutResult;
@@ -391,9 +394,10 @@ export declare interface ConnectEventsEmitter extends ConnectEvents {
     onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
     /**
      * Called by Connect.
+     * @param resourceName - The name of the resource.
      * @param stream - The actual stream itself.
      */
-    onStreamCompleteEvent(stream: SocketObservable<any>): void;
+    onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
     /**
      * Called by Connect.
      * @param eventName - The name of the event.
@@ -737,28 +741,25 @@ export declare function criteriaFiltersToFields(filters: string): Record<string,
 
 /**
  * Represents the current user (i.e. the user that is currently logged in).
+ *
+ * @deprecated - Use {@link @genesislcap/foundation-user#DefaultUser} instead.
+ *
  * @public
  */
-export declare class CurrentUser implements User {
-    permissions: UserPermission[];
-    profiles: UserProfile[];
-    username: string;
-    constructor(options: UserOptions);
-    set(options: UserOptions): void;
-    unset(): void;
-    hasAdminProfile(): boolean;
-    hasPermission(permission: string | string[]): boolean;
-    hasProfile(profile: string | string[]): boolean;
-    /**
-     * Checks if the given key or keys are present in the given array of keys.
-     * @internal
-     * @param keys - The array of keys to check.
-     * @param key - The key or keys to check for.
-     * @returns True if the key or keys are present in the array of keys.
-     */
-    private hasKey;
+export declare class CurrentUser extends DefaultUser implements User {
 }
 
+declare type DATA_LOGON_DETAILS = {
+    DATASOURCE_NAME: string;
+    CRITERIA_MATCH?: string;
+    MAX_ROWS?: number;
+    MAX_VIEW?: number;
+    MOVING_VIEW?: boolean;
+    POLLING_INTERVAL?: number;
+    DISABLE_POLLING?: boolean;
+    REVERSE?: boolean;
+};
+
 /**
  * Data server result filter.
  *
@@ -1080,14 +1081,14 @@ export declare class DefaultAuth implements Auth {
     private connect;
     private messageBuilder;
     private credentialManager;
+    currentUser: User_2;
     isWorking: boolean;
-    currentUser: User;
     loggedUserResult: LoginResult;
     private loggedUserResultChanged;
     private isLoggedInSubject;
     get isLoggedIn$(): Observable<boolean>;
     get isLoggedIn(): boolean;
-    constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager);
+    constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager, currentUser: User_2);
     login(credentials: AuthInfo): Promise<LoginResult>;
     logout(): Promise<LogoutResult>;
     reAuthFromSession(): Promise<boolean>;
@@ -1130,6 +1131,9 @@ export declare class DefaultConnect implements Connect {
     get isConnected$(): Observable<boolean>;
     constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config?: ConnectConfig);
     httpMode(): boolean;
+    /**
+     * @deprecated - Please reference {@link @genesislcap/foundation-user#User} instead.',
+     */
     setValidSession(valid: boolean): void;
     send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
     connect(host: string): Promise<boolean>;
@@ -1166,7 +1170,7 @@ export declare class DefaultConnectEvents implements ConnectEventsEmitter {
     /** {@inheritDoc ConnectEventsEmitter.onStreamEvent} */
     onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
     /** {@inheritDoc ConnectEventsEmitter.onStreamCompleteEvent} */
-    onStreamCompleteEvent(stream: SocketObservable<any>): void;
+    onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
     /** @internal */
     protected commitListeners: Observer<CommitEvent>;
     /** {@inheritDoc ConnectEvents.addCommitListener} */
@@ -1393,9 +1397,9 @@ export declare const defaultHttpConnectConfig: HttpConnectConfig;
  */
 export declare class DefaultKVStorage implements KVStorage {
     private connect;
-    private auth;
+    protected user: User_2;
     private kvStorageConfig;
-    constructor(connect: Connect, auth: Auth, kvStorageConfig?: KVStorageConfig);
+    constructor(connect: Connect, user: User_2, kvStorageConfig?: KVStorageConfig);
     /**
      * Determine whether KV Storage is available for use.
      * @internal
@@ -1499,6 +1503,8 @@ export declare class DefaultMessageBuilder implements MessageBuilder {
     createMoreRowsMessage(sourceRef: string): Message;
     createMoreColumnsMessage(sourceRef: string): Message;
     createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
+    /** {@inheritDoc MessageBuilder.createHeartbeatPingMessage} */
+    createHeartbeatPingMessage(verbose?: boolean): PingMessage;
 }
 
 /**
@@ -1537,7 +1543,7 @@ export declare class DefaultNetworkMonitor implements NetworkMonitor {
     /**
      * @internal
      */
-    protected user: User;
+    protected user: User_2;
     /**
      * @internal
      */
@@ -1554,6 +1560,10 @@ export declare class DefaultNetworkMonitor implements NetworkMonitor {
      * @internal
      */
     protected internalId: ReturnType<typeof setInterval>;
+    /**
+     * @internal
+     */
+    protected isReady: boolean;
     /**
      * @internal
      */
@@ -1562,6 +1572,7 @@ export declare class DefaultNetworkMonitor implements NetworkMonitor {
      * {@inheritDoc NetworkMonitor.status}
      */
     status: SystemHealthStatus;
+    constructor();
     /**
      * {@inheritDoc NetworkMonitor.create}
      */
@@ -1630,6 +1641,11 @@ export declare class DefaultNetworkMonitor implements NetworkMonitor {
      * @internal
      */
     protected normaliseEventDetail(detail: Partial<SystemHealthStatus>): SystemHealthStatus;
+    /**
+     * @returns A flag to indicate if the socket is in a state that allows resource checking.
+     * @internal
+     */
+    protected preFlightSocketChecks(status: SerializedSocketStatus): boolean;
     /**
      * @internal
      */
@@ -1690,6 +1706,10 @@ export declare class DefaultSocket implements Socket {
     private serializer;
     private uuid;
     private status;
+    /**
+     * Temp putting the user in place to bridge the hasValidSession logic.
+     */
+    protected user: User_2;
     private readonly defaultInterval;
     private readonly secondsMultiplier;
     private websocket;
@@ -1702,6 +1722,7 @@ export declare class DefaultSocket implements Socket {
     get isDisconnected(): boolean;
     get isDisconnectedByServer(): boolean;
     get isReconnecting(): boolean;
+    /** {@inheritDoc SerializedSocketStatus.hasValidSession} */
     get hasValidSession(): boolean;
     set hasValidSession(value: boolean);
     private heartbeatIsEnabled;
@@ -1711,7 +1732,11 @@ export declare class DefaultSocket implements Socket {
     private connectOptions;
     private reconnectOptions;
     private socketSubscription;
-    constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSerializer, uuid: UUID, status: SocketStatus);
+    constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSerializer, uuid: UUID, status: SocketStatus, 
+    /**
+     * Temp putting the user in place to bridge the hasValidSession logic.
+     */
+    user: User_2);
     private get heartbeatLoggingIsEnabled();
     private get messageLoggingIsEnabled();
     connect(host: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
@@ -1739,10 +1764,12 @@ export declare class DefaultSocketStatus implements SocketStatus {
     isConnected: boolean;
     isReconnecting: boolean;
     reconnectionLimitReached: boolean;
-    hasValidSession: boolean;
     closedCode: any;
     closedReason: any;
     closedClean: any;
+    protected user: User_2;
+    /** {@inheritDoc SerializedSocketStatus.hasValidSession} */
+    get hasValidSession(): boolean;
     get isDisconnected(): boolean;
     get isDisconnectedByServer(): boolean;
     isConnectedSubject: BehaviorSubject<boolean>;
@@ -2083,6 +2110,23 @@ export declare type GetCredentialOptions = CredentialRequestOptions & {};
  */
 export declare function getDatasource(): Datasource;
 
+/**
+ * Gets KVStorage from the DI container.
+ *
+ * @remarks
+ * A utility method for host applications that are not using decorators or the DI container.
+ *
+ * @example
+ * ```ts
+ * import { getKVStorage } from '@genesislcap/foundation-comms';
+ * ...
+ * private kvStorage = getKVStorage();
+ * ```
+ *
+ * @public
+ */
+export declare function getKVStorage(): KVStorage;
+
 /**
  * Gets NetworkMonitor from the DI container.
  *
@@ -2624,6 +2668,10 @@ export declare interface MessageBuilder {
      * @returns The headers.
      */
     createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
+    /**
+     * @param verbose - A flag to inform the backend you require a verbose response.
+     */
+    createHeartbeatPingMessage(verbose: boolean): PingMessage;
 }
 
 /**
@@ -3011,6 +3059,14 @@ export declare interface NetworkMonitorConfig {
      * Genesis connect events that invoke checks
      */
     genesisConnectEvents?: GenesisConnectEvents[];
+    /**
+     * Ignored Genesis resources that will NOT invoke checks
+     */
+    ignoredGenesisResources?: string[];
+    /**
+     * Start delay in ms
+     */
+    startDelay?: number;
     /**
      * Periodic check internal in ms
      */
@@ -3033,6 +3089,10 @@ export declare interface NetworkMonitorConfig {
      * The element to emit events from
      */
     eventEmitter?: HTMLElement;
+    /**
+     * Default log level
+     */
+    logLevel?: LogLevel;
 }
 
 /**
@@ -3059,6 +3119,14 @@ export declare const NetworkMonitorConfig: InterfaceSymbol<NetworkMonitorConfig>
  */
 export declare function normaliseCriteria(criteria: string, delimiter?: string): string;
 
+/**
+ * @public
+ */
+export declare type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS'> & {
+    VERBOSE?: boolean;
+    [key: string]: any;
+};
+
 /**
  * Configuration options for http polling.
  * @public
@@ -3079,6 +3147,17 @@ export declare interface PollingConfiguration {
     QUERIES: string[];
 }
 
+/**
+ * @public
+ */
+export declare type PongMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'USER_NAME'> & {
+    IS_AUTHENTICATED?: boolean;
+    CREATED_AT?: number;
+    LAST_RECEIVED?: number;
+    LAST_SENT?: number;
+    RESOURCES?: Record<string, RESOURCE_DETAILS[]>;
+};
+
 /**
  * Raw result from a DATASERVER data fetch.
  * @public
@@ -3132,6 +3211,15 @@ export declare type RequestServerResult = {
     MESSAGE_TYPE?: string;
 };
 
+declare type RESOURCE_DETAILS = {
+    NAME: string;
+    CREATED_AT: number;
+    LAST_RECEIVED: number;
+    LAST_SENT: number;
+    SOURCE_REF: string;
+    DATA_LOGON: DATA_LOGON_DETAILS;
+};
+
 /**
  * ResourceHealth.
  * @public
@@ -3195,6 +3283,7 @@ export declare interface SerializedSocketStatus {
     isDisconnectedByServer: boolean;
     isReconnecting: boolean;
     reconnectionLimitReached: boolean;
+    /** @deprecated - Use {@link @genesislcap/foundation-user#User.isAuthenticated} instead. */
     hasValidSession: boolean;
     readonly closedCode: number;
     readonly closedReason: string;
@@ -3435,6 +3524,20 @@ export declare type SocketConnectOptions = {
      * Time in milliseconds
      */
     heartbeatInterval?: number;
+    /**
+     * Server will send resource level information
+     */
+    verboseHeartbeat?: boolean;
+    /**
+     * Called with the ping message before it is sent
+     * @param message - The outgoing ping message.
+     */
+    heartbeatPingCallback?: (message: PingMessage) => void;
+    /**
+     * Called with the pong message after it is received
+     * @param message - The incoming pong message.
+     */
+    heartbeatPongCallback?: (message: PongMessage) => void;
     /**
      * The path to a proxy server to use for the connection.
      */
@@ -3627,7 +3730,12 @@ export declare type StorageType = 'local' | 'session';
 /**
  * @public
  */
-export declare type StreamCompleteEvent = CustomEvent<SocketObservable<any>>;
+export declare type StreamCompleteEvent = CustomEvent<StreamCompleteEventDetail>;
+
+/**
+ * @public
+ */
+export declare type StreamCompleteEventDetail = Pick<StreamEventDetail, 'resourceName' | 'stream'>;
 
 /**
  * @public
@@ -3786,20 +3894,23 @@ export declare function until(conditionFunc: () => boolean, timeoutMs?: number):
 
 /**
  * Represents a User object with associated permissions and profiles.
+ *
+ * @deprecated - Use {@link @genesislcap/foundation-user#User} instead.
+ *
  * @public
  */
-export declare interface User extends UserOptions {
-    hasAdminProfile(): boolean;
-    hasPermission(permission: UserPermission | UserPermission[]): boolean;
-    hasProfile(profile: UserProfile | UserProfile[]): boolean;
-    set(options: UserOptions): void;
-    unset(): void;
+export declare interface User extends User_2 {
 }
 
 /**
  * User DI key.
+ *
  * @privateRemarks
  * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ * Using aliasTo to point to {@link @genesislcap/foundation-user#User}.
+ *
+ * @deprecated - Use {@link @genesislcap/foundation-user#User} instead.
+ *
  * @internal
  */
 export declare const User: InterfaceSymbol<User>;
@@ -3810,24 +3921,6 @@ export declare const User: InterfaceSymbol<User>;
  */
 declare type UserInfoKeys = 'authToken' | 'ssoToken' | 'refreshToken' | 'sessionId' | 'returnUrl' | 'hostUrl' | 'gridOptions';
 
-/**
- * Made some minor adjustments here to make user more accessible in the short term.
- * Please note that this User will be replaced with the enhanced version shortly!
- */
-/**
- * TODO: Evolve, re-locate to foundation-data, foundation-user or similar and add JSON schema based population,
- * validation, evolution, foundation-store interop etc.
- */
-/**
- * Represents the core options for a user.
- * @internal
- */
-declare interface UserOptions {
-    readonly permissions: UserPermission[] | null;
-    readonly profiles: UserProfile[] | null;
-    readonly username: string | null;
-}
-
 /**
  * @internal
  */

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

@@ -19,6 +19,6 @@ export interface ConnectEventsEmitter extends ConnectEvents
 |  --- | --- |
 |  [onCommitEvent(eventName, message)](./foundation-comms.connecteventsemitter.oncommitevent.md) | Called by Connect. |
 |  [onMetadataEvent(resourceName, message, error)](./foundation-comms.connecteventsemitter.onmetadataevent.md) | Called by Connect. |
-|  [onStreamCompleteEvent(stream)](./foundation-comms.connecteventsemitter.onstreamcompleteevent.md) | Called by Connect. |
+|  [onStreamCompleteEvent(resourceName, stream)](./foundation-comms.connecteventsemitter.onstreamcompleteevent.md) | Called by Connect. |
 |  [onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.connecteventsemitter.onstreamevent.md) | Called by Connect. |
 

package/docs/api/foundation-comms.connecteventsemitter.onstreamcompleteevent.md

@@ -9,13 +9,14 @@ Called by Connect.
 **Signature:**
 
 ```typescript
-onStreamCompleteEvent(stream: SocketObservable<any>): void;
+onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
+|  resourceName | string | The name of the resource. |
 |  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
 
 **Returns:**

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

@@ -4,36 +4,19 @@
 
 ## CurrentUser class
 
+> Warning: This API is now obsolete.
+> 
+> - Use  instead.
+> 
+
 Represents the current user (i.e. the user that is currently logged in).
 
 **Signature:**
 
 ```typescript
-export declare class CurrentUser implements User 
+export declare class CurrentUser extends DefaultNextUser implements User 
 ```
-**Implements:** [User](./foundation-comms.user.md)
-
-## Constructors
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./foundation-comms.currentuser._constructor_.md) |  | Constructs a new instance of the <code>CurrentUser</code> class |
+**Extends:** DefaultNextUser
 
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [permissions](./foundation-comms.currentuser.permissions.md) |  | UserPermission\[\] |  |
-|  [profiles](./foundation-comms.currentuser.profiles.md) |  | UserProfile\[\] |  |
-|  [username](./foundation-comms.currentuser.username.md) |  | string |  |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [hasAdminProfile()](./foundation-comms.currentuser.hasadminprofile.md) |  |  |
-|  [hasPermission(permission)](./foundation-comms.currentuser.haspermission.md) |  |  |
-|  [hasProfile(profile)](./foundation-comms.currentuser.hasprofile.md) |  |  |
-|  [set(options)](./foundation-comms.currentuser.set.md) |  |  |
-|  [unset()](./foundation-comms.currentuser.unset.md) |  |  |
+**Implements:** [User](./foundation-comms.user.md)
 

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);
+constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager, currentUser: User);
 ```
 
 ## Parameters
@@ -20,4 +20,5 @@ constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder,
 |  connect | [Connect](./foundation-comms.connect.md) |  |
 |  messageBuilder | [MessageBuilder](./foundation-comms.messagebuilder.md) |  |
 |  credentialManager | [CredentialManager](./foundation-comms.credentialmanager.md) |  |
+|  currentUser | User |  |
 

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

@@ -17,13 +17,13 @@ export declare class DefaultAuth implements Auth
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(session, connect, messageBuilder, credentialManager)](./foundation-comms.defaultauth._constructor_.md) |  | Constructs a new instance of the <code>DefaultAuth</code> class |
+|  [(constructor)(session, connect, messageBuilder, credentialManager, currentUser)](./foundation-comms.defaultauth._constructor_.md) |  | Constructs a new instance of the <code>DefaultAuth</code> class |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [currentUser](./foundation-comms.defaultauth.currentuser.md) |  | [User](./foundation-comms.user.md) |  |
+|  [currentUser](./foundation-comms.defaultauth.currentuser.md) |  | User |  |
 |  [isLoggedIn](./foundation-comms.defaultauth.isloggedin.md) | <code>readonly</code> | boolean |  |
 |  [isLoggedIn$](./foundation-comms.defaultauth.isloggedin_.md) | <code>readonly</code> | Observable&lt;boolean&gt; |  |
 |  [isWorking](./foundation-comms.defaultauth.isworking.md) |  | boolean |  |

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

@@ -4,6 +4,11 @@
 
 ## DefaultConnect.setValidSession() method
 
+> Warning: This API is now obsolete.
+> 
+> - Please reference  instead.',
+> 
+
 **Signature:**
 
 ```typescript

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

@@ -22,6 +22,6 @@ export declare class DefaultConnectEvents implements ConnectEventsEmitter
 |  [addStreamListener(listener, complete)](./foundation-comms.defaultconnectevents.addstreamlistener.md) |  | Add a stream listener. |
 |  [onCommitEvent(eventName, message)](./foundation-comms.defaultconnectevents.oncommitevent.md) |  | Called by Connect. |
 |  [onMetadataEvent(resourceName, message, error)](./foundation-comms.defaultconnectevents.onmetadataevent.md) |  | Called by Connect. |
-|  [onStreamCompleteEvent(stream)](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md) |  | Called by Connect. |
+|  [onStreamCompleteEvent(resourceName, stream)](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md) |  | Called by Connect. |
 |  [onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.defaultconnectevents.onstreamevent.md) |  | Called by Connect. |
 

package/docs/api/foundation-comms.defaultconnectevents.onstreamcompleteevent.md

@@ -9,13 +9,14 @@ Called by Connect.
 **Signature:**
 
 ```typescript
-onStreamCompleteEvent(stream: SocketObservable<any>): void;
+onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
+|  resourceName | string | The name of the resource. |
 |  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
 
 **Returns:**

package/docs/api/foundation-comms.defaultmessagebuilder.createheartbeatpingmessage.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createHeartbeatPingMessage](./foundation-comms.defaultmessagebuilder.createheartbeatpingmessage.md)
+
+## DefaultMessageBuilder.createHeartbeatPingMessage() method
+
+**Signature:**
+
+```typescript
+createHeartbeatPingMessage(verbose?: boolean): PingMessage;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  verbose | boolean | _(Optional)_ A flag to inform the backend you require a verbose response. |
+
+**Returns:**
+
+[PingMessage](./foundation-comms.pingmessage.md)
+

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

@@ -29,6 +29,7 @@ export declare class DefaultMessageBuilder implements MessageBuilder
 |  [createDataLogonMessage(resourceName, params)](./foundation-comms.defaultmessagebuilder.createdatalogonmessage.md) |  |  |
 |  [createForgotPasswordMessage(username, returnUrl, requester)](./foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md) |  |  |
 |  [createForgotPasswordTokenMessage(username, resetToken, newPassword, requester)](./foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md) |  |  |
+|  [createHeartbeatPingMessage(verbose)](./foundation-comms.defaultmessagebuilder.createheartbeatpingmessage.md) |  |  |
 |  [createHTTPHeadersFromMessage(message, contentType)](./foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.md) |  |  |
 |  [createLoginMessage(credentials)](./foundation-comms.defaultmessagebuilder.createloginmessage.md) |  |  |
 |  [createLogoutMessage(loginResult)](./foundation-comms.defaultmessagebuilder.createlogoutmessage.md) |  |  |

package/docs/api/foundation-comms.defaultnetworkmonitor._constructor_.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; [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md) &gt; [(constructor)](./foundation-comms.defaultnetworkmonitor._constructor_.md)
+
+## DefaultNetworkMonitor.(constructor)
+
+Constructs a new instance of the `DefaultNetworkMonitor` class
+
+**Signature:**
+
+```typescript
+constructor();
+```

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

@@ -13,6 +13,12 @@ export declare class DefaultNetworkMonitor implements NetworkMonitor
 ```
 **Implements:** [NetworkMonitor](./foundation-comms.networkmonitor.md)
 
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)()](./foundation-comms.defaultnetworkmonitor._constructor_.md) |  | Constructs a new instance of the <code>DefaultNetworkMonitor</code> class |
+
 ## Properties
 
 |  Property | Modifiers | Type | Description |

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

@@ -9,7 +9,8 @@ Constructs a new instance of the `DefaultSocket` class
 **Signature:**
 
 ```typescript
-constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSerializer, uuid: UUID, status: SocketStatus);
+constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSerializer, uuid: UUID, status: SocketStatus, 
+    user: User);
 ```
 
 ## Parameters
@@ -21,4 +22,5 @@ constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSe
 |  serializer | JSONSerializer |  |
 |  uuid | UUID |  |
 |  status | [SocketStatus](./foundation-comms.socketstatus.md) |  |
+|  user | User |  |
 

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

@@ -17,7 +17,7 @@ export declare class DefaultSocket implements Socket
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(messageBuilder, session, serializer, uuid, status)](./foundation-comms.defaultsocket._constructor_.md) |  | Constructs a new instance of the <code>DefaultSocket</code> class |
+|  [(constructor)(messageBuilder, session, serializer, uuid, status, user)](./foundation-comms.defaultsocket._constructor_.md) |  | Constructs a new instance of the <code>DefaultSocket</code> class |
 
 ## Properties
 
@@ -32,6 +32,7 @@ export declare class DefaultSocket implements Socket
 |  [isDisconnectedByServer](./foundation-comms.defaultsocket.isdisconnectedbyserver.md) | <code>readonly</code> | boolean |  |
 |  [isReconnecting](./foundation-comms.defaultsocket.isreconnecting.md) | <code>readonly</code> | boolean |  |
 |  [socketMessages](./foundation-comms.defaultsocket.socketmessages.md) |  | () =&gt; [SocketSubject](./foundation-comms.socketsubject.md)<!-- -->&lt;[Message](./foundation-comms.message.md)<!-- -->&gt; |  |
+|  [user](./foundation-comms.defaultsocket.user.md) | <code>protected</code> | User | Temp putting the user in place to bridge the hasValidSession logic. |
 
 ## Methods