@interopio/iocd-cli 0.0.92 → 1.0.0

package/dist/templates/tests/tests/package.json

@@ -1,19 +1,27 @@
 {
   "name": "tests",
   "version": "1.0.0",
-  "license": "ISC",
+  "private": true,
+  "type": "module",
+  "license": "MIT",
   "scripts": {
-    "test": "npx wdio run ./wdio.config.ts"
+    "test": "wdio run ./wdio.config.ts",
+    "typecheck": "tsc --noEmit -p ./tsconfig.json"
   },
   "devDependencies": {
-    "@interopio/wdio-iocd-service": "^0.1.1",
-    "@types/node": "^24.10.0",
-    "@wdio/cli": "^8.46.0",
-    "@wdio/local-runner": "^8.46.0",
-    "@wdio/mocha-framework": "^8.46.0",
-    "@wdio/spec-reporter": "^8.43.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.9.3",
-    "webdriverio": "^8.46.0"
+    "@interopio/desktop": "^6.21.0",
+    "@interopio/wdio-iocd-service": "1.0.0-next.2",
+    "@interopio/workspaces-api": "^4.5.0",
+    "@types/chai": "^5.2.3",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.20.1",
+    "@wdio/cli": "^9.29.1",
+    "@wdio/local-runner": "^9.29.1",
+    "@wdio/mocha-framework": "^9.29.1",
+    "@wdio/spec-reporter": "^9.29.1",
+    "chai": "^5.3.3",
+    "tsx": "^4.23.0",
+    "typescript": "^6.0.3",
+    "webdriverio": "^9.29.1"
   }
 }

package/dist/templates/tests/tests/tests/assets/applications/channel-client/index.html

@@ -0,0 +1,31 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Channel Client</title>
+  </head>
+  <body>
+    <main>
+      <h1>Channel Client</h1>
+      <p>Status: <strong id="channel-status" aria-live="polite">Connecting...</strong></p>
+      <p>Current Channel: <strong id="current-channel" aria-live="polite">None</strong></p>
+    </main>
+    <script>
+      const status = document.querySelector("#channel-status");
+      const currentChannel = document.querySelector("#current-channel");
+
+      IODesktop({ channels: true }).then((io) => {
+        window.io = io;
+
+        const showChannels = (channels) => {
+          currentChannel.textContent = channels.join(", ") || "None";
+        };
+
+        showChannels(io.channels.myChannels());
+        io.channels.onChannelsChanged(showChannels);
+        status.textContent = "Ready";
+      });
+    </script>
+  </body>
+</html>

package/dist/templates/tests/tests/tests/assets/applications/interop-responder/index.html

@@ -0,0 +1,25 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Interop Responder</title>
+  </head>
+  <body>
+    <main>
+      <h1>Interop Responder</h1>
+      <p id="status" aria-live="polite">Registering...</p>
+    </main>
+    <script>
+      const addMethod = "IOCD.Sample.Add";
+      const status = document.querySelector("#status");
+
+      IODesktop().then(async (io) => {
+        window.io = io;
+        // Register an Interop method the test will invoke from the runner.
+        await io.interop.register(addMethod, ({ a, b }) => ({ sum: a + b }));
+        status.textContent = "Ready";
+      });
+    </script>
+  </body>
+</html>

package/dist/templates/tests/tests/tests/assets/applications/people-list/index.html

