@genesislcap/foundation-comms 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.0

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

@@ -1,171 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[cache](./foundation-comms.entitydatasource.cache.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-TEntity\[\]
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[isEmpty](./foundation-comms.entitydatasource.isempty.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[disconnect()](./foundation-comms.entitydatasource.disconnect.md)
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[initialize(init)](./foundation-comms.entitydatasource.initialize.md)
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-comms.entitydatasourceinit.fetchmeta.md

@@ -1,14 +0,0 @@
-<!-- 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

@@ -1,14 +0,0 @@
-<!-- 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

@@ -1,99 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[fetchMeta?](./foundation-comms.entitydatasourceinit.fetchmeta.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[mapper](./foundation-comms.entitydatasourceinit.mapper.md)
-
-
-</td><td>
-
-
-</td><td>
-
-DTOMapper&lt;TDTO, TEntity&gt;
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[options](./foundation-comms.entitydatasourceinit.options.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Omit&lt;[DatasourceOptions](./foundation-comms.datasourceoptions.md)<!-- -->, 'isSnapshot'&gt;
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-comms.entitydatasourceinit.options.md

@@ -1,14 +0,0 @@
-<!-- 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.keyvalue.base64.md

@@ -1,16 +0,0 @@
-<!-- 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

@@ -1,16 +0,0 @@
-<!-- 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

@@ -1,16 +0,0 @@
-<!-- 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

@@ -1,137 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[base64?](./foundation-comms.keyvalue.base64.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_ Value should be encoded.
-
-
-</td></tr>
-<tr><td>
-
-[expiration?](./foundation-comms.keyvalue.expiration.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_ Time key expires.
-
-
-</td></tr>
-<tr><td>
-
-[key](./foundation-comms.keyvalue.key.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_** Key
-
-
-</td></tr>
-<tr><td>
-
-[metadata?](./foundation-comms.keyvalue.metadata.md)
-
-
-</td><td>
-
-
-</td><td>
-
-{ \[key: string\]: unknown; }
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_ Additional metadata.
-
-
-</td></tr>
-<tr><td>
-
-[value?](./foundation-comms.keyvalue.value.md)
-
-
-</td><td>
-
-
-</td><td>
-
-T
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_ Value
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-comms.keyvalue.metadata.md

@@ -1,18 +0,0 @@
-<!-- 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

@@ -1,16 +0,0 @@
-<!-- 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

@@ -1,53 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-value
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;T&gt;
-

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

@@ -1,14 +0,0 @@
-<!-- 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>;
-```

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

@@ -1,98 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[kv](./foundation-comms.keyvaluetransfer.kv.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[KeyValue](./foundation-comms.keyvalue.md)<!-- -->&lt;T&gt;
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[deserialize(value)?](./foundation-comms.keyvaluetransfer.deserialize.md)
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[serialize(value)?](./foundation-comms.keyvaluetransfer.serialize.md)
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_
-
-
-</td></tr>
-</tbody></table>
-