@genesislcap/foundation-fdc3 14.199.2 → 14.200.0-FUI-2127.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/dist/dts/fdc3-channel-event.d.ts.map +1 -1
  2. package/dist/dts/fdc3.d.ts +57 -1
  3. package/dist/dts/fdc3.d.ts.map +1 -1
  4. package/dist/dts/index.d.ts +6 -0
  5. package/dist/dts/index.d.ts.map +1 -1
  6. package/dist/dts/notifications/interop-notifications-listener.d.ts.map +1 -1
  7. package/dist/dts/util/fdc3-context-listener.d.ts +7 -337
  8. package/dist/dts/util/fdc3-context-listener.d.ts.map +1 -1
  9. package/dist/dts/util/{fdc3-listener.d.ts → fdc3-intent-listener.d.ts} +6 -19
  10. package/dist/dts/util/fdc3-intent-listener.d.ts.map +1 -0
  11. package/dist/dts/util/fdc3-system-channel-listener.d.ts +348 -0
  12. package/dist/dts/util/fdc3-system-channel-listener.d.ts.map +1 -0
  13. package/dist/dts/util/index.d.ts +0 -1
  14. package/dist/dts/util/index.d.ts.map +1 -1
  15. package/dist/esm/fdc3-channel-event.js +6 -1
  16. package/dist/esm/fdc3.js +99 -16
  17. package/dist/esm/index.js +1 -0
  18. package/dist/esm/util/fdc3-context-listener.js +10 -30
  19. package/dist/esm/util/fdc3-intent-listener.js +48 -0
  20. package/dist/esm/util/fdc3-system-channel-listener.js +55 -0
  21. package/dist/esm/util/index.js +0 -1
  22. package/dist/foundation-fdc3.api.json +384 -0
  23. package/dist/foundation-fdc3.d.ts +57 -358
  24. package/docs/api/foundation-fdc3.fdc3.addsystemchannellistener.md +25 -0
  25. package/docs/api/foundation-fdc3.fdc3.broadcastoncurrentchannel.md +25 -0
  26. package/docs/api/foundation-fdc3.fdc3.currentchannel_.md +13 -0
  27. package/docs/api/foundation-fdc3.fdc3.handlechannelcurrentcontext.md +26 -0
  28. package/docs/api/foundation-fdc3.fdc3.isinteropfdc3.md +13 -0
  29. package/docs/api/foundation-fdc3.fdc3.isready_.md +13 -0
  30. package/docs/api/foundation-fdc3.fdc3.md +7 -0
  31. package/docs/api/foundation-fdc3.fdc3.raiseintentforcontext.md +26 -0
  32. package/docs/api-report.md +22 -34
  33. package/package.json +17 -15
  34. package/test/fdc3.mock.ts +13 -9
  35. package/dist/dts/util/fdc3-listener.d.ts.map +0 -1
  36. package/dist/esm/util/fdc3-listener.js +0 -55
@@ -14,37 +14,41 @@ import { IOConnectDesktop } from '@interopio/desktop';
14
14
  import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
15
15
  import { NotificationDataRow } from '@genesislcap/foundation-notifications';
16
16
  import { NotificationListener } from '@genesislcap/foundation-ui';
17
+ import { Observable } from 'rxjs';
17
18
  import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
18
19
  import { ViewTemplate } from '@microsoft/fast-element';
19
20
 
20
- /**
21
- * fdc3-listener listen channel config
22
- * @alpha
23
- */
24
- export declare interface ChannelConfig {
25
- channelName: string;
26
- channelType: string;
27
- callback: (any: any) => void;
28
- }
29
-
30
21
  /**
31
22
  * The FDC3 implementation.
32
23
  * @internal
33
24
  */
