@genesislcap/foundation-entity-management 11.3.0

package/dist/dts/entities/entities.d.ts

@@ -0,0 +1,550 @@
+import { ColDef } from '@ag-grid-community/core';
+import { Connect, DatasourceOptions } from '@genesislcap/foundation-comms';
+import { FASTElement } from '@microsoft/fast-element';
+/**
+ * Logger for the entity management suite
+ *
+ * @privateRemarks TODO: Should we expose a hook to set log level rather than the logger itself
+ * @internal
+ */
+export declare const logger: import("@genesislcap/foundation-utils").Logger;
+/**
+ * The attribute which is set to configure the resource that the entity manager is working with
+ *
+ * @public
+ *
+ * @example
+ * ```javascript
+ * type DatasourceConfiguration = {
+ *   criteria?: string;
+ *   fields?: string;
+ *   isSnapshot?: boolean;
+ *   maxRows?: number;
+ *   maxView?: number;
+ *   orderBy?: string;
+ *   reverse?: boolean;
+ * }
+ * ```
+ */
+export type DatasourceConfiguration = Omit<DatasourceOptions, 'resourceName' | 'request'>;
+declare const EntityManagement_base: (new (...args: any[]) => {
+    "__#1@#_containingLayout": {
+        dragging: boolean;
+    };
+    cloneNode(deep?: boolean): Node;
+    deepClone(): Node;
+    readonly shouldRunDisconnect: boolean;
+    readonly shouldRunConnect: boolean;
+    "__#1@#_tryFindContainingLayout"(e: Element): {
+        dragging: boolean;
+    };
+    connectedCallback(): void;
+    readonly $fastController: import("@microsoft/fast-element").Controller;
+    $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string, newValue: string): 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; /**
+     * The name of the resource in the backend to interact with when dispatching actions from the update/create modal
+     * @internal
+     */
+    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_1 extends Node>(node: T_1): T_1;
+    compareDocumentPosition(other: Node): number;
+    contains(other: Node): boolean;
+    getRootNode(options?: GetRootNodeOptions): Node;
+    hasChildNodes(): boolean;
+    insertBefore<T_2 extends Node>(node: T_2, child: Node): T_2;
+    isDefaultNamespace(namespace: string): boolean;
+    isEqualNode(otherNode: Node): boolean;
+    isSameNode(otherNode: Node): boolean;
+    lookupNamespaceURI(prefix: string): string;
+    lookupPrefix(namespace: string): string;
+    normalize(): void;
+    removeChild<T_3 extends Node>(child: T_3): T_3;
+    replaceChild<T_4 extends Node>(node: Node, child: T_4): T_4;
+    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; /**
+     * Sets up and opens the model to either edit or add an entity. Added as an event listener on the class when receiving the `edit-entity` event.
+     *
+     * @param e - CustomEvent where `e.detail` is used to deduce whether to edit or add an entity.
+     * @internal
+     */
+    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: PropertyIndexedKeyframes | Keyframe[], 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;
+}) & (new () => HTMLElement & FASTElement) & {
+    from<TBase extends {
+        new (): HTMLElement;
+        prototype: HTMLElement;
+    }>(BaseType: TBase): new () => InstanceType<TBase> & FASTElement;
+    define<TType extends Function>(type: TType, nameOrDef?: string | import("@microsoft/fast-element").PartialFASTElementDefinition): TType;
+};
+/**
+ * Main class which defines the entity management functionality
+ *
+ * @remarks
+ *
+ * Connects to a backend resource and wraps up a grid which is populated
+ * with entities from that resource. The different interactions that the user
+ * can perform with the entities can be configured, examples being able to
+ * update and delete entities.
+ *
+ * @public
+ *
+ * @example
+ * Example of using the entity management system to handle counterparties
+ * ```
+ * <entity-management
+ *   resourceName="ALL_COUNTERPARTYS"
+ *   title="Counterparty Management"
+ *   updateEvent="EVENT_COUNTERPARTY_MODIFY"
+ *   deleteEvent="EVENT_COUNTERPARTY_DELETE"
+ *   createEvent="EVENT_COUNTERPARTY_INSERT"
+ * ></entity-management>
+ * ```
+ * Where:<br />
+ * - the title of the grid is `Counterparty Management`<br />
+ * - the name of the resource in the database to manage is `ALL_COUNTERPARTYS`<br />
+ * - the name of the event handler for update events is `EVENT_COUNTERPARTY_MODIFY`<br />
+ * - the name of the event handler for create events is `EVENT_COUNTERPARTY_INSERT`<br />
+ * - the name of the event handler for delete events is `EVENT_COUNTERPARTY_DELETE`<br />
+ *
+ */
+export declare class EntityManagement extends EntityManagement_base {
+    /**
+     * DI connect object which is used to interact with the backend.
+     *
+     * @remarks
+     *
+     * Requires {@link @genesislcap/foundation-comms#Connect | the connect class} to be registered with the
+     * DI container
+     */
+    protected connect: Connect;
+    /**
+     * Name of the backend resource which contain the entities to manage
+     * @public
+     */
+    resourceName: string;
+    readEvent: string;
+    readEventFn: (...args: any[]) => {};
+    readonly: boolean;
+    /**
+     * Name of the event handler on the Genesis server which handles updating the entity
+     * @public
+     */
+    updateEvent: string;
+    /**
+     * Name of the event handler on the Genesis server which handles deleting the entity
+     * @public
+     */
+    deleteEvent: string;
+    /**
+     * Name of the event handler on the Genesis server which handles creating an entity
+     * @public
+     */
+    createEvent: string;
+    /**
+     * Title of the grid
+     * @public
+     */
+    title: string;
+    /**
+     * Label for the entity which has usages such as being shown in the title of the modal wen editing the entity
+     * @public
+     */
+    entityLabel: string;
+    /**
+     * This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.
+     *
+     * @remarks
+     *
+     * Setting this value will set the entity manager to persist the column states through page refreshes etc. An example of what is stored is when the user resizes or reorders columns.
+     * This value must be unique for each table in your app otherwise the persisted data will be corrupted.
+     * There is an option on the grid for the user to reset the table to the default layout if they wish.
+     * If you omit this attribute then nothing is persisted
+     * @public
+     */
+    persistColumnStateKey: string;
+    /**
+     * Array which holds the column definitions.
+     * @public
+     */
+    columns: ColDef[];
+    /**
+     * The configuration which is used when interacting with the resource on the backend
+     *
+     * @remarks
+     *
+     * Handles the configuration such as how many rows of entities to fetch at a time
+     * @public
+     */
+    datasourceConfig: DatasourceConfiguration;
+    formUiSchema: any;
+    createFormUiSchema: any;
+    updateFormUiSchema: any;
+    /**
+     * The name of the resource in the backend to interact with when dispatching actions from the update/create modal
+     * @internal
+     */
+    formResourceName: string;
+    /**
+     * Reference to the currently selected entity from the grid.
+     *
+     * @remarks
+     *
+     * When the user attempts to initiate functionality such as deleting or editing an entity, the entity which will be deleted/edited is the one which is referenced by this variable
+     * @public
+     */
+    selectedEntity: any;
+    /**
+     * Disables the form while enabled to stop the user dispatching a large number of duplicate events
+     * @public
+     */
+    editedEntity: any;
+    submitting: boolean;
+    /**
+     * String which contains the text of the popup modal when the user is adding or editing an entity
+     */
+    editDialogTitle: string;
+    editModalVisible: boolean;
+    editModalVisibleChanged(): void;
+    editEntityModal: any;
+    sizeColumnsToFit: boolean;
+    enableFilterBar: boolean;
+    enableCellFlashing: boolean;
+    /**
+     * Set up the web component
+     * @internal
+     */
+    connectedCallback(): Promise<void>;
+    /**
+     * Override the deepClone method to ensure that observable attributes are cloned
+     * @public
+     */
+    deepClone(): Node;
+    /**
+     * Event handler for when the user submits the action for the currently open form, either editing or adding the entity
+     *
+     * @param e - CustomEvent which contains the payload for the entity to submit to the backend
+     *
+     * Emits an event upon error
+     * @public
+     */
+    submitEntityChanges(e: CustomEvent): Promise<void>;
+    /**
+     * Updates the reference to the current entity stored in the class. Added as an event listener on the class when receiving the `rowSelected` event.
+     *
+     * @param e - CustomEvent which contains data about the selected entity. If the row is not selected then the reference will be set to an empty object.
+     * @internal
+     */
+    private selectEntity;
+    /**
+     * Sets up and opens the model to either edit or add an entity. Added as an event listener on the class when receiving the `edit-entity` event.
+     *
+     * @param e - CustomEvent where `e.detail` is used to deduce whether to edit or add an entity.
+     * @internal
+     */
+    private editEntity;
+    private readEntity;
+    closeModal(): void;
+    /**
+     * Handler for deleting the entity. Added as an event listener on the class when receiving the `delete-entity` event.
+     *
+     * @param e - CustomEvent where `e.detail` contains data to update the selectedEntity reference with the entity to delete.
+     * @internal
+     */
+    deleteEntity(e: CustomEvent): Promise<void>;
+    /**
+     * Show notifications if the executed event returned an error.
+     * @public
+     */
+    errorNotify(request: any): void;
+}
+export {};
+//# sourceMappingURL=entities.d.ts.map

