@genesislcap/foundation-comms 14.225.4-alpha-5f6eefd.0 → 14.226.1

package/docs/api/foundation-comms.retryinterval.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [retryInterval](./foundation-comms.retryinterval.md)
 
-## retryInterval() function
+## retryInterval variable
 
 Generate reconnect interval based on scheduler
 
@@ -11,17 +11,3 @@ Generate reconnect interval based on scheduler
 ```typescript
 retryInterval: (reconnectOptions: SocketReconnectOptions, scheduler: SocketReconnectScheduler) => Observable<number>
 ```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  reconnectOptions | [SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md) | [SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md) options |
-|  scheduler | [SocketReconnectScheduler](./foundation-comms.socketreconnectscheduler.md) | [SocketReconnectScheduler](./foundation-comms.socketreconnectscheduler.md) function |
-
-**Returns:**
-
-Observable&lt;number&gt;
-
-Observable<number>
-

package/docs/api/foundation-comms.socket.md

@@ -27,6 +27,5 @@ export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 're
 |  [reset()](./foundation-comms.socket.reset.md) | Disconnects the socket and clears all subscriptions |
 |  [send(message, needsHandling)](./foundation-comms.socket.send.md) |  |
 |  [sendForStream(message, onMessage, onError, onComplete)](./foundation-comms.socket.sendforstream.md) |  |
-|  [sendForStreamWithoutTeardown(message, onMessage, onError)](./foundation-comms.socket.sendforstreamwithoutteardown.md) | **_(ALPHA)_** Sends a message and returns an observable that emits messages received from the server. |
 |  [socketMessages()](./foundation-comms.socket.socketmessages.md) |  |
 

package/docs/api/foundation-comms.tofieldmetadata.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [toFieldMetadata](./foundation-comms.tofieldmetadata.md)
 
-## toFieldMetadata() function
+## toFieldMetadata variable
 
 Converts the field definitions to field metadata.
 
@@ -11,16 +11,3 @@ Converts the field definitions to field metadata.
 ```typescript
 toFieldMetadata: (fieldDef: MetadataDetail[]) => FieldMetadata[]
 ```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  fieldDef | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | The field definitions. |
-
-**Returns:**
-
-[FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\]
-
-An array of field metadata.
-

package/docs/{api-report.md.api.md → api-report.md}

@@ -21,7 +21,7 @@ import type { LogLevel } from '@genesislcap/foundation-utils';
 import { Observable } from 'rxjs';
 import { Observer } from '@genesislcap/foundation-utils';
 import { Observer as Observer_2 } from 'rxjs';
-import { SetUserProperties } from '@genesislcap/foundation-user';
+import { SetUserProperties } from '@genesislcap/foundation-user/dist/esm';
 import { Subscription as SocketSubscription } from 'rxjs';
 import { Subject } from 'rxjs';
 import { TypedBroadcastChannel } from '@genesislcap/foundation-broadcast-channel';
@@ -473,15 +473,11 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         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<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
         addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
         removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
@@ -510,12 +506,9 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         slot: string;
         readonly tagName: string;
         attachShadow(init: ShadowRootInit): ShadowRoot;
-        checkVisibility(options?: CheckVisibilityOptions): boolean;
         closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
         closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
-        closest<K_4 extends keyof MathMLElementTagNameMap>(selector: K_4): MathMLElementTagNameMap[K_4];
         closest<E extends Element = Element>(selectors: string): E;
-        computedStyleMap(): StylePropertyMapReadOnly;
         getAttribute(qualifiedName: string): string;
         getAttributeNS(namespace: string, localName: string): string;
         getAttributeNames(): string[];
@@ -524,14 +517,11 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         getBoundingClientRect(): DOMRect;
         getClientRects(): DOMRectList;
         getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
