@genesislcap/foundation-comms 14.167.2 → 14.167.3-alpha-b40d1e5.0

package/docs/api/foundation-comms.networkmonitorconfig.documentevents.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; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [documentEvents](./foundation-comms.networkmonitorconfig.documentevents.md)
+
+## NetworkMonitorConfig.documentEvents property
+
+Document events that invoke checks
+
+**Signature:**
+
+```typescript
+documentEvents?: (keyof DocumentEventMap)[];
+```

package/docs/api/foundation-comms.networkmonitorconfig.eventemitter.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; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [eventEmitter](./foundation-comms.networkmonitorconfig.eventemitter.md)
+
+## NetworkMonitorConfig.eventEmitter property
+
+The element to emit events from
+
+**Signature:**
+
+```typescript
+eventEmitter?: HTMLElement;
+```

package/docs/api/foundation-comms.networkmonitorconfig.genesisconnectevents.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; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [genesisConnectEvents](./foundation-comms.networkmonitorconfig.genesisconnectevents.md)
+
+## NetworkMonitorConfig.genesisConnectEvents property
+
+Genesis connect events that invoke checks
+
+**Signature:**
+
+```typescript
+genesisConnectEvents?: GenesisConnectEvents[];
+```

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

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md)
+
+## NetworkMonitorConfig interface
+
+NetworkMonitorConfig DI interface.
+
+**Signature:**
+
+```typescript
+export interface NetworkMonitorConfig 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [checkInterval?](./foundation-comms.networkmonitorconfig.checkinterval.md) |  | number | _(Optional)_ Periodic check internal in ms |
+|  [checkTimeout?](./foundation-comms.networkmonitorconfig.checktimeout.md) |  | number | _(Optional)_ Check timeout in ms |
+|  [documentEvents?](./foundation-comms.networkmonitorconfig.documentevents.md) |  | (keyof DocumentEventMap)\[\] | _(Optional)_ Document events that invoke checks |
+|  [eventEmitter?](./foundation-comms.networkmonitorconfig.eventemitter.md) |  | HTMLElement | _(Optional)_ The element to emit events from |
+|  [genesisConnectEvents?](./foundation-comms.networkmonitorconfig.genesisconnectevents.md) |  | [GenesisConnectEvents](./foundation-comms.genesisconnectevents.md)<!-- -->\[\] | _(Optional)_ Genesis connect events that invoke checks |
+|  [resourceChecks?](./foundation-comms.networkmonitorconfig.resourcechecks.md) |  | [MonitoredResourceChecks](./foundation-comms.monitoredresourcechecks.md) | _(Optional)_ Default resource checks function |
+|  [resourceDataLogon?](./foundation-comms.networkmonitorconfig.resourcedatalogon.md) |  | [MonitoredResourceDataLogon](./foundation-comms.monitoredresourcedatalogon.md) | _(Optional)_ Default resource data logon function |
+|  [windowEvents?](./foundation-comms.networkmonitorconfig.windowevents.md) |  | (keyof WindowEventHandlersEventMap)\[\] | _(Optional)_ Window events that invoke checks |
+

package/docs/api/foundation-comms.networkmonitorconfig.resourcechecks.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; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [resourceChecks](./foundation-comms.networkmonitorconfig.resourcechecks.md)
+
+## NetworkMonitorConfig.resourceChecks property
+
+Default resource checks function
+
+**Signature:**
+
+```typescript
+resourceChecks?: MonitoredResourceChecks;
+```

package/docs/api/foundation-comms.networkmonitorconfig.resourcedatalogon.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [resourceDataLogon](./foundation-comms.networkmonitorconfig.resourcedatalogon.md)
+
+## NetworkMonitorConfig.resourceDataLogon property
+
+Default resource data logon function
+
+**Signature:**
+
+```typescript
+resourceDataLogon?: MonitoredResourceDataLogon;
+```
+
+## Remarks
+
+Used to re-attempt data logon on an unhealthy data server
+

package/docs/api/foundation-comms.networkmonitorconfig.windowevents.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; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [windowEvents](./foundation-comms.networkmonitorconfig.windowevents.md)
+
+## NetworkMonitorConfig.windowEvents property
+
+Window events that invoke checks
+
+**Signature:**
+
+```typescript
+windowEvents?: (keyof WindowEventHandlersEventMap)[];
+```

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

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ResourceHealth](./foundation-comms.resourcehealth.md)
+
+## ResourceHealth type
+
+ResourceHealth.
+
+**Signature:**
+
+```typescript
+export type ResourceHealth = MonitoredResourceChecksResult & {
+    name: string;
+    sourceRef: string;
+    lastError?: any;
+};
+```
+**References:** [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md)
+

package/docs/api/foundation-comms.serializedsocketstatus.closedclean.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [closedClean](./foundation-comms.serializedsocketstatus.closedclean.md)
+
+## SerializedSocketStatus.closedClean property
+
+**Signature:**
+
+```typescript
+readonly closedClean: boolean;
+```

package/docs/api/foundation-comms.serializedsocketstatus.closedcode.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [closedCode](./foundation-comms.serializedsocketstatus.closedcode.md)
+
+## SerializedSocketStatus.closedCode property
+
+**Signature:**
+
+```typescript
+readonly closedCode: number;
+```

package/docs/api/foundation-comms.serializedsocketstatus.closedreason.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [closedReason](./foundation-comms.serializedsocketstatus.closedreason.md)
+
+## SerializedSocketStatus.closedReason property
+
+**Signature:**
+
+```typescript
+readonly closedReason: string;
+```

package/docs/api/foundation-comms.serializedsocketstatus.hasvalidsession.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [hasValidSession](./foundation-comms.serializedsocketstatus.hasvalidsession.md)
+
+## SerializedSocketStatus.hasValidSession property
+
+**Signature:**
+
+```typescript
+hasValidSession: boolean;
+```

package/docs/api/foundation-comms.serializedsocketstatus.isconfigured.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isConfigured](./foundation-comms.serializedsocketstatus.isconfigured.md)
+
+## SerializedSocketStatus.isConfigured property
+
+When the socket has been configured for use.
+
+**Signature:**
+
+```typescript
+isConfigured: boolean;
+```

package/docs/api/foundation-comms.serializedsocketstatus.isconnected.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isConnected](./foundation-comms.serializedsocketstatus.isconnected.md)
+
+## SerializedSocketStatus.isConnected property
+
+**Signature:**
+
+```typescript
+isConnected: boolean;
+```

package/docs/api/foundation-comms.serializedsocketstatus.isconnecting.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isConnecting](./foundation-comms.serializedsocketstatus.isconnecting.md)
+
+## SerializedSocketStatus.isConnecting property
+
+**Signature:**
+
+```typescript
+isConnecting: boolean;
+```

package/docs/api/foundation-comms.serializedsocketstatus.isdisconnected.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isDisconnected](./foundation-comms.serializedsocketstatus.isdisconnected.md)
+
+## SerializedSocketStatus.isDisconnected property
+
+**Signature:**
+
+```typescript
+isDisconnected: boolean;
+```

package/docs/api/foundation-comms.serializedsocketstatus.isdisconnectedbyserver.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isDisconnectedByServer](./foundation-comms.serializedsocketstatus.isdisconnectedbyserver.md)
+
+## SerializedSocketStatus.isDisconnectedByServer property
+
+**Signature:**
+
+```typescript
+isDisconnectedByServer: boolean;
+```

package/docs/api/foundation-comms.serializedsocketstatus.isreconnecting.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isReconnecting](./foundation-comms.serializedsocketstatus.isreconnecting.md)
+
+## SerializedSocketStatus.isReconnecting property
+
+**Signature:**
+
+```typescript
+isReconnecting: boolean;
+```

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

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md)
+
+## SerializedSocketStatus interface
+
+`SerializedSocketStatus` provides the serialize state of the web socket.
+
+**Signature:**
+
+```typescript
+export interface SerializedSocketStatus 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [closedClean](./foundation-comms.serializedsocketstatus.closedclean.md) | <code>readonly</code> | boolean |  |
+|  [closedCode](./foundation-comms.serializedsocketstatus.closedcode.md) | <code>readonly</code> | number |  |
+|  [closedReason](./foundation-comms.serializedsocketstatus.closedreason.md) | <code>readonly</code> | string |  |
+|  [hasValidSession](./foundation-comms.serializedsocketstatus.hasvalidsession.md) |  | boolean |  |
+|  [isConfigured](./foundation-comms.serializedsocketstatus.isconfigured.md) |  | boolean | When the socket has been configured for use. |
+|  [isConnected](./foundation-comms.serializedsocketstatus.isconnected.md) |  | boolean |  |
+|  [isConnecting](./foundation-comms.serializedsocketstatus.isconnecting.md) |  | boolean |  |
+|  [isDisconnected](./foundation-comms.serializedsocketstatus.isdisconnected.md) |  | boolean |  |
+|  [isDisconnectedByServer](./foundation-comms.serializedsocketstatus.isdisconnectedbyserver.md) |  | boolean |  |
+|  [isReconnecting](./foundation-comms.serializedsocketstatus.isreconnecting.md) |  | boolean |  |
+|  [reconnectionLimitReached](./foundation-comms.serializedsocketstatus.reconnectionlimitreached.md) |  | boolean |  |
+

