@overcrow/mcp 0.0.0 → 0.1.0

package/dist/content/examples/stopwatch/tests/gesture.scenario.json

@@ -0,0 +1,154 @@
+{
+  "scenarioVersion": 1,
+  "name": "gesture",
+  "description": "No input reaches a Passive widget: a click where the buttons would be calls nothing. In Interactive mode a click and Enter or Space on a focused button each make one call.",
+  "fixtures": {
+    "calls": {
+      "stopwatch.toggle": [
+        {
+          "value": {
+            "running": true,
+            "elapsedMs": 0,
+            "at": 0,
+            "shortcuts": {
+              "toggle": "Super+Alt+T",
+              "reset": "Super+Alt+Z",
+              "bound": true
+            }
+          }
+        },
+        {
+          "value": {
+            "running": false,
+            "elapsedMs": 0,
+            "at": 0,
+            "shortcuts": {
+              "toggle": "Super+Alt+T",
+              "reset": "Super+Alt+Z",
+              "bound": true
+            }
+          }
+        }
+      ],
+      "stopwatch.reset": [
+        {
+          "value": {
+            "running": false,
+            "elapsedMs": 0,
+            "at": 0,
+            "shortcuts": {
+              "toggle": "Super+Alt+T",
+              "reset": "Super+Alt+Z",
+              "bound": true
+            }
+          }
+        }
+      ]
+    },
+    "subscriptions": {
+      "stopwatch.subscribe": {
+        "running": false,
+        "elapsedMs": 0,
+        "at": 0,
+        "shortcuts": {
+          "toggle": "Super+Alt+T",
+          "reset": "Super+Alt+Z",
+          "bound": true
+        }
+      }
+    }
+  },
+  "steps": [
+    {
+      "pointer": {
+        "click": {
+          "at": [
+            160,
+            20
+          ]
+        }
+      }
+    },
+    {
+      "pointer": {
+        "click": {
+          "at": [
+            190,
+            20
+          ]
+        }
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:00:00.00"
+        ],
+        "calls": [
+          {
+            "service": "stopwatch.subscribe",
+            "outcome": "ok"
+          }
+        ]
+      }
+    },
+    {
+      "host": {
+        "mode": "interactive"
+      }
+    },
+    {
+      "pointer": {
+        "click": {
+          "label": "Start"
+        }
+      }
+    },
+    {
+      "expect": {
+        "calls": [
+          {
+            "service": "stopwatch.toggle",
+            "outcome": "ok"
+          }
+        ]
+      }
+    },
+    {
+      "key": {
+        "key": "Enter"
+      }
+    },
+    {
+      "expect": {
+        "calls": [
+          {
+            "service": "stopwatch.toggle",
+            "outcome": "ok"
+          }
+        ]
+      }
+    },
+    {
+      "key": {
+        "key": "Tab"
+      }
+    },
+    {
+      "key": {
+        "key": "Space"
+      }
+    },
+    {
+      "expect": {
+        "calls": [
+          {
+            "service": "stopwatch.reset",
+            "outcome": "ok"
+          }
+        ],
+        "fault": "none"
+      }
+    }
+  ]
+}

package/dist/content/examples/stopwatch/tests/hidden.scenario.json

@@ -0,0 +1,57 @@
+{
+  "scenarioVersion": 1,
+  "name": "hidden",
+  "description": "Hidden, nothing is repainted; shown again, the running time is current at once.",
+  "fixtures": {
+    "subscriptions": {
+      "stopwatch.subscribe": {
+        "running": true,
+        "elapsedMs": 60000,
+        "at": 0,
+        "shortcuts": {
+          "toggle": "Super+Alt+T",
+          "reset": "Super+Alt+Z",
+          "bound": true
+        }
+      }
+    }
+  },
+  "steps": [
+    {
+      "expect": {
+        "text": [
+          "00:01:00.00"
+        ]
+      }
+    },
+    {
+      "host": {
+        "visible": false
+      }
+    },
+    {
+      "advance": {
+        "ms": 600125
+      }
+    },
+    {
+      "host": {
+        "visible": true
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:11:00.12"
+        ],
+        "calls": [
+          {
+            "service": "stopwatch.subscribe",
+            "outcome": "ok"
+          }
+        ],
+        "fault": "none"
+      }
+    }
+  ]
+}

package/dist/content/examples/stopwatch/tests/hundredths.scenario.json

