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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/dist/dts/connect/connect.d.ts.map +1 -1
  2. package/dist/dts/connect/connect.events.d.ts +64 -0
  3. package/dist/dts/connect/connect.events.d.ts.map +1 -1
  4. package/dist/dts/connect/http.connect.d.ts.map +1 -1
  5. package/dist/dts/datasource/datasource.config.d.ts.map +1 -1
  6. package/dist/dts/datasource/datasource.d.ts +9 -1
  7. package/dist/dts/datasource/datasource.d.ts.map +1 -1
  8. package/dist/dts/datasource/datasource.types.d.ts +5 -0
  9. package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
  10. package/dist/dts/testing/mocks/datasource/datasource.d.ts +1 -0
  11. package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
  12. package/dist/esm/connect/connect.events.js +42 -0
  13. package/dist/esm/connect/connect.js +5 -1
  14. package/dist/esm/connect/http.connect.js +4 -3
  15. package/dist/esm/connect/http.connect.types.js +3 -3
  16. package/dist/esm/datasource/datasource.config.js +1 -0
  17. package/dist/esm/datasource/datasource.js +22 -8
  18. package/dist/esm/testing/mocks/datasource/datasource.js +3 -0
  19. package/dist/foundation-comms.api.json +908 -91
  20. package/dist/foundation-comms.d.ts +84 -0
  21. package/docs/api/foundation-comms.commitackevent.md +14 -0
  22. package/docs/api/foundation-comms.commitackeventdetail.md +17 -0
  23. package/docs/api/foundation-comms.commitackeventtype.md +12 -0
  24. package/docs/api/foundation-comms.commitresponseevent.md +14 -0
  25. package/docs/api/foundation-comms.commitresponseeventdetail.md +17 -0
  26. package/docs/api/foundation-comms.commitresponseeventtype.md +12 -0
  27. package/docs/api/foundation-comms.connectevents.addcommitacklistener.md +24 -0
  28. package/docs/api/foundation-comms.connectevents.addcommitresponselistener.md +24 -0
  29. package/docs/api/foundation-comms.connectevents.md +2 -0
  30. package/docs/api/foundation-comms.connecteventsemitter.md +2 -0
  31. package/docs/api/foundation-comms.connecteventsemitter.oncommitackevent.md +25 -0
  32. package/docs/api/foundation-comms.connecteventsemitter.oncommitresponseevent.md +25 -0
  33. package/docs/api/foundation-comms.datasource.md +1 -0
  34. package/docs/api/foundation-comms.datasource.triggerpoll.md +17 -0
  35. package/docs/api/foundation-comms.datasourceoptions.md +1 -0
  36. package/docs/api/foundation-comms.datasourceoptions.polltriggerevents.md +18 -0
  37. package/docs/api/foundation-comms.defaultconnectevents.addcommitacklistener.md +24 -0
  38. package/docs/api/foundation-comms.defaultconnectevents.addcommitresponselistener.md +24 -0
  39. package/docs/api/foundation-comms.defaultconnectevents.md +4 -0
  40. package/docs/api/foundation-comms.defaultconnectevents.oncommitackevent.md +25 -0
  41. package/docs/api/foundation-comms.defaultconnectevents.oncommitresponseevent.md +25 -0
  42. package/docs/api/foundation-comms.defaultdatasource.connectevents.md +11 -0
  43. package/docs/api/foundation-comms.defaultdatasource.md +2 -0
  44. package/docs/api/foundation-comms.defaultdatasource.triggerpoll.md +15 -0
  45. package/docs/api/foundation-comms.md +6 -0
  46. package/docs/api-report.md +56 -0
  47. package/package.json +13 -13
@@ -127,6 +127,18 @@ export type BasicCredentialsInput = {
127
127
  password: string;
128
128
  };
129
129
 
130
+ // @public (undocumented)
131
+ export type CommitAckEvent = CustomEvent<CommitAckEventDetail>;
132
+
133
+ // @public (undocumented)
134
+ export type CommitAckEventDetail = {
135
+ eventName: string;
136
+ ack: Message;
137
+ };
138
+
139
+ // @public (undocumented)
140
+ export const CommitAckEventType = "connect-commit-ack-event";
141
+
130
142
  // @public (undocumented)
131
143
  export type CommitEvent = CustomEvent<CommitEventDetail>;
132
144
 