-        getElementsByTagName<K_5 extends keyof HTMLElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<HTMLElementTagNameMap[K_5]>;
-        getElementsByTagName<K_6 extends keyof SVGElementTagNameMap>(qualifiedName: K_6): HTMLCollectionOf<SVGElementTagNameMap[K_6]>;
-        getElementsByTagName<K_7 extends keyof MathMLElementTagNameMap>(qualifiedName: K_7): HTMLCollectionOf<MathMLElementTagNameMap[K_7]>;
-        getElementsByTagName<K_8 extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K_8): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K_8]>;
+        getElementsByTagName<K_4 extends keyof HTMLElementTagNameMap>(qualifiedName: K_4): HTMLCollectionOf<HTMLElementTagNameMap[K_4]>;
+        getElementsByTagName<K_5 extends keyof SVGElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<SVGElementTagNameMap[K_5]>;
         getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
         getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
         getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
-        getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
         getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
         hasAttribute(qualifiedName: string): boolean;
         hasAttributeNS(namespace: string, localName: string): boolean;
@@ -589,24 +579,24 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         normalize(): void;
         removeChild<T_2 extends Node>(child: T_2): T_2;
         replaceChild<T_3 extends Node>(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;
+        readonly ATTRIBUTE_NODE: number;
+        readonly CDATA_SECTION_NODE: number;
+        readonly COMMENT_NODE: number;
+        readonly DOCUMENT_FRAGMENT_NODE: number;
+        readonly DOCUMENT_NODE: number;
+        readonly DOCUMENT_POSITION_CONTAINED_BY: number;
+        readonly DOCUMENT_POSITION_CONTAINS: number;
+        readonly DOCUMENT_POSITION_DISCONNECTED: number;
+        readonly DOCUMENT_POSITION_FOLLOWING: number;
+        readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
+        readonly DOCUMENT_POSITION_PRECEDING: number;
+        readonly DOCUMENT_TYPE_NODE: number;
+        readonly ELEMENT_NODE: number;
+        readonly ENTITY_NODE: number;
+        readonly ENTITY_REFERENCE_NODE: number;
+        readonly NOTATION_NODE: number;
+        readonly PROCESSING_INSTRUCTION_NODE: number;
+        readonly TEXT_NODE: number;
         dispatchEvent(event: Event): boolean;
         ariaAtomic: string;
         ariaAutoComplete: string;
@@ -614,9 +604,9 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         ariaChecked: string;
         ariaColCount: string;
         ariaColIndex: string;
+        ariaColIndexText: string;
         ariaColSpan: string;
         ariaCurrent: string;
-        ariaDescription: string;
         ariaDisabled: string;
         ariaExpanded: string;
         ariaHasPopup: string;
@@ -638,6 +628,7 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         ariaRoleDescription: string;
         ariaRowCount: string;
         ariaRowIndex: string;
+        ariaRowIndexText: string;
         ariaRowSpan: string;
         ariaSelected: string;
         ariaSetSize: string;
@@ -662,19 +653,17 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         readonly lastElementChild: Element;
         append(...nodes: (string | Node)[]): void;
         prepend(...nodes: (string | Node)[]): void;
-        querySelector<K_9 extends keyof HTMLElementTagNameMap>(selectors: K_9): HTMLElementTagNameMap[K_9];
-        querySelector<K_10 extends keyof SVGElementTagNameMap>(selectors: K_10): SVGElementTagNameMap[K_10];
-        querySelector<K_11 extends keyof MathMLElementTagNameMap>(selectors: K_11): MathMLElementTagNameMap[K_11];
-        querySelector<K_12 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_12): HTMLElementDeprecatedTagNameMap[K_12];
+        querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
+        querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
         querySelector<E_1 extends Element = Element>(selectors: string): E_1;
-        querySelectorAll<K_13 extends keyof HTMLElementTagNameMap>(selectors: K_13): NodeListOf<HTMLElementTagNameMap[K_13]>;
-        querySelectorAll<K_14 extends keyof SVGElementTagNameMap>(selectors: K_14): NodeListOf<SVGElementTagNameMap[K_14]>;
-        querySelectorAll<K_15 extends keyof MathMLElementTagNameMap>(selectors: K_15): NodeListOf<MathMLElementTagNameMap[K_15]>;
-        querySelectorAll<K_16 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_16): NodeListOf<HTMLElementDeprecatedTagNameMap[K_16]>;
+        querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
+        querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
         querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
         replaceChildren(...nodes: (string | Node)[]): void;
         readonly assignedSlot: HTMLSlotElement;
