@overcrow/mcp 0.0.0 → 0.1.1

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

@@ -0,0 +1,25 @@
+{
+  "scenarioVersion": 1,
+  "name": "preview",
+  "description": "The clock with its default menu values at 14:08 local time. The marketplace preview: dark theme, English, 150 %, on the stage colour; scripts/compose-previews.mjs frames it into assets/preview.png.",
+  "host": {
+    "zone": {
+      "offsetMinutes": 120
+    },
+    "startAt": 1784290122000,
+    "scale": 1500,
+    "background": "#1e242e"
+  },
+  "steps": [
+    {
+      "expect": {
+        "state": "running",
+        "text": [
+          "14:08",
+          "17/07/2026"
+        ],
+        "image": "preview"
+      }
+    }
+  ]
+}

package/dist/content/examples/clock/tests/render.scenario.json

@@ -0,0 +1,94 @@
+{
+  "scenarioVersion": 1,
+  "name": "render",
+  "description": "Default menu values (date on, day/month/year, no seconds) at 14:08:42 local time (UTC+2), in both themes, both languages, at 100 % and 150 %.",
+  "host": {
+    "zone": {
+      "offsetMinutes": 120
+    },
+    "startAt": 1784290122000
+  },
+  "steps": [
+    {
+      "expect": {
+        "state": "running",
+        "text": [
+          "14:08",
+          "17/07/2026"
+        ],
+        "image": "default-dark-en-100"
+      }
+    },
+    {
+      "host": {
+        "theme": "light"
+      }
+    },
+    {
+      "expect": {
+        "image": "default-light-en-100"
+      }
+    },
+    {
+      "host": {
+        "locale": "fr"
+      }
+    },
+    {
+      "expect": {
+        "image": "default-light-fr-100"
+      }
+    },
+    {
+      "host": {
+        "theme": "dark"
+      }
+    },
+    {
+      "expect": {
+        "image": "default-dark-fr-100"
+      }
+    },
+    {
+      "host": {
+        "scale": 1500
+      }
+    },
+    {
+      "expect": {
+        "image": "default-dark-fr-150"
+      }
+    },
+    {
+      "host": {
+        "theme": "light"
+      }
+    },
+    {
+      "expect": {
+        "image": "default-light-fr-150"
+      }
+    },
+    {
+      "host": {
+        "locale": "en"
+      }
+    },
+    {
+      "expect": {
+        "image": "default-light-en-150"
+      }
+    },
+    {
+      "host": {
+        "theme": "dark"
+      }
+    },
+    {
+      "expect": {
+        "image": "default-dark-en-150",
+        "fault": "none"
+      }
+    }
+  ]
+}

package/dist/content/examples/clock/tests/summer-time.scenario.json

@@ -0,0 +1,74 @@
+{
+  "scenarioVersion": 1,
+  "name": "summer-time",
+  "description": "Central European summer time: 01:59 becomes 03:00 at 01:00 UTC on 2026-03-29, and 02:59 becomes 02:00 at 01:00 UTC on 2026-10-25.",
+  "host": {
+    "zone": {
+      "offsetMinutes": 60,
+      "transitions": [
+        {
+          "at": 1774746000000,
+          "offsetMinutes": 120
+        },
+        {
+          "at": 1792890000000,
+          "offsetMinutes": 60
+        }
+      ]
+    },
+    "startAt": 1774745970000
+  },
+  "steps": [
+    {
+      "expect": {
+        "text": [
+          "01:59",
+          "29/03/2026"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 30000
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "03:00"
+        ],
+        "noText": [
+          "02:00"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 18143970000,
+        "jump": true
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "02:59",
+          "25/10/2026"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 30000
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "02:00",
+          "25/10/2026"
+        ],
+        "fault": "none"
+      }
+    }
+  ]
+}

package/dist/content/examples/clock/tests/ticks.scenario.json

@@ -0,0 +1,120 @@
+{
+  "scenarioVersion": 1,
+  "name": "ticks",
+  "description": "The time changes at each local minute, or each second with seconds on, and the date at local midnight; turning seconds on or off applies at once.",
+  "host": {
+    "zone": {
+      "offsetMinutes": 60
+    },
+    "startAt": 1798757998000
+  },
+  "steps": [
+    {
+      "expect": {
+        "text": [
+          "23:59",
+          "31/12/2026"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 1999
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "23:59"
+        ],
+        "noText": [
+          "00:00"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 1
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:00",
+          "01/01/2027"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 5000
+      }
+    },
+    {
+      "menu": {
+        "id": "show-seconds",
+        "value": true
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:00:05"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 1000
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:00:06"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 58000
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:01:04"
+        ]
+      }
+    },
+    {
+      "menu": {
+        "id": "show-seconds",
+        "value": false
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:01"
+        ],
+        "noText": [
+          "00:01:04"
+        ]
+      }
+    },
+    {
+      "advance": {
+        "ms": 56000
+      }
+    },
+    {
+      "expect": {
+        "text": [
+          "00:02"
+        ],
+        "fault": "none"
+      }
+    }
+  ]
+}

