mark-epub-down 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Thomson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,151 @@
+# mark-epub-down
+
+Convert a single EPUB into a single Markdown source document for LLM knowledge bases, wikis, and related ingestion pipelines.
+
+## Why
+
+This project focuses on producing semantically useful Markdown from EPUB input. The v1 goal is not visual EPUB reproduction. It prioritizes source order, document structure, TOC preservation, and conservative transformation rules.
+
+## What v1 Does
+
+- converts one EPUB into one Markdown file
+- preserves spine order and source heading structure
+- emits a dedicated `## TOC` section from EPUB-native TOC data
+- includes minimal OPF-derived YAML front matter
+- rewrites internal targets conservatively for merged single-file output
+
+## What v1 Does Not Do
+
+- visually reproduce EPUB layout or CSS
+- guess missing structure aggressively
+- optimize first for reader-specific Markdown rendering
+- split output by chapter in the v1 baseline
+
+## Requirements
+
+- Node.js `20`, `22`, or `24`
+- npm
+
+## Install
+
+Install the CLI globally:
+
+```bash
+npm install -g mark-epub-down
+```
+
+Or add the package to a Node.js project:
+
+```bash
+npm install mark-epub-down
+```
+
+## CLI Usage
+
+Convert an EPUB:
+
+```bash
+epub2llm input.epub
+```
+
+Write to an explicit output path:
+
+```bash
+epub2llm input.epub -o output.md
+```
+
+Run without global install:
+
+```bash
+npx --package mark-epub-down epub2llm input.epub
+```
+
+Show CLI help:
+
+```bash
+epub2llm --help
+```
+
+Existing output files are never overwritten silently. In an interactive terminal session, the CLI may ask for explicit overwrite confirmation with a default `No` answer.
+
+## Node API
+
+The published package currently exposes a CommonJS API:
+
+```js
+const { convertEpub } = require("mark-epub-down");
+
+(async () => {
+  const result = await convertEpub({
+    inputPath: "input.epub",
+    outputPath: "output.md",
+  });
+
+  console.log(result.outputPath);
+  console.log(result.warnings);
+})();
+```
+
+If the output path already exists, `convertEpub()` throws unless `overwrite: true` is passed:
+
+```js
+(async () => {
+  await convertEpub({
+    inputPath: "input.epub",
+    outputPath: "output.md",
+    overwrite: true,
+  });
+})();
+```
+
+## Output Shape
+
+The generated Markdown follows this high-level structure:
+
+```markdown
+---
+title: Example Book
+creator: Example Author
+language: en
+published: 2026-04-09
+---
+
+# Example Book
+
+## TOC
+
+- [Chapter 1](#...)
+- Chapter 2
+
+## Chapter 1
+
+...
+```
+
+## Docs
+
+- Public v1 spec: [docs/epub-to-md-v1-public-spec.md](https://github.com/thomson1973/mark-epub-down/blob/main/docs/epub-to-md-v1-public-spec.md)
+- Technical selection notes: [docs/v1-technical-selection.md](https://github.com/thomson1973/mark-epub-down/blob/main/docs/v1-technical-selection.md)
+
+## Limitations
+
+- Fixed Layout EPUB (FXL) is out of scope for the v1 baseline
+- some internal links or TOC targets may degrade to plain text when they cannot be rewritten safely
+- complex tables may remain as HTML instead of being flattened into incorrect Markdown
+- images and other high-confidence non-text media are removed by default in v1
+- output files are never overwritten silently; interactive terminal use may ask for explicit confirmation
+
+## Roadmap
+
+- expand real-world sample coverage for malformed or inconsistent EPUB inputs
+- refine deeper footnote and note-topology edge cases beyond explicit source anchors
+- refine richer table fallback boundaries for more complex publisher markup
+
+## Development
+
+```bash
+npm install
+npm run build
+npm run typecheck
+npm test
+```

package/dist/application/convert-epub-document.d.ts

@@ -0,0 +1,10 @@
+import type { WarningRecord } from "../domain/types";
+export interface ConvertEpubDocumentOptions {
+    inputPath: string;
+}
+export interface ConvertEpubDocumentResult {
+    inputPath: string;
+    markdown: string;
+    warnings: WarningRecord[];
+}
+export declare function convertEpubDocument(options: ConvertEpubDocumentOptions): Promise<ConvertEpubDocumentResult>;

package/dist/application/convert-epub-document.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertEpubDocument = convertEpubDocument;
+const archive_1 = require("../epub/archive");
+const content_1 = require("../epub/content");
+const container_1 = require("../epub/container");
+const opf_1 = require("../epub/opf");
+const spine_1 = require("../epub/spine");
+const toc_1 = require("../epub/toc");
+const warnings_1 = require("../domain/warnings");
+const render_1 = require("../output/render");
+const cleanup_1 = require("../transform/cleanup");
+const links_1 = require("../transform/links");
+const markdown_1 = require("../transform/markdown");
+const tables_1 = require("../transform/tables");
+const errors_1 = require("../domain/errors");
+async function convertEpubDocument(options) {
+    const warnings = new warnings_1.WarningCollector();
+    const workingDirectory = await (0, archive_1.createWorkingDirectory)();
+    try {
+        await (0, archive_1.extractArchive)(options.inputPath, workingDirectory);
+        const container = await (0, container_1.parseContainerDocument)(workingDirectory);
+        const packageDocument = await (0, opf_1.parsePackageDocument)(workingDirectory, container.opfPath);
+        const toc = await (0, toc_1.parseTocDocument)(workingDirectory, packageDocument, warnings);
+        const spineDocuments = (0, spine_1.buildSpineIndex)(packageDocument);
+        const loadedDocuments = await (0, content_1.loadSpineDocuments)(workingDirectory, spineDocuments);
+        for (const loadedDocument of loadedDocuments) {
+            const cleanup = (0, cleanup_1.cleanXhtmlDocument)(loadedDocument.dom.window.document);
+            if (cleanup.removedTags.length > 0) {
+                const uniqueTags = [...new Set(cleanup.removedTags)].join(", ");
+                warnings.add("ELEMENTS_DROPPED", `dropped non-text elements from ${loadedDocument.spineDocument.relativePath}: ${uniqueTags}`);
+            }
+            const tableResult = (0, tables_1.processTables)(loadedDocument.dom.window.document);
+            if (tableResult.complexTableCount > 0) {
+                const noun = tableResult.complexTableCount === 1 ? "table" : "tables";
+                warnings.add("COMPLEX_TABLE_PRESERVED", `preserved ${tableResult.complexTableCount} complex ${noun} as HTML because Markdown conversion would be lossy: ${loadedDocument.spineDocument.relativePath}`);
+            }
+        }
+        const anchorMap = (0, links_1.buildAnchorMap)(loadedDocuments.map((loadedDocument) => ({
+            idref: loadedDocument.spineDocument.idref,
+            relativePath: loadedDocument.spineDocument.relativePath,
+            document: loadedDocument.dom.window.document,
+        })), warnings);
+        for (const loadedDocument of loadedDocuments) {
+            (0, links_1.rewriteInternalLinks)(loadedDocument.dom.window.document, loadedDocument.spineDocument.relativePath, anchorMap, warnings);
+            (0, links_1.injectAnchorTargets)({
+                idref: loadedDocument.spineDocument.idref,
+                relativePath: loadedDocument.spineDocument.relativePath,
+                document: loadedDocument.dom.window.document,
+            }, anchorMap);
+        }
+        const rewrittenToc = (0, links_1.rewriteTocTargets)(toc.items, anchorMap, warnings);
+        const markdownConverter = (0, markdown_1.createMarkdownConverter)();
+        const body = loadedDocuments
+            .filter((loadedDocument) => loadedDocument.spineDocument.linear)
+            .map((loadedDocument) => {
+            const html = loadedDocument.dom.window.document.body?.innerHTML;
+            if (!html) {
+                throw errors_1.ConversionError.fatal("CONTENT_BODY_MISSING", `spine content document is missing a body element: ${loadedDocument.spineDocument.relativePath}`);
+            }
+            return markdownConverter.turndown(html).trim();
+        })
+            .filter((fragment) => fragment.length > 0)
+            .join("\n\n");
+        const markdown = (0, render_1.renderDocument)({
+            metadata: packageDocument.metadata,
+            toc: rewrittenToc,
+            body,
+        });
+        return {
+            inputPath: options.inputPath,
+            markdown,
+            warnings: warnings.list(),
+        };
+    }
+    finally {
+        await (0, archive_1.cleanupWorkingDirectory)(workingDirectory);
+    }
+}
+//# sourceMappingURL=convert-epub-document.js.map

package/dist/application/convert-epub-document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert-epub-document.js","sourceRoot":"","sources":["../../src/application/convert-epub-document.ts"],"names":[],"mappings":";;AAyBA,kDA6FC;AAtHD,6CAAkG;AAClG,6CAAqD;AACrD,iDAA2D;AAC3D,qCAAmD;AACnD,yCAAgD;AAChD,qCAA+C;AAE/C,iDAAsD;AACtD,6CAAkD;AAClD,kDAA0D;AAC1D,8CAAkH;AAClH,oDAAgE;AAChE,gDAAoD;AACpD,6CAAmD;AAY5C,KAAK,UAAU,mBAAmB,CACvC,OAAmC;IAEnC,MAAM,QAAQ,GAAG,IAAI,2BAAgB,EAAE,CAAC;IACxC,MAAM,gBAAgB,GAAG,MAAM,IAAA,gCAAsB,GAAE,CAAC;IAExD,IAAI,CAAC;QACH,MAAM,IAAA,wBAAc,EAAC,OAAO,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QAE1D,MAAM,SAAS,GAAG,MAAM,IAAA,kCAAsB,EAAC,gBAAgB,CAAC,CAAC;QACjE,MAAM,eAAe,GAAG,MAAM,IAAA,0BAAoB,EAAC,gBAAgB,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QACxF,MAAM,GAAG,GAAG,MAAM,IAAA,sBAAgB,EAAC,gBAAgB,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;QAChF,MAAM,cAAc,GAAG,IAAA,uBAAe,EAAC,eAAe,CAAC,CAAC;QACxD,MAAM,eAAe,GAAG,MAAM,IAAA,4BAAkB,EAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;QAEnF,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,IAAA,4BAAkB,EAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACvE,IAAI,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAChE,QAAQ,CAAC,GAAG,CACV,kBAAkB,EAClB,kCAAkC,cAAc,CAAC,aAAa,CAAC,YAAY,KAAK,UAAU,EAAE,CAC7F,CAAC;YACJ,CAAC;YAED,MAAM,WAAW,GAAG,IAAA,sBAAa,EAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACtE,IAAI,WAAW,CAAC,iBAAiB,GAAG,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,GAAG,WAAW,CAAC,iBAAiB,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;gBACtE,QAAQ,CAAC,GAAG,CACV,yBAAyB,EACzB,aAAa,WAAW,CAAC,iBAAiB,YAAY,IAAI,wDAAwD,cAAc,CAAC,aAAa,CAAC,YAAY,EAAE,CAC9J,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,SAAS,GAAG,IAAA,sBAAc,EAC9B,eAAe,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YACvC,KAAK,EAAE,cAAc,CAAC,aAAa,CAAC,KAAK;YACzC,YAAY,EAAE,cAAc,CAAC,aAAa,CAAC,YAAY;YACvD,QAAQ,EAAE,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ;SAC7C,CAAC,CAAC,EACH,QAAQ,CACT,CAAC;QAEF,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;YAC7C,IAAA,4BAAoB,EAClB,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAClC,cAAc,CAAC,aAAa,CAAC,YAAY,EACzC,SAAS,EACT,QAAQ,CACT,CAAC;YACF,IAAA,2BAAmB,EACjB;gBACE,KAAK,EAAE,cAAc,CAAC,aAAa,CAAC,KAAK;gBACzC,YAAY,EAAE,cAAc,CAAC,aAAa,CAAC,YAAY;gBACvD,QAAQ,EAAE,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ;aAC7C,EACD,SAAS,CACV,CAAC;QACJ,CAAC;QAED,MAAM,YAAY,GAAG,IAAA,yBAAiB,EAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACvE,MAAM,iBAAiB,GAAG,IAAA,kCAAuB,GAAE,CAAC;QACpD,MAAM,IAAI,GAAG,eAAe;aACzB,MAAM,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,MAAM,CAAC;aAC/D,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;YACtB,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;YAChE,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,wBAAe,CAAC,KAAK,CACzB,sBAAsB,EACtB,qDAAqD,cAAc,CAAC,aAAa,CAAC,YAAY,EAAE,CACjG,CAAC;YACJ,CAAC;YAED,OAAO,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;QACjD,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aACzC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEhB,MAAM,QAAQ,GAAG,IAAA,uBAAc,EAAC;YAC9B,QAAQ,EAAE,eAAe,CAAC,QAAQ;YAClC,GAAG,EAAE,YAAY;YACjB,IAAI;SACL,CAAC,CAAC;QAEH,OAAO;YACL,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,QAAQ;YACR,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE;SAC1B,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,MAAM,IAAA,iCAAuB,EAAC,gBAAgB,CAAC,CAAC;IAClD,CAAC;AACH,CAAC"}

package/dist/application/convert-epub.d.ts

@@ -0,0 +1,13 @@
+import type { WarningRecord } from "../domain/types";
+export interface ConvertEpubOptions {
+    inputPath: string;
+    outputPath?: string;
+    cwd?: string;
+    overwrite?: boolean;
+}
+export interface ConvertEpubResult {
+    inputPath: string;
+    outputPath: string;
+    warnings: WarningRecord[];
+}
+export declare function convertEpub(options: ConvertEpubOptions): Promise<ConvertEpubResult>;

package/dist/application/convert-epub.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertEpub = convertEpub;
+const promises_1 = require("node:fs/promises");
+const node_path_1 = __importDefault(require("node:path"));
+const convert_epub_document_1 = require("./convert-epub-document");
+const errors_1 = require("../domain/errors");
+const path_1 = require("../utils/path");
+async function convertEpub(options) {
+    const cwd = options.cwd ?? process.cwd();
+    const inputPath = node_path_1.default.resolve(cwd, options.inputPath);
+    const outputPath = (0, path_1.deriveOutputPath)(inputPath, options.outputPath, cwd);
+    await assertInputExists(inputPath);
+    await (0, path_1.ensureOutputPathAvailable)(outputPath, options.overwrite === true);
+    const result = await (0, convert_epub_document_1.convertEpubDocument)({ inputPath });
+    await (0, promises_1.mkdir)(node_path_1.default.dirname(outputPath), { recursive: true });
+    await (0, promises_1.writeFile)(outputPath, result.markdown, "utf8");
+    return {
+        inputPath: result.inputPath,
+        outputPath,
+        warnings: result.warnings,
+    };
+}
+async function assertInputExists(inputPath) {
+    try {
+        await (0, promises_1.access)(inputPath);
+    }
+    catch {
+        throw errors_1.ConversionError.fatal("INPUT_NOT_FOUND", `input EPUB does not exist: ${inputPath}`);
+    }
+}
+//# sourceMappingURL=convert-epub.js.map

package/dist/application/convert-epub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert-epub.js","sourceRoot":"","sources":["../../src/application/convert-epub.ts"],"names":[],"mappings":";;;;;AAqBA,kCAkBC;AAvCD,+CAA4D;AAC5D,0DAA6B;AAE7B,mEAA8D;AAC9D,6CAAmD;AAEnD,wCAA4E;AAerE,KAAK,UAAU,WAAW,CAAC,OAA2B;IAC3D,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IACvD,MAAM,UAAU,GAAG,IAAA,uBAAgB,EAAC,SAAS,EAAE,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IAExE,MAAM,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACnC,MAAM,IAAA,gCAAyB,EAAC,UAAU,EAAE,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,MAAM,IAAA,2CAAmB,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC;IAExD,MAAM,IAAA,gBAAK,EAAC,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3D,MAAM,IAAA,oBAAS,EAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAErD,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,UAAU;QACV,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,SAAiB;IAChD,IAAI,CAAC;QACH,MAAM,IAAA,iBAAM,EAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,wBAAe,CAAC,KAAK,CACzB,iBAAiB,EACjB,8BAA8B,SAAS,EAAE,CAC1C,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/cli/confirm-overwrite.d.ts

@@ -0,0 +1 @@
+export declare function confirmOverwrite(outputPath: string, stdin: NodeJS.ReadableStream, stderr: NodeJS.WritableStream): Promise<boolean>;

package/dist/cli/confirm-overwrite.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.confirmOverwrite = confirmOverwrite;
+async function confirmOverwrite(outputPath, stdin, stderr) {
+    stderr.write(`overwrite existing output file? ${outputPath} (y/N) `);
+    try {
+        const answer = await readSingleLine(stdin);
+        return answer !== null && isAffirmativeAnswer(answer);
+    }
+    catch {
+        return false;
+    }
+}
+function isAffirmativeAnswer(value) {
+    const normalized = value.trim().toLowerCase();
+    return normalized === "y" || normalized === "yes";
+}
+async function readSingleLine(stdin) {
+    let buffered = "";
+    for await (const chunk of stdin) {
+        buffered += chunk.toString();
+        const newlineIndex = buffered.indexOf("\n");
+        if (newlineIndex >= 0) {
+            return buffered.slice(0, newlineIndex).replace(/\r$/, "");
+        }
+    }
+    return buffered.length > 0 ? buffered.replace(/\r$/, "") : null;
+}
+//# sourceMappingURL=confirm-overwrite.js.map

package/dist/cli/confirm-overwrite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"confirm-overwrite.js","sourceRoot":"","sources":["../../src/cli/confirm-overwrite.ts"],"names":[],"mappings":";;AAAA,4CAaC;AAbM,KAAK,UAAU,gBAAgB,CACpC,UAAkB,EAClB,KAA4B,EAC5B,MAA6B;IAE7B,MAAM,CAAC,KAAK,CAAC,mCAAmC,UAAU,SAAS,CAAC,CAAC;IAErE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,CAAC;QAC3C,OAAO,MAAM,KAAK,IAAI,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAa;IACxC,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC9C,OAAO,UAAU,KAAK,GAAG,IAAI,UAAU,KAAK,KAAK,CAAC;AACpD,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,KAA4B;IACxD,IAAI,QAAQ,GAAG,EAAE,CAAC;IAElB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,KAAuC,EAAE,CAAC;QAClE,QAAQ,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QAE7B,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAClE,CAAC"}

package/dist/cli/reporting.d.ts

@@ -0,0 +1,3 @@
+import type { ConvertEpubResult } from "../application/convert-epub";
+export declare function reportConversionResult(stdout: NodeJS.WritableStream, stderr: NodeJS.WritableStream, result: ConvertEpubResult): void;
+export declare function reportCliError(stderr: NodeJS.WritableStream, message: string): void;

package/dist/cli/reporting.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reportConversionResult = reportConversionResult;
+exports.reportCliError = reportCliError;
+const spec_1 = require("../domain/spec");
+const warnings_1 = require("../domain/warnings");
+function reportConversionResult(stdout, stderr, result) {
+    const cliWarnings = (0, warnings_1.summarizeWarnings)((0, warnings_1.getCliVisibleWarnings)(result.warnings));
+    emitWarnings(stderr, cliWarnings);
+    emitSuccess(stdout, result.outputPath, cliWarnings.length);
+}
+function reportCliError(stderr, message) {
+    stderr.write(`${spec_1.CLI_BINARY_NAME}: ${message}\n`);
+}
+function emitWarnings(stderr, warnings) {
+    for (const warning of warnings) {
+        stderr.write(`warning [${warning.code}]: ${warning.message}\n`);
+    }
+}
+function emitSuccess(stdout, outputPath, warningCount) {
+    const suffix = warningCount > 0 ? ` (${warningCount === 1 ? "1 warning" : `${warningCount} warnings`})` : "";
+    stdout.write(`wrote ${outputPath}${suffix}\n`);
+}
+//# sourceMappingURL=reporting.js.map

package/dist/cli/reporting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporting.js","sourceRoot":"","sources":["../../src/cli/reporting.ts"],"names":[],"mappings":";;AAKA,wDAQC;AAED,wCAEC;AAhBD,yCAAiD;AAEjD,iDAA8E;AAE9E,SAAgB,sBAAsB,CACpC,MAA6B,EAC7B,MAA6B,EAC7B,MAAyB;IAEzB,MAAM,WAAW,GAAG,IAAA,4BAAiB,EAAC,IAAA,gCAAqB,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9E,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAClC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;AAC7D,CAAC;AAED,SAAgB,cAAc,CAAC,MAA6B,EAAE,OAAe;IAC3E,MAAM,CAAC,KAAK,CAAC,GAAG,sBAAe,KAAK,OAAO,IAAI,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,YAAY,CAAC,MAA6B,EAAE,QAAyB;IAC5E,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,YAAY,OAAO,CAAC,IAAI,MAAM,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,MAA6B,EAAE,UAAkB,EAAE,YAAoB;IAC1F,MAAM,MAAM,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,YAAY,WAAW,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7G,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,GAAG,MAAM,IAAI,CAAC,CAAC;AACjD,CAAC"}

package/dist/cli/run-convert-command.d.ts

@@ -0,0 +1,10 @@
+export interface RunConvertCommandContext {
+    cwd: string;
+    stdin: NodeJS.ReadableStream;
+    stdout: NodeJS.WritableStream;
+    stderr: NodeJS.WritableStream;
+    interactive: boolean;
+}
+export declare function runConvertCommand(input: string, options: {
+    output?: string;
+}, context: RunConvertCommandContext): Promise<number>;

package/dist/cli/run-convert-command.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runConvertCommand = runConvertCommand;
+const node_path_1 = __importDefault(require("node:path"));
+const convert_epub_1 = require("../application/convert-epub");
+const errors_1 = require("../domain/errors");
+const path_1 = require("../utils/path");
+const confirm_overwrite_1 = require("./confirm-overwrite");
+const reporting_1 = require("./reporting");
+async function runConvertCommand(input, options, context) {
+    try {
+        const result = await (0, convert_epub_1.convertEpub)({
+            inputPath: input,
+            outputPath: options.output,
+            cwd: context.cwd,
+        });
+        (0, reporting_1.reportConversionResult)(context.stdout, context.stderr, result);
+        return 0;
+    }
+    catch (error) {
+        if (!(error instanceof errors_1.ConversionError)) {
+            const message = error instanceof Error ? error.message : String(error);
+            (0, reporting_1.reportCliError)(context.stderr, `unexpected error: ${message}`);
+            return 1;
+        }
+        if (error.code === "OUTPUT_EXISTS" && context.interactive) {
+            const inputPath = node_path_1.default.resolve(context.cwd, input);
+            const outputPath = (0, path_1.deriveOutputPath)(inputPath, options.output, context.cwd);
+            const confirmed = await (0, confirm_overwrite_1.confirmOverwrite)(outputPath, context.stdin, context.stderr);
+            if (confirmed) {
+                try {
+                    const result = await (0, convert_epub_1.convertEpub)({
+                        inputPath: input,
+                        outputPath: options.output,
+                        cwd: context.cwd,
+                        overwrite: true,
+                    });
+                    (0, reporting_1.reportConversionResult)(context.stdout, context.stderr, result);
+                    return 0;
+                }
+                catch (retryError) {
+                    if (retryError instanceof errors_1.ConversionError) {
+                        (0, reporting_1.reportCliError)(context.stderr, retryError.message);
+                        return retryError.exitCode;
+                    }
+                    const message = retryError instanceof Error ? retryError.message : String(retryError);
+                    (0, reporting_1.reportCliError)(context.stderr, `unexpected error: ${message}`);
+                    return 1;
+                }
+            }
+            (0, reporting_1.reportCliError)(context.stderr, `output file already exists and overwrite was not confirmed: ${outputPath}`);
+            return 1;
+        }
+        (0, reporting_1.reportCliError)(context.stderr, error.message);
+        return error.exitCode;
+    }
+}
+//# sourceMappingURL=run-convert-command.js.map

package/dist/cli/run-convert-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-convert-command.js","sourceRoot":"","sources":["../../src/cli/run-convert-command.ts"],"names":[],"mappings":";;;;;AAgBA,8CAwDC;AAxED,0DAA6B;AAE7B,8DAA0D;AAC1D,6CAAmD;AACnD,wCAAiD;AACjD,2DAAuD;AACvD,2CAAqE;AAU9D,KAAK,UAAU,iBAAiB,CACrC,KAAa,EACb,OAA4B,EAC5B,OAAiC;IAEjC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,IAAA,0BAAW,EAAC;YAC/B,SAAS,EAAE,KAAK;YAChB,UAAU,EAAE,OAAO,CAAC,MAAM;YAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC,CAAC;QACH,IAAA,kCAAsB,EAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/D,OAAO,CAAC,CAAC;IACX,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,wBAAe,CAAC,EAAE,CAAC;YACxC,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,IAAA,0BAAc,EAAC,OAAO,CAAC,MAAM,EAAE,qBAAqB,OAAO,EAAE,CAAC,CAAC;YAC/D,OAAO,CAAC,CAAC;QACX,CAAC;QAED,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YAC1D,MAAM,SAAS,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACnD,MAAM,UAAU,GAAG,IAAA,uBAAgB,EAAC,SAAS,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5E,MAAM,SAAS,GAAG,MAAM,IAAA,oCAAgB,EAAC,UAAU,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YACpF,IAAI,SAAS,EAAE,CAAC;gBACd,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,IAAA,0BAAW,EAAC;wBAC/B,SAAS,EAAE,KAAK;wBAChB,UAAU,EAAE,OAAO,CAAC,MAAM;wBAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;wBAChB,SAAS,EAAE,IAAI;qBAChB,CAAC,CAAC;oBACH,IAAA,kCAAsB,EAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBAC/D,OAAO,CAAC,CAAC;gBACX,CAAC;gBAAC,OAAO,UAAU,EAAE,CAAC;oBACpB,IAAI,UAAU,YAAY,wBAAe,EAAE,CAAC;wBAC1C,IAAA,0BAAc,EAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;wBACnD,OAAO,UAAU,CAAC,QAAQ,CAAC;oBAC7B,CAAC;oBAED,MAAM,OAAO,GAAG,UAAU,YAAY,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;oBACtF,IAAA,0BAAc,EAAC,OAAO,CAAC,MAAM,EAAE,qBAAqB,OAAO,EAAE,CAAC,CAAC;oBAC/D,OAAO,CAAC,CAAC;gBACX,CAAC;YACH,CAAC;YAED,IAAA,0BAAc,EACZ,OAAO,CAAC,MAAM,EACd,+DAA+D,UAAU,EAAE,CAC5E,CAAC;YACF,OAAO,CAAC,CAAC;QACX,CAAC;QAED,IAAA,0BAAc,EAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9C,OAAO,KAAK,CAAC,QAAQ,CAAC;IACxB,CAAC;AACH,CAAC"}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const spec_1 = require("./domain/spec");
+const run_convert_command_1 = require("./cli/run-convert-command");
+async function main() {
+    const program = new commander_1.Command();
+    program
+        .name(spec_1.CLI_BINARY_NAME)
+        .description("Convert a single EPUB into a single Markdown source document.")
+        .version("0.1.0", "-V, --version", "output the version number")
+        .argument("<input>", "input EPUB file")
+        .option("-o, --output <path>", "output Markdown path")
+        .showHelpAfterError("(add -h for usage)")
+        .action(async (input, options) => {
+        process.exitCode = await (0, run_convert_command_1.runConvertCommand)(input, options, {
+            cwd: process.cwd(),
+            stdin: process.stdin,
+            stdout: process.stdout,
+            stderr: process.stderr,
+            interactive: Boolean(process.stdin.isTTY && process.stdout.isTTY),
+        });
+    });
+    await program.parseAsync(process.argv);
+}
+void main();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AAEA,yCAAoC;AAEpC,wCAAgD;AAChD,mEAA8D;AAE9D,KAAK,UAAU,IAAI;IACjB,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;IAE9B,OAAO;SACJ,IAAI,CAAC,sBAAe,CAAC;SACrB,WAAW,CAAC,+DAA+D,CAAC;SAC5E,OAAO,CAAC,OAAO,EAAE,eAAe,EAAE,2BAA2B,CAAC;SAC9D,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;SACtC,MAAM,CAAC,qBAAqB,EAAE,sBAAsB,CAAC;SACrD,kBAAkB,CAAC,oBAAoB,CAAC;SACxC,MAAM,CAAC,KAAK,EAAE,KAAa,EAAE,OAA4B,EAAE,EAAE;QAC5D,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAA,uCAAiB,EAAC,KAAK,EAAE,OAAO,EAAE;YACzD,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;YAClB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;SAClE,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEL,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AACzC,CAAC;AAED,KAAK,IAAI,EAAE,CAAC"}

package/dist/domain/errors.d.ts

@@ -0,0 +1,7 @@
+export declare class ConversionError extends Error {
+    readonly code: string;
+    readonly fatal: boolean;
+    readonly exitCode: number;
+    constructor(code: string, message: string, fatal?: boolean, exitCode?: number);
+    static fatal(code: string, message: string): ConversionError;
+}

package/dist/domain/errors.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversionError = void 0;
+class ConversionError extends Error {
+    code;
+    fatal;
+    exitCode;
+    constructor(code, message, fatal = true, exitCode = 1) {
+        super(message);
+        this.name = "ConversionError";
+        this.code = code;
+        this.fatal = fatal;
+        this.exitCode = exitCode;
+    }
+    static fatal(code, message) {
+        return new ConversionError(code, message, true, 1);
+    }
+}
+exports.ConversionError = ConversionError;
+//# sourceMappingURL=errors.js.map

package/dist/domain/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/domain/errors.ts"],"names":[],"mappings":";;;AAAA,MAAa,eAAgB,SAAQ,KAAK;IACxB,IAAI,CAAS;IACb,KAAK,CAAU;IACf,QAAQ,CAAS;IAEjC,YAAmB,IAAY,EAAE,OAAe,EAAE,KAAK,GAAG,IAAI,EAAE,QAAQ,GAAG,CAAC;QAC1E,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,IAAY,EAAE,OAAe;QAC/C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACrD,CAAC;CACF;AAhBD,0CAgBC"}

package/dist/domain/spec.d.ts

@@ -0,0 +1,8 @@
+export declare const CLI_BINARY_NAME = "epub2llm";
+export declare const GENERATED_TOC_HEADING = "TOC";
+export declare const FRONT_MATTER_FIELDS: readonly ["title", "creator", "language", "identifier", "publisher", "published"];
+export declare const REMOVABLE_TAGS: Set<string>;
+export declare const NON_BLACKLISTED_STRUCTURAL_CONTAINERS: Set<string>;
+export declare const NOTE_REFERENCE_TYPES: Set<string>;
+export declare const NOTE_BODY_TYPES: Set<string>;
+export declare const NOTE_BACKLINK_TYPES: Set<string>;

package/dist/domain/spec.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NOTE_BACKLINK_TYPES = exports.NOTE_BODY_TYPES = exports.NOTE_REFERENCE_TYPES = exports.NON_BLACKLISTED_STRUCTURAL_CONTAINERS = exports.REMOVABLE_TAGS = exports.FRONT_MATTER_FIELDS = exports.GENERATED_TOC_HEADING = exports.CLI_BINARY_NAME = void 0;
+exports.CLI_BINARY_NAME = "epub2llm";
+exports.GENERATED_TOC_HEADING = "TOC";
+exports.FRONT_MATTER_FIELDS = [
+    "title",
+    "creator",
+    "language",
+    "identifier",
+    "publisher",
+    "published",
+];
+exports.REMOVABLE_TAGS = new Set([
+    "script",
+    "style",
+    "img",
+    "svg",
+    "canvas",
+    "audio",
+    "video",
+    "source",
+    "track",
+    "iframe",
+    "object",
+    "embed",
+    "form",
+    "input",
+    "button",
+    "select",
+    "option",
+    "textarea",
+    "meta",
+    "link",
+    "noscript",
+]);
+exports.NON_BLACKLISTED_STRUCTURAL_CONTAINERS = new Set([
+    "figure",
+    "figcaption",
+    "aside",
+    "section",
+    "nav",
+    "div",
+    "span",
+]);
+exports.NOTE_REFERENCE_TYPES = new Set(["noteref"]);
+exports.NOTE_BODY_TYPES = new Set(["footnote", "endnote", "rearnote"]);
+exports.NOTE_BACKLINK_TYPES = new Set(["backlink"]);
+//# sourceMappingURL=spec.js.map

package/dist/domain/spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec.js","sourceRoot":"","sources":["../../src/domain/spec.ts"],"names":[],"mappings":";;;AAAa,QAAA,eAAe,GAAG,UAAU,CAAC;AAC7B,QAAA,qBAAqB,GAAG,KAAK,CAAC;AAE9B,QAAA,mBAAmB,GAAG;IACjC,OAAO;IACP,SAAS;IACT,UAAU;IACV,YAAY;IACZ,WAAW;IACX,WAAW;CACH,CAAC;AAEE,QAAA,cAAc,GAAG,IAAI,GAAG,CAAC;IACpC,QAAQ;IACR,OAAO;IACP,KAAK;IACL,KAAK;IACL,QAAQ;IACR,OAAO;IACP,OAAO;IACP,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,MAAM;IACN,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,MAAM;IACN,MAAM;IACN,UAAU;CACX,CAAC,CAAC;AAEU,QAAA,qCAAqC,GAAG,IAAI,GAAG,CAAC;IAC3D,QAAQ;IACR,YAAY;IACZ,OAAO;IACP,SAAS;IACT,KAAK;IACL,KAAK;IACL,MAAM;CACP,CAAC,CAAC;AAEU,QAAA,oBAAoB,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;AAC5C,QAAA,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;AAC/D,QAAA,mBAAmB,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC"}