package/dist/dts/entities/entities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/entities/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAO3E,OAAO,EAAuB,WAAW,EAAc,MAAM,yBAAyB,CAAC;AAKvF;;;;;GAKG;AACH,eAAO,MAAM,MAAM,gDAAoC,CAAC;AAExD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,iBAAiB,EAAE,cAAc,GAAG,SAAS,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mEAwHxF;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAiGH;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA/NL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAKa,gBAAiB,SAAQ,qBAA2B;IAC/D;;;;;;;OAOG;IACM,SAAS,CAAC,OAAO,EAAG,OAAO,CAAC;IAErC;;;OAGG;IACG,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,CAAC,GAAG,IAAI,OAAA,KAAK,EAAE,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAE7C;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACG,KAAK,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAM;IAE/B;;;;;;;;;;OAUG;IAC8C,qBAAqB,EAAE,MAAM,CAAC;IAE/E;;;OAGG;IACS,OAAO,EAAE,MAAM,EAAE,CAAC;IAE9B;;;;;;;OAOG;IACS,gBAAgB,EAAE,uBAAuB,CAAC;IAC1C,YAAY,EAAE,GAAG,CAAC;IAClB,kBAAkB,EAAE,GAAG,CAAC;IACxB,kBAAkB,EAAE,GAAG,CAAC;IAEpC;;;OAGG;IACS,gBAAgB,EAAE,MAAM,CAAC;IAErC;;;;;;;OAOG;IACS,cAAc,EAAE,GAAG,CAAC;IAGhC;;;OAGG;IACS,YAAY,EAAE,GAAG,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACS,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAS;IAC9C,uBAAuB;IAShB,eAAe,EAAE,GAAG,CAAC;IAEiC,gBAAgB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAE1F;;;OAGG;IACG,iBAAiB;IAYvB;;;OAGG;IACM,SAAS,IAAI,IAAI;IAc1B;;;;;;;OAOG;IACU,mBAAmB,CAAC,CAAC,EAAE,WAAW;IAI/C;;;;;OAKG;IACH,OAAO,CAAC,YAAY,CAElB;IAEF;;;;;OAKG;YACW,UAAU;IA4BxB,OAAO,CAAC,UAAU;IAMX,UAAU;IAKjB;;;;;OAKG;IACG,YAAY,CAAC,CAAC,EAAE,WAAW;IAqBjC;;;OAGG;IACI,WAAW,CAAC,OAAO,KAAA;CAsB3B"}

