ooxml.js 2.4.0 → 2.5.0

package/dist/typed/xlsx/build.js

@@ -0,0 +1,455 @@
+import { el, txt } from "../../xml/fragment.js";
+import { encodeXmlText } from "../../xml/entities.js";
+import "../shared/units.js";
+import { SharedStringTable } from "./shared-strings.js";
+import { cellReference, rangeReference } from "./a1.js";
+import { XLNM_PRINT_AREA, XLNM_PRINT_TITLES, buildPrintAreaValue, buildPrintTitlesValue } from "./defined-names.js";
+import { pageSizeToPaperSizeCode, ptToUniversalMeasure, writeXmlBool } from "./util.js";
+import { DEFAULT_HEADER_FOOTER_MARGIN_PT } from "./print-settings.js";
+import { ptToColumnWidthChars } from "./units.js";
+//#region src/typed/xlsx/build.ts
+const SML_NS = "http://schemas.openxmlformats.org/spreadsheetml/2006/main";
+const REL_NS = "http://schemas.openxmlformats.org/officeDocument/2006/relationships";
+const PKG_RELS_NS = "http://schemas.openxmlformats.org/package/2006/relationships";
+const CONTENT_TYPES_NS = "http://schemas.openxmlformats.org/package/2006/content-types";
+const CORE_PROPS_NS = "http://schemas.openxmlformats.org/package/2006/metadata/core-properties";
+const DC_NS = "http://purl.org/dc/elements/1.1/";
+const DCTERMS_NS = "http://purl.org/dc/terms/";
+const XSI_NS = "http://www.w3.org/2001/XMLSchema-instance";
+const EXTENDED_PROPS_NS = "http://schemas.openxmlformats.org/officeDocument/2006/extended-properties";
+const CT_WORKBOOK = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml";
+const CT_STYLES = "application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml";
+const CT_SHARED_STRINGS = "application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml";
+const CT_WORKSHEET = "application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml";
+const CT_CORE_PROPS = "application/vnd.openxmlformats-package.core-properties+xml";
+const CT_EXTENDED_PROPS = "application/vnd.openxmlformats-officedocument.extended-properties+xml";
+const REL_OFFICE_DOCUMENT = `${REL_NS}/officeDocument`;
+const REL_CORE_PROPS = `${PKG_RELS_NS}/metadata/core-properties`;
+const REL_EXTENDED_PROPS = `${REL_NS}/extended-properties`;
+const REL_WORKSHEET = `${REL_NS}/worksheet`;
+const REL_STYLES = `${REL_NS}/styles`;
+const REL_SHARED_STRINGS = `${REL_NS}/sharedStrings`;
+const MAX_COLUMN_INDEX = 16383;
+const MAX_ROW_INDEX = 1048575;
+function xmlDeclaration() {
+	return {
+		type: "declaration",
+		attributes: [
+			{
+				name: "version",
+				value: "1.0"
+			},
+			{
+				name: "encoding",
+				value: "UTF-8"
+			},
+			{
+				name: "standalone",
+				value: "yes"
+			}
+		]
+	};
+}
+function xmlPart(root) {
+	return {
+		kind: "xml",
+		nodes: [xmlDeclaration(), root]
+	};
+}
+function buildContentTypesPart(sheetCount) {
+	const overrides = [
+		el("Override", {
+			PartName: "/xl/workbook.xml",
+			ContentType: CT_WORKBOOK
+		}),
+		el("Override", {
+			PartName: "/xl/styles.xml",
+			ContentType: CT_STYLES
+		}),
+		el("Override", {
+			PartName: "/xl/sharedStrings.xml",
+			ContentType: CT_SHARED_STRINGS
+		})
+	];
+	for (let index = 0; index < sheetCount; index++) overrides.push(el("Override", {
+		PartName: `/xl/worksheets/sheet${index + 1}.xml`,
+		ContentType: CT_WORKSHEET
+	}));
+	overrides.push(el("Override", {
+		PartName: "/docProps/core.xml",
+		ContentType: CT_CORE_PROPS
+	}));
+	overrides.push(el("Override", {
+		PartName: "/docProps/app.xml",
+		ContentType: CT_EXTENDED_PROPS
+	}));
+	return xmlPart(el("Types", { xmlns: CONTENT_TYPES_NS }, [
+		el("Default", {
+			Extension: "rels",
+			ContentType: "application/vnd.openxmlformats-package.relationships+xml"
+		}),
+		el("Default", {
+			Extension: "xml",
+			ContentType: "application/xml"
+		}),
+		...overrides
+	]));
+}
+function buildPackageRelsPart() {
+	return xmlPart(el("Relationships", { xmlns: PKG_RELS_NS }, [
+		el("Relationship", {
+			Id: "rId1",
+			Type: REL_OFFICE_DOCUMENT,
+			Target: "xl/workbook.xml"
+		}),
+		el("Relationship", {
+			Id: "rId2",
+			Type: REL_CORE_PROPS,
+			Target: "docProps/core.xml"
+		}),
+		el("Relationship", {
+			Id: "rId3",
+			Type: REL_EXTENDED_PROPS,
+			Target: "docProps/app.xml"
+		})
+	]));
+}
+function worksheetRelId(sheetIndex) {
+	return `rId${sheetIndex + 1}`;
+}
+function buildWorkbookRelsPart(sheetCount) {
+	const relationships = [];
+	for (let index = 0; index < sheetCount; index++) relationships.push(el("Relationship", {
+		Id: worksheetRelId(index),
+		Type: REL_WORKSHEET,
+		Target: `worksheets/sheet${index + 1}.xml`
+	}));
+	relationships.push(el("Relationship", {
+		Id: `rId${sheetCount + 1}`,
+		Type: REL_STYLES,
+		Target: "styles.xml"
+	}));
+	relationships.push(el("Relationship", {
+		Id: `rId${sheetCount + 2}`,
+		Type: REL_SHARED_STRINGS,
+		Target: "sharedStrings.xml"
+	}));
+	return xmlPart(el("Relationships", { xmlns: PKG_RELS_NS }, relationships));
+}
+function buildDefinedNameElements(sheets) {
+	const elements = [];
+	sheets.forEach((sheet, sheetIndex) => {
+		const { printRange, repeatRows, repeatColumns } = sheet.printSettings;
+		if (printRange !== void 0) {
+			const value = buildPrintAreaValue(sheet.name, printRange);
+			elements.push(el("definedName", {
+				name: XLNM_PRINT_AREA,
+				localSheetId: String(sheetIndex)
+			}, [txt(encodeXmlText(value))]));
+		}
+		if (repeatRows !== void 0 || repeatColumns !== void 0) {
+			const value = buildPrintTitlesValue(sheet.name, repeatRows, repeatColumns);
+			if (value !== void 0) elements.push(el("definedName", {
+				name: XLNM_PRINT_TITLES,
+				localSheetId: String(sheetIndex)
+			}, [txt(encodeXmlText(value))]));
+		}
+	});
+	return elements;
+}
+function buildWorkbookPart(sheets) {
+	const children = [el("sheets", {}, sheets.map((sheet, index) => el("sheet", {
+		name: encodeXmlText(sheet.name),
+		sheetId: String(index + 1),
+		"r:id": worksheetRelId(index)
+	})))];
+	const definedNameElements = buildDefinedNameElements(sheets);
+	if (definedNameElements.length > 0) children.push(el("definedNames", {}, definedNameElements));
+	return xmlPart(el("workbook", {
+		xmlns: SML_NS,
+		"xmlns:r": REL_NS
+	}, children));
+}
+function buildSharedStringsPart(sharedStrings) {
+	const entries = sharedStrings.entries();
+	const siElements = entries.map((value) => el("si", {}, [el("t", { "xml:space": "preserve" }, [txt(encodeXmlText(value))])]));
+	return xmlPart(el("sst", {
+		xmlns: SML_NS,
+		count: String(entries.length),
+		uniqueCount: String(entries.length)
+	}, siElements));
+}
+function buildStylesPart() {
+	return xmlPart(el("styleSheet", { xmlns: SML_NS }, [
+		el("fonts", { count: "1" }, [el("font", {}, [el("sz", { val: "11" }), el("name", { val: "Calibri" })])]),
+		el("fills", { count: "2" }, [el("fill", {}, [el("patternFill", { patternType: "none" })]), el("fill", {}, [el("patternFill", { patternType: "gray125" })])]),
+		el("borders", { count: "1" }, [el("border", {}, [
+			el("left"),
+			el("right"),
+			el("top"),
+			el("bottom"),
+			el("diagonal")
+		])]),
+		el("cellStyleXfs", { count: "1" }, [el("xf", {
+			numFmtId: "0",
+			fontId: "0",
+			fillId: "0",
+			borderId: "0"
+		})]),
+		el("cellXfs", { count: "1" }, [el("xf", {
+			numFmtId: "0",
+			fontId: "0",
+			fillId: "0",
+			borderId: "0",
+			xfId: "0"
+		})]),
+		el("cellStyles", { count: "1" }, [el("cellStyle", {
+			name: "Normal",
+			xfId: "0",
+			builtinId: "0"
+		})])
+	]));
+}
+function buildCorePropertiesPart(metadata) {
+	const children = [];
+	if (metadata.title !== void 0) children.push(el("dc:title", {}, [txt(encodeXmlText(metadata.title))]));
+	if (metadata.author !== void 0) children.push(el("dc:creator", {}, [txt(encodeXmlText(metadata.author))]));
+	if (metadata.subject !== void 0) children.push(el("dc:subject", {}, [txt(encodeXmlText(metadata.subject))]));
+	if (metadata.keywords !== void 0 && metadata.keywords.length > 0) children.push(el("cp:keywords", {}, [txt(encodeXmlText(metadata.keywords.join(", ")))]));
+	if (metadata.createdIso !== void 0) children.push(el("dcterms:created", { "xsi:type": "dcterms:W3CDTF" }, [txt(encodeXmlText(metadata.createdIso))]));
+	if (metadata.modifiedIso !== void 0) children.push(el("dcterms:modified", { "xsi:type": "dcterms:W3CDTF" }, [txt(encodeXmlText(metadata.modifiedIso))]));
+	return xmlPart(el("cp:coreProperties", {
+		"xmlns:cp": CORE_PROPS_NS,
+		"xmlns:dc": DC_NS,
+		"xmlns:dcterms": DCTERMS_NS,
+		"xmlns:xsi": XSI_NS
+	}, children));
+}
+function buildAppPropertiesPart(metadata) {
+	const children = [];
+	if (metadata.creator !== void 0) children.push(el("Application", {}, [txt(encodeXmlText(metadata.creator))]));
+	return xmlPart(el("Properties", { xmlns: EXTENDED_PROPS_NS }, children));
+}
+function computeDimension(sheet) {
+	let maxRow = 0;
+	let maxColumn = 0;
+	let hasAny = false;
+	for (const cell of sheet.cells) {
+		hasAny = true;
+		maxRow = Math.max(maxRow, cell.row);
+		maxColumn = Math.max(maxColumn, cell.column);
+	}
+	for (const column of sheet.columns) {
+		hasAny = true;
+		maxColumn = Math.max(maxColumn, column.index);
+	}
+	for (const row of sheet.rows) {
+		hasAny = true;
+		maxRow = Math.max(maxRow, row.index);
+	}
+	return hasAny ? rangeReference({
+		startRow: 0,
+		startColumn: 0,
+		endRow: maxRow,
+		endColumn: maxColumn
+	}) : "A1";
+}
+function buildColsElement(columns) {
+	if (columns.length === 0) return;
+	return el("cols", {}, columns.map((column) => {
+		const attrs = {
+			min: String(column.index + 1),
+			max: String(column.index + 1),
+			width: ptToColumnWidthChars(column.widthPt).toFixed(2),
+			customWidth: "true"
+		};
+		if (column.hidden === true) attrs.hidden = "true";
+		return el("col", attrs);
+	}));
+}
+function renderCellValue(value, isFormulaResult, sharedStrings) {
+	switch (value.kind) {
+		case "string":
+			if (isFormulaResult) return {
+				type: "str",
+				content: encodeXmlText(value.value)
+			};
+			return {
+				type: "s",
+				content: String(sharedStrings.intern(value.value))
+			};
+		case "number":
+		case "percentage":
+		case "currency": return { content: String(value.value) };
+		case "boolean": return {
+			type: "b",
+			content: value.value ? "1" : "0"
+		};
+		case "date":
+		case "time": return {
+			type: "d",
+			content: encodeXmlText(value.value)
+		};
+		case "error": return {
+			type: "e",
+			content: encodeXmlText(value.value)
+		};
+		case "empty": return;
+	}
+}
+function buildCellElement(cell, sharedStrings) {
+	const attrs = {
+		r: cellReference(cell.row, cell.column),
+		s: "0"
+	};
+	const children = [];
+	if (cell.formula !== void 0) children.push(el("f", {}, [txt(encodeXmlText(cell.formula))]));
+	const rendered = renderCellValue(cell.value, cell.formula !== void 0, sharedStrings);
+	if (rendered !== void 0) {
+		if (rendered.type !== void 0) attrs.t = rendered.type;
+		children.push(el("v", {}, [txt(rendered.content)]));
+	}
+	return el("c", attrs, children);
+}
+function buildSheetDataElement(sheet, sharedStrings) {
+	const cellsByRow = /* @__PURE__ */ new Map();
+	for (const cell of sheet.cells) {
+		const existing = cellsByRow.get(cell.row);
+		if (existing === void 0) cellsByRow.set(cell.row, [cell]);
+		else existing.push(cell);
+	}
+	const rowInfoByIndex = /* @__PURE__ */ new Map();
+	for (const row of sheet.rows) rowInfoByIndex.set(row.index, row);
+	return el("sheetData", {}, Array.from(/* @__PURE__ */ new Set([...cellsByRow.keys(), ...rowInfoByIndex.keys()])).sort((a, b) => a - b).map((rowIndex) => {
+		const cells = (cellsByRow.get(rowIndex) ?? []).slice().sort((a, b) => a.column - b.column);
+		const rowInfo = rowInfoByIndex.get(rowIndex);
+		const attrs = { r: String(rowIndex + 1) };
+		if (rowInfo !== void 0) {
+			attrs.ht = String(rowInfo.heightPt);
+			attrs.customHeight = "true";
+			if (rowInfo.hidden === true) attrs.hidden = "true";
+		}
+		return el("row", attrs, cells.map((cell) => buildCellElement(cell, sharedStrings)));
+	}));
+}
+function buildMergeCellsElement(cells) {
+	const merges = cells.filter((cell) => (cell.colSpan ?? 1) > 1 || (cell.rowSpan ?? 1) > 1);
+	if (merges.length === 0) return;
+	const mergeCellElements = merges.map((cell) => {
+		const endRow = cell.row + (cell.rowSpan ?? 1) - 1;
+		const endColumn = cell.column + (cell.colSpan ?? 1) - 1;
+		return el("mergeCell", { ref: rangeReference({
+			startRow: cell.row,
+			startColumn: cell.column,
+			endRow,
+			endColumn
+		}) });
+	});
+	return el("mergeCells", { count: String(mergeCellElements.length) }, mergeCellElements);
+}
+function buildSheetPrElement(settings) {
+	return el("sheetPr", {}, [el("pageSetUpPr", { fitToPage: writeXmlBool(settings.fitToPages !== void 0) })]);
+}
+function buildPrintOptionsElement(settings) {
+	return el("printOptions", {
+		gridLines: writeXmlBool(settings.gridlines),
+		headings: writeXmlBool(settings.headers)
+	});
+}
+function ptToInches(pt) {
+	return String(pt / 72);
+}
+function buildPageMarginsElement(settings) {
+	const margins = settings.margins;
+	return el("pageMargins", {
+		left: ptToInches(margins.leftPt),
+		right: ptToInches(margins.rightPt),
+		top: ptToInches(margins.topPt),
+		bottom: ptToInches(margins.bottomPt),
+		header: ptToInches(DEFAULT_HEADER_FOOTER_MARGIN_PT),
+		footer: ptToInches(DEFAULT_HEADER_FOOTER_MARGIN_PT)
+	});
+}
+function buildPageSetupElement(settings) {
+	const attrs = {};
+	const paperCode = pageSizeToPaperSizeCode(settings.pageSize);
+	if (paperCode !== void 0) attrs.paperSize = paperCode;
+	else {
+		attrs.paperWidth = ptToUniversalMeasure(settings.pageSize.widthPt);
+		attrs.paperHeight = ptToUniversalMeasure(settings.pageSize.heightPt);
+	}
+	attrs.scale = String(settings.scale ?? 100);
+	attrs.fitToWidth = String(settings.fitToPages?.width ?? 1);
+	attrs.fitToHeight = String(settings.fitToPages?.height ?? 1);
+	attrs.pageOrder = settings.pageOrder;
+	attrs.orientation = settings.pageSize.widthPt > settings.pageSize.heightPt ? "landscape" : "portrait";
+	return el("pageSetup", attrs);
+}
+function buildBreaksElements(settings) {
+	const manualBreaks = settings.manualBreaks;
+	if (manualBreaks === void 0) return {};
+	const result = {};
+	if (manualBreaks.rows.length > 0) {
+		const breaks = manualBreaks.rows.map((id) => el("brk", {
+			id: String(id),
+			min: "0",
+			max: String(MAX_COLUMN_INDEX),
+			man: "1"
+		}));
+		result.rowBreaks = el("rowBreaks", {
+			count: String(breaks.length),
+			manualBreakCount: String(breaks.length)
+		}, breaks);
+	}
+	if (manualBreaks.columns.length > 0) {
+		const breaks = manualBreaks.columns.map((id) => el("brk", {
+			id: String(id),
+			min: "0",
+			max: String(MAX_ROW_INDEX),
+			man: "1"
+		}));
+		result.colBreaks = el("colBreaks", {
+			count: String(breaks.length),
+			manualBreakCount: String(breaks.length)
+		}, breaks);
+	}
+	return result;
+}
+function buildWorksheetPart(sheet, sharedStrings) {
+	const children = [buildSheetPrElement(sheet.printSettings), el("dimension", { ref: computeDimension(sheet) })];
+	const colsElement = buildColsElement(sheet.columns);
+	if (colsElement !== void 0) children.push(colsElement);
+	children.push(buildSheetDataElement(sheet, sharedStrings));
+	const mergeCellsElement = buildMergeCellsElement(sheet.cells);
+	if (mergeCellsElement !== void 0) children.push(mergeCellsElement);
+	children.push(buildPrintOptionsElement(sheet.printSettings), buildPageMarginsElement(sheet.printSettings), buildPageSetupElement(sheet.printSettings));
+	const { rowBreaks, colBreaks } = buildBreaksElements(sheet.printSettings);
+	if (rowBreaks !== void 0) children.push(rowBreaks);
+	if (colBreaks !== void 0) children.push(colBreaks);
+	return xmlPart(el("worksheet", {
+		xmlns: SML_NS,
+		"xmlns:r": REL_NS
+	}, children));
+}
+function buildXlsxPackage(document) {
+	if (document.kind !== "spreadsheet") throw new Error(`buildXlsxPackage: expected a ContentDocument of kind "spreadsheet", got "${document.kind}"`);
+	const sheets = document.sheets;
+	const sharedStrings = new SharedStringTable();
+	const worksheetParts = sheets.map((sheet) => buildWorksheetPart(sheet, sharedStrings));
+	const parts = {
+		"[Content_Types].xml": buildContentTypesPart(sheets.length),
+		"_rels/.rels": buildPackageRelsPart(),
+		"xl/workbook.xml": buildWorkbookPart(sheets),
+		"xl/_rels/workbook.xml.rels": buildWorkbookRelsPart(sheets.length),
+		"xl/styles.xml": buildStylesPart(),
+		"xl/sharedStrings.xml": buildSharedStringsPart(sharedStrings),
+		"docProps/core.xml": buildCorePropertiesPart(document.metadata),
+		"docProps/app.xml": buildAppPropertiesPart(document.metadata)
+	};
+	worksheetParts.forEach((part, index) => {
+		parts[`xl/worksheets/sheet${index + 1}.xml`] = part;
+	});
+	return { parts };
+}
+//#endregion
+export { buildXlsxPackage };