@@ -0,0 +1,59 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>People</title>
+  </head>
+  <body>
+    <main>
+      <h1>People</h1>
+      <p>Select a person to send their name to the details app.</p>
+      <ul id="people-list">
+        <li><button type="button" data-person-name="Ada Lovelace" disabled>Ada Lovelace</button></li>
+        <li><button type="button" data-person-name="Grace Hopper" disabled>Grace Hopper</button></li>
+        <li><button type="button" data-person-name="Katherine Johnson" disabled>Katherine Johnson</button></li>
+        <li><button type="button" data-person-name="Margaret Hamilton" disabled>Margaret Hamilton</button></li>
+        <li><button type="button" data-person-name="Edsger Dijkstra" disabled>Edsger Dijkstra</button></li>
+      </ul>
+      <p id="selection-status" aria-live="polite">Connecting to the details app...</p>
+    </main>
+    <script>
+      const displayPersonMethod = "IOCD.Sample.DisplayPerson";
+      const buttons = Array.from(document.querySelectorAll("[data-person-name]"));
+      const status = document.querySelector("#selection-status");
+
+      IODesktop().then((io) => {
+        window.io = io;
+
+        const enableSelection = () => {
+          buttons.forEach((button) => {
+            button.disabled = false;
+          });
+          status.textContent = "Ready";
+        };
+
+        if (io.interop.methods({ name: displayPersonMethod }).length > 0) {
+          enableSelection();
+        } else {
+          let unsubscribe;
+          unsubscribe = io.interop.methodAdded((method) => {
+            if (method.name === displayPersonMethod) {
+              enableSelection();
+              unsubscribe?.();
+            }
+          });
+        }
+
+        buttons.forEach((button) => {
+          button.addEventListener("click", async () => {
+            const name = button.dataset.personName;
+            status.textContent = `Sending ${name}...`;
+            await io.interop.invoke(displayPersonMethod, { name }, "best");
+            status.textContent = `Sent ${name}`;
+          });
+        });
+      });
+    </script>
+  </body>
+</html>

package/dist/templates/tests/tests/tests/assets/applications/person-details/index.html

@@ -0,0 +1,26 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Person Details</title>
+  </head>
+  <body>
+    <main>
+      <h1>Person Details</h1>
+      <p>Selected person: <strong id="selected-person" aria-live="polite">None</strong></p>
+    </main>
+    <script>
+      const displayPersonMethod = "IOCD.Sample.DisplayPerson";
+      const selectedPerson = document.querySelector("#selected-person");
+
+      IODesktop().then(async (io) => {
+        window.io = io;
+        await io.interop.register(displayPersonMethod, ({ name }) => {
+          selectedPerson.textContent = name;
+          return { displayed: name };
+        });
+      });
+    </script>
+  </body>
+</html>

package/dist/templates/tests/tests/tests/assets/applications/shared-context-client/index.html

@@ -0,0 +1,37 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Shared Context Client</title>
+  </head>
+  <body>
+    <main>
+      <h1>Shared Context Client</h1>
+      <p>Status: <strong id="context-status" aria-live="polite">Connecting...</strong></p>
+      <button id="share-client" type="button" disabled>Share selected client</button>
+      <p>Selected client: <strong id="selected-client" aria-live="polite">None</strong></p>
+    </main>
+    <script>
+      const contextName = "IOCD.Sample.SelectedClient";
+      const selectedClient = document.querySelector("#selected-client");
+      const status = document.querySelector("#context-status");
+      const shareClient = document.querySelector("#share-client");
+
+      IODesktop().then(async (io) => {
+        window.io = io;
+
+        await io.contexts.subscribe(contextName, (data) => {
+          selectedClient.textContent = data?.clientName ?? "None";
+        });
+
+        shareClient.addEventListener("click", async () => {
+          await io.contexts.set(contextName, { clientName: "Ada Lovelace" });
+        });
+
+        shareClient.disabled = false;
+        status.textContent = "Ready";
+      });
+    </script>
+  </body>
+</html>

package/dist/templates/tests/tests/tests/assets/applications/web/index.html

@@ -0,0 +1,31 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>IOCD Test App</title>
+    <script>
+      IODesktop().then((desktop) => {
+        window.io = desktop;
+        console.log("IOCD Desktop API is ready to use.");
+      });
+    </script>
+  </head>
+  <body>
+    <main>
+      <h1>IOCD Test App</h1>
+      <button id="increment-counter" type="button">Increment counter</button>
+      <p>Count: <span id="counter" aria-live="polite">0</span></p>
+    </main>
+    <script>
+      const incrementButton = document.querySelector("#increment-counter");
+      const counter = document.querySelector("#counter");
+      let count = 0;
+
+      incrementButton.addEventListener("click", () => {
+        count += 1;
+        counter.textContent = String(count);
+      });
+    </script>
+  </body>
+</html>

