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

package/docs/api/foundation-comms.getsocket.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; [getSocket](./foundation-comms.getsocket.md)
+
+## getSocket() function
+
+Gets Socket from the DI container.
+
+**Signature:**
+
+```typescript
+export declare function getSocket(): Socket;
+```
+**Returns:**
+
+[Socket](./foundation-comms.socket.md)
+
+## Remarks
+
+A utility method for host applications that are not using decorators or the DI container.
+
+## Example
+
+
+```ts
+import { getSocket } from '@genesislcap/foundation-comms';
+...
+private socket = getSocket();
+```
+

package/docs/api/foundation-comms.getsocketstatus.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; [getSocketStatus](./foundation-comms.getsocketstatus.md)
+
+## getSocketStatus() function
+
+Gets SocketStatus from the DI container.
+
+**Signature:**
+
+```typescript
+export declare function getSocketStatus(): SocketStatus;
+```
+**Returns:**
+
+[SocketStatus](./foundation-comms.socketstatus.md)
+
+## Remarks
+
+A utility method for host applications that are not using decorators or the DI container.
+
+## Example
+
+
+```ts
+import { getSocketStatus } from '@genesislcap/foundation-comms';
+...
+private socketStatus = getSocketStatus();
+```
+

package/docs/api/foundation-comms.md

@@ -13,13 +13,18 @@
 |  [DatasourceDefaults](./foundation-comms.datasourcedefaults.md) | Default values for a DatasourceConfig |
 |  [DefaultAuth](./foundation-comms.defaultauth.md) | The default implementation for the Auth interface. |
 |  [DefaultConnect](./foundation-comms.defaultconnect.md) | The default implementation for the Connect interface (WS-only). |
+|  [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) | Default ConnectEvents implementation. |
 |  [DefaultCredentialManager](./foundation-comms.defaultcredentialmanager.md) | The default implementation for the CredentialManager interface. |
 |  [DefaultDatasource](./foundation-comms.defaultdatasource.md) | The default implementation for the Datasource interface. |
 |  [DefaultFoundationAnalytics](./foundation-comms.defaultfoundationanalytics.md) | The default implementation for the FoundationAnalytics interface. |
 |  [DefaultHttp](./foundation-comms.defaulthttp.md) | The default implementation of the Http interface. |
 |  [DefaultHttpConnect](./foundation-comms.defaulthttpconnect.md) | The default implementation for the Connect interface (HTTP-only). |
+|  [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) | Default MessageBuilder implementation. |
 |  [DefaultMetaCache](./foundation-comms.defaultmetacache.md) | The default implementation for the MetaCache interface. |
+|  [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md) | Default NetworkMonitor implementation. |
 |  [DefaultSession](./foundation-comms.defaultsession.md) | The default implementation for the Session interface. |
+|  [DefaultSocket](./foundation-comms.defaultsocket.md) | Default Socket implementation. |
+|  [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) | Default SocketStatus implementation. |
 |  [SocketMessageHandler](./foundation-comms.socketmessagehandler.md) | The Socket message handler definition. |
 |  [SocketObservable](./foundation-comms.socketobservable.md) | Observable that wraps a WebSocketSubject and provides an Observable interface for sending and receiving messages. |
 |  [SocketSubject](./foundation-comms.socketsubject.md) | Subject that wraps a WebSocketSubject and provides a Subject interface for sending and receiving messages. |
@@ -45,6 +50,9 @@
 |  [dataServerResultFilter(result, rowId)](./foundation-comms.dataserverresultfilter.md) | Data server result filter. |
 |  [getConnect()](./foundation-comms.getconnect.md) | Get Connect from the DI container. |
 |  [getDatasource()](./foundation-comms.getdatasource.md) | Get Datasource from the DI container. |
+|  [getNetworkMonitor()](./foundation-comms.getnetworkmonitor.md) | Gets NetworkMonitor from the DI container. |
+|  [getSocket()](./foundation-comms.getsocket.md) | Gets Socket from the DI container. |
+|  [getSocketStatus()](./foundation-comms.getsocketstatus.md) | Gets SocketStatus from the DI container. |
 |  [normaliseCriteria(criteria, delimiter)](./foundation-comms.normalisecriteria.md) | Normalise criteria. |
 |  [until(conditionFunc, timeoutMs)](./foundation-comms.until.md) | Polls a condition function until it returns true or a timeout is reached. |
 
