@genesislcap/foundation-fdc3 14.408.0 → 14.409.0

package/README.md

@@ -1,14 +1,12 @@
-# Genesis Foundation FDC3
+# @genesislcap/foundation-fdc3
 
-This provides a robust implementation of the FDC3 standard, facilitating interoperability between desktop financial applications. It leverages the `@finos/fdc3` library to implement an API that covers intents, context sharing, and channels, enhancing the communication and interaction capabilities of applications within the financial domain.
+Documentation for this package is published on the Genesis docs site:
 
-## API Documentation
-
-For more detailed information on API and configurations, please refer to the [API documentation](docs/api/index.md) in the `docs/api` directory.
+**Docs: [Foundation FDC3](https://docs.genesis.global/docs/develop/client-capabilities/desktop-interoperability/foundation-fdc3/)**
 
 ## Installation
 
-To include `@genesislcap/foundation-fdc3` in your project, add it as a dependency in your `package.json` file and follow your project's routine for dependency installation.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
 ```json
 {
@@ -18,78 +16,10 @@ To include `@genesislcap/foundation-fdc3` in your project, add it as a dependenc
 }
 ```
 
-## Key Features
-
-- **FDC3 Standard Compliance:** Implements FDC3 API standards, ensuring compatibility and interoperability across financial desktop applications.
-- **Event and Context Management:** Supports handling and broadcasting of various event types and contexts, enabling rich interaction patterns between applications.
-- **Channel Support:** Offers utilities for channel management, allowing applications to join, create, or broadcast over specific channels for targeted communication.
-- **Intent Handling:** Provides mechanisms to raise, listen for, and handle intents, facilitating action-driven communication between applications.
-
-## Usage Examples
-
-### Adding Intent Listeners
-
-```typescript
-import { FDC3, FDC3Intents, FDC3ContextHandler } from '@genesislcap/foundation-fdc3';
-import { FASTElement } from '@microsoft/fast-element';
-
-export class MyComponent extends FASTElement {
-  @FDC3 fdc3Service: FDC3;
-
-  connectedCallback() {
-    const listeners = new Map<FDC3Intents, FDC3ContextHandler>([
-      [FDC3Intents.controlClicked, (context) => console.log('Control clicked', context)],
-      [FDC3Intents.routeChanged, (context) => console.log('Route changed', context)],
-    ]);
-
-    this.fdc3Service.addIntentListeners(listeners);
-  }
-}
-```
-
-### Raising an Intent
-
-```typescript
-import { FDC3, FDC3Intents } from '@genesislcap/foundation-fdc3';
-import { FASTElement } from '@microsoft/fast-element';
-
-export class MyComponent extends FASTElement{
-  @FDC3 fdc3Service: FDC3;
-
-  onClick() {
-    this.fdc3Service.raiseIntent({ type: 'ViewChart', symbol: 'AAPL' }, FDC3Intents.controlClicked);
-  }
-}
-```
-
-### Joining a Channel
-
-```typescript
-import { FDC3 } from '@genesislcap/foundation-fdc3';
-import { FASTElement } from '@microsoft/fast-element';
-
-export class MyComponent extends FASTElement {
-  @FDC3 fdc3Service: FDC3;
-
-  connectedCallback() {
-    this.fdc3Service.joinChannel('blue');
-  }
-}
-```
-
-## Best Practices
-
-- **Intent and Context Definition:** Clearly define the intents and contexts your application will use or listen for, ensuring they align with FDC3 standards and facilitate meaningful interactions between applications.
-- **Error Handling:** Implement robust error handling for intent raising and context sharing operations, especially when dealing with asynchronous actions.
-- **Channel Usage:** When using channels for communication, ensure proper management of channel membership and context broadcasting to avoid unintended interactions.
-
-## Dependency Injection and Service Configuration
-
-The FDC3 service is designed to be easily integrated and configured within your application using dependency injection. This approach allows for flexible instantiation and usage of the FDC3 API, ensuring that financial desktop applications can leverage standard communication protocols for enhanced interoperability.
-
 ## License
 
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
+
 Genesis low-code platform

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-fdc3",
   "description": "Genesis Foundation FDC3",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -61,22 +61,22 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0",
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0",
     "sinon": "^17.0.1"
   },
   "dependencies": {
     "@finos/fdc3": "2.1.1",
-    "@genesislcap/foundation-logger": "14.408.0",
-    "@genesislcap/foundation-notifications": "14.408.0",
-    "@genesislcap/foundation-ui": "14.408.0",
-    "@genesislcap/foundation-utils": "14.408.0",
-    "@genesislcap/web-core": "14.408.0",
+    "@genesislcap/foundation-logger": "14.409.0",
+    "@genesislcap/foundation-notifications": "14.409.0",
+    "@genesislcap/foundation-ui": "14.409.0",
+    "@genesislcap/foundation-utils": "14.409.0",
+    "@genesislcap/web-core": "14.409.0",
     "@interopio/desktop": "^6.3.1",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.50.0",
@@ -90,5 +90,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

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

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md) &gt; [channelName](./foundation-fdc3.appchannellistenerconfig.channelname.md)
-
-## AppChannelListenerConfig.channelName property
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-channelName: string;
-```

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

@@ -1,62 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md)
-
-## AppChannelListenerConfig interface
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-fdc3-context-listener listen channel config
-
-**Signature:**
-
-```typescript
-export interface AppChannelListenerConfig extends SystemChannelListenerConfig 
-```
-**Extends:** [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md)
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[channelName](./foundation-fdc3.appchannellistenerconfig.channelname.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,86 +0,0 @@
-<!-- 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; [addChannelListener](./foundation-fdc3.fdc3.addchannellistener.md)
-
-## FDC3.addChannelListener() method
-
-Helper function to add a context listener on a channel with a handler for channel messages
-
-**Signature:**
-
-```typescript
-addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-channelName
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-name of the channel
-
-
-</td></tr>
-<tr><td>
-
-channelType
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-type of the channel
-
-
-</td></tr>
-<tr><td>
-
-callback
-
-
-</td><td>
-
-(any: any) =&gt; void
-
-
-</td><td>
-
-handler to for the channel context listener
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Channel&gt;
-

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

