@veripublica/epubveri-wasm 0.4.4 → 0.5.0

package/README.md

@@ -26,12 +26,16 @@ 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 ?? "");
+console.log(report.status, report.summary); // "ok" | "problems", { errors, warnings }
+for (const it of report.items) {
+  console.log(`${it.severity} ${it.code}: ${it.message}`, it.location ?? "");
 }
 ```
 
+`report` is the veripublica machine envelope's `inputs[i]` shape — the *same*
+object the CLI's `--format json` emits per input (minus `path`), so one parser
+reads CLI, CI and browser output alike.
+
 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.
@@ -40,16 +44,19 @@ instead (`wasm-pack build . --target web`), which exposes an async `init()` you
 
 ```ts
 interface Report {
-  valid: boolean;        // true when there are zero ERROR-severity messages
-  errors: number;
-  warnings: number;
-  messages: Message[];
+  status: string;        // "ok" (valid) | "problems" (error/fatal findings remain)
+  summary: { fatals?: number; errors: number; warnings: number };
+  items: Item[];
 }
-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
+interface Item {
+  type: string;          // "finding"
+  code: string;          // epubcheck-compatible, e.g. "RSC-005"
+  rule?: string;         // epubveri's finer sub-code, when present
+  severity: string;      // "fatal" | "error" | "warning" | "info" | "usage"
+  location?: string;     // container-relative path, when available
+  position?: { line: number; column: number };
+  message: string;       // epubveri's own message wording
+  data?: { params: string[] };
 }
 
 function validate(bytes: Uint8Array, profile?: string | null): Report;

package/epubveri.d.ts

@@ -9,69 +9,79 @@ export interface Position {
 }
 
 /**
- * One diagnostic, mirroring [`epubveri::report::Message`] with the message ID
- * and severity flattened to strings for the JS boundary.
+ * One EPUB\'s validation result — the envelope\'s `inputs[i]` object without
+ * `path`/`error` (a wasm caller has no path, and in-memory bytes are always
+ * readable, so there is no unprocessable/`\"error\"` case here).
  */
-export interface Message {
+export interface Report {
+    /**
+     * `\"ok\"` (valid) or `\"problems\"` (error/fatal findings remain). The
+     * warning/info/usage-only case is `\"ok\"` — those never fail a book.
+     */
+    status: string;
+    summary: Summary;
+    items: Item[];
+}
+
+/**
+ * One finding, in the shared item shape (FORMATS.md §1.3).
+ */
+export interface Item {
+    /**
+     * Always `\"finding\"` for a verifier.
+     */
+    type: string;
     /**
      * epubcheck-compatible message ID, e.g. `\"RSC-005\"`.
      */
-    id: string;
+    code: string;
     /**
-     * `\"ERROR\"`, `\"WARNING\"`, or `\"INFO\"`.
+     * epubveri\'s finer semantic sub-code, when the site carries one.
      */
-    severity: string;
+    rule: string | undefined;
     /**
-     * Human-readable message text (epubveri\'s own wording).
+     * Lowercase severity: `\"fatal\" | \"error\" | \"warning\" | \"info\" | \"usage\"`.
      */
-    text: string;
+    severity: string;
     /**
-     * Optional location hint (path / element), when the check provides one.
+     * Container-relative path the finding concerns, when known.
      */
     location: string | undefined;
     /**
-     * Optional exact source position, when the check provides one.
+     * Exact source position, when known.
      */
     position: Position | undefined;
     /**
-     * epubveri\'s own stable, semantic sub-code distinguishing sub-cases
-     * of a shared `id` (e.g. `\"opf.spine.duplicate_itemref\"`), when the
-     * check has been retrofitted for it (incremental rollout, see
-     * epubveri issue #2). `None` otherwise.
+     * Human-readable message text (epubveri\'s own wording).
      */
-    rule: string | undefined;
+    message: string;
     /**
-     * The positional values interpolated into `text`, when `rule` is
-     * present. Empty otherwise.
+     * Tool-specific extras — carries the message\'s interpolation `params`.
      */
-    params: string[];
+    data: Data | undefined;
 }
 
 /**
- * The full validation result for one EPUB.
+ * Small aggregate counts, mirroring the envelope\'s per-input `summary`
+ * (`fatals` omitted when zero, exactly as the CLI envelope emits it).
  */
-export interface Report {
-    /**
-     * `true` when there are zero `ERROR`-severity messages (warnings are allowed).
-     */
-    valid: boolean;
-    /**
-     * Count of `ERROR`-severity messages.
-     */
+export interface Summary {
+    fatals: number;
     errors: number;
-    /**
-     * Count of `WARNING`-severity messages.
-     */
     warnings: number;
-    /**
-     * Every diagnostic, in the order the validator produced them.
-     */
-    messages: Message[];
+}
+
+/**
+ * Tool-specific item extras.
+ */
+export interface Data {
+    params: string[];
 }
 
 
 /**
- * Validate raw EPUB bytes and return a typed [`Report`].
+ * Validate raw EPUB bytes and return the typed [`Report`] (an envelope
+ * `inputs[i]` object).
  *
  * `profile` mirrors the CLI `--profile` flag — pass `"dict"`, `"edupub"`,
  * `"idx"`, `"preview"`, or `undefined`/`null` for default behavior. Unknown
@@ -84,6 +94,8 @@ export interface Report {
 export function validate(bytes: Uint8Array, profile?: string | null): Report;
 
 /**
- * The `epubveri-wasm` crate version (matches this crate's `Cargo.toml`).
+ * The validator version — [`epubveri::VERSION`], the one string the CLI's
+ * `-V` and the demo footer also print, with git build metadata
+ * (`+<short-hash>[.dirty]`) when built from a checkout.
  */
 export function version(): string;

package/epubveri_bg.js

@@ -1,5 +1,6 @@
 /**
- * Validate raw EPUB bytes and return a typed [`Report`].
+ * Validate raw EPUB bytes and return the typed [`Report`] (an envelope
+ * `inputs[i]` object).
  *
  * `profile` mirrors the CLI `--profile` flag — pass `"dict"`, `"edupub"`,
  * `"idx"`, `"preview"`, or `undefined`/`null` for default behavior. Unknown
@@ -22,7 +23,9 @@ export function validate(bytes, profile) {
 }
 
 /**
- * The `epubveri-wasm` crate version (matches this crate's `Cargo.toml`).
+ * The validator version — [`epubveri::VERSION`], the one string the CLI's
+ * `-V` and the demo footer also print, with git build metadata
+ * (`+<short-hash>[.dirty]`) when built from a checkout.
  * @returns {string}
  */
 export function version() {

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