package/docs/api/foundation-comms.serializedsocketstatus.reconnectionlimitreached.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; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [reconnectionLimitReached](./foundation-comms.serializedsocketstatus.reconnectionlimitreached.md)
+
+## SerializedSocketStatus.reconnectionLimitReached property
+
+**Signature:**
+
+```typescript
+reconnectionLimitReached: boolean;
+```

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

@@ -9,17 +9,9 @@ Represents a WebSocket used to establish a communication channel between client
 **Signature:**
 
 ```typescript
-export interface Socket 
+export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 'reconnectionLimitReached' | 'closedCode' | 'closedReason' | 'closedClean'> 
 ```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [hasValidSession](./foundation-comms.socket.hasvalidsession.md) |  | boolean |  |
-|  [isConnected](./foundation-comms.socket.isconnected.md) |  | boolean |  |
-|  [isConnectedSubject](./foundation-comms.socket.isconnectedsubject.md) |  | BehaviorSubject&lt;boolean&gt; |  |
-|  [isReconnecting](./foundation-comms.socket.isreconnecting.md) |  | boolean |  |
+**Extends:** Omit&lt;[SocketStatus](./foundation-comms.socketstatus.md)<!-- -->, 'serialize' \| 'onClose' \| 'reconnectionLimitReached' \| 'closedCode' \| 'closedReason' \| 'closedClean'&gt;
 
 ## Methods
 
