doc-codec 2.8.5 → 2.9.0

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.5",
+  "version": "2.9.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.7",
-    "document-schema.js": "7.9.1"
+    "archive-codec": "1.11.0",
+    "document-schema.js": "7.11.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.5",