@genesislcap/foundation-comms 14.291.2-alpha-39f1157.0 → 14.292.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.
- package/dist/dts/connect/connect.d.ts.map +1 -1
- package/dist/dts/connect/connect.events.d.ts +0 -64
- package/dist/dts/connect/connect.events.d.ts.map +1 -1
- package/dist/dts/connect/http.connect.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.config.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.d.ts +1 -9
- package/dist/dts/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.types.d.ts +0 -5
- package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
- package/dist/dts/testing/mocks/datasource/datasource.d.ts +0 -1
- package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
- package/dist/esm/connect/connect.events.js +0 -42
- package/dist/esm/connect/connect.js +1 -5
- package/dist/esm/connect/http.connect.js +3 -4
- package/dist/esm/connect/http.connect.types.js +3 -3
- package/dist/esm/datasource/datasource.config.js +0 -1
- package/dist/esm/datasource/datasource.js +8 -22
- package/dist/esm/testing/mocks/datasource/datasource.js +0 -3
- package/dist/foundation-comms.api.json +100 -917
- package/dist/foundation-comms.d.ts +0 -84
- package/docs/api/foundation-comms.connectevents.md +0 -2
- package/docs/api/foundation-comms.connecteventsemitter.md +0 -2
- package/docs/api/foundation-comms.datasource.md +0 -1
- package/docs/api/foundation-comms.datasourceoptions.md +0 -1
- package/docs/api/foundation-comms.defaultconnectevents.md +0 -4
- package/docs/api/foundation-comms.defaultdatasource.md +0 -2
- package/docs/api/foundation-comms.md +0 -6
- package/docs/api-report.md +0 -56
- package/package.json +13 -13
- package/docs/api/foundation-comms.commitackevent.md +0 -14
- package/docs/api/foundation-comms.commitackeventdetail.md +0 -17
- package/docs/api/foundation-comms.commitackeventtype.md +0 -12
- package/docs/api/foundation-comms.commitresponseevent.md +0 -14
- package/docs/api/foundation-comms.commitresponseeventdetail.md +0 -17
- package/docs/api/foundation-comms.commitresponseeventtype.md +0 -12
- package/docs/api/foundation-comms.connectevents.addcommitacklistener.md +0 -24
- package/docs/api/foundation-comms.connectevents.addcommitresponselistener.md +0 -24
- package/docs/api/foundation-comms.connecteventsemitter.oncommitackevent.md +0 -25
- package/docs/api/foundation-comms.connecteventsemitter.oncommitresponseevent.md +0 -25
- package/docs/api/foundation-comms.datasource.triggerpoll.md +0 -17
- package/docs/api/foundation-comms.datasourceoptions.polltriggerevents.md +0 -18
- package/docs/api/foundation-comms.defaultconnectevents.addcommitacklistener.md +0 -24
- package/docs/api/foundation-comms.defaultconnectevents.addcommitresponselistener.md +0 -24
- package/docs/api/foundation-comms.defaultconnectevents.oncommitackevent.md +0 -25
- package/docs/api/foundation-comms.defaultconnectevents.oncommitresponseevent.md +0 -25
- package/docs/api/foundation-comms.defaultdatasource.connectevents.md +0 -11
- package/docs/api/foundation-comms.defaultdatasource.triggerpoll.md +0 -15
@@ -155,24 +155,6 @@ export declare type BasicCredentialsInput = {
|
|
155
155
|
password: string;
|
156
156
|
};
|
157
157
|
|
158
|
-
/**
|
159
|
-
* @public
|
160
|
-
*/
|
161
|
-
export declare type CommitAckEvent = CustomEvent<CommitAckEventDetail>;
|
162
|
-
|
163
|
-
/**
|
164
|
-
* @public
|
165
|
-
*/
|
166
|
-
export declare type CommitAckEventDetail = {
|
167
|
-
eventName: string;
|
168
|
-
ack: Message;
|
169
|
-
};
|
170
|
-
|
171
|
-
/**
|
172
|
-
* @public
|
173
|
-
*/
|
174
|
-
export declare const CommitAckEventType = "connect-commit-ack-event";
|
175
|
-
|
176
158
|
/**
|
177
159
|
* @public
|
178
160
|
*/
|
@@ -203,24 +185,6 @@ export declare type CommitParams = {
|
|
203
185
|
[key: string]: any;
|
204
186
|
};
|
205
187
|
|
206
|
-
/**
|
207
|
-
* @public
|
208
|
-
*/
|
209
|
-
export declare type CommitResponseEvent = CustomEvent<CommitResponseEventDetail>;
|
210
|
-
|
211
|
-
/**
|
212
|
-
* @public
|
213
|
-
*/
|
214
|
-
export declare type CommitResponseEventDetail = {
|
215
|
-
eventName: string;
|
216
|
-
response: Message;
|
217
|
-
};
|
218
|
-
|
219
|
-
/**
|
220
|
-
* @public
|
221
|
-
*/
|
222
|
-
export declare const CommitResponseEventType = "connect-commit-response-event";
|
223
|
-
|
224
188
|
/**
|
225
189
|
* Represents a connection and its capabilities on a remote server
|
226
190
|
* Provides methods to send and receive messages, as well as metadata and schema information.
|
@@ -441,16 +405,6 @@ export declare interface ConnectEvents {
|
|
441
405
|
* @param listener - A listener callback function.
|
442
406
|
*/
|
443
407
|
addMetadataListener(listener: Listener<MetadataEvent>): () => void;
|
444
|
-
/**
|
445
|
-
* Add a commit ack listener.
|
446
|
-
* @param listener - A listener callback function.
|
447
|
-
*/
|
448
|
-
addCommitAckListener(listener: Listener<CommitAckEvent>): () => void;
|
449
|
-
/**
|
450
|
-
* Add a commit response listener (fires for both ack and nack).
|
451
|
-
* @param listener - A listener callback function.
|
452
|
-
*/
|
453
|
-
addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
|
454
408
|
}
|
455
409
|
|
456
410
|
/**
|
@@ -503,18 +457,6 @@ export declare interface ConnectEventsEmitter extends ConnectEvents {
|
|
503
457
|
* @param error - Optional error.
|
504
458
|
*/
|
505
459
|
onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
|
506
|
-
/**
|
507
|
-
* Called by Connect when a commit ack is received.
|
508
|
-
* @param eventName - The name of the event.
|
509
|
-
* @param ack - The ack message from the server.
|
510
|
-
*/
|
511
|
-
onCommitAckEvent(eventName: string, ack: Message): void;
|
512
|
-
/**
|
513
|
-
* Called by Connect when a commit response (ack or nack) is received.
|
514
|
-
* @param eventName - The name of the event.
|
515
|
-
* @param response - The response message from the server (ack or nack).
|
516
|
-
*/
|
517
|
-
onCommitResponseEvent(eventName: string, response: Message): void;
|
518
460
|
}
|
519
461
|
|
520
462
|
/**
|
@@ -1053,11 +995,6 @@ export declare interface Datasource extends DatasourceMetadata {
|
|
1053
995
|
* @returns A promise that resolves when the item has been updated.
|
1054
996
|
*/
|
1055
997
|
updateItem?(itemId: string, data: any): Promise<void>;
|
1056
|
-
/**
|
1057
|
-
* Triggers a manual poll of the data source.
|
1058
|
-
* @public
|
1059
|
-
*/
|
1060
|
-
triggerPoll(): void;
|
1061
998
|
}
|
1062
999
|
|
1063
1000
|
/**
|
@@ -1489,7 +1426,6 @@ export declare interface DatasourceMetadata {
|
|
1489
1426
|
* @internal
|
1490
1427
|
*/
|
1491
1428
|
export declare class DatasourceMock implements Datasource {
|
1492
|
-
triggerPoll(): void;
|
1493
1429
|
status: DatasourceStatus;
|
1494
1430
|
fetchMetadataRequired: boolean;
|
1495
1431
|
protected fetchingMetadata: boolean;
|
@@ -1603,11 +1539,6 @@ export declare interface DatasourceOptions {
|
|
1603
1539
|
* @remarks Only works with REQUEST_SERVER resources.
|
1604
1540
|
*/
|
1605
1541
|
request?: any;
|
1606
|
-
/**
|
1607
|
-
* Array of event names that will trigger an additional poll.
|
1608
|
-
* @remarks Only works with REQUEST_SERVER resources.
|
1609
|
-
*/
|
1610
|
-
pollTriggerEvents?: string[];
|
1611
1542
|
/**
|
1612
1543
|
* Whether the Datasource service will setup RQUEST object based on metadata.
|
1613
1544
|
* @remarks Default is `true`. Only works with REQUEST_SERVER resources.
|
@@ -1792,18 +1723,6 @@ export declare class DefaultConnectEvents implements ConnectEventsEmitter {
|
|
1792
1723
|
addMetadataListener(listener: Listener<MetadataEvent>): () => void;
|
1793
1724
|
/** {@inheritDoc ConnectEventsEmitter.onMetadataEvent} */
|
1794
1725
|
onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
|
1795
|
-
/** @internal */
|
1796
|
-
protected commitAckListeners: Observer<CommitAckEvent>;
|
1797
|
-
/** {@inheritDoc ConnectEvents.addCommitAckListener} */
|
1798
|
-
addCommitAckListener(listener: Listener<CommitAckEvent>): () => void;
|
1799
|
-
/** {@inheritDoc ConnectEventsEmitter.onCommitAckEvent} */
|
1800
|
-
onCommitAckEvent(eventName: string, ack: Message): void;
|
1801
|
-
/** @internal */
|
1802
|
-
protected commitResponseListeners: Observer<CommitResponseEvent>;
|
1803
|
-
/** {@inheritDoc ConnectEvents.addCommitResponseListener} */
|
1804
|
-
addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
|
1805
|
-
/** {@inheritDoc ConnectEventsEmitter.onCommitResponseEvent} */
|
1806
|
-
onCommitResponseEvent(eventName: string, response: Message): void;
|
1807
1726
|
}
|
1808
1727
|
|
1809
1728
|
/**
|
@@ -1886,10 +1805,7 @@ export declare class DefaultDatasource implements Datasource {
|
|
1886
1805
|
protected options: DatasourceOptions;
|
1887
1806
|
resourceType: ResourceType;
|
1888
1807
|
stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
|
1889
|
-
protected connectEvents: ConnectEvents;
|
1890
1808
|
constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig);
|
1891
|
-
private pollTrigger$;
|
1892
|
-
triggerPoll(): void;
|
1893
1809
|
/**
|
1894
1810
|
* @deprecated - Please use {@link (GenesisResources:interface).isValidResource} instead.
|
1895
1811
|
*/
|
@@ -16,9 +16,7 @@ export interface ConnectEvents
|
|
16
16
|
|
17
17
|
| Method | Description |
|
18
18
|
| --- | --- |
|
19
|
-
| [addCommitAckListener(listener)](./foundation-comms.connectevents.addcommitacklistener.md) | Add a commit ack listener. |
|
20
19
|
| [addCommitListener(listener)](./foundation-comms.connectevents.addcommitlistener.md) | Add a commit listener. |
|
21
|
-
| [addCommitResponseListener(listener)](./foundation-comms.connectevents.addcommitresponselistener.md) | Add a commit response listener (fires for both ack and nack). |
|
22
20
|
| [addMetadataListener(listener)](./foundation-comms.connectevents.addmetadatalistener.md) | Add a metadata listener. |
|
23
21
|
| [addStreamListener(listener, complete, error)](./foundation-comms.connectevents.addstreamlistener.md) | Add a stream listener. |
|
24
22
|
|
@@ -17,9 +17,7 @@ export interface ConnectEventsEmitter extends ConnectEvents
|
|
17
17
|
|
18
18
|
| Method | Description |
|
19
19
|
| --- | --- |
|
20
|
-
| [onCommitAckEvent(eventName, ack)](./foundation-comms.connecteventsemitter.oncommitackevent.md) | Called by Connect when a commit ack is received. |
|
21
20
|
| [onCommitEvent(eventName, message)](./foundation-comms.connecteventsemitter.oncommitevent.md) | Called by Connect. |
|
22
|
-
| [onCommitResponseEvent(eventName, response)](./foundation-comms.connecteventsemitter.oncommitresponseevent.md) | Called by Connect when a commit response (ack or nack) is received. |
|
23
21
|
| [onMetadataEvent(resourceName, message, error)](./foundation-comms.connecteventsemitter.onmetadataevent.md) | Called by Connect. |
|
24
22
|
| [onStreamCompleteEvent(resourceName, stream)](./foundation-comms.connecteventsemitter.onstreamcompleteevent.md) | Called by Connect. |
|
25
23
|
| [onStreamErrorEvent(resourceName, stream, error)](./foundation-comms.connecteventsemitter.onstreamerrorevent.md) | Called by Connect. |
|
@@ -44,7 +44,6 @@ The public interface available on the injected store fragment.
|
|
44
44
|
| [snapshot(overrideParams)](./foundation-comms.datasource.snapshot.md) | Takes a snapshot of the data in the datasource. |
|
45
45
|
| [snapshotFiltered(rowId)](./foundation-comms.datasource.snapshotfiltered.md) | Takes a filtered snapshot of the data in the datasource. |
|
46
46
|
| [startStream()](./foundation-comms.datasource.startstream.md) | Starts the data stream for the datasource. |
|
47
|
-
| [triggerPoll()](./foundation-comms.datasource.triggerpoll.md) | Triggers a manual poll of the data source. |
|
48
47
|
| [updateData(data)?](./foundation-comms.datasource.updatedata.md) | _(Optional)_ Updates the data in the datasource with the specified data. |
|
49
48
|
| [updateItem(itemId, data)?](./foundation-comms.datasource.updateitem.md) | _(Optional)_ Updates an item in the datasource with the given ID and data. |
|
50
49
|
| [validResourceName(resourceName)](./foundation-comms.datasource.validresourcename.md) | Indicates whether the resourceName is valid or not. |
|
@@ -25,7 +25,6 @@ export interface DatasourceOptions
|
|
25
25
|
| [movingView?](./foundation-comms.datasourceoptions.movingview.md) | | boolean | _(Optional)_ Defines the behaviour of the client view when new rows are received in real time. |
|
26
26
|
| [orderBy?](./foundation-comms.datasourceoptions.orderby.md) | | string | _(Optional)_ The field to use for sorting the data. |
|
27
27
|
| [pollingInterval?](./foundation-comms.datasourceoptions.pollinginterval.md) | | number | _(Optional)_ The polling interval to use when using request/reply. |
|
28
|
-
| [pollTriggerEvents?](./foundation-comms.datasourceoptions.polltriggerevents.md) | | string\[\] | _(Optional)_ Array of event names that will trigger an additional poll. |
|
29
28
|
| [request?](./foundation-comms.datasourceoptions.request.md) | | any | _(Optional)_ The request to send to the server. |
|
30
29
|
| [requestAutoSetup?](./foundation-comms.datasourceoptions.requestautosetup.md) | | boolean | _(Optional)_ Whether the Datasource service will setup RQUEST object based on metadata. |
|
31
30
|
| [resourceName?](./foundation-comms.datasourceoptions.resourcename.md) | | string | _(Optional)_ The name of the resource to use for the datasource. |
|
@@ -17,14 +17,10 @@ export declare class DefaultConnectEvents implements ConnectEventsEmitter
|
|
17
17
|
|
18
18
|
| Method | Modifiers | Description |
|
19
19
|
| --- | --- | --- |
|
20
|
-
| [addCommitAckListener(listener)](./foundation-comms.defaultconnectevents.addcommitacklistener.md) | | Add a commit ack listener. |
|
21
20
|
| [addCommitListener(listener)](./foundation-comms.defaultconnectevents.addcommitlistener.md) | | Add a commit listener. |
|
22
|
-
| [addCommitResponseListener(listener)](./foundation-comms.defaultconnectevents.addcommitresponselistener.md) | | Add a commit response listener (fires for both ack and nack). |
|
23
21
|
| [addMetadataListener(listener)](./foundation-comms.defaultconnectevents.addmetadatalistener.md) | | Add a metadata listener. |
|
24
22
|
| [addStreamListener(listener, complete, error)](./foundation-comms.defaultconnectevents.addstreamlistener.md) | | Add a stream listener. |
|
25
|
-
| [onCommitAckEvent(eventName, ack)](./foundation-comms.defaultconnectevents.oncommitackevent.md) | | Called by Connect when a commit ack is received. |
|
26
23
|
| [onCommitEvent(eventName, message)](./foundation-comms.defaultconnectevents.oncommitevent.md) | | Called by Connect. |
|
27
|
-
| [onCommitResponseEvent(eventName, response)](./foundation-comms.defaultconnectevents.oncommitresponseevent.md) | | Called by Connect when a commit response (ack or nack) is received. |
|
28
24
|
| [onMetadataEvent(resourceName, message, error)](./foundation-comms.defaultconnectevents.onmetadataevent.md) | | Called by Connect. |
|
29
25
|
| [onStreamCompleteEvent(resourceName, stream)](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md) | | Called by Connect. |
|
30
26
|
| [onStreamErrorEvent(resourceName, stream, error)](./foundation-comms.defaultconnectevents.onstreamerrorevent.md) | | Called by Connect. |
|
@@ -28,7 +28,6 @@ export declare class DefaultDatasource implements Datasource
|
|
28
28
|
| [availableIndexes](./foundation-comms.defaultdatasource.availableindexes.md) | | [IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\] | |
|
29
29
|
| [config](./foundation-comms.defaultdatasource.config.md) | <code>protected</code> | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | |
|
30
30
|
| [connect](./foundation-comms.defaultdatasource.connect.md) | <code>protected</code> | [Connect](./foundation-comms.connect.md) | |
|
31
|
-
| [connectEvents](./foundation-comms.defaultdatasource.connectevents.md) | <code>protected</code> | [ConnectEvents](./foundation-comms.connectevents.md) | |
|
32
31
|
| [customRequestFields](./foundation-comms.defaultdatasource.customrequestfields.md) | | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
|
33
32
|
| [dataserverParams](./foundation-comms.defaultdatasource.dataserverparams.md) | <code>readonly</code> | [DataserverParams](./foundation-comms.dataserverparams.md) | |
|
34
33
|
| [fetchMetadataRequired](./foundation-comms.defaultdatasource.fetchmetadatarequired.md) | | boolean | |
|
@@ -55,6 +54,5 @@ export declare class DefaultDatasource implements Datasource
|
|
55
54
|
| [snapshot(overrideParams)](./foundation-comms.defaultdatasource.snapshot.md) | | |
|
56
55
|
| [snapshotFiltered(rowId)](./foundation-comms.defaultdatasource.snapshotfiltered.md) | | |
|
57
56
|
| [startStream()](./foundation-comms.defaultdatasource.startstream.md) | | |
|
58
|
-
| [triggerPoll()](./foundation-comms.defaultdatasource.triggerpoll.md) | | |
|
59
57
|
| [validResourceName(resourceName)](./foundation-comms.defaultdatasource.validresourcename.md) | | |
|
60
58
|
|
@@ -111,9 +111,7 @@
|
|
111
111
|
|
112
112
|
| Variable | Description |
|
113
113
|
| --- | --- |
|
114
|
-
| [CommitAckEventType](./foundation-comms.commitackeventtype.md) | |
|
115
114
|
| [CommitEventType](./foundation-comms.commiteventtype.md) | |
|
116
|
-
| [CommitResponseEventType](./foundation-comms.commitresponseeventtype.md) | |
|
117
115
|
| [credentialSeparator](./foundation-comms.credentialseparator.md) | The default separator used for splitting credential parts. |
|
118
116
|
| [DatasourceEventHandler](./foundation-comms.datasourceeventhandler.md) | Datasource event handler mixin for target classes that use or are interested in datasource status changes. |
|
119
117
|
| [DatasourceStatusChanged](./foundation-comms.datasourcestatuschanged.md) | DatasourceStatusChanged. |
|
@@ -149,13 +147,9 @@
|
|
149
147
|
| [AuthInfo](./foundation-comms.authinfo.md) | Union type of all authentication information types. |
|
150
148
|
| [BasicAuthInfo](./foundation-comms.basicauthinfo.md) | Represents basic authentication information. |
|
151
149
|
| [BasicCredentialsInput](./foundation-comms.basiccredentialsinput.md) | Represents basic credentials for a user. |
|
152
|
-
| [CommitAckEvent](./foundation-comms.commitackevent.md) | |
|
153
|
-
| [CommitAckEventDetail](./foundation-comms.commitackeventdetail.md) | |
|
154
150
|
| [CommitEvent](./foundation-comms.commitevent.md) | |
|
155
151
|
| [CommitEventDetail](./foundation-comms.commiteventdetail.md) | |
|
156
152
|
| [CommitParams](./foundation-comms.commitparams.md) | Parameters for a COMMIT message |
|
157
|
-
| [CommitResponseEvent](./foundation-comms.commitresponseevent.md) | |
|
158
|
-
| [CommitResponseEventDetail](./foundation-comms.commitresponseeventdetail.md) | |
|
159
153
|
| [ConnectionStatus](./foundation-comms.connectionstatus.md) | The connection status of the Genesis client. |
|
160
154
|
| [CredentialData\_2](./foundation-comms.credentialdata_2.md) | Represents user credentials. |
|
161
155
|
| [DataserverParams](./foundation-comms.dataserverparams.md) | Parameters for a DATA\_LOGON messages |
|
package/docs/api-report.md
CHANGED
@@ -127,18 +127,6 @@ 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
|
-
|
142
130
|
// @public (undocumented)
|
143
131
|
export type CommitEvent = CustomEvent<CommitEventDetail>;
|
144
132
|
|
@@ -160,18 +148,6 @@ export type CommitParams = {
|
|
160
148
|
[key: string]: any;
|
161
149
|
};
|
162
150
|
|
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
|
-
|
175
151
|
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Connect" because one of its declarations is marked as @internal
|
176
152
|
//
|
177
153
|
// @public
|
@@ -225,9 +201,7 @@ export const ConnectConfig: InterfaceSymbol<ConnectConfig>;
|
|
225
201
|
//
|
226
202
|
// @public
|
227
203
|
export interface ConnectEvents {
|
228
|
-
addCommitAckListener(listener: Listener<CommitAckEvent>): () => void;
|
229
204
|
addCommitListener(listener: Listener<CommitEvent>): () => void;
|
230
|
-
addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
|
231
205
|
addMetadataListener(listener: Listener<MetadataEvent>): () => void;
|
232
206
|
addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
|
233
207
|
}
|
@@ -239,9 +213,7 @@ export const ConnectEvents: InterfaceSymbol<ConnectEvents>;
|
|
239
213
|
//
|
240
214
|
// @public
|
241
215
|
export interface ConnectEventsEmitter extends ConnectEvents {
|
242
|
-
onCommitAckEvent(eventName: string, ack: Message): void;
|
243
216
|
onCommitEvent(eventName: string, message: Message): void;
|
244
|
-
onCommitResponseEvent(eventName: string, response: Message): void;
|
245
217
|
onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
|
246
218
|
onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
|
247
219
|
onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
|
@@ -438,7 +410,6 @@ export interface Datasource extends DatasourceMetadata {
|
|
438
410
|
// (undocumented)
|
439
411
|
status: Partial<DatasourceStatus>;
|
440
412
|
stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
|
441
|
-
triggerPoll(): void;
|
442
413
|
updateData?(data: Array<any>): Promise<void>;
|
443
414
|
updateItem?(itemId: string, data: any): Promise<void>;
|
444
415
|
// @deprecated
|
@@ -882,8 +853,6 @@ export class DatasourceMock implements Datasource {
|
|
882
853
|
// (undocumented)
|
883
854
|
stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
|
884
855
|
// (undocumented)
|
885
|
-
triggerPoll(): void;
|
886
|
-
// (undocumented)
|
887
856
|
unsetMedata(): void;
|
888
857
|
// (undocumented)
|
889
858
|
unsetStream(): void;
|
@@ -906,7 +875,6 @@ export interface DatasourceOptions {
|
|
906
875
|
movingView?: boolean;
|
907
876
|
orderBy?: string;
|
908
877
|
pollingInterval?: number;
|
909
|
-
pollTriggerEvents?: string[];
|
910
878
|
request?: any;
|
911
879
|
requestAutoSetup?: boolean;
|
912
880
|
resourceName?: string;
|
@@ -1024,10 +992,6 @@ export const defaultConnectConfig: ConnectConfig;
|
|
1024
992
|
|
1025
993
|
// @public
|
1026
994
|
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;
|
1031
995
|
// 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
|
1032
996
|
//
|
1033
997
|
// (undocumented)
|
@@ -1035,38 +999,22 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
|
|
1035
999
|
// 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
|
1036
1000
|
//
|
1037
1001
|
// (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)
|
1042
1002
|
addMetadataListener(listener: Listener<MetadataEvent>): () => void;
|
1043
1003
|
// 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
|
1044
1004
|
//
|
1045
1005
|
// (undocumented)
|
1046
1006
|
addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
|
1047
1007
|
// @internal (undocumented)
|
1048
|
-
protected commitAckListeners: Observer<CommitAckEvent>;
|
1049
|
-
// @internal (undocumented)
|
1050
1008
|
protected commitListeners: Observer<CommitEvent>;
|
1051
1009
|
// @internal (undocumented)
|
1052
|
-
protected commitResponseListeners: Observer<CommitResponseEvent>;
|
1053
|
-
// @internal (undocumented)
|
1054
1010
|
protected metadataListeners: Observer<MetadataEvent>;
|
1055
1011
|
// 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
|
1056
1012
|
//
|
1057
1013
|
// (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)
|
1062
1014
|
onCommitEvent(eventName: string, message: Message): void;
|
1063
1015
|
// 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
|
1064
1016
|
//
|
1065
1017
|
// (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)
|
1070
1018
|
onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
|
1071
1019
|
// 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
|
1072
1020
|
//
|
@@ -1163,8 +1111,6 @@ export class DefaultDatasource implements Datasource {
|
|
1163
1111
|
// (undocumented)
|
1164
1112
|
protected connect: Connect;
|
1165
1113
|
// (undocumented)
|
1166
|
-
protected connectEvents: ConnectEvents;
|
1167
|
-
// (undocumented)
|
1168
1114
|
customRequestFields: MetadataDetail[];
|
1169
1115
|
// (undocumented)
|
1170
1116
|
get dataserverParams(): DataserverParams;
|
@@ -1216,8 +1162,6 @@ export class DefaultDatasource implements Datasource {
|
|
1216
1162
|
status: DatasourceStatus;
|
1217
1163
|
// (undocumented)
|
1218
1164
|
stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
|
1219
|
-
// (undocumented)
|
1220
|
-
triggerPoll(): void;
|
1221
1165
|
// @deprecated (undocumented)
|
1222
1166
|
validResourceName(resourceName: string): boolean;
|
1223
1167
|
}
|
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.
|
4
|
+
"version": "14.292.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.
|
79
|
-
"@genesislcap/genx": "14.
|
80
|
-
"@genesislcap/rollup-builder": "14.
|
81
|
-
"@genesislcap/ts-builder": "14.
|
82
|
-
"@genesislcap/uvu-playwright-builder": "14.
|
83
|
-
"@genesislcap/vite-builder": "14.
|
84
|
-
"@genesislcap/webpack-builder": "14.
|
78
|
+
"@genesislcap/foundation-testing": "14.292.0",
|
79
|
+
"@genesislcap/genx": "14.292.0",
|
80
|
+
"@genesislcap/rollup-builder": "14.292.0",
|
81
|
+
"@genesislcap/ts-builder": "14.292.0",
|
82
|
+
"@genesislcap/uvu-playwright-builder": "14.292.0",
|
83
|
+
"@genesislcap/vite-builder": "14.292.0",
|
84
|
+
"@genesislcap/webpack-builder": "14.292.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.
|
92
|
-
"@genesislcap/foundation-logger": "14.
|
93
|
-
"@genesislcap/foundation-user": "14.
|
94
|
-
"@genesislcap/foundation-utils": "14.
|
91
|
+
"@genesislcap/foundation-broadcast-channel": "14.292.0",
|
92
|
+
"@genesislcap/foundation-logger": "14.292.0",
|
93
|
+
"@genesislcap/foundation-user": "14.292.0",
|
94
|
+
"@genesislcap/foundation-utils": "14.292.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": "
|
114
|
+
"gitHead": "1f6610ae9f53c6ac06b8e2c4921bb6ff7a404902"
|
115
115
|
}
|
@@ -1,14 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [CommitAckEvent](./foundation-comms.commitackevent.md)
|
4
|
-
|
5
|
-
## CommitAckEvent type
|
6
|
-
|
7
|
-
|
8
|
-
**Signature:**
|
9
|
-
|
10
|
-
```typescript
|
11
|
-
export type CommitAckEvent = CustomEvent<CommitAckEventDetail>;
|
12
|
-
```
|
13
|
-
**References:** [CommitAckEventDetail](./foundation-comms.commitackeventdetail.md)
|
14
|
-
|
@@ -1,17 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [CommitAckEventDetail](./foundation-comms.commitackeventdetail.md)
|
4
|
-
|
5
|
-
## CommitAckEventDetail type
|
6
|
-
|
7
|
-
|
8
|
-
**Signature:**
|
9
|
-
|
10
|
-
```typescript
|
11
|
-
export type CommitAckEventDetail = {
|
12
|
-
eventName: string;
|
13
|
-
ack: Message;
|
14
|
-
};
|
15
|
-
```
|
16
|
-
**References:** [Message](./foundation-comms.message.md)
|
17
|
-
|
@@ -1,12 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [CommitAckEventType](./foundation-comms.commitackeventtype.md)
|
4
|
-
|
5
|
-
## CommitAckEventType variable
|
6
|
-
|
7
|
-
|
8
|
-
**Signature:**
|
9
|
-
|
10
|
-
```typescript
|
11
|
-
CommitAckEventType = "connect-commit-ack-event"
|
12
|
-
```
|
@@ -1,14 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [CommitResponseEvent](./foundation-comms.commitresponseevent.md)
|
4
|
-
|
5
|
-
## CommitResponseEvent type
|
6
|
-
|
7
|
-
|
8
|
-
**Signature:**
|
9
|
-
|
10
|
-
```typescript
|
11
|
-
export type CommitResponseEvent = CustomEvent<CommitResponseEventDetail>;
|
12
|
-
```
|
13
|
-
**References:** [CommitResponseEventDetail](./foundation-comms.commitresponseeventdetail.md)
|
14
|
-
|
@@ -1,17 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [CommitResponseEventDetail](./foundation-comms.commitresponseeventdetail.md)
|
4
|
-
|
5
|
-
## CommitResponseEventDetail type
|
6
|
-
|
7
|
-
|
8
|
-
**Signature:**
|
9
|
-
|
10
|
-
```typescript
|
11
|
-
export type CommitResponseEventDetail = {
|
12
|
-
eventName: string;
|
13
|
-
response: Message;
|
14
|
-
};
|
15
|
-
```
|
16
|
-
**References:** [Message](./foundation-comms.message.md)
|
17
|
-
|
@@ -1,12 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [CommitResponseEventType](./foundation-comms.commitresponseeventtype.md)
|
4
|
-
|
5
|
-
## CommitResponseEventType variable
|
6
|
-
|
7
|
-
|
8
|
-
**Signature:**
|
9
|
-
|
10
|
-
```typescript
|
11
|
-
CommitResponseEventType = "connect-commit-response-event"
|
12
|
-
```
|
@@ -1,24 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [ConnectEvents](./foundation-comms.connectevents.md) > [addCommitAckListener](./foundation-comms.connectevents.addcommitacklistener.md)
|
4
|
-
|
5
|
-
## ConnectEvents.addCommitAckListener() method
|
6
|
-
|
7
|
-
Add a commit ack listener.
|
8
|
-
|
9
|
-
**Signature:**
|
10
|
-
|
11
|
-
```typescript
|
12
|
-
addCommitAckListener(listener: Listener<CommitAckEvent>): () => void;
|
13
|
-
```
|
14
|
-
|
15
|
-
## Parameters
|
16
|
-
|
17
|
-
| Parameter | Type | Description |
|
18
|
-
| --- | --- | --- |
|
19
|
-
| listener | Listener<[CommitAckEvent](./foundation-comms.commitackevent.md)<!-- -->> | A listener callback function. |
|
20
|
-
|
21
|
-
**Returns:**
|
22
|
-
|
23
|
-
() => void
|
24
|
-
|
@@ -1,24 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [ConnectEvents](./foundation-comms.connectevents.md) > [addCommitResponseListener](./foundation-comms.connectevents.addcommitresponselistener.md)
|
4
|
-
|
5
|
-
## ConnectEvents.addCommitResponseListener() method
|
6
|
-
|
7
|
-
Add a commit response listener (fires for both ack and nack).
|
8
|
-
|
9
|
-
**Signature:**
|
10
|
-
|
11
|
-
```typescript
|
12
|
-
addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
|
13
|
-
```
|
14
|
-
|
15
|
-
## Parameters
|
16
|
-
|
17
|
-
| Parameter | Type | Description |
|
18
|
-
| --- | --- | --- |
|
19
|
-
| listener | Listener<[CommitResponseEvent](./foundation-comms.commitresponseevent.md)<!-- -->> | A listener callback function. |
|
20
|
-
|
21
|
-
**Returns:**
|
22
|
-
|
23
|
-
() => void
|
24
|
-
|
@@ -1,25 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) > [onCommitAckEvent](./foundation-comms.connecteventsemitter.oncommitackevent.md)
|
4
|
-
|
5
|
-
## ConnectEventsEmitter.onCommitAckEvent() method
|
6
|
-
|
7
|
-
Called by Connect when a commit ack is received.
|
8
|
-
|
9
|
-
**Signature:**
|
10
|
-
|
11
|
-
```typescript
|
12
|
-
onCommitAckEvent(eventName: string, ack: Message): void;
|
13
|
-
```
|
14
|
-
|
15
|
-
## Parameters
|
16
|
-
|
17
|
-
| Parameter | Type | Description |
|
18
|
-
| --- | --- | --- |
|
19
|
-
| eventName | string | The name of the event. |
|
20
|
-
| ack | [Message](./foundation-comms.message.md) | The ack message from the server. |
|
21
|
-
|
22
|
-
**Returns:**
|
23
|
-
|
24
|
-
void
|
25
|
-
|
@@ -1,25 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) > [onCommitResponseEvent](./foundation-comms.connecteventsemitter.oncommitresponseevent.md)
|
4
|
-
|
5
|
-
## ConnectEventsEmitter.onCommitResponseEvent() method
|
6
|
-
|
7
|
-
Called by Connect when a commit response (ack or nack) is received.
|
8
|
-
|
9
|
-
**Signature:**
|
10
|
-
|
11
|
-
```typescript
|
12
|
-
onCommitResponseEvent(eventName: string, response: Message): void;
|
13
|
-
```
|
14
|
-
|
15
|
-
## Parameters
|
16
|
-
|
17
|
-
| Parameter | Type | Description |
|
18
|
-
| --- | --- | --- |
|
19
|
-
| eventName | string | The name of the event. |
|
20
|
-
| response | [Message](./foundation-comms.message.md) | The response message from the server (ack or nack). |
|
21
|
-
|
22
|
-
**Returns:**
|
23
|
-
|
24
|
-
void
|
25
|
-
|