@genesislcap/foundation-comms 14.225.3 → 14.225.4-alpha-9342136.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (84) hide show
  1. package/dist/dts/datasource/datasource.mixins.d.ts +45 -29
  2. package/dist/dts/datasource/datasource.mixins.d.ts.map +1 -1
  3. package/dist/dts/testing/mocks/auth/auth.d.ts +1 -1
  4. package/dist/dts/testing/mocks/auth/auth.d.ts.map +1 -1
  5. package/dist/dts/testing/mocks/connect/socket.d.ts +1 -1
  6. package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
  7. package/dist/dts/tsdoc-metadata.json +1 -1
  8. package/dist/esm/auth/auth.js +2 -2
  9. package/dist/esm/connect/connect.js +8 -8
  10. package/dist/esm/connect/http.connect.js +8 -7
  11. package/dist/esm/connect/socket.js +1 -5
  12. package/dist/esm/credentialManager/credentialManager.js +2 -2
  13. package/dist/esm/datasource/datasource.js +7 -7
  14. package/dist/esm/networkMonitor/config.js +1 -2
  15. package/dist/esm/resources/genesis/genesis.js +1 -1
  16. package/dist/esm/storage/kv/kv.service.js +3 -3
  17. package/dist/foundation-comms.api.json +4898 -2404
  18. package/dist/foundation-comms.d.ts +47 -31
  19. package/docs/api/foundation-comms.connect.md +1 -0
  20. package/docs/api/foundation-comms.connect.streamwithoutautoteardown.md +37 -0
  21. package/docs/api/foundation-comms.datasourceeventhandler.md +56 -30
  22. package/docs/api/foundation-comms.defaultentitydatasource._initialized.md +15 -0
  23. package/docs/api/foundation-comms.defaultentitydatasource.cache.md +19 -0
  24. package/docs/api/foundation-comms.defaultentitydatasource.disconnect.md +19 -0
  25. package/docs/api/foundation-comms.defaultentitydatasource.entitycache.md +14 -0
  26. package/docs/api/foundation-comms.defaultentitydatasource.entitymap.md +14 -0
  27. package/docs/api/foundation-comms.defaultentitydatasource.initialize.md +19 -0
  28. package/docs/api/foundation-comms.defaultentitydatasource.initialized.md +16 -0
  29. package/docs/api/foundation-comms.defaultentitydatasource.isempty.md +19 -0
  30. package/docs/api/foundation-comms.defaultentitydatasource.mapper.md +14 -0
  31. package/docs/api/foundation-comms.defaultentitydatasource.md +38 -0
  32. package/docs/api/foundation-comms.defaultentitydatasource.rowid.md +14 -0
  33. package/docs/api/foundation-comms.defaultentitydatasource.sourceref.md +14 -0
  34. package/docs/api/foundation-comms.defaultentitydatasource.subscription.md +14 -0
  35. package/docs/api/foundation-comms.defaultentitydatasource.subscriptionloggedoff.md +14 -0
  36. package/docs/api/foundation-comms.defaultkvstorage._constructor_.md +25 -0
  37. package/docs/api/foundation-comms.defaultkvstorage.md +30 -0
  38. package/docs/api/foundation-comms.defaultkvstorage.user.md +14 -0
  39. package/docs/api/foundation-comms.defaultkvstorageconfig.md +16 -0
  40. package/docs/api/foundation-comms.entitydatasource.cache.md +19 -0
  41. package/docs/api/foundation-comms.entitydatasource.disconnect.md +22 -0
  42. package/docs/api/foundation-comms.entitydatasource.initialize.md +29 -0
  43. package/docs/api/foundation-comms.entitydatasource.isempty.md +19 -0
  44. package/docs/api/foundation-comms.entitydatasource.md +81 -0
  45. package/docs/api/foundation-comms.entitydatasourceinit.fetchmeta.md +14 -0
  46. package/docs/api/foundation-comms.entitydatasourceinit.mapper.md +14 -0
  47. package/docs/api/foundation-comms.entitydatasourceinit.md +25 -0
  48. package/docs/api/foundation-comms.entitydatasourceinit.options.md +14 -0
  49. package/docs/api/foundation-comms.extractfielddefinitions.md +14 -1
  50. package/docs/api/foundation-comms.getkvstorage.md +1 -1
  51. package/docs/api/foundation-comms.keyvalue.base64.md +16 -0
  52. package/docs/api/foundation-comms.keyvalue.expiration.md +16 -0
  53. package/docs/api/foundation-comms.keyvalue.key.md +16 -0
  54. package/docs/api/foundation-comms.keyvalue.md +27 -0
  55. package/docs/api/foundation-comms.keyvalue.metadata.md +18 -0
  56. package/docs/api/foundation-comms.keyvalue.value.md +16 -0
  57. package/docs/api/foundation-comms.keyvaluetransfer.deserialize.md +25 -0
  58. package/docs/api/foundation-comms.keyvaluetransfer.kv.md +14 -0
  59. package/docs/api/foundation-comms.keyvaluetransfer.md +30 -0
  60. package/docs/api/foundation-comms.keyvaluetransfer.serialize.md +25 -0
  61. package/docs/api/foundation-comms.kveventfailureresponse.md +21 -0
  62. package/docs/api/foundation-comms.kveventmessagetype.md +24 -0
  63. package/docs/api/foundation-comms.kvmessagetype.md +24 -0
  64. package/docs/api/foundation-comms.kvstorage.delete.md +25 -0
  65. package/docs/api/foundation-comms.kvstorage.get.md +18 -0
  66. package/docs/api/foundation-comms.kvstorage.get_1.md +25 -0
  67. package/docs/api/foundation-comms.kvstorage.list.md +18 -0
  68. package/docs/api/foundation-comms.kvstorage.md +31 -0
  69. package/docs/api/foundation-comms.kvstorage.put.md +25 -0
  70. package/docs/api/foundation-comms.kvstorageconfig.account.md +16 -0
  71. package/docs/api/foundation-comms.kvstorageconfig.authemail.md +21 -0
  72. package/docs/api/foundation-comms.kvstorageconfig.authkey.md +16 -0
  73. package/docs/api/foundation-comms.kvstorageconfig.md +26 -0
  74. package/docs/api/foundation-comms.kvstorageconfig.namespace.md +16 -0
  75. package/docs/api/foundation-comms.kvvalue.md +16 -0
  76. package/docs/api/foundation-comms.md +19 -6
  77. package/docs/api/foundation-comms.messagehaserrorcode.md +13 -1
  78. package/docs/api/foundation-comms.messageorthrow.md +14 -1
  79. package/docs/api/foundation-comms.retryinterval.md +15 -1
  80. package/docs/api/foundation-comms.socket.md +1 -0
  81. package/docs/api/foundation-comms.socket.sendforstreamwithoutteardown.md +31 -0
  82. package/docs/api/foundation-comms.tofieldmetadata.md +14 -1
  83. package/docs/{api-report.md → api-report.md.api.md} +47 -31
  84. package/package.json +14 -14
