@otisk/preview 1.1.1 → 1.1.2

package/README.md

@@ -7,8 +7,9 @@ the preview shares the **same layout engine** as otisk's PDF output, so what
 you see on screen matches the print geometry pixel-for-pixel; only the
 rasteriser differs (tiny-skia here, the press RIP for the PDF).
 
-The same bundle also exposes the full `render_pdf` entry point, so you can
-generate the final PDF from the exact bytes you previewed.
+This package is **preview-only**: it renders pages to bitmaps for on-screen
+display. It does not generate PDFs — produce the final PDF/X-4 on your
+backend with the otisk engine, from the same `(html, css)` you previewed.
 
 ```
 npm i @otisk/preview
@@ -63,11 +64,6 @@ out-of-range page, or degenerate dimensions.
 
 How many pages the `(html, css)` pair lays out — for preview navigation.
 
-### `render_pdf(html, css, marginMm, assets?, outputIntent?) → Uint8Array`
-
-Render the whole document to a PDF (the production print artefact). Same
-inputs as the preview, so the PDF matches what you previewed.
-
 ### `RasterResult`
 
 | Member     | Type         | Notes                                  |

package/engine_wasm.d.ts

@@ -36,7 +36,7 @@ export class RasterResult {
  *
  * # Errors
  *
- * Same channel as [`render_pdf`].
+ * A stringified [`otisk::RenderError`] via `JsValue::from_str`.
  */
 export function page_count(html: string, css: string, margin_mm: number, assets?: any | null, output_intent?: any | null): number;
 
@@ -44,11 +44,10 @@ export function page_count(html: string, css: string, margin_mm: number, assets?
  * Issue 297 — render one page of an `(html, css)` pair to an RGBA8
  * bitmap for an HTML5-canvas print preview.
  *
- * Mirrors [`render_pdf`]'s argument shape (`html`, `css`, `margin_mm`,
- * optional `assets`, optional `output_intent`) and adds `page_index`
- * (0-based) + `scale` (pixels-per-point, `scale = dpi / 72`). The
- * returned [`RasterResult`] carries the device dimensions + the RGBA
- * buffer.
+ * Takes the same `(html, css, margin_mm, assets?, output_intent?)`
+ * inputs the engine's PDF path uses, plus `page_index` (0-based) +
+ * `scale` (pixels-per-point, `scale = dpi / 72`). The returned
+ * [`RasterResult`] carries the device dimensions + the RGBA buffer.
  *
  * Because the preview reuses the **same** layout the PDF path produces,
  * it is guaranteed to match print geometry; only the rasteriser differs
@@ -56,100 +55,11 @@ export function page_count(html: string, css: string, margin_mm: number, assets?
  *
  * # Errors
  *
- * Same channel as [`render_pdf`] (a stringified [`otisk::RenderError`]
- * via `JsValue::from_str`), plus an out-of-range `page_index` or
- * degenerate device dimensions.
+ * A stringified [`otisk::RenderError`] via `JsValue::from_str`, plus an
+ * out-of-range `page_index` or degenerate device dimensions.
  */
 export function render_page_rgba(html: string, css: string, margin_mm: number, assets: any | null | undefined, output_intent: any | null | undefined, page_index: number, scale: number): RasterResult;
 
-/**
- * Render an `(html, css)` pair to a PDF/X-4 byte buffer.
- *
- * Thin shim over [`otisk::Engine`]: builds an engine with `margin_mm`
- * applied uniformly to all four sides (see
- * [`otisk::EngineBuilder::with_margins_mm`]), then forwards to
- * [`otisk::Engine::render`] and returns [`otisk::RenderResult::bytes`].
- *
- * ## Optional asset resolver (Issue 115)
- *
- * The `assets` parameter is **optional**. wasm-bindgen surfaces it as
- * a fourth positional argument that the JS caller may omit (older
- * 3-arg call sites — `render_pdf(html, css, margin)` — keep working
- * unchanged) or pass as `null` / `undefined` for the same behaviour.
- * When `assets` is present it must be either:
- *
- * - a bare callable: `function(url: string): Uint8Array`, or
- * - an object with the spec'd shape: `{ fetch(url: string): Uint8Array }`.
- *
- * Every engine-side asset lookup (`@font-face`, `<img>`,
- * `background-image`, and — Phase 4 — `@color-profile`) is funneled
- * through that callable. If `assets.fetch` returns a non-`Uint8Array`
- * value, throws, or the method doesn't exist, the render fails with
- * [`otisk::FetchError`] surfaced through the usual
- * `JsValue`-stringified error channel.
- *
- * ### Why synchronous
- *
- * The native [`otisk::AssetResolver::fetch`] signature is synchronous
- * (`SPECIFICATION.md` §3.7); the engine never spins up an async
- * runtime to fetch an asset. Mirroring that on the JS side keeps the
- * byte-identity contract trivial — every fetch returns bytes
- * immediately, with the same byte-for-byte semantics on both sides.
- * A `Promise<Uint8Array>` arm would either (a) require an async
- * engine entry point — out of scope for this issue — or (b) demand
- * host-side blocking that the browser doesn't permit on the main
- * thread. The simpler synchronous arm is the load-bearing acceptance
- * criterion (byte-identical parity for `font_face_load`,
- * `image_embed`, `background_image`) and an async overload can ride
- * on top of it later.
- *
- * ## Optional output intent (Issue 116)
- *
- * The `output_intent` parameter is **optional**. wasm-bindgen surfaces it
- * as a fifth positional argument that the JS caller may omit (older
- * 3-arg / 4-arg call sites keep working unchanged) or pass as `null` /
- * `undefined` for the same default behaviour. When `output_intent` is
- * present it must be a UTF-8 string naming a known
- * [`otisk::ColorProfile`] variant — see [`parse_color_profile`] for the
- * accepted spellings (`"srgb"`, `"fogra39"`, `"swop_v2"`,
- * case-insensitive). An unknown string surfaces as the usual
- * `JsValue`-stringified error so the JS caller can react.
- *
- * ## Diagnostics
- *
- * Diagnostics from the render are intentionally dropped on this entry
- * point — the spec deliberately keeps the WASM surface minimal
- * (Issue 30 §"Out of scope"). A richer entry point returning
- * `{ bytes, diagnostics }` is deferred to a future issue once the
- * parity harness has a concrete need for it.
- *
- * # Errors
- *
- * On any failure inside the pipeline ([`otisk::RenderError`] — HTML/CSS
- * parse errors, layout failures, missing fonts, PDF emit errors, or
- * resource-limit breaches), any failure inside the JS-side
- * resolver, or an unrecognised `output_intent` string, the error is
- * stringified via its `Display` impl and returned as a
- * `JsValue::from_str`. JS sees a plain string error message; richer
- * error objects can land alongside the diagnostic surface later.
- *
- * # Parameters
- *
- * - `html`: the input HTML source as a UTF-8 string.
- * - `css`: the matching CSS source (currently the only style input — the
- *   engine has no `<style>` / `<link rel="stylesheet">` extraction yet).
- * - `margin_mm`: uniform page margin applied to all four sides.
- * - `assets` *(optional)*: a `{ fetch(url): Uint8Array }` object or a
- *   bare `(url) -> Uint8Array` callable; pass `null` / `undefined` /
- *   omit entirely for the empty-resolver baseline (byte-identical to
- *   the pre-Issue-115 3-arg call).
- * - `output_intent` *(optional)*: a UTF-8 string naming a known
- *   [`otisk::ColorProfile`] variant (`"srgb"`, `"fogra39"`,
- *   `"swop_v2"`); pass `null` / `undefined` / omit entirely to keep
- *   the engine's default profile ([`ColorProfile::default`] — sRGB).
- */
-export function render_pdf(html: string, css: string, margin_mm: number, assets?: any | null, output_intent?: any | null): Uint8Array;
-
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
@@ -160,7 +70,6 @@ export interface InitOutput {
     readonly rasterresult_rgba: (a: number) => [number, number];
     readonly rasterresult_width: (a: number) => number;
     readonly render_page_rgba: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => [number, number, number];
-    readonly render_pdf: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number, number];
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_exn_store: (a: number) => void;

package/engine_wasm.js

@@ -63,7 +63,7 @@ if (Symbol.dispose) RasterResult.prototype[Symbol.dispose] = RasterResult.protot
  *
  * # Errors
  *
- * Same channel as [`render_pdf`].
+ * A stringified [`otisk::RenderError`] via `JsValue::from_str`.
  * @param {string} html
  * @param {string} css
  * @param {number} margin_mm
@@ -87,11 +87,10 @@ export function page_count(html, css, margin_mm, assets, output_intent) {
  * Issue 297 — render one page of an `(html, css)` pair to an RGBA8
  * bitmap for an HTML5-canvas print preview.
  *
- * Mirrors [`render_pdf`]'s argument shape (`html`, `css`, `margin_mm`,
- * optional `assets`, optional `output_intent`) and adds `page_index`
- * (0-based) + `scale` (pixels-per-point, `scale = dpi / 72`). The
- * returned [`RasterResult`] carries the device dimensions + the RGBA
- * buffer.
+ * Takes the same `(html, css, margin_mm, assets?, output_intent?)`
+ * inputs the engine's PDF path uses, plus `page_index` (0-based) +
+ * `scale` (pixels-per-point, `scale = dpi / 72`). The returned
+ * [`RasterResult`] carries the device dimensions + the RGBA buffer.
  *
  * Because the preview reuses the **same** layout the PDF path produces,
  * it is guaranteed to match print geometry; only the rasteriser differs
@@ -99,9 +98,8 @@ export function page_count(html, css, margin_mm, assets, output_intent) {
  *
  * # Errors
  *
- * Same channel as [`render_pdf`] (a stringified [`otisk::RenderError`]
- * via `JsValue::from_str`), plus an out-of-range `page_index` or
- * degenerate device dimensions.
+ * A stringified [`otisk::RenderError`] via `JsValue::from_str`, plus an
+ * out-of-range `page_index` or degenerate device dimensions.
  * @param {string} html
  * @param {string} css
  * @param {number} margin_mm
@@ -122,112 +120,6 @@ export function render_page_rgba(html, css, margin_mm, assets, output_intent, pa
     }
     return RasterResult.__wrap(ret[0]);
 }
-
-/**
- * Render an `(html, css)` pair to a PDF/X-4 byte buffer.
- *
- * Thin shim over [`otisk::Engine`]: builds an engine with `margin_mm`
- * applied uniformly to all four sides (see
- * [`otisk::EngineBuilder::with_margins_mm`]), then forwards to
- * [`otisk::Engine::render`] and returns [`otisk::RenderResult::bytes`].
- *
- * ## Optional asset resolver (Issue 115)
- *
- * The `assets` parameter is **optional**. wasm-bindgen surfaces it as
- * a fourth positional argument that the JS caller may omit (older
- * 3-arg call sites — `render_pdf(html, css, margin)` — keep working
- * unchanged) or pass as `null` / `undefined` for the same behaviour.
- * When `assets` is present it must be either:
- *
- * - a bare callable: `function(url: string): Uint8Array`, or
- * - an object with the spec'd shape: `{ fetch(url: string): Uint8Array }`.
- *
- * Every engine-side asset lookup (`@font-face`, `<img>`,
- * `background-image`, and — Phase 4 — `@color-profile`) is funneled
- * through that callable. If `assets.fetch` returns a non-`Uint8Array`
- * value, throws, or the method doesn't exist, the render fails with
- * [`otisk::FetchError`] surfaced through the usual
- * `JsValue`-stringified error channel.
- *
- * ### Why synchronous
- *
- * The native [`otisk::AssetResolver::fetch`] signature is synchronous
- * (`SPECIFICATION.md` §3.7); the engine never spins up an async
- * runtime to fetch an asset. Mirroring that on the JS side keeps the
- * byte-identity contract trivial — every fetch returns bytes
- * immediately, with the same byte-for-byte semantics on both sides.
- * A `Promise<Uint8Array>` arm would either (a) require an async
- * engine entry point — out of scope for this issue — or (b) demand
- * host-side blocking that the browser doesn't permit on the main
- * thread. The simpler synchronous arm is the load-bearing acceptance
- * criterion (byte-identical parity for `font_face_load`,
- * `image_embed`, `background_image`) and an async overload can ride
- * on top of it later.
- *
- * ## Optional output intent (Issue 116)
- *
- * The `output_intent` parameter is **optional**. wasm-bindgen surfaces it
- * as a fifth positional argument that the JS caller may omit (older
- * 3-arg / 4-arg call sites keep working unchanged) or pass as `null` /
- * `undefined` for the same default behaviour. When `output_intent` is
- * present it must be a UTF-8 string naming a known
- * [`otisk::ColorProfile`] variant — see [`parse_color_profile`] for the
- * accepted spellings (`"srgb"`, `"fogra39"`, `"swop_v2"`,
- * case-insensitive). An unknown string surfaces as the usual
- * `JsValue`-stringified error so the JS caller can react.
- *
- * ## Diagnostics
- *
- * Diagnostics from the render are intentionally dropped on this entry
- * point — the spec deliberately keeps the WASM surface minimal
- * (Issue 30 §"Out of scope"). A richer entry point returning
- * `{ bytes, diagnostics }` is deferred to a future issue once the
- * parity harness has a concrete need for it.
- *
- * # Errors
- *
- * On any failure inside the pipeline ([`otisk::RenderError`] — HTML/CSS
- * parse errors, layout failures, missing fonts, PDF emit errors, or
- * resource-limit breaches), any failure inside the JS-side
- * resolver, or an unrecognised `output_intent` string, the error is
- * stringified via its `Display` impl and returned as a
- * `JsValue::from_str`. JS sees a plain string error message; richer
- * error objects can land alongside the diagnostic surface later.
- *
- * # Parameters
- *
- * - `html`: the input HTML source as a UTF-8 string.
- * - `css`: the matching CSS source (currently the only style input — the
- *   engine has no `<style>` / `<link rel="stylesheet">` extraction yet).
- * - `margin_mm`: uniform page margin applied to all four sides.
- * - `assets` *(optional)*: a `{ fetch(url): Uint8Array }` object or a
- *   bare `(url) -> Uint8Array` callable; pass `null` / `undefined` /
- *   omit entirely for the empty-resolver baseline (byte-identical to
- *   the pre-Issue-115 3-arg call).
- * - `output_intent` *(optional)*: a UTF-8 string naming a known
- *   [`otisk::ColorProfile`] variant (`"srgb"`, `"fogra39"`,
- *   `"swop_v2"`); pass `null` / `undefined` / omit entirely to keep
- *   the engine's default profile ([`ColorProfile::default`] — sRGB).
- * @param {string} html
- * @param {string} css
- * @param {number} margin_mm
- * @param {any | null} [assets]
- * @param {any | null} [output_intent]
- * @returns {Uint8Array}
- */
-export function render_pdf(html, css, margin_mm, assets, output_intent) {
-    const ptr0 = passStringToWasm0(html, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-    const len0 = WASM_VECTOR_LEN;
-    const ptr1 = passStringToWasm0(css, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-    const len1 = WASM_VECTOR_LEN;
-    const ret = wasm.render_pdf(ptr0, len0, ptr1, len1, margin_mm, isLikeNone(assets) ? 0 : addToExternrefTable0(assets), isLikeNone(output_intent) ? 0 : addToExternrefTable0(output_intent));
-    if (ret[3]) {
-        throw takeFromExternrefTable0(ret[2]);
-    }
-    var v3 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
-    wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
-    return v3;
-}
 function __wbg_get_imports() {
     const import0 = {
         __proto__: null,

package/package.json

@@ -2,7 +2,7 @@
   "name": "@otisk/preview",
   "type": "module",
   "description": "Raster print-preview for the otisk typesetting engine: render HTML/CSS pages to RGBA bitmaps (WASM) for an HTML5-canvas preview that matches the PDF print geometry.",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "license": "Apache-2.0",
   "files": [
     "engine_wasm_bg.wasm",