package/dist/content/examples/clock/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "types": [],
+    "module": "ES2022",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "noEmit": true,
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true
+  },
+  "include": ["logic.ts"]
+}

package/dist/content/examples/clock/view.ocml

@@ -0,0 +1,8 @@
+<!-- Clock: the local time of day and, optionally, the date on a second line
+     (parity sheet: playervox-overcrow docs/builtin-parity/clock.md). -->
+<box class="clock" label={clockLabel(state.now, state.seconds, state.showDate, state.order)}>
+  <text class="time">{clockTime(state.now, state.seconds)}</text>
+  <if test={state.showDate}>
+    <text class="date">{clockDate(state.now, state.order)}</text>
+  </if>
+</box>

package/dist/content/examples/countdown/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) the authors of Countdown
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/content/examples/countdown/listing.json

@@ -0,0 +1,10 @@
+{
+  "author": "Example Studio",
+  "spdxLicense": "MIT",
+  "sourceUrl": "https://github.com/example/countdown-widget",
+  "defaultLocale": "en",
+  "localizations": [
+    { "locale": "en", "name": "Countdown", "description": "A countdown of a few minutes that counts the rounds you finish." },
+    { "locale": "fr", "name": "Compte à rebours", "description": "Un compte à rebours de quelques minutes, qui compte les tours terminés." }
+  ]
+}

package/dist/content/examples/countdown/locales/en.json

@@ -0,0 +1,15 @@
+{
+  "duration": "Duration",
+  "minutes": "{count} min",
+  "pause": "Pause",
+  "remaining": "Time left",
+  "repeat": "Start again when it ends",
+  "reset-rounds": "Reset the rounds",
+  "rounds": "Rounds",
+  "rounds-drawn": "{count} finished rounds",
+  "start": "Start",
+  "state": "State",
+  "state-done": "Finished",
+  "state-paused": "Paused",
+  "state-running": "Running"
+}

package/dist/content/examples/countdown/locales/fr.json

@@ -0,0 +1,15 @@
+{
+  "duration": "Durée",
+  "minutes": "{count} min",
+  "pause": "Mettre en pause",
+  "remaining": "Temps restant",
+  "repeat": "Recommencer à la fin",
+  "reset-rounds": "Remettre les tours à zéro",
+  "rounds": "Tours",
+  "rounds-drawn": "{count} tours terminés",
+  "start": "Démarrer",
+  "state": "État",
+  "state-done": "Terminé",
+  "state-paused": "En pause",
+  "state-running": "En cours"
+}

package/dist/content/examples/countdown/logic.ts

