@json-to-office/core-docx 0.17.3 → 0.19.0

package/dist/plugin/example/eldermoor-census.component.d.ts

@@ -0,0 +1,32 @@
+import type { ComponentDefinition } from '@json-to-office/shared-docx';
+/**
+ * @example
+ * ```json
+ * {
+ *   "name": "eldermoor-census",
+ *   "props": { "title": "Regno di Valebrook", "manaPct": "51,2%", "castles": "3.120" }
+ * }
+ * ```
+ */
+export declare const eldermoorCensusComponent: import("../createComponent").CustomComponent<ComponentDefinition, {
+    '1.0.0': import("../createComponent").ComponentVersion<ComponentDefinition, import("@sinclair/typebox").TObject<{
+        title: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        manaPct: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        faithfulSubjects: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        swornGuilds: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        mappedTerritoriesPct: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        castles: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        outposts: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        watchtowers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        sovereignTreasury: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        warChest: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        marketMint: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        royalServants: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        servantsLeft: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        servantsRight: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        width: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TString]>>;
+        alignment: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"left">, import("@sinclair/typebox").TLiteral<"center">, import("@sinclair/typebox").TLiteral<"right">]>>;
+        caption: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    }>>;
+}, "eldermoor-census">;
+//# sourceMappingURL=eldermoor-census.component.d.ts.map

package/dist/plugin/example/eldermoor-census.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eldermoor-census.component.d.ts","sourceRoot":"","sources":["../../../src/plugin/example/eldermoor-census.component.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAgNvE;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;sBAwBnC,CAAC"}

package/dist/plugin/example/index.js

