@json-to-office/core-docx 1.4.0 → 1.5.0

package/dist/plugin/example/index.js

@@ -5206,88 +5206,6 @@ async function prerasterizeVisuals(root, serviceConfig, options = {}) {
   return map;
 }
 
-// src/json/normalizer.ts
-function normalizeComponent(component) {
-  if (component.name === "columns") {
-    return normalizeColumnsComponent(component);
-  }
-  if ("children" in component && component.children) {
-    return {
-      ...component,
-      // Preserve ALL properties from validated component
-      children: component.children.map(normalizeComponent)
-    };
-  }
-  if (component.name === "section") {
-    return normalizeSectionComponent(component);
-  }
-  return component;
-}
-function normalizeColumnsComponent(component) {
-  const cfg = component.props || {};
-  const applyTopLevelGap = (cols, topGap) => cols.map((c, i) => {
-    const isLast = i === cols.length - 1;
-    if (!isLast && c.gap === void 0 && topGap !== void 0) {
-      return { ...c, gap: topGap };
-    }
-    return c;
-  });
-  const normalizeAutoWidth = (cols) => cols.map((c) => ({
-    ...c,
-    width: c.width === "auto" ? void 0 : c.width
-  }));
-  let columnsArray;
-  if (typeof cfg.columns === "number" && cfg.columns > 0) {
-    const n = cfg.columns;
-    const base = Array.from(
-      { length: n },
-      () => ({})
-    );
-    const topLevelGap = cfg.gap !== void 0 ? cfg.gap : "5%";
-    columnsArray = applyTopLevelGap(base, topLevelGap);
-  } else if (Array.isArray(cfg.columns)) {
-    columnsArray = cfg.columns;
-    const topLevelGap = cfg.gap !== void 0 ? cfg.gap : "5%";
-    columnsArray = applyTopLevelGap(columnsArray, topLevelGap);
-    columnsArray = normalizeAutoWidth(columnsArray);
-  } else {
-    columnsArray = [{}];
-  }
-  const normalizedProps = {
-    columns: columnsArray
-  };
-  return {
-    ...component,
-    // Preserve any additional properties
-    name: "columns",
-    props: normalizedProps,
-    children: component.children ? component.children.map(normalizeComponent) : void 0
-  };
-}
-function normalizeSectionComponent(component) {
-  const props = component.props || {};
-  return {
-    ...component,
-    // Preserve ALL properties
-    props: {
-      ...props,
-      // Preserve ALL props properties
-      header: props.header ? props.header === "linkToPrevious" ? "linkToPrevious" : props.header.map((m) => normalizeComponent(m)) : void 0,
-      footer: props.footer ? props.footer === "linkToPrevious" ? "linkToPrevious" : props.footer.map((m) => normalizeComponent(m)) : void 0
-    },
-    children: component.children ? component.children.map(normalizeComponent) : void 0
-  };
-}
-function normalizeDocument(document) {
-  if (document.name !== "docx") {
-    throw new Error(
-      'Top-level document must be a docx component with name="docx"'
-    );
-  }
-  const normalized = normalizeComponent(document);
-  return [normalized];
-}
-
 // src/core/desugarExternals.ts
 import {
   clampVisualDpi as clampVisualDpi2,
@@ -11198,8 +11116,7 @@ function resolveComponentTree(components, theme) {
 }
 
 // src/core/structure.ts
-async function processDocument(document, theme, themeName, generationDate) {
-  const metadata = createDocumentMetadata(document.props, generationDate);
+function resolveDocumentTree(document, theme) {
   const docDefaults = document.props.componentDefaults;
   const mergedComponentDefaults = docDefaults ? mergeWithDefaults2(docDefaults, theme.componentDefaults || {}) : void 0;
   const docNoProofWords = document.props.noProofWords;
@@ -11213,6 +11130,14 @@ async function processDocument(document, theme, themeName, generationDate) {
     },
     ...mergedNoProofWords && { noProofWords: mergedNoProofWords }
   } : theme;
+  return {
+    theme: effectiveTheme,
+    children: resolveComponentTree(document.children || [], effectiveTheme)
+  };
+}
+async function processResolvedDocument(document, resolved, themeName, generationDate) {
+  const metadata = createDocumentMetadata(document.props, generationDate);
+  const effectiveTheme = resolved.theme;
   const context = createRenderContext(
     {
       metadata,
@@ -11223,11 +11148,7 @@ async function processDocument(document, theme, themeName, generationDate) {
     effectiveTheme,
     themeName
   );
-  const resolvedChildren = resolveComponentTree(
-    document.children || [],
-    effectiveTheme
-  );
-  const sections = await extractSections(resolvedChildren, context);
+  const sections = await extractSections(resolved.children, context);
   return {
     metadata,
     sections,
@@ -11327,6 +11248,326 @@ function createRenderContext(document, theme, themeName) {
   };
 }
 
+// src/quality/facts.ts
+import { DEFAULT_DOCX_RENDERER_ID as DEFAULT_DOCX_RENDERER_ID2 } from "@json-to-office/shared-docx";
+
+// src/json/normalizer.ts
+function normalizeComponent(component) {
+  if (component.name === "columns") {
+    return normalizeColumnsComponent(component);
+  }
+  if ("children" in component && component.children) {
+    return {
+      ...component,
+      // Preserve ALL properties from validated component
+      children: component.children.map(normalizeComponent)
+    };
+  }
+  if (component.name === "section") {
+    return normalizeSectionComponent(component);
+  }
+  return component;
+}
+function normalizeColumnsComponent(component) {
+  const cfg = component.props || {};
+  const applyTopLevelGap = (cols, topGap) => cols.map((c, i) => {
+    const isLast = i === cols.length - 1;
+    if (!isLast && c.gap === void 0 && topGap !== void 0) {
+      return { ...c, gap: topGap };
+    }
+    return c;
+  });
+  const normalizeAutoWidth = (cols) => cols.map((c) => ({
+    ...c,
+    width: c.width === "auto" ? void 0 : c.width
+  }));
+  let columnsArray;
+  if (typeof cfg.columns === "number" && cfg.columns > 0) {
+    const n = cfg.columns;
+    const base = Array.from(
+      { length: n },
+      () => ({})
+    );
+    const topLevelGap = cfg.gap !== void 0 ? cfg.gap : "5%";
+    columnsArray = applyTopLevelGap(base, topLevelGap);
+  } else if (Array.isArray(cfg.columns)) {
+    columnsArray = cfg.columns;
+    const topLevelGap = cfg.gap !== void 0 ? cfg.gap : "5%";
+    columnsArray = applyTopLevelGap(columnsArray, topLevelGap);
+    columnsArray = normalizeAutoWidth(columnsArray);
+  } else {
+    columnsArray = [{}];
+  }
+  const normalizedProps = {
+    columns: columnsArray
+  };
+  return {
+    ...component,
+    // Preserve any additional properties
+    name: "columns",
+    props: normalizedProps,
+    children: component.children ? component.children.map(normalizeComponent) : void 0
+  };
+}
+function normalizeSectionComponent(component) {
+  const props = component.props || {};
+  return {
+    ...component,
+    // Preserve ALL properties
+    props: {
+      ...props,
+      // Preserve ALL props properties
+      header: props.header ? props.header === "linkToPrevious" ? "linkToPrevious" : props.header.map((m) => normalizeComponent(m)) : void 0,
+      footer: props.footer ? props.footer === "linkToPrevious" ? "linkToPrevious" : props.footer.map((m) => normalizeComponent(m)) : void 0
+    },
+    children: component.children ? component.children.map(normalizeComponent) : void 0
+  };
+}
+function normalizeDocument(document) {
+  if (document.name !== "docx") {
+    throw new Error(
+      'Top-level document must be a docx component with name="docx"'
+    );
+  }
+  const normalized = normalizeComponent(document);
+  return [normalized];
+}
+
+// src/quality/facts.ts
+init_widthUtils();
+function asRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value) ? value : void 0;
+}
+function pageBox(theme, themeName, pageOverride) {
+  const page = createSectionProperties(
+    getColumnSettings("single"),
+    theme,
+    themeName,
+    "nextPage",
+    pageOverride
+  ).page;
+  return {
+    availableWidthTwips: Math.max(
+      0,
+      page.size.width - page.margin.left - page.margin.right
+    ),
+    pageBottomTwips: page.size.height
+  };
+}
+function tableFact(props, path3, availableWidthTwips) {
+  const columns = Array.isArray(props.columns) ? props.columns : void 0;
+  if (!columns) return void 0;
+  let totalWidthTwips = 0;
+  let hasExplicitWidth = false;
+  let pointSum = 0;
+  let percentSum = 0;
+  const explicitWidths = [];
+  columns.forEach((column, index) => {
+    const width = asRecord(column)?.width;
+    if (typeof width === "number" && Number.isFinite(width)) {
+      hasExplicitWidth = true;
+      explicitWidths.push({ index, width });
+      totalWidthTwips += relativeLengthToTwips(width, availableWidthTwips);
+      pointSum += width;
+    } else if (typeof width === "string") {
+      hasExplicitWidth = true;
+      const percent = width.trim().endsWith("%") ? Number(width.trim().slice(0, -1)) : Number.NaN;
+      if (Number.isFinite(percent)) {
+        explicitWidths.push({ index, width });
+        percentSum += percent;
+        totalWidthTwips += Math.max(
+          0,
+          Math.round(availableWidthTwips * percent / 100)
+        );
+      }
+    }
+  });
+  return {
+    id: `docx:table-width:${path3}`,
+    kind: "docx/table-width",
+    path: `${path3}/props/columns`,
+    totalWidthTwips,
+    availableWidthTwips,
+    hasExplicitWidth,
+    allColumnsExplicit: explicitWidths.length === columns.length,
+    pointSum,
+    percentSum,
+    explicitWidths
+  };
+}
+var TWIPS_PER_POINT3 = 20;
+var SINGLE_LINE_RATIO = 1.2;
+function finiteNumber(value) {
+  return typeof value === "number" && Number.isFinite(value) ? value : void 0;
+}
+function lineHeightPt(fontSizePt, spacing) {
+  const rule = asRecord(spacing);
+  const value = finiteNumber(rule?.value);
+  switch (rule?.type) {
+    // `exactly` is an absolute line box, and display type routinely sets it
+    // below the font size — reading it as a multiplier would inflate every
+    // estimate on exactly the headings that matter most.
+    case "exactly":
+      return value ?? fontSizePt * SINGLE_LINE_RATIO;
+    case "atLeast":
+      return Math.max(value ?? 0, fontSizePt * SINGLE_LINE_RATIO);
+    case "multiple":
+      return fontSizePt * SINGLE_LINE_RATIO * (value ?? 1);
+    default:
+      return fontSizePt * SINGLE_LINE_RATIO;
+  }
+}
+function characterSpacingPt(spacing) {
+  const rule = asRecord(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;
+}
+function frameTextFact(props, path3, page) {
+  const floating = asRecord(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 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 offsetY = finiteNumber(asRecord(floating?.verticalPosition)?.offset);
+  return {
+    id: `docx:frame-text:${path3}`,
+    kind: "docx/frame-text",
+    path: path3,
+    text,
+    fontSizePt,
+    lineHeightPt: lineHeightPt(fontSizePt, font?.lineSpacing),
+    characterSpacingPt: characterSpacingPt(font?.characterSpacing),
+    frameWidthTwips,
+    ...finiteNumber(floating?.height) !== void 0 && {
+      frameHeightTwips: finiteNumber(floating?.height)
+    },
+    ...offsetY !== void 0 && { offsetYTwips: offsetY },
+    pageBottomTwips: page.pageBottomTwips,
+    longestWord
+  };
+}
+var SVG_VIEWBOX = /viewBox\s*=\s*"\s*(-?[\d.]+)[\s,]+(-?[\d.]+)[\s,]+(-?[\d.]+)[\s,]+(-?[\d.]+)\s*"/;
+var SVG_TEXT = /<text\b([^>]*)>([^<]*)<\/text>/g;
+var SVG_ATTR = (name) => new RegExp(`\\b${name}\\s*=\\s*"(-?[\\d.]+)"`);
+function svgTextFacts(props, path3) {
+  const svg = typeof props.svg === "string" ? props.svg : void 0;
+  if (!svg) return [];
+  const box = SVG_VIEWBOX.exec(svg);
+  if (!box) return [];
+  const viewBoxMinY = Number(box[2]);
+  const viewBoxHeight = Number(box[4]);
+  if (!Number.isFinite(viewBoxMinY) || !Number.isFinite(viewBoxHeight)) {
+    return [];
+  }
+  const facts = [];
+  let match;
+  SVG_TEXT.lastIndex = 0;
+  let index = 0;
+  while ((match = SVG_TEXT.exec(svg)) !== null) {
+    const [, attributes, content] = match;
+    const baselineY = Number(SVG_ATTR("y").exec(attributes)?.[1]);
+    if (!Number.isFinite(baselineY)) {
+      index += 1;
+      continue;
+    }
+    const fontSizeUnits = Number(
+      SVG_ATTR("font-size").exec(attributes)?.[1] ?? 0
+    );
+    facts.push({
+      id: `docx:svg-text:${path3}:${index}`,
+      kind: "docx/svg-text",
+      path: `${path3}/props/svg`,
+      content: content.trim(),
+      baselineY,
+      fontSizeUnits: Number.isFinite(fontSizeUnits) ? fontSizeUnits : 0,
+      viewBoxMinY,
+      viewBoxHeight
+    });
+    index += 1;
+  }
+  return facts;
+}
+function walkActive(node, path3, page, visit) {
+  const rec = asRecord(node);
+  if (!rec || rec.enabled === false) return;
+  visit(rec, path3, page);
+  const children = Array.isArray(rec.children) ? rec.children : [];
+  children.forEach(
+    (child, index) => walkActive(child, `${path3}/children/${index}`, page, visit)
+  );
+}
+function prepareDocxQualityDocument(document, options = {}) {
+  const context = options.context ?? resolveThemeContext(normalizeDocument(document)[0], {
+    customThemes: options.customThemes,
+    fonts: options.fonts,
+    warnings: options.warnings
+  });
+  const resolved = resolveDocumentTree(context.document, context.theme);
+  const basePage = pageBox(resolved.theme, context.themeName);
+  const facts = [];
+  const provenance = {};
+  let previousHeadingLevel;
+  const addFact = (fact) => {
+    facts.push(fact);
+    provenance[fact.id] = {
+      path: fact.path,
+      ...fact.relatedPaths && { relatedPaths: fact.relatedPaths }
+    };
+  };
+  const visit = (node, path3, page) => {
+    const props = asRecord(node.props) ?? {};
+    if (node.name === "table") {
+      const fact = tableFact(props, path3, page.availableWidthTwips);
+      if (fact) addFact(fact);
+    }
+    if (node.name === "paragraph" || node.name === "text-box") {
+      const fact = frameTextFact(props, path3, page);
+      if (fact) addFact(fact);
+    }
+    if (node.name === "image" || node.name === "visual") {
+      for (const fact of svgTextFacts(props, path3)) addFact(fact);
+    }
+    if (node.name === "heading") {
+      const level = typeof props.level === "number" && Number.isFinite(props.level) ? props.level : 1;
+      addFact({
+        id: `docx:heading:${path3}`,
+        kind: "docx/heading",
+        path: `${path3}/props/level`,
+        level,
+        ...previousHeadingLevel !== void 0 && {
+          previousLevel: previousHeadingLevel
+        }
+      });
+      previousHeadingLevel = level;
+    }
+  };
+  resolved.children.forEach((component, index) => {
+    const rec = component;
+    const page = rec.name === "section" ? pageBox(resolved.theme, context.themeName, rec.props?.page) : basePage;
+    walkActive(component, `/children/${index}`, page, visit);
+  });
+  return {
+    format: "docx",
+    model: {
+      authored: document,
+      context,
+      document: resolved,
+      themeName: context.themeName
+    },
+    facts,
+    provenance,
+    renderer: options.renderer ?? DEFAULT_DOCX_RENDERER_ID2
+  };
+}
+
 // src/core/generateFromIr.ts
 var UncompiledComponentError = class extends Error {
   code = "UNCOMPILED_COMPONENT";
@@ -11354,11 +11595,14 @@ async function compileDocumentToIr(document, options = {}, collector) {
   );
 }
 async function compileDocumentScoped(document, options, warnings) {
-  const context = options.context ?? resolveThemeContext(normalizeDocument(document)[0], {
+  const prepared = options.prepared ?? prepareDocxQualityDocument(document, {
     customThemes: options.customThemes,
     fonts: options.fonts,
-    warnings
+    warnings,
+    context: options.context,
+    renderer: options.renderer
   });
+  const { context } = prepared.model;
   const hasVisual = collectVisualProps(context.document).length > 0;
   const resolvedFonts = await resolveDocumentFonts(
     context.document,
@@ -11374,9 +11618,10 @@ async function compileDocumentScoped(document, options, warnings) {
     ...options.baseDir !== void 0 ? { baseDir: options.baseDir } : {},
     ...visualFonts.length > 0 ? { visualFonts } : {}
   });
-  const structure = await processDocument(
+  const resolved = desugared === context.document ? prepared.model.document : resolveDocumentTree(desugared, context.theme);
+  const structure = await processResolvedDocument(
     desugared,
-    context.theme,
+    resolved,
     context.themeName,
     resolveGenerationDate(options)
   );