mirror of
https://github.com/garrytan/gstack.git
synced 2026-09-10 15:09:00 +02:00
* feat(aside): browser-driver contract, cookbook, research and fallback resolvers
{{ASIDE_SETUP}} (readiness probe + ten rules for driving the user's real browser), {{ASIDE_COOKBOOK}} (script shapes verified live against Aside CLI 1.26: one flow per aside repl script, CDP console hook before navigation, evidence lines, session-directory artifact handoff, GSTACK_STEP_OK sentinel), {{ASIDE_RESEARCH}} (research through aside exec, WebSearch when Aside is absent, knowledge otherwise) and {{BROWSE_FALLBACK}} (the fifteen-row Aside-step to $B-command table plus the rules that differ, so every browsing skill keeps working on gstack's own headless browser). test/aside-driver.test.ts pins the sentences and asserts every browsing skill carries the Aside block followed by the fallback; test/helpers/aside-available.ts is the shared live-Aside probe.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* feat(render): Aside-first local-HTML renderer with the bundled browser as fallback
lib/aside-render.ts serves the HTML's directory on loopback (Aside refuses file:// URLs), opens it with waitUntil load, prints through CDP Page.printToPDF so tagged output, outlines, header/footer templates and page numbers survive, emulates device metrics for sized screenshots, and writes in-page evaluations to files; when Aside is absent it runs the same spec through the browse daemon (newtab, load, js, pdf, screenshot, closetab) and reports ENGINE=aside|browse. bin/gstack-render.ts is the CLI skill templates call. lib/claude-bin.ts and lib/error-handling.ts become the canonical copies (browse/src re-exports them).
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* refactor(browse): /browse drives Aside first, with the $B reference behind the fallback
Contract, cookbook, mode choice (aside repl by default, aside exec for reading), report format, the fallback section, and the full command reference carved on demand.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* refactor(qa): /qa and /qa-only drive Aside, fall back to $B
QA_METHODOLOGY runs every phase as Aside scripts (orient, explore, document, re-test, mobile viewport via CDP emulation, links via HEAD fetch); the authenticate phase is 'you are already signed in'; a 13th rule requires consent before mutating actions on non-local targets; the fallback section translates each step onto $B. The qa E2E tests run on whichever engine is present.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* refactor(design): design-review, design-consultation, design-shotgun, plan-design-review, design-html drive Aside
Design-system extraction is one script printing FONTS/COLORS/HEADINGS/TOUCH_TARGETS/NAV; competitor research confirms the exact URLs before opening them in the real browser and runs on the bundled browser when Aside is absent; design-html's viewport screenshots, sketches and comparison boards render through gstack-render.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* refactor(deploy): benchmark, canary, land-and-deploy Step 7, devex-review drive Aside
One aside repl script per page prints NAV/PAINT/LCP/RESOURCES/SCRIPTS/CSS/SUMMARY (benchmark), CONSOLE_ERRORS/NAV/TEXT + screenshot (canary, re-run every 60s), and the post-deploy check reads responseStatus from the navigation entry; each carries the $B fallback.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* feat(third-party-actions): Aside is the recommended driver; gstack's visible browser stays the fallback
The readiness probe is lifted from {{ASIDE_SETUP}} at gen time (byte-identity pinned) and rule 3 points at browse/SKILL.md for how to drive; the consent question offers Aside first and gstack's own visible browser (handoff/resume for sign-in) as the fallback, as v1.72 framed it.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* refactor(scrape): /scrape reads pages through Aside; the browser-skills runtime rides the fallback
Look-then-extract scripts build the JSON inside the page and print it between JSON_START/JSON_END; aside exec for fuzzy intents; on the $B fallback the browser-skills match/prototype flow and /skillify apply as before.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* refactor(make-pdf): print through Aside first, the bundled browser otherwise
asideClient.ts replaces the direct $B client with one render() call per PDF (the exact option mapping the browse pdf command had: paper, margins, header/footer/page numbers, tagged, outline, printBackground, preferCSSPageSize, Paged.js wait); the diagram pre-pass, oversized-image downscale and DOCX rasters each run as one render script with per-fence try/catch; exit 4 now means no browser is available and names both remedies; $P setup reports which engine it found. The e2e gates run on whichever engine is present, so the Linux lane exercises the fallback.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* refactor(diagram): the triplet is one gstack-render call
SVG, PNG and excalidraw from one invocation over the content-addressed bundle staged under /tmp/gstack-render; every diagram type gets an excalidraw export; gstack-render picks the engine and prints ENGINE=; the diagram E2E gates on either engine.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* feat(research): web research runs in Aside first, WebSearch second
The planning, review, design, security and investigate skills research through {{ASIDE_RESEARCH}}; WebSearch stays in allowed-tools as the fallback; testing.ts's bootstrap step follows; skeleton ceilings ratcheted for the research block.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* feat(setup,gen-skill-docs): prune renders of skills that no longer exist
setup gains _prune_stale_generated for every host tree and the doc generator removes gstack-* output dirs it did not write, so a skill removed from the source tree can never linger in an install.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* test: registries, budgets and suite reconciled for Aside-first with the $B fallback
Touchfiles + E2E tiers gain the Aside keys, coverage matrix and eval baselines updated, size budget re-baselined to parity-baseline-v1.80.0.0.json (the contract plus fallback ride in every browsing skill), parity ceilings ratcheted with measured values, LLM-judge prompts and the E2E fixtures speak Aside-first, browse-fallback.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* docs: Aside first, gstack browser fallback
README, BROWSER.md, docs/, CONTRIBUTING, CLAUDE.md, ARCHITECTURE, AGENTS.md, TODOS and the root router describe the one product story: Aside is the browser gstack drives first; the bundled headless browser is the automatic fallback (Linux, Windows, app closed) where cookie import, GStack Browser, pair-agent and browser-skills still apply.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* chore: regenerate SKILL.md docs, llms.txt, agents digest, ship goldens, context-budget fixture
bun run gen:skill-docs over the templates; goldens re-rendered; context-budget ceilings recaptured.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* v1.80.0.0: Aside is the browser gstack drives first; the bundled browser is the fallback
MINOR: new capability across ten skills, the renderer and research; nothing removed. CHANGELOG release summary + itemized changes; VERSION 1.80.0.0; package.json 1.80.0.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* docs(todos): file non-Claude host ownership-gate and version-heading pin follow-ups
Two follow-ups from the /plan-ceo-review + /plan-eng-review pass on merging
PR #2804 with main's v1.80.0.0 ownership gate: bring the Codex/Factory/
OpenCode/Cursor/Kiro copy loops and the stale-render prune under the
.gstack-owned marker rule, and a free test pinning that the CHANGELOG top
heading equals VERSION (the collision that git cannot see).
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* fix: pre-landing review fixes for the Aside-first branch
Review army + adversarial passes (Claude and Codex) on the merged branch:
setup
- _prune_stale_generated scans the host dirs too (the generator already
removed the render before setup ran, so the host branch was dead), skips
symlinks in the render tree (rm -rf on a slash-terminated link empties its
target), removes a host symlink only when it resolves into gstack, cleans a
bannered real dir through _cleanup_weak_dir, recognizes frontmatter-renamed
skills, and logs through log. The always-run codex render passes every host
dir that may link to it.
- NEEDS_BUILD checks all three binaries (with $_EXE) and lib/ sources; the
browser hint and the bootstrap summary honor GSTACK_SKIP_ASIDE, treat a
requested skip as a request, and derive one skill list.
lib/aside-render.ts + bin/gstack-render.ts
- The loopback server carries a per-render secret path, checks containment on
the real path (symlink escapes are 403), and rejects malformed encoding.
- Inline eval results are one base64 line, so page text cannot forge
ASIDE_DIR= or the sentinel; the last ASIDE_DIR wins.
- runProc escalates SIGTERM to SIGKILL, bounds every wait, and clears every
timer (an uncleared one kept gstack-render alive after printing OK).
- renderTmpDir refuses a shared /tmp name owned by someone else; the work dir
and server are created inside try; goto's budget follows the render budget.
- probeAside classifies a present-but-failing CLI as ASIDE_NOT_RUNNING like
the skills' bash probe; render() retries on gstack's own browser when Aside
could not start or its private CDP bridge is gone (never on a page error
or a timeout of a running script); the CLI reports the engine that actually
rendered, exits 0 on --help, rejects non-numeric flags, documents
--wait-timeout, fences EVAL/PAGE_ERRORS as untrusted content, and names the
daemon's cookie-import JS lock remedy.
- The browse path passes --scale only when asked (a scale change rebuilds
the daemon context) and restores the viewport after a sized screenshot.
resolvers / templates
- The bash probe honors GSTACK_SKIP_ASIDE and has a perl deadline on stock
macOS; .local is no longer LOCAL (mDNS); same-origin filters compare parsed
origins; link status is HEAD-checked only on LOCAL targets; every
aside exec goes through the receipted _aside_exec prelude
({{ASIDE_EXEC_PRELUDE}}), including nine template blocks that called it
bare; the design sketch and diagram staging use private directories.
- The generator prunes only bannered renders and never a host whose
generation failed.
Docs, stale comments and dead code cleaned; goldens re-rendered; tests
updated and added for every behavior above.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* test: coverage for the render CLI, setup rebuild check, make-pdf exit codes, and prose $B spans
New free tests from the ship coverage audit: test/gstack-render-cli.test.ts
(argv guards, --help, output contract with a fake daemon, failure and
serve-root paths, no-browser case, prompt exit), test/setup-needs-build.test.ts
(every binary and source set flips NEEDS_BUILD, Windows suffixes),
make-pdf/test/cli-exit-codes.test.ts and setup-smoke.test.ts (error to exit
code mapping, runSetup stages, renderPdf's engine), and prose-span cases for
extractBrowseCommands in test/skill-parser.test.ts.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* docs: CHANGELOG and TODOS cover the review fixes (v1.81.0.0)
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* docs: sync project docs with the v1.81.0.0 review fixes
BROWSER.md, ARCHITECTURE.md, CONTRIBUTING.md, README.md, CLAUDE.md,
docs/TESTING_INTERNALS.md and docs/PROJECT_STRUCTURE.md now describe the
shipped renderer and setup: the loopback render server's per-render secret
path and real-path containment, ENGINE= naming the engine that actually
rendered (mid-run retry on gstack's own browser), EVAL/PAGE_ERRORS fenced as
untrusted content, --wait-timeout and the CLI's argv guards, the receipted
_aside_exec prelude ({{ASIDE_EXEC_PRELUDE}} in the placeholder table), the
LOCAL host rule without .local, LOCAL-only HEAD checks in the links script,
GSTACK_SKIP_ASIDE across probe/renderer/setup, the ownership-gated
retired-skill prune, the widened NEEDS_BUILD check, and the new free tests
(gstack-render-cli, setup-prune-stale-generated, setup-browser-hint,
setup-needs-build, make-pdf cli-exit-codes and setup-smoke).
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* docs: CHANGELOG states the precise mid-run retry rule
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* fix(test): skill-e2e-bws slices the $B setup block from the Browser fallback section
browse/SKILL.md no longer has '## SETUP' / '## Core QA Patterns' (Aside is the
primary driver; the $B block moved under 'Browser fallback'), so the gate test
sliced an empty block and handed the agent nothing to run. Anchor on
'### Find the `$B` binary' up to the next heading. 7/7 pass.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* fix(test): gate POSIX-only fixtures off Windows
windows-free-tests: the gstack-render CLI tests drive a shebang fake browse
that CreateProcess cannot exec, and two NEEDS_BUILD cases assert an execute
bit and a bare-name miss that MSYS bash does not have (test -x ignores mode
bits and resolves design -> design.exe). Those describes and cases now
self-skip on win32; argument guards, --help, the no-browser case, and every
other rebuild-check case still run there.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* fix(render): runProc waits for the exit code until the kill deadline; newtab retries once on a cold daemon
A process whose pipes have reached EOF is exiting, but runProc gave the exit
code only five seconds to arrive and then returned null, which run() reports
as a failed command. Under CI's six-shard load one such render failed with the
artifact already written. The SIGTERM/SIGKILL timers already bound the wait,
so the exit race now runs to the kill deadline.
The first CLI call auto-starts the browse daemon; on a cold start it can
answer 'Unable to connect' once while the server is still coming up. That
single case is retried after 1.5s; every other newtab failure is not.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* test(aside-render): warm the daemon before live fallback cases; failures name the render error
- Live fallback cases run 'goto about:blank' up to twice before asserting and
skip (never fail) when the daemon cannot come up.
- expectOk() puts r.error and the browse transcript into the assertion so a
failed render is diagnosable from the CI log.
- The argv-contract cases dump the fake's log on a miss.
- File default timeout is 30s: the subject is the CLI contract, not latency.
- Two cases pin the cold-daemon newtab retry and that other errors are not
retried.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
* docs: CHANGELOG notes the cold-start tolerance of the bundled-browser renderer
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
---------
Co-authored-by: Sina <sdroid674+github@gmail.com>
Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
612 lines
25 KiB
TypeScript
612 lines
25 KiB
TypeScript
/**
|
|
* Markdown → HTML renderer. Pure function, no I/O, no browser.
|
|
*
|
|
* Pipeline:
|
|
* 1. marked parses markdown → HTML
|
|
* 2. Sanitize: strip <script>, <iframe>, <object>, <embed>, <link>,
|
|
* <meta>, <base>, <form>, and all on* event handlers + javascript:
|
|
* URLs. (Codex round 2 #9: untrusted markdown can embed raw HTML.)
|
|
* 3. Smartypants transform (code/URL-safe).
|
|
* 4. Assemble full HTML document with print CSS inlined and
|
|
* semantic structure (cover, TOC placeholder, body).
|
|
*/
|
|
|
|
import { marked } from "marked";
|
|
import { smartypants } from "./smartypants";
|
|
import { printCss, type PrintCssOptions } from "./print-css";
|
|
import { applyImageDirectives } from "./image-policy";
|
|
|
|
export interface RenderOptions {
|
|
markdown: string;
|
|
|
|
// Document-level metadata (used for cover, PDF metadata, running header).
|
|
title?: string;
|
|
author?: string;
|
|
date?: string; // ISO or human string
|
|
subtitle?: string;
|
|
|
|
// Features
|
|
cover?: boolean;
|
|
toc?: boolean;
|
|
watermark?: string;
|
|
noChapterBreaks?: boolean;
|
|
confidential?: boolean; // default: true
|
|
|
|
// Page layout
|
|
pageSize?: "letter" | "a4" | "legal" | "tabloid";
|
|
margins?: string;
|
|
// Per-side margins (override `margins`). Must reach the CSS @page rule:
|
|
// when a landscape promotion flips preferCSSPageSize on, the CSS margins
|
|
// are the ones Chromium honors — dropping per-side flags there would
|
|
// silently change the whole document's layout (Codex P2).
|
|
marginTop?: string;
|
|
marginRight?: string;
|
|
marginBottom?: string;
|
|
marginLeft?: string;
|
|
|
|
// Footer behavior. pageNumbers defaults to true. When footerTemplate is set,
|
|
// CSS page numbers are suppressed so the custom Chromium footer wins cleanly.
|
|
pageNumbers?: boolean;
|
|
footerTemplate?: string;
|
|
}
|
|
|
|
export interface RenderResult {
|
|
html: string; // full HTML document, staged and printed through the browser
|
|
printCss: string; // for debugging / preview
|
|
bodyHtml: string; // just the rendered body (tests, snapshots)
|
|
meta: {
|
|
title: string;
|
|
author: string;
|
|
date: string;
|
|
wordCount: number;
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Pure renderer. No side effects.
|
|
*/
|
|
export function render(opts: RenderOptions): RenderResult {
|
|
// 1. Markdown → HTML (strip a leading YAML frontmatter block first; marked
|
|
// has no frontmatter awareness and would otherwise render it as a literal
|
|
// paragraph of body text on its own first page).
|
|
const rawHtml = marked.parse(stripFrontmatter(opts.markdown), { async: false }) as string;
|
|
|
|
// 1.5. Image directive suffixes: `{width=50%}` → data-gstack-*
|
|
// attributes. Before the sanitizer (which keeps data- attrs) so the brace
|
|
// text never reaches smartypants or the final page.
|
|
const directedHtml = applyImageDirectives(rawHtml);
|
|
|
|
// 2. Sanitize
|
|
const cleanHtml = sanitizeUntrustedHtml(directedHtml);
|
|
|
|
// 3. Decode common entities so smartypants can match raw " and '.
|
|
// marked HTML-encodes quotes in text ("hello" → "hello");
|
|
// without decoding, smartypants' regex never fires. These get re-encoded
|
|
// implicitly by the browser's HTML parser downstream, and for the ones
|
|
// that should stay as curly-quote Unicode, that IS the final form.
|
|
const decoded = decodeTypographicEntities(cleanHtml);
|
|
|
|
// 4. Smartypants (code-safe)
|
|
const typographicHtml = smartypants(decoded);
|
|
|
|
// 4. Derive metadata (title from first H1 if not provided)
|
|
const derivedTitle = opts.title ?? extractFirstHeading(typographicHtml) ?? "Document";
|
|
const derivedAuthor = opts.author ?? "";
|
|
const derivedDate = opts.date ?? formatToday();
|
|
|
|
// 5. Build CSS
|
|
// CSS is the single source of truth for page numbers (Chromium native
|
|
// numbering is always off in orchestrator). If the caller supplied a custom
|
|
// footerTemplate, suppress CSS page numbers too so their footer wins.
|
|
const showPageNumbers = opts.pageNumbers !== false && !opts.footerTemplate;
|
|
const cssOptions: PrintCssOptions = {
|
|
cover: opts.cover,
|
|
toc: opts.toc,
|
|
noChapterBreaks: opts.noChapterBreaks,
|
|
watermark: opts.watermark,
|
|
confidential: opts.confidential !== false,
|
|
runningHeader: derivedTitle,
|
|
pageSize: opts.pageSize,
|
|
// Compose per-side margins into the CSS shorthand so @page stays the
|
|
// single source of truth even under preferCSSPageSize.
|
|
margins: composeMargins(opts),
|
|
pageNumbers: showPageNumbers,
|
|
};
|
|
const css = printCss(cssOptions);
|
|
|
|
// 6. Assemble document
|
|
const coverBlock = opts.cover
|
|
? buildCoverBlock({
|
|
title: derivedTitle,
|
|
subtitle: opts.subtitle,
|
|
author: derivedAuthor,
|
|
date: derivedDate,
|
|
})
|
|
: "";
|
|
|
|
// TOC anchors must resolve: assign id="toc-N" to each H1-H3 in the same
|
|
// order buildTocBlock scans them, or every TOC link is a dead href (masked
|
|
// in PDFs by Chromium outline bookmarks, glaring in --to html). Headings
|
|
// that already carry an id keep it — the ids array records the ACTUAL id
|
|
// per heading so TOC entries always link to something real.
|
|
const anchored = opts.toc ? addHeadingIds(typographicHtml) : { html: typographicHtml, ids: [] };
|
|
const anchoredHtml = anchored.html;
|
|
|
|
const tocBlock = opts.toc
|
|
? buildTocBlock(anchoredHtml, anchored.ids)
|
|
: "";
|
|
|
|
// Wrap body in .chapter sections at H1 boundaries if chapter breaks are on.
|
|
const chapterHtml = opts.noChapterBreaks
|
|
? `<section class="chapter">${anchoredHtml}</section>`
|
|
: wrapChaptersByH1(anchoredHtml);
|
|
|
|
const watermarkBlock = opts.watermark
|
|
? `<div class="watermark">${escapeHtml(opts.watermark)}</div>`
|
|
: "";
|
|
|
|
const fullHtml = [
|
|
`<!doctype html>`,
|
|
`<html lang="en">`,
|
|
`<head>`,
|
|
`<meta charset="utf-8">`,
|
|
`<title>${escapeHtml(derivedTitle)}</title>`,
|
|
derivedAuthor ? `<meta name="author" content="${escapeHtml(derivedAuthor)}">` : ``,
|
|
`<style>`,
|
|
css,
|
|
`</style>`,
|
|
`</head>`,
|
|
`<body>`,
|
|
watermarkBlock,
|
|
coverBlock,
|
|
tocBlock,
|
|
chapterHtml,
|
|
`</body>`,
|
|
`</html>`,
|
|
].filter(Boolean).join("\n");
|
|
|
|
return {
|
|
html: fullHtml,
|
|
printCss: css,
|
|
bodyHtml: typographicHtml,
|
|
meta: {
|
|
title: derivedTitle,
|
|
author: derivedAuthor,
|
|
date: derivedDate,
|
|
wordCount: countWords(stripTags(typographicHtml)),
|
|
},
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Decode the HTML entities that marked emits for text-node quotes/apostrophes.
|
|
* Only the four that matter for smartypants — leaves & alone because it
|
|
* can be legitimately doubled (&amp;) and we don't want to double-decode.
|
|
*/
|
|
function decodeTypographicEntities(html: string): string {
|
|
return html
|
|
.replace(/"/g, "\"")
|
|
.replace(/'/g, "'")
|
|
.replace(/'/g, "'")
|
|
.replace(/'/g, "'");
|
|
}
|
|
|
|
// ─── Sanitizer ────────────────────────────────────────────────────────
|
|
|
|
/**
|
|
* Strip dangerous HTML from markdown-produced output.
|
|
*
|
|
* We can't use DOMPurify (server-side; adds a jsdom dep). A conservative
|
|
* regex sanitizer is fine for this use case because:
|
|
* 1. marked produces structured HTML (never malformed)
|
|
* 2. we only need to strip a fixed blacklist of elements + attrs
|
|
* 3. the output goes through Chromium's parser again, which normalizes
|
|
*
|
|
* What's stripped:
|
|
* - <script>, <iframe>, <object>, <embed>, <link>, <meta>, <base>, <form>
|
|
* (and their content).
|
|
* - on* event handler attributes (onclick, ONCLICK, etc.).
|
|
* - href/src with javascript: scheme.
|
|
* - <svg> tags with <script> inside them.
|
|
* - remote href/xlink:href inside <svg> (and on svg-only elements anywhere)
|
|
* → "#" (offline posture: no fetch at print time).
|
|
* - remote CSS fetch vectors in <style> blocks and style attributes
|
|
* (@import, url(), image-set() with remote string candidates).
|
|
*/
|
|
export function sanitizeUntrustedHtml(html: string): string {
|
|
let s = html;
|
|
|
|
// Elements to remove entirely (including content).
|
|
const DANGER_TAGS = [
|
|
"script", "iframe", "object", "embed", "link", "meta", "base", "form",
|
|
"applet", "frame", "frameset",
|
|
];
|
|
for (const tag of DANGER_TAGS) {
|
|
const re = new RegExp(`<${tag}\\b[\\s\\S]*?</${tag}>`, "gi");
|
|
s = s.replace(re, "");
|
|
// Self-closing / unclosed variants
|
|
const selfRe = new RegExp(`<${tag}\\b[^>]*/?>`, "gi");
|
|
s = s.replace(selfRe, "");
|
|
}
|
|
|
|
// SVG <script>
|
|
s = s.replace(/<svg([^>]*)>([\s\S]*?)<\/svg>/gi, (_, attrs, body) => {
|
|
return `<svg${attrs}>${body.replace(/<script\b[\s\S]*?<\/script>/gi, "")}</svg>`;
|
|
});
|
|
|
|
// Event handler attributes (on* in any case).
|
|
s = s.replace(/\s+on[a-zA-Z]+\s*=\s*"[^"]*"/gi, "");
|
|
s = s.replace(/\s+on[a-zA-Z]+\s*=\s*'[^']*'/gi, "");
|
|
s = s.replace(/\s+on[a-zA-Z]+\s*=\s*[^\s>]+/gi, "");
|
|
|
|
// javascript: URLs in href/src/action/formaction
|
|
s = s.replace(
|
|
/(\s(?:href|src|action|formaction|xlink:href)\s*=\s*)(?:"javascript:[^"]*"|'javascript:[^']*'|javascript:[^\s>]+)/gi,
|
|
'$1"#"',
|
|
);
|
|
|
|
// srcdoc attribute (iframe escape hatch — already stripped via iframe above,
|
|
// but defense-in-depth).
|
|
s = s.replace(/\s+srcdoc\s*=\s*"[^"]*"/gi, "");
|
|
s = s.replace(/\s+srcdoc\s*=\s*'[^']*'/gi, "");
|
|
|
|
// style="url(javascript:..)" — strip javascript: inside style attrs.
|
|
s = s.replace(/url\(\s*javascript:[^)]*\)/gi, "url(#)");
|
|
|
|
// ── Offline-posture fetch vectors (no --allow-network must mean no network
|
|
// at print time; the image inliner covers <img src> only, and must keep
|
|
// seeing remote <img src> so its blocked-remote placeholder still fires) ──
|
|
|
|
// Untrusted CSS neutralization. Scoped to <style> blocks and style
|
|
// attributes below so prose/code samples that mention URLs stay untouched.
|
|
//
|
|
// Chromium decodes CSS ident/string escapes (\69 → i, \68 → h) before
|
|
// fetching, so literal patterns alone are bypassable: @\69mport dodges
|
|
// /@import\b/, url("\68ttps://…") dodges the https?://-shaped remote-url
|
|
// pattern, and u\72l(…) dodges the url( prefix itself. Untrusted styling
|
|
// has no legitimate need for escaped url schemes or at-rule names, so any
|
|
// construct carrying a backslash escape is dropped/defanged (fail closed).
|
|
// In style ATTRIBUTES the HTML parser also entity-decodes before the CSS
|
|
// parser runs, so \ / \ / \ spellings of the backslash count
|
|
// as escapes too. (<style> content is raw text — no entity layer there.)
|
|
const CSS_ESCAPE_MARKER = /\\|�*92(?![0-9])|�*5c(?![0-9a-f])|\/i;
|
|
const neutralizeUntrustedCss = (css: string): string => {
|
|
// (a) At-rules whose keyword carries a backslash escape (@\69mport …):
|
|
// drop the whole statement through `;`, `{`, or end-of-value.
|
|
let out = css.replace(
|
|
/@[-\w\\&#;]*?(?:\\|�*92(?![0-9]);?|�*5c(?![0-9a-f]);?|\)[-\w\\&#;]*[^;{}]*(?:;|\{|$)/gi,
|
|
"");
|
|
// (b) Literal @import is always a fetch (relative ones can't resolve
|
|
// under load-html either) — drop outright.
|
|
out = out.replace(/@import\b[^;]*(;|$)/gi, "");
|
|
// (c) Any function-like token whose name or arguments carry a backslash
|
|
// escape → url(#). Covers escaped schemes (url("\68ttps://…")) and
|
|
// escaped function names (u\72l(…)) in one fail-closed pass. The
|
|
// end-of-value alternative closes the unterminated-url() dodge:
|
|
// Chromium's CSS parser closes an open function token at EOF.
|
|
out = out.replace(/[-\w\\&#;][-\w \t\\&#;]*\(\s*[^)]*(?:\)|$)/g, (m) =>
|
|
CSS_ESCAPE_MARKER.test(m) ? "url(#)" : m);
|
|
// (d) Remote url(...) → url(#).
|
|
out = out.replace(
|
|
/url\(\s*(?:"|�?39;|'|["'])?\s*(?:https?:)?\/\/[^)]*(?:\)|$)/gi,
|
|
"url(#)");
|
|
// (e) image-set() / -webkit-image-set() accept BARE quoted URL strings —
|
|
// no url() token, no backslash — so passes (c)/(d) never fire on
|
|
// `image-set("https://…" 1x)`. Any image-set whose arguments carry a
|
|
// remote-scheme quoted string → url(#) (fail closed). Local string
|
|
// candidates stay; url()-form arguments are already covered by (c)/(d).
|
|
out = out.replace(/(?:-webkit-)?image-set\(\s*[^)]*(?:\)|$)/gi, (m) =>
|
|
/(?:"|�?39;|'|["'])\s*(?:https?:)?\/\//i.test(m) ? "url(#)" : m);
|
|
return out;
|
|
};
|
|
|
|
// Raw-HTML <style> blocks. Element content is RAW TEXT — the HTML parser
|
|
// never entity-decodes it — so unlike style attributes below, no entity
|
|
// decode step is needed (or correct) here.
|
|
s = s.replace(/(<style\b[^>]*>)([\s\S]*?)(<\/style>)/gi, (_m, open, css, close) =>
|
|
open + neutralizeUntrustedCss(css) + close);
|
|
|
|
// Style ATTRIBUTE values are entity-decoded by the HTML parser before the
|
|
// CSS parser ever runs, so https://… reaches Chromium as https://… and
|
|
// // as // — dodging every literal pattern above. Decode the value
|
|
// the way the parser will (numeric dec/hex refs with the spec's optional
|
|
// semicolon; the syntax-significant named refs; the legacy semicolonless
|
|
// four), in ONE left-to-right pass so the sanitizer performs exactly the
|
|
// browser's single decode round — decoding recursively would turn a
|
|
// double-encoded &#104; into a live scheme the browser never sees.
|
|
const NAMED_REFS: Record<string, string> = {
|
|
amp: "&", lt: "<", gt: ">", quot: '"', apos: "'",
|
|
sol: "/", bsol: "\\", colon: ":", semi: ";", num: "#",
|
|
lpar: "(", rpar: ")", commat: "@", grave: "`",
|
|
Tab: "\t", NewLine: "\n",
|
|
};
|
|
const refCodePoint = (n: number): string =>
|
|
(!Number.isFinite(n) || n <= 0 || n > 0x10ffff || (n >= 0xd800 && n <= 0xdfff))
|
|
? "�" : String.fromCodePoint(n);
|
|
const decodeStyleAttrEntities = (v: string): string => v.replace(
|
|
/&(?:#[xX]([0-9a-fA-F]+);?|#(\d+);?|([a-zA-Z]+);|(amp|lt|gt|quot)(?![a-zA-Z0-9=;]))/g,
|
|
(m, hex, dec, named, legacy) => {
|
|
if (hex !== undefined) return refCodePoint(parseInt(hex, 16));
|
|
if (dec !== undefined) return refCodePoint(parseInt(dec, 10));
|
|
if (named !== undefined) return NAMED_REFS[named] ?? m;
|
|
return NAMED_REFS[legacy];
|
|
});
|
|
|
|
// Inline style attributes — quoted AND unquoted. HTML spec: an unquoted
|
|
// attribute value runs until whitespace or `>`, so
|
|
// <div style=background:url(https://…)> is live markup Chromium honors;
|
|
// a quoted-only pattern misses it. The value is unquoted, entity-decoded
|
|
// (see above), neutralized in decoded form, then RE-ENCODED and emitted
|
|
// double-quoted — never emit decoded text raw (a decoded `"` would break
|
|
// out of the attribute) and the re-encode also keeps once-decoded text like
|
|
// h inert instead of granting it a second decode round.
|
|
s = s.replace(/(\s+style\s*=\s*)(?:"([^"]*)"|'([^']*)'|([^\s"'>][^\s>]*))/gi,
|
|
(_m, pre, dq, sq, uq) => {
|
|
const raw = dq ?? sq ?? uq;
|
|
const cleaned = neutralizeUntrustedCss(decodeStyleAttrEntities(raw));
|
|
return `${pre}"${escapeHtml(cleaned)}"`;
|
|
});
|
|
|
|
// SVG remote-fetch vectors: <image href>, <use href>, <feImage href> (and
|
|
// their xlink:href spellings) fetch at print time — the svg handling above
|
|
// only strips <script>, and the javascript:-scheme rewrite doesn't touch a
|
|
// plain https:// href. Fail closed: inside an <svg> block, ANY href /
|
|
// xlink:href whose entity-decoded value is remote (https?:// or //) is
|
|
// rewritten to "#"; local fragment refs (href="#id") and local files stay
|
|
// intact. The tag-scoped second pass catches svg-only elements smuggled
|
|
// through an UNCLOSED <svg> (Chromium auto-closes at EOF and still
|
|
// fetches); outside foreign content those tags are inert or parser-mapped
|
|
// to <img> (href ignored), so the extra pass can't break plain HTML —
|
|
// regular <a href> hyperlinks are untouched (links don't fetch at print).
|
|
const neutralizeRemoteSvgHref = (fragment: string): string =>
|
|
fragment.replace(
|
|
/(\s(?:xlink:)?href\s*=\s*)("([^"]*)"|'([^']*)'|[^\s>]+)/gi,
|
|
(m, pre, val, dq, sq) => {
|
|
// Decode the value the way the HTML parser will (same single-round
|
|
// decode as style attributes above), then drop the tab/newline/CR
|
|
// characters URL parsing ignores, so https and h\nttps count.
|
|
const raw = dq ?? sq ?? String(val);
|
|
const decoded = decodeStyleAttrEntities(raw).replace(/[\t\n\r]/g, "");
|
|
return /^\s*(?:https?:)?\/\//i.test(decoded) ? `${pre}"#"` : m;
|
|
});
|
|
s = s.replace(/<svg\b[\s\S]*?<\/svg>/gi, neutralizeRemoteSvgHref);
|
|
s = s.replace(/<(?:image|use|feimage)\b[^>]*>/gi, neutralizeRemoteSvgHref);
|
|
|
|
// srcset with a remote candidate: Chromium prefers srcset over the inlined
|
|
// src, so a remote candidate fetches at print time. Strip the attribute;
|
|
// local/data: srcset values are left alone.
|
|
const remoteSrcsetCandidate = /(?:^|[,\s])\s*(?:https?:)?\/\//i;
|
|
s = s.replace(/\s+srcset\s*=\s*("[^"]*"|'[^']*'|[^\s>]+)/gi, (m, val) =>
|
|
remoteSrcsetCandidate.test(String(val).replace(/^["']|["']$/g, "")) ? "" : m);
|
|
|
|
// Remote src/poster on media elements (<video poster>, <source src>, …).
|
|
s = s.replace(/<(?:video|audio|source|track)\b[^>]*>/gi, (tag) =>
|
|
tag.replace(
|
|
/(\s(?:src|poster)\s*=\s*)(?:"(?:https?:)?\/\/[^"]*"|'(?:https?:)?\/\/[^']*'|(?:https?:)?\/\/[^\s>]+)/gi,
|
|
'$1"#"',
|
|
));
|
|
|
|
return s;
|
|
}
|
|
|
|
// ─── Cover / TOC / Chapter helpers ────────────────────────────────────
|
|
|
|
function buildCoverBlock(opts: {
|
|
title: string;
|
|
subtitle?: string;
|
|
author?: string;
|
|
date: string;
|
|
}): string {
|
|
const title = escapeHtml(opts.title);
|
|
const subtitle = opts.subtitle ? escapeHtml(opts.subtitle) : "";
|
|
const author = opts.author ? escapeHtml(opts.author) : "";
|
|
const date = escapeHtml(opts.date);
|
|
return [
|
|
`<section class="cover">`,
|
|
` <h1 class="cover-title">${title}</h1>`,
|
|
subtitle ? ` <p class="cover-subtitle">${subtitle}</p>` : ``,
|
|
` <hr class="rule">`,
|
|
` <div class="cover-meta">`,
|
|
author ? ` <div><strong>${author}</strong></div>` : ``,
|
|
` <div>${date}</div>`,
|
|
` </div>`,
|
|
`</section>`,
|
|
].filter(Boolean).join("\n");
|
|
}
|
|
|
|
/**
|
|
* Scan HTML for H1/H2/H3 headings and emit a TOC placeholder.
|
|
* Page numbers are filled in by Paged.js (when --toc is passed and Paged.js
|
|
* polyfill is injected).
|
|
*/
|
|
function buildTocBlock(html: string, ids: string[] = []): string {
|
|
const headings = extractHeadings(html);
|
|
if (headings.length === 0) return "";
|
|
|
|
const items = headings.map((h, i) => {
|
|
const level = h.level >= 2 ? "level-2" : "level-1";
|
|
const id = ids[i] ?? `toc-${i}`;
|
|
return [
|
|
` <li class="${level}">`,
|
|
` <span class="toc-title"><a href="#${id}">${escapeHtml(h.text)}</a></span>`,
|
|
` <span class="toc-dots"></span>`,
|
|
` <span class="toc-page" data-toc-target="${id}"></span>`,
|
|
` </li>`,
|
|
].join("\n");
|
|
}).join("\n");
|
|
|
|
return [
|
|
`<section class="toc">`,
|
|
` <h2>Contents</h2>`,
|
|
` <ol>`,
|
|
items,
|
|
` </ol>`,
|
|
`</section>`,
|
|
].join("\n");
|
|
}
|
|
|
|
/**
|
|
* Assign id="toc-N" to every H1-H3 in document order — the same order
|
|
* extractHeadings/buildTocBlock use, so anchors and entries line up by index.
|
|
* A heading that already carries an id keeps it, and the returned ids array
|
|
* records the actual id for that slot so the TOC links to the real anchor
|
|
* instead of a nonexistent toc-N.
|
|
*/
|
|
function addHeadingIds(html: string): { html: string; ids: string[] } {
|
|
const ids: string[] = [];
|
|
const out = html.replace(/<(h[1-3])([^>]*)>/gi, (full, tag: string, attrs: string) => {
|
|
const existing = attrs.match(/\bid\s*=\s*["']([^"']*)["']/i)?.[1];
|
|
if (existing) {
|
|
ids.push(existing);
|
|
return full;
|
|
}
|
|
const id = `toc-${ids.length}`;
|
|
ids.push(id);
|
|
return `<${tag}${attrs} id="${id}">`;
|
|
});
|
|
return { html: out, ids };
|
|
}
|
|
|
|
function extractHeadings(html: string): Array<{ level: number; text: string }> {
|
|
const re = /<(h[1-3])[^>]*>([\s\S]*?)<\/\1>/gi;
|
|
const headings: Array<{ level: number; text: string }> = [];
|
|
let match;
|
|
while ((match = re.exec(html)) !== null) {
|
|
const level = parseInt(match[1].slice(1), 10);
|
|
const text = decodeTextEntities(stripTags(match[2]).trim());
|
|
if (text) headings.push({ level, text });
|
|
}
|
|
return headings;
|
|
}
|
|
|
|
/**
|
|
* Wrap H1-rooted sections in <section class="chapter">. When chapter breaks
|
|
* are on (default), CSS `.chapter { break-before: page }` fires between them.
|
|
*/
|
|
function wrapChaptersByH1(html: string): string {
|
|
// Split on H1 openings. Everything before the first H1 is a preamble.
|
|
const h1Re = /<h1\b[^>]*>/gi;
|
|
const matches: number[] = [];
|
|
let m;
|
|
while ((m = h1Re.exec(html)) !== null) {
|
|
matches.push(m.index);
|
|
}
|
|
if (matches.length === 0) {
|
|
return `<section class="chapter">${html}</section>`;
|
|
}
|
|
const chunks: string[] = [];
|
|
const preamble = html.slice(0, matches[0]);
|
|
// A preamble that renders nothing visible (a leading <style> block, an HTML
|
|
// comment) must NOT become its own .chapter. That section would take the
|
|
// `.chapter:first-of-type { break-before: auto }` exception, so the first
|
|
// *real* chapter inherits `break-before: page` and starts on page 2 — leaving
|
|
// a blank page 1. Keep the non-rendering markup (so its styling still applies)
|
|
// but fold it into the first real chapter instead of giving it a page break.
|
|
let carriedPreamble = "";
|
|
if (preamble.trim().length > 0) {
|
|
if (stripNonRendering(preamble).trim().length > 0) {
|
|
chunks.push(`<section class="chapter">${preamble}</section>`);
|
|
} else {
|
|
carriedPreamble = preamble;
|
|
}
|
|
}
|
|
for (let i = 0; i < matches.length; i++) {
|
|
const start = matches[i];
|
|
const end = i + 1 < matches.length ? matches[i + 1] : html.length;
|
|
const body = i === 0 ? carriedPreamble + html.slice(start, end) : html.slice(start, end);
|
|
chunks.push(`<section class="chapter">${body}</section>`);
|
|
}
|
|
return chunks.join("\n");
|
|
}
|
|
|
|
/**
|
|
* Strip leading YAML frontmatter (`---\n...\n---`). Only a block at the very
|
|
* start of the document is removed, so a `---` thematic break elsewhere is
|
|
* untouched.
|
|
*/
|
|
function stripFrontmatter(md: string): string {
|
|
return md.replace(/^---[ \t]*\r?\n[\s\S]*?\r?\n---[ \t]*(?:\r?\n|$)/, "");
|
|
}
|
|
|
|
/**
|
|
* Remove non-rendering markup (style/script blocks, HTML comments) so an
|
|
* otherwise-empty preamble is recognized as visually empty. Used only to decide
|
|
* whether a preamble deserves its own page — the original markup is preserved in
|
|
* the output.
|
|
*/
|
|
function stripNonRendering(html: string): string {
|
|
return html
|
|
.replace(/<style\b[^>]*>[\s\S]*?<\/style>/gi, "")
|
|
.replace(/<script\b[^>]*>[\s\S]*?<\/script>/gi, "")
|
|
.replace(/<!--[\s\S]*?-->/g, "");
|
|
}
|
|
|
|
function extractFirstHeading(html: string): string | null {
|
|
const m = html.match(/<h1\b[^>]*>([\s\S]*?)<\/h1>/i);
|
|
return m ? decodeTextEntities(stripTags(m[1]).trim()) : null;
|
|
}
|
|
|
|
/**
|
|
* Decode HTML entities in plain text extracted from rendered HTML. Distinct
|
|
* from decodeTypographicEntities (which runs on in-pipeline HTML and preserves
|
|
* & because &amp; can be legitimate there). This runs on text destined
|
|
* for <title>, cover, and TOC entries where & MUST become & or escapeHtml
|
|
* produces &amp;.
|
|
*
|
|
* Amp-last ordering: input "&#169;" decodes to "©" in the named pass,
|
|
* then the numeric pass decodes "©" to "©". Decoding & first would
|
|
* produce "©" and the numeric pass would consume it — different end state
|
|
* but risks double-decode on inputs like "&lt;".
|
|
*/
|
|
function decodeTextEntities(s: string): string {
|
|
return s
|
|
.replace(/</g, "<")
|
|
.replace(/>/g, ">")
|
|
.replace(/"/g, '"')
|
|
.replace(/'/g, "'")
|
|
.replace(/'/g, "'")
|
|
.replace(/'/g, "'")
|
|
.replace(/&#(\d+);/g, (_, n) => String.fromCodePoint(parseInt(n, 10)))
|
|
.replace(/&#x([0-9a-fA-F]+);/g, (_, n) => String.fromCodePoint(parseInt(n, 16)))
|
|
.replace(/&/g, "&");
|
|
}
|
|
|
|
/** Compose `margin: top right bottom left` from per-side overrides + base. */
|
|
function composeMargins(opts: {
|
|
margins?: string; marginTop?: string; marginRight?: string;
|
|
marginBottom?: string; marginLeft?: string;
|
|
}): string | undefined {
|
|
const base = opts.margins ?? "1in";
|
|
if (!opts.marginTop && !opts.marginRight && !opts.marginBottom && !opts.marginLeft) {
|
|
return opts.margins;
|
|
}
|
|
return [
|
|
opts.marginTop ?? base,
|
|
opts.marginRight ?? base,
|
|
opts.marginBottom ?? base,
|
|
opts.marginLeft ?? base,
|
|
].join(" ");
|
|
}
|
|
|
|
function stripTags(html: string): string {
|
|
return html.replace(/<[^>]+>/g, "");
|
|
}
|
|
|
|
export function escapeHtml(s: string): string {
|
|
return s
|
|
.replace(/&/g, "&")
|
|
.replace(/</g, "<")
|
|
.replace(/>/g, ">")
|
|
.replace(/"/g, """)
|
|
.replace(/'/g, "'");
|
|
}
|
|
|
|
function countWords(text: string): number {
|
|
return text.split(/\s+/).filter(w => w.length > 0).length;
|
|
}
|
|
|
|
function formatToday(): string {
|
|
const now = new Date();
|
|
return now.toLocaleDateString("en-US", { year: "numeric", month: "long", day: "numeric" });
|
|
}
|