@quillmark/wasm 0.69.1 → 0.70.0

package/bundler/wasm.d.ts

@@ -122,30 +122,27 @@ export interface QuillCardSchema {
 }
 
 /**
- * Public schema contract returned as `QuillMetadata.schema`.
+ * Document schema. Returned by both `Quill.schema` (no ui hints) and
+ * `Quill.formSchema` (with ui hints) — same shape, optional `ui` keys.
  *
- * Identical to `QuillConfig::public_schema()` on the Rust side.
+ * `main.fields.QUILL` and `card_types[name].fields.CARD` are required
+ * sentinels with `const` values telling consumers what to write.
  */
 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`.
+ * Identity snapshot mirroring the `quill:` section of `Quill.yaml`.
+ * Schemas live on `Quill.schema` / `Quill.formSchema`; the example on
+ * `Quill.example`. Extra `quill:` keys appear as `unknown`.
  */
 export interface QuillMetadata {
-    schema: QuillSchema;
-    backend: string;
+    name: string;
     version: string;
+    backend: string;
     author: string;
     description: string;
     supportedFormats: OutputFormat[];
@@ -508,23 +505,16 @@ export class Quill {
      */
     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:`.
+     * Bundled example document, or `undefined` if none was declared.
+     */
+    readonly example: string | undefined;
+    /**
+     * Document schema with `ui` hints — for form builders.
+     */
+    readonly formSchema: QuillSchema;
+    /**
+     * Identity snapshot of the `quill:` section of `Quill.yaml`, plus
+     * `supportedFormats` and any custom `quill:` keys.
      *
      * Consumers that need validation run their own validator against
      * `metadata.schema`.
@@ -533,6 +523,10 @@ export class Quill {
      * immutable once constructed.
      */
     readonly metadata: QuillMetadata;
+    /**
+     * Document schema with `ui` hints stripped — for LLM/MCP consumers.
+     */
+    readonly schema: QuillSchema;
     /**
      * Whether this quill's backend supports canvas preview.
      *

package/bundler/wasm_bg.js

@@ -575,6 +575,26 @@ export class Quill {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * Bundled example document, or `undefined` if none was declared.
+     * @returns {string | undefined}
+     */
+    get example() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.quill_example(retptr, this.__wbg_ptr);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            let v1;
+            if (r0 !== 0) {
+                v1 = getStringFromWasm0(r0, r1).slice();
+                wasm.__wbindgen_export4(r0, r1 * 1, 1);
+            }
+            return v1;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
     /**
      * The schema-aware form view of `doc`.
      *
@@ -613,23 +633,16 @@ export class Quill {
         }
     }
     /**
-     * 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:`.
+     * Document schema with `ui` hints — for form builders.
+     * @returns {QuillSchema}
+     */
+    get formSchema() {
+        const ret = wasm.quill_formSchema(this.__wbg_ptr);
+        return takeObject(ret);
+    }
+    /**
+     * Identity snapshot of the `quill:` section of `Quill.yaml`, plus
+     * `supportedFormats` and any custom `quill:` keys.
      *
      * Consumers that need validation run their own validator against
      * `metadata.schema`.
@@ -685,6 +698,14 @@ export class Quill {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * Document schema with `ui` hints stripped — for LLM/MCP consumers.
+     * @returns {QuillSchema}
+     */
+    get schema() {
+        const ret = wasm.quill_schema(this.__wbg_ptr);
+        return takeObject(ret);
+    }
     /**
      * Whether this quill's backend supports canvas preview.
      *

package/bundler/wasm_bg.wasm.d.ts

@@ -31,10 +31,13 @@ export const init: () => void;
 export const quill_backendId: (a: number, b: number) => void;
 export const quill_blankCard: (a: number, b: number, c: number, d: number) => void;
 export const quill_blankMain: (a: number, b: number) => void;
+export const quill_example: (a: number, b: number) => void;
 export const quill_form: (a: number, b: number, c: number) => void;
+export const quill_formSchema: (a: number) => number;
 export const quill_metadata: (a: number) => number;
 export const quill_open: (a: number, b: number, c: number) => void;
 export const quill_render: (a: number, b: number, c: number, d: number) => void;
+export const quill_schema: (a: number) => number;
 export const quill_supportsCanvas: (a: number) => number;
 export const quillmark_new: () => number;
 export const quillmark_quill: (a: number, b: number, c: number) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quillmark/wasm",
-  "version": "0.69.1",
+  "version": "0.70.0",
   "description": "WebAssembly bindings for quillmark",
   "type": "module",
   "license": "MIT OR Apache-2.0",