@@ -55,6 +63,8 @@
 |  [Auth](./foundation-comms.auth.md) | Auth is the main interface for authenticating with a Genesis Server endpoint. |
 |  [Connect](./foundation-comms.connect.md) | Represents a connection and its capabilities on a remote server Provides methods to send and receive messages, as well as metadata and schema information. |
 |  [ConnectConfig](./foundation-comms.connectconfig.md) | Configuration options for the Connect (WS) instance. |
+|  [ConnectEvents](./foundation-comms.connectevents.md) | <code>ConnectEvents</code> provide hooks to respond to specific connect events. |
+|  [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) | <code>ConnectEventsEmitter</code> provide event emitting hooks to Connect. |
 |  [CredentialManager](./foundation-comms.credentialmanager.md) | Represents a system for managing user credentials and authentication tokens. |
 |  [CredentialManagerConfig](./foundation-comms.credentialmanagerconfig.md) | The configuration for the CredentialManager |
 |  [CredentialManagerCookieConfig](./foundation-comms.credentialmanagercookieconfig.md) | The configuration options for the CredentialManager cookie |
@@ -76,10 +86,16 @@
 |  [LogoutResult](./foundation-comms.logoutresult.md) | Represents the result of a user logout operation. |
 |  [MessageBuilder](./foundation-comms.messagebuilder.md) | A utility class for building different types of messages. |
 |  [MetadataCache](./foundation-comms.metadatacache.md) | A Metadata cache definition |
+|  [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md) | MonitoredResourceChecksResult. |
+|  [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md) | MonitoredResourceMetadata. |
+|  [NetworkMonitor](./foundation-comms.networkmonitor.md) | <code>NetworkMonitor</code> monitors network and resource availability and health. |
+|  [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) | NetworkMonitorConfig DI interface. |
 |  [PollingConfiguration](./foundation-comms.pollingconfiguration.md) | Configuration options for http polling. |
+|  [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) | <code>SerializedSocketStatus</code> provides the serialize state of the web socket. |
 |  [Serializer](./foundation-comms.serializer.md) | A Serializer interface for serializing and deserializing objects. |
 |  [Session](./foundation-comms.session.md) | Represents a session storage and its capabilities. Provides methods to set and get items from the specified storage. |
 |  [Socket](./foundation-comms.socket.md) | Represents a WebSocket used to establish a communication channel between client and a Genesis server. Provides methods for socket connection, sending and receiving WS messages. |
+|  [SocketStatus](./foundation-comms.socketstatus.md) | <code>SocketStatus</code> provides the state of the web socket. |
 |  [User](./foundation-comms.user.md) | Represents a User object with associated permissions and profiles. |
 
 ## Namespaces
@@ -93,20 +109,28 @@
 
 |  Variable | Description |
 |  --- | --- |
+|  [CommitEventType](./foundation-comms.commiteventtype.md) |  |
 |  [credentialSeparator](./foundation-comms.credentialseparator.md) | The default separator used for splitting credential parts. |
 |  [defaultConnectConfig](./foundation-comms.defaultconnectconfig.md) | The default configuration for connecting to a WS service. |
 |  [defaultCredentialManagerConfig](./foundation-comms.defaultcredentialmanagerconfig.md) | The default configuration for the CredentialManager service. |
 |  [defaultCredentialRequestOptions](./foundation-comms.defaultcredentialrequestoptions.md) | The default request options for the CredentialManager service. |
 |  [defaultDatasourceConfig](./foundation-comms.defaultdatasourceconfig.md) | The default configuration for the Datasource service. |
 |  [defaultHttpConnectConfig](./foundation-comms.defaulthttpconnectconfig.md) | The default configuration for connecting to an HTTP service. |
+|  [defaultNetworkMonitorConfig](./foundation-comms.defaultnetworkmonitorconfig.md) | Default NetworkMonitorConfig DI implementation. |
 |  [exponentialScheduler](./foundation-comms.exponentialscheduler.md) | Expontential Interval scheduler for reconnect |
 |  [extractFieldDefinitions](./foundation-comms.extractfielddefinitions.md) | Extracts the field definitions from the metadata. |
 |  [isWebSocketExpression](./foundation-comms.iswebsocketexpression.md) | Regular Expression to test valid WebSocket (wss and ws) hosts |
 |  [linearScheduler](./foundation-comms.linearscheduler.md) | Linear Interval scheduler for reconnect |
 |  [logger](./foundation-comms.logger.md) | Logger for the foundation-comms package |
 |  [MAX\_RECONNECT\_ATTEMPTS](./foundation-comms.max_reconnect_attempts.md) | Default number of reconnect attempts |
