flowfig 0.1.0

package/dist/cli.js

@@ -0,0 +1,133 @@
+#!/usr/bin/env node
+var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
+    if (typeof path === "string" && /^\.\.?\//.test(path)) {
+        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
+            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
+        });
+    }
+    return path;
+};
+/**
+ * Render a figure as one animated SVG — for a README, a PR, an issue, a blog post — and check it first.
+ *
+ *   flowfig - out.svg < spec.json        # a spec on stdin: nothing is left on disk
+ *   flowfig spec.json out.svg            # a spec file
+ *   flowfig figure.ts out.svg            # a module whose default export is a spec
+ *   flowfig --spec out.svg               # print back the spec the SVG carries
+ *   flowfig check <input> [--json]       # list the faults; the input can also be an SVG this wrote
+ *   flowfig docs                         # print the full guide (Markdown)
+ *   flowfig init [dir]                   # write flowfig instructions for the coding agents of a repo
+ *
+ * A render checks first and writes nothing on an error (--no-check skips that). --strict makes warnings errors; --width and
+ * --min-text set the page width and the smallest text the reader should get.
+ *
+ * Every rendered SVG carries its own spec in <metadata>, so a figure is editable later without anyone having to keep the JSON.
+ */
+import { readFileSync, writeFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { pathToFileURL } from 'node:url';
+import { GUIDE } from './guide.js';
+import { runInit } from './init.js';
+import { counts } from './model.js';
+import { check, toSvg } from './svg.js';
+const SPEC_OPEN = '<metadata id="figure-spec"><![CDATA[';
+const SPEC_CLOSE = ']]></metadata>';
+/** Bad use, not a bad figure: exit 2 with a message, not a stack trace. A declaration, so TypeScript narrows after a call. */
+function usage(message) {
+    console.error(message);
+    process.exit(2);
+}
+const args = process.argv.slice(2);
+const flag = (name) => {
+    const i = args.indexOf(name);
+    return i !== -1 && args.splice(i, 1).length > 0;
+};
+const value = (name) => {
+    const i = args.indexOf(name);
+    if (i === -1)
+        return undefined;
+    const n = Number(args.splice(i, 2)[1] || NaN);
+    return n > 0 && Number.isFinite(n) ? n : usage(`${name} needs a positive number`);
+};
+function specOf(svg, name) {
+    const at = svg.indexOf(SPEC_OPEN);
+    if (at === -1)
+        usage(`${name}: no figure spec inside this SVG`);
+    return svg.slice(at + SPEC_OPEN.length, svg.indexOf(SPEC_CLOSE, at));
+}
+if (args[0] === 'docs') {
+    process.stdout.write(GUIDE);
+    process.exit(0);
+}
+if (args[0] === 'init')
+    process.exit(await runInit(args.slice(1)));
+if (args[0] === '--spec') {
+    if (!args[1])
+        usage('--spec needs the path of an SVG');
+    console.log(specOf(readFileSync(args[1], 'utf8'), args[1]));
+    process.exit(0);
+}
+const command = args[0] === 'check' ? args.shift() : 'render';
+const json = flag('--json'), strict = flag('--strict'), skip = flag('--no-check');
+const opts = { width: value('--width'), minText: value('--min-text') };
+const unknown = args.find((a) => a.startsWith('-') && a !== '-');
+if (unknown)
+    usage(`unknown flag ${unknown}`);
+const [input, out] = args;
+if (!input)
+    usage('usage: flowfig <-|spec.json|figure.ts> [out.svg]  |  flowfig check <-|spec.json|figure.ts|figure.svg> [--json]  |  flowfig docs  |  flowfig init [dir]');
+let loaded;
+try {
+    loaded =
+        input === '-'
+            ? JSON.parse(readFileSync(0, 'utf8'))
+            : input.endsWith('.json')
+                ? JSON.parse(readFileSync(input, 'utf8'))
+                : input.endsWith('.svg')
+                    ? JSON.parse(specOf(readFileSync(input, 'utf8'), input))
+                    : (await import(__rewriteRelativeImportExtension(pathToFileURL(resolve(input)).href))).default;
+}
+catch (e) {
+    usage(`${input}: ${e.message}`);
+}
+const props = loaded?.props ?? loaded;
+if (!props?.layout)
+    usage(`${input}: no figure props (expected { props: { layout, edges, steps } })`);
+if (!Array.isArray(props.edges))
+    usage(`${input}: edges must be an array (use [] for none)`);
+if (props.steps?.some((s) => !Array.isArray(s?.flow)))
+    usage(`${input}: each step needs a flow array`);
+const findings = skip
+    ? []
+    : check(props, opts)
+        .map((f) => (strict ? { ...f, severity: 'error' } : f))
+        .sort((a, b) => (a.severity === b.severity ? a.rule.localeCompare(b.rule) : a.severity === 'error' ? -1 : 1));
+const errors = findings.filter((f) => f.severity === 'error').length;
+/** The findings for a person: one line each, colored only on a terminal. A render prints them to stderr, next to its own output. */
+const report = (print, tty) => {
+    const paint = (s, code) => (tty && !process.env.NO_COLOR ? `\x1b[${code}m${s}\x1b[0m` : s);
+    for (const f of findings)
+        print(`${paint(f.severity.padEnd(8), f.severity === 'error' ? 31 : 33)} ${f.rule.padEnd(18)} ${f.message}`);
+    const n = (k, word) => `${k} ${word}${k === 1 ? '' : 's'}`;
+    if (findings.length || print === console.log)
+        print(`${n(errors, 'error')}, ${n(findings.length - errors, 'warning')}`);
+    const c = counts(props);
+    print(`figure: ${n(c.boxes, 'box').replace('boxs', 'boxes')}, ${n(c.groups, 'group')}, ${n(c.edges, 'edge')}, ${n(c.steps, 'step')}, ${n(c.messages, 'message')}`);
+};
+if (command === 'check') {
+    if (json)
+        console.log(JSON.stringify(findings, null, 2));
+    else
+        report(console.log, process.stdout.isTTY);
+    process.exit(errors ? 1 : 0);
+}
+report(console.error, process.stderr.isTTY);
+if (errors)
+    process.exit(1);
+const dest = out ?? (input === '-' ? 'figure.svg' : input.replace(/\.[^./\\]+$/, '') + '.svg');
+// The spec rides along in <metadata>: an SVG is then its own source, and no JSON has to be kept.
+// `]]>` would close the CDATA early; it cannot appear in JSON-encoded text, but be sure.
+const spec = JSON.stringify({ props }).replaceAll(']]>', ']]\\u003e');
+const withSpec = toSvg(props).replace(/(<svg[^>]*>\n?)/, (tag) => `${tag}${SPEC_OPEN}${spec}${SPEC_CLOSE}\n`);
+writeFileSync(dest, withSpec);
+console.log(`${dest} — ${(withSpec.length / 1024).toFixed(1)} kB`);

package/dist/geometry.d.ts

@@ -0,0 +1,24 @@
+export type Rect = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+};
+export type Pt = {
+    x: number;
+    y: number;
+};
+export type Routed = {
+    id: string;
+    d: string;
+    mid: Pt;
+    curve: [Pt, Pt, Pt, Pt];
+};
+type Around = 'above' | 'below';
+export declare function route(edges: {
+    id: string;
+    from: string;
+    to: string;
+    around?: Around;
+}[], rects: Record<string, Rect>, tips?: Set<string>): Routed[];
+export {};

