@quillmark/wasm 0.82.0 → 0.84.0

package/README.md

@@ -244,6 +244,24 @@ canvas.style.height = `${result.layoutHeight}px`;
   enforcement contract and includes the resolved `backendId` for
   debugging.
 
+### Schema model
+
+A field's *cell* is inferred from whether its schema declares a `default:`:
+
+- **Must Fill** (no `default:`) — `quill.blueprint` renders `<must-fill>`
+  in the value cell, and `quill.render(doc)` throws with
+  `validation::must_fill_absent` when the field is absent at
+  validate time, or `validation::must_fill_sentinel` when the
+  `<must-fill>` sentinel survives into the document.
+- **Endorsed** (with `default:`) — `quill.blueprint` renders the
+  default value followed by a `; skip-ok` annotation, and the default
+  is used when the document omits the field.
+
+`QuillFieldSchema` no longer carries a `required` axis. The legacy
+`validation::missing_required` code has been replaced by
+`validation::must_fill_absent`; the `validation::must_fill_sentinel`
+code covers unreplaced sentinels.
+
 ### Errors
 
 Every method that can fail throws a JS `Error` with `.diagnostics` attached:
@@ -263,7 +281,7 @@ compilation failures. The same shape applies to every throw site:
 - `Document.fromMarkdown` — parse errors (missing root `$quill` metadata, YAML
   errors, `parse::input_too_large` for inputs > 10 MB).
 - `Document` mutators (`setField`, `updateCardField`, etc.) — `EditError`
-  variants (`ReservedName`, `InvalidFieldName`, `InvalidKindName`,
+  variants (`InvalidFieldName`, `InvalidKindName`, `ReservedKind`,
   `IndexOutOfRange`) appear in `diagnostics[0].message` with the
   `[EditError::<Variant>]` prefix.
 - `quill.render` / `session.render` — backend compilation failures and

package/bundler/wasm.d.ts

@@ -106,13 +106,20 @@ export interface QuillCardBody {
     example?: string;
 }
 
-/** Schema entry for a single field declared in a quill's `Quill.yaml`. */
+/** Schema entry for a single field declared in a quill's `Quill.yaml`.
+ *
+ * A field's *cell* is determined by `default`: a field with a `default`
+ * is **Endorsed** (the rendered value is shippable as-is), while a field
+ * without a `default` is **Must Fill** (the blueprint carries a
+ * `<must-fill>` sentinel and validation reports
+ * `validation::must_fill_absent` if the field is absent at validate
+ * time). There is no separate `required` axis.
+ */
 export interface QuillFieldSchema {
     type: "string" | "number" | "integer" | "boolean" | "array" | "object" | "date" | "datetime" | "markdown";
     description?: string;
     default?: unknown;
     example?: unknown;
-    required?: boolean;
     enum?: string[];
     ui?: QuillFieldUi;
     properties?: Record<string, QuillFieldSchema>;
@@ -130,8 +137,9 @@ export interface QuillCardSchema {
 /**
  * Document schema returned by `Quill.schema`. Includes optional `ui` keys.
  *
- * `main.fields.QUILL` and `card_kinds[name].fields.CARD` are required
- * reserved fields with `const` values telling consumers what to write.
+ * Describes only the user-fillable fields. The quill reference
+ * (constructed as `${metadata.name}@${metadata.version}`) and card-kind
+ * discriminators are document-level metadata, not schema fields.
  */
 export interface QuillSchema {
     main: QuillCardSchema;
@@ -202,6 +210,7 @@ export interface Artifact {
 export interface Card {
     kind: string;
     payloadItems: PayloadItem[];
+    ext?: Record<string, unknown> | undefined;
     body: string;
 }
 
@@ -294,8 +303,7 @@ export class Document {
     removeCardField(index: number, name: string): any;
     /**
      * Remove a payload field on the main card, returning the removed value or
-     * `undefined`. Throws if `name` is reserved or does not match
-     * `[a-z_][a-z0-9_]*`.
+     * `undefined`. Throws if `name` does not match `[a-z_][a-z0-9_]*`.
      */
     removeField(name: string): any;
     replaceBody(body: string): void;
@@ -315,8 +323,7 @@ export class Document {
     /**
      * Update a payload field on the main card. Clears any existing `!fill` marker.
      *
-     * Throws if `name` is reserved (`BODY`, `CARDS`, `QUILL`, `CARD`) or does
-     * not match `[a-z_][a-z0-9_]*`.
+     * Throws if `name` does not match `[a-z_][a-z0-9_]*`.
      */
     setField(name: string, value: any): void;
     /**

package/bundler/wasm_bg.js

@@ -239,8 +239,7 @@ export class Document {
     }
     /**
      * Remove a payload field on the main card, returning the removed value or
-     * `undefined`. Throws if `name` is reserved or does not match
-     * `[a-z_][a-z0-9_]*`.
+     * `undefined`. Throws if `name` does not match `[a-z_][a-z0-9_]*`.
      * @param {string} name
      * @returns {any}
      */
@@ -320,8 +319,7 @@ export class Document {
     /**
      * Update a payload field on the main card. Clears any existing `!fill` marker.
      *
-     * Throws if `name` is reserved (`BODY`, `CARDS`, `QUILL`, `CARD`) or does
-     * not match `[a-z_][a-z0-9_]*`.
+     * Throws if `name` does not match `[a-z_][a-z0-9_]*`.
      * @param {string} name
      * @param {any} value
      */

package/package.json

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