@veripublica/epubveri-wasm 0.9.29 → 0.11.0

package/README.md

@@ -26,7 +26,7 @@ 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.status, report.summary); // "ok" | "problems", { errors, warnings }
+console.log(report.status, report.summary); // "ok" | "problems", { error, warning, … }
 for (const it of report.items) {
   console.log(`${it.severity} ${it.code}: ${it.message}`, it.location ?? "");
 }
@@ -45,7 +45,7 @@ instead (`wasm-pack build . --target web`), which exposes an async `init()` you
 ```ts
 interface Report {
   status: string;        // "ok" (valid) | "problems" (error/fatal findings remain)
-  summary: { fatals?: number; errors: number; warnings: number };
+  summary: { fatal?: number; error: number; warning: number; info?: number; usage?: number };
   items: Item[];
 }
 interface Item {
@@ -56,7 +56,13 @@ interface Item {
   location?: string;     // container-relative path, when available
   position?: { line: number; column: number };
   message: string;       // epubveri's own message wording
-  data?: { params: string[] };
+  data?: {
+    params: string[];            // the values interpolated into `message`
+    element_path?: string;       // XPath-style path to the offending node
+    namespaces: Map<string, string>;  // bindings that resolve element_path — a Map, see below
+    advisory_basis?: string;     // "spec-ahead" | "spec-silent", on ADV-*/NEXT-* only
+    violation_kind?: string;     // which of six kinds a schema violation is
+  };
 }
 
 function validate(
@@ -75,17 +81,35 @@ function version(): string;
 
 ### Advisory checks
 
-`advisory` mirrors the CLI `--advisory` flag: pass `true` to also emit the opt-in advisory
-findings epubcheck has no verdict on — currently unknown CSS property and descriptor names
-(`ADV-001`/`ADV-002`, at `usage` severity). It is **off by default**: leaving the argument
-out, or passing `false`/`undefined`, produces a byte-identical report, so existing
-two-argument callers are unaffected.
+`advisory` mirrors the CLI `--advisory` flag: pass `true` to also emit the opt-in findings
+epubcheck has no verdict on, in two families, both at `usage` severity:
 
-### One CLI-only difference
+- **`NEXT-*`** — a published specification requires it and epubcheck has not implemented it
+  yet, so it becomes an ordinary error the day it catches up (today: the EPUB 3.4 rules).
+- **`ADV-*`** — no specification says anything, but the book is still probably wrong
+  (unknown CSS property and descriptor names, a type selector naming no known element, an
+  EPUB 2 package written in EPUB 3, two navigation entries landing on one document).
 
-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.
+It is **off by default**: leaving the argument out, or passing `false`/`undefined`,
+produces a byte-identical report, so existing two-argument callers are unaffected. Neither
+family ever affects `status` — a book that passes epubcheck passes epubveri, with or
+without the flag.
+
+### Two differences from the CLI
+
+**`PKG-016` is not reported here.** That check is about the `.epub` **file extension**
+being lowercase, and this entry point only ever sees bytes, never a filename.
+
+**`data.namespaces` is a `Map`, not a plain object.** That is how a Rust map crosses
+into JavaScript here, and it is the one place this binding's shape differs from the
+CLI's JSON, where the same field is an object. Use `data.namespaces.get("opf")`;
+`data.namespaces["opf"]` is silently `undefined`. Everything else in `data` — added in
+0.10.0, having previously been CLI-only — is exactly the CLI's shape.
+
+**Nothing is filtered here.** The CLI hides `usage`-severity findings from its human
+report unless you pass `-u`; this binding is a machine interface and always returns
+every finding, exactly like `--format json`. Filter on `severity` yourself if your UI
+wants the CLI's default view.
 
 ## Try the demo
 

package/epubveri.d.ts

@@ -63,19 +63,64 @@ export interface Item {
 
 /**
  * Small aggregate counts, mirroring the envelope\'s per-input `summary`
- * (`fatals` omitted when zero, exactly as the CLI envelope emits it).
+ * exactly — same singular key names, and `fatal`/`info`/`usage` omitted when
+ * zero, as the CLI envelope emits them.
+ *
+ * **These counts are never filtered**, unlike the CLI\'s, where `-u` decides
+ * what the output contains and the counts describe the output. This binding
+ * has no such flag: it is a machine interface and always returns everything,
+ * so its counts always describe the whole report.
  */
 export interface Summary {
-    fatals: number;
-    errors: number;
-    warnings: number;
+    fatal: number;
+    error: number;
+    warning: number;
+    info: number;
+    usage: number;
 }
 
 /**
- * Tool-specific item extras.
+ * Tool-specific item extras — the same slot the CLI\'s `--format json` fills,
+ * with the same contents.
+ *
+ * Kept in step with [`epubveri::envelope::Data`] deliberately: a browser
+ * consumer that has to fall back to the CLI for a field is a consumer this
+ * package failed. Through 0.9.x this struct carried `params` alone, so
+ * `element_path`, `namespaces`, `advisory_basis` and `violation_kind` were
+ * reachable from the command line and not from the web. That was an omission
+ * rather than a decision — nothing about the browser makes them harder to
+ * produce — and 0.10.0 closes it.
+ *
+ * **Absent means absent**, as in the CLI envelope: every optional field is
+ * omitted rather than emitted as `null`, so a consumer tests for presence.
  */
 export interface Data {
     params: string[];
+    /**
+     * XPath-style path to the offending node, resolvable with `namespaces`.
+     */
+    element_path?: string;
+    /**
+     * Prefix -> namespace-URI bindings needed to resolve `element_path`.
+     *
+     * **This arrives in JavaScript as a `Map`, not a plain object** — that is
+     * how serde-wasm-bindgen renders a map, and it is the one place this
+     * binding\'s shape differs from the CLI\'s JSON, where the same field is an
+     * object. So `data.namespaces.get(\"opf\")`, never
+     * `data.namespaces[\"opf\"]`, which would silently be `undefined`.
+     */
+    namespaces: Map<string, string>;
+    /**
+     * `spec-ahead` | `spec-silent` — what an advisory finding is grounded in.
+     * Present only on `ADV-*`/`NEXT-*` findings.
+     */
+    advisory_basis?: string;
+    /**
+     * Which of the six kinds of schema violation this is, when the rule
+     * carries kinds. `None` says the rule has no kinds, never that the kind
+     * could not be determined.
+     */
+    violation_kind?: string;
 }
 
 