+|  [messageHasErrorCode](./foundation-comms.messagehaserrorcode.md) | Check if the message contains an error code. |
 |  [messageOrThrow](./foundation-comms.messageorthrow.md) | Check if the provided message contains an error and throw an Error if it does |
+|  [MetadataEventType](./foundation-comms.metadataeventtype.md) |  |
+|  [networkLogger](./foundation-comms.networklogger.md) |  |
 |  [retryInterval](./foundation-comms.retryinterval.md) | Generate reconnect interval based on scheduler |
+|  [StreamCompleteEventType](./foundation-comms.streamcompleteeventtype.md) |  |
+|  [StreamEventType](./foundation-comms.streameventtype.md) |  |
+|  [SystemHealthChanged](./foundation-comms.systemhealthchanged.md) | SystemHealthChanged. |
 |  [toFieldMetadata](./foundation-comms.tofieldmetadata.md) | Converts the field definitions to field metadata. |
 |  [TYPES\_MAP](./foundation-comms.types_map.md) | Types map for FieldTypeEnum. |
 
@@ -117,6 +141,8 @@
 |  [AuthInfo](./foundation-comms.authinfo.md) | Union type of all authentication information types. |
 |  [BasicAuthInfo](./foundation-comms.basicauthinfo.md) | Represents basic authentication information. |
 |  [BasicCredentialsInput](./foundation-comms.basiccredentialsinput.md) | Represents basic credentials for a user. |
+|  [CommitEvent](./foundation-comms.commitevent.md) |  |
+|  [CommitEventDetail](./foundation-comms.commiteventdetail.md) |  |
 |  [CommitParams](./foundation-comms.commitparams.md) | Parameters for a COMMIT message |
 |  [ConnectionStatus](./foundation-comms.connectionstatus.md) | The connection status of the Genesis client. |
 |  [CredentialData\_2](./foundation-comms.credentialdata_2.md) | Represents user credentials. |
@@ -124,6 +150,7 @@
 |  [FDC3Intents](./foundation-comms.fdc3intents.md) |  |
 |  [FieldMetadata](./foundation-comms.fieldmetadata.md) | Field Metadata definition. |
 |  [FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) | Fitlered result after initial DATASERVER data fetch. |
+|  [GenesisConnectEvents](./foundation-comms.genesisconnectevents.md) | Genesis connect events that can be monitored to invoke resource checking. |
 |  [GetCredentialOptions](./foundation-comms.getcredentialoptions.md) | Represents options for retrieving credentials. |
 |  [IndexDetail](./foundation-comms.indexdetail.md) | Index Detail definition. |
 |  [JwtAuthInfo](./foundation-comms.jwtauthinfo.md) | Represents JWT authentication information. |
@@ -133,11 +160,17 @@
 |  [MetaCache](./foundation-comms.metacache.md) | Union type of MetadataCache and JsonSchemaCache |
 |  [Metadata](./foundation-comms.metadata.md) | Metadata definition for a given resource. |
 |  [MetadataDetail](./foundation-comms.metadatadetail.md) | Metadata Detail definition. |
+|  [MetadataEvent](./foundation-comms.metadataevent.md) |  |
+|  [MetadataEventDetail](./foundation-comms.metadataeventdetail.md) |  |
+|  [MonitoredResource](./foundation-comms.monitoredresource.md) | MonitoredResource. |
+|  [MonitoredResourceChecks](./foundation-comms.monitoredresourcechecks.md) | MonitoredResourceChecks. |
+|  [MonitoredResourceDataLogon](./foundation-comms.monitoredresourcedatalogon.md) | MonitoredResourceDataLogon. |
 |  [RawDataServerResult](./foundation-comms.rawdataserverresult.md) | Raw result from a DATASERVER data fetch. |
 |  [RefreshAuthInfo](./foundation-comms.refreshauthinfo.md) | Represents refresh token authentication information. |
 |  [RefreshCredentialsInput](./foundation-comms.refreshcredentialsinput.md) | Represents refresh credentials for a user. |
 |  [RequestParams](./foundation-comms.requestparams.md) | Parameters for a REQUEST message |
 |  [RequestServerResult](./foundation-comms.requestserverresult.md) | Raw result from a REQUEST\_SERVER data fetch. |
