@genesislcap/foundation-events 14.67.1 → 14.67.3

package/README.md

@@ -1,5 +1,9 @@
 # Genesis Foundation Events
 
+`foundation-events` contains strongly typed [event emitting utilities](./src/eventEmitter/README.md) and interfaces.
+
+### [API Docs](./docs/api/index.md)
+
 - Contains [event emitting utilities](./src/eventEmitter/README.md).
 - Contains common system level:
   - Custom event types
@@ -89,4 +93,4 @@ To denote the type of "statistic":
 Note: this project provides front end dependencies and uses licensed components listed in the next section, thus licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
-Genesis low-code platform
+Genesis low-code platform

package/dist/dts/eventEmitter/eventEmitterDI.d.ts

@@ -1,16 +1,55 @@
 import { EmitOptions, EmitOrigin, EmitReturn, EventDetailMap } from '../types';
 /**
- * Base DI key of a strongly typed store event emitter with event type to event detail pairings.
- * This is closely related to the EventEmitter mixin in terms of functionality, however its purpose is a bit different.
- * You can create optional EventEmitters for your store that can be injected anywhere, and that emitter can emit an
- * allowed / typed event from an origin html element, without that element needing to be a FAST element.
+ * EventEmitterDI interface.
+ *
+ * @remarks
+ * A strongly typed event emitter with events typed to {@link EventDetailMap} pairings. This is closely related to the
+ * {@link EventEmitter} mixin in terms of functionality, however its purpose is different. This allows you to create
+ * pre-configured EventEmitters that can be injected anywhere. These can emit typed events from an origin html element,
+ * without that element needing to be an actual {@link @microsoft/fast-element#FASTElement | FASTElement}. If you are
+ * starting out, we recommend using the {@link EventEmitter} mixin where possible.
+ *
+ * @example Create an emitter within the DI.
+ * ```ts
+ * import {registerEmitter} from '@genesislcap/foundation-events';
+ * ...
+ * export const MyEventEmitter = registerEmitter<MyEventDetailMap>();
+ * ```
+ *
+ * @example Use that emitter.
+ * ```ts
+ * export class MyComponent extends FASTElement {
+ *   @observable someElement!: HTMLElement;
+ *   @MyEventEmitter emitter: MyEventEmitter;
+ *   connectedCallback() {
+ *     this.emitter.emit(this.someElement, 'some-event', {foo: 'bar'});
+ *   }
+ * }
+ * ```
+ *
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @public
  */
 export interface EventEmitterDI<TEventDetailMap extends EventDetailMap> {
     emit<K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ? [origin: EmitOrigin, type: K, options?: EmitOptions] : [origin: EmitOrigin, type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
 }
+/**
+ * Default EventEmitterDI.
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @public
+ */
 export declare class DefaultEventEmitterDI<TEventDetailMap extends EventDetailMap> implements EventEmitterDI<TEventDetailMap> {
     emit<K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ? [origin: EmitOrigin, type: K, options?: EmitOptions] : [origin: EmitOrigin, type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
 }
+/**
+ * EventEmitterDI DI key.
+ * @internal
+ */
 export declare const EventEmitterDI: import("@microsoft/fast-foundation").InterfaceSymbol<EventEmitterDI<EventDetailMap>>;
+/**
+ * Register an emitter with the DI.
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @public
+ */
 export declare const registerEmitter: <TEventDetailMap extends EventDetailMap>() => import("@microsoft/fast-foundation").InterfaceSymbol<EventEmitterDI<TEventDetailMap>>;
 //# sourceMappingURL=eventEmitterDI.d.ts.map

package/dist/dts/eventEmitter/eventEmitterDI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eventEmitterDI.d.ts","sourceRoot":"","sources":["../../../src/eventEmitter/eventEmitterDI.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAmB,MAAM,UAAU,CAAC;AAEhG;;;;;GAKG;AAEH,MAAM,WAAW,cAAc,CAAC,eAAe,SAAS,cAAc;IACpE,IAAI,CAAC,CAAC,SAAS,MAAM,eAAe,EAClC,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GACpD,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GACnF,UAAU,CAAC;CACf;AAED,qBAAa,qBAAqB,CAAC,eAAe,SAAS,cAAc,CACvE,YAAW,cAAc,CAAC,eAAe,CAAC;IAE1C,IAAI,CAAC,CAAC,SAAS,MAAM,eAAe,EAClC,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GACpD,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GACnF,UAAU;CAKd;AAED,eAAO,MAAM,cAAc,sFAE1B,CAAC;AAEF,eAAO,MAAM,eAAe,qIAE3B,CAAC"}
+{"version":3,"file":"eventEmitterDI.d.ts","sourceRoot":"","sources":["../../../src/eventEmitter/eventEmitterDI.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAmB,MAAM,UAAU,CAAC;AAEhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,WAAW,cAAc,CAAC,eAAe,SAAS,cAAc;IACpE,IAAI,CAAC,CAAC,SAAS,MAAM,eAAe,EAClC,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GACpD,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GACnF,UAAU,CAAC;CACf;AAED;;;;GAIG;AACH,qBAAa,qBAAqB,CAAC,eAAe,SAAS,cAAc,CACvE,YAAW,cAAc,CAAC,eAAe,CAAC;IAE1C,IAAI,CAAC,CAAC,SAAS,MAAM,eAAe,EAClC,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GACpD,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GACnF,UAAU;CAKd;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,sFAE1B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,qIAE3B,CAAC"}

package/dist/dts/eventEmitter/eventEmitterMixin.d.ts

@@ -1,319 +1,59 @@
-import { ConstructableTypedEventEmitter, EmitOptions, EmitReturn, EventDetailMap } from '../types';
-export declare const EventEmitter: <TEventDetailMap extends EventDetailMap>(Base: ConstructableTypedEventEmitter) => {
-    new (...args: any[]): {
-        $emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
-        readonly $fastController: import("@microsoft/fast-element").Controller;
-        connectedCallback(): 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_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | AddEventListenerOptions): void;
-        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
-        removeEventListener<K_2 extends keyof HTMLElementEventMap>(type: K_2, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_2]) => 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_3 extends keyof HTMLElementTagNameMap>(selector: K_3): HTMLElementTagNameMap[K_3];
-        closest<K_4 extends keyof SVGElementTagNameMap>(selector: K_4): SVGElementTagNameMap[K_4];
-        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_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(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_7 extends keyof HTMLElementTagNameMap>(selectors: K_7): HTMLElementTagNameMap[K_7];
-        querySelector<K_8 extends keyof SVGElementTagNameMap>(selectors: K_8): SVGElementTagNameMap[K_8];
-        querySelector<E_1 extends Element = Element>(selectors: string): E_1;
-        querySelectorAll<K_9 extends keyof HTMLElementTagNameMap>(selectors: K_9): NodeListOf<HTMLElementTagNameMap[K_9]>;
-        querySelectorAll<K_10 extends keyof SVGElementTagNameMap>(selectors: K_10): NodeListOf<SVGElementTagNameMap[K_10]>;
-        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;
-    };
+import { FASTElement } from '@microsoft/fast-element';
+import { EmitOptions, EmitReturn, EventDetailMap, EventEmitterTarget } from '../types';
+/**
+ * EventEmitter mixin.
+ *
+ * @remarks
+ * Strongly types the components `$emit` method, allowing only the mapped events to be emitted.
+ *
+ * @example
+ * Apply mixin to the base {@link @microsoft/fast-element#FASTElement | FASTElement}
+ *
+ * # Import
+ * ```ts
+ * import { EventEmitter, SomeSystemLevelEventDetailMap } from '@genesislcap/foundation-events';
+ * import { StoreEventDetailMap, TradeEntryEventDetailMap } from '../store'; // < custom app level event maps
+ * ```
+ *
+ * # Create event map
+ * ```ts
+ * type EventMap = SomeSystemLevelEventDetailMap & StoreEventDetailMap & TradeEntryEventDetailMap;
+ * ```
+ *
+ * # Apply Mixin
+ * ```ts
+ * export class MyComponent extends EventEmitter<EventMap>(FASTElement) {
+ *   onSomeComponentEvent() {
+ *     this.$emit('some-allowed-event', { foo: 'expected data structure' });
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * Apply mixin to a class in the inheritance chain requires a second generic type param.
+ *
+ * # Apply Mixin to MyComponent that extends MyBaseComponent (which might be abstract). Mixin can be applied at different levels.
+ * # Please note there's a current limitation on retaining protected member access with this approach, so apply to base where possible.
+ * # Also, super classes cannot emit typed events via inheritance. Each level must have an explicit map. Devs can use a Union and Pick to create these.
+ * ```ts
+ * export class MyComponent extends EventEmitter<EventMap, MyBaseComponent>(MyBaseComponent) {}
+ * ```
+ *
+ * @privateRemarks
+ * Failed to retain protected member access when the mixin is applied while keeping the typed emitter, we can revisit if needed.
+ * So in the last example, if `MyBaseComponent` had a protected member, `MyComponent` wouldn't be able to access it with the mixin
+ * applied. Public members are fine. It may be a limitation of TypeScript. Suggestions welcome, but be warned it's a time sink.
+ *
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @typeParam TTarget - The target class.
+ * @param Target - The class to apply the mixin to which ultimately extends {@link @microsoft/fast-element#FASTElement | FASTElement}.
+ * @public
+ */
+export declare const EventEmitter: <TEventDetailMap extends EventDetailMap, TTarget extends FASTElement = FASTElement>(Target: EventEmitterTarget<TTarget>) => abstract new (...args: any[]) => {
+    $emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
+    readonly $fastController: import("@microsoft/fast-element").Controller;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
 };
 //# sourceMappingURL=eventEmitterMixin.d.ts.map

package/dist/dts/eventEmitter/eventEmitterMixin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eventEmitterMixin.d.ts","sourceRoot":"","sources":["../../../src/eventEmitter/eventEmitterMixin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,8BAA8B,EAC9B,WAAW,EACX,UAAU,EACV,cAAc,EAEf,MAAM,UAAU,CAAC;AAElB,eAAO,MAAM,YAAY,iDACjB,8BAA8B;;qMAO/B,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAId,CAAC"}
+{"version":3,"file":"eventEmitterMixin.d.ts","sourceRoot":"","sources":["../../../src/eventEmitter/eventEmitterMixin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EACL,WAAW,EACX,UAAU,EACV,cAAc,EACd,kBAAkB,EAGnB,MAAM,UAAU,CAAC;AAElB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,eAAO,MAAM,YAAY;iMAYlB,UAAU;;;;;CAMhB,CAAC"}

package/dist/dts/index.d.ts

@@ -1,3 +1,4 @@
 export * from './eventEmitter';
 export * from './types';
+export * from './utils';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}

package/dist/dts/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.9"
+    }
+  ]
+}

