@quillmark/wasm 0.68.0 → 0.69.1

package/README.md

@@ -79,6 +79,18 @@ O(1) getter for the number of composable cards (excluding the main card).
 Use this to validate indices before calling card mutators (`removeCard`,
 `updateCardField`, etc.) without allocating the full `cards` array.
 
+### `quill.form(doc)`
+
+Returns `{ main, cards, diagnostics }` — a schema-aware snapshot of `doc`
+without invoking the backend. `diagnostics` contains validation errors and
+warnings; an empty array means the document is valid. Useful for validating
+content without rendering:
+
+```ts
+const form = quill.form(Document.fromMarkdown(markdown));
+const errors = form.diagnostics.filter(d => d.severity === "error");
+```
+
 ### `quill.render(parsed, opts?)` vs. `quill.open(parsed)`
 
 Use **`Quill.render`** for one-shot exports (PDF/SVG/PNG) — compiles, emits

package/bundler/wasm.d.ts

@@ -84,6 +84,113 @@ export interface PaintResult {
 }
 
 
+
+/** UI layout hints for a single field. */
+export interface QuillFieldUi {
+    group?: string;
+    order?: number;
+    compact?: boolean;
+    multiline?: boolean;
+}
+
+/** UI layout hints for a card (main or named card type). */
+export interface QuillCardUi {
+    hide_body?: boolean;
+    default_title?: string;
+}
+
+/** Schema entry for a single field declared in a quill's `Quill.yaml`. */
+export interface QuillFieldSchema {
+    type: "string" | "number" | "integer" | "boolean" | "array" | "object" | "date" | "datetime" | "markdown";
+    title?: string;
+    description?: string;
+    default?: unknown;
+    examples?: unknown;
+    required?: boolean;
+    enum?: string[];
+    ui?: QuillFieldUi;
+    properties?: Record<string, QuillFieldSchema>;
+    items?: QuillFieldSchema;
+}
+
+/** Schema entry for the main card or a named card type. */
+export interface QuillCardSchema {
+    title?: string;
+    description?: string;
+    fields: Record<string, QuillFieldSchema>;
+    ui?: QuillCardUi;
+}
+
+/**
+ * Public schema contract returned as `QuillMetadata.schema`.
+ *
+ * Identical to `QuillConfig::public_schema()` on the Rust side.
+ */
+export interface QuillSchema {
+    name: string;
+    main: QuillCardSchema;
+    /** Present only when the quill declares at least one named card type. */
+    card_types?: Record<string, QuillCardSchema>;
+    /** The quill's bundled example document, if declared. */
+    example?: string;
+}
+
+/**
+ * Read-only snapshot of the loaded quill's engine info and declared schema.
+ * Returned by `Quill.metadata`.
+ *
+ * Well-known keys are strongly typed; any additional keys declared under
+ * `quill:` in `Quill.yaml` appear as `unknown`.
+ */
+export interface QuillMetadata {
+    schema: QuillSchema;
+    backend: string;
+    version: string;
+    author: string;
+    description: string;
+    supportedFormats: OutputFormat[];
+    [key: string]: unknown;
+}
+
+/** Source of a field's effective value in a form view. */
+export type FormFieldSource = "document" | "default" | "missing";
+
+/**
+ * A single field's view within a `FormCard`.
+ *
+ * - `value` — the document-supplied value (`null` when absent).
+ * - `default` — the schema default (`null` when no default is declared).
+ * - `source` — where the effective value comes from.
+ */
+export interface FormFieldValue {
+    value: unknown;
+    default: unknown;
+    source: FormFieldSource;
+}
+
+/**
+ * A card viewed through its schema, as returned by `Quill.form`,
+ * `Quill.blankMain`, and `Quill.blankCard`.
+ */
+export interface FormCard {
+    schema: QuillCardSchema;
+    values: Record<string, FormFieldValue>;
+}
+
+/**
+ * Schema-aware form view of a document, returned by `Quill.form`.
+ *
+ * - `main` — the main card viewed through the quill's main schema.
+ * - `cards` — composable card blocks, in document order (unknown tags excluded).
+ * - `diagnostics` — diagnostics from unknown card tags and validation.
+ */
+export interface Form {
+    main: FormCard;
+    cards: FormCard[];
+    diagnostics: Diagnostic[];
+}
+
+
 export interface Artifact {
     format: OutputFormat;
     bytes: Uint8Array;
@@ -357,7 +464,7 @@ export class Quill {
      *
      * [`Form::cards`]: quillmark::form::Form::cards
      */
-    blankCard(card_type: string): any;
+    blankCard(card_type: string): FormCard | null;
     /**
      * A blank form for the main card — no document values supplied.
      *
@@ -367,7 +474,7 @@ export class Quill {
      *
      * [`Form::main`]: quillmark::form::Form::main
      */
-    blankMain(): any;
+    blankMain(): FormCard;
     /**
      * The schema-aware form view of `doc`.
      *
@@ -387,7 +494,7 @@ export class Quill {
      *
      * [`Form`]: quillmark::form::Form
      */
-    form(doc: Document): any;
+    form(doc: Document): Form;
     /**
      * Open an iterative render session for page-selective rendering.
      */
@@ -425,7 +532,7 @@ export class Quill {
      * Equivalent by value for the lifetime of the handle; the quill is
      * immutable once constructed.
      */
-    readonly metadata: any;
+    readonly metadata: QuillMetadata;
     /**
      * Whether this quill's backend supports canvas preview.
      *

package/bundler/wasm_bg.js

@@ -531,7 +531,7 @@ export class Quill {
      *
      * [`Form::cards`]: quillmark::form::Form::cards
      * @param {string} card_type
-     * @returns {any}
+     * @returns {FormCard | null}
      */
     blankCard(card_type) {
         try {
@@ -558,7 +558,7 @@ export class Quill {
      * the schema declares a default) or `"missing"`.
      *
      * [`Form::main`]: quillmark::form::Form::main
-     * @returns {any}
+     * @returns {FormCard}
      */
     blankMain() {
         try {
@@ -594,7 +594,7 @@ export class Quill {
      *
      * [`Form`]: quillmark::form::Form
      * @param {Document} doc
-     * @returns {any}
+     * @returns {Form}
      */
     form(doc) {
         try {
@@ -636,7 +636,7 @@ export class Quill {
      *
      * Equivalent by value for the lifetime of the handle; the quill is
      * immutable once constructed.
-     * @returns {any}
+     * @returns {QuillMetadata}
      */
     get metadata() {
         const ret = wasm.quill_metadata(this.__wbg_ptr);

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@quillmark/wasm",
-  "version": "0.68.0",
+  "version": "0.69.1",
   "description": "WebAssembly bindings for quillmark",
   "type": "module",
   "license": "MIT OR Apache-2.0",
+  "engines": {
+    "node": ">=24"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nibsbin/quillmark.git"
@@ -13,20 +16,14 @@
     "bundler/wasm_bg.js",
     "bundler/wasm_bg.wasm.d.ts",
     "bundler/wasm.js",
-    "bundler/wasm.d.ts",
-    "node-esm/wasm_bg.wasm",
-    "node-esm/wasm_bg.js",
-    "node-esm/wasm_bg.wasm.d.ts",
-    "node-esm/wasm.js",
-    "node-esm/wasm.d.ts"
+    "bundler/wasm.d.ts"
   ],
-  "main": "./node-esm/wasm.js",
+  "main": "./bundler/wasm.js",
   "module": "./bundler/wasm.js",
   "types": "./bundler/wasm.d.ts",
   "exports": {
     ".": {
       "types": "./bundler/wasm.d.ts",
-      "node": "./node-esm/wasm.js",
       "import": "./bundler/wasm.js",
       "default": "./bundler/wasm.js"
     }
@@ -34,4 +31,4 @@
   "sideEffects": [
     "./bundler/wasm.js"
   ]
-}
+}