+|  [ResourceHealth](./foundation-comms.resourcehealth.md) | ResourceHealth. |
 |  [RowData](./foundation-comms.rowdata.md) | Row Data definition. |
 |  [SchemaResponse](./foundation-comms.schemaresponse.md) | Schema Response definition. |
 |  [ServerRow](./foundation-comms.serverrow.md) | Server Row definition. |
@@ -147,4 +180,10 @@
 |  [SsoAuthInfo](./foundation-comms.ssoauthinfo.md) | Represents SSO authentication information. |
 |  [SSOCredentialsInput](./foundation-comms.ssocredentialsinput.md) | Represents SSO credentials for a user. |
 |  [StorageType](./foundation-comms.storagetype.md) | The available browser storage types. |
+|  [StreamCompleteEvent](./foundation-comms.streamcompleteevent.md) |  |
+|  [StreamEvent](./foundation-comms.streamevent.md) |  |
+|  [StreamEventDetail](./foundation-comms.streameventdetail.md) |  |
+|  [StreamEventFunctions](./foundation-comms.streameventfunctions.md) |  |
+|  [SystemHealthChangedEvent](./foundation-comms.systemhealthchangedevent.md) | SystemHealthChangedEvent. |
+|  [SystemHealthStatus](./foundation-comms.systemhealthstatus.md) | SystemHealthStatus. |
 

