@quillmark/wasm 0.66.2 → 0.68.0

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
@@ -79,12 +79,78 @@ O(1) getter for the number of composable cards (excluding the main card).
79
79
  Use this to validate indices before calling card mutators (`removeCard`,
80
80
  `updateCardField`, etc.) without allocating the full `cards` array.
81
81
 
82
+ ### `quill.render(parsed, opts?)` vs. `quill.open(parsed)`
83
+
84
+ Use **`Quill.render`** for one-shot exports (PDF/SVG/PNG) — compiles, emits
85
+ artifacts, done. Use **`RenderSession`** (returned by `Quill.open`) for
86
+ reactive previews where you'll paint or re-emit pages multiple times: the
87
+ session retains the compiled snapshot so subsequent `paint` / `render`
88
+ calls skip recompilation. Don't open a session per export.
89
+
82
90
  ### `quill.render(parsed, opts?)`
83
91
  Render with a pre-parsed `Document`.
84
92
 
85
93
  ### `quill.open(parsed)` + `session.render(opts?)`
86
94
  Open once, render all or selected pages (`opts.pages`).
87
95
 
96
+ The session also exposes `pageCount`, `backendId`, `supportsCanvas`,
97
+ `warnings` (snapshot of session-level diagnostics attached at `open` time),
98
+ `pageSize(page)`, and `paint(ctx, page, opts?)` for canvas previews. See
99
+ below.
100
+
101
+ A document that compiles to zero pages still produces a valid session
102
+ (`pageCount === 0`); `paint(ctx, 0)` and `pageSize(0)` then throw
103
+ `page index 0 out of range (pageCount=0)`. Branch on `pageCount === 0` to
104
+ render a "no pages to preview" UI without relying on the throw.
105
+
106
+ ### Canvas Preview (Typst only)
107
+
108
+ `session.paint(ctx, page, opts?)` rasterizes a page directly into a
109
+ `CanvasRenderingContext2D` (main thread) or
110
+ `OffscreenCanvasRenderingContext2D` (Worker), skipping PNG/SVG byte
111
+ round-trips.
112
+
113
+ The painter owns `canvas.width` / `canvas.height` — it sizes the backing
114
+ store itself. Consumers own `canvas.style.*` (or the layout system that
115
+ sets them) and read `layoutWidth` / `layoutHeight` from the returned
116
+ `PaintResult`.
117
+
118
+ ```ts
119
+ const result = session.paint(canvas.getContext("2d"), 0, {
120
+ layoutScale: 1, // layout px per Typst pt
121
+ densityScale: window.devicePixelRatio, // backing-store density
122
+ });
123
+
124
+ canvas.style.width = `${result.layoutWidth}px`;
125
+ canvas.style.height = `${result.layoutHeight}px`;
126
+ ```
127
+
128
+ - `layoutScale` (default 1) sets the canvas's display-box size:
129
+ `layoutWidth = widthPt * layoutScale`. For on-screen canvases this is
130
+ CSS pixels per Typst point. Defaults to 1 (one CSS pixel per pt).
131
+ - `densityScale` (default 1) is the backing-store density multiplier.
132
+ Fold `window.devicePixelRatio`, in-app zoom, and `visualViewport.scale`
133
+ (pinch-zoom) into a single value here. Pass `devicePixelRatio` for
134
+ crisp output on high-DPI displays.
135
+ - The effective rasterization scale is `layoutScale * densityScale`. If
136
+ that would exceed the safe maximum (16384 px per side), `densityScale`
137
+ is clamped proportionally; compare `result.pixelWidth` against
138
+ `Math.round(result.layoutWidth * densityScale)` to detect.
139
+ - `paint` is always a full repaint — setting the backing-store width /
140
+ height clears it. No `clearRect` required.
141
+ - `pageCount` and `pageSize(page)` are stable for the session's
142
+ lifetime (immutable snapshot) — cache them.
143
+ - Worker support: pass an `OffscreenCanvasRenderingContext2D` and the
144
+ same call signature works. `layoutWidth` / `layoutHeight` are
145
+ informational in that mode (no CSS layout box); fold everything into
146
+ `densityScale`. Loading the WASM module inside a Worker is the host's
147
+ responsibility.
148
+ - Backend support: gated by `supportsCanvas`. Probe upfront with
149
+ `quill.supportsCanvas` (or `session.supportsCanvas`) before mounting a
150
+ canvas-based UI; the throw on `paint` / `pageSize` remains the
151
+ enforcement contract and includes the resolved `backendId` for
152
+ debugging.
153
+
88
154
  ### Errors
89
155
 
90
156
  Every method that can fail throws a JS `Error` with `.diagnostics` attached:
@@ -118,6 +184,22 @@ without manual `.free()` discipline. `.free()` is still emitted as an eager
118
184
  teardown hook for callers that want deterministic release. Requires
119
185
  Node 14.6+ / current evergreen browsers (all supported targets).
120
186
 
187
+ For environments where `using` (the [explicit resource management][erm]
188
+ proposal) hasn't landed, use an explicit `try` / `finally`:
189
+
190
+ ```ts
191
+ const session = quill.open(doc);
192
+ try {
193
+ for (let p = 0; p < session.pageCount; p++) {
194
+ session.paint(ctx, p);
195
+ }
196
+ } finally {
197
+ session.free();
198
+ }
199
+ ```
200
+
201
+ [erm]: https://github.com/tc39/proposal-explicit-resource-management
202
+
121
203
  ## Notes
122
204
 
123
205
  - Parsed markdown requires top-level `QUILL` in frontmatter. Empty input
package/bundler/wasm.d.ts CHANGED
@@ -13,6 +13,77 @@ export interface CardInput {
13
13
  }
14
14
 
15
15
 
