@helping-ai-workflow/md2doc 3.12.1 → 3.13.0

package/lib/theme/runtime.js

@@ -12,7 +12,16 @@
   btn.hidden = false;
   var data = JSON.parse(dataEl.textContent);
   var listeners = [];
-  function onTheme(fn) { listeners.push(fn); }
+  // Returns the unsubscribe: a page that draws and discards its own svgs (the
+  // wave editor's canvas, once per open) must not leave a listener behind
+  // holding what it drew.
+  function onTheme(fn) {
+    listeners.push(fn);
+    return function () {
+      var at = listeners.indexOf(fn);
+      if (at !== -1) listeners.splice(at, 1);
+    };
+  }
   function notify(dark) { for (var i = 0; i < listeners.length; i++) listeners[i](dark); }
   function isDark() { return root.getAttribute('data-md2doc-theme') === 'dark'; }
   function save(dark) {
@@ -268,7 +277,8 @@
     return /^rect$/i.test(el.tagName) && next !== null && /^text$/i.test(next.tagName) &&
       el.closest('[id^="wavearcs"]') !== null;
   }
-  function recolourSvg(svg, dark) {
+  function recolourSvg(svg, dark, opts) {
+    var backing = (opts && opts.backing) || 'var(--md-bg)';
     var els = svg.querySelectorAll('polygon, ellipse, path, polyline, rect, line, circle, text, tspan, foreignObject *');
     var live = svg.hasAttribute('data-md2doc-live');
     for (var i = 0; i < els.length; i++) {
@@ -314,7 +324,7 @@
       } else {
         if (fill && fill[3] > 0) {
           var L = lum(fill);
-          if (L > 0.85) ov += isWaveLabelBacking(el) ? 'fill:var(--md-bg) !important;' : 'fill:transparent !important;';
+          if (L > 0.85) ov += isWaveLabelBacking(el) ? 'fill:' + backing + ' !important;' : 'fill:transparent !important;';
           else if (L > 0.3) ov += 'fill:' + tone(fill, 0.26, 0.55) + ' !important;';
           else if (el.closest('g.edge, marker')) ov += 'fill:' + lineColour(fill) + ' !important;';
         }
@@ -352,4 +362,9 @@
     }).observe(content, { childList: true, subtree: true });
   }
   if (isDark()) recolourAll(true);
+  // Public surface for pages that draw their own SVG outside .content (the wave editor canvas).
+  // `__listenerCount` is a test hook (test/editor-click.test.js): the wave
+  // editor subscribes once per open and must unsubscribe on close.
+  window.md2docTheme = { isDark: isDark, onTheme: onTheme, recolourSvg: recolourSvg,
+    __listenerCount: function () { return listeners.length; } };
 })();

package/lib/wave-overflow.js

