@lofcz/tikz 0.0.0-stage → 0.2.0

package/NOTICE.md

@@ -0,0 +1,30 @@
+# Third-party runtime
+
+This wrapper maintains a fork of mp-tikz-wasm 0.5.0 by jmckalex, based on commit
+d44aeeba98b0e60d13c35dfd080076e6b05c68b5. `upstream.json` records the archive and
+SHA-256. Only package maintainers download the native baseline from our fork during `npm run build`.
+Engine TypeScript is compiled from `packages/engine` in https://github.com/lofcz/tikz;
+the fork is mirrored at https://github.com/lofcz/mp-tikz-wasm/tree/tikz-monorepo.
+
+The wrapper is GPL-3.0-or-later. Runtime components and fonts retain their
+respective licenses; see the complete upstream `runtime/NOTICE.md`,
+`runtime/LICENSE` and `runtime/licenses/`, included in every npm package.
+The runtime includes GPL pdfTeX/LuaTeX/dvisvgm, LGPL glue, and separately licensed
+TeX macros and fonts. This is not an MIT-only distribution.
+
+Only the ten upstream default bundles are shipped. Optional Classico (AFPL),
+Ghostscript, latex-doc, OpenType and otf-fonts bundles are excluded. No Ghostscript
+engine is included. Native binaries and macro contents are unchanged. Bundle payloads are Brotli-compressed
+without changing their contents. Our Node I/O decompresses them on demand and
+uses portable file URL handling. Browser I/O still uses uncompressed assets.
+
+Corresponding upstream source, patches and reproducible build instructions:
+https://github.com/jmckalex/mp-tikz-wasm/tree/d44aeeba98b0e60d13c35dfd080076e6b05c68b5
+Source archive:
+https://github.com/jmckalex/mp-tikz-wasm/archive/d44aeeba98b0e60d13c35dfd080076e6b05c68b5.tar.gz
+Pinned engine sources:
+https://github.com/jmckalex/mp-tikz-wasm/blob/d44aeeba98b0e60d13c35dfd080076e6b05c68b5/vendor/SOURCES.lock
+
+See the upstream Makefile, vendor/ and patches/ for rebuilding/replacing the
+runtime. The package resolves its runtime from its own install directory;
+consumers can replace those files with compatible rebuilt versions.

package/README.md