-        readonly attributeStyleMap: StylePropertyMap;
+        oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
+        oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
+        onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
         readonly style: CSSStyleDeclaration;
         contentEditable: string;
         enterKeyHint: string;
@@ -687,7 +676,6 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
         onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
         onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
-        onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any;
         onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
         oncancel: (this: GlobalEventHandlers, ev: Event) => any;
         oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
@@ -696,9 +684,7 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
         onclose: (this: GlobalEventHandlers, ev: Event) => any;
         oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
-        oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
         oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
-        oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
         ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
         ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
         ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
@@ -731,7 +717,6 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
         onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
         onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
-        onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
         onpause: (this: GlobalEventHandlers, ev: Event) => any;
         onplay: (this: GlobalEventHandlers, ev: Event) => any;
         onplaying: (this: GlobalEventHandlers, ev: Event) => any;
@@ -748,7 +733,6 @@ export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElemen
         onreset: (this: GlobalEventHandlers, ev: Event) => any;
         onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
         onscroll: (this: GlobalEventHandlers, ev: Event) => any;
-        onscrollend: (this: GlobalEventHandlers, ev: Event) => any;
         onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
         onseeked: (this: GlobalEventHandlers, ev: Event) => any;
         onseeking: (this: GlobalEventHandlers, ev: Event) => any;
@@ -2601,7 +2585,7 @@ export class SocketMock implements Socket {
     // (undocumented)
     socketMessages(): SocketSubject<Message>;
     // (undocumented)
-    socketMessagesSubject: SocketSubject<Message>;
+    socketMessagesSubject: SocketSubject<Message<any>>;
 }
 
 // @public

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-comms",
   "description": "Genesis Foundation UI Comms",
-  "version": "14.225.4-alpha-5f6eefd.0",
+  "version": "14.226.1",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -75,23 +75,23 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.225.4-alpha-5f6eefd.0",
-    "@genesislcap/genx": "14.225.4-alpha-5f6eefd.0",
-    "@genesislcap/rollup-builder": "14.225.4-alpha-5f6eefd.0",
-    "@genesislcap/ts-builder": "14.225.4-alpha-5f6eefd.0",
-    "@genesislcap/uvu-playwright-builder": "14.225.4-alpha-5f6eefd.0",
-    "@genesislcap/vite-builder": "14.225.4-alpha-5f6eefd.0",
-    "@genesislcap/webpack-builder": "14.225.4-alpha-5f6eefd.0",
+    "@genesislcap/foundation-testing": "14.226.1",
+    "@genesislcap/genx": "14.226.1",
+    "@genesislcap/rollup-builder": "14.226.1",
+    "@genesislcap/ts-builder": "14.226.1",
+    "@genesislcap/uvu-playwright-builder": "14.226.1",
+    "@genesislcap/vite-builder": "14.226.1",
+    "@genesislcap/webpack-builder": "14.226.1",
     "@types/js-cookie": "^3.0.2",
     "@types/json-schema": "^7.0.11",
     "@types/webappsec-credential-management": "^0.6.2",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-broadcast-channel": "14.225.4-alpha-5f6eefd.0",
-    "@genesislcap/foundation-logger": "14.225.4-alpha-5f6eefd.0",
-    "@genesislcap/foundation-user": "14.225.4-alpha-5f6eefd.0",
-    "@genesislcap/foundation-utils": "14.225.4-alpha-5f6eefd.0",
+    "@genesislcap/foundation-broadcast-channel": "14.226.1",
+    "@genesislcap/foundation-logger": "14.226.1",
+    "@genesislcap/foundation-user": "14.226.1",
+    "@genesislcap/foundation-utils": "14.226.1",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
     "analytics": "^0.8.0",
@@ -101,7 +101,7 @@
     "js-cookie": "^3.0.1",
     "json-schema": "^0.4.0",
     "rxjs": "^7.5.4",
-    "tslib": "2.8.1"
+    "tslib": "^2.3.1"
   },
   "repository": {
     "type": "git",
@@ -111,5 +111,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "232162ffe08f1239c9af3c85819c422c4a68db00"
+  "gitHead": "e691c1741d135edca5271f338f62df8154efb99c"
 }

