@veripublica/epubveri-wasm 0.1.0

package/README.md

@@ -0,0 +1,102 @@
+# epubveri-wasm
+
+WebAssembly bindings for [**epubveri**](https://github.com/veripublica/epubveri) — a
+pure-Rust EPUB validator. Validate an `.epub` **entirely in the browser** (or any JS
+runtime): no JVM, no server round-trip, no native dependencies. The bytes never leave
+the page.
+
+This is the WASM delivery of epubveri, a small/fast/embeddable alternative to the
+official Java **epubcheck**. It reuses epubcheck-compatible message IDs (`RSC-…`,
+`OPF-…`, `HTM-…`, …) so existing toolchains recognize the output.
+
+## Install
+
+```
+npm install @veripublica/epubveri-wasm
+```
+
+## Usage (bundlers — webpack / Vite / Rollup)
+
+The published package is built for **bundlers**, so there's no manual init step —
+your bundler loads the `.wasm` for you:
+
+```js
+import { validate, version } from "@veripublica/epubveri-wasm";
+
+const bytes = new Uint8Array(await file.arrayBuffer()); // a File / fetched .epub
+const report = validate(bytes, undefined); // second arg: profile or undefined
+
+console.log(report.valid, report.errors, report.warnings);
+for (const m of report.messages) {
+  console.log(`${m.severity} ${m.id}: ${m.text}`, m.location ?? "");
+}
+```
+
+Using it **directly in a browser without a bundler**? Build the `web` target
+instead (`wasm-pack build . --target web`), which exposes an async `init()` you
+`await` once before calling `validate()` — that's what the demo below uses.
+
+### Return shape (fully typed — real `.d.ts` ships in the package)
+
+```ts
+interface Report {
+  valid: boolean;        // true when there are zero ERROR-severity messages
+  errors: number;
+  warnings: number;
+  messages: Message[];
+}
+interface Message {
+  id: string;            // epubcheck-compatible, e.g. "RSC-005"
+  severity: string;      // "ERROR" | "WARNING" | "INFO"
+  text: string;          // epubveri's own message wording
+  location?: string;     // path/element hint, when available
+}
+
+function validate(bytes: Uint8Array, profile?: string | null): Report;
+function version(): string;
+```
+
+### Profiles
+
+`profile` mirrors epubcheck's `--profile` flag: pass `"dict"`, `"edupub"`, `"idx"`,
+`"preview"`, or `undefined`/`null` for default behavior. Unknown names are treated as
+`undefined` (permissive).
+
+### One CLI-only difference
+
+The `PKG-016` check (the `.epub` **file extension** should be lowercase) is filename-
+based and is **not** reported here — this entry point only ever sees bytes, never a
+filename. Everything else matches the native CLI/library exactly.
+
+## Try the demo
+
+The `demo/` folder has a zero-dependency drag-and-drop page. From the crate root:
+
+```
+wasm-pack build . --target web --out-name epubveri   # produces pkg/
+# then serve this folder over HTTP (wasm needs http://, not file://):
+#   any static server works, e.g. `miniserve .` or `python3 -m http.server`
+# open http://localhost:8000/demo/
+```
+
+## Building from source
+
+```
+cargo install wasm-pack
+
+# the published npm package (bundler target, @veripublica scope):
+wasm-pack build . --target bundler --scope veripublica --out-name epubveri
+
+# or the web target used by the demo above:
+wasm-pack build . --target web --out-name epubveri
+```
+
+The generated package lands in `pkg/` (git-ignored). Each `--target`
+(`bundler` / `web` / `nodejs`) emits different JS glue, so pick the one that
+matches how you'll load it; use `--target nodejs` for Node.
+
+## License
+
+Dual-licensed: **AGPL-3.0-only OR a commercial license** (`LicenseRef-veripublica-Commercial`).
+Open-source use is free under the AGPL; closed/commercial embedders should contact the
+author for a commercial license. See the main repository for details.

package/epubveri.d.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * One diagnostic, mirroring [`epubveri::report::Message`] with the message ID
+ * and severity flattened to strings for the JS boundary.
+ */
+export interface Message {
+    /**
+     * epubcheck-compatible message ID, e.g. `\"RSC-005\"`.
+     */
+    id: string;
+    /**
+     * `\"ERROR\"`, `\"WARNING\"`, or `\"INFO\"`.
+     */
+    severity: string;
+    /**
+     * Human-readable message text (epubveri\'s own wording).
+     */
+    text: string;
+    /**
+     * Optional location hint (path / element), when the check provides one.
+     */
+    location: string | undefined;
+}
+
+/**
+ * The full validation result for one EPUB.
+ */
+export interface Report {
+    /**
+     * `true` when there are zero `ERROR`-severity messages (warnings are allowed).
+     */
+    valid: boolean;
+    /**
+     * Count of `ERROR`-severity messages.
+     */
+    errors: number;
+    /**
+     * Count of `WARNING`-severity messages.
+     */
+    warnings: number;
+    /**
+     * Every diagnostic, in the order the validator produced them.
+     */
+    messages: Message[];
+}
+
+
+/**
+ * Validate raw EPUB bytes and return a typed [`Report`].
+ *
+ * `profile` mirrors the CLI `--profile` flag — pass `"dict"`, `"edupub"`,
+ * `"idx"`, `"preview"`, or `undefined`/`null` for default behavior. Unknown
+ * names behave like `undefined` (permissive).
+ *
+ * Note: the CLI-only PKG-016 check (the `.epub` file extension should be
+ * lowercase) is filename-based and intentionally not reachable here — this
+ * entry point only ever sees bytes, never a filename.
+ */
+export function validate(bytes: Uint8Array, profile?: string | null): Report;
+
+/**
+ * The `epubveri-wasm` crate version (matches this crate's `Cargo.toml`).
+ */
+export function version(): string;

package/epubveri.js

@@ -0,0 +1,9 @@
+/* @ts-self-types="./epubveri.d.ts" */
+import * as wasm from "./epubveri_bg.wasm";
+import { __wbg_set_wasm } from "./epubveri_bg.js";
+
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();
+export {
+    validate, version
+} from "./epubveri_bg.js";

package/epubveri_bg.js

@@ -0,0 +1,193 @@
+/**
+ * Validate raw EPUB bytes and return a typed [`Report`].
+ *
+ * `profile` mirrors the CLI `--profile` flag — pass `"dict"`, `"edupub"`,
+ * `"idx"`, `"preview"`, or `undefined`/`null` for default behavior. Unknown
+ * names behave like `undefined` (permissive).
+ *
+ * Note: the CLI-only PKG-016 check (the `.epub` file extension should be
+ * lowercase) is filename-based and intentionally not reachable here — this
+ * entry point only ever sees bytes, never a filename.
+ * @param {Uint8Array} bytes
+ * @param {string | null} [profile]
+ * @returns {Report}
+ */
+export function validate(bytes, profile) {
+    const ptr0 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    var ptr1 = isLikeNone(profile) ? 0 : passStringToWasm0(profile, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    var len1 = WASM_VECTOR_LEN;
+    const ret = wasm.validate(ptr0, len0, ptr1, len1);
+    return ret;
+}
+
+/**
+ * The `epubveri-wasm` crate version (matches this crate's `Cargo.toml`).
+ * @returns {string}
+ */
+export function version() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const ret = wasm.version();
+        deferred1_0 = ret[0];
+        deferred1_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+    }
+}
+export function __wbg_Error_92b29b0548f8b746(arg0, arg1) {
+    const ret = Error(getStringFromWasm0(arg0, arg1));
+    return ret;
+}
+export function __wbg_String_8564e559799eccda(arg0, arg1) {
+    const ret = String(arg1);
+    const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len1 = WASM_VECTOR_LEN;
+    getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
+    getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
+}
+export function __wbg___wbindgen_throw_344f42d3211c4765(arg0, arg1) {
+    throw new Error(getStringFromWasm0(arg0, arg1));
+}
+export function __wbg_new_32b398fb48b6d94a() {
+    const ret = new Array();
+    return ret;
+}
+export function __wbg_new_da52cf8fe3429cb2() {
+    const ret = new Object();
+    return ret;
+}
+export function __wbg_set_6be42768c690e380(arg0, arg1, arg2) {
+    arg0[arg1] = arg2;
+}
+export function __wbg_set_8a16b38e4805b298(arg0, arg1, arg2) {
+    arg0[arg1 >>> 0] = arg2;
+}
+export function __wbindgen_cast_0000000000000001(arg0) {
+    // Cast intrinsic for `F64 -> Externref`.
+    const ret = arg0;
+    return ret;
+}
+export function __wbindgen_cast_0000000000000002(arg0, arg1) {
+    // Cast intrinsic for `Ref(String) -> Externref`.
+    const ret = getStringFromWasm0(arg0, arg1);
+    return ret;
+}
+export function __wbindgen_cast_0000000000000003(arg0) {
+    // Cast intrinsic for `U64 -> Externref`.
+    const ret = BigInt.asUintN(64, arg0);
+    return ret;
+}
+export function __wbindgen_init_externref_table() {
+    const table = wasm.__wbindgen_externrefs;
+    const offset = table.grow(4);
+    table.set(0, undefined);
+    table.set(offset + 0, undefined);
+    table.set(offset + 1, null);
+    table.set(offset + 2, true);
+    table.set(offset + 3, false);
+}
+let cachedDataViewMemory0 = null;
+function getDataViewMemory0() {
+    if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
+        cachedDataViewMemory0 = new DataView(wasm.memory.buffer);
+    }
+    return cachedDataViewMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    return decodeText(ptr >>> 0, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+
+function passArray8ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 1, 1) >>> 0;
+    getUint8ArrayMemory0().set(arg, ptr / 1);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
+
+function passStringToWasm0(arg, malloc, realloc) {
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = cachedTextEncoder.encodeInto(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+const cachedTextEncoder = new TextEncoder();
+
+if (!('encodeInto' in cachedTextEncoder)) {
+    cachedTextEncoder.encodeInto = function (arg, view) {
+        const buf = cachedTextEncoder.encode(arg);
+        view.set(buf);
+        return {
+            read: arg.length,
+            written: buf.length
+        };
+    };
+}
+
+let WASM_VECTOR_LEN = 0;
+
+
+let wasm;
+export function __wbg_set_wasm(val) {
+    wasm = val;
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@veripublica/epubveri-wasm",
+  "type": "module",
+  "description": "WebAssembly bindings for epubveri — a pure-Rust, JVM-free EPUB validator that runs in the browser.",
+  "version": "0.1.0",
+  "license": "AGPL-3.0-only OR LicenseRef-veripublica-Commercial",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/veripublica/epubveri"
+  },
+  "files": [
+    "epubveri_bg.wasm",
+    "epubveri.js",
+    "epubveri_bg.js",
+    "epubveri.d.ts"
+  ],
+  "main": "epubveri.js",
+  "homepage": "https://github.com/veripublica/epubveri",
+  "types": "epubveri.d.ts",
+  "sideEffects": [
+    "./epubveri.js",
+    "./snippets/*"
+  ],
+  "keywords": [
+    "epub",
+    "epubcheck",
+    "validator",
+    "wasm",
+    "ebook"
+  ]
+}