document-cli 1.3.0 → 1.5.0

package/dist/{tui-C8ITn1zQ.js → tui-B-o3iI9a.js}

@@ -1,8 +1,8 @@
-import { d as inferFormatFromExtension, i as formatOdbReportLines, l as loadProvidedFonts, n as describeOdbReport, o as readInput, r as formatOdbFormLines, t as describeOdbForm, u as formatToExtension } from "./odb-structure-CX_0zL8_.js";
+import { c as formatDocxExtrasLines, f as loadProvidedFonts, i as formatOdbReportLines, l as readInput, m as inferFormatFromExtension, n as describeOdbReport, o as formatMetadataLines, p as formatToExtension, r as formatOdbFormLines, t as describeOdbForm } from "./odb-structure-Du1w_hOU.js";
 import { readFile, writeFile } from "node:fs/promises";
-import { buildDocxPackage, buildOdtPackage, convertWordprocessingToLayout, createDocx, createFontMeasurer, createFontRegistry, createOdg, createOdp, createOds, createOdt, createPptx, decodeMarkdownText, docxToPdf, encodeMarkdownText, encodePackage, hsqldbCellDisplayText, markdownToPdf, odgToPdf, odpToPdf, odsToPdf, odtToPdf, openDocx, openOdg, openOdp, openOds, openOdt, openPptx, pptxToPdf, readOdbForms, readOdbReportContent, readOdbReports, readOdbTables, readOdgContent, readOdsContent, readPdf, rgbHexToColor, writePdf, xlsxToPdf } from "documents.js";
+import { buildDocxPackage, buildOdtPackage, convertWordprocessingToLayout, createDocx, createFontMeasurer, createFontRegistry, createOdg, createOdp, createOds, createOdt, createPptx, decodeMarkdownText, docxToPdf, encodeMarkdownText, encodePackage, hsqldbCellDisplayText, markdownToPdf, odgToPdf, odpToPdf, odsToPdf, odtToPdf, openDocx, openOdg, openOdp, openOds, openOdt, openPptx, pptxToPdf, readDocxContent, readDocxExtras, readMarkdownContent, readOdbForms, readOdbReportContent, readOdbReports, readOdbTables, readOdgContent, readOdpContent, readOdsContent, readOdtContent, readPdf, readPptxContent, rgbHexToColor, writePdf, xlsxToPdf } from "documents.js";
 import { basename, dirname, extname, join } from "node:path";
-import { cellReference, columnIndexToLetters, decodePackage, encodePackage as encodePackage$1 } from "odf.js";
+import { cellReference, columnIndexToLetters, decodePackage as decodePackage$1, encodePackage as encodePackage$1 } from "odf.js";
 import { readdirSync } from "node:fs";
 import { Box, Text, render, useApp, useInput, useWindowSize } from "ink";
 import { createContext, useContext, useEffect, useReducer, useState } from "react";