@@ -0,0 +1,173 @@
+{
+  "scenarioVersion": 1,
+  "name": "hundredths",
+  "description": "The host advances the hundredths, truncated, with no VM timer or call; a paused stopwatch never moves; hours grow past 99; a new anchor applies at once; without a game the time is unknown.",
+  "fixtures": {
+    "subscriptions": {
+      "stopwatch.subscribe": {
+        "running": true,
+        "elapsedMs": 1999,
+        "at": 0,
+        "shortcuts": {
+          "toggle": "Super+Alt+T",
+          "reset": "Super+Alt+Z",
+          "bound": true
+        }
+      }
+    }
+  },
+  "steps": [
+    {
+      "expect": {
+        "text": [
+          "00:00:01.99"
+        ],
+        "calls": [
+          {
+            "service": "stopwatch.subscribe",
+            "outcome": "ok"
+          }
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 1
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:00:02.00"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 9
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:00:02.00"
+        ],
+        "noText": [
+          "00:00:02.01"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 1
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:00:02.01"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 988
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:00:02.99"
+        ],
+        "calls": []
+      }
+    },
+    {
+      "publish": {
+        "service": "stopwatch.subscribe",
+        "value": {
+          "running": true,
+          "elapsedMs": 359999990,
+          "at": 999,
+          "shortcuts": {
+            "toggle": "Super+Alt+T",
+            "reset": "Super+Alt+Z",
+            "bound": true
+          }
+        }
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "99:59:59.99"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 10
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "100:00:00.00"
+        ],
+        "image": "hundred-hours"
+      }
+    },
+    {
+      "publish": {
+        "service": "stopwatch.subscribe",
+        "value": {
+          "running": false,
+          "elapsedMs": 3661250,
+          "at": 1009,
+          "shortcuts": {
+            "toggle": "Super+Alt+T",
+            "reset": "Super+Alt+Z",
+            "bound": true
+          }
+        }
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "01:01:01.25"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 60000
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "01:01:01.25"
+        ],
+        "calls": []
+      }
+    },
+    {
+      "publish": {
+        "service": "stopwatch.subscribe",
+        "value": null
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "--:--:--.--"
+        ],
+        "noText": [
+          "01:01:01.25"
+        ],
+        "fault": "none"
+      }
+    }
+  ]
+}

package/dist/content/examples/stopwatch/tests/load-logic.mjs

@@ -0,0 +1,22 @@
+// Compiles this widget's logic.ts with the project's TypeScript into
+// dist/ and imports it, after the test installed its runtime
+// (`@overcrow/sdk/testing`), as the VM runs logic.js after its prelude.
+import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import ts from "typescript";
+
+export async function loadLogic() {
+  const root = new URL("../", import.meta.url);
+  const source = readFileSync(new URL("logic.ts", root), "utf8");
+  const { outputText } = ts.transpileModule(source, {
+    compilerOptions: {
+      module: ts.ModuleKind.ES2022,
+      target: ts.ScriptTarget.ES2023,
+      verbatimModuleSyntax: true,
+    },
+  });
+  mkdirSync(new URL("dist/", root), { recursive: true });
+  // One file per test process: test files run in parallel.
+  const output = new URL(`dist/logic-${process.pid}.mjs`, root);
+  writeFileSync(output, outputText);
+  return import(output.href);
+}

package/dist/content/examples/stopwatch/tests/logic.test.mjs