@@ -148,6 +160,18 @@ export type CommitParams = {
148
160
  [key: string]: any;
149
161
  };
150
162
 
163
+ // @public (undocumented)
164
+ export type CommitResponseEvent = CustomEvent<CommitResponseEventDetail>;
165
+
166
+ // @public (undocumented)
167
+ export type CommitResponseEventDetail = {
168
+ eventName: string;
169
+ response: Message;
170
+ };
171
+
172
+ // @public (undocumented)
173
+ export const CommitResponseEventType = "connect-commit-response-event";
174
+
151
175
  // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Connect" because one of its declarations is marked as @internal
152
176
  //
153
177
  // @public
@@ -201,7 +225,9 @@ export const ConnectConfig: InterfaceSymbol<ConnectConfig>;
201
225
  //
202
226
  // @public
203
227
  export interface ConnectEvents {
228
+ addCommitAckListener(listener: Listener<CommitAckEvent>): () => void;
204
229
  addCommitListener(listener: Listener<CommitEvent>): () => void;
230
+ addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
205
231
  addMetadataListener(listener: Listener<MetadataEvent>): () => void;
206
232
  addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
207
233
  }
@@ -213,7 +239,9 @@ export const ConnectEvents: InterfaceSymbol<ConnectEvents>;
213
239
  //
214
240
  // @public