@@ -2195,12 +2195,17 @@ function resolveComponentTree(components, theme) {
 async function processDocument(document, theme, themeName) {
   const metadata = createDocumentMetadata(document.props);
   const docDefaults = document.props.componentDefaults;
-  const effectiveTheme = docDefaults ? {
+  const mergedComponentDefaults = docDefaults ? mergeWithDefaults2(docDefaults, theme.componentDefaults || {}) : void 0;
+  const docNoProofWords = document.props.noProofWords;
+  const mergedNoProofWords = docNoProofWords || theme.noProofWords ? Array.from(
+    /* @__PURE__ */ new Set([...theme.noProofWords || [], ...docNoProofWords || []])
+  ) : void 0;
+  const effectiveTheme = mergedComponentDefaults || mergedNoProofWords ? {
     ...theme,
-    componentDefaults: mergeWithDefaults2(
-      docDefaults,
-      theme.componentDefaults || {}
-    )
+    ...mergedComponentDefaults && {
+      componentDefaults: mergedComponentDefaults
+    },
+    ...mergedNoProofWords && { noProofWords: mergedNoProofWords }
   } : theme;
   const context = createRenderContext(
     {
@@ -2222,7 +2227,8 @@ async function processDocument(document, theme, themeName) {
     sections,
     theme: effectiveTheme,
     themeName,
-    trackRevisions: document.props.trackRevisions
+    trackRevisions: document.props.trackRevisions,
+    language: document.props.language
   };
 }
 function createDocumentMetadata(props) {
@@ -2849,6 +2855,16 @@ async function downloadImageFromUrl(url) {
     throw new Error(`Failed to download image from ${url}: Unknown error`);
   }
 }
+function resolveImageSource(props) {
+  const hasValue = (v) => typeof v === "string" && v.trim().length > 0;
+  if (hasValue(props.svg)) {
+    const encoded = Buffer.from(props.svg, "utf-8").toString("base64");
+    return `data:image/svg+xml;base64,${encoded}`;
+  }
+  if (hasValue(props.base64)) return props.base64;
+  if (hasValue(props.path)) return props.path;
+  return void 0;
+}
 async function getImageBuffer(imagePath) {
   if (isBase64Image(imagePath)) {
     return { buffer: decodeBase64Image(imagePath) };
@@ -3076,7 +3092,7 @@ function convertBorders(borders, theme) {
     ...right && { right }
   } : void 0;
 }
-function createWordStyles(themeNameOrObject = "minimal") {
+function createWordStyles(themeNameOrObject = "minimal", language) {
   const theme = typeof themeNameOrObject === "string" ? getTheme(themeNameOrObject) || getTheme("minimal") : themeNameOrObject;
   const paragraphStyles = [
     // Normal body text style
@@ -3534,8 +3550,20 @@ function createWordStyles(themeNameOrObject = "minimal") {
     });
   }
   return {
-    paragraphStyles
+    paragraphStyles,
     // Cast needed due to docx typing
+    // Document-default proofing language (w:docDefaults/w:rPrDefault). Runs that
+    // don't set their own w:lang inherit this, so Word spell-checks the whole
+    // document in the requested language unless a component overrides it.
+    ...language && {
+      default: {
+        document: {
+          run: {
+            language: { value: language }
+          }
+        }
+      }
+    }
   };
 }
 function getStyleIdForLevel(level) {
@@ -3657,6 +3685,37 @@ import {
 
 // src/utils/textParser.ts
 import { TextRun, ExternalHyperlink, InternalHyperlink } from "docx";
+function escapeRegExp(s) {
+  return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+function buildNoProofWordsRegex(noProofWords) {
+  const words = (noProofWords || []).filter((w) => w && w.trim().length > 0);
+  if (words.length === 0) return null;
+  const escaped = words.slice().sort((a, b) => b.length - a.length).map(escapeRegExp);
+  return new RegExp(
+    `(?<![\\p{L}\\p{N}])(?:${escaped.join("|")})(?![\\p{L}\\p{N}])`,
+    "giu"
+  );
+}
+function splitByNoProofWords(text, makeRun, noProofWords) {
+  const regex = buildNoProofWordsRegex(noProofWords);
+  if (!regex || !text) return [makeRun(text, false)];
+  const runs = [];
+  let lastIndex = 0;
+  let match;
+  while ((match = regex.exec(text)) !== null) {
+    if (match.index > lastIndex) {
+      runs.push(makeRun(text.slice(lastIndex, match.index), false));
+    }
+    runs.push(makeRun(match[0], true));
+    lastIndex = match.index + match[0].length;
+    if (regex.lastIndex === match.index) regex.lastIndex++;
+  }
+  if (lastIndex < text.length) {
+    runs.push(makeRun(text.slice(lastIndex), false));
+  }
+  return runs.length > 0 ? runs : [makeRun(text, false)];
+}
 function parseTextWithDecorators(text, baseStyle = {}, options = {}) {
   if (!text) {
     return [new TextRun({ text: "", ...baseStyle })];
@@ -3667,7 +3726,8 @@ function parseTextWithDecorators(text, baseStyle = {}, options = {}) {
     return processTextWithPlaceholders(
       normalizedText,
       baseStyle,
-      options.placeholderContext || {}
+      options.placeholderContext || {},
+      options.noProofWords
     );
   }
   if (options.enableHyperlinks) {
@@ -3738,20 +3798,38 @@ function createTextRunsWithNewlines(text, baseStyle, options, overrideStyle) {
         bold: overrideStyle?.bold ?? baseStyle.bold,
         italics: overrideStyle?.italics ?? baseStyle.italics
       };
-      runs.push(
-        new TextRun({
-          text: line,
-          ...baseStyle.font && { font: baseStyle.font },
-          ...baseStyle.size && { size: baseStyle.size },
-          ...baseStyle.color && {
-            color: runStyle.bold && options.boldColor ? options.boldColor : baseStyle.color
-          },
-          ...runStyle.bold !== void 0 && { bold: runStyle.bold },
-          ...runStyle.italics !== void 0 && { italics: runStyle.italics },
-          ...baseStyle.underline && { underline: baseStyle.underline },
-          ...needsLineBreak && { break: 1 }
-        })
+      const commonProps = {
+        ...baseStyle.font && { font: baseStyle.font },
+        ...baseStyle.size && { size: baseStyle.size },
+        ...baseStyle.color && {
+          color: runStyle.bold && options.boldColor ? options.boldColor : baseStyle.color
+        },
+        ...runStyle.bold !== void 0 && { bold: runStyle.bold },
+        ...runStyle.italics !== void 0 && { italics: runStyle.italics },
+        ...baseStyle.underline && { underline: baseStyle.underline },
+        ...baseStyle.language && { language: baseStyle.language }
+      };
+      const wholeRunNoProof = baseStyle.noProof === true;
+      const wordsForLine = wholeRunNoProof ? void 0 : options.noProofWords;
+      let firstSegment = true;
+      const lineRuns = splitByNoProofWords(
+        line,
+        (segment, matched) => {
+          const segNoProof = matched || wholeRunNoProof;
+          const run = new TextRun({
+            text: segment,
+            ...commonProps,
+            ...(matched || baseStyle.noProof !== void 0) && {
+              noProof: segNoProof
+            },
+            ...needsLineBreak && firstSegment && { break: 1 }
+          });
+          firstSegment = false;
+          return run;
+        },
+        wordsForLine
       );
+      runs.push(...lineRuns);
     }
   }
   return runs;
@@ -3856,7 +3934,7 @@ var PlaceholderRegistry = class {
     this.handlers.clear();
   }
 };
-function processTextWithPlaceholders(text, baseStyle = {}, context = {}) {
+function processTextWithPlaceholders(text, baseStyle = {}, context = {}, noProofWords) {
   const normalizedText = normalizeUnicodeText(text);
   const combinedRegex = /(\*\*\*|___)([\s\S]*?)\1|(\*\*|__)([\s\S]*?)\3|(\*|_)([\s\S]*?)\5|\{([^}]+)\}/g;
   const result = [];
@@ -3866,7 +3944,9 @@ function processTextWithPlaceholders(text, baseStyle = {}, context = {}) {
     if (match.index > lastIndex) {
       const beforeText = normalizedText.substring(lastIndex, match.index);
       if (beforeText) {
-        result.push(...createTextRunsWithNewlines2(beforeText, baseStyle));
+        result.push(
+          ...createTextRunsWithNewlines2(beforeText, baseStyle, noProofWords)
+        );
       }
     }
     if (match[7]) {
@@ -3880,11 +3960,17 @@ function processTextWithPlaceholders(text, baseStyle = {}, context = {}) {
           result.push(placeholderResult);
         } else if (typeof placeholderResult === "string") {
           result.push(
-            ...createTextRunsWithNewlines2(placeholderResult, baseStyle)
+            ...createTextRunsWithNewlines2(
+              placeholderResult,
+              baseStyle,
+              noProofWords
+            )
           );
         }
       } else {
-        result.push(...createTextRunsWithNewlines2(match[0], baseStyle));
+        result.push(
+          ...createTextRunsWithNewlines2(match[0], baseStyle, noProofWords)
+        );
       }
     } else {
       let decoratedText;
@@ -3919,33 +4005,54 @@ function processTextWithPlaceholders(text, baseStyle = {}, context = {}) {
   if (lastIndex < normalizedText.length) {
     const remainingText = normalizedText.substring(lastIndex);
     if (remainingText) {
-      result.push(...createTextRunsWithNewlines2(remainingText, baseStyle));
+      result.push(
+        ...createTextRunsWithNewlines2(remainingText, baseStyle, noProofWords)
+      );
     }
   }
   if (result.length === 0 && normalizedText) {
-    result.push(...createTextRunsWithNewlines2(normalizedText, baseStyle));
+    result.push(
+      ...createTextRunsWithNewlines2(normalizedText, baseStyle, noProofWords)
+    );
   }
   return result;
 }
-function createTextRunsWithNewlines2(text, baseStyle) {
+function createTextRunsWithNewlines2(text, baseStyle, noProofWords) {
   const runs = [];
   const lines = text.split("\n");
   for (let lineIndex = 0; lineIndex < lines.length; lineIndex++) {
     const line = lines[lineIndex];
     const needsLineBreak = lineIndex > 0;
     if (line || needsLineBreak) {
-      runs.push(
-        new TextRun2({
-          text: line,
-          font: baseStyle.font,
-          size: baseStyle.size,
-          color: baseStyle.color,
-          bold: baseStyle.bold,
-          italics: baseStyle.italics,
-          underline: baseStyle.underline,
-          break: needsLineBreak ? 1 : void 0
-        })
+      const commonProps = {
+        font: baseStyle.font,
+        size: baseStyle.size,
+        color: baseStyle.color,
+        bold: baseStyle.bold,
+        italics: baseStyle.italics,
+        underline: baseStyle.underline,
+        ...baseStyle.language && { language: baseStyle.language }
+      };
+      const wholeRunNoProof = baseStyle.noProof === true;
+      const wordsForLine = wholeRunNoProof ? void 0 : noProofWords;
+      let firstSegment = true;
+      const lineRuns = splitByNoProofWords(
+        line,
+        (segment, matched) => {
+          const run = new TextRun2({
+            text: segment,
+            ...commonProps,
+            ...(matched || baseStyle.noProof !== void 0) && {
+              noProof: matched || wholeRunNoProof
+            },
+            break: needsLineBreak && firstSegment ? 1 : void 0
+          });
+          firstSegment = false;
+          return run;
+        },
+        wordsForLine
       );
+      runs.push(...lineRuns);
     }
   }
   return runs;
@@ -4290,6 +4397,11 @@ function applyFontWeightAlias(opts) {
   );
   return { font: synth.family, bold: synth.bold, italics: synth.italic };
 }
+function resolveNoProofWords(theme, optionWords) {
+  const themeWords = theme.noProofWords;
+  const merged = [...themeWords || [], ...optionWords || []];
+  return merged.length > 0 ? Array.from(new Set(merged)) : void 0;
+}
 function createText(content, theme, themeName, options = {}) {
   const normalizedContent = normalizeUnicodeText(content);
   const style = options.style || "Normal";
@@ -4332,7 +4444,11 @@ function createText(content, theme, themeName, options = {}) {
     ...weighted.italics !== void 0 && { italics: weighted.italics },
     ...options.underline !== void 0 && {
       underline: options.underline ? { type: "single" } : void 0
-    }
+    },
+    // Proofing: per-run language and/or no-proof. Omitting language lets the
+    // run inherit the document default set on docDefaults.
+    ...options.language && { language: { value: options.language } },
+    ...options.noProof !== void 0 && { noProof: options.noProof }
   };
   if (options.revision) {
     const revisionRuns = createRevisionRuns(options.revision, baseTextStyle);
@@ -4354,7 +4470,8 @@ function createText(content, theme, themeName, options = {}) {
   } else {
     const textRuns = parseTextWithDecorators(normalizedContent, baseTextStyle, {
       boldColor: options.boldColor,
-      enableHyperlinks: true
+      enableHyperlinks: true,
+      noProofWords: resolveNoProofWords(theme, options.noProofWords)
     });
     if (options.bookmarkId) {
       globalBookmarkRegistry.register(
@@ -4489,8 +4606,21 @@ function createHeading(text, level, theme, _themeName, options = {}) {
     },
     ...options.underline !== void 0 && {
       underline: options.underline ? { type: "single" } : void 0
-    }
+    },
+    // Proofing: per-run language and/or no-proof (see createText).
+    ...options.language && { language: { value: options.language } },
+    ...options.noProof !== void 0 && { noProof: options.noProof }
   };
+  const headingNoProofWords = resolveNoProofWords(theme, options.noProofWords);
+  const makeHeadingRuns = (value) => splitByNoProofWords(
+    value,
+    (segment, matched) => new TextRun4({
+      text: segment,
+      ...baseTextStyle,
+      ...matched && { noProof: true }
+    }),
+    headingNoProofWords
+  );
   if (options.revision) {
     const revisionRuns = createRevisionRuns(options.revision, baseTextStyle);
     if (options.bookmarkId) {
@@ -4518,13 +4648,12 @@ function createHeading(text, level, theme, _themeName, options = {}) {
     if (hasDecorators) {
       const textRuns = parseTextWithDecorators(normalizedText, baseTextStyle, {
         boldColor: options.boldColor,
-        enableHyperlinks: true
+        enableHyperlinks: true,
+        noProofWords: headingNoProofWords
       });
       headingTextChildren.push(...textRuns);
     } else {
-      headingTextChildren.push(
-        new TextRun4({ text: normalizedText, ...baseTextStyle })
-      );
+      headingTextChildren.push(...makeHeadingRuns(normalizedText));
     }
     children.push(
       new Bookmark({
@@ -4536,11 +4665,12 @@ function createHeading(text, level, theme, _themeName, options = {}) {
     if (hasDecorators) {
       const textRuns = parseTextWithDecorators(normalizedText, baseTextStyle, {
         boldColor: options.boldColor,
-        enableHyperlinks: true
+        enableHyperlinks: true,
+        noProofWords: headingNoProofWords
       });
       children.push(...textRuns);
     } else {
-      children.push(new TextRun4({ text: normalizedText, ...baseTextStyle }));
+      children.push(...makeHeadingRuns(normalizedText));
     }
   }
   return new Paragraph({
@@ -5066,10 +5196,10 @@ async function createTable(columns, tableConfig, theme, themeName, _options = {}
       } else if (isImageComponent(cell)) {
         const imageComp = cell;
         try {
-          const imageSource = imageComp.props.base64 || imageComp.props.path;
+          const imageSource = resolveImageSource(imageComp.props);
           if (!imageSource) {
             throw new Error(
-              'Image component requires either "path" or "base64" property'
+              'Image component requires one of "path", "base64", or "svg" property'
             );
           }
           const imageResult = await getImageBuffer(imageSource);
@@ -5095,7 +5225,7 @@ async function createTable(columns, tableConfig, theme, themeName, _options = {}
           });
           cellChildren = [imageRun];
         } catch (error) {
-          const imageSource = imageComp.props.base64 || imageComp.props.path || "unknown";
+          const imageSource = imageComp.props.svg?.trim() ? "inline-svg" : imageComp.props.base64 || imageComp.props.path || "unknown";
           cellChildren = [
             new TextRun4({
               text: `[IMAGE: ${imageSource.substring(0, 50)}${imageSource.length > 50 ? "..." : ""}]`,
@@ -5503,6 +5633,10 @@ function renderHeadingComponent(component, theme, themeName) {
       fontWeight: config.font?.fontWeight,
       italic: config.font?.italic,
       underline: config.font?.underline,
+      // Proofing: local language override + no-proof toggle + known-words list
+      language: config.language,
+      noProof: config.noProof,
+      noProofWords: config.noProofWords,
       // Pagination control
       keepNext: config.keepNext,
       keepLines: config.keepLines,
@@ -5621,6 +5755,10 @@ function renderParagraphComponent(component, theme, themeName) {
     fontWeight: resolvedConfig.font?.fontWeight,
     italic: resolvedConfig.font?.italic,
     underline: resolvedConfig.font?.underline,
+    // Proofing: local language override + no-proof toggle + known-words list
+    language: resolvedConfig.language,
+    noProof: resolvedConfig.noProof,
+    noProofWords: resolvedConfig.noProofWords,
     // Pass outline level for TOC support
     outlineLevel,
     // Pass floating positioning properties
@@ -5772,10 +5910,10 @@ function renderListComponent(component, theme, themeName) {
 async function renderImageComponent(component, theme, themeName) {
   if (!isImageComponent(component)) return [];
   const resolvedConfig = component.props;
-  const imageSource = resolvedConfig.base64 || resolvedConfig.path;
+  const imageSource = resolveImageSource(resolvedConfig);
   if (!imageSource) {
     throw new Error(
-      'Image component requires either "path" or "base64" property'
+      'Image component requires one of "path", "base64", or "svg" property'
     );
   }
   return await createImage(imageSource, theme, themeName, {
@@ -6457,7 +6595,10 @@ async function generateChart(config, servicesConfig) {
     infile: config.options,
     type: "png",
     b64: true,
-    scale: config.scale
+    scale: config.scale,
+    // Forward resources verbatim only when present so the payload stays
+    // byte-identical to before for callers that omit it.
+    ...config.resources ? { resources: config.resources } : {}
   };
   const response = await postJsonToService({
     url: serverUrl,
@@ -6744,7 +6885,7 @@ async function renderDocument(structure, layout, options) {
   }
   const numberingConfigs = globalNumberingRegistry2.getAll();
   return new Document({
-    styles: createWordStyles(structure.theme),
+    styles: createWordStyles(structure.theme, structure.language),
     sections,
     features: {
       updateFields: true,
@@ -6795,13 +6936,13 @@ async function renderHeaderFooterComponents(components, theme, themeName, contex
       );
     } else if (isImageComponent(component)) {
       const imageComp = component;
-      let imageSource = imageComp.props.base64 || imageComp.props.path;
+      let imageSource = resolveImageSource(imageComp.props);
       if (!imageSource) {
         elements.push(
           new Paragraph7({
             children: [
               new TextRun6({
-                text: "[IMAGE: Missing path or base64 property]",
+                text: "[IMAGE: Missing path, base64, or svg property]",
                 font: getThemeFonts(theme).body.family,
                 size: 20,
                 bold: true,
@@ -6875,15 +7016,16 @@ async function renderHeaderFooterComponents(components, theme, themeName, contex
           })
         );
       } catch (error) {
+        const sourcePreview = imageSource.substring(0, 50);
         console.error(
-          `[Header/Footer Image Error] Failed to render image: ${imageComp.props.path?.substring(0, 50)}...`,
+          `[Header/Footer Image Error] Failed to render image: ${sourcePreview}...`,
           error instanceof Error ? error.message : error
         );
         elements.push(
           new Paragraph7({
             children: [
               new TextRun6({
-                text: `[IMAGE: ${imageComp.props.path}]`,
+                text: `[IMAGE: ${sourcePreview}]`,
                 font: getThemeFonts(theme).body.family,
                 size: 20,
                 color: getThemeColors(theme).secondary,