@json-to-office/core-docx 6.1.0 → 6.4.1

package/dist/plugin/example/index.js

@@ -12970,6 +12970,7 @@ async function expandBlocksWithPlugins(document, theme, plugins, render, preserv
 init_styleHelpers();
 init_defaults();
 init_widthUtils();
+import probe2 from "probe-image-size";
 
 // src/quality/text-inventory.ts
 function tocDepth(depth) {
@@ -13220,6 +13221,92 @@ function collectDocxTextInventory(children, basePath = "/children") {
   return entries;
 }
 
+// src/quality/text-metrics.ts
+var DEFAULT_ADVANCE = 556;
+var ADVANCE = {
+  " ": 278,
+  A: 667,
+  B: 667,
+  C: 722,
+  D: 722,
+  E: 667,
+  F: 611,
+  G: 778,
+  H: 722,
+  I: 278,
+  J: 500,
+  K: 667,
+  L: 556,
+  M: 833,
+  N: 722,
+  O: 778,
+  P: 667,
+  Q: 778,
+  R: 722,
+  S: 667,
+  T: 611,
+  U: 722,
+  V: 667,
+  W: 944,
+  X: 667,
+  Y: 667,
+  Z: 611,
+  a: 556,
+  b: 556,
+  c: 500,
+  d: 556,
+  e: 556,
+  f: 278,
+  g: 556,
+  h: 556,
+  i: 222,
+  j: 222,
+  k: 500,
+  l: 222,
+  m: 833,
+  n: 556,
+  o: 556,
+  p: 556,
+  q: 556,
+  r: 333,
+  s: 500,
+  t: 278,
+  u: 556,
+  v: 500,
+  w: 722,
+  x: 500,
+  y: 500,
+  z: 500,
+  ".": 278,
+  ",": 278,
+  ":": 278,
+  ";": 278,
+  "!": 278,
+  "?": 556,
+  "'": 191,
+  '"': 355,
+  "-": 333,
+  "\u2013": 556,
+  "\u2014": 1e3,
+  "&": 667,
+  "%": 889,
+  "(": 333,
+  ")": 333,
+  "/": 278,
+  "@": 1015,
+  "#": 556,
+  "+": 584,
+  "=": 584
+};
+function estimateTextWidthPt(text, fontSizePt, trackingPt = 0) {
+  let units = 0;
+  for (const character of text) {
+    units += ADVANCE[character] ?? DEFAULT_ADVANCE;
+  }
+  const width = units / 1e3 * fontSizePt + text.length * trackingPt;
+  return Math.max(0, width);
+}
+
 // src/quality/facts.ts
 function asRecord2(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value) ? value : void 0;
@@ -13917,7 +14004,9 @@ function prepareDocxQualityDocument(document, options = {}) {
       )
     ]
   });