package/dist/dts/types.d.ts

@@ -1,36 +1,104 @@
 import { Binding, Constructable, ExecutionContext, FASTElement } from '@microsoft/fast-element';
+/**
+ * @remarks
+ * Using `abstract` here should cover mixing into both concrete and abstract classes.
+ * @public
+ */
+export type EventEmitterTarget<TBase extends FASTElement> = abstract new (...args: any[]) => TBase;
+/**
+ * @deprecated - Use {@link EventEmitterTarget} type instead.
+ * @public
+ */
 export type ConstructableTypedEventEmitter = Constructable<FASTElement & HTMLElement>;
+/**
+ * @public
+ */
 export type EmitOptions = Omit<CustomEventInit, 'detail'>;
+/**
+ * @public
+ */
 export type EmitReturn = boolean | void;
+/**
+ * @public
+ */
 export type EmitArgs = [string, {} | undefined, EmitOptions | undefined];
+/**
+ * @public
+ */
 export type EmitOrigin = FASTElement;
+/**
+ * @public
+ */
 export type EventDetailMap = Record<string, unknown>;
-export type EventListenerMap<TEventDetailMap extends EventDetailMap> = {
-    [K in keyof TEventDetailMap]: EventListener;
-};
+/**
+ * @public
+ */
+export interface TypedEmitter<TEventDetailMap extends EventDetailMap> {
+    $emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
+}
+/**
+ * @public
+ */
 export type CustomEventMap<TEventDetailMap extends EventDetailMap> = {
     [K in keyof TEventDetailMap]: CustomEvent<TEventDetailMap[K]>;
 };
