@json-to-office/core-docx 0.1.0

package/dist/json/filesystem.d.ts

@@ -0,0 +1,81 @@
+/// <reference types="node" />
+import { FSWatcher } from 'fs';
+import { ComponentDefinition } from '@json-to-office/shared-docx';
+/**
+ * File System utilities for JSON report definitions
+ */
+/**
+ * Load JSON report definition from file
+ * Supports both relative and absolute file paths
+ */
+export declare function loadJsonDefinition(filePath: string): Promise<ComponentDefinition>;
+/**
+ * Load JSON definition with validation but without throwing on validation errors
+ */
+export declare function loadJsonDefinitionSafe(filePath: string): Promise<{
+    success: boolean;
+    definition?: ComponentDefinition;
+    error?: JsonFileError;
+}>;
+/**
+ * Watch JSON file for changes and call callback on modifications
+ * Useful for development workflows
+ */
+export declare function watchJsonFile(filePath: string, callback: (_definition: ComponentDefinition | null, _error?: JsonFileError) => void): JsonFileWatcher;
+/**
+ * Watch multiple JSON files and call callback when any changes
+ */
+export declare function watchJsonFiles(filePaths: string[], callback: (_filePath: string, _definition: ComponentDefinition | null, _error?: JsonFileError) => void): JsonFileWatcher[];
+/**
+ * Check if file exists and is accessible
+ */
+export declare function checkJsonFile(filePath: string): Promise<{
+    exists: boolean;
+    readable: boolean;
+    isDirectory: boolean;
+    error?: string;
+}>;
+/**
+ * Find JSON files in a directory (non-recursive)
+ */
+export declare function findJsonFiles(directoryPath: string): Promise<string[]>;
+/**
+ * Save JSON report definition to file
+ */
+export declare function saveJsonDefinition(definition: ComponentDefinition, filePath: string, options?: {
+    pretty?: boolean;
+    backup?: boolean;
+}): Promise<void>;
+/**
+ * File watcher wrapper class
+ */
+export declare class JsonFileWatcher {
+    private watcher;
+    private filePath;
+    constructor(watcher: FSWatcher, filePath: string);
+    /**
+     * Stop watching the file
+     */
+    close(): void;
+    /**
+     * Get the watched file path
+     */
+    getFilePath(): string;
+}
+/**
+ * Custom error class for file system operations
+ */
+export declare class JsonFileError extends Error {
+    readonly code: string;
+    readonly originalError?: Error;
+    constructor(message: string, code: string, originalError?: Error);
+}
+/**
+ * Utility function to validate JSON file extension
+ */
+export declare function hasJsonExtension(filePath: string): boolean;
+/**
+ * Utility to ensure a path has .json extension
+ */
+export declare function ensureJsonExtension(filePath: string): string;
+//# sourceMappingURL=filesystem.d.ts.map

package/dist/json/filesystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesystem.d.ts","sourceRoot":"","sources":["../../src/json/filesystem.ts"],"names":[],"mappings":";AAEA,OAAO,EAAS,SAAS,EAAE,MAAM,IAAI,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAGlE;;GAEG;AAEH;;;GAGG;AACH,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,mBAAmB,CAAC,CAuD9B;AAED;;GAEG;AACH,wBAAsB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IACtE,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC,CAgBD;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,CACR,WAAW,EAAE,mBAAmB,GAAG,IAAI,EACvC,MAAM,CAAC,EAAE,aAAa,KACnB,IAAI,GACR,eAAe,CA4BjB;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC5B,SAAS,EAAE,MAAM,EAAE,EACnB,QAAQ,EAAE,CACR,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,mBAAmB,GAAG,IAAI,EACvC,MAAM,CAAC,EAAE,aAAa,KACnB,IAAI,GACR,eAAe,EAAE,CAMnB;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7D,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC,CA8CD;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CA2C5E;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,UAAU,EAAE,mBAAmB,EAC/B,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GACnD,OAAO,CAAC,IAAI,CAAC,CA0Df;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,OAAO,CAAY;IAC3B,OAAO,CAAC,QAAQ,CAAS;gBAEb,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM;IAKhD;;OAEG;IACI,KAAK,IAAI,IAAI;IAIpB;;OAEG;IACI,WAAW,IAAI,MAAM;CAG7B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,aAAa,CAAC,EAAE,KAAK,CAAC;gBAE1B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,KAAK;CAMjE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE5D"}

