@genesislcap/foundation-comms 14.187.1 → 14.188.0

package/dist/foundation-comms.d.ts

@@ -2,8 +2,10 @@
 
 import { BehaviorSubject } from 'rxjs';
 import { default as Bowser_2 } from 'bowser';
+import { Controller } from '@microsoft/fast-element';
 import { DefaultUser } from '@genesislcap/foundation-user';
 import type { DTOMapper } from '@genesislcap/foundation-utils';
+import type { FASTElement } from '@microsoft/fast-element';
 import { InterfaceSymbol } from '@microsoft/fast-foundation';
 import { JSONSchema7 } from 'json-schema';
 import { JSONSerializer } from '@genesislcap/foundation-utils';
@@ -13,8 +15,10 @@ 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/dist/esm';
 import { Subscription as SocketSubscription } from 'rxjs';
 import { Subject } from 'rxjs';
+import { TypedBroadcastChannel } from '@genesislcap/foundation-broadcast-channel';
 import { User as User_2 } from '@genesislcap/foundation-user';
 import { UUID } from '@genesislcap/foundation-utils';
 
@@ -116,6 +120,8 @@ export declare class AuthMock implements Auth {
     login(credentials: AuthInfo): Promise<LoginResult>;
     logout(): Promise<LogoutResult>;
     reAuthFromSession(): Promise<boolean>;
+    setTestUser(properties?: Partial<SetUserProperties>): void;
+    resetTestUser(): void;
 }
 
 /**
@@ -223,10 +229,10 @@ export declare interface Connect {
     /**
      * Connects to a server at the specified host.
      * @public
-     * @param host - The host to connect to.
+     * @param host - The host to connect to. Defaults to {@link @genesislcap/foundation-utils#GENESIS_SOCKET_URL | GENESIS_SOCKET_URL}.
      * @returns A promise that resolves with a boolean indicating whether the connection was successful.
      */
-    connect(host: string): Promise<boolean>;
+    connect(host?: string): Promise<boolean>;
     /**
      * Disconnects from the server.
      * @public
@@ -328,7 +334,7 @@ export declare interface Connect {
      * @param params - An object containing optional parameters to include in the request.
      * @returns A promise that resolves to a Message containing the server's response with available resources.
      */
-    getAvailableResources(params?: RequestParams): Promise<Message>;
+    getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
     /**
      * Sends a request to the server to retrieve data or perform an action.
      * @public
@@ -337,6 +343,10 @@ export declare interface Connect {
      * @returns A promise that resolves to a Message containing the server's response.
      */
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
+    /**
+     * @returns The host provided.
+     */
+    host: string;
 }
 
 /**
@@ -471,6 +481,7 @@ export declare class ConnectMock implements Connect {
     isConnected: boolean;
     isWorking: boolean;
     socket: SocketMock;
+    get host(): string;
     get isConnectedSubject(): BehaviorSubject<boolean>;
     get isConnected$(): Observable<boolean>;
     send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
@@ -486,7 +497,7 @@ export declare class ConnectMock implements Connect {
     disconnect(): void;
     getMetadata(resourceName: string): Promise<Metadata>;
     request(resourceName: string, params?: RequestParams): Promise<Message>;
-    getAvailableResources(params?: RequestParams): Promise<Message>;
+    getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
     snapshot(resourceName: string, params?: any): Promise<Message>;
     stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
     streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
@@ -815,17 +826,16 @@ export declare function dataServerResultFilter(result: RawDataServerResult, rowI
  * @remarks
  * The public interface available on the injected store fragment.
  */
