@json-to-office/core-docx 0.12.0 → 0.13.0

package/dist/plugin/createDocumentGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createDocumentGenerator.d.ts","sourceRoot":"","sources":["../../src/plugin/createDocumentGenerator.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,WAAW,EAAwB,MAAM,WAAW,CAAC;AAEnE,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAG9E,OAAO,KAAK,EAEV,wBAAwB,EAKzB,MAAM,SAAS,CAAC;AAcjB;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,kEAAkE;IAClE,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,kFAAkF;IAClF,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3C,4CAA4C;IAC5C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,oFAAoF;IACpF,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAseD;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,wBAAwB,GAChC,wBAAwB,CAAC,SAAS,EAAE,CAAC,CAavC"}
+{"version":3,"file":"createDocumentGenerator.d.ts","sourceRoot":"","sources":["../../src/plugin/createDocumentGenerator.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,WAAW,EAAwB,MAAM,WAAW,CAAC;AAEnE,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAG9E,OAAO,KAAK,EAEV,wBAAwB,EAOzB,MAAM,SAAS,CAAC;AAejB;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,kEAAkE;IAClE,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,kFAAkF;IAClF,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3C,4CAA4C;IAC5C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,oFAAoF;IACpF,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAiiBD;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,wBAAwB,GAChC,wBAAwB,CAAC,SAAS,EAAE,CAAC,CAavC"}

package/dist/plugin/example/index.js

@@ -1888,7 +1888,8 @@ import {
 } from "@json-to-office/shared-docx/validation/unified";
 import {
   DuplicateComponentError,
-  ComponentValidationError as ComponentValidationError2
+  ComponentValidationError as ComponentValidationError2,
+  UnknownPreservedComponentError
 } from "@json-to-office/shared/plugin";
 function validateComponentProps(schema, props, componentName) {
   return validateCustomComponentProps(schema.propsSchema, props, {
@@ -1955,6 +1956,9 @@ function getValidatedProps(schema, props) {
 }
 var cleanComponentProps = getValidatedProps;
 
+// src/plugin/createDocumentGenerator.ts
+import { UnknownPreservedComponentError as UnknownPreservedComponentError2 } from "@json-to-office/shared/plugin";
+
 // src/plugin/schema.ts
 import { Type } from "@sinclair/typebox";
 import { latestVersion } from "@json-to-office/shared-docx";
@@ -6829,17 +6833,19 @@ function createBuilderImpl(state) {
     }
     return getThemeWithFallback(themeName);
   }
-  async function processDocumentComponents(components, warningsCollector, resolvedTheme, depth = 0) {
+  async function processDocumentComponents(components, preserveSet, warningsCollector, resolvedTheme, depth = 0) {
     if (depth > 20) {
       throw new Error(
         "Maximum component nesting depth exceeded (20). Check for circular component references."
       );
     }
-    const processedComponents = [];
+    const standardOut = [];
+    const preservedOut = [];
     for (const componentData of components) {
       const componentName = componentData?.name;
       if (!componentName) {
-        processedComponents.push(componentData);
+        standardOut.push(componentData);
+        preservedOut.push(componentData);
         continue;
       }
       const customComponent = componentMap.get(componentName);
@@ -6862,12 +6868,14 @@ function createBuilderImpl(state) {
           );
           let nestedChildren;
           if (componentWithName.children && Array.isArray(componentWithName.children)) {
-            nestedChildren = await processDocumentComponents(
+            const nested = await processDocumentComponents(
               componentWithName.children,
+              preserveSet,
               warningsCollector,
               resolvedTheme,
               depth + 1
             );
+            nestedChildren = nested.standard;
           }
           const versionLabel = componentWithName.version ? `${customComponent.name}@${componentWithName.version}` : customComponent.name;
           const addWarning = (message, context) => {
@@ -6887,15 +6895,21 @@ function createBuilderImpl(state) {
           const resultComponents = Array.isArray(result) ? result : [result];
           const processedResult = await processDocumentComponents(
             resultComponents,
+            preserveSet,
             warningsCollector,
             resolvedTheme,
             depth + 1
           );
-          processedComponents.push(...processedResult);
+          standardOut.push(...processedResult.standard);
+          if (preserveSet && preserveSet.has(componentName)) {
+            preservedOut.push(componentData);
+          } else {
+            preservedOut.push(...processedResult.preserved);
+          }
           if (state.debug) {
             console.log(
               `Processed custom component '${versionLabel}':`,
-              processedResult
+              processedResult.standard
             );
           }
         } catch (error) {
@@ -6910,20 +6924,26 @@ function createBuilderImpl(state) {
         if ("children" in componentData && Array.isArray(componentData.children)) {
           const processedNested = await processDocumentComponents(
             componentData.children,
+            preserveSet,
             warningsCollector,
             resolvedTheme,
             depth + 1
           );
-          processedComponents.push({
+          standardOut.push({
+            ...componentData,
+            children: processedNested.standard
+          });
+          preservedOut.push({
             ...componentData,
-            children: processedNested
+            children: processedNested.preserved
           });
         } else {
-          processedComponents.push(componentData);
+          standardOut.push(componentData);
+          preservedOut.push(componentData);
         }
       }
     }
-    return processedComponents;
+    return { standard: standardOut, preserved: preservedOut };
   }
   function addComponent(component) {
     if (!component.name) {
@@ -6948,8 +6968,24 @@ function createBuilderImpl(state) {
       newState
     );
   }
-  async function generate(document) {
+  function resolvePreserveSet(options) {
+    const list = options?.preserveCustomComponents;
+    if (!list || list.length === 0) {
+      return void 0;
+    }
+    const registered = new Set(state.componentNames);
+    const unknown = list.filter((n) => !registered.has(n));
+    if (unknown.length > 0) {
+      throw new UnknownPreservedComponentError2(
+        unknown,
+        Array.from(state.componentNames)
+      );
+    }
+    return new Set(list);
+  }
+  async function generate(document, options) {
     try {
+      const preserveSet = resolvePreserveSet(options);
       const internalDocument = document;
       validateDocument(
         internalDocument,
@@ -6973,14 +7009,15 @@ function createBuilderImpl(state) {
           context: { code: w.code }
         });
       }
-      const processedComponents = await processDocumentComponents(
+      const processed = await processDocumentComponents(
         mode.doc.children || [],
+        preserveSet,
         warnings,
         modedTheme
       );
       const processedDocument = {
         ...mode.doc,
-        children: processedComponents
+        children: processed.standard
       };
       const [modedDoc] = normalizeDocument(processedDocument);
       await resolveDocumentFonts(modedDoc, modedTheme, state.fonts, warnings);
@@ -6989,9 +7026,15 @@ function createBuilderImpl(state) {
       const generatedDocument = await renderDocument(structure, layout, {
         services: state.services
       });
+      const preservedDefinition = preserveSet ? {
+        ...mode.doc,
+        children: processed.preserved
+      } : void 0;
       return {
         document: generatedDocument,
-        warnings: warnings.length > 0 ? warnings : null
+        warnings: warnings.length > 0 ? warnings : null,
+        standardDefinition: modedDoc,
+        preservedDefinition
       };
     } catch (error) {
       if (state.debug) {
@@ -7000,16 +7043,40 @@ function createBuilderImpl(state) {
       throw error;
     }
   }
-  async function generateBuffer(document) {
-    const { document: doc, warnings } = await generate(document);
+  async function generateBuffer(document, options) {
+    const {
+      document: doc,
+      warnings,
+      standardDefinition,
+      preservedDefinition
+    } = await generate(document, options);
     const buffer = await Packer.toBuffer(doc);
-    return { buffer, warnings };
+    return { buffer, warnings, standardDefinition, preservedDefinition };
   }
-  async function generateFile(document, outputPath) {
-    const { buffer, warnings } = await generateBuffer(document);
+  async function generateFile(document, outputPath, options) {
+    const { buffer, warnings, standardDefinition, preservedDefinition } = await generateBuffer(document, options);
     const fs4 = await import("fs/promises");
     await fs4.writeFile(outputPath, new Uint8Array(buffer));
-    return { warnings };
+    let preservedOutputPath;
+    if (preservedDefinition !== void 0) {
+      const path3 = await import("path");
+      preservedOutputPath = options?.preservedOutputPath ?? (() => {
+        const ext = path3.extname(outputPath);
+        const base = ext ? outputPath.slice(0, -ext.length) : outputPath;
+        return `${base}-preserved.json`;
+      })();
+      await fs4.writeFile(
+        preservedOutputPath,
+        JSON.stringify(preservedDefinition, null, 2),
+        "utf8"
+      );
+    }
+    return {
+      warnings,
+      standardDefinition,
+      preservedDefinition,
+      preservedOutputPath
+    };
   }
   function getComponentNames() {
     return Array.from(state.componentNames);
@@ -7043,6 +7110,10 @@ function createBuilderImpl(state) {
       };
     }
   }
+  async function getStandardComponentsDefinition(document) {
+    const { standardDefinition } = await generate(document);
+    return standardDefinition;
+  }
   function generateSchema(includeStandardComponents = true) {
     return generatePluginDocumentSchema(
       state.components,
@@ -7056,40 +7127,6 @@ function createBuilderImpl(state) {
       options
     );
   }
-  async function getStandardComponentsDefinition(document) {
-    try {
-      const internalDocument = document;
-      validateDocument(
-        internalDocument,
-        state.components
-      );
-      const themeName = internalDocument.props.theme || "minimal";
-      const docTheme = resolveDocumentTheme(themeName);
-      const warnings = [];
-      const mode = applyExportMode({
-        doc: internalDocument,
-        theme: docTheme,
-        fonts: state.fonts
-      });
-      const modedTheme = mode.theme;
-      const processedComponents = await processDocumentComponents(
-        mode.doc.children || [],
-        warnings,
-        modedTheme
-      );
-      const processedDocument = {
-        ...mode.doc,
-        children: processedComponents
-      };
-      const [finalReportComponent] = normalizeDocument(processedDocument);
-      return finalReportComponent;
-    } catch (error) {
-      if (state.debug) {
-        console.error("Error getting standard components definition:", error);
-      }
-      throw error;
-    }
-  }
   return Object.freeze({
     addComponent,
     generate,