doc-codec 2.8.6 → 2.10.0

package/dist/table/read.cjs

@@ -22,8 +22,8 @@ function effectiveColumnBoundaryTolerance(definitions) {
 	}
 	return narrowestRealGapTwips === void 0 ? TWIPS_PER_POINT : Math.min(TWIPS_PER_POINT, narrowestRealGapTwips - 1);
 }
-function assembleBlocks(entries) {
-	return walkBlocksAtDepth(entries, 0);
+function assembleBlocks(entries, documentStreamEnds = false) {
+	return walkBlocksAtDepth(entries, 0, documentStreamEnds);
 }
 function effectiveTableDepth(properties) {
 	if (properties.tableDepth !== void 0) return properties.tableDepth;
@@ -36,7 +36,7 @@ function isCellBoundary(entry, tableDepth) {
 function isRowBoundary(entry, tableDepth) {
 	return tableDepth === 1 ? entry.properties.tableRowEnd === true : entry.properties.innerTtpMark === true;
 }
-function walkBlocksAtDepth(entries, depth) {
+function walkBlocksAtDepth(entries, depth, documentStreamEnds) {
 	const blocks = [];
 	let index = 0;
 	while (index < entries.length) {
@@ -49,7 +49,7 @@ function walkBlocksAtDepth(entries, depth) {
 		}
 		const tableDepth = depth + 1;
 		const { runEntries, nextIndex } = collectTableRun(entries, index, tableDepth);
-		const table = tryAssembleTable(runEntries, tableDepth);
+		const table = tryAssembleTable(runEntries, tableDepth, !documentStreamEnds || nextIndex < entries.length);
 		blocks.push(...table !== void 0 ? [table] : runEntries.flatMap((run) => run.blocks));
 		index = nextIndex;
 	}
@@ -69,7 +69,7 @@ function collectTableRun(entries, start, tableDepth) {
 		nextIndex: index
 	};
 }
-function tryAssembleTable(runEntries, tableDepth) {
+function tryAssembleTable(runEntries, tableDepth, streamContinues) {
 	const rawRows = [];
 	const rowDefinitions = [];
 	const rowHeights = [];
@@ -101,11 +101,14 @@ function tryAssembleTable(runEntries, tableDepth) {
 			continue;
 		}
 		if (isCellBoundary(entry, tableDepth)) {
-			rowCells.push({ blocks: walkBlocksAtDepth(cellEntries, tableDepth) });
+			rowCells.push({ blocks: walkBlocksAtDepth(cellEntries, tableDepth, false) });
 			cellEntries = [];
 		}
 	}
-	if (cellEntries.length > 0 || rowCells.length > 0) throw new require_errors.DocFormatError("a table's paragraphs end without a row-ending mark to close the row's last cell");
+	if (cellEntries.length > 0 || rowCells.length > 0) {
+		if (rawRows.length === 0 && streamContinues) return;
+		throw new require_errors.DocFormatError("a table's paragraphs end without a row-ending mark to close the row's last cell");
+	}
 	const toleranceTwips = effectiveColumnBoundaryTolerance(rowDefinitions);
 	const columnBoundariesTwips = canonicalColumnBoundariesTwips(rowDefinitions, toleranceTwips);
 	return {

package/dist/table/read.d.cts

@@ -1,6 +1,6 @@
 import { t as ParagraphEntry } from "../paragraphs-DQUp8_HB.cjs";
 import { ContentBlock } from "document-schema.js";
 //#region src/table/read.d.ts
-declare function assembleBlocks(entries: readonly ParagraphEntry[]): ContentBlock[];
+declare function assembleBlocks(entries: readonly ParagraphEntry[], documentStreamEnds?: boolean): ContentBlock[];
 //#endregion
 export { assembleBlocks };

package/dist/table/read.d.ts

@@ -1,6 +1,6 @@
 import { t as ParagraphEntry } from "../paragraphs-s2lJ6w2I.js";
 import { ContentBlock } from "document-schema.js";
 //#region src/table/read.d.ts
-declare function assembleBlocks(entries: readonly ParagraphEntry[]): ContentBlock[];
+declare function assembleBlocks(entries: readonly ParagraphEntry[], documentStreamEnds?: boolean): ContentBlock[];
 //#endregion
 export { assembleBlocks };

package/dist/table/read.js

@@ -21,8 +21,8 @@ function effectiveColumnBoundaryTolerance(definitions) {
 	}
 	return narrowestRealGapTwips === void 0 ? TWIPS_PER_POINT : Math.min(TWIPS_PER_POINT, narrowestRealGapTwips - 1);
 }
-function assembleBlocks(entries) {
-	return walkBlocksAtDepth(entries, 0);
+function assembleBlocks(entries, documentStreamEnds = false) {
+	return walkBlocksAtDepth(entries, 0, documentStreamEnds);
 }
 function effectiveTableDepth(properties) {
 	if (properties.tableDepth !== void 0) return properties.tableDepth;
@@ -35,7 +35,7 @@ function isCellBoundary(entry, tableDepth) {
 function isRowBoundary(entry, tableDepth) {
 	return tableDepth === 1 ? entry.properties.tableRowEnd === true : entry.properties.innerTtpMark === true;
 }
-function walkBlocksAtDepth(entries, depth) {
+function walkBlocksAtDepth(entries, depth, documentStreamEnds) {
 	const blocks = [];
 	let index = 0;
 	while (index < entries.length) {
@@ -48,7 +48,7 @@ function walkBlocksAtDepth(entries, depth) {
 		}
 		const tableDepth = depth + 1;
 		const { runEntries, nextIndex } = collectTableRun(entries, index, tableDepth);
-		const table = tryAssembleTable(runEntries, tableDepth);
+		const table = tryAssembleTable(runEntries, tableDepth, !documentStreamEnds || nextIndex < entries.length);
 		blocks.push(...table !== void 0 ? [table] : runEntries.flatMap((run) => run.blocks));
 		index = nextIndex;
 	}
@@ -68,7 +68,7 @@ function collectTableRun(entries, start, tableDepth) {
 		nextIndex: index
 	};
 }
-function tryAssembleTable(runEntries, tableDepth) {
+function tryAssembleTable(runEntries, tableDepth, streamContinues) {
 	const rawRows = [];
 	const rowDefinitions = [];
 	const rowHeights = [];
@@ -100,11 +100,14 @@ function tryAssembleTable(runEntries, tableDepth) {
 			continue;
 		}
 		if (isCellBoundary(entry, tableDepth)) {
-			rowCells.push({ blocks: walkBlocksAtDepth(cellEntries, tableDepth) });
+			rowCells.push({ blocks: walkBlocksAtDepth(cellEntries, tableDepth, false) });
 			cellEntries = [];
 		}
 	}
-	if (cellEntries.length > 0 || rowCells.length > 0) throw new DocFormatError("a table's paragraphs end without a row-ending mark to close the row's last cell");
+	if (cellEntries.length > 0 || rowCells.length > 0) {
+		if (rawRows.length === 0 && streamContinues) return;
+		throw new DocFormatError("a table's paragraphs end without a row-ending mark to close the row's last cell");
+	}
 	const toleranceTwips = effectiveColumnBoundaryTolerance(rowDefinitions);
 	const columnBoundariesTwips = canonicalColumnBoundariesTwips(rowDefinitions, toleranceTwips);
 	return {

package/dist/table/write.cjs

@@ -1,6 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_errors = require("../errors.cjs");
-require("../data-stream.cjs");
 require("../text/special.cjs");
 const require_prop_fkp_write = require("../prop/fkp-write.cjs");
 const require_pictures_write = require("../pictures-write.cjs");
@@ -210,6 +209,22 @@ function imageParagraph(image, dataStream) {
 		terminator: 13
 	};
 }
+function appendPageBreak(output) {
+	const previous = output[output.length - 1];
+	if (previous?.terminator === 13) {
+		output[output.length - 1] = {
+			...previous,
+			terminator: 12
+		};
+		return;
+	}
+	output.push({
+		runs: [],
+		properties: {},
+		extraGrpprl: [],
+		terminator: 12
+	});
+}
 function flattenSectionBlocks(blocks, dataStream, onWarning) {
 	const output = [];
 	blocks.forEach((block, blockIndex) => {
@@ -230,6 +245,10 @@ function flattenSectionBlocks(blocks, dataStream, onWarning) {
 			output.push(imageParagraph(block, dataStream));
 			return;
 		}
+		if (block.kind === "pageBreak") {
+			appendPageBreak(output);
+			return;
+		}
 		throw new require_errors.DocUnsupportedError(`doc-codec's writer does not yet support '${block.kind}' blocks (see README's scope note)`);
 	});
 	return output;

package/dist/table/write.js

@@ -1,5 +1,4 @@
 import { DocFormatError, DocUnsupportedError } from "../errors.js";
-import "../data-stream.js";
 import "../text/special.js";
 import { fitsAloneOnPapxPage } from "../prop/fkp-write.js";
 import { buildInlinePicture } from "../pictures-write.js";
@@ -209,6 +208,22 @@ function imageParagraph(image, dataStream) {
 		terminator: 13
 	};
 }
+function appendPageBreak(output) {
+	const previous = output[output.length - 1];
+	if (previous?.terminator === 13) {
+		output[output.length - 1] = {
+			...previous,
+			terminator: 12
+		};
+		return;
+	}
+	output.push({
+		runs: [],
+		properties: {},
+		extraGrpprl: [],
+		terminator: 12
+	});
+}
 function flattenSectionBlocks(blocks, dataStream, onWarning) {
 	const output = [];
 	blocks.forEach((block, blockIndex) => {
@@ -229,6 +244,10 @@ function flattenSectionBlocks(blocks, dataStream, onWarning) {
 			output.push(imageParagraph(block, dataStream));
 			return;
 		}
+		if (block.kind === "pageBreak") {
+			appendPageBreak(output);
+			return;
+		}
 		throw new DocUnsupportedError(`doc-codec's writer does not yet support '${block.kind}' blocks (see README's scope note)`);
 	});
 	return output;

package/dist/text/paragraphs.cjs

@@ -26,10 +26,26 @@ function readParagraphs(text, fcs, context) {
 	}
 	return entries;
 }
+/** sprmPHugePapx (0x6646), [MS-DOC] 2.6.2's Paragraph Properties table: "a 4-byte unsigned integer that specifies a location in the Data Stream" where "a PrcData structure begins ... and specifies additional properties for the paragraph". A paragraph whose direct grpprl opens with this sprm keeps its real properties in that Data-stream PrcData -- the whole point of the sprm is a Papx too large for its own 512-byte FKP page, so Word leaves the FKP holding only the pointer. */
+const SPRM_P_HUGE_PAPX = 26182;
+const MAX_PAPX_INDIRECTION_HOPS = 16;
+function resolveIndirectPapx(prls, context) {
+	let current = prls;
+	for (let hop = 0;; hop += 1) {
+		const first = current[0];
+		if (first?.sprm.value !== SPRM_P_HUGE_PAPX) return current;
+		if (hop >= MAX_PAPX_INDIRECTION_HOPS) throw new require_errors.DocFormatError(`a paragraph's indirect property chain did not terminate within ${MAX_PAPX_INDIRECTION_HOPS} sprmPHugePapx hops; [MS-DOC] 2.6.2 requires the chain to terminate`);
+		if (context.dataStream === void 0) throw new require_errors.DocFormatError("a paragraph's grpprl opens with sprmPHugePapx, but this compound file carries no Data stream for it to point into");
+		const offset = require_bytes.readUint32LE(first.operand, 0);
+		const cbGrpprl = require_bytes.readUint16LE(context.dataStream, offset);
+		const grpprl = require_bytes.slice(context.dataStream, offset + 2, cbGrpprl, "a sprmPHugePapx-referenced PrcData's GrpPrl");
+		current = require_prop_sprm.readGrpprl(grpprl);
+	}
+}
 function buildParagraph(text, fcs, propertyFc, terminator, endCp, context) {
 	const papx = context.papxTable.papx(propertyFc);
 	const properties = {};
-	const grpprl = papx !== void 0 ? require_prop_sprm.readGrpprl(papx.grpprl) : [];
+	const grpprl = papx !== void 0 ? resolveIndirectPapx(require_prop_sprm.readGrpprl(papx.grpprl), context) : [];
 	if (papx !== void 0) {
 		properties.istd = papx.istd;
 		if (context.styles !== void 0) require_prop_pap.applyParagraphSprms(require_style_stsh.resolveStyleFormatting(context.styles, papx.istd).paragraphPrls, properties);

package/dist/text/paragraphs.js

@@ -1,5 +1,5 @@
 import { DocFormatError } from "../errors.js";
-import { readInt32LE } from "../bytes.js";
+import { readInt32LE, readUint16LE, readUint32LE, slice } from "../bytes.js";
 import { readGrpprl } from "../prop/sprm.js";
 import { applyCharacterSprms, characterIstdFromGrpprl } from "../prop/chp.js";
 import { applyParagraphSprms } from "../prop/pap.js";
@@ -25,10 +25,26 @@ function readParagraphs(text, fcs, context) {
 	}
 	return entries;
 }
+/** sprmPHugePapx (0x6646), [MS-DOC] 2.6.2's Paragraph Properties table: "a 4-byte unsigned integer that specifies a location in the Data Stream" where "a PrcData structure begins ... and specifies additional properties for the paragraph". A paragraph whose direct grpprl opens with this sprm keeps its real properties in that Data-stream PrcData -- the whole point of the sprm is a Papx too large for its own 512-byte FKP page, so Word leaves the FKP holding only the pointer. */
+const SPRM_P_HUGE_PAPX = 26182;
+const MAX_PAPX_INDIRECTION_HOPS = 16;
+function resolveIndirectPapx(prls, context) {
+	let current = prls;
+	for (let hop = 0;; hop += 1) {
+		const first = current[0];
+		if (first?.sprm.value !== SPRM_P_HUGE_PAPX) return current;
+		if (hop >= MAX_PAPX_INDIRECTION_HOPS) throw new DocFormatError(`a paragraph's indirect property chain did not terminate within ${MAX_PAPX_INDIRECTION_HOPS} sprmPHugePapx hops; [MS-DOC] 2.6.2 requires the chain to terminate`);
+		if (context.dataStream === void 0) throw new DocFormatError("a paragraph's grpprl opens with sprmPHugePapx, but this compound file carries no Data stream for it to point into");
+		const offset = readUint32LE(first.operand, 0);
+		const cbGrpprl = readUint16LE(context.dataStream, offset);
+		const grpprl = slice(context.dataStream, offset + 2, cbGrpprl, "a sprmPHugePapx-referenced PrcData's GrpPrl");
+		current = readGrpprl(grpprl);
+	}
+}
 function buildParagraph(text, fcs, propertyFc, terminator, endCp, context) {
 	const papx = context.papxTable.papx(propertyFc);
 	const properties = {};
-	const grpprl = papx !== void 0 ? readGrpprl(papx.grpprl) : [];
+	const grpprl = papx !== void 0 ? resolveIndirectPapx(readGrpprl(papx.grpprl), context) : [];
 	if (papx !== void 0) {
 		properties.istd = papx.istd;
 		if (context.styles !== void 0) applyParagraphSprms(resolveStyleFormatting(context.styles, papx.istd).paragraphPrls, properties);

package/dist/write.cjs

@@ -13,8 +13,9 @@ const require_prop_chp_write = require("./prop/chp-write.cjs");
 const require_prop_pap_write = require("./prop/pap-write.cjs");
 const require_prop_sep_write = require("./prop/sep-write.cjs");
 const require_style_fonts = require("./style/fonts.cjs");
-const require_list_numbering_write = require("./list/numbering-write.cjs");
 const require_table_write = require("./table/write.cjs");
+const require_subdocument_write = require("./subdocument-write.cjs");
+const require_list_numbering_write = require("./list/numbering-write.cjs");
 let archive_codec = require("archive-codec");
 //#region src/write.ts
 /** Where the text is written in the WordDocument stream: past the FIB (which needs under 900 bytes for the fields this writer populates), on a page boundary though not required to be. */
@@ -38,7 +39,16 @@ function writeDocContent(document, options = {}) {
 			runningIndex += paragraphs.length;
 		}
 	}
-	const writeParagraphs = sectionParagraphLists.flat();
+	const mainParagraphs = sectionParagraphLists.flat();
+	const stories = require_subdocument_write.buildStorySubdocuments(document, dataStream, options.onWarning);
+	const ccpText = mainParagraphs.reduce((count, paragraph) => count + require_subdocument_write.paragraphCharacters(paragraph), 0);
+	const writeParagraphs = [
+		...mainParagraphs,
+		...stories.footnote?.paragraphs ?? [],
+		...stories.header?.paragraphs ?? [],
+		...stories.comment?.paragraphs ?? [],
+		...stories.endnote?.paragraphs ?? []
+	];
 	const FIRST_NON_HEADING_ISTD = 10;
 	const MAX_HEADING_ISTD = 9;
 	const styleNames = /* @__PURE__ */ new Map();
@@ -176,7 +186,7 @@ function writeDocContent(document, options = {}) {
 	const papxBinTable = require_prop_fkp_write.buildPropertyBinTable([...papxPages.map(require_prop_fkp_write.firstFcOfPage), textFcLim], papxPages.map((_, index) => papxPageStart + index));
 	const stsh = require_style_stsh.buildStshForStyles(styleNames);
 	const fontTable = fontNames.length > 0 ? require_style_fonts.buildFontTable(fontNames) : void 0;
-	const plcfSed = require_prop_sep_write.buildPlcfSed(sectionStartCps, text.length, fcSepxList);
+	const plcfSed = require_prop_sep_write.buildPlcfSed(sectionStartCps, ccpText, fcSepxList);
 	let cursor = 0;
 	const place = (bytes) => {
 		const offset = cursor;
@@ -191,6 +201,10 @@ function writeDocContent(document, options = {}) {
 	const fcSttbfFfn = fontTable !== void 0 ? place(fontTable) : 0;
 	const fcPlfLst = numberingTables !== void 0 ? place(numberingTables.plfLst) : 0;
 	const fcPlfLfo = numberingTables !== void 0 ? place(numberingTables.plfLfo) : 0;
+	const fcPlcffndTxt = stories.footnote !== void 0 ? place(stories.footnote.plex) : 0;
+	const fcPlcfHdd = stories.header !== void 0 ? place(stories.header.plex) : 0;
+	const fcPlcfandTxt = stories.comment !== void 0 ? place(stories.comment.plex) : 0;
+	const fcPlcfendTxt = stories.endnote !== void 0 ? place(stories.endnote.plex) : 0;
 	const table = new Uint8Array(cursor);
 	table.set(clx, fcClx);
 	table.set(chpxBinTable, fcPlcfBteChpx);
@@ -202,8 +216,12 @@ function writeDocContent(document, options = {}) {
 		table.set(numberingTables.plfLst, fcPlfLst);
 		table.set(numberingTables.plfLfo, fcPlfLfo);
 	}
+	if (stories.footnote !== void 0) table.set(stories.footnote.plex, fcPlcffndTxt);
+	if (stories.header !== void 0) table.set(stories.header.plex, fcPlcfHdd);
+	if (stories.comment !== void 0) table.set(stories.comment.plex, fcPlcfandTxt);
+	if (stories.endnote !== void 0) table.set(stories.endnote.plex, fcPlcfendTxt);
 	const fib = require_fib_write.buildFib({
-		ccpText: text.length,
+		ccpText,
 		cbMac: wordDocument.length,
 		fcClx,
 		lcbClx: clx.length,
@@ -220,7 +238,19 @@ function writeDocContent(document, options = {}) {
 		fcPlfLst,
 		lcbPlfLst: numberingTables?.lcbPlfLst ?? 0,
 		fcPlfLfo,
-		lcbPlfLfo: numberingTables?.plfLfo.length ?? 0
+		lcbPlfLfo: numberingTables?.plfLfo.length ?? 0,
+		ccpFtn: stories.footnote?.ccp ?? 0,
+		fcPlcffndTxt,
+		lcbPlcffndTxt: stories.footnote?.plex.length ?? 0,
+		ccpHdd: stories.header?.ccp ?? 0,
+		fcPlcfHdd,
+		lcbPlcfHdd: stories.header?.plex.length ?? 0,
+		ccpAtn: stories.comment?.ccp ?? 0,
+		fcPlcfandTxt,
+		lcbPlcfandTxt: stories.comment?.plex.length ?? 0,
+		ccpEdn: stories.endnote?.ccp ?? 0,
+		fcPlcfendTxt,
+		lcbPlcfendTxt: stories.endnote?.plex.length ?? 0
 	});
 	wordDocument.set(fib, 0);
 	const streams = [{

package/dist/write.d.cts

@@ -1,10 +1,19 @@
+import { HeaderFooterStory } from "./headers-footers.cjs";
 import { r as WriteWarning } from "./write-CMB3qF4i.cjs";
+import { Comment, Footnote } from "./notes.cjs";
 import { ContentDocument } from "document-schema.js";
 //#region src/write.d.ts
 interface WriteDocContentOptions {
   /** Reports a non-fatal write-time degradation -- today, only table/write.ts's own per-row lost-boundary-budget fallback (ExaDev/documents.js#1013), the same `onWarning` shape byte-codec's PNG decoder and pdf-codec already use for a recoverable, non-fatal defect. Not a guarantee the write itself goes on to succeed: when a row's own assigned lost boundaries can't be trimmed down to a split that fits at all, this still fires once -- reporting that the row's boundaries could not be stated and that its fully-unsplit encoding is being attempted instead -- before writeDocContent can discover, further down the same pipeline, that even that unsplit encoding overflows the row's own byte budget and throws its usual DocFormatError; the warning describes what this fallback could not recover, not a promise that a hard failure won't immediately follow it. It is never called in place of a genuine refusal this writer makes outright (an unsupported block kind, more than one section, and so on) -- those always throw DocFormatError/DocUnsupportedError directly, with no warning first. */
   readonly onWarning?: WriteWarning;
 }
-declare function writeDocContent(document: ContentDocument, options?: WriteDocContentOptions): Uint8Array<ArrayBuffer>;
+/** writeDocContent's own input: a `ContentDocument` widened by the same story fields `readDocContent`'s own `DocContent` output carries (read.ts) -- footnotes, endnotes, comments, and header/footer stories -- each OPTIONAL, exactly the shape ooxml.js's own `DocxContent` input already established for the identical constructs, so a plain `ContentDocument` (none of the four stated) still writes exactly as it always did, while a genuine `DocContent` assigns straight across. A type-alias intersection rather than an interface for the identical reason DocContent is one: ContentDocument is a union of document kinds, and only the intersection spreads its members statically. The stories are written back as genuine subdocuments (subdocument-write.ts); a document that states none writes no subdocument at all, with every story ccp and fc/lcb pair left zero. */
+type WritableDocContent = ContentDocument & {
+  readonly footnotes?: readonly Footnote[];
+  readonly endnotes?: readonly Footnote[];
+  readonly comments?: readonly Comment[];
+  readonly headerFooterStories?: readonly HeaderFooterStory[];
+};
+declare function writeDocContent(document: WritableDocContent, options?: WriteDocContentOptions): Uint8Array<ArrayBuffer>;
 //#endregion
-export { WriteDocContentOptions, writeDocContent };
+export { WritableDocContent, WriteDocContentOptions, writeDocContent };

package/dist/write.d.ts

@@ -1,10 +1,19 @@
+import { HeaderFooterStory } from "./headers-footers.js";
 import { r as WriteWarning } from "./write-t4rFgnA-.js";
+import { Comment, Footnote } from "./notes.js";
 import { ContentDocument } from "document-schema.js";
 //#region src/write.d.ts
 interface WriteDocContentOptions {
   /** Reports a non-fatal write-time degradation -- today, only table/write.ts's own per-row lost-boundary-budget fallback (ExaDev/documents.js#1013), the same `onWarning` shape byte-codec's PNG decoder and pdf-codec already use for a recoverable, non-fatal defect. Not a guarantee the write itself goes on to succeed: when a row's own assigned lost boundaries can't be trimmed down to a split that fits at all, this still fires once -- reporting that the row's boundaries could not be stated and that its fully-unsplit encoding is being attempted instead -- before writeDocContent can discover, further down the same pipeline, that even that unsplit encoding overflows the row's own byte budget and throws its usual DocFormatError; the warning describes what this fallback could not recover, not a promise that a hard failure won't immediately follow it. It is never called in place of a genuine refusal this writer makes outright (an unsupported block kind, more than one section, and so on) -- those always throw DocFormatError/DocUnsupportedError directly, with no warning first. */
   readonly onWarning?: WriteWarning;
 }
-declare function writeDocContent(document: ContentDocument, options?: WriteDocContentOptions): Uint8Array<ArrayBuffer>;
+/** writeDocContent's own input: a `ContentDocument` widened by the same story fields `readDocContent`'s own `DocContent` output carries (read.ts) -- footnotes, endnotes, comments, and header/footer stories -- each OPTIONAL, exactly the shape ooxml.js's own `DocxContent` input already established for the identical constructs, so a plain `ContentDocument` (none of the four stated) still writes exactly as it always did, while a genuine `DocContent` assigns straight across. A type-alias intersection rather than an interface for the identical reason DocContent is one: ContentDocument is a union of document kinds, and only the intersection spreads its members statically. The stories are written back as genuine subdocuments (subdocument-write.ts); a document that states none writes no subdocument at all, with every story ccp and fc/lcb pair left zero. */
+type WritableDocContent = ContentDocument & {
+  readonly footnotes?: readonly Footnote[];
+  readonly endnotes?: readonly Footnote[];
+  readonly comments?: readonly Comment[];
+  readonly headerFooterStories?: readonly HeaderFooterStory[];
+};
+declare function writeDocContent(document: WritableDocContent, options?: WriteDocContentOptions): Uint8Array<ArrayBuffer>;
 //#endregion
-export { WriteDocContentOptions, writeDocContent };
+export { WritableDocContent, WriteDocContentOptions, writeDocContent };

package/dist/write.js

@@ -12,8 +12,9 @@ import { encodeCharacterGrpprl } from "./prop/chp-write.js";
 import { encodeParagraphGrpprl } from "./prop/pap-write.js";
 import { buildPlcfSed, buildSepx, encodeSectionGrpprl } from "./prop/sep-write.js";
 import { buildFontTable } from "./style/fonts.js";
-import { buildNumberingTables, gatherListUsage } from "./list/numbering-write.js";
 import { flattenSectionBlocks } from "./table/write.js";
+import { buildStorySubdocuments, paragraphCharacters } from "./subdocument-write.js";
+import { buildNumberingTables, gatherListUsage } from "./list/numbering-write.js";
 import { hasSummaryInformationFields, writeCompoundFile, writeSummaryInformationStream } from "archive-codec";
 //#region src/write.ts
 /** Where the text is written in the WordDocument stream: past the FIB (which needs under 900 bytes for the fields this writer populates), on a page boundary though not required to be. */
@@ -37,7 +38,16 @@ function writeDocContent(document, options = {}) {
 			runningIndex += paragraphs.length;
 		}
 	}
-	const writeParagraphs = sectionParagraphLists.flat();
+	const mainParagraphs = sectionParagraphLists.flat();
+	const stories = buildStorySubdocuments(document, dataStream, options.onWarning);
+	const ccpText = mainParagraphs.reduce((count, paragraph) => count + paragraphCharacters(paragraph), 0);
+	const writeParagraphs = [
+		...mainParagraphs,
+		...stories.footnote?.paragraphs ?? [],
+		...stories.header?.paragraphs ?? [],
+		...stories.comment?.paragraphs ?? [],
+		...stories.endnote?.paragraphs ?? []
+	];
 	const FIRST_NON_HEADING_ISTD = 10;
 	const MAX_HEADING_ISTD = 9;
 	const styleNames = /* @__PURE__ */ new Map();
@@ -175,7 +185,7 @@ function writeDocContent(document, options = {}) {
 	const papxBinTable = buildPropertyBinTable([...papxPages.map(firstFcOfPage), textFcLim], papxPages.map((_, index) => papxPageStart + index));
 	const stsh = buildStshForStyles(styleNames);
 	const fontTable = fontNames.length > 0 ? buildFontTable(fontNames) : void 0;
-	const plcfSed = buildPlcfSed(sectionStartCps, text.length, fcSepxList);
+	const plcfSed = buildPlcfSed(sectionStartCps, ccpText, fcSepxList);
 	let cursor = 0;
 	const place = (bytes) => {
 		const offset = cursor;
@@ -190,6 +200,10 @@ function writeDocContent(document, options = {}) {
 	const fcSttbfFfn = fontTable !== void 0 ? place(fontTable) : 0;
 	const fcPlfLst = numberingTables !== void 0 ? place(numberingTables.plfLst) : 0;
 	const fcPlfLfo = numberingTables !== void 0 ? place(numberingTables.plfLfo) : 0;
+	const fcPlcffndTxt = stories.footnote !== void 0 ? place(stories.footnote.plex) : 0;
+	const fcPlcfHdd = stories.header !== void 0 ? place(stories.header.plex) : 0;
+	const fcPlcfandTxt = stories.comment !== void 0 ? place(stories.comment.plex) : 0;
+	const fcPlcfendTxt = stories.endnote !== void 0 ? place(stories.endnote.plex) : 0;
 	const table = new Uint8Array(cursor);
 	table.set(clx, fcClx);
 	table.set(chpxBinTable, fcPlcfBteChpx);
@@ -201,8 +215,12 @@ function writeDocContent(document, options = {}) {
 		table.set(numberingTables.plfLst, fcPlfLst);
 		table.set(numberingTables.plfLfo, fcPlfLfo);
 	}
+	if (stories.footnote !== void 0) table.set(stories.footnote.plex, fcPlcffndTxt);
+	if (stories.header !== void 0) table.set(stories.header.plex, fcPlcfHdd);
+	if (stories.comment !== void 0) table.set(stories.comment.plex, fcPlcfandTxt);
+	if (stories.endnote !== void 0) table.set(stories.endnote.plex, fcPlcfendTxt);
 	const fib = buildFib({
-		ccpText: text.length,
+		ccpText,
 		cbMac: wordDocument.length,
 		fcClx,
 		lcbClx: clx.length,
@@ -219,7 +237,19 @@ function writeDocContent(document, options = {}) {
 		fcPlfLst,
 		lcbPlfLst: numberingTables?.lcbPlfLst ?? 0,
 		fcPlfLfo,
-		lcbPlfLfo: numberingTables?.plfLfo.length ?? 0
+		lcbPlfLfo: numberingTables?.plfLfo.length ?? 0,
+		ccpFtn: stories.footnote?.ccp ?? 0,
+		fcPlcffndTxt,
+		lcbPlcffndTxt: stories.footnote?.plex.length ?? 0,
+		ccpHdd: stories.header?.ccp ?? 0,
+		fcPlcfHdd,
+		lcbPlcfHdd: stories.header?.plex.length ?? 0,
+		ccpAtn: stories.comment?.ccp ?? 0,
+		fcPlcfandTxt,
+		lcbPlcfandTxt: stories.comment?.plex.length ?? 0,
+		ccpEdn: stories.endnote?.ccp ?? 0,
+		fcPlcfendTxt,
+		lcbPlcfendTxt: stories.endnote?.plex.length ?? 0
 	});
 	wordDocument.set(fib, 0);
 	const streams = [{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-codec",
-  "version": "2.8.6",
+  "version": "2.10.0",
   "description": "A hand-written reader for the Word Binary File Format ([MS-DOC], .doc) against the shared document-schema.js content pivot: FIB parsing, piece-table text reconstruction, and CHPX/PAPX formatting exceptions.",
   "type": "module",
   "repository": {
@@ -80,8 +80,8 @@
   "license": "MIT",
   "packageManager": "pnpm@11.6.0",
   "dependencies": {
-    "archive-codec": "1.10.8",
-    "document-schema.js": "7.10.0"
+    "archive-codec": "1.11.0",
+    "document-schema.js": "7.11.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.5",