@stll/folio-core 0.0.1-placeholder.0 → 0.1.1

package/dist/docx/serializer/sectionPropertiesSerializer.js

@@ -0,0 +1,187 @@
+import { getUnserializedSectionPropertyChildNames } from "../sectionParser.js";
+import { escapeXml, intAttr } from "./xmlUtils.js";
+import { serializeBorder } from "./borderSerializer.js";
+//#region src/docx/serializer/sectionPropertiesSerializer.ts
+const serializeHeaderReference = (ref) => `<w:headerReference w:type="${ref.type}" r:id="${ref.rId}"/>`;
+const serializeFooterReference = (ref) => `<w:footerReference w:type="${ref.type}" r:id="${ref.rId}"/>`;
+function serializeFootnoteProperties(props) {
+	if (!props) return "";
+	const parts = [];
+	if (props.position) parts.push(`<w:pos w:val="${props.position}"/>`);
+	if (props.numFmt) parts.push(`<w:numFmt w:val="${props.numFmt}"/>`);
+	if (props.numStart !== void 0) parts.push(`<w:numStart w:val="${intAttr(props.numStart)}"/>`);
+	if (props.numRestart) parts.push(`<w:numRestart w:val="${props.numRestart}"/>`);
+	return parts.length > 0 ? `<w:footnotePr>${parts.join("")}</w:footnotePr>` : "";
+}
+function serializeFootnoteColumns(props) {
+	return props.footnoteColumns !== void 0 ? `<w15:footnoteColumns w:val="${intAttr(props.footnoteColumns)}"/>` : "";
+}
+function serializeEndnoteProperties(props) {
+	if (!props) return "";
+	const parts = [];
+	if (props.position) parts.push(`<w:pos w:val="${props.position}"/>`);
+	if (props.numFmt) parts.push(`<w:numFmt w:val="${props.numFmt}"/>`);
+	if (props.numStart !== void 0) parts.push(`<w:numStart w:val="${intAttr(props.numStart)}"/>`);
+	if (props.numRestart) parts.push(`<w:numRestart w:val="${props.numRestart}"/>`);
+	return parts.length > 0 ? `<w:endnotePr>${parts.join("")}</w:endnotePr>` : "";
+}
+function serializePageSize(props) {
+	const attrs = [];
+	if (props.pageWidth !== void 0) attrs.push(`w:w="${intAttr(props.pageWidth)}"`);
+	if (props.pageHeight !== void 0) attrs.push(`w:h="${intAttr(props.pageHeight)}"`);
+	if (props.orientation === "landscape") attrs.push("w:orient=\"landscape\"");
+	return attrs.length > 0 ? `<w:pgSz ${attrs.join(" ")}/>` : "";
+}
+function serializePageMargins(props) {
+	const attrs = [];
+	if (props.marginTop !== void 0) attrs.push(`w:top="${intAttr(props.marginTop)}"`);
+	if (props.marginRight !== void 0) attrs.push(`w:right="${intAttr(props.marginRight)}"`);
+	if (props.marginBottom !== void 0) attrs.push(`w:bottom="${intAttr(props.marginBottom)}"`);
+	if (props.marginLeft !== void 0) attrs.push(`w:left="${intAttr(props.marginLeft)}"`);
+	if (props.headerDistance !== void 0) attrs.push(`w:header="${intAttr(props.headerDistance)}"`);
+	if (props.footerDistance !== void 0) attrs.push(`w:footer="${intAttr(props.footerDistance)}"`);
+	if (props.gutter !== void 0) attrs.push(`w:gutter="${intAttr(props.gutter)}"`);
+	return attrs.length > 0 ? `<w:pgMar ${attrs.join(" ")}/>` : "";
+}
+function serializePaperSource(props) {
+	const attrs = [];
+	if (props.paperSrcFirst !== void 0) attrs.push(`w:first="${intAttr(props.paperSrcFirst)}"`);
+	if (props.paperSrcOther !== void 0) attrs.push(`w:other="${intAttr(props.paperSrcOther)}"`);
+	return attrs.length > 0 ? `<w:paperSrc ${attrs.join(" ")}/>` : "";
+}
+function serializeColumns(props) {
+	if (!props.columnCount && !props.columns?.length && props.columnSpace === void 0) return "";
+	const attrs = [];
+	if (props.columnCount !== void 0 && props.columnCount > 1) attrs.push(`w:num="${intAttr(props.columnCount)}"`);
+	if (props.columnSpace !== void 0) attrs.push(`w:space="${intAttr(props.columnSpace)}"`);
+	if (props.equalWidth !== void 0) attrs.push(`w:equalWidth="${props.equalWidth ? "1" : "0"}"`);
+	if (props.separator) attrs.push("w:sep=\"1\"");
+	const colElements = (props.columns ?? []).map((col) => {
+		const colAttrs = [];
+		if (col.width !== void 0) colAttrs.push(`w:w="${intAttr(col.width)}"`);
+		if (col.space !== void 0) colAttrs.push(`w:space="${intAttr(col.space)}"`);
+		return `<w:col ${colAttrs.join(" ")}/>`;
+	}).join("");
+	if (attrs.length === 0 && !colElements) return "";
+	return `<w:cols${attrs.length > 0 ? ` ${attrs.join(" ")}` : ""}>${colElements}</w:cols>`;
+}
+function serializeLineNumbers(props) {
+	if (!props.lineNumbers) return "";
+	const attrs = [];
+	const ln = props.lineNumbers;
+	if (ln.countBy !== void 0) attrs.push(`w:countBy="${intAttr(ln.countBy)}"`);
+	if (ln.start !== void 0) attrs.push(`w:start="${intAttr(ln.start)}"`);
+	if (ln.distance !== void 0) attrs.push(`w:distance="${intAttr(ln.distance)}"`);
+	if (ln.restart) attrs.push(`w:restart="${ln.restart}"`);
+	return attrs.length > 0 ? `<w:lnNumType ${attrs.join(" ")}/>` : "";
+}
+function serializePageNumbering(props) {
+	if (!props.pageNumbering) return "";
+	const attrs = [];
+	const pageNumbering = props.pageNumbering;
+	if (pageNumbering.format) attrs.push(`w:fmt="${pageNumbering.format}"`);
+	if (pageNumbering.start !== void 0) attrs.push(`w:start="${intAttr(pageNumbering.start)}"`);
+	if (pageNumbering.chapterStyle !== void 0) attrs.push(`w:chapStyle="${intAttr(pageNumbering.chapterStyle)}"`);
+	if (pageNumbering.chapterSeparator) attrs.push(`w:chapSep="${pageNumbering.chapterSeparator}"`);
+	return attrs.length > 0 ? `<w:pgNumType ${attrs.join(" ")}/>` : "";
+}
+function serializePageBorders(props) {
+	if (!props.pageBorders) return "";
+	const attrs = [];
+	const borderElements = [];
+	const pb = props.pageBorders;
+	if (pb.display) attrs.push(`w:display="${pb.display}"`);
+	if (pb.offsetFrom) attrs.push(`w:offsetFrom="${pb.offsetFrom}"`);
+	if (pb.zOrder) attrs.push(`w:zOrder="${pb.zOrder}"`);
+	for (const [key, elementName] of [
+		["top", "top"],
+		["left", "left"],
+		["bottom", "bottom"],
+		["right", "right"]
+	]) {
+		const xml = serializeBorder(pb[key], elementName);
+		if (xml) borderElements.push(xml);
+	}
+	if (borderElements.length === 0 && attrs.length === 0) return "";
+	const attrsStr = attrs.length > 0 ? ` ${attrs.join(" ")}` : "";
+	if (borderElements.length === 0) return `<w:pgBorders${attrsStr}/>`;
+	return `<w:pgBorders${attrsStr}>${borderElements.join("")}</w:pgBorders>`;
+}
+function serializeBackground(props) {
+	if (!props.background) return "";
+	const attrs = [];
+	const { background } = props;
+	if (background.color?.auto) attrs.push("w:color=\"auto\"");
+	else if (background.color?.rgb) attrs.push(`w:color="${background.color.rgb}"`);
+	if (background.themeColor ?? background.color?.themeColor) attrs.push(`w:themeColor="${background.themeColor ?? background.color?.themeColor}"`);
+	if (background.themeTint ?? background.color?.themeTint) attrs.push(`w:themeTint="${background.themeTint ?? background.color?.themeTint}"`);
+	if (background.themeShade ?? background.color?.themeShade) attrs.push(`w:themeShade="${background.themeShade ?? background.color?.themeShade}"`);
+	return attrs.length > 0 ? `<w:background ${attrs.join(" ")}/>` : "";
+}
+function serializeDocGrid(props) {
+	if (!props.docGrid) return "";
+	const attrs = [];
+	const dg = props.docGrid;
+	if (dg.type) attrs.push(`w:type="${dg.type}"`);
+	if (dg.linePitch !== void 0) attrs.push(`w:linePitch="${intAttr(dg.linePitch)}"`);
+	if (dg.charSpace !== void 0) attrs.push(`w:charSpace="${intAttr(dg.charSpace)}"`);
+	return attrs.length > 0 ? `<w:docGrid ${attrs.join(" ")}/>` : "";
+}
+function serializeOnOffElement(value, name) {
+	if (value === void 0) return "";
+	return value ? `<w:${name}/>` : `<w:${name} w:val="0"/>`;
+}
+function serializeSectionPropertyChange(change) {
+	const normalizedId = Number.isInteger(change.info.id) && change.info.id >= 0 ? change.info.id : 0;
+	const authorCandidate = typeof change.info.author === "string" ? change.info.author.trim() : "";
+	const normalizedAuthor = authorCandidate.length > 0 ? authorCandidate : "Unknown";
+	const normalizedDate = typeof change.info.date === "string" ? change.info.date.trim() : void 0;
+	const normalizedRsid = typeof change.info.rsid === "string" ? change.info.rsid.trim() : void 0;
+	const attrs = [`w:id="${normalizedId}"`, `w:author="${escapeXml(normalizedAuthor)}"`];
+	if (normalizedDate) attrs.push(`w:date="${escapeXml(normalizedDate)}"`);
+	if (normalizedRsid) attrs.push(`w:rsid="${escapeXml(normalizedRsid)}"`);
+	const previousSectPrXml = serializeSectionProperties(change.previousProperties) || "<w:sectPr/>";
+	return `<w:sectPrChange ${attrs.join(" ")}>${previousSectPrXml}</w:sectPrChange>`;
+}
+function serializeSectionProperties(props) {
+	if (!props) return "";
+	const parts = [];
+	for (const ref of props.headerReferences ?? []) parts.push(serializeHeaderReference(ref));
+	for (const ref of props.footerReferences ?? []) parts.push(serializeFooterReference(ref));
+	const footnotePrXml = serializeFootnoteProperties(props.footnotePr);
+	if (footnotePrXml) parts.push(footnotePrXml);
+	const footnoteColumnsXml = serializeFootnoteColumns(props);
+	if (footnoteColumnsXml) parts.push(footnoteColumnsXml);
+	const endnotePrXml = serializeEndnoteProperties(props.endnotePr);
+	if (endnotePrXml) parts.push(endnotePrXml);
+	if (props.sectionStart) parts.push(`<w:type w:val="${props.sectionStart}"/>`);
+	for (const xml of [
+		serializePageSize(props),
+		serializePageMargins(props),
+		serializePaperSource(props),
+		serializePageBorders(props),
+		serializeBackground(props),
+		serializeLineNumbers(props),
+		serializePageNumbering(props),
+		serializeColumns(props),
+		serializeDocGrid(props)
+	]) if (xml) parts.push(xml);
+	if (props.verticalAlign) parts.push(`<w:vAlign w:val="${props.verticalAlign}"/>`);
+	if (props.textDirection) parts.push(`<w:textDirection w:val="${props.textDirection}"/>`);
+	if (props.titlePg) parts.push("<w:titlePg/>");
+	if (props.bidi) parts.push("<w:bidi/>");
+	for (const xml of [
+		serializeOnOffElement(props.formProtection, "formProt"),
+		serializeOnOffElement(props.noEndnote, "noEndnote"),
+		serializeOnOffElement(props.rtlGutter, "rtlGutter")
+	]) if (xml) parts.push(xml);
+	if (props.printerSettingsRelationshipId) parts.push(`<w:printerSettings r:id="${props.printerSettingsRelationshipId}"/>`);
+	for (const change of props.propertyChanges ?? []) parts.push(serializeSectionPropertyChange(change));
+	const unserializedChildNames = getUnserializedSectionPropertyChildNames(props);
+	if (unserializedChildNames && unserializedChildNames.length > 0) return "";
+	if (parts.length > 0) return `<w:sectPr>${parts.join("")}</w:sectPr>`;
+	if (Object.keys(props).length > 0) return "";
+	return "<w:sectPr/>";
+}
+//#endregion
+export { serializeSectionProperties };