@@ -15,7 +15,7 @@ import type { LogLevel } from '@genesislcap/foundation-utils';
15
15
  import { Observable } from 'rxjs';
16
16
  import { Observer } from '@genesislcap/foundation-utils';
17
17
  import { Observer as Observer_2 } from 'rxjs';
18
- import { SetUserProperties } from '@genesislcap/foundation-user/dist/esm';
18
+ import { SetUserProperties } from '@genesislcap/foundation-user';
19
19
  import { Subscription as SocketSubscription } from 'rxjs';
20
20
  import { Subject } from 'rxjs';
21
21
  import { TypedBroadcastChannel } from '@genesislcap/foundation-broadcast-channel';
@@ -1104,11 +1104,15 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1104
1104
  readonly offsetTop: number;
1105
1105
  readonly offsetWidth: number;
1106
1106
  outerText: string;
1107
+ popover: string;
1107
1108
  spellcheck: boolean;
1108
1109
  title: string;
1109
1110
  translate: boolean;
1110
1111
  attachInternals(): ElementInternals;
1111
1112
  click(): void;
1113
+ hidePopover(): void;
1114
+ showPopover(): void;
1115
+ togglePopover(force?: boolean): boolean;
1112
1116
  addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
1113
1117
  addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
1114
1118
  removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
@@ -1137,9 +1141,12 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1137
1141
  slot: string;
1138
1142
  readonly tagName: string;
1139
1143
  attachShadow(init: ShadowRootInit): ShadowRoot;
1144
+ checkVisibility(options?: CheckVisibilityOptions): boolean;
1140
1145
  closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
1141
1146
  closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
1147
+ closest<K_4 extends keyof MathMLElementTagNameMap>(selector: K_4): MathMLElementTagNameMap[K_4];
1142
1148
  closest<E extends Element = Element>(selectors: string): E;
1149
+ computedStyleMap(): StylePropertyMapReadOnly;
1143
1150
  getAttribute(qualifiedName: string): string;
1144
1151
  getAttributeNS(namespace: string, localName: string): string;
1145
1152
  getAttributeNames(): string[];
@@ -1148,11 +1155,14 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1148
1155
  getBoundingClientRect(): DOMRect;
1149
1156
  getClientRects(): DOMRectList;
1150
1157
  getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
1151
- getElementsByTagName<K_4 extends keyof HTMLElementTagNameMap>(qualifiedName: K_4): HTMLCollectionOf<HTMLElementTagNameMap[K_4]>;
1152
- getElementsByTagName<K_5 extends keyof SVGElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<SVGElementTagNameMap[K_5]>;
1158
+ getElementsByTagName<K_5 extends keyof HTMLElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<HTMLElementTagNameMap[K_5]>;
1159
+ getElementsByTagName<K_6 extends keyof SVGElementTagNameMap>(qualifiedName: K_6): HTMLCollectionOf<SVGElementTagNameMap[K_6]>;
1160
+ getElementsByTagName<K_7 extends keyof MathMLElementTagNameMap>(qualifiedName: K_7): HTMLCollectionOf<MathMLElementTagNameMap[K_7]>;
1161
+ getElementsByTagName<K_8 extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K_8): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K_8]>;
1153
1162
  getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
1154
1163
  getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
1155
1164
  getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
1165
+ getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
1156
1166
  getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
1157
1167
  hasAttribute(qualifiedName: string): boolean;
1158
1168
  hasAttributeNS(namespace: string, localName: string): boolean;
@@ -1210,24 +1220,24 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1210
1220
  normalize(): void;
1211
1221
  removeChild<T_2 extends Node>(child: T_2): T_2;
1212
1222
  replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
1213
- readonly ATTRIBUTE_NODE: number;
1214
- readonly CDATA_SECTION_NODE: number;
1215
- readonly COMMENT_NODE: number;
1216
- readonly DOCUMENT_FRAGMENT_NODE: number;
1217
- readonly DOCUMENT_NODE: number;
1218
- readonly DOCUMENT_POSITION_CONTAINED_BY: number;
1219
- readonly DOCUMENT_POSITION_CONTAINS: number;
1220
- readonly DOCUMENT_POSITION_DISCONNECTED: number;
1221
- readonly DOCUMENT_POSITION_FOLLOWING: number;
1222
- readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
1223
- readonly DOCUMENT_POSITION_PRECEDING: number;
1224
- readonly DOCUMENT_TYPE_NODE: number;
1225
- readonly ELEMENT_NODE: number;
1226
- readonly ENTITY_NODE: number;
1227
- readonly ENTITY_REFERENCE_NODE: number;
1228
- readonly NOTATION_NODE: number;
1229
- readonly PROCESSING_INSTRUCTION_NODE: number;
1230
- readonly TEXT_NODE: number;
1223
+ readonly ELEMENT_NODE: 1;
1224
+ readonly ATTRIBUTE_NODE: 2;
1225
+ readonly TEXT_NODE: 3;
1226
+ readonly CDATA_SECTION_NODE: 4;
1227
+ readonly ENTITY_REFERENCE_NODE: 5;
1228
+ readonly ENTITY_NODE: 6;
1229
+ readonly PROCESSING_INSTRUCTION_NODE: 7;
1230
+ readonly COMMENT_NODE: 8;
1231
+ readonly DOCUMENT_NODE: 9;
1232
+ readonly DOCUMENT_TYPE_NODE: 10;
1233
+ readonly DOCUMENT_FRAGMENT_NODE: 11;
1234
+ readonly NOTATION_NODE: 12;
1235
+ readonly DOCUMENT_POSITION_DISCONNECTED: 1;
1236
+ readonly DOCUMENT_POSITION_PRECEDING: 2;
1237
+ readonly DOCUMENT_POSITION_FOLLOWING: 4;
1238
+ readonly DOCUMENT_POSITION_CONTAINS: 8;
1239
+ readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
1240
+ readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
1231
1241
  dispatchEvent(event: Event): boolean;
