ooxml-core 1.8.4 → 1.9.0

package/dist/docx/embedded.cjs

@@ -62,8 +62,8 @@ function named(element, local, ns, lenient = true) {
 }
 var children = (parent, local, ns, lenient = true) => elements(parent).filter((element) => named(element, local, ns, lenient));
 var first = (parent, local, ns, lenient = true) => parent ? children(parent, local, ns, lenient)[0] : void 0;
-function attr(element, local, ns, prefix) {
-  return element?.getAttributeNS(ns, local) ?? element?.getAttribute(`${prefix}:${local}`) ?? void 0;
+function attr(element, local, ns, prefix2) {
+  return element?.getAttributeNS(ns, local) ?? element?.getAttribute(`${prefix2}:${local}`) ?? void 0;
 }
 var relAttr = (element, local) => attr(element, local, NS.r, "r");
 
@@ -344,24 +344,24 @@ var parseLigatures = (props) => {
 };
 function extensionPrefix(doc, ns, preferred) {
   const root = doc.documentElement;
-  let prefix = preferred;
-  for (let index = 1; root.lookupNamespaceURI(prefix) && root.lookupNamespaceURI(prefix) !== ns; index++)
-    prefix = `${preferred}${index}`;
-  root.setAttributeNS(XMLNS, `xmlns:${prefix}`, ns);
-  return prefix;
+  let prefix2 = preferred;
+  for (let index = 1; root.lookupNamespaceURI(prefix2) && root.lookupNamespaceURI(prefix2) !== ns; index++)
+    prefix2 = `${preferred}${index}`;
+  root.setAttributeNS(XMLNS, `xmlns:${prefix2}`, ns);
+  return prefix2;
 }
 function writeLigatures(doc, props, value) {
   for (const element2 of ligatureElements(props)) props.removeChild(element2);
   if (value === void 0) return;
-  const prefix = extensionPrefix(doc, WORD_2010_NS, "w14");
+  const prefix2 = extensionPrefix(doc, WORD_2010_NS, "w14");
   const mc = extensionPrefix(doc, MC, "mc");
   const ignored = new Set(
     (doc.documentElement.getAttributeNS(MC, "Ignorable") ?? "").split(/\s+/).filter(Boolean)
   );
-  ignored.add(prefix);
+  ignored.add(prefix2);
   doc.documentElement.setAttributeNS(MC, `${mc}:Ignorable`, [...ignored].join(" "));
-  const element = doc.createElementNS(WORD_2010_NS, `${prefix}:ligatures`);
-  element.setAttributeNS(WORD_2010_NS, `${prefix}:val`, value);
+  const element = doc.createElementNS(WORD_2010_NS, `${prefix2}:ligatures`);
+  element.setAttributeNS(WORD_2010_NS, `${prefix2}:val`, value);
   props.appendChild(element);
 }
 
@@ -1304,7 +1304,7 @@ async function applyCoreProperties(zip, next, prior) {
   const root = doc.documentElement;
   for (const field of PROPERTY_FIELDS) {
     if ((next?.[field] ?? "") === (prior?.[field] ?? "")) continue;
-    const [prefix, ns] = PREFIX[field];
+    const [prefix2, ns] = PREFIX[field];
     let element = child(root, field);
     const value = next?.[field] ?? "";
     if (!value) {
@@ -1312,7 +1312,7 @@ async function applyCoreProperties(zip, next, prior) {
       continue;
     }
     if (!element) {
-      element = doc.createElementNS(ns, `${prefix}:${field}`);
+      element = doc.createElementNS(ns, `${prefix2}:${field}`);
       root.appendChild(element);
     }
     element.textContent = value;
@@ -2212,6 +2212,36 @@ function writeTable(doc, table, node, base, writeParagraph, replaceSlots2) {
   return node;
 }
 
+// docx/write-footnote-columns.ts
+var W15 = "http://schemas.microsoft.com/office/word/2012/wordml";
+var XMLNS2 = "http://www.w3.org/2000/xmlns/";
+var MC2 = "http://schemas.openxmlformats.org/markup-compatibility/2006";
+function prefix(doc, preferred, namespace) {
+  let name = preferred;
+  for (let suffix = 1; doc.documentElement.lookupNamespaceURI(name) && doc.documentElement.lookupNamespaceURI(name) !== namespace; suffix++)
+    name = preferred + suffix;
+  doc.documentElement.setAttributeNS(XMLNS2, "xmlns:" + name, namespace);
+  return name;
+}
+function writeFootnoteColumns(doc, section, value) {
+  if (value !== void 0 && (!Number.isInteger(value) || value < 0 || value > 2147483647))
+    throw new Error("Footnote column count must be an integer from 0 to 2147483647.");
+  const old = elements(section).filter(
+    (element2) => element2.namespaceURI === W15 && element2.localName === "footnoteColumns"
+  );
+  for (const element2 of old) section.removeChild(element2);
+  if (value === void 0) return;
+  const w15 = prefix(doc, "w15", W15), mc = prefix(doc, "mc", MC2);
+  const ignored = new Set(
+    (doc.documentElement.getAttributeNS(MC2, "Ignorable") ?? "").split(/\s+/).filter(Boolean)
+  );
+  ignored.add(w15);
+  doc.documentElement.setAttributeNS(MC2, mc + ":Ignorable", [...ignored].join(" "));
+  const element = doc.createElementNS(W15, w15 + ":footnoteColumns");
+  element.setAttributeNS(WORD_NS, "w:val", String(value));
+  section.appendChild(element);
+}
+
 // docx/page-borders.ts
 var SIDES3 = ["top", "left", "bottom", "right"];
 var ATTRIBUTES = ["offsetFrom", "display", "zOrder"];
@@ -2355,6 +2385,7 @@ var WRITABLE = /* @__PURE__ */ new Set([
   "footerDistanceTwips",
   "gutterTwips",
   "columns",
+  "footnoteColumns",
   "titlePage",
   "verticalAlign",
   "pageNumbering",
@@ -2418,6 +2449,8 @@ var AFTER_TITLEPG = [
 var AFTER_PGBORDERS = ["lnNumType", ...AFTER_LNNUM];
 var AFTER_TYPE = ["pgSz", ...AFTER_PGSZ];
 function writeSectionProperties(doc, sectPr, section, base) {
+  if (section.footnoteColumns !== base?.footnoteColumns)
+    writeFootnoteColumns(doc, sectPr, section.footnoteColumns);
   if (section.type === "nextPage")
     for (const type of children2(sectPr, "type")) sectPr.removeChild(type);
   else setW5(child2(doc, sectPr, "type", AFTER_TYPE), "val", section.type);
@@ -4391,7 +4424,7 @@ function readBuiltInChartStyle(root) {
   for (const content of children(root, "AlternateContent", NS.mc)) {
     for (const choice of children(content, "Choice", NS.mc)) {
       const requires = choice.getAttribute("Requires")?.trim().split(/\s+/);
-      if (!requires?.length || !requires.every((prefix) => choice.lookupNamespaceURI(prefix) === C14))
+      if (!requires?.length || !requires.every((prefix2) => choice.lookupNamespaceURI(prefix2) === C14))
         continue;
       const modern = first(choice, "style", C14)?.getAttribute("val");
       if (modern && /^\d+$/.test(modern) && Number(modern) >= 101 && Number(modern) <= 148)
@@ -4553,12 +4586,12 @@ var CHART_ROOT_BINDINGS = /* @__PURE__ */ new Map([
 var DECLARATION = / xmlns:([A-Za-z_][\w.-]*)="([^"]*)"/g;
 function stripDeclarations(xml, bindings) {
   const conflicting = /* @__PURE__ */ new Set();
-  for (const [, prefix, uri] of xml.matchAll(DECLARATION))
-    if (prefix !== void 0 && bindings.has(prefix) && bindings.get(prefix) !== uri)
-      conflicting.add(prefix);
+  for (const [, prefix2, uri] of xml.matchAll(DECLARATION))
+    if (prefix2 !== void 0 && bindings.has(prefix2) && bindings.get(prefix2) !== uri)
+      conflicting.add(prefix2);
   return xml.replace(
     DECLARATION,
-    (match, prefix, uri) => bindings.get(prefix) === uri && !conflicting.has(prefix) ? "" : match
+    (match, prefix2, uri) => bindings.get(prefix2) === uri && !conflicting.has(prefix2) ? "" : match
   );
 }
 var innerXml = (element) => stripDeclarations(elements(element).map(buildXml).join(""), CHART_ROOT_BINDINGS);
@@ -6133,6 +6166,10 @@ function createRun(doc, run, base, old, allocator) {
     node.appendChild(code);
     return node;
   }
+  if (run.noteSeparator) {
+    node.appendChild(makeW(doc, run.noteSeparator));
+    return node;
+  }
   if (run.noteMark) {
     node.appendChild(makeW(doc, run.noteMark === "footnote" ? "footnoteRef" : "endnoteRef"));
     return node;
@@ -8027,7 +8064,12 @@ async function applyNoteEdits(zip, model, base, pendingMedia, docPrIds) {
       const original = baseNotes.get(note.id);
       return !original || JSON.stringify(original.blocks) !== JSON.stringify(note.blocks);
     });
-    if (!edited.length && !removed.length) continue;
+    const separators = kind === "footnote" ? model.footnoteSeparators : void 0;
+    const baseSeparators = kind === "footnote" ? base.footnoteSeparators : void 0;
+    const editedSeparators = ["separator", "continuationSeparator"].filter(
+      (type) => separators?.[type] && JSON.stringify(separators[type].blocks) !== JSON.stringify(baseSeparators?.[type]?.blocks)
+    );
+    if (!edited.length && !removed.length && !editedSeparators.length) continue;
     const file = zip.file(part);
     const doc = parseXml2(file ? await file.async("string") : await createNotesPart(zip, kind));
     const elements2 = new Map(
@@ -8039,6 +8081,24 @@ async function applyNoteEdits(zip, model, base, pendingMedia, docPrIds) {
         doc.documentElement.removeChild(element);
     }
     const allocator = await allocatorForPart(zip, part, doc, docPrIds);
+    for (const type of editedSeparators) {
+      const separator = separators[type];
+      let element = children2(doc.documentElement, kind).find((node) => getW(node, "type") === type);
+      if (!element) {
+        element = doc.createElementNS(WORD_NS3, `w:${kind}`);
+        element.setAttributeNS(WORD_NS3, "w:id", separator.id);
+        element.setAttributeNS(WORD_NS3, "w:type", type);
+        doc.documentElement.appendChild(element);
+      }
+      applyBlocks(
+        doc,
+        element,
+        separator.blocks,
+        baseSeparators?.[type]?.blocks ?? [],
+        allocator,
+        contentWidthTwips
+      );
+    }
     for (const note of edited) {
       let element = elements2.get(note.id);
       const original = baseNotes.get(note.id);
@@ -8206,6 +8266,43 @@ async function applyTrackChangesSetting(zip, enabled2) {
   }
   await applySettingsFlag(zip, "trackRevisions", enabled2);
 }
+async function applyCompatibilityMode(zip, mode) {
+  if (mode !== void 0 && (!Number.isInteger(mode) || mode <= 0 || mode > 2147483647))
+    throw new RangeError("Compatibility mode must be a positive integer.");
+  const file = zip.file(SETTINGS_PATH);
+  if (!file && mode === void 0) return;
+  const doc = parseXml2(
+    await file?.async("string") ?? `<?xml version="1.0" encoding="UTF-8" standalone="yes"?><w:settings xmlns:w="${WORD_NS}"/>`
+  );
+  const root = doc.documentElement;
+  let compat = children2(root, "compat")[0];
+  if (!compat && mode !== void 0) {
+    compat = makeW(doc, "compat");
+    const rank = SETTINGS_ORDER.indexOf("compat");
+    const after = Array.from(root.childNodes).find(
+      (node) => node.nodeType === 1 && SETTINGS_ORDER.indexOf(node.localName ?? "") > rank
+    );
+    root.insertBefore(compat, after ?? null);
+  }
+  const uri = "http://schemas.microsoft.com/office/word";
+  if (compat) {
+    for (const setting of children2(compat, "compatSetting"))
+      if (setting.getAttributeNS(WORD_NS, "name") === "compatibilityMode" && setting.getAttributeNS(WORD_NS, "uri") === uri)
+        compat.removeChild(setting);
+    if (mode !== void 0) {
+      const setting = makeW(doc, "compatSetting");
+      setting.setAttributeNS(WORD_NS, "w:name", "compatibilityMode");
+      setting.setAttributeNS(WORD_NS, "w:uri", uri);
+      setting.setAttributeNS(WORD_NS, "w:val", String(mode));
+      compat.appendChild(setting);
+    }
+  }
+  zip.file(SETTINGS_PATH, buildXml(doc));
+  if (!file) {
+    await ensureContentTypeOverride(zip, SETTINGS_PATH, SETTINGS_CONTENT_TYPE);
+    await ensureDocumentRelationship(zip, SETTINGS_RELATIONSHIP_TYPE, "settings.xml");
+  }
+}
 
 // docx/page-background.ts
 var HEX = /^[0-9a-fA-F]{6}$/;
@@ -8237,6 +8334,7 @@ function documentBlockLists(model) {
         (slots) => Object.values(slots ?? {}).flatMap((content) => content ? [content.blocks] : [])
       )
     ),
+    ...Object.values(model.footnoteSeparators ?? {}).map((note) => note.blocks),
     ...[...model.footnotes ?? [], ...model.endnotes ?? []].map((note) => note.blocks)
   ];
 }
@@ -8269,6 +8367,14 @@ function mapDocumentParagraphs(model, map) {
         ...section.footers ? { footers: slots(section.footers) } : {}
       }))
     } : {},
+    ...model.footnoteSeparators ? {
+      footnoteSeparators: Object.fromEntries(
+        Object.entries(model.footnoteSeparators).map(([kind, note]) => [
+          kind,
+          { ...note, blocks: mapBlockParagraphs(note.blocks, map) }
+        ])
+      )
+    } : {},
     ...model.footnotes ? {
       footnotes: model.footnotes.map((note) => ({
         ...note,
@@ -8449,6 +8555,8 @@ async function saveDocx(model, pendingMedia) {
   await applyNumberingCatalog(zip, model, binding);
   await applyCoreProperties(zip, model.properties, binding?.base.properties);
   if (binding) await applyStyleNumbering(zip, model, binding.base);
+  if (model.compatibilityMode !== binding?.base.compatibilityMode)
+    await applyCompatibilityMode(zip, model.compatibilityMode);
   if (Boolean(model.evenAndOddHeaders) !== Boolean(binding?.base.evenAndOddHeaders))
     await applySettingsFlag(zip, "evenAndOddHeaders", Boolean(model.evenAndOddHeaders));
   if (model.pageColor !== binding?.base.pageColor)
@@ -8519,6 +8627,20 @@ function parseCell(cell, parseParagraph3, id) {
   if (margins) result.margins = margins;
   const nested = children2(cell, "tbl").map(nestedPreview);
   if (nested.length) result.nestedTables = nested;
+  if (nested.length) {
+    let paragraphIndex = 0, tableIndex = 0;
+    result.sourceBlocks = Array.from(cell.childNodes).flatMap(
+      (child3) => {
+        if (child3.nodeType !== 1) return [];
+        const element = child3;
+        if (element.namespaceURI !== WORD_NS) return [];
+        if (element.localName === "p") return [result.paragraphs[paragraphIndex++]];
+        if (element.localName === "tbl")
+          return [parseTable(element, `${id}-nested${tableIndex++}`, parseParagraph3)];
+        return [];
+      }
+    );
+  }
   return result;
 }
 function parseLook(element) {
@@ -8733,6 +8855,7 @@ function parseRun2(node, revision) {
   let breakKind;
   let noteReference;
   let noteMark;
+  let noteSeparator;
   let fieldChar;
   const fieldCode = content.length > 0 && content.every((child3) => named2(child3, "instrText")) ? content.map((child3) => textContent(child3)).join("") : void 0;
   const only = content.length === 1 ? content[0] : void 0;
@@ -8748,6 +8871,8 @@ function parseRun2(node, revision) {
       if (id) noteReference = { kind: "endnote", id };
     } else if (named2(only, "footnoteRef")) noteMark = "footnote";
     else if (named2(only, "endnoteRef")) noteMark = "endnote";
+    else if (named2(only, "separator")) noteSeparator = "separator";
+    else if (named2(only, "continuationSeparator")) noteSeparator = "continuationSeparator";
     else if (named2(only, "fldChar")) {
       const type = getW(only, "fldCharType");
       if (type === "begin" || type === "separate" || type === "end") fieldChar = type;
@@ -8765,6 +8890,7 @@ function parseRun2(node, revision) {
   if (breakKind) run.break = breakKind;
   if (noteReference) run.noteReference = noteReference;
   if (noteMark) run.noteMark = noteMark;
+  if (noteSeparator) run.noteSeparator = noteSeparator;
   if (fieldChar) {
     run.fieldChar = fieldChar;
     const flags = parseFieldFlags(only);
@@ -8941,6 +9067,14 @@ function pageBordersOf(element) {
   return borders ? { pageBorders: borders } : {};
 }
 function parseOneSection(section, endsAtBlockId) {
+  const footnoteColumns = parseUnsignedInteger(
+    getW(
+      elements(section).find(
+        (element) => element.localName === "footnoteColumns" && element.namespaceURI === "http://schemas.microsoft.com/office/word/2012/wordml"
+      ),
+      "val"
+    )
+  );
   const size = first2(section, "pgSz");
   const margins = first2(section, "pgMar");
   const typeValue = enumValue(isStSectionMark, getW(first2(section, "type"), "val"), "w:type");
@@ -8965,6 +9099,7 @@ function parseOneSection(section, endsAtBlockId) {
     ...footerDistance !== void 0 ? { footerDistanceTwips: footerDistance } : {},
     ...gutter !== void 0 ? { gutterTwips: gutter } : {},
     columns: parseColumns(section),
+    ...footnoteColumns !== void 0 ? { footnoteColumns } : {},
     ...onOffElement(first2(section, "titlePg")) === true ? { titlePage: true } : {},
     ...vAlignValue ? { verticalAlign: vAlignValue } : {},
     ...pgNum ? {
@@ -9018,6 +9153,29 @@ function parseNotesPart(xml, kind, parseBlocks) {
   }
   return notes;
 }
+function parseFootnoteSeparators(xml, parseBlocks) {
+  const root = parseXml2(xml).documentElement;
+  const result = {};
+  for (const element of children2(root, "footnote")) {
+    const type = getW(element, "type");
+    if (type !== "separator" && type !== "continuationSeparator") continue;
+    for (const run of Array.from(element.getElementsByTagNameNS(root.namespaceURI, "r"))) {
+      const content = Array.from(run.childNodes).filter((child3) => child3.nodeType === 1).filter((child3) => child3.localName !== "rPr");
+      if (content.length < 2 || !content.some((child3) => skippedTypes.has(child3.localName)))
+        continue;
+      const props = children2(run, "rPr")[0];
+      for (const child3 of content) {
+        const split = run.cloneNode(false);
+        if (props) split.appendChild(props.cloneNode(true));
+        split.appendChild(child3.cloneNode(true));
+        run.parentNode.insertBefore(split, run);
+      }
+      run.parentNode.removeChild(run);
+    }
+    result[type] = { id: getW(element, "id") ?? type, blocks: parseBlocks(element, `fn-${type}-`) };
+  }
+  return result;
+}
 
 // docx/document-parts.ts
 async function partContext(zip, path2, base) {
@@ -9033,6 +9191,10 @@ async function readPart(zip, path2) {
 function parseSettings(xml) {
   if (!xml) return { evenAndOddHeaders: false, autoHyphenation: false };
   const root = parseXml2(xml).documentElement;
+  const compatibility = (first2(root, "compat") ? children2(first2(root, "compat"), "compatSetting") : []).find(
+    (setting) => getW(setting, "name") === "compatibilityMode" && getW(setting, "uri") === "http://schemas.microsoft.com/office/word"
+  );
+  const compatibilityMode = compatibility ? Number(getW(compatibility, "val")) : void 0;
   const footnoteNumFmt = enumValue(
     isStNumberFormat,
     getW(first2(first2(root, "footnotePr"), "numFmt"), "val"),
@@ -9044,6 +9206,7 @@ function parseSettings(xml) {
     "w:endnotePr/w:numFmt"
   );
   return {
+    ...compatibilityMode !== void 0 && Number.isInteger(compatibilityMode) && compatibilityMode > 0 ? { compatibilityMode } : {},
     evenAndOddHeaders: onOffElement(first2(root, "evenAndOddHeaders")) === true,
     autoHyphenation: onOffElement(first2(root, "autoHyphenation")) === true,
     ...footnoteNumFmt ? { footnoteNumFmt } : {},
@@ -9108,9 +9271,10 @@ async function parseDocumentParts(zip, body, blocks, drawings) {
   const endnotesXml = await readPart(zip, "word/endnotes.xml");
   const notesParser = async (path2) => {
     const context = await partContext(zip, path2, drawings);
-    return (container, prefix) => withParseWarnings(warnings, () => parseBlocksFromContainer(container, prefix, context));
+    return (container, prefix2) => withParseWarnings(warnings, () => parseBlocksFromContainer(container, prefix2, context));
   };
   const footnotes = footnotesXml ? parseNotesPart(footnotesXml, "footnote", await notesParser("word/footnotes.xml")) : void 0;
+  const footnoteSeparators = footnotesXml ? parseFootnoteSeparators(footnotesXml, await notesParser("word/footnotes.xml")) : void 0;
   const endnotes = endnotesXml ? parseNotesPart(endnotesXml, "endnote", await notesParser("word/endnotes.xml")) : void 0;
   if (sections.some((section) => section.columns.count > 1))
     warnings.push(
@@ -9122,7 +9286,9 @@ async function parseDocumentParts(zip, body, blocks, drawings) {
     );
   return {
     sections,
+    ...settings.compatibilityMode !== void 0 ? { compatibilityMode: settings.compatibilityMode } : {},
     ...footnotes ? { footnotes } : {},
+    ...footnoteSeparators ? { footnoteSeparators } : {},
     ...endnotes ? { endnotes } : {},
     ...settings.footnoteNumFmt ? { footnoteNumFmt: settings.footnoteNumFmt } : {},
     ...settings.endnoteNumFmt ? { endnoteNumFmt: settings.endnoteNumFmt } : {},
@@ -9310,7 +9476,9 @@ async function readPackage(input) {
     );
   const parts = await parseDocumentParts(zip, body, blocks, drawings);
   model.sections = parts.sections;
+  if (parts.compatibilityMode !== void 0) model.compatibilityMode = parts.compatibilityMode;
   if (parts.footnotes) model.footnotes = parts.footnotes;
+  if (parts.footnoteSeparators) model.footnoteSeparators = parts.footnoteSeparators;
   if (parts.endnotes) model.endnotes = parts.endnotes;
   if (parts.footnoteNumFmt) model.footnoteNumFmt = parts.footnoteNumFmt;
   if (parts.endnoteNumFmt) model.endnoteNumFmt = parts.endnoteNumFmt;
@@ -9357,6 +9525,7 @@ async function readPackage(input) {
         (slots) => Object.values(slots ?? {}).flatMap((content) => content?.blocks ?? [])
       )
     ),
+    ...Object.values(model.footnoteSeparators ?? {}).flatMap((note) => note.blocks),
     ...[...model.footnotes ?? [], ...model.endnotes ?? []].flatMap((note) => note.blocks)
   ];
   await resolveDocumentDiagrams(