@quillmark/wasm 0.37.0 → 0.38.0

package/README.md

@@ -108,7 +108,7 @@ The main workflow for rendering documents:
 - `static parseMarkdown(markdown)` - Parse markdown into a ParsedDocument (Step 1)
 - `registerQuill(quillJson)` - Register a Quill template bundle from JSON (Step 2)
 - `getQuillInfo(name)` - Get shallow Quill metadata and configuration options (Step 3)
-- `render(parsedDoc, options)` - Render a ParsedDocument to final artifacts (Step 4)
+- `render(parsedDoc, options)` - Render a ParsedDocument to final artifacts. Note that the quill reference in `options` is optional to specify and can be inferred from the markdown content's frontmatter (Step 4)
 
 ### Utility Methods
 
@@ -125,7 +125,7 @@ Additional methods for managing the engine and debugging:
 {
   format?: 'pdf' | 'svg' | 'txt',  // Output format (default: 'pdf')
   assets?: Record<string, Uint8Array>,  // Additional assets to inject as plain object (not Map)
-  quillName?: string  // Override quillName from ParsedDocument
+  quillName?: string  // Override quillRef from ParsedDocument
 }
 ```
 
@@ -136,7 +136,7 @@ Returned by `parseMarkdown()`:
 ```typescript
 {
   fields: object,  // YAML frontmatter fields
-  quillName: string  // Template name from QUILL field (or "__default__")
+  quillRef: string  // Quill reference from QUILL field (or "__default__")
 }
 ```
 

package/bundler/wasm.d.ts

@@ -49,7 +49,7 @@ export interface QuillInfo {
 
 export interface ParsedDocument {
     fields: Record<string, any>;
-    quillName: string;
+    quillRef: string;
 }
 
 export interface RenderOptions {
@@ -74,7 +74,7 @@ export class Quillmark {
    * Parse markdown into a ParsedDocument
    *
    * This is the first step in the workflow. The returned ParsedDocument contains
-   * the parsed YAML frontmatter fields and the quill_name (from QUILL field or "__default__").
+   * the parsed YAML frontmatter fields and the quill_ref (from QUILL field or "__default__").
    */
   static parseMarkdown(markdown: string): ParsedDocument;
   /**
@@ -120,8 +120,9 @@ export class Quillmark {
   /**
    * Render a ParsedDocument to final artifacts (PDF, SVG, TXT)
    *
+   * Note that the quill reference is optional to specify and can be inferred from the markdown content's frontmatter.
    * Uses the Quill specified in options.quill_name if provided,
-   * otherwise infers it from the ParsedDocument's quill_name field.
+   * otherwise infers it from the ParsedDocument's quill_ref field.
    */
   render(parsed: ParsedDocument, opts: RenderOptions): RenderResult;
   /**

package/bundler/wasm_bg.js

@@ -258,7 +258,7 @@ export class Quillmark {
      * Parse markdown into a ParsedDocument
      *
      * This is the first step in the workflow. The returned ParsedDocument contains
-     * the parsed YAML frontmatter fields and the quill_name (from QUILL field or "__default__").
+     * the parsed YAML frontmatter fields and the quill_ref (from QUILL field or "__default__").
      * @param {string} markdown
      * @returns {ParsedDocument}
      */
@@ -407,8 +407,9 @@ export class Quillmark {
     /**
      * Render a ParsedDocument to final artifacts (PDF, SVG, TXT)
      *
+     * Note that the quill reference is optional to specify and can be inferred from the markdown content's frontmatter.
      * Uses the Quill specified in options.quill_name if provided,
-     * otherwise infers it from the ParsedDocument's quill_name field.
+     * otherwise infers it from the ParsedDocument's quill_ref field.
      * @param {ParsedDocument} parsed
      * @param {RenderOptions} opts
      * @returns {RenderResult}

package/node-esm/wasm.d.ts

@@ -49,7 +49,7 @@ export interface QuillInfo {
 
 export interface ParsedDocument {
     fields: Record<string, any>;
-    quillName: string;
+    quillRef: string;
 }
 
 export interface RenderOptions {
@@ -74,7 +74,7 @@ export class Quillmark {
    * Parse markdown into a ParsedDocument
    *
    * This is the first step in the workflow. The returned ParsedDocument contains
-   * the parsed YAML frontmatter fields and the quill_name (from QUILL field or "__default__").
+   * the parsed YAML frontmatter fields and the quill_ref (from QUILL field or "__default__").
    */
   static parseMarkdown(markdown: string): ParsedDocument;
   /**
@@ -120,8 +120,9 @@ export class Quillmark {
   /**
    * Render a ParsedDocument to final artifacts (PDF, SVG, TXT)
    *
+   * Note that the quill reference is optional to specify and can be inferred from the markdown content's frontmatter.
    * Uses the Quill specified in options.quill_name if provided,
-   * otherwise infers it from the ParsedDocument's quill_name field.
+   * otherwise infers it from the ParsedDocument's quill_ref field.
    */
   render(parsed: ParsedDocument, opts: RenderOptions): RenderResult;
   /**

package/node-esm/wasm_bg.js

@@ -252,7 +252,7 @@ export class Quillmark {
      * Parse markdown into a ParsedDocument
      *
      * This is the first step in the workflow. The returned ParsedDocument contains
-     * the parsed YAML frontmatter fields and the quill_name (from QUILL field or "__default__").
+     * the parsed YAML frontmatter fields and the quill_ref (from QUILL field or "__default__").
      * @param {string} markdown
      * @returns {ParsedDocument}
      */
@@ -401,8 +401,9 @@ export class Quillmark {
     /**
      * Render a ParsedDocument to final artifacts (PDF, SVG, TXT)
      *
+     * Note that the quill reference is optional to specify and can be inferred from the markdown content's frontmatter.
      * Uses the Quill specified in options.quill_name if provided,
-     * otherwise infers it from the ParsedDocument's quill_name field.
+     * otherwise infers it from the ParsedDocument's quill_ref field.
      * @param {ParsedDocument} parsed
      * @param {RenderOptions} opts
      * @returns {RenderResult}

package/package.json

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