@@ -28,6 +20,6 @@ export interface Socket
 |  [connect(host, options, reconnectOptions)](./foundation-comms.socket.connect.md) |  |
 |  [reset()](./foundation-comms.socket.reset.md) | Disconnects the socket and clears all subscriptions |
 |  [send(message, needsHandling)](./foundation-comms.socket.send.md) |  |
-|  [sendForStream(message, onMessage, onError)](./foundation-comms.socket.sendforstream.md) |  |
+|  [sendForStream(message, onMessage, onError, onComplete)](./foundation-comms.socket.sendforstream.md) |  |
 |  [socketMessages()](./foundation-comms.socket.socketmessages.md) |  |
 

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

@@ -7,7 +7,7 @@
 **Signature:**
 
 ```typescript
-sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
+sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
 ```
 
 ## Parameters
@@ -17,6 +17,7 @@ sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Functi
 |  message | [Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt; |  |
 |  onMessage | Function |  |
 |  onError | Function |  |
+|  onComplete | Function | _(Optional)_ |
 
 **Returns:**
 

package/docs/api/{foundation-comms.socket.isconnectedsubject.md → foundation-comms.socketstatus.isconnectedsubject.md}

@@ -1,8 +1,8 @@
 <!-- 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; [isConnectedSubject](./foundation-comms.socket.isconnectedsubject.md)
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SocketStatus](./foundation-comms.socketstatus.md) &gt; [isConnectedSubject](./foundation-comms.socketstatus.isconnectedsubject.md)
 
-## Socket.isConnectedSubject property
+## SocketStatus.isConnectedSubject property
 
 **Signature:**
 

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

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SocketStatus](./foundation-comms.socketstatus.md)
+
+## SocketStatus interface
+
+`SocketStatus` provides the state of the web socket.
+
+**Signature:**
+
+```typescript
+export interface SocketStatus extends SerializedSocketStatus 
+```
+**Extends:** [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md)
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isConnectedSubject](./foundation-comms.socketstatus.isconnectedsubject.md) |  | BehaviorSubject&lt;boolean&gt; |  |
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [onClose(closeEvent)](./foundation-comms.socketstatus.onclose.md) |  |
+|  [serialize()](./foundation-comms.socketstatus.serialize.md) |  |
+

