@genesislcap/foundation-comms 14.237.1 → 14.237.2-alpha-78ebbc0.0

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

@@ -0,0 +1,38 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md)
+
+## DefaultEntityDatasource class
+
+> 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.
+> 
+
+Default EntityDatasource DI implementation.
+
+**Signature:**
+
+```typescript
+export declare class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatasource implements EntityDatasource<TDTO, TEntity> 
+```
+**Extends:** [DefaultDatasource](./foundation-comms.defaultdatasource.md)
+
+**Implements:** [EntityDatasource](./foundation-comms.entitydatasource.md)<!-- -->&lt;TDTO, TEntity&gt;
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [\_initialized](./foundation-comms.defaultentitydatasource._initialized.md) | <code>protected</code> | boolean | **_(ALPHA)_** |
+|  [cache](./foundation-comms.defaultentitydatasource.cache.md) | <code>readonly</code> | TEntity\[\] | **_(ALPHA)_** |
+|  [disconnect](./foundation-comms.defaultentitydatasource.disconnect.md) |  | () =&gt; void | **_(ALPHA)_** |
+|  [entityCache](./foundation-comms.defaultentitydatasource.entitycache.md) | <code>protected</code> | TEntity\[\] | **_(ALPHA)_** |
+|  [entityMap](./foundation-comms.defaultentitydatasource.entitymap.md) | <code>protected</code> | Map&lt;string, TEntity&gt; | **_(ALPHA)_** |
+|  [initialize](./foundation-comms.defaultentitydatasource.initialize.md) |  | (init: [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md)<!-- -->&lt;TDTO, TEntity&gt;) =&gt; Promise&lt;boolean&gt; | **_(ALPHA)_** |
+|  [initialized](./foundation-comms.defaultentitydatasource.initialized.md) |  | boolean | **_(ALPHA)_** |
+|  [isEmpty](./foundation-comms.defaultentitydatasource.isempty.md) | <code>readonly</code> | boolean | **_(ALPHA)_** |
+|  [mapper](./foundation-comms.defaultentitydatasource.mapper.md) | <code>protected</code> | DTOMapper&lt;TDTO, TEntity&gt; | **_(ALPHA)_** |
+|  [rowId](./foundation-comms.defaultentitydatasource.rowid.md) | <code>protected</code> | string | **_(ALPHA)_** |
+|  [sourceRef](./foundation-comms.defaultentitydatasource.sourceref.md) | <code>protected</code> | string | **_(ALPHA)_** |
+|  [subscription](./foundation-comms.defaultentitydatasource.subscription.md) | <code>protected</code> | SocketSubscription | **_(ALPHA)_** |
+|  [subscriptionLoggedOff](./foundation-comms.defaultentitydatasource.subscriptionloggedoff.md) | <code>protected</code> | boolean | **_(ALPHA)_** |
+

package/docs/api/foundation-comms.defaultentitydatasource.rowid.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; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [rowId](./foundation-comms.defaultentitydatasource.rowid.md)
+
+## DefaultEntityDatasource.rowId 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.
+> 
+
+**Signature:**
+
+```typescript
+protected rowId: string;
+```

package/docs/api/foundation-comms.defaultentitydatasource.sourceref.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; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [sourceRef](./foundation-comms.defaultentitydatasource.sourceref.md)
+
+## DefaultEntityDatasource.sourceRef 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.
+> 
+
+**Signature:**
+
+```typescript
+protected sourceRef: string;
+```

package/docs/api/foundation-comms.defaultentitydatasource.subscription.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; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [subscription](./foundation-comms.defaultentitydatasource.subscription.md)
+
+## DefaultEntityDatasource.subscription 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.
+> 
+
+**Signature:**
+
+```typescript
+protected subscription: SocketSubscription;
+```

package/docs/api/foundation-comms.defaultentitydatasource.subscriptionloggedoff.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; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [subscriptionLoggedOff](./foundation-comms.defaultentitydatasource.subscriptionloggedoff.md)
+
+## DefaultEntityDatasource.subscriptionLoggedOff 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.
+> 
+
+**Signature:**
+
+```typescript
+protected subscriptionLoggedOff: boolean;
+```