package/dist/docx/serializer/tableSerializer.d.ts

@@ -0,0 +1,79 @@
+import { document_d_exports } from "../../types/document.js";
+
+//#region src/docx/serializer/tableSerializer.d.ts
+/**
+ * Serialize table formatting properties (w:tblPr)
+ */
+declare function serializeTableFormatting(formatting: document_d_exports.TableFormatting | undefined, propertyChanges?: document_d_exports.TablePropertyChange[]): string;
+/**
+ * Serialize table row formatting properties (w:trPr)
+ */
+declare function serializeTableRowFormatting(formatting: document_d_exports.TableRowFormatting | undefined, propertyChanges?: document_d_exports.TableRowPropertyChange[], structuralChange?: document_d_exports.TableStructuralChangeInfo): string;
+/**
+ * Serialize table cell formatting properties (w:tcPr)
+ */
+declare function serializeTableCellFormatting(formatting: document_d_exports.TableCellFormatting | undefined, propertyChanges?: document_d_exports.TableCellPropertyChange[], structuralChange?: document_d_exports.TableStructuralChangeInfo): string;
+/**
+ * Serialize a table cell (w:tc)
+ */
+declare function serializeTableCell(cell: document_d_exports.TableCell): string;
+/**
+ * Serialize a table row (w:tr)
+ */
+declare function serializeTableRow(row: document_d_exports.TableRow): string;
+/**
+ * Serialize a table to OOXML XML (w:tbl)
+ *
+ * @param table - The table to serialize
+ * @returns XML string for the table
+ */
+declare function serializeTable(table: document_d_exports.Table): string;
+/**
+ * Serialize multiple tables to OOXML XML
+ *
+ * @param tables - The tables to serialize
+ * @returns XML string for all tables
+ */
+declare function serializeTables(tables: document_d_exports.Table[]): string;
+/**
+ * Check if a table has any rows
+ */
+declare function hasTableRows(table: document_d_exports.Table): boolean;
+/**
+ * Check if a table has formatting
+ */
+declare function hasTableFormatting(table: document_d_exports.Table): boolean;
+/**
+ * Check if a row has any cells
+ */
+declare function hasRowCells(row: document_d_exports.TableRow): boolean;
+/**
+ * Check if a row has formatting
+ */
+declare function hasRowFormatting(row: document_d_exports.TableRow): boolean;
+/**
+ * Check if a cell has any content
+ */
+declare function hasCellContent(cell: document_d_exports.TableCell): boolean;
+/**
+ * Check if a cell has formatting
+ */
+declare function hasCellFormatting(cell: document_d_exports.TableCell): boolean;
+/**
+ * Get the number of columns in a table
+ */
+declare function getTableColumnCount(table: document_d_exports.Table): number;
+/**
+ * Get the number of rows in a table
+ */
+declare function getTableRowCount(table: document_d_exports.Table): number;
+/**
+ * Create an empty table
+ */
+declare function createEmptyTable(rows?: number, cols?: number): document_d_exports.Table;
+/**
+ * Create a table cell with text content
+ */
+declare function createTextCell(text: string, formatting?: document_d_exports.TableCellFormatting): document_d_exports.TableCell;
+//#endregion
+export { createEmptyTable, createTextCell, getTableColumnCount, getTableRowCount, hasCellContent, hasCellFormatting, hasRowCells, hasRowFormatting, hasTableFormatting, hasTableRows, serializeTable, serializeTableCell, serializeTableCellFormatting, serializeTableFormatting, serializeTableRow, serializeTableRowFormatting, serializeTables };