@beyondwork/docx-react-component 1.0.0 → 1.0.2

package/test/io/headers-footers-roundtrip.test.ts

@@ -1,547 +0,0 @@
-import assert from "node:assert/strict";
-import test from "node:test";
-
-import type { PersistedEditorSnapshot } from "../../src/api/public-types.ts";
-import { loadDocxEditorSession } from "../../src/io/docx-session.ts";
-import { writeDocxPackage } from "../../src/io/opc/docx-package.ts";
-import { readOpcPackage, type OpcPackage } from "../../src/io/opc/package-reader.ts";
-import { writeOpcPackage } from "../../src/io/opc/package-writer.ts";
-import {
-  parseHeaderFooterReferences,
-  parseHeaderXml,
-  parseFooterXml,
-} from "../../src/io/ooxml/parse-headers-footers.ts";
-import { parseThemeXml } from "../../src/io/ooxml/parse-theme.ts";
-import {
-  serializeHeaderXml,
-  serializeFooterXml,
-} from "../../src/io/export/serialize-headers-footers.ts";
-import type { HeaderDocument, FooterDocument } from "../../src/model/canonical-document.ts";
-
-// ---- Fixtures ----
-
-const DOCUMENT_WITH_DEFAULT_HEADER = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"
-            xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
-  <w:body>
-    <w:p><w:r><w:t>Body text</w:t></w:r></w:p>
-    <w:sectPr>
-      <w:headerReference w:type="default" r:id="rId1"/>
-      <w:footerReference w:type="default" r:id="rId2"/>
-      <w:headerReference w:type="first" r:id="rId3"/>
-    </w:sectPr>
-  </w:body>
-</w:document>`;
-
-const DOCUMENT_WITH_EVEN_ODD = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"
-            xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
-  <w:body>
-    <w:p><w:r><w:t>Body text</w:t></w:r></w:p>
-    <w:sectPr>
-      <w:headerReference w:type="default" r:id="rId1"/>
-      <w:headerReference w:type="even" r:id="rId2"/>
-    </w:sectPr>
-  </w:body>
-</w:document>`;
-
-const HEADER_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<w:hdr xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
-  <w:p>
-    <w:pPr><w:pStyle w:val="Header"/></w:pPr>
-    <w:r><w:t xml:space="preserve">Document Title  </w:t></w:r>
-    <w:r><w:rPr><w:b/></w:rPr><w:t>Bold</w:t></w:r>
-  </w:p>
-  <w:p>
-    <w:r><w:t>Page</w:t></w:r>
-  </w:p>
-</w:hdr>`;
-
-const FOOTER_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<w:ftr xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
-  <w:p>
-    <w:pPr><w:jc w:val="center"/></w:pPr>
-    <w:r><w:t>Confidential</w:t></w:r>
-  </w:p>
-</w:ftr>`;
-
-const FIRST_PAGE_HEADER_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<w:hdr xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
-  <w:p>
-    <w:r><w:t>First Page</w:t></w:r>
-  </w:p>
-</w:hdr>`;
-
-const EMPTY_HEADER_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<w:hdr xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
-</w:hdr>`;
-
-const THEME_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<a:theme xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main" name="Office Theme">
-  <a:themeElements>
-    <a:clrScheme name="Office">
-      <a:dk1><a:sysClr val="windowText" lastClr="000000"/></a:dk1>
-      <a:lt1><a:sysClr val="window" lastClr="FFFFFF"/></a:lt1>
-      <a:accent1><a:srgbClr val="4F81BD"/></a:accent1>
-      <a:hlink><a:srgbClr val="0000FF"/></a:hlink>
-    </a:clrScheme>
-    <a:fontScheme name="Office">
-      <a:majorFont><a:latin typeface="Calibri"/></a:majorFont>
-      <a:minorFont><a:latin typeface="Cambria"/></a:minorFont>
-    </a:fontScheme>
-  </a:themeElements>
-</a:theme>`;
-
-// ---- Tests: parseHeaderFooterReferences ----
-
-test("parseHeaderFooterReferences extracts default, first-page header and default footer references", () => {
-  const refs = parseHeaderFooterReferences(DOCUMENT_WITH_DEFAULT_HEADER);
-
-  assert.equal(refs.length, 3);
-
-  const defaultHeader = refs.find((r) => r.kind === "header" && r.variant === "default");
-  assert.ok(defaultHeader, "expected a default header reference");
-  assert.equal(defaultHeader.relationshipId, "rId1");
-
-  const defaultFooter = refs.find((r) => r.kind === "footer" && r.variant === "default");
-  assert.ok(defaultFooter, "expected a default footer reference");
-  assert.equal(defaultFooter.relationshipId, "rId2");
-
-  const firstHeader = refs.find((r) => r.kind === "header" && r.variant === "first");
-  assert.ok(firstHeader, "expected a first-page header reference");
-  assert.equal(firstHeader.relationshipId, "rId3");
-});
-
-test("parseHeaderFooterReferences extracts even-page header variant", () => {
-  const refs = parseHeaderFooterReferences(DOCUMENT_WITH_EVEN_ODD);
-
-  const evenHeader = refs.find((r) => r.kind === "header" && r.variant === "even");
-  assert.ok(evenHeader, "expected an even header reference");
-  assert.equal(evenHeader.relationshipId, "rId2");
-});
-
-test("parseHeaderFooterReferences returns empty array for document with no headers/footers", () => {
-  const bare = `<?xml version="1.0"?><w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"><w:body><w:p/></w:body></w:document>`;
-  const refs = parseHeaderFooterReferences(bare);
-  assert.equal(refs.length, 0);
-});
-
-test("parseHeaderFooterReferences deduplicates references across multiple sectPr elements", () => {
-  const xml = `<?xml version="1.0"?>
-<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"
-            xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
-  <w:body>
-    <w:p>
-      <w:pPr>
-        <w:sectPr>
-          <w:headerReference w:type="default" r:id="rId1"/>
-        </w:sectPr>
-      </w:pPr>
-    </w:p>
-    <w:sectPr>
-      <w:headerReference w:type="default" r:id="rId1"/>
-    </w:sectPr>
-  </w:body>
-</w:document>`;
-
-  const refs = parseHeaderFooterReferences(xml);
-  const headerRefs = refs.filter((r) => r.kind === "header" && r.relationshipId === "rId1");
-  assert.equal(headerRefs.length, 1, "duplicate rId1 header reference should be deduplicated");
-});
-
-// ---- Tests: parseHeaderXml ----
-
-test("parseHeaderXml extracts paragraphs and text runs from hdr XML", () => {
-  const result = parseHeaderXml(HEADER_XML);
-
-  assert.equal(result.blocks.length, 2, "expected two paragraphs");
-
-  const firstParagraph = result.blocks[0];
-  assert.equal(firstParagraph?.type, "paragraph");
-  if (firstParagraph?.type === "paragraph") {
-    assert.equal(firstParagraph.styleId, "Header");
-    assert.ok(firstParagraph.children.length >= 2, "expected at least two inline nodes");
-    const firstText = firstParagraph.children[0];
-    assert.equal(firstText?.type, "text");
-    if (firstText?.type === "text") {
-      assert.equal(firstText.text, "Document Title  ");
-    }
-    const boldText = firstParagraph.children[1];
-    assert.equal(boldText?.type, "text");
-    if (boldText?.type === "text") {
-      assert.equal(boldText.text, "Bold");
-      assert.ok(boldText.marks?.some((m) => m.type === "bold"), "expected bold mark");
-    }
-  }
-});
-
-test("parseHeaderXml returns empty blocks for empty hdr element", () => {
-  const result = parseHeaderXml(EMPTY_HEADER_XML);
-  assert.equal(result.blocks.length, 0);
-});
-
-test("parseHeaderXml returns empty blocks for non-hdr root XML", () => {
-  const result = parseHeaderXml(`<?xml version="1.0"?><w:ftr xmlns:w="...">`);
-  assert.equal(result.blocks.length, 0);
-});
-
-// ---- Tests: parseFooterXml ----
-
-test("parseFooterXml extracts aligned paragraph from ftr XML", () => {
-  const result = parseFooterXml(FOOTER_XML);
-
-  assert.equal(result.blocks.length, 1);
-  const para = result.blocks[0];
-  assert.equal(para?.type, "paragraph");
-  if (para?.type === "paragraph") {
-    assert.equal(para.alignment, "center");
-    assert.equal(para.children.length, 1);
-    const text = para.children[0];
-    assert.equal(text?.type, "text");
-    if (text?.type === "text") {
-      assert.equal(text.text, "Confidential");
-    }
-  }
-});
-
-// ---- Tests: parseThemeXml ----
-
-test("parseThemeXml extracts theme name, colors, and font scheme", () => {
-  const theme = parseThemeXml(THEME_XML);
-
-  assert.equal(theme.name, "Office Theme");
-  assert.equal(theme.colorScheme?.name, "Office");
-  assert.equal(theme.colorScheme?.colors.dk1, "#000000");
-  assert.equal(theme.colorScheme?.colors.lt1, "#FFFFFF");
-  assert.equal(theme.colorScheme?.colors.accent1, "#4F81BD");
-  assert.equal(theme.colorScheme?.colors.hlink, "#0000FF");
-  assert.equal(theme.fontScheme?.name, "Office");
-  assert.equal(theme.fontScheme?.majorFont, "Calibri");
-  assert.equal(theme.fontScheme?.minorFont, "Cambria");
-});
-
-test("parseThemeXml returns an empty theme definition for blank XML", () => {
-  assert.deepEqual(parseThemeXml("   "), {});
-});
-
-// ---- Tests: serializeHeaderXml / serializeFooterXml ----
-
-test("serializeHeaderXml produces valid hdr XML with correct namespace", () => {
-  const header: HeaderDocument = {
-    variant: "default",
-    partPath: "/word/header1.xml",
-    relationshipId: "rId1",
-    blocks: [
-      {
-        type: "paragraph",
-        children: [{ type: "text", text: "Company Name" }],
-      },
-    ],
-  };
-
-  const xml = serializeHeaderXml(header);
-  assert.ok(xml.includes("<w:hdr"), "should emit w:hdr root element");
-  assert.ok(xml.includes("xmlns:w="), "should include wordprocessingml namespace");
-  assert.ok(xml.includes("Company Name"), "should include header text");
-  assert.ok(xml.includes("</w:hdr>"), "should close w:hdr element");
-});
-
-test("serializeFooterXml produces valid ftr XML with correct namespace", () => {
-  const footer: FooterDocument = {
-    variant: "default",
-    partPath: "/word/footer1.xml",
-    relationshipId: "rId2",
-    blocks: [
-      {
-        type: "paragraph",
-        alignment: "center",
-        children: [{ type: "text", text: "Page 1" }],
-      },
-    ],
-  };
-
-  const xml = serializeFooterXml(footer);
-  assert.ok(xml.includes("<w:ftr"), "should emit w:ftr root element");
-  assert.ok(xml.includes("Page 1"), "should include footer text");
-  assert.ok(xml.includes("</w:ftr>"), "should close w:ftr element");
-});
-
-test("serializeHeaderXml emits empty paragraph for opaque_block nodes", () => {
-  const header: HeaderDocument = {
-    variant: "default",
-    partPath: "/word/header1.xml",
-    relationshipId: "rId1",
-    blocks: [
-      { type: "opaque_block", fragmentId: "fragment:hdrftr-tbl", warningId: "warning:hdrftr-opaque-table" },
-    ],
-  };
-
-  const xml = serializeHeaderXml(header);
-  assert.ok(xml.includes("<w:p/>"), "opaque block should produce empty paragraph");
-});
-
-test("serializeHeaderXml uses empty paragraph stub when blocks array is empty", () => {
-  const header: HeaderDocument = {
-    variant: "default",
-    partPath: "/word/header1.xml",
-    relationshipId: "rId1",
-    blocks: [],
-  };
-
-  const xml = serializeHeaderXml(header);
-  // Empty blocks produces a minimal valid hdr with one paragraph stub
-  assert.ok(xml.includes("<w:p>"), "should emit at least one paragraph");
-});
-
-// ---- Tests: parse → serialize round-trip ----
-
-test("header parse-serialize roundtrip preserves paragraph count and text content", () => {
-  const parsed = parseHeaderXml(HEADER_XML);
-
-  const header: HeaderDocument = {
-    variant: "default",
-    partPath: "/word/header1.xml",
-    relationshipId: "rId1",
-    blocks: parsed.blocks,
-  };
-  const serialized = serializeHeaderXml(header);
-  const reparsed = parseHeaderXml(serialized);
-
-  assert.equal(reparsed.blocks.length, parsed.blocks.length, "block count should be stable");
-
-  const firstBlock = parsed.blocks[0];
-  const firstBlockReparsed = reparsed.blocks[0];
-  assert.equal(firstBlockReparsed?.type, firstBlock?.type);
-  if (
-    firstBlock?.type === "paragraph" &&
-    firstBlockReparsed?.type === "paragraph"
-  ) {
-    assert.equal(firstBlockReparsed.styleId, firstBlock.styleId);
-    assert.equal(firstBlockReparsed.children.length, firstBlock.children.length);
-    const firstChild = firstBlock.children[0];
-    const firstChildReparsed = firstBlockReparsed.children[0];
-    if (firstChild?.type === "text" && firstChildReparsed?.type === "text") {
-      assert.equal(firstChildReparsed.text, firstChild.text);
-    }
-  }
-});
-
-test("footer parse-serialize roundtrip preserves alignment", () => {
-  const parsed = parseFooterXml(FOOTER_XML);
-  const footer: FooterDocument = {
-    variant: "default",
-    partPath: "/word/footer1.xml",
-    relationshipId: "rId2",
-    blocks: parsed.blocks,
-  };
-  const serialized = serializeFooterXml(footer);
-  const reparsed = parseFooterXml(serialized);
-
-  const firstBlock = reparsed.blocks[0];
-  assert.equal(firstBlock?.type, "paragraph");
-  if (firstBlock?.type === "paragraph") {
-    assert.equal(firstBlock.alignment, "center");
-  }
-});
-
-test("first-page header roundtrip preserves variant structure", () => {
-  const parsed = parseHeaderXml(FIRST_PAGE_HEADER_XML);
-  const header: HeaderDocument = {
-    variant: "first",
-    partPath: "/word/header2.xml",
-    relationshipId: "rId3",
-    blocks: parsed.blocks,
-  };
-  const serialized = serializeHeaderXml(header);
-  const reparsed = parseHeaderXml(serialized);
-
-  assert.equal(reparsed.blocks.length, parsed.blocks.length);
-  const firstBlock = reparsed.blocks[0];
-  if (firstBlock?.type === "paragraph") {
-    const text = firstBlock.children[0];
-    if (text?.type === "text") {
-      assert.equal(text.text, "First Page");
-    }
-  }
-});
-
-test("header with footnote_ref inline node serializes and parses back", () => {
-  const header: HeaderDocument = {
-    variant: "default",
-    partPath: "/word/header1.xml",
-    relationshipId: "rId1",
-    blocks: [
-      {
-        type: "paragraph",
-        children: [
-          { type: "text", text: "See note " },
-          { type: "footnote_ref", noteId: "1", noteKind: "footnote" },
-        ],
-      },
-    ],
-  };
-
-  const serialized = serializeHeaderXml(header);
-  assert.ok(
-    serialized.includes("<w:footnoteReference"),
-    "should serialize footnote reference element",
-  );
-
-  const reparsed = parseHeaderXml(serialized);
-  const firstBlock = reparsed.blocks[0];
-  if (firstBlock?.type === "paragraph") {
-    const refNode = firstBlock.children.find((c) => c.type === "footnote_ref");
-    assert.ok(refNode, "should parse back footnote_ref node");
-    if (refNode?.type === "footnote_ref") {
-      assert.equal(refNode.noteId, "1");
-      assert.equal(refNode.noteKind, "footnote");
-    }
-  }
-});
-
-test("package-backed sessions import theme1.xml into subParts and preserve it on export", async () => {
-  const sourceBytes = createPackageWithThemePart();
-  const sourcePackage = readOpcPackage(sourceBytes);
-  const session = loadDocxEditorSession({
-    documentId: "theme-subpart",
-    sourceLabel: "theme-subpart.docx",
-    bytes: sourceBytes,
-    editorBuild: "test",
-  });
-
-  assert.equal(session.readOnly, false);
-
-  const snapshot = structuredClone(session.initialSnapshot) as PersistedEditorSnapshot;
-  const theme = snapshot.canonicalDocument.subParts?.theme;
-  assert.ok(theme, "expected theme metadata in canonical subParts");
-  assert.equal(theme?.name, "Office Theme");
-  assert.equal(theme?.colorScheme?.colors.accent1, "#4F81BD");
-  assert.equal(theme?.fontScheme?.majorFont, "Calibri");
-
-  const firstParagraph = (snapshot.canonicalDocument.content as {
-    children: Array<{ children: Array<{ text?: string }> }>;
-  }).children[0];
-  const firstText = firstParagraph?.children[0];
-  assert.ok(firstText);
-  firstText.text = `${firstText.text ?? ""} Updated`;
-
-  const result = await session.exportDocx(snapshot, {
-    fileName: "theme-subpart-export.docx",
-  });
-  const exportedPackage = readOpcPackage(result.bytes);
-
-  assert.equal(
-    text(exportedPackage.parts.get("/word/theme/theme1.xml")?.bytes),
-    text(sourcePackage.parts.get("/word/theme/theme1.xml")?.bytes),
-  );
-});
-
-const THEME_PART_CONTENT_TYPE =
-  "application/vnd.openxmlformats-officedocument.theme+xml";
-const THEME_RELATIONSHIP_TYPE =
-  "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme";
-
-function createPackageWithThemePart(): Uint8Array {
-  const documentXml = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<w:document xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
-  <w:body>
-    <w:p><w:r><w:t>Theme preservation fixture</w:t></w:r></w:p>
-    <w:sectPr/>
-  </w:body>
-</w:document>`;
-
-  return augmentBasePackage(documentXml, (basePackage) => {
-    const documentPart = basePackage.parts.get("/word/document.xml");
-    assert.ok(documentPart);
-
-    return {
-      manifest: {
-        ...basePackage.manifest,
-        contentTypes: {
-          defaults: {
-            ...basePackage.manifest.contentTypes.defaults,
-          },
-          overrides: {
-            ...basePackage.manifest.contentTypes.overrides,
-            "/word/theme/theme1.xml": THEME_PART_CONTENT_TYPE,
-          },
-        },
-        parts: [
-          ...basePackage.manifest.parts.map((part) =>
-            part.path === "/word/document.xml"
-              ? {
-                  ...part,
-                  relationships: [
-                    ...part.relationships,
-                    {
-                      id: "rIdTheme1",
-                      type: THEME_RELATIONSHIP_TYPE,
-                      target: "theme/theme1.xml",
-                      targetMode: "internal" as const,
-                    },
-                  ],
-                }
-              : part,
-          ),
-          {
-            path: "/word/theme/theme1.xml",
-            surfaceKind: "content",
-            contentType: THEME_PART_CONTENT_TYPE,
-            relationshipsPartPath: "/word/theme/_rels/theme1.xml.rels",
-            relationships: [],
-            compression: "deflate",
-            byteLength: toBytes(THEME_XML).byteLength,
-          },
-        ],
-      },
-      parts: new Map([
-        ...basePackage.parts.entries(),
-        [
-          "/word/document.xml",
-          {
-            ...documentPart,
-            relationships: [
-              ...documentPart.relationships,
-              {
-                id: "rIdTheme1",
-                type: THEME_RELATIONSHIP_TYPE,
-                target: "theme/theme1.xml",
-                targetMode: "internal" as const,
-              },
-            ],
-          },
-        ],
-        [
-          "/word/theme/theme1.xml",
-          {
-            path: "/word/theme/theme1.xml",
-            surfaceKind: "content",
-            contentType: THEME_PART_CONTENT_TYPE,
-            relationshipsPartPath: "/word/theme/_rels/theme1.xml.rels",
-            relationships: [],
-            compression: "deflate",
-            bytes: toBytes(THEME_XML),
-            crc32: 0,
-          },
-        ],
-      ]),
-      sourceByteLength: 0,
-    };
-  });
-}
-
-function augmentBasePackage(
-  documentXml: string,
-  transform: (basePackage: OpcPackage) => OpcPackage,
-): Uint8Array {
-  const baseBytes = writeDocxPackage({ documentXml });
-  return writeOpcPackage(transform(readOpcPackage(baseBytes)));
-}
-
-function toBytes(value: string): Uint8Array {
-  return new TextEncoder().encode(value);
-}
-
-function text(bytes: Uint8Array | undefined): string | undefined {
-  return bytes ? new TextDecoder().decode(bytes) : undefined;
-}