ooxml-core 0.4.0 → 0.6.0

package/dist/docx/embedded.mjs

@@ -1653,6 +1653,46 @@ function orderSectionProperties(sectPr) {
   orderChildren(sectPr, SECTPR_ORDER);
 }
 
+// src/docx/write-table-margins.ts
+var SIDES2 = ["top", "left", "bottom", "right"];
+var ORDER = ["top", "start", "left", "bottom", "end", "right"];
+function patchMarginProperties(doc, host, propertiesTag, marginTag, propertiesOrder, next, base) {
+  const changed = SIDES2.filter((side) => next?.[side] !== base?.[side]);
+  if (!changed.length) return;
+  for (const side of changed) {
+    const value = next?.[side];
+    if (value !== void 0 && (!Number.isSafeInteger(value) || value < 0))
+      throw new Error("Table cell margins must be nonnegative whole twips.");
+  }
+  let properties = first2(host, propertiesTag);
+  if (!properties) {
+    properties = makeW(doc, propertiesTag);
+    host.insertBefore(properties, host.firstChild);
+  }
+  let margins = first2(properties, marginTag);
+  if (!margins) {
+    margins = makeW(doc, marginTag);
+    properties.appendChild(margins);
+  }
+  for (const side of changed) {
+    const logical = side === "left" ? "start" : side === "right" ? "end" : side;
+    const edge = first2(margins, logical) ?? first2(margins, side) ?? makeW(doc, side);
+    for (const alias of /* @__PURE__ */ new Set([side, logical]))
+      for (const old of children2(margins, alias)) margins.removeChild(old);
+    const value = next?.[side];
+    if (value === void 0) continue;
+    edge.setAttributeNS(WORD_NS, "w:w", String(value));
+    edge.setAttributeNS(WORD_NS, "w:type", "dxa");
+    margins.appendChild(edge);
+  }
+  if (!Array.from(margins.childNodes).some((node) => node.nodeType === 1) && !margins.attributes.length)
+    properties.removeChild(margins);
+  else orderChildren(margins, ORDER);
+  orderChildren(properties, propertiesOrder);
+  if (!Array.from(properties.childNodes).some((node) => node.nodeType === 1) && !properties.attributes.length)
+    host.removeChild(properties);
+}
+
 // src/docx/write-table-properties.ts
 var ROW_ORDER = [
   "cnfStyle",
@@ -1712,26 +1752,15 @@ function patchRowProperties(doc, tr, next, base) {
   orderChildren(props, ROW_ORDER);
 }
 function patchTableMargins(doc, table, node, base) {
-  if (JSON.stringify(table.cellMargins ?? {}) === JSON.stringify(base?.cellMargins ?? {})) return;
-  let props = first2(node, "tblPr");
-  if (!props) {
-    props = makeW(doc, "tblPr");
-    node.insertBefore(props, node.firstChild);
-  }
-  let margins = first2(props, "tblCellMar");
-  if (!margins) {
-    margins = makeW(doc, "tblCellMar");
-    props.appendChild(margins);
-  }
-  const built = buildMargins(doc, table.cellMargins ?? {}, "tblCellMar");
-  for (const side of ["top", "left", "bottom", "right"]) {
-    if (table.cellMargins?.[side] === base?.cellMargins?.[side]) continue;
-    for (const old of children2(margins, side)) margins.removeChild(old);
-    const replacement = first2(built, side);
-    if (replacement) margins.appendChild(replacement);
-  }
-  orderChildren(margins, ["top", "left", "start", "bottom", "right", "end"]);
-  orderChildren(props, TABLE_ORDER);
+  patchMarginProperties(
+    doc,
+    node,
+    "tblPr",
+    "tblCellMar",
+    TABLE_ORDER,
+    table.cellMargins,
+    base?.cellMargins
+  );
 }
 var CELL_ORDER = [
   "cnfStyle",
@@ -1755,6 +1784,9 @@ var CELL_ORDER = [
 ];
 var CELL_BORDER_ORDER = ["top", "start", "left", "bottom", "end", "right", "insideH", "insideV"];
 var CELL_SIDES = ["top", "left", "bottom", "right"];
+function patchCellMargins(doc, tc, next, base) {
+  patchMarginProperties(doc, tc, "tcPr", "tcMar", CELL_ORDER, next, base);
+}
 function patchCellBorders(doc, tc, next, base) {
   const changed = CELL_SIDES.filter(
     (side) => JSON.stringify(next?.[side]) !== JSON.stringify(base?.[side])
@@ -1782,6 +1814,23 @@ function patchCellBorders(doc, tc, next, base) {
   orderChildren(props, CELL_ORDER);
   if (!Array.from(props.childNodes).some((node) => node.nodeType === 1)) tc.removeChild(props);
 }
+function patchCellShading(doc, tc, next, base) {
+  if (next.shadingFill === base?.shadingFill && JSON.stringify(next.shadingThemeFill) === JSON.stringify(base?.shadingThemeFill))
+    return;
+  if (next.shadingFill && next.shadingFill !== "auto" && !/^#?[0-9a-f]{6}$/i.test(next.shadingFill))
+    throw new Error("Cell shading must be a six-digit RGB color or auto.");
+  let props = first2(tc, "tcPr");
+  if (!props) {
+    props = makeW(doc, "tcPr");
+    tc.insertBefore(props, tc.firstChild);
+  }
+  for (const old of children2(props, "shd")) props.removeChild(old);
+  const built = buildCellProperties(doc, next);
+  const replacement = built && first2(built, "shd");
+  if (replacement) props.appendChild(replacement);
+  orderChildren(props, CELL_ORDER);
+  if (!Array.from(props.childNodes).some((node) => node.nodeType === 1)) tc.removeChild(props);
+}
 
 // src/docx/write-table.ts
 function canEditTableStructure(table) {
@@ -1825,15 +1874,7 @@ var TABLE_DESCRIPTOR_KEYS = [
   "style",
   "look"
 ];
-var CELL_DESCRIPTOR_KEYS = [
-  "gridSpan",
-  "verticalMerge",
-  "widthTwips",
-  "verticalAlign",
-  "shadingFill",
-  "shadingThemeFill",
-  "margins"
-];
+var CELL_DESCRIPTOR_KEYS = ["gridSpan", "verticalMerge", "widthTwips", "verticalAlign"];
 function pick(source, keys) {
   const record = source;
   const result = {};
@@ -1859,7 +1900,7 @@ function assertNoDescriptorEdits(table, base) {
       if (!source) continue;
       if (JSON.stringify(pick(cell, CELL_DESCRIPTOR_KEYS)) !== JSON.stringify(pick(source, CELL_DESCRIPTOR_KEYS)))
         throw new Error(
-          "Cannot edit table cell width, merge, vertical alignment, shading, or margins on an existing cell; only cell text and borders are supported. The original DOCX package remains unchanged."
+          "Cannot edit table cell width, merge or vertical alignment on an existing cell; only cell text, borders, shading and margins are supported. The original DOCX package remains unchanged."
         );
     }
 }
@@ -1928,6 +1969,8 @@ function writeTable(doc, table, node, base, writeParagraph, replaceSlots2) {
         throw new Error("Moving paragraphs between table cells is not supported.");
       const tc = source?.cell ?? makeW(doc, "tc");
       patchCellBorders(doc, tc, cell.borders, source?.model.borders);
+      patchCellShading(doc, tc, cell, source?.model);
+      patchCellMargins(doc, tc, cell.margins, source?.model.margins);
       const oldParagraphs = children2(tc, "p");
       const nextParagraphs = cell.paragraphs.map((paragraph) => {
         const index = source?.paragraphs.findIndex((p) => p.id === paragraph.id) ?? -1;
@@ -1958,13 +2001,13 @@ function writeTable(doc, table, node, base, writeParagraph, replaceSlots2) {
 }
 
 // src/docx/page-borders.ts
-var SIDES2 = ["top", "left", "bottom", "right"];
+var SIDES3 = ["top", "left", "bottom", "right"];
 var ATTRIBUTES = ["offsetFrom", "display", "zOrder"];
 var setW4 = (element, name, value) => element.setAttributeNS(WORD_NS, `w:${name}`, value);
 function parsePageBorders(element) {
   if (!element) return void 0;
   const result = {};
-  for (const side of SIDES2) {
+  for (const side of SIDES3) {
     const source = first2(element, side);
     const value = borderSide(source);
     const art = getW(source, "art");
@@ -2002,7 +2045,7 @@ function patchPageBorders(doc, sectPr, next, base, create) {
     return;
   }
   const element = create(doc, sectPr, "pgBorders");
-  for (const side of SIDES2) {
+  for (const side of SIDES3) {
     if (JSON.stringify(next[side]) === JSON.stringify(base?.[side])) continue;
     for (const old of children2(element, side)) element.removeChild(old);
     const value = next[side];
@@ -2327,7 +2370,7 @@ function applySectionEdits(doc, body, blocks, sections, base, references = /* @_
 }
 
 // src/docx/write-paragraph-decoration.ts
-var SIDES3 = ["top", "left", "bottom", "right", "between"];
+var SIDES4 = ["top", "left", "bottom", "right", "between"];
 function wordColor(color) {
   const hex = /^#?([0-9a-f]{6})$/i.exec(color ?? "")?.[1];
   return hex ? hex.toUpperCase() : "auto";
@@ -2361,7 +2404,7 @@ function updateBorders(doc, props, paragraph, base) {
   const borders = paragraph.borders;
   if (!borders) return;
   const pBdr = makeW(doc, "pBdr");
-  for (const side of SIDES3) {
+  for (const side of SIDES4) {
     const value = borders[side];
     if (value) pBdr.appendChild(borderElement(doc, side, value));
   }
@@ -4648,6 +4691,30 @@ function createRun(doc, run, base, old, allocator) {
   if (!run.text) node.appendChild(makeW(doc, "t"));
   return node;
 }
+var MATH_NAMESPACES = /* @__PURE__ */ new Set([
+  "http://schemas.openxmlformats.org/officeDocument/2006/math",
+  "http://purl.oclc.org/ooxml/officeDocument/math"
+]);
+function isEquationElement(element) {
+  return MATH_NAMESPACES.has(element.namespaceURI ?? "") && (element.localName === "oMath" || element.localName === "oMathPara");
+}
+function parseEquation(element) {
+  if (!isEquationElement(element)) return void 0;
+  return {
+    text: "",
+    equation: {
+      omml: new XMLSerializer().serializeToString(element),
+      display: element.localName === "oMathPara"
+    }
+  };
+}
+function preserveEquation(run, base, old) {
+  if (!old || !isEquationElement(old) || !base?.equation || run.text !== "" || run.equation?.omml !== base.equation.omml || run.equation?.display !== base.equation.display)
+    throw new Error(
+      "Equation editing or insertion is unsupported; imported OMML must remain unchanged."
+    );
+  return old.cloneNode(true);
+}
 
 // src/docx/breaks.ts
 function hasSpecialBreak(element) {
@@ -4746,10 +4813,11 @@ function collectParagraphRuns(node, parseRun3, parseOther, resolveLink, active =
       if (!isCommentReferenceRun(item)) push(parseRun3(item));
     } else if (named2(item, "hyperlink")) {
       const link = resolveLink?.(item);
-      for (const run of children2(item, "r")) {
-        const parsed = parseRun3(run);
-        if (link) parsed.link = link;
-        push(parsed);
+      for (const child3 of Array.from(item.childNodes).filter(isElement)) {
+        for (const parsed of named2(child3, "r") ? [parseRun3(child3)] : parseOther?.(child3) ?? []) {
+          if (link) parsed.link = link;
+          push(parsed);
+        }
       }
     } else if ((!item.namespaceURI || item.namespaceURI === WORD_NS) && Object.hasOwn(REVISION_WRAPPERS, item.localName)) {
       const kind = expectDefined(
@@ -4760,7 +4828,12 @@ function collectParagraphRuns(node, parseRun3, parseOther, resolveLink, active =
       const revision = revisionFrom(item, kind);
       const range = kind === "moveFrom" || kind === "moveTo" ? moves[kind].at(-1) : void 0;
       if (range) revision.move = { name: range.name, rangeId: range.id };
-      for (const run of children2(item, "r")) push(parseRun3(run, revision));
+      for (const child3 of Array.from(item.childNodes).filter(isElement)) {
+        for (const parsed of named2(child3, "r") ? [parseRun3(child3, revision)] : parseOther?.(child3) ?? []) {
+          parsed.revision = revision;
+          push(parsed);
+        }
+      }
     } else if (trackMoveRange(item, moves)) {
       continue;
     } else if (named2(item, "commentRangeStart")) {
@@ -4807,7 +4880,9 @@ function runsOf(parent, container, slots) {
       if (child3.nodeType === 3 && child3.textContent?.trim()) return false;
       continue;
     }
-    if (named2(child3, "r")) {
+    if (isEquationElement(child3)) {
+      slots.push({ element: child3, ...container && { container } });
+    } else if (named2(child3, "r")) {
       if (isCommentReferenceRun(child3)) continue;
       if (!runIsSafe(child3)) return false;
       slots.push({ element: child3, ...container && { container } });
@@ -4831,7 +4906,9 @@ function collectInlineSlots(paragraph) {
       if (child3.nodeType === 3 && child3.textContent?.trim()) return void 0;
       continue;
     }
-    if (named2(child3, "r")) {
+    if (isEquationElement(child3)) {
+      slots.push({ element: child3 });
+    } else if (named2(child3, "r")) {
       if (isCommentReferenceRun(child3)) continue;
       if (!runIsSafe(child3)) return void 0;
       slots.push({ element: child3 });
@@ -4847,7 +4924,7 @@ function collectInlineSlots(paragraph) {
 }
 function replaceableInlineChildren(paragraph) {
   return Array.from(paragraph.childNodes).filter(
-    (child3) => isElement(child3) && (named2(child3, "r") || named2(child3, "hyperlink") || named2(child3, "fldSimple") || isRevisionWrapperElement(child3) || isCommentAnchorElement(child3))
+    (child3) => isElement(child3) && (isEquationElement(child3) || named2(child3, "r") || named2(child3, "hyperlink") || named2(child3, "fldSimple") || isRevisionWrapperElement(child3) || isCommentAnchorElement(child3))
   );
 }
 function sameLink(a, b) {
@@ -4872,7 +4949,7 @@ function newHyperlink(doc, link, allocator) {
 }
 function runNodes(doc, run, base, old, opens, closes, allocator) {
   const nodes = opens.flatMap((edge) => rangeStartNodes(doc, edge));
-  const node = createRun(doc, run, base, old, allocator);
+  const node = run.equation ? preserveEquation(run, base, old) : createRun(doc, run, base, old, allocator);
   const revision = run.revision;
   if (revision && ["insert", "delete", "moveFrom", "moveTo"].includes(revision.kind)) {
     if (revision.kind === "delete" || revision.kind === "moveFrom") convertToDeleteText(doc, node);
@@ -4884,15 +4961,23 @@ function runNodes(doc, run, base, old, opens, closes, allocator) {
 function buildInlineContent(doc, runs, base, slots, allocator, ranges) {
   const { opens, closes } = rangeEdges(runs, ranges);
   const runAt = (at) => expectDefined(runs[at], `run ${at}`);
-  const nodesFor = (index2) => runNodes(
-    doc,
-    runAt(index2),
-    base?.[index2],
-    slots[index2]?.element,
-    opens.get(index2) ?? [],
-    closes.get(index2) ?? [],
-    allocator
-  );
+  const nodesFor = (index2) => {
+    const run = runAt(index2);
+    const sourceIndex = run.equation ? base?.findIndex(
+      (source2) => source2.equation?.omml === run.equation?.omml && source2.equation?.display === run.equation?.display
+    ) : index2;
+    const source = sourceIndex === void 0 ? void 0 : base?.[sourceIndex];
+    const old = sourceIndex === void 0 ? void 0 : slots[sourceIndex]?.element;
+    return runNodes(
+      doc,
+      run,
+      !run.equation && source?.equation ? void 0 : source,
+      !run.equation && old && isEquationElement(old) ? void 0 : old,
+      opens.get(index2) ?? [],
+      closes.get(index2) ?? [],
+      allocator
+    );
+  };
   const output = [];
   let index = 0;
   while (index < runs.length) {
@@ -6547,14 +6632,14 @@ function parseCell(cell, parseParagraph3, id) {
   const vMerge = first2(props, "vMerge");
   if (vMerge) result.verticalMerge = getW(vMerge, "val") === "restart" ? "restart" : "continue";
   const tcW = first2(props, "tcW");
-  if (getW(tcW, "type") !== "nil") {
+  if ((getW(tcW, "type") ?? "dxa") === "dxa") {
     const width = dxa(getW(tcW, "w"));
     if (width !== void 0) result.widthTwips = width;
   }
   const vAlign = enumValue(isStVerticalJc, getW(first2(props, "vAlign"), "val"), "w:tcPr/w:vAlign");
   if (vAlign) result.verticalAlign = vAlign;
   const shd = first2(props, "shd");
-  const fill = parseShadingFill(shd);
+  const fill = parseShadingFill(shd) ?? (getW(shd, "fill") === "auto" && !getW(shd, "themeFill") ? "auto" : void 0);
   if (fill) result.shadingFill = fill;
   const themeFill = parseShadingThemeFill(shd);
   if (themeFill) result.shadingThemeFill = themeFill;
@@ -6593,7 +6678,9 @@ function parseMargins(element) {
     ["left", "start"],
     ["right", "end"]
   ]) {
-    const value = dxa(getW(first2(element, side) ?? first2(element, logical), "w"));
+    const edge = first2(element, logical) ?? first2(element, side);
+    const type = getW(edge, "type") ?? "dxa";
+    const value = type === "nil" ? parseSignedTwips("0") : type === "dxa" ? parseSignedTwips(getW(edge, "w")) : void 0;
     if (value !== void 0) parsed[side] = value;
   }
   return Object.keys(parsed).length ? parsed : void 0;
@@ -6623,7 +6710,8 @@ function parseTable(node, id, parseParagraph3) {
   }) : [];
   if (grid.length) table.grid = grid;
   const tblPr = first2(node, "tblPr");
-  const width = dxa(getW(first2(tblPr, "tblW"), "w"));
+  const tableWidth = first2(tblPr, "tblW");
+  const width = (getW(tableWidth, "type") ?? "dxa") === "dxa" ? dxa(getW(tableWidth, "w")) : void 0;
   if (width !== void 0) table.widthTwips = width;
   const justification = enumValue(isStJcTable, getW(first2(tblPr, "jc"), "val"), "w:tblPr/w:jc");
   if (justification) {
@@ -6797,13 +6885,19 @@ function parseParagraph2(node, id) {
     node,
     (element, revision) => trackField(element, parseRun2(element, revision)),
     (item) => {
+      const equation = parseEquation(item);
+      if (equation) return [equation];
       if (!named2(item, "fldSimple")) return void 0;
       const instr = getW(item, "instr") ?? "";
       const link = parseSimpleHyperlinkField(instr);
-      const results = children2(item, "r").map((run) => parseRun2(run));
+      const results = Array.from(item.childNodes).filter(isElement).flatMap((child3) => {
+        const equation2 = parseEquation(child3);
+        return equation2 ? [equation2] : named2(child3, "r") ? [parseRun2(child3)] : [];
+      });
       if (link) return results.map((run) => ({ ...run, link }));
       const field = { instr: instr.trim(), simple: true };
-      if (!results.some((run) => run.text)) return [{ text: fieldPlaceholderText(instr), field }];
+      if (!results.some((run) => run.text || run.equation))
+        return [{ text: fieldPlaceholderText(instr), field }];
       return results.map((run) => ({ ...run, field }));
     },
     (hyperlink) => {

package/dist/docx/equation.d.ts

@@ -0,0 +1,8 @@
+import type { TextRun } from './model.js';
+import type { XmlElement } from './xml.js';
+export declare function isEquationElement(element: XmlElement): boolean;
+/** Serializing the subtree supplies inherited namespaces, so consumers can parse it independently. */
+export declare function parseEquation(element: XmlElement): TextRun | undefined;
+/** Equation source may be relocated within its paragraph, but cannot be created or changed. */
+export declare function preserveEquation(run: TextRun, base: TextRun | undefined, old: XmlElement | undefined): XmlElement;
+//# sourceMappingURL=equation.d.ts.map

package/dist/docx/equation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"equation.d.ts","sourceRoot":"","sources":["../../src/docx/equation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAQ3C,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAK9D;AAED,sGAAsG;AACtG,wBAAgB,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,GAAG,SAAS,CAStE;AAED,+FAA+F;AAC/F,wBAAgB,gBAAgB,CAC/B,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,OAAO,GAAG,SAAS,EACzB,GAAG,EAAE,UAAU,GAAG,SAAS,GACzB,UAAU,CAaZ"}