@genesislcap/foundation-fdc3 14.192.1 → 14.192.2-FUI-2127.1

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

@@ -9,15 +9,15 @@ Helper function to add a context listener on a channel with a handler for channe
 **Signature:**
 
 ```typescript
-addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
+addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<Channel>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  channelName | string | name of the channel |
-|  channelType | string | type of the channel |
+|  channel | [FDC3Channel](./foundation-fdc3.fdc3channel.md) \| Channel | instance of a channel |
+|  channelType | string | type of the channel context |
 |  callback | (any: any) =&gt; void | handler to for the channel context listener |
 
 **Returns:**

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.currentchannelobs.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; [currentChannelObs](./foundation-fdc3.fdc3.currentchannelobs.md)
+
+## FDC3.currentChannelObs property
+
+Observable which emits the current channel When a new channel is joined a new value is emitted
+
+**Signature:**
+
+```typescript
+currentChannelObs: Observable<FDC3Channel>;
+```

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

@@ -0,0 +1,17 @@
+<!-- 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; [init](./foundation-fdc3.fdc3.init.md)
+
+## FDC3.init() method
+
+Method to initialize the fdc3 service. The service will check if the fdc3 agent has been initialized and emit via the isReadyObs when ready. The service will store the current app channel internally
+
+**Signature:**
+
+```typescript
+init(): void;
+```
+**Returns:**
+
+void
+

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 → foundation-fdc3.fdc3.isreadyobs.md}

@@ -1,13 +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)
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [isReadyObs](./foundation-fdc3.fdc3.isreadyobs.md)
 
-## FDC3.isReady property
+## FDC3.isReadyObs property
 
-Whether the FDC3 API is ready.
+Observable indicating the FDC3 API is ready.
 
 **Signature:**
 
 ```typescript
