odf.js 1.12.0 → 1.13.0

package/dist/typed/odp/read.js

@@ -0,0 +1,38 @@
+import { childrenWithTag, elementsWithTag, findChildElement, rootElement } from "../../xml/query.js";
+import { decodeOdfText } from "../shared/text.js";
+import { readOdfMetadata } from "../shared/metadata.js";
+import { resolveDrawPageSize } from "../shared/masterpage.js";
+import { walkDrawShapes } from "../draw/shapes.js";
+import { SLIDE_SIZE_WIDESCREEN } from "document-schema.js";
+//#region src/typed/odp/read.ts
+const CONTENT_PART = "content.xml";
+function readSlideSize(page, pkg) {
+	return resolveDrawPageSize(page, pkg) ?? SLIDE_SIZE_WIDESCREEN;
+}
+function readSlideNotes(page) {
+	const notes = childrenWithTag(page, "presentation:notes")[0];
+	if (notes === void 0) return "";
+	return elementsWithTag(notes.children, "text:p").map(decodeOdfText).join("\n");
+}
+function readSlide(page, pkg) {
+	const shapes = [];
+	walkDrawShapes(page.children, [], pkg, shapes);
+	return {
+		size: readSlideSize(page, pkg),
+		shapes,
+		notes: readSlideNotes(page)
+	};
+}
+function readOdp(pkg) {
+	const contentPart = pkg.parts[CONTENT_PART];
+	const root = contentPart?.kind === "xml" ? rootElement(contentPart.nodes) : void 0;
+	const body = root === void 0 ? void 0 : findChildElement(root.children, "office:body");
+	const presentation = body === void 0 ? void 0 : findChildElement(body.children, "office:presentation");
+	const pages = presentation === void 0 ? [] : childrenWithTag(presentation, "draw:page");
+	return {
+		metadata: readOdfMetadata(pkg),
+		slides: pages.map((page) => readSlide(page, pkg))
+	};
+}
+//#endregion
+export { readOdp };

package/dist/typed/ods/read.cjs

