@phin-tech/dottie 0.10.0 → 0.11.0

package/PARITY.md

@@ -24,6 +24,8 @@ fixture, so the gap is visible rather than silent.
 | Ports and edge-following, rotated shapes, free ends | Supported | [edge/connectors](../fixtures/edge/connectors.dottie) | |
 | Connectors and labels on outlines (ADR 0001) | Supported | [edge/extensions](../fixtures/edge/extensions.dottie) | Edge-following meets a `.path`'s actual outline, not its box (ray against 16-step flattened curves). Endpoints pinned with `portIndex` attach to the element's `ports`. A path's label goes in its `labelRect`. |
 | Extension shapes as stored (ADR 0001) | Supported | [edge/extensions](../fixtures/edge/extensions.dottie) | Drawn from the stored path with no extension installed. The `extension` field is kept as metadata and nothing runs. Parameters, commands and handles are Dottie-only. |
+| Click logic (`logic`, a click's `run`) | Supported | [edge/logic](../fixtures/edge/logic.dottie) | One engine for both: `logic.ts` (QuickJS in WebAssembly), run by `LogicEngine.swift` in JavaScriptCore. Runs only with `allow-logic` (ADR 0007). |
+| Number variables, expressions in conditions and clicks, `{value}` in labels | Supported | [edge/counters](../fixtures/edge/counters.dottie), [expressions.json](../fixtures/expressions.json) | One grammar in `Expression.swift` and `expression.ts` (ADR 0007). |
 | Containers and swimlanes | Supported | [edge/containers](../fixtures/edge/containers.dottie) | Drawn from the stored frame and title band (`labelRect`); the app keeps them fitted (ADR 0006). |
 | Themes of a page's own, and palette colors by name | Supported | [edge/palette](../fixtures/edge/palette.dottie) | Names are resolved when a file is read, by the same rules in `Theme.swift` and `theme.ts` (ADR 0005). |
 | Elbows that go round shapes (`avoid`) | Supported | [edge/elbow-around](../fixtures/edge/elbow-around.dottie) | The same grid router, point for point (`ElbowRouter.swift`, `elbow.ts`). |

package/README.md

@@ -56,6 +56,21 @@ when it is showing. The classic script starts the worker from its own source (a
 loads `dottie-player.min.js` from beside itself, so host the two together. Where a worker can't start, as under a
 `worker-src` policy that refuses it, the player works it out in place as before. Small drawings always do.
 
+**Click logic.** Variables can be numbers, and conditions and clicks are small expressions (`count >= 3`,
+`"count + 1"`, `{count}` in a label). For more, a page can carry `logic`: JavaScript handlers a click `run`s, each
+getting the variables and the click and returning new values. The player runs them only with `allow-logic`:
+
+```html
+<dottie-player src="game.dottie" allow-logic></dottie-player>
+```
+
+Each click's handler runs in a fresh QuickJS sandbox compiled to WebAssembly, never in your page's JavaScript: it has
+no `window`, `document`, network, timers, `Date` or `Math.random`, and a time and memory limit, so the same click on
+the same state gives the same result everywhere. A handler that fails leaves the state as it was and fires
+`logicerror` (with `{element, handler, error}`). Without `allow-logic`, a click does its own `set` and `toggle`
+instead. The engine (`dottie-logic.min.js`, about 850 KB) is loaded from beside the player only when a page with
+logic is clicked, so host it with the player; `dottie-compile --allow-logic` puts it in the compiled script instead.
+
 **Fonts.** Text in Dottie's handwriting fonts (Caveat, Patrick Hand, Architects Daughter; SIL Open Font License)
 is drawn in them: the player loads the ones a drawing uses from `fonts/` beside its own script, as `dist/fonts` on
 npm and the CDNs. If you host the player yourself, copy that folder with it, or call `Dottie.setFontBase(url)`

package/dist/compile.js

@@ -1,4 +1,4 @@
-/*! dottie.js 0.10.0 | Apache-2.0 | https://github.com/phin-tech/dottie */
+/*! dottie.js 0.11.0 | Apache-2.0 | https://github.com/phin-tech/dottie */
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -109,12 +109,12 @@ function resolvingPalette(page) {
 }
 
 // src/model.ts
-var SUPPORTED_VERSION = 2;
+var SUPPORTED_VERSION = 3;
 var KINDS = ["rectangle", "ellipse", "diamond", "text", "connector", "freehand", "path", "note", "image", "symbol"];
 var EASES = ["linear", "easeIn", "easeOut", "easeInOut", "hold", "spring", "bounce", "elastic"];
 var KNOWN_FIELDS = {
   file: ["version", "pages", "images"],
-  page: ["id", "name", "layers", "elements", "theme", "customTheme", "guidesX", "guidesY", "guidesLocked", "timeline", "symbols", "variables", "flows"],
+  page: ["id", "name", "layers", "elements", "theme", "customTheme", "logic", "guidesX", "guidesY", "guidesLocked", "timeline", "symbols", "variables", "flows"],
   flow: ["id", "from", "to", "every", "speed", "color", "size", "when", "spread", "volume", "overrides"],
   flowOverride: ["when", "volume"],
   symbol: ["id", "name", "width", "height", "layers", "elements", "timeline", "button", "params"],
@@ -183,7 +183,7 @@ var KNOWN_FIELDS = {
   repeat: ["start", "end", "count"],
   cameraKey: ["t", "x", "y", "width", "height", "ease"],
   marker: ["t", "name", "loop"],
-  click: ["scene", "url", "set", "toggle", "reset"],
+  click: ["scene", "url", "set", "toggle", "reset", "run"],
   hover: ["stroke", "fill", "opacity"],
   override: ["when", "stroke", "fill", "textColor", "opacity", "strokeWidth", "dash", "text", "reroute", "offline", "cost", "capacity", "delay"]
 };
@@ -430,7 +430,7 @@ var Reader = class {
   variables(v) {
     if (!isObj(v)) return null;
     const out = {};
-    for (const [k, b] of Object.entries(v)) if (typeof b === "boolean") out[k] = b;
+    for (const [k, b] of Object.entries(v)) if (typeof b === "boolean" || typeof b === "number" && Number.isFinite(b)) out[k] = b;
     return Object.keys(out).length > 0 ? out : null;
   }
   click(v) {
@@ -442,12 +442,22 @@ var Reader = class {
     let set = null;
     if (isObj(v.set)) {
       set = {};
-      for (const [k, b] of Object.entries(v.set)) if (typeof b === "boolean" && isName(k)) set[k] = b;
+      for (const [k, b] of Object.entries(v.set)) {
+        if (isName(k) && (typeof b === "boolean" || typeof b === "string" || typeof b === "number" && Number.isFinite(b))) set[k] = b;
+      }
       if (Object.keys(set).length === 0) set = null;
     }
     const raw = typeof v.toggle === "string" ? [v.toggle] : Array.isArray(v.toggle) && v.toggle.every((x) => typeof x === "string") ? v.toggle : null;
     const toggle = raw ? raw.filter(isName) : null;
-    return { scene: str(v.scene) ?? null, url: safe, set, toggle: toggle && toggle.length > 0 ? toggle : null, reset: v.reset === true ? true : null };
+    const run = str(v.run);
+    return {
+      scene: str(v.scene) ?? null,
+      url: safe,
+      set,
+      toggle: toggle && toggle.length > 0 ? toggle : null,
+      reset: v.reset === true ? true : null,
+      run: run !== void 0 && isName(run) ? run : null
+    };
   }
   playback(v) {
     const s = str(v);
@@ -610,6 +620,7 @@ var Reader = class {
       elements: (Array.isArray(v.elements) ? v.elements : []).map((e) => this.element(e, images)).filter((e) => e !== null),
       theme: str(v.theme) ?? null,
       customTheme: this.customTheme(v.customTheme),
+      logic: typeof v.logic === "string" && v.logic.length > 0 ? v.logic : null,
       timeline: this.timeline(v.timeline),
       symbols: Array.isArray(v.symbols) ? v.symbols.map((x) => this.symbol(x, images)).filter((x) => x !== null) : null,
       variables: this.variables(v.variables),
@@ -751,6 +762,7 @@ function playerAttributes(options) {
   if (options.noAutoplay) out["no-autoplay"] = "";
   if (options.noLoop) out["no-loop"] = "";
   if (options.label !== void 0) out.label = options.label;
+  if (options.logicEngine) out["allow-logic"] = "";
   return out;
 }
 function compile(source, runtime, options = {}) {
@@ -783,10 +795,11 @@ function compile(source, runtime, options = {}) {
   }
   const fill = {
     DOTTIE_DATA: () => scriptJSON(data),
-    DOTTIE_OPTIONS: () => scriptJSON(playerAttributes(options)),
+    DOTTIE_OPTIONS: () => scriptJSON(playerAttributes(file.pages[i].logic ? options : { ...options, logicEngine: void 0 })),
     DOTTIE_FONTS: () => scriptJSON(fonts)
   };
-  return runtime.trimEnd() + "\n" + LOADER.replace(/\bDOTTIE_(?:DATA|OPTIONS|FONTS)\b/g, (m) => fill[m]());
+  const engine = options.logicEngine && file.pages[i].logic ? options.logicEngine.trimEnd() + "\n" : "";
+  return engine + runtime.trimEnd() + "\n" + LOADER.replace(/\bDOTTIE_(?:DATA|OPTIONS|FONTS)\b/g, (m) => fill[m]());
 }
 export {
   LOADER,

package/dist/dottie-compile.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-/*! dottie.js 0.10.0 | Apache-2.0 | https://github.com/phin-tech/dottie */
+/*! dottie.js 0.11.0 | Apache-2.0 | https://github.com/phin-tech/dottie */
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -117,12 +117,12 @@ function resolvingPalette(page) {
 }
 
 // src/model.ts
-var SUPPORTED_VERSION = 2;
+var SUPPORTED_VERSION = 3;
 var KINDS = ["rectangle", "ellipse", "diamond", "text", "connector", "freehand", "path", "note", "image", "symbol"];
 var EASES = ["linear", "easeIn", "easeOut", "easeInOut", "hold", "spring", "bounce", "elastic"];
 var KNOWN_FIELDS = {
   file: ["version", "pages", "images"],
-  page: ["id", "name", "layers", "elements", "theme", "customTheme", "guidesX", "guidesY", "guidesLocked", "timeline", "symbols", "variables", "flows"],
+  page: ["id", "name", "layers", "elements", "theme", "customTheme", "logic", "guidesX", "guidesY", "guidesLocked", "timeline", "symbols", "variables", "flows"],
   flow: ["id", "from", "to", "every", "speed", "color", "size", "when", "spread", "volume", "overrides"],
   flowOverride: ["when", "volume"],
   symbol: ["id", "name", "width", "height", "layers", "elements", "timeline", "button", "params"],
@@ -191,7 +191,7 @@ var KNOWN_FIELDS = {
   repeat: ["start", "end", "count"],
   cameraKey: ["t", "x", "y", "width", "height", "ease"],
   marker: ["t", "name", "loop"],
-  click: ["scene", "url", "set", "toggle", "reset"],
+  click: ["scene", "url", "set", "toggle", "reset", "run"],
   hover: ["stroke", "fill", "opacity"],
   override: ["when", "stroke", "fill", "textColor", "opacity", "strokeWidth", "dash", "text", "reroute", "offline", "cost", "capacity", "delay"]
 };
@@ -438,7 +438,7 @@ var Reader = class {
   variables(v) {
     if (!isObj(v)) return null;
     const out = {};
-    for (const [k, b] of Object.entries(v)) if (typeof b === "boolean") out[k] = b;
+    for (const [k, b] of Object.entries(v)) if (typeof b === "boolean" || typeof b === "number" && Number.isFinite(b)) out[k] = b;
     return Object.keys(out).length > 0 ? out : null;
   }
   click(v) {
@@ -450,12 +450,22 @@ var Reader = class {
     let set = null;
     if (isObj(v.set)) {
       set = {};
-      for (const [k, b] of Object.entries(v.set)) if (typeof b === "boolean" && isName(k)) set[k] = b;
+      for (const [k, b] of Object.entries(v.set)) {
+        if (isName(k) && (typeof b === "boolean" || typeof b === "string" || typeof b === "number" && Number.isFinite(b))) set[k] = b;
+      }
       if (Object.keys(set).length === 0) set = null;
     }
     const raw = typeof v.toggle === "string" ? [v.toggle] : Array.isArray(v.toggle) && v.toggle.every((x) => typeof x === "string") ? v.toggle : null;
     const toggle = raw ? raw.filter(isName) : null;
-    return { scene: str(v.scene) ?? null, url: safe, set, toggle: toggle && toggle.length > 0 ? toggle : null, reset: v.reset === true ? true : null };
+    const run = str(v.run);
+    return {
+      scene: str(v.scene) ?? null,
+      url: safe,
+      set,
+      toggle: toggle && toggle.length > 0 ? toggle : null,
+      reset: v.reset === true ? true : null,
+      run: run !== void 0 && isName(run) ? run : null
+    };
   }
   playback(v) {
     const s = str(v);
@@ -618,6 +628,7 @@ var Reader = class {
       elements: (Array.isArray(v.elements) ? v.elements : []).map((e) => this.element(e, images)).filter((e) => e !== null),
       theme: str(v.theme) ?? null,
       customTheme: this.customTheme(v.customTheme),
+      logic: typeof v.logic === "string" && v.logic.length > 0 ? v.logic : null,
       timeline: this.timeline(v.timeline),
       symbols: Array.isArray(v.symbols) ? v.symbols.map((x) => this.symbol(x, images)).filter((x) => x !== null) : null,
       variables: this.variables(v.variables),
@@ -759,6 +770,7 @@ function playerAttributes(options2) {
   if (options2.noAutoplay) out["no-autoplay"] = "";
   if (options2.noLoop) out["no-loop"] = "";
   if (options2.label !== void 0) out.label = options2.label;
+  if (options2.logicEngine) out["allow-logic"] = "";
   return out;
 }
 function compile(source2, runtime, options2 = {}) {
@@ -791,14 +803,15 @@ function compile(source2, runtime, options2 = {}) {
   }
   const fill = {
     DOTTIE_DATA: () => scriptJSON(data),
-    DOTTIE_OPTIONS: () => scriptJSON(playerAttributes(options2)),
+    DOTTIE_OPTIONS: () => scriptJSON(playerAttributes(file.pages[i].logic ? options2 : { ...options2, logicEngine: void 0 })),
     DOTTIE_FONTS: () => scriptJSON(fonts)
   };
-  return runtime.trimEnd() + "\n" + LOADER.replace(/\bDOTTIE_(?:DATA|OPTIONS|FONTS)\b/g, (m) => fill[m]());
+  const engine = options2.logicEngine && file.pages[i].logic ? options2.logicEngine.trimEnd() + "\n" : "";
+  return engine + runtime.trimEnd() + "\n" + LOADER.replace(/\bDOTTIE_(?:DATA|OPTIONS|FONTS)\b/g, (m) => fill[m]());
 }
 
 // src/index.ts
-var VERSION = "0.10.0";
+var VERSION = "0.11.0";
 
 // src/cli.ts
 var usage = `dottie-compile ${VERSION}: a Dottie drawing as one script that plays it on any page.
@@ -815,6 +828,7 @@ OPTIONS
       --at <seconds>    Show that moment as a still
       --clean           Draw precisely instead of sketchy
       --no-controls, --no-autoplay, --no-loop
+      --allow-logic        let the page's click logic run (ADR 0007); it carries the engine (about 850 KB)
       --label <text>    The player's accessible name
 `;
 function fail(message, code = 2) {
@@ -824,6 +838,7 @@ function fail(message, code = 2) {
 }
 var args = process.argv.slice(2);
 var options = {};
+var allowLogic = false;
 var input;
 var output;
 for (let i = 0; i < args.length; i++) {
@@ -865,6 +880,9 @@ for (let i = 0; i < args.length; i++) {
     case "--no-loop":
       options.noLoop = true;
       break;
+    case "--allow-logic":
+      allowLogic = true;
+      break;
     case "--label":
       options.label = value();
       break;
@@ -895,7 +913,8 @@ try {
       return void 0;
     }
   };
-  const js = compile(source, runtime, { ...options, fontData });
+  const logicEngine = allowLogic ? readFileSync(new URL("./dottie-logic.min.js", import.meta.url), "utf8") : void 0;
+  const js = compile(source, runtime, { ...options, fontData, logicEngine });
   if (output === "-") process.stdout.write(js);
   else {
     const target = output ?? input.replace(/\.dottie$/i, "") + ".js";