+/**
+ * @public
+ */
 export declare const getBaseEmitArgs: (...args: unknown[]) => EmitArgs;
+/**
+ * @public
+ */
 export declare const customEvent: <TEventDetail = void>(ctx: ExecutionContext) => CustomEvent<TEventDetail>;
+/**
+ * @internal
+ */
 type ValueGetter = (ctx: ExecutionContext) => any;
+/**
+ * @public
+ */
 export declare const targetValue: ValueGetter;
+/**
+ * @public
+ */
 export declare const targetFirstSelectedValue: ValueGetter;
 /**
- * Template emit helpers for input and select elements:
+ * @public
+ */
+export type KeysMatching<T, V> = {
+    [K in keyof T]-?: T[K] extends V ? K : never;
+}[keyof T];
+/**
+ * `<input>` template emit helper.
  *
+ * @remarks
  * In some.template.ts file you create the helper upfront by passing in the full event map.
  *
+ * @example
+ * ```ts
  * const inputEmit = createInputEmitter<EventMap>();
- * const selectEmit = createSelectEmitter<EventMap>();
- *
+ * ...
  * <zero-text-field @change="${inputEmit('some-input-changed')}">
- * <zero-select @change="${selectEmit('some-select-changed')}">
+ * ```
+ *
+ * @public
  */
