implement addIntentWithContextListener

Author: Roaders

CHANGELOG.md

@@ -42,6 +42,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Setup package publishing for mono-repo packages. ([#1520](https://github.com/finos/FDC3/pull/1520))
 * Implementation PR for FDC3 for the Web ([#896](https://github.com/finos/FDC3/pull/896))
 * Adjusted reference Desktop Agent implementation for FDC3 for Web to open a new app instance when raiseIntent is called with an appId but no instanceId ([#1556](https://github.com/finos/FDC3/pull/1556))
+* Added `addIntentWithContextListener` to `DesktopAgent` and implemented in `DesktopAgentProxy`
 
 ### Changed
 

packages/fdc3-agent-proxy/src/DesktopAgentProxy.ts

@@ -66,6 +66,7 @@ export class DesktopAgentProxy implements DesktopAgent, Connectable {
     this.findIntentsByContext = this.findIntentsByContext.bind(this);
     this.raiseIntent = this.raiseIntent.bind(this);
     this.addIntentListener = this.addIntentListener.bind(this);
+    this.addIntentListenerWithContext = this.addIntentListenerWithContext.bind(this);
     this.raiseIntentForContext = this.raiseIntentForContext.bind(this);
     this.open = this.open.bind(this);
     this.findInstances = this.findInstances.bind(this);
@@ -183,6 +184,10 @@ export class DesktopAgentProxy implements DesktopAgent, Connectable {
     return this.intents.addIntentListener(intent, handler);
   }
 
+  addIntentListenerWithContext(intent: string, contextType: string | string[], handler: IntentHandler) {
+    return this.intents.addIntentListenerWithContext(intent, contextType, handler);
+  }
+
   raiseIntentForContext(context: Context, app?: string | AppIdentifier): Promise<IntentResolution> {
     return this.intents.raiseIntentForContext(context, this.ensureAppId(app));
   }

packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts

@@ -217,7 +217,23 @@ export class DefaultIntentSupport implements IntentSupport {
   }
 
   async addIntentListener(intent: string, handler: IntentHandler): Promise<Listener> {
-    const out = new DefaultIntentListener(this.messaging, intent, handler, this.messageExchangeTimeout);
+    const out = new DefaultIntentListener(this.messaging, intent, undefined, handler, this.messageExchangeTimeout);
+    await out.register();
+    return out;
+  }
+
+  async addIntentListenerWithContext(
+    intent: string,
+    contextType: string | string[],
+    handler: IntentHandler
+  ): Promise<Listener> {
+    const out = new DefaultIntentListener(
+      this.messaging,
+      intent,
+      Array.isArray(contextType) ? contextType : [contextType],
+      handler,
+      this.messageExchangeTimeout
+    );
     await out.register();
     return out;
   }

packages/fdc3-agent-proxy/src/intents/IntentSupport.ts

@@ -7,4 +7,9 @@ export interface IntentSupport {
   raiseIntent(intent: string, context: Context, app?: AppIdentifier): Promise<IntentResolution>;
   raiseIntentForContext(context: Context, app?: AppIdentifier): Promise<IntentResolution>;
   addIntentListener(intent: string, handler: IntentHandler): Promise<Listener>;
+  addIntentListenerWithContext(
+    intent: string,
+    contextType: string | string[],
+    handler: IntentHandler
+  ): Promise<Listener>;
 }

packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts

@@ -7,28 +7,34 @@ import {
   IntentEvent,
   IntentResultRequest,
   IntentResultResponse,
-  //RaiseIntentResponse,
 } from '@finos/fdc3-schema/dist/generated/api/BrowserTypes';
 
 export class DefaultIntentListener extends AbstractListener<IntentHandler, AddIntentListenerRequest> {
-  readonly intent: string;
-
-  constructor(messaging: Messaging, intent: string, action: IntentHandler, messageExchangeTimeout: number) {
+  constructor(
+    messaging: Messaging,
+    private readonly intent: string,
+    private readonly contextTypes: string[] | undefined,
+    action: IntentHandler,
+    messageExchangeTimeout: number
+  ) {
     super(
       messaging,
       messageExchangeTimeout,
-      { intent },
+      { intent, contextTypes },
       action,
       'addIntentListenerRequest',
       'addIntentListenerResponse',
       'intentListenerUnsubscribeRequest',
       'intentListenerUnsubscribeResponse'
     );
-    this.intent = intent;
   }
 
   filter(m: IntentEvent): boolean {
-    return m.type == 'intentEvent' && m.payload.intent == this.intent;
+    return (
+      m.type == 'intentEvent' &&
+      m.payload.intent == this.intent &&
+      (this.contextTypes == null || this.contextTypes.includes(m.payload.context.type))
+    );
   }
 
   action(m: IntentEvent): void {

packages/fdc3-context/generated/context/ContextTypes.ts

@@ -1980,6 +1980,10 @@ export interface Trade {
    * A human-readable summary of the trade.
    */
   name?: string;
+  /**
+   * Additional notes or comments about the trade.
+   */
+  notes?: string;
   /**
    * A product that is the subject of the trade.
    */
@@ -2044,6 +2048,10 @@ export interface TradeElement {
    * A human-readable summary of the trade.
    */
   name?: string;
+  /**
+   * Additional notes or comments about the trade.
+   */
+  notes?: string;
   /**
    * A product that is the subject of the trade.
    */
@@ -3067,6 +3075,7 @@ const typeMap: any = {
     [
       { json: 'id', js: 'id', typ: m('') },
       { json: 'name', js: 'name', typ: u(undefined, '') },
+      { json: 'notes', js: 'notes', typ: u(undefined, '') },
       { json: 'product', js: 'product', typ: r('ProductObject') },
       { json: 'type', js: 'type', typ: r('TradeType') },
     ],
@@ -3085,6 +3094,7 @@ const typeMap: any = {
     [
       { json: 'id', js: 'id', typ: m('') },
       { json: 'name', js: 'name', typ: u(undefined, '') },
+      { json: 'notes', js: 'notes', typ: u(undefined, '') },
       { json: 'product', js: 'product', typ: r('ProductObject') },
       { json: 'type', js: 'type', typ: r('TradeType') },
     ],

packages/fdc3-get-agent/test/step-definitions/desktop-agent.steps.ts

@@ -223,6 +223,7 @@ Given('A Dummy Desktop Agent in {string}', async function (this: CustomWorld, fi
     raiseIntent: notImplemented,
     raiseIntentForContext: notImplemented,
     addIntentListener: notImplemented,
+    addIntentListenerWithContext: notImplemented,
     addContextListener: notImplemented,
     addEventListener: notImplemented,
     getUserChannels: notImplemented,