@@ -0,0 +1,107 @@
+'use strict';
+
+/**
+ * wave-overflow — estimate how wide a WaveDrom data label is and find the ones
+ * wider than the segment they sit in.
+ *
+ * UMD: node `module.exports`. The edit page loads it through lib/editor/server.js
+ * `waveModuleTag`, whose CommonJS shim supplies `module`, so in the browser it
+ * lands at `window.__md2docWave['wave-overflow.js']` (wave-ui.js receives it as
+ * `opts.waveOverflow`). Segments come from wave-codec (`expandWave`,
+ * `dataSlotOf`), never from a second parser of the wave string.
+ *
+ * Widths are the standard Helvetica AFM advances (1/1000 em) for ASCII 32-126;
+ * anything else counts one em. The reader draws data labels in Helvetica at
+ * 14.6667px, which measured 107px for twelve F and 149px for
+ * "D2 (client FCS last 4B)"; this table reproduces both within 2px.
+ */
+(function (root, factory) {
+  if (typeof module === 'object' && module.exports) {
+    module.exports = factory(require('./editor/wave-codec.js'));
+  } else {
+    // Only a bare <script> with no shim reaches this branch; nothing ships it
+    // that way today.
+    root.md2docWaveOverflow = factory(root.__md2docWave['wave-codec.js']);
+  }
+}(typeof self !== 'undefined' ? self : this, function (codec) {
+  // Index 0 is code 32 (space).
+  const AFM = [
+    278, 278, 355, 556, 556, 889, 667, 191, 333, 333, 389, 584, 278, 333, 278, 278,
+    556, 556, 556, 556, 556, 556, 556, 556, 556, 556, 278, 278, 584, 584, 584, 556,
+    1015, 667, 667, 722, 722, 667, 611, 778, 722, 278, 500, 667, 556, 833, 722, 778,
+    667, 778, 722, 667, 611, 722, 667, 944, 667, 667, 611, 278, 278, 278, 469, 556,
+    333, 556, 556, 500, 556, 556, 278, 556, 556, 222, 222, 500, 222, 833, 556, 556,
+    556, 556, 333, 500, 278, 556, 500, 722, 500, 500, 500, 334, 260, 334, 584,
+  ];
+  const DEFAULT_FONT_PX = 14.6667;
+  const CYCLE_UNITS = 40;
+  const PAD = 6;   // breathing room kept on top of the text
+
+  function estimateTextWidth(text, fontPx) {
+    const px = typeof fontPx === 'number' ? fontPx : DEFAULT_FONT_PX;
+    let em = 0;
+    for (const ch of String(text)) {
+      const c = ch.codePointAt(0);
+      em += (c >= 32 && c <= 126 ? AFM[c - 32] : 1000) / 1000;
+    }
+    return em * px;
+  }
+
+  // WaveDrom's own rule (parse-config.js): rounded, <=0 -> 1, capped at 100.
+  function hscaleOf(doc) {
+    const h = doc && doc.config && doc.config.hscale;
+    if (!h) return 1;
+    const n = Math.round(h > 0 ? Math.round(h) : 1);
+    return n > 0 ? Math.min(n, 100) : 1;
+  }
+
+  function lanesOf(list, out) {
+    for (const item of list) {
+      if (Array.isArray(item)) lanesOf(item, out);
+      else if (item && typeof item === 'object') out.push(item);
+    }
+    return out;
+  }
+
+  function dataList(lane) {
+    if (Array.isArray(lane.data)) return lane.data.map(String);
+    if (typeof lane.data === 'string') return lane.data.split(/\s+/).filter(Boolean);
+    return [];
+  }
+
+  function overflowOf(doc) {
+    const out = [];
+    if (!doc || !Array.isArray(doc.signal)) return out;
+    const hscale = hscaleOf(doc);
+    lanesOf(doc.signal, []).forEach(function (lane, laneIndex) {
+      if (typeof lane.wave !== 'string') return;
+      const cells = codec.expandWave(lane.wave);
+      const data = dataList(lane);
+      const p = Number(lane.period);
+      const period = p > 0 ? p : 1;
+      for (let i = 0; i < cells.length; i++) {
+        const slot = codec.dataSlotOf(lane, i);
+        if (slot === null || slot >= data.length) continue;
+        let n = 1;
+        while (i + n < cells.length && cells[i + n].held) n++;
+        const label = data[slot];
+        const need = estimateTextWidth(label) + PAD;
+        const unit = n * CYCLE_UNITS * period;
+        if (need <= unit * hscale) continue;
+        out.push({
+          laneIndex: laneIndex, name: typeof lane.name === 'string' ? lane.name : '',
+          slot: slot, label: label, cells: n, needScale: Math.ceil(need / unit),
+        });
+      }
+    });
+    return out;
+  }
+
+  function suggestScale(list, current) {
+    let k = 0;
+    for (const o of list || []) if (o.needScale > k) k = o.needScale;
+    return k || (typeof current === 'number' ? current : 1);
+  }
+
+  return { estimateTextWidth: estimateTextWidth, overflowOf: overflowOf, suggestScale: suggestScale };
+}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helping-ai-workflow/md2doc",
-  "version": "3.12.1",
+  "version": "3.13.0",
   "description": "Markdown → HTML / PDF renderer with WaveDrom, Mermaid, Graphviz, and draw.io support",
   "keywords": [
     "markdown",
@@ -46,8 +46,8 @@
   },
   "scripts": {
     "preinstall": "node scripts/preinstall.js",
-    "test": "node test/md2doc.test.js && node test/highlight.test.js && node test/blockmap.test.js && node test/drawio.test.js && node test/images.test.js && node test/scroll-anchor.test.js && node test/lightbox.test.js && node test/lightbox-anno.test.js && node test/lightbox-anno-style.test.js && node test/reader-panels.test.js && node test/cli.test.js && node test/code-operator.test.js && node test/convert-md.test.js && node test/render-api.test.js && node test/lineops.test.js && node test/indent-clamp.test.js && node test/selection.test.js && node test/cell-range.test.js && node test/editmode-render.test.js && node test/editmode-wavedrom-reinit.test.js && node test/editor-server.test.js && node test/cli-edit.test.js && node test/open-viewer.test.js && node test/editor-client.test.js && node test/editor-client-runtime.test.js && node test/roundtrip.test.js && node test/byte-stability.test.js && node test/editor-server-throw.test.js && node test/editor-reader-rebind.test.js && node test/inline-md.test.js && node test/table-md.test.js && node test/table-anchor-recovery.test.js && node test/gate-compat.test.js && node test/history.test.js && node test/list-md.test.js && node test/table-width.test.js && node test/toolbar-model.test.js && node test/asset.test.js && node test/paste-md.test.js && node test/patchmap.test.js && node test/wave-codec.test.js && node test/wave-draw.test.js && node test/wave-geometry.test.js && node test/wave-store.test.js && node test/wave-rail-clearance.test.js && node test/editor-journey.test.js && node test/detach-census.test.js && node test/editor-arrow-nav.test.js && node test/editor-cell-range.test.js && node test/reader-design.test.js && node test/theme.test.js",
-    "test:browser": "node test/reader-click.test.js && node test/editor-click.test.js"
+    "test": "node test/md2doc.test.js && node test/highlight.test.js && node test/blockmap.test.js && node test/drawio.test.js && node test/images.test.js && node test/scroll-anchor.test.js && node test/lightbox.test.js && node test/lightbox-anno.test.js && node test/lightbox-anno-style.test.js && node test/reader-panels.test.js && node test/cli.test.js && node test/code-operator.test.js && node test/convert-md.test.js && node test/render-api.test.js && node test/lineops.test.js && node test/indent-clamp.test.js && node test/selection.test.js && node test/cell-range.test.js && node test/editmode-render.test.js && node test/editmode-wavedrom-reinit.test.js && node test/editor-server.test.js && node test/cli-edit.test.js && node test/open-viewer.test.js && node test/editor-client.test.js && node test/editor-client-runtime.test.js && node test/roundtrip.test.js && node test/byte-stability.test.js && node test/editor-server-throw.test.js && node test/editor-reader-rebind.test.js && node test/inline-md.test.js && node test/table-md.test.js && node test/table-anchor-recovery.test.js && node test/gate-compat.test.js && node test/history.test.js && node test/list-md.test.js && node test/table-width.test.js && node test/toolbar-model.test.js && node test/asset.test.js && node test/paste-md.test.js && node test/patchmap.test.js && node test/wave-codec.test.js && node test/wave-draw.test.js && node test/wave-geometry.test.js && node test/wave-store.test.js && node test/editor-journey.test.js && node test/detach-census.test.js && node test/editor-arrow-nav.test.js && node test/editor-cell-range.test.js && node test/reader-design.test.js && node test/theme.test.js && node test/release-check.test.js && node test/wave-overflow.test.js",
+    "test:browser": "node test/reader-click.test.js && node test/editor-click.test.js && node test/wave-canvas.test.js"
   },
   "repository": {
     "type": "git",

package/scripts/release-check.js

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+'use strict';
+
+// Release gate for .github/workflows/publish.yml.
+//
+// The test suites run once, on the pull request. Branch protection on `main`
+// requires those checks to be green and the branch to be up to date before a
+// merge, so every commit on main is a tree that already passed them; running
+// `npm test` again on the tag only repeated a 40-minute job (v3.12.1: four
+// `npm test` runs for one release). What the tag job still has to prove is that
+// the release metadata agrees:
+//   - the tag is vX.Y.Z and equals package.json's version;
+//   - the top `## vX.Y.Z — YYYY-MM-DD` heading of CHANGELOG.md is that version;
+//   - (CLI, --on-main) the tagged commit is reachable from origin/main.
+//
+// Usage: node scripts/release-check.js <tag> [--on-main]
+
+const fs = require('fs');
+const path = require('path');
+const { execFileSync } = require('child_process');
+
+const HEADING = /^## v(\d+\.\d+\.\d+) — \d{4}-\d{2}-\d{2}\s*$/m;
+
+function checkRelease({ tag, pkgVersion, changelog }) {
+  const errors = [];
+  if (!/^v\d+\.\d+\.\d+$/.test(tag)) {
+    errors.push(`tag "${tag}" is not of the form vX.Y.Z`);
+  } else if (tag !== 'v' + pkgVersion) {
+    errors.push(`tag ${tag} does not match package.json version ${pkgVersion}`);
+  }
+  const m = HEADING.exec(changelog);
+  if (m === null) {
+    errors.push('CHANGELOG.md has no "## vX.Y.Z — YYYY-MM-DD" heading');
+  } else if ('v' + m[1] !== tag) {
+    errors.push(`CHANGELOG.md top section is v${m[1]}, not ${tag}`);
+  }
+  return errors;
+}
+
+function main(argv) {
+  const tag = argv[0];
+  if (!tag) { console.error('usage: node scripts/release-check.js <tag> [--on-main]'); return 2; }
+  const root = path.join(__dirname, '..');
+  const pkgVersion = JSON.parse(fs.readFileSync(path.join(root, 'package.json'), 'utf8')).version;
+  const changelog = fs.readFileSync(path.join(root, 'CHANGELOG.md'), 'utf8');
+  const errors = checkRelease({ tag, pkgVersion, changelog });
+  if (argv.includes('--on-main')) {
+    try {
+      execFileSync('git', ['merge-base', '--is-ancestor', 'HEAD', 'origin/main'], { cwd: root, stdio: 'ignore' });
+    } catch (e) {
+      errors.push(`the tagged commit is not on origin/main (tag only merge commits on main)`);
+    }
+  }
+  for (const e of errors) console.error('release-check: ' + e);
+  if (errors.length === 0) console.log(`release-check: ${tag} ok (package.json ${pkgVersion}, CHANGELOG top section ${tag})`);
+  return errors.length === 0 ? 0 : 1;
+}
+
+module.exports = { checkRelease };
+if (require.main === module) process.exit(main(process.argv.slice(2)));