34
25
  export declare class DefaultFDC3 implements FDC3 {
35
26
  isReady: boolean;
27
+ private _isReady$;
28
+ isReady$: Observable<true>;
29
+ private _currentChannel$;
30
+ private _currentChannel;
31
+ currentChannel$: Observable<Channel>;
32
+ isInteropFdc3: () => boolean;
36
33
  constructor();
37
- private connect;
34
+ private init;
38
35
  addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
39
36
  findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
40
37
  findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
38
+ raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
41
39
  raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
42
40
  joinChannel(channelId: string): Promise<void>;
43
41
  getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
44
42
  broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
43
+ broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
45
44
  broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
46
45
  addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
46
+ addSystemChannelListener(channelType: string, callback: (any: any) => void): Promise<void>;
47
47
  getCurrentChannel(): Promise<Channel>;
48
+ handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
49
+ private broadcastMessageOnChannel;
50
+ private getAndUpdateCurrentChannel;
51
+ private handleInteropChannelChanges;
48
52
  }
49
53
 
50
54
  /**
@@ -57,6 +61,22 @@ export declare interface FDC3 {
57
61
  * @public
58
62
  */
59
63
  isReady: boolean;
64
+ /**
65
+ * Observable indicating the FDC3 API is ready.
66
+ * @public
67
+ */
68
+ isReady$: Observable<true>;
69
+ /**
70
+ * Check if the interop global is available.
71
+ * @public
72
+ */
73
+ isInteropFdc3: () => boolean;
74
+ /**
75
+ * Observable which emits the current channel
76
+ * When a new channel is joined a new value is emitted
77
+ * @public
78
+ */
79
+ currentChannel$: Observable<FDC3Channel>;
60
80
  /**
61
81
  * Adds intent listeners for the specified intents.
62
82
  * @public
@@ -78,6 +98,13 @@ export declare interface FDC3 {
78
98
  * @returns A promise that resolves with an array of all matching intents and their metadata.
79
99
  */
80
100
  findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
101
+ /**
102
+ * Raises an intent against an application based purely on the context data.
103
+ * @public
104
+ * @param context - The context to use.
105
+ * @returns A promise that resolves with the result of the intent resolution.
106
+ */
107
+ raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
81
108
  /**
82
109
  * Raises the specified intent with the specified context.
83
110
  * @public
@@ -107,6 +134,12 @@ export declare interface FDC3 {
107
134
  * @param payload - payload sent to the channel
108
135
  */
109
136
  broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
137
+ /**
138
+ * Broadcasts a message on the current app channel
139
+ * @param type - type of the channel
140
+ * @param payload - payload sent to the channel
141
+ */
142
+ broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
110
143
  /**
111
144
  * Helper function to broadcast message on channel in response to dispatched event
112
145
  * @param channelName - name of the channel
@@ -120,10 +153,23 @@ export declare interface FDC3 {
120
153
  * @param callback - handler to for the channel context listener
121
154
  * */
122
155
  addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
156
+ /**
157
+ * Helper function to add a context listener on to the system, aka 'color', channel with a handler for channel messages
158
+ * @param channelType - type of the channel
159
+ * @param callback - handler to for the channel context listener
160
+ * */
161
+ addSystemChannelListener(channelType: string, callback: (any: any) => void): Promise<void>;
123
162
  /**
124
163
  * Helper function to get the current channel of the application
125
164
  * */
126
165
  getCurrentChannel(): Promise<Channel>;
166
+ /**
167
+ * Helper function to add a context listener on a channel with a handler for channel messages
168
+ * @param channel - channel instance for getting for getting current context
169
+ * @param contextType - context type of the channel to listen to
170
+ * @param callback - handler to for the channel context listener
171
+ * */
172
+ handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
127
173
  }
128
174
 
129
175
  /**
@@ -508,344 +554,6 @@ export declare interface FDC3IntentResolution extends IntentResolution {
508
554
  */
509
555
  export declare type FDC3Intents = Intents;
510
556
 
