@genesislcap/foundation-comms 14.225.3 → 14.225.4-alpha-9342136.0

package/docs/api/foundation-comms.keyvaluetransfer.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; [KeyValueTransfer](./foundation-comms.keyvaluetransfer.md)
+
+## KeyValueTransfer interface
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+KeyValueTransfer interface.
+
+**Signature:**
+
+```typescript
+export interface KeyValueTransfer<T> 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [kv](./foundation-comms.keyvaluetransfer.kv.md) |  | [KeyValue](./foundation-comms.keyvalue.md)<!-- -->&lt;T&gt; | **_(ALPHA)_** |
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [deserialize(value)?](./foundation-comms.keyvaluetransfer.deserialize.md) | **_(ALPHA)_** _(Optional)_ |
+|  [serialize(value)?](./foundation-comms.keyvaluetransfer.serialize.md) | **_(ALPHA)_** _(Optional)_ |
+

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [KeyValueTransfer](./foundation-comms.keyvaluetransfer.md) &gt; [serialize](./foundation-comms.keyvaluetransfer.serialize.md)
+
+## KeyValueTransfer.serialize() method
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+serialize?(value: unknown): unknown;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | unknown |  |
+
+**Returns:**
+
+unknown
+

package/docs/api/foundation-comms.kveventfailureresponse.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; [KVEventFailureResponse](./foundation-comms.kveventfailureresponse.md)
+
+## KVEventFailureResponse type
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+KVStorage type.
+
+**Signature:**
+
+```typescript
+export type KVEventFailureResponse = {
+    ERROR?: MessageError[];
+    WARNING: any[];
+};
+```
+**References:** [MessageError](./foundation-comms.messageerror.md)
+

package/docs/api/foundation-comms.kveventmessagetype.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; [KVEventMessageType](./foundation-comms.kveventmessagetype.md)
+
+## KVEventMessageType enum
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+KV Event Message types
+
+**Signature:**
+
+```typescript
+export declare enum KVEventMessageType 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  EVENT\_KEY\_VALUE\_DELETE | <code>&quot;EVENT_KEY_VALUE_DELETE&quot;</code> | **_(ALPHA)_** |
+|  EVENT\_KEY\_VALUE\_PUT | <code>&quot;EVENT_KEY_VALUE_PUT&quot;</code> | **_(ALPHA)_** |
+

package/docs/api/foundation-comms.kvmessagetype.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; [KVMessageType](./foundation-comms.kvmessagetype.md)
+
+## KVMessageType enum
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+KV Message types
+
+**Signature:**
+
+```typescript
+export declare enum KVMessageType 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  REQ\_KEY\_VALUE\_LIST | <code>&quot;REQ_KEY_VALUE_LIST&quot;</code> | **_(ALPHA)_** |
+|  REQ\_KEY\_VALUE\_READ | <code>&quot;REQ_KEY_VALUE_READ&quot;</code> | **_(ALPHA)_** |
+

package/docs/api/foundation-comms.kvstorage.delete.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [KVStorage](./foundation-comms.kvstorage.md) &gt; [delete](./foundation-comms.kvstorage.delete.md)
+
+## KVStorage.delete() method
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+delete(keys: string[]): Promise<true | KVEventFailureResponse>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  keys | string\[\] |  |
+
+**Returns:**
+
+Promise&lt;true \| [KVEventFailureResponse](./foundation-comms.kveventfailureresponse.md)<!-- -->&gt;
+

package/docs/api/foundation-comms.kvstorage.get.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; [KVStorage](./foundation-comms.kvstorage.md) &gt; [get](./foundation-comms.kvstorage.get.md)
+
+## KVStorage.get() method
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+get<T = KVValue>(): Promise<KeyValueTransfer<T>[]>;
+```
+**Returns:**
+
+Promise&lt;[KeyValueTransfer](./foundation-comms.keyvaluetransfer.md)<!-- -->&lt;T&gt;\[\]&gt;
+

package/docs/api/foundation-comms.kvstorage.get_1.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [KVStorage](./foundation-comms.kvstorage.md) &gt; [get](./foundation-comms.kvstorage.get_1.md)
+
+## KVStorage.get() method
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+get<T = KVValue>(key: string): Promise<KeyValueTransfer<T>>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  key | string |  |
+
+**Returns:**
+
+Promise&lt;[KeyValueTransfer](./foundation-comms.keyvaluetransfer.md)<!-- -->&lt;T&gt;&gt;
+

