@quillmark/wasm 0.124.0 → 0.126.0

package/core/wasm.d.ts

@@ -146,7 +146,8 @@ export interface TableCell {
 
 /** `props` of a `type: "table"` island: a pipe table normalized to one column
  * count that `header`, every row of `rows`, `aligns` and `widths` all share.
- * A layout key at its default is absent. */
+ * A layout key at its default is absent; one holding a value outside its type
+ * stays as written and reads as absent. */
 export interface TableProps {
     header: TableCell[];
     rows: TableCell[][];
@@ -154,7 +155,7 @@ export interface TableProps {
     aligns: ("none" | "left" | "center" | "right")[];
     /** Per-column relative weights; `null` is an auto-fit column. Absent when
      * every column is auto-fit. A weight is an integer from 1 to
-     * `Number.MAX_SAFE_INTEGER`; any other entry drops the key. */
+     * `Number.MAX_SAFE_INTEGER`. */
     widths?: (number | null)[];
     /** The table's placement; absent is the quill's. */
     align?: "left" | "center" | "right";
@@ -237,14 +238,14 @@ export interface Revised {
 
 /**
  * The receipt of `writer.reviseDocument`. `droppedAnchors` names every prose
- * anchor the write did not carry, at its path in the stored document; a table
+ * anchor the write did not carry, at its path and line in the stored document; a table
  * cell's anchors drop unnamed. `warnings` are the parse's, then each revised
  * content field's `parse::dropped_construct`, then the writer's `conform::*`.
  * A field that lands rather than revises, on an inserted card or over no stored
  * content, reports no drop.
  */
 export interface DocumentRevised {
-    droppedAnchors: { path: string; id: string }[];
+    droppedAnchors: DocumentAnchor[];
     warnings: Diagnostic[];
 }
 
@@ -258,7 +259,13 @@ export interface DocumentRevised {
  */
 export interface AnnotatedMarkdown {
     markdown: string;
-    anchors: { id: string; path: string; line: string }[];
+    anchors: DocumentAnchor[];
+}
+
+export interface DocumentAnchor {
+    id: string;
+    path: string;
+    line: string;
 }
 
 /**
@@ -439,9 +446,10 @@ export interface Resolved {
 /** UI layout hints for a single field. Display order is not a hint: key order
  * in the schema's `fields`/`properties` objects is the ordering contract. */
 export interface QuillFieldUi {
+    /** The id of the card group holding the field, a key of the card's
+     *  `ui.groups`. */
     group?: string;
     compact?: boolean;
-    multiline?: boolean;
     /** Label for an `enum`'s blank option. Absent, the consumer supplies a
      *  conventional label of its own. */
     blank_title?: string;
@@ -455,18 +463,18 @@ export interface QuillFieldUi {
     layout?: "table" | "flat";
 }
 
-/** One entry in a card's `ui.groups` registry: a display-label override for the
- * group id (the map key). An empty object carries no override, and the consumer
- * derives the label from the id (`memo_for` → "Memo For"). */
+/** One group in a card's `ui.groups`: a display-label override for the
+ * group id (the map key). An empty object carries no override, and the
+ * consumer derives the label from the id (`memo_for` → "Memo For"). */
 export interface QuillGroupUi {
     title?: string;
 }
 
 /** UI layout hints for a card (main or named card kind). */
 export interface QuillCardUi {
-    /** The groups a field's `ui.group` may reference, keyed by group id. Key
-     * order is the display-order contract, as with `fields`. Absent when the
-     * card declares no groups. */
+    /** The card's groups keyed by id, each holding at least one field, which
+     * names it in its `ui.group`. Key order is the display-order contract, as
+     * with `fields`. Absent when the card declares no groups. */
     groups?: Record<string, QuillGroupUi>;
 }
 
@@ -476,7 +484,7 @@ export interface QuillCardBody {
     enabled?: boolean;
 }
 
-export type QuillFieldType = "string" | "number" | "integer" | "boolean" | "array" | "object" | "date" | "datetime" | "richtext" | "plaintext" | "enum" | "matrix";
+export type QuillFieldType = "number" | "integer" | "boolean" | "array" | "object" | "date" | "datetime" | "text" | "richtext" | "enum" | "matrix";
 
 /** Schema entry for a single field declared in a quill's `Quill.yaml`.
  *
@@ -521,9 +529,12 @@ export interface QuillFieldSchema {
      *  out on. Valid only on an `array`. Never gates render: a document over
      *  the cap warns `validation::cardinality` and renders. */
     max?: number;
-    /** `true` on a `richtext` or `plaintext` field declared `inline`: the
-     *  single-paragraph, container-free, island-free constraint. */
-    inline?: boolean;
+    /** The line shape of a `text` or `richtext` field, valid nowhere else.
+     *  Absent or `false`, the field is one line (`text`) or one paragraph with
+     *  no container or island (`richtext`); `true` admits line breaks
+     *  (`text`) or block structure (`richtext`). A `richtext` always carries
+     *  it. */
+    multiline?: boolean;
 }
 
 /** Schema entry for the main card or a named card kind. */
@@ -563,6 +574,10 @@ export interface QuillMetadata {
     backend: string;
     author: string;
     description: string;
+    /** An SPDX license expression; absent when the quill declares none. */
+    license?: string;
+    /** An absolute `http(s)` URL; absent when the quill declares none. */
+    homepage?: string;
 }
 
 
@@ -677,7 +692,7 @@ export class Document {
      * `edit::index_out_of_range`.
      *
      * A content field at rest has one stored form per codec: a `richtext` field
-     * holds the canonical content object, a `plaintext` field its literal
+     * holds the canonical content object, a `text` field its literal
      * string. A document from the bound door (`quill.parse` / `quill.conform`)
      * is at rest; one from the transport door may rest as authored until it is
      * conformed, and this read reports what is there. For the `Content` either
@@ -690,8 +705,9 @@ export class Document {
     /**
      * Insert a card: `at` absent appends, a number inserts at that index (in
      * `0..=cards.length`). Accepts any `CardInput`, including a card read back
-     * out of a document. Throws if `card.kind` is not a valid kind name, or if
-     * `at` is out of range.
+     * out of a document. Throws if `card.kind` is not a valid kind name, if
+     * `at` is out of range, or `edit::too_many_cards` if the document holds
+     * 1,000 cards.
      */
     insertCard(card: CardInput, at?: number): void;
     /**
@@ -904,7 +920,7 @@ export class Quill {
      * The quill's example document, `undefined` when the quill has no
      * `example.md` at its root: a filled-in page whose values are made up to show the
      * quill in use, never kept. It comes back pinned to this quill's
-     * `name@version` and conformed as `parse` conforms, its parse and
+     * `name@MAJOR.MINOR` and conformed as `parse` conforms, its parse and
      * `conform::*` warnings on `doc.warnings`. Throws when the file does not
      * parse or its `$quill` is not this quill's bare name.
      */
@@ -919,7 +935,7 @@ export class Quill {
      * Parse `markdown` and conform it against this quill: the primary ingestion
      * path, and the bound twin of the schema-free `Document.fromMarkdown`. The
      * returned document rests at its canonical form (a `richtext` field as a
-     * content object, a `plaintext` field as its literal string), so `getStored`
+     * content object, a `text` field as its literal string), so `getStored`
      * answers by the field's declared codec, not by how the document was built.
      *
      * Parse warnings and the `conform::*` diagnostics both land on
@@ -963,8 +979,9 @@ export class Quill {
     toTree(): Map<string, Uint8Array>;
     /**
      * Validate `doc` against this quill's schema, returning every diagnostic:
-     * an error blocks a render, a warning does not. Forwards the canonical
-     * `validation::*` diagnostics the engine emits.
+     * an error blocks a render, a warning does not. Forwards the engine's
+     * `validation::*`, a markdown string's `parse::dropped_construct` and the
+     * backend's `backend::declined_construct`.
      */
     validate(doc: Document): Diagnostic[];
     /**
@@ -1029,15 +1046,15 @@ export function formatDocPath(segs: DocPathSeg[]): string;
 export function importMarkdown(markdown: string): Imported;
 
 /**
- * Whether `content` satisfies the `inline` constraint of `richtext` and
- * `plaintext`: one `Para` line, in no container, with no islands. Judged on
+ * Whether `content` satisfies the one-line constraint of `text` and
+ * `richtext`: one `Para` line, in no container, with no islands. Judged on
  * the normalized content, which is what a write stores. Throws if `content` is
  * not canonical content.
  */
 export function isInline(content: Content): boolean;
 
 /**
- * Whether `content` satisfies the `plaintext` constraint: no marks, no
+ * Whether `content` satisfies the `text` constraint: no marks, no
  * islands, every line a `Para` in no container. Judged on the normalized
  * content, which is what a write stores. Throws if `content` is not canonical
  * content.

package/core/wasm.js

@@ -26,8 +26,8 @@ export class Document {
      * leaves the document untouched. Field errors throw the same per-field
      * bundle as [`commitFields`](Self::commit_fields); an invalid kind or body,
      * or a bad position, throws a single-entry bundle keyed `$kind` / `$body`.
-     * Returns the body import's `parse::dropped_construct` warnings, anchored
-     * at the placed card's body.
+     * Returns the fields' `parse::dropped_construct` warnings, then the body
+     * import's, anchored under the placed card.
      * @param {Quill} quill
      * @param {string} kind
      * @param {Record<string, unknown>} [fields]
@@ -58,7 +58,7 @@ export class Document {
     /**
      * Typed field write at `addr`, resolving the field's schema `type` from
      * `quill`: the stable ABI under the runtime `writer.set`. One verb for every
-     * field type; the schema carries the `inline` constraint, so no type token
+     * field type; the schema carries the one-line constraint, so no type token
      * is passed.
      *
      * A bare string is `Addr` shorthand for `{ field }`. A body address throws,
@@ -67,15 +67,19 @@ export class Document {
      * `edit::unknown_field` rather than falling to the opaque store — use
      * [`storeField`](Document::store_field) for that. Also throws
      * `edit::field_coercion_failed` / `edit::field_decode` /
-     * `edit::field_not_inline` on a typed mismatch,
+     * `edit::field_not_single_line` on a typed mismatch,
      * `edit::invalid_field_name` on a malformed name, and
      * `edit::index_out_of_range` on an out-of-range card.
      *
      * The `quill` handle is passed per call because a `Document` carries only a
      * `$quill` reference, not the resolved schema.
+     *
+     * Returns a `parse::dropped_construct` warning per construct a `richtext`
+     * markdown string in the value dropped, at the string's path.
      * @param {Quill} quill
      * @param {Addr | string} addr
      * @param {any} value
+     * @returns {Diagnostic[]}
      */
     _commitField(quill, addr, value) {
         try {
@@ -84,9 +88,11 @@ export class Document {
             wasm.document__commitField(retptr, this.__wbg_ptr, quill.__wbg_ptr, addHeapObject(addr), addHeapObject(value));
             var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
             var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
-            if (r1) {
-                throw takeObject(r0);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            if (r2) {
+                throw takeObject(r1);
             }
+            return takeObject(r0);
         } finally {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
@@ -98,10 +104,12 @@ export class Document {
      * diagnostic contract as [`storeFields`](Document::store_fields) — nothing
      * applied on error, one `diagnostics` entry per offending field, including
      * `edit::unknown_field` for undeclared names. Throws on an out-of-range
-     * card.
+     * card. Returns [`commitField`](Document::commit_field)'s warnings for
+     * every field, in batch order.
      * @param {Quill} quill
      * @param {CardAddr} addr
      * @param {Record<string, unknown>} fields
+     * @returns {Diagnostic[]}
      */
     _commitFields(quill, addr, fields) {
         try {
@@ -110,9 +118,11 @@ export class Document {
             wasm.document__commitFields(retptr, this.__wbg_ptr, quill.__wbg_ptr, addHeapObject(addr), addHeapObject(fields));
             var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
             var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
-            if (r1) {
-                throw takeObject(r0);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            if (r2) {
+                throw takeObject(r1);
             }
+            return takeObject(r0);
         } finally {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
@@ -263,10 +273,10 @@ export class Document {
      * Revise the content field at `addr` from authored text, typed *and*
      * anchor-preserving: the ABI under `writer.reviseField`. Surviving anchors
      * rebase as in [`revise`](Self::revise), then the diffed result is
-     * schema-conformed, so a `richtext(inline)` field rejects a multi-block
-     * result with `edit::field_not_inline`. Returns the `Revised` receipt, its
+     * schema-conformed, so a one-paragraph `richtext` field rejects a multi-block
+     * result with `edit::field_not_single_line`. Returns the `Revised` receipt, its
      * warnings anchored at the field. The codec is the declared type's:
-     * `richtext` diffs markdown, `plaintext` literal text, which drops nothing.
+     * `richtext` diffs markdown, `text` literal text, which drops nothing.
      *
      * `addr` must name a field; a body address throws, since a body carries no
      * field schema (use [`revise`](Self::revise)). An undeclared name throws
@@ -541,7 +551,7 @@ export class Document {
      * `edit::index_out_of_range`.
      *
      * A content field at rest has one stored form per codec: a `richtext` field
-     * holds the canonical content object, a `plaintext` field its literal
+     * holds the canonical content object, a `text` field its literal
      * string. A document from the bound door (`quill.parse` / `quill.conform`)
      * is at rest; one from the transport door may rest as authored until it is
      * conformed, and this read reports what is there. For the `Content` either
@@ -570,8 +580,9 @@ export class Document {
     /**
      * Insert a card: `at` absent appends, a number inserts at that index (in
      * `0..=cards.length`). Accepts any `CardInput`, including a card read back
-     * out of a document. Throws if `card.kind` is not a valid kind name, or if
-     * `at` is out of range.
+     * out of a document. Throws if `card.kind` is not a valid kind name, if
+     * `at` is out of range, or `edit::too_many_cards` if the document holds
+     * 1,000 cards.
      * @param {CardInput} card
      * @param {number} [at]
      */
@@ -1308,7 +1319,7 @@ export class Quill {
      * The quill's example document, `undefined` when the quill has no
      * `example.md` at its root: a filled-in page whose values are made up to show the
      * quill in use, never kept. It comes back pinned to this quill's
-     * `name@version` and conformed as `parse` conforms, its parse and
+     * `name@MAJOR.MINOR` and conformed as `parse` conforms, its parse and
      * `conform::*` warnings on `doc.warnings`. Throws when the file does not
      * parse or its `$quill` is not this quill's bare name.
      * @returns {Document | undefined}
@@ -1375,7 +1386,7 @@ export class Quill {
      * Parse `markdown` and conform it against this quill: the primary ingestion
      * path, and the bound twin of the schema-free `Document.fromMarkdown`. The
      * returned document rests at its canonical form (a `richtext` field as a
-     * content object, a `plaintext` field as its literal string), so `getStored`
+     * content object, a `text` field as its literal string), so `getStored`
      * answers by the field's declared codec, not by how the document was built.
      *
      * Parse warnings and the `conform::*` diagnostics both land on
@@ -1500,8 +1511,9 @@ export class Quill {
     }
     /**
      * Validate `doc` against this quill's schema, returning every diagnostic:
-     * an error blocks a render, a warning does not. Forwards the canonical
-     * `validation::*` diagnostics the engine emits.
+     * an error blocks a render, a warning does not. Forwards the engine's
+     * `validation::*`, a markdown string's `parse::dropped_construct` and the
+     * backend's `backend::declined_construct`.
      * @param {Document} doc
      * @returns {Diagnostic[]}
      */
@@ -1674,8 +1686,8 @@ export function importMarkdown(markdown) {
 }
 
 /**
- * Whether `content` satisfies the `inline` constraint of `richtext` and
- * `plaintext`: one `Para` line, in no container, with no islands. Judged on
+ * Whether `content` satisfies the one-line constraint of `text` and
+ * `richtext`: one `Para` line, in no container, with no islands. Judged on
  * the normalized content, which is what a write stores. Throws if `content` is
  * not canonical content.
  * @param {Content} content
@@ -1698,7 +1710,7 @@ export function isInline(content) {
 }
 
 /**
- * Whether `content` satisfies the `plaintext` constraint: no marks, no
+ * Whether `content` satisfies the `text` constraint: no marks, no
  * islands, every line a `Para` in no container. Judged on the normalized
  * content, which is what a write stores. Throws if `content` is not canonical
  * content.

package/package.json

@@ -1,11 +1,26 @@
 {
   "name": "@quillmark/wasm",
-  "version": "0.124.0",
+  "version": "0.126.0",
   "description": "WebAssembly bindings for Quillmark, a schema-driven document engine",
   "type": "module",
   "license": "Apache-2.0",
+  "author": "Quillmark Contributors",
+  "homepage": "https://quillmark.dev/",
+  "bugs": {
+    "url": "https://github.com/borb-sh/quillmark/issues"
+  },
+  "keywords": [
+    "markdown",
+    "pdf",
+    "typst",
+    "document",
+    "template",
+    "schema",
+    "forms",
+    "wasm"
+  ],
   "engines": {
-    "node": ">=24"
+    "node": ">=22"
   },
   "repository": {
     "type": "git",
@@ -15,7 +30,10 @@
     "core",
     "render",
     "runtime",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "NOTICE",
+    "THIRD_PARTY_LICENSES.md",
+    "sbom.cdx.json"
   ],
   "main": "./runtime/runtime.js",
   "module": "./runtime/runtime.js",