@genesislcap/foundation-comms 14.167.3-alpha-69ba23f.0 → 14.169.0

package/docs/api/foundation-comms.commitevent.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; [CommitEvent](./foundation-comms.commitevent.md)
+
+## CommitEvent type
+
+
+**Signature:**
+
+```typescript
+export type CommitEvent = CustomEvent<CommitEventDetail>;
+```
+**References:** [CommitEventDetail](./foundation-comms.commiteventdetail.md)
+

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [CommitEventDetail](./foundation-comms.commiteventdetail.md)
+
+## CommitEventDetail type
+
+
+**Signature:**
+
+```typescript
+export type CommitEventDetail = {
+    eventName: string;
+    message: Message;
+};
+```
+**References:** [Message](./foundation-comms.message.md)
+

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

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [CommitEventType](./foundation-comms.commiteventtype.md)
+
+## CommitEventType variable
+
+
+**Signature:**
+
+```typescript
+CommitEventType = "connect-commit-event"
+```

package/docs/api/foundation-comms.connect.getmorecolumns.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; [Connect](./foundation-comms.connect.md) &gt; [getMoreColumns](./foundation-comms.connect.getmorecolumns.md)
+
+## Connect.getMoreColumns() method
+
+Requests additional columns for the specified source reference.
+
+**Signature:**
+
+```typescript
+getMoreColumns(sourceRef: string): Promise<Message>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  sourceRef | string | The source reference to request more columns for. |
+
+**Returns:**
+
+Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
+
+A promise that resolves with the additional columns.
+

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

@@ -32,6 +32,7 @@ export interface Connect
 |  [getAvailableResources(params)](./foundation-comms.connect.getavailableresources.md) | Sends a request to the server to get available resources. |
 |  [getJSONSchema(resourceName)](./foundation-comms.connect.getjsonschema.md) | Retrieves the JSON schema for the specified resource. |
 |  [getMetadata(resourceName, useCache)](./foundation-comms.connect.getmetadata.md) | Retrieves the metadata for the specified resource. |
+|  [getMoreColumns(sourceRef)](./foundation-comms.connect.getmorecolumns.md) | Requests additional columns for the specified source reference. |
 |  [getMoreRows(sourceRef)](./foundation-comms.connect.getmorerows.md) | Requests additional rows of data for the specified source reference. |
 |  [request(resourceName, params)](./foundation-comms.connect.request.md) | Sends a request to the server to retrieve data or perform an action. |
 |  [snapshot(resourceName, params)](./foundation-comms.connect.snapshot.md) | Retrieves a snapshot of data for the specified resource. |

package/docs/api/foundation-comms.connectevents.addcommitlistener.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; [ConnectEvents](./foundation-comms.connectevents.md) &gt; [addCommitListener](./foundation-comms.connectevents.addcommitlistener.md)
+
+## ConnectEvents.addCommitListener() method
+
+Add a commit listener.
+
+**Signature:**
+
+```typescript
+addCommitListener(listener: Listener<CommitEvent>): () => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | Listener&lt;[CommitEvent](./foundation-comms.commitevent.md)<!-- -->&gt; | A listener callback function. |
+
+**Returns:**
+
+() =&gt; void
+

package/docs/api/foundation-comms.connectevents.addmetadatalistener.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; [ConnectEvents](./foundation-comms.connectevents.md) &gt; [addMetadataListener](./foundation-comms.connectevents.addmetadatalistener.md)
+
+## ConnectEvents.addMetadataListener() method
+
+Add a metadata listener.
+
+**Signature:**
+
+```typescript
+addMetadataListener(listener: Listener<MetadataEvent>): () => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | Listener&lt;[MetadataEvent](./foundation-comms.metadataevent.md)<!-- -->&gt; | A listener callback function. |
+
+**Returns:**
+
+() =&gt; void
+

package/docs/api/foundation-comms.connectevents.addstreamlistener.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; [ConnectEvents](./foundation-comms.connectevents.md) &gt; [addStreamListener](./foundation-comms.connectevents.addstreamlistener.md)
+
+## ConnectEvents.addStreamListener() method
+
+Add a stream listener.
+
+**Signature:**
+
+```typescript
+addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | Listener&lt;[StreamEvent](./foundation-comms.streamevent.md)<!-- -->&gt; | A listener callback function. |
+|  complete | Listener&lt;[StreamCompleteEvent](./foundation-comms.streamcompleteevent.md)<!-- -->&gt; | A complete listener callback function. |
+
+**Returns:**
+
+() =&gt; void
+