package/docs/api/foundation-comms.messagebuilder.createmorecolumnsmessage.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; [MessageBuilder](./foundation-comms.messagebuilder.md) &gt; [createMoreColumnsMessage](./foundation-comms.messagebuilder.createmorecolumnsmessage.md)
+
+## MessageBuilder.createMoreColumnsMessage() method
+
+Creates a message to request more columns.
+
+**Signature:**
+
+```typescript
+createMoreColumnsMessage(sourceRef: string): Message;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  sourceRef | string | The source reference. |
+
+**Returns:**
+
+[Message](./foundation-comms.message.md)
+
+The more columns message.
+
+## Remarks
+
+MORE\_COLUMNS
+

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

@@ -26,6 +26,7 @@ export interface MessageBuilder
 |  [createLoginMessage(credentials)](./foundation-comms.messagebuilder.createloginmessage.md) | Creates a login message. |
 |  [createLogoutMessage(loginResult)](./foundation-comms.messagebuilder.createlogoutmessage.md) | Creates a logout message. |
 |  [createMetaRequestMessage(resourceName, messageType)](./foundation-comms.messagebuilder.createmetarequestmessage.md) | Creates a metadata fetch message. |
+|  [createMoreColumnsMessage(sourceRef)](./foundation-comms.messagebuilder.createmorecolumnsmessage.md) | Creates a message to request more columns. |
 |  [createMoreRowsMessage(sourceRef)](./foundation-comms.messagebuilder.createmorerowsmessage.md) | Creates a message to request more rows. |
 |  [createRefreshTokenMessage()](./foundation-comms.messagebuilder.createrefreshtokenmessage.md) | Creates an auth message specific for token refresh. |
 |  [createRequestMessage(resourceName, params)](./foundation-comms.messagebuilder.createrequestmessage.md) | Creates a request message. |

package/docs/api/foundation-comms.messagehaserrorcode.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; [messageHasErrorCode](./foundation-comms.messagehaserrorcode.md)
+
+## messageHasErrorCode variable
+
+Check if the message contains an error code.
+
+**Signature:**
+
+```typescript
+messageHasErrorCode: (message: Message, code: string | number) => boolean
+```

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

@@ -24,6 +24,8 @@ export declare enum MessageType
 |  LOGON\_NACK | <code>&quot;LOGON_NACK&quot;</code> |  |
 |  LOGOUT\_ACK | <code>&quot;LOGOUT_ACK&quot;</code> |  |
 |  LOGOUT\_NACK | <code>&quot;LOGOUT_NACK&quot;</code> |  |
+|  MORE\_COLUMNS | <code>&quot;MORE_COLUMNS&quot;</code> |  |
+|  MORE\_COLUMNS\_ACK | <code>&quot;MORE_COLUMNS_ACK&quot;</code> |  |
 |  MORE\_ROWS | <code>&quot;MORE_ROWS&quot;</code> |  |
 |  MSG\_ACK | <code>&quot;MSG_ACK&quot;</code> |  |
 |  MSG\_NACK | <code>&quot;MSG_NACK&quot;</code> |  |

package/docs/api/foundation-comms.metadataevent.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; [MetadataEvent](./foundation-comms.metadataevent.md)
+
+## MetadataEvent type
+
+
+**Signature:**
+
+```typescript
+export type MetadataEvent = CustomEvent<MetadataEventDetail>;
+```
+**References:** [MetadataEventDetail](./foundation-comms.metadataeventdetail.md)
+

package/docs/api/foundation-comms.metadataeventdetail.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; [MetadataEventDetail](./foundation-comms.metadataeventdetail.md)
+
+## MetadataEventDetail type
+
+
+**Signature:**
+
+```typescript
+export type MetadataEventDetail = {
+    resourceName: string;
+    message: Message<MessageDetails.MetaRequest>;
+    error?: any;
+};
+```
+**References:** [Message](./foundation-comms.message.md)<!-- -->, [MessageDetails.MetaRequest](./foundation-comms.messagedetails.metarequest.md)
+

package/docs/api/foundation-comms.metadataeventtype.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; [MetadataEventType](./foundation-comms.metadataeventtype.md)
+
+## MetadataEventType variable
+
+
+**Signature:**
+
+```typescript
+MetadataEventType = "connect-metadata-event"
+```

package/docs/api/foundation-comms.monitoredresource.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; [MonitoredResource](./foundation-comms.monitoredresource.md)
+
+## MonitoredResource type
+
+MonitoredResource.
+
+**Signature:**
+
+```typescript
+export type MonitoredResource = SocketObservable<any>;
+```
+**References:** [SocketObservable](./foundation-comms.socketobservable.md)
+

package/docs/api/foundation-comms.monitoredresourcechecks.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; [MonitoredResourceChecks](./foundation-comms.monitoredresourcechecks.md)
+
+## MonitoredResourceChecks type
+
+MonitoredResourceChecks.
+
+**Signature:**
+
+```typescript
+export type MonitoredResourceChecks = (sourceRef: string, resource: MonitoredResource) => Promise<MonitoredResourceChecksResult>;
+```
+**References:** [MonitoredResource](./foundation-comms.monitoredresource.md)<!-- -->, [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md)
+

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

package/docs/api/foundation-comms.monitoredresourcechecksresult.lastmessage.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; [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md) &gt; [lastMessage](./foundation-comms.monitoredresourcechecksresult.lastmessage.md)
+
+## MonitoredResourceChecksResult.lastMessage property
+
+**Signature:**
+
+```typescript
+lastMessage?: Message;
+```

package/docs/api/foundation-comms.monitoredresourcechecksresult.lastupdated.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; [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md) &gt; [lastUpdated](./foundation-comms.monitoredresourcechecksresult.lastupdated.md)
+
+## MonitoredResourceChecksResult.lastUpdated property
+
+**Signature:**
+
+```typescript
+lastUpdated: number;
+```

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md)
+
+## MonitoredResourceChecksResult interface
+
+MonitoredResourceChecksResult.
+
+**Signature:**
+
+```typescript
+export interface MonitoredResourceChecksResult 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isConnected](./foundation-comms.monitoredresourcechecksresult.isconnected.md) |  | boolean |  |
+|  [lastMessage?](./foundation-comms.monitoredresourcechecksresult.lastmessage.md) |  | [Message](./foundation-comms.message.md) | _(Optional)_ |
+|  [lastUpdated](./foundation-comms.monitoredresourcechecksresult.lastupdated.md) |  | number |  |
+|  [timeout?](./foundation-comms.monitoredresourcechecksresult.timeout.md) |  | boolean | _(Optional)_ |
+

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

package/docs/api/foundation-comms.monitoredresourcedatalogon.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; [MonitoredResourceDataLogon](./foundation-comms.monitoredresourcedatalogon.md)
+
+## MonitoredResourceDataLogon type
+
+MonitoredResourceDataLogon.
+
+**Signature:**
+
+```typescript
+export type MonitoredResourceDataLogon = (metadata: MonitoredResourceMetadata) => void;
+```
+**References:** [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md)
+