@@ -1,3 +1,128 @@
-# Temporary Holding Version
+# @lofcz/tikz
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Render standard TikZ and standalone LaTeX to SVG using
+our maintained [mp-tikz-wasm fork](https://github.com/lofcz/mp-tikz-wasm). Node 22.19+ and
+Bun with Node on PATH. No system TeX installation, network access, runtime
+download, install script, framework, or API key is needed by consumers.
+
+```sh
+npm install @lofcz/tikz
+```
+
+```js
+import { renderTikz } from '@lofcz/tikz';
+
+const image = await renderTikz(String.raw`
+\begin{tikzpicture}
+  \draw[->] (-2,0) -- (2,0);
+  \draw[blue,thick] (0,0) circle (1);
+  \node at (1,1) {$\frac{1}{2}$};
+\end{tikzpicture}
+`);
+// image.svg, image.width, image.height, image.dataUrl
+```
+
+Use `dataUrl` as an image source. Do not insert untrusted SVG as HTML. Text is
+outlined, so the image does not need web fonts. Full `\documentclass` documents
+are accepted unchanged. Snippets receive a standalone wrapper and the standard
+calc, intersections, angles, quotes, arrows.meta and positioning libraries.
+pgfplots is available through `\usepackage{pgfplots}` in a complete document.
+
+## Limits and cancellation
+
+One page; 12,000 source characters; 30 seconds per execution and queue wait;
+4 MB output; two running processes and eight queued jobs per renderer instance.
+Only bundled TeX packages, no external files. Rendering does not verify the
+mathematics. The default `renderTikz` shares one renderer within a process.
+
+```js
+import { createTikzRenderer } from '@lofcz/tikz';
+const renderer = createTikzRenderer({ concurrency: 1, maxQueue: 4, timeoutMs: 15_000 });
+const image = await renderer.render(source, { signal: AbortSignal.timeout(10_000) });
+```
+
+Each request runs in a fresh child process with an empty environment and WASM
+virtual filesystem. Timeouts/aborts kill that process, including synchronous TeX
+loops; queue capacity is not released until the process closes. The Node heap
+limit is 512 MB, not a total RSS/WASM memory limit. Apply container/OS resource
+limits when serving untrusted workloads. Browser apps use the worker entry below; backend generation uses the Node entry.
+
+## Browser rendering
+
+Compile locally in a dedicated Web Worker:
+
+```js
+import { createTikzRenderer } from '@lofcz/tikz/browser';
+const renderer = createTikzRenderer({ assetBaseUrl: '/tikz/' });
+const image = await renderer.render(source, { signal });
+// On teardown: renderer.dispose();
+```
+
+Copy static assets during your app build and serve them from that same-origin URL:
+
+```js
+import { copyTikzBrowserAssets } from '@lofcz/tikz/deploy';
+await copyTikzBrowserAssets('public/tikz');
+```
+
+The helper expands compressed TeX bundles for ordinary static hosting. WASM and
+TeX files load lazily on the first figure, with normal HTTP caching; there is no
+rendering endpoint or CDN dependency. The worker is reused for successive figures
+and terminated on cancellation, failure, or the 30-second compilation deadline.
+Initial runtime loading has a separate 60-second deadline. Eight jobs may queue.
+Call `dispose()` when the host is destroyed. Use versioned asset URLs on deployment.
+
+With Streamdown, pass `render: source => renderer.render(source)` to
+`createTikzPlugin`. The plugin displays the returned `dataUrl` as an isolated image.
+
+## Bundlers and deployment
+
+Ordinary Node/Bun installs work directly. Keep `@lofcz/tikz` external when
+possible. For a standalone serverless artifact that omits node_modules:
+
+```js
+import { copyTikzAssets } from '@lofcz/tikz/deploy';
+await copyTikzAssets('.vercel/output/functions/render.func');
+```
+
+This copies the complete package into that function's node_modules. The small
+entry module can also be bundled: it resolves `@lofcz/tikz/package.json` from the
+output location, rather than resolving WASM relative to a relocated chunk. Call
+the helper for each function that includes the renderer. File tracers must retain
+the full package including `runtime/`; copying only JavaScript is insufficient.
+
+## Development
+
+```sh
+npm ci
+npm run check
+```
+
+The engine source lives in `packages/engine`, imported from upstream v0.5.0 as a
+Git subtree. Every build compiles this source. Native WASM and TeX data come from
+a checksum-pinned release in our fork; their original build provenance is recorded
+in `upstream.json`. Set `TIKZ_ARCHIVE=/path/to/archive.tar.gz` for offline builds.
+The native binaries are the upstream baseline, not a new native compilation.
+
+The server distribution Brotli-compresses complete bundles and lazily decompresses each bundle
+on its first file request. It retains all ten default bundles, including pgfplots and LuaTeX.
+The engine source still supports ordinary uncompressed assets and browser I/O.
+
+
+Tests render real TikZ/pgfplots, exercise cancellation and limits, and install the
+packed tarball offline before rendering from a relocated function directory.
+
+For engine development and native rebuilds, see [packages/engine](packages/engine).
+Mirror engine changes to the fork with:
+
+```sh
+git subtree push --prefix=packages/engine https://github.com/lofcz/mp-tikz-wasm.git tikz-monorepo
+```
+
+Release through GitHub Actions with npm trusted publishing:
+
+```sh
+gh workflow run release.yml -R lofcz/tikz -f release_type=patch
+```
+
+Licensing and native source links are in [NOTICE.md](NOTICE.md).

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@lofcz/tikz",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Self-contained, process-isolated TikZ to SVG rendering powered by mp-tikz-wasm.",
+  "type": "module",
+  "license": "GPL-3.0-or-later",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./deploy": {
+      "types": "./src/deploy.d.ts",
+      "default": "./src/deploy.js"
+    },
+    "./package.json": "./package.json",
+    "./browser": {
+      "types": "./src/browser.d.ts",
+      "default": "./src/browser.js"
+    }
+  },
+  "files": [
+    "src",
+    "runtime",
+    "LICENSE",
+    "NOTICE.md",
+    "upstream.json"
+  ],
+  "engines": {
+    "node": ">=22.19.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lofcz/tikz.git"
+  },
+  "homepage": "https://github.com/lofcz/tikz#readme",
+  "bugs": {
+    "url": "https://github.com/lofcz/tikz/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "node scripts/prepare-runtime.mjs",
+    "test": "node --test test/*.test.mjs",
+    "test:package": "node scripts/test-package.mjs",
+    "check": "npm run build && npm test && npm run test:package",
+    "prepack": "npm run build",
+    "build:engine": "tsc -p packages/engine/tsconfig.build.json",
+    "test:browser": "node test/browser.mjs"
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.5",
+    "playwright": "^1.64.1",
+    "tar": "^7.5.22",
+    "typescript": "^5.9.3"
+  }
+}