package/dist/geometry.js

@@ -0,0 +1,80 @@
+const cx = (r) => r.x + r.w / 2;
+const cy = (r) => r.y + r.h / 2;
+// Turns edges between measured boxes into curved SVG paths.
+// Boxes stacked on top of each other connect bottom->top, otherwise side->side.
+// Several edges leaving the same side of a box are spread out so they don't overlap,
+// except on `tips` boxes (diamonds), where they all meet at the point.
+// `around` makes an edge leave and enter from the top or bottom, arcing over whatever sits between.
+export function route(edges, rects, tips = new Set()) {
+    const picks = [];
+    for (const e of edges) {
+        const a = rects[e.from], b = rects[e.to];
+        if (!a || !b)
+            continue;
+        const stacked = a.x < b.x + b.w && b.x < a.x + a.w;
+        const [sa, sb] = e.around
+            ? e.around === 'above'
+                ? ['t', 't']
+                : ['b', 'b']
+            : stacked
+                ? a.y < b.y
+                    ? ['b', 't']
+                    : ['t', 'b']
+                : a.x < b.x
+                    ? ['r', 'l']
+                    : ['l', 'r'];
+        picks.push({ ...e, a, b, sa, sb });
+    }
+    // For every (box, side), list the edge ends that sit there, sorted by where the other end is.
+    const ends = new Map();
+    for (const pick of picks) {
+        for (const start of [true, false]) {
+            const key = (start ? pick.from : pick.to) + ':' + (start ? pick.sa : pick.sb);
+            if (!ends.has(key))
+                ends.set(key, []);
+            ends.get(key).push({ pick, start });
+        }
+    }
+    const anchor = new Map();
+    for (const [key, list] of ends) {
+        const tip = tips.has(key.slice(0, key.lastIndexOf(':')));
+        const side = list[0].start ? list[0].pick.sa : list[0].pick.sb;
+        const horiz = side === 't' || side === 'b';
+        const other = (x) => {
+            const r = x.start ? x.pick.b : x.pick.a;
+            return horiz ? cx(r) : cy(r);
+        };
+        list.sort((p, q) => other(p) - other(q)); // stable: ties keep declaration order
+        list.forEach((x, i) => {
+            const r = x.start ? x.pick.a : x.pick.b;
+            const f = tip ? 0.5 : (i + 1) / (list.length + 1);
+            const pt = side === 'l'
+                ? { x: r.x, y: r.y + r.h * f }
+                : side === 'r'
+                    ? { x: r.x + r.w, y: r.y + r.h * f }
+                    : side === 't'
+                        ? { x: r.x + r.w * f, y: r.y }
+                        : { x: r.x + r.w * f, y: r.y + r.h };
+            anchor.set(x.pick.id + (x.start ? ':s' : ':e'), pt);
+        });
+    }
+    // The four points travel with the path string: `flowfig check` samples the curve, and nothing has to parse `d`.
+    const drawn = (id, curve, mid) => {
+        const [s, c1, c2, e] = curve;
+        return { id, d: `M ${s.x} ${s.y} C ${c1.x} ${c1.y}, ${c2.x} ${c2.y}, ${e.x} ${e.y}`, mid, curve };
+    };
+    return picks.map((p) => {
+        const s = anchor.get(p.id + ':s'), e = anchor.get(p.id + ':e');
+        if (p.around) {
+            // ponytail: arcs 50px past the two ends' boxes; a taller box in between can still be crossed.
+            const y = p.around === 'above' ? Math.min(p.a.y, p.b.y) - 50 : Math.max(p.a.y + p.a.h, p.b.y + p.b.h) + 50;
+            return drawn(p.id, [s, { x: s.x, y }, { x: e.x, y }, e], { x: (s.x + e.x) / 2, y: (s.y + 6 * y + e.y) / 8 });
+        }
+        const horiz = p.sa === 'l' || p.sa === 'r';
+        const k = (horiz ? Math.abs(e.x - s.x) : Math.abs(e.y - s.y)) / 2;
+        const sign = p.sa === 'r' || p.sa === 'b' ? 1 : -1;
+        const c1 = horiz ? { x: s.x + sign * k, y: s.y } : { x: s.x, y: s.y + sign * k };
+        const c2 = horiz ? { x: e.x - sign * k, y: e.y } : { x: e.x, y: e.y - sign * k };
+        return drawn(p.id, [s, c1, c2, e], { x: (s.x + e.x) / 2, y: (s.y + e.y) / 2 });
+    });
+}

