@stll/folio-core 0.15.9 → 0.15.11

package/dist/docx/rezip.js

@@ -11,7 +11,7 @@ import { ensureThreadedCommentParaIds, serializeComments, serializeCommentsExten
 import { serializeDocument } from "./serializer/documentSerializer.js";
 import { serializeFontTableXml } from "./serializer/fontTableSerializer.js";
 import { serializeHeaderFooter } from "./serializer/headerFooterSerializer.js";
-import { serializeEndnotes, serializeFootnotes } from "./serializer/noteSerializer.js";
+import { serializeEndnotes, serializeFootnotes, serializeNewEndnotesPart, serializeNewFootnotesPart } from "./serializer/noteSerializer.js";
 import { serializeNumberingXml } from "./serializer/numberingSerializer.js";
 import { serializeSettingsXml } from "./serializer/settingsSerializer.js";
 import { serializeStylesXml } from "./serializer/stylesSerializer.js";
@@ -978,9 +978,50 @@ function serializeHeadersFootersToZip(doc, zip, compressionLevel) {
 */
 async function serializeNotesToZip(doc, originalZip, newZip, compressionLevel) {
 	const footnotes = doc.package.footnotes ?? [];
-	if (footnotes.length > 0) await patchNotePartIntoZip("word/footnotes.xml", serializeFootnotes(footnotes), (xml) => serializeFootnotes(parseFootnotes(xml).getNormalFootnotes()), originalZip, newZip, compressionLevel);
+	if (footnotes.length > 0) if (findNotePartEntry(originalZip, "word/footnotes.xml")) await patchNotePartIntoZip("word/footnotes.xml", serializeFootnotes(footnotes), (xml) => serializeFootnotes(parseFootnotes(xml).getNormalFootnotes()), originalZip, newZip, compressionLevel);
+	else await materializeNewNotePart({
+		contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.footnotes+xml",
+		newZip,
+		partPath: "word/footnotes.xml",
+		relationshipType: RELATIONSHIP_TYPES.footnotes,
+		serializedPart: serializeNewFootnotesPart(footnotes),
+		compressionLevel
+	});
 	const endnotes = doc.package.endnotes ?? [];
-	if (endnotes.length > 0) await patchNotePartIntoZip("word/endnotes.xml", serializeEndnotes(endnotes), (xml) => serializeEndnotes(parseEndnotes(xml).getNormalEndnotes()), originalZip, newZip, compressionLevel);
+	if (endnotes.length > 0) if (findNotePartEntry(originalZip, "word/endnotes.xml")) await patchNotePartIntoZip("word/endnotes.xml", serializeEndnotes(endnotes), (xml) => serializeEndnotes(parseEndnotes(xml).getNormalEndnotes()), originalZip, newZip, compressionLevel);
+	else await materializeNewNotePart({
+		contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.endnotes+xml",
+		newZip,
+		partPath: "word/endnotes.xml",
+		relationshipType: RELATIONSHIP_TYPES.endnotes,
+		serializedPart: serializeNewEndnotesPart(endnotes),
+		compressionLevel
+	});
+}
+async function materializeNewNotePart({ contentType, newZip, partPath, relationshipType, serializedPart, compressionLevel }) {
+	const contentTypesFile = findNotePartEntry(newZip, "[content_types].xml");
+	const relationshipsFile = findNotePartEntry(newZip, "word/_rels/document.xml.rels");
+	if (!contentTypesFile || !relationshipsFile) throw new DocxPackageFidelityError(`Cannot create ${partPath}: the DOCX package is missing content types or document relationships`);
+	const compressionOptions = { level: compressionLevel };
+	const contentTypesXml = await contentTypesFile.async("text");
+	const partName = `/${partPath}`;
+	if (!contentTypesXml.toLowerCase().includes(partName.toLowerCase())) newZip.file(contentTypesFile.name, contentTypesXml.replace("</Types>", () => `<Override PartName="${partName}" ContentType="${contentType}"/></Types>`), {
+		compression: "DEFLATE",
+		compressionOptions
+	});
+	const relationshipsXml = await relationshipsFile.async("text");
+	if (!relationshipsXml.includes(relationshipType)) {
+		const relationshipId = `rId${findMaxRId(relationshipsXml) + 1}`;
+		const target = partPath.slice(5);
+		newZip.file(relationshipsFile.name, relationshipsXml.replace("</Relationships>", () => `<Relationship Id="${relationshipId}" Type="${relationshipType}" Target="${target}"/></Relationships>`), {
+			compression: "DEFLATE",
+			compressionOptions
+		});
+	}
+	newZip.file(partPath, serializedPart, {
+		compression: "DEFLATE",
+		compressionOptions
+	});
 }
 const numberingBaselines = /* @__PURE__ */ new WeakMap();
 async function serializeNumberingIntoZip(doc, originalZip, newZip, compressionLevel) {

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

@@ -14,5 +14,11 @@ declare function serializeFootnotes(footnotes: readonly document_d_exports.Footn
  * @returns Complete endnotes.xml string.
  */
 declare function serializeEndnotes(endnotes: readonly document_d_exports.Endnote[]): string;
+/** Serialize a brand-new footnote part, including Word's required separators
+ * and the automatic reference mark at the start of every normal note. */
+declare function serializeNewFootnotesPart(footnotes: readonly document_d_exports.Footnote[]): string;
+/** Serialize a brand-new endnote part, including Word's required separators
+ * and the automatic reference mark at the start of every normal note. */
+declare function serializeNewEndnotesPart(endnotes: readonly document_d_exports.Endnote[]): string;
 //#endregion
-export { serializeEndnotes, serializeFootnotes };
+export { serializeEndnotes, serializeFootnotes, serializeNewEndnotesPart, serializeNewFootnotesPart };

package/dist/docx/serializer/noteSerializer.js

@@ -48,6 +48,25 @@ function serializeNote(elementName, note) {
 	const body = note.content.map((block) => serializeBlock(block)).join("");
 	return `<w:${elementName} ${attrs.join(" ")}>${body}</w:${elementName}>`;
 }
+const NOTE_SEPARATOR_BODY = "<w:p><w:pPr><w:spacing w:after=\"0\" w:line=\"240\" w:lineRule=\"auto\"/></w:pPr>";
+function serializeRequiredNoteSeparators(elementName) {
+	return `<w:${elementName} w:type="separator" w:id="-1">${NOTE_SEPARATOR_BODY}<w:r><w:separator/></w:r></w:p></w:${elementName}><w:${elementName} w:type="continuationSeparator" w:id="0">${NOTE_SEPARATOR_BODY}<w:r><w:continuationSeparator/></w:r></w:p></w:${elementName}>`;
+}
+function insertNoteReferenceMark(xml, elementName) {
+	const paragraphOpen = /<w:p(?=[\s>])[^>]*>/u.exec(xml);
+	if (!paragraphOpen) return `${`<w:p><w:r><w:rPr><w:rStyle w:val="${elementName === "footnote" ? "FootnoteReference" : "EndnoteReference"}"/></w:rPr><w:${elementName}Ref/></w:r></w:p>`}${xml}`;
+	const paragraphStart = paragraphOpen.index + paragraphOpen[0].length;
+	const paragraphEnd = xml.indexOf("</w:p>", paragraphStart);
+	const propertiesEnd = xml.indexOf("</w:pPr>", paragraphStart);
+	const insertAt = propertiesEnd !== -1 && propertiesEnd < paragraphEnd ? propertiesEnd + 8 : paragraphStart;
+	const referenceRun = `<w:r><w:rPr><w:rStyle w:val="${elementName === "footnote" ? "FootnoteReference" : "EndnoteReference"}"/></w:rPr><w:${elementName}Ref/></w:r>`;
+	return `${xml.slice(0, insertAt)}${referenceRun}${xml.slice(insertAt)}`;
+}
+function serializeNewNotePart(elementName, notes) {
+	const nsDecl = buildNamespaceDeclarations();
+	const serializedNotes = notes.map((note) => insertNoteReferenceMark(serializeNote(elementName, note), elementName)).join("");
+	return `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n<w:${elementName}s ${nsDecl} mc:Ignorable="w14 w15 wp14">` + serializeRequiredNoteSeparators(elementName) + serializedNotes + `</w:${elementName}s>`;
+}
 /**
 * Serialize footnotes to a complete word/footnotes.xml string.
 *
@@ -66,5 +85,15 @@ function serializeFootnotes(footnotes) {
 function serializeEndnotes(endnotes) {
 	return `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n<w:endnotes ${buildNamespaceDeclarations()} mc:Ignorable="w14 w15 wp14">${endnotes.map((en) => serializeNote("endnote", en)).join("")}</w:endnotes>`;
 }
+/** Serialize a brand-new footnote part, including Word's required separators
+* and the automatic reference mark at the start of every normal note. */
+function serializeNewFootnotesPart(footnotes) {
+	return serializeNewNotePart("footnote", footnotes);
+}
+/** Serialize a brand-new endnote part, including Word's required separators
+* and the automatic reference mark at the start of every normal note. */
+function serializeNewEndnotesPart(endnotes) {
+	return serializeNewNotePart("endnote", endnotes);
+}
 //#endregion
-export { serializeEndnotes, serializeFootnotes };
+export { serializeEndnotes, serializeFootnotes, serializeNewEndnotesPart, serializeNewFootnotesPart };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stll/folio-core",
-  "version": "0.15.9",
+  "version": "0.15.11",
   "description": "Headless, framework-neutral core of folio: the OOXML (.docx) parser, document model, ProseMirror integration, and page-layout engine. No React.",
   "keywords": [
     "document-model",
@@ -107,7 +107,7 @@
     "perf": "bun scripts/profile-editor.ts"
   },
   "dependencies": {
-    "@stll/docx-core": "^0.12.0",
+    "@stll/docx-core": "^0.13.0",
     "@stll/docx-utils": "^0.1.0",
     "@stll/template-conditions": "^0.1.0",
     "better-result": "2.10.0",