-export declare interface Datasource {
+export declare interface Datasource extends DatasourceMetadata {
     /**
-     * Indicates whether the datasource has been initialized.
      * @public
      */
-    initialized: boolean;
+    status: Partial<DatasourceStatus>;
     /**
-     * Metadata about the fields of the datasource.
+     * Indicates whether the datasource has been initialized.
      * @public
      */
-    fieldMetadata: FieldMetadata[];
+    initialized: boolean;
     /**
      * Indicates whether the datasource is read-only.
      * TODO: Should have is prefix
@@ -851,10 +861,10 @@ export declare interface Datasource {
      * Initializes the datasource with the given options and fetches metadata if specified.
      * @public
      * @param options - The options to initialize the datasource with.
-     * @param fetchMeta - Whether to fetch metadata for the datasource.
+     * @param fetchMeta - Optional flag to fetch metadata for the datasource. Defaults to true.
      * @returns A promise that resolves with a boolean indicating whether the initialization was successful.
      */
-    init(options: DatasourceOptions, fetchMeta: boolean): Promise<boolean>;
+    init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
     /**
      * Deinitializes the datasource.
      * @remarks This should be called to clean up any resources when the datasource is no longer needed.
@@ -960,22 +970,29 @@ export declare interface Datasource {
 export declare const Datasource: InterfaceSymbol<Datasource>;
 
 /**
- * The configuration object for a Datasource
+ * DatasourceConfig DI interface.
+ *
  * @public
  */
 export declare interface DatasourceConfig {
+    /**
+     * The element to emit events from.
+     *
+     * @remarks
+     * If omitted the document is used.
+     */
+    eventEmitter?: HTMLElement;
     options: DatasourceOptions;
     criteriaToFields(filters: string): Record<string, string>;
     dataServerResultFilter(result: RawDataServerResult, rowId?: string): FilteredDataServerResult;
 }
 
 /**
- * The DI token for the DatasourceConfig interface.
+ * DatasourceConfig DI key.
  *
+ * @internal
  * @privateRemarks
  * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- *
- * @internal
  */
 export declare const DatasourceConfig: InterfaceSymbol<DatasourceConfig>;
 
@@ -991,16 +1008,411 @@ export declare class DatasourceDefaults {
     static readonly REQUEST_SERVER_ROW_ID = "RECORD_ID";
 }
 
+/**
+ * Datasource event handler mixin for target classes that use or are interested in datasource status changes.
+ *
+ * @remarks
+ * Classes that use the mixin are not required to own the datasource itself, there may be several interested parties.
+ *
+ * @example
+ * ```ts
+ * import { DatasourceEventHandler, DatasourceStatus } from '@genesislcap/foundation-comms';
+ * ...
+ * class MyComponent extends DatasourceEventHandler(FASTElement) {
+ *     resourceName: string = 'some-resource';
+ *     ...
+ *     datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus) {
+ *         // Respond to changes in the target datasource.
+ *     }
+ * }
+ * ```
+ *
+ * @privateRemarks
+ * Unfortunately our datasource ui components do not share a common baseclass. Given datasource ui components contain a
+ * Datasource and currently await their `init`, usage is more for example at this point, ie. how could we allow interested
+ * parties to monitor and respond to changes, given they will exist at different levels of DOM hierarchy etc. Datasource
+ * itself is also transient DI injectable, so each interested party would not have access to the same instance, nor would
+ * we necessarily want to expose that via the event to prevent them operating on it to cause unwanted side effects.
+ *
+ * @param Target - The class to mix the event handler with.
+ *
+ * @public
+ */
+export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
+    new (): {
+        datasourceStatus: DatasourceStatus;
+        /**
+         * Classes should provide.
+         */
+        resourceName: string;
+        /**
+         * The component-level handler for datasource status changes.
+         *
+         * @remarks
+         * If implementing custom logic in the target class, please check the `event.detail.name` matches your resourceName.
+         */
+        onDatasourceStatusChanged: (event: DatasourceStatusChangedEvent) => void;
+        /**
+         * @remarks
+         * Override this method to respond to changes in the target datasource.
+         */
+        datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): 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;
+        spellcheck: boolean;
+        title: string;
+        translate: boolean;
+        attachInternals(): ElementInternals;
+        click(): void;
+        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;
+        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) => any;
+        onfullscreenerror: (this: Element, ev: Event) => 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;
+        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<E extends Element = Element>(selectors: string): E;
+        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<Element>;
+        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(namespace: string, localName: string): HTMLCollectionOf<Element>;
+        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<void>;
+        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<ChildNode>;
+        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<T extends Node>(node: T): T;
+        cloneNode(deep?: boolean): Node;
+        compareDocumentPosition(other: Node): number;
+        contains(other: Node): boolean;
+        getRootNode(options?: GetRootNodeOptions): Node;
+        hasChildNodes(): boolean;
+        insertBefore<T_1 extends Node>(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<T_2 extends Node>(child: T_2): T_2;
+        replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
+        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;
+        ariaBusy: string;
+        ariaChecked: string;
+        ariaColCount: string;
+        ariaColIndex: string;
+        ariaColIndexText: string;
+        ariaColSpan: string;
+        ariaCurrent: 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;
+        ariaRowIndexText: 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<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_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;
+        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;
+        inputMode: string;
+        readonly isContentEditable: boolean;
+        onabort: (this: GlobalEventHandlers, ev: UIEvent) => any;
+        onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
+        onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
+        onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
+        onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
+        onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
+        onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
+        oncancel: (this: GlobalEventHandlers, ev: Event) => any;
+        oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
+        oncanplaythrough: (this: GlobalEventHandlers, ev: Event) => any;
+        onchange: (this: GlobalEventHandlers, ev: Event) => any;
+        onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        onclose: (this: GlobalEventHandlers, ev: Event) => any;
+        oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
+        ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
+        ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
+        ondragenter: (this: GlobalEventHandlers, ev: DragEvent) => any;
+        ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any;
+        ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any;
+        ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any;
+        ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any;
+        ondurationchange: (this: GlobalEventHandlers, ev: Event) => any;
+        onemptied: (this: GlobalEventHandlers, ev: Event) => any;
+        onended: (this: GlobalEventHandlers, ev: Event) => any;
+        onerror: OnErrorEventHandlerNonNull;
+        onfocus: (this: GlobalEventHandlers, ev: FocusEvent) => any;
+        onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) => any;
+        ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
+        oninput: (this: GlobalEventHandlers, ev: Event) => any;
+        oninvalid: (this: GlobalEventHandlers, ev: Event) => any;
+        onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
+        onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
+        onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
+        onload: (this: GlobalEventHandlers, ev: Event) => any;
+        onloadeddata: (this: GlobalEventHandlers, ev: Event) => any;
+        onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any;
+        onloadstart: (this: GlobalEventHandlers, ev: Event) => any;
+        onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
+        onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
+        onpause: (this: GlobalEventHandlers, ev: Event) => any;
+        onplay: (this: GlobalEventHandlers, ev: Event) => any;
+        onplaying: (this: GlobalEventHandlers, ev: Event) => any;
+        onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any;
+        onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) => any;
+        onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) => any;
+        onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) => any;
+        onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) => any;
+        onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) => any;
+        onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) => any;
+        onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) => any;
+        onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
+        onratechange: (this: GlobalEventHandlers, ev: Event) => any;
+        onreset: (this: GlobalEventHandlers, ev: Event) => any;
+        onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
+        onscroll: (this: GlobalEventHandlers, ev: Event) => any;
+        onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
+        onseeked: (this: GlobalEventHandlers, ev: Event) => any;
+        onseeking: (this: GlobalEventHandlers, ev: Event) => any;
+        onselect: (this: GlobalEventHandlers, ev: Event) => any;
+        onselectionchange: (this: GlobalEventHandlers, ev: Event) => any;
+        onselectstart: (this: GlobalEventHandlers, ev: Event) => any;
+        onslotchange: (this: GlobalEventHandlers, ev: Event) => any;
+        onstalled: (this: GlobalEventHandlers, ev: Event) => any;
+        onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any;
+        onsuspend: (this: GlobalEventHandlers, ev: Event) => any;
+        ontimeupdate: (this: GlobalEventHandlers, ev: Event) => any;
+        ontoggle: (this: GlobalEventHandlers, ev: Event) => any;
+        ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
+        ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
+        ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
+        ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
+        ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
+        ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
+        ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
+        ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
+        onvolumechange: (this: GlobalEventHandlers, ev: Event) => any;
+        onwaiting: (this: GlobalEventHandlers, ev: Event) => any;
+        onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any;
+        onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any;
+        onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any;
+        onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any;
+        onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any;
+        autofocus: boolean;
+        readonly dataset: DOMStringMap;
+        nonce?: string;
+        tabIndex: number;
+        blur(): void;
+        focus(options?: FocusOptions): void;
+        readonly $fastController: Controller;
+        $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
+        attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
+    };
+};
+
+/**
+ * DatasourceMetadata interface.
+ * @public
+ */
+export declare interface DatasourceMetadata {
+    fetchMetadataRequired: boolean;
+    readonly availableIndexes: IndexDetail[];
+    readonly originalFieldDef: MetadataDetail[];
+    readonly fieldMetadata: FieldMetadata[];
+    readonly requestFields: MetadataDetail[];
+}
+
 /**
  * @internal
  */
 export declare class DatasourceMock implements Datasource {
-    initialized: boolean;
+    status: DatasourceStatus;
+    fetchMetadataRequired: boolean;
+    protected fetchingMetadata: boolean;
+    originalFieldDef: MetadataDetail[];
     fieldMetadata: FieldMetadata[];
+    requestFields: MetadataDetail[];
+    availableIndexes: IndexDetail[];
+    initialized: boolean;
     readOnly: boolean;
     resourceType: ResourceType;
     stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
     init(options: DatasourceOptions, fetchMeta: boolean): Promise<boolean>;
+    /**
+     * Convenience method to avoid you having to prime connect etc.
+     * @param meta - The metadata to set.
+     */
+    setMetadata(meta: Metadata): void;
+    unsetMedata(): void;
+    /**
+     * Convenience method to avoid you having to prime connect etc.
+     * @param message - The Message to stream.
+     */
+    setStream(message: Message): void;
+    unsetStream(): void;
     deinit(): void;
     destroy(): void;
     validResourceName(resourceName: string): boolean;
@@ -1074,6 +1486,30 @@ export declare interface DatasourceOptions {
     reverse?: boolean;
 }
 
+/**
+ * DatasourceStatus.
+ * @public
+ */
+export declare type DatasourceStatus = {
+    name: string;
+    type: `${ResourceType}`;
+    isInitialized: boolean;
+    metadataRequired: boolean;
+    hasMetadata: boolean;
+};
+
+/**
+ * DatasourceStatusChanged.
+ * @public
+ */
+export declare const DatasourceStatusChanged = "datasource-status-changed";
+
+/**
+ * DatasourceStatusChangedEvent.
+ * @public
+ */
+export declare type DatasourceStatusChangedEvent = CustomEvent<DatasourceStatus>;
+
 /**
  * Data Update definition with details of what data to add, drop, and/or modify.
  * @public
@@ -1166,6 +1602,7 @@ export declare class DefaultConnect implements Connect {
     get isConnected(): boolean;
     get isConnectedSubject(): BehaviorSubject<boolean>;
     get isConnected$(): Observable<boolean>;
+    get host(): string;
     constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
     httpMode(): boolean;
     /**
@@ -1173,7 +1610,7 @@ export declare class DefaultConnect implements Connect {
      */
     setValidSession(valid: boolean): void;
     send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
-    connect(host: string): Promise<boolean>;
+    connect(host?: string): Promise<boolean>;
     disconnect(): void;
     snapshot(resourceName: string, params?: any): Promise<Message>;
     stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
@@ -1185,7 +1622,7 @@ export declare class DefaultConnect implements Connect {
     getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
     getJSONSchema(resourceName: string, useCache?: boolean): Promise<SchemaResponse>;
     request(resourceName: string, params?: RequestParams): Promise<Message>;
-    getAvailableResources(params?: any): Promise<Message>;
+    getAvailableResources(params?: any): Promise<ResourcesMessage>;
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
 }
 
@@ -1282,33 +1719,56 @@ export declare const defaultCredentialRequestOptions: GetCredentialOptions;
 export declare class DefaultDatasource implements Datasource {
     protected connect: Connect;
     protected auth: Auth;
+    protected resources: GenesisResources;
     protected config: DatasourceConfig;
-    initialized: boolean;
+    /**
+     * {@inheritDoc Datasource.status}
+     */
+    status: DatasourceStatus;
+    /** {@inheritDoc DatasourceMetadata.fetchMetadataRequired} */
+    fetchMetadataRequired: boolean;
+    /** {@inheritDoc DatasourceMetadata.originalFieldDef} */
+    originalFieldDef: MetadataDetail[];
+    /** {@inheritDoc DatasourceMetadata.fieldMetadata} */
+    fieldMetadata: FieldMetadata[];
+    /** {@inheritDoc DatasourceMetadata.requestFields} */
+    requestFields: MetadataDetail[];
+    /** {@inheritDoc DatasourceMetadata.availableIndexes} */
+    availableIndexes: IndexDetail[];
+    /** {@inheritDoc Datasource.initialized} */
+    get initialized(): boolean;
     readOnly: boolean;
     protected options: DatasourceOptions;
     resourceType: ResourceType;
-    protected _stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
-    protected originalFieldDef: MetadataDetail[];
-    protected requestFields: MetadataDetail[];
-    fieldMetadata: FieldMetadata[];
-    protected availableIndexes: IndexDetail[];
-    constructor(connect: Connect, auth: Auth, config?: DatasourceConfig);
+    stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
+    constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig);
+    /**
+     * @deprecated - Please use {@link (GenesisResources:interface).isValidResource} instead.
+     */
     validResourceName(resourceName: string): boolean;
     init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
     deinit(): void;
     /** {@inheritDoc Datasource.destroy} */
     destroy(): void;
-    get stream(): SocketObservable<FilteredDataServerResult | RequestServerResult>;
     get params(): any;
     snapshot(): Promise<Message>;
     snapshotFiltered(rowId?: string): Promise<any[]>;
     private createStream;
     private createDataserverStream;
     private createReqRepStream;
+    protected fetchAndApplyMetadata(resourceName: string): Promise<void>;
+    /**
+     * @internal
+     */
+    protected reportStatus(detail?: Partial<DatasourceStatus>): void;
+    /**
+     * @internal
+     */
+    protected normaliseStatus(status: Partial<DatasourceStatus>): DatasourceStatus;
 }
 
 /**
- * The default configuration for the Datasource service.
+ * Default DatasourceConfig DI implementation.
  * @public
  */
 export declare const defaultDatasourceConfig: DatasourceConfig;