package/dist/guide.d.ts

@@ -0,0 +1,6 @@
+/** The full guide, as Markdown. `flowfig docs` prints it. */
+export declare const GUIDE = "# flowfig guide\n\nflowfig draws animated flow figures. A figure has boxes, the edges between the boxes, and steps. In each step, a packet moves along\nthe edges. The output is one animated SVG with no script. The SVG plays in a GitHub README, in PR and issue comments, and in blog\nposts. A figure is about 5 to 50 kB.\n\nYou write a JSON spec. You never write SVG by hand. The command `npx flowfig` checks the spec and renders it.\n\n## What flowfig draws\n\nA spec has three forms.\n\n- The map (the default). The map shows the boxes and the edges. A packet moves along an edge in each beat.\n- The map with a rail (`\"rail\": true`). The rail is a lifeline diagram under the map. It has one row for each message.\n- The rail alone (`\"rail\": \"only\"`). Use it when the reader needs only the order of the messages, for example when the map is already in the same document.\n\nUse the rail for a sequence of messages: a request lifecycle, an API call chain, or a Mermaid `sequenceDiagram`. Put each message on\nan edge. Put each phase in a step. Put messages that run at the same time in one beat. Mark a message that does not wait for an\nanswer with `\"async\": true`.\n\n## Scope: what flowfig draws and what it does not\n\nflowfig draws how something works: parts, the messages between them, and the order of the messages.\n\n| The user asks for                          | Draw                                                                                       |\n| ------------------------------------------ | ------------------------------------------------------------------------------------------ |\n| An architecture, a data flow, a pipeline   | The map. Group parts by service, network or trust boundary. `store` for data at rest.       |\n| A request lifecycle, a call chain          | The map with `\"rail\": true`. One message per hop, with its real payload in `data`.          |\n| A sequence diagram only                    | `\"rail\": \"only\"`.                                                                           |\n| A state lifecycle, a state machine         | One box per state, one edge per transition, labeled with its event. One step per path. Mark each end state, for example with `sub: \"end state\"`. |\n| A flowchart with branches                  | `shape: \"decision\"` for each branch. One step per path.                                     |\n\nflowfig does not draw class or ER diagrams (fields, types, cardinality), Gantt charts, timelines with dates, charts of numbers,\nor mind maps. If the user asks for one of these, say that flowfig does not draw it, suggest Mermaid (`classDiagram`,\n`erDiagram`, `gantt`), and draw nothing with flowfig.\n\n## Workflow\n\n### 1. Pick the scope\n\nIf the code has more than one flow, name each flow in the reply. Then draw one flow, or draw one structure view and call it a\nstructure view. If the user asks for the whole system, draw one top view with groups, or a set of figures that together cover\nevery part. Keep each figure to 12 boxes or fewer.\n\n### 2. Write the fact list\n\nBefore the spec, write a list of the facts that the figure must show. Take each fact from the code and from its wiring: config\nfiles, compose files, route tables and queue bindings (or from the pasted Mermaid). Give each fact its `file:line`:\n\n- every part (service, function, store, queue, external system);\n- every call, in order, written as `caller \u2192 callee: payload (file:line of the call)`. The edge in the spec goes from that caller\n  to that callee;\n- every call that does not wait for an answer (fire and forget, a queue, a webhook, a callback), and every consumer of each queue\n  or topic;\n- every branch and every error path (a rejected input, a retry, a dead-letter path);\n- every end state.\n\nIf the code does not show a fact, leave the fact out. Do not guess a part, a name or an order.\n\n### 3. Write the spec\n\nEach fact becomes a box, an edge, a beat, a `data` card or a `show` row. Use the real names from the code as labels, and\nreal example data from the code or its tests. Keep each fact that you leave out, with the reason, for the reply.\n\nMermaid mapping:\n\n| Mermaid                                  | flowfig                                                            |\n| ---------------------------------------- | ------------------------------------------------------------------ |\n| `participant`                            | a box                                                              |\n| `A->>B: text`                            | an edge from A to B, and a hop with `data: \"text\"`                 |\n| `B-->>A: text` (a reply)                 | a hop on the same edge with `back: true`                           |\n| `A-)B: text` (async)                     | a hop with `async: true`                                           |\n| `par ... and ... end`                    | the hops of all branches in one beat                               |\n| `alt` / `opt`                            | one step per path                                                  |\n| `stateDiagram` states and transitions    | boxes, and edges labeled with the event                            |\n\n### 4. Render, then fix\n\n```bash\nnpx flowfig - out.svg <<'SPEC'\n{ \"props\": { \"layout\": ..., \"edges\": [...], \"steps\": [...] } }\nSPEC\n```\n\nThe quoted `<<'SPEC'` heredoc passes the JSON with no change. The command checks the spec first. If the check finds an error, the\ncommand writes no SVG and lists the faults. Fix each fault and render again.\n\n- Fix a layout fault by changing the layout first: put parts in rows or columns, route an edge `around`, or change a gap.\n  Never remove a fact from the fact list to pass the check. If you must remove one, name it in the reply.\n- If `small-text` appears, the figure is too wide. Shorten labels, or split the figure. Use more steps in one figure before\n  you make a second figure. Do not change `--width` to pass the check: the reader sees the figure at the real page width.\n- Fix every other warning, or tell the user why it stays.\n- Do not use `--no-check` to hide a fault.\n\n### 5. Read the figure back\n\nRun `npx flowfig --spec out.svg`. Compare the spec with the fact list. Check that each edge goes from the caller to the callee\nthat its fact names. Add each fact that is missing, fix each wrong edge, and render again.\n\n### 6. Look at the SVG\n\nThe check estimates the text width, so it cannot see everything. If you can open a browser, open the SVG and take a\nscreenshot. Wait a few seconds and take a second screenshot to see a later beat. If you cannot open a browser, write \"not\nlooked at\" in the reply. Never report a look that you did not do. A browser tool can block `file://` URLs. If it does, serve the folder\nwith `python3 -m http.server`.\n\n### 7. Write the reply\n\nThe reply has these parts, in this order:\n\n1. the path of each SVG;\n2. what each figure shows: the parts and the steps. Copy the counts from the `figure:` line of the check output. Copy every name\n   from the read-back spec. Never count from memory;\n3. the scope: the flow you drew, why, and the other flows that exist;\n4. what the figure leaves out, and why;\n5. the check line, exactly as the command printed it, and whether you looked at the SVG.\n\nTo change an SVG later, print its spec with `--spec`, change the spec, and render again.\n\n## Spec reference\n\n`props` has these fields.\n\n| Field      | Type                    | Meaning                                                                                        |\n| ---------- | ----------------------- | ---------------------------------------------------------------------------------------------- |\n| `layout`   | group                   | The boxes and how they line up. Required.                                                      |\n| `edges`    | edge[]                  | The arrows between the boxes. Required.                                                        |\n| `steps`    | step[]                  | The stories the figure tells. With no steps, the figure is a still map.                        |\n| `rail`     | `true` or `\"only\"`      | Draw the steps as a lifeline rail under the map. `\"only\"` draws the rail without the map.      |\n| `speed`    | number                  | Milliseconds a packet takes to cross one edge. Default: 900.                                   |\n| `theme`    | object                  | Colors: `accent`, `fg`, `muted`, `bg`, `surface`, `border`, `font`. Each color you omit keeps its built-in value. |\n\n### layout\n\nThe layout is a tree. A group has `children` and these optional fields.\n\n- `id`: a name that an edge can use to reach the group as a whole.\n- `label`: the title on the frame. Only a group with a `label` gets a frame.\n- `direction`: `\"row\"` (the default) or `\"column\"`.\n- `gap`: the space between children in px. Default: 28 for a column. For a row, the gap fits the widest edge label between two children (at least 56).\n- `align`: `\"start\"`, `\"center\"` or `\"end\"`. This sets where the children line up across the direction.\n\nEvery other item is a box.\n\n| Box field | Meaning                                                                                                   |\n| --------- | --------------------------------------------------------------------------------------------------------- |\n| `id`      | Required. The name that edges and steps use. It must be unique in the figure.                             |\n| `label`   | Required. The title in the box.                                                                           |\n| `sub`     | A smaller line under the label.                                                                           |\n| `shape`   | `\"box\"` (default), `\"decision\"` (a diamond) or `\"store\"` (a database cylinder for data at rest).          |\n| `width`   | Width in px. This overrides the width that the layout picks.                                              |\n| `lines`   | The least number of text lines that a content card keeps. The card still grows to fit its content.        |\n\n### edges\n\nAn edge has these fields.\n\n- `id`: the name that steps use. Default: `from->to`.\n- `from` and `to`: the `id` of a box or a group.\n- `label`: text on the edge, drawn as a small pill.\n- `around`: `\"above\"` or `\"below\"`. This routes the edge over or under the boxes in between (loops, skip-ahead edges).\n- `quiet`: if `true`, the SVG draws the edge only while a step uses it.\n\n### steps\n\nA step has `label` and `flow`. It can also have `caption` (the line under the figure while no beat has a `say`) and `nodes` (ids of\nboxes to highlight for the whole step).\n\n`flow` is a list of beats. A beat is one of these:\n\n- an edge id (a string);\n- an array of edge ids, which run at the same time;\n- an object `{ edges?, say?, show?, light?, ms? }`. A beat with no `edges` is a pause.\n\nThe beat fields:\n\n- `edges`: an edge id, a hop object, or an array of these. A hop object is `{ edge, back?, data?, async? }`.\n  - `back: true` runs the packet from the `to` box to the `from` box.\n  - `data` is a small card that moves with the packet.\n  - `async: true` marks a message that does not wait for an answer. The rail draws it dashed, with an `async` tag.\n- `say`: the caption for the beat.\n- `show`: `{ boxId: [row, ...] }`. This fills the content card of each named box. The card keeps the rows until the step ends.\n- `light`: ids of boxes to highlight for this beat.\n- `ms`: how long the beat lasts. Default: the time one packet needs to cross an edge.\n\nA row of a content card is `{ tag?, tone?, text, meta?, mark?, mono? }`.\n\n- `tag`: a short colored label at the start of the line.\n- `tone`: the color of the tag: `blue` (default), `purple`, `green`, `orange` or `gray`.\n- `text`: the main text.\n- `meta`: muted text after the main text.\n- `mark`: a mark at the right end of the line, such as a check or \"new\".\n- `mono`: if `true`, the text uses a monospace font.\n\n## Content rules\n\n- Give every box a stable `id`.\n- Use `shape: \"store\"` for data at rest (a database, a cache, a file, a queue). Use a plain box for a part that does work. Use `shape: \"decision\"` for a branch.\n- Keep one clear main path, left to right. Put side parts in a `column` group.\n- Use `quiet: true` on a long edge that crosses the picture.\n- Keep an SVG to one or two steps. The SVG plays every step in a loop, with no controls.\n- Use the React player, `<Flow {...props} />` from `flowfig`, for a page that needs tabs, pause or hover.\n\n## Example\n\n```json\n{\n  \"props\": {\n    \"layout\": {\n      \"children\": [\n        { \"id\": \"client\", \"label\": \"Browser\" },\n        { \"id\": \"api\", \"label\": \"API Server\" },\n        { \"id\": \"db\", \"label\": \"Database\", \"shape\": \"store\" }\n      ]\n    },\n    \"edges\": [\n      { \"id\": \"req\", \"from\": \"client\", \"to\": \"api\", \"label\": \"GET /users/42\" },\n      { \"id\": \"q\", \"from\": \"api\", \"to\": \"db\", \"label\": \"SELECT\" }\n    ],\n    \"steps\": [\n      {\n        \"label\": \"read\",\n        \"flow\": [\n          { \"edges\": { \"edge\": \"req\", \"data\": \"GET /users/42\" }, \"say\": \"The browser asks for user 42.\" },\n          { \"edges\": \"q\", \"show\": { \"db\": [{ \"tag\": \"row\", \"tone\": \"gray\", \"text\": \"Ada Lovelace\" }] }, \"say\": \"The API server reads the row.\" },\n          { \"edges\": { \"edge\": \"req\", \"back\": true, \"data\": \"200 OK\" }, \"say\": \"The API server sends the user.\" }\n        ]\n      }\n    ]\n  }\n}\n```\n\n## Commands\n\n```bash\nnpx flowfig - out.svg < spec.json      # render a spec from stdin\nnpx flowfig spec.json out.svg          # render a spec file\nnpx flowfig figure.ts out.svg          # render a module whose default export is a spec\nnpx flowfig check <input> [--json]     # list the faults. The input can also be an SVG that flowfig wrote.\nnpx flowfig --spec out.svg             # print the spec that an SVG carries\nnpx flowfig docs                       # print this guide\nnpx flowfig init                       # write these instructions for the coding agents of a repo\n```\n\nA render checks first and writes nothing on an error. `--strict` makes warnings errors. `--width` sets the page width.\n`--min-text` sets the smallest text that the reader should get. `--no-check` skips the check.\n";
+/** The short instruction text that `flowfig init` writes for each coding agent. */
+export declare const AGENT_TEXT = "# Diagrams with flowfig\n\nUse flowfig when the user wants a diagram of how something works: an architecture, a data flow or pipeline, a request lifecycle,\na call sequence, a state lifecycle, or a flowchart. flowfig also converts a pasted Mermaid flowchart, `stateDiagram` or\n`sequenceDiagram`.\n\nflowfig does not draw class or ER diagrams, Gantt charts or charts of numbers. For those, tell the user so, suggest Mermaid\n(`classDiagram`, `erDiagram`, `gantt`), and draw nothing with flowfig.\n\n1. Run `npx flowfig docs` and read it. If the command fails, stop: tell the user that flowfig is not available, give them\n   `npm install --save-dev flowfig`, and draw nothing with another tool.\n2. Pick the scope. If the code has more than one flow, name each flow in the reply, then draw one flow, or draw one structure\n   view and call it a structure view. If the user asks for the whole system, draw one top view with groups, or a set of figures\n   that together cover every part. Keep each figure to 12 boxes or fewer.\n3. Write a fact list from the code and from its wiring (config, compose, route and queue files). Write each call as\n   `caller \u2192 callee: payload (file:line of the call)`, in order. Include each async call and every consumer of a queue, each\n   branch and error path, and each end state. Leave out what the code does not show.\n4. Write the spec from the fact list, with the real names and data. Render it with `npx flowfig - out.svg`. Fix every fault by\n   changing the layout first (rows, `around`, the gap). Never remove a fact to pass the check; if you must remove one, name it\n   in the reply. If `small-text` appears, split the figure; do not change `--width`.\n5. Run `npx flowfig --spec out.svg` and compare it with the fact list: each edge must go from the caller to the callee that the\n   fact names. Fix each gap.\n6. If you can open a browser, look at the SVG at two moments of the loop. If you cannot, write \"not looked at\" in the reply.\n   Never report a look that you did not do.\n7. Reply with: the SVG path; what it shows, with the counts copied from the `figure:` line and the names copied from the read-back spec; what it leaves out and why;\n   the check line exactly as the command printed it.\n";
+/** The description of the Claude skill: the words that make the agent load it. */
+export declare const SKILL_DESCRIPTION = "Use when the user asks for a diagram, figure or animation of how code or a system works: an architecture, a data flow, a pipeline, a request lifecycle, a call sequence, a state lifecycle or a flowchart; when the user pastes a Mermaid flowchart, stateDiagram or sequenceDiagram to convert; or when the user asks for a class, ER or Gantt diagram.";