package/docs/api/foundation-comms.kvstorage.list.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; [KVStorage](./foundation-comms.kvstorage.md) &gt; [list](./foundation-comms.kvstorage.list.md)
+
+## KVStorage.list() method
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+list(): Promise<string[]>;
+```
+**Returns:**
+
+Promise&lt;string\[\]&gt;
+

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

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [KVStorage](./foundation-comms.kvstorage.md)
+
+## KVStorage interface
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Represents a KV (key-value) data storage and its capabilities. Provides methods to set and get items from the KV data storage.
+
+**Signature:**
+
+```typescript
+export interface KVStorage 
+```
+
+## Remarks
+
+Provides a key value storage api that abstracts the underlying storage technology.
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [delete(keys)](./foundation-comms.kvstorage.delete.md) | **_(ALPHA)_** |
+|  [get()](./foundation-comms.kvstorage.get.md) | **_(ALPHA)_** |
+|  [get(key)](./foundation-comms.kvstorage.get_1.md) | **_(ALPHA)_** |
+|  [list()](./foundation-comms.kvstorage.list.md) | **_(ALPHA)_** |
+|  [put(kvs)](./foundation-comms.kvstorage.put.md) | **_(ALPHA)_** |
+

package/docs/api/foundation-comms.kvstorage.put.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [KVStorage](./foundation-comms.kvstorage.md) &gt; [put](./foundation-comms.kvstorage.put.md)
+
+## KVStorage.put() method
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+put(kvs: KeyValue<KVValue>[]): Promise<true | KVEventFailureResponse>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  kvs | [KeyValue](./foundation-comms.keyvalue.md)<!-- -->&lt;[KVValue](./foundation-comms.kvvalue.md)<!-- -->&gt;\[\] |  |
+
+**Returns:**
+
+Promise&lt;true \| [KVEventFailureResponse](./foundation-comms.kveventfailureresponse.md)<!-- -->&gt;
+

package/docs/api/foundation-comms.kvstorageconfig.account.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [KVStorageConfig](./foundation-comms.kvstorageconfig.md) &gt; [account](./foundation-comms.kvstorageconfig.account.md)
+
+## KVStorageConfig.account property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+The account id to use.
+
+**Signature:**
+
+```typescript
+account?: string;
+```

package/docs/api/foundation-comms.kvstorageconfig.authemail.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; [KVStorageConfig](./foundation-comms.kvstorageconfig.md) &gt; [authEmail](./foundation-comms.kvstorageconfig.authemail.md)
+
+## KVStorageConfig.authEmail property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Access control auth email.
+
+**Signature:**
+
+```typescript
+authEmail?: string;
+```
+
+## Remarks
+
+Part of access requirements and where to report integration issues.
+

package/docs/api/foundation-comms.kvstorageconfig.authkey.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [KVStorageConfig](./foundation-comms.kvstorageconfig.md) &gt; [authKey](./foundation-comms.kvstorageconfig.authkey.md)
+
+## KVStorageConfig.authKey property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Access control auth key.
+
+**Signature:**
+
+```typescript
+authKey?: string;
+```

package/docs/api/foundation-comms.kvstorageconfig.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; [KVStorageConfig](./foundation-comms.kvstorageconfig.md)
+
+## KVStorageConfig interface
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+KVStorageConfig DI interface.
+
+**Signature:**
+
+```typescript
+export interface KVStorageConfig 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [account?](./foundation-comms.kvstorageconfig.account.md) |  | string | **_(ALPHA)_** _(Optional)_ The account id to use. |
+|  [authEmail?](./foundation-comms.kvstorageconfig.authemail.md) |  | string | **_(ALPHA)_** _(Optional)_ Access control auth email. |
+|  [authKey?](./foundation-comms.kvstorageconfig.authkey.md) |  | string | **_(ALPHA)_** _(Optional)_ Access control auth key. |
+|  [namespace?](./foundation-comms.kvstorageconfig.namespace.md) |  | string | **_(ALPHA)_** _(Optional)_ The namespace to use. |
+

package/docs/api/foundation-comms.kvstorageconfig.namespace.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [KVStorageConfig](./foundation-comms.kvstorageconfig.md) &gt; [namespace](./foundation-comms.kvstorageconfig.namespace.md)
+
+## KVStorageConfig.namespace property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+The namespace to use.
+
+**Signature:**
+
+```typescript
+namespace?: string;
+```

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

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [KVValue](./foundation-comms.kvvalue.md)
+
+## KVValue type
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+KVValue type.
+
+**Signature:**
+
+```typescript
+export type KVValue = string | ArrayBuffer;
+```

