2.0 FDC3 For The Web

package.json

@@ -5,7 +5,7 @@
     "compile": "webpack build",
     "replace-glue-core": "npm run copy && npx replace-in-file --configFile=options/glue-core-app-1.2.js && npx replace-in-file --configFile=options/glue-core-support-1.2.js && npx replace-in-file --configFile=options/glue-core-app-2.0.js && npx replace-in-file --configFile=options/glue-core-support-2.0.js",
     "replace-glue-core-plus": "npm run copy && npx replace-in-file --configFile=options/glue-core-plus-app-2.0.js && npx replace-in-file --configFile=options/glue-core-support-2.0.js",
-    "copy-glue-libs" : "shx cp -R options/glue/* ./dist",
+    "copy-glue-libs": "shx cp -R options/glue/* ./dist",
     "replace-connectifi": "npm run copy && npx replace-in-file --configFile=options/connectifi-adapter.js",
     "serve": "npx http-server ./dist -p 3001 -c-1",
     "start": "npm run copy && npm run compile && npm run serve",
@@ -18,7 +18,7 @@
     "buffer": "^6.0.3",
     "chai": "^4.3.6",
     "fdc3_1_2": "npm:@finos/fdc3@^1.2.0",
-    "fdc3_2_0": "npm:@finos/fdc3@^2.0.0-beta.4",
+    "fdc3_2_2": "npm:@finos/fdc3@^2.2.0",
     "mocha": "^10.0.0",
     "process": "^0.11.10",
     "source-map-support": "^0.5.21",
@@ -40,4 +40,4 @@
     "webpack": "^5.69.1",
     "webpack-cli": "^4.9.2"
   }
-}
+}

src/context-types.ts

@@ -14,6 +14,10 @@ export interface AppControlContext extends CommonContext {
   errorMessage?: string;
 }
 
+export interface AppControlContextListener {
+  listenerPromise: Promise<AppControlContext>
+}
+
 export interface IntentUtilityContext extends CommonContext {
   delayBeforeReturn?: number;
   onUnsubscribedTriggered?: boolean;

src/mock/v1.2/mock-functions.ts

@@ -1,6 +1,7 @@
 import { DesktopAgent } from "fdc3_1_2/dist/api/DesktopAgent";
 import constants from "../../constants";
 import { AppControlContext } from "../../context-types";
+import { getAgent } from "fdc3_2_2";
 
 declare let fdc3: DesktopAgent;
 
@@ -9,7 +10,7 @@ export const onFdc3Ready = () =>
     if (window.fdc3) {
       resolve(undefined);
     } else {
-      window.addEventListener("fdc3Ready", () => resolve(undefined));
+      getAgent().then(() => resolve(undefined));
     }
   });
 

src/mock/v2.0/basic.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0/dist/api/DesktopAgent";
+import { DesktopAgent } from "fdc3_2_2";
 import { sendContextToTests } from "./mock-functions";
 import { AppControlContext } from "../../context-types";
 import { ControlContextType, Intent } from "../../test/v2.0/support/intent-support-2.0";

src/mock/v2.0/channel.ts

@@ -1,6 +1,6 @@
 import { ChannelService2_0 } from "./support/channel-support-2.0";
 import { onFdc3Ready } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0";
+import { DesktopAgent } from "fdc3_2_2";
 import { Fdc3CommandExecutor } from "../channel-command";
 import { ChannelsAppContext } from "../../test/common/control/channel-control";
 

src/mock/v2.0/general.ts

@@ -1,6 +1,6 @@
 import { closeWindowOnCompletion, onFdc3Ready } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0/dist/api/DesktopAgent";
-import { Context } from "fdc3_2_0";
+import { DesktopAgent } from "fdc3_2_2";
+import { Context } from "fdc3_2_2";
 import { sendContextToTests } from "../v2.0/mock-functions";
 import { AppControlContext } from "../../context-types";
 declare let fdc3: DesktopAgent;

src/mock/v2.0/intent-a.ts

@@ -2,7 +2,7 @@ import { closeWindowOnCompletion, onFdc3Ready, validateContext } from "./mock-fu
 import { sendContextToTests } from "../v2.0/mock-functions";
 import { wait } from "../../utils";
 import { IntentUtilityContext } from "../../context-types";
-import { IntentResult, DesktopAgent } from "fdc3_2_0";
+import { IntentResult, DesktopAgent } from "fdc3_2_2";
 import { ContextType, ControlContextType, Intent } from "../../test/v2.0/support/intent-support-2.0";
 declare let fdc3: DesktopAgent;
 

