@genesislcap/foundation-fdc3 14.200.1-alpha-e974201.0 → 14.202.0

package/dist/foundation-fdc3.d.ts

@@ -14,17 +14,18 @@ import { IOConnectDesktop } from '@interopio/desktop';
 import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
 import { NotificationDataRow } from '@genesislcap/foundation-notifications';
 import { NotificationListener } from '@genesislcap/foundation-ui';
+import { Observable } from 'rxjs';
 import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
 import { ViewTemplate } from '@microsoft/fast-element';
 
 /**
- * fdc3-listener listen channel config
+ * fdc3-context-listener listen channel config
  * @alpha
+ * @param channelType - string for the context channel type
+ * @param callback - async function that is called if a message with a matching context is emitted
  */
-export declare interface ChannelConfig {
+export declare interface AppChannelListenerConfig extends SystemChannelListenerConfig {
     channelName: string;
-    channelType: string;
-    callback: (any: any) => void;
 }
 
 /**
@@ -33,18 +34,31 @@ export declare interface ChannelConfig {
  */
 export declare class DefaultFDC3 implements FDC3 {
     isReady: boolean;
+    private _isReady$;
+    isReady$: Observable<true>;
+    private _currentChannel$;
+    private _currentChannel;
+    currentChannel$: Observable<Channel>;
+    isInteropFdc3: () => boolean;
     constructor();
-    private connect;
+    private init;
     addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
     findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
     findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
+    raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
     raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
     joinChannel(channelId: string): Promise<void>;
     getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
     broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
+    broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
     broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
     addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
+    addSystemChannelListener(channelType: string, callback: (any: any) => void): Promise<void>;
     getCurrentChannel(): Promise<Channel>;
+    handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
+    private broadcastMessageOnChannel;
+    private getAndUpdateCurrentChannel;
+    private handleInteropChannelChanges;
 }
 
 /**
@@ -57,6 +71,22 @@ export declare interface FDC3 {
      * @public
      */
     isReady: boolean;
+    /**
+     * Observable indicating the FDC3 API is ready.
+     * @public
+     */
+    isReady$: Observable<true>;
+    /**
+     * Check if the interop global is available.
+     * @public
+     */
+    isInteropFdc3: () => boolean;
+    /**
+     * Observable which emits the current channel
+     * When a new channel is joined a new value is emitted
+     * @public
+     */
+    currentChannel$: Observable<FDC3Channel>;
     /**
      * Adds intent listeners for the specified intents.
      * @public
@@ -78,6 +108,13 @@ export declare interface FDC3 {
      * @returns A promise that resolves with an array of all matching intents and their metadata.
      */
     findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
+    /**
+     * Raises an intent against an application based purely on the context data.
+     * @public
+     * @param context - The context to use.
+     * @returns A promise that resolves with the result of the intent resolution.
+     */
+    raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
     /**
      * Raises the specified intent with the specified context.
      * @public
@@ -107,6 +144,12 @@ export declare interface FDC3 {
      * @param payload - payload sent to the channel
      */
     broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
+    /**
+     * Broadcasts a message on the current app channel
+     * @param type - type of the channel
+     * @param payload - payload sent to the channel
+     */
+    broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
     /**
      * Helper function to broadcast message on channel in response to dispatched event
      * @param channelName - name of the channel
@@ -120,10 +163,23 @@ export declare interface FDC3 {
      * @param callback - handler to for the channel context listener
      * */
     addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
+    /**
+     * Helper function to add a context listener on to the system, aka 'color', channel with a handler for channel messages
+     * @param channelType - type of the channel
+     * @param callback - handler to for the channel context listener
+     * */
+    addSystemChannelListener(channelType: string, callback: (any: any) => void): Promise<void>;
     /**
      * Helper function to get the current channel of the application
      * */
     getCurrentChannel(): Promise<Channel>;
+    /**
+     * Helper function to add a context listener on a channel with a handler for channel messages
+     * @param channel - channel instance for getting for getting current context
+     * @param contextType - context type of the channel to listen to
+     * @param callback - handler to for the channel context listener
+     * */
+    handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
 }
 
 /**
@@ -498,29 +554,28 @@ export declare interface FDC3Context extends Context {
 export declare type FDC3ContextHandler = ContextHandler;
 
 /**
- * @public
+ * fdc3-context-listener listen to app channel context
+ * @alpha
  */