@@ -88,10 +133,13 @@ export interface Data {
  * names behave like `undefined` (permissive).
  *
  * `advisory` mirrors the CLI `--advisory` flag: pass `true` to also emit the
- * opt-in advisory findings epubcheck has no verdict on (unknown CSS
- * property/descriptor names, `ADV-*`, at usage severity). `undefined`/`false`
- * leaves them off, and with them off the report is byte-identical — so
- * existing two-argument callers are unaffected.
+ * opt-in findings epubcheck has no verdict on, in two families, both at
+ * `usage` severity — `NEXT-*` (a published specification requires it and
+ * epubcheck has not implemented it yet, so it becomes an ordinary error once
+ * it does) and `ADV-*` (no specification says anything, but the book is still
+ * probably wrong). `undefined`/`false` leaves them off, and with them off the
+ * report is byte-identical — so existing two-argument callers are unaffected.
+ * Neither family can move `status`.
  *
  * `epub_version` mirrors the CLI `-v` flag — pass `"2"`, `"2.0"`, `"3"`,
  * `"3.0"` to validate against that version whatever the book declares, or

package/epubveri_bg.js

@@ -7,10 +7,13 @@
  * names behave like `undefined` (permissive).
  *
  * `advisory` mirrors the CLI `--advisory` flag: pass `true` to also emit the
- * opt-in advisory findings epubcheck has no verdict on (unknown CSS
- * property/descriptor names, `ADV-*`, at usage severity). `undefined`/`false`
- * leaves them off, and with them off the report is byte-identical — so
- * existing two-argument callers are unaffected.
+ * opt-in findings epubcheck has no verdict on, in two families, both at
+ * `usage` severity — `NEXT-*` (a published specification requires it and
+ * epubcheck has not implemented it yet, so it becomes an ordinary error once
+ * it does) and `ADV-*` (no specification says anything, but the book is still
+ * probably wrong). `undefined`/`false` leaves them off, and with them off the
+ * report is byte-identical — so existing two-argument callers are unaffected.
+ * Neither family can move `status`.
  *
  * `epub_version` mirrors the CLI `-v` flag — pass `"2"`, `"2.0"`, `"3"`,
  * `"3.0"` to validate against that version whatever the book declares, or
@@ -68,6 +71,10 @@ export function __wbg_String_8564e559799eccda(arg0, arg1) {
     getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
     getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
 }
+export function __wbg___wbindgen_is_string_ea5e6cc2e4141dfe(arg0) {
+    const ret = typeof(arg0) === 'string';
+    return ret;
+}
 export function __wbg___wbindgen_throw_344f42d3211c4765(arg0, arg1) {
     throw new Error(getStringFromWasm0(arg0, arg1));
 }
@@ -75,10 +82,18 @@ export function __wbg_new_32b398fb48b6d94a() {
     const ret = new Array();
     return ret;
 }
+export function __wbg_new_7796ffc7ed656783() {
+    const ret = new Map();
+    return ret;
+}
 export function __wbg_new_da52cf8fe3429cb2() {
     const ret = new Object();
     return ret;
 }
+export function __wbg_set_575dd786d51585f8(arg0, arg1, arg2) {
+    const ret = arg0.set(arg1, arg2);
+    return ret;
+}
 export function __wbg_set_6be42768c690e380(arg0, arg1, arg2) {
     arg0[arg1] = arg2;
 }

package/package.json

@@ -2,7 +2,7 @@
   "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.9.29",
+  "version": "0.11.0",
   "license": "AGPL-3.0-only OR LicenseRef-veripublica-Commercial",
   "repository": {
     "type": "git",