package/runtime/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/runtime/NOTICE.md

@@ -0,0 +1,32 @@
+# Licences (NOTICE)
+
+mp-tikz-wasm is a build of several upstream programs plus its own glue.
+Each part keeps its licence; the table says what applies to what.
+
+| Part | Licence | Notes |
+| --- | --- | --- |
+| `src/`, `scripts/`, `site/`, `test/`, `docs/` (this project's own code and documents) | LGPL-3.0-or-later | so that the whole `mplib.wasm` can be distributed under one licence |
+| MetaPost (`mplib`: `mp.w`, `psout.w`, `svgout.w`, …) | public domain | Taco Hoekwater, Luigi Scarso, John Hobby; TeX Live 2025 |
+| `avl.c` (in `mplib.wasm`) | LGPL-3.0-or-later | hence `mplib.wasm` is LGPL-3.0-or-later; the sources, the patches in `patches/` and a reproducible build (`make wasm`) are in this repository |
+| decNumber (in `mplib.wasm`) | ICU licence | |
+| pdfTeX, kpathsea (`tex.wasm`) | GPL-2.0-or-later / LGPL-2.1-or-later | `tex.wasm` is distributed under the GPL |
+| LuaTeX (`luatex.wasm`) | GPL-2.0-or-later | includes Lua 5.3 (MIT), pplib (Paweł Jackowski, permissive; see `libs/pplib` in the TeX Live source), zziplib (LGPL-2.1-or-later or MPL-1.1), the fontforge-derived font loader (BSD-3-Clause), kpathsea, and our patched mplib; `luatex.wasm` is distributed under the GPL |
+| dvisvgm (`dvisvgm.wasm`) | GPL-3.0-or-later | includes FreeType (FTL), potrace (GPL-2.0-or-later), clipper (Boost), woff2 and brotli (MIT), xxHash (BSD), the URW base-14 CFF fonts as distributed by dvisvgm |
+| BibTeX (`bibtex.wasm`) | BibTeX's own terms (as Knuth's TeX) / LGPL-2.1-or-later (kpathsea) | Oren Patashnik's BibTeX 0.99d with web2c's change file and `lib/` (public domain), from the pinned TeX Live 2025 source, unmodified: `bibtex.web` is "available under the same terms as Donald Knuth's TeX program". Built by `scripts/build-texutils-wasm.sh` |
+| makeindex (`makeindex.wasm`) | **MakeIndex Distribution Notice** (`licenses/COPYING.makeindex`) / LGPL-2.1-or-later (kpathsea) | Pehong Chen, Nelson Beebe and the TeX Live project; makeindex 2.17 from the pinned TeX Live 2025 source (`texk/makeindexk`, see `vendor/SOURCES.lock`), unmodified. The notice allows copying and distribution; whoever ships the binary without its source must include the notice conspicuously and say where the source is: here, `vendor/texlive-source/texk/makeindexk` after `scripts/extract-vendor.sh`, or TeX Live's own source |
+| Computer Modern, AMS and Latin Modern fonts (`bundles/`) | Knuth's licence / AMS / GUST Font License | |
+| EB Garamond and Garamond-Math (`bundles/latex-doc`, opt-in) | **SIL Open Font License 1.1** (`licenses/OFL-1.1.txt`) | EB Garamond: The EB Garamond Project Authors (Georg Duffner, Octavio Pardo), four of its faces; Garamond-Math: Yuansheng Zhao. From TeX Live's `ebgaramond` and `garamond-math`, unmodified |
+| The `latex-doc` bundle's macro packages, BibTeX and makeindex styles (`bundles/latex-doc`, opt-in) | LPPL 1.3c, 1.3 or 1.2, and package-specific free licences | tcolorbox, cleveref, thmtools, natbib, caption, adjustbox, soul, setspace, multirow, fancyhdr, csquotes, float, fvextra, fancyvrb, microtype, titling, babel and its languages, and the rest: LPPL; enumitem and titlesec: MIT; greek-fontenc: LPPL or BSD-2-Clause; babel-hungarian: LPPL or GPL; BibTeX's standard styles: Patashnik's terms in `btxbst.doc` (changed copies must be renamed). From TeX Live 2025, unmodified |
+| Hyphenation patterns (`bundles/latex-doc`, opt-in: `tex/generic/hyph-utf8`) | each file's own free licence, stated in its header | hyph-utf8 (MIT); the patterns: MIT, LPPL, BSD-3-Clause (Portuguese), the Unlicense (Galician), public domain (Finnish), GPL (Czech, Slovak), and several with a choice of MIT, LPPL, LGPL, MPL or GPL. The Romanian patterns (Adrian Rezus, 1995–96) state a copyright but no licence; TeX Live distributes them, and so do we |
+| URW Classico fonts (`bundles/classico`, opt-in) | **Aladdin Free Public License** (`licenses/COPYING.AFPL`) | (URW)++ Design & Development, 2000 and 2013; the LaTeX support (`classico.sty`, `.fd`, metrics) by Michael Sharpe, from CTAN's `classico`. The AFPL allows modification and **non-commercial** distribution only, which is why TeX Live does not include it: anyone redistributing this project's bundles in a commercial product must leave the `classico` bundle out. Not part of TeX Live; built from a local install. |
+| LaTeX, PGF/TikZ, pgfplots and the other macro packages (`bundles/`) | LPPL 1.3c and package-specific free licences | see each package's header in TeX Live |
+| Ghostscript (`dist/ghostscript/`: `gs.mjs`, `gs.wasm`; opt-in, released as an archive of its own) | **GNU AGPL v3** (`dist/ghostscript/COPYING`; `LICENSE` says which parts it covers) | Artifex Software. Ghostscript 10.08.0 built to WebAssembly by the Ghostscript port (pinned in `vendor/GHOSTSCRIPT.lock`): the upstream source unmodified apart from a new `svg` device and a dependency fix in `pdf/pdf.mak`, in its lean variant. It is a separate module, never linked into the engines here: dvisvgm reaches it through `src/c/gs-bridge.c` and `src/ts/ghostscript.ts` when a document carries PostScript. Anyone serving or shipping it must offer its corresponding source: each release carries it as `mp-tikz-wasm-ghostscript-<version>-source.tar.gz` (the port's tree at the commit pinned in `vendor/GHOSTSCRIPT.lock`), and `dist/ghostscript/SOURCE.md` says so. Its fonts carry the AGPL with Artifex's font exception. |
+| dvips's PostScript headers and the PSTricks family (`bundles/ghostscript`, opt-in) | GPL (dvips's `.pro` headers) / LPPL 1.3c (PSTricks, `pst-*`, `multido`) | from TeX Live; the `.pro` files are what dvips itself prepends to PostScript |
+
+The full texts are in the repository: `LICENSE` (LGPL-3.0, this project's own
+licence) and `licenses/GPL-3.0.txt` / `licenses/LGPL-3.0.txt`, copied from
+<https://www.gnu.org/licenses/>; `licenses/COPYING.AFPL` is the Aladdin Free Public
+License of the URW Classico fonts, as distributed with CTAN's `classico`;
+`licenses/COPYING.makeindex` is makeindex's distribution notice, as in TeX Live's
+source; `licenses/OFL-1.1.txt` is the SIL Open Font License of EB Garamond and
+Garamond-Math, as distributed with TeX Live's `ebgaramond`.