package/dist/dts/entities/entities.styles.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Defines the css of the entity component as an ElementStyles object
+ *
+ * @remarks
+ *
+ * Mixin to custom ElementStyles to override and customise the style of an
+ * entity manager component
+ */
+export declare const styles: import("@microsoft/fast-element").ElementStyles;
+//# sourceMappingURL=entities.styles.d.ts.map

package/dist/dts/entities/entities.styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.styles.d.ts","sourceRoot":"","sources":["../../../src/entities/entities.styles.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,iDAmBlB,CAAC"}

package/dist/dts/entities/entities.template.d.ts

@@ -0,0 +1,7 @@
+import { EntityManagement } from './entities';
+/**
+ * Defines the html of the entity component as a ViewTemplate object
+ * @typeParam EntityManagement - the {@link @genesislcap/foundation-entity-management#EntityManagement | class} the template is defined for
+ */
+export declare const template: import("@microsoft/fast-element").ViewTemplate<EntityManagement, any>;
+//# sourceMappingURL=entities.template.d.ts.map

package/dist/dts/entities/entities.template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.template.d.ts","sourceRoot":"","sources":["../../../src/entities/entities.template.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAK9C;;;GAGG;AACH,eAAO,MAAM,QAAQ,uEAoCpB,CAAC"}