1232
1242
  ariaAtomic: string;
1233
1243
  ariaAutoComplete: string;
@@ -1235,9 +1245,9 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1235
1245
  ariaChecked: string;
1236
1246
  ariaColCount: string;
1237
1247
  ariaColIndex: string;
1238
- ariaColIndexText: string;
1239
1248
  ariaColSpan: string;
1240
1249
  ariaCurrent: string;
1250
+ ariaDescription: string;
1241
1251
  ariaDisabled: string;
1242
1252
  ariaExpanded: string;
1243
1253
  ariaHasPopup: string;
@@ -1259,7 +1269,6 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1259
1269
  ariaRoleDescription: string;
1260
1270
  ariaRowCount: string;
1261
1271
  ariaRowIndex: string;
1262
- ariaRowIndexText: string;
1263
1272
  ariaRowSpan: string;
1264
1273
  ariaSelected: string;
1265
1274
  ariaSetSize: string;
@@ -1284,17 +1293,19 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1284
1293
  readonly lastElementChild: Element;
1285
1294
  append(...nodes: (string | Node)[]): void;
1286
1295
  prepend(...nodes: (string | Node)[]): void;
1287
- querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
1288
- querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
1296
+ querySelector<K_9 extends keyof HTMLElementTagNameMap>(selectors: K_9): HTMLElementTagNameMap[K_9];
1297
+ querySelector<K_10 extends keyof SVGElementTagNameMap>(selectors: K_10): SVGElementTagNameMap[K_10];
1298
+ querySelector<K_11 extends keyof MathMLElementTagNameMap>(selectors: K_11): MathMLElementTagNameMap[K_11];
1299
+ querySelector<K_12 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_12): HTMLElementDeprecatedTagNameMap[K_12];
1289
1300
  querySelector<E_1 extends Element = Element>(selectors: string): E_1;
1290
- querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
1291
- querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
1301
+ querySelectorAll<K_13 extends keyof HTMLElementTagNameMap>(selectors: K_13): NodeListOf<HTMLElementTagNameMap[K_13]>;
1302
+ querySelectorAll<K_14 extends keyof SVGElementTagNameMap>(selectors: K_14): NodeListOf<SVGElementTagNameMap[K_14]>;
1303
+ querySelectorAll<K_15 extends keyof MathMLElementTagNameMap>(selectors: K_15): NodeListOf<MathMLElementTagNameMap[K_15]>;
1304
+ querySelectorAll<K_16 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_16): NodeListOf<HTMLElementDeprecatedTagNameMap[K_16]>;
1292
1305
  querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
1293
1306
  replaceChildren(...nodes: (string | Node)[]): void;
1294
1307
  readonly assignedSlot: HTMLSlotElement;
1295
- oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
1296
- oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
1297
- onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
1308
+ readonly attributeStyleMap: StylePropertyMap;
1298
1309
  readonly style: CSSStyleDeclaration;
1299
1310
  contentEditable: string;
1300
1311
  enterKeyHint: string;
@@ -1307,6 +1318,7 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1307
1318
  onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
1308
1319
  onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1309
1320
  onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
1321
+ onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any;
1310
1322
  onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
1311
1323
  oncancel: (this: GlobalEventHandlers, ev: Event) => any;
1312
1324
  oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
@@ -1315,7 +1327,9 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1315
1327
  onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1316
1328
  onclose: (this: GlobalEventHandlers, ev: Event) => any;
1317
1329
  oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1330
+ oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
1318
1331
  oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
1332
+ oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
1319
1333
  ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1320
1334
  ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
1321
1335
  ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
@@ -1348,6 +1362,7 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1348
1362
  onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1349
1363
  onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1350
1364
  onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1365
+ onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
1351
1366
  onpause: (this: GlobalEventHandlers, ev: Event) => any;
1352
1367
  onplay: (this: GlobalEventHandlers, ev: Event) => any;
1353
1368
  onplaying: (this: GlobalEventHandlers, ev: Event) => any;
@@ -1364,6 +1379,7 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1364
1379
  onreset: (this: GlobalEventHandlers, ev: Event) => any;
1365
1380
  onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
1366
1381
  onscroll: (this: GlobalEventHandlers, ev: Event) => any;
1382
+ onscrollend: (this: GlobalEventHandlers, ev: Event) => any;
1367
1383
  onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
1368
1384
  onseeked: (this: GlobalEventHandlers, ev: Event) => any;
1369
1385
  onseeking: (this: GlobalEventHandlers, ev: Event) => any;