package/docs/api/foundation-comms.connectevents.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; [ConnectEvents](./foundation-comms.connectevents.md)
+
+## ConnectEvents interface
+
+`ConnectEvents` provide hooks to respond to specific connect events.
+
+**Signature:**
+
+```typescript
+export interface ConnectEvents 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [addCommitListener(listener)](./foundation-comms.connectevents.addcommitlistener.md) | Add a commit listener. |
+|  [addMetadataListener(listener)](./foundation-comms.connectevents.addmetadatalistener.md) | Add a metadata listener. |
+|  [addStreamListener(listener, complete)](./foundation-comms.connectevents.addstreamlistener.md) | Add a stream listener. |
+

package/docs/api/foundation-comms.connecteventsemitter.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; [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md)
+
+## ConnectEventsEmitter interface
+
+`ConnectEventsEmitter` provide event emitting hooks to Connect.
+
+**Signature:**
+
+```typescript
+export interface ConnectEventsEmitter extends ConnectEvents 
+```
+**Extends:** [ConnectEvents](./foundation-comms.connectevents.md)
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [onCommitEvent(eventName, message)](./foundation-comms.connecteventsemitter.oncommitevent.md) | Called by Connect. |
+|  [onMetadataEvent(resourceName, message, error)](./foundation-comms.connecteventsemitter.onmetadataevent.md) | Called by Connect. |
+|  [onStreamCompleteEvent(stream)](./foundation-comms.connecteventsemitter.onstreamcompleteevent.md) | Called by Connect. |
+|  [onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.connecteventsemitter.onstreamevent.md) | Called by Connect. |
+

package/docs/api/foundation-comms.connecteventsemitter.oncommitevent.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; [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) &gt; [onCommitEvent](./foundation-comms.connecteventsemitter.oncommitevent.md)
+
+## ConnectEventsEmitter.onCommitEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onCommitEvent(eventName: string, message: Message): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  eventName | string | The name of the event. |
+|  message | [Message](./foundation-comms.message.md) | The message. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.connecteventsemitter.onmetadataevent.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; [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) &gt; [onMetadataEvent](./foundation-comms.connecteventsemitter.onmetadataevent.md)
+
+## ConnectEventsEmitter.onMetadataEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource. |
+|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.MetaRequest](./foundation-comms.messagedetails.metarequest.md)<!-- -->&gt; | The message. |
+|  error | any | _(Optional)_ Optional error. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.connecteventsemitter.onstreamcompleteevent.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; [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) &gt; [onStreamCompleteEvent](./foundation-comms.connecteventsemitter.onstreamcompleteevent.md)
+
+## ConnectEventsEmitter.onStreamCompleteEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onStreamCompleteEvent(stream: SocketObservable<any>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.connecteventsemitter.onstreamevent.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; [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) &gt; [onStreamEvent](./foundation-comms.connecteventsemitter.onstreamevent.md)
+
+## ConnectEventsEmitter.onStreamEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource. |
+|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.DataserverRequest](./foundation-comms.messagedetails.dataserverrequest.md)<!-- -->&gt; | The message. |
+|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
+|  functions | [StreamEventFunctions](./foundation-comms.streameventfunctions.md) | Any functions provided. |
+
+**Returns:**
+
+void
+

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

@@ -34,4 +34,6 @@ export declare class CurrentUser implements User
 |  [hasAdminProfile()](./foundation-comms.currentuser.hasadminprofile.md) |  |  |
 |  [hasPermission(permission)](./foundation-comms.currentuser.haspermission.md) |  |  |
 |  [hasProfile(profile)](./foundation-comms.currentuser.hasprofile.md) |  |  |
+|  [set(options)](./foundation-comms.currentuser.set.md) |  |  |
+|  [unset()](./foundation-comms.currentuser.unset.md) |  |  |
 

package/docs/api/foundation-comms.currentuser.set.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; [CurrentUser](./foundation-comms.currentuser.md) &gt; [set](./foundation-comms.currentuser.set.md)
+
+## CurrentUser.set() method
+
+**Signature:**
+
+```typescript
+set(options: UserOptions): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | UserOptions |  |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.currentuser.unset.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [CurrentUser](./foundation-comms.currentuser.md) &gt; [unset](./foundation-comms.currentuser.unset.md)
+
+## CurrentUser.unset() method
+
+**Signature:**
+
+```typescript
+unset(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.datasource.destroy.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Datasource](./foundation-comms.datasource.md) &gt; [destroy](./foundation-comms.datasource.destroy.md)
+
+## Datasource.destroy() method
+
+Destroy the datasource.
+
+**Signature:**
+
+```typescript
+destroy(): void;
+```
+**Returns:**
+
+void
+

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

@@ -36,6 +36,7 @@ The public interface available on the injected store fragment.
 |  [dataHandler(data)?](./foundation-comms.datasource.datahandler.md) | _(Optional)_ Handles the specified data and returns it. |
 |  [deinit()](./foundation-comms.datasource.deinit.md) | Deinitializes the datasource. |
 |  [deleteItem(itemId)?](./foundation-comms.datasource.deleteitem.md) | _(Optional)_ Deletes an item with the given ID from the datasource. |
+|  [destroy()](./foundation-comms.datasource.destroy.md) | Destroy the datasource. |
 |  [dropView(view)?](./foundation-comms.datasource.dropview.md) | _(Optional)_ Removes the specified dataview from the datasource. |
 |  [getMetadata(resourceName)?](./foundation-comms.datasource.getmetadata.md) | _(Optional)_ Fetches metadata for the specified resource name. |
 |  [init(options, fetchMeta)](./foundation-comms.datasource.init.md) | Initializes the datasource with the given options and fetches metadata if specified. |

package/docs/api/foundation-comms.defaultconnect._constructor_.md

@@ -9,7 +9,7 @@ Constructs a new instance of the `DefaultConnect` class
 **Signature:**
 
 ```typescript
-constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, config?: ConnectConfig);
+constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config?: ConnectConfig);
 ```
 
 ## Parameters
@@ -19,5 +19,6 @@ constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache
 |  socket | [Socket](./foundation-comms.socket.md) |  |
 |  messageBuilder | [MessageBuilder](./foundation-comms.messagebuilder.md) |  |
 |  metaCache | [MetaCache](./foundation-comms.metacache.md) |  |
+|  events | [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) |  |
 |  config | [ConnectConfig](./foundation-comms.connectconfig.md) | _(Optional)_ |
 

package/docs/api/foundation-comms.defaultconnect.getmorecolumns.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; [DefaultConnect](./foundation-comms.defaultconnect.md) &gt; [getMoreColumns](./foundation-comms.defaultconnect.getmorecolumns.md)
+
+## DefaultConnect.getMoreColumns() method
+
+**Signature:**
+
+```typescript
+getMoreColumns(sourceRef: string): Promise<Message>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  sourceRef | string |  |
+
+**Returns:**
+
+Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
+

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

@@ -17,7 +17,7 @@ export declare class DefaultConnect implements Connect
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(socket, messageBuilder, metaCache, config)](./foundation-comms.defaultconnect._constructor_.md) |  | Constructs a new instance of the <code>DefaultConnect</code> class |
+|  [(constructor)(socket, messageBuilder, metaCache, events, config)](./foundation-comms.defaultconnect._constructor_.md) |  | Constructs a new instance of the <code>DefaultConnect</code> class |
 
 ## Properties
 
@@ -40,6 +40,7 @@ export declare class DefaultConnect implements Connect
 |  [getAvailableResources(params)](./foundation-comms.defaultconnect.getavailableresources.md) |  |  |
 |  [getJSONSchema(resourceName, useCache)](./foundation-comms.defaultconnect.getjsonschema.md) |  |  |
 |  [getMetadata(resourceName, useCache)](./foundation-comms.defaultconnect.getmetadata.md) |  |  |
+|  [getMoreColumns(sourceRef)](./foundation-comms.defaultconnect.getmorecolumns.md) |  |  |
 |  [getMoreRows(sourceRef)](./foundation-comms.defaultconnect.getmorerows.md) |  |  |
 |  [httpMode()](./foundation-comms.defaultconnect.httpmode.md) |  |  |
 |  [request(resourceName, params)](./foundation-comms.defaultconnect.request.md) |  |  |

