@json-to-office/core-docx 4.0.0 → 4.2.0

package/dist/plugin/example/index.js

@@ -12482,9 +12482,260 @@ async function expandBlocksWithPlugins(document, theme, plugins, render, preserv
 init_styleHelpers();
 init_defaults();
 init_widthUtils();
+
+// src/quality/text-inventory.ts
+function tocDepth(depth) {
+  const range = asRecord(depth) ?? {};
+  const from = typeof range.from === "number" ? range.from : 1;
+  const to = typeof range.to === "number" ? range.to : 3;
+  return { from, to };
+}
 function asRecord(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value) ? value : void 0;
 }
+function twipsToPt(value) {
+  return typeof value === "number" && Number.isFinite(value) ? value / 20 : void 0;
+}
+function frameOf(props) {
+  const widthPt = twipsToPt(asRecord(props.floating)?.width);
+  return widthPt === void 0 ? void 0 : { widthPt };
+}
+function collectDocxTextInventory(children, basePath = "/children") {
+  const entries = [];
+  const add = (path3, text, role, extra = {}) => {
+    if (typeof text !== "string" || text.trim() === "") return;
+    entries.push({
+      id: `docx:text:${path3}`,
+      kind: "docx/text",
+      path: path3,
+      text,
+      role,
+      // Renumbered once the walk is done: contents entries are spliced in.
+      order: -1,
+      ...extra
+    });
+  };
+  const headings = [];
+  const tocs = [];
+  let sectionCount = 0;
+  const visitCell = (cell, path3, role, inherited) => {
+    const cellRole = inherited.repeats ? "chrome" : role;
+    const extra = inherited.repeats ? { repeats: true } : {};
+    if (typeof cell === "string") {
+      add(path3, cell, cellRole, extra);
+      return;
+    }
+    const rec = asRecord(cell);
+    if (!rec) return;
+    if ("content" in rec) {
+      if (typeof rec.content === "string")
+        add(`${path3}/content`, rec.content, cellRole, extra);
+      else {
+        const inner = asRecord(rec.content);
+        if (inner)
+          visitNode(inner, `${path3}/content`, { ...inherited, inCell: true });
+      }
+      return;
+    }
+    if (typeof rec.name === "string")
+      visitNode(rec, path3, { ...inherited, inCell: true });
+  };
+  const visitNode = (node, path3, inherited) => {
+    if (node.enabled === false) return;
+    const props = asRecord(node.props) ?? {};
+    const name = typeof node.name === "string" ? node.name : "";
+    const extra = {
+      ...inherited.repeats && { repeats: true }
+    };
+    const scope = name === "section" ? { ...inherited, section: ++sectionCount } : inherited;
+    switch (name) {
+      case "heading": {
+        if (inherited.repeats) {
+          add(`${path3}/props/text`, props.text, "chrome", extra);
+          break;
+        }
+        const level = typeof props.level === "number" && Number.isFinite(props.level) ? props.level : 1;
+        add(`${path3}/props/text`, props.text, "heading", { ...extra, level });
+        if (typeof props.text === "string" && props.text.trim() !== "" && !scope.inCell) {
+          headings.push({ text: props.text, level, section: scope.section });
+        }
+        break;
+      }
+      case "toc": {
+        add(`${path3}/props/title`, props.title, "toc-entry", extra);
+        const styles = /* @__PURE__ */ new Set();
+        if (Array.isArray(props.styles)) {
+          for (const mapping of props.styles) {
+            const id = asRecord(mapping)?.styleId;
+            if (typeof id === "string") styles.add(id);
+          }
+        }
+        tocs.push({
+          at: entries.length,
+          path: path3,
+          depth: tocDepth(props.depth),
+          styles,
+          section: props.scope === "document" ? void 0 : scope.section
+        });
+        break;
+      }
+      case "paragraph": {
+        const frame = frameOf(props);
+        add(
+          `${path3}/props/text`,
+          props.text,
+          inherited.repeats ? "chrome" : "body",
+          {
+            ...extra,
+            ...frame && { frame }
+          }
+        );
+        if (typeof props.themeStyle === "string" && typeof props.text === "string" && props.text.trim() !== "" && !scope.inCell) {
+          headings.push({
+            text: props.text,
+            themeStyle: props.themeStyle,
+            section: scope.section
+          });
+        }
+        break;
+      }
+      case "list": {
+        if (Array.isArray(props.items)) {
+          props.items.forEach((item, index) => {
+            const itemPath = `${path3}/props/items/${index}`;
+            if (typeof item === "string")
+              add(itemPath, item, "list-item", extra);
+            else {
+              const rec = asRecord(item);
+              if (rec) add(`${itemPath}/text`, rec.text, "list-item", extra);
+            }
+          });
+        }
+        break;
+      }
+      case "table": {
+        const columns = Array.isArray(props.columns) ? props.columns.map(asRecord) : [];
+        columns.forEach((column, columnIndex) => {
+          if (!column) return;
+          visitCell(
+            column.header,
+            `${path3}/props/columns/${columnIndex}/header`,
+            "table-header",
+            inherited
+          );
+        });
+        const rows = Math.max(
+          0,
+          ...columns.map(
+            (column) => Array.isArray(column?.cells) ? column.cells.length : 0
+          )
+        );
+        for (let row = 0; row < rows; row++) {
+          columns.forEach((column, columnIndex) => {
+            if (!column || !Array.isArray(column.cells)) return;
+            if (row >= column.cells.length) return;
+            visitCell(
+              column.cells[row],
+              `${path3}/props/columns/${columnIndex}/cells/${row}`,
+              "table-cell",
+              inherited
+            );
+          });
+        }
+        break;
+      }
+      case "statistic": {
+        add(`${path3}/props/number`, props.number, "statistic", extra);
+        add(`${path3}/props/description`, props.description, "statistic", extra);
+        break;
+      }
+      case "chart": {
+        if (props.showTitle !== false) {
+          add(`${path3}/props/title`, props.title, "caption", extra);
+        }
+        if (props.type !== "pie" && props.type !== "doughnut") {
+          add(
+            `${path3}/props/catAxisTitle`,
+            props.catAxisTitle,
+            "caption",
+            extra
+          );
+          add(
+            `${path3}/props/valAxisTitle`,
+            props.valAxisTitle,
+            "caption",
+            extra
+          );
+        }
+        add(`${path3}/props/caption`, props.caption, "caption", extra);
+        break;
+      }
+      case "image":
+      case "highcharts":
+      case "visual":
+      case "visual-native": {
+        add(`${path3}/props/caption`, props.caption, "caption", extra);
+        break;
+      }
+      case "section": {
+        for (const part of ["header", "footer"]) {
+          const components = props[part];
+          if (!Array.isArray(components)) continue;
+          components.forEach((component, index) => {
+            const rec = asRecord(component);
+            if (rec) {
+              visitNode(rec, `${path3}/props/${part}/${index}`, {
+                repeats: true
+              });
+            }
+          });
+        }
+        break;
+      }
+      default:
+        break;
+    }
+    if (Array.isArray(node.children)) {
+      node.children.forEach((child, index) => {
+        const rec = asRecord(child);
+        if (rec) visitNode(rec, `${path3}/children/${index}`, scope);
+      });
+    }
+  };
+  children.forEach((child, index) => {
+    const rec = asRecord(child);
+    if (rec) visitNode(rec, `${basePath}/${index}`, {});
+  });
+  for (const toc of [...tocs].reverse()) {
+    const collected = headings.filter(
+      (heading) => (toc.section === void 0 || heading.section === toc.section) && (heading.level !== void 0 ? heading.level >= toc.depth.from && heading.level <= toc.depth.to : heading.themeStyle !== void 0 && toc.styles.has(heading.themeStyle))
+    );
+    entries.splice(
+      toc.at,
+      0,
+      ...collected.map(
+        (heading, index) => ({
+          id: `docx:text:${toc.path}:entry:${index}`,
+          kind: "docx/text",
+          path: toc.path,
+          text: heading.text,
+          role: "toc-entry",
+          order: 0,
+          optional: true
+        })
+      )
+    );
+  }
+  entries.forEach((entry, index) => {
+    entry.order = index;
+  });
+  return entries;
+}
+
+// src/quality/facts.ts
+function asRecord2(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value) ? value : void 0;
+}
 function pageBox(theme, themeName, pageOverride) {
   const page = createSectionProperties(
     getColumnSettings("single"),
@@ -12510,7 +12761,7 @@ function tableFact(props, path3, availableWidthTwips) {
   let percentSum = 0;
   const explicitWidths = [];
   columns.forEach((column, index) => {
-    const width = asRecord(column)?.width;
+    const width = asRecord2(column)?.width;
     if (typeof width === "number" && Number.isFinite(width)) {
       hasExplicitWidth = true;
       explicitWidths.push({ index, width });
@@ -12591,7 +12842,7 @@ function chartFact(node, props, path3, paletteTokens) {
   const categoryCount = Math.max(
     0,
     ...series.map((entry) => {
-      const record = asRecord(entry);
+      const record = asRecord2(entry);
       const labels = Array.isArray(record?.labels) ? record.labels.length : 0;
       const values = Array.isArray(record?.values) ? record.values.length : 0;
       return Math.max(labels, values);
@@ -12633,8 +12884,8 @@ function statesOwnBorders(authored) {
     return true;
   }
   const layers = [
-    asRecord(authored.cellDefaults),
-    asRecord(authored.headerCellDefaults)
+    asRecord2(authored.cellDefaults),
+    asRecord2(authored.headerCellDefaults)
   ];
   if (layers.some(
     (layer) => layer?.borderSize !== void 0 || layer?.borderColor !== void 0
@@ -12643,8 +12894,8 @@ function statesOwnBorders(authored) {
   }
   const columns = Array.isArray(authored.columns) ? authored.columns : [];
   return columns.some((column) => {
-    const record = asRecord(column);
-    const defaults = asRecord(record?.cellDefaults);
+    const record = asRecord2(column);
+    const defaults = asRecord2(record?.cellDefaults);
     return defaults?.borderSize !== void 0 || defaults?.borderColor !== void 0;
   });
 }
@@ -12668,7 +12919,7 @@ function tableDesignFact(props, path3, theme, themeName, authored) {
   );
   const columns = authoredColumns.map(
     (column, index) => {
-      const authoredColumn = asRecord(column) ?? {};
+      const authoredColumn = asRecord2(column) ?? {};
       const cells = Array.isArray(authoredColumn.cells) ? authoredColumn.cells : [];
       const alignments = /* @__PURE__ */ new Set();
       const values = [];
@@ -12687,11 +12938,11 @@ function tableDesignFact(props, path3, theme, themeName, authored) {
         },
         values,
         alignment: alignments.size === 1 ? [...alignments][0] : alignments.size === 0 ? "left" : "mixed",
-        hasCellDefaults: asRecord(authoredColumn.cellDefaults) !== void 0,
-        hasHeader: asRecord(authoredColumn.header) !== void 0,
+        hasCellDefaults: asRecord2(authoredColumn.cellDefaults) !== void 0,
+        hasHeader: asRecord2(authoredColumn.header) !== void 0,
         generated: false,
         cellsWithOwnAlignment: cells.flatMap((cell, cellIndex) => {
-          const alignment2 = asRecord(cell)?.horizontalAlignment;
+          const alignment2 = asRecord2(cell)?.horizontalAlignment;
           return typeof alignment2 === "string" && DOCX_ALIGNMENTS.has(alignment2) && alignment2 !== "right" ? [cellIndex] : [];
         })
       };
@@ -12712,7 +12963,7 @@ function finiteNumber(value) {
   return typeof value === "number" && Number.isFinite(value) ? value : void 0;
 }
 function lineHeightPt(fontSizePt, spacing) {
-  const rule = asRecord(spacing);
+  const rule = asRecord2(spacing);
   const value = finiteNumber(rule?.value);
   switch (rule?.type) {
     // `exactly` is an absolute line box, and display type routinely sets it
@@ -12729,7 +12980,7 @@ function lineHeightPt(fontSizePt, spacing) {
   }
 }
 function characterSpacingPt(spacing) {
-  const rule = asRecord(spacing);
+  const rule = asRecord2(spacing);
   const value = finiteNumber(rule?.value);
   if (rule === void 0 || value === void 0) return 0;
   return rule.type === "condensed" ? -value / TWIPS_PER_POINT3 : value / TWIPS_PER_POINT3;
@@ -12743,7 +12994,7 @@ function nodeAtPointer(root, pointer) {
       current = current[index];
       continue;
     }
-    const record = asRecord(current);
+    const record = asRecord2(current);
     if (!record) return void 0;
     current = record[token];
   }
@@ -12759,10 +13010,10 @@ function styleKey(node, props) {
   return typeof props.themeStyle === "string" && props.themeStyle !== "" ? props.themeStyle : "normal";
 }
 function effectiveFontSize(node, props, typography) {
-  const authored = finiteNumber(asRecord(props.font)?.size);
+  const authored = finiteNumber(asRecord2(props.font)?.size);
   if (authored !== void 0) return { fontSizePt: authored, authored: true };
   const { styles, theme } = typography;
-  const style = asRecord(styles[styleKey(node, props)]) ?? asRecord(styles.normal);
+  const style = asRecord2(styles[styleKey(node, props)]) ?? asRecord2(styles.normal);
   const stated = finiteNumber(style?.size);
   if (stated !== void 0) return { fontSizePt: stated, authored: false };
   const reference = style?.font === "heading" || style?.font === "body" || style?.font === "mono" || style?.font === "light" ? style.font : void 0;
@@ -12772,11 +13023,11 @@ function effectiveFontSize(node, props, typography) {
 function pinnedLineBox(props, path3) {
   const candidates = [
     [props.lineSpacing, `${path3}/props/lineSpacing`],
-    [asRecord(props.font)?.lineSpacing, `${path3}/props/font/lineSpacing`]
+    [asRecord2(props.font)?.lineSpacing, `${path3}/props/font/lineSpacing`]
   ];
   for (const [spacing, pointer] of candidates) {
     if (spacing === void 0) continue;
-    const rule = asRecord(spacing);
+    const rule = asRecord2(spacing);
     if (rule?.type !== "exactly") return void 0;
     const lineBoxPt = finiteNumber(rule.value);
     return lineBoxPt === void 0 ? void 0 : { lineBoxPt, pointer };
@@ -12802,8 +13053,8 @@ function lineBoxFact(node, props, path3, typography, authored) {
   };
 }
 function frameSignature(floating) {
-  const horizontal = asRecord(floating.horizontalPosition);
-  const vertical = asRecord(floating.verticalPosition);
+  const horizontal = asRecord2(floating.horizontalPosition);
+  const vertical = asRecord2(floating.verticalPosition);
   return JSON.stringify([
     floating.width ?? null,
     floating.height ?? null,
@@ -12813,24 +13064,24 @@ function frameSignature(floating) {
     vertical?.offset ?? null,
     vertical?.relative ?? null,
     vertical?.align ?? null,
-    asRecord(floating.wrap)?.type ?? null
+    asRecord2(floating.wrap)?.type ?? null
   ]);
 }
 function frameTextFact(props, path3, page, frameChainId, flowIndex) {
-  const floating = asRecord(props.floating);
+  const floating = asRecord2(props.floating);
   const frameWidthTwips = finiteNumber(floating?.width);
   if (frameWidthTwips === void 0) return void 0;
   const text = typeof props.text === "string" ? props.text : "";
   if (text.trim() === "") return void 0;
-  const font = asRecord(props.font);
+  const font = asRecord2(props.font);
   const fontSizePt = finiteNumber(font?.size);
   if (fontSizePt === void 0) return void 0;
   const longestWord = text.split(/\s+/).reduce(
     (longest, word) => word.length > longest.length ? word : longest,
     ""
   );
-  const horizontal = asRecord(floating?.horizontalPosition);
-  const vertical = asRecord(floating?.verticalPosition);
+  const horizontal = asRecord2(floating?.horizontalPosition);
+  const vertical = asRecord2(floating?.verticalPosition);
   const offsetX = finiteNumber(horizontal?.offset);
   const offsetY = finiteNumber(vertical?.offset);
   const absolutelyPinned = horizontal?.offset !== void 0 || vertical?.offset !== void 0;
@@ -12901,7 +13152,7 @@ function svgTextFacts(props, path3) {
   return facts;
 }
 function walkActive(node, path3, page, visit) {
-  const rec = asRecord(node);
+  const rec = asRecord2(node);
   if (!rec || rec.enabled === false) return;
   visit(rec, path3, page);
   const children = Array.isArray(rec.children) ? rec.children : [];
@@ -12924,7 +13175,7 @@ function textSizeFact(node, props, path3, typography, role) {
 }
 function tableTextSizeFacts(props, authored, path3, typography, page) {
   const facts = [];
-  const sizeOf = (holder) => finiteNumber(asRecord(asRecord(holder)?.font)?.size);
+  const sizeOf = (holder) => finiteNumber(asRecord2(asRecord2(holder)?.font)?.size);
   const authoredSize = (holder, pointer, role) => {
     const size = sizeOf(holder);
     if (size === void 0) return;
@@ -12939,11 +13190,11 @@ function tableTextSizeFacts(props, authored, path3, typography, page) {
     });
   };
   const cellContent = (holder, pointer, role) => {
-    const content = asRecord(holder)?.content;
-    if (asRecord(content) === void 0) return;
+    const content = asRecord2(holder)?.content;
+    if (asRecord2(content) === void 0) return;
     walkActive(content, `${pointer}/content`, page, (node, nodePath) => {
       if (node.name !== "paragraph" && node.name !== "heading") return;
-      const nodeProps = asRecord(node.props) ?? {};
+      const nodeProps = asRecord2(node.props) ?? {};
       if (typeof nodeProps.text !== "string" || nodeProps.text.trim() === "")
         return;
       const fact = textSizeFact(node, nodeProps, nodePath, typography, role);
@@ -12963,7 +13214,7 @@ function tableTextSizeFacts(props, authored, path3, typography, page) {
     );
     const columns = Array.isArray(authored.columns) ? authored.columns : [];
     columns.forEach((column, index) => {
-      const record = asRecord(column) ?? {};
+      const record = asRecord2(column) ?? {};
       const columnPath = `${path3}/props/columns/${index}`;
       authoredSize(
         record.cellDefaults,
@@ -13060,7 +13311,7 @@ function prepareDocxQualityDocument(document, options = {}) {
   let inherited = {};
   topLevel.forEach((node, index) => {
     if (node?.name !== "section") return;
-    const props = asRecord(node.props) ?? {};
+    const props = asRecord2(node.props) ?? {};
     const part = (kind) => props[kind] === "linkToPrevious" ? inherited[kind] : props[kind];
     const header = part("header");
     const footer = part("footer");
@@ -13068,8 +13319,8 @@ function prepareDocxQualityDocument(document, options = {}) {
     for (const kind of ["header", "footer"]) {
       if (!Array.isArray(props[kind])) continue;
       const drawnByBlock = !Array.isArray(
-        asRecord(
-          asRecord(
+        asRecord2(
+          asRecord2(
             (Array.isArray(themed.document.children) ? themed.document.children : [])[index]
           )?.props
         )?.[kind]
@@ -13077,7 +13328,7 @@ function prepareDocxQualityDocument(document, options = {}) {
       const part2 = props[kind];
       const visitChrome = (child, childPath) => {
         if (child.name !== "paragraph" && child.name !== "heading") return;
-        const childProps = asRecord(child.props) ?? {};
+        const childProps = asRecord2(child.props) ?? {};
         if (typeof childProps.text !== "string" || childProps.text.trim() === "")
           return;
         const fact = textSizeFact(
@@ -13134,7 +13385,7 @@ function prepareDocxQualityDocument(document, options = {}) {
   const paletteTokens = resolved.theme.palette?.chart?.map(
     (value) => `#${resolveDesignColor2(value, visualColors)}`
   ) ?? SERIES_COLOR_TOKENS.filter((token) => paletteHexes[token] !== void 0);
-  const authoredPropsAt = (pointer) => asRecord(asRecord(nodeAtPointer(context.document, pointer))?.props);
+  const authoredPropsAt = (pointer) => asRecord2(asRecord2(nodeAtPointer(context.document, pointer))?.props);
   const roleSizesPt = {};
   for (const key of Object.keys(typography.styles)) {
     const size = effectiveFontSize(
@@ -13170,7 +13421,7 @@ function prepareDocxQualityDocument(document, options = {}) {
     fontFamilies: [
       ...new Set(
         ["heading", "body"].flatMap((role) => {
-          const family = asRecord(
+          const family = asRecord2(
             resolved.theme.fonts?.[role]
           )?.family;
           return typeof family === "string" && family.trim() !== "" ? [family] : [];
@@ -13206,12 +13457,15 @@ function prepareDocxQualityDocument(document, options = {}) {
       excerpt: occurrence.match.excerpt
     });
   });
+  for (const entry of collectDocxTextInventory(resolved.children)) {
+    addFact({ ...entry, generated: authoredPath(entry.path) !== entry.path });
+  }
   let previousVisitPath;
   let lastFrame;
   let flowIndex = 0;
   const parentOf = (path3) => path3.slice(0, path3.lastIndexOf("/"));
   const visit = (node, path3, page) => {
-    const props = asRecord(node.props) ?? {};
+    const props = asRecord2(node.props) ?? {};
     if (node.name === "table") {
       const fact = tableFact(props, path3, page.availableWidthTwips);
       if (fact) addFact(fact);
@@ -13240,7 +13494,7 @@ function prepareDocxQualityDocument(document, options = {}) {
             return {
               ...column,
               path: authored,
-              generated: table2 === void 0 || asRecord(nodeAtPointer(themed.document, table2))?.name !== "table"
+              generated: table2 === void 0 || asRecord2(nodeAtPointer(themed.document, table2))?.name !== "table"
             };
           })
         });
@@ -13256,7 +13510,7 @@ function prepareDocxQualityDocument(document, options = {}) {
         addFact({
           ...fact,
           generated: !["chart", "highcharts"].includes(
-            String(asRecord(nodeAtPointer(themed.document, authored))?.name)
+            String(asRecord2(nodeAtPointer(themed.document, authored))?.name)
           ),
           seriesColorsPath: authoredPath(fact.seriesColorsPath),
           ...fact.annotation && {
@@ -13270,7 +13524,7 @@ function prepareDocxQualityDocument(document, options = {}) {
       }
     }
     if (node.name === "paragraph" || node.name === "text-box") {
-      const floating = asRecord(props.floating);
+      const floating = asRecord2(props.floating);
       if (floating) {
         const signature = frameSignature(floating);
         const chainId = lastFrame !== void 0 && previousVisitPath === lastFrame.path && parentOf(lastFrame.path) === parentOf(path3) && lastFrame.signature === signature ? lastFrame.chainId : `docx:frame-chain:${path3}`;