package/docs/api/foundation-comms.connect.streamwithoutautoteardown.md

@@ -1,37 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Connect](./foundation-comms.connect.md) &gt; [streamWithoutAutoTeardown](./foundation-comms.connect.streamwithoutautoteardown.md)
-
-## Connect.streamWithoutAutoTeardown() method
-
-> 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.
-> 
-
-> Warning: This API is now obsolete.
-> 
-> - Use `stream` instead. Will be removed in v15.
-> 
-
-Starts listening for updates on the specified resource without auto-teardown.
-
-**Signature:**
-
-```typescript
-streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string | The name of the resource to listen for updates on. |
-|  onMessage | Function | A callback function to handle received messages. |
-|  onError | Function | A callback function to handle errors. |
-|  params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ Additional parameters to pass to the server. |
-
-**Returns:**
-
-[SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
-
-An observable that emits messages received from the server.
-

package/docs/api/foundation-comms.defaultentitydatasource._initialized.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [\_initialized](./foundation-comms.defaultentitydatasource._initialized.md)
-
-## DefaultEntityDatasource.\_initialized property
-
-> 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.
-> 
-
-
-**Signature:**
-
-```typescript
-protected _initialized: boolean;
-```

package/docs/api/foundation-comms.defaultentitydatasource.cache.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [cache](./foundation-comms.defaultentitydatasource.cache.md)
-
-## DefaultEntityDatasource.cache property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-get cache(): TEntity[];
-```
-
-## Remarks
-
-In-memory entity cache.
-

package/docs/api/foundation-comms.defaultentitydatasource.disconnect.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [disconnect](./foundation-comms.defaultentitydatasource.disconnect.md)
-
-## DefaultEntityDatasource.disconnect property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-disconnect: () => void;
-```
-
-## Remarks
-
-Disconnect and reset cache.
-

package/docs/api/foundation-comms.defaultentitydatasource.entitycache.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [entityCache](./foundation-comms.defaultentitydatasource.entitycache.md)
-
-## DefaultEntityDatasource.entityCache property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-protected entityCache: TEntity[];
-```

package/docs/api/foundation-comms.defaultentitydatasource.entitymap.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [entityMap](./foundation-comms.defaultentitydatasource.entitymap.md)
-
-## DefaultEntityDatasource.entityMap property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-protected entityMap: Map<string, TEntity>;
-```

package/docs/api/foundation-comms.defaultentitydatasource.initialize.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [initialize](./foundation-comms.defaultentitydatasource.initialize.md)
-
-## DefaultEntityDatasource.initialize property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-initialize: (init: EntityDatasourceInit<TDTO, TEntity>) => Promise<boolean>;
-```
-
-## Remarks
-
-Initialize datasource.
-

package/docs/api/foundation-comms.defaultentitydatasource.initialized.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [initialized](./foundation-comms.defaultentitydatasource.initialized.md)
-
-## DefaultEntityDatasource.initialized property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-get initialized(): boolean;
-
-set initialized(value: boolean);
-```

package/docs/api/foundation-comms.defaultentitydatasource.isempty.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [isEmpty](./foundation-comms.defaultentitydatasource.isempty.md)
-
-## DefaultEntityDatasource.isEmpty property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-get isEmpty(): boolean;
-```
-
-## Remarks
-
-Cache is empty / awaiting first result.
-