@@ -4422,7 +4438,7 @@ export declare class SocketMock implements Socket {
4422
4438
  isReconnecting: boolean;
4423
4439
  host: string;
4424
4440
  nextMessage: Message;
4425
- socketMessagesSubject: SocketSubject<Message<any>>;
4441
+ socketMessagesSubject: SocketSubject<Message>;
4426
4442
  connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
4427
4443
  disconnect(): void;
4428
4444
  send<T>(message: Message<any>): Promise<Message | any>;
@@ -39,4 +39,5 @@ export interface Connect
39
39
  | [snapshot(resourceName, params)](./foundation-comms.connect.snapshot.md) | Retrieves a snapshot of data for the specified resource. |
40
40
  | [stream(resourceName, onMessage, onError, params)](./foundation-comms.connect.stream.md) | Starts listening for updates on the specified resource. |
41
41
  | [streamState(resourceName, onMessage, onError, params, initialState)](./foundation-comms.connect.streamstate.md) | Starts listening for updates on the specified resource. |
42
+ | [streamWithoutAutoTeardown(resourceName, onMessage, onError, params)](./foundation-comms.connect.streamwithoutautoteardown.md) | **_(ALPHA)_** Starts listening for updates on the specified resource without auto-teardown. |
42
43
 
@@ -0,0 +1,37 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Connect](./foundation-comms.connect.md) &gt; [streamWithoutAutoTeardown](./foundation-comms.connect.streamwithoutautoteardown.md)
4
+
5
+ ## Connect.streamWithoutAutoTeardown() method
6
+
7
+ > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+ > Warning: This API is now obsolete.
11
+ >
12
+ > - Use `stream` instead. Will be removed in v15.
13
+ >
14
+
15
+ Starts listening for updates on the specified resource without auto-teardown.
16
+
17
+ **Signature:**
18
+
19
+ ```typescript
20
+ streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
21
+ ```
22
+
23
+ ## Parameters
24
+
25
+ | Parameter | Type | Description |
26
+ | --- | --- | --- |
27
+ | resourceName | string | The name of the resource to listen for updates on. |
28
+ | onMessage | Function | A callback function to handle received messages. |
29
+ | onError | Function | A callback function to handle errors. |
30
+ | params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ Additional parameters to pass to the server. |
31
+
32
+ **Returns:**
33
+
34
+ [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
35
+
36
+ An observable that emits messages received from the server.
37
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DatasourceEventHandler](./foundation-comms.datasourceeventhandler.md)
4
4
 
5
- ## DatasourceEventHandler variable
5
+ ## DatasourceEventHandler() function
6
6
 
7
7
  Datasource event handler mixin for target classes that use or are interested in datasource status changes.
8
8
 
@@ -32,11 +32,15 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
32
32
  readonly offsetTop: number;
33
33
  readonly offsetWidth: number;
34
34
  outerText: string;
35
+ popover: string;
35
36
  spellcheck: boolean;
36
37
  title: string;
37
38
  translate: boolean;
38
39
  attachInternals(): ElementInternals;
39
40
  click(): void;
41
+ hidePopover(): void;
42
+ showPopover(): void;
43
+ togglePopover(force?: boolean): boolean;
40
44
  addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
41
45
  addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
42
46
  removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
@@ -65,9 +69,12 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
65
69
  slot: string;
66
70
  readonly tagName: string;
67
71
  attachShadow(init: ShadowRootInit): ShadowRoot;
72
+ checkVisibility(options?: CheckVisibilityOptions): boolean;
68
73
  closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
69
74
  closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
75
+ closest<K_4 extends keyof MathMLElementTagNameMap>(selector: K_4): MathMLElementTagNameMap[K_4];
70
76
  closest<E extends Element = Element>(selectors: string): E;
77
+ computedStyleMap(): StylePropertyMapReadOnly;
71
78
  getAttribute(qualifiedName: string): string;
72
79
  getAttributeNS(namespace: string, localName: string): string;
73
80
  getAttributeNames(): string[];
@@ -76,11 +83,14 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
76
83
  getBoundingClientRect(): DOMRect;
77
84
  getClientRects(): DOMRectList;
78
85
  getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
79
- getElementsByTagName<K_4 extends keyof HTMLElementTagNameMap>(qualifiedName: K_4): HTMLCollectionOf<HTMLElementTagNameMap[K_4]>;
80
- getElementsByTagName<K_5 extends keyof SVGElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<SVGElementTagNameMap[K_5]>;
86
+ getElementsByTagName<K_5 extends keyof HTMLElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<HTMLElementTagNameMap[K_5]>;
87
+ getElementsByTagName<K_6 extends keyof SVGElementTagNameMap>(qualifiedName: K_6): HTMLCollectionOf<SVGElementTagNameMap[K_6]>;
88
+ getElementsByTagName<K_7 extends keyof MathMLElementTagNameMap>(qualifiedName: K_7): HTMLCollectionOf<MathMLElementTagNameMap[K_7]>;
89
+ getElementsByTagName<K_8 extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K_8): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K_8]>;
81
90
  getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
82
91
  getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
83
92
  getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
93
+ getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
84
94
  getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
85
95
  hasAttribute(qualifiedName: string): boolean;
86
96
  hasAttributeNS(namespace: string, localName: string): boolean;
@@ -138,24 +148,24 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
138
148
  normalize(): void;
139
149
  removeChild<T_2 extends Node>(child: T_2): T_2;
140
150
  replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
141
- readonly ATTRIBUTE_NODE: number;
142
- readonly CDATA_SECTION_NODE: number;
143
- readonly COMMENT_NODE: number;
144
- readonly DOCUMENT_FRAGMENT_NODE: number;
145
- readonly DOCUMENT_NODE: number;
146
- readonly DOCUMENT_POSITION_CONTAINED_BY: number;
147
- readonly DOCUMENT_POSITION_CONTAINS: number;
148
- readonly DOCUMENT_POSITION_DISCONNECTED: number;
149
- readonly DOCUMENT_POSITION_FOLLOWING: number;
150
- readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
151
- readonly DOCUMENT_POSITION_PRECEDING: number;
152
- readonly DOCUMENT_TYPE_NODE: number;
153
- readonly ELEMENT_NODE: number;
154
- readonly ENTITY_NODE: number;
155
- readonly ENTITY_REFERENCE_NODE: number;
156
- readonly NOTATION_NODE: number;
157
- readonly PROCESSING_INSTRUCTION_NODE: number;
158
- readonly TEXT_NODE: number;
151
+ readonly ELEMENT_NODE: 1;
152
+ readonly ATTRIBUTE_NODE: 2;
153
+ readonly TEXT_NODE: 3;
154
+ readonly CDATA_SECTION_NODE: 4;
155
+ readonly ENTITY_REFERENCE_NODE: 5;
156
+ readonly ENTITY_NODE: 6;
157
+ readonly PROCESSING_INSTRUCTION_NODE: 7;
158
+ readonly COMMENT_NODE: 8;
159
+ readonly DOCUMENT_NODE: 9;
160
+ readonly DOCUMENT_TYPE_NODE: 10;
161
+ readonly DOCUMENT_FRAGMENT_NODE: 11;
162
+ readonly NOTATION_NODE: 12;
163
+ readonly DOCUMENT_POSITION_DISCONNECTED: 1;
164
+ readonly DOCUMENT_POSITION_PRECEDING: 2;
165
+ readonly DOCUMENT_POSITION_FOLLOWING: 4;
166
+ readonly DOCUMENT_POSITION_CONTAINS: 8;
167
+ readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
168
+ readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
159
169
  dispatchEvent(event: Event): boolean;
