@likecoin/epubcheck-ts 0.3.2 → 0.3.4

package/README.md

@@ -6,7 +6,7 @@ A TypeScript port of [EPUBCheck](https://github.com/w3c/epubcheck) - the officia
 [![npm](https://img.shields.io/npm/v/%40likecoin%2Fepubcheck-ts)](https://www.npmjs.com/package/@likecoin/epubcheck-ts)
 [![License](https://img.shields.io/npm/l/%40likecoin%2Fepubcheck-ts)](./LICENSE)
 
-> **Note**: This library is primarily developed for internal use at [3ook.com](https://3ook.com/about) and is built with AI-assisted development. While it has comprehensive test coverage (476 tests) and ~70% feature parity with Java EPUBCheck, it may not be suitable for mission-critical production workloads. For production environments requiring full EPUB validation, consider using the official [Java EPUBCheck](https://github.com/w3c/epubcheck). Contributions and feedback are welcome!
+> **Note**: This library is primarily developed for internal use at [3ook.com](https://3ook.com/about) and is built with AI-assisted development. While it has comprehensive test coverage (607 tests) and ~75% feature parity with Java EPUBCheck, it may not be suitable for mission-critical production workloads. For production environments requiring full EPUB validation, consider using the official [Java EPUBCheck](https://github.com/w3c/epubcheck). Contributions and feedback are welcome!
 
 ## Features
 
@@ -133,6 +133,8 @@ fileInput.addEventListener('change', async (event) => {
 
 ## API
 
+> Full API reference: [online](https://likecoin.github.io/epubcheck-ts/docs/) | [markdown](./docs/md/globals.md)
+
 ### `EpubCheck.validate(data, options?)`
 
 Static method to validate an EPUB file.
@@ -319,6 +321,9 @@ npm run build
 | `npm run format` | Format with Biome |
 | `npm run typecheck` | TypeScript type checking |
 | `npm run check` | Run all checks (format + typecheck) |
+| `npm run docs` | Generate API docs (HTML + Markdown) |
+| `npm run docs:html` | Generate HTML API docs to `docs/html/` |
+| `npm run docs:md` | Generate Markdown API docs to `docs/md/` |
 
 ### Project Structure
 
@@ -345,6 +350,8 @@ epubcheck-ts/
 ├── test/
 │   ├── fixtures/          # Test EPUB files
 │   └── integration/       # Integration tests
+├── docs/
+│   └── md/                # Generated API docs (Markdown, checked in)
 ├── examples/
 │   └── web/               # Web demo ✅
 └── dist/                  # Build output

package/bin/epubcheck.js

@@ -3,7 +3,7 @@ import { readFile, writeFile } from "node:fs/promises";
 import { parseArgs } from "node:util";
 import { basename } from "node:path";
 const { EpubCheck, toJSONReport } = await import("../dist/index.js");
-const VERSION = "0.3.2";
+const VERSION = "0.3.4";
 const { values, positionals } = parseArgs({
   options: {
     json: { type: "string", short: "j" },
@@ -111,9 +111,7 @@ async function main() {
     if (!values.quiet) {
       const fatal = result.messages.filter((m) => m.severity === "fatal");
       const errors = result.messages.filter((m) => m.severity === "error");
-      const warnings = result.messages.filter(
-        (m) => m.severity === "warning"
-      );
+      const warnings = result.messages.filter((m) => m.severity === "warning");
       const info = result.messages.filter((m) => m.severity === "info");
       const usage = result.messages.filter((m) => m.severity === "usage");
       const printMessages = (messages, color, label) => {

package/bin/epubcheck.ts

@@ -10,11 +10,12 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { parseArgs } from 'node:util';
 import { basename } from 'node:path';
+import type { EpubCheckOptions, EPUBProfile, ValidationMessage } from '../src/types.js';
 
 // Dynamic import to support both ESM and CJS builds
 const { EpubCheck, toJSONReport } = await import('../dist/index.js');
 
-const VERSION = '0.3.2';
+const VERSION = '0.3.4';
 
 // Parse command line arguments
 const { values, positionals } = parseArgs({
@@ -110,12 +111,9 @@ async function main(): Promise<void> {
 
     // Validate
     const startTime = Date.now();
-    const options: {
-      profile?: 'default' | 'dict' | 'edupub' | 'idx' | 'preview';
-      includeUsage?: boolean;
-    } = {};
+    const options: EpubCheckOptions = {};
     if (values.profile) {
-      options.profile = values.profile as 'default' | 'dict' | 'edupub' | 'idx' | 'preview';
+      options.profile = values.profile as EPUBProfile;
     }
     if (values.usage) {
       options.includeUsage = true;
@@ -147,13 +145,11 @@ async function main(): Promise<void> {
     // Console output (unless quiet mode)
     if (!values.quiet) {
       // Group messages by severity
-      const fatal = result.messages.filter((m: { severity: string }) => m.severity === 'fatal');
-      const errors = result.messages.filter((m: { severity: string }) => m.severity === 'error');
-      const warnings = result.messages.filter(
-        (m: { severity: string }) => m.severity === 'warning',
-      );
-      const info = result.messages.filter((m: { severity: string }) => m.severity === 'info');
-      const usage = result.messages.filter((m: { severity: string }) => m.severity === 'usage');
+      const fatal = result.messages.filter((m: ValidationMessage) => m.severity === 'fatal');
+      const errors = result.messages.filter((m: ValidationMessage) => m.severity === 'error');
+      const warnings = result.messages.filter((m: ValidationMessage) => m.severity === 'warning');
+      const info = result.messages.filter((m: ValidationMessage) => m.severity === 'info');
+      const usage = result.messages.filter((m: ValidationMessage) => m.severity === 'usage');
 
       // Print messages with colors
       const printMessages = (