511
- /**
512
- * fdc3-listener
513
- * @alpha
514
- */
515
- export declare class Fdc3Listener extends Fdc3Listener_base {
516
- fdc3: FDC3;
517
- intentConfig: IntentConfig[];
518
- channelConfig: ChannelConfig[];
519
- deepClone(): Node;
520
- connectedCallback(): void;
521
- }
522
-
523
- declare const Fdc3Listener_base: (new (...args: any[]) => {
524
- "__#1@#_container": FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
525
- "__#1@#_latestTokenCode": string;
526
- "__#1@#_hasFirstLoaded": boolean;
527
- "__#1@#_cleanupTimeout": NodeJS.Timeout;
528
- "__#1@#_shouldForceLifecycle": boolean;
529
- cloneNode(deep?: boolean): Node;
530
- deepClone(): Node;
531
- readonly shouldRunDisconnect: boolean;
532
- readonly shouldRunConnect: boolean;
533
- "__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
534
- "__#1@#_tryFindContainingLayout"(e: Element): FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
535
- connectedCallback(): void;
536
- readonly $fastController: Controller;
537
- $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
538
- disconnectedCallback(): void;
539
- attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
540
- accessKey: string;
541
- readonly accessKeyLabel: string;
542
- autocapitalize: string;
543
- dir: string;
544
- draggable: boolean;
545
- hidden: boolean;
546
- inert: boolean;
547
- innerText: string;
548
- lang: string;
549
- readonly offsetHeight: number;
550
- readonly offsetLeft: number;
551
- readonly offsetParent: Element;
552
- readonly offsetTop: number;
553
- readonly offsetWidth: number;
554
- outerText: string;
555
- spellcheck: boolean;
556
- title: string;
557
- translate: boolean;
558
- attachInternals(): ElementInternals;
559
- click(): void;
560
- addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
561
- addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
562
- removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
563
- removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
564
- readonly attributes: NamedNodeMap;
565
- readonly classList: DOMTokenList;
566
- className: string;
567
- readonly clientHeight: number;
568
- readonly clientLeft: number;
569
- readonly clientTop: number;
570
- readonly clientWidth: number;
571
- id: string;
572
- readonly localName: string;
573
- readonly namespaceURI: string;
574
- onfullscreenchange: (this: Element, ev: Event) => any;
575
- onfullscreenerror: (this: Element, ev: Event) => any;
576
- outerHTML: string;
577
- readonly ownerDocument: Document;
578
- readonly part: DOMTokenList;
579
- readonly prefix: string;
580
- readonly scrollHeight: number;
581
- scrollLeft: number;
582
- scrollTop: number;
583
- readonly scrollWidth: number;
584
- readonly shadowRoot: ShadowRoot;
585
- slot: string;
586
- readonly tagName: string;
587
- attachShadow(init: ShadowRootInit): ShadowRoot;
588
- closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
589
- closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
590
- closest<E extends Element = Element>(selectors: string): E;
591
- getAttribute(qualifiedName: string): string;
592
- getAttributeNS(namespace: string, localName: string): string;
593
- getAttributeNames(): string[];
594
- getAttributeNode(qualifiedName: string): Attr;
595
- getAttributeNodeNS(namespace: string, localName: string): Attr;
596
- getBoundingClientRect(): DOMRect;
597
- getClientRects(): DOMRectList;
598
- getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
599
- getElementsByTagName<K_4 extends keyof HTMLElementTagNameMap>(qualifiedName: K_4): HTMLCollectionOf<HTMLElementTagNameMap[K_4]>;
600
- getElementsByTagName<K_5 extends keyof SVGElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<SVGElementTagNameMap[K_5]>;
601
- getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
602
- getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
603
- getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
604
- getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
605
- hasAttribute(qualifiedName: string): boolean;
606
- hasAttributeNS(namespace: string, localName: string): boolean;
607
- hasAttributes(): boolean;
608
- hasPointerCapture(pointerId: number): boolean;
609
- insertAdjacentElement(where: InsertPosition, element: Element): Element;
610
- insertAdjacentHTML(position: InsertPosition, text: string): void;
611
- insertAdjacentText(where: InsertPosition, data: string): void;
612
- matches(selectors: string): boolean;
613
- releasePointerCapture(pointerId: number): void;
614
- removeAttribute(qualifiedName: string): void;
615
- removeAttributeNS(namespace: string, localName: string): void;
616
- removeAttributeNode(attr: Attr): Attr;
617
- requestFullscreen(options?: FullscreenOptions): Promise<void>;
618
- requestPointerLock(): void;
619
- scroll(options?: ScrollToOptions): void;
620
- scroll(x: number, y: number): void;
621
- scrollBy(options?: ScrollToOptions): void;
622
- scrollBy(x: number, y: number): void;
623
- scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
624
- scrollTo(options?: ScrollToOptions): void;
625
- scrollTo(x: number, y: number): void;
626
- setAttribute(qualifiedName: string, value: string): void;
627
- setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
628
- setAttributeNode(attr: Attr): Attr;
629
- setAttributeNodeNS(attr: Attr): Attr;
630
- setPointerCapture(pointerId: number): void;
631
- toggleAttribute(qualifiedName: string, force?: boolean): boolean;
632
- webkitMatchesSelector(selectors: string): boolean;
633
- readonly baseURI: string;
634
- readonly childNodes: NodeListOf<ChildNode>;
635
- readonly firstChild: ChildNode;
636
- readonly isConnected: boolean;
637
- readonly lastChild: ChildNode;
638
- readonly nextSibling: ChildNode;
639
- readonly nodeName: string;
640
- readonly nodeType: number;
641
- nodeValue: string;
642
- readonly parentElement: HTMLElement;
643
- readonly parentNode: ParentNode;
644
- readonly previousSibling: ChildNode;
645
- textContent: string;
646
- appendChild<T_1 extends Node>(node: T_1): T_1;
647
- compareDocumentPosition(other: Node): number;
648
- contains(other: Node): boolean;
649
- getRootNode(options?: GetRootNodeOptions): Node;
650
- hasChildNodes(): boolean;
651
- insertBefore<T_2 extends Node>(node: T_2, child: Node): T_2;
652
- isDefaultNamespace(namespace: string): boolean;
653
- isEqualNode(otherNode: Node): boolean;
654
- isSameNode(otherNode: Node): boolean;
655
- lookupNamespaceURI(prefix: string): string;
656
- lookupPrefix(namespace: string): string;
657
- normalize(): void;
658
- removeChild<T_3 extends Node>(child: T_3): T_3;
659
- replaceChild<T_4 extends Node>(node: Node, child: T_4): T_4;
660
- readonly ATTRIBUTE_NODE: number;
661
- readonly CDATA_SECTION_NODE: number;
662
- readonly COMMENT_NODE: number;
663
- readonly DOCUMENT_FRAGMENT_NODE: number;
664
- readonly DOCUMENT_NODE: number;
665
- readonly DOCUMENT_POSITION_CONTAINED_BY: number;
666
- readonly DOCUMENT_POSITION_CONTAINS: number;
667
- readonly DOCUMENT_POSITION_DISCONNECTED: number;
668
- readonly DOCUMENT_POSITION_FOLLOWING: number;
669
- readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
670
- readonly DOCUMENT_POSITION_PRECEDING: number;
671
- readonly DOCUMENT_TYPE_NODE: number;
672
- readonly ELEMENT_NODE: number;
673
- readonly ENTITY_NODE: number;
674
- readonly ENTITY_REFERENCE_NODE: number;
675
- readonly NOTATION_NODE: number;
676
- readonly PROCESSING_INSTRUCTION_NODE: number;
677
- readonly TEXT_NODE: number;
678
- dispatchEvent(event: Event): boolean;
679
- ariaAtomic: string;
680
- ariaAutoComplete: string;
681
- ariaBusy: string;
682
- ariaChecked: string;
683
- ariaColCount: string;
684
- ariaColIndex: string;
685
- ariaColIndexText: string;
686
- ariaColSpan: string;
687
- ariaCurrent: string;
688
- ariaDisabled: string;
689
- ariaExpanded: string;
690
- ariaHasPopup: string;
691
- ariaHidden: string;
692
- ariaInvalid: string;
693
- ariaKeyShortcuts: string;
694
- ariaLabel: string;
695
- ariaLevel: string;
696
- ariaLive: string;
697
- ariaModal: string;
698
- ariaMultiLine: string;
699
- ariaMultiSelectable: string;
700
- ariaOrientation: string;
701
- ariaPlaceholder: string;
702
- ariaPosInSet: string;
703
- ariaPressed: string;
704
- ariaReadOnly: string;
705
- ariaRequired: string;
706
- ariaRoleDescription: string;
707
- ariaRowCount: string;
708
- ariaRowIndex: string;
709
- ariaRowIndexText: string;
710
- ariaRowSpan: string;
711
- ariaSelected: string;
712
- ariaSetSize: string;
713
- ariaSort: string;
714
- ariaValueMax: string;
715
- ariaValueMin: string;
716
- ariaValueNow: string;
717
- ariaValueText: string;
718
- role: string;
719
- animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
720
- getAnimations(options?: GetAnimationsOptions): Animation[];
721
- after(...nodes: (string | Node)[]): void;
722
- before(...nodes: (string | Node)[]): void;
723
- remove(): void;
724
- replaceWith(...nodes: (string | Node)[]): void;
725
- innerHTML: string;
726
- readonly nextElementSibling: Element;
727
- readonly previousElementSibling: Element;
728
- readonly childElementCount: number;
729
- readonly children: HTMLCollection;
730
- readonly firstElementChild: Element;
731
- readonly lastElementChild: Element;
732
- append(...nodes: (string | Node)[]): void;
733
- prepend(...nodes: (string | Node)[]): void;
734
- querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
735
- querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
736
- querySelector<E_1 extends Element = Element>(selectors: string): E_1;
737
- querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
738
- querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
739
- querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
740
- replaceChildren(...nodes: (string | Node)[]): void;
741
- readonly assignedSlot: HTMLSlotElement;
742
- oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
743
- oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
744
- onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
745
- readonly style: CSSStyleDeclaration;
746
- contentEditable: string;
747
- enterKeyHint: string;
748
- inputMode: string;
749
- readonly isContentEditable: boolean;
750
- onabort: (this: GlobalEventHandlers, ev: UIEvent) => any;
751
- onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
752
- onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
753
- onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
754
- onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
755
- onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
756
- onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
757
- onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
758
- oncancel: (this: GlobalEventHandlers, ev: Event) => any;
759
- oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
760
- oncanplaythrough: (this: GlobalEventHandlers, ev: Event) => any;
761
- onchange: (this: GlobalEventHandlers, ev: Event) => any;
762
- onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
763
- onclose: (this: GlobalEventHandlers, ev: Event) => any;
764
- oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
765
- oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
766
- ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
767
- ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
768
- ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
769
- ondragenter: (this: GlobalEventHandlers, ev: DragEvent) => any;
770
- ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any;
771
- ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any;
772
- ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any;
773
- ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any;
774
- ondurationchange: (this: GlobalEventHandlers, ev: Event) => any;
775
- onemptied: (this: GlobalEventHandlers, ev: Event) => any;
776
- onended: (this: GlobalEventHandlers, ev: Event) => any;
777
- onerror: OnErrorEventHandlerNonNull;
778
- onfocus: (this: GlobalEventHandlers, ev: FocusEvent) => any;
779
- onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) => any;
780
- ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
781
- oninput: (this: GlobalEventHandlers, ev: Event) => any;
782
- oninvalid: (this: GlobalEventHandlers, ev: Event) => any;
783
- onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
784
- onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
785
- onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
786
- onload: (this: GlobalEventHandlers, ev: Event) => any;
787
- onloadeddata: (this: GlobalEventHandlers, ev: Event) => any;
788
- onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any;
789
- onloadstart: (this: GlobalEventHandlers, ev: Event) => any;
790
- onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
791
- onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any;
792
- onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) => any;
793
- onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) => any;
794
- onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) => any;
795
- onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
796
- onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
797
- onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
798
- onpause: (this: GlobalEventHandlers, ev: Event) => any;
799
- onplay: (this: GlobalEventHandlers, ev: Event) => any;
800
- onplaying: (this: GlobalEventHandlers, ev: Event) => any;
801
- onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any;
802
- onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) => any;
803
- onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) => any;
804
- onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) => any;
805
- onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) => any;
806
- onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) => any;
807
- onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) => any;
808
- onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) => any;
809
- onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
810
- onratechange: (this: GlobalEventHandlers, ev: Event) => any;
811
- onreset: (this: GlobalEventHandlers, ev: Event) => any;
812
- onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
813
- onscroll: (this: GlobalEventHandlers, ev: Event) => any;
814
- onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
815
- onseeked: (this: GlobalEventHandlers, ev: Event) => any;
816
- onseeking: (this: GlobalEventHandlers, ev: Event) => any;
817
- onselect: (this: GlobalEventHandlers, ev: Event) => any;
818
- onselectionchange: (this: GlobalEventHandlers, ev: Event) => any;
819
- onselectstart: (this: GlobalEventHandlers, ev: Event) => any;
820
- onslotchange: (this: GlobalEventHandlers, ev: Event) => any;
821
- onstalled: (this: GlobalEventHandlers, ev: Event) => any;
822
- onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any;
823
- onsuspend: (this: GlobalEventHandlers, ev: Event) => any;
824
- ontimeupdate: (this: GlobalEventHandlers, ev: Event) => any;
825
- ontoggle: (this: GlobalEventHandlers, ev: Event) => any;
826
- ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
827
- ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
828
- ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
829
- ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
830
- ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
831
- ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
832
- ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
833
- ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
834
- onvolumechange: (this: GlobalEventHandlers, ev: Event) => any;
835
- onwaiting: (this: GlobalEventHandlers, ev: Event) => any;
836
- onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any;
837
- onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any;
838
- onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any;
839
- onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any;
840
- onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any;
841
- autofocus: boolean;
842
- readonly dataset: DOMStringMap;
843
- nonce?: string;
844
- tabIndex: number;
845
- blur(): void;
846
- focus(options?: FocusOptions): void;
847
- }) & typeof FoundationElement;
848
-
849
557
  /**
850
558
  * fdc3-raise-intent
851
559
  * @alpha
@@ -1188,15 +896,6 @@ declare const Fdc3RaiseIntent_base: (new (...args: any[]) => {
1188
896
  focus(options?: FocusOptions): void;
1189
897
  }) & typeof FoundationElement;
1190
898
 
1191
- /**
1192
- * fdc3-listener listen intent config
1193
- * @alpha
1194
- */
1195
- export declare interface IntentConfig {
1196
- intent: string;
1197
- callback: (any: any) => void;
1198
- }
1199
-
1200
899
  /**
1201
900
  * The Foundation Interop Notification Listener
1202
901
  *
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [addSystemChannelListener](./foundation-fdc3.fdc3.addsystemchannellistener.md)
4
+
5
+ ## FDC3.addSystemChannelListener() method
6
+
7
+ Helper function to add a context listener on to the system, aka 'color', channel with a handler for channel messages
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ addSystemChannelListener(channelType: string, callback: (any: any) => void): Promise<void>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | channelType | string | type of the channel |
20
+ | callback | (any: any) =&gt; void | handler to for the channel context listener |
21
+
22
+ **Returns:**
23
+
24
+ Promise&lt;void&gt;
25
+
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [broadcastOnCurrentChannel](./foundation-fdc3.fdc3.broadcastoncurrentchannel.md)
4
+
5
+ ## FDC3.broadcastOnCurrentChannel() method
6
+
7
+ Broadcasts a message on the current app channel
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | payload | any | payload sent to the channel |
20
+ | type | string | _(Optional)_ type of the channel |
21
+
22
+ **Returns:**
23
+
24
+ Promise&lt;void&gt;
25
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [currentChannel$](./foundation-fdc3.fdc3.currentchannel_.md)
4
+
5
+ ## FDC3.currentChannel$ property
6
+
7
+ Observable which emits the current channel When a new channel is joined a new value is emitted
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ currentChannel$: Observable<FDC3Channel>;
13
+ ```
@@ -0,0 +1,26 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [handleChannelCurrentContext](./foundation-fdc3.fdc3.handlechannelcurrentcontext.md)
4
+
5
+ ## FDC3.handleChannelCurrentContext() method
6
+
7
+ Helper function to add a context listener on a channel with a handler for channel messages
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | channel | Channel \| [FDC3Channel](./foundation-fdc3.fdc3channel.md) | channel instance for getting for getting current context |
20
+ | contextType | string | context type of the channel to listen to |
21
+ | listenerCallback | (FDC3Context: any) =&gt; any | |
22
+
23
+ **Returns:**
24
+
25
+ Promise&lt;void&gt;
26
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md)
4
+
5
+ ## FDC3.isInteropFdc3 property
6
+
7
+ Check if the interop global is available.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ isInteropFdc3: () => boolean;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [isReady$](./foundation-fdc3.fdc3.isready_.md)
4
+
5
+ ## FDC3.isReady$ property
6
+
7
+ Observable indicating the FDC3 API is ready.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ isReady$: Observable<true>;
13
+ ```
@@ -16,7 +16,10 @@ export interface FDC3
16
16
 
17
17
  | Property | Modifiers | Type | Description |
18
18
  | --- | --- | --- | --- |
19
+ | [currentChannel$](./foundation-fdc3.fdc3.currentchannel_.md) | | Observable&lt;[FDC3Channel](./foundation-fdc3.fdc3channel.md)<!-- -->&gt; | Observable which emits the current channel When a new channel is joined a new value is emitted |
20
+ | [isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md) | | () =&gt; boolean | Check if the interop global is available. |
19
21
  | [isReady](./foundation-fdc3.fdc3.isready.md) | | boolean | Whether the FDC3 API is ready. |
22
+ | [isReady$](./foundation-fdc3.fdc3.isready_.md) | | Observable&lt;true&gt; | Observable indicating the FDC3 API is ready. |
20
23
 
21
24
  ## Methods
22
25
 
@@ -24,12 +27,16 @@ export interface FDC3
24
27
  | --- | --- |
25
28
  | [addChannelListener(channelName, channelType, callback)](./foundation-fdc3.fdc3.addchannellistener.md) | Helper function to add a context listener on a channel with a handler for channel messages |
26
29
  | [addIntentListeners(listeners)](./foundation-fdc3.fdc3.addintentlisteners.md) | Adds intent listeners for the specified intents. |
30
+ | [addSystemChannelListener(channelType, callback)](./foundation-fdc3.fdc3.addsystemchannellistener.md) | Helper function to add a context listener on to the system, aka 'color', channel with a handler for channel messages |
27
31
  | [broadcastOnChannel(channelName, type, payload)](./foundation-fdc3.fdc3.broadcastonchannel.md) | Broadcasts a message on a given channel with a given type |
28
32
  | [broadcastOnChannelEventHandler(channelName, type)](./foundation-fdc3.fdc3.broadcastonchanneleventhandler.md) | Helper function to broadcast message on channel in response to dispatched event |
33
+ | [broadcastOnCurrentChannel(payload, type)](./foundation-fdc3.fdc3.broadcastoncurrentchannel.md) | Broadcasts a message on the current app channel |
29
34
  | [findIntent(intent, context)](./foundation-fdc3.fdc3.findintent.md) | Finds an app that supports the specified intent. |
30
35
  | [findIntentsByContext(context)](./foundation-fdc3.fdc3.findintentsbycontext.md) | Finds all the intents supported by the specified context. |
31
36
  | [getCurrentChannel()](./foundation-fdc3.fdc3.getcurrentchannel.md) | Helper function to get the current channel of the application |
32
37
  | [getOrCreateChannel(channelId)](./foundation-fdc3.fdc3.getorcreatechannel.md) | Gets or creates the specified channel. |
38
+ | [handleChannelCurrentContext(channel, contextType, listenerCallback)](./foundation-fdc3.fdc3.handlechannelcurrentcontext.md) | Helper function to add a context listener on a channel with a handler for channel messages |
33
39
  | [joinChannel(channelId)](./foundation-fdc3.fdc3.joinchannel.md) | Joins the specified channel. |
34
40
  | [raiseIntent(context, intent)](./foundation-fdc3.fdc3.raiseintent.md) | Raises the specified intent with the specified context. |
41
+ | [raiseIntentForContext(context)](./foundation-fdc3.fdc3.raiseintentforcontext.md) | Raises an intent against an application based purely on the context data. |
35
42
 
@@ -0,0 +1,26 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [raiseIntentForContext](./foundation-fdc3.fdc3.raiseintentforcontext.md)
4
+
5
+ ## FDC3.raiseIntentForContext() method
6
+
7
+ Raises an intent against an application based purely on the context data.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | context | [FDC3Context](./foundation-fdc3.fdc3context.md) | The context to use. |
20
+
21
+ **Returns:**
22
+
23
+ Promise&lt;[FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md)<!-- -->&gt;
24
+
25
+ A promise that resolves with the result of the intent resolution.
26
+