package/dist/json/index.d.ts

@@ -0,0 +1,6 @@
+export * from './parser';
+export * from './normalizer';
+export * from './filesystem';
+export type { ComponentDefinition as JsonComponentDefinition } from '@json-to-office/shared-docx';
+export type { CoreValidationResult as ValidationResult, JsonValidationError as ValidationError, } from '@json-to-office/shared-docx';
+//# sourceMappingURL=index.d.ts.map

package/dist/json/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/json/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAG7B,YAAY,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAClG,YAAY,EACV,oBAAoB,IAAI,gBAAgB,EACxC,mBAAmB,IAAI,eAAe,GACvC,MAAM,6BAA6B,CAAC"}

package/dist/json/normalizer.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Component Normalizer - Transforms JSON components where business logic requires it
+ *
+ * This module ONLY handles transformations that are actually necessary:
+ * 1. Columns shorthand notation (columns: 3 → array format)
+ * 2. Recursive processing of nested components
+ * 3. Gap application for columns
+ *
+ * All other properties are preserved as-is from TypeBox validation.
+ * This prevents information loss and maintains single source of truth.
+ */
+import { ComponentDefinition, ReportComponentDefinition } from '../types';
+/**
+ * Normalize a component definition and its nested children
+ * Preserves all validated properties - only transforms where business logic requires
+ */
+export declare function normalizeComponent(component: ComponentDefinition): ComponentDefinition;
+/**
+ * Normalize entire document (top-level report component)
+ * Returns as single-element tuple for backward compatibility
+ */
+export declare function normalizeDocument(document: ComponentDefinition | ReportComponentDefinition): [ReportComponentDefinition];
+/**
+ * Validate component structure (container vs content components)
+ */
+export declare function validateComponentStructure(component: any): {
+    valid: boolean;
+    errors: string[];
+};
+//# sourceMappingURL=normalizer.d.ts.map

package/dist/json/normalizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalizer.d.ts","sourceRoot":"","sources":["../../src/json/normalizer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EACL,mBAAmB,EACnB,yBAAyB,EAI1B,MAAM,UAAU,CAAC;AAElB;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,mBAAmB,GAC7B,mBAAmB,CAqBrB;AAqGD;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,mBAAmB,GAAG,yBAAyB,GACxD,CAAC,yBAAyB,CAAC,CAU7B;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,GAAG,GAAG;IAC1D,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAqCA"}

package/dist/json/parser.d.ts

@@ -0,0 +1,9 @@
+/**
+ * JSON Document Parser - Re-exports from shared package
+ *
+ * This module re-exports the JSON parsing functionality from the shared package
+ * and provide a clean interface for the core package.
+ */
+export { JsonDocumentParser, JsonParsingError, JsonValidationError, parseJsonComponent, validateJsonComponent, parseJsonWithLineNumbers, } from '@json-to-office/shared-docx';
+export type { DocumentValidationResult, DocumentValidationError, } from '@json-to-office/shared-docx';
+//# sourceMappingURL=parser.d.ts.map

package/dist/json/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/json/parser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,6BAA6B,CAAC;AAGrC,YAAY,EACV,wBAAwB,EACxB,uBAAuB,GACxB,MAAM,6BAA6B,CAAC"}

package/dist/plugin/createComponent.d.ts