@@ -1327,7 +1787,9 @@ export declare class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatas
     protected entityMap: Map<string, TEntity>;
     protected rowId: string;
     /** {@inheritDoc EntityDatasource.initialized} */
-    initialized: boolean;
+    protected _initialized: boolean;
+    get initialized(): boolean;
+    set initialized(value: boolean);
     /** {@inheritDoc EntityDatasource.initialize} */
     initialize: (init: EntityDatasourceInit<TDTO, TEntity>) => Promise<boolean>;
     /** {@inheritDoc EntityDatasource.cache} */
@@ -1362,6 +1824,32 @@ export declare class DefaultFoundationAnalytics implements FoundationAnalytics {
     trackEvent(eventName: FoundationAnalyticsEventType.routeChanged, payload: FoundationAnalyticsEvent.RouteChanged): void;
 }
 
+/**
+ * Default GenesisResources implementation.
+ * @public
+ */
+export declare class DefaultGenesisResources implements GenesisResources {
+    protected connect: Connect;
+    protected config: GenesisResourcesConfig;
+    protected resources: ResourceItem[];
+    protected resourcesPromise: Promise<ResourcesMessage>;
+    constructor(connect: Connect, config: GenesisResourcesConfig);
+    /** {@inheritDoc GenesisResources.isValidResource} */
+    isValidResource(resourceName: string): Promise<boolean>;
+    /** {@inheritDoc GenesisResources.getResourceTypeFor} */
+    getResourceTypeFor(resourceName: string): Promise<ResourceType>;
+    /** {@inheritDoc GenesisResources.destroy} */
+    destroy(): void;
+    protected getResources(): Promise<void>;
+    protected postLoadedMessage(): void;
+}
+
+/**
+ * Default GenesisResourcesConfig implementation.
+ * @public
+ */
+export declare const defaultGenesisResourcesConfig: GenesisResourcesConfig;
+
 /**
  * The default implementation of the Http interface.
  * @public
@@ -1421,7 +1909,7 @@ export declare class DefaultHttpConnect implements Connect {
     getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
     getJSONSchema(resourceName: string): Promise<SchemaResponse>;
     request(resourceName: string, params?: RequestParams): Promise<Message>;
-    getAvailableResources(params?: any): Promise<Message>;
+    getAvailableResources(params?: any): Promise<ResourcesMessage>;
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
     private maybeTurbo;
     private updateIntervals;
@@ -1749,6 +2237,7 @@ export declare class DefaultSocket implements Socket {
      * Temp putting the user in place to bridge the hasValidSession logic.
      */
     protected user: User_2;
