@genesislcap/foundation-comms 14.167.3-alpha-69ba23f.0 → 14.168.0
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/dts/auth/auth.d.ts.map +1 -1
- package/dist/dts/connect/connect.d.ts +11 -1
- package/dist/dts/connect/connect.d.ts.map +1 -1
- package/dist/dts/connect/connect.events.d.ts +173 -0
- package/dist/dts/connect/connect.events.d.ts.map +1 -0
- package/dist/dts/connect/http.connect.d.ts +1 -0
- package/dist/dts/connect/http.connect.d.ts.map +1 -1
- package/dist/dts/connect/index.d.ts +2 -0
- package/dist/dts/connect/index.d.ts.map +1 -1
- package/dist/dts/connect/message.d.ts +51 -0
- package/dist/dts/connect/message.d.ts.map +1 -1
- package/dist/dts/connect/socket.d.ts +72 -8
- package/dist/dts/connect/socket.d.ts.map +1 -1
- package/dist/dts/connect/socket.status.d.ts +79 -0
- package/dist/dts/connect/socket.status.d.ts.map +1 -0
- package/dist/dts/datasource/datasource.d.ts +9 -0
- package/dist/dts/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/fdc3/fdc3.d.ts +17 -1
- package/dist/dts/fdc3/fdc3.d.ts.map +1 -1
- package/dist/dts/index.d.ts +1 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/networkMonitor/config.d.ts +56 -0
- package/dist/dts/networkMonitor/config.d.ts.map +1 -0
- package/dist/dts/networkMonitor/index.d.ts +4 -0
- package/dist/dts/networkMonitor/index.d.ts.map +1 -0
- package/dist/dts/networkMonitor/service.d.ts +193 -0
- package/dist/dts/networkMonitor/service.d.ts.map +1 -0
- package/dist/dts/networkMonitor/types.d.ts +133 -0
- package/dist/dts/networkMonitor/types.d.ts.map +1 -0
- package/dist/dts/testing/mocks/connect/connect.d.ts +1 -0
- package/dist/dts/testing/mocks/connect/connect.d.ts.map +1 -1
- package/dist/dts/testing/mocks/connect/socket.d.ts +5 -1
- package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
- package/dist/dts/testing/mocks/datasource/datasource.d.ts +1 -0
- package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/user/user.d.ts +15 -0
- package/dist/dts/user/user.d.ts.map +1 -1
- package/dist/esm/auth/auth.js +5 -2
- package/dist/esm/connect/connect.events.js +113 -0
- package/dist/esm/connect/connect.js +30 -8
- package/dist/esm/connect/http.connect.js +6 -0
- package/dist/esm/connect/index.js +2 -0
- package/dist/esm/connect/message.js +25 -4
- package/dist/esm/connect/socket.js +113 -44
- package/dist/esm/connect/socket.status.js +119 -0
- package/dist/esm/datasource/datasource.js +18 -8
- package/dist/esm/fdc3/fdc3.js +4 -4
- package/dist/esm/index.js +1 -0
- package/dist/esm/networkMonitor/config.js +46 -0
- package/dist/esm/networkMonitor/index.js +3 -0
- package/dist/esm/networkMonitor/service.js +445 -0
- package/dist/esm/networkMonitor/types.js +5 -0
- package/dist/esm/testing/mocks/connect/connect.js +3 -0
- package/dist/esm/testing/mocks/connect/socket.js +1 -1
- package/dist/esm/testing/mocks/datasource/datasource.js +1 -0
- package/dist/esm/user/user.js +22 -1
- package/dist/foundation-comms.api.json +14711 -8166
- package/dist/foundation-comms.d.ts +841 -13
- package/docs/api/foundation-comms.commitevent.md +14 -0
- package/docs/api/foundation-comms.commiteventdetail.md +17 -0
- package/docs/api/foundation-comms.commiteventtype.md +12 -0
- package/docs/api/foundation-comms.connect.getmorecolumns.md +26 -0
- package/docs/api/foundation-comms.connect.md +1 -0
- package/docs/api/foundation-comms.connectevents.addcommitlistener.md +24 -0
- package/docs/api/foundation-comms.connectevents.addmetadatalistener.md +24 -0
- package/docs/api/foundation-comms.connectevents.addstreamlistener.md +25 -0
- package/docs/api/foundation-comms.connectevents.md +22 -0
- package/docs/api/foundation-comms.connecteventsemitter.md +24 -0
- package/docs/api/foundation-comms.connecteventsemitter.oncommitevent.md +25 -0
- package/docs/api/foundation-comms.connecteventsemitter.onmetadataevent.md +26 -0
- package/docs/api/foundation-comms.connecteventsemitter.onstreamcompleteevent.md +24 -0
- package/docs/api/foundation-comms.connecteventsemitter.onstreamevent.md +27 -0
- package/docs/api/foundation-comms.currentuser.md +2 -0
- package/docs/api/foundation-comms.currentuser.set.md +22 -0
- package/docs/api/foundation-comms.currentuser.unset.md +15 -0
- package/docs/api/foundation-comms.datasource.destroy.md +17 -0
- package/docs/api/foundation-comms.datasource.md +1 -0
- package/docs/api/foundation-comms.defaultconnect._constructor_.md +2 -1
- package/docs/api/foundation-comms.defaultconnect.getmorecolumns.md +22 -0
- package/docs/api/foundation-comms.defaultconnect.md +2 -1
- package/docs/api/foundation-comms.defaultconnectevents.addcommitlistener.md +24 -0
- package/docs/api/foundation-comms.defaultconnectevents.addmetadatalistener.md +24 -0
- package/docs/api/foundation-comms.defaultconnectevents.addstreamlistener.md +25 -0
- package/docs/api/foundation-comms.defaultconnectevents.md +27 -0
- package/docs/api/foundation-comms.defaultconnectevents.oncommitevent.md +25 -0
- package/docs/api/foundation-comms.defaultconnectevents.onmetadataevent.md +26 -0
- package/docs/api/foundation-comms.defaultconnectevents.onstreamcompleteevent.md +24 -0
- package/docs/api/foundation-comms.defaultconnectevents.onstreamevent.md +27 -0
- package/docs/api/foundation-comms.defaultdatasource.destroy.md +17 -0
- package/docs/api/foundation-comms.defaultdatasource.md +1 -0
- package/docs/api/foundation-comms.defaulthttpconnect.getmorecolumns.md +22 -0
- package/docs/api/foundation-comms.defaulthttpconnect.md +1 -0
- package/docs/api/foundation-comms.defaultmessagebuilder._constructor_.md +21 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createchangepasswordmessage.md +24 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createcommitmessage.md +23 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogoffmessage.md +22 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogonmessage.md +23 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md +24 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md +25 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.md +23 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createloginmessage.md +22 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createlogoutmessage.md +22 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createmetarequestmessage.md +23 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createmorecolumnsmessage.md +22 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +22 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createrefreshtokenmessage.md +15 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createrequestmessage.md +23 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createresourcesmessage.md +22 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.md +41 -0
- package/docs/api/foundation-comms.defaultnetworkmonitor.addresource.md +23 -0
- package/docs/api/foundation-comms.defaultnetworkmonitor.create.md +16 -0
- package/docs/api/foundation-comms.defaultnetworkmonitor.destroy.md +16 -0
- package/docs/api/foundation-comms.defaultnetworkmonitor.md +31 -0
- package/docs/api/foundation-comms.defaultnetworkmonitor.removeresource.md +22 -0
- package/docs/api/foundation-comms.defaultnetworkmonitor.runallchecks.md +11 -0
- package/docs/api/foundation-comms.defaultnetworkmonitor.status.md +12 -0
- package/docs/api/foundation-comms.defaultnetworkmonitorconfig.md +13 -0
- package/docs/api/foundation-comms.defaultsocket._constructor_.md +24 -0
- package/docs/api/foundation-comms.defaultsocket.connect.md +24 -0
- package/docs/api/foundation-comms.defaultsocket.hasvalidsession.md +13 -0
- package/docs/api/foundation-comms.defaultsocket.isconfigured.md +11 -0
- package/docs/api/foundation-comms.defaultsocket.isconnected.md +11 -0
- package/docs/api/foundation-comms.defaultsocket.isconnectedsubject.md +11 -0
- package/docs/api/foundation-comms.defaultsocket.isconnecting.md +11 -0
- package/docs/api/foundation-comms.defaultsocket.isdisconnected.md +11 -0
- package/docs/api/foundation-comms.defaultsocket.isdisconnectedbyserver.md +11 -0
- package/docs/api/foundation-comms.defaultsocket.isreconnecting.md +11 -0
- package/docs/api/foundation-comms.defaultsocket.md +44 -0
- package/docs/api/foundation-comms.defaultsocket.reset.md +15 -0
- package/docs/api/foundation-comms.defaultsocket.send.md +23 -0
- package/docs/api/foundation-comms.defaultsocket.sendforstream.md +25 -0
- package/docs/api/foundation-comms.defaultsocket.socketmessages.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.closedclean.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.closedcode.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.closedreason.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.hasvalidsession.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.isconfigured.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.isconnected.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.isconnectedchanged.md +15 -0
- package/docs/api/foundation-comms.defaultsocketstatus.isconnectedsubject.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.isconnecting.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.isdisconnected.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.isdisconnectedbyserver.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.isreconnecting.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.isreconnectingchanged.md +15 -0
- package/docs/api/foundation-comms.defaultsocketstatus.md +42 -0
- package/docs/api/foundation-comms.defaultsocketstatus.onclose.md +22 -0
- package/docs/api/foundation-comms.defaultsocketstatus.reconnectionlimitreached.md +11 -0
- package/docs/api/foundation-comms.defaultsocketstatus.resetclosedstate.md +15 -0
- package/docs/api/foundation-comms.defaultsocketstatus.serialize.md +15 -0
- package/docs/api/foundation-comms.genesisconnectevents.md +18 -0
- package/docs/api/foundation-comms.getnetworkmonitor.md +30 -0
- package/docs/api/foundation-comms.getsocket.md +30 -0
- package/docs/api/foundation-comms.getsocketstatus.md +30 -0
- package/docs/api/foundation-comms.md +39 -0
- package/docs/api/foundation-comms.messagebuilder.createmorecolumnsmessage.md +30 -0
- package/docs/api/foundation-comms.messagebuilder.md +1 -0
- package/docs/api/foundation-comms.messagehaserrorcode.md +13 -0
- package/docs/api/foundation-comms.messagetype.md +2 -0
- package/docs/api/foundation-comms.metadataevent.md +14 -0
- package/docs/api/foundation-comms.metadataeventdetail.md +18 -0
- package/docs/api/foundation-comms.metadataeventtype.md +12 -0
- package/docs/api/foundation-comms.monitoredresource.md +15 -0
- package/docs/api/foundation-comms.monitoredresourcechecks.md +15 -0
- package/docs/api/foundation-comms.monitoredresourcechecksresult.isconnected.md +11 -0
- package/docs/api/foundation-comms.monitoredresourcechecksresult.lastmessage.md +11 -0
- package/docs/api/foundation-comms.monitoredresourcechecksresult.lastupdated.md +11 -0
- package/docs/api/foundation-comms.monitoredresourcechecksresult.md +23 -0
- package/docs/api/foundation-comms.monitoredresourcechecksresult.timeout.md +11 -0
- package/docs/api/foundation-comms.monitoredresourcedatalogon.md +15 -0
- package/docs/api/foundation-comms.monitoredresourcemetadata.md +15 -0
- package/docs/api/foundation-comms.networklogger.md +12 -0
- package/docs/api/foundation-comms.networkmonitor.addresource.md +23 -0
- package/docs/api/foundation-comms.networkmonitor.create.md +15 -0
- package/docs/api/foundation-comms.networkmonitor.destroy.md +15 -0
- package/docs/api/foundation-comms.networkmonitor.md +34 -0
- package/docs/api/foundation-comms.networkmonitor.removeresource.md +22 -0
- package/docs/api/foundation-comms.networkmonitor.runallchecks.md +23 -0
- package/docs/api/foundation-comms.networkmonitor.status.md +11 -0
- package/docs/api/foundation-comms.networkmonitorconfig.checkinterval.md +13 -0
- package/docs/api/foundation-comms.networkmonitorconfig.checktimeout.md +13 -0
- package/docs/api/foundation-comms.networkmonitorconfig.documentevents.md +13 -0
- package/docs/api/foundation-comms.networkmonitorconfig.eventemitter.md +13 -0
- package/docs/api/foundation-comms.networkmonitorconfig.genesisconnectevents.md +13 -0
- package/docs/api/foundation-comms.networkmonitorconfig.md +27 -0
- package/docs/api/foundation-comms.networkmonitorconfig.resourcechecks.md +13 -0
- package/docs/api/foundation-comms.networkmonitorconfig.resourcedatalogon.md +18 -0
- package/docs/api/foundation-comms.networkmonitorconfig.windowevents.md +13 -0
- package/docs/api/foundation-comms.resourcehealth.md +19 -0
- package/docs/api/foundation-comms.serializedsocketstatus.closedclean.md +11 -0
- package/docs/api/foundation-comms.serializedsocketstatus.closedcode.md +11 -0
- package/docs/api/foundation-comms.serializedsocketstatus.closedreason.md +11 -0
- package/docs/api/foundation-comms.serializedsocketstatus.hasvalidsession.md +11 -0
- package/docs/api/foundation-comms.serializedsocketstatus.isconfigured.md +13 -0
- package/docs/api/foundation-comms.serializedsocketstatus.isconnected.md +11 -0
- package/docs/api/foundation-comms.serializedsocketstatus.isconnecting.md +11 -0
- package/docs/api/foundation-comms.serializedsocketstatus.isdisconnected.md +11 -0
- package/docs/api/foundation-comms.serializedsocketstatus.isdisconnectedbyserver.md +11 -0
- package/docs/api/foundation-comms.serializedsocketstatus.isreconnecting.md +11 -0
- package/docs/api/foundation-comms.serializedsocketstatus.md +30 -0
- package/docs/api/foundation-comms.serializedsocketstatus.reconnectionlimitreached.md +11 -0
- package/docs/api/foundation-comms.socket.md +3 -11
- package/docs/api/foundation-comms.socket.sendforstream.md +2 -1
- package/docs/api/{foundation-comms.socket.isconnectedsubject.md → foundation-comms.socketstatus.isconnectedsubject.md} +2 -2
- package/docs/api/foundation-comms.socketstatus.md +28 -0
- package/docs/api/foundation-comms.socketstatus.onclose.md +22 -0
- package/docs/api/foundation-comms.socketstatus.serialize.md +15 -0
- package/docs/api/foundation-comms.streamcompleteevent.md +14 -0
- package/docs/api/foundation-comms.streamcompleteeventtype.md +12 -0
- package/docs/api/foundation-comms.streamevent.md +14 -0
- package/docs/api/foundation-comms.streameventdetail.md +19 -0
- package/docs/api/foundation-comms.streameventfunctions.md +19 -0
- package/docs/api/foundation-comms.streameventtype.md +12 -0
- package/docs/api/foundation-comms.systemhealthchanged.md +13 -0
- package/docs/api/foundation-comms.systemhealthchangedevent.md +15 -0
- package/docs/api/foundation-comms.systemhealthstatus.md +29 -0
- package/docs/api/foundation-comms.user.md +2 -0
- package/docs/api/foundation-comms.user.set.md +22 -0
- package/docs/api/foundation-comms.user.unset.md +15 -0
- package/docs/api-report.md +520 -16
- package/package.json +13 -11
- package/docs/api/foundation-comms.socket.hasvalidsession.md +0 -11
- package/docs/api/foundation-comms.socket.isconnected.md +0 -11
- package/docs/api/foundation-comms.socket.isreconnecting.md +0 -11
package/docs/api-report.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
|
9
9
|
import { AppIntent } from '@finos/fdc3';
|
10
10
|
import { BehaviorSubject } from 'rxjs';
|
11
|
+
import { default as Bowser_2 } from 'bowser';
|
11
12
|
import { Channel } from '@finos/fdc3';
|
12
13
|
import { Context } from '@finos/fdc3';
|
13
14
|
import { ContextHandler } from '@finos/fdc3';
|
@@ -17,11 +18,14 @@ import { Intents } from '@finos/fdc3';
|
|
17
18
|
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
18
19
|
import { JSONSchema7 } from 'json-schema';
|
19
20
|
import { JSONSerializer } from '@genesislcap/foundation-utils';
|
21
|
+
import { Listener } from '@genesislcap/foundation-utils';
|
20
22
|
import { Logger } from '@genesislcap/foundation-logger';
|
21
23
|
import { Observable } from 'rxjs';
|
22
|
-
import { Observer } from '
|
24
|
+
import { Observer } from '@genesislcap/foundation-utils';
|
25
|
+
import { Observer as Observer_2 } from 'rxjs';
|
23
26
|
import { Subscription as SocketSubscription } from 'rxjs';
|
24
27
|
import { Subject } from 'rxjs';
|
28
|
+
import { UUID } from '@genesislcap/foundation-utils';
|
25
29
|
|
26
30
|
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Auth" because one of its declarations is marked as @internal
|
27
31
|
//
|
@@ -118,6 +122,18 @@ export type BasicCredentialsInput = {
|
|
118
122
|
password: string;
|
119
123
|
};
|
120
124
|
|
125
|
+
// @public (undocumented)
|
126
|
+
export type CommitEvent = CustomEvent<CommitEventDetail>;
|
127
|
+
|
128
|
+
// @public (undocumented)
|
129
|
+
export type CommitEventDetail = {
|
130
|
+
eventName: string;
|
131
|
+
message: Message;
|
132
|
+
};
|
133
|
+
|
134
|
+
// @public (undocumented)
|
135
|
+
export const CommitEventType = "connect-commit-event";
|
136
|
+
|
121
137
|
// @public
|
122
138
|
export type CommitParams = {
|
123
139
|
DETAILS: any;
|
@@ -137,6 +153,7 @@ export interface Connect {
|
|
137
153
|
getAvailableResources(params?: RequestParams): Promise<Message>;
|
138
154
|
getJSONSchema(resourceName: string): Promise<SchemaResponse>;
|
139
155
|
getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
|
156
|
+
getMoreColumns(sourceRef: string): Promise<Message>;
|
140
157
|
getMoreRows(sourceRef: string): Promise<Message>;
|
141
158
|
// @internal
|
142
159
|
httpMode(): boolean;
|
@@ -168,6 +185,31 @@ export interface ConnectConfig {
|
|
168
185
|
// @internal
|
169
186
|
export const ConnectConfig: InterfaceSymbol<ConnectConfig>;
|
170
187
|
|
188
|
+
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "ConnectEvents" because one of its declarations is marked as @internal
|
189
|
+
//
|
190
|
+
// @public
|
191
|
+
export interface ConnectEvents {
|
192
|
+
addCommitListener(listener: Listener<CommitEvent>): () => void;
|
193
|
+
addMetadataListener(listener: Listener<MetadataEvent>): () => void;
|
194
|
+
addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
|
195
|
+
}
|
196
|
+
|
197
|
+
// @internal
|
198
|
+
export const ConnectEvents: InterfaceSymbol<ConnectEvents>;
|
199
|
+
|
200
|
+
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "ConnectEventsEmitter" because one of its declarations is marked as @internal
|
201
|
+
//
|
202
|
+
// @public
|
203
|
+
export interface ConnectEventsEmitter extends ConnectEvents {
|
204
|
+
onCommitEvent(eventName: string, message: Message): void;
|
205
|
+
onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
|
206
|
+
onStreamCompleteEvent(stream: SocketObservable<any>): void;
|
207
|
+
onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
|
208
|
+
}
|
209
|
+
|
210
|
+
// @internal
|
211
|
+
export const ConnectEventsEmitter: InterfaceSymbol<ConnectEventsEmitter>;
|
212
|
+
|
171
213
|
// @public
|
172
214
|
export type ConnectionStatus = 'connected' | 'disconnected' | 'busy';
|
173
215
|
|
@@ -190,6 +232,8 @@ export class ConnectMock implements Connect {
|
|
190
232
|
// (undocumented)
|
191
233
|
getMetadata(resourceName: string): Promise<Metadata>;
|
192
234
|
// (undocumented)
|
235
|
+
getMoreColumns(sourceRef: string): Promise<Message<any>>;
|
236
|
+
// (undocumented)
|
193
237
|
getMoreRows(sourceRef: string): Promise<Message<any>>;
|
194
238
|
// (undocumented)
|
195
239
|
httpMode(): boolean;
|
@@ -321,6 +365,10 @@ export class CurrentUser implements User {
|
|
321
365
|
// (undocumented)
|
322
366
|
profiles: UserProfile[];
|
323
367
|
// (undocumented)
|
368
|
+
set(options: UserOptions): void;
|
369
|
+
// (undocumented)
|
370
|
+
unset(): void;
|
371
|
+
// (undocumented)
|
324
372
|
username: string;
|
325
373
|
}
|
326
374
|
|
@@ -337,6 +385,7 @@ export interface Datasource {
|
|
337
385
|
dataHandler?(data: Array<any>): Array<any>;
|
338
386
|
deinit(): any;
|
339
387
|
deleteItem?(itemId: string): Promise<void>;
|
388
|
+
destroy(): void;
|
340
389
|
dropView?(view: Dataview): void;
|
341
390
|
fieldMetadata: FieldMetadata[];
|
342
391
|
getMetadata?(resourceName: string): Promise<Array<FieldMetadata>>;
|
@@ -402,6 +451,8 @@ export class DatasourceMock implements Datasource {
|
|
402
451
|
// (undocumented)
|
403
452
|
deleteItem?(itemId: string): Promise<void>;
|
404
453
|
// (undocumented)
|
454
|
+
destroy(): void;
|
455
|
+
// (undocumented)
|
405
456
|
dropView?(view: Dataview): void;
|
406
457
|
// (undocumented)
|
407
458
|
fieldMetadata: FieldMetadata[];
|
@@ -488,7 +539,7 @@ export class DefaultAuth implements Auth {
|
|
488
539
|
|
489
540
|
// @public
|
490
541
|
export class DefaultConnect implements Connect {
|
491
|
-
constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, config?: ConnectConfig);
|
542
|
+
constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config?: ConnectConfig);
|
492
543
|
// (undocumented)
|
493
544
|
commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
|
494
545
|
// (undocumented)
|
@@ -504,6 +555,8 @@ export class DefaultConnect implements Connect {
|
|
504
555
|
// (undocumented)
|
505
556
|
getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
|
506
557
|
// (undocumented)
|
558
|
+
getMoreColumns(sourceRef: string): Promise<Message>;
|
559
|
+
// (undocumented)
|
507
560
|
getMoreRows(sourceRef: string): Promise<Message>;
|
508
561
|
// (undocumented)
|
509
562
|
httpMode(): boolean;
|
@@ -532,6 +585,46 @@ export class DefaultConnect implements Connect {
|
|
532
585
|
// @public
|
533
586
|
export const defaultConnectConfig: ConnectConfig;
|
534
587
|
|
588
|
+
// @public
|
589
|
+
export class DefaultConnectEvents implements ConnectEventsEmitter {
|
590
|
+
// 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
|
591
|
+
//
|
592
|
+
// (undocumented)
|
593
|
+
addCommitListener(listener: Listener<CommitEvent>): () => void;
|
594
|
+
// 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
|
595
|
+
//
|
596
|
+
// (undocumented)
|
597
|
+
addMetadataListener(listener: Listener<MetadataEvent>): () => void;
|
598
|
+
// 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
|
599
|
+
//
|
600
|
+
// (undocumented)
|
601
|
+
addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
|
602
|
+
// @internal (undocumented)
|
603
|
+
protected commitListeners: Observer<CommitEvent>;
|
604
|
+
// @internal (undocumented)
|
605
|
+
protected metadataListeners: Observer<MetadataEvent>;
|
606
|
+
// 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
|
607
|
+
//
|
608
|
+
// (undocumented)
|
609
|
+
onCommitEvent(eventName: string, message: Message): void;
|
610
|
+
// 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
|
611
|
+
//
|
612
|
+
// (undocumented)
|
613
|
+
onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
|
614
|
+
// 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
|
615
|
+
//
|
616
|
+
// (undocumented)
|
617
|
+
onStreamCompleteEvent(stream: SocketObservable<any>): void;
|
618
|
+
// 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
|
619
|
+
//
|
620
|
+
// (undocumented)
|
621
|
+
onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
|
622
|
+
// @internal (undocumented)
|
623
|
+
protected streamCompleteListeners: Observer<StreamCompleteEvent>;
|
624
|
+
// @internal (undocumented)
|
625
|
+
protected streamListeners: Observer<StreamEvent>;
|
626
|
+
}
|
627
|
+
|
535
628
|
// @public
|
536
629
|
export class DefaultCredentialManager implements CredentialManager {
|
537
630
|
constructor(session: Session, config?: CredentialManagerConfig);
|
@@ -606,6 +699,10 @@ export class DefaultDatasource implements Datasource {
|
|
606
699
|
protected connect: Connect;
|
607
700
|
// (undocumented)
|
608
701
|
deinit(): void;
|
702
|
+
// 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
|
703
|
+
//
|
704
|
+
// (undocumented)
|
705
|
+
destroy(): void;
|
609
706
|
// (undocumented)
|
610
707
|
fieldMetadata: FieldMetadata[];
|
611
708
|
// (undocumented)
|
@@ -681,6 +778,30 @@ export class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatasource im
|
|
681
778
|
protected updateCache(result: FilteredDataServerResult): void;
|
682
779
|
}
|
683
780
|
|
781
|
+
// Warning: (ae-forgotten-export) The symbol "FDC3_2" needs to be exported by the entry point index.d.ts
|
782
|
+
// Warning: (ae-internal-missing-underscore) The name "DefaultFDC3" should be prefixed with an underscore because the declaration is marked as @internal
|
783
|
+
//
|
784
|
+
// @internal
|
785
|
+
export class DefaultFDC3 implements FDC3_2 {
|
786
|
+
constructor();
|
787
|
+
// (undocumented)
|
788
|
+
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
789
|
+
// (undocumented)
|
790
|
+
broadcastOnChannel(channelId: string, context: FDC3Context): Promise<void>;
|
791
|
+
// (undocumented)
|
792
|
+
findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
|
793
|
+
// (undocumented)
|
794
|
+
findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
|
795
|
+
// (undocumented)
|
796
|
+
getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
|
797
|
+
// (undocumented)
|
798
|
+
isReady: boolean;
|
799
|
+
// (undocumented)
|
800
|
+
joinChannel(channelId: string): Promise<void>;
|
801
|
+
// (undocumented)
|
802
|
+
raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
|
803
|
+
}
|
804
|
+
|
684
805
|
// @public
|
685
806
|
export class DefaultFoundationAnalytics implements FoundationAnalytics {
|
686
807
|
constructor(config: {
|
@@ -719,6 +840,8 @@ export class DefaultHttpConnect implements Connect {
|
|
719
840
|
// (undocumented)
|
720
841
|
getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
|
721
842
|
// (undocumented)
|
843
|
+
getMoreColumns(sourceRef: string): Promise<Message>;
|
844
|
+
// (undocumented)
|
722
845
|
getMoreRows(sourceRef: string): Promise<Message>;
|
723
846
|
// (undocumented)
|
724
847
|
host: string;
|
@@ -762,6 +885,41 @@ export class DefaultKVStorage implements KVStorage {
|
|
762
885
|
// @alpha
|
763
886
|
export const defaultKVStorageConfig: KVStorageConfig;
|
764
887
|
|
888
|
+
// @public
|
889
|
+
export class DefaultMessageBuilder implements MessageBuilder {
|
890
|
+
constructor(session: Session, uuid: UUID);
|
891
|
+
// (undocumented)
|
892
|
+
createChangePasswordMessage(username: string, oldPassword: string, newPassword: string): Message<MessageDetails.ChangePassword>;
|
893
|
+
// (undocumented)
|
894
|
+
createCommitMessage<T = any>(eventName: string, params?: CommitParams): Message<T>;
|
895
|
+
// (undocumented)
|
896
|
+
createDataLogoffMessage<T = any>(sourceRef: string): Message<T>;
|
897
|
+
// (undocumented)
|
898
|
+
createDataLogonMessage(resourceName: string, params?: any): Message<MessageDetails.DataserverRequest>;
|
899
|
+
// (undocumented)
|
900
|
+
createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;
|
901
|
+
// (undocumented)
|
902
|
+
createForgotPasswordTokenMessage(username: string, resetToken: string, newPassword: string, requester?: string): Message<MessageDetails.ForgotPasswordToken>;
|
903
|
+
// (undocumented)
|
904
|
+
createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
|
905
|
+
// (undocumented)
|
906
|
+
createLoginMessage(credentials: AuthInfo): Message<MessageDetails.Login>;
|
907
|
+
// (undocumented)
|
908
|
+
createLogoutMessage(loginResult?: LoginResult): Message;
|
909
|
+
// (undocumented)
|
910
|
+
createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
|
911
|
+
// (undocumented)
|
912
|
+
createMoreColumnsMessage(sourceRef: string): Message;
|
913
|
+
// (undocumented)
|
914
|
+
createMoreRowsMessage(sourceRef: string): Message;
|
915
|
+
// (undocumented)
|
916
|
+
createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
|
917
|
+
// (undocumented)
|
918
|
+
createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
|
919
|
+
// (undocumented)
|
920
|
+
createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
|
921
|
+
}
|
922
|
+
|
765
923
|
// @public
|
766
924
|
export class DefaultMetaCache implements MetaCache {
|
767
925
|
// (undocumented)
|
@@ -782,6 +940,77 @@ export class DefaultMetaCache implements MetaCache {
|
|
782
940
|
setMetadataFor(resourceName: string, metadata: Metadata): void;
|
783
941
|
}
|
784
942
|
|
943
|
+
// @public
|
944
|
+
export class DefaultNetworkMonitor implements NetworkMonitor {
|
945
|
+
// @internal (undocumented)
|
946
|
+
protected addListeners(): void;
|
947
|
+
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
|
948
|
+
//
|
949
|
+
// (undocumented)
|
950
|
+
addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
|
951
|
+
// @internal
|
952
|
+
protected config: NetworkMonitorConfig;
|
953
|
+
// @internal (undocumented)
|
954
|
+
protected connectEvents: ConnectEvents;
|
955
|
+
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
|
956
|
+
//
|
957
|
+
// (undocumented)
|
958
|
+
create(): void;
|
959
|
+
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
|
960
|
+
//
|
961
|
+
// (undocumented)
|
962
|
+
destroy(): void;
|
963
|
+
// @internal (undocumented)
|
964
|
+
protected getFormattedTimestamp(milliseconds: number): string;
|
965
|
+
// @internal (undocumented)
|
966
|
+
protected getNextTimestamp(): number;
|
967
|
+
// @internal (undocumented)
|
968
|
+
protected getNowTimestamp(): number;
|
969
|
+
// @internal (undocumented)
|
970
|
+
protected internalId: ReturnType<typeof setInterval>;
|
971
|
+
// @internal (undocumented)
|
972
|
+
protected isOnlineCheck(): Promise<boolean>;
|
973
|
+
// @internal (undocumented)
|
974
|
+
protected isRunningChecks: boolean;
|
975
|
+
// @internal (undocumented)
|
976
|
+
protected normaliseEventDetail(detail: Partial<SystemHealthStatus>): SystemHealthStatus;
|
977
|
+
// @internal (undocumented)
|
978
|
+
protected normaliseResourceHealth(health: ResourceHealth, isOnline?: boolean): ResourceHealth;
|
979
|
+
// @internal (undocumented)
|
980
|
+
protected normaliseSerializedSocketStatus(socketStatus: SerializedSocketStatus, isOnline?: boolean): SerializedSocketStatus;
|
981
|
+
// @internal (undocumented)
|
982
|
+
protected removeListeners(): void;
|
983
|
+
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
|
984
|
+
//
|
985
|
+
// (undocumented)
|
986
|
+
removeResource(resource: MonitoredResource): void;
|
987
|
+
// @internal (undocumented)
|
988
|
+
protected reportStabilityToGenesis(detail: Partial<SystemHealthStatus>): Promise<boolean>;
|
989
|
+
// @internal (undocumented)
|
990
|
+
protected reportSystemHealth(detail: Partial<SystemHealthStatus>): void;
|
991
|
+
// @internal (undocumented)
|
992
|
+
protected resources: Map<MonitoredResource, MonitoredResourceMetadata>;
|
993
|
+
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
|
994
|
+
//
|
995
|
+
// (undocumented)
|
996
|
+
runAllChecks: (source?: unknown, force?: boolean) => Promise<void>;
|
997
|
+
// @internal (undocumented)
|
998
|
+
protected socketStatus: SocketStatus;
|
999
|
+
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
|
1000
|
+
//
|
1001
|
+
// (undocumented)
|
1002
|
+
status: SystemHealthStatus;
|
1003
|
+
// @internal (undocumented)
|
1004
|
+
protected synchroniseCheckInterval(): void;
|
1005
|
+
// @internal (undocumented)
|
1006
|
+
protected unsubscribableObservers: any[];
|
1007
|
+
// @internal (undocumented)
|
1008
|
+
protected user: User;
|
1009
|
+
}
|
1010
|
+
|
1011
|
+
// @public
|
1012
|
+
export const defaultNetworkMonitorConfig: NetworkMonitorConfig;
|
1013
|
+
|
785
1014
|
// @public
|
786
1015
|
export class DefaultSession implements Session {
|
787
1016
|
// (undocumented)
|
@@ -816,6 +1045,76 @@ export class DefaultSession implements Session {
|
|
816
1045
|
setStorageKeyPrefix(prefix: string): void;
|
817
1046
|
}
|
818
1047
|
|
1048
|
+
// @public
|
1049
|
+
export class DefaultSocket implements Socket {
|
1050
|
+
constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSerializer, uuid: UUID, status: SocketStatus);
|
1051
|
+
// (undocumented)
|
1052
|
+
connect(host: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
|
1053
|
+
// (undocumented)
|
1054
|
+
get hasValidSession(): boolean;
|
1055
|
+
set hasValidSession(value: boolean);
|
1056
|
+
// (undocumented)
|
1057
|
+
get isConfigured(): boolean;
|
1058
|
+
// (undocumented)
|
1059
|
+
get isConnected(): boolean;
|
1060
|
+
// (undocumented)
|
1061
|
+
get isConnectedSubject(): BehaviorSubject<boolean>;
|
1062
|
+
// (undocumented)
|
1063
|
+
get isConnecting(): boolean;
|
1064
|
+
// (undocumented)
|
1065
|
+
get isDisconnected(): boolean;
|
1066
|
+
// (undocumented)
|
1067
|
+
get isDisconnectedByServer(): boolean;
|
1068
|
+
// (undocumented)
|
1069
|
+
get isReconnecting(): boolean;
|
1070
|
+
// (undocumented)
|
1071
|
+
reset(): void;
|
1072
|
+
// (undocumented)
|
1073
|
+
send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
|
1074
|
+
// (undocumented)
|
1075
|
+
sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
|
1076
|
+
// (undocumented)
|
1077
|
+
socketMessages: () => SocketSubject<Message>;
|
1078
|
+
}
|
1079
|
+
|
1080
|
+
// @public
|
1081
|
+
export class DefaultSocketStatus implements SocketStatus {
|
1082
|
+
// (undocumented)
|
1083
|
+
closedClean: any;
|
1084
|
+
// (undocumented)
|
1085
|
+
closedCode: any;
|
1086
|
+
// (undocumented)
|
1087
|
+
closedReason: any;
|
1088
|
+
// (undocumented)
|
1089
|
+
hasValidSession: boolean;
|
1090
|
+
// (undocumented)
|
1091
|
+
isConfigured: boolean;
|
1092
|
+
// (undocumented)
|
1093
|
+
isConnected: boolean;
|
1094
|
+
// (undocumented)
|
1095
|
+
protected isConnectedChanged(): void;
|
1096
|
+
// (undocumented)
|
1097
|
+
isConnectedSubject: BehaviorSubject<boolean>;
|
1098
|
+
// (undocumented)
|
1099
|
+
isConnecting: boolean;
|
1100
|
+
// (undocumented)
|
1101
|
+
get isDisconnected(): boolean;
|
1102
|
+
// (undocumented)
|
1103
|
+
get isDisconnectedByServer(): boolean;
|
1104
|
+
// (undocumented)
|
1105
|
+
isReconnecting: boolean;
|
1106
|
+
// (undocumented)
|
1107
|
+
protected isReconnectingChanged(): void;
|
1108
|
+
// (undocumented)
|
1109
|
+
onClose(event: CloseEvent): void;
|
1110
|
+
// (undocumented)
|
1111
|
+
reconnectionLimitReached: boolean;
|
1112
|
+
// (undocumented)
|
1113
|
+
protected resetClosedState(): void;
|
1114
|
+
// (undocumented)
|
1115
|
+
serialize(): SerializedSocketStatus;
|
1116
|
+
}
|
1117
|
+
|
819
1118
|
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "EntityDatasource" because one of its declarations is marked as @internal
|
820
1119
|
//
|
821
1120
|
// @alpha
|
@@ -879,7 +1178,6 @@ export const exponentialScheduler: SocketReconnectScheduler;
|
|
879
1178
|
// @public
|
880
1179
|
export const extractFieldDefinitions: (metadata: Metadata) => MetadataDetail[];
|
881
1180
|
|
882
|
-
// Warning: (ae-forgotten-export) The symbol "FDC3_2" needs to be exported by the entry point index.d.ts
|
883
1181
|
// Warning: (ae-internal-missing-underscore) The name "FDC3" should be prefixed with an underscore because the declaration is marked as @internal
|
884
1182
|
//
|
885
1183
|
// @internal
|
@@ -979,6 +1277,9 @@ export enum FoundationAnalyticsEventType {
|
|
979
1277
|
routeChanged = "routeChanged"
|
980
1278
|
}
|
981
1279
|
|
1280
|
+
// @public
|
1281
|
+
export type GenesisConnectEvents = 'stream' | 'commit';
|
1282
|
+
|
982
1283
|
// @public
|
983
1284
|
export function getConnect(): Connect;
|
984
1285
|
|
@@ -988,6 +1289,15 @@ export type GetCredentialOptions = CredentialRequestOptions & {};
|
|
988
1289
|
// @public
|
989
1290
|
export function getDatasource(): Datasource;
|
990
1291
|
|
1292
|
+
// @public
|
1293
|
+
export function getNetworkMonitor(): NetworkMonitor;
|
1294
|
+
|
1295
|
+
// @public
|
1296
|
+
export function getSocket(): Socket;
|
1297
|
+
|
1298
|
+
// @public
|
1299
|
+
export function getSocketStatus(): SocketStatus;
|
1300
|
+
|
991
1301
|
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Http" because one of its declarations is marked as @internal
|
992
1302
|
//
|
993
1303
|
// @public
|
@@ -1198,6 +1508,7 @@ export interface MessageBuilder {
|
|
1198
1508
|
createLoginMessage(credentials: AuthInfo): Message<MessageDetails.Login>;
|
1199
1509
|
createLogoutMessage(loginResult?: LoginResult): Message;
|
1200
1510
|
createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
|
1511
|
+
createMoreColumnsMessage(sourceRef: string): Message;
|
1201
1512
|
createMoreRowsMessage(sourceRef: string): Message;
|
1202
1513
|
createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
|
1203
1514
|
createRequestMessage<T = any>(resourceName: string, params?: any): Message<T>;
|
@@ -1288,6 +1599,9 @@ export type MessageError = {
|
|
1288
1599
|
TEXT: string;
|
1289
1600
|
};
|
1290
1601
|
|
1602
|
+
// @public
|
1603
|
+
export const messageHasErrorCode: (message: Message, code: string | number) => boolean;
|
1604
|
+
|
1291
1605
|
// @public
|
1292
1606
|
export const messageOrThrow: (message: Message) => Message<any>;
|
1293
1607
|
|
@@ -1310,6 +1624,10 @@ export enum MessageType {
|
|
1310
1624
|
// (undocumented)
|
1311
1625
|
LOGOUT_NACK = "LOGOUT_NACK",
|
1312
1626
|
// (undocumented)
|
1627
|
+
MORE_COLUMNS = "MORE_COLUMNS",
|
1628
|
+
// (undocumented)
|
1629
|
+
MORE_COLUMNS_ACK = "MORE_COLUMNS_ACK",
|
1630
|
+
// (undocumented)
|
1313
1631
|
MORE_ROWS = "MORE_ROWS",
|
1314
1632
|
// (undocumented)
|
1315
1633
|
MSG_ACK = "MSG_ACK",
|
@@ -1356,6 +1674,85 @@ export type MetadataDetail = {
|
|
1356
1674
|
UI_LABEL?: string;
|
1357
1675
|
};
|
1358
1676
|
|
1677
|
+
// @public (undocumented)
|
1678
|
+
export type MetadataEvent = CustomEvent<MetadataEventDetail>;
|
1679
|
+
|
1680
|
+
// @public (undocumented)
|
1681
|
+
export type MetadataEventDetail = {
|
1682
|
+
resourceName: string;
|
1683
|
+
message: Message<MessageDetails.MetaRequest>;
|
1684
|
+
error?: any;
|
1685
|
+
};
|
1686
|
+
|
1687
|
+
// @public (undocumented)
|
1688
|
+
export const MetadataEventType = "connect-metadata-event";
|
1689
|
+
|
1690
|
+
// @public
|
1691
|
+
export type MonitoredResource = SocketObservable<any>;
|
1692
|
+
|
1693
|
+
// @public
|
1694
|
+
export type MonitoredResourceChecks = (sourceRef: string, resource: MonitoredResource) => Promise<MonitoredResourceChecksResult>;
|
1695
|
+
|
1696
|
+
// @public
|
1697
|
+
export interface MonitoredResourceChecksResult {
|
1698
|
+
// (undocumented)
|
1699
|
+
isConnected: boolean;
|
1700
|
+
// (undocumented)
|
1701
|
+
lastMessage?: Message;
|
1702
|
+
// (undocumented)
|
1703
|
+
lastUpdated: number;
|
1704
|
+
// (undocumented)
|
1705
|
+
timeout?: boolean;
|
1706
|
+
}
|
1707
|
+
|
1708
|
+
// @public
|
1709
|
+
export type MonitoredResourceDataLogon = (metadata: MonitoredResourceMetadata) => void;
|
1710
|
+
|
1711
|
+
// @public
|
1712
|
+
export interface MonitoredResourceMetadata extends Partial<MonitoredResourceChecksResult>, Partial<StreamEventDetail> {
|
1713
|
+
}
|
1714
|
+
|
1715
|
+
// @public (undocumented)
|
1716
|
+
export const networkLogger: Logger;
|
1717
|
+
|
1718
|
+
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "NetworkMonitor" because one of its declarations is marked as @internal
|
1719
|
+
//
|
1720
|
+
// @public
|
1721
|
+
export interface NetworkMonitor {
|
1722
|
+
// (undocumented)
|
1723
|
+
addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
|
1724
|
+
// (undocumented)
|
1725
|
+
create(): void;
|
1726
|
+
// (undocumented)
|
1727
|
+
destroy(): void;
|
1728
|
+
// (undocumented)
|
1729
|
+
removeResource(resource: MonitoredResource): void;
|
1730
|
+
// (undocumented)
|
1731
|
+
runAllChecks(source?: unknown, force?: boolean): Promise<void>;
|
1732
|
+
// (undocumented)
|
1733
|
+
status: SystemHealthStatus;
|
1734
|
+
}
|
1735
|
+
|
1736
|
+
// @internal
|
1737
|
+
export const NetworkMonitor: InterfaceSymbol<NetworkMonitor>;
|
1738
|
+
|
1739
|
+
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "NetworkMonitorConfig" because one of its declarations is marked as @internal
|
1740
|
+
//
|
1741
|
+
// @public
|
1742
|
+
export interface NetworkMonitorConfig {
|
1743
|
+
checkInterval?: number;
|
1744
|
+
checkTimeout?: number;
|
1745
|
+
documentEvents?: (keyof DocumentEventMap)[];
|
1746
|
+
eventEmitter?: HTMLElement;
|
1747
|
+
genesisConnectEvents?: GenesisConnectEvents[];
|
1748
|
+
resourceChecks?: MonitoredResourceChecks;
|
1749
|
+
resourceDataLogon?: MonitoredResourceDataLogon;
|
1750
|
+
windowEvents?: (keyof WindowEventHandlersEventMap)[];
|
1751
|
+
}
|
1752
|
+
|
1753
|
+
// @internal
|
1754
|
+
export const NetworkMonitorConfig: InterfaceSymbol<NetworkMonitorConfig>;
|
1755
|
+
|
1359
1756
|
// @public
|
1360
1757
|
export function normaliseCriteria(criteria: string, delimiter?: string): string;
|
1361
1758
|
|
@@ -1404,6 +1801,13 @@ export type RequestServerResult = {
|
|
1404
1801
|
MESSAGE_TYPE?: string;
|
1405
1802
|
};
|
1406
1803
|
|
1804
|
+
// @public
|
1805
|
+
export type ResourceHealth = MonitoredResourceChecksResult & {
|
1806
|
+
name: string;
|
1807
|
+
sourceRef: string[];
|
1808
|
+
lastError?: any;
|
1809
|
+
};
|
1810
|
+
|
1407
1811
|
// @public
|
1408
1812
|
export enum ResourceType {
|
1409
1813
|
// (undocumented)
|
@@ -1430,6 +1834,31 @@ export type SchemaResponse = {
|
|
1430
1834
|
SOURCE_REF: string;
|
1431
1835
|
};
|
1432
1836
|
|
1837
|
+
// @public
|
1838
|
+
export interface SerializedSocketStatus {
|
1839
|
+
// (undocumented)
|
1840
|
+
readonly closedClean: boolean;
|
1841
|
+
// (undocumented)
|
1842
|
+
readonly closedCode: number;
|
1843
|
+
// (undocumented)
|
1844
|
+
readonly closedReason: string;
|
1845
|
+
// (undocumented)
|
1846
|
+
hasValidSession: boolean;
|
1847
|
+
isConfigured: boolean;
|
1848
|
+
// (undocumented)
|
1849
|
+
isConnected: boolean;
|
1850
|
+
// (undocumented)
|
1851
|
+
isConnecting: boolean;
|
1852
|
+
// (undocumented)
|
1853
|
+
isDisconnected: boolean;
|
1854
|
+
// (undocumented)
|
1855
|
+
isDisconnectedByServer: boolean;
|
1856
|
+
// (undocumented)
|
1857
|
+
isReconnecting: boolean;
|
1858
|
+
// (undocumented)
|
1859
|
+
reconnectionLimitReached: boolean;
|
1860
|
+
}
|
1861
|
+
|
1433
1862
|
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Serializer" because one of its declarations is marked as @internal
|
1434
1863
|
//
|
1435
1864
|
// @public
|
@@ -1517,22 +1946,14 @@ export class SessionMock implements Session {
|
|
1517
1946
|
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Socket" because one of its declarations is marked as @internal
|
1518
1947
|
//
|
1519
1948
|
// @public
|
1520
|
-
export interface Socket {
|
1949
|
+
export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 'reconnectionLimitReached' | 'closedCode' | 'closedReason' | 'closedClean'> {
|
1521
1950
|
// (undocumented)
|
1522
1951
|
connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
|
1523
|
-
// (undocumented)
|
1524
|
-
hasValidSession: boolean;
|
1525
|
-
// (undocumented)
|
1526
|
-
isConnected: boolean;
|
1527
|
-
// (undocumented)
|
1528
|
-
isConnectedSubject: BehaviorSubject<boolean>;
|
1529
|
-
// (undocumented)
|
1530
|
-
isReconnecting: boolean;
|
1531
1952
|
reset(): void;
|
1532
1953
|
// (undocumented)
|
1533
1954
|
send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
|
1534
1955
|
// (undocumented)
|
1535
|
-
sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
|
1956
|
+
sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
|
1536
1957
|
// (undocumented)
|
1537
1958
|
socketMessages(): SocketSubject<Message>;
|
1538
1959
|
}
|
@@ -1543,7 +1964,7 @@ export const Socket: InterfaceSymbol<Socket>;
|
|
1543
1964
|
// @public
|
1544
1965
|
export type SocketConnectOptions = {
|
1545
1966
|
alwaysOn?: boolean;
|
1546
|
-
connectObserver?:
|
1967
|
+
connectObserver?: Observer_2<Message>;
|
1547
1968
|
enableHeartbeat?: boolean;
|
1548
1969
|
enableHeartbeatLogging?: boolean;
|
1549
1970
|
enableMessageLogging?: boolean;
|
@@ -1571,10 +1992,18 @@ export class SocketMock implements Socket {
|
|
1571
1992
|
// (undocumented)
|
1572
1993
|
hasValidSession: boolean;
|
1573
1994
|
// (undocumented)
|
1995
|
+
isConfigured: boolean;
|
1996
|
+
// (undocumented)
|
1574
1997
|
isConnected: boolean;
|
1575
1998
|
// (undocumented)
|
1576
1999
|
isConnectedSubject: BehaviorSubject<boolean>;
|
1577
2000
|
// (undocumented)
|
2001
|
+
isConnecting: boolean;
|
2002
|
+
// (undocumented)
|
2003
|
+
isDisconnected: boolean;
|
2004
|
+
// (undocumented)
|
2005
|
+
isDisconnectedByServer: boolean;
|
2006
|
+
// (undocumented)
|
1578
2007
|
isReconnecting: boolean;
|
1579
2008
|
// (undocumented)
|
1580
2009
|
nextMessage: Message;
|
@@ -1583,7 +2012,7 @@ export class SocketMock implements Socket {
|
|
1583
2012
|
// (undocumented)
|
1584
2013
|
send<T>(message: Message<any>): Promise<Message | any>;
|
1585
2014
|
// (undocumented)
|
1586
|
-
sendForStream<T>(message: Message<any>, onMessage: Function, onError: Function): Observable<Message>;
|
2015
|
+
sendForStream<T>(message: Message<any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
|
1587
2016
|
// (undocumented)
|
1588
2017
|
socketMessages(): SocketSubject<Message>;
|
1589
2018
|
// (undocumented)
|
@@ -1599,7 +2028,7 @@ export class SocketObservable<T> extends Observable<T> {
|
|
1599
2028
|
export type SocketReconnectOptions = {
|
1600
2029
|
reconnectAttempts?: number;
|
1601
2030
|
reconnectInterval?: number;
|
1602
|
-
reconnectObserver?:
|
2031
|
+
reconnectObserver?: Observer_2<any>;
|
1603
2032
|
reconnectStreams?: boolean;
|
1604
2033
|
reconnectStrategy?: SocketReconnectStrategy;
|
1605
2034
|
};
|
@@ -1615,6 +2044,21 @@ export enum SocketReconnectStrategy {
|
|
1615
2044
|
Linear = "linear"
|
1616
2045
|
}
|
1617
2046
|
|
2047
|
+
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "SocketStatus" because one of its declarations is marked as @internal
|
2048
|
+
//
|
2049
|
+
// @public
|
2050
|
+
export interface SocketStatus extends SerializedSocketStatus {
|
2051
|
+
// (undocumented)
|
2052
|
+
isConnectedSubject: BehaviorSubject<boolean>;
|
2053
|
+
// (undocumented)
|
2054
|
+
onClose(closeEvent: CloseEvent): void;
|
2055
|
+
// (undocumented)
|
2056
|
+
serialize(): SerializedSocketStatus;
|
2057
|
+
}
|
2058
|
+
|
2059
|
+
// @internal
|
2060
|
+
export const SocketStatus: InterfaceSymbol<SocketStatus>;
|
2061
|
+
|
1618
2062
|
// @public
|
1619
2063
|
export class SocketSubject<T> extends Subject<T> {
|
1620
2064
|
constructor();
|
@@ -1636,6 +2080,57 @@ export type SSOCredentialsInput = {
|
|
1636
2080
|
// @public
|
1637
2081
|
export type StorageType = 'local' | 'session';
|
1638
2082
|
|
2083
|
+
// @public (undocumented)
|
2084
|
+
export type StreamCompleteEvent = CustomEvent<SocketObservable<any>>;
|
2085
|
+
|
2086
|
+
// @public (undocumented)
|
2087
|
+
export const StreamCompleteEventType = "connect-stream-complete-event";
|
2088
|
+
|
2089
|
+
// @public (undocumented)
|
2090
|
+
export type StreamEvent = CustomEvent<StreamEventDetail>;
|
2091
|
+
|
2092
|
+
// @public (undocumented)
|
2093
|
+
export type StreamEventDetail = {
|
2094
|
+
functions: StreamEventFunctions;
|
2095
|
+
message: Message<MessageDetails.DataserverRequest>;
|
2096
|
+
resourceName: string;
|
2097
|
+
stream: SocketObservable<any>;
|
2098
|
+
};
|
2099
|
+
|
2100
|
+
// @public (undocumented)
|
2101
|
+
export type StreamEventFunctions = {
|
2102
|
+
onMessage?: Function;
|
2103
|
+
onError?: Function;
|
2104
|
+
resourceChecks?: MonitoredResourceChecks;
|
2105
|
+
resourceDataLogon?: MonitoredResourceDataLogon;
|
2106
|
+
};
|
2107
|
+
|
2108
|
+
// @public (undocumented)
|
2109
|
+
export const StreamEventType = "connect-stream-event";
|
2110
|
+
|
2111
|
+
// @public
|
2112
|
+
export const SystemHealthChanged = "system-health-changed";
|
2113
|
+
|
2114
|
+
// @public
|
2115
|
+
export type SystemHealthChangedEvent = CustomEvent<SystemHealthStatus>;
|
2116
|
+
|
2117
|
+
// @public
|
2118
|
+
export type SystemHealthStatus = {
|
2119
|
+
isOnline: boolean;
|
2120
|
+
browserInformation?: Bowser_2.Parser.ParsedResult;
|
2121
|
+
isAuthenticated: boolean;
|
2122
|
+
username?: string;
|
2123
|
+
isHealthy: boolean;
|
2124
|
+
socket: SerializedSocketStatus;
|
2125
|
+
resources: Record<string, ResourceHealth>;
|
2126
|
+
resourcesAllConnected: boolean;
|
2127
|
+
lastUpdated: number;
|
2128
|
+
nextUpdate: number;
|
2129
|
+
firstUpdated: number;
|
2130
|
+
runAllChecks(): void;
|
2131
|
+
reportStabilityToGenesis(): Promise<boolean>;
|
2132
|
+
};
|
2133
|
+
|
1639
2134
|
// @public
|
1640
2135
|
export const toFieldMetadata: (fieldDef: MetadataDetail[]) => FieldMetadata[];
|
1641
2136
|
|
@@ -1665,6 +2160,8 @@ export type UnknownUserProfiles = string;
|
|
1665
2160
|
// @public
|
1666
2161
|
export function until(conditionFunc: () => boolean, timeoutMs?: number): Promise<any>;
|
1667
2162
|
|
2163
|
+
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "User" because one of its declarations is marked as @internal
|
2164
|
+
//
|
1668
2165
|
// @public
|
1669
2166
|
export interface User extends UserOptions {
|
1670
2167
|
// (undocumented)
|
@@ -1677,8 +2174,15 @@ export interface User extends UserOptions {
|
|
1677
2174
|
//
|
1678
2175
|
// (undocumented)
|
1679
2176
|
hasProfile(profile: UserProfile | UserProfile[]): boolean;
|
2177
|
+
// (undocumented)
|
2178
|
+
set(options: UserOptions): void;
|
2179
|
+
// (undocumented)
|
2180
|
+
unset(): void;
|
1680
2181
|
}
|
1681
2182
|
|
2183
|
+
// @internal
|
2184
|
+
export const User: InterfaceSymbol<User>;
|
2185
|
+
|
1682
2186
|
// Warning: (ae-internal-missing-underscore) The name "UserPermission" should be prefixed with an underscore because the declaration is marked as @internal
|
1683
2187
|
//
|
1684
2188
|
// @internal (undocumented)
|