package/dist/templates/tests/tests/tests/assets/applications/workspace-widget/index.html

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Workspace Widget</title>
+  </head>
+  <body>
+    <main>
+      <h1 id="widget-ready">Workspace Widget</h1>
+      <p>Added to the workspace through the add-application popup.</p>
+    </main>
+  </body>
+</html>

package/dist/templates/tests/tests/tests/channel-selector.spec.ts

@@ -0,0 +1,80 @@
+import { expect } from "chai";
+import type { IOConnectDesktop } from "@interopio/desktop";
+import { Group } from "@interopio/wdio-iocd-service/models";
+import { $, browser } from "@wdio/globals";
+
+// Selects a Channel through the Web Group caption UI and verifies that the
+// client app observes the resulting Channel membership through its IO API.
+describe("Channel Selector", function () {
+  this.timeout(60_000);
+
+  let instance: IOConnectDesktop.AppManager.Instance | undefined;
+  let windowId: string | undefined;
+
+  afterEach(async () => {
+    const io = await browser.io();
+    if (windowId) {
+      await io.channels.leave(windowId).catch(() => undefined);
+    }
+    await instance?.stop().catch(() => undefined);
+    instance = undefined;
+    windowId = undefined;
+  });
+
+  it("joins the Channel selected from the app caption", async () => {
+    const io = await browser.io();
+    const [channelName] = await io.channels.all();
+
+    expect(channelName, "configured test Channel").to.be.a("string").and.not.be.empty;
+
+    instance = await io.appManager.application("channel-client")!.start({}, { mode: "flat" });
+    const window = await instance.getWindow();
+    windowId = window.id;
+
+    await browser.switchById(window.id);
+    await browser.waitUntil(async () => (await $("#channel-status").getText()) === "Ready", {
+      timeoutMsg: "Expected the Channel client to initialize its Channels API",
+    });
+
+    expect(window.groupId, "Web Group ID").to.be.a("string").and.not.be.empty;
+
+    const group = new Group(window.groupId!);
+    const [frame] = await group.frames.waitForCount(1);
+    const channelSelector = frame.captionBar.channelSelector;
+
+    await group.switchTo();
+    await channelSelector.waitForDisplayed();
+    await channelSelector.click();
+    await switchToChannelSelectorPopup();
+
+    await $(`[data-testid="channel-selector-channel-${channelName}"]`).waitAndClick();
+
+    await browser.switchById(window.id);
+    const currentChannel = await $("#current-channel");
+    await browser.waitUntil(async () => (await currentChannel.getText()) === channelName, {
+      timeoutMsg: `Expected the app to join the ${channelName} Channel`,
+    });
+
+    expect(await currentChannel.getText()).to.equal(channelName);
+  });
+});
+
+async function switchToChannelSelectorPopup(): Promise<void> {
+  await browser.waitUntil(
+    async () => {
+      for (const handle of await browser.getWindowHandles()) {
+        try {
+          await browser.switchToWindow(handle);
+          if (await $(".io-channel-selector-panel").isDisplayed()) {
+            return true;
+          }
+        } catch {
+          // The popup can be created or removed while handles are being inspected.
+        }
+      }
+
+      return false;
+    },
+    { timeoutMsg: "Expected the Channel Selector popup to open" }
+  );
+}

package/dist/templates/tests/tests/tests/common/iocd.ts

