@json-to-office/shared-docx 0.6.0 → 0.8.0

package/dist/chunk-S5KMAUDZ.js

@@ -0,0 +1,645 @@
+import {
+  ColumnsPropsSchema,
+  ComponentDefaultsSchema,
+  FloatingPropertiesSchema,
+  HeadingPropsSchema,
+  ImagePropsSchema,
+  ListPropsSchema,
+  ParagraphPropsSchema,
+  SectionPropsSchema,
+  StatisticPropsSchema,
+  TablePropsSchema,
+  createSectionPropsSchema,
+  createTablePropsSchema
+} from "./chunk-F5IGGVWN.js";
+import {
+  HexColorSchema
+} from "./chunk-JOXJOD2C.js";
+
+// src/schemas/component-registry.ts
+import { Type as Type5 } from "@sinclair/typebox";
+
+// src/schemas/components/report.ts
+import { Type } from "@sinclair/typebox";
+var createReportPropsSchema = (_moduleRef) => Type.Object(
+  {
+    theme: Type.Optional(
+      Type.String({
+        description: 'Theme name to apply (default: "minimal")',
+        examples: ["minimal", "corporate", "modern"],
+        default: "minimal"
+      })
+    ),
+    componentDefaults: Type.Optional(ComponentDefaultsSchema),
+    metadata: Type.Optional(
+      Type.Object(
+        {
+          title: Type.Optional(
+            Type.String({
+              description: "Document title",
+              examples: ["Annual Report 2024", "Technical Documentation"]
+            })
+          ),
+          subtitle: Type.Optional(
+            Type.String({
+              description: "Document subtitle"
+            })
+          ),
+          description: Type.Optional(Type.String()),
+          author: Type.Optional(Type.String()),
+          company: Type.Optional(Type.String()),
+          date: Type.Optional(Type.String()),
+          created: Type.Optional(Type.String({ format: "date-time" })),
+          modified: Type.Optional(Type.String({ format: "date-time" })),
+          version: Type.Optional(Type.String()),
+          tags: Type.Optional(Type.Array(Type.String()))
+        },
+        {
+          description: "Document metadata (title, author, company, dates, etc.)",
+          additionalProperties: false
+        }
+      )
+    )
+  },
+  {
+    description: "Report component props",
+    additionalProperties: false
+  }
+);
+var ReportPropsSchema = createReportPropsSchema();
+
+// src/schemas/components/text-box.ts
+import { Type as Type2 } from "@sinclair/typebox";
+var TextBoxPropsSchema = Type2.Object(
+  {
+    width: Type2.Optional(
+      Type2.Union(
+        [
+          Type2.Number({
+            minimum: 1,
+            description: "Text box width in pixels"
+          }),
+          Type2.String({
+            pattern: "^\\d+(\\.\\d+)?%$",
+            description: 'Text box width as percentage (e.g., "50%") relative to content width'
+          })
+        ],
+        {
+          description: 'Text box width in pixels (number) or as percentage string (e.g., "50%")'
+        }
+      )
+    ),
+    height: Type2.Optional(
+      Type2.Union(
+        [
+          Type2.Number({
+            minimum: 1,
+            description: "Text box height in pixels"
+          }),
+          Type2.String({
+            pattern: "^\\d+(\\.\\d+)?%$",
+            description: 'Text box height as percentage (e.g., "50%") relative to content height'
+          })
+        ],
+        {
+          description: 'Text box height in pixels (number) or as percentage string (e.g., "50%")'
+        }
+      )
+    ),
+    floating: Type2.Optional(FloatingPropertiesSchema),
+    style: Type2.Optional(
+      Type2.Object(
+        {
+          padding: Type2.Optional(
+            Type2.Object(
+              {
+                top: Type2.Optional(Type2.Number({ minimum: 0 })),
+                right: Type2.Optional(Type2.Number({ minimum: 0 })),
+                bottom: Type2.Optional(Type2.Number({ minimum: 0 })),
+                left: Type2.Optional(Type2.Number({ minimum: 0 }))
+              },
+              { additionalProperties: false }
+            )
+          ),
+          border: Type2.Optional(
+            Type2.Object(
+              {
+                top: Type2.Optional(
+                  // Reuse border schema semantics: style/width/color
+                  Type2.Object({
+                    style: Type2.Optional(
+                      Type2.Union([
+                        Type2.Literal("solid"),
+                        Type2.Literal("dashed"),
+                        Type2.Literal("dotted"),
+                        Type2.Literal("double"),
+                        Type2.Literal("none")
+                      ])
+                    ),
+                    width: Type2.Optional(Type2.Number({ minimum: 0 })),
+                    color: Type2.Optional(HexColorSchema)
+                  })
+                ),
+                right: Type2.Optional(
+                  Type2.Object({
+                    style: Type2.Optional(
+                      Type2.Union([
+                        Type2.Literal("solid"),
+                        Type2.Literal("dashed"),
+                        Type2.Literal("dotted"),
+                        Type2.Literal("double"),
+                        Type2.Literal("none")
+                      ])
+                    ),
+                    width: Type2.Optional(Type2.Number({ minimum: 0 })),
+                    color: Type2.Optional(HexColorSchema)
+                  })
+                ),
+                bottom: Type2.Optional(
+                  Type2.Object({
+                    style: Type2.Optional(
+                      Type2.Union([
+                        Type2.Literal("solid"),
+                        Type2.Literal("dashed"),
+                        Type2.Literal("dotted"),
+                        Type2.Literal("double"),
+                        Type2.Literal("none")
+                      ])
+                    ),
+                    width: Type2.Optional(Type2.Number({ minimum: 0 })),
+                    color: Type2.Optional(HexColorSchema)
+                  })
+                ),
+                left: Type2.Optional(
+                  Type2.Object({
+                    style: Type2.Optional(
+                      Type2.Union([
+                        Type2.Literal("solid"),
+                        Type2.Literal("dashed"),
+                        Type2.Literal("dotted"),
+                        Type2.Literal("double"),
+                        Type2.Literal("none")
+                      ])
+                    ),
+                    width: Type2.Optional(Type2.Number({ minimum: 0 })),
+                    color: Type2.Optional(HexColorSchema)
+                  })
+                )
+              },
+              { additionalProperties: false }
+            )
+          ),
+          shading: Type2.Optional(
+            Type2.Object(
+              {
+                fill: Type2.Optional(Type2.String())
+              },
+              { additionalProperties: false }
+            )
+          )
+        },
+        { additionalProperties: false }
+      )
+    )
+  },
+  { additionalProperties: false }
+);
+
+// src/schemas/components/toc.ts
+import { Type as Type3 } from "@sinclair/typebox";
+var TocStyleSchema = Type3.Union(
+  [Type3.Literal("numeric"), Type3.Literal("bullet"), Type3.Literal("none")],
+  { description: "TOC numbering style" }
+);
+var TocScopeSchema = Type3.Union(
+  [Type3.Literal("document"), Type3.Literal("section")],
+  { description: "TOC scope: document-wide or section-only" }
+);
+var TocStyleMappingSchema = Type3.Object(
+  {
+    styleId: Type3.String({
+      description: "Custom style ID matching a key in theme.styles"
+    }),
+    level: Type3.Number({
+      minimum: 1,
+      maximum: 6,
+      description: "TOC level (1-6) to assign to this style"
+    })
+  },
+  {
+    description: "Mapping of custom style to TOC level",
+    additionalProperties: false
+  }
+);
+var TocDepthRangeSchema = Type3.Object(
+  {
+    from: Type3.Optional(
+      Type3.Number({
+        minimum: 1,
+        maximum: 6,
+        default: 1,
+        description: "Starting heading level (1-6). Defaults to 1 if not specified."
+      })
+    ),
+    to: Type3.Optional(
+      Type3.Number({
+        minimum: 1,
+        maximum: 6,
+        default: 3,
+        description: "Ending heading level (1-6). Defaults to 3 if not specified."
+      })
+    )
+  },
+  {
+    description: 'Range of heading levels to include in TOC. Specify at least one of "from" or "to".',
+    additionalProperties: false
+  }
+);
+var TocPropsSchema = Type3.Object(
+  {
+    pageBreak: Type3.Optional(
+      Type3.Boolean({
+        description: "Insert page break before TOC block"
+      })
+    ),
+    depth: Type3.Optional(
+      Type3.Object(
+        {
+          from: Type3.Optional(
+            Type3.Number({
+              minimum: 1,
+              maximum: 6,
+              default: 1,
+              description: "Starting heading level (1-6). Defaults to 1 if not specified."
+            })
+          ),
+          to: Type3.Optional(
+            Type3.Number({
+              minimum: 1,
+              maximum: 6,
+              default: 3,
+              description: "Ending heading level (1-6). Defaults to 3 if not specified."
+            })
+          )
+        },
+        {
+          description: 'Range of heading levels to include in TOC. Specify "from", "to", or both. Defaults: from=1, to=3',
+          additionalProperties: false,
+          default: { to: 3 }
+        }
+      )
+    ),
+    pageNumbersDepth: Type3.Optional(
+      Type3.Object(
+        {
+          from: Type3.Optional(
+            Type3.Number({
+              minimum: 1,
+              maximum: 6,
+              default: 1,
+              description: "Starting heading level (1-6). Defaults to 1 if not specified."
+            })
+          ),
+          to: Type3.Optional(
+            Type3.Number({
+              minimum: 1,
+              maximum: 6,
+              default: 3,
+              description: "Ending heading level (1-6). Defaults to 3 if not specified."
+            })
+          )
+        },
+        {
+          description: 'Range of heading levels to show page numbers. Specify "from", "to", or both. When specified, page numbers are hidden for entries outside this range.',
+          additionalProperties: false
+        }
+      )
+    ),
+    numberingStyle: Type3.Optional(TocStyleSchema),
+    title: Type3.Optional(
+      Type3.String({
+        description: "TOC heading title"
+      })
+    ),
+    includePageNumbers: Type3.Optional(
+      Type3.Boolean({
+        default: true,
+        description: "Show page numbers next to entries"
+      })
+    ),
+    numberSeparator: Type3.Optional(
+      Type3.Boolean({
+        default: true,
+        description: 'Use tab separator between entry and page number. True applies "\\t" (default), false applies " "'
+      })
+    ),
+    scope: Type3.Optional(
+      Type3.Union([TocScopeSchema, Type3.Literal("auto")], {
+        default: "auto",
+        description: 'TOC scope: "document" for entire document, "section" for parent section only, "auto" for automatic detection (section if inside section, otherwise document)'
+      })
+    ),
+    styles: Type3.Optional(
+      Type3.Array(TocStyleMappingSchema, {
+        description: "Custom style mappings for TOC entries. Maps custom theme styles to TOC levels."
+      })
+    )
+  },
+  {
+    description: "Table of Contents component props",
+    additionalProperties: false
+  }
+);
+
+// src/schemas/components/highcharts.ts
+import { Type as Type4 } from "@sinclair/typebox";
+var HighchartsPropsSchema = Type4.Object({
+  // Highcharts chart options - can be anything but must at least have chart.width and chart.height
+  options: Type4.Intersect([
+    Type4.Record(Type4.String(), Type4.Unknown()),
+    Type4.Object({
+      chart: Type4.Object({
+        width: Type4.Number(),
+        height: Type4.Number()
+      })
+    })
+  ]),
+  // Optional scale factor for export
+  scale: Type4.Optional(Type4.Number()),
+  // Optional Highcharts Export Server URL override
+  serverUrl: Type4.Optional(Type4.String({ description: "Highcharts Export Server URL (default: http://localhost:7801)" })),
+  // Optional width for rendering (overrides chart width)
+  width: Type4.Optional(
+    Type4.Union(
+      [
+        Type4.Number({
+          minimum: 1,
+          description: "Image width in pixels"
+        }),
+        Type4.String({
+          pattern: "^\\d+(\\.\\d+)?%$",
+          description: 'Image width as percentage (e.g., "90%") relative to content width'
+        })
+      ],
+      {
+        description: 'Rendered image width in pixels (number) or as percentage string (e.g., "90%")'
+      }
+    )
+  ),
+  // Optional height for rendering (overrides chart height)
+  height: Type4.Optional(
+    Type4.Union(
+      [
+        Type4.Number({
+          minimum: 1,
+          description: "Image height in pixels"
+        }),
+        Type4.String({
+          pattern: "^\\d+(\\.\\d+)?%$",
+          description: 'Image height as percentage (e.g., "90%") relative to content height'
+        })
+      ],
+      {
+        description: 'Rendered image height in pixels (number) or as percentage string (e.g., "90%")'
+      }
+    )
+  )
+});
+
+// src/schemas/component-registry.ts
+var STANDARD_COMPONENTS_REGISTRY = [
+  // ========================================================================
+  // Container Components (can contain children)
+  // ========================================================================
+  {
+    name: "docx",
+    propsSchema: ReportPropsSchema,
+    hasChildren: true,
+    allowedChildren: ["section"],
+    category: "container",
+    description: "Main document container - defines the overall document structure. Required as the root component.",
+    special: {
+      hasSchemaField: true
+      // Only docx root has $schema field
+    }
+  },
+  {
+    name: "section",
+    propsSchema: SectionPropsSchema,
+    createPropsSchema: createSectionPropsSchema,
+    hasChildren: true,
+    allowedChildren: [
+      "heading",
+      "paragraph",
+      "image",
+      "statistic",
+      "table",
+      "list",
+      "toc",
+      "highcharts",
+      "columns",
+      "text-box"
+    ],
+    category: "container",
+    description: "Section container - groups related content with optional title. Use for organizing document structure."
+  },
+  {
+    name: "columns",
+    propsSchema: ColumnsPropsSchema,
+    hasChildren: true,
+    allowedChildren: [
+      "heading",
+      "paragraph",
+      "image",
+      "statistic",
+      "table",
+      "list",
+      "toc",
+      "highcharts",
+      "text-box"
+    ],
+    category: "layout",
+    description: "Multi-column layout - arranges content in 2-4 columns. Great for side-by-side content."
+  },
+  {
+    name: "text-box",
+    propsSchema: TextBoxPropsSchema,
+    hasChildren: true,
+    allowedChildren: ["heading", "paragraph", "image"],
+    category: "layout",
+    description: "Floating text container - allows positioning text anywhere on the page with absolute or relative positioning."
+  },
+  // ========================================================================
+  // Content Components (leaf nodes, no children)
+  // ========================================================================
+  {
+    name: "heading",
+    propsSchema: HeadingPropsSchema,
+    hasChildren: false,
+    category: "content",
+    description: "Heading text - supports levels 1-6 for document hierarchy. Level 1 is largest."
+  },
+  {
+    name: "paragraph",
+    propsSchema: ParagraphPropsSchema,
+    hasChildren: false,
+    category: "content",
+    description: "Paragraph text - supports formatting like bold, italic, and color. Main content element."
+  },
+  {
+    name: "image",
+    propsSchema: ImagePropsSchema,
+    hasChildren: false,
+    category: "content",
+    description: "Image element - displays images with optional caption. Supports various formats."
+  },
+  {
+    name: "statistic",
+    propsSchema: StatisticPropsSchema,
+    hasChildren: false,
+    category: "content",
+    description: "Statistic display - shows a number with description. Perfect for KPIs and metrics."
+  },
+  {
+    name: "table",
+    propsSchema: TablePropsSchema,
+    createPropsSchema: createTablePropsSchema,
+    hasChildren: false,
+    category: "content",
+    description: "Data table - displays tabular data with headers. Supports formatting and alignment."
+  },
+  {
+    name: "list",
+    propsSchema: ListPropsSchema,
+    hasChildren: false,
+    category: "content",
+    description: "List element - bulleted or numbered list items. Supports nested lists."
+  },
+  {
+    name: "toc",
+    propsSchema: TocPropsSchema,
+    hasChildren: false,
+    category: "content",
+    description: "Table of contents - automatically generates TOC from document headings. Supports depth ranges and custom styles."
+  },
+  {
+    name: "highcharts",
+    propsSchema: HighchartsPropsSchema,
+    hasChildren: false,
+    category: "content",
+    description: "Chart component powered by Highcharts - render line, bar, pie, heatmap, and more with rich options."
+  }
+];
+function getStandardComponent(name) {
+  return STANDARD_COMPONENTS_REGISTRY.find((c) => c.name === name);
+}
+function getAllStandardComponentNames() {
+  return STANDARD_COMPONENTS_REGISTRY.map((c) => c.name);
+}
+function getComponentsByCategory(category) {
+  return STANDARD_COMPONENTS_REGISTRY.filter((c) => c.category === category);
+}
+function getContainerComponents() {
+  return STANDARD_COMPONENTS_REGISTRY.filter((c) => c.hasChildren);
+}
+function getContentComponents() {
+  return STANDARD_COMPONENTS_REGISTRY.filter((c) => !c.hasChildren);
+}
+function isStandardComponent(name) {
+  return STANDARD_COMPONENTS_REGISTRY.some((c) => c.name === name);
+}
+function createComponentSchemaObject(component, childrenType, selfRef) {
+  const schema = {
+    name: Type5.Literal(component.name),
+    id: Type5.Optional(Type5.String()),
+    enabled: Type5.Optional(
+      Type5.Boolean({
+        default: true,
+        description: "When false, this component is filtered out and not rendered. Defaults to true. Useful for conditional component inclusion."
+      })
+    )
+  };
+  if (component.special?.hasSchemaField) {
+    schema.$schema = Type5.Optional(Type5.String({ format: "uri" }));
+  }
+  schema.props = component.createPropsSchema && selfRef ? component.createPropsSchema(selfRef) : component.propsSchema;
+  if (component.hasChildren && childrenType) {
+    schema.children = Type5.Optional(Type5.Array(childrenType));
+  }
+  return Type5.Object(schema, { additionalProperties: false });
+}
+function createAllComponentSchemas(recursiveRef) {
+  return STANDARD_COMPONENTS_REGISTRY.map(
+    (component) => createComponentSchemaObject(component, recursiveRef)
+  );
+}
+function createAllComponentSchemasNarrowed(selfRef, pluginSchemas = []) {
+  const leafSchemas = /* @__PURE__ */ new Map();
+  for (const comp of STANDARD_COMPONENTS_REGISTRY) {
+    if (!comp.hasChildren) {
+      leafSchemas.set(
+        comp.name,
+        createComponentSchemaObject(comp, void 0, selfRef)
+      );
+    }
+  }
+  const containers = STANDARD_COMPONENTS_REGISTRY.filter((c) => c.hasChildren);
+  const resolved = /* @__PURE__ */ new Map();
+  const pending = [...containers];
+  while (pending.length > 0) {
+    const before = pending.length;
+    for (let i = pending.length - 1; i >= 0; i--) {
+      const comp = pending[i];
+      if (!comp.allowedChildren) {
+        resolved.set(
+          comp.name,
+          createComponentSchemaObject(comp, selfRef, selfRef)
+        );
+        pending.splice(i, 1);
+        continue;
+      }
+      const containerDeps = comp.allowedChildren.filter(
+        (name) => containers.some((c) => c.name === name)
+      );
+      if (!containerDeps.every((d) => resolved.has(d))) continue;
+      const childSchemas = comp.allowedChildren.map((name) => resolved.get(name) ?? leafSchemas.get(name)).filter((s) => s !== void 0);
+      const allChildSchemas = [...childSchemas, ...pluginSchemas];
+      const childrenType = allChildSchemas.length === 1 ? allChildSchemas[0] : Type5.Union(allChildSchemas);
+      resolved.set(
+        comp.name,
+        createComponentSchemaObject(comp, childrenType, selfRef)
+      );
+      pending.splice(i, 1);
+    }
+    if (pending.length === before) {
+      throw new Error(
+        `Circular allowedChildren among: ${pending.map((c) => c.name).join(", ")}`
+      );
+    }
+  }
+  const byName = new Map([...resolved, ...leafSchemas]);
+  return { schemas: [...byName.values()], byName };
+}
+
+export {
+  createReportPropsSchema,
+  ReportPropsSchema,
+  TextBoxPropsSchema,
+  TocStyleSchema,
+  TocScopeSchema,
+  TocStyleMappingSchema,
+  TocDepthRangeSchema,
+  TocPropsSchema,
+  HighchartsPropsSchema,
+  STANDARD_COMPONENTS_REGISTRY,
+  getStandardComponent,
+  getAllStandardComponentNames,
+  getComponentsByCategory,
+  getContainerComponents,
+  getContentComponents,
+  isStandardComponent,
+  createComponentSchemaObject,
+  createAllComponentSchemas,
+  createAllComponentSchemasNarrowed
+};
+//# sourceMappingURL=chunk-S5KMAUDZ.js.map