@@ -0,0 +1,113 @@
+import { type TSchema, type Static } from '@sinclair/typebox';
+import type { ComponentDefinition } from '@json-to-office/shared-docx';
+import type { AddWarningFunction } from '@json-to-office/shared-docx';
+import type { ThemeConfig } from '../styles';
+/**
+ * Render function context - parameters passed to render
+ */
+export interface RenderContext<T> {
+    /** The validated props for this component */
+    props: T;
+    /** The resolved theme configuration */
+    theme: ThemeConfig;
+    /** Function to add warnings during processing */
+    addWarning: AddWarningFunction;
+    /** For container components: processed nested children */
+    children?: unknown[];
+}
+/**
+ * Render function that transforms custom component props into standard components.
+ */
+export type RenderFunction<TProps, TComponentDefinition = ComponentDefinition> = (context: RenderContext<TProps>) => Promise<TComponentDefinition[]>;
+/**
+ * A single version entry within a versioned component.
+ * Each version is self-contained with its own schema, render, and metadata.
+ */
+export interface ComponentVersion<TComponentDefinition = ComponentDefinition, TPropsSchema extends TSchema = TSchema> {
+    /** TypeBox schema for props validation */
+    propsSchema: TPropsSchema;
+    /** Async render function to transform props into standard components */
+    render: RenderFunction<Static<TPropsSchema>, TComponentDefinition>;
+    /** Whether this version supports nested children */
+    hasChildren?: boolean;
+    /** Optional description for this version */
+    description?: string;
+}
+/**
+ * Map of semver version strings to their version definitions.
+ */
+export type ComponentVersionMap<TComponentDefinition = ComponentDefinition> = Record<string, ComponentVersion<TComponentDefinition, any>>;
+/**
+ * Custom component definition with multiple semver-keyed versions.
+ * Each version is self-contained with its own schema + render.
+ *
+ * @typeParam TComponentDefinition - The component definition type for render return
+ * @typeParam TVersions - The versions map type
+ * @typeParam TName - The literal string type for the component name
+ */
+export interface CustomComponent<TComponentDefinition = ComponentDefinition, TVersions extends ComponentVersionMap<TComponentDefinition> = ComponentVersionMap<TComponentDefinition>, TName extends string = string> {
+    /** Unique name for the component type */
+    name: TName;
+    /** Map of semver version strings to version definitions */
+    versions: TVersions;
+}
+/**
+ * Create a single version entry with full type inference for props.
+ *
+ * Wrapping each version with `createVersion` lets TypeScript infer the
+ * props type from `propsSchema` and propagate it to the `render` function,
+ * so `props` is fully typed instead of `any`.
+ *
+ * @example
+ * ```typescript
+ * createVersion({
+ *   propsSchema: Type.Object({ city: Type.String() }),
+ *   render: async ({ props }) => {
+ *     // props.city is inferred as string
+ *     return [{ name: 'paragraph', props: { text: props.city } }];
+ *   },
+ * })
+ * ```
+ */
+export declare function createVersion<TPropsSchema extends TSchema, TComponentDefinition = ComponentDefinition>(version: ComponentVersion<TComponentDefinition, TPropsSchema>): ComponentVersion<TComponentDefinition, TPropsSchema>;
+/**
+ * Create a custom component with multiple semver-keyed versions.
+ *
+ * Use {@link createVersion} for each version entry to get full type inference
+ * for `props` in render functions.
+ *
+ * @example Basic single-version usage
+ * ```typescript
+ * const weatherComponent = createComponent({
+ *   name: 'weather' as const,
+ *   versions: {
+ *     '1.0.0': createVersion({
+ *       propsSchema: Type.Object({ city: Type.String() }),
+ *       render: async ({ props }) => [{
+ *         name: 'paragraph',
+ *         props: { text: `Weather in ${props.city}` }
+ *       }]
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Multi-version with breaking changes
+ * ```typescript
+ * const weatherComponent = createComponent({
+ *   name: 'weather' as const,
+ *   versions: {
+ *     '1.0.0': createVersion({
+ *       propsSchema: WeatherV1PropsSchema,
+ *       render: async ({ props }) => [...],
+ *     }),
+ *     '2.0.0': createVersion({
+ *       propsSchema: WeatherV2PropsSchema,
+ *       render: async ({ props }) => [...],
+ *     }),
+ *   },
+ * });
+ * ```
+ */
+export declare function createComponent<TComponentDefinition = ComponentDefinition, TVersions extends ComponentVersionMap<TComponentDefinition> = ComponentVersionMap<TComponentDefinition>, TName extends string = string>(component: CustomComponent<TComponentDefinition, TVersions, TName>): CustomComponent<TComponentDefinition, TVersions, TName>;
+//# sourceMappingURL=createComponent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createComponent.d.ts","sourceRoot":"","sources":["../../src/plugin/createComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,6CAA6C;IAC7C,KAAK,EAAE,CAAC,CAAC;IACT,uCAAuC;IACvC,KAAK,EAAE,WAAW,CAAC;IACnB,iDAAiD;IACjD,UAAU,EAAE,kBAAkB,CAAC;IAC/B,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,CACxB,MAAM,EACN,oBAAoB,GAAG,mBAAmB,IACxC,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;AAExE;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAC/B,oBAAoB,GAAG,mBAAmB,EAC1C,YAAY,SAAS,OAAO,GAAG,OAAO;IAEtC,0CAA0C;IAC1C,WAAW,EAAE,YAAY,CAAC;IAC1B,wEAAwE;IACxE,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,oBAAoB,CAAC,CAAC;IACnE,oDAAoD;IACpD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,oBAAoB,GAAG,mBAAmB,IACxE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC,CAAC;AAE9D;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe,CAC9B,oBAAoB,GAAG,mBAAmB,EAC1C,SAAS,SACP,mBAAmB,CAAC,oBAAoB,CAAC,GAAG,mBAAmB,CAAC,oBAAoB,CAAC,EACvF,KAAK,SAAS,MAAM,GAAG,MAAM;IAE7B,yCAAyC;IACzC,IAAI,EAAE,KAAK,CAAC;IACZ,2DAA2D;IAC3D,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAC3B,YAAY,SAAS,OAAO,EAC5B,oBAAoB,GAAG,mBAAmB,EAE1C,OAAO,EAAE,gBAAgB,CAAC,oBAAoB,EAAE,YAAY,CAAC,GAC5D,gBAAgB,CAAC,oBAAoB,EAAE,YAAY,CAAC,CAEtD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,eAAe,CAC7B,oBAAoB,GAAG,mBAAmB,EAC1C,SAAS,SACP,mBAAmB,CAAC,oBAAoB,CAAC,GAAG,mBAAmB,CAAC,oBAAoB,CAAC,EACvF,KAAK,SAAS,MAAM,GAAG,MAAM,EAE7B,SAAS,EAAE,eAAe,CAAC,oBAAoB,EAAE,SAAS,EAAE,KAAK,CAAC,GACjE,eAAe,CAAC,oBAAoB,EAAE,SAAS,EAAE,KAAK,CAAC,CAoCzD"}