@@ -0,0 +1,99 @@
+// Unit tests of the stopwatch's logic on @overcrow/sdk/testing.
+import assert from "node:assert/strict";
+import { readFileSync } from "node:fs";
+import { test } from "node:test";
+import { installRuntime } from "@overcrow/sdk/testing";
+
+import { loadLogic } from "./load-logic.mjs";
+
+const messages = (locale) =>
+  JSON.parse(readFileSync(new URL(`../locales/${locale}.json`, import.meta.url), "utf8"));
+
+const vm = installRuntime({
+  host: {
+    grants: ["stopwatch.read", "stopwatch.control"],
+    mode: "passive",
+    messages: messages("en"),
+  },
+});
+const logic = await loadLogic();
+const { state } = await import("@overcrow/sdk");
+
+const shortcuts = { toggle: "Super+Alt+T", reset: "Super+Alt+Z", bound: true };
+const at = (elapsedMs, running, time) => ({ running, elapsedMs, at: time, shortcuts });
+const settle = () => new Promise((resolve) => setImmediate(resolve));
+
+test("with the read grant, it subscribes once and starts unknown, without timers", () => {
+  assert.deepEqual(
+    vm.subscriptions.map(({ service, params }) => ({ service, params })),
+    [{ service: "stopwatch.subscribe", params: {} }],
+  );
+  assert.equal(state.stopwatch, null);
+  assert.equal(state.interactive, false);
+  assert.equal(vm.timers.length, 0, "the host advances the hundredths: no timer");
+});
+
+test("each update replaces the state; null and failures leave it unknown", () => {
+  vm.push("stopwatch.subscribe", at(123_450, true, 10));
+  assert.deepEqual(state.stopwatch, at(123_450, true, 10));
+  vm.push("stopwatch.subscribe", at(0, false, 20));
+  assert.deepEqual(state.stopwatch, at(0, false, 20), "a reset, or a new game");
+  vm.push("stopwatch.subscribe", null);
+  assert.equal(state.stopwatch, null, "no active game");
+  assert.equal(logic.current({ ok: false }), null);
+  assert.deepEqual(logic.current({ ok: true, value: at(5, false, 1) }), at(5, false, 1));
+});
+
+test("the buttons follow the mode, the control grant and a known state", () => {
+  const known = at(0, false, 0);
+  assert.equal(logic.showControls(false, known), false, "Passive: no buttons");
+  assert.equal(logic.showControls(true, null), false);
+  assert.equal(logic.showControls(true, known), true);
+  vm.setHost({ mode: "interactive" });
+  assert.equal(state.interactive, true);
+  vm.setHost({ mode: "passive" });
+  assert.equal(state.interactive, false);
+});
+
+test("a command's result applies at once; a failure changes nothing", async () => {
+  vm.push("stopwatch.subscribe", at(5_000, false, 0));
+  logic.toggle();
+  vm.lastCall("stopwatch.toggle").resolve(at(5_000, true, 30));
+  await settle();
+  assert.deepEqual(state.stopwatch, at(5_000, true, 30));
+  logic.reset();
+  vm.lastCall("stopwatch.reset").reject("unavailable");
+  await settle();
+  assert.deepEqual(state.stopwatch, at(5_000, true, 30), "the host did not act");
+  logic.reset();
+  vm.lastCall("stopwatch.reset").resolve(at(0, false, 40));
+  await settle();
+  assert.deepEqual(state.stopwatch, at(0, false, 40));
+  logic.toggle();
+  vm.lastCall("stopwatch.toggle").resolve(null);
+  await settle();
+  assert.equal(state.stopwatch, null, "the game ended meanwhile");
+  assert.deepEqual(
+    vm.calls.map(({ service }) => service),
+    ["stopwatch.toggle", "stopwatch.reset", "stopwatch.reset", "stopwatch.toggle"],
+  );
+});
+
+test("labels, tooltips and the reminder, in English and French", () => {
+  assert.equal(logic.toggleLabel(false), "Start");
+  assert.equal(logic.toggleLabel(true), "Pause");
+  assert.equal(logic.withChord("Start", "Super+Alt+T"), "Start (Super+Alt+T)");
+  assert.equal(
+    logic.reminder(shortcuts),
+    "Super+Alt+T  Start / pause  ·  Super+Alt+Z  Reset",
+  );
+  vm.setHost({ locale: "fr", messages: messages("fr") });
+  assert.equal(logic.toggleLabel(false), "Démarrer");
+  assert.equal(logic.toggleLabel(true), "Pause");
+  assert.equal(logic.withChord("Réinitialiser", "Ctrl+Shift+R"), "Réinitialiser (Ctrl+Shift+R)");
+  assert.equal(
+    logic.reminder({ toggle: "Ctrl+Shift+P", reset: "Ctrl+Shift+R", bound: false }),
+    "Ctrl+Shift+P  Démarrer / pause  ·  Ctrl+Shift+R  Réinitialiser",
+    "the reminder stays when the chords are not bound",
+  );
+});

package/dist/content/examples/stopwatch/tests/preview.scenario.json

