@stll/folio-core 0.45.0 → 0.47.0

package/dist/docx/serializer/sectionPropertiesSerializer.js

@@ -1,9 +1,11 @@
-import { getUnserializedSectionPropertyChildNames } from "../sectionParser.js";
+import { serializePreservedAttributes } from "../attributeRemainder.js";
 import { serializeSectionReferenceHistory } from "../sectionReferenceHistory.js";
 import { serializeBorder } from "./borderSerializer.js";
 import { serializeTrackedChangeAttributes } from "./trackedChangeAttributes.js";
 import { intAttr } from "./xmlUtils.js";
-import { escapeXmlAttribute } from "@stll/docx-core";
+import { escapeXmlAttribute, serializeOnOffElement } from "@stll/docx-core";
+import { themeColorToken } from "@stll/docx-core/model";
+import { serializeSequenceChildren } from "@stll/docx-core/schema";
 //#region src/docx/serializer/sectionPropertiesSerializer.ts
 const serializeHeaderReference = (ref) => `<w:headerReference w:type="${ref.type}" r:id="${escapeXmlAttribute(ref.rId)}"/>`;
 const serializeFooterReference = (ref) => `<w:footerReference w:type="${ref.type}" r:id="${escapeXmlAttribute(ref.rId)}"/>`;
