@phin-tech/dottie 0.9.0 → 0.10.0

package/PARITY.md

@@ -24,6 +24,9 @@ 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. |
+| 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`). |
 | Waypoints (bends) on every routing, and hops | Supported | [edge/waypoints](../fixtures/edge/waypoints.dottie), [edge/waypoints-symbol](../fixtures/edge/waypoints-symbol.dottie) | Hops need the page, so `connectorParts` takes it; without one a line draws none. |
 | Arrowheads: arrow, triangle, dot, bar | Supported | [edge/connectors](../fixtures/edge/connectors.dottie) | |
 | Label colors (`textColor`, apart from the stroke) | Supported | [edge/text-colors](../fixtures/edge/text-colors.dottie) | Text boxes and notes ignore it, as in Dottie |

package/dist/compile.js

@@ -1,4 +1,4 @@
-/*! dottie.js 0.9.0 | Apache-2.0 | https://github.com/phin-tech/dottie */
+/*! dottie.js 0.10.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);
@@ -50,19 +50,80 @@ function isName(name) {
   return name.length <= MAX_NAME && /^[A-Za-z_][A-Za-z0-9_]*$/.test(name);
 }
 
+// src/theme.ts
+var rgb = (r, g, b) => ({ r, g, b, a: 1 });
+function hex(h) {
+  const n = parseInt(h.slice(1), 16);
+  return { r: (n >> 16 & 255) / 255, g: (n >> 8 & 255) / 255, b: (n & 255) / 255, a: 1 };
+}
+var PALETTE_NAMES = ["accent", "muted", "danger", "warning", "success", "info"];
+var palette = (colors) => PALETTE_NAMES.map((name, i) => ({ name, color: hex(colors[i]) }));
+var LIGHT_PALETTE = palette(["#2563eb", "#6b7280", "#dc2626", "#d97706", "#16a34a", "#0891b2"]);
+var DARK_PALETTE = palette(["#93c5fd", "#cbd5e1", "#fca5a5", "#fcd34d", "#86efac", "#67e8f9"]);
+var themes = [
+  { id: "paper", name: "Paper", background: rgb(0.984, 0.98, 0.965), ink: rgb(0.12, 0.12, 0.13), palette: LIGHT_PALETTE },
+  { id: "white", name: "White", background: rgb(1, 1, 1), ink: rgb(0.12, 0.12, 0.13), palette: LIGHT_PALETTE },
+  {
+    id: "sepia",
+    name: "Sepia",
+    background: rgb(0.953, 0.914, 0.824),
+    ink: rgb(0.23, 0.18, 0.13),
+    palette: palette(["#9a3412", "#78716c", "#b91c1c", "#b45309", "#4d7c0f", "#0e7490"])
+  },
+  { id: "blueprint", name: "Blueprint", background: rgb(0.106, 0.227, 0.361), ink: rgb(0.91, 0.945, 0.984), palette: DARK_PALETTE },
+  { id: "chalkboard", name: "Chalkboard", background: rgb(0.169, 0.227, 0.2), ink: rgb(0.945, 0.945, 0.918), palette: DARK_PALETTE },
+  { id: "midnight", name: "Midnight", background: rgb(0.082, 0.086, 0.102), ink: rgb(0.925, 0.925, 0.94), palette: DARK_PALETTE }
+];
+function themeNamed(id) {
+  return themes.find((t) => t.id === id) ?? null;
+}
+function pageTheme(page) {
+  const c = page.customTheme;
+  if (c) return { id: "custom", name: c.name, background: c.background, ink: c.ink, palette: c.palette };
+  return themeNamed(page.theme);
+}
+function paletteColor(page, name) {
+  const n = name.trim().toLowerCase();
+  return (pageTheme(page)?.palette ?? LIGHT_PALETTE).find((p) => p.name.toLowerCase() === n)?.color ?? null;
+}
+function resolvingPalette(page) {
+  const named = (e) => !!e.style.named;
+  if (!page.elements.some(named) && !(page.symbols ?? []).some((s) => s.elements.some(named))) return page;
+  const resolve = (e) => {
+    const n = e.style.named;
+    if (!n) return e;
+    const style = { ...e.style };
+    const f = n.fill !== null ? paletteColor(page, n.fill) : null;
+    const s = n.stroke !== null ? paletteColor(page, n.stroke) : null;
+    const t = n.textColor !== null ? paletteColor(page, n.textColor) : null;
+    if (f) style.fill = { ...f };
+    if (s) style.stroke = { ...s };
+    if (t) style.textColor = { ...t };
+    return { ...e, style };
+  };
+  return {
+    ...page,
+    elements: page.elements.map(resolve),
+    symbols: page.symbols ? page.symbols.map((s) => ({ ...s, elements: s.elements.map(resolve) })) : page.symbols
+  };
+}
+
 // src/model.ts
 var SUPPORTED_VERSION = 2;
 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", "guidesX", "guidesY", "guidesLocked", "timeline", "symbols", "variables", "flows"],
+  page: ["id", "name", "layers", "elements", "theme", "customTheme", "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"],
   layer: ["id", "name", "visible", "locked"],
   rgba: ["r", "g", "b", "a"],
-  style: ["stroke", "fill", "fillStyle", "strokeWidth", "dash", "roughness", "bowing", "fontSize", "font", "gridSize", "opacity", "dashOffset", "textColor"],
+  style: ["stroke", "fill", "fillStyle", "strokeWidth", "dash", "roughness", "bowing", "fontSize", "font", "gridSize", "opacity", "dashOffset", "textColor", "named"],
+  colorNames: ["fill", "stroke", "textColor"],
+  customTheme: ["name", "background", "ink", "palette", "base"],
+  paletteColor: ["name", "color"],
   element: [
     "id",
     "kind",
@@ -100,8 +161,11 @@ var KNOWN_FIELDS = {
     "capacity",
     "delay",
     "queue",
-    "gauge"
+    "gauge",
+    "containerID",
+    "container"
   ],
+  container: ["fixed", "lanes"],
   gauge: ["metric", "of", "max", "warn", "alarm", "style", "label"],
   strokePoint: ["x", "y"],
   subpath: ["closed", "coords"],
@@ -110,7 +174,7 @@ var KNOWN_FIELDS = {
   extensionRef: ["id", "shape", "version", "params"],
   normalizedPoint: ["x", "y"],
   normalizedRect: ["x", "y", "width", "height"],
-  connector: ["start", "end", "routing", "startHead", "endHead", "waypoints", "hops", "cost"],
+  connector: ["start", "end", "routing", "startHead", "endHead", "waypoints", "hops", "avoid", "cost"],
   waypoint: ["x", "y"],
   timeline: ["fps", "duration", "boil", "settle", "poster", "tracks", "camera", "markers"],
   track: ["element", "keys", "boil", "follow", "repeats", "march"],
@@ -192,9 +256,36 @@ var Reader = class {
       gridSize: num(s.gridSize) ?? null,
       opacity: num(s.opacity) ?? null,
       dashOffset: num(s.dashOffset) ?? null,
-      textColor: rgba(s.textColor) ?? null
+      textColor: rgba(s.textColor) ?? null,
+      named: this.colorNames(s.named)
     };
   }
+  container(v) {
+    if (!isObj(v)) return null;
+    this.fields(v, "container");
+    return { fixed: v.fixed === true ? true : null, lanes: v.lanes === "rows" || v.lanes === "columns" ? v.lanes : null };
+  }
+  colorNames(v) {
+    if (!isObj(v)) return null;
+    this.fields(v, "colorNames");
+    const n = { fill: str(v.fill) ?? null, stroke: str(v.stroke) ?? null, textColor: str(v.textColor) ?? null };
+    return n.fill === null && n.stroke === null && n.textColor === null ? null : n;
+  }
+  customTheme(v) {
+    if (!isObj(v)) return null;
+    this.fields(v, "customTheme");
+    const background = rgba(v.background), ink = rgba(v.ink);
+    if (!background || !ink) {
+      this.warn("A custom theme needs a background and an ink; drawn without it");
+      return null;
+    }
+    const palette2 = (Array.isArray(v.palette) ? v.palette : []).filter(isObj).flatMap((p) => {
+      this.fields(p, "paletteColor");
+      const name = str(p.name), color = rgba(p.color);
+      return name && color ? [{ name, color }] : [];
+    });
+    return { name: str(v.name) ?? "Custom", background, ink, palette: palette2, base: str(v.base) ?? null };
+  }
   endpoint(v) {
     const e = isObj(v) ? v : {};
     const port = str(e.port);
@@ -226,6 +317,7 @@ var Reader = class {
         return { x: num(w.x) ?? 0, y: num(w.y) ?? 0 };
       }) : null,
       hops: typeof v.hops === "boolean" ? v.hops : null,
+      avoid: typeof v.avoid === "boolean" ? v.avoid : null,
       cost: typeof v.cost === "number" && Number.isFinite(v.cost) ? v.cost : null
     };
   }
@@ -294,7 +386,9 @@ var Reader = class {
       capacity: num(v.capacity) ?? null,
       delay: num(v.delay) ?? null,
       queue: v.queue === true ? true : null,
-      gauge: this.gauge(v.gauge)
+      gauge: this.gauge(v.gauge),
+      containerID: uuid(v.containerID) ?? null,
+      container: this.container(v.container)
     };
   }
   gauge(v) {
@@ -515,6 +609,7 @@ var Reader = class {
       layers,
       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),
       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),
@@ -578,7 +673,7 @@ function parseDottie(source) {
       if (isObj(v) && typeof v.data === "string") images[k] = reader.picture(v.data, str(v.format));
     }
   }
-  const pages = json.pages.map((p, i) => reader.page(p, images, i + 1));
+  const pages = json.pages.map((p, i) => resolvingPalette(reader.page(p, images, i + 1)));
   if (new Set(pages.map((p) => p.id)).size !== pages.length) throw new DottieFormatError("Two pages share an id");
   return { version, pages, warnings: reader.warnings };
 }

package/dist/dottie-compile.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-/*! dottie.js 0.9.0 | Apache-2.0 | https://github.com/phin-tech/dottie */
+/*! dottie.js 0.10.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);
@@ -58,19 +58,80 @@ function isName(name) {
   return name.length <= MAX_NAME && /^[A-Za-z_][A-Za-z0-9_]*$/.test(name);
 }
 
+// src/theme.ts
+var rgb = (r, g, b) => ({ r, g, b, a: 1 });
+function hex(h) {
+  const n = parseInt(h.slice(1), 16);
+  return { r: (n >> 16 & 255) / 255, g: (n >> 8 & 255) / 255, b: (n & 255) / 255, a: 1 };
+}
+var PALETTE_NAMES = ["accent", "muted", "danger", "warning", "success", "info"];
+var palette = (colors) => PALETTE_NAMES.map((name, i) => ({ name, color: hex(colors[i]) }));
+var LIGHT_PALETTE = palette(["#2563eb", "#6b7280", "#dc2626", "#d97706", "#16a34a", "#0891b2"]);
+var DARK_PALETTE = palette(["#93c5fd", "#cbd5e1", "#fca5a5", "#fcd34d", "#86efac", "#67e8f9"]);
+var themes = [
+  { id: "paper", name: "Paper", background: rgb(0.984, 0.98, 0.965), ink: rgb(0.12, 0.12, 0.13), palette: LIGHT_PALETTE },
+  { id: "white", name: "White", background: rgb(1, 1, 1), ink: rgb(0.12, 0.12, 0.13), palette: LIGHT_PALETTE },
+  {
+    id: "sepia",
+    name: "Sepia",
+    background: rgb(0.953, 0.914, 0.824),
+    ink: rgb(0.23, 0.18, 0.13),
+    palette: palette(["#9a3412", "#78716c", "#b91c1c", "#b45309", "#4d7c0f", "#0e7490"])
+  },
+  { id: "blueprint", name: "Blueprint", background: rgb(0.106, 0.227, 0.361), ink: rgb(0.91, 0.945, 0.984), palette: DARK_PALETTE },
+  { id: "chalkboard", name: "Chalkboard", background: rgb(0.169, 0.227, 0.2), ink: rgb(0.945, 0.945, 0.918), palette: DARK_PALETTE },
+  { id: "midnight", name: "Midnight", background: rgb(0.082, 0.086, 0.102), ink: rgb(0.925, 0.925, 0.94), palette: DARK_PALETTE }
+];
+function themeNamed(id) {
+  return themes.find((t) => t.id === id) ?? null;
+}
+function pageTheme(page) {
+  const c = page.customTheme;
+  if (c) return { id: "custom", name: c.name, background: c.background, ink: c.ink, palette: c.palette };
+  return themeNamed(page.theme);
+}
+function paletteColor(page, name) {
+  const n = name.trim().toLowerCase();
+  return (pageTheme(page)?.palette ?? LIGHT_PALETTE).find((p) => p.name.toLowerCase() === n)?.color ?? null;
+}
+function resolvingPalette(page) {
+  const named = (e) => !!e.style.named;
+  if (!page.elements.some(named) && !(page.symbols ?? []).some((s) => s.elements.some(named))) return page;
+  const resolve = (e) => {
+    const n = e.style.named;
+    if (!n) return e;
+    const style = { ...e.style };
+    const f = n.fill !== null ? paletteColor(page, n.fill) : null;
+    const s = n.stroke !== null ? paletteColor(page, n.stroke) : null;
+    const t = n.textColor !== null ? paletteColor(page, n.textColor) : null;
+    if (f) style.fill = { ...f };
+    if (s) style.stroke = { ...s };
+    if (t) style.textColor = { ...t };
+    return { ...e, style };
+  };
+  return {
+    ...page,
+    elements: page.elements.map(resolve),
+    symbols: page.symbols ? page.symbols.map((s) => ({ ...s, elements: s.elements.map(resolve) })) : page.symbols
+  };
+}
+
 // src/model.ts
 var SUPPORTED_VERSION = 2;
 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", "guidesX", "guidesY", "guidesLocked", "timeline", "symbols", "variables", "flows"],
+  page: ["id", "name", "layers", "elements", "theme", "customTheme", "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"],
   layer: ["id", "name", "visible", "locked"],
   rgba: ["r", "g", "b", "a"],
-  style: ["stroke", "fill", "fillStyle", "strokeWidth", "dash", "roughness", "bowing", "fontSize", "font", "gridSize", "opacity", "dashOffset", "textColor"],
+  style: ["stroke", "fill", "fillStyle", "strokeWidth", "dash", "roughness", "bowing", "fontSize", "font", "gridSize", "opacity", "dashOffset", "textColor", "named"],
+  colorNames: ["fill", "stroke", "textColor"],
+  customTheme: ["name", "background", "ink", "palette", "base"],
+  paletteColor: ["name", "color"],
   element: [
     "id",
     "kind",
@@ -108,8 +169,11 @@ var KNOWN_FIELDS = {
     "capacity",
     "delay",
     "queue",
-    "gauge"
+    "gauge",
+    "containerID",
+    "container"
   ],
+  container: ["fixed", "lanes"],
   gauge: ["metric", "of", "max", "warn", "alarm", "style", "label"],
   strokePoint: ["x", "y"],
   subpath: ["closed", "coords"],
@@ -118,7 +182,7 @@ var KNOWN_FIELDS = {
   extensionRef: ["id", "shape", "version", "params"],
   normalizedPoint: ["x", "y"],
   normalizedRect: ["x", "y", "width", "height"],
-  connector: ["start", "end", "routing", "startHead", "endHead", "waypoints", "hops", "cost"],
+  connector: ["start", "end", "routing", "startHead", "endHead", "waypoints", "hops", "avoid", "cost"],
   waypoint: ["x", "y"],
   timeline: ["fps", "duration", "boil", "settle", "poster", "tracks", "camera", "markers"],
   track: ["element", "keys", "boil", "follow", "repeats", "march"],
@@ -200,9 +264,36 @@ var Reader = class {
       gridSize: num(s.gridSize) ?? null,
       opacity: num(s.opacity) ?? null,
       dashOffset: num(s.dashOffset) ?? null,
-      textColor: rgba(s.textColor) ?? null
+      textColor: rgba(s.textColor) ?? null,
+      named: this.colorNames(s.named)
     };
   }
+  container(v) {
+    if (!isObj(v)) return null;
+    this.fields(v, "container");
+    return { fixed: v.fixed === true ? true : null, lanes: v.lanes === "rows" || v.lanes === "columns" ? v.lanes : null };
+  }
+  colorNames(v) {
+    if (!isObj(v)) return null;
+    this.fields(v, "colorNames");
+    const n = { fill: str(v.fill) ?? null, stroke: str(v.stroke) ?? null, textColor: str(v.textColor) ?? null };
+    return n.fill === null && n.stroke === null && n.textColor === null ? null : n;
+  }
+  customTheme(v) {
+    if (!isObj(v)) return null;
+    this.fields(v, "customTheme");
+    const background = rgba(v.background), ink = rgba(v.ink);
+    if (!background || !ink) {
+      this.warn("A custom theme needs a background and an ink; drawn without it");
+      return null;
+    }
+    const palette2 = (Array.isArray(v.palette) ? v.palette : []).filter(isObj).flatMap((p) => {
+      this.fields(p, "paletteColor");
+      const name = str(p.name), color = rgba(p.color);
+      return name && color ? [{ name, color }] : [];
+    });
+    return { name: str(v.name) ?? "Custom", background, ink, palette: palette2, base: str(v.base) ?? null };
+  }
   endpoint(v) {
     const e = isObj(v) ? v : {};
     const port = str(e.port);
@@ -234,6 +325,7 @@ var Reader = class {
         return { x: num(w.x) ?? 0, y: num(w.y) ?? 0 };
       }) : null,
       hops: typeof v.hops === "boolean" ? v.hops : null,
+      avoid: typeof v.avoid === "boolean" ? v.avoid : null,
       cost: typeof v.cost === "number" && Number.isFinite(v.cost) ? v.cost : null
     };
   }
@@ -302,7 +394,9 @@ var Reader = class {
       capacity: num(v.capacity) ?? null,
       delay: num(v.delay) ?? null,
       queue: v.queue === true ? true : null,
-      gauge: this.gauge(v.gauge)
+      gauge: this.gauge(v.gauge),
+      containerID: uuid(v.containerID) ?? null,
+      container: this.container(v.container)
     };
   }
   gauge(v) {
@@ -523,6 +617,7 @@ var Reader = class {
       layers,
       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),
       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),
@@ -586,7 +681,7 @@ function parseDottie(source2) {
       if (isObj(v) && typeof v.data === "string") images[k] = reader.picture(v.data, str(v.format));
     }
   }
-  const pages = json.pages.map((p, i) => reader.page(p, images, i + 1));
+  const pages = json.pages.map((p, i) => resolvingPalette(reader.page(p, images, i + 1)));
   if (new Set(pages.map((p) => p.id)).size !== pages.length) throw new DottieFormatError("Two pages share an id");
   return { version, pages, warnings: reader.warnings };
 }
@@ -703,7 +798,7 @@ function compile(source2, runtime, options2 = {}) {
 }
 
 // src/index.ts
-var VERSION = "0.9.0";
+var VERSION = "0.10.0";
 
 // src/cli.ts
 var usage = `dottie-compile ${VERSION}: a Dottie drawing as one script that plays it on any page.