package/dist/guide.js

@@ -0,0 +1,280 @@
+// The texts that `flowfig docs` and `flowfig init` print or write. Plain strings, so they ship in dist/.
+/** The full guide, as Markdown. `flowfig docs` prints it. */
+export const GUIDE = `# flowfig guide
+
+flowfig draws animated flow figures. A figure has boxes, the edges between the boxes, and steps. In each step, a packet moves along
+the edges. The output is one animated SVG with no script. The SVG plays in a GitHub README, in PR and issue comments, and in blog
+posts. A figure is about 5 to 50 kB.
+
+You write a JSON spec. You never write SVG by hand. The command \`npx flowfig\` checks the spec and renders it.
+
+## What flowfig draws
+
+A spec has three forms.
+
+- The map (the default). The map shows the boxes and the edges. A packet moves along an edge in each beat.
+- The map with a rail (\`"rail": true\`). The rail is a lifeline diagram under the map. It has one row for each message.
+- The rail alone (\`"rail": "only"\`). Use it when the reader needs only the order of the messages, for example when the map is already in the same document.
+
+Use the rail for a sequence of messages: a request lifecycle, an API call chain, or a Mermaid \`sequenceDiagram\`. Put each message on
+an edge. Put each phase in a step. Put messages that run at the same time in one beat. Mark a message that does not wait for an
+answer with \`"async": true\`.
+
+## Scope: what flowfig draws and what it does not
+
+flowfig draws how something works: parts, the messages between them, and the order of the messages.
+
+| The user asks for                          | Draw                                                                                       |
+| ------------------------------------------ | ------------------------------------------------------------------------------------------ |
+| An architecture, a data flow, a pipeline   | The map. Group parts by service, network or trust boundary. \`store\` for data at rest.       |
+| A request lifecycle, a call chain          | The map with \`"rail": true\`. One message per hop, with its real payload in \`data\`.          |
+| A sequence diagram only                    | \`"rail": "only"\`.                                                                           |
+| A state lifecycle, a state machine         | One box per state, one edge per transition, labeled with its event. One step per path. Mark each end state, for example with \`sub: "end state"\`. |
+| A flowchart with branches                  | \`shape: "decision"\` for each branch. One step per path.                                     |
+
+flowfig does not draw class or ER diagrams (fields, types, cardinality), Gantt charts, timelines with dates, charts of numbers,
+or mind maps. If the user asks for one of these, say that flowfig does not draw it, suggest Mermaid (\`classDiagram\`,
+\`erDiagram\`, \`gantt\`), and draw nothing with flowfig.
+
+## Workflow
+
+### 1. Pick the scope
+
+If the code has more than one flow, name each flow in the reply. Then draw one flow, or draw one structure view and call it a
+structure view. If the user asks for the whole system, draw one top view with groups, or a set of figures that together cover
+every part. Keep each figure to 12 boxes or fewer.
+
+### 2. Write the fact list
+
+Before the spec, write a list of the facts that the figure must show. Take each fact from the code and from its wiring: config
+files, compose files, route tables and queue bindings (or from the pasted Mermaid). Give each fact its \`file:line\`:
+
+- every part (service, function, store, queue, external system);
+- every call, in order, written as \`caller → callee: payload (file:line of the call)\`. The edge in the spec goes from that caller
+  to that callee;
+- every call that does not wait for an answer (fire and forget, a queue, a webhook, a callback), and every consumer of each queue
+  or topic;
+- every branch and every error path (a rejected input, a retry, a dead-letter path);
+- every end state.
+
+If the code does not show a fact, leave the fact out. Do not guess a part, a name or an order.
+
+### 3. Write the spec
+
+Each fact becomes a box, an edge, a beat, a \`data\` card or a \`show\` row. Use the real names from the code as labels, and
+real example data from the code or its tests. Keep each fact that you leave out, with the reason, for the reply.
+
+Mermaid mapping:
+
+| Mermaid                                  | flowfig                                                            |
+| ---------------------------------------- | ------------------------------------------------------------------ |
+| \`participant\`                            | a box                                                              |
+| \`A->>B: text\`                            | an edge from A to B, and a hop with \`data: "text"\`                 |
+| \`B-->>A: text\` (a reply)                 | a hop on the same edge with \`back: true\`                           |
+| \`A-)B: text\` (async)                     | a hop with \`async: true\`                                           |
+| \`par ... and ... end\`                    | the hops of all branches in one beat                               |
+| \`alt\` / \`opt\`                            | one step per path                                                  |
+| \`stateDiagram\` states and transitions    | boxes, and edges labeled with the event                            |
+
+### 4. Render, then fix
+
+\`\`\`bash
+npx flowfig - out.svg <<'SPEC'
+{ "props": { "layout": ..., "edges": [...], "steps": [...] } }
+SPEC
+\`\`\`
+
+The quoted \`<<'SPEC'\` heredoc passes the JSON with no change. The command checks the spec first. If the check finds an error, the
+command writes no SVG and lists the faults. Fix each fault and render again.
+
+- Fix a layout fault by changing the layout first: put parts in rows or columns, route an edge \`around\`, or change a gap.
+  Never remove a fact from the fact list to pass the check. If you must remove one, name it in the reply.
+- If \`small-text\` appears, the figure is too wide. Shorten labels, or split the figure. Use more steps in one figure before
+  you make a second figure. Do not change \`--width\` to pass the check: the reader sees the figure at the real page width.
+- Fix every other warning, or tell the user why it stays.
+- Do not use \`--no-check\` to hide a fault.
+
+### 5. Read the figure back
+
+Run \`npx flowfig --spec out.svg\`. Compare the spec with the fact list. Check that each edge goes from the caller to the callee
+that its fact names. Add each fact that is missing, fix each wrong edge, and render again.
+
+### 6. Look at the SVG
+
+The check estimates the text width, so it cannot see everything. If you can open a browser, open the SVG and take a
+screenshot. Wait a few seconds and take a second screenshot to see a later beat. If you cannot open a browser, write "not
+looked at" in the reply. Never report a look that you did not do. A browser tool can block \`file://\` URLs. If it does, serve the folder
+with \`python3 -m http.server\`.
+
+### 7. Write the reply
+
+The reply has these parts, in this order:
+
+1. the path of each SVG;
+2. what each figure shows: the parts and the steps. Copy the counts from the \`figure:\` line of the check output. Copy every name
+   from the read-back spec. Never count from memory;
+3. the scope: the flow you drew, why, and the other flows that exist;
+4. what the figure leaves out, and why;
+5. the check line, exactly as the command printed it, and whether you looked at the SVG.
+
+To change an SVG later, print its spec with \`--spec\`, change the spec, and render again.
+
+## Spec reference
+
+\`props\` has these fields.
+
+| Field      | Type                    | Meaning                                                                                        |
+| ---------- | ----------------------- | ---------------------------------------------------------------------------------------------- |
+| \`layout\`   | group                   | The boxes and how they line up. Required.                                                      |
+| \`edges\`    | edge[]                  | The arrows between the boxes. Required.                                                        |
+| \`steps\`    | step[]                  | The stories the figure tells. With no steps, the figure is a still map.                        |
+| \`rail\`     | \`true\` or \`"only"\`      | Draw the steps as a lifeline rail under the map. \`"only"\` draws the rail without the map.      |
+| \`speed\`    | number                  | Milliseconds a packet takes to cross one edge. Default: 900.                                   |
+| \`theme\`    | object                  | Colors: \`accent\`, \`fg\`, \`muted\`, \`bg\`, \`surface\`, \`border\`, \`font\`. Each color you omit keeps its built-in value. |
+
+### layout
+
+The layout is a tree. A group has \`children\` and these optional fields.
+
+- \`id\`: a name that an edge can use to reach the group as a whole.
+- \`label\`: the title on the frame. Only a group with a \`label\` gets a frame.
+- \`direction\`: \`"row"\` (the default) or \`"column"\`.
+- \`gap\`: the space between children in px. Default: 28 for a column. For a row, the gap fits the widest edge label between two children (at least 56).
+- \`align\`: \`"start"\`, \`"center"\` or \`"end"\`. This sets where the children line up across the direction.
+
+Every other item is a box.
+
+| Box field | Meaning                                                                                                   |
+| --------- | --------------------------------------------------------------------------------------------------------- |
+| \`id\`      | Required. The name that edges and steps use. It must be unique in the figure.                             |
+| \`label\`   | Required. The title in the box.                                                                           |
+| \`sub\`     | A smaller line under the label.                                                                           |
+| \`shape\`   | \`"box"\` (default), \`"decision"\` (a diamond) or \`"store"\` (a database cylinder for data at rest).          |
+| \`width\`   | Width in px. This overrides the width that the layout picks.                                              |
+| \`lines\`   | The least number of text lines that a content card keeps. The card still grows to fit its content.        |
+
+### edges
+
+An edge has these fields.
+
+- \`id\`: the name that steps use. Default: \`from->to\`.
+- \`from\` and \`to\`: the \`id\` of a box or a group.
+- \`label\`: text on the edge, drawn as a small pill.
+- \`around\`: \`"above"\` or \`"below"\`. This routes the edge over or under the boxes in between (loops, skip-ahead edges).
+- \`quiet\`: if \`true\`, the SVG draws the edge only while a step uses it.
+
+### steps
+
+A step has \`label\` and \`flow\`. It can also have \`caption\` (the line under the figure while no beat has a \`say\`) and \`nodes\` (ids of
+boxes to highlight for the whole step).
+
+\`flow\` is a list of beats. A beat is one of these:
+
+- an edge id (a string);
+- an array of edge ids, which run at the same time;
+- an object \`{ edges?, say?, show?, light?, ms? }\`. A beat with no \`edges\` is a pause.
+
+The beat fields:
+
+- \`edges\`: an edge id, a hop object, or an array of these. A hop object is \`{ edge, back?, data?, async? }\`.
+  - \`back: true\` runs the packet from the \`to\` box to the \`from\` box.
+  - \`data\` is a small card that moves with the packet.
+  - \`async: true\` marks a message that does not wait for an answer. The rail draws it dashed, with an \`async\` tag.
+- \`say\`: the caption for the beat.
+- \`show\`: \`{ boxId: [row, ...] }\`. This fills the content card of each named box. The card keeps the rows until the step ends.
+- \`light\`: ids of boxes to highlight for this beat.
+- \`ms\`: how long the beat lasts. Default: the time one packet needs to cross an edge.
+
+A row of a content card is \`{ tag?, tone?, text, meta?, mark?, mono? }\`.
+
+- \`tag\`: a short colored label at the start of the line.
+- \`tone\`: the color of the tag: \`blue\` (default), \`purple\`, \`green\`, \`orange\` or \`gray\`.
+- \`text\`: the main text.
+- \`meta\`: muted text after the main text.
+- \`mark\`: a mark at the right end of the line, such as a check or "new".
+- \`mono\`: if \`true\`, the text uses a monospace font.
+
+## Content rules
+
+- Give every box a stable \`id\`.
+- Use \`shape: "store"\` for data at rest (a database, a cache, a file, a queue). Use a plain box for a part that does work. Use \`shape: "decision"\` for a branch.
+- Keep one clear main path, left to right. Put side parts in a \`column\` group.
+- Use \`quiet: true\` on a long edge that crosses the picture.
+- Keep an SVG to one or two steps. The SVG plays every step in a loop, with no controls.
+- Use the React player, \`<Flow {...props} />\` from \`flowfig\`, for a page that needs tabs, pause or hover.
+
+## Example
+
+\`\`\`json
+{
+  "props": {
+    "layout": {
+      "children": [
+        { "id": "client", "label": "Browser" },
+        { "id": "api", "label": "API Server" },
+        { "id": "db", "label": "Database", "shape": "store" }
+      ]
+    },
+    "edges": [
+      { "id": "req", "from": "client", "to": "api", "label": "GET /users/42" },
+      { "id": "q", "from": "api", "to": "db", "label": "SELECT" }
+    ],
+    "steps": [
+      {
+        "label": "read",
+        "flow": [
+          { "edges": { "edge": "req", "data": "GET /users/42" }, "say": "The browser asks for user 42." },
+          { "edges": "q", "show": { "db": [{ "tag": "row", "tone": "gray", "text": "Ada Lovelace" }] }, "say": "The API server reads the row." },
+          { "edges": { "edge": "req", "back": true, "data": "200 OK" }, "say": "The API server sends the user." }
+        ]
+      }
+    ]
+  }
+}
+\`\`\`
+
+## Commands
+
+\`\`\`bash
+npx flowfig - out.svg < spec.json      # render a spec from stdin
+npx flowfig spec.json out.svg          # render a spec file
+npx flowfig figure.ts out.svg          # render a module whose default export is a spec
+npx flowfig check <input> [--json]     # list the faults. The input can also be an SVG that flowfig wrote.
+npx flowfig --spec out.svg             # print the spec that an SVG carries
+npx flowfig docs                       # print this guide
+npx flowfig init                       # write these instructions for the coding agents of a repo
+\`\`\`
+
+A render checks first and writes nothing on an error. \`--strict\` makes warnings errors. \`--width\` sets the page width.
+\`--min-text\` sets the smallest text that the reader should get. \`--no-check\` skips the check.
+`;
+/** The short instruction text that `flowfig init` writes for each coding agent. */
+export const AGENT_TEXT = `# Diagrams with flowfig
+
+Use flowfig when the user wants a diagram of how something works: an architecture, a data flow or pipeline, a request lifecycle,
+a call sequence, a state lifecycle, or a flowchart. flowfig also converts a pasted Mermaid flowchart, \`stateDiagram\` or
+\`sequenceDiagram\`.
+
+flowfig does not draw class or ER diagrams, Gantt charts or charts of numbers. For those, tell the user so, suggest Mermaid
+(\`classDiagram\`, \`erDiagram\`, \`gantt\`), and draw nothing with flowfig.
+
+1. Run \`npx flowfig docs\` and read it. If the command fails, stop: tell the user that flowfig is not available, give them
+   \`npm install --save-dev flowfig\`, and draw nothing with another tool.
+2. Pick the scope. If the code has more than one flow, name each flow in the reply, then draw one flow, or draw one structure
+   view and call it a structure view. If the user asks for the whole system, draw one top view with groups, or a set of figures
+   that together cover every part. Keep each figure to 12 boxes or fewer.
+3. Write a fact list from the code and from its wiring (config, compose, route and queue files). Write each call as
+   \`caller → callee: payload (file:line of the call)\`, in order. Include each async call and every consumer of a queue, each
+   branch and error path, and each end state. Leave out what the code does not show.
+4. Write the spec from the fact list, with the real names and data. Render it with \`npx flowfig - out.svg\`. Fix every fault by
+   changing the layout first (rows, \`around\`, the gap). Never remove a fact to pass the check; if you must remove one, name it
+   in the reply. If \`small-text\` appears, split the figure; do not change \`--width\`.
+5. Run \`npx flowfig --spec out.svg\` and compare it with the fact list: each edge must go from the caller to the callee that the
+   fact names. Fix each gap.
+6. If you can open a browser, look at the SVG at two moments of the loop. If you cannot, write "not looked at" in the reply.
+   Never report a look that you did not do.
+7. Reply with: the SVG path; what it shows, with the counts copied from the \`figure:\` line and the names copied from the read-back spec; what it leaves out and why;
+   the check line exactly as the command printed it.
+`;
+/** The description of the Claude skill: the words that make the agent load it. */
+export const SKILL_DESCRIPTION = 'Use when the user asks for a diagram, figure or animation of how code or a system works: an architecture, a data flow, a pipeline, a request lifecycle, a call sequence, a state lifecycle or a flowchart; when the user pastes a Mermaid flowchart, stateDiagram or sequenceDiagram to convert; or when the user asks for a class, ER or Gantt diagram.';

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { type FlowProps } from './model.ts';
+export type * from './model.ts';
+export { LIGHT, DARK } from './model.ts';
+/**
+ * The interactive player for one figure: tabs for the steps, play and pause, speed, hover and full screen.
+ * Give it a `FlowProps` spec. Use `toSvg` from `flowfig/svg` for a static animated SVG instead.
+ */
+export declare function Flow({ layout, edges, steps, theme, speed, autoplay, check, rail: withRail }: FlowProps): import("react").JSX.Element;