rapier-html 1.2.6 → 1.2.7

package/BUILD.json

@@ -1,10 +1,10 @@
 {
   "package": "rapier-html",
-  "version": "1.2.6",
+  "version": "1.2.7",
   "path": "dist/rapier.html",
-  "bytes": 4952859,
-  "sha256": "48b694df7db506a77f5a98e01098f37d54e7f9a88d6e5647ca09ea43578c3927",
-  "builtAt": "2026-10-16T12:09:12.607Z",
+  "bytes": 5886529,
+  "sha256": "1fda3f30b4140f90c74cef0ea3fce795e9a9672ed7c37a4d393d42dfcf1de8c1",
+  "builtAt": "2026-10-16T19:38:46.299Z",
   "node": "v22.23.3",
   "canonical": true,
   "packing": "zopfli",

package/README.md

@@ -2,13 +2,14 @@
 
 Turn Markdown into one offline HTML file that contains the full Rapier editor. It opens in any browser, on a phone or
 computer, with no account. People read, edit, draw and paint; agents hand over documents, show what changed and get
-the edited copy back. Start with `npx rapier-html@1.2.6 notes.md`.
+the edited copy back. Start with `npx rapier-html@1.2.7 notes.md`.
 
 Use it for a plan to rearrange, a guide to annotate, a draft to keep writing, or a revision to review. The file works
 without any hosted workspace.
 
-- The page writes, draws and paints, saves Markdown, exports Word, PDF and a web page, and prints. It needs no account
-  and fetches nothing to open, edit or save.
+- The page writes, saves Markdown, exports Word, PDF and a web page, and prints. It needs no account and fetches
+  nothing to open, edit or save. It is the base editor (about 1.7 MB) with the plug-ins the document displays with
+  (Math, Mermaid); `--include draw` adds drawing and painting. Notes never travel.
 - `--return` adds a one-use Send back address from the agent door.
 - `--view draw` opens on Draw. `--compare original.md` opens the edit with its diff; `--by <name>` attributes it.
 - `wrap` and `unwrap` move a document into a page and back out, exactly.
@@ -16,14 +17,14 @@ without any hosted workspace.
 Needs Node 22 or newer.
 
 ```sh
-npx -- rapier-html@1.2.6 notes.md                          # the editor, notes.md inside it, written beside the file
-npx -- rapier-html@1.2.6 notes.md --view draw              # opens on Draw: sketch and paint, the document behind it
-npx -- rapier-html@1.2.6 notes.md --view notes             # opens the Notes library
-npx -- rapier-html@1.2.6 notes.md --drawing sketch.svg     # carries a drawing, opened on Draw over the document
-npx -- rapier-html@1.2.6 revised.md --compare original.md # opens showing what changed
-npx -- rapier-html@1.2.6 notes.md --return "$RETURN_URL" --return-expires-at "$RETURN_EXPIRES_AT" # Send back
-npx -- rapier-html@1.2.6 notes.md out.html                 # a named output
-npm install rapier-html@1.2.6                              # as a library: wrap, unwrap
+npx -- rapier-html@1.2.7 notes.md                          # the editor, notes.md inside it, written beside the file
+npx -- rapier-html@1.2.7 notes.md --view draw              # opens on Draw: sketch and paint, the document behind it
+npx -- rapier-html@1.2.7 notes.md --include draw,math     # carries Draw and Math (default: what the document needs)
+npx -- rapier-html@1.2.7 notes.md --drawing sketch.svg     # carries a drawing, opened on Draw over the document
+npx -- rapier-html@1.2.7 revised.md --compare original.md # opens showing what changed
+npx -- rapier-html@1.2.7 notes.md --return "$RETURN_URL" --return-expires-at "$RETURN_EXPIRES_AT" # Send back
+npx -- rapier-html@1.2.7 notes.md out.html                 # a named output
+npm install rapier-html@1.2.7                              # as a library: wrap, unwrap
 ```
 
 The first `--` is for npm, so `--help` reaches the command. It never overwrites a file.

package/dist/page.mjs

@@ -1,14 +1,16 @@
 // SPDX-License-Identifier: MIT
 import {readFile, writeFile} from 'node:fs/promises';
 import {basename, dirname, join} from 'node:path';
-import {wrap} from './wrap.mjs';
+import {wrap, carry, portableNeeds} from './wrap.mjs';
 import {returnAddress, returnExpiresAt} from './return-address.mjs';
-export {wrap, unwrap, encodeCarried, decodeCarried} from './wrap.mjs';
+export {wrap, unwrap, carry, portableNeeds, encodeCarried, decodeCarried} from './wrap.mjs';
 // Unknown options, a bare --drawing or --compare and a third name are refused.
-const USAGE = 'usage: rapier-html <document.md> [out.html] [--view draw|notes] [--drawing sketch.svg] [--compare original.md [--by <your name>]] [--return <url> --return-expires-at <timestamp>]\n' +
+const USAGE = 'usage: rapier-html <document.md> [out.html] [--include draw,math,mermaid] [--view draw] [--drawing sketch.svg] [--compare original.md [--by <your name>]] [--return <url> --return-expires-at <timestamp>]\n' +
 	'  writes <document>.rapier.html beside the file: Rapier with the document inside it, one file, offline.\n' +
 	'  It never overwrites: an output that already exists, the document itself included, is refused.\n' +
-	'  --view      opens the page on Draw (sketch and paint, the document behind it) or on Notes\n' +
+	'  --include   what the file carries beyond the base editor: draw (drawing and painting), math, mermaid, or none;\n' +
+	'              by default, the plug-ins the document displays with, and Draw for --view draw or --drawing\n' +
+	'  --view      draw: opens the page on Draw (sketch and paint, the document behind it)\n' +
 	'  --drawing   carries an SVG drawing alongside the document, opened on Draw as the page boots\n' +
 	'  --compare   carries the original text; the page opens showing its diff from the current document\n' +
 	'  --by        with --compare: the name shown on the diff with the time the page was made\n' +
@@ -21,16 +23,22 @@ const text = async path => { try { return new TextDecoder('utf-8', {fatal: true,
 
 export async function main(argv, pagesDir, {log = console.log} = {}) {
 	const names = [];
-	let drawingPath = null, basePath = null, by = null, view = null, address = null, expiry = null, onlyNames = false;
+	let drawingPath = null, basePath = null, by = null, view = null, address = null, expiry = null, include = null, onlyNames = false;
 	for (let i = 0; i < argv.length; i++) {
 		const arg = argv[i];
 		if (onlyNames || !arg.startsWith('-')) names.push(arg);
 		else if (arg === '--') onlyNames = true;
 		else if (arg === '--help') { log(USAGE); return null; }
 		else if (arg === '--view') {
-			if (view !== null || !['draw', 'notes'].includes(argv[i + 1])) throw new Error('--view takes draw or notes');
+			if (view !== null || argv[i + 1] !== 'draw') throw new Error('--view takes draw');
 			view = argv[++i];
 		}
+		else if (arg === '--include') {
+			const listed = argv[i + 1] === 'none' ? [] : String(argv[i + 1] || '').split(',');
+			if (include !== null || listed.some(item => !['draw', 'math', 'mermaid'].includes(item))) throw new Error('--include takes draw, math and mermaid, comma-separated, or none');
+			include = listed.map(item => item === 'draw' ? 'drawing' : item);
+			i++;
+		}
 		else if (arg === '--compare') {
 			if (basePath !== null || !argv[i + 1] || argv[i + 1].startsWith('-')) throw new Error('--compare takes one text file (write a name that starts with a dash as ./-original.md)');
 			basePath = argv[++i];
@@ -66,9 +74,12 @@ export async function main(argv, pagesDir, {log = console.log} = {}) {
 	if (address) wrapOptions.return = address;
 	if (expiry) wrapOptions.return_expires_at = expiry;
 	// Always a new file; 'wx' refuses any existing path, links included.
-	try { await writeFile(out, wrap(page, source, name, wrapOptions), {flag: 'wx'}); }
+	const carries = include || [...(view === 'draw' || drawingPath ? ['drawing'] : []), ...portableNeeds(source, {base: wrapOptions.base})];
+	const html = wrap(carry(page, carries), source, name, wrapOptions);
+	try { await writeFile(out, html, {flag: 'wx'}); }
 	catch (error) { throw error.code === 'EEXIST' ? new Error(out + ' already exists, and rapier-html never overwrites a file: name a new one') : error; }
-	log(out + ' (' + name + ', ' + Buffer.byteLength(source) + ' bytes of document' +
-		(view ? ', opens on ' + (view === 'draw' ? 'Draw' : 'Notes') : '') + (drawingPath ? ', ' + basename(drawingPath) + ' drawing' : '') + (basePath ? ', its diff from ' + basename(basePath) : '') + ')');
+	const labels = {drawing: 'Draw', math: 'Math', mermaid: 'Mermaid'};
+	log(out + ' (' + name + ', ' + Buffer.byteLength(source) + ' bytes of document, ' + Buffer.byteLength(html) + ' bytes in all, the base editor' +
+		[...new Set(carries)].map(id => ' + ' + labels[id]).join('') + (view ? ', opens on Draw' : '') + (drawingPath ? ', ' + basename(drawingPath) + ' drawing' : '') + (basePath ? ', its diff from ' + basename(basePath) : '') + ')');
 	return out;
 }