@@ -1,54 +0,0 @@
-<!-- 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; [addIntentListeners](./foundation-fdc3.fdc3.addintentlisteners.md)
-
-## FDC3.addIntentListeners() method
-
-Adds intent listeners for the specified intents.
-
-**Signature:**
-
-```typescript
-addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-listeners
-
-
-</td><td>
-
-Map&lt;[FDC3Intents](./foundation-fdc3.fdc3intents.md)<!-- -->, [FDC3ContextHandler](./foundation-fdc3.fdc3contexthandler.md)<!-- -->&gt;
-
-
-</td><td>
-
-The intent listeners to add.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

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

@@ -1,70 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-channelType
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-type of the channel
-
-
-</td></tr>
-<tr><td>
-
-callback
-
-
-</td><td>
-
-(any: any) =&gt; void
-
-
-</td><td>
-
-handler to for the channel context listener
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-

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

@@ -1,86 +0,0 @@
-<!-- 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; [broadcastOnChannel](./foundation-fdc3.fdc3.broadcastonchannel.md)
-
-## FDC3.broadcastOnChannel() method
-
-Broadcasts a message on a given channel with a given type
-
-**Signature:**
-
-```typescript
-broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-channelName
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-name of the channel
-
-
-</td></tr>
-<tr><td>
-
-type
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-type of the channel
-
-
-</td></tr>
-<tr><td>
-
-payload
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-payload sent to the channel
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-

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

@@ -1,70 +0,0 @@
-<!-- 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; [broadcastOnChannelEventHandler](./foundation-fdc3.fdc3.broadcastonchanneleventhandler.md)
-
-## FDC3.broadcastOnChannelEventHandler() method
-
-Helper function to broadcast message on channel in response to dispatched event
-
-**Signature:**
-
-```typescript
-broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-channelName
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-name of the channel
-
-
-</td></tr>
-<tr><td>
-
-type
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-type of the channel
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;(e: any) =&gt; Promise&lt;void&gt;&gt;
-

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

@@ -1,70 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-payload
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-payload sent to the channel
-
-
-</td></tr>
-<tr><td>
-
-type
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ type of the channel
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-

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

@@ -1,13 +0,0 @@
-<!-- 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>;
-```