+    protected config: ConnectConfig;
     private readonly defaultInterval;
     private readonly secondsMultiplier;
     private websocket;
@@ -1764,6 +2253,7 @@ export declare class DefaultSocket implements Socket {
     /** {@inheritDoc SerializedSocketStatus.hasValidSession} */
     get hasValidSession(): boolean;
     set hasValidSession(value: boolean);
+    get host(): string;
     private heartbeatIsEnabled;
     private heartbeatInterval;
     private heartbeatTicker;
@@ -1775,10 +2265,10 @@ export declare class DefaultSocket implements Socket {
     /**
      * Temp putting the user in place to bridge the hasValidSession logic.
      */
-    user: User_2);
+    user: User_2, config: ConnectConfig);
     private get heartbeatLoggingIsEnabled();
     private get messageLoggingIsEnabled();
-    connect(host: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
+    connect(host?: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
     private prepareHeartbeat;
     private reconnect;
     reset(): void;
@@ -1886,12 +2376,7 @@ export declare class DefaultSocketStatus implements SocketStatus {
  *
  * @alpha
  */
-export declare interface EntityDatasource<TDTO, TEntity> {
-    /**
-     * @remarks
-     * Datasource initialized.
-     */
-    readonly initialized: boolean;
+export declare interface EntityDatasource<TDTO, TEntity> extends Datasource {
     /**
      * @remarks
      * Initialize datasource.
@@ -1955,6 +2440,8 @@ export declare enum EventMessageType {
     META_REQUEST = "META_REQUEST",
     JSON_SCHEMA_REQUEST = "JSON_SCHEMA_REQUEST",
     RESOURCES_REQUEST = "RESOURCES_REQUEST",
+    RESOURCES_REQUEST_ACK = "RESOURCES_REQUEST_ACK",
+    RESOURCES_REQUEST_NACK = "RESOURCES_REQUEST_NACK",
     EVENT_CHANGE_USER_PASSWORD = "EVENT_CHANGE_USER_PASSWORD",
     EVENT_SELF_SERVICE_PASSWORD_RESET = "EVENT_SELF_SERVICE_PASSWORD_RESET",
     EVENT_PASSWORD_RESET_ACTION = "EVENT_PASSWORD_RESET_ACTION"
@@ -2092,6 +2579,118 @@ export declare enum FoundationAnalyticsEventType {
  */
 export declare type GenesisConnectEvents = 'stream' | 'commit';
 
+/**
+ * GenesisResources DI interface.
+ * @remarks
+ * A lazy shared Genesis Resources lookup system. N number of callers can request information in succession, but only
+ * the first will invoke the server request, and each caller will receive their results when that returns.
+ * @public
+ */
+export declare interface GenesisResources {
+    /**
+     * Checks if the resource exists
+     * @param resourceName - The name of the resource to check.
+     */
+    isValidResource: (resourceName: string) => Promise<boolean>;
+    /**
+     * Gets the type of resource
+     * @param resourceName - The name of the resource to get the type for.
+     */
+    getResourceTypeFor: (resourceName: string) => Promise<ResourceType>;
+    /**
+     * Destroy and garbage collect
+     */
+    destroy: () => void;
+}
+
+/**
+ * GenesisResources DI key.
+ * @internal
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ */
+export declare const GenesisResources: InterfaceSymbol<GenesisResources>;
+
+/**
+ * GenesisResourcesChannel DI interface.
+ * @example
+ * ```ts
+ * import { GenesisResourcesChannel } from '@genesislcap/foundation-comms';
+ * ...
+ * @GenesisResourcesChannel protected channel: GenesisResourcesChannel;
+ * ...
+ * this.channel.onmessage = (e) => {
+ *  if (this.channel.isMessageType('resources-loaded', e)) {
+ *    logger.debug('resources-loaded', e.data.detail);
+ *    return;
+ *  }
+ * }
+ * ...
+ * this.channel.close();
+ * ```
+ * @public
+ */
+export declare interface GenesisResourcesChannel extends TypedBroadcastChannel<GenesisResourcesEvents> {
+}
+
+/**
+ * GenesisResourcesChannel DI key.
+ * @internal
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ */
+export declare const GenesisResourcesChannel: InterfaceSymbol<TypedBroadcastChannel<GenesisResourcesEvents>>;
+
+/**
+ * @public
+ */
+export declare const GenesisResourcesChannelId = "genesis-resources";
+
+/**
+ * GenesisResourcesConfig DI interface.
+ * @public
+ */
+export declare interface GenesisResourcesConfig {
+    /**
+     * Treat unavailable/empty genesis resource sets as fatal errors.
+     */
+    throwWhenUnavailable?: boolean;
+    /**
+     * Treat unknown resources as fatal errors.
+     */
+    throwWhenUnknown?: boolean;
+}
+
+/**
+ * GenesisResourcesConfig DI key.
+ * @internal
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ */
+export declare const GenesisResourcesConfig: InterfaceSymbol<GenesisResourcesConfig>;
+
+/**
+ * @public
+ */
+export declare type GenesisResourcesEvents = {
+    'resources-loaded': ResourceItem[];
+    'resources-unloaded': void;
+};
+
+/**
+ * @public
+ */
+export declare class GenesisResourcesMock implements GenesisResources {
+    resources: ResourceItem[];
+    nextIsValidResourceResponse: boolean;
+    nextResourceTypeForResponse: ResourceType;
+    /** {@inheritDoc GenesisResources.isValidResource} */
+    isValidResource(resourceName: string): Promise<boolean>;
+    /** {@inheritDoc GenesisResources.getResourceTypeFor} */
+    getResourceTypeFor(resourceName: string): Promise<ResourceType>;
+    destroy(): void;
+}
+
 /**
  * Get Connect from the DI container.
  *
@@ -2150,6 +2749,47 @@ export declare type GetCredentialOptions = CredentialRequestOptions & {};
  */
 export declare function getDatasource(): Datasource;
 
+/**
+ * Gets GenesisResources from the DI container.
+ *
+ * @remarks
+ * A utility method for host applications that are not using decorators or the DI container.
+ *
+ * @example
+ * ```ts
+ * import { getGenesisResources } from '@genesislcap/foundation-comms';
+ * ...
+ * const genesisResources = getGenesisResources();
+ * ```
+ * @public
+ */
+export declare function getGenesisResources(): GenesisResources;
+
+/**
+ * Gets GenesisResourcesChannel from the DI container.
+ *
+ * @remarks
+ * A utility method for host applications that are not using decorators or the DI container.
+ *
+ * @example
+ * ```ts
+ * import { getGenesisResourcesChannel } from '@genesislcap/foundation-comms';
+ * ...
+ * const channel = getGenesisResourcesChannel();
+ * ...
+ * channel.onmessage = (e) => {
+ *  if (channel.isMessageType('resources-loaded', e)) {
+ *    logger.debug('resources-loaded', e.data.detail);
+ *    return;
+ *  }
+ * }
+ * ...
+ * channel.close();
+ * ```
+ * @public
+ */
+export declare function getGenesisResourcesChannel(): GenesisResourcesChannel;
+
 /**
  * Gets KVStorage from the DI container.
  *
@@ -3274,6 +3914,23 @@ export declare type ResourceHealth = MonitoredResourceChecksResult & {
     lastError?: any;
 };
 
+/**
+ * @public
+ */
+export declare type ResourceItem = {
+    RESOURCE_NAME: string;
+    RESOURCE_TYPE: string;
+};
+
+/**
+ * @public
+ */
+export declare type ResourcesMessage = {
+    MESSAGE_TYPE: EventMessageType.RESOURCES_REQUEST_ACK | EventMessageType.RESOURCES_REQUEST_NACK | MessageType.MSG_NACK;
+    SOURCE_REF: string;
+    RESOURCES: ResourceItem[];
+};
+
 /**
  * Types of Genesis resources.
  * @public
@@ -3534,6 +4191,7 @@ export declare interface Socket extends Omit<SocketStatus, 'serialize' | 'onClos
      */
     sendForStreamWithoutTeardown<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
     socketMessages(): SocketSubject<Message>;
+    host: string;
 }
 
 /**
@@ -3653,6 +4311,7 @@ export declare class SocketMock implements Socket {
     isConnected: boolean;
     isConnectedSubject: BehaviorSubject<boolean>;
     isReconnecting: boolean;
+    host: string;
     nextMessage: Message;
     socketMessagesSubject: SocketSubject<Message<any>>;
     connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;