pdf2-wasm 1.0.2 → 1.0.4

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alexander Korolev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSE-UNLICENSE

@@ -0,0 +1,21 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
+software, either in source code form or as a compiled binary, for any purpose,
+commercial or non-commercial, and by any means.
+
+In jurisdictions that recognize copyright laws, the author or authors of this
+software dedicate any and all copyright interest in the software to the public
+domain. We make this dedication for the benefit of the public at large and to
+the detriment of our heirs and successors. We intend this dedication to be an
+overt act of relinquishment in perpetuity of all present and future rights to
+this software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org/>.

package/README.md

@@ -1,70 +1,76 @@
 # pdf2-wasm
 
-WebAssembly bindings for the [`pdf2`](https://crates.io/crates/pdf2) crate and
-its renderer: open a PDF 2.0 file in the browser, read its facts and paint a page.
+PDF 2.0 in the browser: open, inspect and render PDF files with the [`pdf2`]
+crate compiled to WebAssembly. No dependencies, no server, and the bytes never
+leave the page.
 
-```js
-import init, { open } from "pdf2-wasm";
-
-await init();
-const response = await fetch("sample.pdf");
-const doc = open(new Uint8Array(await response.arrayBuffer()), null);
-console.log(doc.version(), doc.pageCount(), doc.pageSize(0));
-console.log(doc.text(0));
-doc.renderPageToCanvas(0, 1.5, document.querySelector("canvas"));
+```sh
+npm install pdf2-wasm
 ```
 
-## API
+```js
+import init, { open } from 'pdf2-wasm';
 
-| Member | Description |
-| --- | --- |
-| `open(bytes, password?)` | Open a document; throws on a malformed file or a wrong password |
-| `new PdfDocument(bytes, password?)` | The same as a constructor |
-| `version()` | Header version, e.g. `"2.0"` |
-| `isEncrypted()` | Whether the file was opened with a security handler |
-| `pageCount()` | Number of pages |
-| `pageSize(index)` | `Float64Array` of `[width, height]` in PDF points |
-| `text(index)` | Extracted text of a page |
-| `metadata()` | XMP metadata packet as text, or `undefined` |
-| `renderPage(index, scale)` | `Uint8ClampedArray` of RGBA8 pixels (`scale` is device pixels per point) |
-| `renderPageToCanvas(index, scale, canvas)` | Render straight onto an `HtmlCanvasElement` |
-
-Rendering covers what `pdf2-render` covers: paths, fills, strokes, dashes, clips,
-transforms, text (embedded TrueType or the built-in base-14 fallback) and image
-XObjects. No anti-aliasing, no colour management, no `SMask` alpha.
-
-## Building
-
-The bindgen output must match the `wasm-bindgen` version the crate is compiled
-against (pinned in `Cargo.toml`):
+await init(); // fetches and instantiates pdf2_wasm_bg.wasm
+const response = await fetch('file.pdf');
+const doc = open(new Uint8Array(await response.arrayBuffer()));
 
-```sh
-cargo install wasm-bindgen-cli --version 0.2.127 --locked
-cargo build -p pdf2-wasm --release --target wasm32-unknown-unknown
-wasm-bindgen --target nodejs --out-dir crates/pdf2-wasm/pkg-node \
-    target/wasm32-unknown-unknown/release/pdf2_wasm.wasm
-wasm-bindgen --target web --no-typescript --out-dir crates/pdf2-wasm/demo/pkg \
-    target/wasm32-unknown-unknown/release/pdf2_wasm.wasm
-node --no-warnings crates/pdf2-wasm/check.mjs   # API smoke test + size budget
+doc.version();      // "2.0"
+doc.pageCount();    // 1
+doc.pageSize(0);    // [612, 792]
+doc.text(0);        // extracted text
+doc.renderPageToCanvas(0, 1.5, canvasElement);
 ```
 
-`check.mjs` covers `open`, password handling, page count and size, text,
-metadata, `renderPage` and the gzip size budget (260 KiB for the wasm module
-plus its JS glue; the current build is about 199 KiB gzipped).
-
-## Demo
+TypeScript declarations ship with the package. The wasm module is fetched
+relative to the glue by default; pass `{ module_or_path }` to `init()` to load
+it yourself, for example from a bundler asset or a `Uint8Array`.
 
-`demo/` is a static page: it renders the bundled `sample.pdf` on load and lets
-you pick another file locally (nothing is uploaded). Build `demo/pkg/` as above
-and serve the directory:
-
-```sh
-python3 -m http.server -d crates/pdf2-wasm/demo 8080
-```
+## API
 
-The `Demo` GitHub workflow builds and deploys it to GitHub Pages on every push
-that touches the package.
+| Export | What it does |
+| --- | --- |
+| `init(options?)` | instantiate the module; call once before using anything else |
+| `open(bytes, password?)` | parse a document; throws on a malformed file or a wrong password |
+| `doc.version()` | header version, e.g. `"2.0"` |
+| `doc.isEncrypted()` | whether the file was encrypted (AES-256 R6 is supported) |
+| `doc.pageCount()` | number of pages |
+| `doc.pageSize(index)` | `[width, height]` in points, after `/Rotate` |
+| `doc.text(index)` | text on a page; throws `unsupported: composite (Type0) fonts` for fonts this version cannot decode |
+| `doc.metadata()` | the XMP packet as text, when the document has one |
+| `doc.renderPage(index, scale)` | RGBA8 `Uint8ClampedArray`; `scale` is device pixels per point |
+| `doc.renderPageToCanvas(index, scale, canvas)` | the same, drawn straight onto a canvas |
+
+Rendering covers paths and curves, fills (non-zero and even-odd), strokes with
+caps, joins, the miter limit and dash phases, clips, transforms, `/MediaBox`
+origins, `/Rotate`, text through simple-font encodings with `/Widths` (embedded
+TrueType via `ttf-parser`, a built-in base-14 fallback otherwise), and
+`/Image` XObjects (DeviceGray/RGB/CMYK, `/Indexed`, `/ICCBased`, `/Decode`).
+Type 0/Type 3 fonts and embedded Type 1/CFF programs are reported rather than
+faked. [`docs/RENDERING.md`][rendering] has the clause-by-clause matrix.
+
+## Packages
+
+- npm: `pdf2-wasm` — this package: `pdf2_wasm.js`, `pdf2_wasm.d.ts`,
+  `pdf2_wasm_bg.wasm`, README and the two licences, nothing else.
+- crates.io: [`pdf2-wasm`][crate] — the Rust crate it is built from.
+- Demo: <https://pdf2-rs.github.io/pdf2/> renders the crate's own fixtures, with
+  page navigation, zoom and a password field for the encrypted sample.
+
+## Building from source
+
+The package is built by `cargo xtask wasm-package` from the workspace root: it
+runs `cargo build` for `wasm32-unknown-unknown`, `wasm-bindgen --target web`
+into `pkg/`, copies the manifest, README and licences beside the output, and
+then checks the result (API smoke test, package contents, size budget). The
+`wasm-bindgen` CLI must match the `wasm-bindgen` dependency exactly — the
+bindgen schema is not compatible across versions.
 
 ## Licence
 
-Dual-licensed under `MIT` or the [UNLICENSE](http://unlicense.org/), like `pdf2`.
+Unlicense OR MIT. The full texts ship with the package as `LICENSE-UNLICENSE`
+and `LICENSE-MIT`.
+
+[`pdf2`]: https://crates.io/crates/pdf2
+[crate]: https://crates.io/crates/pdf2-wasm
+[rendering]: https://github.com/pdf2-rs/pdf2/blob/main/docs/RENDERING.md

package/package.json

@@ -1,27 +1,51 @@
 {
   "name": "pdf2-wasm",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "PDF 2.0 in the browser: open, inspect and render with the pdf2 crate compiled to WebAssembly.",
   "license": "Unlicense OR MIT",
   "type": "module",
-  "main": "demo/pkg/pdf2_wasm.js",
+  "main": "./pdf2_wasm.js",
+  "module": "./pdf2_wasm.js",
+  "types": "./pdf2_wasm.d.ts",
+  "exports": {
+    ".": {
+      "types": "./pdf2_wasm.d.ts",
+      "import": "./pdf2_wasm.js",
+      "default": "./pdf2_wasm.js"
+    },
+    "./pdf2_wasm_bg.wasm": "./pdf2_wasm_bg.wasm"
+  },
   "files": [
-    "demo/pkg/pdf2_wasm.js",
-    "demo/pkg/pdf2_wasm_bg.wasm",
-    "README.md"
+    "pdf2_wasm.js",
+    "pdf2_wasm.d.ts",
+    "pdf2_wasm_bg.wasm",
+    "pdf2_wasm_bg.wasm.d.ts",
+    "README.md",
+    "LICENSE-MIT",
+    "LICENSE-UNLICENSE"
   ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
   "homepage": "https://pdf2-rs.github.io/pdf2/",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pdf2-rs/pdf2.git"
   },
+  "bugs": {
+    "url": "https://github.com/pdf2-rs/pdf2/issues"
+  },
   "keywords": [
     "pdf",
     "pdf2",
     "wasm",
-    "render"
+    "webassembly",
+    "render",
+    "browser"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   }
 }

package/pdf2_wasm.d.ts

@@ -0,0 +1,108 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * An open PDF document.
+ */
+export class PdfDocument {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Open a PDF from bytes; `new PdfDocument(bytes)` and
+     * `new PdfDocument(bytes, password)` both work.
+     */
+    constructor(bytes: Uint8Array, password?: string | null);
+    /**
+     * Whether the document was opened with a security handler.
+     */
+    isEncrypted(): boolean;
+    /**
+     * The XMP metadata packet as text, when the document has one.
+     */
+    metadata(): string | undefined;
+    /**
+     * Number of pages.
+     */
+    pageCount(): number;
+    /**
+     * `[width, height]` of a page in PDF points, counting from 0.
+     */
+    pageSize(index: number): Float64Array;
+    /**
+     * Render a page to RGBA8 pixels at `scale` device pixels per point.
+     *
+     * The result is a `Uint8ClampedArray` of `width * height * 4` bytes, ready
+     * for `ImageData` or a manual canvas `putImageData`.
+     */
+    renderPage(index: number, scale: number): Uint8ClampedArray;
+    /**
+     * Render a page straight onto a canvas, resizing it to the page.
+     */
+    renderPageToCanvas(index: number, scale: number, canvas: HTMLCanvasElement): void;
+    /**
+     * Extracted text of a page.
+     */
+    text(index: number): string;
+    /**
+     * The version from the header, e.g. `"2.0"`.
+     */
+    version(): string;
+}
+
+/**
+ * Open a PDF from bytes, with an optional password.
+ *
+ * ```js
+ * import init, { open } from "./pdf2_wasm.js";
+ * await init();
+ * const doc = open(bytes, null);
+ * ```
+ */
+export function open(bytes: Uint8Array, password?: string | null): PdfDocument;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_pdfdocument_free: (a: number, b: number) => void;
+    readonly open: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly pdfdocument_from_bytes: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly pdfdocument_isEncrypted: (a: number) => number;
+    readonly pdfdocument_metadata: (a: number) => [number, number];
+    readonly pdfdocument_pageCount: (a: number) => [number, number, number];
+    readonly pdfdocument_pageSize: (a: number, b: number) => [number, number, number, number];
+    readonly pdfdocument_renderPage: (a: number, b: number, c: number) => [number, number, number];
+    readonly pdfdocument_renderPageToCanvas: (a: number, b: number, c: number, d: any) => [number, number];
+    readonly pdfdocument_text: (a: number, b: number) => [number, number, number, number];
+    readonly pdfdocument_version: (a: number) => [number, number];
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/{demo/pkg/pdf2_wasm.js → pdf2_wasm.js}

@@ -1,3 +1,5 @@
+/* @ts-self-types="./pdf2_wasm.d.ts" */
+
 /**
  * An open PDF document.
  */

package/pdf2_wasm_bg.wasm.d.ts

@@ -0,0 +1,22 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_pdfdocument_free: (a: number, b: number) => void;
+export const open: (a: number, b: number, c: number, d: number) => [number, number, number];
+export const pdfdocument_from_bytes: (a: number, b: number, c: number, d: number) => [number, number, number];
+export const pdfdocument_isEncrypted: (a: number) => number;
+export const pdfdocument_metadata: (a: number) => [number, number];
+export const pdfdocument_pageCount: (a: number) => [number, number, number];
+export const pdfdocument_pageSize: (a: number, b: number) => [number, number, number, number];
+export const pdfdocument_renderPage: (a: number, b: number, c: number) => [number, number, number];
+export const pdfdocument_renderPageToCanvas: (a: number, b: number, c: number, d: any) => [number, number];
+export const pdfdocument_text: (a: number, b: number) => [number, number, number, number];
+export const pdfdocument_version: (a: number) => [number, number];
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+export const __externref_table_alloc: () => number;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __wbindgen_exn_store: (a: number) => void;
+export const __externref_table_dealloc: (a: number) => void;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __wbindgen_start: () => void;