@genesislcap/foundation-comms 14.167.3-alpha-b40d1e5.0 → 14.167.3-alpha-69ba23f.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 +1 -11
- package/dist/dts/connect/connect.d.ts.map +1 -1
- package/dist/dts/connect/http.connect.d.ts +0 -1
- package/dist/dts/connect/http.connect.d.ts.map +1 -1
- package/dist/dts/connect/index.d.ts +0 -2
- package/dist/dts/connect/index.d.ts.map +1 -1
- package/dist/dts/connect/message.d.ts +0 -51
- package/dist/dts/connect/message.d.ts.map +1 -1
- package/dist/dts/connect/socket.d.ts +8 -72
- package/dist/dts/connect/socket.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.d.ts +0 -9
- package/dist/dts/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/fdc3/fdc3.d.ts +1 -17
- package/dist/dts/fdc3/fdc3.d.ts.map +1 -1
- package/dist/dts/index.d.ts +0 -1
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/testing/mocks/connect/connect.d.ts +0 -1
- package/dist/dts/testing/mocks/connect/connect.d.ts.map +1 -1
- package/dist/dts/testing/mocks/connect/socket.d.ts +1 -5
- package/dist/dts/testing/mocks/connect/socket.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/dts/user/user.d.ts +0 -15
- package/dist/dts/user/user.d.ts.map +1 -1
- package/dist/esm/auth/auth.js +2 -5
- package/dist/esm/connect/connect.js +8 -30
- package/dist/esm/connect/http.connect.js +0 -6
- package/dist/esm/connect/index.js +0 -2
- package/dist/esm/connect/message.js +4 -25
- package/dist/esm/connect/socket.js +44 -113
- package/dist/esm/datasource/datasource.js +8 -18
- package/dist/esm/fdc3/fdc3.js +4 -4
- package/dist/esm/index.js +0 -1
- package/dist/esm/testing/mocks/connect/connect.js +0 -3
- package/dist/esm/testing/mocks/connect/socket.js +1 -1
- package/dist/esm/testing/mocks/datasource/datasource.js +0 -1
- package/dist/esm/user/user.js +1 -22
- package/dist/foundation-comms.api.json +6567 -13112
- package/dist/foundation-comms.d.ts +13 -841
- package/docs/api/foundation-comms.connect.md +0 -1
- package/docs/api/foundation-comms.currentuser.md +0 -2
- package/docs/api/foundation-comms.datasource.md +0 -1
- package/docs/api/foundation-comms.defaultconnect._constructor_.md +1 -2
- package/docs/api/foundation-comms.defaultconnect.md +1 -2
- package/docs/api/foundation-comms.defaultdatasource.md +0 -1
- package/docs/api/foundation-comms.defaulthttpconnect.md +0 -1
- package/docs/api/foundation-comms.md +0 -39
- package/docs/api/foundation-comms.messagebuilder.md +0 -1
- package/docs/api/foundation-comms.messagetype.md +0 -2
- package/docs/api/foundation-comms.socket.hasvalidsession.md +11 -0
- package/docs/api/foundation-comms.socket.isconnected.md +11 -0
- package/docs/api/{foundation-comms.socketstatus.isconnectedsubject.md → foundation-comms.socket.isconnectedsubject.md} +2 -2
- package/docs/api/foundation-comms.socket.isreconnecting.md +11 -0
- package/docs/api/foundation-comms.socket.md +11 -3
- package/docs/api/foundation-comms.socket.sendforstream.md +1 -2
- package/docs/api/foundation-comms.user.md +0 -2
- package/docs/api-report.md +16 -520
- package/package.json +11 -13
- package/dist/dts/connect/connect.events.d.ts +0 -173
- package/dist/dts/connect/connect.events.d.ts.map +0 -1
- package/dist/dts/connect/socket.status.d.ts +0 -79
- package/dist/dts/connect/socket.status.d.ts.map +0 -1
- package/dist/dts/networkMonitor/config.d.ts +0 -56
- package/dist/dts/networkMonitor/config.d.ts.map +0 -1
- package/dist/dts/networkMonitor/index.d.ts +0 -4
- package/dist/dts/networkMonitor/index.d.ts.map +0 -1
- package/dist/dts/networkMonitor/service.d.ts +0 -193
- package/dist/dts/networkMonitor/service.d.ts.map +0 -1
- package/dist/dts/networkMonitor/types.d.ts +0 -133
- package/dist/dts/networkMonitor/types.d.ts.map +0 -1
- package/dist/esm/connect/connect.events.js +0 -113
- package/dist/esm/connect/socket.status.js +0 -119
- package/dist/esm/networkMonitor/config.js +0 -46
- package/dist/esm/networkMonitor/index.js +0 -3
- package/dist/esm/networkMonitor/service.js +0 -432
- package/dist/esm/networkMonitor/types.js +0 -5
- package/docs/api/foundation-comms.commitevent.md +0 -14
- package/docs/api/foundation-comms.commiteventdetail.md +0 -17
- package/docs/api/foundation-comms.commiteventtype.md +0 -12
- package/docs/api/foundation-comms.connect.getmorecolumns.md +0 -26
- package/docs/api/foundation-comms.connectevents.addcommitlistener.md +0 -24
- package/docs/api/foundation-comms.connectevents.addmetadatalistener.md +0 -24
- package/docs/api/foundation-comms.connectevents.addstreamlistener.md +0 -25
- package/docs/api/foundation-comms.connectevents.md +0 -22
- package/docs/api/foundation-comms.connecteventsemitter.md +0 -24
- package/docs/api/foundation-comms.connecteventsemitter.oncommitevent.md +0 -25
- package/docs/api/foundation-comms.connecteventsemitter.onmetadataevent.md +0 -26
- package/docs/api/foundation-comms.connecteventsemitter.onstreamcompleteevent.md +0 -24
- package/docs/api/foundation-comms.connecteventsemitter.onstreamevent.md +0 -27
- package/docs/api/foundation-comms.currentuser.set.md +0 -22
- package/docs/api/foundation-comms.currentuser.unset.md +0 -15
- package/docs/api/foundation-comms.datasource.destroy.md +0 -17
- package/docs/api/foundation-comms.defaultconnect.getmorecolumns.md +0 -22
- package/docs/api/foundation-comms.defaultconnectevents.addcommitlistener.md +0 -24
- package/docs/api/foundation-comms.defaultconnectevents.addmetadatalistener.md +0 -24
- package/docs/api/foundation-comms.defaultconnectevents.addstreamlistener.md +0 -25
- package/docs/api/foundation-comms.defaultconnectevents.md +0 -27
- package/docs/api/foundation-comms.defaultconnectevents.oncommitevent.md +0 -25
- package/docs/api/foundation-comms.defaultconnectevents.onmetadataevent.md +0 -26
- package/docs/api/foundation-comms.defaultconnectevents.onstreamcompleteevent.md +0 -24
- package/docs/api/foundation-comms.defaultconnectevents.onstreamevent.md +0 -27
- package/docs/api/foundation-comms.defaultdatasource.destroy.md +0 -17
- package/docs/api/foundation-comms.defaulthttpconnect.getmorecolumns.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder._constructor_.md +0 -21
- package/docs/api/foundation-comms.defaultmessagebuilder.createchangepasswordmessage.md +0 -24
- package/docs/api/foundation-comms.defaultmessagebuilder.createcommitmessage.md +0 -23
- package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogoffmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogonmessage.md +0 -23
- package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md +0 -24
- package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md +0 -25
- package/docs/api/foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.md +0 -23
- package/docs/api/foundation-comms.defaultmessagebuilder.createloginmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.createlogoutmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.createmetarequestmessage.md +0 -23
- package/docs/api/foundation-comms.defaultmessagebuilder.createmorecolumnsmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.createrefreshtokenmessage.md +0 -15
- package/docs/api/foundation-comms.defaultmessagebuilder.createrequestmessage.md +0 -23
- package/docs/api/foundation-comms.defaultmessagebuilder.createresourcesmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.md +0 -41
- package/docs/api/foundation-comms.defaultnetworkmonitor.addresource.md +0 -23
- package/docs/api/foundation-comms.defaultnetworkmonitor.create.md +0 -16
- package/docs/api/foundation-comms.defaultnetworkmonitor.destroy.md +0 -16
- package/docs/api/foundation-comms.defaultnetworkmonitor.md +0 -31
- package/docs/api/foundation-comms.defaultnetworkmonitor.removeresource.md +0 -22
- package/docs/api/foundation-comms.defaultnetworkmonitor.runallchecks.md +0 -11
- package/docs/api/foundation-comms.defaultnetworkmonitor.status.md +0 -12
- package/docs/api/foundation-comms.defaultnetworkmonitorconfig.md +0 -13
- package/docs/api/foundation-comms.defaultsocket._constructor_.md +0 -24
- package/docs/api/foundation-comms.defaultsocket.connect.md +0 -24
- package/docs/api/foundation-comms.defaultsocket.hasvalidsession.md +0 -13
- package/docs/api/foundation-comms.defaultsocket.isconfigured.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isconnected.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isconnectedsubject.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isconnecting.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isdisconnected.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isdisconnectedbyserver.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isreconnecting.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.md +0 -44
- package/docs/api/foundation-comms.defaultsocket.reset.md +0 -15
- package/docs/api/foundation-comms.defaultsocket.send.md +0 -23
- package/docs/api/foundation-comms.defaultsocket.sendforstream.md +0 -25
- package/docs/api/foundation-comms.defaultsocket.socketmessages.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.closedclean.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.closedcode.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.closedreason.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.hasvalidsession.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isconfigured.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isconnected.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isconnectedchanged.md +0 -15
- package/docs/api/foundation-comms.defaultsocketstatus.isconnectedsubject.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isconnecting.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isdisconnected.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isdisconnectedbyserver.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isreconnecting.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isreconnectingchanged.md +0 -15
- package/docs/api/foundation-comms.defaultsocketstatus.md +0 -42
- package/docs/api/foundation-comms.defaultsocketstatus.onclose.md +0 -22
- package/docs/api/foundation-comms.defaultsocketstatus.reconnectionlimitreached.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.resetclosedstate.md +0 -15
- package/docs/api/foundation-comms.defaultsocketstatus.serialize.md +0 -15
- package/docs/api/foundation-comms.genesisconnectevents.md +0 -18
- package/docs/api/foundation-comms.getnetworkmonitor.md +0 -30
- package/docs/api/foundation-comms.getsocket.md +0 -30
- package/docs/api/foundation-comms.getsocketstatus.md +0 -30
- package/docs/api/foundation-comms.messagebuilder.createmorecolumnsmessage.md +0 -30
- package/docs/api/foundation-comms.messagehaserrorcode.md +0 -13
- package/docs/api/foundation-comms.metadataevent.md +0 -14
- package/docs/api/foundation-comms.metadataeventdetail.md +0 -18
- package/docs/api/foundation-comms.metadataeventtype.md +0 -12
- package/docs/api/foundation-comms.monitoredresource.md +0 -15
- package/docs/api/foundation-comms.monitoredresourcechecks.md +0 -15
- package/docs/api/foundation-comms.monitoredresourcechecksresult.isconnected.md +0 -11
- package/docs/api/foundation-comms.monitoredresourcechecksresult.lastmessage.md +0 -11
- package/docs/api/foundation-comms.monitoredresourcechecksresult.lastupdated.md +0 -11
- package/docs/api/foundation-comms.monitoredresourcechecksresult.md +0 -23
- package/docs/api/foundation-comms.monitoredresourcechecksresult.timeout.md +0 -11
- package/docs/api/foundation-comms.monitoredresourcedatalogon.md +0 -15
- package/docs/api/foundation-comms.monitoredresourcemetadata.md +0 -15
- package/docs/api/foundation-comms.networklogger.md +0 -12
- package/docs/api/foundation-comms.networkmonitor.addresource.md +0 -23
- package/docs/api/foundation-comms.networkmonitor.create.md +0 -15
- package/docs/api/foundation-comms.networkmonitor.destroy.md +0 -15
- package/docs/api/foundation-comms.networkmonitor.md +0 -34
- package/docs/api/foundation-comms.networkmonitor.removeresource.md +0 -22
- package/docs/api/foundation-comms.networkmonitor.runallchecks.md +0 -23
- package/docs/api/foundation-comms.networkmonitor.status.md +0 -11
- package/docs/api/foundation-comms.networkmonitorconfig.checkinterval.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.checktimeout.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.documentevents.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.eventemitter.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.genesisconnectevents.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.md +0 -27
- package/docs/api/foundation-comms.networkmonitorconfig.resourcechecks.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.resourcedatalogon.md +0 -18
- package/docs/api/foundation-comms.networkmonitorconfig.windowevents.md +0 -13
- package/docs/api/foundation-comms.resourcehealth.md +0 -19
- package/docs/api/foundation-comms.serializedsocketstatus.closedclean.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.closedcode.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.closedreason.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.hasvalidsession.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.isconfigured.md +0 -13
- package/docs/api/foundation-comms.serializedsocketstatus.isconnected.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.isconnecting.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.isdisconnected.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.isdisconnectedbyserver.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.isreconnecting.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.md +0 -30
- package/docs/api/foundation-comms.serializedsocketstatus.reconnectionlimitreached.md +0 -11
- package/docs/api/foundation-comms.socketstatus.md +0 -28
- package/docs/api/foundation-comms.socketstatus.onclose.md +0 -22
- package/docs/api/foundation-comms.socketstatus.serialize.md +0 -15
- package/docs/api/foundation-comms.streamcompleteevent.md +0 -14
- package/docs/api/foundation-comms.streamcompleteeventtype.md +0 -12
- package/docs/api/foundation-comms.streamevent.md +0 -14
- package/docs/api/foundation-comms.streameventdetail.md +0 -19
- package/docs/api/foundation-comms.streameventfunctions.md +0 -19
- package/docs/api/foundation-comms.streameventtype.md +0 -12
- package/docs/api/foundation-comms.systemhealthchanged.md +0 -13
- package/docs/api/foundation-comms.systemhealthchangedevent.md +0 -15
- package/docs/api/foundation-comms.systemhealthstatus.md +0 -29
- package/docs/api/foundation-comms.user.set.md +0 -22
- package/docs/api/foundation-comms.user.unset.md +0 -15
@@ -2,7 +2,6 @@
|
|
2
2
|
|
3
3
|
import { AppIntent } from '@finos/fdc3';
|
4
4
|
import { BehaviorSubject } from 'rxjs';
|
5
|
-
import { default as Bowser_2 } from 'bowser';
|
6
5
|
import { Channel } from '@finos/fdc3';
|
7
6
|
import { Context } from '@finos/fdc3';
|
8
7
|
import { ContextHandler } from '@finos/fdc3';
|
@@ -12,14 +11,11 @@ import { Intents } from '@finos/fdc3';
|
|
12
11
|
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
13
12
|
import { JSONSchema7 } from 'json-schema';
|
14
13
|
import { JSONSerializer } from '@genesislcap/foundation-utils';
|
15
|
-
import { Listener } from '@genesislcap/foundation-utils';
|
16
14
|
import { Logger } from '@genesislcap/foundation-logger';
|
17
15
|
import { Observable } from 'rxjs';
|
18
|
-
import { Observer } from '
|
19
|
-
import { Observer as Observer_2 } from 'rxjs';
|
16
|
+
import { Observer } from 'rxjs';
|
20
17
|
import { Subscription as SocketSubscription } from 'rxjs';
|
21
18
|
import { Subject } from 'rxjs';
|
22
|
-
import { UUID } from '@genesislcap/foundation-utils';
|
23
19
|
|
24
20
|
/**
|
25
21
|
* Auth is the main interface for authenticating with a Genesis Server endpoint.
|
@@ -152,24 +148,6 @@ export declare type BasicCredentialsInput = {
|
|
152
148
|
password: string;
|
153
149
|
};
|
154
150
|
|
155
|
-
/**
|
156
|
-
* @public
|
157
|
-
*/
|
158
|
-
export declare type CommitEvent = CustomEvent<CommitEventDetail>;
|
159
|
-
|
160
|
-
/**
|
161
|
-
* @public
|
162
|
-
*/
|
163
|
-
export declare type CommitEventDetail = {
|
164
|
-
eventName: string;
|
165
|
-
message: Message;
|
166
|
-
};
|
167
|
-
|
168
|
-
/**
|
169
|
-
* @public
|
170
|
-
*/
|
171
|
-
export declare const CommitEventType = "connect-commit-event";
|
172
|
-
|
173
151
|
/**
|
174
152
|
* Parameters for a COMMIT message
|
175
153
|
* @public
|
@@ -267,13 +245,6 @@ export declare interface Connect {
|
|
267
245
|
* @returns A promise that resolves with the additional rows of data.
|
268
246
|
*/
|
269
247
|
getMoreRows(sourceRef: string): Promise<Message>;
|
270
|
-
/**
|
271
|
-
* Requests additional columns for the specified source reference.
|
272
|
-
* @public
|
273
|
-
* @param sourceRef - The source reference to request more columns for.
|
274
|
-
* @returns A promise that resolves with the additional columns.
|
275
|
-
*/
|
276
|
-
getMoreColumns(sourceRef: string): Promise<Message>;
|
277
248
|
/**
|
278
249
|
* Logs off from the specified data source.
|
279
250
|
* @public
|
@@ -347,85 +318,6 @@ export declare interface ConnectConfig {
|
|
347
318
|
*/
|
348
319
|
export declare const ConnectConfig: InterfaceSymbol<ConnectConfig>;
|
349
320
|
|
350
|
-
/**
|
351
|
-
* `ConnectEvents` provide hooks to respond to specific connect events.
|
352
|
-
*
|
353
|
-
* @public
|
354
|
-
*/
|
355
|
-
export declare interface ConnectEvents {
|
356
|
-
/**
|
357
|
-
* Add a stream listener.
|
358
|
-
* @param listener - A listener callback function.
|
359
|
-
* @param complete - A complete listener callback function.
|
360
|
-
*/
|
361
|
-
addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
|
362
|
-
/**
|
363
|
-
* Add a commit listener.
|
364
|
-
* @param listener - A listener callback function.
|
365
|
-
*/
|
366
|
-
addCommitListener(listener: Listener<CommitEvent>): () => void;
|
367
|
-
/**
|
368
|
-
* Add a metadata listener.
|
369
|
-
* @param listener - A listener callback function.
|
370
|
-
*/
|
371
|
-
addMetadataListener(listener: Listener<MetadataEvent>): () => void;
|
372
|
-
}
|
373
|
-
|
374
|
-
/**
|
375
|
-
* ConnectEvents DI key.
|
376
|
-
*
|
377
|
-
* @privateRemarks
|
378
|
-
* Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
|
379
|
-
*
|
380
|
-
* @internal
|
381
|
-
*/
|
382
|
-
export declare const ConnectEvents: InterfaceSymbol<ConnectEvents>;
|
383
|
-
|
384
|
-
/**
|
385
|
-
* `ConnectEventsEmitter` provide event emitting hooks to Connect.
|
386
|
-
*
|
387
|
-
* @public
|
388
|
-
*/
|
389
|
-
export declare interface ConnectEventsEmitter extends ConnectEvents {
|
390
|
-
/**
|
391
|
-
* Called by Connect.
|
392
|
-
* @param resourceName - The name of the resource.
|
393
|
-
* @param message - The message.
|
394
|
-
* @param stream - The actual stream itself.
|
395
|
-
* @param functions - Any functions provided.
|
396
|
-
*/
|
397
|
-
onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
|
398
|
-
/**
|
399
|
-
* Called by Connect.
|
400
|
-
* @param stream - The actual stream itself.
|
401
|
-
*/
|
402
|
-
onStreamCompleteEvent(stream: SocketObservable<any>): void;
|
403
|
-
/**
|
404
|
-
* Called by Connect.
|
405
|
-
* @param eventName - The name of the event.
|
406
|
-
* @param message - The message.
|
407
|
-
*/
|
408
|
-
onCommitEvent(eventName: string, message: Message): void;
|
409
|
-
/**
|
410
|
-
* Called by Connect.
|
411
|
-
* @param resourceName - The name of the resource.
|
412
|
-
* @param message - The message.
|
413
|
-
* @param error - Optional error.
|
414
|
-
*/
|
415
|
-
onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
|
416
|
-
}
|
417
|
-
|
418
|
-
/**
|
419
|
-
* ConnectEventsEmitter DI key.
|
420
|
-
*
|
421
|
-
* @privateRemarks
|
422
|
-
* ConnectEventsEmitter is used by Connect.
|
423
|
-
* Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
|
424
|
-
*
|
425
|
-
* @internal
|
426
|
-
*/
|
427
|
-
export declare const ConnectEventsEmitter: InterfaceSymbol<ConnectEventsEmitter>;
|
428
|
-
|
429
321
|
/**
|
430
322
|
* The connection status of the Genesis client.
|
431
323
|
* @public
|
@@ -457,7 +349,6 @@ export declare class ConnectMock implements Connect {
|
|
457
349
|
snapshot(resourceName: string, params?: any): Promise<Message>;
|
458
350
|
stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
|
459
351
|
getMoreRows(sourceRef: string): Promise<Message<any>>;
|
460
|
-
getMoreColumns(sourceRef: string): Promise<Message<any>>;
|
461
352
|
dataLogoff(sourceRef: string): Promise<Message<any>>;
|
462
353
|
getJSONSchema(resourceName: string): Promise<any>;
|
463
354
|
}
|
@@ -750,8 +641,6 @@ export declare class CurrentUser implements User {
|
|
750
641
|
profiles: UserProfile[];
|
751
642
|
username: string;
|
752
643
|
constructor(options: UserOptions);
|
753
|
-
set(options: UserOptions): void;
|
754
|
-
unset(): void;
|
755
644
|
hasAdminProfile(): boolean;
|
756
645
|
hasPermission(permission: string | string[]): boolean;
|
757
646
|
hasProfile(profile: string | string[]): boolean;
|
@@ -912,13 +801,6 @@ export declare interface Datasource {
|
|
912
801
|
* @returns A promise that resolves when the item has been updated.
|
913
802
|
*/
|
914
803
|
updateItem?(itemId: string, data: any): Promise<void>;
|
915
|
-
/**
|
916
|
-
* Destroy the datasource.
|
917
|
-
* @privateRemarks
|
918
|
-
* I suspect we may need to call this from datasource disconnectedCallbacks etc to ensure we fully clean up.
|
919
|
-
* @public
|
920
|
-
*/
|
921
|
-
destroy(): void;
|
922
804
|
}
|
923
805
|
|
924
806
|
/**
|
@@ -970,7 +852,6 @@ export declare class DatasourceMock implements Datasource {
|
|
970
852
|
stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
|
971
853
|
init(options: DatasourceOptions, fetchMeta: boolean): Promise<boolean>;
|
972
854
|
deinit(): void;
|
973
|
-
destroy(): void;
|
974
855
|
validResourceName(resourceName: string): boolean;
|
975
856
|
getMetadata?(resourceName: string): Promise<FieldMetadata[]>;
|
976
857
|
snapshot(params?: any): void;
|
@@ -1128,13 +1009,12 @@ export declare class DefaultConnect implements Connect {
|
|
1128
1009
|
socket: Socket;
|
1129
1010
|
private messageBuilder;
|
1130
1011
|
private metaCache;
|
1131
|
-
private events;
|
1132
1012
|
private config;
|
1133
1013
|
isWorking: boolean;
|
1134
1014
|
get isConnected(): boolean;
|
1135
1015
|
get isConnectedSubject(): BehaviorSubject<boolean>;
|
1136
1016
|
get isConnected$(): Observable<boolean>;
|
1137
|
-
constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache,
|
1017
|
+
constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, config?: ConnectConfig);
|
1138
1018
|
httpMode(): boolean;
|
1139
1019
|
setValidSession(valid: boolean): void;
|
1140
1020
|
send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
|
@@ -1143,7 +1023,6 @@ export declare class DefaultConnect implements Connect {
|
|
1143
1023
|
snapshot(resourceName: string, params?: any): Promise<Message>;
|
1144
1024
|
stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
|
1145
1025
|
getMoreRows(sourceRef: string): Promise<Message>;
|
1146
|
-
getMoreColumns(sourceRef: string): Promise<Message>;
|
1147
1026
|
dataLogoff(streamSourceRef: string): Promise<Message>;
|
1148
1027
|
getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
|
1149
1028
|
getJSONSchema(resourceName: string, useCache?: boolean): Promise<SchemaResponse>;
|
@@ -1158,35 +1037,6 @@ export declare class DefaultConnect implements Connect {
|
|
1158
1037
|
*/
|
1159
1038
|
export declare const defaultConnectConfig: ConnectConfig;
|
1160
1039
|
|
1161
|
-
/**
|
1162
|
-
* Default ConnectEvents implementation.
|
1163
|
-
* @public
|
1164
|
-
*/
|
1165
|
-
export declare class DefaultConnectEvents implements ConnectEventsEmitter {
|
1166
|
-
/** @internal */
|
1167
|
-
protected streamListeners: Observer<StreamEvent>;
|
1168
|
-
/** @internal */
|
1169
|
-
protected streamCompleteListeners: Observer<StreamCompleteEvent>;
|
1170
|
-
/** {@inheritDoc ConnectEvents.addStreamListener} */
|
1171
|
-
addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
|
1172
|
-
/** {@inheritDoc ConnectEventsEmitter.onStreamEvent} */
|
1173
|
-
onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
|
1174
|
-
/** {@inheritDoc ConnectEventsEmitter.onStreamCompleteEvent} */
|
1175
|
-
onStreamCompleteEvent(stream: SocketObservable<any>): void;
|
1176
|
-
/** @internal */
|
1177
|
-
protected commitListeners: Observer<CommitEvent>;
|
1178
|
-
/** {@inheritDoc ConnectEvents.addCommitListener} */
|
1179
|
-
addCommitListener(listener: Listener<CommitEvent>): () => void;
|
1180
|
-
/** {@inheritDoc ConnectEventsEmitter.onStreamEvent} */
|
1181
|
-
onCommitEvent(eventName: string, message: Message): void;
|
1182
|
-
/** @internal */
|
1183
|
-
protected metadataListeners: Observer<MetadataEvent>;
|
1184
|
-
/** {@inheritDoc ConnectEvents.addMetadataListener} */
|
1185
|
-
addMetadataListener(listener: Listener<MetadataEvent>): () => void;
|
1186
|
-
/** {@inheritDoc ConnectEventsEmitter.onMetadataEvent} */
|
1187
|
-
onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
|
1188
|
-
}
|
1189
|
-
|
1190
1040
|
/**
|
1191
1041
|
* The default implementation for the CredentialManager interface.
|
1192
1042
|
* @public
|
@@ -1255,8 +1105,6 @@ export declare class DefaultDatasource implements Datasource {
|
|
1255
1105
|
validResourceName(resourceName: string): boolean;
|
1256
1106
|
init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
|
1257
1107
|
deinit(): void;
|
1258
|
-
/** {@inheritDoc Datasource.destroy} */
|
1259
|
-
destroy(): void;
|
1260
1108
|
get stream(): SocketObservable<FilteredDataServerResult | RequestServerResult>;
|
1261
1109
|
get params(): any;
|
1262
1110
|
snapshot(): Promise<Message>;
|
@@ -1299,23 +1147,6 @@ export declare class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatas
|
|
1299
1147
|
protected processRowDataUpdate(rowData: RowData[], inserting?: boolean): void;
|
1300
1148
|
}
|
1301
1149
|
|
1302
|
-
/**
|
1303
|
-
* The FDC3 implementation.
|
1304
|
-
* @internal
|
1305
|
-
*/
|
1306
|
-
export declare class DefaultFDC3 implements FDC3_2 {
|
1307
|
-
isReady: boolean;
|
1308
|
-
constructor();
|
1309
|
-
private connect;
|
1310
|
-
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
1311
|
-
findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
|
1312
|
-
findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
|
1313
|
-
raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
|
1314
|
-
joinChannel(channelId: string): Promise<void>;
|
1315
|
-
getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
|
1316
|
-
broadcastOnChannel(channelId: string, context: FDC3Context): Promise<void>;
|
1317
|
-
}
|
1318
|
-
|
1319
1150
|
/**
|
1320
1151
|
* The default implementation for the FoundationAnalytics interface.
|
1321
1152
|
* @public
|
@@ -1390,7 +1221,6 @@ export declare class DefaultHttpConnect implements Connect {
|
|
1390
1221
|
stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
|
1391
1222
|
private getMessage;
|
1392
1223
|
getMoreRows(sourceRef: string): Promise<Message>;
|
1393
|
-
getMoreColumns(sourceRef: string): Promise<Message>;
|
1394
1224
|
dataLogoff(streamSourceRef: string): Promise<Message>;
|
1395
1225
|
getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
|
1396
1226
|
getJSONSchema(resourceName: string): Promise<SchemaResponse>;
|
@@ -1492,38 +1322,6 @@ export declare class DefaultKVStorage implements KVStorage {
|
|
1492
1322
|
*/
|
1493
1323
|
export declare const defaultKVStorageConfig: KVStorageConfig;
|
1494
1324
|
|
1495
|
-
/**
|
1496
|
-
* TODO: Abstract out localStorage interaction with shell io stuff
|
1497
|
-
*/
|
1498
|
-
/**
|
1499
|
-
* Default MessageBuilder implementation.
|
1500
|
-
* @public
|
1501
|
-
*/
|
1502
|
-
export declare class DefaultMessageBuilder implements MessageBuilder {
|
1503
|
-
private session;
|
1504
|
-
private uuid;
|
1505
|
-
/**
|
1506
|
-
* UUID will be created in the DI with the App specific requirements.
|
1507
|
-
* Keeping it encapsulated means messages will always conform.
|
1508
|
-
*/
|
1509
|
-
constructor(session: Session, uuid: UUID);
|
1510
|
-
createLoginMessage(credentials: AuthInfo): Message<MessageDetails.Login>;
|
1511
|
-
createLogoutMessage(loginResult?: LoginResult): Message;
|
1512
|
-
createDataLogonMessage(resourceName: string, params?: any): Message<MessageDetails.DataserverRequest>;
|
1513
|
-
createDataLogoffMessage<T = any>(sourceRef: string): Message<T>;
|
1514
|
-
createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
|
1515
|
-
createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
|
1516
|
-
createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
|
1517
|
-
createCommitMessage<T = any>(eventName: string, params?: CommitParams): Message<T>;
|
1518
|
-
createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
|
1519
|
-
createChangePasswordMessage(username: string, oldPassword: string, newPassword: string): Message<MessageDetails.ChangePassword>;
|
1520
|
-
createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;
|
1521
|
-
createForgotPasswordTokenMessage(username: string, resetToken: string, newPassword: string, requester?: string): Message<MessageDetails.ForgotPasswordToken>;
|
1522
|
-
createMoreRowsMessage(sourceRef: string): Message;
|
1523
|
-
createMoreColumnsMessage(sourceRef: string): Message;
|
1524
|
-
createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
|
1525
|
-
}
|
1526
|
-
|
1527
1325
|
/**
|
1528
1326
|
* The default implementation for the MetaCache interface.
|
1529
1327
|
* @public
|
@@ -1539,144 +1337,6 @@ export declare class DefaultMetaCache implements MetaCache {
|
|
1539
1337
|
setJsonSchemaFor(resourceName: string, schemaResponse: SchemaResponse): void;
|
1540
1338
|
}
|
1541
1339
|
|
1542
|
-
/**
|
1543
|
-
* Default NetworkMonitor implementation.
|
1544
|
-
* @public
|
1545
|
-
*/
|
1546
|
-
export declare class DefaultNetworkMonitor implements NetworkMonitor {
|
1547
|
-
/**
|
1548
|
-
* High-level configuration.
|
1549
|
-
* @internal
|
1550
|
-
*/
|
1551
|
-
protected config: NetworkMonitorConfig;
|
1552
|
-
/**
|
1553
|
-
* @internal
|
1554
|
-
*/
|
1555
|
-
protected socketStatus: SocketStatus;
|
1556
|
-
/**
|
1557
|
-
* @internal
|
1558
|
-
*/
|
1559
|
-
protected connectEvents: ConnectEvents;
|
1560
|
-
/**
|
1561
|
-
* @internal
|
1562
|
-
*/
|
1563
|
-
protected user: User;
|
1564
|
-
/**
|
1565
|
-
* @internal
|
1566
|
-
*/
|
1567
|
-
protected unsubscribableObservers: any[];
|
1568
|
-
/**
|
1569
|
-
* @privateRemarks
|
1570
|
-
* Originally aimed to use WeakMap for resources, but need to iterate and process these. I also had a
|
1571
|
-
* `this.registry = new FinalizationRegistry<any>(this.registryCleanup);` in the mix to handle clean up actions.
|
1572
|
-
*
|
1573
|
-
* @internal
|
1574
|
-
*/
|
1575
|
-
protected resources: Map<MonitoredResource, MonitoredResourceMetadata>;
|
1576
|
-
/**
|
1577
|
-
* @internal
|
1578
|
-
*/
|
1579
|
-
protected internalId: ReturnType<typeof setInterval>;
|
1580
|
-
/**
|
1581
|
-
* @internal
|
1582
|
-
*/
|
1583
|
-
protected isRunningChecks: boolean;
|
1584
|
-
/**
|
1585
|
-
* {@inheritDoc NetworkMonitor.status}
|
1586
|
-
*/
|
1587
|
-
status: SystemHealthStatus;
|
1588
|
-
/**
|
1589
|
-
* {@inheritDoc NetworkMonitor.create}
|
1590
|
-
*/
|
1591
|
-
create(): void;
|
1592
|
-
/**
|
1593
|
-
* {@inheritDoc NetworkMonitor.destroy}
|
1594
|
-
*/
|
1595
|
-
destroy(): void;
|
1596
|
-
/**
|
1597
|
-
* @internal
|
1598
|
-
*/
|
1599
|
-
protected isOnlineCheck(): Promise<boolean>;
|
1600
|
-
/**
|
1601
|
-
* {@inheritDoc NetworkMonitor.runAllChecks}
|
1602
|
-
*/
|
1603
|
-
runAllChecks: (source?: unknown, force?: boolean) => Promise<void>;
|
1604
|
-
/**
|
1605
|
-
* {@inheritDoc NetworkMonitor.addResource}
|
1606
|
-
*/
|
1607
|
-
addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
|
1608
|
-
/**
|
1609
|
-
* {@inheritDoc NetworkMonitor.removeResource}
|
1610
|
-
*/
|
1611
|
-
removeResource(resource: MonitoredResource): void;
|
1612
|
-
/**
|
1613
|
-
* @internal
|
1614
|
-
*/
|
1615
|
-
protected addListeners(): void;
|
1616
|
-
/**
|
1617
|
-
* @internal
|
1618
|
-
*/
|
1619
|
-
protected removeListeners(): void;
|
1620
|
-
/**
|
1621
|
-
* @internal
|
1622
|
-
*/
|
1623
|
-
protected reportSystemHealth(detail: Partial<SystemHealthStatus>): void;
|
1624
|
-
/**
|
1625
|
-
* @internal
|
1626
|
-
*/
|
1627
|
-
protected reportStabilityToGenesis(detail: Partial<SystemHealthStatus>): Promise<boolean>;
|
1628
|
-
/**
|
1629
|
-
* @remarks
|
1630
|
-
* Deal with false positives.
|
1631
|
-
*
|
1632
|
-
* @privateRemarks
|
1633
|
-
* There's an argument here for and against normalising ResourceHealth. I think it's more useful to consumers like
|
1634
|
-
* visual overlays if there is no conflicting information. If we're offline and using the cache, then that should be
|
1635
|
-
* reflected here.
|
1636
|
-
*
|
1637
|
-
* @internal
|
1638
|
-
*/
|
1639
|
-
protected normaliseResourceHealth(health: ResourceHealth, isOnline?: boolean): ResourceHealth;
|
1640
|
-
/**
|
1641
|
-
* @remarks
|
1642
|
-
* Deal with false positives.
|
1643
|
-
*
|
1644
|
-
* @privateRemarks
|
1645
|
-
* There's an argument here for and against a normalised SerializedSocketStatus. I think it's more useful to consumers
|
1646
|
-
* like visual overlays if there is no conflicting information. If we're offline and using the cache, then that
|
1647
|
-
* should be reflected here.
|
1648
|
-
*
|
1649
|
-
* @internal
|
1650
|
-
*/
|
1651
|
-
protected normaliseSerializedSocketStatus(socketStatus: SerializedSocketStatus, isOnline?: boolean): SerializedSocketStatus;
|
1652
|
-
/**
|
1653
|
-
* @internal
|
1654
|
-
*/
|
1655
|
-
protected normaliseEventDetail(detail: Partial<SystemHealthStatus>): SystemHealthStatus;
|
1656
|
-
/**
|
1657
|
-
* @internal
|
1658
|
-
*/
|
1659
|
-
protected getFormattedTimestamp(milliseconds: number): string;
|
1660
|
-
/**
|
1661
|
-
* @internal
|
1662
|
-
*/
|
1663
|
-
protected getNowTimestamp(): number;
|
1664
|
-
/**
|
1665
|
-
* @internal
|
1666
|
-
*/
|
1667
|
-
protected getNextTimestamp(): number;
|
1668
|
-
/**
|
1669
|
-
* @internal
|
1670
|
-
*/
|
1671
|
-
protected synchroniseCheckInterval(): void;
|
1672
|
-
}
|
1673
|
-
|
1674
|
-
/**
|
1675
|
-
* Default NetworkMonitorConfig DI implementation.
|
1676
|
-
* @public
|
1677
|
-
*/
|
1678
|
-
export declare const defaultNetworkMonitorConfig: NetworkMonitorConfig;
|
1679
|
-
|
1680
1340
|
/**
|
1681
1341
|
* The default implementation for the Session interface.
|
1682
1342
|
* @public
|
@@ -1703,79 +1363,6 @@ export declare class DefaultSession implements Session {
|
|
1703
1363
|
removeSessionStorageItem(key: string | UserInfoKeys): void;
|
1704
1364
|
}
|
1705
1365
|
|
1706
|
-
/**
|
1707
|
-
* Default Socket implementation.
|
1708
|
-
* @public
|
1709
|
-
*/
|
1710
|
-
export declare class DefaultSocket implements Socket {
|
1711
|
-
private messageBuilder;
|
1712
|
-
private session;
|
1713
|
-
private serializer;
|
1714
|
-
private uuid;
|
1715
|
-
private status;
|
1716
|
-
private readonly defaultInterval;
|
1717
|
-
private readonly secondsMultiplier;
|
1718
|
-
private websocket;
|
1719
|
-
private wsMessages;
|
1720
|
-
private wsMessageHandlers;
|
1721
|
-
get isConfigured(): boolean;
|
1722
|
-
get isConnecting(): boolean;
|
1723
|
-
get isConnected(): boolean;
|
1724
|
-
get isConnectedSubject(): BehaviorSubject<boolean>;
|
1725
|
-
get isDisconnected(): boolean;
|
1726
|
-
get isDisconnectedByServer(): boolean;
|
1727
|
-
get isReconnecting(): boolean;
|
1728
|
-
get hasValidSession(): boolean;
|
1729
|
-
set hasValidSession(value: boolean);
|
1730
|
-
private heartbeatIsEnabled;
|
1731
|
-
private heartbeatInterval;
|
1732
|
-
private heartbeatTicker;
|
1733
|
-
private url;
|
1734
|
-
private connectOptions;
|
1735
|
-
private reconnectOptions;
|
1736
|
-
private socketSubscription;
|
1737
|
-
constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSerializer, uuid: UUID, status: SocketStatus);
|
1738
|
-
private get heartbeatLoggingIsEnabled();
|
1739
|
-
private get messageLoggingIsEnabled();
|
1740
|
-
connect(host: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
|
1741
|
-
private prepareHeartbeat;
|
1742
|
-
private reconnect;
|
1743
|
-
reset(): void;
|
1744
|
-
private cleanMessages;
|
1745
|
-
send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
|
1746
|
-
sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
|
1747
|
-
socketMessages: () => SocketSubject<Message>;
|
1748
|
-
private setMessageHandler;
|
1749
|
-
private sendDataLogoff;
|
1750
|
-
private removeMessageHandler;
|
1751
|
-
private getMessageHandler;
|
1752
|
-
private logMessageTypeFlow;
|
1753
|
-
}
|
1754
|
-
|
1755
|
-
/**
|
1756
|
-
* Default SocketStatus implementation.
|
1757
|
-
* @public
|
1758
|
-
*/
|
1759
|
-
export declare class DefaultSocketStatus implements SocketStatus {
|
1760
|
-
isConfigured: boolean;
|
1761
|
-
isConnecting: boolean;
|
1762
|
-
isConnected: boolean;
|
1763
|
-
isReconnecting: boolean;
|
1764
|
-
reconnectionLimitReached: boolean;
|
1765
|
-
hasValidSession: boolean;
|
1766
|
-
closedCode: any;
|
1767
|
-
closedReason: any;
|
1768
|
-
closedClean: any;
|
1769
|
-
get isDisconnected(): boolean;
|
1770
|
-
get isDisconnectedByServer(): boolean;
|
1771
|
-
isConnectedSubject: BehaviorSubject<boolean>;
|
1772
|
-
protected isConnectedChanged(): void;
|
1773
|
-
protected isReconnectingChanged(): void;
|
1774
|
-
protected resetClosedState(): void;
|
1775
|
-
serialize(): SerializedSocketStatus;
|
1776
|
-
onClose(event: CloseEvent): void;
|
1777
|
-
}
|
1778
|
-
|
1779
1366
|
/**
|
1780
1367
|
* EntityDatasource DI interface.
|
1781
1368
|
*
|
@@ -1934,7 +1521,7 @@ export declare const exponentialScheduler: SocketReconnectScheduler;
|
|
1934
1521
|
export declare const extractFieldDefinitions: (metadata: Metadata) => MetadataDetail[];
|
1935
1522
|
|
1936
1523
|
/**
|
1937
|
-
* The DI token for the
|
1524
|
+
* The DI token for the FDC3Service interface.
|
1938
1525
|
* @internal
|
1939
1526
|
*/
|
1940
1527
|
export declare const FDC3: InterfaceSymbol<FDC3_2>;
|
@@ -2003,7 +1590,7 @@ declare interface FDC3_2 {
|
|
2003
1590
|
}
|
2004
1591
|
|
2005
1592
|
/**
|
2006
|
-
* The DI token for the
|
1593
|
+
* The DI token for the FDC3Service interface.
|
2007
1594
|
* @internal
|
2008
1595
|
*/
|
2009
1596
|
declare const FDC3: InterfaceSymbol<FDC3_2>;
|
@@ -2146,17 +1733,6 @@ export declare enum FoundationAnalyticsEventType {
|
|
2146
1733
|
routeChanged = "routeChanged"
|
2147
1734
|
}
|
2148
1735
|
|
2149
|
-
/**
|
2150
|
-
* Genesis connect events that can be monitored to invoke resource checking.
|
2151
|
-
*
|
2152
|
-
* @remarks
|
2153
|
-
* 'steam' and 'commit' are monitored by default and will invoke resource checking. 'metadata' request failures are
|
2154
|
-
* monitored for the purpose of surfacing such errors to the console only. For now, 'metadata' errors are unrecoverable.
|
2155
|
-
*
|
2156
|
-
* @public
|
2157
|
-
*/
|
2158
|
-
export declare type GenesisConnectEvents = 'stream' | 'commit';
|
2159
|
-
|
2160
1736
|
/**
|
2161
1737
|
* Get Connect from the DI container.
|
2162
1738
|
*
|
@@ -2215,57 +1791,6 @@ export declare type GetCredentialOptions = CredentialRequestOptions & {};
|
|
2215
1791
|
*/
|
2216
1792
|
export declare function getDatasource(): Datasource;
|
2217
1793
|
|
2218
|
-
/**
|
2219
|
-
* Gets NetworkMonitor from the DI container.
|
2220
|
-
*
|
2221
|
-
* @remarks
|
2222
|
-
* A utility method for host applications that are not using decorators or the DI container.
|
2223
|
-
*
|
2224
|
-
* @example
|
2225
|
-
* ```ts
|
2226
|
-
* import { getNetworkMonitor } from '@genesislcap/foundation-comms';
|
2227
|
-
* ...
|
2228
|
-
* private monitor = getNetworkMonitor();
|
2229
|
-
* ```
|
2230
|
-
*
|
2231
|
-
* @public
|
2232
|
-
*/
|
2233
|
-
export declare function getNetworkMonitor(): NetworkMonitor;
|
2234
|
-
|
2235
|
-
/**
|
2236
|
-
* Gets Socket from the DI container.
|
2237
|
-
*
|
2238
|
-
* @remarks
|
2239
|
-
* A utility method for host applications that are not using decorators or the DI container.
|
2240
|
-
*
|
2241
|
-
* @example
|
2242
|
-
* ```ts
|
2243
|
-
* import { getSocket } from '@genesislcap/foundation-comms';
|
2244
|
-
* ...
|
2245
|
-
* private socket = getSocket();
|
2246
|
-
* ```
|
2247
|
-
*
|
2248
|
-
* @public
|
2249
|
-
*/
|
2250
|
-
export declare function getSocket(): Socket;
|
2251
|
-
|
2252
|
-
/**
|
2253
|
-
* Gets SocketStatus from the DI container.
|
2254
|
-
*
|
2255
|
-
* @remarks
|
2256
|
-
* A utility method for host applications that are not using decorators or the DI container.
|
2257
|
-
*
|
2258
|
-
* @example
|
2259
|
-
* ```ts
|
2260
|
-
* import { getSocketStatus } from '@genesislcap/foundation-comms';
|
2261
|
-
* ...
|
2262
|
-
* private socketStatus = getSocketStatus();
|
2263
|
-
* ```
|
2264
|
-
*
|
2265
|
-
* @public
|
2266
|
-
*/
|
2267
|
-
export declare function getSocketStatus(): SocketStatus;
|
2268
|
-
|
2269
1794
|
/**
|
2270
1795
|
* An interface representing an HTTP client that can make GET and POST requests and return a promise with the response data.
|
2271
1796
|
* @public
|
@@ -2659,15 +2184,6 @@ export declare interface MessageBuilder {
|
|
2659
2184
|
* @returns The more rows message.
|
2660
2185
|
*/
|
2661
2186
|
createMoreRowsMessage(sourceRef: string): Message;
|
2662
|
-
/**
|
2663
|
-
* Creates a message to request more columns.
|
2664
|
-
*
|
2665
|
-
* @remarks MORE_COLUMNS
|
2666
|
-
* @public
|
2667
|
-
* @param sourceRef - The source reference.
|
2668
|
-
* @returns The more columns message.
|
2669
|
-
*/
|
2670
|
-
createMoreColumnsMessage(sourceRef: string): Message;
|
2671
2187
|
/**
|
2672
2188
|
* Creates a request message.
|
2673
2189
|
*
|
@@ -2915,14 +2431,6 @@ export declare type MessageError = {
|
|
2915
2431
|
TEXT: string;
|
2916
2432
|
};
|
2917
2433
|
|
2918
|
-
/**
|
2919
|
-
* Check if the message contains an error code.
|
2920
|
-
* @param message - The message object.
|
2921
|
-
* @param code - The error code.
|
2922
|
-
* @public
|
2923
|
-
*/
|
2924
|
-
export declare const messageHasErrorCode: (message: Message, code: string | number) => boolean;
|
2925
|
-
|
2926
2434
|
/**
|
2927
2435
|
* Check if the provided message contains an error and throw an Error if it does
|
2928
2436
|
* @public
|
@@ -2943,8 +2451,6 @@ export declare enum MessageType {
|
|
2943
2451
|
HEARTBEAT_PING = "HEARTBEAT_PING",
|
2944
2452
|
HEARTBEAT_PONG = "HEARTBEAT_PONG",
|
2945
2453
|
MORE_ROWS = "MORE_ROWS",
|
2946
|
-
MORE_COLUMNS = "MORE_COLUMNS",
|
2947
|
-
MORE_COLUMNS_ACK = "MORE_COLUMNS_ACK",
|
2948
2454
|
MSG_ACK = "MSG_ACK",
|
2949
2455
|
MSG_NACK = "MSG_NACK",
|
2950
2456
|
LOGOUT_ACK = "LOGOUT_ACK",
|
@@ -3024,158 +2530,6 @@ export declare type MetadataDetail = {
|
|
3024
2530
|
UI_LABEL?: string;
|
3025
2531
|
};
|
3026
2532
|
|
3027
|
-
/**
|
3028
|
-
* @public
|
3029
|
-
*/
|
3030
|
-
export declare type MetadataEvent = CustomEvent<MetadataEventDetail>;
|
3031
|
-
|
3032
|
-
/**
|
3033
|
-
* @public
|
3034
|
-
*/
|
3035
|
-
export declare type MetadataEventDetail = {
|
3036
|
-
resourceName: string;
|
3037
|
-
message: Message<MessageDetails.MetaRequest>;
|
3038
|
-
error?: any;
|
3039
|
-
};
|
3040
|
-
|
3041
|
-
/**
|
3042
|
-
* @public
|
3043
|
-
*/
|
3044
|
-
export declare const MetadataEventType = "connect-metadata-event";
|
3045
|
-
|
3046
|
-
/**
|
3047
|
-
* MonitoredResource.
|
3048
|
-
* @public
|
3049
|
-
*/
|
3050
|
-
export declare type MonitoredResource = SocketObservable<any>;
|
3051
|
-
|
3052
|
-
/**
|
3053
|
-
* MonitoredResourceChecks.
|
3054
|
-
* @param sourceRef - The resource source ref.
|
3055
|
-
* @param resource - The resource reference.
|
3056
|
-
* @public
|
3057
|
-
*/
|
3058
|
-
export declare type MonitoredResourceChecks = (sourceRef: string, resource: MonitoredResource) => Promise<MonitoredResourceChecksResult>;
|
3059
|
-
|
3060
|
-
/**
|
3061
|
-
* MonitoredResourceChecksResult.
|
3062
|
-
* @public
|
3063
|
-
*/
|
3064
|
-
export declare interface MonitoredResourceChecksResult {
|
3065
|
-
isConnected: boolean;
|
3066
|
-
lastUpdated: number;
|
3067
|
-
lastMessage?: Message;
|
3068
|
-
timeout?: boolean;
|
3069
|
-
}
|
3070
|
-
|
3071
|
-
/**
|
3072
|
-
* MonitoredResourceDataLogon.
|
3073
|
-
* @param metadata - The resource metadata.
|
3074
|
-
* @public
|
3075
|
-
*/
|
3076
|
-
export declare type MonitoredResourceDataLogon = (metadata: MonitoredResourceMetadata) => void;
|
3077
|
-
|
3078
|
-
/**
|
3079
|
-
* MonitoredResourceMetadata.
|
3080
|
-
* @public
|
3081
|
-
*/
|
3082
|
-
export declare interface MonitoredResourceMetadata extends Partial<MonitoredResourceChecksResult>, Partial<StreamEventDetail> {
|
3083
|
-
}
|
3084
|
-
|
3085
|
-
/**
|
3086
|
-
* @public
|
3087
|
-
*/
|
3088
|
-
export declare const networkLogger: Logger;
|
3089
|
-
|
3090
|
-
/**
|
3091
|
-
* `NetworkMonitor` monitors network and resource availability and health.
|
3092
|
-
*
|
3093
|
-
* @remarks
|
3094
|
-
* UIs can listen for 'system-health-changed' events and display visual overlays to communicate status to the user.
|
3095
|
-
*
|
3096
|
-
* @public
|
3097
|
-
*/
|
3098
|
-
export declare interface NetworkMonitor {
|
3099
|
-
status: SystemHealthStatus;
|
3100
|
-
create(): void;
|
3101
|
-
destroy(): void;
|
3102
|
-
/**
|
3103
|
-
* @param source - The source of the call, which may have been an event or scheduled interval.
|
3104
|
-
* @param force - A flag to bypass abort if already in progress logic.
|
3105
|
-
*/
|
3106
|
-
runAllChecks(source?: unknown, force?: boolean): Promise<void>;
|
3107
|
-
/**
|
3108
|
-
* @param resource - The resource reference.
|
3109
|
-
* @param metadata - The resource metadata.
|
3110
|
-
*/
|
3111
|
-
addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
|
3112
|
-
/**
|
3113
|
-
* @param resource - The resource reference.
|
3114
|
-
*/
|
3115
|
-
removeResource(resource: MonitoredResource): void;
|
3116
|
-
}
|
3117
|
-
|
3118
|
-
/**
|
3119
|
-
* NetworkMonitor DI key.
|
3120
|
-
*
|
3121
|
-
* @privateRemarks
|
3122
|
-
* Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
|
3123
|
-
*
|
3124
|
-
* @internal
|
3125
|
-
*/
|
3126
|
-
export declare const NetworkMonitor: InterfaceSymbol<NetworkMonitor>;
|
3127
|
-
|
3128
|
-
/**
|
3129
|
-
* NetworkMonitorConfig DI interface.
|
3130
|
-
*
|
3131
|
-
* @public
|
3132
|
-
*/
|
3133
|
-
export declare interface NetworkMonitorConfig {
|
3134
|
-
/**
|
3135
|
-
* Window events that invoke checks
|
3136
|
-
*/
|
3137
|
-
windowEvents?: (keyof WindowEventHandlersEventMap)[];
|
3138
|
-
/**
|
3139
|
-
* Document events that invoke checks
|
3140
|
-
*/
|
3141
|
-
documentEvents?: (keyof DocumentEventMap)[];
|
3142
|
-
/**
|
3143
|
-
* Genesis connect events that invoke checks
|
3144
|
-
*/
|
3145
|
-
genesisConnectEvents?: GenesisConnectEvents[];
|
3146
|
-
/**
|
3147
|
-
* Periodic check internal in ms
|
3148
|
-
*/
|
3149
|
-
checkInterval?: number;
|
3150
|
-
/**
|
3151
|
-
* Check timeout in ms
|
3152
|
-
*/
|
3153
|
-
checkTimeout?: number;
|
3154
|
-
/**
|
3155
|
-
* Default resource checks function
|
3156
|
-
*/
|
3157
|
-
resourceChecks?: MonitoredResourceChecks;
|
3158
|
-
/**
|
3159
|
-
* Default resource data logon function
|
3160
|
-
* @remarks
|
3161
|
-
* Used to re-attempt data logon on an unhealthy data server
|
3162
|
-
*/
|
3163
|
-
resourceDataLogon?: MonitoredResourceDataLogon;
|
3164
|
-
/**
|
3165
|
-
* The element to emit events from
|
3166
|
-
*/
|
3167
|
-
eventEmitter?: HTMLElement;
|
3168
|
-
}
|
3169
|
-
|
3170
|
-
/**
|
3171
|
-
* NetworkMonitorConfig DI key.
|
3172
|
-
*
|
3173
|
-
* @internal
|
3174
|
-
* @privateRemarks
|
3175
|
-
* Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
|
3176
|
-
*/
|
3177
|
-
export declare const NetworkMonitorConfig: InterfaceSymbol<NetworkMonitorConfig>;
|
3178
|
-
|
3179
2533
|
/**
|
3180
2534
|
* Normalise criteria.
|
3181
2535
|
*
|
@@ -3264,16 +2618,6 @@ export declare type RequestServerResult = {
|
|
3264
2618
|
MESSAGE_TYPE?: string;
|
3265
2619
|
};
|
3266
2620
|
|
3267
|
-
/**
|
3268
|
-
* ResourceHealth.
|
3269
|
-
* @public
|
3270
|
-
*/
|
3271
|
-
export declare type ResourceHealth = MonitoredResourceChecksResult & {
|
3272
|
-
name: string;
|
3273
|
-
sourceRef: string;
|
3274
|
-
lastError?: any;
|
3275
|
-
};
|
3276
|
-
|
3277
2621
|
/**
|
3278
2622
|
* Types of Genesis resources.
|
3279
2623
|
* @public
|
@@ -3312,27 +2656,6 @@ export declare type SchemaResponse = {
|
|
3312
2656
|
SOURCE_REF: string;
|
3313
2657
|
};
|
3314
2658
|
|
3315
|
-
/**
|
3316
|
-
* `SerializedSocketStatus` provides the serialize state of the web socket.
|
3317
|
-
* @public
|
3318
|
-
*/
|
3319
|
-
export declare interface SerializedSocketStatus {
|
3320
|
-
/**
|
3321
|
-
* When the socket has been configured for use.
|
3322
|
-
*/
|
3323
|
-
isConfigured: boolean;
|
3324
|
-
isConnecting: boolean;
|
3325
|
-
isConnected: boolean;
|
3326
|
-
isDisconnected: boolean;
|
3327
|
-
isDisconnectedByServer: boolean;
|
3328
|
-
isReconnecting: boolean;
|
3329
|
-
reconnectionLimitReached: boolean;
|
3330
|
-
hasValidSession: boolean;
|
3331
|
-
readonly closedCode: number;
|
3332
|
-
readonly closedReason: string;
|
3333
|
-
readonly closedClean: boolean;
|
3334
|
-
}
|
3335
|
-
|
3336
2659
|
/**
|
3337
2660
|
* A Serializer interface for serializing and deserializing objects.
|
3338
2661
|
* @public
|
@@ -3515,14 +2838,18 @@ export declare class SessionMock implements Session {
|
|
3515
2838
|
* Provides methods for socket connection, sending and receiving WS messages.
|
3516
2839
|
* @public
|
3517
2840
|
*/
|
3518
|
-
export declare interface Socket
|
2841
|
+
export declare interface Socket {
|
2842
|
+
isConnected: boolean;
|
2843
|
+
isReconnecting: boolean;
|
2844
|
+
hasValidSession: boolean;
|
2845
|
+
isConnectedSubject: BehaviorSubject<boolean>;
|
3519
2846
|
connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
|
3520
2847
|
/**
|
3521
2848
|
* Disconnects the socket and clears all subscriptions
|
3522
2849
|
*/
|
3523
2850
|
reset(): void;
|
3524
2851
|
send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
|
3525
|
-
sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function
|
2852
|
+
sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
|
3526
2853
|
socketMessages(): SocketSubject<Message>;
|
3527
2854
|
}
|
3528
2855
|
|
@@ -3548,7 +2875,7 @@ export declare type SocketConnectOptions = {
|
|
3548
2875
|
/**
|
3549
2876
|
* An observer to receive notifications of incoming messages from the server.
|
3550
2877
|
*/
|
3551
|
-
connectObserver?:
|
2878
|
+
connectObserver?: Observer<Message>;
|
3552
2879
|
/**
|
3553
2880
|
* Enable sending heartbeat messages to the server to prevent the connection from timing out.
|
3554
2881
|
*/
|
@@ -3621,11 +2948,7 @@ export declare class SocketMessageHandler {
|
|
3621
2948
|
* @internal
|
3622
2949
|
*/
|
3623
2950
|
export declare class SocketMock implements Socket {
|
3624
|
-
isConfigured: boolean;
|
3625
|
-
isDisconnected: boolean;
|
3626
|
-
isDisconnectedByServer: boolean;
|
3627
2951
|
hasValidSession: boolean;
|
3628
|
-
isConnecting: boolean;
|
3629
2952
|
isConnected: boolean;
|
3630
2953
|
isConnectedSubject: BehaviorSubject<boolean>;
|
3631
2954
|
isReconnecting: boolean;
|
@@ -3634,7 +2957,7 @@ export declare class SocketMock implements Socket {
|
|
3634
2957
|
connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
|
3635
2958
|
disconnect(): void;
|
3636
2959
|
send<T>(message: Message<any>): Promise<Message | any>;
|
3637
|
-
sendForStream<T>(message: Message<any>, onMessage: Function, onError: Function
|
2960
|
+
sendForStream<T>(message: Message<any>, onMessage: Function, onError: Function): Observable<Message>;
|
3638
2961
|
socketMessages(): SocketSubject<Message>;
|
3639
2962
|
reset(): void;
|
3640
2963
|
}
|
@@ -3665,7 +2988,7 @@ export declare type SocketReconnectOptions = {
|
|
3665
2988
|
* Observer to notify when reconnection occurs
|
3666
2989
|
* @public
|
3667
2990
|
*/
|
3668
|
-
reconnectObserver?:
|
2991
|
+
reconnectObserver?: Observer<any>;
|
3669
2992
|
/**
|
3670
2993
|
* Reconnect stream subscriptions on reconnection
|
3671
2994
|
* @public
|
@@ -3698,26 +3021,6 @@ export declare enum SocketReconnectStrategy {
|
|
3698
3021
|
Exponential = "exponential"
|
3699
3022
|
}
|
3700
3023
|
|
3701
|
-
/**
|
3702
|
-
* `SocketStatus` provides the state of the web socket.
|
3703
|
-
* @public
|
3704
|
-
*/
|
3705
|
-
export declare interface SocketStatus extends SerializedSocketStatus {
|
3706
|
-
isConnectedSubject: BehaviorSubject<boolean>;
|
3707
|
-
serialize(): SerializedSocketStatus;
|
3708
|
-
onClose(closeEvent: CloseEvent): void;
|
3709
|
-
}
|
3710
|
-
|
3711
|
-
/**
|
3712
|
-
* SocketStatus DI key.
|
3713
|
-
*
|
3714
|
-
* @privateRemarks
|
3715
|
-
* Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
|
3716
|
-
*
|
3717
|
-
* @internal
|
3718
|
-
*/
|
3719
|
-
export declare const SocketStatus: InterfaceSymbol<SocketStatus>;
|
3720
|
-
|
3721
3024
|
/**
|
3722
3025
|
* Subject that wraps a WebSocketSubject and provides a Subject interface for sending and receiving messages.
|
3723
3026
|
* @public
|
@@ -3756,123 +3059,6 @@ export declare type SSOCredentialsInput = {
|
|
3756
3059
|
*/
|
3757
3060
|
export declare type StorageType = 'local' | 'session';
|
3758
3061
|
|
3759
|
-
/**
|
3760
|
-
* @public
|
3761
|
-
*/
|
3762
|
-
export declare type StreamCompleteEvent = CustomEvent<SocketObservable<any>>;
|
3763
|
-
|
3764
|
-
/**
|
3765
|
-
* @public
|
3766
|
-
*/
|
3767
|
-
export declare const StreamCompleteEventType = "connect-stream-complete-event";
|
3768
|
-
|
3769
|
-
/**
|
3770
|
-
* @public
|
3771
|
-
*/
|
3772
|
-
export declare type StreamEvent = CustomEvent<StreamEventDetail>;
|
3773
|
-
|
3774
|
-
/**
|
3775
|
-
* @public
|
3776
|
-
*/
|
3777
|
-
export declare type StreamEventDetail = {
|
3778
|
-
functions: StreamEventFunctions;
|
3779
|
-
message: Message<MessageDetails.DataserverRequest>;
|
3780
|
-
resourceName: string;
|
3781
|
-
stream: SocketObservable<any>;
|
3782
|
-
};
|
3783
|
-
|
3784
|
-
/**
|
3785
|
-
* @public
|
3786
|
-
*/
|
3787
|
-
export declare type StreamEventFunctions = {
|
3788
|
-
onMessage?: Function;
|
3789
|
-
onError?: Function;
|
3790
|
-
resourceChecks?: MonitoredResourceChecks;
|
3791
|
-
resourceDataLogon?: MonitoredResourceDataLogon;
|
3792
|
-
};
|
3793
|
-
|
3794
|
-
/**
|
3795
|
-
* @public
|
3796
|
-
*/
|
3797
|
-
export declare const StreamEventType = "connect-stream-event";
|
3798
|
-
|
3799
|
-
/**
|
3800
|
-
* SystemHealthChanged.
|
3801
|
-
* @public
|
3802
|
-
*/
|
3803
|
-
export declare const SystemHealthChanged = "system-health-changed";
|
3804
|
-
|
3805
|
-
/**
|
3806
|
-
* SystemHealthChangedEvent.
|
3807
|
-
* @public
|
3808
|
-
*/
|
3809
|
-
export declare type SystemHealthChangedEvent = CustomEvent<SystemHealthStatus>;
|
3810
|
-
|
3811
|
-
/**
|
3812
|
-
* SystemHealthStatus.
|
3813
|
-
* @public
|
3814
|
-
*/
|
3815
|
-
export declare type SystemHealthStatus = {
|
3816
|
-
/**
|
3817
|
-
* Is the browser or device working online.
|
3818
|
-
*/
|
3819
|
-
isOnline: boolean;
|
3820
|
-
/**
|
3821
|
-
* Browser information.
|
3822
|
-
*/
|
3823
|
-
browserInformation?: Bowser_2.Parser.ParsedResult;
|
3824
|
-
/**
|
3825
|
-
* Is the user authenticated.
|
3826
|
-
*/
|
3827
|
-
isAuthenticated: boolean;
|
3828
|
-
/**
|
3829
|
-
* The username if authenticated.
|
3830
|
-
*/
|
3831
|
-
username?: string;
|
3832
|
-
/**
|
3833
|
-
* Is everything online and connected.
|
3834
|
-
*/
|
3835
|
-
isHealthy: boolean;
|
3836
|
-
/**
|
3837
|
-
* Socket status.
|
3838
|
-
*/
|
3839
|
-
socket: SerializedSocketStatus;
|
3840
|
-
/**
|
3841
|
-
* Resource health information.
|
3842
|
-
*/
|
3843
|
-
resources: Record<string, ResourceHealth>;
|
3844
|
-
/**
|
3845
|
-
* Resources are all connected flag.
|
3846
|
-
*/
|
3847
|
-
resourcesAllConnected: boolean;
|
3848
|
-
/**
|
3849
|
-
* Last time the information was updated.
|
3850
|
-
*/
|
3851
|
-
lastUpdated: number;
|
3852
|
-
/**
|
3853
|
-
* Next time the information will be updated.
|
3854
|
-
*
|
3855
|
-
* @privateRemarks
|
3856
|
-
* Overlays may use deltas for a visual countdown to next update.
|
3857
|
-
*/
|
3858
|
-
nextUpdate: number;
|
3859
|
-
/**
|
3860
|
-
* First time the information was updated.
|
3861
|
-
*
|
3862
|
-
* @remarks
|
3863
|
-
* Can be used by applications to understand how-long it has been since the last refresh and to drive automations.
|
3864
|
-
*/
|
3865
|
-
firstUpdated: number;
|
3866
|
-
/**
|
3867
|
-
* User requested run checks.
|
3868
|
-
*/
|
3869
|
-
runAllChecks(): void;
|
3870
|
-
/**
|
3871
|
-
* User requested report stability to Genesis.
|
3872
|
-
*/
|
3873
|
-
reportStabilityToGenesis(): Promise<boolean>;
|
3874
|
-
};
|
3875
|
-
|
3876
3062
|
/**
|
3877
3063
|
* Converts the field definitions to field metadata.
|
3878
3064
|
* @public
|
@@ -3924,28 +3110,14 @@ export declare interface User extends UserOptions {
|
|
3924
3110
|
hasAdminProfile(): boolean;
|
3925
3111
|
hasPermission(permission: UserPermission | UserPermission[]): boolean;
|
3926
3112
|
hasProfile(profile: UserProfile | UserProfile[]): boolean;
|
3927
|
-
set(options: UserOptions): void;
|
3928
|
-
unset(): void;
|
3929
3113
|
}
|
3930
3114
|
|
3931
|
-
/**
|
3932
|
-
* User DI key.
|
3933
|
-
* @privateRemarks
|
3934
|
-
* Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
|
3935
|
-
* @internal
|
3936
|
-
*/
|
3937
|
-
export declare const User: InterfaceSymbol<User>;
|
3938
|
-
|
3939
3115
|
/**
|
3940
3116
|
* The keys used to store user information in the session storage.
|
3941
3117
|
* @internal
|
3942
3118
|
*/
|
3943
3119
|
declare type UserInfoKeys = 'authToken' | 'ssoToken' | 'refreshToken' | 'sessionId' | 'returnUrl' | 'hostUrl' | 'gridOptions';
|
3944
3120
|
|
3945
|
-
/**
|
3946
|
-
* Made some minor adjustments here to make user more accessible in the short term.
|
3947
|
-
* Please note that this User will be replaced with the enhanced version shortly!
|
3948
|
-
*/
|
3949
3121
|
/**
|
3950
3122
|
* TODO: Evolve, re-locate to foundation-data, foundation-user or similar and add JSON schema based population,
|
3951
3123
|
* validation, evolution, foundation-store interop etc.
|