@veripublica/paginaverto-wasm 0.1.2 → 0.1.3

package/README.md

@@ -14,10 +14,12 @@ import { read } from "@veripublica/paginaverto-wasm"; // bundler build
 // or, without a bundler: wasm-pack build --target web, then
 // import init, { read } from "./pkg/paginaverto_wasm.js"; await init();
 const book = read(new Uint8Array(await file.arrayBuffer()));
-// book.chapters: [{ title, blocks: [{ kind: "paragraph", text } | { kind: "figure", mediaType, ext, data }] }]
-// A refusal throws an Error with `kind` (Open, ScanNeedsOcr, UndecodableFonts, NoText, QualityGate, Internal).
+// book: Book = { chapters: [{ title, blocks: [{ kind: "paragraph", text } | { kind: "figure", mediaType, ext, data }] }] }
+// A refusal throws a PaginavertoError: an Error with `kind` (Open, ScanNeedsOcr, UndecodableFonts, NoText, QualityGate, Internal).
 ```
 
+- **Typed.** The `.d.ts` declares `Book`, `Chapter`, `Block` (a union you
+  narrow on `kind`), `ErrorKind` and `PaginavertoError`.
 - **Text layers only.** OCR is not built for the browser; a scan throws
   `ScanNeedsOcr`.
 - A panic cannot be caught in WebAssembly: it traps the instance. The demo

package/package.json

@@ -2,7 +2,7 @@
   "name": "@veripublica/paginaverto-wasm",
   "type": "module",
   "description": "WebAssembly bindings for paginaverto: read a PDF into chapters in the browser, no upload.",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "license": "AGPL-3.0-only OR LicenseRef-veripublica-Commercial",
   "repository": {
     "type": "git",

package/paginaverto_wasm.d.ts

@@ -1,14 +1,61 @@
 /* tslint:disable */
 /* eslint-disable */
 
+/** One piece of chapter content, in reading order. */
+export type Block =
+| {
+    kind: "paragraph";
+    /** The paragraph's text, whitespace collapsed to single spaces. */
+    text: string;
+}
+| {
+    kind: "figure";
+    /** A JPEG verbatim, or raw pixels re-encoded as PNG. */
+    mediaType: "image/jpeg" | "image/png";
+    ext: "jpg" | "png";
+    /** The image file's bytes. */
+    data: Uint8Array;
+};
+
+/** An optional heading and its content. */
+export interface Chapter {
+    /** The heading that starts the chapter; `null` before the first heading. */
+    title: string | null;
+    blocks: Block[];
+}
+
+/** What a PDF turned into. `chapters` is never empty. */
+export interface Book {
+    chapters: Chapter[];
+}
+
+/** Why a PDF could not be read; the `kind` of a thrown `PaginavertoError`. */
+export type ErrorKind =
+| "Open"
+| "ScanNeedsOcr"
+| "LanguageRequired"
+| "Models"
+| "OcrFoundNothing"
+| "UndecodableFonts"
+| "NoText"
+| "QualityGate"
+| "Internal";
+
+/** What `read` throws: an `Error` whose `kind` names the reason. */
+export interface PaginavertoError extends Error {
+    kind: ErrorKind;
+}
+
+
+
 /**
- * Read a PDF. Returns `{ chapters: [{ title, blocks }] }`, where each block
- * is `{ kind: "paragraph", text }` or `{ kind: "figure", mediaType, ext,
- * data }`. Throws an `Error` whose `kind` names the reason (`Open`,
+ * Read a PDF into a `Book` (chapters of paragraphs and figures). Throws a
+ * `PaginavertoError`: an `Error` whose `kind` names the reason (`Open`,
  * `ScanNeedsOcr`, `UndecodableFonts`, `NoText`, `QualityGate`, `Internal`)
- * and whose `message` says it in English.
+ * and whose `message` says it in English. Text layers only: a scan throws
+ * `ScanNeedsOcr`.
  */
-export function read(pdf: Uint8Array): any;
+export function read(pdf: Uint8Array): Book;
 
 /**
  * The crate version.

package/paginaverto_wasm_bg.js

@@ -1,11 +1,11 @@
 /**
- * Read a PDF. Returns `{ chapters: [{ title, blocks }] }`, where each block
- * is `{ kind: "paragraph", text }` or `{ kind: "figure", mediaType, ext,
- * data }`. Throws an `Error` whose `kind` names the reason (`Open`,
+ * Read a PDF into a `Book` (chapters of paragraphs and figures). Throws a
+ * `PaginavertoError`: an `Error` whose `kind` names the reason (`Open`,
  * `ScanNeedsOcr`, `UndecodableFonts`, `NoText`, `QualityGate`, `Internal`)
- * and whose `message` says it in English.
+ * and whose `message` says it in English. Text layers only: a scan throws
+ * `ScanNeedsOcr`.
  * @param {Uint8Array} pdf
- * @returns {any}
+ * @returns {Book}
  */
 export function read(pdf) {
     const ptr0 = passArray8ToWasm0(pdf, wasm.__wbindgen_malloc);