package/dist/dts/entities/index.d.ts

@@ -0,0 +1,4 @@
+export * from './entities';
+export * from './entities.template';
+export * from './entities.styles';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/entities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC"}

package/dist/dts/index.d.ts

@@ -0,0 +1,5 @@
+export * from './users/users';
+export * from './profiles/profiles';
+export * from './entities/entities';
+export * from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,SAAS,CAAC"}

package/dist/dts/index.federated.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=index.federated.d.ts.map

package/dist/dts/index.federated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.federated.d.ts","sourceRoot":"","sources":["../../src/index.federated.ts"],"names":[],"mappings":""}

package/dist/dts/list/index.d.ts

@@ -0,0 +1,2 @@
+export * from './list';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/list/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/list/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC"}

package/dist/dts/list/list.d.ts

@@ -0,0 +1,29 @@
+import { ColDef } from '@ag-grid-community/core';
+import { GridProGenesisDatasource, ZeroGridPro } from '@genesislcap/foundation-zero-grid-pro';
+import { FASTElement } from '@microsoft/fast-element';
+import { DatasourceConfiguration } from '../entities/entities';
+export declare class List extends FASTElement {
+    resourceName: string;
+    title: string;
+    persistColumnStateKey: string;
+    sizeColumnsToFit: boolean;
+    enableFilterBar: boolean;
+    enableCellFlashing: boolean;
+    grid: ZeroGridPro;
+    datasource: GridProGenesisDatasource;
+    columns: ColDef[];
+    datasourceConfig: DatasourceConfiguration;
+    actionButtonsConfig: any[];
+    createEvent: string;
+    deleteEvent: string;
+    updateEvent: string;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private handleFilterChanged;
+    private handleFilterCleared;
+    private select;
+    create(): void;
+    private edit;
+    delete(e: any): Promise<void>;
+}
+//# sourceMappingURL=list.d.ts.map

package/dist/dts/list/list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../src/list/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAU,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,wBAAwB,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAC9F,OAAO,EAAuB,WAAW,EAAc,MAAM,yBAAyB,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAI/D,qBAKa,IAAK,SAAQ,WAAW;IAC7B,YAAY,EAAE,MAAM,CAAM;IAC1B,KAAK,EAAE,MAAM,CAAM;IACwB,qBAAqB,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IACnF,IAAI,EAAG,WAAW,CAAC;IACnB,UAAU,EAAG,wBAAwB,CAAC;IACjC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,gBAAgB,EAAE,uBAAuB,CAAC;IAC1C,mBAAmB,QAAM;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IAEhC,iBAAiB;IA4BjB,oBAAoB,IAAI,IAAI;IAQ5B,OAAO,CAAC,mBAAmB;IAM3B,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,MAAM;IAIP,MAAM;IAIb,OAAO,CAAC,IAAI,CAEV;IAEI,MAAM,CAAC,CAAC,KAAA;CAGf"}

package/dist/dts/list/list.styles.d.ts

@@ -0,0 +1,2 @@
+export declare const listStyles: import("@microsoft/fast-element").ElementStyles;
+//# sourceMappingURL=list.styles.d.ts.map

package/dist/dts/list/list.styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.styles.d.ts","sourceRoot":"","sources":["../../../src/list/list.styles.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,UAAU,iDAyBtB,CAAC"}