@json-to-office/core-docx 2.6.0 → 2.7.0

package/dist/index.js

@@ -8455,11 +8455,167 @@ function emptyToUndefined(formatting) {
 }
 
 // src/blocks/index.ts
-import { KEY_TAKEAWAYS_BUDGET } from "@json-to-office/shared-docx";
+import {
+  COVER_BUDGET,
+  KEY_TAKEAWAYS_BUDGET,
+  RUNNING_HEAD_BUDGET,
+  SECTION_OPENER_BUDGET
+} from "@json-to-office/shared-docx";
 
-// src/blocks/keyTakeaways.ts
+// src/blocks/cover.ts
+init_widthUtils();
+
+// src/blocks/recipe.ts
 var MIN_RULE_PT = 0.25;
 var MAX_RULE_PT = 12;
+function clampRule(weightPt) {
+  return Math.min(MAX_RULE_PT, Math.max(MIN_RULE_PT, weightPt));
+}
+var FALLBACK_EYEBROW_FONT = {
+  size: 9,
+  bold: true,
+  color: "accent",
+  case: "upper"
+};
+function hasStyle(theme, role) {
+  const styles = theme.styles;
+  return styles?.[role] !== void 0;
+}
+function roleProps(theme, role, fallbackFont, color) {
+  if (hasStyle(theme, role)) {
+    return {
+      themeStyle: role,
+      ...color !== void 0 && { font: { color } }
+    };
+  }
+  return { font: { ...fallbackFont, ...color !== void 0 && { color } } };
+}
+
+// src/blocks/cover.ts
+var DROP_SHARE = 0.3;
+var DROP_SHARE_WITH_LOGO = 0.22;
+var DEFAULT_LOGO_WIDTH = "25%";
+var FALLBACK = {
+  ruleWeightPt: 3,
+  ruleColor: "accent",
+  padPt: 12,
+  metaFont: { size: 9, color: "textSecondary" }
+};
+function compileCover(props, theme) {
+  const recipe = theme.chrome?.cover;
+  const ruleWeightPt = recipe?.rule?.weightPt ?? FALLBACK.ruleWeightPt;
+  const padPt = recipe?.padPt ?? FALLBACK.padPt;
+  const heightPt = getAvailableHeightTwips(theme) / 20;
+  const dropPt = Math.round(
+    heightPt * (props.logo ? DROP_SHARE_WITH_LOGO : DROP_SHARE)
+  );
+  const children = [];
+  const sourceMap = {};
+  const emit = (child, slots) => {
+    const index = children.push(child) - 1;
+    sourceMap[`/children/${index}`] = "";
+    for (const [emitted, authored] of Object.entries(slots)) {
+      sourceMap[`/children/${index}${emitted}`] = authored;
+    }
+  };
+  if (props.logo) {
+    const { width, height, ...source } = props.logo;
+    emit(
+      {
+        name: "image",
+        props: {
+          ...source,
+          width: width ?? DEFAULT_LOGO_WIDTH,
+          ...height !== void 0 && { height },
+          alignment: theme.chrome?.logoSlot?.alignment ?? "left",
+          spacing: { before: 0, after: 0 }
+        }
+      },
+      { "/props": "/props/logo" }
+    );
+  }
+  const drawsRule = ruleWeightPt > 0;
+  if (drawsRule) {
+    emit(
+      {
+        name: "divider",
+        props: {
+          thickness: clampRule(ruleWeightPt),
+          color: recipe?.rule?.color ?? FALLBACK.ruleColor,
+          spacing: { before: dropPt, after: padPt }
+        }
+      },
+      {}
+    );
+  }
+  let dropPending = !drawsRule;
+  const before = () => {
+    if (!dropPending) return {};
+    dropPending = false;
+    return { before: dropPt };
+  };
+  if (props.client) {
+    emit(
+      {
+        name: "paragraph",
+        props: {
+          text: props.client,
+          keepNext: true,
+          spacing: { ...before(), after: 4 },
+          ...roleProps(theme, "eyebrow", FALLBACK_EYEBROW_FONT)
+        }
+      },
+      { "/props/text": "/props/client" }
+    );
+  }
+  const titleRole = recipe?.type && hasStyle(theme, recipe.type) ? recipe.type : "title";
+  emit(
+    {
+      name: "paragraph",
+      props: {
+        text: props.title,
+        keepNext: true,
+        ...dropPending && { spacing: before() },
+        ...roleProps(theme, titleRole, { size: 26, bold: true }, recipe?.color)
+      }
+    },
+    { "/props/text": "/props/title" }
+  );
+  if (props.subtitle) {
+    emit(
+      {
+        name: "paragraph",
+        props: {
+          text: props.subtitle,
+          keepNext: true,
+          ...roleProps(theme, "subtitle", { size: 13, color: "textSecondary" })
+        }
+      },
+      { "/props/text": "/props/subtitle" }
+    );
+  }
+  const meta = [props.date, props.confidentiality].filter(
+    (part) => typeof part === "string" && part !== ""
+  );
+  if (meta.length > 0) {
+    emit(
+      {
+        name: "paragraph",
+        props: {
+          text: meta.join("  \xB7  "),
+          spacing: { before: padPt, after: 0 },
+          ...roleProps(theme, "label", FALLBACK.metaFont)
+        }
+      },
+      {
+        "/props/text": props.date ? "/props/date" : "/props/confidentiality"
+      }
+    );
+  }
+  return { children, sourceMap };
+}
+
+// src/blocks/keyTakeaways.ts
 var KEY_TAKEAWAYS_DEFAULT_LABEL = "Key takeaways";
 var FALLBACK_RECIPE = {
   ruleWeightPt: 1.5,
@@ -8470,13 +8626,9 @@ var FALLBACK_RECIPE = {
 function compileKeyTakeaways(props, theme) {
   const recipe = theme.chrome?.keyTakeaways;
   const labelRole = recipe?.type ?? FALLBACK_RECIPE.type;
-  const labelStyle = theme.styles?.[labelRole];
-  const ruleWeightPt = Math.min(
-    MAX_RULE_PT,
-    Math.max(
-      MIN_RULE_PT,
-      recipe?.rule?.weightPt ?? FALLBACK_RECIPE.ruleWeightPt
-    )
+  const labelStyle = hasStyle(theme, labelRole);
+  const ruleWeightPt = clampRule(
+    recipe?.rule?.weightPt ?? FALLBACK_RECIPE.ruleWeightPt
   );
   const ruleColor = recipe?.rule?.color ?? recipe?.color ?? FALLBACK_RECIPE.ruleColor;
   const padPt = recipe?.padPt ?? FALLBACK_RECIPE.padPt;
@@ -8531,10 +8683,195 @@ function compileKeyTakeaways(props, theme) {
   };
 }
 
+// src/blocks/runningHead.ts
+init_styles();
+init_widthUtils();
+var FALLBACK2 = {
+  headFont: { size: 8, color: "textMuted", case: "upper" },
+  footFont: { size: 8, color: "textMuted" },
+  ruleWeightPt: 0.5,
+  ruleColor: "border"
+};
+var PAGE_OF_TOTAL = "{PAGE} / {TOTAL_PAGES}";
+function sectionMeasureTwips(theme, page) {
+  if (!page || page.size === void 0 && page.margins === void 0) {
+    return getAvailableWidthTwips(theme);
+  }
+  const width = page.size ? getPageDimensions(page.size).width : getPageDimensions(theme.page.size).width;
+  const margins = getDocumentMargins(theme);
+  const left = page.margins?.left ?? margins.left ?? 1440;
+  const right = page.margins?.right ?? margins.right ?? 1440;
+  return Math.max(0, width - left - right);
+}
+function compileRunningHead(props, theme, scope) {
+  const measure = sectionMeasureTwips(theme, scope.page);
+  const head = theme.chrome?.runningHead;
+  const foot = theme.chrome?.confidentialFooter;
+  const slot = (name) => props[name] !== void 0 ? `${scope.block}/props/${name}` : void 0;
+  const header = [];
+  const headerMap = {};
+  const title = props.title ?? scope.documentTitle ?? "";
+  const tracker = scope.opener?.text ?? props.tracker ?? "";
+  if (title !== "" || tracker !== "") {
+    const both = title !== "" && tracker !== "";
+    header.push({
+      name: "paragraph",
+      props: {
+        text: both ? `${title}	${tracker}` : title || tracker,
+        ...both ? { tabStops: [{ type: "right", position: measure }] } : { alignment: title !== "" ? "left" : head?.alignment ?? "right" },
+        spacing: { before: 0, after: 0 },
+        ...roleProps(
+          theme,
+          head?.type ?? "tracker",
+          FALLBACK2.headFont,
+          head?.color
+        )
+      }
+    });
+    headerMap["/0"] = scope.block;
+    headerMap["/0/props/text"] = (tracker !== "" ? scope.opener?.slot ?? slot("tracker") : slot("title")) ?? scope.block;
+  }
+  const headRule = head?.rule?.weightPt ?? FALLBACK2.ruleWeightPt;
+  if (headRule > 0) {
+    header.push({
+      name: "divider",
+      props: {
+        thickness: clampRule(headRule),
+        color: head?.rule?.color ?? FALLBACK2.ruleColor,
+        spacing: { before: 2, after: 0 }
+      }
+    });
+    headerMap[`/${header.length - 1}`] = scope.block;
+  }
+  const footer = [];
+  const footerMap = {};
+  const footRule = foot?.rule?.weightPt ?? FALLBACK2.ruleWeightPt;
+  if (footRule > 0) {
+    footer.push({
+      name: "divider",
+      props: {
+        thickness: clampRule(footRule),
+        color: foot?.rule?.color ?? FALLBACK2.ruleColor,
+        spacing: { before: 0, after: 4 }
+      }
+    });
+    footerMap["/0"] = scope.block;
+  }
+  const parts = [
+    props.confidentiality ?? "",
+    props.pageNumbers === false ? "" : PAGE_OF_TOTAL,
+    props.date ?? ""
+  ];
+  const present = parts.filter((part) => part !== "");
+  if (present.length > 0) {
+    const single = present.length === 1;
+    const alignment2 = present[0] === PAGE_OF_TOTAL ? "center" : foot?.alignment ?? "left";
+    footer.push({
+      name: "paragraph",
+      props: {
+        text: single ? present[0] : parts.join("	").replace(/\t+$/, ""),
+        ...single ? { alignment: alignment2 } : {
+          tabStops: [
+            { type: "center", position: Math.round(measure / 2) },
+            { type: "right", position: measure }
+          ]
+        },
+        spacing: { before: 0, after: 0 },
+        ...roleProps(
+          theme,
+          foot?.type ?? "footer",
+          FALLBACK2.footFont,
+          foot?.color
+        )
+      }
+    });
+    const index = footer.length - 1;
+    footerMap[`/${index}`] = scope.block;
+    footerMap[`/${index}/props/text`] = slot("confidentiality") ?? slot("date") ?? scope.block;
+  }
+  return {
+    header: { children: header, sourceMap: headerMap },
+    footer: { children: footer, sourceMap: footerMap }
+  };
+}
+
+// src/blocks/sectionOpener.ts
+function compileSectionOpener(props, theme) {
+  const children = [];
+  const sourceMap = {};
+  const pageBreak = props.pageBreak === true;
+  if (props.number !== void 0) {
+    children.push({
+      name: "paragraph",
+      props: {
+        text: String(props.number),
+        keepNext: true,
+        spacing: { after: 2 },
+        ...pageBreak && { pageBreak: true },
+        ...roleProps(theme, "eyebrow", FALLBACK_EYEBROW_FONT)
+      }
+    });
+    sourceMap["/children/0"] = "";
+    sourceMap["/children/0/props/text"] = "/props/number";
+  }
+  const index = children.length;
+  children.push({
+    name: "heading",
+    props: {
+      text: props.title,
+      level: 1,
+      ...pageBreak && index === 0 && { pageBreak: true }
+    }
+  });
+  sourceMap[`/children/${index}`] = "";
+  sourceMap[`/children/${index}/props/text`] = "/props/title";
+  return { children, sourceMap };
+}
+function sectionTracker(section2) {
+  if (!Array.isArray(section2.children)) return void 0;
+  for (const [index, child] of section2.children.entries()) {
+    if (typeof child !== "object" || child === null || child.name !== "section-opener" || child.enabled === false) {
+      continue;
+    }
+    const props = child.props;
+    if (!props) continue;
+    if (typeof props.tracker === "string" && props.tracker !== "") {
+      return { text: props.tracker, slot: `/children/${index}/props/tracker` };
+    }
+    if (typeof props.title === "string" && props.title !== "") {
+      return { text: props.title, slot: `/children/${index}/props/title` };
+    }
+  }
+  return void 0;
+}
+
 // src/blocks/index.ts
-var BLOCK_NAMES = ["key-takeaways"];
+var BLOCK_NAMES = [
+  "key-takeaways",
+  "cover",
+  "section-opener",
+  "running-head"
+];
+function slotBudget(block2, props, pointer, slot, maxWords) {
+  const value = props[slot];
+  return typeof value === "string" ? [
+    {
+      block: block2,
+      slot,
+      path: `${pointer}/props/${slot}`,
+      words: wordCount(value),
+      maxWords
+    }
+  ] : [];
+}
+function budgetsOf(block2, budget) {
+  return (props, pointer) => Object.entries(budget).flatMap(
+    ([slot, { maxWords }]) => slotBudget(block2, props, pointer, slot, maxWords)
+  );
+}
 var BLOCKS = {
   "key-takeaways": {
+    kind: "flow",
     compile: (props, theme) => compileKeyTakeaways(props, theme),
     budgets: (props, pointer) => (Array.isArray(props.items) ? props.items : []).flatMap(
       (item, index) => typeof item === "string" ? [
@@ -8547,25 +8884,95 @@ var BLOCKS = {
         }
       ] : []
     )
+  },
+  cover: {
+    kind: "flow",
+    compile: (props, theme) => compileCover(props, theme),
+    budgets: budgetsOf("cover", COVER_BUDGET)
+  },
+  "section-opener": {
+    kind: "flow",
+    compile: (props, theme) => compileSectionOpener(props, theme),
+    budgets: budgetsOf("section-opener", SECTION_OPENER_BUDGET)
+  },
+  "running-head": {
+    kind: "chrome",
+    budgets: budgetsOf("running-head", RUNNING_HEAD_BUDGET)
   }
 };
 function isBlockName(name) {
   return BLOCK_NAMES.includes(name);
 }
+function isChromeBlockName(name) {
+  return isBlockName(name) && BLOCKS[name].kind === "chrome";
+}
 function isRecord(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
+var SECTION_CHILD = /^\/children\/\d+\/children\/\d+$/;
+var SECTION = /^\/children\/(\d+)$/;
+function planChrome(document, theme) {
+  const plans = /* @__PURE__ */ new Map();
+  if (!isRecord(document) || document.name !== "docx" || !Array.isArray(document.children)) {
+    return plans;
+  }
+  const metadata = isRecord(document.props) ? document.props.metadata : void 0;
+  const documentTitle = isRecord(metadata) && typeof metadata.title === "string" ? metadata.title : void 0;
+  let inForce;
+  document.children.forEach((section2, index) => {
+    if (!isRecord(section2) || section2.name !== "section" || section2.enabled === false) {
+      return;
+    }
+    const sectionPointer = `/children/${index}`;
+    const children = Array.isArray(section2.children) ? section2.children : [];
+    children.forEach((child, childIndex) => {
+      if (isRecord(child) && isChromeBlockName(child.name) && child.enabled !== false) {
+        inForce = {
+          block: `${sectionPointer}/children/${childIndex}`,
+          props: isRecord(child.props) ? child.props : {}
+        };
+      }
+    });
+    if (!inForce) return;
+    const opener = sectionTracker(section2);
+    const sectionProps = isRecord(section2.props) ? section2.props : {};
+    plans.set(
+      index,
+      compileRunningHead(inForce.props, theme, {
+        block: inForce.block,
+        documentTitle,
+        ...opener && {
+          opener: {
+            text: opener.text,
+            slot: `${sectionPointer}${opener.slot}`
+          }
+        },
+        ...isRecord(sectionProps.page) && {
+          page: sectionProps.page
+        }
+      })
+    );
+  });
+  return plans;
+}
 function expandBlocks(document, theme) {
   const sourceMap = {};
   const blocks = [];
+  const chrome = planChrome(document, theme);
   const walk2 = (node, pointer) => {
     if (Array.isArray(node)) {
       return node.map((child, index) => walk2(child, `${pointer}/${index}`));
     }
     if (!isRecord(node)) return node;
-    if (typeof node.name === "string" && isRecord(node.props)) {
-      if (node.enabled !== false && isBlockName(node.name)) {
-        const compiled = BLOCKS[node.name].compile(node.props, theme);
+    if (typeof node.name === "string" && node.enabled !== false && isBlockName(node.name)) {
+      const definition = BLOCKS[node.name];
+      if (definition.kind === "chrome") {
+        if (!SECTION_CHILD.test(pointer)) return node;
+        blocks.push(pointer);
+        return { ...node, children: [] };
+      }
+      if (isRecord(node.props)) {
+        const compiled = definition.compile(node.props, theme);
         blocks.push(pointer);
         for (const [emitted, authored] of Object.entries(compiled.sourceMap)) {
           sourceMap[`${pointer}${emitted}`] = `${pointer}${authored}`;
@@ -8614,6 +9021,30 @@ function expandBlocks(document, theme) {
     if (Array.isArray(node.children)) {
       next.children = walk2(node.children, `${pointer}/children`);
     }
+    const section2 = SECTION.exec(pointer);
+    if (section2 && node.name === "section" && node.enabled !== false) {
+      const plan = chrome.get(Number(section2[1]));
+      if (plan) {
+        const props = isRecord(next.props) ? { ...next.props } : {};
+        let changed = false;
+        for (const part of ["header", "footer"]) {
+          const { children, sourceMap: partMap } = plan[part];
+          if (props[part] !== void 0 || children.length === 0) continue;
+          props[part] = children;
+          changed = true;
+          const base = `${pointer}/props/${part}`;
+          sourceMap[base] = partMap["/0"] ?? pointer;
+          for (const [emitted, authored] of Object.entries(partMap)) {
+            sourceMap[`${base}${emitted}`] = authored;
+          }
+        }
+        if (props.pageBreak === void 0) {
+          props.pageBreak = true;
+          changed = true;
+        }
+        if (changed) next.props = props;
+      }
+    }
     return next;
   };
   const expanded = walk2(document, "");
@@ -8955,33 +9386,47 @@ function compileChromeParagraph(component, scope) {
   const text = String(props.text ?? "");
   if (reportUnlowered(component, props, text, scope)) return [];
   const font = props.font ?? {};
-  const normal = getNormalStyle(ctx.theme);
+  const named = chromeStyle(ctx.theme, props.themeStyle);
+  const base = { ...getNormalStyle(ctx.theme), ...named };
+  const styleId = named ? paragraphStyleId(props.themeStyle) ?? "Normal" : "Normal";
+  if (styleId !== "Normal" && !ctx.styleIds.has(styleId)) {
+    ctx.styleIds.add(styleId);
+  }
   const chromeProps = {
     text,
-    ...props.alignment ? { alignment: props.alignment } : {},
+    ...named ? { themeStyle: props.themeStyle } : {},
+    ...props.alignment ? { alignment: props.alignment } : named?.alignment ? { alignment: named.alignment } : {},
     ...props.spacing ? { spacing: props.spacing } : {},
+    ...props.indent ? { indent: props.indent } : {},
+    ...props.tabStops ? { tabStops: props.tabStops } : {},
     ...props.boldColor ? { boldColor: props.boldColor } : {},
     font: {
-      family: font.family || resolveFontFamily(ctx.theme, normal.font) || getThemeFonts(ctx.theme).body.family,
-      size: font.size ?? normal.size ?? 11,
-      color: font.color || normal.color || "textPrimary",
-      bold: font.bold ?? false,
-      italic: font.italic ?? false,
+      family: font.family || resolveFontFamily(ctx.theme, base.font) || getThemeFonts(ctx.theme).body.family,
+      size: font.size ?? base.size ?? 11,
+      color: font.color || base.color || "textPrimary",
+      bold: font.bold ?? base.bold ?? false,
+      italic: font.italic ?? base.italic ?? false,
       ...font.underline !== void 0 ? { underline: font.underline } : {},
-      ...font.fontWeight !== void 0 ? { fontWeight: font.fontWeight } : {},
-      ...font.case !== void 0 ? { case: font.case } : {},
+      ...(font.fontWeight ?? base.fontWeight) !== void 0 ? { fontWeight: font.fontWeight ?? base.fontWeight } : {},
+      ...(font.case ?? base.case) !== void 0 ? { case: font.case ?? base.case } : {},
+      ...(font.characterSpacing ?? base.characterSpacing) !== void 0 ? { characterSpacing: font.characterSpacing ?? base.characterSpacing } : {},
       ...font.lineSpacing !== void 0 ? { lineSpacing: font.lineSpacing } : {}
     }
   };
   return [
     paragraphNode(scope, compileRuns(chromeProps, text, ctx, scope.path), {
-      styleId: "Normal",
+      styleId,
       formatting: paragraphFormatting(chromeProps, ctx, {
         alwaysSpacing: true
       })
     })
   ];
 }
+function chromeStyle(theme, themeStyle) {
+  if (typeof themeStyle !== "string" || !themeStyle) return void 0;
+  const styles = getThemeStyles(theme);
+  return styles[themeStyle] ?? styles[themeStyle.toLowerCase()];
+}
 function compileChromeImage(component, scope) {
   const { ctx, path: path4 } = scope;
   const props = component.props ?? {};
@@ -9081,8 +9526,8 @@ function compileComponent(component, scope) {
   }
 }
 function compileBlock(component, scope) {
-  const children = component.children ?? [];
-  if (children.length === 0) {
+  const children = component.children;
+  if (!Array.isArray(children)) {
     scope.ctx.unsupported.push({ name: component.name, path: scope.path });
     return [];
   }
@@ -14970,7 +15415,10 @@ export {
   analyzeDocxQuality,
   blockSlotBudgets,
   cleanComponentProps,
+  compileCover,
   compileKeyTakeaways,
+  compileRunningHead,
+  compileSectionOpener,
   consultingTheme,
   createComponent,
   createDocumentGenerator,
@@ -15001,6 +15449,7 @@ export {
   getExampleNames,
   getVisualPrepassStats,
   hasNodeBuiltins,
+  isChromeBlockName,
   isColumnsComponent,
   isDocxRendererId,
   isHeadingComponent,
@@ -15024,6 +15473,8 @@ export {
   resetVisualPrepassStats,
   resolveDocxQualityProfile,
   runExample,
+  sectionMeasureTwips,
+  sectionTracker,
   themes,
   toAuthoredPointer,
   validateComponentProps,