-export type KeysMatching<T, V> = {
-    [K in keyof T]-?: T[K] extends V ? K : never;
-}[keyof T];
 export declare const createInputEmitter: <TEventDetailMap extends EventDetailMap>() => <K extends KeysMatching<TEventDetailMap, string>>(type: K, options?: EmitOptions) => Binding;
+/**
+ * `<select>` template emit helper.
+ *
+ * @remarks
+ * In some.template.ts file you create the helper upfront by passing in the full event map.
+ *
+ * @example
+ * ```ts
+ * const selectEmit = createSelectEmitter<EventMap>();
+ * ...
+ * <zero-select @change="${selectEmit('some-select-changed')}">
+ * ```
+ *
+ * @public
+ */
 export declare const createSelectEmitter: <TEventDetailMap extends EventDetailMap>() => <K extends KeysMatching<TEventDetailMap, string>>(type: K, options?: EmitOptions) => Binding;
 export {};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAGhG,MAAM,MAAM,8BAA8B,GAAG,aAAa,CAAC,WAAW,GAAG,WAAW,CAAC,CAAC;AACtF,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;AAC1D,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,IAAI,CAAC;AACxC,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,SAAS,EAAE,WAAW,GAAG,SAAS,CAAC,CAAC;AACzE,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAErC,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACrD,MAAM,MAAM,gBAAgB,CAAC,eAAe,SAAS,cAAc,IAAI;KACpE,CAAC,IAAI,MAAM,eAAe,GAAG,aAAa;CAC5C,CAAC;AACF,MAAM,MAAM,cAAc,CAAC,eAAe,SAAS,cAAc,IAAI;KAClE,CAAC,IAAI,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;CAC9D,CAAC;AAOF,eAAO,MAAM,eAAe,YAAa,OAAO,EAAE,aAWjD,CAAC;AAEF,eAAO,MAAM,WAAW,6BAA8B,gBAAgB,8BAC9B,CAAC;AAEzC,KAAK,WAAW,GAAG,CAAC,GAAG,EAAE,gBAAgB,KAAK,GAAG,CAAC;AAElD,eAAO,MAAM,WAAW,EAAE,WAAwE,CAAC;AAEnG,eAAO,MAAM,wBAAwB,EAAE,WACmB,CAAC;AAE3D;;;;;;;;;;GAUG;AAEH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,MAAM,CAAC,CAAC,CAAC;AAO3F,eAAO,MAAM,kBAAkB,qHAJwC,WAAW,KAAG,OAKlC,CAAC;AAEpD,eAAO,MAAM,mBAAmB,qHAPuC,WAAW,KAAG,OAQrB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAGhG;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,KAAK,SAAS,WAAW,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC;AAEnG;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,aAAa,CAAC,WAAW,GAAG,WAAW,CAAC,CAAC;AAEtF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,IAAI,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,SAAS,EAAE,WAAW,GAAG,SAAS,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,eAAe,SAAS,cAAc;IAClE,KAAK,CAAC,CAAC,SAAS,MAAM,eAAe,GAAG,MAAM,EAC5C,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GACpC,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GAChC,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GAC/D,UAAU,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,eAAe,SAAS,cAAc,IAAI;KAClE,CAAC,IAAI,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;CAC9D,CAAC;AAUF;;GAEG;AACH,eAAO,MAAM,eAAe,YAAa,OAAO,EAAE,aAWjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,6BAA8B,gBAAgB,8BAC9B,CAAC;AAEzC;;GAEG;AACH,KAAK,WAAW,GAAG,CAAC,GAAG,EAAE,gBAAgB,KAAK,GAAG,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,WAAwE,CAAC;AAEnG;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,WACmB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,MAAM,CAAC,CAAC,CAAC;AAW3F;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kBAAkB,qHAnBwC,WAAW,KAAG,OAoBlC,CAAC;AAEpD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB,qHArCuC,WAAW,KAAG,OAsCrB,CAAC"}

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

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

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

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

package/dist/dts/utils/logger.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @public
+ */
+export declare const logger: import("@genesislcap/foundation-utils").Logger;
+//# sourceMappingURL=logger.d.ts.map

package/dist/dts/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/utils/logger.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,MAAM,gDAAoC,CAAC"}