package/dist/plugin/createDocumentGenerator.d.ts

@@ -0,0 +1,18 @@
+import type { ThemeConfig } from '../styles';
+import type { DocumentGeneratorBuilder } from './types';
+/**
+ * Options for creating a document generator
+ */
+export interface DocumentGeneratorOptions {
+    /** Theme configuration */
+    theme: ThemeConfig;
+    /** Enable caching for better performance */
+    enableCache?: boolean;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * Create a document generator with chainable component registration.
+ */
+export declare function createDocumentGenerator(options: DocumentGeneratorOptions): DocumentGeneratorBuilder<readonly []>;
+//# sourceMappingURL=createDocumentGenerator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createDocumentGenerator.d.ts","sourceRoot":"","sources":["../../src/plugin/createDocumentGenerator.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C,OAAO,KAAK,EAEV,wBAAwB,EAKzB,MAAM,SAAS,CAAC;AAgBjB;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,0BAA0B;IAC1B,KAAK,EAAE,WAAW,CAAC;IACnB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAoZD;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,wBAAwB,GAChC,wBAAwB,CAAC,SAAS,EAAE,CAAC,CAUvC"}

package/dist/plugin/example/columns-layout.component.d.ts

@@ -0,0 +1,29 @@
+import type { ComponentDefinition } from '@json-to-office/shared-docx';
+/**
+ * Columns layout component that renders a list of components in a 2-column layout
+ *
+ * @example
+ * ```json
+ * {
+ *   "name": "columnsLayout",
+ *   "children": [
+ *     {
+ *       "name": "paragraph",
+ *       "props": {
+ *         "content": "Left column content"
+ *       }
+ *     },
+ *     {
+ *       "name": "paragraph",
+ *       "props": {
+ *         "content": "Right column content"
+ *       }
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export declare const columnsLayoutComponent: import("../createComponent").CustomComponent<ComponentDefinition, {
+    '1.0.0': import("../createComponent").ComponentVersion<ComponentDefinition, import("@sinclair/typebox").TObject<{}>>;
+}, "columnsLayout">;
+//# sourceMappingURL=columns-layout.component.d.ts.map

package/dist/plugin/example/columns-layout.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"columns-layout.component.d.ts","sourceRoot":"","sources":["../../../src/plugin/example/columns-layout.component.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAavE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,sBAAsB;;mBAqBjC,CAAC"}

package/dist/plugin/example/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Demo application showing how to use the plugin system
+ */
+declare function runPluginDemo(): Promise<void>;
+export { runPluginDemo };
+//# sourceMappingURL=index.d.ts.map

package/dist/plugin/example/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugin/example/index.ts"],"names":[],"mappings":"AAsBA;;GAEG;AACH,iBAAe,aAAa,kBA6E3B;AAQD,OAAO,EAAE,aAAa,EAAE,CAAC"}