@@ -0,0 +1,125 @@
+export async function waitFor(
+  condition: () => boolean | Promise<boolean>,
+  timeoutMs = 5000,
+  intervalMs = 100
+): Promise<void> {
+  const deadline = Date.now() + timeoutMs;
+  while (!(await condition())) {
+    if (Date.now() >= deadline) {
+      throw new Error(`Condition was not met within ${timeoutMs}ms.`);
+    }
+    await new Promise(resolve => setTimeout(resolve, intervalMs));
+  }
+}
+
+type Cleanup = () => void | Promise<void>;
+
+export function createCleanupRegistry() {
+  const cleanups: Cleanup[] = [];
+
+  return {
+    add(cleanup: Cleanup): Cleanup {
+      cleanups.push(cleanup);
+      return cleanup;
+    },
+    async run(): Promise<void> {
+      const pending = cleanups.splice(0).reverse();
+      let firstError: unknown;
+
+      for (const cleanup of pending) {
+        try {
+          await cleanup();
+        } catch (error) {
+          firstError ??= error;
+        }
+      }
+
+      if (firstError) {
+        throw firstError;
+      }
+    },
+  };
+}
+
+interface WaitForEventOptions<T> {
+  predicate?: (value: T) => boolean;
+  timeoutMs?: number;
+  timeoutMsg?: string;
+}
+
+export async function waitForEvent<T>(
+  subscribe: (listener: (value: T) => void) => Cleanup | Promise<Cleanup>,
+  options: WaitForEventOptions<T> = {}
+): Promise<{ result: Promise<T>; unsubscribe: Cleanup }> {
+  const {
+    predicate = () => true,
+    timeoutMs = 5000,
+    timeoutMsg = `Event was not received within ${timeoutMs}ms.`,
+  } = options;
+
+  let resolveResult!: (value: T) => void;
+  let rejectResult!: (error: Error) => void;
+  let subscriptionCleanup: Cleanup | undefined;
+  let cleanupRequested = false;
+  let settled = false;
+
+  const result = new Promise<T>((resolve, reject) => {
+    resolveResult = resolve;
+    rejectResult = reject;
+  });
+
+  const unsubscribe: Cleanup = async () => {
+    if (!subscriptionCleanup) {
+      cleanupRequested = true;
+      return;
+    }
+
+    const cleanup = subscriptionCleanup;
+    subscriptionCleanup = undefined;
+    await cleanup();
+  };
+
+  const timeout = setTimeout(() => {
+    if (settled) {
+      return;
+    }
+
+    settled = true;
+    void (async () => {
+      try {
+        await unsubscribe();
+      } finally {
+        rejectResult(new Error(timeoutMsg));
+      }
+    })().catch(() => undefined);
+  }, timeoutMs);
+
+  try {
+    subscriptionCleanup = await subscribe((value) => {
+      if (settled || !predicate(value)) {
+        return;
+      }
+
+      settled = true;
+      clearTimeout(timeout);
+      void (async () => {
+        try {
+          await unsubscribe();
+          resolveResult(value);
+        } catch (error) {
+          rejectResult(error instanceof Error ? error : new Error(String(error)));
+        }
+      })();
+    });
+
+    if (cleanupRequested) {
+      await unsubscribe();
+    }
+  } catch (error) {
+    settled = true;
+    clearTimeout(timeout);
+    rejectResult(error instanceof Error ? error : new Error(String(error)));
+  }
+
+  return { result, unsubscribe };
+}

package/dist/templates/tests/tests/tests/config/apps.json

@@ -0,0 +1,96 @@
+[
+  {
+    "name": "web",
+    "title": "IOCD Test App",
+    "type": "window",
+    "allowScriptExecution": true,
+    "details": {
+      "left": 100,
+      "top": 100,
+      "height": 400,
+      "width": 400,
+      "url": "file://%WDIO_TESTS_ROOT%/assets/applications/web/index.html",
+      "allowOverrides": {
+        "url": true
+      }
+    },
+    "hidden": true,
+    "ignoreSavedLayout": true
+  },
+  {
+    "name": "people-list",
+    "title": "People",
+    "type": "window",
+    "details": {
+      "height": 500,
+      "width": 360,
+      "url": "file://%WDIO_TESTS_ROOT%/assets/applications/people-list/index.html"
+    },
+    "hidden": true,
+    "ignoreSavedLayout": true
+  },
+  {
+    "name": "person-details",
+    "title": "Person Details",
+    "type": "window",
+    "details": {
+      "height": 500,
+      "width": 480,
+      "url": "file://%WDIO_TESTS_ROOT%/assets/applications/person-details/index.html"
+    },
+    "hidden": true,
+    "ignoreSavedLayout": true
+  },
+  {
+    "name": "interop-responder",
+    "title": "Interop Responder",
+    "type": "window",
+    "details": {
+      "height": 200,
+      "width": 320,
+      "url": "file://%WDIO_TESTS_ROOT%/assets/applications/interop-responder/index.html"
+    },
+    "hidden": true,
+    "ignoreSavedLayout": true
+  },
+  {
+    "name": "channel-client",
+    "title": "Channel Client",
+    "type": "window",
+    "details": {
+      "height": 260,
+      "width": 360,
+      "url": "file://%WDIO_TESTS_ROOT%/assets/applications/channel-client/index.html",
+      "channelSelector": {
+        "enabled": true,
+        "type": "single"
+      }
+    },
+    "ignoreSavedLayout": true
+  },
+  {
+    "name": "shared-context-client",
+    "title": "Shared Context Client",
+    "type": "window",
+    "details": {
+      "height": 300,
+      "width": 380,
+      "url": "file://%WDIO_TESTS_ROOT%/assets/applications/shared-context-client/index.html"
+    },
+    "ignoreSavedLayout": true
+  },
+  {
+    "name": "workspace-widget",
+    "title": "Workspace Widget",
+    "type": "window",
+    "details": {
+      "height": 300,
+      "width": 360,
+      "url": "file://%WDIO_TESTS_ROOT%/assets/applications/workspace-widget/index.html"
+    },
+    "customProperties": {
+      "includeInWorkspaces": true
+    },
+    "ignoreSavedLayout": true
+  }
+]

