@quillmark/wasm 0.36.0 → 0.37.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -108,7 +108,7 @@ The main workflow for rendering documents:
108
108
  - `static parseMarkdown(markdown)` - Parse markdown into a ParsedDocument (Step 1)
109
109
  - `registerQuill(quillJson)` - Register a Quill template bundle from JSON (Step 2)
110
110
  - `getQuillInfo(name)` - Get shallow Quill metadata and configuration options (Step 3)
111
- - `render(parsedDoc, options)` - Render a ParsedDocument to final artifacts (Step 4)
111
+ - `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)
112
112
 
113
113
  ### Utility Methods
114
114
 
package/bundler/wasm.d.ts CHANGED
@@ -4,41 +4,45 @@
4
4
  * Initialize the WASM module with panic hooks for better error messages
5
5
  */
6
6
  export function init(): void;
7
- export interface QuillInfo {
8
- name: string;
9
- backend: string;
10
- metadata: Record<string, any>;
11
- example?: string;
12
- schema: Record<string, any>;
13
- defaults: Record<string, any>;
14
- examples: Record<string, any[]>;
15
- supportedFormats: OutputFormat[];
16
- }
17
-
18
- export type OutputFormat = "pdf" | "svg" | "txt";
19
-
20
- export interface Location {
21
- file: string;
22
- line: number;
23
- column: number;
24
- }
25
-
26
7
  export interface RenderOptions {
27
8
  format?: OutputFormat;
28
9
  assets?: Record<string, Uint8Array | number[]>;
29
10
  quillName?: string;
30
11
  }
31
12
 
13
+ export type Severity = "error" | "warning" | "note";
14
+
15
+ export type OutputFormat = "pdf" | "svg" | "txt";
16
+
17
+ export interface Diagnostic {
18
+ severity: Severity;
19
+ code?: string;
20
+ message: string;
21
+ location?: Location;
22
+ hint?: string;
23
+ sourceChain: string[];
24
+ }
25
+
32
26
  export interface ParsedDocument {
33
27
  fields: Record<string, any>;
34
28
  quillName: string;
35
29
  }
36
30
 
37
- export interface RenderResult {
38
- artifacts: Artifact[];
39
- warnings: Diagnostic[];
40
- outputFormat: OutputFormat;
41
- renderTimeMs: number;
31
+ export interface Location {
32
+ file: string;
33
+ line: number;
34
+ column: number;
35
+ }
36
+
37
+ export interface QuillInfo {
38
+ name: string;
39
+ backend: string;
40
+ metadata: Record<string, any>;
41
+ example?: string;
42
+ schema: Record<string, any>;
43
+ defaults: Record<string, any>;
44
+ examples: Record<string, any[]>;
45
+ supportedFormats: OutputFormat[];
42
46
  }
43
47
 
44
48
  export interface Artifact {
@@ -47,17 +51,13 @@ export interface Artifact {
47
51
  mimeType: string;
48
52
  }
49
53
 
50
- export interface Diagnostic {
51
- severity: Severity;
52
- code?: string;
53
- message: string;
54
- location?: Location;
55
- hint?: string;
56
- sourceChain: string[];
54
+ export interface RenderResult {
55
+ artifacts: Artifact[];
56
+ warnings: Diagnostic[];
57
+ outputFormat: OutputFormat;
58
+ renderTimeMs: number;
57
59
  }
58
60
 
59
- export type Severity = "error" | "warning" | "note";
60
-
61
61
  /**
62
62
  * Quillmark WASM Engine
63
63
  *
@@ -130,6 +130,7 @@ export class Quillmark {
130
130
  /**
131
131
  * Render a ParsedDocument to final artifacts (PDF, SVG, TXT)
132
132
  *
133
+ * Note that the quill reference is optional to specify and can be inferred from the markdown content's frontmatter.
133
134
  * Uses the Quill specified in options.quill_name if provided,
134
135
  * otherwise infers it from the ParsedDocument's quill_name field.
135
136
  */
@@ -429,6 +429,7 @@ export class Quillmark {
429
429
  /**
430
430
  * Render a ParsedDocument to final artifacts (PDF, SVG, TXT)
431
431
  *
432
+ * Note that the quill reference is optional to specify and can be inferred from the markdown content's frontmatter.
432
433
  * Uses the Quill specified in options.quill_name if provided,
433
434
  * otherwise infers it from the ParsedDocument's quill_name field.
434
435
  * @param {ParsedDocument} parsed
Binary file
@@ -4,41 +4,45 @@
4
4
  * Initialize the WASM module with panic hooks for better error messages
5
5
  */
6
6
  export function init(): void;
7
- export interface QuillInfo {
8
- name: string;
9
- backend: string;
10
- metadata: Record<string, any>;
11
- example?: string;
12
- schema: Record<string, any>;
13
- defaults: Record<string, any>;
14
- examples: Record<string, any[]>;
15
- supportedFormats: OutputFormat[];
16
- }
17
-
18
- export type OutputFormat = "pdf" | "svg" | "txt";
19
-
20
- export interface Location {
21
- file: string;
22
- line: number;
23
- column: number;
24
- }
25
-
26
7
  export interface RenderOptions {
27
8
  format?: OutputFormat;
28
9
  assets?: Record<string, Uint8Array | number[]>;
29
10
  quillName?: string;
30
11
  }
31
12
 
13
+ export type Severity = "error" | "warning" | "note";
14
+
15
+ export type OutputFormat = "pdf" | "svg" | "txt";
16
+
17
+ export interface Diagnostic {
18
+ severity: Severity;
19
+ code?: string;
20
+ message: string;
21
+ location?: Location;
22
+ hint?: string;
23
+ sourceChain: string[];
24
+ }
25
+
32
26
  export interface ParsedDocument {
33
27
  fields: Record<string, any>;
34
28
  quillName: string;
35
29
  }
36
30
 
37
- export interface RenderResult {
38
- artifacts: Artifact[];
39
- warnings: Diagnostic[];
40
- outputFormat: OutputFormat;
41
- renderTimeMs: number;
31
+ export interface Location {
32
+ file: string;
33
+ line: number;
34
+ column: number;
35
+ }
36
+
37
+ export interface QuillInfo {
38
+ name: string;
39
+ backend: string;
40
+ metadata: Record<string, any>;
41
+ example?: string;
42
+ schema: Record<string, any>;
43
+ defaults: Record<string, any>;
44
+ examples: Record<string, any[]>;
45
+ supportedFormats: OutputFormat[];
42
46
  }
43
47
 
44
48
  export interface Artifact {
@@ -47,17 +51,13 @@ export interface Artifact {
47
51
  mimeType: string;
48
52
  }
49
53
 
50
- export interface Diagnostic {
51
- severity: Severity;
52
- code?: string;
53
- message: string;
54
- location?: Location;
55
- hint?: string;
56
- sourceChain: string[];
54
+ export interface RenderResult {
55
+ artifacts: Artifact[];
56
+ warnings: Diagnostic[];
57
+ outputFormat: OutputFormat;
58
+ renderTimeMs: number;
57
59
  }
58
60
 
59
- export type Severity = "error" | "warning" | "note";
60
-
61
61
  /**
62
62
  * Quillmark WASM Engine
63
63
  *
@@ -130,6 +130,7 @@ export class Quillmark {
130
130
  /**
131
131
  * Render a ParsedDocument to final artifacts (PDF, SVG, TXT)
132
132
  *
133
+ * Note that the quill reference is optional to specify and can be inferred from the markdown content's frontmatter.
133
134
  * Uses the Quill specified in options.quill_name if provided,
134
135
  * otherwise infers it from the ParsedDocument's quill_name field.
135
136
  */
@@ -423,6 +423,7 @@ export class Quillmark {
423
423
  /**
424
424
  * Render a ParsedDocument to final artifacts (PDF, SVG, TXT)
425
425
  *
426
+ * Note that the quill reference is optional to specify and can be inferred from the markdown content's frontmatter.
426
427
  * Uses the Quill specified in options.quill_name if provided,
427
428
  * otherwise infers it from the ParsedDocument's quill_name field.
428
429
  * @param {ParsedDocument} parsed
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quillmark/wasm",
3
- "version": "0.36.0",
3
+ "version": "0.37.1",
4
4
  "description": "WebAssembly bindings for quillmark",
5
5
  "type": "module",
6
6
  "license": "MIT OR Apache-2.0",