@@ -0,0 +1,179 @@
+// A countdown of a few minutes. It counts the rounds the user finished,
+// keeps that count in the widget's storage and draws one dot per round.
+import {
+  draw,
+  formatDuration,
+  initState,
+  log,
+  onHost,
+  onMenu,
+  option,
+  storage,
+  t,
+  timers,
+  type DrawCommand,
+  type Timer,
+} from "@overcrow/sdk";
+
+const MINUTE = 60_000;
+/** Dots drawn at most; the count itself goes on. */
+const MAX_DOTS = 12;
+
+declare module "@overcrow/sdk" {
+  interface WidgetState {
+    durations: number[];
+    minutes: number;
+    remainingMs: number;
+    running: boolean;
+    repeat: boolean;
+    rounds: number;
+    showRounds: boolean;
+    menu: boolean;
+  }
+}
+
+const state = initState({
+  durations: [5, 15, 25, 50],
+  minutes: 25,
+  remainingMs: 25 * MINUTE,
+  running: false,
+  repeat: false,
+  rounds: 0,
+  showRounds: option("show-rounds", true),
+  menu: false,
+});
+
+export function total(minutes: number): number {
+  return minutes * MINUTE;
+}
+
+/** `24:59`, counted down to the second. */
+export function timeLeft(ms: number): string {
+  return formatDuration(Math.ceil(ms / 1000) * 1000);
+}
+
+/** The value of an `option` is text. */
+export function minutesValue(minutes: number): string {
+  return String(minutes);
+}
+
+export function ringClass(ms: number): string {
+  return ms === 0 ? "ring done" : "ring";
+}
+
+export function startLabel(running: boolean): string {
+  return t(running ? "pause" : "start");
+}
+
+export function stateText(running: boolean, ms: number): string {
+  return t(running ? "state-running" : ms === 0 ? "state-done" : "state-paused");
+}
+
+/** One dot per finished round, on the `dots` canvas. */
+function paint(): void {
+  const dots: DrawCommand[] = [];
+  for (let index = 0; index < Math.min(state.rounds, MAX_DOTS); index += 1) {
+    dots.push(["circle", 6 + index * 14, 6, 4], ["fill", "var(--color-accent)"]);
+  }
+  draw("dots", dots);
+}
+
+function setRounds(rounds: number): void {
+  state.rounds = rounds;
+  paint();
+  // Storage needs the user's consent: without it the count lasts as long
+  // as the widget runs.
+  storage.set({ key: "rounds", value: rounds }).catch(() => {});
+}
+
+let ticker: Timer | undefined;
+/** When the running countdown ends, in `Date.now()` time. */
+let endsAt = 0;
+
+function stop(): void {
+  ticker?.cancel();
+  ticker = undefined;
+  state.running = false;
+}
+
+function start(): void {
+  if (state.remainingMs === 0) {
+    state.remainingMs = total(state.minutes);
+  }
+  endsAt = Date.now() + state.remainingMs;
+  state.running = true;
+  ticker = timers.every(250, tick);
+}
+
+// A timer does not tick while the widget is hidden: the time left comes
+// from the clock, not from the number of ticks.
+function tick(): void {
+  state.remainingMs = Math.max(0, endsAt - Date.now());
+  if (state.remainingMs > 0) {
+    return;
+  }
+  stop();
+  setRounds(state.rounds + 1);
+  log.info(`round ${state.rounds} finished`);
+  if (state.repeat) {
+    start();
+  }
+}
+
+export function toggle(): void {
+  if (state.running) {
+    stop();
+  } else {
+    start();
+  }
+}
+
+export function setMinutes(event: { value: unknown }): void {
+  const minutes = Number(event.value);
+  if (state.durations.includes(minutes)) {
+    state.minutes = minutes;
+    state.remainingMs = total(minutes);
+  }
+}
+
+export function setRepeat(event: { value: unknown }): void {
+  state.repeat = event.value === true;
+}
+
+export function openMenu(): void {
+  state.menu = true;
+}
+
+export function closeMenu(): void {
+  state.menu = false;
+}
+
+export function resetRounds(): void {
+  state.menu = false;
+  setRounds(0);
+}
+
+// The `reset-rounds` row of the options menu does the same as the button
+// of the context menu.
+onMenu((row) => {
+  if (row === "reset-rounds") {
+    resetRounds();
+  }
+});
+
+onHost((changed) => {
+  if (changed.includes("options")) {
+    state.showRounds = option("show-rounds", true);
+    paint();
+  }
+});
+
+storage.get({ key: "rounds" }).then(
+  (stored) => {
+    if (typeof stored === "number" && Number.isInteger(stored) && stored > 0) {
+      state.rounds = stored;
+      paint();
+    }
+  },
+  () => {},
+);

package/dist/content/examples/countdown/manifest.json

@@ -0,0 +1,34 @@
+{
+  "schemaVersion": 1,
+  "apiVersion": 1,
+  "id": "nova.countdown",
+  "version": "1.0.0",
+  "name": { "en": "Countdown", "fr": "Compte à rebours" },
+  "sizing": {
+    "fit": "none",
+    "preferred": { "width": 220, "height": 190 },
+    "min": { "width": 180, "height": 160 },
+    "max": { "width": 480, "height": 400 }
+  },
+  "permissions": {
+    "storage": true
+  },
+  "wrapper": {
+    "menu": [
+      {
+        "type": "toggle",
+        "id": "show-rounds",
+        "label": { "en": "Show finished rounds", "fr": "Afficher les tours terminés" },
+        "icon": "circle-check",
+        "default": true
+      },
+      {
+        "type": "action",
+        "id": "reset-rounds",
+        "label": { "en": "Reset the rounds", "fr": "Remettre les tours à zéro" },
+        "icon": "rotate-ccw",
+        "visibleWhen": "show-rounds"
+      }
+    ]
+  }
+}

package/dist/content/examples/countdown/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "overcrow-example-countdown",
+  "version": "1.0.0",
+  "private": true,
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "check": "overcrow-widget check",
+    "package": "overcrow-widget package"
+  },
+  "devDependencies": {
+    "@overcrow/sdk": "1.0.0",
+    "typescript": "6.0.3"
+  }
+}