@genesislcap/foundation-comms 14.408.0 → 14.409.0

package/docs/api/foundation-comms.defaultsocketstatus.resetclosedstate.md

@@ -1,15 +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; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [resetClosedState](./foundation-comms.defaultsocketstatus.resetclosedstate.md)
-
-## DefaultSocketStatus.resetClosedState() method
-
-**Signature:**
-
-```typescript
-protected resetClosedState(): void;
-```
-**Returns:**
-
-void
-

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

@@ -1,15 +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; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [serialize](./foundation-comms.defaultsocketstatus.serialize.md)
-
-## DefaultSocketStatus.serialize() method
-
-**Signature:**
-
-```typescript
-serialize(): SerializedSocketStatus;
-```
-**Returns:**
-
-[SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md)
-

package/docs/api/foundation-comms.defaultsocketstatus.user.md

@@ -1,11 +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; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [user](./foundation-comms.defaultsocketstatus.user.md)
-
-## DefaultSocketStatus.user property
-
-**Signature:**
-
-```typescript
-protected user: User;
-```

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

@@ -1,19 +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) &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

@@ -1,22 +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) &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

@@ -1,57 +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) &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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-init
-
-
-</td><td>
-
-[EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md)<!-- -->&lt;TDTO, TEntity&gt;
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-
-## Remarks
-
-Initialize datasource.
-

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

@@ -1,19 +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) &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

@@ -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.eventmessagetype.md

@@ -1,230 +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; [EventMessageType](./foundation-comms.eventmessagetype.md)
-
-## EventMessageType enum
-
-Event Message types
-
-**Signature:**
-
-```typescript
-export declare enum EventMessageType 
-```
-
-## Enumeration Members
-
-<table><thead><tr><th>
-
-Member
-
-
-</th><th>
-
-Value
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-DATA\_LOGOFF
-
-
-</td><td>
-
-`"DATA_LOGOFF"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-DATA\_LOGON
-
-
-</td><td>
-
-`"DATA_LOGON"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-EVENT\_CHANGE\_USER\_PASSWORD
-
-
-</td><td>
-
-`"EVENT_CHANGE_USER_PASSWORD"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-EVENT\_LOGIN\_AUTH
-
-
-</td><td>
-
-`"EVENT_LOGIN_AUTH"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-EVENT\_LOGIN\_AUTH\_ACK
-
-
-</td><td>
-
-`"EVENT_LOGIN_AUTH_ACK"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-EVENT\_LOGIN\_AUTH\_NACK
-
-
-</td><td>
-
-`"EVENT_LOGIN_AUTH_NACK"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-EVENT\_LOGOUT
-
-
-</td><td>
-
-`"EVENT_LOGOUT"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-EVENT\_PASSWORD\_RESET\_ACTION
-
-
-</td><td>
-
-`"EVENT_PASSWORD_RESET_ACTION"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-EVENT\_SELF\_SERVICE\_PASSWORD\_RESET
-
-
-</td><td>
-
-`"EVENT_SELF_SERVICE_PASSWORD_RESET"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-JSON\_SCHEMA\_REQUEST
-
-
-</td><td>
-
-`"JSON_SCHEMA_REQUEST"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-META\_REQUEST
-
-
-</td><td>
-
-`"META_REQUEST"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-RESOURCES\_REQUEST
-
-
-</td><td>
-
-`"RESOURCES_REQUEST"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-RESOURCES\_REQUEST\_ACK
-
-
-</td><td>
-
-`"RESOURCES_REQUEST_ACK"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-RESOURCES\_REQUEST\_NACK
-
-
-</td><td>
-
-`"RESOURCES_REQUEST_NACK"`
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-