@json-to-office/core-docx 1.7.0 → 1.9.0

package/dist/index.js

@@ -1188,6 +1188,15 @@ function resolveFontFamily(theme, fontRef) {
   }
   return theme.fonts[fontRef]?.family || theme.fonts.body.family;
 }
+function resolveFontSize(theme, fontRef) {
+  if (!theme?.fonts?.body?.size) {
+    return void 0;
+  }
+  if (!fontRef) {
+    return theme.fonts.body.size;
+  }
+  return theme.fonts[fontRef]?.size || theme.fonts.body.size;
+}
 function resolveFontProperties(theme, fontRef) {
   const targetFontKey = fontRef || "body";
   if (!theme?.fonts?.[targetFontKey]) {
@@ -2512,6 +2521,14 @@ function paragraphOptions(formatting) {
   if (formatting.outlineLevel !== void 0) {
     options.outlineLevel = formatting.outlineLevel;
   }
+  if (formatting.borders) {
+    const borders3 = {};
+    for (const side of ["top", "bottom", "left", "right", "between"]) {
+      const emitted = emitBorder(formatting.borders[side]);
+      if (emitted) borders3[side] = emitted;
+    }
+    if (Object.keys(borders3).length > 0) options.border = borders3;
+  }
   return options;
 }
 function emitParagraph(block2, resources = /* @__PURE__ */ new Map()) {
@@ -2695,7 +2712,11 @@ function emitBorder(border3) {
   return {
     style: BORDER_STYLE[border3.style] ?? BorderStyle.SINGLE,
     size: border3.sizeEighthPoints ?? 0,
-    color: border3.color?.hex ?? "000000"
+    color: border3.color?.hex ?? "000000",
+    // Stated only when the IR states it, so every border that predates the
+    // rule component emits exactly the bytes it did before. office-open
+    // already carries `w:space`; this is what keeps the two agreeing.
+    ...border3.spacePoints !== void 0 ? { space: border3.spacePoints } : {}
   };
 }
 var ALIGNMENT2, PAGE_FIELD, WRAP_TYPE, VERTICAL_ALIGN, TABLE_ANCHOR, HORIZONTAL_POSITION, VERTICAL_POSITION, BORDER_STYLE;
@@ -3365,6 +3386,7 @@ var init_docxjs = __esm({
       "endnotes",
       "revisions",
       "breaks",
+      "borders",
       "tab-stops",
       "proofing-language",
       "custom-properties"
@@ -4664,6 +4686,7 @@ var init_office_open = __esm({
       "endnotes",
       "revisions",
       "breaks",
+      "borders",
       "tab-stops",
       "proofing-language",
       "custom-properties"
@@ -6521,17 +6544,17 @@ function createDocumentStyles(themeNameOrObject = "minimal", language) {
     "subtitle"
   ]);
   if (theme.styles) {
-    for (const [styleKey, styleValue] of Object.entries(theme.styles)) {
-      if (predefinedStyleKeys.has(styleKey)) {
+    for (const [styleKey2, styleValue] of Object.entries(theme.styles)) {
+      if (predefinedStyleKeys.has(styleKey2)) {
         continue;
       }
       if (!styleValue) {
         continue;
       }
-      const tocMatch = /^TOC([1-9])$/.exec(styleKey);
-      const customStyle = tocMatch ? styleValue : resolveStyleWithBaseStyle(theme, styleKey) || styleValue;
-      const styleId = tocMatch ? `TOC${tocMatch[1]}` : styleKey;
-      const styleName = tocMatch ? `TOC ${tocMatch[1]}` : styleKey.replace(/([A-Z])/g, " $1").trim();
+      const tocMatch = /^TOC([1-9])$/.exec(styleKey2);
+      const customStyle = tocMatch ? styleValue : resolveStyleWithBaseStyle(theme, styleKey2) || styleValue;
+      const styleId = tocMatch ? `TOC${tocMatch[1]}` : styleKey2;
+      const styleName = tocMatch ? `TOC ${tocMatch[1]}` : styleKey2.replace(/([A-Z])/g, " $1").trim();
       const mapBaseStyleId = (base) => {
         if (!base) return "Normal";
         const lower = base.toLowerCase();
@@ -8455,6 +8478,8 @@ function compileComponent(component, scope) {
       return compileStatistic(component, scope);
     case "toc":
       return compileToc(component, scope);
+    case "rule":
+      return compileRule(component, scope);
     case "text-box":
       return compileTextBox(component, scope);
     case "columns":
@@ -9031,6 +9056,100 @@ function compileToc(component, scope) {
   });
   return blocks;
 }
+var DEFAULT_RULE_SPACING_PT = 6;
+var DEFAULT_RULE_THICKNESS_PT = 1;
+var RULE_LINE_TWIPS = 20;
+var RULE_BORDER_STYLE = {
+  solid: "single",
+  dashed: "dashed",
+  dotted: "dotted",
+  double: "double"
+};
+function compileRule(component, scope) {
+  const { ctx, path: path4 } = scope;
+  const props = component.props ?? {};
+  ctx.features.require("borders", path4);
+  const thicknessPt = Math.min(
+    12,
+    Math.max(
+      0.25,
+      typeof props.thickness === "number" && Number.isFinite(props.thickness) ? props.thickness : DEFAULT_RULE_THICKNESS_PT
+    )
+  );
+  const spacing = props.spacing ?? {};
+  const beforePt = typeof spacing.before === "number" && Number.isFinite(spacing.before) ? spacing.before : DEFAULT_RULE_SPACING_PT;
+  const afterPt = typeof spacing.after === "number" && Number.isFinite(spacing.after) ? spacing.after : DEFAULT_RULE_SPACING_PT;
+  return [
+    {
+      kind: "paragraph",
+      id: scope.id,
+      path: path4,
+      styleId: "Normal",
+      children: [],
+      formatting: {
+        spacing: {
+          beforeTwips: pointsToTwips2(beforePt),
+          afterTwips: pointsToTwips2(afterPt),
+          lineTwips: RULE_LINE_TWIPS,
+          lineRule: "exact"
+        },
+        ...ruleIndent(props, ctx, path4),
+        borders: {
+          bottom: {
+            style: RULE_BORDER_STYLE[String(props.style)] ?? "single",
+            sizeEighthPoints: pointsToEighthPoints(thicknessPt),
+            color: irColor(
+              resolveColor(String(props.color ?? "border"), ctx.theme)
+            ),
+            // The border hangs off the paragraph edge; any gap the author
+            // wants belongs to `spacing`, where they can see it.
+            spacePoints: 0
+          }
+        }
+      }
+    }
+  ];
+}
+function ruleIndent(props, ctx, path4) {
+  const width = props.width;
+  if (width === void 0) return {};
+  const page = getPageSetup(ctx.theme);
+  const measureTwips = Math.max(
+    0,
+    page.size.width - page.margin.left - page.margin.right
+  );
+  let usedTwips;
+  if (typeof width === "number" && Number.isFinite(width)) {
+    usedTwips = pointsToTwips2(width);
+  } else if (typeof width === "string" && width.trim().endsWith("%")) {
+    const percent = Number(width.trim().slice(0, -1));
+    if (Number.isFinite(percent)) {
+      usedTwips = Math.round(measureTwips * percent / 100);
+    }
+  }
+  if (usedTwips === void 0) return {};
+  const remainder = measureTwips - usedTwips;
+  if (remainder <= 0) {
+    if (remainder < 0) {
+      warnOnce(
+        ctx,
+        "rule",
+        `Rule width ${JSON.stringify(width)} at ${path4} is wider than the ${Math.round(measureTwips / 20)}pt text measure; it runs the full measure instead.`
+      );
+    }
+    return {};
+  }
+  switch (props.alignment) {
+    case "right":
+      return { indent: { leftTwips: remainder } };
+    case "center": {
+      const half = Math.round(remainder / 2);
+      return { indent: { leftTwips: half, rightTwips: remainder - half } };
+    }
+    default:
+      return { indent: { rightTwips: remainder } };
+  }
+}
 var TREND_GLYPHS = {
   up: "\u25B2",
   down: "\u25BC",
@@ -11019,8 +11138,8 @@ function getHeadingDefaults(theme) {
 function getHeadingDefaultsForLevel(theme, level) {
   const defaults = {};
   if (theme.styles) {
-    const styleKey = `heading${level}`;
-    const headingStyle = theme.styles[styleKey];
+    const styleKey2 = `heading${level}`;
+    const headingStyle = theme.styles[styleKey2];
     if (headingStyle?.alignment) {
       defaults.alignment = headingStyle.alignment;
     }
@@ -11461,6 +11580,8 @@ function normalizeDocument(document) {
 }
 
 // src/quality/facts.ts
+init_styleHelpers();
+init_defaults();
 init_widthUtils();
 function asRecord(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value) ? value : void 0;
@@ -11550,6 +11671,70 @@ function characterSpacingPt(spacing) {
   if (rule === void 0 || value === void 0) return 0;
   return rule.type === "condensed" ? -value / TWIPS_PER_POINT3 : value / TWIPS_PER_POINT3;
 }
+function pointerExists(root, pointer) {
+  let current = root;
+  for (const token of pointer.split("/").slice(1)) {
+    if (Array.isArray(current)) {
+      const index = Number(token);
+      if (!Number.isInteger(index)) return false;
+      current = current[index];
+      continue;
+    }
+    const record = asRecord(current);
+    if (!record) return false;
+    current = record[token];
+  }
+  return current !== void 0;
+}
+function styleKey(node, props) {
+  if (node.name === "heading") {
+    return `heading${finiteNumber(props.level) ?? 1}`;
+  }
+  return typeof props.themeStyle === "string" && props.themeStyle !== "" ? props.themeStyle : "normal";
+}
+function effectiveFontSize(node, props, typography) {
+  const authored = finiteNumber(asRecord(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 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;
+  const inherited = resolveFontSize(theme, reference);
+  return inherited === void 0 ? void 0 : { fontSizePt: inherited, authored: false };
+}
+function pinnedLineBox(props, path4) {
+  const candidates = [
+    [props.lineSpacing, `${path4}/props/lineSpacing`],
+    [asRecord(props.font)?.lineSpacing, `${path4}/props/font/lineSpacing`]
+  ];
+  for (const [spacing, pointer] of candidates) {
+    if (spacing === void 0) continue;
+    const rule = asRecord(spacing);
+    if (rule?.type !== "exactly") return void 0;
+    const lineBoxPt = finiteNumber(rule.value);
+    return lineBoxPt === void 0 ? void 0 : { lineBoxPt, pointer };
+  }
+  return void 0;
+}
+function lineBoxFact(node, props, path4, typography, authored) {
+  if (typeof props.text !== "string" || props.text.trim() === "") {
+    return void 0;
+  }
+  const pinned = pinnedLineBox(props, path4);
+  if (!pinned) return void 0;
+  const size = effectiveFontSize(node, props, typography);
+  if (size === void 0) return void 0;
+  return {
+    id: `docx:line-box:${path4}`,
+    kind: "docx/line-box",
+    path: pinned.pointer,
+    lineBoxPt: pinned.lineBoxPt,
+    fontSizePt: size.fontSizePt,
+    fontSizeAuthored: size.authored,
+    patchable: pointerExists(authored, pinned.pointer)
+  };
+}
 function frameSignature(floating) {
   const horizontal = asRecord(floating.horizontalPosition);
   const vertical = asRecord(floating.verticalPosition);
@@ -11666,6 +11851,10 @@ function prepareDocxQualityDocument(document, options = {}) {
   });
   const resolved = resolveDocumentTree(context.document, context.theme);
   const basePage = pageBox(resolved.theme, context.themeName);
+  const typography = {
+    styles: getThemeStyles(resolved.theme),
+    theme: resolved.theme
+  };
   const facts = [];
   const provenance = {};
   let previousHeadingLevel;
@@ -11696,6 +11885,10 @@ function prepareDocxQualityDocument(document, options = {}) {
         if (fact) addFact(fact);
       }
     }
+    if (node.name === "paragraph" || node.name === "heading") {
+      const fact = lineBoxFact(node, props, path4, typography, context.document);
+      if (fact) addFact(fact);
+    }
     if (node.name === "image" || node.name === "visual") {
       for (const fact of svgTextFacts(props, path4)) addFact(fact);
     }
@@ -12513,6 +12706,63 @@ var docxSvgTextBoundsRule = {
     ];
   })
 };
+var LINE_BOX_MIN_RATIO = 0.7;
+function tenths(value) {
+  return Math.round(value * 10) / 10;
+}
+var docxLineBoxRule = {
+  id: "docx/line-box",
+  code: QUALITY_CODES.LINE_BOX_COLLAPSE,
+  category: "legibility",
+  defaultSeverity: "warning",
+  defaultCertainty: "measured",
+  formats: ["docx"],
+  defaultParameters: { minimumLineBoxRatio: LINE_BOX_MIN_RATIO },
+  evaluate: ({ facts, configuration }) => {
+    const ratio = numberParameter(
+      configuration.parameters,
+      "minimumLineBoxRatio",
+      LINE_BOX_MIN_RATIO
+    );
+    return facts.filter((fact) => fact.kind === "docx/line-box").flatMap((fact) => {
+      const floorPt = Math.ceil(fact.fontSizePt * ratio * 10) / 10;
+      if (fact.lineBoxPt >= floorPt) return [];
+      const repairPt = Math.max(tenths(fact.fontSizePt), floorPt);
+      const inherited = fact.fontSizeAuthored ? "" : " inherited from the paragraph style";
+      return [
+        {
+          message: `An exact ${tenths(fact.lineBoxPt)}pt line box holds ${tenths(fact.fontSizePt)}pt text${inherited} \u2014 shorter than the capitals it contains, so the lines overlap or lose their tops.`,
+          path: fact.path,
+          // The second sentence is the exit from the incentive that
+          // produced this geometry: the reported route to a 3pt rule was a
+          // collapsed line box on 8pt type, because nothing else drew one.
+          suggestion: `Set the box to at least ${repairPt}pt \u2014 as tall as the type it holds \u2014 or use "atLeast" so the line grows to fit the text. To draw a line rather than set leading, use the "rule" component.${fact.patchable ? "" : " This box is not stated on the component: it arrives through `componentDefaults` and has to be repaired there."}`,
+          context: {
+            lineBoxPt: tenths(fact.lineBoxPt),
+            fontSizePt: tenths(fact.fontSizePt),
+            capHeightFloorPt: floorPt
+          },
+          evidence: {
+            actual: tenths(fact.lineBoxPt),
+            expected: floorPt,
+            unit: "pt"
+          },
+          // Only when the pointer exists in the authored document: a box
+          // arriving through `componentDefaults` has to be repaired there.
+          ...fact.patchable && {
+            fixes: [
+              {
+                op: "add",
+                path: `${fact.path}/value`,
+                value: repairPt
+              }
+            ]
+          }
+        }
+      ];
+    });
+  }
+};
 var DOCX_QUALITY_RULES = {
   id: "docx/default",
   rules: [
@@ -12520,7 +12770,8 @@ var DOCX_QUALITY_RULES = {
     docxHeadingHierarchyRule,
     docxTextFitRule,
     docxFrameCollisionRule,
-    docxSvgTextBoundsRule
+    docxSvgTextBoundsRule,
+    docxLineBoxRule
   ]
 };
 var DOCX_QUALITY_PROFILES = {