@genesislcap/foundation-comms 14.291.2-alpha-f8334d9.0 → 14.291.2-alpha-39f1157.0

package/docs/api/foundation-comms.defaultdatasource.triggerpoll.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; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [triggerPoll](./foundation-comms.defaultdatasource.triggerpoll.md)
+
+## DefaultDatasource.triggerPoll() method
+
+**Signature:**
+
+```typescript
+triggerPoll(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.md

@@ -111,7 +111,9 @@
 
 |  Variable | Description |
 |  --- | --- |
+|  [CommitAckEventType](./foundation-comms.commitackeventtype.md) |  |
 |  [CommitEventType](./foundation-comms.commiteventtype.md) |  |
+|  [CommitResponseEventType](./foundation-comms.commitresponseeventtype.md) |  |
 |  [credentialSeparator](./foundation-comms.credentialseparator.md) | The default separator used for splitting credential parts. |
 |  [DatasourceEventHandler](./foundation-comms.datasourceeventhandler.md) | Datasource event handler mixin for target classes that use or are interested in datasource status changes. |
 |  [DatasourceStatusChanged](./foundation-comms.datasourcestatuschanged.md) | DatasourceStatusChanged. |
@@ -147,9 +149,13 @@
 |  [AuthInfo](./foundation-comms.authinfo.md) | Union type of all authentication information types. |
 |  [BasicAuthInfo](./foundation-comms.basicauthinfo.md) | Represents basic authentication information. |
 |  [BasicCredentialsInput](./foundation-comms.basiccredentialsinput.md) | Represents basic credentials for a user. |
+|  [CommitAckEvent](./foundation-comms.commitackevent.md) |  |
+|  [CommitAckEventDetail](./foundation-comms.commitackeventdetail.md) |  |
 |  [CommitEvent](./foundation-comms.commitevent.md) |  |
 |  [CommitEventDetail](./foundation-comms.commiteventdetail.md) |  |
 |  [CommitParams](./foundation-comms.commitparams.md) | Parameters for a COMMIT message |
+|  [CommitResponseEvent](./foundation-comms.commitresponseevent.md) |  |
+|  [CommitResponseEventDetail](./foundation-comms.commitresponseeventdetail.md) |  |
 |  [ConnectionStatus](./foundation-comms.connectionstatus.md) | The connection status of the Genesis client. |
 |  [CredentialData\_2](./foundation-comms.credentialdata_2.md) | Represents user credentials. |
 |  [DataserverParams](./foundation-comms.dataserverparams.md) | Parameters for a DATA\_LOGON messages |

package/docs/api-report.md

@@ -127,6 +127,18 @@ export type BasicCredentialsInput = {
     password: string;
 };
 
+// @public (undocumented)
+export type CommitAckEvent = CustomEvent<CommitAckEventDetail>;
+
+// @public (undocumented)
+export type CommitAckEventDetail = {
+    eventName: string;
+    ack: Message;
+};
+
+// @public (undocumented)
+export const CommitAckEventType = "connect-commit-ack-event";
+
 // @public (undocumented)
 export type CommitEvent = CustomEvent<CommitEventDetail>;
 
@@ -148,6 +160,18 @@ export type CommitParams = {
     [key: string]: any;
 };
 
+// @public (undocumented)
+export type CommitResponseEvent = CustomEvent<CommitResponseEventDetail>;
+
+// @public (undocumented)
+export type CommitResponseEventDetail = {
+    eventName: string;
+    response: Message;
+};
+
+// @public (undocumented)
+export const CommitResponseEventType = "connect-commit-response-event";
+
 // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Connect" because one of its declarations is marked as @internal
 //
 // @public
@@ -201,7 +225,9 @@ export const ConnectConfig: InterfaceSymbol<ConnectConfig>;
 //
 // @public
 export interface ConnectEvents {
+    addCommitAckListener(listener: Listener<CommitAckEvent>): () => void;
     addCommitListener(listener: Listener<CommitEvent>): () => void;
+    addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
     addMetadataListener(listener: Listener<MetadataEvent>): () => void;
     addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
 }
@@ -213,7 +239,9 @@ export const ConnectEvents: InterfaceSymbol<ConnectEvents>;
 //
 // @public
 export interface ConnectEventsEmitter extends ConnectEvents {
+    onCommitAckEvent(eventName: string, ack: Message): void;
     onCommitEvent(eventName: string, message: Message): void;
+    onCommitResponseEvent(eventName: string, response: Message): void;
     onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
     onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
     onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
@@ -410,6 +438,7 @@ export interface Datasource extends DatasourceMetadata {
     // (undocumented)
     status: Partial<DatasourceStatus>;
     stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
+    triggerPoll(): void;
     updateData?(data: Array<any>): Promise<void>;
     updateItem?(itemId: string, data: any): Promise<void>;
     // @deprecated
@@ -853,6 +882,8 @@ export class DatasourceMock implements Datasource {
     // (undocumented)
     stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
     // (undocumented)
+    triggerPoll(): void;
+    // (undocumented)
     unsetMedata(): void;
     // (undocumented)
     unsetStream(): void;
@@ -875,6 +906,7 @@ export interface DatasourceOptions {
     movingView?: boolean;
     orderBy?: string;
     pollingInterval?: number;
+    pollTriggerEvents?: string[];
     request?: any;
     requestAutoSetup?: boolean;
     resourceName?: string;
@@ -992,6 +1024,10 @@ export const defaultConnectConfig: ConnectConfig;
 
 // @public
 export class DefaultConnectEvents implements ConnectEventsEmitter {
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
+    addCommitAckListener(listener: Listener<CommitAckEvent>): () => void;
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
@@ -999,22 +1035,38 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
+    addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
     addMetadataListener(listener: Listener<MetadataEvent>): () => void;
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
     addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
     // @internal (undocumented)
+    protected commitAckListeners: Observer<CommitAckEvent>;
+    // @internal (undocumented)
     protected commitListeners: Observer<CommitEvent>;
     // @internal (undocumented)
+    protected commitResponseListeners: Observer<CommitResponseEvent>;
+    // @internal (undocumented)
     protected metadataListeners: Observer<MetadataEvent>;
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
+    onCommitAckEvent(eventName: string, ack: Message): void;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
     onCommitEvent(eventName: string, message: Message): void;
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
+    onCommitResponseEvent(eventName: string, response: Message): void;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
     onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
     //
@@ -1100,8 +1152,8 @@ export const defaultCredentialRequestOptions: GetCredentialOptions;
 // @public
 export class DefaultDatasource implements Datasource {
     constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig);
-    // @internal (undocumented)
-    get allResourceParams(): DataserverParams & RequestParams;
+    // (undocumented)
+    get allParams(): any;
     // (undocumented)
     protected auth: Auth;
     // (undocumented)
@@ -1111,9 +1163,11 @@ export class DefaultDatasource implements Datasource {
     // (undocumented)
     protected connect: Connect;
     // (undocumented)
+    protected connectEvents: ConnectEvents;
+    // (undocumented)
     customRequestFields: MetadataDetail[];
-    // @internal (undocumented)
-    get dataserverOnlyParams(): DataserverParams;
+    // (undocumented)
+    get dataserverParams(): DataserverParams;
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "Datasource" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
@@ -1142,8 +1196,8 @@ export class DefaultDatasource implements Datasource {
     protected reportStatus(detail?: Partial<DatasourceStatus>): void;
     // (undocumented)
     requestFields: MetadataDetail[];
-    // @internal (undocumented)
-    get requestOnlyParams(): RequestParams;
+    // (undocumented)
+    get requestParams(): RequestParams;
     // (undocumented)
     protected resources: GenesisResources;
     // (undocumented)
@@ -1162,6 +1216,8 @@ export class DefaultDatasource implements Datasource {
     status: DatasourceStatus;
     // (undocumented)
     stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
+    // (undocumented)
+    triggerPoll(): void;
     // @deprecated (undocumented)
     validResourceName(resourceName: string): boolean;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-comms",
   "description": "Genesis Foundation UI Comms",
-  "version": "14.291.2-alpha-f8334d9.0",
+  "version": "14.291.2-alpha-39f1157.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -75,23 +75,23 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.291.2-alpha-f8334d9.0",
-    "@genesislcap/genx": "14.291.2-alpha-f8334d9.0",
-    "@genesislcap/rollup-builder": "14.291.2-alpha-f8334d9.0",
-    "@genesislcap/ts-builder": "14.291.2-alpha-f8334d9.0",
-    "@genesislcap/uvu-playwright-builder": "14.291.2-alpha-f8334d9.0",
-    "@genesislcap/vite-builder": "14.291.2-alpha-f8334d9.0",
-    "@genesislcap/webpack-builder": "14.291.2-alpha-f8334d9.0",
+    "@genesislcap/foundation-testing": "14.291.2-alpha-39f1157.0",
+    "@genesislcap/genx": "14.291.2-alpha-39f1157.0",
+    "@genesislcap/rollup-builder": "14.291.2-alpha-39f1157.0",
+    "@genesislcap/ts-builder": "14.291.2-alpha-39f1157.0",
+    "@genesislcap/uvu-playwright-builder": "14.291.2-alpha-39f1157.0",
+    "@genesislcap/vite-builder": "14.291.2-alpha-39f1157.0",
+    "@genesislcap/webpack-builder": "14.291.2-alpha-39f1157.0",
     "@types/js-cookie": "^3.0.2",
     "@types/json-schema": "^7.0.11",
     "@types/webappsec-credential-management": "^0.6.2",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-broadcast-channel": "14.291.2-alpha-f8334d9.0",
-    "@genesislcap/foundation-logger": "14.291.2-alpha-f8334d9.0",
-    "@genesislcap/foundation-user": "14.291.2-alpha-f8334d9.0",
-    "@genesislcap/foundation-utils": "14.291.2-alpha-f8334d9.0",
+    "@genesislcap/foundation-broadcast-channel": "14.291.2-alpha-39f1157.0",
+    "@genesislcap/foundation-logger": "14.291.2-alpha-39f1157.0",
+    "@genesislcap/foundation-user": "14.291.2-alpha-39f1157.0",
+    "@genesislcap/foundation-utils": "14.291.2-alpha-39f1157.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
     "analytics": "^0.8.0",
@@ -111,5 +111,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "daa7b5af7619b8f3365cdcef574fc35989c30de8"
+  "gitHead": "2cfbcb24b1fef701618d81ebba13623c87344ef9"
 }