@genesislcap/foundation-comms 14.187.1 → 14.188.0

package/docs/api/foundation-comms.genesisresources.isvalidresource.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; [GenesisResources](./foundation-comms.genesisresources.md) &gt; [isValidResource](./foundation-comms.genesisresources.isvalidresource.md)
+
+## GenesisResources.isValidResource property
+
+Checks if the resource exists
+
+**Signature:**
+
+```typescript
+isValidResource: (resourceName: string) => Promise<boolean>;
+```

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResources](./foundation-comms.genesisresources.md)
+
+## GenesisResources interface
+
+GenesisResources DI interface.
+
+**Signature:**
+
+```typescript
+export interface GenesisResources 
+```
+
+## Remarks
+
+A lazy shared Genesis Resources lookup system. N number of callers can request information in succession, but only the first will invoke the server request, and each caller will receive their results when that returns.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [destroy](./foundation-comms.genesisresources.destroy.md) |  | () =&gt; void | Destroy and garbage collect |
+|  [getResourceTypeFor](./foundation-comms.genesisresources.getresourcetypefor.md) |  | (resourceName: string) =&gt; Promise&lt;[ResourceType](./foundation-comms.resourcetype.md)<!-- -->&gt; | Gets the type of resource |
+|  [isValidResource](./foundation-comms.genesisresources.isvalidresource.md) |  | (resourceName: string) =&gt; Promise&lt;boolean&gt; | Checks if the resource exists |
+

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

@@ -0,0 +1,33 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesChannel](./foundation-comms.genesisresourceschannel.md)
+
+## GenesisResourcesChannel interface
+
+GenesisResourcesChannel DI interface.
+
+**Signature:**
+
+```typescript
+export interface GenesisResourcesChannel extends TypedBroadcastChannel<GenesisResourcesEvents> 
+```
+**Extends:** TypedBroadcastChannel&lt;[GenesisResourcesEvents](./foundation-comms.genesisresourcesevents.md)<!-- -->&gt;
+
+## Example
+
+
+```ts
+import { GenesisResourcesChannel } from '@genesislcap/foundation-comms';
+...
+@GenesisResourcesChannel protected channel: GenesisResourcesChannel;
+...
+this.channel.onmessage = (e) => {
+ if (this.channel.isMessageType('resources-loaded', e)) {
+   logger.debug('resources-loaded', e.data.detail);
+   return;
+ }
+}
+...
+this.channel.close();
+```
+

package/docs/api/foundation-comms.genesisresourceschannelid.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; [GenesisResourcesChannelId](./foundation-comms.genesisresourceschannelid.md)
+
+## GenesisResourcesChannelId variable
+
+
+**Signature:**
+
+```typescript
+GenesisResourcesChannelId = "genesis-resources"
+```

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md)
+
+## GenesisResourcesConfig interface
+
+GenesisResourcesConfig DI interface.
+
+**Signature:**
+
+```typescript
+export interface GenesisResourcesConfig 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [throwWhenUnavailable?](./foundation-comms.genesisresourcesconfig.throwwhenunavailable.md) |  | boolean | _(Optional)_ Treat unavailable/empty genesis resource sets as fatal errors. |
+|  [throwWhenUnknown?](./foundation-comms.genesisresourcesconfig.throwwhenunknown.md) |  | boolean | _(Optional)_ Treat unknown resources as fatal errors. |
+

package/docs/api/foundation-comms.genesisresourcesconfig.throwwhenunavailable.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; [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md) &gt; [throwWhenUnavailable](./foundation-comms.genesisresourcesconfig.throwwhenunavailable.md)
+
+## GenesisResourcesConfig.throwWhenUnavailable property
+
+Treat unavailable/empty genesis resource sets as fatal errors.
+
+**Signature:**
+
+```typescript
+throwWhenUnavailable?: boolean;
+```

package/docs/api/foundation-comms.genesisresourcesconfig.throwwhenunknown.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; [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md) &gt; [throwWhenUnknown](./foundation-comms.genesisresourcesconfig.throwwhenunknown.md)
+
+## GenesisResourcesConfig.throwWhenUnknown property
+
+Treat unknown resources as fatal errors.
+
+**Signature:**
+
+```typescript
+throwWhenUnknown?: boolean;
+```

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesEvents](./foundation-comms.genesisresourcesevents.md)
+
+## GenesisResourcesEvents type
+
+
+**Signature:**
+
+```typescript
+export type GenesisResourcesEvents = {
+    'resources-loaded': ResourceItem[];
+    'resources-unloaded': void;
+};
+```
+**References:** [ResourceItem](./foundation-comms.resourceitem.md)
+

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

package/docs/api/foundation-comms.genesisresourcesmock.getresourcetypefor.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [getResourceTypeFor](./foundation-comms.genesisresourcesmock.getresourcetypefor.md)
+
+## GenesisResourcesMock.getResourceTypeFor() method
+
+Gets the type of resource
+
+**Signature:**
+
+```typescript
+getResourceTypeFor(resourceName: string): Promise<ResourceType>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource to get the type for. |
+
+**Returns:**
+
+Promise&lt;[ResourceType](./foundation-comms.resourcetype.md)<!-- -->&gt;
+