package/docs/api/foundation-comms.defaultkvstorage._constructor_.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; [DefaultKVStorage](./foundation-comms.defaultkvstorage.md) &gt; [(constructor)](./foundation-comms.defaultkvstorage._constructor_.md)
+
+## DefaultKVStorage.(constructor)
+
+> 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.
+> 
+
+Constructs a new instance of the `DefaultKVStorage` class
+
+**Signature:**
+
+```typescript
+constructor(connect: Connect, user: User, kvStorageConfig?: KVStorageConfig);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  connect | [Connect](./foundation-comms.connect.md) |  |
+|  user | User |  |
+|  kvStorageConfig | [KVStorageConfig](./foundation-comms.kvstorageconfig.md) | _(Optional)_ |
+

package/docs/api/foundation-comms.defaultkvstorage.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; [DefaultKVStorage](./foundation-comms.defaultkvstorage.md)
+
+## DefaultKVStorage class
+
+> 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 default implementation for the KVStorage interface.
+
+**Signature:**
+
+```typescript
+export declare class DefaultKVStorage implements KVStorage 
+```
+**Implements:** [KVStorage](./foundation-comms.kvstorage.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(connect, user, kvStorageConfig)](./foundation-comms.defaultkvstorage._constructor_.md) |  | **_(ALPHA)_** Constructs a new instance of the <code>DefaultKVStorage</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [user](./foundation-comms.defaultkvstorage.user.md) | <code>protected</code> | User | **_(ALPHA)_** |
+

package/docs/api/foundation-comms.defaultkvstorage.user.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; [DefaultKVStorage](./foundation-comms.defaultkvstorage.md) &gt; [user](./foundation-comms.defaultkvstorage.user.md)
+
+## DefaultKVStorage.user 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.
+> 
+
+**Signature:**
+
+```typescript
+protected user: User;
+```

package/docs/api/foundation-comms.defaultkvstorageconfig.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; [defaultKVStorageConfig](./foundation-comms.defaultkvstorageconfig.md)
+
+## defaultKVStorageConfig variable
+
+> 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 default configuration for the KVStorage service.
+
+**Signature:**
+
+```typescript
+defaultKVStorageConfig: KVStorageConfig
+```

package/docs/api/foundation-comms.entitydatasource.cache.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; [EntityDatasource](./foundation-comms.entitydatasource.md) &gt; [cache](./foundation-comms.entitydatasource.cache.md)
+
+## EntityDatasource.cache 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.
+> 
+
+**Signature:**
+
+```typescript
+readonly cache: TEntity[];
+```
+
+## Remarks
+
+In-memory entity cache.
+

package/docs/api/foundation-comms.entitydatasource.disconnect.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; [EntityDatasource](./foundation-comms.entitydatasource.md) &gt; [disconnect](./foundation-comms.entitydatasource.disconnect.md)
+
+## EntityDatasource.disconnect() 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
+disconnect(): void;
+```
+**Returns:**
+
+void
+
+## Remarks
+
+Disconnect and reset cache.
+

package/docs/api/foundation-comms.entitydatasource.initialize.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; [EntityDatasource](./foundation-comms.entitydatasource.md) &gt; [initialize](./foundation-comms.entitydatasource.initialize.md)
+
+## EntityDatasource.initialize() 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
+initialize(init: EntityDatasourceInit<TDTO, TEntity>): Promise<boolean>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  init | [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md)<!-- -->&lt;TDTO, TEntity&gt; |  |
+
+**Returns:**
+
+Promise&lt;boolean&gt;
+
+## Remarks
+
+Initialize datasource.
+

package/docs/api/foundation-comms.entitydatasource.isempty.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; [EntityDatasource](./foundation-comms.entitydatasource.md) &gt; [isEmpty](./foundation-comms.entitydatasource.isempty.md)
+
+## EntityDatasource.isEmpty 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.
+> 
+
+**Signature:**
+
+```typescript
+readonly isEmpty: boolean;
+```
+
+## Remarks
+
+Cache is empty / awaiting first result.
+

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