160
170
  ariaAtomic: string;
161
171
  ariaAutoComplete: string;
@@ -163,9 +173,9 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
163
173
  ariaChecked: string;
164
174
  ariaColCount: string;
165
175
  ariaColIndex: string;
166
- ariaColIndexText: string;
167
176
  ariaColSpan: string;
168
177
  ariaCurrent: string;
178
+ ariaDescription: string;
169
179
  ariaDisabled: string;
170
180
  ariaExpanded: string;
171
181
  ariaHasPopup: string;
@@ -187,7 +197,6 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
187
197
  ariaRoleDescription: string;
188
198
  ariaRowCount: string;
189
199
  ariaRowIndex: string;
190
- ariaRowIndexText: string;
191
200
  ariaRowSpan: string;
192
201
  ariaSelected: string;
193
202
  ariaSetSize: string;
@@ -212,17 +221,19 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
212
221
  readonly lastElementChild: Element;
213
222
  append(...nodes: (string | Node)[]): void;
214
223
  prepend(...nodes: (string | Node)[]): void;
215
- querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
216
- querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
224
+ querySelector<K_9 extends keyof HTMLElementTagNameMap>(selectors: K_9): HTMLElementTagNameMap[K_9];
225
+ querySelector<K_10 extends keyof SVGElementTagNameMap>(selectors: K_10): SVGElementTagNameMap[K_10];
226
+ querySelector<K_11 extends keyof MathMLElementTagNameMap>(selectors: K_11): MathMLElementTagNameMap[K_11];
227
+ querySelector<K_12 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_12): HTMLElementDeprecatedTagNameMap[K_12];
217
228
  querySelector<E_1 extends Element = Element>(selectors: string): E_1;
218
- querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
219
- querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
229
+ querySelectorAll<K_13 extends keyof HTMLElementTagNameMap>(selectors: K_13): NodeListOf<HTMLElementTagNameMap[K_13]>;
230
+ querySelectorAll<K_14 extends keyof SVGElementTagNameMap>(selectors: K_14): NodeListOf<SVGElementTagNameMap[K_14]>;
231
+ querySelectorAll<K_15 extends keyof MathMLElementTagNameMap>(selectors: K_15): NodeListOf<MathMLElementTagNameMap[K_15]>;
232
+ querySelectorAll<K_16 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_16): NodeListOf<HTMLElementDeprecatedTagNameMap[K_16]>;
220
233
  querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
221
234
  replaceChildren(...nodes: (string | Node)[]): void;
222
235
  readonly assignedSlot: HTMLSlotElement;
223
- oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
224
- oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
225
- onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
236
+ readonly attributeStyleMap: StylePropertyMap;
226
237
  readonly style: CSSStyleDeclaration;
227
238
  contentEditable: string;
228
239
  enterKeyHint: string;
@@ -235,6 +246,7 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
235
246
  onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
236
247
  onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
237
248
  onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
249
+ onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any;
238
250
  onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
239
251
  oncancel: (this: GlobalEventHandlers, ev: Event) => any;
240
252
  oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
@@ -243,7 +255,9 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
243
255
  onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
244
256
  onclose: (this: GlobalEventHandlers, ev: Event) => any;
245
257
  oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
258
+ oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
246
259
  oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
260
+ oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
247
261
  ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
248
262
  ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
249
263
  ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
@@ -276,6 +290,7 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
276
290
  onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
277
291
  onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
278
292
  onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
293
+ onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
279
294
  onpause: (this: GlobalEventHandlers, ev: Event) => any;
280
295
  onplay: (this: GlobalEventHandlers, ev: Event) => any;
281
296
  onplaying: (this: GlobalEventHandlers, ev: Event) => any;
@@ -292,6 +307,7 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
292
307
  onreset: (this: GlobalEventHandlers, ev: Event) => any;
293
308
  onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
294
309
  onscroll: (this: GlobalEventHandlers, ev: Event) => any;
310
+ onscrollend: (this: GlobalEventHandlers, ev: Event) => any;
295
311
  onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
296
312
  onseeked: (this: GlobalEventHandlers, ev: Event) => any;
297
313
  onseeking: (this: GlobalEventHandlers, ev: Event) => any;
@@ -332,6 +348,16 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
332
348
  }
