@genesislcap/foundation-comms 14.303.0 → 14.303.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +16 -13
  2. package/docs/api-report.md +0 -2870
@@ -1,2870 +0,0 @@
1
- ## API Report File for "@genesislcap/foundation-comms"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- /// <reference types="webappsec-credential-management" />
8
-
9
- import { BehaviorSubject } from 'rxjs';
10
- import { default as Bowser_2 } from 'bowser';
11
- import { Controller } from '@microsoft/fast-element';
12
- import { DefaultUser } from '@genesislcap/foundation-user';
13
- import type { DTOMapper } from '@genesislcap/foundation-utils';
14
- import type { FASTElement } from '@microsoft/fast-element';
15
- import { InterfaceSymbol } from '@microsoft/fast-foundation';
16
- import { JSONSchema7 } from 'json-schema';
17
- import { JSONSerializer } from '@genesislcap/foundation-utils';
18
- import { Listener } from '@genesislcap/foundation-utils';
19
- import { Logger } from '@genesislcap/foundation-logger';
20
- import type { LogLevel } from '@genesislcap/foundation-utils';
21
- import { Observable } from 'rxjs';
22
- import { Observer } from '@genesislcap/foundation-utils';
23
- import { Observer as Observer_2 } from 'rxjs';
24
- import { SetUserProperties } from '@genesislcap/foundation-user/dist/esm';
25
- import { Subscription as SocketSubscription } from 'rxjs';
26
- import { Subject } from 'rxjs';
27
- import { TypedBroadcastChannel } from '@genesislcap/foundation-broadcast-channel';
28
- import { User as User_2 } from '@genesislcap/foundation-user';
29
- import { UUID } from '@genesislcap/foundation-utils';
30
-
31
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Auth" because one of its declarations is marked as @internal
32
- //
33
- // @public
34
- export interface Auth {
35
- // @internal
36
- readonly currentUser: User_2;
37
- readonly isLoggedIn$?: Observable<boolean>;
38
- readonly isLoggedIn: boolean;
39
- isWorking: boolean;
40
- // @internal
41
- readonly loggedUserResult: LoginResult;
42
- login(credentials: AuthInfo): Promise<LoginResult>;
43
- logout(): Promise<LogoutResult>;
44
- reAuthFromSession(): Promise<boolean>;
45
- }
46
-
47
- // @internal
48
- export const Auth: InterfaceSymbol<Auth>;
49
-
50
- // @public
51
- export class AuthError extends Error {
52
- constructor(sent: Message, received?: Message, message?: string);
53
- // (undocumented)
54
- getDetailsError(): string;
55
- // (undocumented)
56
- getMessageError(): string;
57
- // (undocumented)
58
- hasErrorCode(code: string): boolean;
59
- // (undocumented)
60
- hasMFAError(): boolean;
61
- // (undocumented)
62
- hasPasswordExpiredError(): boolean;
63
- // (undocumented)
64
- isIgnorableError(): boolean;
65
- // (undocumented)
66
- received?: Message;
67
- // (undocumented)
68
- sent: Message;
69
- }
70
-
71
- // @public
72
- export type AuthInfo = BasicAuthInfo | SsoAuthInfo | JwtAuthInfo | RefreshAuthInfo;
73
-
74
- // Warning: (ae-internal-missing-underscore) The name "AuthMock" should be prefixed with an underscore because the declaration is marked as @internal
75
- //
76
- // @internal (undocumented)
77
- export class AuthMock implements Auth {
78
- // (undocumented)
79
- currentUser: User_2;
80
- // (undocumented)
81
- get isLoggedIn$(): Observable<boolean>;
82
- // (undocumented)
83
- isLoggedIn: boolean;
84
- // (undocumented)
85
- isWorking: boolean;
86
- // (undocumented)
87
- loggedUserResult: LoginResult;
88
- // (undocumented)
89
- login(credentials: AuthInfo): Promise<LoginResult>;
90
- // (undocumented)
91
- logout(): Promise<LogoutResult>;
92
- // (undocumented)
93
- nextLoginResult: LoginResult;
94
- // (undocumented)
95
- nextLogoutResult: LogoutResult;
96
- // (undocumented)
97
- nextReAuthResult: boolean;
98
- // (undocumented)
99
- reAuthFromSession(): Promise<boolean>;
100
- // (undocumented)
101
- resetTestUser(): void;
102
- // (undocumented)
103
- setTestUser(properties?: Partial<SetUserProperties>): void;
104
- }
105
-
106
- // @public
107
- export enum AuthType {
108
- // (undocumented)
109
- BASIC = "BASIC",
110
- // (undocumented)
111
- JWT = "JWT",
112
- // (undocumented)
113
- REFRESH = "REFRESH",
114
- // (undocumented)
115
- SSO = "SSO"
116
- }
117
-
118
- // @public
119
- export type BasicAuthInfo = {
120
- type: AuthType & AuthType.BASIC;
121
- username: string;
122
- password: string;
123
- mfaToken?: string;
124
- };
125
-
126
- // @public
127
- export type BasicCredentialsInput = {
128
- username: string;
129
- password: string;
130
- };
131
-
132
- // @public (undocumented)
133
- export type CommitAckEvent = CustomEvent<CommitAckEventDetail>;
134
-
135
- // @public (undocumented)
136
- export type CommitAckEventDetail = {
137
- eventName: string;
138
- ack: Message;
139
- };
140
-
141
- // @public (undocumented)
142
- export const CommitAckEventType = "connect-commit-ack-event";
143
-
144
- // @public (undocumented)
145
- export type CommitEvent = CustomEvent<CommitEventDetail>;
146
-
147
- // @public (undocumented)
148
- export type CommitEventDetail = {
149
- eventName: string;
150
- message: Message;
151
- };
152
-
153
- // @public (undocumented)
154
- export const CommitEventType = "connect-commit-event";
155
-
156
- // @public
157
- export type CommitParams = {
158
- DETAILS: any;
159
- HOSTNAME?: string;
160
- IGNORE_WARNINGS?: boolean;
161
- VALIDATE?: boolean;
162
- [key: string]: any;
163
- };
164
-
165
- // @public (undocumented)
166
- export type CommitResponseEvent = CustomEvent<CommitResponseEventDetail>;
167
-
168
- // @public (undocumented)
169
- export type CommitResponseEventDetail = {
170
- eventName: string;
171
- response: Message;
172
- };
173
-
174
- // @public (undocumented)
175
- export const CommitResponseEventType = "connect-commit-response-event";
176
-
177
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Connect" because one of its declarations is marked as @internal
178
- //
179
- // @public
180
- export interface Connect {
181
- commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
182
- connect(host?: string): Promise<boolean>;
183
- dataLogoff(sourceRef: string): Promise<Message>;
184
- disconnect(): void;
185
- getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
186
- getJSONSchema(resourceName: string): Promise<SchemaResponse>;
187
- getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
188
- getMoreColumns(sourceRef: string): Promise<Message>;
189
- getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
190
- // (undocumented)
191
- host: string;
192
- // @internal
193
- httpMode(): boolean;
194
- readonly isConnected$?: Observable<boolean>;
195
- readonly isConnected: boolean;
196
- // @deprecated
197
- readonly isConnectedSubject?: BehaviorSubject<boolean>;
198
- isWorking: boolean;
199
- request(resourceName: string, params?: RequestParams): Promise<Message>;
200
- // @internal
201
- send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
202
- // @internal
203
- setValidSession(valid: boolean): void;
204
- snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
205
- stream(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
206
- streamState(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
207
- // @alpha @deprecated
208
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
209
- }
210
-
211
- // @internal
212
- export const Connect: InterfaceSymbol<Connect>;
213
-
214
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "ConnectConfig" because one of its declarations is marked as @internal
215
- //
216
- // @public
217
- export interface ConnectConfig {
218
- connect: SocketConnectOptions;
219
- isWebSocketExpression: RegExp;
220
- reconnect: SocketReconnectOptions;
221
- }
222
-
223
- // @internal
224
- export const ConnectConfig: InterfaceSymbol<ConnectConfig>;
225
-
226
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "ConnectEvents" because one of its declarations is marked as @internal
227
- //
228
- // @public
229
- export interface ConnectEvents {
230
- addCommitListener(listener: Listener<CommitEvent>): () => void;
231
- addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
232
- addMetadataListener(listener: Listener<MetadataEvent>): () => void;
233
- addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
234
- }
235
-
236
- // @internal
237
- export const ConnectEvents: InterfaceSymbol<ConnectEvents>;
238
-
239
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "ConnectEventsEmitter" because one of its declarations is marked as @internal
240
- //
241
- // @public
242
- export interface ConnectEventsEmitter extends ConnectEvents {
243
- onCommitEvent(eventName: string, message: Message): void;
244
- onCommitResponseEvent(eventName: string, response: Message): void;
245
- onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
246
- onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
247
- onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
248
- onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
249
- }
250
-
251
- // @internal
252
- export const ConnectEventsEmitter: InterfaceSymbol<ConnectEventsEmitter>;
253
-
254
- // Warning: (ae-internal-missing-underscore) The name "ConnectEventsMock" should be prefixed with an underscore because the declaration is marked as @internal
255
- //
256
- // @internal (undocumented)
257
- export class ConnectEventsMock {
258
- // Warning: (ae-forgotten-export) The symbol "CommitAckEvent_2" needs to be exported by the entry point index.d.ts
259
- //
260
- // (undocumented)
261
- addCommitAckListener(listener: Listener_2<CommitAckEvent_2>): () => void;
262
- // Warning: (ae-forgotten-export) The symbol "CommitEvent_2" needs to be exported by the entry point index.d.ts
263
- //
264
- // (undocumented)
265
- addCommitListener(listener: Listener_2<CommitEvent_2>): () => void;
266
- // Warning: (ae-forgotten-export) The symbol "CommitResponseEvent_2" needs to be exported by the entry point index.d.ts
267
- //
268
- // (undocumented)
269
- addCommitResponseListener(listener: Listener_2<CommitResponseEvent_2>): () => void;
270
- // Warning: (ae-forgotten-export) The symbol "MetadataEvent_2" needs to be exported by the entry point index.d.ts
271
- //
272
- // (undocumented)
273
- addMetadataListener(listener: Listener_2<MetadataEvent_2>): () => void;
274
- // Warning: (ae-forgotten-export) The symbol "Listener_2" needs to be exported by the entry point index.d.ts
275
- // Warning: (ae-forgotten-export) The symbol "StreamEvent_2" needs to be exported by the entry point index.d.ts
276
- // Warning: (ae-forgotten-export) The symbol "StreamCompleteEvent_2" needs to be exported by the entry point index.d.ts
277
- // Warning: (ae-forgotten-export) The symbol "StreamErrorEvent_2" needs to be exported by the entry point index.d.ts
278
- //
279
- // (undocumented)
280
- addStreamListener(listener: Listener_2<StreamEvent_2>, complete: Listener_2<StreamCompleteEvent_2>, error: Listener_2<StreamErrorEvent_2>): () => void;
281
- // (undocumented)
282
- onCommitEvent(eventName: string, message: Message_2): void;
283
- // (undocumented)
284
- onCommitResponseEvent(eventName: string, response: Message_2): void;
285
- // (undocumented)
286
- onMetadataEvent(resourceName: string, message: Message_2, error?: any): void;
287
- // (undocumented)
288
- onStreamCompleteEvent(resourceName: string, stream: SocketObservable_2<any>): void;
289
- // (undocumented)
290
- onStreamErrorEvent(resourceName: string, stream: SocketObservable_2<any>, error: any): void;
291
- // Warning: (ae-forgotten-export) The symbol "Message_2" needs to be exported by the entry point index.d.ts
292
- // Warning: (ae-forgotten-export) The symbol "SocketObservable_2" needs to be exported by the entry point index.d.ts
293
- // Warning: (ae-forgotten-export) The symbol "StreamEventFunctions_2" needs to be exported by the entry point index.d.ts
294
- //
295
- // (undocumented)
296
- onStreamEvent(resourceName: string, message: Message_2, stream: SocketObservable_2<any>, functions: StreamEventFunctions_2): void;
297
- }
298
-
299
- // @public
300
- export type ConnectionStatus = 'connected' | 'disconnected' | 'busy';
301
-
302
- // Warning: (ae-internal-missing-underscore) The name "ConnectMock" should be prefixed with an underscore because the declaration is marked as @internal
303
- //
304
- // @internal (undocumented)
305
- export class ConnectMock implements Connect {
306
- // (undocumented)
307
- commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
308
- // (undocumented)
309
- connect(host: string): Promise<boolean>;
310
- // (undocumented)
311
- dataLogoff(sourceRef: string): Promise<Message<any>>;
312
- // (undocumented)
313
- disconnect(): void;
314
- // (undocumented)
315
- getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
316
- // (undocumented)
317
- getJSONSchema(resourceName: string): Promise<any>;
318
- // (undocumented)
319
- getMetadata(resourceName: string): Promise<Metadata>;
320
- // (undocumented)
321
- getMoreColumns(sourceRef: string): Promise<Message<any>>;
322
- // (undocumented)
323
- getMoreRows(sourceRef: string): Promise<Message<any>>;
324
- // (undocumented)
325
- get host(): string;
326
- // (undocumented)
327
- httpMode(): boolean;
328
- // (undocumented)
329
- get isConnected$(): Observable<boolean>;
330
- // (undocumented)
331
- isConnected: boolean;
332
- // (undocumented)
333
- get isConnectedSubject(): BehaviorSubject<boolean>;
334
- // (undocumented)
335
- isWorking: boolean;
336
- // (undocumented)
337
- nextJSONSchema: any;
338
- // (undocumented)
339
- nextListState: any[];
340
- // (undocumented)
341
- nextMessage: Message;
342
- // (undocumented)
343
- nextMetadata: Metadata;
344
- // (undocumented)
345
- request(resourceName: string, params?: RequestParams): Promise<Message>;
346
- // (undocumented)
347
- requestParams: RequestParams;
348
- // (undocumented)
349
- send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
350
- // (undocumented)
351
- setValidSession(valid: boolean): void;
352
- // (undocumented)
353
- snapshot(resourceName: string, params?: any): Promise<Message>;
354
- // (undocumented)
355
- socket: SocketMock;
356
- // (undocumented)
357
- stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
358
- // (undocumented)
359
- streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
360
- // (undocumented)
361
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
362
- }
363
-
364
- // Warning: (ae-internal-missing-underscore) The name "CoreUserPermissions" should be prefixed with an underscore because the declaration is marked as @internal
365
- //
366
- // @internal (undocumented)
367
- export type CoreUserPermissions = 'somePermission' | 'someOtherPermission';
368
-
369
- // Warning: (ae-internal-missing-underscore) The name "CoreUserProfiles" should be prefixed with an underscore because the declaration is marked as @internal
370
- //
371
- // @internal (undocumented)
372
- export type CoreUserProfiles = 'someProfile' | 'someOtherProfile';
373
-
374
- // @public
375
- type CredentialData_2 = PasswordCredentialData & {
376
- password?: string;
377
- };
378
- export { CredentialData_2 as CredentialData }
379
-
380
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "CredentialManager" because one of its declarations is marked as @internal
381
- //
382
- // @public
383
- export interface CredentialManager {
384
- createBasicCredentials(inputs: BasicCredentialsInput): BasicAuthInfo;
385
- createRefreshCredentials(inputs?: RefreshCredentialsInput): RefreshAuthInfo;
386
- createSSOCredentials(inputs?: SSOCredentialsInput): SsoAuthInfo;
387
- getCredentials(options?: GetCredentialOptions): Promise<CredentialData_2 | undefined>;
388
- getCredentialsFromContainer(options?: GetCredentialOptions): Promise<CredentialData_2 | null>;
389
- getCredentialsFromCookie(): CredentialData_2 | undefined;
390
- getMFAToken(): string | null;
391
- getRefreshToken(): string | null;
392
- getSSOToken(): string | null;
393
- getUsername(): string | null;
394
- normaliseLegacyCredentialData(data?: CredentialData_2, cookie?: CredentialData_2): [CredentialData_2 | undefined, boolean];
395
- preventSilentAccess(): Promise<void>;
396
- removeAll(): void;
397
- removeCookie(): void;
398
- removeMFAToken(): void;
399
- removeRefreshToken(): void;
400
- removeSSOToken(): void;
401
- removeUsername(): void;
402
- storeCredentials(data: CredentialData_2): Promise<boolean>;
403
- storeCredentialsInContainer(data: CredentialData_2): Promise<Credential | undefined>;
404
- storeCredentialsInCookie(data: CredentialData_2): boolean;
405
- validateBasicCredentials(credentials: BasicAuthInfo): boolean;
406
- validateRefreshCredentials(credentials: RefreshAuthInfo): boolean;
407
- validateSSOCredentials(credentials: SsoAuthInfo): boolean;
408
- validateUserCredentialData(data: CredentialData_2, ensurePassword?: boolean): boolean;
409
- }
410
-
411
- // @internal
412
- export const CredentialManager: InterfaceSymbol<CredentialManager>;
413
-
414
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "CredentialManagerConfig" because one of its declarations is marked as @internal
415
- //
416
- // @public
417
- export interface CredentialManagerConfig {
418
- // (undocumented)
419
- cookie: CredentialManagerCookieConfig;
420
- }
421
-
422
- // @internal
423
- export const CredentialManagerConfig: InterfaceSymbol<CredentialManagerConfig>;
424
-
425
- // @public
426
- export interface CredentialManagerCookieConfig {
427
- // (undocumented)
428
- expires: number | Date;
429
- // (undocumented)
430
- name: string;
431
- // (undocumented)
432
- path: string;
433
- // (undocumented)
434
- storePasswords?: boolean;
435
- }
436
-
437
- // @public
438
- export const credentialSeparator = ":";
439
-
440
- // @public
441
- export function criteriaFiltersToFields(filters: string): Record<string, string>;
442
-
443
- // @public @deprecated
444
- export class CurrentUser extends DefaultUser implements User {
445
- }
446
-
447
- // @public
448
- export type DataserverParams = {
449
- DATASOURCE_NAME?: string;
450
- CRITERIA_MATCH?: string;
451
- MAX_ROWS?: number;
452
- VIEW_NUMBER?: number;
453
- FIELDS?: string;
454
- MAX_VIEW?: number;
455
- MOVING_VIEW?: boolean;
456
- ORDER_BY?: string;
457
- REVERSE?: boolean;
458
- };
459
-
460
- // @public
461
- export function dataServerResultFilter(result: RawDataServerResult, rowId?: string): FilteredDataServerResult;
462
-
463
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Datasource" because one of its declarations is marked as @internal
464
- //
465
- // @public
466
- export interface Datasource extends DatasourceMetadata {
467
- addView?(view: Dataview): void;
468
- clearFilter?(name: string): Promise<void>;
469
- createItem?(data: any): Promise<string>;
470
- dataHandler?(data: Array<any>): Array<any>;
471
- deleteItem?(itemId: string): Promise<void>;
472
- destroy(): void;
473
- dropView?(view: Dataview): void;
474
- getMetadata?(resourceName: string): Promise<Array<FieldMetadata>>;
475
- init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
476
- initialized: boolean;
477
- readOnly: boolean;
478
- resourceType: ResourceType;
479
- setFilter?(name: string, value: any, type?: string): Promise<void>;
480
- snapshot(overrideParams?: any): Promise<Message>;
481
- snapshotFiltered(rowId?: string): Promise<any[]>;
482
- startStream(): Promise<void>;
483
- // (undocumented)
484
- status: Partial<DatasourceStatus>;
485
- stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
486
- updateData?(data: Array<any>): Promise<void>;
487
- updateItem?(itemId: string, data: any): Promise<void>;
488
- // @deprecated
489
- validResourceName(resourceName: string): boolean;
490
- }
491
-
492
- // @internal
493
- export const Datasource: InterfaceSymbol<Datasource>;
494
-
495
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "DatasourceConfig" because one of its declarations is marked as @internal
496
- //
497
- // @public
498
- export interface DatasourceConfig {
499
- // (undocumented)
500
- criteriaToFields(filters: string): Record<string, string>;
501
- // (undocumented)
502
- dataServerResultFilter(result: RawDataServerResult, rowId?: string): FilteredDataServerResult;
503
- eventEmitter?: HTMLElement;
504
- // (undocumented)
505
- options: DatasourceOptions;
506
- }
507
-
508
- // @internal
509
- export const DatasourceConfig: InterfaceSymbol<DatasourceConfig>;
510
-
511
- // @public
512
- export class DatasourceDefaults {
513
- // (undocumented)
514
- static readonly DATASERVER_ROW_ID = "ROW_REF";
515
- // (undocumented)
516
- static readonly DEFAULT_PAGINATION_PAGE_SIZE = 25;
517
- // (undocumented)
518
- static readonly MAX_ROWS_250 = 250;
519
- // (undocumented)
520
- static readonly MAX_VIEW_1000 = 1000;
521
- // (undocumented)
522
- static readonly REQ_REP_POLLING_INTERVAL_MS = 10000;
523
- // (undocumented)
524
- static readonly REQUEST_SERVER_ROW_ID = "RECORD_ID";
525
- }
526
-
527
- // @public
528
- export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
529
- new (): {
530
- datasourceStatus: DatasourceStatus;
531
- resourceName: string;
532
- onDatasourceStatusChanged: (event: DatasourceStatusChangedEvent) => void;
533
- datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): void;
534
- connectedCallback(): void;
535
- disconnectedCallback(): void;
536
- accessKey: string;
537
- readonly accessKeyLabel: string;
538
- autocapitalize: string;
539
- dir: string;
540
- draggable: boolean;
541
- hidden: boolean;
542
- inert: boolean;
543
- innerText: string;
544
- lang: string;
545
- readonly offsetHeight: number;
546
- readonly offsetLeft: number;
547
- readonly offsetParent: Element;
548
- readonly offsetTop: number;
549
- readonly offsetWidth: number;
550
- outerText: string;
551
- spellcheck: boolean;
552
- title: string;
553
- translate: boolean;
554
- attachInternals(): ElementInternals;
555
- click(): void;
556
- addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
557
- addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
558
- removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
559
- removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
560
- readonly attributes: NamedNodeMap;
561
- readonly classList: DOMTokenList;
562
- className: string;
563
- readonly clientHeight: number;
564
- readonly clientLeft: number;
565
- readonly clientTop: number;
566
- readonly clientWidth: number;
567
- id: string;
568
- readonly localName: string;
569
- readonly namespaceURI: string;
570
- onfullscreenchange: (this: Element, ev: Event) => any;
571
- onfullscreenerror: (this: Element, ev: Event) => any;
572
- outerHTML: string;
573
- readonly ownerDocument: Document;
574
- readonly part: DOMTokenList;
575
- readonly prefix: string;
576
- readonly scrollHeight: number;
577
- scrollLeft: number;
578
- scrollTop: number;
579
- readonly scrollWidth: number;
580
- readonly shadowRoot: ShadowRoot;
581
- slot: string;
582
- readonly tagName: string;
583
- attachShadow(init: ShadowRootInit): ShadowRoot;
584
- closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
585
- closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
586
- closest<E extends Element = Element>(selectors: string): E;
587
- getAttribute(qualifiedName: string): string;
588
- getAttributeNS(namespace: string, localName: string): string;
589
- getAttributeNames(): string[];
590
- getAttributeNode(qualifiedName: string): Attr;
591
- getAttributeNodeNS(namespace: string, localName: string): Attr;
592
- getBoundingClientRect(): DOMRect;
593
- getClientRects(): DOMRectList;
594
- getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
595
- getElementsByTagName<K_4 extends keyof HTMLElementTagNameMap>(qualifiedName: K_4): HTMLCollectionOf<HTMLElementTagNameMap[K_4]>;
596
- getElementsByTagName<K_5 extends keyof SVGElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<SVGElementTagNameMap[K_5]>;
597
- getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
598
- getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
599
- getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
600
- getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
601
- hasAttribute(qualifiedName: string): boolean;
602
- hasAttributeNS(namespace: string, localName: string): boolean;
603
- hasAttributes(): boolean;
604
- hasPointerCapture(pointerId: number): boolean;
605
- insertAdjacentElement(where: InsertPosition, element: Element): Element;
606
- insertAdjacentHTML(position: InsertPosition, text: string): void;
607
- insertAdjacentText(where: InsertPosition, data: string): void;
608
- matches(selectors: string): boolean;
609
- releasePointerCapture(pointerId: number): void;
610
- removeAttribute(qualifiedName: string): void;
611
- removeAttributeNS(namespace: string, localName: string): void;
612
- removeAttributeNode(attr: Attr): Attr;
613
- requestFullscreen(options?: FullscreenOptions): Promise<void>;
614
- requestPointerLock(): void;
615
- scroll(options?: ScrollToOptions): void;
616
- scroll(x: number, y: number): void;
617
- scrollBy(options?: ScrollToOptions): void;
618
- scrollBy(x: number, y: number): void;
619
- scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
620
- scrollTo(options?: ScrollToOptions): void;
621
- scrollTo(x: number, y: number): void;
622
- setAttribute(qualifiedName: string, value: string): void;
623
- setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
624
- setAttributeNode(attr: Attr): Attr;
625
- setAttributeNodeNS(attr: Attr): Attr;
626
- setPointerCapture(pointerId: number): void;
627
- toggleAttribute(qualifiedName: string, force?: boolean): boolean;
628
- webkitMatchesSelector(selectors: string): boolean;
629
- readonly baseURI: string;
630
- readonly childNodes: NodeListOf<ChildNode>;
631
- readonly firstChild: ChildNode;
632
- readonly isConnected: boolean;
633
- readonly lastChild: ChildNode;
634
- readonly nextSibling: ChildNode;
635
- readonly nodeName: string;
636
- readonly nodeType: number;
637
- nodeValue: string;
638
- readonly parentElement: HTMLElement;
639
- readonly parentNode: ParentNode;
640
- readonly previousSibling: ChildNode;
641
- textContent: string;
642
- appendChild<T extends Node>(node: T): T;
643
- cloneNode(deep?: boolean): Node;
644
- compareDocumentPosition(other: Node): number;
645
- contains(other: Node): boolean;
646
- getRootNode(options?: GetRootNodeOptions): Node;
647
- hasChildNodes(): boolean;
648
- insertBefore<T_1 extends Node>(node: T_1, child: Node): T_1;
649
- isDefaultNamespace(namespace: string): boolean;
650
- isEqualNode(otherNode: Node): boolean;
651
- isSameNode(otherNode: Node): boolean;
652
- lookupNamespaceURI(prefix: string): string;
653
- lookupPrefix(namespace: string): string;
654
- normalize(): void;
655
- removeChild<T_2 extends Node>(child: T_2): T_2;
656
- replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
657
- readonly ATTRIBUTE_NODE: number;
658
- readonly CDATA_SECTION_NODE: number;
659
- readonly COMMENT_NODE: number;
660
- readonly DOCUMENT_FRAGMENT_NODE: number;
661
- readonly DOCUMENT_NODE: number;
662
- readonly DOCUMENT_POSITION_CONTAINED_BY: number;
663
- readonly DOCUMENT_POSITION_CONTAINS: number;
664
- readonly DOCUMENT_POSITION_DISCONNECTED: number;
665
- readonly DOCUMENT_POSITION_FOLLOWING: number;
666
- readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
667
- readonly DOCUMENT_POSITION_PRECEDING: number;
668
- readonly DOCUMENT_TYPE_NODE: number;
669
- readonly ELEMENT_NODE: number;
670
- readonly ENTITY_NODE: number;
671
- readonly ENTITY_REFERENCE_NODE: number;
672
- readonly NOTATION_NODE: number;
673
- readonly PROCESSING_INSTRUCTION_NODE: number;
674
- readonly TEXT_NODE: number;
675
- dispatchEvent(event: Event): boolean;
676
- ariaAtomic: string;
677
- ariaAutoComplete: string;
678
- ariaBusy: string;
679
- ariaChecked: string;
680
- ariaColCount: string;
681
- ariaColIndex: string;
682
- ariaColIndexText: string;
683
- ariaColSpan: string;
684
- ariaCurrent: string;
685
- ariaDisabled: string;
686
- ariaExpanded: string;
687
- ariaHasPopup: string;
688
- ariaHidden: string;
689
- ariaInvalid: string;
690
- ariaKeyShortcuts: string;
691
- ariaLabel: string;
692
- ariaLevel: string;
693
- ariaLive: string;
694
- ariaModal: string;
695
- ariaMultiLine: string;
696
- ariaMultiSelectable: string;
697
- ariaOrientation: string;
698
- ariaPlaceholder: string;
699
- ariaPosInSet: string;
700
- ariaPressed: string;
701
- ariaReadOnly: string;
702
- ariaRequired: string;
703
- ariaRoleDescription: string;
704
- ariaRowCount: string;
705
- ariaRowIndex: string;
706
- ariaRowIndexText: string;
707
- ariaRowSpan: string;
708
- ariaSelected: string;
709
- ariaSetSize: string;
710
- ariaSort: string;
711
- ariaValueMax: string;
712
- ariaValueMin: string;
713
- ariaValueNow: string;
714
- ariaValueText: string;
715
- role: string;
716
- animate(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions): Animation;
717
- getAnimations(options?: GetAnimationsOptions): Animation[];
718
- after(...nodes: (string | Node)[]): void;
719
- before(...nodes: (string | Node)[]): void;
720
- remove(): void;
721
- replaceWith(...nodes: (string | Node)[]): void;
722
- innerHTML: string;
723
- readonly nextElementSibling: Element;
724
- readonly previousElementSibling: Element;
725
- readonly childElementCount: number;
726
- readonly children: HTMLCollection;
727
- readonly firstElementChild: Element;
728
- readonly lastElementChild: Element;
729
- append(...nodes: (string | Node)[]): void;
730
- prepend(...nodes: (string | Node)[]): void;
731
- querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
732
- querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
733
- querySelector<E_1 extends Element = Element>(selectors: string): E_1;
734
- querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
735
- querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
736
- querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
737
- replaceChildren(...nodes: (string | Node)[]): void;
738
- readonly assignedSlot: HTMLSlotElement;
739
- oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
740
- oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
741
- onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
742
- readonly style: CSSStyleDeclaration;
743
- contentEditable: string;
744
- enterKeyHint: string;
745
- inputMode: string;
746
- readonly isContentEditable: boolean;
747
- onabort: (this: GlobalEventHandlers, ev: UIEvent) => any;
748
- onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
749
- onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
750
- onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
751
- onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
752
- onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
753
- onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
754
- onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
755
- oncancel: (this: GlobalEventHandlers, ev: Event) => any;
756
- oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
757
- oncanplaythrough: (this: GlobalEventHandlers, ev: Event) => any;
758
- onchange: (this: GlobalEventHandlers, ev: Event) => any;
759
- onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
760
- onclose: (this: GlobalEventHandlers, ev: Event) => any;
761
- oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
762
- oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
763
- ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
764
- ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
765
- ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
766
- ondragenter: (this: GlobalEventHandlers, ev: DragEvent) => any;
767
- ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any;
768
- ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any;
769
- ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any;
770
- ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any;
771
- ondurationchange: (this: GlobalEventHandlers, ev: Event) => any;
772
- onemptied: (this: GlobalEventHandlers, ev: Event) => any;
773
- onended: (this: GlobalEventHandlers, ev: Event) => any;
774
- onerror: OnErrorEventHandlerNonNull;
775
- onfocus: (this: GlobalEventHandlers, ev: FocusEvent) => any;
776
- onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) => any;
777
- ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
778
- oninput: (this: GlobalEventHandlers, ev: Event) => any;
779
- oninvalid: (this: GlobalEventHandlers, ev: Event) => any;
780
- onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
781
- onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
782
- onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
783
- onload: (this: GlobalEventHandlers, ev: Event) => any;
784
- onloadeddata: (this: GlobalEventHandlers, ev: Event) => any;
785
- onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any;
786
- onloadstart: (this: GlobalEventHandlers, ev: Event) => any;
787
- onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
788
- onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any;
789
- onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) => any;
790
- onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) => any;
791
- onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) => any;
792
- onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
793
- onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
794
- onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
795
- onpause: (this: GlobalEventHandlers, ev: Event) => any;
796
- onplay: (this: GlobalEventHandlers, ev: Event) => any;
797
- onplaying: (this: GlobalEventHandlers, ev: Event) => any;
798
- onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any;
799
- onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) => any;
800
- onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) => any;
801
- onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) => any;
802
- onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) => any;
803
- onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) => any;
804
- onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) => any;
805
- onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) => any;
806
- onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
807
- onratechange: (this: GlobalEventHandlers, ev: Event) => any;
808
- onreset: (this: GlobalEventHandlers, ev: Event) => any;
809
- onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
810
- onscroll: (this: GlobalEventHandlers, ev: Event) => any;
811
- onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
812
- onseeked: (this: GlobalEventHandlers, ev: Event) => any;
813
- onseeking: (this: GlobalEventHandlers, ev: Event) => any;
814
- onselect: (this: GlobalEventHandlers, ev: Event) => any;
815
- onselectionchange: (this: GlobalEventHandlers, ev: Event) => any;
816
- onselectstart: (this: GlobalEventHandlers, ev: Event) => any;
817
- onslotchange: (this: GlobalEventHandlers, ev: Event) => any;
818
- onstalled: (this: GlobalEventHandlers, ev: Event) => any;
819
- onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any;
820
- onsuspend: (this: GlobalEventHandlers, ev: Event) => any;
821
- ontimeupdate: (this: GlobalEventHandlers, ev: Event) => any;
822
- ontoggle: (this: GlobalEventHandlers, ev: Event) => any;
823
- ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
824
- ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
825
- ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
826
- ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
827
- ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
828
- ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
829
- ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
830
- ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
831
- onvolumechange: (this: GlobalEventHandlers, ev: Event) => any;
832
- onwaiting: (this: GlobalEventHandlers, ev: Event) => any;
833
- onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any;
834
- onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any;
835
- onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any;
836
- onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any;
837
- onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any;
838
- autofocus: boolean;
839
- readonly dataset: DOMStringMap;
840
- nonce?: string;
841
- tabIndex: number;
842
- blur(): void;
843
- focus(options?: FocusOptions): void;
844
- readonly $fastController: Controller;
845
- $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
846
- attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
847
- };
848
- };
849
-
850
- // @public
851
- export interface DatasourceMetadata {
852
- // (undocumented)
853
- readonly availableIndexes: IndexDetail[];
854
- // (undocumented)
855
- readonly customRequestFields: MetadataDetail[];
856
- // (undocumented)
857
- fetchMetadataRequired: boolean;
858
- // (undocumented)
859
- readonly fieldMetadata: FieldMetadata[];
860
- // (undocumented)
861
- readonly originalFieldDef: MetadataDetail[];
862
- // (undocumented)
863
- readonly requestFields: MetadataDetail[];
864
- // (undocumented)
865
- startStreamRequired: boolean;
866
- }
867
-
868
- // Warning: (ae-internal-missing-underscore) The name "DatasourceMock" should be prefixed with an underscore because the declaration is marked as @internal
869
- //
870
- // @internal (undocumented)
871
- export class DatasourceMock implements Datasource {
872
- // (undocumented)
873
- addView?(view: Dataview): void;
874
- // (undocumented)
875
- availableIndexes: IndexDetail[];
876
- // (undocumented)
877
- clearFilter?(name: string): Promise<void>;
878
- // (undocumented)
879
- createItem?(data: any): Promise<string>;
880
- // (undocumented)
881
- customRequestFields: MetadataDetail[];
882
- // (undocumented)
883
- dataHandler?(data: any[]): any[];
884
- // (undocumented)
885
- deinit(): void;
886
- // (undocumented)
887
- deleteItem?(itemId: string): Promise<void>;
888
- // (undocumented)
889
- destroy(): void;
890
- // (undocumented)
891
- dropView?(view: Dataview): void;
892
- // (undocumented)
893
- protected fetchingMetadata: boolean;
894
- // (undocumented)
895
- fetchMetadataRequired: boolean;
896
- // (undocumented)
897
- fieldMetadata: FieldMetadata[];
898
- // (undocumented)
899
- getMetadata?(resourceName: string): Promise<FieldMetadata[]>;
900
- // (undocumented)
901
- init(options: DatasourceOptions, fetchMeta: boolean): Promise<boolean>;
902
- // (undocumented)
903
- initialized: boolean;
904
- // (undocumented)
905
- originalFieldDef: MetadataDetail[];
906
- // (undocumented)
907
- readOnly: boolean;
908
- // (undocumented)
909
- requestFields: MetadataDetail[];
910
- // (undocumented)
911
- resourceType: ResourceType;
912
- // (undocumented)
913
- setFilter?(name: string, value: any, type?: string): Promise<void>;
914
- setMetadata(meta: Metadata): void;
915
- setStream(message: Message): void;
916
- // (undocumented)
917
- snapshot(params?: any): Promise<Message<any>>;
918
- // (undocumented)
919
- snapshotFiltered(rowId?: string): Promise<any[]>;
920
- // (undocumented)
921
- startStream(): Promise<void>;
922
- // (undocumented)
923
- startStreamRequired: boolean;
924
- // (undocumented)
925
- status: DatasourceStatus;
926
- // (undocumented)
927
- stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
928
- // (undocumented)
929
- unsetMedata(): void;
930
- // (undocumented)
931
- unsetStream(): void;
932
- // (undocumented)
933
- updateData?(data: any[]): Promise<void>;
934
- // (undocumented)
935
- updateItem?(itemId: string, data: any): Promise<void>;
936
- // (undocumented)
937
- validResourceName(resourceName: string): boolean;
938
- }
939
-
940
- // @public
941
- export interface DatasourceOptions {
942
- criteria?: string;
943
- disablePolling?: boolean;
944
- fields?: string;
945
- isSnapshot?: boolean;
946
- maxRows?: number;
947
- maxView?: number;
948
- movingView?: boolean;
949
- orderBy?: string;
950
- pollingInterval?: number;
951
- pollTriggerEvents?: string[];
952
- request?: any;
953
- requestAutoSetup?: boolean;
954
- resourceName?: string;
955
- reverse?: boolean;
956
- viewNumber?: number;
957
- }
958
-
959
- // @public
960
- export type DatasourceStatus = {
961
- name: string;
962
- type: `${ResourceType}`;
963
- isInitialized: boolean;
964
- metadataRequired: boolean;
965
- hasMetadata: boolean;
966
- };
967
-
968
- // @public
969
- export const DatasourceStatusChanged = "datasource-status-changed";
970
-
971
- // @public
972
- export type DatasourceStatusChangedEvent = CustomEvent<DatasourceStatus>;
973
-
974
- // @public
975
- export interface DataUpdate {
976
- // (undocumented)
977
- add?: Array<any>;
978
- // (undocumented)
979
- drop?: Array<any>;
980
- // (undocumented)
981
- modify?: Array<any>;
982
- }
983
-
984
- // @public
985
- export interface Dataview {
986
- columnsMetadata?: FieldMetadata[];
987
- data: any[];
988
- hideSearch?: boolean;
989
- update?: (data: DataUpdate) => Promise<void>;
990
- }
991
-
992
- // @public
993
- export class DefaultAuth implements Auth {
994
- constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager, currentUser: User_2);
995
- // (undocumented)
996
- currentUser: User_2;
997
- // (undocumented)
998
- get isLoggedIn$(): Observable<boolean>;
999
- // (undocumented)
1000
- get isLoggedIn(): boolean;
1001
- // (undocumented)
1002
- isWorking: boolean;
1003
- // (undocumented)
1004
- loggedUserResult: LoginResult;
1005
- // (undocumented)
1006
- login(credentials: AuthInfo): Promise<LoginResult>;
1007
- // (undocumented)
1008
- logout(): Promise<LogoutResult>;
1009
- // (undocumented)
1010
- reAuthFromSession(): Promise<boolean>;
1011
- }
1012
-
1013
- // @public
1014
- export class DefaultConnect implements Connect {
1015
- constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
1016
- // (undocumented)
1017
- commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
1018
- // (undocumented)
1019
- connect(host?: string): Promise<boolean>;
1020
- // (undocumented)
1021
- dataLogoff(streamSourceRef: string): Promise<Message>;
1022
- // (undocumented)
1023
- disconnect(): void;
1024
- // (undocumented)
1025
- getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
1026
- // (undocumented)
1027
- getJSONSchema(resourceName: string, useCache?: boolean): Promise<SchemaResponse>;
1028
- // (undocumented)
1029
- getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
1030
- // (undocumented)
1031
- getMoreColumns(sourceRef: string): Promise<Message>;
1032
- // (undocumented)
1033
- getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
1034
- // (undocumented)
1035
- get host(): string;
1036
- // (undocumented)
1037
- httpMode(): boolean;
1038
- // (undocumented)
1039
- get isConnected$(): Observable<boolean>;
1040
- // (undocumented)
1041
- get isConnected(): boolean;
1042
- // (undocumented)
1043
- get isConnectedSubject(): BehaviorSubject<boolean>;
1044
- // (undocumented)
1045
- isWorking: boolean;
1046
- // (undocumented)
1047
- request(resourceName: string, params?: RequestParams): Promise<Message>;
1048
- // (undocumented)
1049
- send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
1050
- // @deprecated (undocumented)
1051
- setValidSession(valid: boolean): void;
1052
- // (undocumented)
1053
- snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
1054
- // (undocumented)
1055
- socket: Socket;
1056
- // (undocumented)
1057
- stream(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
1058
- // (undocumented)
1059
- streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
1060
- // (undocumented)
1061
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
1062
- }
1063
-
1064
- // @public
1065
- export const defaultConnectConfig: ConnectConfig;
1066
-
1067
- // @public
1068
- export class DefaultConnectEvents implements ConnectEventsEmitter {
1069
- // 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
1070
- //
1071
- // (undocumented)
1072
- addCommitListener(listener: Listener<CommitEvent>): () => void;
1073
- // 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
1074
- //
1075
- // (undocumented)
1076
- addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
1077
- // 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
1078
- //
1079
- // (undocumented)
1080
- addMetadataListener(listener: Listener<MetadataEvent>): () => void;
1081
- // 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
1082
- //
1083
- // (undocumented)
1084
- addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
1085
- // @internal (undocumented)
1086
- protected commitListeners: Observer<CommitEvent>;
1087
- // @internal (undocumented)
1088
- protected commitResponseListeners: Observer<CommitResponseEvent>;
1089
- // @internal (undocumented)
1090
- protected metadataListeners: Observer<MetadataEvent>;
1091
- // 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
1092
- //
1093
- // (undocumented)
1094
- onCommitEvent(eventName: string, message: Message): void;
1095
- // 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
1096
- //
1097
- // (undocumented)
1098
- onCommitResponseEvent(eventName: string, response: Message): void;
1099
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
1100
- //
1101
- // (undocumented)
1102
- onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
1103
- // 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
1104
- //
1105
- // (undocumented)
1106
- onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
1107
- // 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
1108
- //
1109
- // (undocumented)
1110
- onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
1111
- // 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
1112
- //
1113
- // (undocumented)
1114
- onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
1115
- // @internal (undocumented)
1116
- protected streamCompleteListeners: Observer<StreamCompleteEvent>;
1117
- // @internal (undocumented)
1118
- protected streamErrorListeners: Observer<StreamErrorEvent>;
1119
- // @internal (undocumented)
1120
- protected streamListeners: Observer<StreamEvent>;
1121
- }
1122
-
1123
- // @public
1124
- export class DefaultCredentialManager implements CredentialManager {
1125
- constructor(session: Session, config?: CredentialManagerConfig);
1126
- // (undocumented)
1127
- createBasicCredentials(inputs: BasicCredentialsInput): BasicAuthInfo;
1128
- // (undocumented)
1129
- createRefreshCredentials(inputs?: RefreshCredentialsInput): RefreshAuthInfo;
1130
- // (undocumented)
1131
- createSSOCredentials(inputs?: SSOCredentialsInput): SsoAuthInfo;
1132
- // (undocumented)
1133
- getCredentials(options?: GetCredentialOptions): Promise<CredentialData_2 | undefined>;
1134
- // (undocumented)
1135
- getCredentialsFromContainer(options?: CredentialRequestOptions): Promise<CredentialData_2 | null>;
1136
- // (undocumented)
1137
- getCredentialsFromCookie(): CredentialData_2 | undefined;
1138
- // (undocumented)
1139
- getMFAToken(): string;
1140
- // (undocumented)
1141
- getRefreshToken(): string;
1142
- // (undocumented)
1143
- getSSOToken(): string;
1144
- // (undocumented)
1145
- getUsername(): string;
1146
- // (undocumented)
1147
- normaliseLegacyCredentialData(data?: CredentialData_2, cookie?: CredentialData_2): [CredentialData_2 | undefined, boolean];
1148
- // (undocumented)
1149
- preventSilentAccess(): Promise<void>;
1150
- // (undocumented)
1151
- removeAll(): void;
1152
- // (undocumented)
1153
- removeCookie(): void;
1154
- // (undocumented)
1155
- removeMFAToken(): void;
1156
- // (undocumented)
1157
- removeRefreshToken(): void;
1158
- // (undocumented)
1159
- removeSSOToken(): void;
1160
- // (undocumented)
1161
- removeUsername(): void;
1162
- // (undocumented)
1163
- storeCredentials(data: CredentialData_2): Promise<boolean>;
1164
- // (undocumented)
1165
- storeCredentialsInContainer(data: CredentialData_2): Promise<Credential | undefined>;
1166
- // (undocumented)
1167
- storeCredentialsInCookie(data: CredentialData_2): boolean;
1168
- // (undocumented)
1169
- validateBasicCredentials(credentials: BasicAuthInfo): boolean;
1170
- // (undocumented)
1171
- validateRefreshCredentials(credentials: RefreshAuthInfo): boolean;
1172
- // (undocumented)
1173
- validateSSOCredentials(credentials: SsoAuthInfo): boolean;
1174
- // (undocumented)
1175
- validateUserCredentialData(data: CredentialData_2, ensurePassword?: boolean): boolean;
1176
- }
1177
-
1178
- // @public
1179
- export const defaultCredentialManagerConfig: CredentialManagerConfig;
1180
-
1181
- // @public
1182
- export const defaultCredentialRequestOptions: GetCredentialOptions;
1183
-
1184
- // @public
1185
- export class DefaultDatasource implements Datasource {
1186
- constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig, connectEvents: ConnectEvents);
1187
- // @internal (undocumented)
1188
- get allResourceParams(): DataserverParams & RequestParams;
1189
- // (undocumented)
1190
- protected auth: Auth;
1191
- // (undocumented)
1192
- availableIndexes: IndexDetail[];
1193
- // (undocumented)
1194
- protected config: DatasourceConfig;
1195
- // (undocumented)
1196
- protected connect: Connect;
1197
- // (undocumented)
1198
- protected connectEvents: ConnectEvents;
1199
- // (undocumented)
1200
- customRequestFields: MetadataDetail[];
1201
- // @internal (undocumented)
1202
- get dataserverOnlyParams(): DataserverParams;
1203
- // 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
1204
- //
1205
- // (undocumented)
1206
- destroy(): void;
1207
- // (undocumented)
1208
- protected fetchAndApplyMetadata(resourceName: string): Promise<void>;
1209
- // (undocumented)
1210
- fetchMetadataRequired: boolean;
1211
- // (undocumented)
1212
- fieldMetadata: FieldMetadata[];
1213
- // (undocumented)
1214
- init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
1215
- // 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
1216
- //
1217
- // (undocumented)
1218
- get initialized(): boolean;
1219
- // @internal (undocumented)
1220
- protected normaliseStatus(status: Partial<DatasourceStatus>): DatasourceStatus;
1221
- // (undocumented)
1222
- protected options: DatasourceOptions;
1223
- // (undocumented)
1224
- originalFieldDef: MetadataDetail[];
1225
- // (undocumented)
1226
- readOnly: boolean;
1227
- // @internal (undocumented)
1228
- protected reportStatus(detail?: Partial<DatasourceStatus>): void;
1229
- // (undocumented)
1230
- requestFields: MetadataDetail[];
1231
- // @internal (undocumented)
1232
- get requestOnlyParams(): RequestParams;
1233
- // (undocumented)
1234
- protected resources: GenesisResources;
1235
- // (undocumented)
1236
- resourceType: ResourceType;
1237
- // (undocumented)
1238
- snapshot(overrideParams?: any): Promise<Message>;
1239
- // (undocumented)
1240
- snapshotFiltered(rowId?: string): Promise<any[]>;
1241
- // (undocumented)
1242
- startStream(): Promise<void>;
1243
- // (undocumented)
1244
- startStreamRequired: boolean;
1245
- // 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
1246
- //
1247
- // (undocumented)
1248
- status: DatasourceStatus;
1249
- // (undocumented)
1250
- stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
1251
- // @deprecated (undocumented)
1252
- validResourceName(resourceName: string): boolean;
1253
- }
1254
-
1255
- // @public
1256
- export const defaultDatasourceConfig: DatasourceConfig;
1257
-
1258
- // @alpha
1259
- export class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatasource implements EntityDatasource<TDTO, TEntity> {
1260
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "EntityDatasource" has more than one declaration; you need to add a TSDoc member reference selector
1261
- //
1262
- // (undocumented)
1263
- get cache(): TEntity[];
1264
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "EntityDatasource" has more than one declaration; you need to add a TSDoc member reference selector
1265
- //
1266
- // (undocumented)
1267
- disconnect: () => void;
1268
- // (undocumented)
1269
- protected entityCache: TEntity[];
1270
- // (undocumented)
1271
- protected entityMap: Map<string, TEntity>;
1272
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "EntityDatasource" has more than one declaration; you need to add a TSDoc member reference selector
1273
- //
1274
- // (undocumented)
1275
- initialize: (init: EntityDatasourceInit<TDTO, TEntity>) => Promise<boolean>;
1276
- // (undocumented)
1277
- get initialized(): boolean;
1278
- set initialized(value: boolean);
1279
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "EntityDatasource" has more than one declaration; you need to add a TSDoc member reference selector
1280
- //
1281
- // (undocumented)
1282
- protected _initialized: boolean;
1283
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "EntityDatasource" has more than one declaration; you need to add a TSDoc member reference selector
1284
- //
1285
- // (undocumented)
1286
- get isEmpty(): boolean;
1287
- // (undocumented)
1288
- protected mapper: DTOMapper<TDTO, TEntity>;
1289
- // (undocumented)
1290
- protected processRowDataUpdate(rowData: RowData[], inserting?: boolean): void;
1291
- // (undocumented)
1292
- protected rowId: string;
1293
- // (undocumented)
1294
- protected sourceRef: string;
1295
- // (undocumented)
1296
- protected subscription: SocketSubscription;
1297
- // (undocumented)
1298
- protected subscriptionLoggedOff: boolean;
1299
- // (undocumented)
1300
- protected updateCache(result: FilteredDataServerResult): void;
1301
- }
1302
-
1303
- // @public
1304
- export class DefaultFoundationAnalytics implements FoundationAnalytics {
1305
- constructor(config: {
1306
- app: 'foundation-app';
1307
- debug: true;
1308
- });
1309
- trackEvent(eventName: FoundationAnalyticsEventType.controlClicked, payload: FoundationAnalyticsEvent.ControlClicked): void;
1310
- // (undocumented)
1311
- trackEvent(eventName: FoundationAnalyticsEventType.routeChanged, payload: FoundationAnalyticsEvent.RouteChanged): void;
1312
- }
1313
-
1314
- // @public
1315
- export class DefaultGenesisResources implements GenesisResources {
1316
- constructor(connect: Connect, config: GenesisResourcesConfig);
1317
- // (undocumented)
1318
- protected config: GenesisResourcesConfig;
1319
- // (undocumented)
1320
- protected connect: Connect;
1321
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1322
- //
1323
- // (undocumented)
1324
- destroy(): void;
1325
- // (undocumented)
1326
- protected fetchResources(): Promise<void>;
1327
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1328
- //
1329
- // (undocumented)
1330
- getAllResources(): Promise<ResourceItem[]>;
1331
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1332
- //
1333
- // (undocumented)
1334
- getResourceTypeFor(resourceName: string): Promise<ResourceType>;
1335
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1336
- //
1337
- // (undocumented)
1338
- isValidResource(resourceName: string): Promise<boolean>;
1339
- // (undocumented)
1340
- protected postLoadedMessage(): void;
1341
- // (undocumented)
1342
- protected resources: ResourceItem[];
1343
- // (undocumented)
1344
- protected resourcesPromise: Promise<ResourcesMessage>;
1345
- }
1346
-
1347
- // @public
1348
- export const defaultGenesisResourcesConfig: GenesisResourcesConfig;
1349
-
1350
- // @public
1351
- export class DefaultHttp implements Http {
1352
- constructor(serializer: JSONSerializer);
1353
- // (undocumented)
1354
- get<T>(url: string, requestInit: HttpRequestInit): Promise<T>;
1355
- // (undocumented)
1356
- post<T>(url: string, requestInit: HttpRequestInit): Promise<T>;
1357
- }
1358
-
1359
- // @public
1360
- export class DefaultHttpConnect implements Connect {
1361
- // Warning: (ae-forgotten-export) The symbol "HttpConnectConfig" needs to be exported by the entry point index.d.ts
1362
- constructor(http: Http, messageBuilder: MessageBuilder, session: Session, metaCache: MetaCache, serializer: JSONSerializer, config: HttpConnectConfig);
1363
- // (undocumented)
1364
- commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
1365
- // (undocumented)
1366
- connect(host: string): Promise<boolean>;
1367
- // (undocumented)
1368
- dataLogoff(streamSourceRef: string): Promise<Message>;
1369
- // (undocumented)
1370
- disconnect(): void;
1371
- // (undocumented)
1372
- getAvailableResources(params?: any): Promise<ResourcesMessage>;
1373
- // (undocumented)
1374
- getJSONSchema(resourceName: string): Promise<SchemaResponse>;
1375
- // (undocumented)
1376
- getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
1377
- // (undocumented)
1378
- getMoreColumns(sourceRef: string): Promise<Message>;
1379
- // (undocumented)
1380
- getMoreRows(sourceRef: string): Promise<Message>;
1381
- // (undocumented)
1382
- host: string;
1383
- // (undocumented)
1384
- http: Http;
1385
- // (undocumented)
1386
- httpMode(): boolean;
1387
- // (undocumented)
1388
- isConnected$: Observable<boolean>;
1389
- // (undocumented)
1390
- get isConnected(): boolean;
1391
- set isConnected(value: boolean);
1392
- // (undocumented)
1393
- isConnectedSubject: BehaviorSubject<boolean>;
1394
- // (undocumented)
1395
- isWorking: boolean;
1396
- // (undocumented)
1397
- request(resourceName: string, params?: RequestParams): Promise<Message>;
1398
- // (undocumented)
1399
- send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
1400
- // @deprecated (undocumented)
1401
- setValidSession(valid: boolean): void;
1402
- // (undocumented)
1403
- snapshot(resourceName: string, params?: any): Promise<Message>;
1404
- // (undocumented)
1405
- stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
1406
- // (undocumented)
1407
- streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: any, initialState?: any[]): Observable<any[]>;
1408
- // (undocumented)
1409
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message<any>>;
1410
- }
1411
-
1412
- // @alpha
1413
- export class DefaultKVStorage implements KVStorage {
1414
- constructor(connect: Connect, user: User_2, kvStorageConfig?: KVStorageConfig);
1415
- delete(keys: string[]): Promise<true | KVEventFailureResponse>;
1416
- get<T = KVValue>(): Promise<KeyValueTransfer<T>[]>;
1417
- // (undocumented)
1418
- get<T = KVValue>(key: string): Promise<KeyValueTransfer<T>>;
1419
- list(): Promise<string[]>;
1420
- put(kvs: KeyValue<KVValue>[]): Promise<true | KVEventFailureResponse>;
1421
- // (undocumented)
1422
- protected user: User_2;
1423
- }
1424
-
1425
- // @alpha
1426
- export const defaultKVStorageConfig: KVStorageConfig;
1427
-
1428
- // @public
1429
- export class DefaultMessageBuilder implements MessageBuilder {
1430
- constructor(session: Session, uuid: UUID);
1431
- // (undocumented)
1432
- createChangePasswordMessage(username: string, oldPassword: string, newPassword: string): Message<MessageDetails.ChangePassword>;
1433
- // (undocumented)
1434
- createCommitMessage<T = any>(eventName: string, params?: CommitParams): Message<T>;
1435
- // (undocumented)
1436
- createDataLogoffMessage<T = any>(sourceRef: string): Message<T>;
1437
- // (undocumented)
1438
- createDataLogonMessage(resourceName: string, params?: DataserverParams): Message<MessageDetails.DataserverRequest>;
1439
- // (undocumented)
1440
- createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;
1441
- // (undocumented)
1442
- createForgotPasswordTokenMessage(username: string, resetToken: string, newPassword: string, requester?: string): Message<MessageDetails.ForgotPasswordToken>;
1443
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "MessageBuilder" has more than one declaration; you need to add a TSDoc member reference selector
1444
- //
1445
- // (undocumented)
1446
- createHeartbeatPingMessage(verbose?: boolean): PingMessage;
1447
- // (undocumented)
1448
- createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
1449
- // (undocumented)
1450
- createLoginMessage(credentials: AuthInfo): Message<MessageDetails.Login>;
1451
- // (undocumented)
1452
- createLogoutMessage(loginResult?: LoginResult): Message;
1453
- // (undocumented)
1454
- createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
1455
- // (undocumented)
1456
- createMoreColumnsMessage(sourceRef: string): Message;
1457
- // (undocumented)
1458
- createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
1459
- // (undocumented)
1460
- createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
1461
- // (undocumented)
1462
- createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
1463
- // (undocumented)
1464
- createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
1465
- }
1466
-
1467
- // @public
1468
- export class DefaultMetaCache implements MetaCache {
1469
- // (undocumented)
1470
- cachedJsonSchema: Map<string, SchemaResponse>;
1471
- // (undocumented)
1472
- cachedMetadata: Map<string, Metadata>;
1473
- // (undocumented)
1474
- getJsonSchemaFor(resourceName: string): SchemaResponse;
1475
- // (undocumented)
1476
- getMetadataFor(resourceName: string): Metadata;
1477
- // (undocumented)
1478
- hasJsonSchemaFor(resourceName: string): boolean;
1479
- // (undocumented)
1480
- hasMetadataFor(resourceName: string): boolean;
1481
- // (undocumented)
1482
- setJsonSchemaFor(resourceName: string, schemaResponse: SchemaResponse): void;
1483
- // (undocumented)
1484
- setMetadataFor(resourceName: string, metadata: Metadata): void;
1485
- }
1486
-
1487
- // @public
1488
- export class DefaultNetworkMonitor implements NetworkMonitor {
1489
- constructor();
1490
- // @internal (undocumented)
1491
- protected addListeners(): void;
1492
- // 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
1493
- //
1494
- // (undocumented)
1495
- addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
1496
- // @internal
1497
- protected config: NetworkMonitorConfig;
1498
- // @internal (undocumented)
1499
- protected connectEvents: ConnectEvents;
1500
- // 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
1501
- //
1502
- // (undocumented)
1503
- create(): void;
1504
- // 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
1505
- //
1506
- // (undocumented)
1507
- destroy(): void;
1508
- // @internal (undocumented)
1509
- protected getFormattedTimestamp(milliseconds: number): string;
1510
- // @internal (undocumented)
1511
- protected getNextTimestamp(): number;
1512
- // @internal (undocumented)
1513
- protected getNowTimestamp(): number;
1514
- // @internal (undocumented)
1515
- protected internalId: ReturnType<typeof setInterval>;
1516
- // @internal (undocumented)
1517
- protected isOnlineCheck(): Promise<boolean>;
1518
- // @internal (undocumented)
1519
- protected isReady: boolean;
1520
- // @internal (undocumented)
1521
- protected isRunningChecks: boolean;
1522
- // @internal (undocumented)
1523
- protected normaliseEventDetail(detail: Partial<SystemHealthStatus>): SystemHealthStatus;
1524
- // @internal (undocumented)
1525
- protected normaliseResourceHealth(health: ResourceHealth, isOnline?: boolean): ResourceHealth;
1526
- // @internal (undocumented)
1527
- protected normaliseSerializedSocketStatus(socketStatus: SerializedSocketStatus, isOnline?: boolean): SerializedSocketStatus;
1528
- // @internal (undocumented)
1529
- protected preFlightSocketChecks(status: SerializedSocketStatus): boolean;
1530
- // @internal (undocumented)
1531
- protected removeListeners(): void;
1532
- // 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
1533
- //
1534
- // (undocumented)
1535
- removeResource(resource: MonitoredResource): void;
1536
- // @internal (undocumented)
1537
- protected reportStabilityToGenesis(detail: Partial<SystemHealthStatus>): Promise<boolean>;
1538
- // @internal (undocumented)
1539
- protected reportSystemHealth(detail: Partial<SystemHealthStatus>): void;
1540
- // @internal (undocumented)
1541
- protected resources: Map<MonitoredResource, MonitoredResourceMetadata>;
1542
- // 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
1543
- //
1544
- // (undocumented)
1545
- runAllChecks: (source?: unknown, force?: boolean) => Promise<void>;
1546
- // @internal (undocumented)
1547
- protected socketStatus: SocketStatus;
1548
- // 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
1549
- //
1550
- // (undocumented)
1551
- status: SystemHealthStatus;
1552
- // @internal (undocumented)
1553
- protected synchroniseCheckInterval(): void;
1554
- // @internal (undocumented)
1555
- protected unsubscribableObservers: any[];
1556
- // @internal (undocumented)
1557
- protected user: User_2;
1558
- }
1559
-
1560
- // @public
1561
- export const defaultNetworkMonitorConfig: NetworkMonitorConfig;
1562
-
1563
- // @public
1564
- export class DefaultSession implements Session {
1565
- // (undocumented)
1566
- captureReturnUrl(): void;
1567
- // (undocumented)
1568
- deleteUserFromSessionStorage(): void;
1569
- // (undocumented)
1570
- getItem(key: string | UserInfoKeys, storage: StorageType): string;
1571
- // (undocumented)
1572
- getLocalStorageItem(key: string | UserInfoKeys): string;
1573
- // (undocumented)
1574
- getSessionStorageItem(key: string | UserInfoKeys): string;
1575
- // (undocumented)
1576
- removeItem(key: string | UserInfoKeys, storage: StorageType): void;
1577
- // (undocumented)
1578
- removeLocalStorageItem(key: string | UserInfoKeys): void;
1579
- // (undocumented)
1580
- removeSessionStorageItem(key: string | UserInfoKeys): void;
1581
- // (undocumented)
1582
- returnUrl: string;
1583
- // (undocumented)
1584
- setAuthResult(result: Message): void;
1585
- // Warning: (ae-forgotten-export) The symbol "UserInfoKeys" needs to be exported by the entry point index.d.ts
1586
- //
1587
- // (undocumented)
1588
- setItem(key: string | UserInfoKeys, value: string, storage: StorageType): void;
1589
- // (undocumented)
1590
- setLocalStorageItem(key: string | UserInfoKeys, value: string): void;
1591
- // (undocumented)
1592
- setSessionStorageItem(key: string | UserInfoKeys, value: string): void;
1593
- // (undocumented)
1594
- setStorageKeyPrefix(prefix: string): void;
1595
- }
1596
-
1597
- // @public
1598
- export class DefaultSocket implements Socket {
1599
- constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSerializer, uuid: UUID, status: SocketStatus,
1600
- user: User_2, config: ConnectConfig);
1601
- // (undocumented)
1602
- protected config: ConnectConfig;
1603
- // (undocumented)
1604
- connect(host?: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
1605
- // @deprecated (undocumented)
1606
- get hasValidSession(): boolean;
1607
- set hasValidSession(value: boolean);
1608
- // (undocumented)
1609
- get host(): string;
1610
- // (undocumented)
1611
- http: Http;
1612
- // (undocumented)
1613
- get isConfigured(): boolean;
1614
- // (undocumented)
1615
- get isConnected(): boolean;
1616
- // (undocumented)
1617
- get isConnectedSubject(): BehaviorSubject<boolean>;
1618
- // (undocumented)
1619
- get isConnecting(): boolean;
1620
- // (undocumented)
1621
- get isDisconnected(): boolean;
1622
- // (undocumented)
1623
- get isDisconnectedByServer(): boolean;
1624
- // (undocumented)
1625
- get isReconnecting(): boolean;
1626
- // (undocumented)
1627
- reset(): void;
1628
- // (undocumented)
1629
- send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
1630
- // (undocumented)
1631
- sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
1632
- // (undocumented)
1633
- sendForStreamWithoutTeardown<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
1634
- // (undocumented)
1635
- socketMessages: () => SocketSubject<Message>;
1636
- protected user: User_2;
1637
- }
1638
-
1639
- // @public
1640
- export class DefaultSocketStatus implements SocketStatus {
1641
- // (undocumented)
1642
- closedClean: any;
1643
- // (undocumented)
1644
- closedCode: any;
1645
- // (undocumented)
1646
- closedReason: any;
1647
- // (undocumented)
1648
- get hasValidSession(): boolean;
1649
- // (undocumented)
1650
- isConfigured: boolean;
1651
- // (undocumented)
1652
- isConnected: boolean;
1653
- // (undocumented)
1654
- protected isConnectedChanged(): void;
1655
- // (undocumented)
1656
- isConnectedSubject: BehaviorSubject<boolean>;
1657
- // (undocumented)
1658
- isConnecting: boolean;
1659
- // (undocumented)
1660
- get isDisconnected(): boolean;
1661
- // (undocumented)
1662
- get isDisconnectedByServer(): boolean;
1663
- // (undocumented)
1664
- isReconnecting: boolean;
1665
- // (undocumented)
1666
- protected isReconnectingChanged(): void;
1667
- // (undocumented)
1668
- onClose(event: CloseEvent): void;
1669
- // (undocumented)
1670
- reconnectionLimitReached: boolean;
1671
- // (undocumented)
1672
- protected resetClosedState(): void;
1673
- // (undocumented)
1674
- serialize(): SerializedSocketStatus;
1675
- // (undocumented)
1676
- protected user: User_2;
1677
- }
1678
-
1679
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "EntityDatasource" because one of its declarations is marked as @internal
1680
- //
1681
- // @alpha
1682
- export interface EntityDatasource<TDTO, TEntity> extends Datasource {
1683
- // (undocumented)
1684
- readonly cache: TEntity[];
1685
- // (undocumented)
1686
- disconnect(): void;
1687
- // (undocumented)
1688
- initialize(init: EntityDatasourceInit<TDTO, TEntity>): Promise<boolean>;
1689
- // (undocumented)
1690
- readonly isEmpty: boolean;
1691
- }
1692
-
1693
- // @internal
1694
- export const EntityDatasource: InterfaceSymbol<EntityDatasource<any, any>>;
1695
-
1696
- // @alpha
1697
- export interface EntityDatasourceInit<TDTO, TEntity> {
1698
- // (undocumented)
1699
- fetchMeta?: boolean;
1700
- // (undocumented)
1701
- mapper: DTOMapper<TDTO, TEntity>;
1702
- // (undocumented)
1703
- options: Omit<DatasourceOptions, 'isSnapshot'>;
1704
- }
1705
-
1706
- // @public
1707
- export enum EventMessageType {
1708
- // (undocumented)
1709
- DATA_LOGOFF = "DATA_LOGOFF",
1710
- // (undocumented)
1711
- DATA_LOGON = "DATA_LOGON",
1712
- // (undocumented)
1713
- EVENT_CHANGE_USER_PASSWORD = "EVENT_CHANGE_USER_PASSWORD",
1714
- // (undocumented)
1715
- EVENT_LOGIN_AUTH = "EVENT_LOGIN_AUTH",
1716
- // (undocumented)
1717
- EVENT_LOGIN_AUTH_ACK = "EVENT_LOGIN_AUTH_ACK",
1718
- // (undocumented)
1719
- EVENT_LOGIN_AUTH_NACK = "EVENT_LOGIN_AUTH_NACK",
1720
- // (undocumented)
1721
- EVENT_LOGOUT = "EVENT_LOGOUT",
1722
- // (undocumented)
1723
- EVENT_PASSWORD_RESET_ACTION = "EVENT_PASSWORD_RESET_ACTION",
1724
- // (undocumented)
1725
- EVENT_SELF_SERVICE_PASSWORD_RESET = "EVENT_SELF_SERVICE_PASSWORD_RESET",
1726
- // (undocumented)
1727
- JSON_SCHEMA_REQUEST = "JSON_SCHEMA_REQUEST",
1728
- // (undocumented)
1729
- META_REQUEST = "META_REQUEST",
1730
- // (undocumented)
1731
- RESOURCES_REQUEST = "RESOURCES_REQUEST",
1732
- // (undocumented)
1733
- RESOURCES_REQUEST_ACK = "RESOURCES_REQUEST_ACK",
1734
- // (undocumented)
1735
- RESOURCES_REQUEST_NACK = "RESOURCES_REQUEST_NACK"
1736
- }
1737
-
1738
- // @public
1739
- export const exponentialScheduler: SocketReconnectScheduler;
1740
-
1741
- // @public
1742
- export const extractFieldDefinitions: (metadata: Metadata) => MetadataDetail[];
1743
-
1744
- // @public
1745
- export type FieldMetadata = {
1746
- name: string;
1747
- displayName?: string;
1748
- type: FieldTypeEnum;
1749
- enumOptions?: Array<any>;
1750
- enumMultiple?: boolean;
1751
- required?: boolean;
1752
- readOnly?: boolean;
1753
- component?: string;
1754
- };
1755
-
1756
- // @public
1757
- export enum FieldTypeEnum {
1758
- // (undocumented)
1759
- BOOLEAN = "BOOLEAN",
1760
- // (undocumented)
1761
- CUSTOM = "CUSTOM",
1762
- // (undocumented)
1763
- DATE = "DATE",
1764
- // (undocumented)
1765
- DATETIME = "DATETIME",
1766
- // (undocumented)
1767
- ENUM = "ENUM",
1768
- // (undocumented)
1769
- NANO_TIMESTAMP = "NANO_TIMESTAMP",
1770
- // (undocumented)
1771
- NUMBER = "NUMBER",
1772
- // (undocumented)
1773
- STRING = "STRING"
1774
- }
1775
-
1776
- // @public
1777
- export type FilteredDataServerResult = {
1778
- inserts?: RowData[];
1779
- deletes?: RowData[];
1780
- updates?: RowData[];
1781
- SOURCE_REF?: string;
1782
- };
1783
-
1784
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "FoundationAnalytics" because one of its declarations is marked as @internal
1785
- //
1786
- // @public
1787
- export interface FoundationAnalytics {
1788
- trackEvent(eventName: FoundationAnalyticsEventType.controlClicked, payload: FoundationAnalyticsEvent.ControlClicked): void;
1789
- trackEvent(eventName: FoundationAnalyticsEventType.routeChanged, payload: FoundationAnalyticsEvent.RouteChanged): void;
1790
- trackEvent(eventName: FoundationAnalyticsEventType, payload: {}): void;
1791
- }
1792
-
1793
- // @internal
1794
- export const FoundationAnalytics: InterfaceSymbol<FoundationAnalytics>;
1795
-
1796
- // @public
1797
- export namespace FoundationAnalyticsEvent {
1798
- export interface ControlClicked {
1799
- // (undocumented)
1800
- name: string;
1801
- }
1802
- export interface RouteChanged {
1803
- // (undocumented)
1804
- path: string;
1805
- // (undocumented)
1806
- referrer?: string;
1807
- }
1808
- }
1809
-
1810
- // @public
1811
- export enum FoundationAnalyticsEventType {
1812
- // (undocumented)
1813
- controlClicked = "controlClicked",
1814
- // (undocumented)
1815
- routeChanged = "routeChanged"
1816
- }
1817
-
1818
- // @public
1819
- export type GenesisConnectEvents = 'stream' | 'commit';
1820
-
1821
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "GenesisResources" because one of its declarations is marked as @internal
1822
- //
1823
- // @public
1824
- export interface GenesisResources {
1825
- destroy: () => void;
1826
- getAllResources: () => Promise<ResourceItem[]>;
1827
- getResourceTypeFor: (resourceName: string) => Promise<ResourceType>;
1828
- isValidResource: (resourceName: string) => Promise<boolean>;
1829
- }
1830
-
1831
- // @internal
1832
- export const GenesisResources: InterfaceSymbol<GenesisResources>;
1833
-
1834
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "GenesisResourcesChannel" because one of its declarations is marked as @internal
1835
- //
1836
- // @public
1837
- export interface GenesisResourcesChannel extends TypedBroadcastChannel<GenesisResourcesEvents> {
1838
- }
1839
-
1840
- // @internal
1841
- export const GenesisResourcesChannel: InterfaceSymbol<TypedBroadcastChannel<GenesisResourcesEvents>>;
1842
-
1843
- // @public (undocumented)
1844
- export const GenesisResourcesChannelId = "genesis-resources";
1845
-
1846
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "GenesisResourcesConfig" because one of its declarations is marked as @internal
1847
- //
1848
- // @public
1849
- export interface GenesisResourcesConfig {
1850
- throwWhenUnavailable?: boolean;
1851
- throwWhenUnknown?: boolean;
1852
- }
1853
-
1854
- // @internal
1855
- export const GenesisResourcesConfig: InterfaceSymbol<GenesisResourcesConfig>;
1856
-
1857
- // @public (undocumented)
1858
- export type GenesisResourcesEvents = {
1859
- 'resources-loaded': ResourceItem[];
1860
- 'resources-unloaded': void;
1861
- };
1862
-
1863
- // @public (undocumented)
1864
- export class GenesisResourcesMock implements GenesisResources {
1865
- // (undocumented)
1866
- destroy(): void;
1867
- // (undocumented)
1868
- getAllResources(): Promise<ResourceItem[]>;
1869
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1870
- //
1871
- // (undocumented)
1872
- getResourceTypeFor(resourceName: string): Promise<ResourceType>;
1873
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1874
- //
1875
- // (undocumented)
1876
- isValidResource(resourceName: string): Promise<boolean>;
1877
- // (undocumented)
1878
- nextIsValidResourceResponse: boolean;
1879
- // (undocumented)
1880
- nextResourceTypeForResponse: ResourceType;
1881
- // (undocumented)
1882
- resources: ResourceItem[];
1883
- }
1884
-
1885
- // @public
1886
- export function getConnect(): Connect;
1887
-
1888
- // @public
1889
- export type GetCredentialOptions = CredentialRequestOptions & {};
1890
-
1891
- // @public
1892
- export function getDatasource(): Datasource;
1893
-
1894
- // @public
1895
- export function getGenesisResources(): GenesisResources;
1896
-
1897
- // @public
1898
- export function getGenesisResourcesChannel(): GenesisResourcesChannel;
1899
-
1900
- // Warning: (ae-incompatible-release-tags) The symbol "getKVStorage" is marked as @public, but its signature references "KVStorage" which is marked as @alpha
1901
- //
1902
- // @public
1903
- export function getKVStorage(): KVStorage;
1904
-
1905
- // @public
1906
- export function getNetworkMonitor(): NetworkMonitor;
1907
-
1908
- // @public
1909
- export function getSocket(): Socket;
1910
-
1911
- // @public
1912
- export function getSocketStatus(): SocketStatus;
1913
-
1914
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Http" because one of its declarations is marked as @internal
1915
- //
1916
- // @public
1917
- export interface Http {
1918
- // (undocumented)
1919
- get<T = any>(url: string, requestInit: HttpRequestInit): Promise<T>;
1920
- // (undocumented)
1921
- post<T = any>(url: string, requestInit: HttpRequestInit): Promise<T>;
1922
- }
1923
-
1924
- // @internal
1925
- export const Http: InterfaceSymbol<Http>;
1926
-
1927
- // Warning: (ae-internal-missing-underscore) The name "HttpConnect" should be prefixed with an underscore because the declaration is marked as @internal
1928
- //
1929
- // @internal
1930
- export const HttpConnect: InterfaceSymbol<Connect>;
1931
-
1932
- // @public
1933
- export interface HttpRequestInit extends RequestInit {
1934
- serializer?: JSONSerializer;
1935
- }
1936
-
1937
- // @public
1938
- export type IndexDetail = {
1939
- NAME: string;
1940
- FIELDS: string;
1941
- };
1942
-
1943
- // @public
1944
- export const isWebSocketExpression: RegExp;
1945
-
1946
- // @public
1947
- export interface JsonSchemaCache {
1948
- // (undocumented)
1949
- cachedJsonSchema: Map<string, SchemaResponse>;
1950
- // (undocumented)
1951
- getJsonSchemaFor(resourceName: string): SchemaResponse;
1952
- // (undocumented)
1953
- hasJsonSchemaFor(resourceName: string): boolean;
1954
- // (undocumented)
1955
- setJsonSchemaFor(resourceName: string, schemaResponse: SchemaResponse): any;
1956
- }
1957
-
1958
- // @public
1959
- export type JwtAuthInfo = {
1960
- type: AuthType & AuthType.JWT;
1961
- jwt: string;
1962
- domain: string;
1963
- };
1964
-
1965
- // @alpha
1966
- export interface KeyValue<T = KVValue> {
1967
- base64?: boolean;
1968
- expiration?: number;
1969
- key: string;
1970
- metadata?: {
1971
- [key: string]: unknown;
1972
- };
1973
- value?: T;
1974
- }
1975
-
1976
- // @alpha
1977
- export interface KeyValueTransfer<T> {
1978
- // (undocumented)
1979
- deserialize?(value: unknown): Promise<T>;
1980
- // (undocumented)
1981
- kv: KeyValue<T>;
1982
- // (undocumented)
1983
- serialize?(value: unknown): unknown;
1984
- }
1985
-
1986
- // @alpha
1987
- export type KVEventFailureResponse = {
1988
- ERROR?: MessageError[];
1989
- WARNING: any[];
1990
- };
1991
-
1992
- // @alpha
1993
- export enum KVEventMessageType {
1994
- // (undocumented)
1995
- EVENT_KEY_VALUE_DELETE = "EVENT_KEY_VALUE_DELETE",
1996
- // (undocumented)
1997
- EVENT_KEY_VALUE_PUT = "EVENT_KEY_VALUE_PUT"
1998
- }
1999
-
2000
- // @alpha
2001
- export enum KVMessageType {
2002
- // (undocumented)
2003
- REQ_KEY_VALUE_LIST = "REQ_KEY_VALUE_LIST",
2004
- // (undocumented)
2005
- REQ_KEY_VALUE_READ = "REQ_KEY_VALUE_READ"
2006
- }
2007
-
2008
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "KVStorage" because one of its declarations is marked as @internal
2009
- //
2010
- // @alpha
2011
- export interface KVStorage {
2012
- // (undocumented)
2013
- delete(keys: string[]): Promise<true | KVEventFailureResponse>;
2014
- // (undocumented)
2015
- get<T = KVValue>(): Promise<KeyValueTransfer<T>[]>;
2016
- // (undocumented)
2017
- get<T = KVValue>(key: string): Promise<KeyValueTransfer<T>>;
2018
- // (undocumented)
2019
- list(): Promise<string[]>;
2020
- // (undocumented)
2021
- put(kvs: KeyValue<KVValue>[]): Promise<true | KVEventFailureResponse>;
2022
- }
2023
-
2024
- // @internal
2025
- export const KVStorage: InterfaceSymbol<KVStorage>;
2026
-
2027
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "KVStorageConfig" because one of its declarations is marked as @internal
2028
- //
2029
- // @alpha
2030
- export interface KVStorageConfig {
2031
- account?: string;
2032
- authEmail?: string;
2033
- authKey?: string;
2034
- namespace?: string;
2035
- }
2036
-
2037
- // @internal
2038
- export const KVStorageConfig: InterfaceSymbol<KVStorageConfig>;
2039
-
2040
- // @alpha
2041
- export type KVValue = string | ArrayBuffer;
2042
-
2043
- // @public
2044
- export const linearScheduler: SocketReconnectScheduler;
2045
-
2046
- // @public
2047
- export const logger: Logger;
2048
-
2049
- // @public
2050
- export type LoginResult = {
2051
- authToken: string;
2052
- refreshToken: string;
2053
- username: string;
2054
- profiles: string[];
2055
- permissions: string[];
2056
- sessionId: string;
2057
- };
2058
-
2059
- // @public
2060
- export interface LogoutResult {
2061
- error?: string;
2062
- success: boolean;
2063
- }
2064
-
2065
- // @public
2066
- export const MAX_RECONNECT_ATTEMPTS = 10;
2067
-
2068
- // @public
2069
- export type Message<T = void | any> = {
2070
- REPLY?: any[];
2071
- CODE?: MessageCode | string;
2072
- DETAILS?: T | any;
2073
- GENERATED?: T | any;
2074
- LOGGED_OUT?: boolean;
2075
- ERROR?: MessageError[];
2076
- MESSAGE_TYPE?: MessageType | EventMessageType | string;
2077
- PERMISSION?: string[];
2078
- PROFILE?: string[];
2079
- RESOURCES?: any[];
2080
- REFRESH_AUTH_TOKEN?: string;
2081
- ROW?: any[];
2082
- ROWS_COUNT?: number;
2083
- SEQUENCE_ID?: number;
2084
- SERVICE_NAME?: string;
2085
- SESSION_AUTH_TOKEN?: string;
2086
- SESSION_ID?: string;
2087
- SOURCE_REF?: string;
2088
- USER_NAME?: string;
2089
- WARNING?: any[];
2090
- };
2091
-
2092
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "MessageBuilder" because one of its declarations is marked as @internal
2093
- //
2094
- // @public
2095
- export interface MessageBuilder {
2096
- createChangePasswordMessage(username: string, oldPassword: string, newPassword: string): Message<MessageDetails.ChangePassword>;
2097
- createCommitMessage<T = any>(eventName: string, params?: CommitParams): Message<T>;
2098
- createDataLogoffMessage<T = any>(sourceRef: string): Message<T>;
2099
- createDataLogonMessage(resourceName: string, params?: DataserverParams): Message<MessageDetails.DataserverRequest>;
2100
- createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;
2101
- createForgotPasswordTokenMessage(username: string, resetToken: string, newPassword: string, requester?: string): Message<MessageDetails.ForgotPasswordToken>;
2102
- // (undocumented)
2103
- createHeartbeatPingMessage(verbose: boolean): PingMessage;
2104
- createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
2105
- createLoginMessage(credentials: AuthInfo): Message<MessageDetails.Login>;
2106
- createLogoutMessage(loginResult?: LoginResult): Message;
2107
- createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
2108
- createMoreColumnsMessage(sourceRef: string): Message;
2109
- createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
2110
- createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
2111
- createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
2112
- createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
2113
- }
2114
-
2115
- // @internal
2116
- export const MessageBuilder: InterfaceSymbol<MessageBuilder>;
2117
-
2118
- // @public
2119
- export enum MessageCode {
2120
- // (undocumented)
2121
- SESSION_NOT_FOUND = "SESSION_NOT_FOUND",
2122
- // (undocumented)
2123
- UNKNOWN_MESSAGE_TYPE = "UNKNOWN_MESSAGE_TYPE"
2124
- }
2125
-
2126
- // @public
2127
- export namespace MessageDetails {
2128
- export type ChangePassword = {
2129
- OLD_PASSWORD: string;
2130
- NEW_PASSWORD: string;
2131
- };
2132
- export type DataserverRequest = {
2133
- DATASOURCE_NAME: string;
2134
- };
2135
- export type Error = {
2136
- ERROR: string;
2137
- };
2138
- export type ExpirePassword = {
2139
- USER_NAME: string;
2140
- PASSWORD: string;
2141
- };
2142
- export type ForgotPassword = {
2143
- USER_NAME: string;
2144
- RETURN_URL: string;
2145
- };
2146
- export type ForgotPasswordToken = {
2147
- USER_NAME: string;
2148
- RESET_TOKEN: string;
2149
- NEW_PASSWORD: string;
2150
- };
2151
- export type LoggedInSystemInfo = {
2152
- DAYS_TO_PASSWORD_EXPIRY: number;
2153
- FAILED_LOGIN_ATTEMPTS: number;
2154
- HEARTBEAT_INTERVAL_SECS: number;
2155
- LAST_LOGIN_DATETIME: number;
2156
- NOTIFY_EXPIRY?: boolean;
2157
- PRODUCT?: any[];
2158
- SYSTEM?: any;
2159
- };
2160
- export type Login = LoginBasic | LoginSSO | LoginJWT;
2161
- export type LoginBasic = {
2162
- USER_NAME: string;
2163
- PASSWORD: string;
2164
- };
2165
- export type LoginJWT = {
2166
- JWT: string;
2167
- DOMAIN: string;
2168
- };
2169
- export type LoginSSO = {
2170
- SSO_TOKEN: string;
2171
- };
2172
- export type MetaRequest = {
2173
- FEATURE: string;
2174
- };
2175
- export type MoreRows = {
2176
- SOURCE_REF: string;
2177
- VIEW_NUMBER?: number;
2178
- };
2179
- export type RefreshToken = {
2180
- REFRESH_AUTH_TOKEN: string;
2181
- MFA_CODE?: string;
2182
- };
2183
- export type ResetPassword = {
2184
- USER_NAME: string;
2185
- };
2186
- export type UpdateColumns = {
2187
- SOURCE_REF: string;
2188
- ADD_COLUMNS: string;
2189
- DROP_COLUMNS: string;
2190
- };
2191
- }
2192
-
2193
- // @public
2194
- export type MessageError = {
2195
- CODE: MessageCode | string;
2196
- STATUS_CODE?: string;
2197
- TEXT: string;
2198
- };
2199
-
2200
- // @public
2201
- export const messageHasErrorCode: (message: Message, code: string | number) => boolean;
2202
-
2203
- // @public
2204
- export const messageOrThrow: (message: Message) => Message<any>;
2205
-
2206
- // @public
2207
- export enum MessageType {
2208
- // (undocumented)
2209
- HEARTBEAT_PING = "HEARTBEAT_PING",
2210
- // (undocumented)
2211
- HEARTBEAT_PONG = "HEARTBEAT_PONG",
2212
- // (undocumented)
2213
- LOGOFF_ACK = "LOGOFF_ACK",
2214
- // (undocumented)
2215
- LOGOFF_NACK = "LOGOFF_NACK",
2216
- // (undocumented)
2217
- LOGON_ACK = "LOGON_ACK",
2218
- // (undocumented)
2219
- LOGON_NACK = "LOGON_NACK",
2220
- // (undocumented)
2221
- LOGOUT_ACK = "LOGOUT_ACK",
2222
- // (undocumented)
2223
- LOGOUT_NACK = "LOGOUT_NACK",
2224
- // (undocumented)
2225
- MORE_COLUMNS = "MORE_COLUMNS",
2226
- // (undocumented)
2227
- MORE_COLUMNS_ACK = "MORE_COLUMNS_ACK",
2228
- // (undocumented)
2229
- MORE_ROWS = "MORE_ROWS",
2230
- // (undocumented)
2231
- MSG_ACK = "MSG_ACK",
2232
- // (undocumented)
2233
- MSG_NACK = "MSG_NACK",
2234
- // (undocumented)
2235
- QUERY_UPDATE = "QUERY_UPDATE"
2236
- }
2237
-
2238
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "MetaCache" because one of its declarations is marked as @internal
2239
- //
2240
- // @public
2241
- export type MetaCache = MetadataCache & JsonSchemaCache;
2242
-
2243
- // @internal
2244
- export const MetaCache: InterfaceSymbol<MetaCache>;
2245
-
2246
- // @public
2247
- export type Metadata = {
2248
- DEFINITIONS?: Record<string, any>;
2249
- DESCRIPTION?: string;
2250
- FIELD?: MetadataDetail[];
2251
- REPLY?: ReplyDetail;
2252
- REPLY_FIELD?: MetadataDetail[];
2253
- REQUEST_FIELD?: MetadataDetail[];
2254
- NAME?: string;
2255
- TYPE?: string;
2256
- INDEXES?: IndexDetail[];
2257
- ERROR?: string;
2258
- };
2259
-
2260
- // @public
2261
- export interface MetadataCache {
2262
- cachedMetadata: Map<string, Metadata>;
2263
- getMetadataFor(resourceName: string): Metadata;
2264
- hasMetadataFor(resourceName: string): boolean;
2265
- setMetadataFor(resourceName: string, metadata: Metadata): void;
2266
- }
2267
-
2268
- // @public
2269
- export type MetadataDetail = {
2270
- NAME: string;
2271
- TYPE: string;
2272
- DESCRIPTION?: string;
2273
- JSON_TYPE?: string;
2274
- VALID_VALUES?: string;
2275
- READ_ONLY?: boolean;
2276
- OPTIONAL?: boolean;
2277
- NULLABLE?: boolean;
2278
- UI_LABEL?: string;
2279
- };
2280
-
2281
- // @public (undocumented)
2282
- export type MetadataEvent = CustomEvent<MetadataEventDetail>;
2283
-
2284
- // @public (undocumented)
2285
- export type MetadataEventDetail = {
2286
- resourceName: string;
2287
- message: Message<MessageDetails.MetaRequest>;
2288
- error?: any;
2289
- };
2290
-
2291
- // @public (undocumented)
2292
- export const MetadataEventType = "connect-metadata-event";
2293
-
2294
- // @public
2295
- export type MonitoredResource = SocketObservable<any>;
2296
-
2297
- // @public
2298
- export type MonitoredResourceChecks = (sourceRef: string, resource: MonitoredResource) => Promise<MonitoredResourceChecksResult>;
2299
-
2300
- // @public
2301
- export interface MonitoredResourceChecksResult {
2302
- // (undocumented)
2303
- isConnected: boolean;
2304
- // (undocumented)
2305
- lastMessage?: Message;
2306
- // (undocumented)
2307
- lastUpdated: number;
2308
- // (undocumented)
2309
- timeout?: boolean;
2310
- }
2311
-
2312
- // @public
2313
- export type MonitoredResourceDataLogon = (metadata: MonitoredResourceMetadata) => void;
2314
-
2315
- // @public
2316
- export interface MonitoredResourceMetadata extends Partial<MonitoredResourceChecksResult>, Partial<StreamEventDetail> {
2317
- }
2318
-
2319
- // @public (undocumented)
2320
- export const networkLogger: Logger;
2321
-
2322
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "NetworkMonitor" because one of its declarations is marked as @internal
2323
- //
2324
- // @public
2325
- export interface NetworkMonitor {
2326
- // (undocumented)
2327
- addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
2328
- // (undocumented)
2329
- create(): void;
2330
- // (undocumented)
2331
- destroy(): void;
2332
- // (undocumented)
2333
- removeResource(resource: MonitoredResource): void;
2334
- // (undocumented)
2335
- runAllChecks(source?: unknown, force?: boolean): Promise<void>;
2336
- // (undocumented)
2337
- status: SystemHealthStatus;
2338
- }
2339
-
2340
- // @internal
2341
- export const NetworkMonitor: InterfaceSymbol<NetworkMonitor>;
2342
-
2343
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "NetworkMonitorConfig" because one of its declarations is marked as @internal
2344
- //
2345
- // @public
2346
- export interface NetworkMonitorConfig {
2347
- checkInterval?: number;
2348
- checkTimeout?: number;
2349
- documentEvents?: (keyof DocumentEventMap)[];
2350
- eventEmitter?: HTMLElement;
2351
- genesisConnectEvents?: GenesisConnectEvents[];
2352
- ignoredGenesisResources?: string[];
2353
- logLevel?: LogLevel;
2354
- resourceChecks?: MonitoredResourceChecks;
2355
- resourceDataLogon?: MonitoredResourceDataLogon;
2356
- startDelay?: number;
2357
- windowEvents?: (keyof WindowEventHandlersEventMap)[];
2358
- }
2359
-
2360
- // @internal
2361
- export const NetworkMonitorConfig: InterfaceSymbol<NetworkMonitorConfig>;
2362
-
2363
- // @public
2364
- export function normaliseCriteria(criteria: string, delimiter?: string): string;
2365
-
2366
- // @public (undocumented)
2367
- export type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS' | 'SESSION_AUTH_TOKEN'> & {
2368
- VERBOSE?: boolean;
2369
- [key: string]: any;
2370
- };
2371
-
2372
- // @public (undocumented)
2373
- export type PongMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'USER_NAME'> & {
2374
- IS_AUTHENTICATED?: boolean;
2375
- CREATED_AT?: number;
2376
- LAST_RECEIVED?: number;
2377
- LAST_SENT?: number;
2378
- RESOURCES?: Record<string, RESOURCE_DETAILS[]>;
2379
- };
2380
-
2381
- // @public
2382
- export type RawDataServerResult = {
2383
- MESSAGE_TYPE: string;
2384
- ROW: ServerRow[];
2385
- SOURCE_REF: string;
2386
- MORE_ROWS: boolean;
2387
- ROWS_COUNT: number;
2388
- SEQUENCE_ID: number;
2389
- };
2390
-
2391
- // @public
2392
- export type RefreshAuthInfo = {
2393
- type: AuthType & AuthType.REFRESH;
2394
- username: string;
2395
- refreshToken: string;
2396
- mfaToken: string;
2397
- };
2398
-
2399
- // @public
2400
- export type RefreshCredentialsInput = {
2401
- username: string;
2402
- refreshToken: string;
2403
- mfaToken?: string;
2404
- };
2405
-
2406
- // @public
2407
- export type ReplyDetail = {
2408
- DEFINITIONS?: Record<string, any>;
2409
- DESCRIPTION?: string;
2410
- FIELD: MetadataDetail[];
2411
- NAME: string;
2412
- [key: string]: any;
2413
- };
2414
-
2415
- // @public (undocumented)
2416
- export type RequestDetailsParam = {
2417
- MAX_ROWS?: number;
2418
- CRITERIA_MATCH?: string;
2419
- VIEW_NUMBER?: number;
2420
- };
2421
-
2422
- // @public
2423
- export type RequestParams = {
2424
- DETAILS?: RequestDetailsParam | any;
2425
- REQUEST?: any;
2426
- [key: string]: any;
2427
- };
2428
-
2429
- // @public
2430
- export type RequestServerResult = {
2431
- SOURCE_REF?: string;
2432
- REPLY: any[];
2433
- MESSAGE_TYPE?: string;
2434
- MORE_ROWS?: boolean;
2435
- NEXT_VIEW?: number;
2436
- PARAMETRIC_TYPE?: string;
2437
- ROWS_COUNT?: number;
2438
- SEQUENCE_ID?: number;
2439
- };
2440
-
2441
- // @public
2442
- export type ResourceHealth = MonitoredResourceChecksResult & {
2443
- name: string;
2444
- sourceRef: string[];
2445
- lastError?: any;
2446
- };
2447
-
2448
- // @public (undocumented)
2449
- export type ResourceItem = {
2450
- RESOURCE_NAME: string;
2451
- RESOURCE_TYPE: string;
2452
- };
2453
-
2454
- // @public (undocumented)
2455
- export type ResourcesMessage = {
2456
- MESSAGE_TYPE: EventMessageType.RESOURCES_REQUEST_ACK | EventMessageType.RESOURCES_REQUEST_NACK | MessageType.MSG_NACK;
2457
- SOURCE_REF: string;
2458
- RESOURCES: ResourceItem[];
2459
- };
2460
-
2461
- // @public
2462
- export enum ResourceType {
2463
- // (undocumented)
2464
- DATASERVER = "DATASERVER",
2465
- // (undocumented)
2466
- EVENT_HANDLER = "EVENT_HANDLER",
2467
- // (undocumented)
2468
- REQUEST_SERVER = "REQUEST_SERVER"
2469
- }
2470
-
2471
- // @public
2472
- export const retryInterval: (reconnectOptions: SocketReconnectOptions, scheduler: SocketReconnectScheduler) => Observable<number>;
2473
-
2474
- // @public
2475
- export type RowData = {
2476
- ROW_REF: string;
2477
- };
2478
-
2479
- // @public
2480
- export type SchemaResponse = {
2481
- INBOUND: JSONSchema7;
2482
- OUTBOUND: JSONSchema7;
2483
- MESSAGE_TYPE: string;
2484
- SOURCE_REF: string;
2485
- };
2486
-
2487
- // @public
2488
- export interface SerializedSocketStatus {
2489
- // (undocumented)
2490
- readonly closedClean: boolean;
2491
- // (undocumented)
2492
- readonly closedCode: number;
2493
- // (undocumented)
2494
- readonly closedReason: string;
2495
- // @deprecated (undocumented)
2496
- hasValidSession: boolean;
2497
- isConfigured: boolean;
2498
- // (undocumented)
2499
- isConnected: boolean;
2500
- // (undocumented)
2501
- isConnecting: boolean;
2502
- // (undocumented)
2503
- isDisconnected: boolean;
2504
- // (undocumented)
2505
- isDisconnectedByServer: boolean;
2506
- // (undocumented)
2507
- isReconnecting: boolean;
2508
- // (undocumented)
2509
- reconnectionLimitReached: boolean;
2510
- }
2511
-
2512
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Serializer" because one of its declarations is marked as @internal
2513
- //
2514
- // @public
2515
- export interface Serializer {
2516
- // @deprecated
2517
- deserialize<T = any>(response: Response): Promise<T>;
2518
- // @deprecated
2519
- deserialize<T = any>(event: MessageEvent): T;
2520
- // @deprecated
2521
- deserialize<T = any>(text: string): T;
2522
- // @deprecated
2523
- serialize(object: any): string;
2524
- }
2525
-
2526
- // @internal
2527
- export const Serializer: InterfaceSymbol<Serializer>;
2528
-
2529
- // @public
2530
- export type ServerRow = {
2531
- DETAILS: {
2532
- OPERATION: 'INSERT' | 'MODIFY' | 'DELETE';
2533
- ROW_REF: string;
2534
- };
2535
- [key: string]: any;
2536
- };
2537
-
2538
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Session" because one of its declarations is marked as @internal
2539
- //
2540
- // @public
2541
- export interface Session {
2542
- captureReturnUrl(): void;
2543
- deleteUserFromSessionStorage(): void;
2544
- getItem(key: string | UserInfoKeys, storage: StorageType): string;
2545
- getLocalStorageItem(key: string | UserInfoKeys): string;
2546
- getSessionStorageItem(key: string | UserInfoKeys): string;
2547
- removeItem(key: string | UserInfoKeys, storage: StorageType): void;
2548
- removeLocalStorageItem(key: string | UserInfoKeys): void;
2549
- removeSessionStorageItem(key: string | UserInfoKeys): void;
2550
- returnUrl: string;
2551
- setAuthResult(info: Message): void;
2552
- setItem(key: string | UserInfoKeys, value: string, storage: StorageType): void;
2553
- setLocalStorageItem(key: string | UserInfoKeys, value: string): void;
2554
- setSessionStorageItem(key: string | UserInfoKeys, value: string): void;
2555
- setStorageKeyPrefix(prefix: string): void;
2556
- }
2557
-
2558
- // @internal
2559
- export const Session: InterfaceSymbol<Session>;
2560
-
2561
- // Warning: (ae-internal-missing-underscore) The name "SessionMock" should be prefixed with an underscore because the declaration is marked as @internal
2562
- //
2563
- // @internal (undocumented)
2564
- export class SessionMock implements Session {
2565
- // (undocumented)
2566
- captureReturnUrl(): void;
2567
- // (undocumented)
2568
- deleteUserFromSessionStorage(): void;
2569
- // (undocumented)
2570
- getItem(key: string): string;
2571
- // (undocumented)
2572
- getLocalStorageItem(key: string): string;
2573
- // (undocumented)
2574
- getSessionStorageItem(key: string): string;
2575
- // (undocumented)
2576
- nextStorageItem: string;
2577
- // (undocumented)
2578
- removeItem(key: string): void;
2579
- // (undocumented)
2580
- removeLocalStorageItem(key: string): void;
2581
- // (undocumented)
2582
- removeSessionStorageItem(key: string): void;
2583
- // (undocumented)
2584
- returnUrl: string;
2585
- // (undocumented)
2586
- setAuthResult(loginResult: Message): void;
2587
- // (undocumented)
2588
- setItem(key: string, value: string): void;
2589
- // (undocumented)
2590
- setLocalStorageItem(key: string, value: string): void;
2591
- // (undocumented)
2592
- setSessionStorageItem(key: string, value: string): void;
2593
- // (undocumented)
2594
- setStorageKeyPrefix(prefix: string): void;
2595
- }
2596
-
2597
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Socket" because one of its declarations is marked as @internal
2598
- //
2599
- // @public
2600
- export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 'reconnectionLimitReached' | 'closedCode' | 'closedReason' | 'closedClean'> {
2601
- // (undocumented)
2602
- connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
2603
- // (undocumented)
2604
- host: string;
2605
- reset(): void;
2606
- // (undocumented)
2607
- send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
2608
- // (undocumented)
2609
- sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
2610
- // @alpha
2611
- sendForStreamWithoutTeardown<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
2612
- // (undocumented)
2613
- socketMessages(): SocketSubject<Message>;
2614
- }
2615
-
2616
- // @internal
2617
- export const Socket: InterfaceSymbol<Socket>;
2618
-
2619
- // @public
2620
- export type SocketConnectOptions = {
2621
- alwaysOn?: boolean;
2622
- connectObserver?: Observer_2<Message>;
2623
- enableHeartbeat?: boolean;
2624
- enableHeartbeatLogging?: boolean;
2625
- enableMessageLogging?: boolean;
2626
- heartbeatInterval?: number;
2627
- verboseHeartbeat?: boolean;
2628
- heartbeatPingCallback?: (message: PingMessage) => void;
2629
- heartbeatPongCallback?: (message: PongMessage) => void;
2630
- proxyPath?: string;
2631
- };
2632
-
2633
- // @public
2634
- export class SocketMessageHandler {
2635
- constructor(message: Message, onMessage: Function, onError: Function, isSubscription: boolean);
2636
- get isSubscription(): boolean;
2637
- get onReceivedError(): Function;
2638
- get onReceivedMessage(): Function;
2639
- get sentMessage(): Message;
2640
- }
2641
-
2642
- // Warning: (ae-internal-missing-underscore) The name "SocketMock" should be prefixed with an underscore because the declaration is marked as @internal
2643
- //
2644
- // @internal (undocumented)
2645
- export class SocketMock implements Socket {
2646
- // (undocumented)
2647
- connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
2648
- // (undocumented)
2649
- disconnect(): void;
2650
- // (undocumented)
2651
- hasValidSession: boolean;
2652
- // (undocumented)
2653
- host: string;
2654
- // (undocumented)
2655
- isConfigured: boolean;
2656
- // (undocumented)
2657
- isConnected: boolean;
2658
- // (undocumented)
2659
- isConnectedSubject: BehaviorSubject<boolean>;
2660
- // (undocumented)
2661
- isConnecting: boolean;
2662
- // (undocumented)
2663
- isDisconnected: boolean;
2664
- // (undocumented)
2665
- isDisconnectedByServer: boolean;
2666
- // (undocumented)
2667
- isReconnecting: boolean;
2668
- // (undocumented)
2669
- nextMessage: Message;
2670
- // (undocumented)
2671
- reset(): void;
2672
- // (undocumented)
2673
- send<T>(message: Message<any>): Promise<Message | any>;
2674
- // (undocumented)
2675
- sendForStream<T>(message: Message<any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
2676
- // (undocumented)
2677
- sendForStreamWithoutTeardown<T>(message: Message<any>, onMessage: Function, onError: Function): Observable<Message>;
2678
- // (undocumented)
2679
- socketMessages(): SocketSubject<Message>;
2680
- // (undocumented)
2681
- socketMessagesSubject: SocketSubject<Message<any>>;
2682
- }
2683
-
2684
- // @public
2685
- export class SocketObservable<T> extends Observable<T> {
2686
- constructor(...args: any[]);
2687
- }
2688
-
2689
- // @public
2690
- export type SocketReconnectOptions = {
2691
- reconnectAttempts?: number;
2692
- reconnectInterval?: number;
2693
- reconnectObserver?: Observer_2<any>;
2694
- reconnectStreams?: boolean;
2695
- reconnectStrategy?: SocketReconnectStrategy;
2696
- };
2697
-
2698
- // @public
2699
- export type SocketReconnectScheduler = (reconnectOptions: SocketReconnectOptions, attempts?: number) => number;
2700
-
2701
- // @public
2702
- export enum SocketReconnectStrategy {
2703
- // (undocumented)
2704
- Exponential = "exponential",
2705
- // (undocumented)
2706
- Linear = "linear"
2707
- }
2708
-
2709
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "SocketStatus" because one of its declarations is marked as @internal
2710
- //
2711
- // @public
2712
- export interface SocketStatus extends SerializedSocketStatus {
2713
- // (undocumented)
2714
- isConnectedSubject: BehaviorSubject<boolean>;
2715
- // (undocumented)
2716
- onClose(closeEvent: CloseEvent): void;
2717
- // (undocumented)
2718
- serialize(): SerializedSocketStatus;
2719
- }
2720
-
2721
- // @internal
2722
- export const SocketStatus: InterfaceSymbol<SocketStatus>;
2723
-
2724
- // @public
2725
- export class SocketSubject<T> extends Subject<T> {
2726
- constructor();
2727
- }
2728
-
2729
- export { SocketSubscription }
2730
-
2731
- // @public
2732
- export type SsoAuthInfo = {
2733
- type: AuthType & AuthType.SSO;
2734
- ssoToken: string;
2735
- };
2736
-
2737
- // @public
2738
- export type SSOCredentialsInput = {
2739
- ssoToken: string;
2740
- };
2741
-
2742
- // @public
2743
- export type StorageType = 'local' | 'session';
2744
-
2745
- // @public (undocumented)
2746
- export type StreamCompleteEvent = CustomEvent<StreamCompleteEventDetail>;
2747
-
2748
- // @public (undocumented)
2749
- export type StreamCompleteEventDetail = Pick<StreamEventDetail, 'resourceName' | 'stream'>;
2750
-
2751
- // @public (undocumented)
2752
- export const StreamCompleteEventType = "connect-stream-complete-event";
2753
-
2754
- // @public (undocumented)
2755
- export type StreamErrorEvent = CustomEvent<StreamErrorEventDetail>;
2756
-
2757
- // @public (undocumented)
2758
- export type StreamErrorEventDetail = Pick<StreamEventDetail, 'resourceName' | 'stream'> & {
2759
- error: any;
2760
- };
2761
-
2762
- // @public (undocumented)
2763
- export const StreamErrorEventType = "connect-stream-error-event";
2764
-
2765
- // @public (undocumented)
2766
- export type StreamEvent = CustomEvent<StreamEventDetail>;
2767
-
2768
- // @public (undocumented)
2769
- export type StreamEventDetail = {
2770
- functions: StreamEventFunctions;
2771
- message: Message<MessageDetails.DataserverRequest>;
2772
- resourceName: string;
2773
- stream: SocketObservable<any>;
2774
- };
2775
-
2776
- // @public (undocumented)
2777
- export type StreamEventFunctions = {
2778
- onMessage?: Function;
2779
- onError?: Function;
2780
- resourceChecks?: MonitoredResourceChecks;
2781
- resourceDataLogon?: MonitoredResourceDataLogon;
2782
- };
2783
-
2784
- // @public (undocumented)
2785
- export const StreamEventType = "connect-stream-event";
2786
-
2787
- // @public
2788
- export const SystemHealthChanged = "system-health-changed";
2789
-
2790
- // @public
2791
- export type SystemHealthChangedEvent = CustomEvent<SystemHealthStatus>;
2792
-
2793
- // @public
2794
- export type SystemHealthStatus = {
2795
- isOnline: boolean;
2796
- browserInformation?: Bowser_2.Parser.ParsedResult;
2797
- isAuthenticated: boolean;
2798
- username?: string;
2799
- isHealthy: boolean;
2800
- socket: SerializedSocketStatus;
2801
- resources: Record<string, ResourceHealth>;
2802
- resourcesAllConnected: boolean;
2803
- lastUpdated: number;
2804
- nextUpdate: number;
2805
- firstUpdated: number;
2806
- runAllChecks(): void;
2807
- reportStabilityToGenesis(): Promise<boolean>;
2808
- };
2809
-
2810
- // @public
2811
- export const toFieldMetadata: (fieldDef: MetadataDetail[]) => FieldMetadata[];
2812
-
2813
- // @public
2814
- export const TYPES_MAP: {
2815
- STRING: FieldTypeEnum;
2816
- ENUM: FieldTypeEnum;
2817
- BOOLEAN: FieldTypeEnum;
2818
- INT: FieldTypeEnum;
2819
- LONG: FieldTypeEnum;
2820
- DOUBLE: FieldTypeEnum;
2821
- BIGDECIMAL: FieldTypeEnum;
2822
- DATE: FieldTypeEnum;
2823
- DATETIME: FieldTypeEnum;
2824
- NANO_TIMESTAMP: FieldTypeEnum;
2825
- };
2826
-
2827
- // Warning: (ae-internal-missing-underscore) The name "UnknownUserPermissions" should be prefixed with an underscore because the declaration is marked as @internal
2828
- //
2829
- // @internal (undocumented)
2830
- export type UnknownUserPermissions = string;
2831
-
2832
- // Warning: (ae-internal-missing-underscore) The name "UnknownUserProfiles" should be prefixed with an underscore because the declaration is marked as @internal
2833
- //
2834
- // @internal (undocumented)
2835
- export type UnknownUserProfiles = string;
2836
-
2837
- // @public
2838
- export function until(conditionFunc: () => boolean, timeoutMs?: number): Promise<any>;
2839
-
2840
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "User" because one of its declarations is marked as @internal
2841
- //
2842
- // @public @deprecated
2843
- export interface User extends User_2 {
2844
- }
2845
-
2846
- // @internal @deprecated
2847
- export const User: InterfaceSymbol<User>;
2848
-
2849
- // Warning: (ae-internal-missing-underscore) The name "UserPermission" should be prefixed with an underscore because the declaration is marked as @internal
2850
- //
2851
- // @internal (undocumented)
2852
- export type UserPermission = CoreUserPermissions | UnknownUserPermissions;
2853
-
2854
- // Warning: (ae-internal-missing-underscore) The name "UserProfile" should be prefixed with an underscore because the declaration is marked as @internal
2855
- //
2856
- // @internal (undocumented)
2857
- export type UserProfile = CoreUserProfiles | UnknownUserProfiles;
2858
-
2859
- // Warning: (ae-internal-missing-underscore) The name "WSConnect" should be prefixed with an underscore because the declaration is marked as @internal
2860
- //
2861
- // @internal
2862
- export const WSConnect: InterfaceSymbol<Connect>;
2863
-
2864
- // Warnings were encountered during analysis:
2865
- //
2866
- // src/connect/message.ts:291:3 - (ae-forgotten-export) The symbol "RESOURCE_DETAILS" needs to be exported by the entry point index.d.ts
2867
-
2868
- // (No @packageDocumentation comment for this package)
2869
-
2870
- ```