@@ -0,0 +1,36 @@
+{
+  "scenarioVersion": 1,
+  "name": "preview",
+  "description": "A running stopwatch at 00:02:03.45 with its buttons in Interactive mode. The marketplace preview: dark theme, English, 150 %, on the stage colour; scripts/compose-previews.mjs frames it into assets/preview.png.",
+  "host": {
+    "mode": "interactive",
+    "scale": 1500,
+    "background": "#1e242e"
+  },
+  "fixtures": {
+    "subscriptions": {
+      "stopwatch.subscribe": {
+        "running": true,
+        "elapsedMs": 123450,
+        "at": 0,
+        "shortcuts": {
+          "toggle": "Super+Alt+T",
+          "reset": "Super+Alt+Z",
+          "bound": true
+        }
+      }
+    }
+  },
+  "steps": [
+    {
+      "expect": {
+        "state": "running",
+        "text": [
+          "00:02:03.45",
+          "Super+Alt+T  Start / pause  ·  Super+Alt+Z  Reset"
+        ],
+        "image": "preview"
+      }
+    }
+  ]
+}

package/dist/content/examples/stopwatch/tests/read-only.scenario.json

@@ -0,0 +1,42 @@
+{
+  "scenarioVersion": 1,
+  "name": "read-only",
+  "description": "With stopwatch.read only, the time and the reminder show, never the buttons.",
+  "host": {
+    "grants": [
+      "stopwatch.read"
+    ],
+    "mode": "interactive"
+  },
+  "fixtures": {
+    "subscriptions": {
+      "stopwatch.subscribe": {
+        "running": false,
+        "elapsedMs": 42420,
+        "at": 0,
+        "shortcuts": {
+          "toggle": "Super+Alt+T",
+          "reset": "Super+Alt+Z",
+          "bound": true
+        }
+      }
+    }
+  },
+  "steps": [
+    {
+      "expect": {
+        "text": [
+          "00:00:42.42"
+        ],
+        "calls": [
+          {
+            "service": "stopwatch.subscribe",
+            "outcome": "ok"
+          }
+        ],
+        "image": "read-only",
+        "fault": "none"
+      }
+    }
+  ]
+}

package/dist/content/examples/stopwatch/tests/read-only.test.mjs

@@ -0,0 +1,18 @@
+// With stopwatch.read alone the logic shows the time but never the buttons.
+import assert from "node:assert/strict";
+import { test } from "node:test";
+import { installRuntime } from "@overcrow/sdk/testing";
+
+import { loadLogic } from "./load-logic.mjs";
+
+const vm = installRuntime({ host: { grants: ["stopwatch.read"], mode: "interactive" } });
+const logic = await loadLogic();
+const { state } = await import("@overcrow/sdk");
+
+test("read only: subscribed, no buttons", () => {
+  assert.equal(vm.subscriptions.length, 1);
+  const known = { running: true, elapsedMs: 1, at: 0, shortcuts: { toggle: "", reset: "", bound: true } };
+  vm.push("stopwatch.subscribe", known);
+  assert.deepEqual(state.stopwatch, known);
+  assert.equal(logic.showControls(state.interactive, state.stopwatch), false);
+});

package/dist/content/examples/stopwatch/tests/refused.scenario.json

@@ -0,0 +1,22 @@
+{
+  "scenarioVersion": 1,
+  "name": "refused",
+  "description": "Without its grants the widget asks nothing and shows --:--:--.--, without buttons.",
+  "host": {
+    "grants": [],
+    "mode": "interactive"
+  },
+  "steps": [
+    {
+      "expect": {
+        "state": "running",
+        "text": [
+          "--:--:--.--"
+        ],
+        "calls": [],
+        "image": "refused",
+        "fault": "none"
+      }
+    }
+  ]
+}

package/dist/content/examples/stopwatch/tests/refused.test.mjs

@@ -0,0 +1,18 @@
+// Without its grants the logic asks the host nothing and shows no buttons.
+import assert from "node:assert/strict";
+import { test } from "node:test";
+import { installRuntime } from "@overcrow/sdk/testing";
+
+import { loadLogic } from "./load-logic.mjs";
+
+const vm = installRuntime({ host: { grants: [], mode: "interactive" } });
+const logic = await loadLogic();
+const { state } = await import("@overcrow/sdk");
+
+test("no grant: no subscription, unknown time, no buttons", () => {
+  assert.equal(vm.subscriptions.length, 0);
+  assert.equal(vm.calls.length, 0);
+  assert.equal(state.stopwatch, null);
+  const known = { running: false, elapsedMs: 0, at: 0, shortcuts: { toggle: "", reset: "", bound: false } };
+  assert.equal(logic.showControls(true, known), false, "no stopwatch.control");
+});