package/docs/api/foundation-comms.md

@@ -16,10 +16,12 @@
 |  [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. |
+|  [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) | **_(ALPHA)_** Default EntityDatasource DI implementation. |
 |  [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). |
+|  [DefaultKVStorage](./foundation-comms.defaultkvstorage.md) | **_(ALPHA)_** The default implementation for the KVStorage interface. |
 |  [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. |
@@ -39,6 +41,8 @@
 |  [EventMessageType](./foundation-comms.eventmessagetype.md) | Event Message types |
 |  [FieldTypeEnum](./foundation-comms.fieldtypeenum.md) | Available types for a field metadata. |
 |  [FoundationAnalyticsEventType](./foundation-comms.foundationanalyticseventtype.md) | Analytics event types |
+|  [KVEventMessageType](./foundation-comms.kveventmessagetype.md) | **_(ALPHA)_** KV Event Message types |
+|  [KVMessageType](./foundation-comms.kvmessagetype.md) | **_(ALPHA)_** KV Message types |
 |  [MessageCode](./foundation-comms.messagecode.md) | General Message codes |
 |  [MessageType](./foundation-comms.messagetype.md) | General Message types |
 |  [ResourceType](./foundation-comms.resourcetype.md) | Types of Genesis resources. |
@@ -50,6 +54,8 @@
 |  --- | --- |
 |  [criteriaFiltersToFields(filters)](./foundation-comms.criteriafilterstofields.md) | Criteria filters to fields. |
 |  [dataServerResultFilter(result, rowId)](./foundation-comms.dataserverresultfilter.md) | Data server result filter. |
+|  [DatasourceEventHandler(Target)](./foundation-comms.datasourceeventhandler.md) | Datasource event handler mixin for target classes that use or are interested in datasource status changes. |
+|  [extractFieldDefinitions(metadata)](./foundation-comms.extractfielddefinitions.md) | Extracts the field definitions from the metadata. |
 |  [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. |
@@ -58,7 +64,11 @@
 |  [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. |
+|  [messageHasErrorCode(message, code)](./foundation-comms.messagehaserrorcode.md) | Check if the message contains an error code. |
+|  [messageOrThrow(message)](./foundation-comms.messageorthrow.md) | Check if the provided message contains an error and throw an Error if it does |
 |  [normaliseCriteria(criteria, delimiter)](./foundation-comms.normalisecriteria.md) | Normalise criteria. |
+|  [retryInterval(reconnectOptions, scheduler)](./foundation-comms.retryinterval.md) | Generate reconnect interval based on scheduler |
+|  [toFieldMetadata(fieldDef)](./foundation-comms.tofieldmetadata.md) | Converts the field definitions to field metadata. |
 |  [until(conditionFunc, timeoutMs)](./foundation-comms.until.md) | Polls a condition function until it returns true or a timeout is reached. |
 
 ## Interfaces
@@ -79,6 +89,8 @@
 |  [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 |
+|  [EntityDatasource](./foundation-comms.entitydatasource.md) | **_(ALPHA)_** EntityDatasource DI interface. |
+|  [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md) | **_(ALPHA)_** EntityDatasourceInit interface. |
 |  [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. |
@@ -86,6 +98,10 @@
 |  [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 |
+|  [KeyValue](./foundation-comms.keyvalue.md) | **_(ALPHA)_** KeyValue interface. |
+|  [KeyValueTransfer](./foundation-comms.keyvaluetransfer.md) | **_(ALPHA)_** KeyValueTransfer interface. |
+|  [KVStorage](./foundation-comms.kvstorage.md) | **_(ALPHA)_** Represents a KV (key-value) data storage and its capabilities. Provides methods to set and get items from the KV data storage. |
+|  [KVStorageConfig](./foundation-comms.kvstorageconfig.md) | **_(ALPHA)_** KVStorageConfig DI interface. |
 |  [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 |
@@ -113,31 +129,26 @@
 |  --- | --- |
 |  [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) | Default DatasourceConfig DI implementation. |
 |  [defaultGenesisResourcesConfig](./foundation-comms.defaultgenesisresourcesconfig.md) | Default GenesisResourcesConfig implementation. |
+|  [defaultKVStorageConfig](./foundation-comms.defaultkvstorageconfig.md) | **_(ALPHA)_** The default configuration for the KVStorage 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. |
 |  [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 |
 |  [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) |  |
 |  [StreamErrorEventType](./foundation-comms.streamerroreventtype.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. |
 
 ## Type Aliases
@@ -162,6 +173,8 @@
 |  [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. |
+|  [KVEventFailureResponse](./foundation-comms.kveventfailureresponse.md) | **_(ALPHA)_** KVStorage type. |
+|  [KVValue](./foundation-comms.kvvalue.md) | **_(ALPHA)_** KVValue type. |
 |  [LoginResult](./foundation-comms.loginresult.md) | Represents the result of a user login operation. |
 |  [Message](./foundation-comms.message.md) | Base Message type for all DETAIL variants |
 |  [MessageError](./foundation-comms.messageerror.md) | Error definition for a message result |

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

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [messageHasErrorCode](./foundation-comms.messagehaserrorcode.md)
 
-## messageHasErrorCode variable
+## messageHasErrorCode() function
 
 Check if the message contains an error code.
 
@@ -11,3 +11,15 @@ Check if the message contains an error code.
 ```typescript
 messageHasErrorCode: (message: Message, code: string | number) => boolean
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  message | [Message](./foundation-comms.message.md) | The message object. |
+|  code | string \| number | The error code. Either a  number or an entire status code string. |
+
+**Returns:**
+
+boolean
+

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

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [messageOrThrow](./foundation-comms.messageorthrow.md)
 
-## messageOrThrow variable
+## messageOrThrow() function
 
 Check if the provided message contains an error and throw an Error if it does
 
@@ -11,3 +11,16 @@ Check if the provided message contains an error and throw an Error if it does
 ```typescript
 messageOrThrow: (message: Message) => Message<any>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  message | [Message](./foundation-comms.message.md) | Message to check for errors |
+
+**Returns:**
+
+[Message](./foundation-comms.message.md)<!-- -->&lt;any&gt;
+
+The message if no errors are present, otherwise throws an Error
+

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

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [retryInterval](./foundation-comms.retryinterval.md)
 
-## retryInterval variable
+## retryInterval() function
 
 Generate reconnect interval based on scheduler
 
@@ -11,3 +11,17 @@ Generate reconnect interval based on scheduler
 ```typescript
 retryInterval: (reconnectOptions: SocketReconnectOptions, scheduler: SocketReconnectScheduler) => Observable<number>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  reconnectOptions | [SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md) | [SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md) options |
+|  scheduler | [SocketReconnectScheduler](./foundation-comms.socketreconnectscheduler.md) | [SocketReconnectScheduler](./foundation-comms.socketreconnectscheduler.md) function |
+
+**Returns:**
+
+Observable&lt;number&gt;
+
+Observable<number>
+

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

@@ -27,5 +27,6 @@ export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 're
 |  [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, onComplete)](./foundation-comms.socket.sendforstream.md) |  |
+|  [sendForStreamWithoutTeardown(message, onMessage, onError)](./foundation-comms.socket.sendforstreamwithoutteardown.md) | **_(ALPHA)_** Sends a message and returns an observable that emits messages received from the server. |
 |  [socketMessages()](./foundation-comms.socket.socketmessages.md) |  |
 

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

@@ -0,0 +1,31 @@
+<!-- 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; [sendForStreamWithoutTeardown](./foundation-comms.socket.sendforstreamwithoutteardown.md)
+
+## Socket.sendForStreamWithoutTeardown() method
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Sends a message and returns an observable that emits messages received from the server.
+
+**Signature:**
+
+```typescript
+sendForStreamWithoutTeardown<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt; | The message to send. |
+|  onMessage | Function | The function to call when a message is received. |
+|  onError | Function | The function to call when an error is received. |
+
+**Returns:**
+
+Observable&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
+
+An observable that emits messages received from the server.
+

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

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [toFieldMetadata](./foundation-comms.tofieldmetadata.md)
 
-## toFieldMetadata variable
+## toFieldMetadata() function
 
 Converts the field definitions to field metadata.
 
@@ -11,3 +11,16 @@ Converts the field definitions to field metadata.
 ```typescript
 toFieldMetadata: (fieldDef: MetadataDetail[]) => FieldMetadata[]
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fieldDef | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | The field definitions. |
+
+**Returns:**
+
+[FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\]
+
+An array of field metadata.
+