@@ -0,0 +1,318 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_typed_shared_units = require("../shared/units.cjs");
+const require_xml_query = require("../../xml/query.cjs");
+const require_typed_shared_a1 = require("../shared/a1.cjs");
+const require_typed_shared_geometry = require("../shared/geometry.cjs");
+const require_typed_shared_cascade = require("../shared/cascade.cjs");
+const require_typed_shared_metadata = require("../shared/metadata.cjs");
+const require_typed_shared_paragraph = require("../shared/paragraph.cjs");
+const require_typed_shared_masterpage = require("../shared/masterpage.cjs");
+let document_schema_js = require("document-schema.js");
+//#region src/typed/ods/read.ts
+const CONTENT_PART = "content.xml";
+function parseKnownOdfLength(value) {
+	const parsed = require_typed_shared_units.parseOdfLength(value);
+	if (parsed === void 0) throw new Error(`readOds: internal error -- "${value}" is not a valid ODF length literal`);
+	return parsed;
+}
+const DEFAULT_MARGIN_PT = parseKnownOdfLength("2cm");
+const DEFAULT_MARGINS = {
+	topPt: DEFAULT_MARGIN_PT,
+	rightPt: DEFAULT_MARGIN_PT,
+	bottomPt: DEFAULT_MARGIN_PT,
+	leftPt: DEFAULT_MARGIN_PT
+};
+function readRepeatCount(element, attrName) {
+	const raw = require_xml_query.attrValue(element, attrName);
+	if (raw === void 0) return 1;
+	const parsed = Number.parseInt(raw, 10);
+	return Number.isInteger(parsed) && parsed > 0 ? parsed : 1;
+}
+function isHidden(element) {
+	return require_xml_query.attrValue(element, "table:visibility") === "collapse";
+}
+function readColumnLayout(columnElement, pkg) {
+	const styleName = require_xml_query.attrValue(columnElement, "table:style-name");
+	const styleElement = styleName === void 0 ? void 0 : require_typed_shared_cascade.findStyleElement(styleName, "table-column", pkg);
+	const properties = styleElement === void 0 ? void 0 : require_xml_query.childrenWithTag(styleElement, "style:table-column-properties")[0];
+	const widthValue = properties === void 0 ? void 0 : require_xml_query.attrValue(properties, "style:column-width");
+	return {
+		widthPt: widthValue === void 0 ? 0 : require_typed_shared_units.parseOdfLength(widthValue) ?? 0,
+		manualBreak: (properties === void 0 ? void 0 : require_xml_query.attrValue(properties, "fo:break-before")) === "page"
+	};
+}
+function readRowLayout(rowElement, pkg) {
+	const styleName = require_xml_query.attrValue(rowElement, "table:style-name");
+	const styleElement = styleName === void 0 ? void 0 : require_typed_shared_cascade.findStyleElement(styleName, "table-row", pkg);
+	const properties = styleElement === void 0 ? void 0 : require_xml_query.childrenWithTag(styleElement, "style:table-row-properties")[0];
+	const heightValue = properties === void 0 ? void 0 : require_xml_query.attrValue(properties, "style:row-height");
+	return {
+		heightPt: heightValue === void 0 ? 0 : require_typed_shared_units.parseOdfLength(heightValue) ?? 0,
+		manualBreak: (properties === void 0 ? void 0 : require_xml_query.attrValue(properties, "fo:break-before")) === "page"
+	};
+}
+function readCellText(cellElement, pkg) {
+	const paragraphs = require_xml_query.childrenWithTag(cellElement, "text:p");
+	const runs = [];
+	paragraphs.forEach((paragraph, index) => {
+		if (index > 0) runs.push({ text: "\n" });
+		runs.push(...require_typed_shared_paragraph.readOdfParagraph(paragraph, pkg).runs);
+	});
+	return {
+		runs,
+		displayText: runs.map((run) => run.text).join("")
+	};
+}
+function readCellValue(cellElement, displayText) {
+	const valueType = require_xml_query.attrValue(cellElement, "office:value-type");
+	const stringFallback = {
+		kind: "string",
+		value: displayText
+	};
+	switch (valueType) {
+		case "float": {
+			const value = parseRequiredNumber(require_xml_query.attrValue(cellElement, "office:value"));
+			return value === void 0 ? stringFallback : {
+				kind: "number",
+				value
+			};
+		}
+		case "percentage": {
+			const value = parseRequiredNumber(require_xml_query.attrValue(cellElement, "office:value"));
+			return value === void 0 ? stringFallback : {
+				kind: "percentage",
+				value
+			};
+		}
+		case "currency": {
+			const value = parseRequiredNumber(require_xml_query.attrValue(cellElement, "office:value"));
+			if (value === void 0) return stringFallback;
+			const currency = require_xml_query.attrValue(cellElement, "office:currency");
+			return currency === void 0 ? {
+				kind: "currency",
+				value
+			} : {
+				kind: "currency",
+				value,
+				currency
+			};
+		}
+		case "boolean": {
+			const raw = require_xml_query.attrValue(cellElement, "office:boolean-value");
+			return raw === void 0 ? stringFallback : {
+				kind: "boolean",
+				value: raw === "true"
+			};
+		}
+		case "date": return {
+			kind: "date",
+			value: require_xml_query.attrValue(cellElement, "office:date-value") ?? displayText
+		};
+		case "time": return {
+			kind: "time",
+			value: require_xml_query.attrValue(cellElement, "office:time-value") ?? displayText
+		};
+		case "string": return {
+			kind: "string",
+			value: require_xml_query.attrValue(cellElement, "office:string-value") ?? displayText
+		};
+		default: return { kind: "empty" };
+	}
+}
+function parseRequiredNumber(raw) {
+	if (raw === void 0) return;
+	const value = Number(raw);
+	return Number.isNaN(value) ? void 0 : value;
+}
+function parsePrintRanges(value) {
+	const first = value.split(" ").find((part) => part.length > 0);
+	if (first === void 0) return;
+	const separatorIndex = first.indexOf(":");
+	if (separatorIndex === -1) return;
+	const start = parseA1WithOptionalSheetPrefix(first.slice(0, separatorIndex));
+	const end = parseA1WithOptionalSheetPrefix(first.slice(separatorIndex + 1));
+	if (start === void 0 || end === void 0) return;
+	return {
+		startRow: start.row,
+		startColumn: start.column,
+		endRow: end.row,
+		endColumn: end.column
+	};
+}
+function parseA1WithOptionalSheetPrefix(cellPart) {
+	const dotIndex = cellPart.lastIndexOf(".");
+	const bareReference = dotIndex === -1 ? cellPart : cellPart.slice(dotIndex + 1);
+	return require_typed_shared_a1.parseCellReference(bareReference);
+}
+function parseScalePercentage(value) {
+	const match = /^(\d+(?:\.\d+)?)%$/.exec(value);
+	if (match === null) return;
+	const numeric = match[1];
+	return numeric === void 0 ? void 0 : Number(numeric);
+}
+function parseNonNegativeInteger(value) {
+	if (value === void 0) return;
+	const parsed = Number.parseInt(value, 10);
+	return Number.isInteger(parsed) && parsed >= 0 ? parsed : void 0;
+}
+function readTable(tableElement, pkg) {
+	const columns = [];
+	const rows = [];
+	const cells = [];
+	const manualBreakRows = [];
+	const manualBreakColumns = [];
+	let repeatColumns;
+	let repeatRows;
+	let columnCursor = 0;
+	const cursor = new require_typed_shared_a1.TableCursor();
+	function processColumn(columnElement) {
+		const { widthPt, manualBreak } = readColumnLayout(columnElement, pkg);
+		columns.push({
+			index: columnCursor,
+			widthPt,
+			hidden: isHidden(columnElement) ? true : void 0
+		});
+		if (manualBreak) manualBreakColumns.push(columnCursor);
+		columnCursor += readRepeatCount(columnElement, "table:number-columns-repeated");
+	}
+	function processRowCells(rowElement) {
+		for (const child of rowElement.children) {
+			if (child.type !== "element") continue;
+			if (child.tag === "table:covered-table-cell") cursor.nextCell(readRepeatCount(child, "table:number-columns-repeated"));
+			else if (child.tag === "table:table-cell") {
+				const columnIndex = cursor.columnIndex;
+				const rowIndex = cursor.rowIndex;
+				cursor.nextCell(readRepeatCount(child, "table:number-columns-repeated"));
+				const formula = require_xml_query.attrValue(child, "table:formula");
+				const { runs, displayText } = readCellText(child, pkg);
+				if (!(require_xml_query.attrValue(child, "office:value-type") !== void 0) && formula === void 0 && displayText.length === 0) continue;
+				const value = readCellValue(child, displayText);
+				const colSpan = parseNonNegativeInteger(require_xml_query.attrValue(child, "table:number-columns-spanned"));
+				const rowSpan = parseNonNegativeInteger(require_xml_query.attrValue(child, "table:number-rows-spanned"));
+				const cell = {
+					row: rowIndex,
+					column: columnIndex,
+					value,
+					displayText
+				};
+				if (formula !== void 0) cell.formula = formula;
+				if (runs.length > 0) cell.runs = runs;
+				if (colSpan !== void 0) cell.colSpan = colSpan;
+				if (rowSpan !== void 0) cell.rowSpan = rowSpan;
+				cells.push(cell);
+			}
+		}
+	}
+	function processRow(rowElement) {
+		const startIndex = cursor.rowIndex;
+		processRowCells(rowElement);
+		const { heightPt, manualBreak } = readRowLayout(rowElement, pkg);
+		rows.push({
+			index: startIndex,
+			heightPt,
+			hidden: isHidden(rowElement) ? true : void 0
+		});
+		if (manualBreak) manualBreakRows.push(startIndex);
+		cursor.nextRow(readRepeatCount(rowElement, "table:number-rows-repeated"));
+	}
+	for (const child of tableElement.children) {
+		if (child.type !== "element") continue;
+		if (child.tag === "table:table-column") processColumn(child);
+		else if (child.tag === "table:table-header-columns") {
+			const startIndex = columnCursor;
+			for (const headerChild of child.children) if (headerChild.type === "element" && headerChild.tag === "table:table-column") processColumn(headerChild);
+			if (columnCursor > startIndex) repeatColumns = {
+				start: startIndex,
+				end: columnCursor - 1
+			};
+		} else if (child.tag === "table:table-row") processRow(child);
+		else if (child.tag === "table:table-header-rows") {
+			const startIndex = cursor.rowIndex;
+			for (const headerChild of child.children) if (headerChild.type === "element" && headerChild.tag === "table:table-row") processRow(headerChild);
+			if (cursor.rowIndex > startIndex) repeatRows = {
+				start: startIndex,
+				end: cursor.rowIndex - 1
+			};
+		}
+	}
+	return {
+		columns,
+		rows,
+		cells,
+		repeatColumns,
+		repeatRows,
+		manualBreakRows,
+		manualBreakColumns
+	};
+}
+function readPrintSettings(tableElement, pkg, repeatColumns, repeatRows, manualBreakRows, manualBreakColumns) {
+	const tableStyleName = require_xml_query.attrValue(tableElement, "table:style-name");
+	const tableStyleElement = tableStyleName === void 0 ? void 0 : require_typed_shared_cascade.findStyleElement(tableStyleName, "table", pkg);
+	const masterPageName = tableStyleElement === void 0 ? void 0 : require_xml_query.attrValue(tableStyleElement, "style:master-page-name");
+	const layoutProperties = require_typed_shared_masterpage.resolvePageLayoutProperties(pkg, masterPageName);
+	const pageSize = layoutProperties === void 0 ? void 0 : require_typed_shared_geometry.parsePageSize(layoutProperties);
+	const margins = layoutProperties === void 0 ? void 0 : require_typed_shared_geometry.parseMargins(layoutProperties);
+	const printTokens = new Set((layoutProperties === void 0 ? void 0 : require_xml_query.attrValue(layoutProperties, "style:print"))?.split(" ").filter((token) => token.length > 0));
+	const pageOrder = (layoutProperties === void 0 ? void 0 : require_xml_query.attrValue(layoutProperties, "style:print-page-order")) === "ltr" ? "overThenDown" : "downThenOver";
+	const scaleToRaw = layoutProperties === void 0 ? void 0 : require_xml_query.attrValue(layoutProperties, "style:scale-to");
+	const scale = scaleToRaw === void 0 ? void 0 : parseScalePercentage(scaleToRaw);
+	const scaleToXRaw = layoutProperties === void 0 ? void 0 : require_xml_query.attrValue(layoutProperties, "style:scale-to-X");
+	const scaleToYRaw = layoutProperties === void 0 ? void 0 : require_xml_query.attrValue(layoutProperties, "style:scale-to-Y");
+	const fitWidth = parseNonNegativeInteger(scaleToXRaw);
+	const fitHeight = parseNonNegativeInteger(scaleToYRaw);
+	const fitToPages = fitWidth === void 0 || fitHeight === void 0 ? void 0 : {
+		width: fitWidth,
+		height: fitHeight
+	};
+	const printRangesRaw = require_xml_query.attrValue(tableElement, "table:print-ranges");
+	const printRange = printRangesRaw === void 0 ? void 0 : parsePrintRanges(printRangesRaw);
+	const manualBreaks = manualBreakRows.length > 0 || manualBreakColumns.length > 0 ? {
+		rows: manualBreakRows,
+		columns: manualBreakColumns
+	} : void 0;
+	const settings = {
+		pageSize: pageSize ?? document_schema_js.PAGE_SIZE_A4,
+		margins: margins ?? DEFAULT_MARGINS,
+		gridlines: printTokens.has("grid"),
+		headers: printTokens.has("headers"),
+		pageOrder
+	};
+	if (printRange !== void 0) settings.printRange = printRange;
+	if (scale !== void 0) settings.scale = scale;
+	if (fitToPages !== void 0) settings.fitToPages = fitToPages;
+	if (repeatRows !== void 0) settings.repeatRows = repeatRows;
+	if (repeatColumns !== void 0) settings.repeatColumns = repeatColumns;
+	if (manualBreaks !== void 0) settings.manualBreaks = manualBreaks;
+	return settings;
+}
+function readSheet(tableElement, pkg) {
+	const name = require_xml_query.attrValue(tableElement, "table:name");
+	if (name === void 0) return;
+	const { columns, rows, cells, repeatColumns, repeatRows, manualBreakRows, manualBreakColumns } = readTable(tableElement, pkg);
+	return {
+		name,
+		cells,
+		columns,
+		rows,
+		images: [],
+		printSettings: readPrintSettings(tableElement, pkg, repeatColumns, repeatRows, manualBreakRows, manualBreakColumns)
+	};
+}
+function readOds(pkg) {
+	const contentPart = pkg.parts[CONTENT_PART];
+	const root = contentPart?.kind === "xml" ? require_xml_query.rootElement(contentPart.nodes) : void 0;
+	const body = root === void 0 ? void 0 : require_xml_query.findChildElement(root.children, "office:body");
+	const spreadsheet = body === void 0 ? void 0 : require_xml_query.findChildElement(body.children, "office:spreadsheet");
+	const tables = spreadsheet === void 0 ? [] : require_xml_query.childrenWithTag(spreadsheet, "table:table");
+	const sheets = [];
+	for (const table of tables) {
+		const sheet = readSheet(table, pkg);
+		if (sheet !== void 0) sheets.push(sheet);
+	}
+	return {
+		metadata: require_typed_shared_metadata.readOdfMetadata(pkg),
+		sheets
+	};
+}
+//#endregion
+exports.readOds = readOds;

package/dist/typed/ods/read.d.cts

@@ -0,0 +1,10 @@
+import { Package } from "../../model/package.cjs";
+import { ContentSheet, LayoutMetadata } from "document-schema.js";
+//#region src/typed/ods/read.d.ts
+interface OdsDocument {
+  metadata: LayoutMetadata;
+  sheets: ContentSheet[];
+}
+declare function readOds(pkg: Package): OdsDocument;
+//#endregion
+export { OdsDocument, readOds };

package/dist/typed/ods/read.d.ts

@@ -0,0 +1,10 @@
+import { Package } from "../../model/package.js";
+import { ContentSheet, LayoutMetadata } from "document-schema.js";
+//#region src/typed/ods/read.d.ts
+interface OdsDocument {
+  metadata: LayoutMetadata;
+  sheets: ContentSheet[];
+}
+declare function readOds(pkg: Package): OdsDocument;
+//#endregion
+export { OdsDocument, readOds };