fleuron 0.1.0

package/README.md

@@ -0,0 +1,132 @@
+# fleuron
+
+Paged-media layout in a worker: markdown and CSS in, a display
+structure or PDF bytes out.
+
+[fleuron](https://fleuron.typeworks.dev/) is a layout engine for
+book-shaped documents, compiled to WebAssembly. It shapes text, breaks
+and hyphenates lines, fragments the result into pages, and paints the
+preview and the PDF from the same numbers. It touches no DOM and opens
+no files.
+
+```sh
+npm install fleuron
+```
+
+## On screen
+
+```js
+import { Preview } from 'fleuron';
+
+const preview = await Preview.mount(document.querySelector('#book'));
+await preview.setStyle(css);
+await preview.setMarkdown(markdown);
+
+preview.page = 12;
+preview.zoom = 1.5;
+```
+
+`Preview` starts the worker, loads the module into it, keeps the
+session, fetches the fonts the book was set in, and paints a page as
+SVG. The encoded buffer, the worker messages and the display structure
+are handled internally, and all three stay exported.
+
+`fleuron-react` is the same thing as a component, and holds no engine
+logic of its own.
+
+## In a worker
+
+```js
+// fleuron.worker.js
+import { createEngine } from 'fleuron';
+
+const engine = createEngine();
+self.onmessage = ({ data }) => {
+  void engine.then((ready) =>
+    ready.submit(data, (response, transfer) => self.postMessage(response, transfer)),
+  );
+};
+```
+
+```js
+// the host
+import { Client, paintPage } from 'fleuron';
+
+const worker = new Worker(new URL('./fleuron.worker.js', import.meta.url), { type: 'module' });
+const client = new Client({ post: (request, transfer) => worker.postMessage(request, transfer) });
+worker.onmessage = ({ data }) => client.receive(data);
+
+const output = await client.preview([
+  { op: 'markdown', name: 'manuscript.md', text: markdown },
+  { op: 'style', css },
+]);
+if (output !== null) {
+  element.innerHTML = paintPage(output.pages[0], { fonts: output.fonts });
+}
+```
+
+`null` means a later render overtook this one, so there is nothing to
+paint. Every render raises a generation, the worker echoes it back, and
+a reply that arrives behind the current one is dropped.
+
+The package ships the worker in the shape above, so a host that wants
+no worker file of its own can point at `fleuron/worker`.
+
+## Sending what changed
+
+The module keeps a session between calls: the content tree, the
+styling, and every stage between them and the page. A second render
+pays for the edit rather than for the book.
+
+```js
+await client.preview([{ op: 'style', css: '@page { margin-bottom: 84pt }' }]);
+await client.preview([{ op: 'edit', name: 'ch03.md', text }]);
+await client.apply([{ op: 'font', bytes }]);
+```
+
+A stylesheet that only moves the page box re-fragments over lines that
+are already broken. A keystroke in one chapter reparses that file and
+leaves every other section's lines alone. Font bytes cross once and
+stay registered. `client.stages` reports how many times each stage has
+run, which shows when a cache served.
+
+## Batch
+
+```js
+import { decodeDisplayList, initWasm, render, renderPdf } from 'fleuron';
+
+await initWasm();
+const output = decodeDisplayList(render(markdown, css));
+const pdf = renderPdf(markdown, css);
+```
+
+## The display structure
+
+`client.preview` hands back pages of text runs, rules and images, in
+points, origin top left. Each text run carries the string it was shaped
+from and each glyph a byte range into it, which is what a painter needs
+for selection and copy-and-paste.
+
+`paintPage` draws one of them as SVG. Each run becomes one `<text>`
+carrying an x for every character in it, so the browser places the
+glyphs where the engine put them instead of working out positions of
+its own. `exportPdf` writes the same pages as PDF.
+
+The bytes underneath are postcard with a version in front of them.
+`decodeDisplayList` reads them, exported for a host that moves them
+around itself. Nothing about using the package requires touching them.
+
+## What the host owns
+
+The engine reads no paths, so the host fetches the font bytes and sends
+them once. `client.fontBytes(id)` hands back the file a face was
+registered from, which is how a painter draws with the bundled one.
+
+Layout never decodes an image. It places one from the size the host
+gives it, and the host draws the pixels.
+
+The host starts the worker. A book-scale manuscript is hundreds of
+milliseconds of work, and that much time on the main thread drops
+interactions.
+
+MIT or Apache-2.0.

package/dist/client.d.ts

@@ -0,0 +1,74 @@
+/**
+ * The host's side of the wall: send an edit, get a display structure, and
+ * never paint one the reader has already typed past.
+ */
+import { type Op, type Request, type Response, type Want } from './protocol.js';
+import { type LayoutOutput } from './wire.js';
+/** How a request reaches the worker. */
+export interface Transport {
+    /**
+     * Sends one request. `transfer` holds the buffers that should move
+     * rather than be copied: font and image bytes, which the host has
+     * no reason to keep a second copy of.
+     */
+    post(request: Request, transfer: ArrayBuffer[]): void;
+}
+/** A render that was overtaken: nothing came back, and nothing should be painted. */
+export declare const SUPERSEDED: null;
+/**
+ * A client over one worker.
+ *
+ * Every render raises the generation, so a reply that arrives behind
+ * the current one resolves to `null` instead of bytes. A caller that
+ * paints what it is given therefore cannot paint a stale page.
+ */
+export declare class Client {
+    private readonly transport;
+    private readonly waiting;
+    private id;
+    private generation;
+    private counters;
+    constructor(transport: Transport);
+    /** Hands a reply from the worker to whoever is waiting for it. */
+    receive(response: Response): void;
+    /** The generation the next render will carry. */
+    get current(): number;
+    /**
+     * What the last painted render cost, counted in stage runs rather
+     * than milliseconds: a cache that served shows here, where a clock
+     * would only show a fast machine.
+     */
+    get stages(): {
+        style: number;
+        lines: number;
+        flow: number;
+        paint: number;
+    };
+    /**
+     * Applies inputs and asks for a display structure. Resolves to `null`
+     * when a later render overtook this one, or when its reply came
+     * back behind the current generation.
+     */
+    preview(ops?: Op[]): Promise<LayoutOutput | null>;
+    /** The same, as PDF bytes. */
+    exportPdf(ops?: Op[]): Promise<Uint8Array | null>;
+    /**
+     * The file a face was registered from, for a painter that has to
+     * draw with the bytes the engine shaped with.
+     *
+     * A question rather than a render: nothing overtakes it, and the
+     * answer does not go stale, since a face keeps its id for the
+     * session's life.
+     */
+    fontBytes(font: number): Promise<Uint8Array>;
+    /** Applies inputs and asks for nothing back. */
+    apply(ops: Op[]): Promise<void>;
+    /**
+     * Applies inputs and asks for bytes: the display structure as the
+     * engine encoded it, or a PDF. `null` when this render was
+     * overtaken.
+     */
+    render(ops: Op[], want: Want): Promise<Uint8Array | null>;
+    private send;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAwB,KAAK,EAAE,EAAE,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,IAAI,EAAE,MAAM,eAAe,CAAC;AACtG,OAAO,EAAqB,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AAEjE,wCAAwC;AACxC,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;CACvD;AAED,qFAAqF;AACrF,eAAO,MAAM,UAAU,MAAO,CAAC;AAE/B;;;;;;GAMG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmD;IAC3E,OAAO,CAAC,EAAE,CAAK;IACf,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,QAAQ,CAAkD;gBAEtD,SAAS,EAAE,SAAS;IAIhC,kEAAkE;IAClE,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IASjC,iDAAiD;IACjD,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAG1E;IAED;;;;OAIG;IACG,OAAO,CAAC,GAAG,GAAE,EAAE,EAAO,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAK3D,8BAA8B;IACxB,SAAS,CAAC,GAAG,GAAE,EAAE,EAAO,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAI3D;;;;;;;OAOG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAQlD,gDAAgD;IAC1C,KAAK,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrC;;;;OAIG;IACG,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAgB/D,OAAO,CAAC,IAAI;CA4Bb"}

package/dist/client.js

@@ -0,0 +1,124 @@
+/**
+ * The host's side of the wall: send an edit, get a display structure, and
+ * never paint one the reader has already typed past.
+ */
+import { isFailed, isRendered } from './protocol.js';
+import { decodeDisplayList } from './wire.js';
+/** A render that was overtaken: nothing came back, and nothing should be painted. */
+export const SUPERSEDED = null;
+/**
+ * A client over one worker.
+ *
+ * Every render raises the generation, so a reply that arrives behind
+ * the current one resolves to `null` instead of bytes. A caller that
+ * paints what it is given therefore cannot paint a stale page.
+ */
+export class Client {
+    transport;
+    waiting = new Map();
+    id = 0;
+    generation = 0;
+    counters = [0, 0, 0, 0];
+    constructor(transport) {
+        this.transport = transport;
+    }
+    /** Hands a reply from the worker to whoever is waiting for it. */
+    receive(response) {
+        const settle = this.waiting.get(response.id);
+        if (settle === undefined) {
+            return;
+        }
+        this.waiting.delete(response.id);
+        settle(response);
+    }
+    /** The generation the next render will carry. */
+    get current() {
+        return this.generation;
+    }
+    /**
+     * What the last painted render cost, counted in stage runs rather
+     * than milliseconds: a cache that served shows here, where a clock
+     * would only show a fast machine.
+     */
+    get stages() {
+        const [style, lines, flow, paint] = this.counters;
+        return { style, lines, flow, paint };
+    }
+    /**
+     * Applies inputs and asks for a display structure. Resolves to `null`
+     * when a later render overtook this one, or when its reply came
+     * back behind the current generation.
+     */
+    async preview(ops = []) {
+        const bytes = await this.render(ops, 'preview');
+        return bytes === SUPERSEDED ? SUPERSEDED : decodeDisplayList(bytes);
+    }
+    /** The same, as PDF bytes. */
+    async exportPdf(ops = []) {
+        return this.render(ops, 'pdf');
+    }
+    /**
+     * The file a face was registered from, for a painter that has to
+     * draw with the bytes the engine shaped with.
+     *
+     * A question rather than a render: nothing overtakes it, and the
+     * answer does not go stale, since a face keeps its id for the
+     * session's life.
+     */
+    async fontBytes(font) {
+        const response = await this.send({ ops: [], want: 'font', font });
+        if (!isRendered(response)) {
+            throw new Error(`the engine sent no bytes for font ${font}`);
+        }
+        return response.bytes;
+    }
+    /** Applies inputs and asks for nothing back. */
+    async apply(ops) {
+        await this.send({ ops });
+    }
+    /**
+     * Applies inputs and asks for bytes: the display structure as the
+     * engine encoded it, or a PDF. `null` when this render was
+     * overtaken.
+     */
+    async render(ops, want) {
+        this.generation += 1;
+        const response = await this.send({ ops, want, generation: this.generation });
+        if (!isRendered(response)) {
+            return SUPERSEDED;
+        }
+        // The worker only knows it was overtaken by a request it had in
+        // hand. A reply can also be outrun in flight, and the host is the
+        // one who can see that.
+        if (response.generation < this.generation) {
+            return SUPERSEDED;
+        }
+        this.counters = response.stages;
+        return response.bytes;
+    }
+    send(what) {
+        this.id += 1;
+        const request = {
+            id: this.id,
+            generation: what.generation ?? this.generation,
+            ops: what.ops,
+            ...(what.want === undefined ? {} : { want: what.want }),
+            ...(what.font === undefined ? {} : { font: what.font }),
+        };
+        const transfer = request.ops
+            .filter((op) => op.op === 'font' || op.op === 'image')
+            .map((op) => op.bytes.buffer);
+        return new Promise((resolve, reject) => {
+            this.waiting.set(request.id, (response) => {
+                if (isFailed(response)) {
+                    reject(new Error(response.error));
+                }
+                else {
+                    resolve(response);
+                }
+            });
+            this.transport.post(request, transfer);
+        });
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAmD,MAAM,eAAe,CAAC;AACtG,OAAO,EAAE,iBAAiB,EAAqB,MAAM,WAAW,CAAC;AAYjE,qFAAqF;AACrF,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,OAAO,MAAM;IACA,SAAS,CAAY;IACrB,OAAO,GAAG,IAAI,GAAG,EAAwC,CAAC;IACnE,EAAE,GAAG,CAAC,CAAC;IACP,UAAU,GAAG,CAAC,CAAC;IACf,QAAQ,GAAqC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAElE,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,kEAAkE;IAClE,OAAO,CAAC,QAAkB;QACxB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC7C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACjC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACnB,CAAC;IAED,iDAAiD;IACjD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAClD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,MAAY,EAAE;QAC1B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAChD,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACtE,CAAC;IAED,8BAA8B;IAC9B,KAAK,CAAC,SAAS,CAAC,MAAY,EAAE;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,CAAC,IAAY;QAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,qCAAqC,IAAI,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED,gDAAgD;IAChD,KAAK,CAAC,KAAK,CAAC,GAAS;QACnB,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,GAAS,EAAE,IAAU;QAChC,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC;QACrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAC7E,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,gEAAgE;QAChE,kEAAkE;QAClE,wBAAwB;QACxB,IAAI,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YAC1C,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC;QAChC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAEO,IAAI,CAAC,IAKZ;QACC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;QACb,MAAM,OAAO,GAAY;YACvB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU;YAC9C,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;YACvD,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;SACxD,CAAC;QACF,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG;aACzB,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,MAAM,IAAI,EAAE,CAAC,EAAE,KAAK,OAAO,CAAC;aACrD,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,MAAqB,CAAC,CAAC;QAC/C,OAAO,IAAI,OAAO,CAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC/C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACxC,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvB,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpC,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACpB,CAAC;YACH,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/engine.d.ts

@@ -0,0 +1,50 @@
+/**
+ * The worker's side of the wall: the module, the session it keeps,
+ * and the rule that only the newest render is worth running.
+ *
+ * Requests are applied in the order they arrive and renders are not.
+ * A render that a later request overtakes before it starts is
+ * dropped, and the inputs it carried are applied all the same. So a
+ * dropped render leaves no stage half-built, and the render that
+ * follows it produces exactly what it would have produced had nobody
+ * typed.
+ */
+import { Session, type InitInput } from '../wasm/fleuron.js';
+import type { Request, Response } from './protocol.js';
+/** How the module is loaded. */
+export interface EngineOptions {
+    /**
+     * The module itself, or where to fetch it. A browser that serves
+     * the package can leave this out and let the module find its own
+     * `.wasm` beside the glue. Anywhere without `fetch` over the
+     * package's own files (Node, an extension, a bundler that inlines
+     * the module) passes the bytes.
+     */
+    wasm?: InitInput;
+}
+/** Sends one reply, moving the bytes rather than copying them. */
+export type Reply = (response: Response, transfer: ArrayBuffer[]) => void;
+/**
+ * Loads the module and opens a session over it.
+ *
+ * One session per worker: it holds the manuscript, the styling and
+ * every stage between them, which is what makes the second render of
+ * a book cost what changed rather than the book.
+ */
+export declare function createEngine(options?: EngineOptions): Promise<Engine>;
+/** A session, and the queue of requests waiting on it. */
+export declare class Engine {
+    private readonly session;
+    private readonly queue;
+    private draining;
+    constructor(session: Session);
+    /** Takes a request. Replies arrive through `reply`, in order. */
+    submit(request: Request, reply: Reply): void;
+    /** Releases the module's session. */
+    free(): void;
+    private drain;
+    private run;
+    private produce;
+    private apply;
+}
+//# sourceMappingURL=engine.d.ts.map

package/dist/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAa,EAAE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,KAAK,EAAM,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE3D,gCAAgC;AAChC,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,kEAAkE;AAClE,MAAM,MAAM,KAAK,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,IAAI,CAAC;AAO1E;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAG/E;AAED,0DAA0D;AAC1D,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiB;IACvC,OAAO,CAAC,QAAQ,CAAS;gBAEb,OAAO,EAAE,OAAO;IAI5B,iEAAiE;IACjE,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAK5C,qCAAqC;IACrC,IAAI,IAAI,IAAI;YAIE,KAAK;IAqBnB,OAAO,CAAC,GAAG;IAmCX,OAAO,CAAC,OAAO;IAWf,OAAO,CAAC,KAAK;CAwCd"}

package/dist/engine.js

@@ -0,0 +1,163 @@
+/**
+ * The worker's side of the wall: the module, the session it keeps,
+ * and the rule that only the newest render is worth running.
+ *
+ * Requests are applied in the order they arrive and renders are not.
+ * A render that a later request overtakes before it starts is
+ * dropped, and the inputs it carried are applied all the same. So a
+ * dropped render leaves no stage half-built, and the render that
+ * follows it produces exactly what it would have produced had nobody
+ * typed.
+ */
+import init, { Session } from '../wasm/fleuron.js';
+/**
+ * Loads the module and opens a session over it.
+ *
+ * One session per worker: it holds the manuscript, the styling and
+ * every stage between them, which is what makes the second render of
+ * a book cost what changed rather than the book.
+ */
+export async function createEngine(options = {}) {
+    await init(options.wasm === undefined ? undefined : { module_or_path: options.wasm });
+    return new Engine(new Session());
+}
+/** A session, and the queue of requests waiting on it. */
+export class Engine {
+    session;
+    queue = [];
+    draining = false;
+    constructor(session) {
+        this.session = session;
+    }
+    /** Takes a request. Replies arrive through `reply`, in order. */
+    submit(request, reply) {
+        this.queue.push({ request, reply });
+        void this.drain();
+    }
+    /** Releases the module's session. */
+    free() {
+        this.session.free();
+    }
+    async drain() {
+        if (this.draining) {
+            return;
+        }
+        this.draining = true;
+        try {
+            while (this.queue.length > 0) {
+                // Everything already sent is delivered before anything is
+                // rendered, which is what makes latest-wins mean the latest
+                // the host has actually asked for rather than the latest one
+                // request ago.
+                await settle();
+                const batch = this.queue.splice(0);
+                const newest = lastRenderIn(batch);
+                batch.forEach((pending, index) => this.run(pending, index === newest));
+            }
+        }
+        finally {
+            this.draining = false;
+        }
+    }
+    run(pending, render) {
+        const { request, reply } = pending;
+        const { id, generation } = request;
+        try {
+            // Inputs are applied whether or not this request's render
+            // survives: an edit that crossed the wall is not undone by the
+            // keystroke that followed it.
+            for (const op of request.ops) {
+                this.apply(op);
+            }
+            if (request.want === undefined) {
+                reply({ id, generation, applied: true }, []);
+                return;
+            }
+            if (!render && request.want !== 'font') {
+                reply({ id, generation, superseded: true }, []);
+                return;
+            }
+            const bytes = this.produce(request);
+            const stages = this.session.stages();
+            reply({
+                id,
+                generation,
+                kind: request.want,
+                bytes,
+                stages: [stages[0] ?? 0, stages[1] ?? 0, stages[2] ?? 0, stages[3] ?? 0],
+            }, [bytes.buffer]);
+        }
+        catch (error) {
+            reply({ id, generation, error: String(error) }, []);
+        }
+    }
+    produce(request) {
+        switch (request.want) {
+            case 'pdf':
+                return this.session.exportPdf();
+            case 'font':
+                return this.session.fontBytes(request.font ?? 0);
+            default:
+                return this.session.preview();
+        }
+    }
+    apply(op) {
+        switch (op.op) {
+            case 'font':
+                this.session.addFont(op.bytes);
+                break;
+            case 'image':
+                this.session.addImage(op.url, op.bytes);
+                break;
+            case 'dialect':
+                this.session.setDialect(op.dialect);
+                break;
+            case 'split':
+                this.session.setSplit(op.level);
+                break;
+            case 'markdown':
+                this.session.setMarkdown(op.name, op.text);
+                break;
+            case 'book':
+                this.session.setSources(op.sources.map((source) => source.name), op.sources.map((source) => source.text));
+                break;
+            case 'remove':
+                this.session.removeMarkdown(op.name);
+                break;
+            case 'metadata':
+                this.session.setMetadata(JSON.stringify(op.metadata));
+                break;
+            case 'edit':
+                this.session.updateMarkdown(op.name, op.text);
+                break;
+            case 'content':
+                this.session.setContent(op.json);
+                break;
+            case 'style':
+                this.session.setStyle(op.css);
+                break;
+        }
+    }
+}
+/**
+ * Which request in a batch is the one whose render still matters.
+ *
+ * A question is not a render: asking for a face's bytes neither
+ * overtakes a render nor is overtaken by one.
+ */
+function lastRenderIn(batch) {
+    for (let index = batch.length - 1; index >= 0; index -= 1) {
+        const want = batch[index]?.request.want;
+        if (want === 'preview' || want === 'pdf') {
+            return index;
+        }
+    }
+    return -1;
+}
+/** Yields long enough for messages already sent to be delivered. */
+function settle() {
+    return new Promise((resolve) => {
+        setTimeout(resolve, 0);
+    });
+}
+//# sourceMappingURL=engine.js.map

package/dist/engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.js","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,IAAI,EAAE,EAAE,OAAO,EAAkB,MAAM,oBAAoB,CAAC;AAuBnE;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,UAAyB,EAAE;IAC5D,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACtF,OAAO,IAAI,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC;AACnC,CAAC;AAED,0DAA0D;AAC1D,MAAM,OAAO,MAAM;IACA,OAAO,CAAU;IACjB,KAAK,GAAc,EAAE,CAAC;IAC/B,QAAQ,GAAG,KAAK,CAAC;IAEzB,YAAY,OAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,iEAAiE;IACjE,MAAM,CAAC,OAAgB,EAAE,KAAY;QACnC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACpC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;IAED,qCAAqC;IACrC,IAAI;QACF,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAEO,KAAK,CAAC,KAAK;QACjB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,0DAA0D;gBAC1D,4DAA4D;gBAC5D,6DAA6D;gBAC7D,eAAe;gBACf,MAAM,MAAM,EAAE,CAAC;gBACf,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACnC,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;gBACnC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACxB,CAAC;IACH,CAAC;IAEO,GAAG,CAAC,OAAgB,EAAE,MAAe;QAC3C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QACnC,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QACnC,IAAI,CAAC;YACH,0DAA0D;YAC1D,+DAA+D;YAC/D,8BAA8B;YAC9B,KAAK,MAAM,EAAE,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;gBAC7B,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACjB,CAAC;YACD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC/B,KAAK,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC7C,OAAO;YACT,CAAC;YACD,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBACvC,KAAK,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;gBAChD,OAAO;YACT,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACpC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACrC,KAAK,CACH;gBACE,EAAE;gBACF,UAAU;gBACV,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,KAAK;gBACL,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;aACzE,EACD,CAAC,KAAK,CAAC,MAAqB,CAAC,CAC9B,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,KAAK,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAEO,OAAO,CAAC,OAAgB;QAC9B,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,KAAK;gBACR,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAClC,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;YACnD;gBACE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,EAAM;QAClB,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;YACd,KAAK,MAAM;gBACT,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,OAAO;gBACV,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,SAAS;gBACZ,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;gBACpC,MAAM;YACR,KAAK,OAAO;gBACV,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;gBAChC,MAAM;YACR,KAAK,UAAU;gBACb,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;gBAC3C,MAAM;YACR,KAAK,MAAM;gBACT,IAAI,CAAC,OAAO,CAAC,UAAU,CACrB,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EACvC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CACxC,CAAC;gBACF,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;gBACrC,MAAM;YACR,KAAK,UAAU;gBACb,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACtD,MAAM;YACR,KAAK,MAAM;gBACT,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;gBAC9C,MAAM;YACR,KAAK,SAAS;gBACZ,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;gBACjC,MAAM;YACR,KAAK,OAAO;gBACV,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC9B,MAAM;QACV,CAAC;IACH,CAAC;CACF;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,KAAgB;IACpC,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC;QACxC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACzC,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC;AAED,oEAAoE;AACpE,SAAS,MAAM;IACb,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * fleuron in a worker: markdown and CSS in, a display structure or PDF
+ * bytes out.
+ *
+ * The host keeps a {@link Client}, the worker keeps an
+ * {@link Engine}, and between them the engine's session keeps every
+ * stage of the pipeline so that a second render pays for the edit
+ * rather than for the book.
+ *
+ * {@link Preview} is all of that behind one object: an element, a
+ * manuscript, and a page on screen.
+ */
+export { Client, SUPERSEDED, type Transport } from './client.js';
+export { Engine, createEngine, type EngineOptions, type Reply } from './engine.js';
+export { isFailed, isRendered, type Applied, type Failed, type Metadata, type Op, type Rendered, type Request, type Response, type Source, type Superseded, type Want, } from './protocol.js';
+export { Preview, type PreviewOptions } from './preview.js';
+export { VERSION } from './version.js';
+export { faceFamily, paintPage, type PaintOptions } from './svg.js';
+export { WIRE_VERSION, WireError, decodeDisplayList, wireVersionOf, type Asset, type DrawItem, type AxisSetting, type FaceAttributes, type FontRefEntry, type Glyph, type ImageItem, type Intrinsic, type LayoutOutput, type Page, type RectItem, type Side, type TextItem, type Warning, } from './wire.js';
+export { Session, render, renderPdf, wireVersion } from '../wasm/fleuron.js';
+export { default as initWasm, initSync, type InitInput, type SyncInitInput } from '../wasm/fleuron.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,aAAa,EAAE,KAAK,KAAK,EAAE,MAAM,aAAa,CAAC;AACnF,OAAO,EACL,QAAQ,EACR,UAAU,EACV,KAAK,OAAO,EACZ,KAAK,MAAM,EACX,KAAK,QAAQ,EACb,KAAK,EAAE,EACP,KAAK,QAAQ,EACb,KAAK,OAAO,EACZ,KAAK,QAAQ,EACb,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,IAAI,GACV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AACpE,OAAO,EACL,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,KAAK,KAAK,EACV,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,KAAK,EACV,KAAK,SAAS,EACd,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,KAAK,IAAI,EACT,KAAK,QAAQ,EACb,KAAK,IAAI,EACT,KAAK,QAAQ,EACb,KAAK,OAAO,GACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,22 @@
+/**
+ * fleuron in a worker: markdown and CSS in, a display structure or PDF
+ * bytes out.
+ *
+ * The host keeps a {@link Client}, the worker keeps an
+ * {@link Engine}, and between them the engine's session keeps every
+ * stage of the pipeline so that a second render pays for the edit
+ * rather than for the book.
+ *
+ * {@link Preview} is all of that behind one object: an element, a
+ * manuscript, and a page on screen.
+ */
+export { Client, SUPERSEDED } from './client.js';
+export { Engine, createEngine } from './engine.js';
+export { isFailed, isRendered, } from './protocol.js';
+export { Preview } from './preview.js';
+export { VERSION } from './version.js';
+export { faceFamily, paintPage } from './svg.js';
+export { WIRE_VERSION, WireError, decodeDisplayList, wireVersionOf, } from './wire.js';
+export { Session, render, renderPdf, wireVersion } from '../wasm/fleuron.js';
+export { default as initWasm, initSync } from '../wasm/fleuron.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAkB,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAkC,MAAM,aAAa,CAAC;AACnF,OAAO,EACL,QAAQ,EACR,UAAU,GAWX,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,OAAO,EAAuB,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAqB,MAAM,UAAU,CAAC;AACpE,OAAO,EACL,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,aAAa,GAed,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,QAAQ,EAAsC,MAAM,oBAAoB,CAAC"}