@genesislcap/foundation-fdc3 14.200.1-alpha-599cb19.0 → 14.201.0

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

@@ -16,7 +16,10 @@ export interface FDC3
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
+|  [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 |
+|  [isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md) |  | () =&gt; boolean | Check if the interop global is available. |
 |  [isReady](./foundation-fdc3.fdc3.isready.md) |  | boolean | Whether the FDC3 API is ready. |
+|  [isReady$](./foundation-fdc3.fdc3.isready_.md) |  | Observable&lt;true&gt; | Observable indicating the FDC3 API is ready. |
 
 ## Methods
 
@@ -24,12 +27,16 @@ export interface FDC3
 |  --- | --- |
 |  [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 |
 |  [addIntentListeners(listeners)](./foundation-fdc3.fdc3.addintentlisteners.md) | Adds intent listeners for the specified intents. |
+|  [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 |
 |  [broadcastOnChannel(channelName, type, payload)](./foundation-fdc3.fdc3.broadcastonchannel.md) | Broadcasts a message on a given channel with a given type |
 |  [broadcastOnChannelEventHandler(channelName, type)](./foundation-fdc3.fdc3.broadcastonchanneleventhandler.md) | Helper function to broadcast message on channel in response to dispatched event |
+|  [broadcastOnCurrentChannel(payload, type)](./foundation-fdc3.fdc3.broadcastoncurrentchannel.md) | Broadcasts a message on the current app channel |
 |  [findIntent(intent, context)](./foundation-fdc3.fdc3.findintent.md) | Finds an app that supports the specified intent. |
 |  [findIntentsByContext(context)](./foundation-fdc3.fdc3.findintentsbycontext.md) | Finds all the intents supported by the specified context. |
 |  [getCurrentChannel()](./foundation-fdc3.fdc3.getcurrentchannel.md) | Helper function to get the current channel of the application |
 |  [getOrCreateChannel(channelId)](./foundation-fdc3.fdc3.getorcreatechannel.md) | Gets or creates the specified channel. |
+|  [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 |
 |  [joinChannel(channelId)](./foundation-fdc3.fdc3.joinchannel.md) | Joins the specified channel. |
 |  [raiseIntent(context, intent)](./foundation-fdc3.fdc3.raiseintent.md) | Raises the specified intent with the specified context. |
+|  [raiseIntentForContext(context)](./foundation-fdc3.fdc3.raiseintentforcontext.md) | Raises an intent against an application based purely on the context data. |
 

package/docs/api/foundation-fdc3.fdc3.raiseintentforcontext.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; [raiseIntentForContext](./foundation-fdc3.fdc3.raiseintentforcontext.md)
+
+## FDC3.raiseIntentForContext() method
+
+Raises an intent against an application based purely on the context data.
+
+**Signature:**
+
+```typescript
+raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  context | [FDC3Context](./foundation-fdc3.fdc3context.md) | The context to use. |
+
+**Returns:**
+
+Promise&lt;[FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md)<!-- -->&gt;
+
+A promise that resolves with the result of the intent resolution.
+

package/docs/api-report.md

@@ -20,17 +20,14 @@ 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';
 
 // @alpha
-export interface ChannelConfig {
-    // (undocumented)
-    callback: (any: any) => void;
+export interface AppChannelListenerConfig extends SystemChannelListenerConfig {
     // (undocumented)
     channelName: string;
-    // (undocumented)
-    channelType: string;
 }
 
 // Warning: (ae-internal-missing-underscore) The name "DefaultFDC3" should be prefixed with an underscore because the declaration is marked as @internal
@@ -43,10 +40,16 @@ export class DefaultFDC3 implements FDC3 {
     // (undocumented)
     addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
     // (undocumented)
+    addSystemChannelListener(channelType: string, callback: (any: any) => void): Promise<void>;
+    // (undocumented)
     broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
     // (undocumented)
     broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
     // (undocumented)
+    broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
+    // (undocumented)
+    currentChannel$: Observable<Channel>;
+    // (undocumented)
     findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
     // (undocumented)
     findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
@@ -55,11 +58,19 @@ export class DefaultFDC3 implements FDC3 {
     // (undocumented)
     getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
     // (undocumented)
+    handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
+    // (undocumented)
+    isInteropFdc3: () => boolean;
+    // (undocumented)
+    isReady$: Observable<true>;
+    // (undocumented)
     isReady: boolean;
     // (undocumented)
     joinChannel(channelId: string): Promise<void>;
     // (undocumented)
     raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
+    // (undocumented)
+    raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
 }
 
 // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "FDC3" because one of its declarations is marked as @internal
@@ -68,15 +79,22 @@ export class DefaultFDC3 implements FDC3 {
 export interface FDC3 {
     addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
     addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
+    addSystemChannelListener(channelType: string, callback: (any: any) => void): Promise<void>;
     broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
     broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
+    broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
+    currentChannel$: Observable<FDC3Channel>;
     findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
     findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
     getCurrentChannel(): Promise<Channel>;
     getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
+    handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
+    isInteropFdc3: () => boolean;
+    isReady$: Observable<true>;
     isReady: boolean;
     joinChannel(channelId: string): Promise<void>;
     raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
+    raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
 }
 
 // @internal
@@ -120,19 +138,18 @@ export interface FDC3Context extends Context {
 // @public (undocumented)
 export type FDC3ContextHandler = ContextHandler;
 
-// @public (undocumented)
-export interface FDC3IntentResolution extends IntentResolution {
+// @alpha
+export class Fdc3ContextListener extends Fdc3SystemChannelListener {
+    // (undocumented)
+    protected addChannelListeners(): void;
+    // (undocumented)
+    config: AppChannelListenerConfig[];
 }
 
-// @public (undocumented)
-export type FDC3Intents = Intents;
-
-// Warning: (ae-forgotten-export) The symbol "Fdc3Listener_base" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "Fdc3IntentListener_base" needs to be exported by the entry point index.d.ts
 //
 // @alpha
-export class Fdc3Listener extends Fdc3Listener_base {
-    // (undocumented)
-    channelConfig: ChannelConfig[];
+export class Fdc3IntentListener extends Fdc3IntentListener_base {
     // (undocumented)
     connectedCallback(): void;
     // (undocumented)
@@ -143,6 +160,13 @@ export class Fdc3Listener extends Fdc3Listener_base {
     intentConfig: IntentConfig[];
 }
 
+// @public (undocumented)
+export interface FDC3IntentResolution extends IntentResolution {
+}
+
+// @public (undocumented)
+export type FDC3Intents = Intents;
+
 // Warning: (ae-forgotten-export) The symbol "Fdc3RaiseIntent_base" needs to be exported by the entry point index.d.ts
 //
 // @alpha
@@ -165,10 +189,28 @@ export class Fdc3RaiseIntent extends Fdc3RaiseIntent_base {
     mappingFunction: (any: any) => any;
 }
 
+// Warning: (ae-forgotten-export) The symbol "Fdc3SystemChannelListener_base" needs to be exported by the entry point index.d.ts
+//
+// @alpha
+export class Fdc3SystemChannelListener extends Fdc3SystemChannelListener_base {
+    // (undocumented)
+    protected addChannelListeners(): void;
+    // (undocumented)
+    config: SystemChannelListenerConfig[];
+    // (undocumented)
+    connectedCallback(): void;
+    // (undocumented)
+    deepClone(): Node;
+    // (undocumented)
+    disconnectedCallback(): void;
+    // (undocumented)
+    fdc3: FDC3;
+}
+
 // @alpha
 export interface IntentConfig {
     // (undocumented)
-    callback: (any: any) => void;
+    callback: (FDC3Context: any) => void;
     // (undocumented)
     intent: string;
 }
@@ -192,6 +234,14 @@ export class InteropNotificationsListener extends NotificationListener {
     protected showNotificationToast(row: NotificationDataRow): void;
 }
 
+// @alpha
+export interface SystemChannelListenerConfig {
+    // (undocumented)
+    callback: (any: any) => void;
+    // (undocumented)
+    channelType: string;
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-fdc3",
   "description": "Genesis Foundation FDC3",
-  "version": "14.200.1-alpha-599cb19.0",
+  "version": "14.201.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -59,25 +59,27 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.200.1-alpha-599cb19.0",
-    "@genesislcap/genx": "14.200.1-alpha-599cb19.0",
-    "@genesislcap/rollup-builder": "14.200.1-alpha-599cb19.0",
-    "@genesislcap/ts-builder": "14.200.1-alpha-599cb19.0",
-    "@genesislcap/uvu-playwright-builder": "14.200.1-alpha-599cb19.0",
-    "@genesislcap/vite-builder": "14.200.1-alpha-599cb19.0",
-    "@genesislcap/webpack-builder": "14.200.1-alpha-599cb19.0",
-    "rimraf": "^5.0.0"
+    "@genesislcap/foundation-testing": "14.201.0",
+    "@genesislcap/genx": "14.201.0",
+    "@genesislcap/rollup-builder": "14.201.0",
+    "@genesislcap/ts-builder": "14.201.0",
+    "@genesislcap/uvu-playwright-builder": "14.201.0",
+    "@genesislcap/vite-builder": "14.201.0",
+    "@genesislcap/webpack-builder": "14.201.0",
+    "rimraf": "^5.0.0",
+    "sinon": "^17.0.1"
   },
   "dependencies": {
     "@finos/fdc3": "^1.2.0",
-    "@genesislcap/foundation-logger": "14.200.1-alpha-599cb19.0",
-    "@genesislcap/foundation-notifications": "14.200.1-alpha-599cb19.0",
-    "@genesislcap/foundation-ui": "14.200.1-alpha-599cb19.0",
-    "@genesislcap/foundation-utils": "14.200.1-alpha-599cb19.0",
-    "@genesislcap/web-core": "14.200.1-alpha-599cb19.0",
+    "@genesislcap/foundation-logger": "14.201.0",
+    "@genesislcap/foundation-notifications": "14.201.0",
+    "@genesislcap/foundation-ui": "14.201.0",
+    "@genesislcap/foundation-utils": "14.201.0",
+    "@genesislcap/web-core": "14.201.0",
     "@interopio/desktop": "^6.3.1",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
+    "rxjs": "^7.5.4",
     "tslib": "^2.3.1"
   },
   "repository": {
@@ -88,5 +90,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "870e612d13133e7a86b4eca45e682e14c703c382"
+  "gitHead": "d9585bb0f774fe0193ae3b7306e3b73a69e09f56"
 }

package/test/fdc3.mock.ts

@@ -4,21 +4,25 @@ export const mockFdc3 = () => {
   if (!('fdc3' in window)) {
     const broadcast = sinon.stub();
     const addContextListener = sinon.stub();
+    const channel = {
+      getCurrentContext: async () => ({}),
+      broadcast,
+      addContextListener,
+    };
+
     window.fdc3 = {
       broadcast,
+      channel,
       addContextListener,
-      getOrCreateChannel: sinon.stub().returns({
-        broadcast,
-        addContextListener,
-      }),
+      findIntent: sinon.spy(),
+      findIntentsByContext: sinon.spy(),
+      getOrCreateChannel: sinon.stub().returns(channel),
       getInfo: () => ({ fdc3Version: '2.1', provider: 'FINOS' }),
+      joinChannel: sinon.spy(),
       raiseIntent: sinon.stub(),
       raiseIntentForContext: sinon.stub(),
-      addIntentListener: (intent, callback) => {
-        return sinon.fake.returns({
-          fireIntent: (value) => callback(value),
-        });
-      },
+      addIntentListener: sinon.spy(),
+      getCurrentChannel: sinon.stub().returns(channel),
     };
   }
 };

package/dist/dts/util/fdc3-listener.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fdc3-listener.d.ts","sourceRoot":"","sources":["../../../src/util/fdc3-listener.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,CAAC,GAAG,KAAA,KAAK,IAAI,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,CAAC,GAAG,KAAA,KAAK,IAAI,CAAC;CACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED;;;GAGG;AACH,qBAGa,YAAa,SAAQ,iBAAiC;IAC3D,IAAI,EAAE,IAAI,CAAC;IAEjB,YAAY,EAAE,YAAY,EAAE,CAAM;IAElC,aAAa,EAAE,aAAa,EAAE,CAAM;IAE3B,SAAS,IAAI,IAAI;IA0B1B,iBAAiB;CAYlB"}

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

@@ -1,55 +0,0 @@
-import { __decorate } from "tslib";
-import { LifecycleMixin } from '@genesislcap/foundation-utils';
-import { customElement, FoundationElement } from '@genesislcap/web-core';
-import { FDC3 } from '../fdc3';
-/**
- * fdc3-listener
- * @alpha
- */
-let Fdc3Listener = class Fdc3Listener extends LifecycleMixin(FoundationElement) {
-    constructor() {
-        super(...arguments);
-        this.intentConfig = [];
-        this.channelConfig = [];
-    }
-    deepClone() {
-        const copy = super.deepClone();
-        if (this.intentConfig) {
-            copy.intentConfig = this.intentConfig.map((c) => {
-                const copyConfig = Object.assign({}, c);
-                if (c.callback) {
-                    copyConfig.callback = c.callback.bind(this);
-                }
-                return copyConfig;
-            });
-        }
-        if (this.channelConfig) {
-            copy.channelConfig = this.channelConfig.map((c) => {
-                const copyConfig = Object.assign({}, c);
-                if (c.callback) {
-                    copyConfig.callback = c.callback.bind(this);
-                }
-                return copyConfig;
-            });
-        }
-        return copy;
-    }
-    connectedCallback() {
-        super.connectedCallback();
-        if (window.fdc3) {
-            const listeners = new Map();
-            this.intentConfig.forEach((intent) => listeners.set(intent.intent, intent.callback));
-            this.fdc3.addIntentListeners(listeners);
-            this.channelConfig.forEach((c) => this.fdc3.addChannelListener(c.channelName, c.channelType, c.callback));
-        }
-    }
-};
-__decorate([
-    FDC3
-], Fdc3Listener.prototype, "fdc3", void 0);
-Fdc3Listener = __decorate([
-    customElement({
-        name: 'fdc3-listener',
-    })
-], Fdc3Listener);
-export { Fdc3Listener };