16
+
17
+ /**
18
+ * Page dimensions in Typst points (1 pt = 1/72 inch).
19
+ *
20
+ * Report-only: the painter sizes the canvas itself based on
21
+ * `PaintOptions`. `pageSize` is exposed for callers that need page
22
+ * geometry up-front (e.g. to lay out a scrollable list of canvases
23
+ * before any pixels are rendered).
24
+ */
25
+ export interface PageSize {
26
+ widthPt: number;
27
+ heightPt: number;
28
+ }
29
+
30
+ /**
31
+ * Inputs to `RenderSession.paint`. Both fields are optional and default
32
+ * to `1`.
33
+ *
34
+ * - `layoutScale` — layout-space pixels per Typst point. For on-screen
35
+ * canvases this is CSS pixels per pt; the page's layout-pixel size is
36
+ * `widthPt * layoutScale × heightPt * layoutScale`. The painter
37
+ * surfaces these dimensions as `layoutWidth` / `layoutHeight` so
38
+ * consumers can drive `canvas.style.*` (or any layout system).
39
+ * - `densityScale` — backing-store density multiplier. Fold
40
+ * `window.devicePixelRatio`, in-app zoom, and `visualViewport.scale`
41
+ * (pinch-zoom) into a single value here. Defaults to `1`, which
42
+ * produces a non-retina backing store — pass `window.devicePixelRatio`
43
+ * for crisp output on high-DPI displays.
44
+ *
45
+ * The effective rasterization scale is `layoutScale * densityScale`.
46
+ * Both must be finite and `> 0`. For `OffscreenCanvasRenderingContext2D`
47
+ * the two collapse to a single scalar; folding everything into
48
+ * `densityScale` is the simplest convention.
49
+ */
50
+ export interface PaintOptions {
51
+ layoutScale?: number;
52
+ densityScale?: number;
53
+ }
54
+
55
+ /**
56
+ * Returned by `RenderSession.paint`.
57
+ *
58
+ * - `layoutWidth` / `layoutHeight` — layout-pixel dimensions of the
59
+ * canvas's display box. For on-screen canvases this is CSS pixels:
60
+ * set `canvas.style.width = layoutWidth + "px"` and
61
+ * `canvas.style.height = layoutHeight + "px"` (or feed these into
62
+ * your layout system). Independent of `densityScale`.
63
+ * - `pixelWidth` / `pixelHeight` — integer backing-store pixel
64
+ * dimensions the painter wrote to `canvas.width` / `canvas.height`.
65
+ * Equal to `round(layoutWidth * densityScale)` ×
66
+ * `round(layoutHeight * densityScale)` *unless* the requested backing
67
+ * exceeded the painter's safe maximum (16384 px per side), in which
68
+ * case `densityScale` was clamped to fit. Detect clamping via
69
+ * `pixelWidth < round(layoutWidth * densityScale)`.
70
+ *
71
+ * The painter owns `canvas.width` / `canvas.height`; consumers must not
72
+ * write to them. The painter does **not** touch `canvas.style.*`;
73
+ * consumers own layout.
74
+ *
75
+ * For `OffscreenCanvasRenderingContext2D` (Worker rasterization, no
76
+ * DOM), `layoutWidth` / `layoutHeight` are informational — there's no
77
+ * CSS layout box to apply them to.
78
+ */
79
+ export interface PaintResult {
80
+ layoutWidth: number;
81
+ layoutHeight: number;
82
+ pixelWidth: number;
83
+ pixelHeight: number;
84
+ }
85
+
86
+
16
87
  export interface Artifact {
17
88
  format: OutputFormat;
18
89
  bytes: Uint8Array;
@@ -355,6 +426,15 @@ export class Quill {
355
426
  * immutable once constructed.
356
427
  */
357
428
  readonly metadata: any;
429
+ /**
430
+ * Whether this quill's backend supports canvas preview.
431
+ *
432
+ * `true` iff `RenderSession.paint` and `RenderSession.pageSize` will
433
+ * succeed for sessions opened by this quill. Use this as a precondition
434
+ * probe before mounting a canvas-based preview UI; the throw on `paint`
435
+ * remains the enforcement contract.
436
+ */
437
+ readonly supportsCanvas: boolean;
358
438
  }
359
439
 
360
440
  /**
@@ -378,18 +458,117 @@ export class Quillmark {
378
458
  quill(tree: Map<string, Uint8Array>): Quill;
379
459
  }
380
460
 
461
+ /**
462
+ * An iterative render handle backed by an immutable compiled snapshot.
463
+ *
464
+ * Created via [`Quill::open`]. Holds the compiled output so that
465
+ * [`RenderSession::render`], [`RenderSession::paint`], and
466
+ * [`RenderSession::page_size`] can be called repeatedly without
467
+ * recompiling.
468
+ *
469
+ * **Empty documents.** A document that compiles to zero pages still
470
+ * produces a valid session (`pageCount === 0`). Iterating
471
+ * `0..pageCount` is then a no-op; calling `paint(ctx, 0)` or
472
+ * `pageSize(0)` throws `"... page index 0 out of range
473
+ * (pageCount=0)"`. Hosts that surface "no pages to preview" UI should
474
+ * branch on `pageCount === 0` rather than on a thrown error.
475
+ */
381
476
  export class RenderSession {
382
477
  private constructor();
383
478
  free(): void;
384
479
  [Symbol.dispose](): void;
480
+ /**
481
+ * Page dimensions in Typst points (1 pt = 1/72 inch).
482
+ *
483
+ * Report-only: the painter sizes the canvas itself based on
484
+ * `PaintOptions`. Exposed for consumers that need page geometry
485
+ * up-front (e.g. to lay out a scrollable list of canvases before
486
+ * any pixels are rendered).
487
+ *
488
+ * Stable for a given `page` across the session's lifetime — the
489
+ * compiled document is an immutable snapshot, so callers can cache
490
+ * results.
491
+ *
492
+ * Throws if the underlying backend has no canvas painter (i.e. is not
493
+ * the Typst backend) or if `page` is out of range.
494
+ */
495
+ pageSize(page: number): PageSize;
496
+ /**
497
+ * Paint `page` into a 2D canvas context.
498
+ *
499
+ * Accepts either a `CanvasRenderingContext2D` (main thread) or an
500
+ * `OffscreenCanvasRenderingContext2D` (Worker / off-DOM rasterization).
501
+ * Both dispatch to the same Rust rasterizer; the dispatch happens at
502
+ * the JS boundary so neither context type is privileged.
503
+ *
504
+ * The painter owns `canvas.width` / `canvas.height` and writes them
505
+ * itself; consumers must not. The painter does not touch
506
+ * `canvas.style.*` — that's layout, owned by the consumer (see
507
+ * `PaintResult.layoutWidth` / `layoutHeight`).
508
+ *
509
+ * `opts.layoutScale` (default 1.0) is layout-space pixels per Typst
510
+ * point and determines the canvas's display-box size. `opts.densityScale`
511
+ * (default 1.0) is the rasterization density multiplier the consumer
512
+ * folds `window.devicePixelRatio`, in-app zoom, and
513
+ * `visualViewport.scale` (pinch-zoom) into. The effective
514
+ * rasterization scale is `layoutScale * densityScale`.
515
+ *
516
+ * If `layoutScale * densityScale` would exceed the safe backing-store
517
+ * maximum (16384 px per side), `densityScale` is clamped
518
+ * proportionally so the largest dimension fits. The actual
519
+ * backing-store dimensions are reported in the returned
520
+ * `PaintResult` — compare against
521
+ * `round(layoutWidth * densityScale)` to detect clamping.
522
+ *
523
+ * Each call resets the backing store (`paint` is always a full
524
+ * repaint). Consumers do not need to call `clearRect`.
525
+ *
526
+ * Throws when:
527
+ * - the backend does not support canvas preview (message includes the
528
+ * resolved `backendId`),
529
+ * - `page` is out of range,
530
+ * - `ctx` is neither `CanvasRenderingContext2D` nor
531
+ * `OffscreenCanvasRenderingContext2D`,
532
+ * - `opts.layoutScale` or `opts.densityScale` is non-finite or `<= 0`.
533
+ */
534
+ paint(ctx: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D, page: number, opts: PaintOptions | undefined): PaintResult;
385
535
  /**
386
536
  * Render all or selected pages from this session.
387
537
  */
388
538
  render(opts?: RenderOptions | null): RenderResult;
539
+ /**
540
+ * The backend that produced this session (e.g. `"typst"`).
541
+ *
542
+ * Equal to the `backendId` of the [`Quill`] that opened this session
543
+ * (sessions inherit their quill's backend), so checking either is fine.
544
+ */
545
+ readonly backendId: string;
389
546
  /**
390
547
  * Number of pages in this render session.
548
+ *
549
+ * Stable for the lifetime of the session — the underlying compiled
550
+ * document is an immutable snapshot.
391
551
  */
392
552
  readonly pageCount: number;
553
+ /**
554
+ * Whether this session's backend supports canvas preview.
555
+ *
556
+ * `true` iff [`paint`](Self::paint) and [`page_size`](Self::page_size)
557
+ * will succeed. Equal to `Quill.supportsCanvas` for the quill that
558
+ * opened this session.
559
+ */
560
+ readonly supportsCanvas: boolean;
561
+ /**
562
+ * Session-level warnings attached at `quill.open(...)` time.
563
+ *
564
+ * Snapshot of any non-fatal diagnostics emitted while opening the
565
+ * session (e.g. version compatibility shims). Stable across the
566
+ * session's lifetime. These are also appended to
567
+ * [`RenderResult.warnings`] on every `render()` call; the accessor
568
+ * surfaces them to canvas-preview consumers that don't go through
569
+ * `render()`.
570
+ */
571
+ readonly warnings: Diagnostic[];
393
572
  }
394
573
 
395
574
  /**
@@ -685,6 +685,19 @@ export class Quill {
685
685
  wasm.__wbindgen_add_to_stack_pointer(16);
686
686
  }
687
687
  }
688
+ /**
689
+ * Whether this quill's backend supports canvas preview.
690
+ *
691
+ * `true` iff `RenderSession.paint` and `RenderSession.pageSize` will
692
+ * succeed for sessions opened by this quill. Use this as a precondition
693
+ * probe before mounting a canvas-based preview UI; the throw on `paint`
694
+ * remains the enforcement contract.
695
+ * @returns {boolean}
696
+ */
697
+ get supportsCanvas() {
698
+ const ret = wasm.quill_supportsCanvas(this.__wbg_ptr);
699
+ return ret !== 0;
700
+ }
688
701
  }