src/mock/v2.0/intent-b.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0/dist/api/DesktopAgent";
+import { DesktopAgent } from "fdc3_2_2";
 import { sendContextToTests } from "../v2.0/mock-functions";
 import { wait } from "../../utils";
 import { AppControlContext, IntentUtilityContext } from "../../context-types";

src/mock/v2.0/intent-c.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0/dist/api/DesktopAgent";
+import { DesktopAgent } from "fdc3_2_2";
 import { sendContextToTests } from "../v2.0/mock-functions";
 import { AppControlContext } from "../../context-types";
 import { ControlContextType, Intent } from "../../test/v2.0/support/intent-support-2.0";

src/mock/v2.0/intent-d.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0";
+import { DesktopAgent } from "fdc3_2_2";
 import { Intent } from "../../test/v2.0/support/intent-support-2.0";
 declare let fdc3: DesktopAgent;
 

src/mock/v2.0/intent-e.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready, sendContextToTests, validateContext } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0";
+import { DesktopAgent } from "fdc3_2_2";
 import { wait } from "../../utils";
 import { ContextType, ControlContextType, Intent } from "../../test/v2.0/support/intent-support-2.0";
 import constants from "../../constants";
@@ -10,16 +10,16 @@ declare let fdc3: DesktopAgent;
 onFdc3Ready().then(async () => {
   await closeWindowOnCompletion();
   const { appMetadata } = await fdc3.getInfo();
-  
+
   fdc3.addIntentListener(Intent.sharedTestingIntent2, async (context) => {
     validateContext(context.type, ContextType.testContextY);
     const channel = await fdc3.getOrCreateChannel("test-channel");
-    
+
     //set-up alert to test framework that the task was completed after a short delay
     setTimeout(async () => {
       await sendContextToTests({ type: ControlContextType.sharedTestingIntent2ResultSent, id: { key: "uniqueId" }, instanceId: appMetadata.instanceId });
     }, constants.ShortWait)
-    
+
     return channel;
   });
 });

src/mock/v2.0/intent-f.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready, sendContextToTests, validateContext } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0";
+import { DesktopAgent } from "fdc3_2_2";
 import { wait } from "../../utils";
 import { ContextType, ControlContextType, Intent } from "../../test/v2.0/support/intent-support-2.0";
 import constants from "../../constants";
@@ -18,7 +18,7 @@ onFdc3Ready().then(async () => {
     setTimeout(async () => {
       await sendContextToTests({ type: ControlContextType.sharedTestingIntent2ResultSent, id: { key: "uniqueId" }, instanceId: appMetadata.instanceId });
     }, constants.ShortWait)
-    
+
     return privateChannel;
   });
 });

src/mock/v2.0/intent-g.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0";
+import { DesktopAgent } from "fdc3_2_2";
 import { Intent } from "../../test/v2.0/support/intent-support-2.0";
 declare let fdc3: DesktopAgent;
 

src/mock/v2.0/intent-i.ts

@@ -1,14 +1,13 @@
 import {
-    closeWindowOnCompletion,
-    onFdc3Ready,
-  } from "./mock-functions";
-  import { DesktopAgent } from "fdc3_2_0";
-  declare let fdc3: DesktopAgent;
-
-  onFdc3Ready().then(async () => {
-    await closeWindowOnCompletion();
-    fdc3.addIntentListener("MadeUpIntent", async (context) => {
-      return context;
-    });
+  closeWindowOnCompletion,
+  onFdc3Ready,
+} from "./mock-functions";
+import { DesktopAgent } from "fdc3_2_2";
+declare let fdc3: DesktopAgent;
+
+onFdc3Ready().then(async () => {
+  await closeWindowOnCompletion();
+  fdc3.addIntentListener("MadeUpIntent", async (context) => {
+    return context;
   });
-  
+});

src/mock/v2.0/intent-j.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready, sendContextToTests, validateContext } from "./mock-functions";
-import { ChannelError, DesktopAgent } from "fdc3_2_0";
+import { ChannelError, DesktopAgent } from "fdc3_2_2";
 import { ContextType, ControlContextType, Intent } from "../../test/v2.0/support/intent-support-2.0";
 
 declare let fdc3: DesktopAgent;

