odf.js 1.13.2 → 2.1.0

package/dist/typed/ods/read.js

@@ -2,11 +2,18 @@ import { parseOdfLength } from "../shared/units.js";
 import { attrValue, childrenWithTag, findChildElement, rootElement } from "../../xml/query.js";
 import { TableCursor, parseCellReference } from "../shared/a1.js";
 import { parseMargins, parsePageSize } from "../shared/geometry.js";
-import { findStyleElement } from "../shared/cascade.js";
+import { findStyleElement, resolveStyleElementChain } from "../shared/cascade.js";
 import { readOdfMetadata } from "../shared/metadata.js";
 import { readOdfParagraph } from "../shared/paragraph.js";
+import { readCellStyleDecoration } from "../shared/table.js";
+import { parseOdfTransform } from "../shared/transform.js";
 import { resolvePageLayoutProperties } from "../shared/masterpage.js";
-import { PAGE_SIZE_A4 } from "document-schema.js";
+import { readDrawFrame } from "../draw/shapes.js";
+import { readDrawObjectReference } from "../draw/embedded.js";
+import { readOdp } from "../odp/read.js";
+import { readOdt } from "../odt/read.js";
+import { readOdg } from "../odg/read.js";
+import { CONTENT_FORMAT_VERSION, PAGE_SIZE_A4 } from "document-schema.js";
 //#region src/typed/ods/read.ts
 const CONTENT_PART = "content.xml";
 function parseKnownOdfLength(value) {
@@ -154,10 +161,84 @@ function parseNonNegativeInteger(value) {
 	const parsed = Number.parseInt(value, 10);
 	return Number.isInteger(parsed) && parsed >= 0 ? parsed : void 0;
 }
+function readEmbeddedObjectDocument(reference) {
+	switch (reference.objectKind) {
+		case "wordprocessing": {
+			const { metadata, sections } = readOdt(reference.package);
+			return {
+				kind: "wordprocessing",
+				formatVersion: CONTENT_FORMAT_VERSION,
+				metadata,
+				sections
+			};
+		}
+		case "presentation": {
+			const { metadata, slides } = readOdp(reference.package);
+			return {
+				kind: "presentation",
+				formatVersion: CONTENT_FORMAT_VERSION,
+				metadata,
+				slides
+			};
+		}
+		case "drawing": {
+			const { metadata, pages } = readOdg(reference.package);
+			return {
+				kind: "drawing",
+				formatVersion: CONTENT_FORMAT_VERSION,
+				metadata,
+				pages
+			};
+		}
+		case "spreadsheet": {
+			const { metadata, sheets } = readOds(reference.package);
+			return {
+				kind: "spreadsheet",
+				formatVersion: CONTENT_FORMAT_VERSION,
+				metadata,
+				sheets
+			};
+		}
+	}
+}
+function collectAnchoredFrame(frameElement, groupFunctions, pkg, anchorRow, anchorColumn, images, embeddedObjects) {
+	const shape = readDrawFrame(frameElement, groupFunctions, pkg);
+	if (shape === void 0) return;
+	const reference = readDrawObjectReference(frameElement, pkg);
+	if (reference !== void 0) {
+		embeddedObjects.push({
+			objectKind: reference.objectKind,
+			document: readEmbeddedObjectDocument(reference),
+			frame: shape.frame
+		});
+		return;
+	}
+	for (const block of shape.blocks) if (block.kind === "image") images.push({
+		...block,
+		anchorRow,
+		anchorColumn,
+		offsetXPt: shape.frame.xPt,
+		offsetYPt: shape.frame.yPt
+	});
+}
+function collectAnchoredFrames(children, groupFunctions, pkg, anchorRow, anchorColumn, images, embeddedObjects) {
+	for (const child of children) {
+		if (child.type !== "element") continue;
+		if (child.tag === "draw:frame") collectAnchoredFrame(child, groupFunctions, pkg, anchorRow, anchorColumn, images, embeddedObjects);
+		else if (child.tag === "draw:g") {
+			const ownValue = attrValue(child, "draw:transform");
+			const ownFunctions = ownValue === void 0 ? [] : parseOdfTransform(ownValue);
+			const nested = ownFunctions.length === 0 ? groupFunctions : [...ownFunctions, ...groupFunctions];
+			collectAnchoredFrames(child.children, nested, pkg, anchorRow, anchorColumn, images, embeddedObjects);
+		}
+	}
+}
 function readTable(tableElement, pkg) {
 	const columns = [];
 	const rows = [];
 	const cells = [];
+	const images = [];
+	const embeddedObjects = [];
 	const manualBreakRows = [];
 	const manualBreakColumns = [];
 	let repeatColumns;
@@ -182,6 +263,7 @@ function readTable(tableElement, pkg) {
 				const columnIndex = cursor.columnIndex;
 				const rowIndex = cursor.rowIndex;
 				cursor.nextCell(readRepeatCount(child, "table:number-columns-repeated"));
+				collectAnchoredFrames(child.children, [], pkg, rowIndex, columnIndex, images, embeddedObjects);
 				const formula = attrValue(child, "table:formula");
 				const { runs, displayText } = readCellText(child, pkg);
 				if (!(attrValue(child, "office:value-type") !== void 0) && formula === void 0 && displayText.length === 0) continue;
@@ -198,6 +280,13 @@ function readTable(tableElement, pkg) {
 				if (runs.length > 0) cell.runs = runs;
 				if (colSpan !== void 0) cell.colSpan = colSpan;
 				if (rowSpan !== void 0) cell.rowSpan = rowSpan;
+				const cellStyleName = attrValue(child, "table:style-name");
+				const { elements: cellStyleChain } = resolveStyleElementChain(cellStyleName, "table-cell", pkg);
+				const decoration = readCellStyleDecoration(cellStyleChain);
+				if (decoration.background !== void 0) cell.background = decoration.background;
+				if (decoration.borders !== void 0) cell.borders = decoration.borders;
+				if (decoration.alignment !== void 0) cell.alignment = decoration.alignment;
+				if (decoration.verticalAlignment !== void 0) cell.verticalAlignment = decoration.verticalAlignment;
 				cells.push(cell);
 			}
 		}
@@ -216,7 +305,8 @@ function readTable(tableElement, pkg) {
 	}
 	for (const child of tableElement.children) {
 		if (child.type !== "element") continue;
-		if (child.tag === "table:table-column") processColumn(child);
+		if (child.tag === "table:shapes") collectAnchoredFrames(child.children, [], pkg, 0, 0, images, embeddedObjects);
+		else 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);
@@ -238,6 +328,8 @@ function readTable(tableElement, pkg) {
 		columns,
 		rows,
 		cells,
+		images,
+		embeddedObjects,
 		repeatColumns,
 		repeatRows,
 		manualBreakRows,
@@ -287,15 +379,17 @@ function readPrintSettings(tableElement, pkg, repeatColumns, repeatRows, manualB
 function readSheet(tableElement, pkg) {
 	const name = attrValue(tableElement, "table:name");
 	if (name === void 0) return;
-	const { columns, rows, cells, repeatColumns, repeatRows, manualBreakRows, manualBreakColumns } = readTable(tableElement, pkg);
-	return {
+	const { columns, rows, cells, images, embeddedObjects, repeatColumns, repeatRows, manualBreakRows, manualBreakColumns } = readTable(tableElement, pkg);
+	const sheet = {
 		name,
 		cells,
 		columns,
 		rows,
-		images: [],
+		images,
 		printSettings: readPrintSettings(tableElement, pkg, repeatColumns, repeatRows, manualBreakRows, manualBreakColumns)
 	};
+	if (embeddedObjects.length > 0) sheet.embeddedObjects = embeddedObjects;
+	return sheet;
 }
 function readOds(pkg) {
 	const contentPart = pkg.parts[CONTENT_PART];

package/dist/typed/shared/table.cjs

@@ -25,22 +25,108 @@ function resolveRowHeightPt(rowElement, pkg) {
 	const heightValue = props === void 0 ? void 0 : require_xml_query.attrValue(props, "style:row-height");
 	return heightValue === void 0 ? void 0 : require_typed_shared_units.parseOdfLength(heightValue);
 }
-function readTableCellBackground(cellElement, pkg) {
-	const styleName = require_xml_query.attrValue(cellElement, "table:style-name");
-	const styleElement = styleName === void 0 ? void 0 : require_typed_shared_cascade.findStyleElement(styleName, "table-cell", pkg);
-	const props = styleElement === void 0 ? void 0 : require_xml_query.childrenWithTag(styleElement, "style:table-cell-properties")[0];
-	const value = props === void 0 ? void 0 : require_xml_query.attrValue(props, "fo:background-color");
-	return value === void 0 ? void 0 : require_typed_shared_color.parseOdfColor(value);
+const BORDER_STYLE_MAP = {
+	solid: "solid",
+	dashed: "dashed",
+	dotted: "dotted",
+	double: "double"
+};
+const BORDER_EDGE_KEYS = [
+	"left",
+	"right",
+	"top",
+	"bottom"
+];
+const BORDER_EDGE_ATTRS = {
+	left: "fo:border-left",
+	right: "fo:border-right",
+	top: "fo:border-top",
+	bottom: "fo:border-bottom"
+};
+function isVerticalAlign(value) {
+	return value === "top" || value === "middle" || value === "bottom";
+}
+function parseBorderEdge(value) {
+	const tokens = value.trim().split(/\s+/);
+	if (tokens.length !== 3) return;
+	const [widthToken, styleToken, colorToken] = tokens;
+	if (widthToken === void 0 || styleToken === void 0 || colorToken === void 0) return;
+	if (styleToken === "none" || styleToken === "hidden") return { none: true };
+	const widthPt = require_typed_shared_units.parseOdfLength(widthToken);
+	const color = require_typed_shared_color.parseOdfColor(colorToken);
+	if (widthPt === void 0 || widthPt <= 0 || color === void 0) return;
+	const style = BORDER_STYLE_MAP[styleToken];
+	return { border: style === void 0 ? {
+		color,
+		widthPt
+	} : {
+		color,
+		widthPt,
+		style
+	} };
+}
+function applyBorderEdgeUpdates(accumulated, cellProperties) {
+	const shorthandValue = require_xml_query.attrValue(cellProperties, "fo:border");
+	const shorthandUpdate = shorthandValue === void 0 ? void 0 : parseBorderEdge(shorthandValue);
+	if (shorthandUpdate !== void 0) for (const edge of BORDER_EDGE_KEYS) applyBorderEdgeUpdate(accumulated, edge, shorthandUpdate);
+	for (const edge of BORDER_EDGE_KEYS) {
+		const rawValue = require_xml_query.attrValue(cellProperties, BORDER_EDGE_ATTRS[edge]);
+		const update = rawValue === void 0 ? void 0 : parseBorderEdge(rawValue);
+		if (update !== void 0) applyBorderEdgeUpdate(accumulated, edge, update);
+	}
+}
+function applyBorderEdgeUpdate(accumulated, edge, update) {
+	if ("none" in update) delete accumulated[edge];
+	else accumulated[edge] = update.border;
+}
+function bordersFromAccumulated(accumulated) {
+	if (accumulated.left === void 0 && accumulated.right === void 0 && accumulated.top === void 0 && accumulated.bottom === void 0) return;
+	const borders = {};
+	if (accumulated.left !== void 0) borders.left = accumulated.left;
+	if (accumulated.right !== void 0) borders.right = accumulated.right;
+	if (accumulated.top !== void 0) borders.top = accumulated.top;
+	if (accumulated.bottom !== void 0) borders.bottom = accumulated.bottom;
+	return borders;
+}
+function readCellStyleDecoration(elements) {
+	let background;
+	let alignment;
+	let verticalAlignment;
+	const borderAccumulator = {};
+	for (const styleElement of elements) {
+		const cellProperties = require_xml_query.childrenWithTag(styleElement, "style:table-cell-properties")[0];
+		if (cellProperties !== void 0) {
+			const backgroundValue = require_xml_query.attrValue(cellProperties, "fo:background-color");
+			const parsedBackground = backgroundValue === void 0 ? void 0 : require_typed_shared_color.parseOdfColor(backgroundValue);
+			if (parsedBackground !== void 0) background = parsedBackground;
+			applyBorderEdgeUpdates(borderAccumulator, cellProperties);
+			const verticalAlignValue = require_xml_query.attrValue(cellProperties, "style:vertical-align");
+			if (verticalAlignValue !== void 0 && isVerticalAlign(verticalAlignValue)) verticalAlignment = verticalAlignValue;
+		}
+		const paragraphProperties = require_xml_query.childrenWithTag(styleElement, "style:paragraph-properties")[0];
+		const textAlignValue = paragraphProperties === void 0 ? void 0 : require_xml_query.attrValue(paragraphProperties, "fo:text-align");
+		if (textAlignValue === "left" || textAlignValue === "center" || textAlignValue === "right" || textAlignValue === "justify") alignment = textAlignValue;
+	}
+	return {
+		background,
+		borders: bordersFromAccumulated(borderAccumulator),
+		alignment,
+		verticalAlignment
+	};
 }
 function readTableCell(cellElement, pkg) {
 	const blocks = require_xml_query.childrenWithTag(cellElement, "text:p").map((p) => require_typed_shared_paragraph.readOdfParagraph(p, pkg));
 	const colSpanRaw = require_xml_query.attrValue(cellElement, "table:number-columns-spanned");
 	const rowSpanRaw = require_xml_query.attrValue(cellElement, "table:number-rows-spanned");
+	const styleName = require_xml_query.attrValue(cellElement, "table:style-name");
+	const styleElement = styleName === void 0 ? void 0 : require_typed_shared_cascade.findStyleElement(styleName, "table-cell", pkg);
+	const { background, borders } = readCellStyleDecoration(styleElement === void 0 ? [] : [styleElement]);
 	return {
 		blocks,
 		colSpan: colSpanRaw === void 0 ? void 0 : Number.parseInt(colSpanRaw, 10),
 		rowSpan: rowSpanRaw === void 0 ? void 0 : Number.parseInt(rowSpanRaw, 10),
-		background: readTableCellBackground(cellElement, pkg)
+		background,
+		borders
 	};
 }
 function readTableRow(rowElement, pkg) {
@@ -81,4 +167,5 @@ function readOdfTable(tableElement, pkg) {
 	};
 }
 //#endregion
+exports.readCellStyleDecoration = readCellStyleDecoration;
 exports.readOdfTable = readOdfTable;

package/dist/typed/shared/table.d.cts

@@ -1,7 +1,14 @@
 import { l as XmlElement } from "../../node-CkBWRjNR.cjs";
 import { Package } from "../../model/package.cjs";
-import { ContentTable } from "document-schema.js";
+import { Alignment, Color, ContentCellBorders, ContentTable } from "document-schema.js";
 //#region src/typed/shared/table.d.ts
+interface CellStyleDecoration {
+  background?: Color;
+  borders?: ContentCellBorders;
+  alignment?: Alignment;
+  verticalAlignment?: 'top' | 'middle' | 'bottom';
+}
+declare function readCellStyleDecoration(elements: readonly XmlElement[]): CellStyleDecoration;
 declare function readOdfTable(tableElement: XmlElement, pkg: Package): ContentTable;
 //#endregion
-export { readOdfTable };
+export { CellStyleDecoration, readCellStyleDecoration, readOdfTable };

package/dist/typed/shared/table.d.ts

@@ -1,7 +1,14 @@
 import { l as XmlElement } from "../../node-CkBWRjNR.js";
 import { Package } from "../../model/package.js";
-import { ContentTable } from "document-schema.js";
+import { Alignment, Color, ContentCellBorders, ContentTable } from "document-schema.js";
 //#region src/typed/shared/table.d.ts
+interface CellStyleDecoration {
+  background?: Color;
+  borders?: ContentCellBorders;
+  alignment?: Alignment;
+  verticalAlignment?: 'top' | 'middle' | 'bottom';
+}
+declare function readCellStyleDecoration(elements: readonly XmlElement[]): CellStyleDecoration;
 declare function readOdfTable(tableElement: XmlElement, pkg: Package): ContentTable;
 //#endregion
-export { readOdfTable };
+export { CellStyleDecoration, readCellStyleDecoration, readOdfTable };

package/dist/typed/shared/table.js

@@ -24,22 +24,108 @@ function resolveRowHeightPt(rowElement, pkg) {
 	const heightValue = props === void 0 ? void 0 : attrValue(props, "style:row-height");
 	return heightValue === void 0 ? void 0 : parseOdfLength(heightValue);
 }
-function readTableCellBackground(cellElement, pkg) {
-	const styleName = attrValue(cellElement, "table:style-name");
-	const styleElement = styleName === void 0 ? void 0 : findStyleElement(styleName, "table-cell", pkg);
-	const props = styleElement === void 0 ? void 0 : childrenWithTag(styleElement, "style:table-cell-properties")[0];
-	const value = props === void 0 ? void 0 : attrValue(props, "fo:background-color");
-	return value === void 0 ? void 0 : parseOdfColor(value);
+const BORDER_STYLE_MAP = {
+	solid: "solid",
+	dashed: "dashed",
+	dotted: "dotted",
+	double: "double"
+};
+const BORDER_EDGE_KEYS = [
+	"left",
+	"right",
+	"top",
+	"bottom"
+];
+const BORDER_EDGE_ATTRS = {
+	left: "fo:border-left",
+	right: "fo:border-right",
+	top: "fo:border-top",
+	bottom: "fo:border-bottom"
+};
+function isVerticalAlign(value) {
+	return value === "top" || value === "middle" || value === "bottom";
+}
+function parseBorderEdge(value) {
+	const tokens = value.trim().split(/\s+/);
+	if (tokens.length !== 3) return;
+	const [widthToken, styleToken, colorToken] = tokens;
+	if (widthToken === void 0 || styleToken === void 0 || colorToken === void 0) return;
+	if (styleToken === "none" || styleToken === "hidden") return { none: true };
+	const widthPt = parseOdfLength(widthToken);
+	const color = parseOdfColor(colorToken);
+	if (widthPt === void 0 || widthPt <= 0 || color === void 0) return;
+	const style = BORDER_STYLE_MAP[styleToken];
+	return { border: style === void 0 ? {
+		color,
+		widthPt
+	} : {
+		color,
+		widthPt,
+		style
+	} };
+}
+function applyBorderEdgeUpdates(accumulated, cellProperties) {
+	const shorthandValue = attrValue(cellProperties, "fo:border");
+	const shorthandUpdate = shorthandValue === void 0 ? void 0 : parseBorderEdge(shorthandValue);
+	if (shorthandUpdate !== void 0) for (const edge of BORDER_EDGE_KEYS) applyBorderEdgeUpdate(accumulated, edge, shorthandUpdate);
+	for (const edge of BORDER_EDGE_KEYS) {
+		const rawValue = attrValue(cellProperties, BORDER_EDGE_ATTRS[edge]);
+		const update = rawValue === void 0 ? void 0 : parseBorderEdge(rawValue);
+		if (update !== void 0) applyBorderEdgeUpdate(accumulated, edge, update);
+	}
+}
+function applyBorderEdgeUpdate(accumulated, edge, update) {
+	if ("none" in update) delete accumulated[edge];
+	else accumulated[edge] = update.border;
+}
+function bordersFromAccumulated(accumulated) {
+	if (accumulated.left === void 0 && accumulated.right === void 0 && accumulated.top === void 0 && accumulated.bottom === void 0) return;
+	const borders = {};
+	if (accumulated.left !== void 0) borders.left = accumulated.left;
+	if (accumulated.right !== void 0) borders.right = accumulated.right;
+	if (accumulated.top !== void 0) borders.top = accumulated.top;
+	if (accumulated.bottom !== void 0) borders.bottom = accumulated.bottom;
+	return borders;
+}
+function readCellStyleDecoration(elements) {
+	let background;
+	let alignment;
+	let verticalAlignment;
+	const borderAccumulator = {};
+	for (const styleElement of elements) {
+		const cellProperties = childrenWithTag(styleElement, "style:table-cell-properties")[0];
+		if (cellProperties !== void 0) {
+			const backgroundValue = attrValue(cellProperties, "fo:background-color");
+			const parsedBackground = backgroundValue === void 0 ? void 0 : parseOdfColor(backgroundValue);
+			if (parsedBackground !== void 0) background = parsedBackground;
+			applyBorderEdgeUpdates(borderAccumulator, cellProperties);
+			const verticalAlignValue = attrValue(cellProperties, "style:vertical-align");
+			if (verticalAlignValue !== void 0 && isVerticalAlign(verticalAlignValue)) verticalAlignment = verticalAlignValue;
+		}
+		const paragraphProperties = childrenWithTag(styleElement, "style:paragraph-properties")[0];
+		const textAlignValue = paragraphProperties === void 0 ? void 0 : attrValue(paragraphProperties, "fo:text-align");
+		if (textAlignValue === "left" || textAlignValue === "center" || textAlignValue === "right" || textAlignValue === "justify") alignment = textAlignValue;
+	}
+	return {
+		background,
+		borders: bordersFromAccumulated(borderAccumulator),
+		alignment,
+		verticalAlignment
+	};
 }
 function readTableCell(cellElement, pkg) {
 	const blocks = childrenWithTag(cellElement, "text:p").map((p) => readOdfParagraph(p, pkg));
 	const colSpanRaw = attrValue(cellElement, "table:number-columns-spanned");
 	const rowSpanRaw = attrValue(cellElement, "table:number-rows-spanned");
+	const styleName = attrValue(cellElement, "table:style-name");
+	const styleElement = styleName === void 0 ? void 0 : findStyleElement(styleName, "table-cell", pkg);
+	const { background, borders } = readCellStyleDecoration(styleElement === void 0 ? [] : [styleElement]);
 	return {
 		blocks,
 		colSpan: colSpanRaw === void 0 ? void 0 : Number.parseInt(colSpanRaw, 10),
 		rowSpan: rowSpanRaw === void 0 ? void 0 : Number.parseInt(rowSpanRaw, 10),
-		background: readTableCellBackground(cellElement, pkg)
+		background,
+		borders
 	};
 }
 function readTableRow(rowElement, pkg) {
@@ -80,4 +166,4 @@ function readOdfTable(tableElement, pkg) {
 	};
 }
 //#endregion
-export { readOdfTable };
+export { readCellStyleDecoration, readOdfTable };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "odf.js",
-  "version": "1.13.2",
+  "version": "2.1.0",
   "description": "Type-safe, lossless round-trip conversion between OpenDocument Format packages (odt, ods, odp) and JSON, hand-written and dependency-minimal, built on Zod 4 codecs.",
   "type": "module",
   "repository": {