package/docs/api/foundation-comms.defaultentitydatasource.mapper.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [mapper](./foundation-comms.defaultentitydatasource.mapper.md)
-
-## DefaultEntityDatasource.mapper property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-protected mapper: DTOMapper<TDTO, TEntity>;
-```

package/docs/api/foundation-comms.defaultentitydatasource.md

@@ -1,38 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md)
-
-## DefaultEntityDatasource class
-
-> 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.
-> 
-
-Default EntityDatasource DI implementation.
-
-**Signature:**
-
-```typescript
-export declare class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatasource implements EntityDatasource<TDTO, TEntity> 
-```
-**Extends:** [DefaultDatasource](./foundation-comms.defaultdatasource.md)
-
-**Implements:** [EntityDatasource](./foundation-comms.entitydatasource.md)<!-- -->&lt;TDTO, TEntity&gt;
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [\_initialized](./foundation-comms.defaultentitydatasource._initialized.md) | <code>protected</code> | boolean | **_(ALPHA)_** |
-|  [cache](./foundation-comms.defaultentitydatasource.cache.md) | <code>readonly</code> | TEntity\[\] | **_(ALPHA)_** |
-|  [disconnect](./foundation-comms.defaultentitydatasource.disconnect.md) |  | () =&gt; void | **_(ALPHA)_** |
-|  [entityCache](./foundation-comms.defaultentitydatasource.entitycache.md) | <code>protected</code> | TEntity\[\] | **_(ALPHA)_** |
-|  [entityMap](./foundation-comms.defaultentitydatasource.entitymap.md) | <code>protected</code> | Map&lt;string, TEntity&gt; | **_(ALPHA)_** |
-|  [initialize](./foundation-comms.defaultentitydatasource.initialize.md) |  | (init: [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md)<!-- -->&lt;TDTO, TEntity&gt;) =&gt; Promise&lt;boolean&gt; | **_(ALPHA)_** |
-|  [initialized](./foundation-comms.defaultentitydatasource.initialized.md) |  | boolean | **_(ALPHA)_** |
-|  [isEmpty](./foundation-comms.defaultentitydatasource.isempty.md) | <code>readonly</code> | boolean | **_(ALPHA)_** |
-|  [mapper](./foundation-comms.defaultentitydatasource.mapper.md) | <code>protected</code> | DTOMapper&lt;TDTO, TEntity&gt; | **_(ALPHA)_** |
-|  [rowId](./foundation-comms.defaultentitydatasource.rowid.md) | <code>protected</code> | string | **_(ALPHA)_** |
-|  [sourceRef](./foundation-comms.defaultentitydatasource.sourceref.md) | <code>protected</code> | string | **_(ALPHA)_** |
-|  [subscription](./foundation-comms.defaultentitydatasource.subscription.md) | <code>protected</code> | SocketSubscription | **_(ALPHA)_** |
-|  [subscriptionLoggedOff](./foundation-comms.defaultentitydatasource.subscriptionloggedoff.md) | <code>protected</code> | boolean | **_(ALPHA)_** |
-

package/docs/api/foundation-comms.defaultentitydatasource.rowid.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [rowId](./foundation-comms.defaultentitydatasource.rowid.md)
-
-## DefaultEntityDatasource.rowId property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-protected rowId: string;
-```

package/docs/api/foundation-comms.defaultentitydatasource.sourceref.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [sourceRef](./foundation-comms.defaultentitydatasource.sourceref.md)
-
-## DefaultEntityDatasource.sourceRef property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-protected sourceRef: string;
-```

package/docs/api/foundation-comms.defaultentitydatasource.subscription.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [subscription](./foundation-comms.defaultentitydatasource.subscription.md)
-
-## DefaultEntityDatasource.subscription property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-protected subscription: SocketSubscription;
-```

package/docs/api/foundation-comms.defaultentitydatasource.subscriptionloggedoff.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [subscriptionLoggedOff](./foundation-comms.defaultentitydatasource.subscriptionloggedoff.md)
-
-## DefaultEntityDatasource.subscriptionLoggedOff property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-protected subscriptionLoggedOff: boolean;
-```

package/docs/api/foundation-comms.defaultkvstorage._constructor_.md

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultKVStorage](./foundation-comms.defaultkvstorage.md) &gt; [(constructor)](./foundation-comms.defaultkvstorage._constructor_.md)
-
-## DefaultKVStorage.(constructor)
-
-> 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.
-> 
-
-Constructs a new instance of the `DefaultKVStorage` class
-
-**Signature:**
-
-```typescript
-constructor(connect: Connect, user: User, kvStorageConfig?: KVStorageConfig);
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  connect | [Connect](./foundation-comms.connect.md) |  |
-|  user | User |  |
-|  kvStorageConfig | [KVStorageConfig](./foundation-comms.kvstorageconfig.md) | _(Optional)_ |
-