package/docs/api/foundation-comms.monitoredresourcemetadata.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; [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md)
+
+## MonitoredResourceMetadata interface
+
+MonitoredResourceMetadata.
+
+**Signature:**
+
+```typescript
+export interface MonitoredResourceMetadata extends Partial<MonitoredResourceChecksResult>, Partial<StreamEventDetail> 
+```
+**Extends:** Partial&lt;[MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md)<!-- -->&gt;, Partial&lt;[StreamEventDetail](./foundation-comms.streameventdetail.md)<!-- -->&gt;
+

package/docs/api/foundation-comms.networklogger.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; [networkLogger](./foundation-comms.networklogger.md)
+
+## networkLogger variable
+
+
+**Signature:**
+
+```typescript
+networkLogger: import("@genesislcap/foundation-logger").Logger
+```

package/docs/api/foundation-comms.networkmonitor.addresource.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [addResource](./foundation-comms.networkmonitor.addresource.md)
+
+## NetworkMonitor.addResource() method
+
+**Signature:**
+
+```typescript
+addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resource | [MonitoredResource](./foundation-comms.monitoredresource.md) | The resource reference. |
+|  metadata | [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md) | The resource metadata. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.networkmonitor.create.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; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [create](./foundation-comms.networkmonitor.create.md)
+
+## NetworkMonitor.create() method
+
+**Signature:**
+
+```typescript
+create(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.networkmonitor.destroy.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; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [destroy](./foundation-comms.networkmonitor.destroy.md)
+
+## NetworkMonitor.destroy() method
+
+**Signature:**
+
+```typescript
+destroy(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,34 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitor](./foundation-comms.networkmonitor.md)
+
+## NetworkMonitor interface
+
+`NetworkMonitor` monitors network and resource availability and health.
+
+**Signature:**
+
+```typescript
+export interface NetworkMonitor 
+```
+
+## Remarks
+
+UIs can listen for 'system-health-changed' events and display visual overlays to communicate status to the user.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [status](./foundation-comms.networkmonitor.status.md) |  | [SystemHealthStatus](./foundation-comms.systemhealthstatus.md) |  |
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [addResource(resource, metadata)](./foundation-comms.networkmonitor.addresource.md) |  |
+|  [create()](./foundation-comms.networkmonitor.create.md) |  |
+|  [destroy()](./foundation-comms.networkmonitor.destroy.md) |  |
+|  [removeResource(resource)](./foundation-comms.networkmonitor.removeresource.md) |  |
+|  [runAllChecks(source, force)](./foundation-comms.networkmonitor.runallchecks.md) |  |
+

package/docs/api/foundation-comms.networkmonitor.removeresource.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; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [removeResource](./foundation-comms.networkmonitor.removeresource.md)
+
+## NetworkMonitor.removeResource() method
+
+**Signature:**
+
+```typescript
+removeResource(resource: MonitoredResource): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resource | [MonitoredResource](./foundation-comms.monitoredresource.md) | The resource reference. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.networkmonitor.runallchecks.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [runAllChecks](./foundation-comms.networkmonitor.runallchecks.md)
+
+## NetworkMonitor.runAllChecks() method
+
+**Signature:**
+
+```typescript
+runAllChecks(source?: unknown, force?: boolean): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  source | unknown | _(Optional)_ The source of the call, which may have been an event or scheduled interval. |
+|  force | boolean | _(Optional)_ A flag to bypass abort if already in progress logic. |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/foundation-comms.networkmonitor.status.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; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [status](./foundation-comms.networkmonitor.status.md)
+
+## NetworkMonitor.status property
+
+**Signature:**
+
+```typescript
+status: SystemHealthStatus;
+```

package/docs/api/foundation-comms.networkmonitorconfig.checkinterval.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; [checkInterval](./foundation-comms.networkmonitorconfig.checkinterval.md)
+
+## NetworkMonitorConfig.checkInterval property
+
+Periodic check internal in ms
+
+**Signature:**
+
+```typescript
+checkInterval?: number;
+```

package/docs/api/foundation-comms.networkmonitorconfig.checktimeout.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; [checkTimeout](./foundation-comms.networkmonitorconfig.checktimeout.md)
+
+## NetworkMonitorConfig.checkTimeout property
+
+Check timeout in ms
+
+**Signature:**
+
+```typescript
+checkTimeout?: number;
+```