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

package/dist/esm/util/fdc3-system-channel-listener.js

@@ -0,0 +1,55 @@
+import { __awaiter, __decorate } from "tslib";
+import { LifecycleMixin } from '@genesislcap/foundation-utils';
+import { customElement, FoundationElement } from '@genesislcap/web-core';
+import { first, Subscription } from 'rxjs';
+import { FDC3 } from '../fdc3';
+let Fdc3SystemChannelListener = class Fdc3SystemChannelListener extends LifecycleMixin(FoundationElement) {
+    constructor() {
+        super(...arguments);
+        this.config = [];
+        this.channelSub = new Subscription();
+    }
+    deepClone() {
+        const copy = super.deepClone();
+        if (this.config) {
+            copy.config = this.config.map((c) => {
+                const copyConfig = Object.assign({}, c);
+                if (c.callback) {
+                    copyConfig.callback = c.callback.bind(this);
+                }
+                return copyConfig;
+            });
+        }
+        return copy;
+    }
+    connectedCallback() {
+        super.connectedCallback();
+        this.fdc3.isReady$.pipe(first()).subscribe(() => {
+            if (this.config) {
+                this.addChannelListeners();
+            }
+        });
+    }
+    addChannelListeners() {
+        this.fdc3.isReady$.pipe(first()).subscribe(() => __awaiter(this, void 0, void 0, function* () {
+            return this.config.forEach((c) => this.channelSub.add(this.fdc3.currentChannel$.subscribe((channel) => {
+                this.fdc3.handleChannelCurrentContext(channel, c.channelType, c.callback);
+                channel.addContextListener(c.channelType, c.callback);
+            })));
+        }));
+    }
+    disconnectedCallback() {
+        var _a;
+        (_a = this.channelSub) === null || _a === void 0 ? void 0 : _a.unsubscribe();
+        super.disconnectedCallback();
+    }
+};
+__decorate([
+    FDC3
+], Fdc3SystemChannelListener.prototype, "fdc3", void 0);
+Fdc3SystemChannelListener = __decorate([
+    customElement({
+        name: 'fdc3-system-channel-listener',
+    })
+], Fdc3SystemChannelListener);
+export { Fdc3SystemChannelListener };

package/dist/esm/util/index.js

@@ -1,2 +1 @@
 export * from './fdc3-raise-intent';
-export * from './fdc3-listener';

package/dist/foundation-fdc3.api.json

@@ -358,6 +358,72 @@
               ],
               "name": "addIntentListeners"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#addSystemChannelListener:member(1)",
+              "docComment": "/**\n * Helper function to add a context listener on to the system, aka 'color', channel with a handler for channel messages\n *\n * @param channelType - type of the channel\n *\n * @param callback - handler to for the channel context listener\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "addSystemChannelListener(channelType: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", callback: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(any: any) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 7
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "channelType",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "callback",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "addSystemChannelListener"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#broadcastOnChannel:member(1)",
@@ -515,6 +581,113 @@
               ],
               "name": "broadcastOnChannelEventHandler"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#broadcastOnCurrentChannel:member(1)",
+              "docComment": "/**\n * Broadcasts a message on the current app channel\n *\n * @param type - type of the channel\n *\n * @param payload - payload sent to the channel\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "broadcastOnCurrentChannel(payload: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", type?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 7
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "payload",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "type",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "name": "broadcastOnCurrentChannel"
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#currentChannel$:member",
+              "docComment": "/**\n * Observable which emits the current channel When a new channel is joined a new value is emitted\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "currentChannel$: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Observable",
+                  "canonicalReference": "rxjs!Observable:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FDC3Channel",
+                  "canonicalReference": "@genesislcap/foundation-fdc3!FDC3Channel:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "currentChannel$",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#findIntent:member(1)",
@@ -753,6 +926,125 @@
               ],
               "name": "getOrCreateChannel"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#handleChannelCurrentContext:member(1)",
+              "docComment": "/**\n * Helper function to add a context listener on a channel with a handler for channel messages\n *\n * @param channel - channel instance for getting for getting current context\n *\n * @param contextType - context type of the channel to listen to\n *\n * @param callback - handler to for the channel context listener\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "handleChannelCurrentContext(channel: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Channel",
+                  "canonicalReference": "@finos/fdc3!Channel:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FDC3Channel",
+                  "canonicalReference": "@genesislcap/foundation-fdc3!FDC3Channel:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", contextType: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", listenerCallback: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(FDC3Context: any) => any"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 9,
+                "endIndex": 11
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "channel",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "contextType",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "listenerCallback",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "handleChannelCurrentContext"
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#isInteropFdc3:member",
+              "docComment": "/**\n * Check if the interop global is available.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "isInteropFdc3: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "isInteropFdc3",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#isReady:member",
@@ -780,6 +1072,38 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#isReady$:member",
+              "docComment": "/**\n * Observable indicating the FDC3 API is ready.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "isReady$: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Observable",
+                  "canonicalReference": "rxjs!Observable:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<true>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "isReady$",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#joinChannel:member(1)",
@@ -906,6 +1230,66 @@
                 }
               ],
               "name": "raiseIntent"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-fdc3!FDC3#raiseIntentForContext:member(1)",
+              "docComment": "/**\n * Raises an intent against an application based purely on the context data.\n *\n * @param context - The context to use.\n *\n * @returns A promise that resolves with the result of the intent resolution.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "raiseIntentForContext(context: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FDC3Context",
+                  "canonicalReference": "@genesislcap/foundation-fdc3!FDC3Context:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FDC3IntentResolution",
+                  "canonicalReference": "@genesislcap/foundation-fdc3!FDC3IntentResolution:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 7
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "context",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "raiseIntentForContext"
             }
           ],
           "extendsTokenRanges": []