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

package/dist/index.d.ts

@@ -15,6 +15,6 @@ export { examples, getExample, getExampleNames, loadJsonExample, } from './templ
 export { runExample } from './utils/exampleRunner';
 import './components/index';
 export type { ChartGenerationResult, } from './components/highcharts';
-export { createComponent, createVersion, createDocumentGenerator, validateComponentProps, validateDocument, cleanComponentProps, ComponentValidationError, generatePluginDocumentSchema, exportPluginSchema, generateComponentSchemas, mergeSchemas, type CustomComponent, type ComponentVersion, type ComponentVersionMap, type RenderFunction, type RenderContext as ComponentRenderContext, type DocumentGenerator, type DocumentGeneratorOptions, type GenerationResult, type BufferGenerationResult, type FileGenerationResult, type ValidationResult, type ValidationError, type ExtractCustomComponentType, type CustomComponentUnion, type ExtendedComponentDefinition, type ExtendedReportComponent, type InferCustomComponents, } from './plugin/index';
+export { createComponent, createVersion, createDocumentGenerator, validateComponentProps, validateDocument, cleanComponentProps, ComponentValidationError, UnknownPreservedComponentError, generatePluginDocumentSchema, exportPluginSchema, generateComponentSchemas, mergeSchemas, type CustomComponent, type ComponentVersion, type ComponentVersionMap, type RenderFunction, type RenderContext as ComponentRenderContext, type DocumentGenerator, type DocumentGeneratorOptions, type GenerateOptions, type GenerateFileOptions, type GenerationResult, type BufferGenerationResult, type FileGenerationResult, type ValidationResult, type ValidationError, type ExtractCustomComponentType, type CustomComponentUnion, type ExtendedComponentDefinition, type ExtendedReportComponent, type InferCustomComponents, } from './plugin/index';
 export type { PluginComponent, PluginRenderFunction, PluginValidationError, PluginValidationResult, } from './types/plugin';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,wBAAgB,cAAc,IAAI,MAAM,CAEvC;AAGD,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,kBAAkB,EAClB,2BAA2B,EAC3B,YAAY,EACZ,eAAe,EACf,iBAAiB,IAAI,qBAAqB,GAC3C,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACrB,YAAY,EACZ,uBAAuB,EAEvB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EACzB,KAAK,+BAA+B,EACpC,KAAK,eAAe,GACrB,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAK9B,OAAO,EAEL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,GACtB,MAAM,eAAe,CAAC;AAGvB,YAAY,EAEV,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,GACd,MAAM,eAAe,CAAC;AAGvB,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,EACL,wBAAwB,EACxB,kBAAkB,GACnB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EACL,MAAM,EACN,YAAY,EACZ,cAAc,EACd,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,QAAQ,EACR,UAAU,EACV,eAAe,EACf,eAAe,GAChB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAGnD,OAAO,oBAAoB,CAAC;AAG5B,YAAY,EAEV,qBAAqB,GACtB,MAAM,yBAAyB,CAAC;AAMjC,OAAO,EAEL,eAAe,EACf,aAAa,EACb,uBAAuB,EAGvB,sBAAsB,EACtB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EAGxB,4BAA4B,EAC5B,kBAAkB,EAClB,wBAAwB,EACxB,YAAY,EAGZ,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,aAAa,IAAI,sBAAsB,EAC5C,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EAGpB,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,GAC3B,MAAM,gBAAgB,CAAC;AAGxB,YAAY,EACV,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,wBAAgB,cAAc,IAAI,MAAM,CAEvC;AAGD,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,kBAAkB,EAClB,2BAA2B,EAC3B,YAAY,EACZ,eAAe,EACf,iBAAiB,IAAI,qBAAqB,GAC3C,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACrB,YAAY,EACZ,uBAAuB,EAEvB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EACzB,KAAK,+BAA+B,EACpC,KAAK,eAAe,GACrB,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAK9B,OAAO,EAEL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,GACtB,MAAM,eAAe,CAAC;AAGvB,YAAY,EAEV,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,GACd,MAAM,eAAe,CAAC;AAGvB,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,EACL,wBAAwB,EACxB,kBAAkB,GACnB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EACL,MAAM,EACN,YAAY,EACZ,cAAc,EACd,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,QAAQ,EACR,UAAU,EACV,eAAe,EACf,eAAe,GAChB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAGnD,OAAO,oBAAoB,CAAC;AAG5B,YAAY,EAEV,qBAAqB,GACtB,MAAM,yBAAyB,CAAC;AAMjC,OAAO,EAEL,eAAe,EACf,aAAa,EACb,uBAAuB,EAGvB,sBAAsB,EACtB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,8BAA8B,EAG9B,4BAA4B,EAC5B,kBAAkB,EAClB,wBAAwB,EACxB,YAAY,EAGZ,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,aAAa,IAAI,sBAAsB,EAC5C,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EAGpB,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,GAC3B,MAAM,gBAAgB,CAAC;AAGxB,YAAY,EACV,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -7268,7 +7268,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, {
@@ -7335,6 +7336,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 as Type2 } from "@sinclair/typebox";
 import { latestVersion } from "@json-to-office/shared-docx";
@@ -7510,17 +7514,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);
@@ -7543,12 +7549,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) => {
@@ -7568,15 +7576,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) {
@@ -7591,20 +7605,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) {
@@ -7629,8 +7649,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,
@@ -7654,14 +7690,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);
@@ -7670,9 +7707,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) {
@@ -7681,16 +7724,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 Packer2.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 fs6 = await import("fs/promises");
     await fs6.writeFile(outputPath, new Uint8Array(buffer));
-    return { warnings };
+    let preservedOutputPath;
+    if (preservedDefinition !== void 0) {
+      const path4 = await import("path");
+      preservedOutputPath = options?.preservedOutputPath ?? (() => {
+        const ext = path4.extname(outputPath);
+        const base = ext ? outputPath.slice(0, -ext.length) : outputPath;
+        return `${base}-preserved.json`;
+      })();
+      await fs6.writeFile(
+        preservedOutputPath,
+        JSON.stringify(preservedDefinition, null, 2),
+        "utf8"
+      );
+    }
+    return {
+      warnings,
+      standardDefinition,
+      preservedDefinition,
+      preservedOutputPath
+    };
   }
   function getComponentNames() {
     return Array.from(state.componentNames);
@@ -7724,6 +7791,10 @@ function createBuilderImpl(state) {
       };
     }
   }
+  async function getStandardComponentsDefinition(document) {
+    const { standardDefinition } = await generate(document);
+    return standardDefinition;
+  }
   function generateSchema(includeStandardComponents = true) {
     return generatePluginDocumentSchema(
       state.components,
@@ -7737,40 +7808,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 = applyExportMode2({
-        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,
@@ -7816,6 +7853,7 @@ export {
   ThemeFileError,
   ThemeParseError,
   ThemeValidationError,
+  UnknownPreservedComponentError,
   cleanComponentProps,
   clearComponentCache,
   corporateTheme,