document-cli 1.0.0 → 1.1.0

package/README.md

@@ -6,6 +6,39 @@
 
 `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.
 
+```mermaid
+graph TD
+    schema("document-schema.js")
+    ooxml("ooxml.js")
+    odf("odf.js")
+    pdfcodec("pdf-codec")
+    mdcodec("markdown-codec")
+    documents("documents.js")
+    cli("document-cli")
+
+    schema --> ooxml
+    schema --> odf
+    schema --> pdfcodec
+    schema --> mdcodec
+    schema --> documents
+    ooxml --> documents
+    odf --> documents
+    pdfcodec --> documents
+    mdcodec --> documents
+    documents --> cli
+    odf --> cli
+
+    click schema "https://github.com/ExaDev/document-schema.js" "document-schema.js"
+    click ooxml "https://github.com/ExaDev/ooxml.js" "ooxml.js"
+    click odf "https://github.com/ExaDev/odf.js" "odf.js"
+    click pdfcodec "https://github.com/ExaDev/pdf-codec" "pdf-codec"
+    click mdcodec "https://github.com/ExaDev/markdown-codec" "markdown-codec"
+    click documents "https://github.com/ExaDev/documents.js" "documents.js"
+    click cli "https://github.com/ExaDev/document-cli" "document-cli"
+
+    style cli fill:#f9a825,stroke:#333,stroke-width:3px
+```
+
 ## Why
 
 `documents.js` is a library, not a tool — everything it does happens through function calls from TypeScript/JavaScript. Most people who want to convert a docx to a PDF, extract an `.odb` table to CSV, or poke at a PDF's structure from a terminal don't want to write a script to do it. `document-cli` is that missing entry point: every one of documents.js's 19 direct conversion pairs, its generic converter, its `.odm`/`.odb` extraction functions, and its PDF inspector become a single command-line invocation, and its six live-view editors (docx/pptx/odt/odp/ods/odg) become a keyboard-driven terminal app that never needs a code editor open at all.

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { a as inferFormatFromExtension, n as resolveDefaultOutputPath, o as isDocumentFormat, r as writeOutput, t as readInput } from "./io-Cl3MaB0L.js";
+import { a as inferFormatFromExtension, n as resolveDefaultOutputPath, o as isDocumentFormat, r as writeOutput, t as readInput } from "./io-CKOE9Xda.js";
 import { Command, CommanderError, InvalidArgumentError } from "commander";
 import { writeFile } from "node:fs/promises";
 import { OdbNoEmbeddedDataSourceError, OdbTableNotFoundError, OdbTableNotSpecifiedError, OdbUnsupportedFormatError, OdmUnresolvedSectionError, PdfEncryptedError, PdfParseError, createLocalDocumentConverter, odbToCsv, odbToXlsx, odmToPdf, readOdbTables, readPdf } from "documents.js";
@@ -181,7 +181,7 @@ function toConversionCommandOptions(options) {
 		dumpPackage: options.dumpPackage
 	};
 }
-const KNOWN_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, odf, pdf";
+const KNOWN_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, odf, markdown, pdf";
 function resolveGenericTarget(output, options) {
 	if (options.to !== void 0) {
 		if (!isDocumentFormat(options.to)) return { errorMessage: `unknown --to format '${options.to}'; expected one of ${KNOWN_FORMATS}` };
@@ -546,7 +546,7 @@ function registerPdfInspectCommand(program) {
 }
 //#endregion
 //#region package.json
-var version = "1.0.0";
+var version = "1.1.0";
 //#endregion
 //#region src/program.ts
 function createProgram() {
@@ -568,7 +568,7 @@ function createProgram() {
 //#region src/cli.ts
 async function launchTui(startPath, signal) {
 	try {
-		const { runTui } = await import("./tui-CucYgqmL.js");
+		const { runTui } = await import("./tui-Dywpifqx.js");
 		await runTui({
 			startPath,
 			signal

package/dist/index.cjs

@@ -15,6 +15,8 @@ const EXTENSION_TO_FORMAT = {
 	ods: "ods",
 	odg: "odg",
 	odf: "odf",
+	markdown: "markdown",
+	md: "markdown",
 	pdf: "pdf"
 };
 const FORMAT_TO_EXTENSION = {
@@ -26,6 +28,7 @@ const FORMAT_TO_EXTENSION = {
 	ods: "ods",
 	odg: "odg",
 	odf: "odf",
+	markdown: "md",
 	pdf: "pdf"
 };
 function isDocumentFormat(value) {
@@ -265,7 +268,7 @@ function toConversionCommandOptions(options) {
 		dumpPackage: options.dumpPackage
 	};
 }
-const KNOWN_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, odf, pdf";
+const KNOWN_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, odf, markdown, pdf";
 function resolveGenericTarget(output, options) {
 	if (options.to !== void 0) {
 		if (!isDocumentFormat(options.to)) return { errorMessage: `unknown --to format '${options.to}'; expected one of ${KNOWN_FORMATS}` };
@@ -630,7 +633,7 @@ function registerPdfInspectCommand(program) {
 }
 //#endregion
 //#region package.json
-var version = "1.0.0";
+var version = "1.1.0";
 //#endregion
 //#region src/program.ts
 function createProgram() {

package/dist/index.js

@@ -14,6 +14,8 @@ const EXTENSION_TO_FORMAT = {
 	ods: "ods",
 	odg: "odg",
 	odf: "odf",
+	markdown: "markdown",
+	md: "markdown",
 	pdf: "pdf"
 };
 const FORMAT_TO_EXTENSION = {
@@ -25,6 +27,7 @@ const FORMAT_TO_EXTENSION = {
 	ods: "ods",
 	odg: "odg",
 	odf: "odf",
+	markdown: "md",
 	pdf: "pdf"
 };
 function isDocumentFormat(value) {
@@ -264,7 +267,7 @@ function toConversionCommandOptions(options) {
 		dumpPackage: options.dumpPackage
 	};
 }
-const KNOWN_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, odf, pdf";
+const KNOWN_FORMATS = "docx, pptx, xlsx, odt, odp, ods, odg, odf, markdown, pdf";
 function resolveGenericTarget(output, options) {
 	if (options.to !== void 0) {
 		if (!isDocumentFormat(options.to)) return { errorMessage: `unknown --to format '${options.to}'; expected one of ${KNOWN_FORMATS}` };
@@ -629,7 +632,7 @@ function registerPdfInspectCommand(program) {
 }
 //#endregion
 //#region package.json
-var version = "1.0.0";
+var version = "1.1.0";
 //#endregion
 //#region src/program.ts
 function createProgram() {

package/dist/{io-Cl3MaB0L.js → io-CKOE9Xda.js}

@@ -11,6 +11,8 @@ const EXTENSION_TO_FORMAT = {
 	ods: "ods",
 	odg: "odg",
 	odf: "odf",
+	markdown: "markdown",
+	md: "markdown",
 	pdf: "pdf"
 };
 const FORMAT_TO_EXTENSION = {
@@ -22,6 +24,7 @@ const FORMAT_TO_EXTENSION = {
 	ods: "ods",
 	odg: "odg",
 	odf: "odf",
+	markdown: "md",
 	pdf: "pdf"
 };
 function isDocumentFormat(value) {

package/dist/{tui-CucYgqmL.js → tui-Dywpifqx.js}

@@ -1,6 +1,6 @@
-import { a as inferFormatFromExtension, i as formatToExtension, t as readInput } from "./io-Cl3MaB0L.js";
+import { a as inferFormatFromExtension, i as formatToExtension, t as readInput } from "./io-CKOE9Xda.js";
 import { readFile, writeFile } from "node:fs/promises";
-import { createDocx, createOdg, createOdp, createOds, createOdt, createPptx, docxToPdf, hsqldbCellDisplayText, odgToPdf, odpToPdf, odsToPdf, odtToPdf, openDocx, openOdg, openOdp, openOds, openOdt, openPptx, pptxToPdf, readOdbTables, readOdgContent, readOdsContent, readPdf, rgbHexToColor } from "documents.js";
+import { createDocx, createOdg, createOdp, createOds, createOdt, createPptx, decodeMarkdownText, docxToPdf, encodeMarkdownText, hsqldbCellDisplayText, markdownToPdf, odgToPdf, odpToPdf, odsToPdf, odtToPdf, openDocx, openOdg, openOdp, openOds, openOdt, openPptx, pptxToPdf, readOdbTables, readOdgContent, readOdsContent, readPdf, rgbHexToColor } from "documents.js";
 import { basename, dirname, extname, join } from "node:path";
 import { cellReference, columnIndexToLetters, decodePackage } from "odf.js";
 import { readdirSync } from "node:fs";
@@ -29,8 +29,13 @@ function toPdfOptions(options) {
 }
 async function exportToPdf(openDocument, destinationPath, options) {
 	if (openDocument.format === "odb" || openDocument.format === "pdf") throw new Error(`A ${openDocument.format} document is already a read-only source; there is no export-to-PDF path for it`);
-	const bytes = openDocument.editor.toBytes();
 	const pdfOptions = toPdfOptions(options);
+	if (openDocument.format === "markdown") {
+		const pdfBytes = markdownToPdf(encodeMarkdownText(openDocument.source), pdfOptions);
+		await writeFile(destinationPath, pdfBytes);
+		return;
+	}
+	const bytes = openDocument.editor.toBytes();
 	const pdfBytes = convert(openDocument.format, bytes, pdfOptions);
 	await writeFile(destinationPath, pdfBytes);
 }
@@ -102,6 +107,11 @@ async function openDocumentAtPath(path) {
 			layout: readPdf(bytes),
 			path
 		};
+		case "markdown": return {
+			format,
+			source: decodeMarkdownText(bytes),
+			path
+		};
 		case "xlsx": throw new Error("documents.js has no xlsx editor; convert the workbook to ods first (xlsxToOds) and open that");
 		case "odf": throw new Error("A standalone .odf formula document has no editor; convert it to PDF (odfToPdf) instead");
 	}
@@ -142,6 +152,10 @@ function createNewDocument(format) {
 }
 async function saveDocumentTo(openDocument, path) {
 	if (openDocument.format === "odb" || openDocument.format === "pdf") 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.source));
+		return;
+	}
 	await writeFile(path, openDocument.editor.toBytes());
 }
 //#endregion
@@ -154,11 +168,18 @@ const EDITABLE_FORMATS = {
 	ods: true,
 	odg: true
 };
+const WRITABLE_FORMATS = {
+	...EDITABLE_FORMATS,
+	markdown: true
+};
 function isEditableFormat(value) {
 	return value in EDITABLE_FORMATS;
 }
-function isEditableDocument(document) {
-	return isEditableFormat(document.format);
+function isWritableFormat(value) {
+	return value in WRITABLE_FORMATS;
+}
+function isWritableDocument(document) {
+	return isWritableFormat(document.format);
 }
 function selectionKeyFor(screen) {
 	switch (screen.kind) {
@@ -171,7 +192,8 @@ function selectionKeyFor(screen) {
 		case "odbTableList":
 		case "pdfPageList":
 		case "exportOptions":
-		case "saveAsPrompt": return screen.kind;
+		case "saveAsPrompt":
+		case "markdownLineList": return screen.kind;
 		case "filePicker": return `filePicker:${screen.purpose}:${screen.cwd}`;
 		case "paragraphDetail":
 		case "tableView":
@@ -189,6 +211,7 @@ function selectionKeyFor(screen) {
 		case "shapeOrVectorDetail":
 		case "pdfItemDetail": return `${screen.kind}:${screen.pageIndex}:${screen.itemIndex}`;
 		case "odbTableRows": return `odbTableRows:${screen.tableName}`;
+		case "markdownLineEditor": return `markdownLineEditor:${screen.lineIndex}`;
 	}
 }
 function rootScreenForFormat(format) {
@@ -200,6 +223,7 @@ function rootScreenForFormat(format) {
 		case "ods": return { kind: "sheetList" };
 		case "odg": return { kind: "pageList" };
 		case "odb": return { kind: "odbTableList" };
+		case "markdown": return { kind: "markdownLineList" };
 		case "pdf": return { kind: "pdfPageList" };
 	}
 }
@@ -317,6 +341,11 @@ function documentWithPath(doc, path) {
 			tables: doc.tables,
 			path
 		};
+		case "markdown": return {
+			format: "markdown",
+			source: doc.source,
+			path
+		};
 		case "pdf": return {
 			format: "pdf",
 			layout: doc.layout,
@@ -367,6 +396,18 @@ function mutate(state, doc, apply) {
 		undoStack: pushSnapshot(state.undoStack, snapshot)
 	};
 }
+function mutateMarkdown(state, doc, source) {
+	const snapshot = encodeMarkdownText(doc.source);
+	return {
+		...state,
+		openDocument: {
+			...doc,
+			source
+		},
+		hasUnsavedChanges: true,
+		undoStack: pushSnapshot(state.undoStack, snapshot)
+	};
+}
 function wrongDocument(state, expected) {
 	return withStatus(state, "warning", `That action needs ${expected}; the open document is ${state.openDocument === void 0 ? "no document" : state.openDocument.format}`);
 }
@@ -395,6 +436,11 @@ function drawingDocument(state) {
 	if (doc === void 0) return;
 	return doc.format === "odg" ? doc : void 0;
 }
+function markdownDocument(state) {
+	const doc = state.openDocument;
+	if (doc === void 0) return;
+	return doc.format === "markdown" ? doc : void 0;
+}
 function paragraphAt(doc, blockIndex) {
 	return doc.editor.paragraphs()[blockIndex];
 }
@@ -771,6 +817,11 @@ function appReducer(state, action) {
 				action.vector.stroke = action.stroke;
 			});
 		}
+		case "SET_MARKDOWN_SOURCE": {
+			const doc = markdownDocument(state);
+			if (doc === void 0) return wrongDocument(state, "a markdown document");
+			return mutateMarkdown(state, doc, action.source);
+		}
 		case "APPEND_DIAGNOSTIC": return {
 			...state,
 			diagnostics: [...state.diagnostics, action.diagnostic]
@@ -802,9 +853,13 @@ function appReducer(state, action) {
 			if (doc.format === "odb" || doc.format === "pdf") 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" ? {
+				...doc,
+				source: decodeMarkdownText(snapshot)
+			} : reopenEditable(doc, snapshot);
 			return withStatus({
 				...state,
-				openDocument: reopenEditable(doc, snapshot),
+				openDocument: restored,
 				undoStack: state.undoStack.slice(0, -1),
 				hasUnsavedChanges: true
 			}, "info", "Undone");
@@ -2171,6 +2226,123 @@ function DocxBodyListScreen() {
 	return /* @__PURE__ */ jsx(ParagraphFamilyBodyList, { adapter });
 }
 //#endregion
+//#region src/tui/screens/editors/markdown/shared.ts
+function requireMarkdownDocument(openDocument) {
+	if (openDocument?.format !== "markdown") throw new Error("A markdown editing screen rendered without an open markdown document; the app router only reaches this screen group from markdownLineList, which is only ever the root screen of an open markdown document.");
+	return openDocument;
+}
+//#endregion
+//#region src/tui/screens/editors/markdown/line-list.tsx
+function MarkdownLineListScreen() {
+	const state = useAppState();
+	const dispatch = useAppDispatch();
+	const doc = requireMarkdownDocument(state.openDocument);
+	const query = state.searchQuery.trim().toLowerCase();
+	const allLines = doc.source.split("\n").map((line, lineIndex) => ({
+		line,
+		lineIndex
+	}));
+	const lines = query === "" ? allLines : allLines.filter((entry) => entry.line.toLowerCase().includes(query));
+	const { selectedIndex } = useNavigationInput({
+		itemCount: lines.length,
+		onSelect: (index) => {
+			const entry = lines[index];
+			if (entry === void 0) return;
+			dispatch({
+				type: "PUSH_SCREEN",
+				screen: {
+					kind: "markdownLineEditor",
+					lineIndex: entry.lineIndex
+				}
+			});
+		},
+		onBack: () => {
+			dispatch({ type: "POP_SCREEN" });
+		},
+		isActive: !anyOverlayOpen(state)
+	});
+	return /* @__PURE__ */ jsxs(Box, {
+		flexDirection: "column",
+		children: [/* @__PURE__ */ jsxs(Text, {
+			bold: true,
+			children: [
+				"Lines (",
+				lines.length,
+				" of ",
+				allLines.length,
+				")"
+			]
+		}), /* @__PURE__ */ jsx(ListView, {
+			items: lines,
+			selectedIndex,
+			emptyMessage: query === "" ? "This document has no lines." : `No lines match "${state.searchQuery}".`,
+			renderItem: ({ line, lineIndex }, isSelected) => /* @__PURE__ */ jsxs(Text, {
+				color: isSelected ? "cyan" : void 0,
+				inverse: isSelected,
+				children: [
+					lineIndex + 1,
+					": ",
+					line === "" ? "(blank)" : line
+				]
+			})
+		})]
+	});
+}
+//#endregion
+//#region src/tui/screens/editors/markdown/line-editor.tsx
+function MarkdownLineEditorScreen() {
+	const state = useAppState();
+	const dispatch = useAppDispatch();
+	const screen = currentScreen(state);
+	const doc = state.openDocument;
+	if (screen.kind !== "markdownLineEditor") return /* @__PURE__ */ jsx(Text, {
+		color: "red",
+		children: "MarkdownLineEditorScreen rendered outside a markdownLineEditor screen."
+	});
+	if (doc?.format !== "markdown") return /* @__PURE__ */ jsx(Text, {
+		color: "red",
+		children: "MarkdownLineEditorScreen requires an open markdown document."
+	});
+	const lines = doc.source.split("\n");
+	const line = lines[screen.lineIndex];
+	if (line === void 0) return /* @__PURE__ */ jsxs(Text, {
+		color: "red",
+		children: [
+			"There is no line at index ",
+			screen.lineIndex,
+			"."
+		]
+	});
+	return /* @__PURE__ */ jsxs(Box, {
+		flexDirection: "column",
+		children: [
+			/* @__PURE__ */ jsxs(Text, {
+				bold: true,
+				children: ["Edit line ", screen.lineIndex + 1]
+			}),
+			/* @__PURE__ */ jsx(RunTextEditor, {
+				initialText: line,
+				onCommit: (text) => {
+					const nextLines = [...lines];
+					nextLines[screen.lineIndex] = text;
+					dispatch({
+						type: "SET_MARKDOWN_SOURCE",
+						source: nextLines.join("\n")
+					});
+					dispatch({ type: "POP_SCREEN" });
+				},
+				onCancel: () => {
+					dispatch({ type: "POP_SCREEN" });
+				}
+			}),
+			/* @__PURE__ */ jsx(Text, {
+				dimColor: true,
+				children: "Enter to commit, Esc to discard"
+			})
+		]
+	});
+}
+//#endregion
 //#region src/tui/screens/editors/odb/shared.ts
 function requireOdbDocument(openDocument) {
 	if (openDocument?.format !== "odb") throw new Error("An .odb browsing screen rendered without an open .odb document; the app router only reaches this screen group from odbTableList, which is only ever the root screen of an open .odb document.");
@@ -5093,7 +5265,7 @@ function defaultBasenameFor(purpose, document) {
 	const sourcePath = document?.path;
 	const stem = sourcePath === void 0 ? "untitled" : basename(sourcePath, extname(sourcePath));
 	if (purpose === "exportTarget") return `${stem}.pdf`;
-	return document !== void 0 && isEditableDocument(document) ? `${stem}.${formatToExtension(document.format)}` : stem;
+	return document !== void 0 && isWritableDocument(document) ? `${stem}.${formatToExtension(document.format)}` : stem;
 }
 function titleFor(purpose) {
 	switch (purpose) {
@@ -5307,7 +5479,7 @@ function LauncherScreen() {
 			}),
 			/* @__PURE__ */ jsx(Text, {
 				dimColor: true,
-				children: "A terminal editor for docx, pptx, odt, odp, ods, odg, odb and pdf."
+				children: "A terminal editor for docx, pptx, odt, odp, ods, odg, markdown, odb and pdf."
 			}),
 			/* @__PURE__ */ jsx(Text, { children: " " }),
 			/* @__PURE__ */ jsxs(Text, { children: [/* @__PURE__ */ jsx(Text, {
@@ -5410,7 +5582,7 @@ function NewDocumentPickerScreen() {
 //#endregion
 //#region src/tui/screens/save-as-prompt.tsx
 function defaultDestinationFor(document, cwd) {
-	const extension = isEditableDocument(document) ? formatToExtension(document.format) : "bin";
+	const extension = isWritableDocument(document) ? formatToExtension(document.format) : "bin";
 	const suggestedName = document.path === void 0 ? `untitled.${extension}` : basename(document.path);
 	return join(cwd, suggestedName);
 }
@@ -5493,6 +5665,8 @@ function ScreenBody({ screen }) {
 		case "shapeOrVectorDetail": return /* @__PURE__ */ jsx(OdgShapeOrVectorDetailScreen, {});
 		case "odbTableList": return /* @__PURE__ */ jsx(OdbTableListScreen, {});
 		case "odbTableRows": return /* @__PURE__ */ jsx(OdbTableRowsScreen, {});
+		case "markdownLineList": return /* @__PURE__ */ jsx(MarkdownLineListScreen, {});
+		case "markdownLineEditor": return /* @__PURE__ */ jsx(MarkdownLineEditorScreen, {});
 		case "pdfPageList": return /* @__PURE__ */ jsx(PdfPageListScreen, {});
 		case "pdfPageItems": return /* @__PURE__ */ jsx(PdfPageItemsScreen, {});
 		case "pdfItemDetail": return /* @__PURE__ */ jsx(PdfItemDetailScreen, {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-cli",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "CLI and interactive Ink TUI for documents.js: every docx/pptx/odt/odp/ods/odg/odf/odm/odb conversion, bridge, and editor as a scriptable command or a terminal app.",
   "type": "module",
   "repository": {
@@ -72,7 +72,7 @@
   "packageManager": "pnpm@11.6.0",
   "dependencies": {
     "commander": "^15.0.0",
-    "documents.js": "^1.54.5",
+    "documents.js": "^1.60.0",
     "ink": "^7.1.1",
     "ink-text-input": "^6.0.0",
     "odf.js": "^1.10.4",