-export declare interface FDC3IntentResolution extends IntentResolution {
+export declare class Fdc3ContextListener extends Fdc3SystemChannelListener {
+    config: AppChannelListenerConfig[];
+    protected addChannelListeners(): void;
 }
 
 /**
- * @public
- */
-export declare type FDC3Intents = Intents;
-
-/**
- * fdc3-listener
+ * fdc3-system-channel-listener
+ * Util element to listen to the context on a fdc3 app channel
  * @alpha
  */
-export declare class Fdc3Listener extends Fdc3Listener_base {
+export declare class Fdc3IntentListener extends Fdc3IntentListener_base {
     fdc3: FDC3;
     intentConfig: IntentConfig[];
-    channelConfig: ChannelConfig[];
-    deepClone(): Node;
     connectedCallback(): void;
+    deepClone(): Node;
+    private addIntentListeners;
 }
 
-declare const Fdc3Listener_base: (new (...args: any[]) => {
+declare const Fdc3IntentListener_base: (new (...args: any[]) => {
     "__#1@#_container": FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
     "__#1@#_latestTokenCode": string;
     "__#1@#_hasFirstLoaded": boolean;
@@ -846,6 +901,17 @@ declare const Fdc3Listener_base: (new (...args: any[]) => {
     focus(options?: FocusOptions): void;
 }) & typeof FoundationElement;
 
+/**
+ * @public
+ */
+export declare interface FDC3IntentResolution extends IntentResolution {
+}
+
+/**
+ * @public
+ */
+export declare type FDC3Intents = Intents;
+
 /**
  * fdc3-raise-intent
  * @alpha
@@ -1189,12 +1255,353 @@ declare const Fdc3RaiseIntent_base: (new (...args: any[]) => {
 }) & typeof FoundationElement;
 
 /**
- * fdc3-listener listen intent config
+ * fdc3-system-channel-listener
+ * Util element to listen to the context on a fdc3 system channel
+ * @alpha
+ */
+export declare class Fdc3SystemChannelListener extends Fdc3SystemChannelListener_base {
+    config: SystemChannelListenerConfig[];
+    fdc3: FDC3;
+    deepClone(): Node;
+    connectedCallback(): void;
+    private channelSub;
+    protected addChannelListeners(): void;
+    disconnectedCallback(): void;
+}
+
+declare const Fdc3SystemChannelListener_base: (new (...args: any[]) => {
+    "__#1@#_container": FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
+    "__#1@#_latestTokenCode": string;
+    "__#1@#_hasFirstLoaded": boolean;
+    "__#1@#_cleanupTimeout": NodeJS.Timeout;
+    "__#1@#_shouldForceLifecycle": boolean;
+    cloneNode(deep?: boolean): Node;
+    deepClone(): Node;
+    readonly shouldRunDisconnect: boolean;
+    readonly shouldRunConnect: boolean;
+    "__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
+    "__#1@#_tryFindContainingLayout"(e: Element): FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
+    connectedCallback(): void;
+    readonly $fastController: 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;
+    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;
+    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;
+}) & typeof FoundationElement;
+
+/**
+ * fdc3-intent-listener listen intent config
  * @alpha
  */
 export declare interface IntentConfig {
     intent: string;
-    callback: (any: any) => void;
+    callback: (FDC3Context: any) => void;
 }
 
 /**
@@ -1225,4 +1632,15 @@ export declare class InteropNotificationsListener extends NotificationListener {
     protected showNotificationToast(row: NotificationDataRow): void;
 }
 
+/**
+ * System channel listener config. System channels are also known as color channels
+ * @alpha
+ * @param channelType - string for the context channel type
+ * @param callback - function that is called if a message with a matching context is emitted
+ */
+export declare interface SystemChannelListenerConfig {
+    channelType: string;
+    callback: (any: any) => void;
+}
+
 export { }

package/docs/api/foundation-fdc3.fdc3.addsystemchannellistener.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [addSystemChannelListener](./foundation-fdc3.fdc3.addsystemchannellistener.md)
+
+## FDC3.addSystemChannelListener() method
+
+Helper function to add a context listener on to the system, aka 'color', channel with a handler for channel messages
+
+**Signature:**
+
+```typescript
+addSystemChannelListener(channelType: string, callback: (any: any) => void): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  channelType | string | type of the channel |
+|  callback | (any: any) =&gt; void | handler to for the channel context listener |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/foundation-fdc3.fdc3.broadcastoncurrentchannel.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [broadcastOnCurrentChannel](./foundation-fdc3.fdc3.broadcastoncurrentchannel.md)
+
+## FDC3.broadcastOnCurrentChannel() method
+
+Broadcasts a message on the current app channel
+
+**Signature:**
+
+```typescript
+broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  payload | any | payload sent to the channel |
+|  type | string | _(Optional)_ type of the channel |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/foundation-fdc3.fdc3.currentchannel_.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [currentChannel$](./foundation-fdc3.fdc3.currentchannel_.md)
+
+## FDC3.currentChannel$ property
+
+Observable which emits the current channel When a new channel is joined a new value is emitted
+
+**Signature:**
+
+```typescript
+currentChannel$: Observable<FDC3Channel>;
+```

package/docs/api/foundation-fdc3.fdc3.handlechannelcurrentcontext.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [handleChannelCurrentContext](./foundation-fdc3.fdc3.handlechannelcurrentcontext.md)
+
+## FDC3.handleChannelCurrentContext() method
+
+Helper function to add a context listener on a channel with a handler for channel messages
+
+**Signature:**
+
+```typescript
+handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  channel | Channel \| [FDC3Channel](./foundation-fdc3.fdc3channel.md) | channel instance for getting for getting current context |
+|  contextType | string | context type of the channel to listen to |
+|  listenerCallback | (FDC3Context: any) =&gt; any |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/foundation-fdc3.fdc3.isinteropfdc3.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md)
+
+## FDC3.isInteropFdc3 property
+
+Check if the interop global is available.
+
+**Signature:**
+
+```typescript
+isInteropFdc3: () => boolean;
+```

package/docs/api/foundation-fdc3.fdc3.isready_.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [isReady$](./foundation-fdc3.fdc3.isready_.md)
+
+## FDC3.isReady$ property
+
+Observable indicating the FDC3 API is ready.
+
+**Signature:**
+
+```typescript
+isReady$: Observable<true>;
+```