-  collectColorLiterals(document).forEach((literal, index) => {
+  const content = { ...document, props: { ...asRecord2(document.props) } };
+  delete content.props.themeOverrides;
+  collectColorLiterals(content).forEach((literal, index) => {
     addFact({
       id: `docx:color:${index}:${literal.path}`,
       kind: "docx/color",
@@ -13926,7 +14015,7 @@ function prepareDocxQualityDocument(document, options = {}) {
       hex: literal.hex
     });
   });
-  collectFontFamilies(document).forEach((use, index) => {
+  collectFontFamilies(content).forEach((use, index) => {
     addFact({
       id: `docx:font:${index}:${use.path}`,
       kind: "docx/font-family",
@@ -14031,14 +14120,29 @@ function prepareDocxQualityDocument(document, options = {}) {
     }
     if (node.name === "image" || node.name === "visual") {
       for (const fact of svgTextFacts(props, path3)) addFact(fact);
+      const drawn = drawnRatio(props);
+      const natural = readableRatio(props);
+      addFact({
+        id: `docx:image:${path3}`,
+        kind: "docx/image",
+        path: path3,
+        ...typeof props.alt === "string" && props.alt.trim() !== "" && { alt: props.alt },
+        captioned: isCaptioned(facts, authoredPath(path3)),
+        ...drawn !== void 0 && { drawnRatio: drawn },
+        ...natural !== void 0 && { naturalRatio: natural }
+      });
     }
     if (node.name === "heading") {
       const level = typeof props.level === "number" && Number.isFinite(props.level) ? props.level : 1;
+      const styleKeepNext = asRecord2(
+        typography.styles[`heading${level}`]
+      )?.keepNext;
       addFact({
         id: `docx:heading:${path3}`,
         kind: "docx/heading",
         path: `${path3}/props/level`,
         level,
+        keepNext: props.keepNext === true || props.keepNext === void 0 && styleKeepNext === true,
         ...previousHeadingLevel !== void 0 && {
           previousLevel: previousHeadingLevel
         }
@@ -14053,6 +14157,65 @@ function prepareDocxQualityDocument(document, options = {}) {
     const page = rec.name === "section" ? pageBox(resolved.theme, context.themeName, rec.props?.page) : basePage;
     walkActive(component, `/children/${index}`, page, visit);
   });
+  const wordsOf = (text) => text.split(/\s+/).filter(Boolean).length;
+  const bodyRoles = /* @__PURE__ */ new Set([
+    "body",
+    "list-item",
+    "table-header",
+    "table-cell",
+    "statistic",
+    "caption"
+  ]);
+  const exhibitKinds = /* @__PURE__ */ new Set(["docx/table", "docx/chart", "docx/image"]);
+  resolved.children.forEach((component, index) => {
+    const rec = component;
+    if (rec.name !== "section") return;
+    const prefix = `/children/${index}/`;
+    const own = facts.filter((fact) => fact.path.startsWith(prefix));
+    const texts = own.filter(
+      (fact) => fact.kind === "docx/text"
+    );
+    addFact({
+      id: `docx:section:${index}`,
+      kind: "docx/section",
+      path: `/children/${index}`,
+      index,
+      words: texts.filter((fact) => bodyRoles.has(fact.role)).reduce((total, fact) => total + wordsOf(fact.text), 0),
+      exhibits: own.filter((fact) => exhibitKinds.has(fact.kind)).length,
+      headings: texts.filter((fact) => fact.role === "heading").length
+    });
+    if (hasColumnsComponent(rec)) return;
+    const page = pageBox(
+      resolved.theme,
+      context.themeName,
+      rec.props?.page
+    );
+    const fontSizePt = effectiveFontSize({ name: "paragraph" }, {}, typography)?.fontSizePt ?? 11;
+    const widthPt = page.availableWidthTwips / 20;
+    const averageAdvancePt = estimateTextWidthPt(MEASURE_SAMPLE, fontSizePt) / MEASURE_SAMPLE.length;
+    if (averageAdvancePt > 0)
+      addFact({
+        id: `docx:measure:${index}`,
+        kind: "docx/measure",
+        path: `/children/${index}`,
+        index,
+        charactersPerLine: Math.round(widthPt / averageAdvancePt),
+        widthTwips: page.availableWidthTwips,
+        fontSizePt
+      });
+  });
+  const headingCount = facts.filter(
+    (fact) => fact.kind === "docx/text" && fact.role === "heading"
+  ).length;
+  addFact({
+    id: "docx:outline",
+    kind: "docx/outline",
+    path: "/props",
+    headings: headingCount,
+    contents: facts.some(
+      (fact) => fact.kind === "docx/text" && fact.role === "toc-entry"
+    )
+  });
   return {
     format: "docx",
     model: {
@@ -14083,6 +14246,52 @@ function prepareDocxQualityDocument(document, options = {}) {
     }
   };
 }
+function hasColumnsComponent(node) {
+  if (Array.isArray(node)) return node.some(hasColumnsComponent);
+  const rec = asRecord2(node);
+  if (!rec) return false;
+  if (rec.name === "columns") return true;
+  return Object.values(rec).some(hasColumnsComponent);
+}
+var CAPTION_LABEL = /^\s*(?:\*\*)?\s*(figure|exhibit|table|chart|image)\b/i;
+function isCaptioned(facts, image) {
+  return facts.some((fact) => {
+    if (fact.kind !== "docx/text") return false;
+    const text = fact;
+    const near = siblingOf(text.path) === siblingOf(image) || text.path.startsWith(`${image}/`) || image.startsWith(`${text.path}/`);
+    return near && (text.role === "caption" || CAPTION_LABEL.test(text.text));
+  });
+}
+function siblingOf(pointer) {
+  return pointer.slice(0, pointer.lastIndexOf("/"));
+}
+var MEASURE_SAMPLE = "the quick brown fox jumps over the lazy dog and then settles under it ";
+function drawnRatio(props) {
+  const width = finiteNumber(props.width);
+  const height = finiteNumber(props.height);
+  return width !== void 0 && height !== void 0 && height > 0 ? width / height : void 0;
+}
+function readableRatio(props) {
+  if (typeof props.svg === "string") {
+    const box = /viewBox\s*=\s*["']\s*[-\d.]+[ ,]+[-\d.]+[ ,]+([\d.]+)[ ,]+([\d.]+)/.exec(
+      props.svg
+    );
+    const width = box ? Number(box[1]) : NaN;
+    const height = box ? Number(box[2]) : NaN;
+    return Number.isFinite(width) && Number.isFinite(height) && height > 0 ? width / height : void 0;
+  }
+  if (typeof props.base64 !== "string") return void 0;
+  const comma = props.base64.indexOf(",");
+  if (comma < 0) return void 0;
+  try {
+    const size = probe2.sync(
+      Buffer.from(props.base64.slice(comma + 1), "base64")
+    );
+    return size && size.height > 0 ? size.width / size.height : void 0;
+  } catch {
+    return void 0;
+  }
+}
 function slotIsFilled(value) {
   if (typeof value === "string") return value.trim() !== "";
   return value !== void 0 && value !== null && value !== false && (!Array.isArray(value) || value.length > 0);