@@ -0,0 +1,81 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [EntityDatasource](./foundation-comms.entitydatasource.md)
+
+## EntityDatasource 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.
+> 
+
+EntityDatasource DI interface.
+
+**Signature:**
+
+```typescript
+export interface EntityDatasource<TDTO, TEntity> extends Datasource 
+```
+**Extends:** [Datasource](./foundation-comms.datasource.md)
+
+## Remarks
+
+A simple streaming datasource cache used mainly by services that employ DTO mappers.
+
+## Example
+
+An example service using an underlying EntityDatasource:
+
+```ts
+export class DefaultDomainService implements DomainService {
+  constructor(
+    @EntityDatasource protected datasource: EntityDatasource<DomainDTO, DomainEntity>,
+    @DomainDTOMapper protected mapper: DomainDTOMapper,
+    @optional(DomainServiceConfig) private config = defaultConfig
+  ) {}
+
+  get initialized = () {
+    return this.datasource.initialized;
+  }
+
+  initialize = async (init) => {
+    await this.datasource.initialize({
+      mapper: this.mapper,
+      options: {
+        resourceName: this.config.resourceName,
+        ...init,
+      },
+    });
+    return this.initialized;
+  };
+
+  list = () => this.datasource.cache;
+
+  get = async (id: string) => this.datasource.cache.find((entity) => entity.id === id);
+
+  action = async (id: string, message?: string): Promise<Message> => {
+    return this.commitEvent('EVENT_DOMAIN_ACTION', { id, message });
+  };
+
+  private async commitEvent(event: string, entity: Partial<DomainEntity>) {
+    const msg = await this.connect.commitEvent(event, {
+      DETAILS: this.mapper.toDTO(entity),
+      IGNORE_WARNINGS: true,
+      VALIDATE: false,
+    });
+    return messageOrThrow(msg);
+  }
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [cache](./foundation-comms.entitydatasource.cache.md) | <code>readonly</code> | TEntity\[\] | **_(ALPHA)_** |
+|  [isEmpty](./foundation-comms.entitydatasource.isempty.md) | <code>readonly</code> | boolean | **_(ALPHA)_** |
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [disconnect()](./foundation-comms.entitydatasource.disconnect.md) | **_(ALPHA)_** |
+|  [initialize(init)](./foundation-comms.entitydatasource.initialize.md) | **_(ALPHA)_** |
+

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

package/docs/api/foundation-comms.entitydatasourceinit.mapper.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; [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md) &gt; [mapper](./foundation-comms.entitydatasourceinit.mapper.md)
+
+## EntityDatasourceInit.mapper 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.
+> 
+
+**Signature:**
+
+```typescript
+mapper: DTOMapper<TDTO, TEntity>;
+```

package/docs/api/foundation-comms.entitydatasourceinit.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; [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md)
+
+## EntityDatasourceInit 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.
+> 
+
+EntityDatasourceInit interface.
+
+**Signature:**
+
+```typescript
+export interface EntityDatasourceInit<TDTO, TEntity> 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [fetchMeta?](./foundation-comms.entitydatasourceinit.fetchmeta.md) |  | boolean | **_(ALPHA)_** _(Optional)_ |
+|  [mapper](./foundation-comms.entitydatasourceinit.mapper.md) |  | DTOMapper&lt;TDTO, TEntity&gt; | **_(ALPHA)_** |
+|  [options](./foundation-comms.entitydatasourceinit.options.md) |  | Omit&lt;[DatasourceOptions](./foundation-comms.datasourceoptions.md)<!-- -->, 'isSnapshot'&gt; | **_(ALPHA)_** |
+

package/docs/api/foundation-comms.entitydatasourceinit.options.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; [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md) &gt; [options](./foundation-comms.entitydatasourceinit.options.md)
+
+## EntityDatasourceInit.options 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.
+> 
+
+**Signature:**
+
+```typescript
+options: Omit<DatasourceOptions, 'isSnapshot'>;
+```

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

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [extractFieldDefinitions](./foundation-comms.extractfielddefinitions.md)
 
-## extractFieldDefinitions variable
+## extractFieldDefinitions() function
 
 Extracts the field definitions from the metadata.
 