package/docs/api/foundation-comms.socketstatus.onclose.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; [SocketStatus](./foundation-comms.socketstatus.md) &gt; [onClose](./foundation-comms.socketstatus.onclose.md)
+
+## SocketStatus.onClose() method
+
+**Signature:**
+
+```typescript
+onClose(closeEvent: CloseEvent): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  closeEvent | CloseEvent |  |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.socketstatus.serialize.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SocketStatus](./foundation-comms.socketstatus.md) &gt; [serialize](./foundation-comms.socketstatus.serialize.md)
+
+## SocketStatus.serialize() method
+
+**Signature:**
+
+```typescript
+serialize(): SerializedSocketStatus;
+```
+**Returns:**
+
+[SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md)
+

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

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamCompleteEvent](./foundation-comms.streamcompleteevent.md)
+
+## StreamCompleteEvent type
+
+
+**Signature:**
+
+```typescript
+export type StreamCompleteEvent = CustomEvent<SocketObservable<any>>;
+```
+**References:** [SocketObservable](./foundation-comms.socketobservable.md)
+

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

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamCompleteEventType](./foundation-comms.streamcompleteeventtype.md)
+
+## StreamCompleteEventType variable
+
+
+**Signature:**
+
+```typescript
+StreamCompleteEventType = "connect-stream-complete-event"
+```

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

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamEvent](./foundation-comms.streamevent.md)
+
+## StreamEvent type
+
+
+**Signature:**
+
+```typescript
+export type StreamEvent = CustomEvent<StreamEventDetail>;
+```
+**References:** [StreamEventDetail](./foundation-comms.streameventdetail.md)
+

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

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamEventDetail](./foundation-comms.streameventdetail.md)
+
+## StreamEventDetail type
+
+
+**Signature:**
+
+```typescript
+export type StreamEventDetail = {
+    functions: StreamEventFunctions;
+    message: Message<MessageDetails.DataserverRequest>;
+    resourceName: string;
+    stream: SocketObservable<any>;
+};
+```
+**References:** [StreamEventFunctions](./foundation-comms.streameventfunctions.md)<!-- -->, [Message](./foundation-comms.message.md)<!-- -->, [MessageDetails.DataserverRequest](./foundation-comms.messagedetails.dataserverrequest.md)<!-- -->, [SocketObservable](./foundation-comms.socketobservable.md)
+

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

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamEventFunctions](./foundation-comms.streameventfunctions.md)
+
+## StreamEventFunctions type
+
+
+**Signature:**
+
+```typescript
+export type StreamEventFunctions = {
+    onMessage?: Function;
+    onError?: Function;
+    resourceChecks?: MonitoredResourceChecks;
+    resourceDataLogon?: MonitoredResourceDataLogon;
+};
+```
+**References:** [MonitoredResourceChecks](./foundation-comms.monitoredresourcechecks.md)<!-- -->, [MonitoredResourceDataLogon](./foundation-comms.monitoredresourcedatalogon.md)
+

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

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamEventType](./foundation-comms.streameventtype.md)
+
+## StreamEventType variable
+
+
+**Signature:**
+
+```typescript
+StreamEventType = "connect-stream-event"
+```

package/docs/api/foundation-comms.systemhealthchanged.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; [SystemHealthChanged](./foundation-comms.systemhealthchanged.md)
+
+## SystemHealthChanged variable
+
+SystemHealthChanged.
+
+**Signature:**
+
+```typescript
+SystemHealthChanged = "system-health-changed"
+```

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SystemHealthChangedEvent](./foundation-comms.systemhealthchangedevent.md)
+
+## SystemHealthChangedEvent type
+
+SystemHealthChangedEvent.
+
+**Signature:**
+
+```typescript
+export type SystemHealthChangedEvent = CustomEvent<SystemHealthStatus>;
+```
+**References:** [SystemHealthStatus](./foundation-comms.systemhealthstatus.md)
+

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

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SystemHealthStatus](./foundation-comms.systemhealthstatus.md)
+
+## SystemHealthStatus type
+
+SystemHealthStatus.
+
+**Signature:**
+
+```typescript
+export type SystemHealthStatus = {
+    isOnline: boolean;
+    browserInformation?: Bowser.Parser.ParsedResult;
+    isAuthenticated: boolean;
+    username?: string;
+    isHealthy: boolean;
+    socket: SerializedSocketStatus;
+    resources: Record<string, ResourceHealth>;
+    resourcesAllConnected: boolean;
+    lastUpdated: number;
+    nextUpdate: number;
+    firstUpdated: number;
+    runAllChecks(): void;
+    reportStabilityToGenesis(): Promise<boolean>;
+};
+```
+**References:** [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md)<!-- -->, [ResourceHealth](./foundation-comms.resourcehealth.md)
+

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

@@ -20,4 +20,6 @@ export interface User extends UserOptions
 |  [hasAdminProfile()](./foundation-comms.user.hasadminprofile.md) |  |
 |  [hasPermission(permission)](./foundation-comms.user.haspermission.md) |  |
 |  [hasProfile(profile)](./foundation-comms.user.hasprofile.md) |  |
+|  [set(options)](./foundation-comms.user.set.md) |  |
+|  [unset()](./foundation-comms.user.unset.md) |  |
 

package/docs/api/foundation-comms.user.set.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; [User](./foundation-comms.user.md) &gt; [set](./foundation-comms.user.set.md)
+
+## User.set() method
+
+**Signature:**
+
+```typescript
+set(options: UserOptions): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | UserOptions |  |
+
+**Returns:**
+
+void
+