package/docs/api/foundation-comms.genesisresourcesmock.isvalidresource.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [isValidResource](./foundation-comms.genesisresourcesmock.isvalidresource.md)
+
+## GenesisResourcesMock.isValidResource() method
+
+Checks if the resource exists
+
+**Signature:**
+
+```typescript
+isValidResource(resourceName: string): Promise<boolean>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource to check. |
+
+**Returns:**
+
+Promise&lt;boolean&gt;
+

package/docs/api/foundation-comms.genesisresourcesmock.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; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md)
+
+## GenesisResourcesMock class
+
+
+**Signature:**
+
+```typescript
+export declare class GenesisResourcesMock implements GenesisResources 
+```
+**Implements:** [GenesisResources](./foundation-comms.genesisresources.md)
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [nextIsValidResourceResponse](./foundation-comms.genesisresourcesmock.nextisvalidresourceresponse.md) |  | boolean |  |
+|  [nextResourceTypeForResponse](./foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.md) |  | [ResourceType](./foundation-comms.resourcetype.md) |  |
+|  [resources](./foundation-comms.genesisresourcesmock.resources.md) |  | [ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\] |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [destroy()](./foundation-comms.genesisresourcesmock.destroy.md) |  |  |
+|  [getResourceTypeFor(resourceName)](./foundation-comms.genesisresourcesmock.getresourcetypefor.md) |  | Gets the type of resource |
+|  [isValidResource(resourceName)](./foundation-comms.genesisresourcesmock.isvalidresource.md) |  | Checks if the resource exists |
+

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

package/docs/api/foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.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; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [nextResourceTypeForResponse](./foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.md)
+
+## GenesisResourcesMock.nextResourceTypeForResponse property
+
+**Signature:**
+
+```typescript
+nextResourceTypeForResponse: ResourceType;
+```

package/docs/api/foundation-comms.genesisresourcesmock.resources.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; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [resources](./foundation-comms.genesisresourcesmock.resources.md)
+
+## GenesisResourcesMock.resources property
+
+**Signature:**
+
+```typescript
+resources: ResourceItem[];
+```

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

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

@@ -0,0 +1,39 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [getGenesisResourcesChannel](./foundation-comms.getgenesisresourceschannel.md)
+
+## getGenesisResourcesChannel() function
+
+Gets GenesisResourcesChannel from the DI container.
+
+**Signature:**
+
+```typescript
+export declare function getGenesisResourcesChannel(): GenesisResourcesChannel;
+```
+**Returns:**
+
+[GenesisResourcesChannel](./foundation-comms.genesisresourceschannel.md)
+
+## Remarks
+
+A utility method for host applications that are not using decorators or the DI container.
+
+## Example
+
+
+```ts
+import { getGenesisResourcesChannel } from '@genesislcap/foundation-comms';
+...
+const channel = getGenesisResourcesChannel();
+...
+channel.onmessage = (e) => {
+ if (channel.isMessageType('resources-loaded', e)) {
+   logger.debug('resources-loaded', e.data.detail);
+   return;
+ }
+}
+...
+channel.close();
+```
+

package/docs/api/foundation-comms.md

@@ -17,6 +17,7 @@
 |  [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. |
+|  [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) | Default GenesisResources implementation. |
 |  [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. |
@@ -25,6 +26,7 @@
 |  [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. |
+|  [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) |  |
 |  [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. |
@@ -50,6 +52,8 @@
 |  [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. |
+|  [getGenesisResources()](./foundation-comms.getgenesisresources.md) | Gets GenesisResources from the DI container. |
+|  [getGenesisResourcesChannel()](./foundation-comms.getgenesisresourceschannel.md) | Gets GenesisResourcesChannel from the DI container. |
 |  [getKVStorage()](./foundation-comms.getkvstorage.md) | Gets KVStorage 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. |
@@ -70,11 +74,15 @@
 |  [CredentialManagerConfig](./foundation-comms.credentialmanagerconfig.md) | The configuration for the CredentialManager |
 |  [CredentialManagerCookieConfig](./foundation-comms.credentialmanagercookieconfig.md) | The configuration options for the CredentialManager cookie |
 |  [Datasource](./foundation-comms.datasource.md) | Datasource interface. |
-|  [DatasourceConfig](./foundation-comms.datasourceconfig.md) | The configuration object for a Datasource |
+|  [DatasourceConfig](./foundation-comms.datasourceconfig.md) | DatasourceConfig DI interface. |
+|  [DatasourceMetadata](./foundation-comms.datasourcemetadata.md) | DatasourceMetadata interface. |
 |  [DatasourceOptions](./foundation-comms.datasourceoptions.md) | Options that can be passed when initializing a datasource. |
 |  [DataUpdate](./foundation-comms.dataupdate.md) | Data Update definition with details of what data to add, drop, and/or modify. |
 |  [Dataview](./foundation-comms.dataview.md) | Dataview object |
 |  [FoundationAnalytics](./foundation-comms.foundationanalytics.md) | Represents an analytics tracking system. |
+|  [GenesisResources](./foundation-comms.genesisresources.md) | GenesisResources DI interface. |
+|  [GenesisResourcesChannel](./foundation-comms.genesisresourceschannel.md) | GenesisResourcesChannel DI interface. |
+|  [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md) | GenesisResourcesConfig DI interface. |
 |  [Http](./foundation-comms.http.md) | An interface representing an HTTP client that can make GET and POST requests and return a promise with the response data. |
 |  [HttpRequestInit](./foundation-comms.httprequestinit.md) | The options object used when making an HTTP request. |
 |  [JsonSchemaCache](./foundation-comms.jsonschemacache.md) | A JSON schema cache definition |
@@ -105,13 +113,17 @@
 |  --- | --- |
 |  [CommitEventType](./foundation-comms.commiteventtype.md) |  |
 |  [credentialSeparator](./foundation-comms.credentialseparator.md) | The default separator used for splitting credential parts. |
+|  [DatasourceEventHandler](./foundation-comms.datasourceeventhandler.md) | Datasource event handler mixin for target classes that use or are interested in datasource status changes. |
+|  [DatasourceStatusChanged](./foundation-comms.datasourcestatuschanged.md) | DatasourceStatusChanged. |
 |  [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. |
+|  [defaultDatasourceConfig](./foundation-comms.defaultdatasourceconfig.md) | Default DatasourceConfig DI implementation. |
+|  [defaultGenesisResourcesConfig](./foundation-comms.defaultgenesisresourcesconfig.md) | Default GenesisResourcesConfig implementation. |
 |  [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. |
+|  [GenesisResourcesChannelId](./foundation-comms.genesisresourceschannelid.md) |  |
 |  [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 |
@@ -140,9 +152,12 @@
 |  [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. |
+|  [DatasourceStatus](./foundation-comms.datasourcestatus.md) | DatasourceStatus. |
+|  [DatasourceStatusChangedEvent](./foundation-comms.datasourcestatuschangedevent.md) | DatasourceStatusChangedEvent. |
 |  [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. |
+|  [GenesisResourcesEvents](./foundation-comms.genesisresourcesevents.md) |  |
 |  [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. |
@@ -165,6 +180,8 @@
 |  [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. |
+|  [ResourceItem](./foundation-comms.resourceitem.md) |  |
+|  [ResourcesMessage](./foundation-comms.resourcesmessage.md) |  |
 |  [RowData](./foundation-comms.rowdata.md) | Row Data definition. |
 |  [SchemaResponse](./foundation-comms.schemaresponse.md) | Schema Response definition. |
 |  [ServerRow](./foundation-comms.serverrow.md) | Server Row definition. |

package/docs/api/foundation-comms.resourceitem.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; [ResourceItem](./foundation-comms.resourceitem.md)
+
+## ResourceItem type
+
+
+**Signature:**
+
+```typescript
+export type ResourceItem = {
+    RESOURCE_NAME: string;
+    RESOURCE_TYPE: string;
+};
+```

package/docs/api/foundation-comms.resourcesmessage.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; [ResourcesMessage](./foundation-comms.resourcesmessage.md)
+
+## ResourcesMessage type
+
+
+**Signature:**
+
+```typescript
+export type ResourcesMessage = {
+    MESSAGE_TYPE: EventMessageType.RESOURCES_REQUEST_ACK | EventMessageType.RESOURCES_REQUEST_NACK | MessageType.MSG_NACK;
+    SOURCE_REF: string;
+    RESOURCES: ResourceItem[];
+};
+```
+**References:** [EventMessageType.RESOURCES\_REQUEST\_ACK](./foundation-comms.eventmessagetype.md)<!-- -->, [EventMessageType.RESOURCES\_REQUEST\_NACK](./foundation-comms.eventmessagetype.md)<!-- -->, [MessageType.MSG\_NACK](./foundation-comms.messagetype.md)<!-- -->, [ResourceItem](./foundation-comms.resourceitem.md)
+

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

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

@@ -13,6 +13,12 @@ export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 're
 ```
 **Extends:** Omit&lt;[SocketStatus](./foundation-comms.socketstatus.md)<!-- -->, 'serialize' \| 'onClose' \| 'reconnectionLimitReached' \| 'closedCode' \| 'closedReason' \| 'closedClean'&gt;
 
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [host](./foundation-comms.socket.host.md) |  | string |  |
+
 ## Methods
 
 |  Method | Description |