package/dist/templates/tests/tests/tests/interop.spec.ts

@@ -0,0 +1,37 @@
+import { expect } from "chai";
+import type { IOConnectDesktop } from "@interopio/desktop";
+import { browser } from "@wdio/globals";
+import { waitFor } from "./common/iocd";
+
+// Shows the request/response Interop pattern driven from the test itself:
+// the test starts an app that registers a method, then invokes it and asserts
+// the returned value. The existing workspace sample only exercises Interop
+// between two apps; here the test process is the caller.
+describe("Interop request/response", () => {
+  let instance: IOConnectDesktop.AppManager.Instance | undefined;
+
+  afterEach(async () => {
+    // Stop the responder app even if the test failed.
+    await instance?.stop().catch(() => undefined);
+    instance = undefined;
+  });
+
+  it("invokes an Interop method registered by another app", async () => {
+    const io = await browser.io();
+    const methodName = "IOCD.Sample.Add";
+
+    // Start the app that registers the Interop method.
+    instance = await io.appManager.application("interop-responder")!.start();
+
+    // The app registers the method asynchronously once its API is ready, so
+    // wait for it to be published before invoking it.
+    await waitFor(() =>
+      io.interop.methods().some((method) => method.name === methodName)
+    );
+
+    // Invoke the method and assert the app's computed response.
+    const result = await io.interop.invoke(methodName, { a: 2, b: 3 });
+
+    expect((result.returned as { sum: number }).sum).to.equal(5);
+  });
+});

package/dist/templates/tests/tests/tests/notifications.spec.ts

@@ -0,0 +1,37 @@
+import { expect } from "chai";
+import { $, browser } from "@wdio/globals";
+
+// Raises a notification and asserts it in the Notification Panel. This is the
+// only sample that uses the panel-specific service commands:
+// browser.switchToNotificationPanel() and element.waitForChildrenCount().
+describe("Notifications", () => {
+  afterEach(async () => {
+    // Clear every notification so the next test starts from an empty panel.
+    const io = await browser.io();
+    await io.notifications.clearAll().catch(() => undefined);
+  });
+
+  it("shows a raised notification in the Notification Panel", async () => {
+    const io = await browser.io();
+    const title = "Trade executed";
+    const body = "AAPL 100 @ 190.25";
+
+    // Notifications are disabled on a fresh platform; enable before raising.
+    await io.notifications.configure({ enable: true });
+    await io.notifications.raise({ title, body });
+
+    // Open the panel through the API, then move the WebdriverIO context to it.
+    // switchToNotificationPanel() only switches focus; it doesn't open the panel.
+    await io.notifications.panel.show();
+    await browser.switchToNotificationPanel();
+
+    // waitForChildrenCount waits until the list holds exactly one notification.
+    const list = await $(".io-notification-list");
+    await list.waitForChildrenCount(".io-notification", 1);
+
+    const notificationTitle = await $(
+      ".io-notification .io-notification-body-content .io-title"
+    );
+    expect(await notificationTitle.getText()).to.equal(title);
+  });
+});