@@ -53,12 +55,12 @@ function serializePaperSource(props) {
 	return attrs.length > 0 ? `<w:paperSrc ${attrs.join(" ")}/>` : "";
 }
 function serializeColumns(props) {
-	if (props.columnCount === void 0 && !props.columns?.length && props.columnSpace === void 0 && props.equalWidth === void 0) return "";
+	if (props.columnCount === void 0 && !props.columns?.length && props.columnSpace === void 0 && props.equalWidth === void 0 && props.separator === 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\"");
+	if (props.separator !== void 0) attrs.push(`w:sep="${props.separator ? "1" : "0"}"`);
 	const colElements = (props.columns ?? []).map((col) => {
 		const colAttrs = [];
 		if (col.width !== void 0) colAttrs.push(`w:w="${intAttr(col.width)}"`);
@@ -76,7 +78,7 @@ function serializeLineNumbers(props) {
 	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(" ")}/>` : "";
+	return attrs.length > 0 ? `<w:lnNumType ${attrs.join(" ")}/>` : "<w:lnNumType/>";
 }
 function serializePageNumbering(props) {
 	if (!props.pageNumbering) return "";
@@ -105,7 +107,6 @@ function serializePageBorders(props) {
 		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>`;
@@ -116,7 +117,8 @@ function serializeBackground(props) {
 	const { background } = props;
 	if (background.color?.auto) attrs.push("w:color=\"auto\"");
 	else if (background.color?.rgb) attrs.push(`w:color="${escapeXmlAttribute(background.color.rgb)}"`);
-	if (background.themeColor ?? background.color?.themeColor) attrs.push(`w:themeColor="${escapeXmlAttribute(background.themeColor ?? background.color?.themeColor ?? "")}"`);
+	const backgroundThemeColor = background.themeColor ?? background.color?.themeColor;
+	if (backgroundThemeColor !== void 0) attrs.push(`w:themeColor="${escapeXmlAttribute(themeColorToken(backgroundThemeColor))}"`);
 	if (background.themeTint ?? background.color?.themeTint) attrs.push(`w:themeTint="${escapeXmlAttribute(background.themeTint ?? background.color?.themeTint ?? "")}"`);
 	if (background.themeShade ?? background.color?.themeShade) attrs.push(`w:themeShade="${escapeXmlAttribute(background.themeShade ?? background.color?.themeShade ?? "")}"`);
 	return attrs.length > 0 ? `<w:background ${attrs.join(" ")}/>` : "";
@@ -130,10 +132,6 @@ function serializeDocGrid(props) {
 	if (dg.charSpace !== void 0) attrs.push(`w:charSpace="${intAttr(dg.charSpace)}"`);
 	return attrs.length > 0 ? `<w:docGrid ${attrs.join(" ")}/>` : "<w:docGrid/>";
 }
-function serializeOnOffElement(value, name) {
-	if (value === void 0) return "";
-	return value ? `<w:${name}/>` : `<w:${name} w:val="0"/>`;
-}
 function serializeSectionPropertyChange(change) {
 	const { headerReferences: _headers, footerReferences: _footers, ...previous } = change.previousProperties ?? {};
 	const previousSectPrXml = serializeSectionProperties(previous) || "<w:sectPr/>";
@@ -142,44 +140,39 @@ function serializeSectionPropertyChange(change) {
 }
 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}"/>`);
-	const titlePgXml = serializeOnOffElement(props.titlePg, "titlePg");
-	if (titlePgXml) parts.push(titlePgXml);
-	const bidiXml = serializeOnOffElement(props.bidi, "bidi");
-	if (bidiXml) parts.push(bidiXml);
-	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="${escapeXmlAttribute(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 "";
+	const parts = serializeSequenceChildren({
+		container: "section-properties",
+		modelled: [
+			["headerReference", (props.headerReferences ?? []).map(serializeHeaderReference).join("")],
+			["footerReference", (props.footerReferences ?? []).map(serializeFooterReference).join("")],
+			["footnotePr", serializeFootnoteProperties(props.footnotePr) + serializeFootnoteColumns(props)],
+			["endnotePr", serializeEndnoteProperties(props.endnotePr)],
+			["type", props.sectionStart ? `<w:type w:val="${props.sectionStart}"/>` : ""],
+			["pgSz", serializePageSize(props)],
+			["pgMar", serializePageMargins(props)],
+			["paperSrc", serializePaperSource(props)],
+			["pgBorders", serializePageBorders(props) + serializeBackground(props)],
+			["lnNumType", serializeLineNumbers(props)],
+			["pgNumType", serializePageNumbering(props)],
+			["cols", serializeColumns(props)],
+			["formProt", serializeOnOffElement(props.formProtection, "formProt")],
+			["vAlign", props.verticalAlign ? `<w:vAlign w:val="${props.verticalAlign}"/>` : ""],
+			["noEndnote", serializeOnOffElement(props.noEndnote, "noEndnote")],
+			["titlePg", serializeOnOffElement(props.titlePg, "titlePg")],
+			["textDirection", props.textDirection ? `<w:textDirection w:val="${props.textDirection}"/>` : ""],
+			["bidi", serializeOnOffElement(props.bidi, "bidi")],
+			["rtlGutter", serializeOnOffElement(props.rtlGutter, "rtlGutter")],
+			["docGrid", serializeDocGrid(props)],
+			["printerSettings", props.printerSettingsRelationshipId ? `<w:printerSettings r:id="${escapeXmlAttribute(props.printerSettingsRelationshipId)}"/>` : ""],
+			["sectPrChange", (props.propertyChanges ?? []).map(serializeSectionPropertyChange).join("")]
+		],
+		preserved: props.preserved
+	});
+	const attributes = serializePreservedAttributes([], props.preservedAttributes);
+	const startTag = attributes.length > 0 ? `<w:sectPr ${attributes.join(" ")}` : "<w:sectPr";
+	if (parts.length > 0) return `${startTag}>${parts.join("")}</w:sectPr>`;
+	if (Object.keys(props).some((key) => key !== "preservedAttributes")) return "";
+	if (attributes.length > 0) return `${startTag}/>`;
 	return "<w:sectPr/>";
 }
 //#endregion

package/dist/docx/serializer/settingsSerializer.js

@@ -1,11 +1,13 @@
 import { serializePartElement } from "./partNamespaces.js";
 import { intAttr } from "./xmlUtils.js";
-import { escapeXmlAttribute } from "@stll/docx-core";
+import { escapeXmlAttribute, serializeOnOffElement } from "@stll/docx-core";
 //#region src/docx/serializer/settingsSerializer.ts
 const serializeSettingsXml = (settings) => {
-	const parts = [`<w:defaultTabStop w:val="${intAttr(settings.defaultTabStop)}"/>`];
-	if (settings.evenAndOddHeaders) parts.push("<w:evenAndOddHeaders/>");
-	if (settings.updateFields) parts.push("<w:updateFields w:val=\"true\"/>");
+	const parts = [
+		`<w:defaultTabStop w:val="${intAttr(settings.defaultTabStop)}"/>`,
+		serializeOnOffElement(settings.evenAndOddHeaders, "evenAndOddHeaders"),
+		serializeOnOffElement(settings.updateFields, "updateFields")
+	];
 	if (settings.themeFontLang) {
 		const attrs = [];
 		if (settings.themeFontLang.eastAsia) attrs.push(`w:eastAsia="${escapeXmlAttribute(settings.themeFontLang.eastAsia)}"`);

package/dist/docx/serializer/stylesSerializer.js

@@ -2,7 +2,7 @@ import { serializeParagraphFormatting } from "./paragraphSerializer.js";
 import { serializePartElement } from "./partNamespaces.js";
 import { serializeTableCellFormatting, serializeTableFormatting, serializeTableRowFormatting } from "./tableSerializer.js";
 import { serializeTextFormatting } from "./textFormattingSerializer.js";
-import { escapeXmlAttribute } from "@stll/docx-core";
+import { escapeXmlAttribute, pushOnOffElement } from "@stll/docx-core";
 //#region src/docx/serializer/stylesSerializer.ts
 const serializeStylesXml = (definitions) => {
 	return "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n" + serializePartElement({
@@ -14,7 +14,8 @@ const serializeStylesXml = (definitions) => {
 	});
 };
 const serializeDocumentDefaults = (definitions) => {
-	return `<w:docDefaults><w:rPrDefault>${serializeTextFormatting(definitions.docDefaults?.rPr) || "<w:rPr/>"}</w:rPrDefault><w:pPrDefault>${serializeParagraphFormatting(definitions.docDefaults?.pPr) || "<w:pPr/>"}</w:pPrDefault></w:docDefaults>`;
+	const rPr = serializeTextFormatting(definitions.docDefaults?.rPr);
+	return `<w:docDefaults>${rPr === "" ? "<w:rPrDefault/>" : `<w:rPrDefault>${rPr}</w:rPrDefault>`}<w:pPrDefault>${serializeParagraphFormatting(definitions.docDefaults?.pPr) || "<w:pPr/>"}</w:pPrDefault></w:docDefaults>`;
 };
 const serializeLatentStyles = (definitions) => {
 	const latent = definitions.latentStyles;
@@ -35,11 +36,11 @@ const serializeStyle = (style) => {
 	if (style.next) parts.push(`<w:next w:val="${escapeXmlAttribute(style.next)}"/>`);
 	if (style.link) parts.push(`<w:link w:val="${escapeXmlAttribute(style.link)}"/>`);
 	if (style.uiPriority !== void 0) parts.push(`<w:uiPriority w:val="${style.uiPriority}"/>`);
-	pushBooleanElement(parts, "hidden", style.hidden);
-	pushBooleanElement(parts, "semiHidden", style.semiHidden);
-	pushBooleanElement(parts, "unhideWhenUsed", style.unhideWhenUsed);
-	pushBooleanElement(parts, "qFormat", style.qFormat);
-	pushBooleanElement(parts, "personal", style.personal);
+	pushOnOffElement(parts, style.hidden, "hidden");
+	pushOnOffElement(parts, style.semiHidden, "semiHidden");
+	pushOnOffElement(parts, style.unhideWhenUsed, "unhideWhenUsed");
+	pushOnOffElement(parts, style.qFormat, "qFormat");
+	pushOnOffElement(parts, style.personal, "personal");
 	parts.push(serializeParagraphFormatting(style.pPr));
 	parts.push(serializeTextFormatting(style.rPr));
 	parts.push(serializeTableFormatting(style.tblPr));
@@ -48,10 +49,6 @@ const serializeStyle = (style) => {
 	for (const conditional of style.tblStylePr ?? []) parts.push(`<w:tblStylePr w:type="${conditional.type}">${serializeParagraphFormatting(conditional.pPr)}${serializeTextFormatting(conditional.rPr)}${serializeTableFormatting(conditional.tblPr)}${serializeTableRowFormatting(conditional.trPr)}${serializeTableCellFormatting(conditional.tcPr)}</w:tblStylePr>`);
 	return `<w:style ${attrs.join(" ")}>${parts.join("")}</w:style>`;
 };
-const pushBooleanElement = (parts, name, value) => {
-	if (value === true) parts.push(`<w:${name}/>`);
-	else if (value === false) parts.push(`<w:${name} w:val="0"/>`);
-};
 const pushBooleanAttr = (attrs, name, value) => {
 	if (value !== void 0) attrs.push(`${name}="${value ? 1 : 0}"`);
 };