@@ -78,7 +78,7 @@ const ODB_EXTENSION = ".odb";
 async function openDocumentAtPath(path) {
 	const bytes = new Uint8Array(await readFile(path));
 	if (path.toLowerCase().endsWith(ODB_EXTENSION)) {
-		const pkg = decodePackage(bytes);
+		const pkg = decodePackage$1(bytes);
 		return {
 			format: "odb",
 			tables: readOdbTables(pkg),
@@ -209,6 +209,7 @@ function selectionKeyFor(screen) {
 		case "launcher":
 		case "newDocumentPicker":
 		case "bodyList":
+		case "docxExtras":
 		case "slideList":
 		case "sheetList":
 		case "pageList":
@@ -218,7 +219,8 @@ function selectionKeyFor(screen) {
 		case "pdfPageList":
 		case "exportOptions":
 		case "saveAsPrompt":
-		case "markdownLineList": return screen.kind;
+		case "markdownLineList":
+		case "metadata": return screen.kind;
 		case "filePicker": return `filePicker:${screen.purpose}:${screen.cwd}`;
 		case "paragraphDetail":
 		case "tableView":
@@ -1416,6 +1418,10 @@ const GLOBAL_KEYS = [
 		keys: "a",
 		description: "Append a new item to the current list"
 	},
+	{
+		keys: "m",
+		description: "Show the open document's metadata (read-only)"
+	},
 	{
 		keys: "Ctrl+S",
 		description: "Save the open document"
@@ -2261,6 +2267,12 @@ function DocxBodyListScreen() {
 	const state = useAppState();
 	const dispatch = useAppDispatch();
 	const doc = state.openDocument;
+	useInput((input) => {
+		if (input === "x" && doc?.format === "docx") dispatch({
+			type: "PUSH_SCREEN",
+			screen: { kind: "docxExtras" }
+		});
+	}, { isActive: doc?.format === "docx" && !anyOverlayOpen(state) });
 	if (doc?.format !== "docx") return /* @__PURE__ */ jsxs(Text, {
 		color: "red",
 		children: [
@@ -2278,6 +2290,65 @@ function DocxBodyListScreen() {
 	return /* @__PURE__ */ jsx(ParagraphFamilyBodyList, { adapter });
 }
 //#endregion
+//#region src/tui/screens/editors/docx/extras.tsx
+const DOCX_EXTRAS_RESERVED_ROWS = 5;
+function DocxExtrasScreen() {
+	const state = useAppState();
+	const dispatch = useAppDispatch();
+	const doc = state.openDocument;
+	const isDocx = doc?.format === "docx";
+	const extras = doc?.format === "docx" ? readDocxExtras(doc.editor.toPackage()) : void 0;
+	const allLines = extras === void 0 ? [] : formatDocxExtrasLines(extras);
+	const query = state.searchQuery.trim().toLowerCase();
+	const lines = query === "" ? allLines : allLines.filter((line) => line.toLowerCase().includes(query));
+	const { selectedIndex } = useNavigationInput({
+		itemCount: lines.length,
+		onSelect: () => {},
+		onBack: () => {
+			dispatch({ type: "POP_SCREEN" });
+		},
+		isActive: isDocx && !anyOverlayOpen(state)
+	});
+	if (!isDocx) return /* @__PURE__ */ jsxs(Text, {
+		color: "red",
+		children: [
+			"DocxExtrasScreen requires an open docx document, found ",
+			doc === void 0 ? "no open document" : doc.format,
+			"."
+		]
+	});
+	return /* @__PURE__ */ jsxs(Box, {
+		flexDirection: "column",
+		children: [
+			/* @__PURE__ */ jsxs(Text, {
+				bold: true,
+				children: [
+					"Comments, footnotes, headers, footers, numbering (",
+					lines.length,
+					" of ",
+					allLines.length,
+					" lines)"
+				]
+			}),
+			/* @__PURE__ */ jsx(ListView, {
+				items: lines,
+				selectedIndex,
+				reservedRows: DOCX_EXTRAS_RESERVED_ROWS,
+				emptyMessage: query === "" ? "This document carries no comments, footnotes, headers, footers, or numbering definitions." : `No lines match "${state.searchQuery}".`,
+				renderItem: (line, isSelected) => /* @__PURE__ */ jsx(Text, {
+					color: isSelected ? "cyan" : void 0,
+					inverse: isSelected,
+					children: line
+				})
+			}),
+			/* @__PURE__ */ jsx(Text, {
+				dimColor: true,
+				children: "Esc to go back to the body list"
+			})
+		]
+	});
+}
+//#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.");
@@ -2686,7 +2757,7 @@ async function renderOdbReportTo(doc, destinationPath, options) {
 	const format = detectFormat(destinationPath);
 	if (!isReportRenderTargetFormat(format)) throw new Error(`Cannot tell whether to render "${options.reportName}" as docx, odt, or pdf from '${destinationPath}' -- give the destination one of those three extensions`);
 	const fonts = await loadProvidedFonts(options.fontFiles ?? [], { signal: options.signal });
-	const pkg = decodePackage(new Uint8Array(await readFile(doc.path)));
+	const pkg = decodePackage$1(new Uint8Array(await readFile(doc.path)));
 	const bytes = renderReportBytes(readOdbReportContent(pkg, { report: options.reportName }), format, fonts, options);
 	await writeFile(destinationPath, bytes);
 }
@@ -6174,6 +6245,67 @@ function SaveAsPromptScreen() {
 	});
 }
 //#endregion
+//#region src/tui/format/read-metadata.ts
+function metadataFor(doc) {
+	switch (doc.format) {
+		case "docx": return readDocxContent(doc.editor.toPackage()).metadata;
+		case "pptx": return readPptxContent(doc.editor.toPackage()).metadata;
+		case "odt": return readOdtContent(doc.editor.toPackage()).metadata;
+		case "odp": return readOdpContent(doc.editor.toPackage()).metadata;
+		case "ods": return readOdsContent(doc.editor.toPackage()).metadata;
+		case "odg": return readOdgContent(doc.editor.toPackage()).metadata;
+		case "markdown": return readMarkdownContent(doc.source).metadata;
+		case "pdf":
+		case "xlsx": 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.");
+	}
+}
+//#endregion
+//#region src/tui/screens/shared/metadata.tsx
+function MetadataScreen() {
+	const state = useAppState();
+	const dispatch = useAppDispatch();
+	const doc = state.openDocument;
+	useInput((input, key) => {
+		if (key.escape || key.leftArrow || input === "h") dispatch({ type: "POP_SCREEN" });
+	}, { isActive: doc !== void 0 && !anyOverlayOpen(state) });
+	if (doc === void 0) return /* @__PURE__ */ jsx(Text, {
+		color: "red",
+		children: "MetadataScreen requires an open document."
+	});
+	let lines;
+	let errorMessage;
+	try {
+		lines = formatMetadataLines(metadataFor(doc));
+	} catch (error) {
+		errorMessage = error instanceof Error ? error.message : String(error);
+	}
+	return /* @__PURE__ */ jsxs(Box, {
+		flexDirection: "column",
+		children: [
+			/* @__PURE__ */ jsxs(Text, {
+				bold: true,
+				children: [
+					"Document metadata (",
+					doc.format,
+					")"
+				]
+			}),
+			errorMessage !== void 0 ? /* @__PURE__ */ jsx(Text, {
+				color: "yellow",
+				children: errorMessage
+			}) : lines !== void 0 && lines.length > 0 ? lines.map((line) => /* @__PURE__ */ jsx(Text, { children: line }, line)) : /* @__PURE__ */ jsx(Text, {
+				dimColor: true,
+				children: "This document carries no metadata."
+			}),
+			/* @__PURE__ */ jsx(Text, {
+				dimColor: true,
+				children: "Esc / ← / h to go back"
+			})
+		]
+	});
+}
+//#endregion
 //#region src/tui/app.tsx
 function App(props) {
 	return /* @__PURE__ */ jsx(AppStateProvider, {
@@ -6188,6 +6320,7 @@ function ScreenBody({ screen }) {
 		case "filePicker": return /* @__PURE__ */ jsx(FilePickerScreen, {});
 		case "newDocumentPicker": return /* @__PURE__ */ jsx(NewDocumentPickerScreen, {});
 		case "bodyList": return format === "odt" ? /* @__PURE__ */ jsx(OdtBodyListScreen, {}) : /* @__PURE__ */ jsx(DocxBodyListScreen, {});
+		case "docxExtras": return /* @__PURE__ */ jsx(DocxExtrasScreen, {});
 		case "paragraphDetail": return /* @__PURE__ */ jsx(ParagraphDetailScreen, {});
 		case "runEditor": return /* @__PURE__ */ jsx(RunEditorScreen, {});
 		case "tableView": return /* @__PURE__ */ jsx(TableViewScreen, {});
@@ -6218,6 +6351,7 @@ function ScreenBody({ screen }) {
 		case "pdfItemDetail": return /* @__PURE__ */ jsx(PdfItemDetailScreen, {});
 		case "exportOptions": return /* @__PURE__ */ jsx(ExportOptionsScreen, {});
 		case "saveAsPrompt": return /* @__PURE__ */ jsx(SaveAsPromptScreen, {});
+		case "metadata": return /* @__PURE__ */ jsx(MetadataScreen, {});
 	}
 }
 function Overlay({ state }) {
@@ -6328,10 +6462,27 @@ function AppShell({ startPath }) {
 			});
 			return;
 		}
-		if (key.ctrl && input === "d") dispatch({
-			type: "OPEN_OVERLAY",
-			overlay: "diagnosticsPanel"
-		});
+		if (key.ctrl && input === "d") {
+			dispatch({
+				type: "OPEN_OVERLAY",
+				overlay: "diagnosticsPanel"
+			});
+			return;
+		}
+		if (input === "m") {
+			if (state.openDocument === void 0) {
+				dispatch({
+					type: "SET_STATUS",
+					severity: "warning",
+					text: "There is no open document to show metadata for"
+				});
+				return;
+			}
+			dispatch({
+				type: "PUSH_SCREEN",
+				screen: { kind: "metadata" }
+			});
+		}
 	}, { isActive: !overlayOpen });
 	return /* @__PURE__ */ jsxs(Box, {
 		flexDirection: "column",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-cli",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "CLI and interactive Ink TUI for documents.js: every docx/pptx/odt/odp/ods/odg/odf/pdf/odm/odb/xlsx/markdown conversion, bridge, and editor as a scriptable command or a terminal app.",
   "type": "module",
   "repository": {