document-cli 5.5.2 → 5.6.0

package/README.md

@@ -2,7 +2,7 @@
 
 [![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white)](https://github.com/ExaDev/documents.js/tree/main/packages/document-cli) [![npm](https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/document-cli) [![npm version](https://img.shields.io/npm/v/document-cli)](https://www.npmjs.com/package/document-cli) [![CI](https://img.shields.io/github/actions/workflow/status/ExaDev/documents.js/ci.yml?branch=main)](https://github.com/ExaDev/documents.js/actions)
 
-> A command-line interface and an interactive terminal (Ink) app for [`documents.js`](https://github.com/ExaDev/documents.js): every docx/pptx/odt/odp/ods/odg/odf/pdf/odm/odb/xlsx/csv/svg/markdown/rtf/wpd/doc/xls/ppt conversion, bridge, and editor documents.js exposes, plus the outline projection [`document-outline.js`](../document-outline.js/README.md) builds over any readable document, wired up as a scriptable subcommand or a full-screen terminal editor. Installs as either `document-cli` or `doculi`.
+> A command-line interface and an interactive terminal (Ink) app for [`documents.js`](https://github.com/ExaDev/documents.js): every docx/pptx/odt/odp/ods/odg/odf/pdf/odm/odb/xlsx/csv/svg/markdown/rtf/wpd/doc/xls/ppt/epub conversion, bridge, and editor documents.js exposes, plus the outline projection [`document-outline.js`](../document-outline.js/README.md) builds over any readable document, wired up as a scriptable subcommand or a full-screen terminal editor. Installs as either `document-cli` or `doculi`.
 
 `document-cli` adds no conversion or editing logic of its own — it is a dispatch layer over `documents.js`'s existing conversion functions, `DocumentConverter` port, live-view editors, and `.odb`/PDF readers. What it adds is two ways to drive them without writing TypeScript: a scriptable, Unix-shaped CLI (stdin/stdout, exit codes, `--json` diagnostics) for pipelines, and a full-screen Ink terminal app for browsing and editing a document interactively.
 
@@ -143,7 +143,7 @@ document-cli pdf-inspect report.pdf
 document-cli pdf-inspect report.pdf --json
 ```
 
-**`fonts <input>`** — lists every source-embedded font face a docx/pptx/odt/odp/ods/odg document carries (family, weight/style, byte length) — the same embedded faces every `<format>-to-pdf` conversion already extracts and renders through automatically (see [Real fonts](#real-fonts) below); this command just reports what's there without converting anything. Rejects a format with no source-embedded-font concept at all (xlsx, csv, svg, pdf, markdown, odf, rtf, wpd, doc, xls, ppt), naming it:
+**`fonts <input>`** — lists every source-embedded font face a docx/pptx/odt/odp/ods/odg document carries (family, weight/style, byte length) — the same embedded faces every `<format>-to-pdf` conversion already extracts and renders through automatically (see [Real fonts](#real-fonts) below); this command just reports what's there without converting anything. Rejects a format with no source-embedded-font concept at all (xlsx, csv, svg, pdf, markdown, odf, rtf, wpd, doc, xls, ppt) or with no font-embedding support in this ecosystem's own reader yet (epub — EPUB 3 can embed fonts via CSS `@font-face`, but epub-codec's own reader doesn't extract them), naming it:
 
 ```sh
 document-cli fonts report.docx
@@ -155,7 +155,7 @@ document-cli fonts report.docx
 document-cli docx-extras report.docx
 ```
 
-**`metadata <input>`** — prints a document's own title/author/subject/keywords/creator/producer/created/modified metadata, for any of the seventeen supported formats (docx, pptx, xlsx, odt, odp, ods, odg, svg, odf, csv, markdown, rtf, wpd, doc, xls, ppt, pdf); csv, svg, doc, xls, and ppt carry no metadata container of their own (doc-codec/xls-codec/ppt-codec don't read one yet — see each package's own README), so they always report none. `--json` emits the raw metadata object:
+**`metadata <input>`** — prints a document's own title/author/subject/keywords/creator/producer/created/modified metadata, for any of the eighteen supported formats (docx, pptx, xlsx, odt, odp, ods, odg, svg, odf, csv, markdown, rtf, wpd, doc, xls, ppt, epub, pdf); csv, svg, doc, xls, and ppt carry no metadata container of their own (doc-codec/xls-codec/ppt-codec don't read one yet — see each package's own README), so they always report none, and epub reports title/author/keywords but never subject (epub-codec's OPF reader has no Dublin Core mapping for it). `--json` emits the raw metadata object:
 
 ```sh
 document-cli metadata report.pdf

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { a as odbFormSummary, c as presentMetadataEntries, d as resolveDefaultOutputPath, f as writeOutput, g as isDocumentFormat, h as inferFormatFromExtension, i as formatOdbReportLines, l as formatDocxExtrasLines, n as describeOdbReport, o as formatMetadataLines, p as loadProvidedFonts, r as formatOdbFormLines, t as describeOdbForm, u as readInput } from "./odb-structure-DKJ3vi6l.js";
+import { a as odbFormSummary, c as presentMetadataEntries, d as resolveDefaultOutputPath, f as writeOutput, g as isDocumentFormat, h as inferFormatFromExtension, i as formatOdbReportLines, l as formatDocxExtrasLines, n as describeOdbReport, o as formatMetadataLines, p as loadProvidedFonts, r as formatOdbFormLines, t as describeOdbForm, u as readInput } from "./odb-structure-CItnH50p.js";
 import { Command, CommanderError, InvalidArgumentError } from "commander";
 import { writeFile } from "node:fs/promises";
 import { basename, dirname, extname, join, resolve } from "node:path";
@@ -139,7 +139,7 @@ function createFilesystemMarkdownImageResolver(baseDir) {
 }
 //#endregion
 //#region src/commands/shared.ts
-const KNOWN_DOCUMENT_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, svg, odf, csv, markdown, rtf, pdf";
+const KNOWN_DOCUMENT_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, svg, odf, csv, markdown, rtf, wpd, doc, xls, ppt, epub, pdf";
 function resolveTargetFormat(output, out, to) {
 	if (to !== void 0) {
 		if (!isDocumentFormat(to)) return { errorMessage: `unknown --to format '${to}'; expected one of ${KNOWN_DOCUMENT_FORMATS}` };
@@ -1199,7 +1199,7 @@ function registerSetMetadataCommand(program) {
 }
 //#endregion
 //#region package.json
-var version = "5.5.2";
+var version = "5.6.0";
 //#endregion
 //#region src/program.ts
 function createProgram() {
@@ -1227,7 +1227,7 @@ function createProgram() {
 //#region src/cli.ts
 async function launchTui(startPath, signal) {
 	try {
-		const { runTui } = await import("./tui-C_It5tfz.js");
+		const { runTui } = await import("./tui-FXazDCHg.js");
 		await runTui({
 			startPath,
 			signal

package/dist/index.cjs

@@ -36,6 +36,7 @@ const EXTENSION_TO_FORMAT = {
 	doc: "doc",
 	xls: "xls",
 	ppt: "ppt",
+	epub: "epub",
 	pdf: "pdf"
 };
 const FORMAT_TO_EXTENSION = {
@@ -55,6 +56,7 @@ const FORMAT_TO_EXTENSION = {
 	doc: "doc",
 	xls: "xls",
 	ppt: "ppt",
+	epub: "epub",
 	pdf: "pdf"
 };
 function isDocumentFormat(value) {
@@ -267,7 +269,7 @@ function resolveDefaultOutputPath(inputPath, targetFormat) {
 }
 //#endregion
 //#region src/commands/shared.ts
-const KNOWN_DOCUMENT_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, svg, odf, csv, markdown, rtf, pdf";
+const KNOWN_DOCUMENT_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, svg, odf, csv, markdown, rtf, wpd, doc, xls, ppt, epub, pdf";
 function resolveTargetFormat(output, out, to) {
 	if (to !== void 0) {
 		if (!isDocumentFormat(to)) return { errorMessage: `unknown --to format '${to}'; expected one of ${KNOWN_DOCUMENT_FORMATS}` };
@@ -1547,7 +1549,7 @@ function registerSetMetadataCommand(program) {
 }
 //#endregion
 //#region package.json
-var version = "5.5.2";
+var version = "5.6.0";
 //#endregion
 //#region src/program.ts
 function createProgram() {

package/dist/index.js

@@ -35,6 +35,7 @@ const EXTENSION_TO_FORMAT = {
 	doc: "doc",
 	xls: "xls",
 	ppt: "ppt",
+	epub: "epub",
 	pdf: "pdf"
 };
 const FORMAT_TO_EXTENSION = {
@@ -54,6 +55,7 @@ const FORMAT_TO_EXTENSION = {
 	doc: "doc",
 	xls: "xls",
 	ppt: "ppt",
+	epub: "epub",
 	pdf: "pdf"
 };
 function isDocumentFormat(value) {
@@ -266,7 +268,7 @@ function resolveDefaultOutputPath(inputPath, targetFormat) {
 }
 //#endregion
 //#region src/commands/shared.ts
-const KNOWN_DOCUMENT_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, svg, odf, csv, markdown, rtf, pdf";
+const KNOWN_DOCUMENT_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, svg, odf, csv, markdown, rtf, wpd, doc, xls, ppt, epub, pdf";
 function resolveTargetFormat(output, out, to) {
 	if (to !== void 0) {
 		if (!isDocumentFormat(to)) return { errorMessage: `unknown --to format '${to}'; expected one of ${KNOWN_DOCUMENT_FORMATS}` };
@@ -1546,7 +1548,7 @@ function registerSetMetadataCommand(program) {
 }
 //#endregion
 //#region package.json
-var version = "5.5.2";
+var version = "5.6.0";
 //#endregion
 //#region src/program.ts
 function createProgram() {

package/dist/{odb-structure-DKJ3vi6l.js → odb-structure-CItnH50p.js}

@@ -31,6 +31,7 @@ const EXTENSION_TO_FORMAT = {
 	doc: "doc",
 	xls: "xls",
 	ppt: "ppt",
+	epub: "epub",
 	pdf: "pdf"
 };
 const FORMAT_TO_EXTENSION = {
@@ -50,6 +51,7 @@ const FORMAT_TO_EXTENSION = {
 	doc: "doc",
 	xls: "xls",
 	ppt: "ppt",
+	epub: "epub",
 	pdf: "pdf"
 };
 function isDocumentFormat(value) {

package/dist/{tui-C_It5tfz.js → tui-FXazDCHg.js}

@@ -1,7 +1,7 @@
-import { h as inferFormatFromExtension, i as formatOdbReportLines, l as formatDocxExtrasLines, m as formatToExtension, n as describeOdbReport, o as formatMetadataLines, p as loadProvidedFonts, r as formatOdbFormLines, s as formatMetadataValue, t as describeOdbForm, u as readInput } from "./odb-structure-DKJ3vi6l.js";
+import { h as inferFormatFromExtension, i as formatOdbReportLines, l as formatDocxExtrasLines, m as formatToExtension, n as describeOdbReport, o as formatMetadataLines, p as loadProvidedFonts, r as formatOdbFormLines, s as formatMetadataValue, t as describeOdbForm, u as readInput } from "./odb-structure-CItnH50p.js";
 import { readFile, writeFile } from "node:fs/promises";
 import { basename, dirname, extname, join } from "node:path";
-import { bytesToBase64, cellReference, columnIndexToLetters, convertDocument, createDocx, createMarkdownEditor, createOdg, createOdp, createOds, createOdt, createPdf, createPptx, csvToPdf, decodeMarkdownText, decodeOdbPackage, docToPdf, docxToPdf, encodeMarkdownText, hsqldbCellDisplayText, markdownToPdf, odbReportToDocx, odbReportToOdt, odbReportToPdf, odgToPdf, odpToPdf, odsToPdf, odtToPdf, openDocx, openMarkdown, openOdg, openOdp, openOds, openOdt, openPdf, openPptx, parseXml, pptToPdf, pptxToPdf, readDocxContent, readDocxExtras, readMarkdownContent, readOdbForms, readOdbReportContent, readOdbReports, readOdbTables, readOdgContent, readOdpContent, readOdsContent, readOdtContent, readPdf, readPptxContent, rgbHexToColor, rtfToPdf, svgToPdf, xlsToPdf, xlsxToPdf } from "documents.js";
+import { bytesToBase64, cellReference, columnIndexToLetters, convertDocument, createDocx, createMarkdownEditor, createOdg, createOdp, createOds, createOdt, createPdf, createPptx, csvToPdf, decodeMarkdownText, decodeOdbPackage, docToPdf, docxToPdf, encodeMarkdownText, epubToPdf, hsqldbCellDisplayText, markdownToPdf, odbReportToDocx, odbReportToOdt, odbReportToPdf, odgToPdf, odpToPdf, odsToPdf, odtToPdf, openDocx, openMarkdown, openOdg, openOdp, openOds, openOdt, openPdf, openPptx, parseXml, pptToPdf, pptxToPdf, readDocxContent, readDocxExtras, readMarkdownContent, readOdbForms, readOdbReportContent, readOdbReports, readOdbTables, readOdgContent, readOdpContent, readOdsContent, readOdtContent, readPdf, readPptxContent, rgbHexToColor, rtfToPdf, svgToPdf, xlsToPdf, xlsxToPdf } from "documents.js";
 import { readdirSync } from "node:fs";
 import { Box, Text, render, useApp, useInput, useWindowSize } from "ink";
 import { createContext, useContext, useEffect, useReducer, useState } from "react";
@@ -82,6 +82,11 @@ async function exportToPdf(openDocument, destinationPath, options) {
 		await writeFile(destinationPath, pdfBytes);
 		return;
 	}
+	if (openDocument.format === "epub") {
+		const pdfBytes = epubToPdf(openDocument.bytes, pdfOptions);
+		await writeFile(destinationPath, pdfBytes);
+		return;
+	}
 	const bytes = openDocument.editor.toBytes();
 	const pdfBytes = convert(openDocument.format, bytes, pdfOptions);
 	await writeFile(destinationPath, pdfBytes);
@@ -225,6 +230,12 @@ async function openDocumentAtPath(path, options = {}) {
 			bytes,
 			path
 		};
+		case "epub": return {
+			format,
+			layout: readPdf(epubToPdf(bytes)),
+			bytes,
+			path
+		};
 		case "odf": throw new Error("A standalone .odf formula document has no editor; convert it to PDF (odfToPdf) instead");
 	}
 }
@@ -278,7 +289,7 @@ function createNewDocument(format) {
 	}
 }
 async function saveDocumentTo(openDocument, path) {
-	if (openDocument.format === "odb" || openDocument.format === "xlsx" || openDocument.format === "csv" || openDocument.format === "svg" || openDocument.format === "rtf" || openDocument.format === "wpd" || openDocument.format === "doc" || openDocument.format === "xls" || openDocument.format === "ppt") throw new Error(`A ${openDocument.format} document is opened read-only and cannot be written back`);
+	if (openDocument.format === "odb" || openDocument.format === "xlsx" || openDocument.format === "csv" || openDocument.format === "svg" || openDocument.format === "rtf" || openDocument.format === "wpd" || openDocument.format === "doc" || openDocument.format === "xls" || openDocument.format === "ppt" || openDocument.format === "epub") throw new Error(`A ${openDocument.format} document is opened read-only and cannot be written back`);
 	if (openDocument.format === "markdown") {
 		await writeFile(path, encodeMarkdownText(openDocument.editor.toMarkdownText()));
 		return;
@@ -370,7 +381,8 @@ function rootScreenForFormat(format) {
 		case "wpd":
 		case "doc":
 		case "xls":
-		case "ppt": return { kind: "pdfPageList" };
+		case "ppt":
+		case "epub": return { kind: "pdfPageList" };
 	}
 }
 function currentScreen(state) {
@@ -549,6 +561,12 @@ function documentWithPath(doc, path) {
 			bytes: doc.bytes,
 			path
 		};
+		case "epub": return {
+			format: "epub",
+			layout: doc.layout,
+			bytes: doc.bytes,
+			path
+		};
 	}
 }
 function reopenEditable(doc, bytes) {
@@ -867,7 +885,7 @@ function appReducer(state, action) {
 			selection: {},
 			errorDetail: void 0,
 			stack: [rootScreenForFormat(action.doc.format)]
-		}, "info", action.doc.format === "xlsx" || action.doc.format === "csv" || action.doc.format === "svg" || action.doc.format === "rtf" || action.doc.format === "wpd" || action.doc.format === "doc" || action.doc.format === "xls" || action.doc.format === "ppt" ? `Opened ${action.path} as a read-only PDF preview -- press ':' then 'export pdf' to save it as a real PDF` : `Opened ${action.path}`);
+		}, "info", action.doc.format === "xlsx" || action.doc.format === "csv" || action.doc.format === "svg" || action.doc.format === "rtf" || action.doc.format === "wpd" || action.doc.format === "doc" || action.doc.format === "xls" || action.doc.format === "ppt" || action.doc.format === "epub" ? `Opened ${action.path} as a read-only PDF preview -- press ':' then 'export pdf' to save it as a real PDF` : `Opened ${action.path}`);
 		case "OPEN_FILE_ERROR": return withStatus({
 			...state,
 			errorDetail: {
@@ -1479,7 +1497,7 @@ function appReducer(state, action) {
 		case "UNDO": {
 			const doc = state.openDocument;
 			if (doc === void 0) return withStatus(state, "info", "There is nothing to undo");
-			if (doc.format === "odb" || doc.format === "xlsx" || doc.format === "csv" || doc.format === "svg" || doc.format === "rtf" || doc.format === "wpd" || doc.format === "doc" || doc.format === "xls" || doc.format === "ppt") return withStatus(state, "warning", `A ${doc.format} document is read-only, so it has no history to undo`);
+			if (doc.format === "odb" || doc.format === "xlsx" || doc.format === "csv" || doc.format === "svg" || doc.format === "rtf" || doc.format === "wpd" || doc.format === "doc" || doc.format === "xls" || doc.format === "ppt" || doc.format === "epub") return withStatus(state, "warning", `A ${doc.format} document is read-only, so it has no history to undo`);
 			const snapshot = state.undoStack.at(-1);
 			if (snapshot === void 0) return withStatus(state, "info", "There is nothing to undo");
 			const restored = doc.format === "markdown" ? {
@@ -9171,7 +9189,8 @@ function metadataFor(doc) {
 		case "wpd":
 		case "doc":
 		case "xls":
-		case "ppt": return doc.layout.metadata;
+		case "ppt":
+		case "epub": return doc.layout.metadata;
 		case "odb": throw new Error("A .odb database has no document-level metadata -- it is a table/form/report container, not a single document with its own title/author/etc.");
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-cli",
-  "version": "5.5.2",
+  "version": "5.6.0",
   "description": "CLI and interactive Ink TUI for documents.js: every docx/pptx/odt/odp/ods/odg/odf/pdf/odm/odb/xlsx/csv/svg/markdown/rtf conversion, bridge, and editor as a scriptable command or a terminal app.",
   "type": "module",
   "repository": {
@@ -94,7 +94,7 @@
     "commander": "^15.0.0",
     "document-outline.js": "^3.5.5",
     "document-schema.js": "^7.1.0",
-    "documents.js": "^7.6.2",
+    "documents.js": "^7.7.0",
     "ink": "^7.1.1",
     "ink-text-input": "^6.0.0",
     "react": "^19.2.8"