-isReady: boolean;
+isReadyObs: Observable<true>;
 ```

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

@@ -16,20 +16,25 @@ export interface FDC3
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [isReady](./foundation-fdc3.fdc3.isready.md) |  | boolean | Whether the FDC3 API is ready. |
+|  [currentChannelObs](./foundation-fdc3.fdc3.currentchannelobs.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. |
+|  [isReadyObs](./foundation-fdc3.fdc3.isreadyobs.md) |  | Observable&lt;true&gt; | Observable indicating the FDC3 API is ready. |
 
 ## Methods
 
 |  Method | Description |
 |  --- | --- |
-|  [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 |
+|  [addChannelListener(channel, 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. |
 |  [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. |
+|  [init()](./foundation-fdc3.fdc3.init.md) | Method to initialize the fdc3 service. The service will check if the fdc3 agent has been initialized and emit via the isReadyObs when ready. The service will store the current app channel internally |
 |  [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

@@ -10,7 +10,6 @@ import { Context } from '@finos/fdc3';
 import { ContextHandler } from '@finos/fdc3';
 import { Controller } from '@microsoft/fast-element';
 import { DOMContainer } from '@genesislcap/foundation-utils';
-import { FASTElement } from '@genesislcap/web-core';
 import { FoundationElement } from '@genesislcap/web-core';
 import { FoundationElementRegistry } from '@microsoft/fast-foundation';
 import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
@@ -21,15 +20,16 @@ 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;
+    callback: (FDC3Context: any) => void;
     // (undocumented)
-    channelName: string;
+    channelName?: string;
     // (undocumented)
     channelType: string;
 }
@@ -40,7 +40,7 @@ export interface ChannelConfig {
 export class DefaultFDC3 implements FDC3 {
     constructor();
     // (undocumented)
-    addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
+    addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<FDC3Channel | Channel>;
     // (undocumented)
     addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
     // (undocumented)
@@ -48,6 +48,10 @@ export class DefaultFDC3 implements FDC3 {
     // (undocumented)
     broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
     // (undocumented)
+    broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
+    // (undocumented)
+    currentChannelObs: Observable<Channel>;
+    // (undocumented)
     findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
     // (undocumented)
     findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
@@ -56,28 +60,39 @@ export class DefaultFDC3 implements FDC3 {
     // (undocumented)
     getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
     // (undocumented)
-    isReady: boolean;
+    init(): Promise<void>;
+    // (undocumented)
+    isInteropFdc3: () => boolean;
+    // (undocumented)
+    isReadyObs: Observable<true>;
     // (undocumented)
     joinChannel(channelId: string): Promise<void>;
     // (undocumented)
-    raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
+    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
 //
 // @public
 export interface FDC3 {
-    addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
+    addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<Channel>;
     addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): 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>;
+    currentChannelObs: Observable<FDC3Channel>;
     findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
     findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
     getCurrentChannel(): Promise<Channel>;
     getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
-    isReady: boolean;
+    init(): void;
+    isInteropFdc3: () => boolean;
+    isReadyObs: Observable<true>;
     joinChannel(channelId: string): Promise<void>;
     raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
+    raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
 }
 
 // @internal
@@ -128,23 +143,33 @@ export interface FDC3IntentResolution extends IntentResolution {
 // @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
+//
 // @alpha
-export class Fdc3Listener extends FASTElement {
+export class Fdc3Listener extends Fdc3Listener_base {
     // (undocumented)
     channelConfig: ChannelConfig[];
     // (undocumented)
     connectedCallback(): void;
     // (undocumented)
+    deepClone(): Node;
+    // (undocumented)
+    disconnectedCallback(): void;
+    // (undocumented)
     fdc3: FDC3;
     // (undocumented)
     intentConfig: IntentConfig[];
 }
 
+// Warning: (ae-forgotten-export) The symbol "Fdc3RaiseIntent_base" needs to be exported by the entry point index.d.ts
+//
 // @alpha
-export class Fdc3RaiseIntent extends FASTElement {
+export class Fdc3RaiseIntent extends Fdc3RaiseIntent_base {
     // (undocumented)
     connectedCallback(): void;
     // (undocumented)
+    deepClone(): Node;
+    // (undocumented)
     disconnectedCallback(): void;
     // (undocumented)
     eventName: string;
@@ -161,7 +186,7 @@ export class Fdc3RaiseIntent extends FASTElement {
 // @alpha
 export interface IntentConfig {
     // (undocumented)
-    callback: (any: any) => void;
+    callback: (FDC3Context: any) => void;
     // (undocumented)
     intent: string;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-fdc3",
   "description": "Genesis Foundation FDC3",
-  "version": "14.192.1",
+  "version": "14.192.2-FUI-2127.1",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -59,25 +59,26 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.192.1",
-    "@genesislcap/genx": "14.192.1",
-    "@genesislcap/rollup-builder": "14.192.1",
-    "@genesislcap/ts-builder": "14.192.1",
-    "@genesislcap/uvu-playwright-builder": "14.192.1",
-    "@genesislcap/vite-builder": "14.192.1",
-    "@genesislcap/webpack-builder": "14.192.1",
+    "@genesislcap/foundation-testing": "14.192.2-FUI-2127.1",
+    "@genesislcap/genx": "14.192.2-FUI-2127.1",
+    "@genesislcap/rollup-builder": "14.192.2-FUI-2127.1",
+    "@genesislcap/ts-builder": "14.192.2-FUI-2127.1",
+    "@genesislcap/uvu-playwright-builder": "14.192.2-FUI-2127.1",
+    "@genesislcap/vite-builder": "14.192.2-FUI-2127.1",
+    "@genesislcap/webpack-builder": "14.192.2-FUI-2127.1",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
     "@finos/fdc3": "^1.2.0",
-    "@genesislcap/foundation-logger": "14.192.1",
-    "@genesislcap/foundation-notifications": "14.192.1",
-    "@genesislcap/foundation-ui": "14.192.1",
-    "@genesislcap/foundation-utils": "14.192.1",
-    "@genesislcap/web-core": "14.192.1",
+    "@genesislcap/foundation-logger": "14.192.2-FUI-2127.1",
+    "@genesislcap/foundation-notifications": "14.192.2-FUI-2127.1",
+    "@genesislcap/foundation-ui": "14.192.2-FUI-2127.1",
+    "@genesislcap/foundation-utils": "14.192.2-FUI-2127.1",
+    "@genesislcap/web-core": "14.192.2-FUI-2127.1",
     "@interopio/desktop": "^6.3.1",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
+    "rxjs": "^7.8.1",
     "tslib": "^2.3.1"
   },
   "repository": {
@@ -88,5 +89,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a29aa171eb4bd0a83c1787bdcfb0351f77ff0cc5"
+  "gitHead": "cafa4ea375512fe75ce9f71646cf84062ffd1c57"
 }

package/test/fdc3.mock.ts

@@ -4,10 +4,18 @@ export const mockFdc3 = () => {
   if (!('fdc3' in window)) {
     const broadcast = sinon.stub();
     const addContextListener = sinon.stub();
+    const getCurrentContext = sinon.stub();
+    const channel = sinon.stub().returns({
+      getCurrentContext: async () => ({}),
+      broadcast,
+      addContextListener,
+    });
     window.fdc3 = {
       broadcast,
+      channel,
       addContextListener,
       getOrCreateChannel: sinon.stub().returns({
+        getCurrentContext,
         broadcast,
         addContextListener,
       }),
@@ -19,6 +27,9 @@ export const mockFdc3 = () => {
           fireIntent: (value) => callback(value),
         });
       },
+      getCurrentChannel: sinon.stub().returns({
+        channel,
+      }),
     };
   }
 };