src/mock/v2.0/intent-k.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready, sendContextToTests, validateContext } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0";
+import { DesktopAgent } from "fdc3_2_2";
 import { wait } from "../../utils";
 import { IntentUtilityContext } from "../../context-types";
 import constants from "../../constants";

src/mock/v2.0/metadata.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready, sendContextToTests } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0";
+import { DesktopAgent } from "fdc3_2_2";
 import { AppControlContext } from "../../context-types";
 import { ControlContextType, Intent } from "../../test/v2.0/support/intent-support-2.0";
 

src/mock/v2.0/mock-functions.ts

@@ -1,6 +1,7 @@
-import { DesktopAgent } from "fdc3_2_0/dist/api/DesktopAgent";
+import { DesktopAgent } from "fdc3_2_2";
 import constants from "../../constants";
 import { AppControlContext } from "../../context-types";
+import { fdc3Ready } from "fdc3_2_2";
 
 declare let fdc3: DesktopAgent;
 
@@ -9,7 +10,7 @@ export const onFdc3Ready = () =>
     if (window.fdc3) {
       resolve(undefined);
     } else {
-      window.addEventListener("fdc3Ready", () => resolve(undefined));
+      fdc3Ready().then(() => resolve(undefined));
     }
   });
 

src/mock/v2.0/open-a.ts

@@ -1,5 +1,5 @@
 import { closeWindowOnCompletion, onFdc3Ready } from "./mock-functions";
-import { DesktopAgent } from "fdc3_2_0/dist/api/DesktopAgent";
+import { DesktopAgent } from "fdc3_2_2";
 import { sendContextToTests } from "../v2.0/mock-functions";
 import { AppControlContext } from "../../context-types";
 import { ControlContextType } from "../../test/v2.0/support/intent-support-2.0";

src/mock/v2.0/support/channel-support-2.0.ts

@@ -1,4 +1,4 @@
-import { Channel, DesktopAgent } from "fdc3_2_0";
+import { Channel, DesktopAgent } from "fdc3_2_2";
 import constants from "../../../constants";
 import { AppControlContext } from "../../../context-types";
 import { channelType } from "../../constants";

src/test/v1.2/fdc3-1_2-utils.ts

@@ -21,7 +21,7 @@ const broadcastCloseWindow = async (currentTest) => {
   } as AppControlContext);
 };
 