333
349
  ```
334
350
 
351
+ ## Parameters
352
+
353
+ | Parameter | Type | Description |
354
+ | --- | --- | --- |
355
+ | Target | new () =&gt; HTMLElement &amp; FASTElement | The class to mix the event handler with. |
356
+
357
+ **Returns:**
358
+
359
+ { new (): { datasourceStatus: [DatasourceStatus](./foundation-comms.datasourcestatus.md)<!-- -->; resourceName: string; onDatasourceStatusChanged: (event: [DatasourceStatusChangedEvent](./foundation-comms.datasourcestatuschangedevent.md)<!-- -->) =&gt; void; datasourceStatusChanged(prev: [DatasourceStatus](./foundation-comms.datasourcestatus.md)<!-- -->, next: [DatasourceStatus](./foundation-comms.datasourcestatus.md)<!-- -->): void; connectedCallback(): void; disconnectedCallback(): void; accessKey: string; readonly accessKeyLabel: string; autocapitalize: string; dir: string; draggable: boolean; hidden: boolean; inert: boolean; innerText: string; lang: string; readonly offsetHeight: number; readonly offsetLeft: number; readonly offsetParent: Element; readonly offsetTop: number; readonly offsetWidth: number; outerText: string; popover: string; spellcheck: boolean; title: string; translate: boolean; attachInternals(): ElementInternals; click(): void; hidePopover(): void; showPopover(): void; togglePopover(force?: boolean): boolean; addEventListener&lt;K extends keyof HTMLElementEventMap&gt;(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap\[K\]) =&gt; any, options?: boolean \| AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| AddEventListenerOptions): void; removeEventListener&lt;K\_1 extends keyof HTMLElementEventMap&gt;(type: K\_1, listener: (this: HTMLElement, ev: HTMLElementEventMap\[K\_1\]) =&gt; any, options?: boolean \| EventListenerOptions): void; removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| EventListenerOptions): void; readonly attributes: NamedNodeMap; readonly classList: DOMTokenList; className: string; readonly clientHeight: number; readonly clientLeft: number; readonly clientTop: number; readonly clientWidth: number; id: string; readonly localName: string; readonly namespaceURI: string; onfullscreenchange: (this: Element, ev: Event) =&gt; any; onfullscreenerror: (this: Element, ev: Event) =&gt; any; outerHTML: string; readonly ownerDocument: Document; readonly part: DOMTokenList; readonly prefix: string; readonly scrollHeight: number; scrollLeft: number; scrollTop: number; readonly scrollWidth: number; readonly shadowRoot: ShadowRoot; slot: string; readonly tagName: string; attachShadow(init: ShadowRootInit): ShadowRoot; checkVisibility(options?: CheckVisibilityOptions): boolean; closest&lt;K\_2 extends keyof HTMLElementTagNameMap&gt;(selector: K\_2): HTMLElementTagNameMap\[K\_2\]; closest&lt;K\_3 extends keyof SVGElementTagNameMap&gt;(selector: K\_3): SVGElementTagNameMap\[K\_3\]; closest&lt;K\_4 extends keyof MathMLElementTagNameMap&gt;(selector: K\_4): MathMLElementTagNameMap\[K\_4\]; closest&lt;E extends Element = Element&gt;(selectors: string): E; computedStyleMap(): StylePropertyMapReadOnly; getAttribute(qualifiedName: string): string; getAttributeNS(namespace: string, localName: string): string; getAttributeNames(): string\[\]; getAttributeNode(qualifiedName: string): Attr; getAttributeNodeNS(namespace: string, localName: string): Attr; getBoundingClientRect(): DOMRect; getClientRects(): DOMRectList; getElementsByClassName(classNames: string): HTMLCollectionOf&lt;Element&gt;; getElementsByTagName&lt;K\_5 extends keyof HTMLElementTagNameMap&gt;(qualifiedName: K\_5): HTMLCollectionOf&lt;HTMLElementTagNameMap\[K\_5\]&gt;; getElementsByTagName&lt;K\_6 extends keyof SVGElementTagNameMap&gt;(qualifiedName: K\_6): HTMLCollectionOf&lt;SVGElementTagNameMap\[K\_6\]&gt;; getElementsByTagName&lt;K\_7 extends keyof MathMLElementTagNameMap&gt;(qualifiedName: K\_7): HTMLCollectionOf&lt;MathMLElementTagNameMap\[K\_7\]&gt;; getElementsByTagName&lt;K\_8 extends keyof HTMLElementDeprecatedTagNameMap&gt;(qualifiedName: K\_8): HTMLCollectionOf&lt;HTMLElementDeprecatedTagNameMap\[K\_8\]&gt;; getElementsByTagName(qualifiedName: string): HTMLCollectionOf&lt;Element&gt;; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf&lt;HTMLElement&gt;; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf&lt;SVGElement&gt;; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf&lt;MathMLElement&gt;; getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf&lt;Element&gt;; hasAttribute(qualifiedName: string): boolean; hasAttributeNS(namespace: string, localName: string): boolean; hasAttributes(): boolean; hasPointerCapture(pointerId: number): boolean; insertAdjacentElement(where: InsertPosition, element: Element): Element; insertAdjacentHTML(position: InsertPosition, text: string): void; insertAdjacentText(where: InsertPosition, data: string): void; matches(selectors: string): boolean; releasePointerCapture(pointerId: number): void; removeAttribute(qualifiedName: string): void; removeAttributeNS(namespace: string, localName: string): void; removeAttributeNode(attr: Attr): Attr; requestFullscreen(options?: FullscreenOptions): Promise&lt;void&gt;; requestPointerLock(): void; scroll(options?: ScrollToOptions): void; scroll(x: number, y: number): void; scrollBy(options?: ScrollToOptions): void; scrollBy(x: number, y: number): void; scrollIntoView(arg?: boolean \| ScrollIntoViewOptions): void; scrollTo(options?: ScrollToOptions): void; scrollTo(x: number, y: number): void; setAttribute(qualifiedName: string, value: string): void; setAttributeNS(namespace: string, qualifiedName: string, value: string): void; setAttributeNode(attr: Attr): Attr; setAttributeNodeNS(attr: Attr): Attr; setPointerCapture(pointerId: number): void; toggleAttribute(qualifiedName: string, force?: boolean): boolean; webkitMatchesSelector(selectors: string): boolean; readonly baseURI: string; readonly childNodes: NodeListOf&lt;ChildNode&gt;; readonly firstChild: ChildNode; readonly isConnected: boolean; readonly lastChild: ChildNode; readonly nextSibling: ChildNode; readonly nodeName: string; readonly nodeType: number; nodeValue: string; readonly parentElement: HTMLElement; readonly parentNode: ParentNode; readonly previousSibling: ChildNode; textContent: string; appendChild&lt;T extends Node&gt;(node: T): T; cloneNode(deep?: boolean): Node; compareDocumentPosition(other: Node): number; contains(other: Node): boolean; getRootNode(options?: GetRootNodeOptions): Node; hasChildNodes(): boolean; insertBefore&lt;T\_1 extends Node&gt;(node: T\_1, child: Node): T\_1; isDefaultNamespace(namespace: string): boolean; isEqualNode(otherNode: Node): boolean; isSameNode(otherNode: Node): boolean; lookupNamespaceURI(prefix: string): string; lookupPrefix(namespace: string): string; normalize(): void; removeChild&lt;T\_2 extends Node&gt;(child: T\_2): T\_2; replaceChild&lt;T\_3 extends Node&gt;(node: Node, child: T\_3): T\_3; readonly ELEMENT\_NODE: 1; readonly ATTRIBUTE\_NODE: 2; readonly TEXT\_NODE: 3; readonly CDATA\_SECTION\_NODE: 4; readonly ENTITY\_REFERENCE\_NODE: 5; readonly ENTITY\_NODE: 6; readonly PROCESSING\_INSTRUCTION\_NODE: 7; readonly COMMENT\_NODE: 8; readonly DOCUMENT\_NODE: 9; readonly DOCUMENT\_TYPE\_NODE: 10; readonly DOCUMENT\_FRAGMENT\_NODE: 11; readonly NOTATION\_NODE: 12; readonly DOCUMENT\_POSITION\_DISCONNECTED: 1; readonly DOCUMENT\_POSITION\_PRECEDING: 2; readonly DOCUMENT\_POSITION\_FOLLOWING: 4; readonly DOCUMENT\_POSITION\_CONTAINS: 8; readonly DOCUMENT\_POSITION\_CONTAINED\_BY: 16; readonly DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC: 32; dispatchEvent(event: Event): boolean; ariaAtomic: string; ariaAutoComplete: string; ariaBusy: string; ariaChecked: string; ariaColCount: string; ariaColIndex: string; ariaColSpan: string; ariaCurrent: string; ariaDescription: string; ariaDisabled: string; ariaExpanded: string; ariaHasPopup: string; ariaHidden: string; ariaInvalid: string; ariaKeyShortcuts: string; ariaLabel: string; ariaLevel: string; ariaLive: string; ariaModal: string; ariaMultiLine: string; ariaMultiSelectable: string; ariaOrientation: string; ariaPlaceholder: string; ariaPosInSet: string; ariaPressed: string; ariaReadOnly: string; ariaRequired: string; ariaRoleDescription: string; ariaRowCount: string; ariaRowIndex: string; ariaRowSpan: string; ariaSelected: string; ariaSetSize: string; ariaSort: string; ariaValueMax: string; ariaValueMin: string; ariaValueNow: string; ariaValueText: string; role: string; animate(keyframes: Keyframe\[\] \| PropertyIndexedKeyframes, options?: number \| KeyframeAnimationOptions): Animation; getAnimations(options?: GetAnimationsOptions): Animation\[\]; after(...nodes: (string \| Node)\[\]): void; before(...nodes: (string \| Node)\[\]): void; remove(): void; replaceWith(...nodes: (string \| Node)\[\]): void; innerHTML: string; readonly nextElementSibling: Element; readonly previousElementSibling: Element; readonly childElementCount: number; readonly children: HTMLCollection; readonly firstElementChild: Element; readonly lastElementChild: Element; append(...nodes: (string \| Node)\[\]): void; prepend(...nodes: (string \| Node)\[\]): void; querySelector&lt;K\_9 extends keyof HTMLElementTagNameMap&gt;(selectors: K\_9): HTMLElementTagNameMap\[K\_9\]; querySelector&lt;K\_10 extends keyof SVGElementTagNameMap&gt;(selectors: K\_10): SVGElementTagNameMap\[K\_10\]; querySelector&lt;K\_11 extends keyof MathMLElementTagNameMap&gt;(selectors: K\_11): MathMLElementTagNameMap\[K\_11\]; querySelector&lt;K\_12 extends keyof HTMLElementDeprecatedTagNameMap&gt;(selectors: K\_12): HTMLElementDeprecatedTagNameMap\[K\_12\]; querySelector&lt;E\_1 extends Element = Element&gt;(selectors: string): E\_1; querySelectorAll&lt;K\_13 extends keyof HTMLElementTagNameMap&gt;(selectors: K\_13): NodeListOf&lt;HTMLElementTagNameMap\[K\_13\]&gt;; querySelectorAll&lt;K\_14 extends keyof SVGElementTagNameMap&gt;(selectors: K\_14): NodeListOf&lt;SVGElementTagNameMap\[K\_14\]&gt;; querySelectorAll&lt;K\_15 extends keyof MathMLElementTagNameMap&gt;(selectors: K\_15): NodeListOf&lt;MathMLElementTagNameMap\[K\_15\]&gt;; querySelectorAll&lt;K\_16 extends keyof HTMLElementDeprecatedTagNameMap&gt;(selectors: K\_16): NodeListOf&lt;HTMLElementDeprecatedTagNameMap\[K\_16\]&gt;; querySelectorAll&lt;E\_2 extends Element = Element&gt;(selectors: string): NodeListOf&lt;E\_2&gt;; replaceChildren(...nodes: (string \| Node)\[\]): void; readonly assignedSlot: HTMLSlotElement; readonly attributeStyleMap: StylePropertyMap; readonly style: CSSStyleDeclaration; contentEditable: string; enterKeyHint: string; inputMode: string; readonly isContentEditable: boolean; onabort: (this: GlobalEventHandlers, ev: UIEvent) =&gt; any; onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) =&gt; any; onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) =&gt; any; onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) =&gt; any; onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) =&gt; any; onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) =&gt; any; onbeforetoggle: (this: GlobalEventHandlers, ev: Event) =&gt; any; onblur: (this: GlobalEventHandlers, ev: FocusEvent) =&gt; any; oncancel: (this: GlobalEventHandlers, ev: Event) =&gt; any; oncanplay: (this: GlobalEventHandlers, ev: Event) =&gt; any; oncanplaythrough: (this: GlobalEventHandlers, ev: Event) =&gt; any; onchange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onclick: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onclose: (this: GlobalEventHandlers, ev: Event) =&gt; any; oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) =&gt; any; oncuechange: (this: GlobalEventHandlers, ev: Event) =&gt; any; oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) =&gt; any; ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; ondrag: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondragend: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondragenter: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondragleave: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondragover: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondragstart: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondrop: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondurationchange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onemptied: (this: GlobalEventHandlers, ev: Event) =&gt; any; onended: (this: GlobalEventHandlers, ev: Event) =&gt; any; onerror: OnErrorEventHandlerNonNull; onfocus: (this: GlobalEventHandlers, ev: FocusEvent) =&gt; any; onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) =&gt; any; ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; oninput: (this: GlobalEventHandlers, ev: Event) =&gt; any; oninvalid: (this: GlobalEventHandlers, ev: Event) =&gt; any; onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) =&gt; any; onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) =&gt; any; onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) =&gt; any; onload: (this: GlobalEventHandlers, ev: Event) =&gt; any; onloadeddata: (this: GlobalEventHandlers, ev: Event) =&gt; any; onloadedmetadata: (this: GlobalEventHandlers, ev: Event) =&gt; any; onloadstart: (this: GlobalEventHandlers, ev: Event) =&gt; any; onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) =&gt; any; onpause: (this: GlobalEventHandlers, ev: Event) =&gt; any; onplay: (this: GlobalEventHandlers, ev: Event) =&gt; any; onplaying: (this: GlobalEventHandlers, ev: Event) =&gt; any; onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onprogress: (this: GlobalEventHandlers, ev: ProgressEvent&lt;EventTarget&gt;) =&gt; any; onratechange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onreset: (this: GlobalEventHandlers, ev: Event) =&gt; any; onresize: (this: GlobalEventHandlers, ev: UIEvent) =&gt; any; onscroll: (this: GlobalEventHandlers, ev: Event) =&gt; any; onscrollend: (this: GlobalEventHandlers, ev: Event) =&gt; any; onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) =&gt; any; onseeked: (this: GlobalEventHandlers, ev: Event) =&gt; any; onseeking: (this: GlobalEventHandlers, ev: Event) =&gt; any; onselect: (this: GlobalEventHandlers, ev: Event) =&gt; any; onselectionchange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onselectstart: (this: GlobalEventHandlers, ev: Event) =&gt; any; onslotchange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onstalled: (this: GlobalEventHandlers, ev: Event) =&gt; any; onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) =&gt; any; onsuspend: (this: GlobalEventHandlers, ev: Event) =&gt; any; ontimeupdate: (this: GlobalEventHandlers, ev: Event) =&gt; any; ontoggle: (this: GlobalEventHandlers, ev: Event) =&gt; any; ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) =&gt; any; ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) =&gt; any; ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) =&gt; any; ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) =&gt; any; ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) =&gt; any; ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) =&gt; any; ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) =&gt; any; ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) =&gt; any; onvolumechange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwaiting: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwheel: (this: GlobalEventHandlers, ev: WheelEvent) =&gt; any; autofocus: boolean; readonly dataset: DOMStringMap; nonce?: string; tabIndex: number; blur(): void; focus(options?: FocusOptions): void; readonly $fastController: import("@microsoft/fast-element").Controller; $emit(type: string, detail?: any, options?: Omit&lt;CustomEventInit&lt;any&gt;, "detail"&gt;): boolean \| void; attributeChangedCallback(name: string, oldValue: string, newValue: string): void; }; }
360
+
335
361
  ## Remarks
336
362
 
337
363
  Classes that use the mixin are not required to own the datasource itself, there may be several interested parties.
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [\_initialized](./foundation-comms.defaultentitydatasource._initialized.md)
4
+
5
+ ## DefaultEntityDatasource.\_initialized property
6
+
7
+ > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ protected _initialized: boolean;
15
+ ```
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [cache](./foundation-comms.defaultentitydatasource.cache.md)
4
+
5
+ ## DefaultEntityDatasource.cache property
6
+
7
+ > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ get cache(): TEntity[];
14
+ ```
15
+
16
+ ## Remarks
17
+
18
+ In-memory entity cache.
19
+
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [disconnect](./foundation-comms.defaultentitydatasource.disconnect.md)
4
+
5
+ ## DefaultEntityDatasource.disconnect property
6
+
7
+ > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ disconnect: () => void;
14
+ ```
15
+
16
+ ## Remarks
17
+
18
+ Disconnect and reset cache.
19
+
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [entityCache](./foundation-comms.defaultentitydatasource.entitycache.md)
4
+
5
+ ## DefaultEntityDatasource.entityCache property
6
+
7
+ > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ protected entityCache: TEntity[];
14
+ ```
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [entityMap](./foundation-comms.defaultentitydatasource.entitymap.md)
4
+
5
+ ## DefaultEntityDatasource.entityMap property
6
+
7
+ > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ protected entityMap: Map<string, TEntity>;
14
+ ```
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [initialize](./foundation-comms.defaultentitydatasource.initialize.md)
4
+
5
+ ## DefaultEntityDatasource.initialize property
6
+
7
+ > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ initialize: (init: EntityDatasourceInit<TDTO, TEntity>) => Promise<boolean>;
14
+ ```
15
+
16
+ ## Remarks
17
+
18
+ Initialize datasource.
19
+
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [initialized](./foundation-comms.defaultentitydatasource.initialized.md)
4
+
5
+ ## DefaultEntityDatasource.initialized property
6
+
7
+ > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ get initialized(): boolean;
14
+
15
+ set initialized(value: boolean);
16
+ ```
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [isEmpty](./foundation-comms.defaultentitydatasource.isempty.md)
4
+
5
+ ## DefaultEntityDatasource.isEmpty property
6
+
7
+ > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ get isEmpty(): boolean;
14
+ ```
15
+
16
+ ## Remarks
17
+
18
+ Cache is empty / awaiting first result.
19
+
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [mapper](./foundation-comms.defaultentitydatasource.mapper.md)
4
+
5
+ ## DefaultEntityDatasource.mapper property
6
+
7
+ > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ protected mapper: DTOMapper<TDTO, TEntity>;
14
+ ```