@@ -11,3 +11,16 @@ Extracts the field definitions from the metadata.
 ```typescript
 extractFieldDefinitions: (metadata: Metadata) => MetadataDetail[]
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  metadata | [Metadata](./foundation-comms.metadata.md) | The metadata object. |
+
+**Returns:**
+
+[MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\]
+
+An array of metadata detail.
+

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

@@ -13,7 +13,7 @@ export declare function getKVStorage(): KVStorage;
 ```
 **Returns:**
 
-KVStorage
+[KVStorage](./foundation-comms.kvstorage.md)
 
 ## Remarks
 

package/docs/api/foundation-comms.keyvalue.base64.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; [KeyValue](./foundation-comms.keyvalue.md) &gt; [base64](./foundation-comms.keyvalue.base64.md)
+
+## KeyValue.base64 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.
+> 
+
+Value should be encoded.
+
+**Signature:**
+
+```typescript
+base64?: boolean;
+```

package/docs/api/foundation-comms.keyvalue.expiration.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; [KeyValue](./foundation-comms.keyvalue.md) &gt; [expiration](./foundation-comms.keyvalue.expiration.md)
+
+## KeyValue.expiration 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.
+> 
+
+Time key expires.
+
+**Signature:**
+
+```typescript
+expiration?: number;
+```

package/docs/api/foundation-comms.keyvalue.key.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; [KeyValue](./foundation-comms.keyvalue.md) &gt; [key](./foundation-comms.keyvalue.key.md)
+
+## KeyValue.key 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.
+> 
+
+Key
+
+**Signature:**
+
+```typescript
+key: string;
+```

package/docs/api/foundation-comms.keyvalue.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; [KeyValue](./foundation-comms.keyvalue.md)
+
+## KeyValue 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.
+> 
+
+KeyValue interface.
+
+**Signature:**
+
+```typescript
+export interface KeyValue<T = KVValue> 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [base64?](./foundation-comms.keyvalue.base64.md) |  | boolean | **_(ALPHA)_** _(Optional)_ Value should be encoded. |
+|  [expiration?](./foundation-comms.keyvalue.expiration.md) |  | number | **_(ALPHA)_** _(Optional)_ Time key expires. |
+|  [key](./foundation-comms.keyvalue.key.md) |  | string | **_(ALPHA)_** Key |
+|  [metadata?](./foundation-comms.keyvalue.metadata.md) |  | { \[key: string\]: unknown; } | **_(ALPHA)_** _(Optional)_ Additional metadata. |
+|  [value?](./foundation-comms.keyvalue.value.md) |  | T | **_(ALPHA)_** _(Optional)_ Value |
+

package/docs/api/foundation-comms.keyvalue.metadata.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; [KeyValue](./foundation-comms.keyvalue.md) &gt; [metadata](./foundation-comms.keyvalue.metadata.md)
+
+## KeyValue.metadata 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.
+> 
+
+Additional metadata.
+
+**Signature:**
+
+```typescript
+metadata?: {
+        [key: string]: unknown;
+    };
+```

package/docs/api/foundation-comms.keyvalue.value.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; [KeyValue](./foundation-comms.keyvalue.md) &gt; [value](./foundation-comms.keyvalue.value.md)
+
+## KeyValue.value 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.
+> 
+
+Value
+
+**Signature:**
+
+```typescript
+value?: T;
+```

package/docs/api/foundation-comms.keyvaluetransfer.deserialize.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; [deserialize](./foundation-comms.keyvaluetransfer.deserialize.md)
+
+## KeyValueTransfer.deserialize() 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
+deserialize?(value: unknown): Promise<T>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | unknown |  |
+
+**Returns:**
+
+Promise&lt;T&gt;
+

package/docs/api/foundation-comms.keyvaluetransfer.kv.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; [KeyValueTransfer](./foundation-comms.keyvaluetransfer.md) &gt; [kv](./foundation-comms.keyvaluetransfer.kv.md)
+
+## KeyValueTransfer.kv 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.
+> 
+
+**Signature:**
+
+```typescript
+kv: KeyValue<T>;
+```