-export const waitForContext = (contextType: string, testId: string, channel?: Channel): Promise<AppControlContext> => {
+export const waitForContext = (contextType: string, testId: string, channel: Channel): Promise<AppControlContext> => {
   let executionListener: Listener;
   return new Promise<Context>(async (resolve) => {
     console.log(Date.now() + ` Waiting for type: "${contextType}", on channel: "${channel.id}" in test: "${testId}"`);

src/test/v1.2/index.ts

@@ -1,3 +1,4 @@
+import { fdc3Ready } from "fdc3_2_2";
 import { getPackMembers, getPackNames, executeTestsInBrowser } from "./testSuite";
 
 require("mocha/mocha.css");
@@ -29,7 +30,7 @@ function executeTests() {
   if (window.fdc3) {
     action();
   } else {
-    window.addEventListener("fdc3Ready", action);
+    fdc3Ready().then(() => action());
   }
 }
 

src/test/v2.0/advanced/fdc3.findInstances.ts

@@ -1,11 +1,11 @@
 import { assert, expect } from "chai";
 import { APIDocumentation2_0 } from "../../v2.0/apiDocuments-2.0";
-import { failOnTimeout, wrapPromise } from "../../../utils";
+import { failOnTimeout, wait, wrapPromise } from "../../../utils";
 import { closeMockAppWindow } from "../fdc3-2_0-utils";
 import { IntentUtilityContext } from "../../../context-types";
 import { MetadataFdc3Api } from "../support/metadata-support-2.0";
 import { ContextType, ControlContextType, Intent, IntentApp, RaiseIntentControl2_0 } from "../support/intent-support-2.0";
-import { AppIdentifier, IntentResolution } from "fdc3_2_0";
+import { AppIdentifier, IntentResolution } from "fdc3_2_2";
 
 const findInstancesDocs = "\r\nDocumentation: " + APIDocumentation2_0.findInstances + "\r\nCause: ";
 
@@ -14,14 +14,15 @@ const control = new RaiseIntentControl2_0();
 export default () =>
   describe("fdc3.findInstances", () => {
     after(async function after() {
-      await closeMockAppWindow(this.currentTest.title);
+      await closeMockAppWindow(this.currentTest.title, 2);
     });
 
     const findInstances = "(2.0-FindInstances) valid appID when opening multiple instances of the same app";
     it(findInstances, async () => {
       const api = new MetadataFdc3Api();
       let listener;
       try {
+
         const appIdentifier = await control.openIntentApp(IntentApp.IntentAppA); // open IntentAppA
         const appIdentifier2 = await control.openIntentApp(IntentApp.IntentAppA); // open second instance of IntentAppA
 
@@ -45,7 +46,7 @@ export default () =>
         const resolution = await api.raiseIntent(Intent.aTestingIntent, ContextType.testContextX, appIdentifier); // raise an intent that targets appIdentifier
         validateResolutionSource(resolution, appIdentifier);
         await wrapper.promise; // wait for context from IntentAppA
-        
+
       } catch (ex) {
         assert.fail(findInstancesDocs + (ex.message ?? ex));
       }
@@ -66,7 +67,7 @@ function validateInstances(instances: AppIdentifier[], appIdentifier: AppIdentif
   const compareAppIdentifiers = (a: AppIdentifier, b: AppIdentifier) => a.appId === b.appId && a.instanceId === b.instanceId;
 
   if (!(instances.some((instance) => compareAppIdentifiers(instance, appIdentifier)) &&
-       instances.some((instance) => compareAppIdentifiers(instance, appIdentifier2)))) {
+    instances.some((instance) => compareAppIdentifiers(instance, appIdentifier2)))) {
     assert.fail(`At least one AppIdentifier object is missing from the AppIdentifier array returned after calling fdc3.findInstances(app: AppIdentifier)${findInstancesDocs}`);
   }
 }

src/test/v2.0/advanced/fdc3.findIntent.ts

@@ -1,4 +1,4 @@
-import { AppIntent, IntentMetadata, ResolveError, DesktopAgent } from "fdc3_2_0";
+import { AppIntent, IntentMetadata, ResolveError, DesktopAgent } from "fdc3_2_2";
 import { assert, expect } from "chai";
 import { APIDocumentation2_0 } from "../apiDocuments-2.0";
 import { ContextType, IntentApp, Intent } from "../support/intent-support-2.0";
@@ -41,12 +41,12 @@ export default () =>
 
     it("(2.0-FindIntentAppDMultiple1) Should find intent 'sharedTestingIntent2' belonging to multiple apps (intent-a & intent-b)", async () => {
       const appIntent = await fdc3.findIntent(Intent.sharedTestingIntent2);
-      validateAppIntent(appIntent, 6, { name: Intent.sharedTestingIntent2, displayName: "Shared Testing Intent" }, IntentApp.IntentAppD);
+      validateAppIntent(appIntent, 6, { name: Intent.sharedTestingIntent2, displayName: "Shared Testing Intent 2" }, IntentApp.IntentAppD);
     });
 
     it("(IntentAppDMultiple2) Should find intent 'sharedTestingIntent2' belonging to multiple apps (intent-a & intent-b) filtered by specific context 'testContextY'", async () => {
       const appIntent = await fdc3.findIntent(Intent.sharedTestingIntent2, { type: ContextType.testContextY });
-      validateAppIntent(appIntent, 5, { name: Intent.sharedTestingIntent2, displayName: "Shared Testing Intent" }, IntentApp.IntentAppE);
+      validateAppIntent(appIntent, 5, { name: Intent.sharedTestingIntent2, displayName: "Shared Testing Intent 2" }, IntentApp.IntentAppE);
     });
 
     it("(2.0-FindIntentAppDByResultSingle) Should find intent 'cTestingIntent' belonging only to app intent-c with context 'testContextX' and result type 'testContextZ'", async () => {
@@ -61,17 +61,17 @@ export default () =>
 
     it("(2.0-FindIntentAppDByResultMultiple) Should find intent 'sharedTestingIntent1' belonging only to app intent-b with context 'testContextX' and result type 'testContextY'", async () => {
       const appIntent = await fdc3.findIntent(Intent.sharedTestingIntent1, { type: ContextType.testContextX }, ContextType.testContextY);
-      validateAppIntent(appIntent, 1, { name: Intent.sharedTestingIntent1, displayName: "Shared Testing Intent" }, IntentApp.IntentAppB);
+      validateAppIntent(appIntent, 1, { name: Intent.sharedTestingIntent1, displayName: "Shared Testing Intent 1" }, IntentApp.IntentAppB);
     });
 
     it("(2.0-FindIntentAppDByResultChannel1) Should find intent 'sharedTestingIntent2' belonging only to apps intent-e and itent-f with context 'testContextY' and result type 'channel", async () => {
       const appIntent = await fdc3.findIntent(Intent.sharedTestingIntent2, { type: ContextType.testContextY }, "channel");
-      validateAppIntent(appIntent, 2, { name: Intent.sharedTestingIntent2, displayName: "Shared Testing Intent" }, IntentApp.IntentAppE);
+      validateAppIntent(appIntent, 2, { name: Intent.sharedTestingIntent2, displayName: "Shared Testing Intent 2" }, IntentApp.IntentAppE);
     });
 
     it("(2.0-FindIntentAppDByResultChannel2) Should find intent 'sharedTestingIntent2' belonging only to app intent-c with context 'testContextY' and result type 'channel<testContextZ>'", async () => {
       const appIntent = await fdc3.findIntent(Intent.sharedTestingIntent2, { type: ContextType.testContextY }, "channel<testContextZ>");
-      validateAppIntent(appIntent, 1, { name: Intent.sharedTestingIntent2, displayName: "Shared Testing Intent" }, IntentApp.IntentAppF);
+      validateAppIntent(appIntent, 1, { name: Intent.sharedTestingIntent2, displayName: "Shared Testing Intent 2" }, IntentApp.IntentAppF);
     });
   });
 

src/test/v2.0/advanced/fdc3.findIntentsByContext.ts

@@ -1,7 +1,7 @@
-import { AppIntent, ResolveError } from "fdc3_2_0";
+import { AppIntent, ResolveError } from "fdc3_2_2";
 import { assert, expect } from "chai";
 import { APIDocumentation2_0 } from "../apiDocuments-2.0";
-import { DesktopAgent } from "fdc3_2_0/dist/api/DesktopAgent";
+import { DesktopAgent } from "fdc3_2_2";
 import { ContextType, IntentApp, Intent } from "../support/intent-support-2.0";
 
 declare let fdc3: DesktopAgent;

src/test/v2.0/advanced/fdc3.getInfo.ts

@@ -1,7 +1,7 @@
 import { assert, expect } from "chai";
 import { failOnTimeout, wrapPromise } from "../../../utils";
 import { closeMockAppWindow } from "../fdc3-2_0-utils";
-import { ImplementationMetadata, Listener } from "fdc3_2_0";
+import { ImplementationMetadata, Listener } from "fdc3_2_2";
 import { MetadataValidator, MetadataContext, MetadataFdc3Api } from "../support/metadata-support-2.0";
 import { APIDocumentation2_0 } from "../apiDocuments-2.0";
 import { ControlContextType } from "../support/intent-support-2.0";

src/test/v2.0/advanced/fdc3.open.ts

@@ -3,7 +3,7 @@ import { getCommonOpenTests } from "../../common/fdc3.open";
 import { openApp, OpenCommonConfig } from "../../common/control/open-control";
 import { APIDocumentation2_0 } from "../apiDocuments-2.0";
 import { OpenControl2_0 } from "../support/open-support-2.0";
-import { DesktopAgent } from "fdc3_2_0";
+import { DesktopAgent } from "fdc3_2_2";
 import { assert, expect } from "chai";
 
 const openDocs = "\r\nDocumentation: " + APIDocumentation2_0 + "\r\nCause:";
@@ -26,7 +26,7 @@ export default () =>
     const AOpensB4 = "(AOpensB4) Can open app B from app A with appId as config.target, and recieves the same appId and also contains InstanceId";
     it(AOpensB4, async () => {
       const result = control.contextReceiver("fdc3-conformance-opened");
-      const targetApp = {appId:openApp.b.id};
+      const targetApp = { appId: openApp.b.id };
       const instanceIdentifier = await control.openMockApp(targetApp);
       expect(instanceIdentifier.appId).to.eq(openApp.b.id);
       expect(instanceIdentifier).to.have.property("instanceId");

src/test/v2.0/advanced/fdc3.raiseIntent-NoAppsFound.ts

@@ -1,4 +1,4 @@
-import { ResolveError } from "fdc3_2_0";
+import { ResolveError } from "fdc3_2_2";
 import { assert, expect } from "chai";
 import { APIDocumentation2_0 } from "../apiDocuments-2.0";
 import { ContextType, IntentApp, Intent, RaiseIntentControl2_0 } from "../support/intent-support-2.0";