package/runtime/dist/auto.d.ts

@@ -0,0 +1,68 @@
+import type { MetaPostOptions, LogLevel } from './types.js';
+import { figureHash, figureName, wrapTikz, wrapMetaPost } from './figures.js';
+import type { FigureRequest, FigureResult, SavedFigure } from './figures.js';
+export { wrapTikz, wrapMetaPost, figureHash, figureName };
+export type { FigureRequest as RenderRequest, SavedFigure };
+/** Where the SVG came from: the IndexedDB result cache, a saved figure file, or the engines. */
+export type RenderSource = 'cache' | 'file' | 'engine';
+/** ms is the engine's own time for this diagram (queueing and engine start-up excluded). */
+export interface RenderOutput extends FigureResult {
+    cached: boolean;
+    from: RenderSource;
+    hash: string;
+    name: string;
+}
+export interface AutoOptions extends MetaPostOptions {
+    /** false: neither read nor write the IndexedDB result cache (data-cache="off" on the loader). */
+    cacheResults?: boolean;
+    /** Base URL of the saved figures (`figure-HASH.svg`), looked up before the engines start (data-figures on the loader). */
+    figuresBaseUrl?: string;
+}
+export declare class AutoRenderer {
+    private options;
+    private engine;
+    private readonly log;
+    private readonly rendered;
+    private readonly inFlight;
+    /** Files handed over before the engine existed; applied when it starts (see addFiles). */
+    private readonly pendingFiles;
+    constructor(options?: AutoOptions);
+    /** Has an engine been started? A page whose figures all came from the cache or the saved files never starts one. */
+    get started(): boolean;
+    /**
+     * Put files where this page's TeX runs will find them: a font the host wants to
+     * typeset in (`\setmainfont{X.ttf}[Path=./]` — the run's working directory leads
+     * OPENTYPEFONTS and TTFONTS), an image, a .sty. They stay for the life of the page.
+     *
+     * Deliberately does NOT start the engine: files handed over before the first
+     * render are held and applied when one is created, so a page whose figures all
+     * come from the cache or from saved files still starts nothing. Call it before
+     * the figures that need the font, and with the `opentype` bundle loaded
+     * (`data-bundles="+opentype"`) if the font is for fontspec.
+     */
+    addFiles(files: Record<string, string | Uint8Array>): Promise<void>;
+    private get mp();
+    /** How much reaches the console (see `MetaPostOptions.logLevel`), for the engine now and later. */
+    setLogLevel(level: LogLevel): void;
+    render(req: FigureRequest): Promise<RenderOutput>;
+    private renderFrom;
+    private done;
+    /** Drop a figure from figures() (and so from saveFigures()): a live element has replaced it. */
+    forget(nameOrHash: string): void;
+    /** Resolves when no render is in flight. */
+    idle(): Promise<void>;
+    /** Every figure that has rendered successfully so far (from any source), in the order it finished. */
+    figures(): SavedFigure[];
+    /**
+     * Write every figure on the page as figure-HASH.svg: into a folder chosen with the
+     * directory picker where the browser has one (Chrome, Edge), otherwise as a zip
+     * download. Waits for figures still rendering. Returns the file names written.
+     */
+    saveFigures(opts?: {
+        zip?: boolean;
+        name?: string;
+    }): Promise<string[]>;
+}
+export declare function renderElement(el: Element): Promise<void>;
+/** Render every diagram element currently in the document (and later ones, unless observe is off). */
+export declare function autoRender(root?: ParentNode): void;