215
241
  export interface ConnectEventsEmitter extends ConnectEvents {
242
+ onCommitAckEvent(eventName: string, ack: Message): void;
216
243
  onCommitEvent(eventName: string, message: Message): void;
244
+ onCommitResponseEvent(eventName: string, response: Message): void;
217
245
  onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
218
246
  onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
219
247
  onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
@@ -410,6 +438,7 @@ export interface Datasource extends DatasourceMetadata {
410
438
  // (undocumented)
411
439
  status: Partial<DatasourceStatus>;
412
440
  stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
441
+ triggerPoll(): void;
413
442
  updateData?(data: Array<any>): Promise<void>;
414
443
  updateItem?(itemId: string, data: any): Promise<void>;
415
444
  // @deprecated
@@ -853,6 +882,8 @@ export class DatasourceMock implements Datasource {
853
882
  // (undocumented)
854
883
  stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
855
884
  // (undocumented)
885
+ triggerPoll(): void;
886
+ // (undocumented)
856
887
  unsetMedata(): void;
857
888
  // (undocumented)
858
889
  unsetStream(): void;
@@ -875,6 +906,7 @@ export interface DatasourceOptions {
875
906
  movingView?: boolean;
876
907
  orderBy?: string;
877
908
  pollingInterval?: number;
909
+ pollTriggerEvents?: string[];
878
910
  request?: any;
879
911
  requestAutoSetup?: boolean;
880
912
  resourceName?: string;
@@ -992,6 +1024,10 @@ export const defaultConnectConfig: ConnectConfig;
992
1024
 
993
1025
  // @public
994
1026
  export class DefaultConnectEvents implements ConnectEventsEmitter {
1027
+ // 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
1028
+ //
1029
+ // (undocumented)
1030
+ addCommitAckListener(listener: Listener<CommitAckEvent>): () => void;
995
1031
  // 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
996
1032
  //
997
1033
  // (undocumented)
@@ -999,22 +1035,38 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
999
1035
  // 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
1000
1036
  //
1001
1037
  // (undocumented)
1038
+ addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
1039
+ // 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
1040
+ //
1041
+ // (undocumented)
1002
1042
  addMetadataListener(listener: Listener<MetadataEvent>): () => void;
1003
1043
  // 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
1004
1044
  //
1005
1045
  // (undocumented)
1006
1046
  addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
1007
1047
  // @internal (undocumented)
1048
+ protected commitAckListeners: Observer<CommitAckEvent>;
1049
+ // @internal (undocumented)
1008
1050
  protected commitListeners: Observer<CommitEvent>;
1009
1051
  // @internal (undocumented)
1052
+ protected commitResponseListeners: Observer<CommitResponseEvent>;
1053
+ // @internal (undocumented)
1010
1054
  protected metadataListeners: Observer<MetadataEvent>;
1011
1055
  // 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
1012
1056
  //
1013
1057
  // (undocumented)
1058
+ onCommitAckEvent(eventName: string, ack: Message): void;
1059
+ // 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
1060
+ //
1061
+ // (undocumented)
1014
1062
  onCommitEvent(eventName: string, message: Message): void;
1015
1063
  // 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
1016
1064
  //
1017
1065
  // (undocumented)
1066
+ onCommitResponseEvent(eventName: string, response: Message): void;
1067
+ // 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
1068
+ //
1069
+ // (undocumented)
1018
1070
  onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
1019
1071
  // 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
1020
1072
  //
@@ -1111,6 +1163,8 @@ export class DefaultDatasource implements Datasource {
1111
1163
  // (undocumented)
1112
1164
  protected connect: Connect;
1113
1165
  // (undocumented)
1166
+ protected connectEvents: ConnectEvents;
1167
+ // (undocumented)
1114
1168
  customRequestFields: MetadataDetail[];
1115
1169
  // (undocumented)
1116
1170
  get dataserverParams(): DataserverParams;
@@ -1162,6 +1216,8 @@ export class DefaultDatasource implements Datasource {
1162
1216
  status: DatasourceStatus;
1163
1217
  // (undocumented)
1164
1218
  stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
1219
+ // (undocumented)
1220
+ triggerPoll(): void;
1165
1221
  // @deprecated (undocumented)
1166
1222
  validResourceName(resourceName: string): boolean;
1167
1223
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-comms",
3
3
  "description": "Genesis Foundation UI Comms",
4
- "version": "14.291.2-alpha-309a406.0",
4
+ "version": "14.291.2-alpha-39f1157.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -75,23 +75,23 @@
75
75
  }
76
76
  },
77
77
  "devDependencies": {
78
- "@genesislcap/foundation-testing": "14.291.2-alpha-309a406.0",
79
- "@genesislcap/genx": "14.291.2-alpha-309a406.0",
80
- "@genesislcap/rollup-builder": "14.291.2-alpha-309a406.0",
81
- "@genesislcap/ts-builder": "14.291.2-alpha-309a406.0",
82
- "@genesislcap/uvu-playwright-builder": "14.291.2-alpha-309a406.0",
83
- "@genesislcap/vite-builder": "14.291.2-alpha-309a406.0",
84
- "@genesislcap/webpack-builder": "14.291.2-alpha-309a406.0",
78
+ "@genesislcap/foundation-testing": "14.291.2-alpha-39f1157.0",
79
+ "@genesislcap/genx": "14.291.2-alpha-39f1157.0",
80
+ "@genesislcap/rollup-builder": "14.291.2-alpha-39f1157.0",
81
+ "@genesislcap/ts-builder": "14.291.2-alpha-39f1157.0",
82
+ "@genesislcap/uvu-playwright-builder": "14.291.2-alpha-39f1157.0",
83
+ "@genesislcap/vite-builder": "14.291.2-alpha-39f1157.0",
84
+ "@genesislcap/webpack-builder": "14.291.2-alpha-39f1157.0",
85
85
  "@types/js-cookie": "^3.0.2",
86
86
  "@types/json-schema": "^7.0.11",
87
87
  "@types/webappsec-credential-management": "^0.6.2",
88
88
  "rimraf": "^5.0.0"
89
89
  },
90
90
  "dependencies": {
91
- "@genesislcap/foundation-broadcast-channel": "14.291.2-alpha-309a406.0",
92
- "@genesislcap/foundation-logger": "14.291.2-alpha-309a406.0",
93
- "@genesislcap/foundation-user": "14.291.2-alpha-309a406.0",
94
- "@genesislcap/foundation-utils": "14.291.2-alpha-309a406.0",
91
+ "@genesislcap/foundation-broadcast-channel": "14.291.2-alpha-39f1157.0",
92
+ "@genesislcap/foundation-logger": "14.291.2-alpha-39f1157.0",
93
+ "@genesislcap/foundation-user": "14.291.2-alpha-39f1157.0",
94
+ "@genesislcap/foundation-utils": "14.291.2-alpha-39f1157.0",
95
95
  "@microsoft/fast-element": "1.14.0",
96
96
  "@microsoft/fast-foundation": "2.49.6",
97
97
  "analytics": "^0.8.0",
@@ -111,5 +111,5 @@
111
111
  "publishConfig": {
112
112
  "access": "public"
113
113
  },
114
- "gitHead": "24efe1a72d3d4cc57955d1010966c0cc8cf69867"
114
+ "gitHead": "2cfbcb24b1fef701618d81ebba13623c87344ef9"
115
115
  }