@vedivad/typst-web-service 0.14.4 → 0.15.1

package/dist/index.d.ts

@@ -476,6 +476,12 @@ declare class TypstProject {
 }
 
 interface TypstRendererOptions {
+    /**
+     * Explicit Worker instance. When omitted, an inlined blob worker is created
+     * automatically. Use this for Vite apps to get proper source maps:
+     *   `TypstRenderer.create({ worker: new Worker(new URL('typst-web-service/renderer-worker', import.meta.url)) })`
+     */
+    worker?: Worker;
     /** URL to the typst-ts-renderer WASM binary. Defaults to jsDelivr CDN. */
     wasmUrl?: string;
 }
@@ -490,30 +496,35 @@ interface RenderedSvgPage {
     svg: string;
 }
 /**
- * Converts Typst vector artifacts to SVG strings.
+ * Converts Typst vector artifacts to SVG strings, off the main thread.
  *
- * Thin wrapper around `@myriaddreamin/typst.ts`'s renderer: we own the public
- * API surface and WASM-URL convention; typst.ts owns the WASM session,
- * sub-page rendering, and lifecycle. See `renderer.mts` in that package for
- * the inner mechanics.
+ * Wraps `@myriaddreamin/typst.ts`'s renderer hosted in a Web Worker — the
+ * WASM init, vector → SVG conversion, and base64 image-embedding all happen
+ * off-thread. Returned SVG strings cross via Comlink; page splitting runs on
+ * the main thread (Workers don't have `DOMParser`).
  *
  *   const renderer = TypstRenderer.create();
  *   const svg = await renderer.renderSvg(vector);
  */
 declare class TypstRenderer {
     #private;
-    private readonly wasmUrl;
-    private inner;
     private constructor();
     static create(options?: TypstRendererOptions): TypstRenderer;
-    private getInner;
+    /** Terminate the worker. The instance is unusable afterwards. */
+    destroy(): void;
     /**
-     * Drop the reference to the inner renderer. The upstream wrapper doesn't
-     * expose an explicit free(); the WASM module is reclaimed when the page
-     * unloads. Consumers may still call this to release the JS-side handle.
+     * Render a Typst vector artifact to a single merged SVG string.
+     *
+     * Ownership of `vector.buffer` transfers to the worker (zero-copy).
+     * Don't reuse the vector after passing it in — accessing its bytes from
+     * the main thread after this call is undefined behavior.
+     *
+     * Concurrent calls are serialized in the worker: while a render is in
+     * flight, the most recent `vector` becomes the next render and any
+     * intermediate calls are dropped. All overlapping callers share one
+     * returned promise that resolves with the LAST rendered SVG — your
+     * specific vector may have been superseded.
      */
-    destroy(): void;
-    /** Render a Typst vector artifact to a single merged SVG string. */
     renderSvg(vector: Uint8Array): Promise<string>;
     /**
      * Render a Typst vector artifact into one self-contained SVG string per
@@ -524,43 +535,6 @@ declare class TypstRenderer {
      * the document has no page groups.
      */
     renderSvgPages(vector: Uint8Array): Promise<RenderedSvgPage[]>;
-    /**
-     * Mount an incremental canvas renderer into `root`. Each `update(vector)`
-     * call repaints the canvases in place. The win for image-heavy docs comes
-     * from the persistent WASM session: decoded image bitmaps are cached in
-     * the renderer, so subsequent paints skip the decode step. Canvas elements
-     * are recreated each update (typst.ts manages the DOM inside `root`), but
-     * canvas creation is cheap — the bottleneck the SVG path was solving was
-     * `<image>` data-URL decode, not DOM construction.
-     *
-     * Call `reset()` when switching to an unrelated document (next `update`
-     * starts fresh from the session). Call `dispose()` to free the session.
-     *
-     * Trade-off vs the SVG paths: output is rasterized — text in the rendered
-     * canvas isn't selectable, and zoom past `pixelPerPt` needs a re-render to
-     * stay crisp. typst.ts builds a `<canvas>` per page inside `root` and adds
-     * a text-semantic layer alongside it for screen readers / a11y.
-     */
-    createIncrementalCanvasRenderer(root: HTMLElement, options?: IncrementalCanvasOptions): IncrementalCanvasRenderer;
-}
-interface IncrementalCanvasOptions {
-    pixelPerPt?: number;
-    backgroundColor?: string;
-}
-interface IncrementalCanvasRenderer {
-    /**
-     * Apply a new vector and repaint. First call seeds the session.
-     *
-     * Concurrent calls are serialized: while a repaint is in flight, the most
-     * recent `update` becomes the next paint and intermediates are dropped.
-     * All overlapping callers share one returned promise that resolves when
-     * the chain catches up — your specific vector may have been superseded.
-     */
-    update(vector: Uint8Array): Promise<void>;
-    /** Force the next `update` to re-seed (use when the doc identity changes). */
-    reset(): void;
-    /** Free the WASM session. */
-    dispose(): void;
 }
 
-export { type AnalyzerUri, type CompileResult, type DiagnosticMessage, type DiagnosticRange, type FormatConfig, type FormatRangeResult, type IncrementalCanvasOptions, type IncrementalCanvasRenderer, type LspCompletionItem, type LspCompletionList, type LspCompletionResponse, type LspDiagnostic, type LspHover, type LspHoverContents, type LspMarkupContent, type LspPosition, type LspRange, type Path, type RenderedSvgPage, TypstAnalyzer, type TypstAnalyzerOptions, TypstCompiler, type TypstCompilerOptions, TypstFormatter, TypstProject, type TypstProjectOptions, TypstRenderer, type TypstRendererOptions, normalizePath, normalizeRoot, pathToAnalyzerUri };
+export { type AnalyzerUri, type CompileResult, type DiagnosticMessage, type DiagnosticRange, type FormatConfig, type FormatRangeResult, type LspCompletionItem, type LspCompletionList, type LspCompletionResponse, type LspDiagnostic, type LspHover, type LspHoverContents, type LspMarkupContent, type LspPosition, type LspRange, type Path, type RenderedSvgPage, TypstAnalyzer, type TypstAnalyzerOptions, TypstCompiler, type TypstCompilerOptions, TypstFormatter, TypstProject, type TypstProjectOptions, TypstRenderer, type TypstRendererOptions, normalizePath, normalizeRoot, pathToAnalyzerUri };