@quillmark/wasm 0.58.0 → 0.58.2-rc.4

package/node-esm/wasm.d.ts

@@ -6,6 +6,12 @@ export interface Artifact {
     mimeType: string;
 }
 
+export interface Card {
+    tag: string;
+    fields: Record<string, unknown>;
+    body: string;
+}
+
 export interface Diagnostic {
     severity: Severity;
     code?: string;
@@ -21,14 +27,8 @@ export interface Location {
     column: number;
 }
 
-export interface ParsedDocument {
-    fields: Record<string, any>;
-    quillRef: string;
-}
-
 export interface RenderOptions {
     format?: OutputFormat;
-    assets?: Record<string, Uint8Array | number[]>;
     ppi?: number;
     pages?: number[];
 }
@@ -45,6 +45,148 @@ 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;
+    /**
+     * 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: any): 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: any): void;
+    /**
+     * Remove the card at `index` and return it, or `undefined` if out of range.
+     *
+     * Mutators never modify `warnings`.
+     */
+    removeCard(index: number): any;
+    /**
+     * Remove a frontmatter field, returning the removed value or `undefined`.
+     *
+     * Mutators never modify `warnings`.
+     */
+    removeField(name: string): any;
+    /**
+     * Replace the global Markdown body.
+     *
+     * Mutators never modify `warnings`.
+     */
+    replaceBody(body: string): void;
+    /**
+     * Set a frontmatter 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;
+    /**
+     * 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;
+    /**
+     * Global Markdown body between frontmatter and the first card.
+     *
+     * Trailing newlines are stripped — those are structural separators in
+     * the Markdown wire format, not content the consumer wrote.
+     *
+     * Empty string when no body is present.
+     */
+    readonly body: string;
+    /**
+     * Ordered list of card blocks as JS objects with `tag`, `fields`, and `body`.
+     */
+    readonly cards: any;
+    /**
+     * Typed YAML frontmatter fields as a JS object (no QUILL, BODY, or CARDS keys).
+     */
+    readonly frontmatter: any;
+    /**
+     * The QUILL reference string (e.g. `"usaf_memo@0.1"`).
+     */
+    readonly quillRef: string;
+    /**
+     * Non-fatal parse-time warnings as a JS array of Diagnostic objects.
+     */
+    readonly warnings: any;
+}
+
 /**
  * Opaque, shareable Quill handle.
  */
@@ -55,11 +197,36 @@ export class Quill {
     /**
      * Open an iterative render session for page-selective rendering.
      */
-    open(parsed: ParsedDocument): RenderSession;
+    open(doc: Document): RenderSession;
+    /**
+     * Project a document through this quill's schema.
+     *
+     * Returns a plain JS object (not a class) that is immediately
+     * `JSON.stringify`-able. The shape mirrors [`FormProjection`]:
+     *
+     * ```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 `projectForm`
+     * again.
+     *
+     * [`FormProjection`]: quillmark::form::FormProjection
+     */
+    projectForm(doc: Document): any;
     /**
      * Render a document to final artifacts.
      */
-    render(parsed: ParsedDocument, opts: RenderOptions): RenderResult;
+    render(doc: Document, opts?: RenderOptions | null): RenderResult;
+    /**
+     * The resolved backend identifier (e.g. `"typst"`).
+     */
+    readonly backendId: string;
 }
 
 /**
@@ -87,7 +254,7 @@ export class RenderSession {
     /**
      * Render all or selected pages from this session.
      */
-    render(opts: RenderOptions): RenderResult;
+    render(opts?: RenderOptions | null): RenderResult;
     /**
      * Number of pages in this render session.
      */