package/docs/api/foundation-comms.defaultconnectevents.addcommitlistener.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [addCommitListener](./foundation-comms.defaultconnectevents.addcommitlistener.md)
+
+## DefaultConnectEvents.addCommitListener() method
+
+Add a commit listener.
+
+**Signature:**
+
+```typescript
+addCommitListener(listener: Listener<CommitEvent>): () => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | Listener&lt;[CommitEvent](./foundation-comms.commitevent.md)<!-- -->&gt; | A listener callback function. |
+
+**Returns:**
+
+() =&gt; void
+

package/docs/api/foundation-comms.defaultconnectevents.addmetadatalistener.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [addMetadataListener](./foundation-comms.defaultconnectevents.addmetadatalistener.md)
+
+## DefaultConnectEvents.addMetadataListener() method
+
+Add a metadata listener.
+
+**Signature:**
+
+```typescript
+addMetadataListener(listener: Listener<MetadataEvent>): () => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | Listener&lt;[MetadataEvent](./foundation-comms.metadataevent.md)<!-- -->&gt; | A listener callback function. |
+
+**Returns:**
+
+() =&gt; void
+

package/docs/api/foundation-comms.defaultconnectevents.addstreamlistener.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [addStreamListener](./foundation-comms.defaultconnectevents.addstreamlistener.md)
+
+## DefaultConnectEvents.addStreamListener() method
+
+Add a stream listener.
+
+**Signature:**
+
+```typescript
+addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | Listener&lt;[StreamEvent](./foundation-comms.streamevent.md)<!-- -->&gt; | A listener callback function. |
+|  complete | Listener&lt;[StreamCompleteEvent](./foundation-comms.streamcompleteevent.md)<!-- -->&gt; | A complete listener callback function. |
+
+**Returns:**
+
+() =&gt; void
+

package/docs/api/foundation-comms.defaultconnectevents.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md)
+
+## DefaultConnectEvents class
+
+Default ConnectEvents implementation.
+
+**Signature:**
+
+```typescript
+export declare class DefaultConnectEvents implements ConnectEventsEmitter 
+```
+**Implements:** [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md)
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [addCommitListener(listener)](./foundation-comms.defaultconnectevents.addcommitlistener.md) |  | Add a commit listener. |
+|  [addMetadataListener(listener)](./foundation-comms.defaultconnectevents.addmetadatalistener.md) |  | Add a metadata listener. |
+|  [addStreamListener(listener, complete)](./foundation-comms.defaultconnectevents.addstreamlistener.md) |  | Add a stream listener. |
+|  [onCommitEvent(eventName, message)](./foundation-comms.defaultconnectevents.oncommitevent.md) |  | Called by Connect. |
+|  [onMetadataEvent(resourceName, message, error)](./foundation-comms.defaultconnectevents.onmetadataevent.md) |  | Called by Connect. |
+|  [onStreamCompleteEvent(stream)](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md) |  | Called by Connect. |
+|  [onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.defaultconnectevents.onstreamevent.md) |  | Called by Connect. |
+

package/docs/api/foundation-comms.defaultconnectevents.oncommitevent.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onCommitEvent](./foundation-comms.defaultconnectevents.oncommitevent.md)
+
+## DefaultConnectEvents.onCommitEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onCommitEvent(eventName: string, message: Message): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  eventName | string |  |
+|  message | [Message](./foundation-comms.message.md) | The message. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.defaultconnectevents.onmetadataevent.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onMetadataEvent](./foundation-comms.defaultconnectevents.onmetadataevent.md)
+
+## DefaultConnectEvents.onMetadataEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource. |
+|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.MetaRequest](./foundation-comms.messagedetails.metarequest.md)<!-- -->&gt; | The message. |
+|  error | any | _(Optional)_ Optional error. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.defaultconnectevents.onstreamcompleteevent.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onStreamCompleteEvent](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md)
+
+## DefaultConnectEvents.onStreamCompleteEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onStreamCompleteEvent(stream: SocketObservable<any>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
+
+**Returns:**
+
+void
+