689
702
  if (Symbol.dispose) Quill.prototype[Symbol.dispose] = Quill.prototype.free;
690
703
 
@@ -739,6 +752,21 @@ export class Quillmark {
739
752
  }
740
753
  if (Symbol.dispose) Quillmark.prototype[Symbol.dispose] = Quillmark.prototype.free;
741
754
 
755
+ /**
756
+ * An iterative render handle backed by an immutable compiled snapshot.
757
+ *
758
+ * Created via [`Quill::open`]. Holds the compiled output so that
759
+ * [`RenderSession::render`], [`RenderSession::paint`], and
760
+ * [`RenderSession::page_size`] can be called repeatedly without
761
+ * recompiling.
762
+ *
763
+ * **Empty documents.** A document that compiles to zero pages still
764
+ * produces a valid session (`pageCount === 0`). Iterating
765
+ * `0..pageCount` is then a no-op; calling `paint(ctx, 0)` or
766
+ * `pageSize(0)` throws `"... page index 0 out of range
767
+ * (pageCount=0)"`. Hosts that surface "no pages to preview" UI should
768
+ * branch on `pageCount === 0` rather than on a thrown error.
769
+ */
742
770
  export class RenderSession {
743
771
  static __wrap(ptr) {
744
772
  ptr = ptr >>> 0;
@@ -757,14 +785,129 @@ export class RenderSession {
757
785
  const ptr = this.__destroy_into_raw();
758
786
  wasm.__wbg_rendersession_free(ptr, 0);
759
787
  }
788
+ /**
789
+ * The backend that produced this session (e.g. `"typst"`).
790
+ *
791
+ * Equal to the `backendId` of the [`Quill`] that opened this session
792
+ * (sessions inherit their quill's backend), so checking either is fine.
793
+ * @returns {string}
794
+ */
795
+ get backendId() {
796
+ let deferred1_0;
797
+ let deferred1_1;
798
+ try {
799
+ const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
800
+ wasm.rendersession_backendId(retptr, this.__wbg_ptr);
801
+ var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
802
+ var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
803
+ deferred1_0 = r0;
804
+ deferred1_1 = r1;
805
+ return getStringFromWasm0(r0, r1);
806
+ } finally {
807
+ wasm.__wbindgen_add_to_stack_pointer(16);
808
+ wasm.__wbindgen_export4(deferred1_0, deferred1_1, 1);
809
+ }
810
+ }
760
811
  /**
761
812
  * Number of pages in this render session.
813
+ *
814
+ * Stable for the lifetime of the session — the underlying compiled
815
+ * document is an immutable snapshot.
762
816
  * @returns {number}
763
817
  */
764
818
  get pageCount() {
765
819
  const ret = wasm.rendersession_pageCount(this.__wbg_ptr);
766
820
  return ret >>> 0;
767
821
  }
822
+ /**
823
+ * Page dimensions in Typst points (1 pt = 1/72 inch).
824
+ *
825
+ * Report-only: the painter sizes the canvas itself based on
826
+ * `PaintOptions`. Exposed for consumers that need page geometry
827
+ * up-front (e.g. to lay out a scrollable list of canvases before
828
+ * any pixels are rendered).
829
+ *
830
+ * Stable for a given `page` across the session's lifetime — the
831
+ * compiled document is an immutable snapshot, so callers can cache
832
+ * results.
833
+ *
834
+ * Throws if the underlying backend has no canvas painter (i.e. is not
835
+ * the Typst backend) or if `page` is out of range.
836
+ * @param {number} page
837
+ * @returns {PageSize}
838
+ */
839
+ pageSize(page) {
840
+ try {
841
+ const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
842
+ wasm.rendersession_pageSize(retptr, this.__wbg_ptr, page);
843
+ var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
844
+ var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
845
+ var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
846
+ if (r2) {
847
+ throw takeObject(r1);
848
+ }
849
+ return takeObject(r0);
850
+ } finally {
851
+ wasm.__wbindgen_add_to_stack_pointer(16);
852
+ }
853
+ }
854
+ /**
855
+ * Paint `page` into a 2D canvas context.
856
+ *
857
+ * Accepts either a `CanvasRenderingContext2D` (main thread) or an
858
+ * `OffscreenCanvasRenderingContext2D` (Worker / off-DOM rasterization).
859
+ * Both dispatch to the same Rust rasterizer; the dispatch happens at
860
+ * the JS boundary so neither context type is privileged.
861
+ *
862
+ * The painter owns `canvas.width` / `canvas.height` and writes them
863
+ * itself; consumers must not. The painter does not touch
864
+ * `canvas.style.*` — that's layout, owned by the consumer (see
865
+ * `PaintResult.layoutWidth` / `layoutHeight`).
866
+ *
867
+ * `opts.layoutScale` (default 1.0) is layout-space pixels per Typst
868
+ * point and determines the canvas's display-box size. `opts.densityScale`
869
+ * (default 1.0) is the rasterization density multiplier the consumer
870
+ * folds `window.devicePixelRatio`, in-app zoom, and
871
+ * `visualViewport.scale` (pinch-zoom) into. The effective
872
+ * rasterization scale is `layoutScale * densityScale`.
873
+ *
874
+ * If `layoutScale * densityScale` would exceed the safe backing-store
875
+ * maximum (16384 px per side), `densityScale` is clamped
876
+ * proportionally so the largest dimension fits. The actual
877
+ * backing-store dimensions are reported in the returned
878
+ * `PaintResult` — compare against
879
+ * `round(layoutWidth * densityScale)` to detect clamping.
880
+ *
881
+ * Each call resets the backing store (`paint` is always a full
882
+ * repaint). Consumers do not need to call `clearRect`.
883
+ *
884
+ * Throws when:
885
+ * - the backend does not support canvas preview (message includes the
886
+ * resolved `backendId`),
887
+ * - `page` is out of range,
888
+ * - `ctx` is neither `CanvasRenderingContext2D` nor
889
+ * `OffscreenCanvasRenderingContext2D`,
890
+ * - `opts.layoutScale` or `opts.densityScale` is non-finite or `<= 0`.
891
+ * @param {CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D} ctx
892
+ * @param {number} page
893
+ * @param {PaintOptions | undefined} opts
894
+ * @returns {PaintResult}
895
+ */
896
+ paint(ctx, page, opts) {
897
+ try {
898
+ const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
899
+ wasm.rendersession_paint(retptr, this.__wbg_ptr, addHeapObject(ctx), page, addHeapObject(opts));
900
+ var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
901
+ var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
902
+ var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
903
+ if (r2) {
904
+ throw takeObject(r1);
905
+ }
906
+ return takeObject(r0);
907
+ } finally {
908
+ wasm.__wbindgen_add_to_stack_pointer(16);
909
+ }
910
+ }
768
911
  /**
769
912
  * Render all or selected pages from this session.
770
913
  * @param {RenderOptions | null} [opts]
@@ -785,6 +928,33 @@ export class RenderSession {
785
928
  wasm.__wbindgen_add_to_stack_pointer(16);
786
929
  }
787
930
  }
931
+ /**
932
+ * Whether this session's backend supports canvas preview.
933
+ *
934
+ * `true` iff [`paint`](Self::paint) and [`page_size`](Self::page_size)
935
+ * will succeed. Equal to `Quill.supportsCanvas` for the quill that
936
+ * opened this session.
937
+ * @returns {boolean}
938
+ */
939
+ get supportsCanvas() {
940
+ const ret = wasm.rendersession_supportsCanvas(this.__wbg_ptr);
941
+ return ret !== 0;
942
+ }
943
+ /**
944
+ * Session-level warnings attached at `quill.open(...)` time.
945
+ *
946
+ * Snapshot of any non-fatal diagnostics emitted while opening the
947
+ * session (e.g. version compatibility shims). Stable across the
948
+ * session's lifetime. These are also appended to
949
+ * [`RenderResult.warnings`] on every `render()` call; the accessor
950
+ * surfaces them to canvas-preview consumers that don't go through
951
+ * `render()`.
952
+ * @returns {Diagnostic[]}
953
+ */
954
+ get warnings() {
955
+ const ret = wasm.rendersession_warnings(this.__wbg_ptr);
956
+ return takeObject(ret);
957
+ }
788
958
  }
789
959
  if (Symbol.dispose) RenderSession.prototype[Symbol.dispose] = RenderSession.prototype.free;
790
960
 
@@ -892,6 +1062,14 @@ export function __wbg_call_14b169f759b26747() { return handleError(function (arg
892
1062
  const ret = getObject(arg0).call(getObject(arg1));
893
1063
  return addHeapObject(ret);
894
1064
  }, arguments); }
1065
+ export function __wbg_canvas_2c0c6d263d4c52ad(arg0) {
1066
+ const ret = getObject(arg0).canvas;
1067
+ return isLikeNone(ret) ? 0 : addHeapObject(ret);
1068
+ }
1069
+ export function __wbg_canvas_374da9f3c5b3dd0e(arg0) {
1070
+ const ret = getObject(arg0).canvas;
1071
+ return addHeapObject(ret);
1072
+ }
895
1073
  export function __wbg_done_9158f7cc8751ba32(arg0) {
896
1074
  const ret = getObject(arg0).done;
897
1075
  return ret;
@@ -968,6 +1146,16 @@ export function __wbg_instanceof_ArrayBuffer_7c8433c6ed14ffe3(arg0) {
968
1146
  const ret = result;
969
1147
  return ret;
970
1148
  }
1149
+ export function __wbg_instanceof_CanvasRenderingContext2d_24a3fe06e62b98d7(arg0) {
1150
+ let result;
1151
+ try {
1152
+ result = getObject(arg0) instanceof CanvasRenderingContext2D;
1153
+ } catch (_) {
1154
+ result = false;
1155
+ }
1156
+ const ret = result;
1157
+ return ret;
1158
+ }
971
1159
  export function __wbg_instanceof_Map_1b76fd4635be43eb(arg0) {
972
1160
  let result;
973
1161
  try {
@@ -978,6 +1166,16 @@ export function __wbg_instanceof_Map_1b76fd4635be43eb(arg0) {
978
1166
  const ret = result;
979
1167
  return ret;
980
1168
  }
1169
+ export function __wbg_instanceof_OffscreenCanvasRenderingContext2d_285a274020b4f230(arg0) {
1170
+ let result;
1171
+ try {
1172
+ result = getObject(arg0) instanceof OffscreenCanvasRenderingContext2D;
1173
+ } catch (_) {
1174
+ result = false;
1175
+ }
1176
+ const ret = result;
1177
+ return ret;
1178
+ }
981
1179
  export function __wbg_instanceof_Uint8Array_152ba1f289edcf3f(arg0) {
982
1180
  let result;
983
1181
  try {
@@ -1040,6 +1238,10 @@ export function __wbg_new_aa8d0fa9762c29bd() {
1040
1238
  const ret = new Object();
1041
1239
  return addHeapObject(ret);
1042
1240
  }
1241
+ export function __wbg_new_with_u8_clamped_array_and_sh_fe957411824b5158() { return handleError(function (arg0, arg1, arg2, arg3) {
1242
+ const ret = new ImageData(getClampedArrayU8FromWasm0(arg0, arg1), arg2 >>> 0, arg3 >>> 0);
1243
+ return addHeapObject(ret);
1244
+ }, arguments); }
1043
1245
  export function __wbg_next_0340c4ae324393c3() { return handleError(function (arg0) {
1044
1246
  const ret = getObject(arg0).next();
1045
1247
  return addHeapObject(ret);
@@ -1055,6 +1257,12 @@ export function __wbg_now_a9b7df1cbee90986() {
1055
1257
  export function __wbg_prototypesetcall_a6b02eb00b0f4ce2(arg0, arg1, arg2) {
1056
1258
  Uint8Array.prototype.set.call(getArrayU8FromWasm0(arg0, arg1), getObject(arg2));
1057
1259
  }
1260
+ export function __wbg_putImageData_c810e62ea70e761d() { return handleError(function (arg0, arg1, arg2, arg3) {
1261
+ getObject(arg0).putImageData(getObject(arg1), arg2, arg3);
1262
+ }, arguments); }
1263
+ export function __wbg_putImageData_cb4de9afd58963be() { return handleError(function (arg0, arg1, arg2, arg3) {
1264
+ getObject(arg0).putImageData(getObject(arg1), arg2, arg3);
1265
+ }, arguments); }
1058
1266
  export function __wbg_set_022bee52d0b05b19() { return handleError(function (arg0, arg1, arg2) {
1059
1267
  const ret = Reflect.set(getObject(arg0), getObject(arg1), getObject(arg2));
1060
1268
  return ret;
@@ -1072,6 +1280,18 @@ export function __wbg_set_fde2cec06c23692b(arg0, arg1, arg2) {
1072
1280
  const ret = getObject(arg0).set(getObject(arg1), getObject(arg2));
1073
1281
  return addHeapObject(ret);
1074
1282
  }
1283
+ export function __wbg_set_height_24d07d982f176ac6(arg0, arg1) {
1284
+ getObject(arg0).height = arg1 >>> 0;
1285
+ }
1286
+ export function __wbg_set_height_be9b2b920bd68401(arg0, arg1) {
1287
+ getObject(arg0).height = arg1 >>> 0;
1288
+ }
1289
+ export function __wbg_set_width_5cda41d4d06a14dd(arg0, arg1) {
1290
+ getObject(arg0).width = arg1 >>> 0;
1291
+ }
1292
+ export function __wbg_set_width_adc925bca9c5351a(arg0, arg1) {
1293
+ getObject(arg0).width = arg1 >>> 0;
1294
+ }
1075
1295
  export function __wbg_stack_3b0d974bbf31e44f(arg0, arg1) {
1076
1296
  const ret = getObject(arg1).stack;
1077
1297
  const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_export, wasm.__wbindgen_export2);
@@ -1219,6 +1439,11 @@ function getArrayU8FromWasm0(ptr, len) {
1219
1439
  return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
1220
1440
  }
1221
1441
 
1442
+ function getClampedArrayU8FromWasm0(ptr, len) {
1443
+ ptr = ptr >>> 0;
1444
+ return getUint8ClampedArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
1445
+ }
1446
+
1222
1447
  let cachedDataViewMemory0 = null;
1223
1448
  function getDataViewMemory0() {
1224
1449
  if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
@@ -1240,6 +1465,14 @@ function getUint8ArrayMemory0() {
1240
1465
  return cachedUint8ArrayMemory0;
1241
1466
  }
1242
1467
 
1468
+ let cachedUint8ClampedArrayMemory0 = null;
1469
+ function getUint8ClampedArrayMemory0() {
1470
+ if (cachedUint8ClampedArrayMemory0 === null || cachedUint8ClampedArrayMemory0.byteLength === 0) {
1471
+ cachedUint8ClampedArrayMemory0 = new Uint8ClampedArray(wasm.memory.buffer);
1472
+ }
1473
+ return cachedUint8ClampedArrayMemory0;
1474
+ }
1475
+
1243
1476
  function getObject(idx) { return heap[idx]; }
1244
1477
 
1245
1478
  function handleError(f, args) {
Binary file
@@ -35,10 +35,16 @@ export const quill_form: (a: number, b: number, c: number) => void;
35
35
  export const quill_metadata: (a: number) => number;
36
36
  export const quill_open: (a: number, b: number, c: number) => void;
37
37
  export const quill_render: (a: number, b: number, c: number, d: number) => void;
38
+ export const quill_supportsCanvas: (a: number) => number;
38
39
  export const quillmark_new: () => number;
39
40
  export const quillmark_quill: (a: number, b: number, c: number) => void;
41
+ export const rendersession_backendId: (a: number, b: number) => void;
40
42
  export const rendersession_pageCount: (a: number) => number;
43
+ export const rendersession_pageSize: (a: number, b: number, c: number) => void;
44
+ export const rendersession_paint: (a: number, b: number, c: number, d: number, e: number) => void;
41
45
  export const rendersession_render: (a: number, b: number, c: number) => void;
46
+ export const rendersession_supportsCanvas: (a: number) => number;
47
+ export const rendersession_warnings: (a: number) => number;
42
48
  export const lut_inverse_interp16: (a: number, b: number, c: number) => number;
43
49
  export const qcms_profile_precache_output_transform: (a: number) => void;
44
50
  export const qcms_white_point_sRGB: (a: number) => void;
@@ -13,6 +13,77 @@ export interface CardInput {
13
13
  }
14
14
 
15
15
 
16
+
17
+ /**
18
+ * Page dimensions in Typst points (1 pt = 1/72 inch).
19
+ *
20
+ * Report-only: the painter sizes the canvas itself based on
21
+ * `PaintOptions`. `pageSize` is exposed for callers that need page
22
+ * geometry up-front (e.g. to lay out a scrollable list of canvases
23
+ * before any pixels are rendered).
24
+ */
25
+ export interface PageSize {
26
+ widthPt: number;
27
+ heightPt: number;
28
+ }
29
+
30
+ /**
31
+ * Inputs to `RenderSession.paint`. Both fields are optional and default
32
+ * to `1`.
33
+ *
34
+ * - `layoutScale` — layout-space pixels per Typst point. For on-screen
35
+ * canvases this is CSS pixels per pt; the page's layout-pixel size is
36
+ * `widthPt * layoutScale × heightPt * layoutScale`. The painter
37
+ * surfaces these dimensions as `layoutWidth` / `layoutHeight` so
38
+ * consumers can drive `canvas.style.*` (or any layout system).
39
+ * - `densityScale` — backing-store density multiplier. Fold
40
+ * `window.devicePixelRatio`, in-app zoom, and `visualViewport.scale`
41
+ * (pinch-zoom) into a single value here. Defaults to `1`, which
42
+ * produces a non-retina backing store — pass `window.devicePixelRatio`
43
+ * for crisp output on high-DPI displays.
44
+ *
45
+ * The effective rasterization scale is `layoutScale * densityScale`.
46
+ * Both must be finite and `> 0`. For `OffscreenCanvasRenderingContext2D`
47
+ * the two collapse to a single scalar; folding everything into
48
+ * `densityScale` is the simplest convention.
49
+ */
50
+ export interface PaintOptions {
51
+ layoutScale?: number;
52
+ densityScale?: number;
53
+ }
54
+
55
+ /**
56
+ * Returned by `RenderSession.paint`.
57
+ *
58
+ * - `layoutWidth` / `layoutHeight` — layout-pixel dimensions of the
59
+ * canvas's display box. For on-screen canvases this is CSS pixels:
60
+ * set `canvas.style.width = layoutWidth + "px"` and
61
+ * `canvas.style.height = layoutHeight + "px"` (or feed these into
62
+ * your layout system). Independent of `densityScale`.
63
+ * - `pixelWidth` / `pixelHeight` — integer backing-store pixel
64
+ * dimensions the painter wrote to `canvas.width` / `canvas.height`.
65
+ * Equal to `round(layoutWidth * densityScale)` ×
66
+ * `round(layoutHeight * densityScale)` *unless* the requested backing
67
+ * exceeded the painter's safe maximum (16384 px per side), in which
68
+ * case `densityScale` was clamped to fit. Detect clamping via
69
+ * `pixelWidth < round(layoutWidth * densityScale)`.
70
+ *
71
+ * The painter owns `canvas.width` / `canvas.height`; consumers must not
72
+ * write to them. The painter does **not** touch `canvas.style.*`;
73
+ * consumers own layout.
74
+ *
75
+ * For `OffscreenCanvasRenderingContext2D` (Worker rasterization, no
76
+ * DOM), `layoutWidth` / `layoutHeight` are informational — there's no
77
+ * CSS layout box to apply them to.
78
+ */
79
+ export interface PaintResult {
80
+ layoutWidth: number;
81
+ layoutHeight: number;
82
+ pixelWidth: number;
83
+ pixelHeight: number;
84
+ }
85
+
86
+
16
87
  export interface Artifact {
17
88
  format: OutputFormat;
18
89
  bytes: Uint8Array;
@@ -355,6 +426,15 @@ export class Quill {
355
426
  * immutable once constructed.
356
427
  */
357
428
  readonly metadata: any;
429
+ /**
430
+ * Whether this quill's backend supports canvas preview.
431
+ *
432
+ * `true` iff `RenderSession.paint` and `RenderSession.pageSize` will
433
+ * succeed for sessions opened by this quill. Use this as a precondition
434
+ * probe before mounting a canvas-based preview UI; the throw on `paint`
435
+ * remains the enforcement contract.
436
+ */
437
+ readonly supportsCanvas: boolean;
358
438
  }
359
439
 
360
440
  /**
@@ -378,18 +458,117 @@ export class Quillmark {
378
458
  quill(tree: Map<string, Uint8Array>): Quill;
379
459
  }
380
460
 
461
+ /**
462
+ * An iterative render handle backed by an immutable compiled snapshot.
463
+ *
464
+ * Created via [`Quill::open`]. Holds the compiled output so that
465
+ * [`RenderSession::render`], [`RenderSession::paint`], and
466
+ * [`RenderSession::page_size`] can be called repeatedly without
467
+ * recompiling.
468
+ *
469
+ * **Empty documents.** A document that compiles to zero pages still
470
+ * produces a valid session (`pageCount === 0`). Iterating
471
+ * `0..pageCount` is then a no-op; calling `paint(ctx, 0)` or
472
+ * `pageSize(0)` throws `"... page index 0 out of range
473
+ * (pageCount=0)"`. Hosts that surface "no pages to preview" UI should
474
+ * branch on `pageCount === 0` rather than on a thrown error.
475
+ */
381
476
  export class RenderSession {
382
477
  private constructor();
383
478
  free(): void;
384
479
  [Symbol.dispose](): void;
480
+ /**
481
+ * Page dimensions in Typst points (1 pt = 1/72 inch).
482
+ *
483
+ * Report-only: the painter sizes the canvas itself based on
484
+ * `PaintOptions`. Exposed for consumers that need page geometry
485
+ * up-front (e.g. to lay out a scrollable list of canvases before
486
+ * any pixels are rendered).
487
+ *
488
+ * Stable for a given `page` across the session's lifetime — the
489
+ * compiled document is an immutable snapshot, so callers can cache
490
+ * results.
491
+ *
492
+ * Throws if the underlying backend has no canvas painter (i.e. is not
493
+ * the Typst backend) or if `page` is out of range.
494
+ */
495
+ pageSize(page: number): PageSize;
496
+ /**
497
+ * Paint `page` into a 2D canvas context.
498
+ *
499
+ * Accepts either a `CanvasRenderingContext2D` (main thread) or an
500
+ * `OffscreenCanvasRenderingContext2D` (Worker / off-DOM rasterization).
501
+ * Both dispatch to the same Rust rasterizer; the dispatch happens at
502
+ * the JS boundary so neither context type is privileged.
503
+ *
504
+ * The painter owns `canvas.width` / `canvas.height` and writes them
505
+ * itself; consumers must not. The painter does not touch
506
+ * `canvas.style.*` — that's layout, owned by the consumer (see
507
+ * `PaintResult.layoutWidth` / `layoutHeight`).
508
+ *
509
+ * `opts.layoutScale` (default 1.0) is layout-space pixels per Typst
510
+ * point and determines the canvas's display-box size. `opts.densityScale`
511
+ * (default 1.0) is the rasterization density multiplier the consumer
512
+ * folds `window.devicePixelRatio`, in-app zoom, and
513
+ * `visualViewport.scale` (pinch-zoom) into. The effective
514
+ * rasterization scale is `layoutScale * densityScale`.
515
+ *
516
+ * If `layoutScale * densityScale` would exceed the safe backing-store
517
+ * maximum (16384 px per side), `densityScale` is clamped
518
+ * proportionally so the largest dimension fits. The actual
519
+ * backing-store dimensions are reported in the returned
520
+ * `PaintResult` — compare against
521
+ * `round(layoutWidth * densityScale)` to detect clamping.
522
+ *
523
+ * Each call resets the backing store (`paint` is always a full
524
+ * repaint). Consumers do not need to call `clearRect`.
525
+ *
526
+ * Throws when:
527
+ * - the backend does not support canvas preview (message includes the
528
+ * resolved `backendId`),
529
+ * - `page` is out of range,
530
+ * - `ctx` is neither `CanvasRenderingContext2D` nor
531
+ * `OffscreenCanvasRenderingContext2D`,
532
+ * - `opts.layoutScale` or `opts.densityScale` is non-finite or `<= 0`.
533
+ */
534
+ paint(ctx: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D, page: number, opts: PaintOptions | undefined): PaintResult;
385
535
  /**
386
536
  * Render all or selected pages from this session.
387
537
  */
388
538
  render(opts?: RenderOptions | null): RenderResult;
539
+ /**
540
+ * The backend that produced this session (e.g. `"typst"`).
541
+ *
542
+ * Equal to the `backendId` of the [`Quill`] that opened this session
543
+ * (sessions inherit their quill's backend), so checking either is fine.
544
+ */
545
+ readonly backendId: string;
389
546
  /**
390
547
  * Number of pages in this render session.
548
+ *
549
+ * Stable for the lifetime of the session — the underlying compiled
550
+ * document is an immutable snapshot.
391
551
  */
392
552
  readonly pageCount: number;
553
+ /**
554
+ * Whether this session's backend supports canvas preview.
555
+ *
556
+ * `true` iff [`paint`](Self::paint) and [`page_size`](Self::page_size)
557
+ * will succeed. Equal to `Quill.supportsCanvas` for the quill that
558
+ * opened this session.
559
+ */
560
+ readonly supportsCanvas: boolean;
561
+ /**
562
+ * Session-level warnings attached at `quill.open(...)` time.
563
+ *
564
+ * Snapshot of any non-fatal diagnostics emitted while opening the
565
+ * session (e.g. version compatibility shims). Stable across the
566
+ * session's lifetime. These are also appended to
567
+ * [`RenderResult.warnings`] on every `render()` call; the accessor
568
+ * surfaces them to canvas-preview consumers that don't go through
569
+ * `render()`.
570
+ */
571
+ readonly warnings: Diagnostic[];
393
572
  }
394
573
 
395
574
  /**
package/node-esm/wasm.js CHANGED
@@ -689,6 +689,19 @@ export class Quill {
689
689
  wasm.__wbindgen_add_to_stack_pointer(16);
690
690
  }
691
691
  }
692
+ /**
693
+ * Whether this quill's backend supports canvas preview.
694
+ *
695
+ * `true` iff `RenderSession.paint` and `RenderSession.pageSize` will
696
+ * succeed for sessions opened by this quill. Use this as a precondition
697
+ * probe before mounting a canvas-based preview UI; the throw on `paint`
698
+ * remains the enforcement contract.
699
+ * @returns {boolean}
700
+ */
701
+ get supportsCanvas() {
702
+ const ret = wasm.quill_supportsCanvas(this.__wbg_ptr);
703
+ return ret !== 0;
704
+ }
692
705
  }
693
706
  if (Symbol.dispose) Quill.prototype[Symbol.dispose] = Quill.prototype.free;
694
707
 
@@ -743,6 +756,21 @@ export class Quillmark {
743
756
  }
744
757
  if (Symbol.dispose) Quillmark.prototype[Symbol.dispose] = Quillmark.prototype.free;
745
758
 
759
+ /**
760
+ * An iterative render handle backed by an immutable compiled snapshot.
761
+ *
762
+ * Created via [`Quill::open`]. Holds the compiled output so that
763
+ * [`RenderSession::render`], [`RenderSession::paint`], and
764
+ * [`RenderSession::page_size`] can be called repeatedly without
765
+ * recompiling.
766
+ *
767
+ * **Empty documents.** A document that compiles to zero pages still
768
+ * produces a valid session (`pageCount === 0`). Iterating
769
+ * `0..pageCount` is then a no-op; calling `paint(ctx, 0)` or
770
+ * `pageSize(0)` throws `"... page index 0 out of range
771
+ * (pageCount=0)"`. Hosts that surface "no pages to preview" UI should
772
+ * branch on `pageCount === 0` rather than on a thrown error.
773
+ */
746
774
  export class RenderSession {
747
775
  static __wrap(ptr) {
748
776
  ptr = ptr >>> 0;
@@ -761,14 +789,129 @@ export class RenderSession {
761
789
  const ptr = this.__destroy_into_raw();
762
790
  wasm.__wbg_rendersession_free(ptr, 0);
763
791
  }
792
+ /**
793
+ * The backend that produced this session (e.g. `"typst"`).
794
+ *
795
+ * Equal to the `backendId` of the [`Quill`] that opened this session
796
+ * (sessions inherit their quill's backend), so checking either is fine.
797
+ * @returns {string}
798
+ */
799
+ get backendId() {
800
+ let deferred1_0;
801
+ let deferred1_1;
802
+ try {
803
+ const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
804
+ wasm.rendersession_backendId(retptr, this.__wbg_ptr);
805
+ var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
806
+ var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
807
+ deferred1_0 = r0;
808
+ deferred1_1 = r1;
809
+ return getStringFromWasm0(r0, r1);
810
+ } finally {
811
+ wasm.__wbindgen_add_to_stack_pointer(16);
812
+ wasm.__wbindgen_export4(deferred1_0, deferred1_1, 1);
813
+ }
814
+ }
764
815
  /**
765
816
  * Number of pages in this render session.
817
+ *
818
+ * Stable for the lifetime of the session — the underlying compiled
819
+ * document is an immutable snapshot.
766
820
  * @returns {number}
767
821
  */
768
822
  get pageCount() {
769
823
  const ret = wasm.rendersession_pageCount(this.__wbg_ptr);
770
824
  return ret >>> 0;
771
825
  }
826
+ /**
827
+ * Page dimensions in Typst points (1 pt = 1/72 inch).
828
+ *
829
+ * Report-only: the painter sizes the canvas itself based on
830
+ * `PaintOptions`. Exposed for consumers that need page geometry
831
+ * up-front (e.g. to lay out a scrollable list of canvases before
832
+ * any pixels are rendered).
833
+ *
834
+ * Stable for a given `page` across the session's lifetime — the
835
+ * compiled document is an immutable snapshot, so callers can cache
836
+ * results.
837
+ *
838
+ * Throws if the underlying backend has no canvas painter (i.e. is not
839
+ * the Typst backend) or if `page` is out of range.
840
+ * @param {number} page
841
+ * @returns {PageSize}
842
+ */
843
+ pageSize(page) {
844
+ try {
845
+ const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
846
+ wasm.rendersession_pageSize(retptr, this.__wbg_ptr, page);
847
+ var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
848
+ var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
849
+ var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
850
+ if (r2) {
851
+ throw takeObject(r1);
852
+ }
853
+ return takeObject(r0);
854
+ } finally {
855
+ wasm.__wbindgen_add_to_stack_pointer(16);
856
+ }
857
+ }
858
+ /**
859
+ * Paint `page` into a 2D canvas context.
860
+ *
861
+ * Accepts either a `CanvasRenderingContext2D` (main thread) or an
862
+ * `OffscreenCanvasRenderingContext2D` (Worker / off-DOM rasterization).
863
+ * Both dispatch to the same Rust rasterizer; the dispatch happens at
864
+ * the JS boundary so neither context type is privileged.
865
+ *
866
+ * The painter owns `canvas.width` / `canvas.height` and writes them
867
+ * itself; consumers must not. The painter does not touch
868
+ * `canvas.style.*` — that's layout, owned by the consumer (see
869
+ * `PaintResult.layoutWidth` / `layoutHeight`).
870
+ *
871
+ * `opts.layoutScale` (default 1.0) is layout-space pixels per Typst
872
+ * point and determines the canvas's display-box size. `opts.densityScale`
873
+ * (default 1.0) is the rasterization density multiplier the consumer
874
+ * folds `window.devicePixelRatio`, in-app zoom, and
875
+ * `visualViewport.scale` (pinch-zoom) into. The effective
876
+ * rasterization scale is `layoutScale * densityScale`.
877
+ *
878
+ * If `layoutScale * densityScale` would exceed the safe backing-store
879
+ * maximum (16384 px per side), `densityScale` is clamped
880
+ * proportionally so the largest dimension fits. The actual
881
+ * backing-store dimensions are reported in the returned
882
+ * `PaintResult` — compare against
883
+ * `round(layoutWidth * densityScale)` to detect clamping.
884
+ *
885
+ * Each call resets the backing store (`paint` is always a full
886
+ * repaint). Consumers do not need to call `clearRect`.
887
+ *
888
+ * Throws when:
889
+ * - the backend does not support canvas preview (message includes the
890
+ * resolved `backendId`),
891
+ * - `page` is out of range,
892
+ * - `ctx` is neither `CanvasRenderingContext2D` nor
893
+ * `OffscreenCanvasRenderingContext2D`,
894
+ * - `opts.layoutScale` or `opts.densityScale` is non-finite or `<= 0`.
895
+ * @param {CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D} ctx
896
+ * @param {number} page
897
+ * @param {PaintOptions | undefined} opts
898
+ * @returns {PaintResult}
899
+ */
900
+ paint(ctx, page, opts) {
901
+ try {
902
+ const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
903
+ wasm.rendersession_paint(retptr, this.__wbg_ptr, addHeapObject(ctx), page, addHeapObject(opts));
904
+ var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
905
+ var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
906
+ var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
907
+ if (r2) {
908
+ throw takeObject(r1);
909
+ }
910
+ return takeObject(r0);
911
+ } finally {
912
+ wasm.__wbindgen_add_to_stack_pointer(16);
913
+ }
914
+ }
772
915
  /**
773
916
  * Render all or selected pages from this session.
774
917
  * @param {RenderOptions | null} [opts]
@@ -789,6 +932,33 @@ export class RenderSession {
789
932
  wasm.__wbindgen_add_to_stack_pointer(16);
790
933
  }
791
934
  }
935
+ /**
936
+ * Whether this session's backend supports canvas preview.
937
+ *
938
+ * `true` iff [`paint`](Self::paint) and [`page_size`](Self::page_size)
939
+ * will succeed. Equal to `Quill.supportsCanvas` for the quill that
940
+ * opened this session.
941
+ * @returns {boolean}
942
+ */
943
+ get supportsCanvas() {
944
+ const ret = wasm.rendersession_supportsCanvas(this.__wbg_ptr);
945
+ return ret !== 0;
946
+ }
947
+ /**
948
+ * Session-level warnings attached at `quill.open(...)` time.
949
+ *
950
+ * Snapshot of any non-fatal diagnostics emitted while opening the
951
+ * session (e.g. version compatibility shims). Stable across the
952
+ * session's lifetime. These are also appended to
953
+ * [`RenderResult.warnings`] on every `render()` call; the accessor
954
+ * surfaces them to canvas-preview consumers that don't go through
955
+ * `render()`.
956
+ * @returns {Diagnostic[]}
957
+ */
958
+ get warnings() {
959
+ const ret = wasm.rendersession_warnings(this.__wbg_ptr);
960
+ return takeObject(ret);
961
+ }
792
962
  }
793
963
  if (Symbol.dispose) RenderSession.prototype[Symbol.dispose] = RenderSession.prototype.free;
794
964
 
@@ -899,6 +1069,14 @@ function __wbg_get_imports() {
899
1069
  const ret = getObject(arg0).call(getObject(arg1));
900
1070
  return addHeapObject(ret);
901
1071
  }, arguments); },
1072
+ __wbg_canvas_2c0c6d263d4c52ad: function(arg0) {
1073
+ const ret = getObject(arg0).canvas;
1074
+ return isLikeNone(ret) ? 0 : addHeapObject(ret);
1075
+ },
1076
+ __wbg_canvas_374da9f3c5b3dd0e: function(arg0) {
1077
+ const ret = getObject(arg0).canvas;
1078
+ return addHeapObject(ret);
1079
+ },
902
1080
  __wbg_done_9158f7cc8751ba32: function(arg0) {
903
1081
  const ret = getObject(arg0).done;
904
1082
  return ret;
@@ -975,6 +1153,16 @@ function __wbg_get_imports() {
975
1153
  const ret = result;
976
1154
  return ret;
977
1155
  },
1156
+ __wbg_instanceof_CanvasRenderingContext2d_24a3fe06e62b98d7: function(arg0) {
1157
+ let result;
1158
+ try {
1159
+ result = getObject(arg0) instanceof CanvasRenderingContext2D;
1160
+ } catch (_) {
1161
+ result = false;
1162
+ }
1163
+ const ret = result;
1164
+ return ret;
1165
+ },
978
1166
  __wbg_instanceof_Map_1b76fd4635be43eb: function(arg0) {
979
1167
  let result;
980
1168
  try {
@@ -985,6 +1173,16 @@ function __wbg_get_imports() {
985
1173
  const ret = result;
986
1174
  return ret;
987
1175
  },
1176
+ __wbg_instanceof_OffscreenCanvasRenderingContext2d_285a274020b4f230: function(arg0) {
1177
+ let result;
1178
+ try {
1179
+ result = getObject(arg0) instanceof OffscreenCanvasRenderingContext2D;
1180
+ } catch (_) {
1181
+ result = false;
1182
+ }
1183
+ const ret = result;
1184
+ return ret;
1185
+ },
988
1186
  __wbg_instanceof_Uint8Array_152ba1f289edcf3f: function(arg0) {
989
1187
  let result;
990
1188
  try {
@@ -1047,6 +1245,10 @@ function __wbg_get_imports() {
1047
1245
  const ret = new Object();
1048
1246
  return addHeapObject(ret);
1049
1247
  },
1248
+ __wbg_new_with_u8_clamped_array_and_sh_fe957411824b5158: function() { return handleError(function (arg0, arg1, arg2, arg3) {
1249
+ const ret = new ImageData(getClampedArrayU8FromWasm0(arg0, arg1), arg2 >>> 0, arg3 >>> 0);
1250
+ return addHeapObject(ret);
1251
+ }, arguments); },
1050
1252
  __wbg_next_0340c4ae324393c3: function() { return handleError(function (arg0) {
1051
1253
  const ret = getObject(arg0).next();
1052
1254
  return addHeapObject(ret);
@@ -1062,6 +1264,12 @@ function __wbg_get_imports() {
1062
1264
  __wbg_prototypesetcall_a6b02eb00b0f4ce2: function(arg0, arg1, arg2) {
1063
1265
  Uint8Array.prototype.set.call(getArrayU8FromWasm0(arg0, arg1), getObject(arg2));
1064
1266
  },
1267
+ __wbg_putImageData_c810e62ea70e761d: function() { return handleError(function (arg0, arg1, arg2, arg3) {
1268
+ getObject(arg0).putImageData(getObject(arg1), arg2, arg3);
1269
+ }, arguments); },
1270
+ __wbg_putImageData_cb4de9afd58963be: function() { return handleError(function (arg0, arg1, arg2, arg3) {
1271
+ getObject(arg0).putImageData(getObject(arg1), arg2, arg3);
1272
+ }, arguments); },
1065
1273
  __wbg_set_022bee52d0b05b19: function() { return handleError(function (arg0, arg1, arg2) {
1066
1274
  const ret = Reflect.set(getObject(arg0), getObject(arg1), getObject(arg2));
1067
1275
  return ret;
@@ -1079,6 +1287,18 @@ function __wbg_get_imports() {
1079
1287
  const ret = getObject(arg0).set(getObject(arg1), getObject(arg2));
1080
1288
  return addHeapObject(ret);
1081
1289
  },
1290
+ __wbg_set_height_24d07d982f176ac6: function(arg0, arg1) {
1291
+ getObject(arg0).height = arg1 >>> 0;
1292
+ },
1293
+ __wbg_set_height_be9b2b920bd68401: function(arg0, arg1) {
1294
+ getObject(arg0).height = arg1 >>> 0;
1295
+ },
1296
+ __wbg_set_width_5cda41d4d06a14dd: function(arg0, arg1) {
1297
+ getObject(arg0).width = arg1 >>> 0;
1298
+ },
1299
+ __wbg_set_width_adc925bca9c5351a: function(arg0, arg1) {
1300
+ getObject(arg0).width = arg1 >>> 0;
1301
+ },
1082
1302
  __wbg_stack_3b0d974bbf31e44f: function(arg0, arg1) {
1083
1303
  const ret = getObject(arg1).stack;
1084
1304
  const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_export, wasm.__wbindgen_export2);
@@ -1233,6 +1453,11 @@ function getArrayU8FromWasm0(ptr, len) {
1233
1453
  return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
1234
1454
  }
1235
1455
 
1456
+ function getClampedArrayU8FromWasm0(ptr, len) {
1457
+ ptr = ptr >>> 0;
1458
+ return getUint8ClampedArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
1459
+ }
1460
+
1236
1461
  let cachedDataViewMemory0 = null;
1237
1462
  function getDataViewMemory0() {
1238
1463
  if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
@@ -1254,6 +1479,14 @@ function getUint8ArrayMemory0() {
1254
1479
  return cachedUint8ArrayMemory0;
1255
1480
  }
1256
1481
 
1482
+ let cachedUint8ClampedArrayMemory0 = null;
1483
+ function getUint8ClampedArrayMemory0() {
1484
+ if (cachedUint8ClampedArrayMemory0 === null || cachedUint8ClampedArrayMemory0.byteLength === 0) {
1485
+ cachedUint8ClampedArrayMemory0 = new Uint8ClampedArray(wasm.memory.buffer);
1486
+ }
1487
+ return cachedUint8ClampedArrayMemory0;
1488
+ }
1489
+
1257
1490
  function getObject(idx) { return heap[idx]; }
1258
1491
 
1259
1492
  function handleError(f, args) {
Binary file
@@ -35,10 +35,16 @@ export const quill_form: (a: number, b: number, c: number) => void;
35
35
  export const quill_metadata: (a: number) => number;
36
36
  export const quill_open: (a: number, b: number, c: number) => void;
37
37
  export const quill_render: (a: number, b: number, c: number, d: number) => void;
38
+ export const quill_supportsCanvas: (a: number) => number;
38
39
  export const quillmark_new: () => number;
39
40
  export const quillmark_quill: (a: number, b: number, c: number) => void;
41
+ export const rendersession_backendId: (a: number, b: number) => void;
40
42
  export const rendersession_pageCount: (a: number) => number;
43
+ export const rendersession_pageSize: (a: number, b: number, c: number) => void;
44
+ export const rendersession_paint: (a: number, b: number, c: number, d: number, e: number) => void;
41
45
  export const rendersession_render: (a: number, b: number, c: number) => void;
46
+ export const rendersession_supportsCanvas: (a: number) => number;
47
+ export const rendersession_warnings: (a: number) => number;
42
48
  export const lut_inverse_interp16: (a: number, b: number, c: number) => number;
43
49
  export const qcms_profile_precache_output_transform: (a: number) => void;
44
50
  export const qcms_white_point_sRGB: (a: number) => void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quillmark/wasm",
3
- "version": "0.66.2",
3
+ "version": "0.68.0",
4
4
  "description": "WebAssembly bindings for quillmark",
5
5
  "type": "module",
6
6
  "license": "MIT OR Apache-2.0",