@quillmark/wasm 0.68.0 → 0.69.0

package/node-esm/wasm.d.ts

@@ -1,577 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-
-/**
- * Input shape for `Document.pushCard` and `Document.insertCard`.
- *
- * Only `tag` is required. `fields` defaults to `{}`, `body` to `""`.
- */
-export interface CardInput {
-    tag: string;
-    fields?: Record<string, unknown>;
-    body?: string;
-}
-
-
-
-/**
- * Page dimensions in Typst points (1 pt = 1/72 inch).
- *
- * Report-only: the painter sizes the canvas itself based on
- * `PaintOptions`. `pageSize` is exposed for callers that need page
- * geometry up-front (e.g. to lay out a scrollable list of canvases
- * before any pixels are rendered).
- */
-export interface PageSize {
-    widthPt: number;
-    heightPt: number;
-}
-
-/**
- * Inputs to `RenderSession.paint`. Both fields are optional and default
- * to `1`.
- *
- * - `layoutScale` — layout-space pixels per Typst point. For on-screen
- *   canvases this is CSS pixels per pt; the page's layout-pixel size is
- *   `widthPt * layoutScale × heightPt * layoutScale`. The painter
- *   surfaces these dimensions as `layoutWidth` / `layoutHeight` so
- *   consumers can drive `canvas.style.*` (or any layout system).
- * - `densityScale` — backing-store density multiplier. Fold
- *   `window.devicePixelRatio`, in-app zoom, and `visualViewport.scale`
- *   (pinch-zoom) into a single value here. Defaults to `1`, which
- *   produces a non-retina backing store — pass `window.devicePixelRatio`
- *   for crisp output on high-DPI displays.
- *
- * The effective rasterization scale is `layoutScale * densityScale`.
- * Both must be finite and `> 0`. For `OffscreenCanvasRenderingContext2D`
- * the two collapse to a single scalar; folding everything into
- * `densityScale` is the simplest convention.
- */
-export interface PaintOptions {
-    layoutScale?: number;
-    densityScale?: number;
-}
-
-/**
- * Returned by `RenderSession.paint`.
- *
- * - `layoutWidth` / `layoutHeight` — layout-pixel dimensions of the
- *   canvas's display box. For on-screen canvases this is CSS pixels:
- *   set `canvas.style.width = layoutWidth + "px"` and
- *   `canvas.style.height = layoutHeight + "px"` (or feed these into
- *   your layout system). Independent of `densityScale`.
- * - `pixelWidth` / `pixelHeight` — integer backing-store pixel
- *   dimensions the painter wrote to `canvas.width` / `canvas.height`.
- *   Equal to `round(layoutWidth * densityScale)` ×
- *   `round(layoutHeight * densityScale)` *unless* the requested backing
- *   exceeded the painter's safe maximum (16384 px per side), in which
- *   case `densityScale` was clamped to fit. Detect clamping via
- *   `pixelWidth < round(layoutWidth * densityScale)`.
- *
- * The painter owns `canvas.width` / `canvas.height`; consumers must not
- * write to them. The painter does **not** touch `canvas.style.*`;
- * consumers own layout.
- *
- * For `OffscreenCanvasRenderingContext2D` (Worker rasterization, no
- * DOM), `layoutWidth` / `layoutHeight` are informational — there's no
- * CSS layout box to apply them to.
- */
-export interface PaintResult {
-    layoutWidth: number;
-    layoutHeight: number;
-    pixelWidth: number;
-    pixelHeight: number;
-}
-
-
-export interface Artifact {
-    format: OutputFormat;
-    bytes: Uint8Array;
-    mimeType: string;
-}
-
-export interface Card {
-    sentinel: string;
-    tag: string;
-    frontmatter: Record<string, unknown>;
-    frontmatterItems: FrontmatterItem[];
-    body: string;
-}
-
-export interface Diagnostic {
-    severity: Severity;
-    code?: string;
-    message: string;
-    location?: Location;
-    hint?: string;
-    sourceChain: string[];
-}
-
-export interface Location {
-    file: string;
-    line: number;
-    column: number;
-}
-
-export interface RenderOptions {
-    format?: OutputFormat;
-    ppi?: number;
-    pages?: number[];
-}
-
-export interface RenderResult {
-    artifacts: Artifact[];
-    warnings: Diagnostic[];
-    outputFormat: OutputFormat;
-    renderTimeMs: number;
-}
-
-export type FrontmatterItem = { kind: "field"; key: string; value: unknown; fill?: boolean } | { kind: "comment"; text: string };
-
-export type OutputFormat = "pdf" | "svg" | "txt" | "png";
-
-export type Severity = "error" | "warning" | "note";
-
-
-/**
- * Typed in-memory Quillmark document.
- *
- * Created via `Document.fromMarkdown(markdown)`. Exposes:
- * - `quillRef` (string)
- * - `frontmatter` (JS object/Record)
- * - `body` (string)
- * - `cards` (array of Card objects)
- * - `warnings` (array of Diagnostic objects)
- *
- * `toMarkdown()` emits canonical Quillmark Markdown that round-trips back to
- * an equal `Document` by value and by type.
- */
-export class Document {
-    private constructor();
-    free(): void;
-    [Symbol.dispose](): void;
-    /**
-     * Return a fresh `Document` handle with the same parse state.
-     *
-     * Mutations on the returned handle do not affect the original and
-     * vice versa. Parse-time warnings are snapshotted alongside the
-     * document — they describe the original parse, not the edit
-     * history of either handle.
-     */
-    clone(): Document;
-    /**
-     * Structural equality against another `Document`.
-     *
-     * Compares `main` and `cards` by value (matching core's [`PartialEq`]).
-     * Parse-time `warnings` are intentionally excluded — they describe the
-     * source text, not the document's content.
-     *
-     * Use this to debounce upstream prop updates: keep the last parsed
-     * `Document` and compare instead of re-parsing on every keystroke.
-     */
-    equals(other: Document): boolean;
-    /**
-     * Parse markdown into a typed Document.
-     *
-     * Returns the document with any parse-time warnings accessible via `.warnings`.
-     * Throws on parse errors.
-     */
-    static fromMarkdown(markdown: string): Document;
-    /**
-     * Insert a card at the given index.
-     *
-     * `index` must be in `0..=cards.length`. Out-of-range throws an `Error`.
-     *
-     * Mutators never modify `warnings`.
-     */
-    insertCard(index: number, card: CardInput): void;
-    /**
-     * Move the card at `from` to position `to`.
-     *
-     * `from == to` is a no-op. Both indices must be in `0..cards.length`.
-     * Out-of-range throws an `Error`.
-     *
-     * Mutators never modify `warnings`.
-     */
-    moveCard(from: number, to: number): void;
-    /**
-     * Append a card to the end of the card list.
-     *
-     * `card` must be a JS object with a `tag` string field and optional
-     * `fields` (object) and `body` (string).
-     *
-     * Throws an `Error` if `card.tag` is not a valid tag name.
-     *
-     * Mutators never modify `warnings`.
-     */
-    pushCard(card: CardInput): void;
-    /**
-     * Remove the card at `index` and return it, or `undefined` if out of range.
-     *
-     * Mutators never modify `warnings`.
-     */
-    removeCard(index: number): Card | undefined;
-    /**
-     * Remove a frontmatter field on the card at `index`, returning the
-     * removed value or `undefined` if the field was absent.
-     *
-     * Throws if `index` is out of range, `name` is reserved, or `name` does
-     * not match `[a-z_][a-z0-9_]*`.
-     *
-     * Mutators never modify `warnings`.
-     */
-    removeCardField(index: number, name: string): any;
-    /**
-     * Remove a frontmatter field on the main card, returning the removed value or `undefined`.
-     *
-     * Throws an `Error` whose message includes the `EditError` variant name
-     * and details if `name` is reserved (`BODY`, `CARDS`, `QUILL`, `CARD`)
-     * or does not match `[a-z_][a-z0-9_]*`. Absence of an otherwise-valid
-     * name returns `undefined`.
-     *
-     * Mutators never modify `warnings`.
-     */
-    removeField(name: string): any;
-    /**
-     * Replace the main card's body (the global Markdown body).
-     *
-     * Mutators never modify `warnings`.
-     */
-    replaceBody(body: string): void;
-    /**
-     * Replace the tag of the composable card at `index`.
-     *
-     * Mutates only the sentinel — the card's frontmatter and body are
-     * untouched. Schema-aware migration (clearing orphan fields, applying
-     * new defaults) is the caller's responsibility; `setCardTag` is a
-     * structural primitive.
-     *
-     * Throws if `index` is out of range or if `newTag` does not match
-     * `[a-z_][a-z0-9_]*`.
-     *
-     * Mutators never modify `warnings`.
-     */
-    setCardTag(index: number, new_tag: string): void;
-    /**
-     * Update a frontmatter field on the main card.
-     *
-     * Convenience method: equivalent to `doc.mainMut().setField(name, value)`.
-     * Clears any existing `!fill` marker on the field.
-     *
-     * Throws an `Error` whose message includes the `EditError` variant name and
-     * details if `name` is reserved (`BODY`, `CARDS`, `QUILL`, `CARD`) or does
-     * not match `[a-z_][a-z0-9_]*`.
-     *
-     * Mutators never modify `warnings`.
-     */
-    setField(name: string, value: any): void;
-    /**
-     * Update a frontmatter field on the main card AND mark it as `!fill`.
-     *
-     * Convenience method: equivalent to `doc.mainMut().setFill(name, value)`.
-     *
-     * Throws on invalid name (see [`setField`](Document::set_field)).
-     *
-     * Mutators never modify `warnings`.
-     */
-    setFill(name: string, value: any): void;
-    /**
-     * Replace the QUILL reference string.
-     *
-     * Throws if `ref_str` is not a valid `QuillReference`.
-     *
-     * Mutators never modify `warnings`.
-     */
-    setQuillRef(ref_str: string): void;
-    /**
-     * Emit canonical Quillmark Markdown.
-     *
-     * Returns the document serialised as a Quillmark Markdown string.
-     * The output is type-fidelity round-trip safe: re-parsing the result
-     * produces a `Document` equal to `self` by value and by type.
-     */
-    toMarkdown(): string;
-    /**
-     * Replace the body of the card at `index`.
-     *
-     * Throws if `index` is out of range.
-     *
-     * Mutators never modify `warnings`.
-     */
-    updateCardBody(index: number, body: string): void;
-    /**
-     * Update a field on the card at `index`.
-     *
-     * Convenience method: equivalent to `doc.card_mut(index)?.set_field(name, value)`.
-     *
-     * Throws if `index` is out of range, `name` is reserved or invalid, or
-     * `value` cannot be serialized.
-     *
-     * Mutators never modify `warnings`.
-     */
-    updateCardField(index: number, name: string, value: any): void;
-    /**
-     * Number of composable cards (excludes the main card).
-     *
-     * O(1). Use this to validate indices before calling card mutators
-     * instead of allocating the full `cards` array.
-     */
-    readonly cardCount: number;
-    /**
-     * Ordered list of composable card blocks as typed `Card` objects.
-     */
-    readonly cards: Card[];
-    /**
-     * The document's main (entry) card.
-     *
-     * Carries the QUILL sentinel, the document-level frontmatter, and the
-     * global body. Frontmatter/body reads and mutations go through this
-     * handle — there are no document-level shortcuts after the rework.
-     *
-     * Allocates and serializes on each call — cache locally if read in a hot loop.
-     */
-    readonly main: Card;
-    /**
-     * The QUILL reference string (e.g. `"usaf_memo@0.1"`).
-     */
-    readonly quillRef: string;
-    /**
-     * Non-fatal parse-time warnings as an array of typed `Diagnostic` objects.
-     */
-    readonly warnings: Diagnostic[];
-}
-
-/**
- * Opaque, shareable Quill handle.
- */
-export class Quill {
-    private constructor();
-    free(): void;
-    [Symbol.dispose](): void;
-    /**
-     * A blank form for a card of the given type — no document values supplied.
-     *
-     * Returns `null` if `cardType` is not declared in this quill's schema.
-     * Otherwise returns a plain JS object shaped like a single entry in
-     * [`Form::cards`].
-     *
-     * [`Form::cards`]: quillmark::form::Form::cards
-     */
-    blankCard(card_type: string): any;
-    /**
-     * A blank form for the main card — no document values supplied.
-     *
-     * Returns a plain JS object with the same shape as one entry in
-     * [`Form::main`]. Every declared field's `source` is `"default"` (when
-     * the schema declares a default) or `"missing"`.
-     *
-     * [`Form::main`]: quillmark::form::Form::main
-     */
-    blankMain(): any;
-    /**
-     * The schema-aware form view of `doc`.
-     *
-     * Returns a plain JS object (not a class) that is immediately
-     * `JSON.stringify`-able. The shape mirrors [`Form`]:
-     *
-     * ```json
-     * {
-     *   "main":  { "schema": {...}, "values": { "field": {...} } },
-     *   "cards": [ ... ],
-     *   "diagnostics": [ ... ]
-     * }
-     * ```
-     *
-     * **Snapshot semantics.** This is a read-only snapshot of the document
-     * at call time. Subsequent edits to `doc` require calling `form` again.
-     *
-     * [`Form`]: quillmark::form::Form
-     */
-    form(doc: Document): any;
-    /**
-     * Open an iterative render session for page-selective rendering.
-     */
-    open(doc: Document): RenderSession;
-    /**
-     * Render a document to final artifacts.
-     */
-    render(doc: Document, opts?: RenderOptions | null): RenderResult;
-    /**
-     * The resolved backend identifier (e.g. `"typst"`).
-     */
-    readonly backendId: string;
-    /**
-     * Read-only snapshot of the loaded quill's engine info and declared schema.
-     *
-     * Returns a plain JS object with:
-     * - `schema` — the quill's public schema contract, identical to
-     *   `QuillConfig::public_schema()`. Top-level keys: `name`, `main`,
-     *   optional `card_types` (map keyed by card name, omitted when empty),
-     *   optional `example`. `main` and each card under `card_types` share
-     *   the same shape: `fields` (map keyed by field name), optional
-     *   `title`, `description`, `ui`.
-     * - `backend`, `version`, `author`, `description` — quill identity
-     *   declared in `Quill.yaml`'s `quill:` section. `description` describes
-     *   the quill itself; if the author also declared `main.description` (the
-     *   schema description of the entry-point card), it lives at
-     *   `schema.main.description` and is independent.
-     * - `supportedFormats` — output formats the backend produces, as
-     *   lowercase strings.
-     * - Any additional unstructured keys declared under `quill:`.
-     *
-     * Consumers that need validation run their own validator against
-     * `metadata.schema`.
-     *
-     * Equivalent by value for the lifetime of the handle; the quill is
-     * immutable once constructed.
-     */
-    readonly metadata: any;
-    /**
-     * Whether this quill's backend supports canvas preview.
-     *
-     * `true` iff `RenderSession.paint` and `RenderSession.pageSize` will
-     * succeed for sessions opened by this quill. Use this as a precondition
-     * probe before mounting a canvas-based preview UI; the throw on `paint`
-     * remains the enforcement contract.
-     */
-    readonly supportsCanvas: boolean;
-}
-
-/**
- * Quillmark WASM Engine
- */
-export class Quillmark {
-    free(): void;
-    [Symbol.dispose](): void;
-    /**
-     * JavaScript constructor: `new Quillmark()`
-     */
-    constructor();
-    /**
-     * Load a quill from a file tree and attach the appropriate backend.
-     *
-     * Accepts either a `Map<string, Uint8Array>` or a plain object
-     * (`Record<string, Uint8Array>`). Plain objects are walked via
-     * `Object.entries` at the boundary; the Rust side sees a single
-     * canonical shape.
-     */
-    quill(tree: Map<string, Uint8Array>): Quill;
-}
-
-/**
- * An iterative render handle backed by an immutable compiled snapshot.
- *
- * Created via [`Quill::open`]. Holds the compiled output so that
- * [`RenderSession::render`], [`RenderSession::paint`], and
- * [`RenderSession::page_size`] can be called repeatedly without
- * recompiling.
- *
- * **Empty documents.** A document that compiles to zero pages still
- * produces a valid session (`pageCount === 0`). Iterating
- * `0..pageCount` is then a no-op; calling `paint(ctx, 0)` or
- * `pageSize(0)` throws `"... page index 0 out of range
- * (pageCount=0)"`. Hosts that surface "no pages to preview" UI should
- * branch on `pageCount === 0` rather than on a thrown error.
- */
-export class RenderSession {
-    private constructor();
-    free(): void;
-    [Symbol.dispose](): void;
-    /**
-     * Page dimensions in Typst points (1 pt = 1/72 inch).
-     *
-     * Report-only: the painter sizes the canvas itself based on
-     * `PaintOptions`. Exposed for consumers that need page geometry
-     * up-front (e.g. to lay out a scrollable list of canvases before
-     * any pixels are rendered).
-     *
-     * Stable for a given `page` across the session's lifetime — the
-     * compiled document is an immutable snapshot, so callers can cache
-     * results.
-     *
-     * Throws if the underlying backend has no canvas painter (i.e. is not
-     * the Typst backend) or if `page` is out of range.
-     */
-    pageSize(page: number): PageSize;
-    /**
-     * Paint `page` into a 2D canvas context.
-     *
-     * Accepts either a `CanvasRenderingContext2D` (main thread) or an
-     * `OffscreenCanvasRenderingContext2D` (Worker / off-DOM rasterization).
-     * Both dispatch to the same Rust rasterizer; the dispatch happens at
-     * the JS boundary so neither context type is privileged.
-     *
-     * The painter owns `canvas.width` / `canvas.height` and writes them
-     * itself; consumers must not. The painter does not touch
-     * `canvas.style.*` — that's layout, owned by the consumer (see
-     * `PaintResult.layoutWidth` / `layoutHeight`).
-     *
-     * `opts.layoutScale` (default 1.0) is layout-space pixels per Typst
-     * point and determines the canvas's display-box size. `opts.densityScale`
-     * (default 1.0) is the rasterization density multiplier the consumer
-     * folds `window.devicePixelRatio`, in-app zoom, and
-     * `visualViewport.scale` (pinch-zoom) into. The effective
-     * rasterization scale is `layoutScale * densityScale`.
-     *
-     * If `layoutScale * densityScale` would exceed the safe backing-store
-     * maximum (16384 px per side), `densityScale` is clamped
-     * proportionally so the largest dimension fits. The actual
-     * backing-store dimensions are reported in the returned
-     * `PaintResult` — compare against
-     * `round(layoutWidth * densityScale)` to detect clamping.
-     *
-     * Each call resets the backing store (`paint` is always a full
-     * repaint). Consumers do not need to call `clearRect`.
-     *
-     * Throws when:
-     * - the backend does not support canvas preview (message includes the
-     *   resolved `backendId`),
-     * - `page` is out of range,
-     * - `ctx` is neither `CanvasRenderingContext2D` nor
-     *   `OffscreenCanvasRenderingContext2D`,
-     * - `opts.layoutScale` or `opts.densityScale` is non-finite or `<= 0`.
-     */
-    paint(ctx: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D, page: number, opts: PaintOptions | undefined): PaintResult;
-    /**
-     * Render all or selected pages from this session.
-     */
-    render(opts?: RenderOptions | null): RenderResult;
-    /**
-     * The backend that produced this session (e.g. `"typst"`).
-     *
-     * Equal to the `backendId` of the [`Quill`] that opened this session
-     * (sessions inherit their quill's backend), so checking either is fine.
-     */
-    readonly backendId: string;
-    /**
-     * Number of pages in this render session.
-     *
-     * Stable for the lifetime of the session — the underlying compiled
-     * document is an immutable snapshot.
-     */
-    readonly pageCount: number;
-    /**
-     * Whether this session's backend supports canvas preview.
-     *
-     * `true` iff [`paint`](Self::paint) and [`page_size`](Self::page_size)
-     * will succeed. Equal to `Quill.supportsCanvas` for the quill that
-     * opened this session.
-     */
-    readonly supportsCanvas: boolean;
-    /**
-     * Session-level warnings attached at `quill.open(...)` time.
-     *
-     * Snapshot of any non-fatal diagnostics emitted while opening the
-     * session (e.g. version compatibility shims). Stable across the
-     * session's lifetime. These are also appended to
-     * [`RenderResult.warnings`] on every `render()` call; the accessor
-     * surfaces them to canvas-preview consumers that don't go through
-     * `render()`.
-     */
-    readonly warnings: Diagnostic[];
-}
-
-/**
- * Initialize the WASM module with panic hooks for better error messages
- */
-export function init(): void;