@genesislcap/foundation-comms 14.301.0 → 14.302.1-alpha-d11831b.0

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,99 @@
+<!-- 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

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

@@ -14,20 +14,217 @@ export declare enum EventMessageType
 
 ## Enumeration Members
 
-|  Member | Value | Description |
-|  --- | --- | --- |
-|  DATA\_LOGOFF | <code>&quot;DATA_LOGOFF&quot;</code> |  |
-|  DATA\_LOGON | <code>&quot;DATA_LOGON&quot;</code> |  |
-|  EVENT\_CHANGE\_USER\_PASSWORD | <code>&quot;EVENT_CHANGE_USER_PASSWORD&quot;</code> |  |
-|  EVENT\_LOGIN\_AUTH | <code>&quot;EVENT_LOGIN_AUTH&quot;</code> |  |
-|  EVENT\_LOGIN\_AUTH\_ACK | <code>&quot;EVENT_LOGIN_AUTH_ACK&quot;</code> |  |
-|  EVENT\_LOGIN\_AUTH\_NACK | <code>&quot;EVENT_LOGIN_AUTH_NACK&quot;</code> |  |
-|  EVENT\_LOGOUT | <code>&quot;EVENT_LOGOUT&quot;</code> |  |
-|  EVENT\_PASSWORD\_RESET\_ACTION | <code>&quot;EVENT_PASSWORD_RESET_ACTION&quot;</code> |  |
-|  EVENT\_SELF\_SERVICE\_PASSWORD\_RESET | <code>&quot;EVENT_SELF_SERVICE_PASSWORD_RESET&quot;</code> |  |
-|  JSON\_SCHEMA\_REQUEST | <code>&quot;JSON_SCHEMA_REQUEST&quot;</code> |  |
-|  META\_REQUEST | <code>&quot;META_REQUEST&quot;</code> |  |
-|  RESOURCES\_REQUEST | <code>&quot;RESOURCES_REQUEST&quot;</code> |  |
-|  RESOURCES\_REQUEST\_ACK | <code>&quot;RESOURCES_REQUEST_ACK&quot;</code> |  |
-|  RESOURCES\_REQUEST\_NACK | <code>&quot;RESOURCES_REQUEST_NACK&quot;</code> |  |
+<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>
 

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,46 @@ Extracts the field definitions from the metadata.
 ```typescript
 extractFieldDefinitions: (metadata: Metadata) => MetadataDetail[]
 ```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+metadata
+
+
+</td><td>
+
+[Metadata](./foundation-comms.metadata.md)
+
+
+</td><td>
+
+The metadata object.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\]
+
+An array of metadata detail.
+

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

@@ -14,14 +14,133 @@ export declare enum FieldTypeEnum
 
 ## Enumeration Members
 
-|  Member | Value | Description |
-|  --- | --- | --- |
-|  BOOLEAN | <code>&quot;BOOLEAN&quot;</code> |  |
-|  CUSTOM | <code>&quot;CUSTOM&quot;</code> |  |
-|  DATE | <code>&quot;DATE&quot;</code> |  |
-|  DATETIME | <code>&quot;DATETIME&quot;</code> |  |
-|  ENUM | <code>&quot;ENUM&quot;</code> |  |
-|  NANO\_TIMESTAMP | <code>&quot;NANO_TIMESTAMP&quot;</code> |  |
-|  NUMBER | <code>&quot;NUMBER&quot;</code> |  |
-|  STRING | <code>&quot;STRING&quot;</code> |  |
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+BOOLEAN
+
+
+</td><td>
+
+`"BOOLEAN"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+CUSTOM
+
+
+</td><td>
+
+`"CUSTOM"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+DATE
+
+
+</td><td>
+
+`"DATE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+DATETIME
+
+
+</td><td>
+
+`"DATETIME"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ENUM
+
+
+</td><td>
+
+`"ENUM"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+NANO\_TIMESTAMP
+
+
+</td><td>
+
+`"NANO_TIMESTAMP"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+NUMBER
+
+
+</td><td>
+
+`"NUMBER"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+STRING
+
+
+</td><td>
+
+`"STRING"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

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

@@ -14,9 +14,49 @@ export interface FoundationAnalytics
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [trackEvent(eventName, payload)](./foundation-comms.foundationanalytics.trackevent.md) | Tracks a "control clicked" event with the specified payload. |
-|  [trackEvent(eventName, payload)](./foundation-comms.foundationanalytics.trackevent_1.md) | Tracks a "route changed" event with the specified payload. |
-|  [trackEvent(eventName, payload)](./foundation-comms.foundationanalytics.trackevent_2.md) | Tracks an event with the specified name and payload. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[trackEvent(eventName, payload)](./foundation-comms.foundationanalytics.trackevent.md)
+
+
+</td><td>
+
+Tracks a "control clicked" event with the specified payload.
+
+
+</td></tr>
+<tr><td>
+
+[trackEvent(eventName, payload)](./foundation-comms.foundationanalytics.trackevent_1.md)
+
+
+</td><td>
+
+Tracks a "route changed" event with the specified payload.
+
+
+</td></tr>
+<tr><td>
+
+[trackEvent(eventName, payload)](./foundation-comms.foundationanalytics.trackevent_2.md)
+
+
+</td><td>
+
+Tracks an event with the specified name and payload.
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.foundationanalytics.trackevent.md

@@ -14,10 +14,55 @@ trackEvent(eventName: FoundationAnalyticsEventType.controlClicked, payload: Foun
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  eventName | [FoundationAnalyticsEventType.controlClicked](./foundation-comms.foundationanalyticseventtype.md) | The name of the event to track. |
-|  payload | [FoundationAnalyticsEvent.ControlClicked](./foundation-comms.foundationanalyticsevent.controlclicked.md) | The payload data for the event. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eventName
+
+
+</td><td>
+
+[FoundationAnalyticsEventType.controlClicked](./foundation-comms.foundationanalyticseventtype.md)
+
+
+</td><td>
+
+The name of the event to track.
+
+
+</td></tr>
+<tr><td>
+
+payload
+
+
+</td><td>
+
+[FoundationAnalyticsEvent.ControlClicked](./foundation-comms.foundationanalyticsevent.controlclicked.md)
+
+
+</td><td>
+
+The payload data for the event.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**