@json-to-office/core-docx 0.1.0

package/dist/utils/placeholderProcessor.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Placeholder Processing System
+ * Handles dynamic content replacement in text with support for rich text formatting
+ */
+import { TextRun, ExternalHyperlink, InternalHyperlink } from 'docx';
+import { TextStyle } from './textParser';
+type ParagraphChild = TextRun | ExternalHyperlink | InternalHyperlink;
+/**
+ * Placeholder handler function type
+ */
+export type PlaceholderHandler = (_context?: PlaceholderContext) => TextRun | TextRun[] | string;
+/**
+ * Context passed to placeholder handlers
+ */
+export interface PlaceholderContext {
+    style?: TextStyle;
+    [key: string]: unknown;
+}
+/**
+ * Placeholder registry for managing dynamic content
+ */
+export declare class PlaceholderRegistry {
+    private static handlers;
+    /**
+     * Register a placeholder handler
+     */
+    static register(name: string, handler: PlaceholderHandler): void;
+    /**
+     * Get a placeholder handler
+     */
+    static get(name: string): PlaceholderHandler | undefined;
+    /**
+     * Check if a placeholder is registered
+     */
+    static has(name: string): boolean;
+    /**
+     * Get all registered placeholder names
+     */
+    static getRegisteredNames(): string[];
+    /**
+     * Clear all registered placeholders
+     */
+    static clear(): void;
+}
+/**
+ * Process text containing placeholders and return array of paragraph children
+ */
+export declare function processPlaceholders(text: string, baseStyle?: TextStyle, context?: PlaceholderContext): ParagraphChild[];
+/**
+ * Process text with both decorators and placeholders
+ */
+export declare function processTextWithPlaceholders(text: string, baseStyle?: TextStyle, context?: PlaceholderContext): ParagraphChild[];
+/**
+ * Initialize built-in placeholders
+ */
+export declare function initializeBuiltinPlaceholders(): void;
+export {};
+//# sourceMappingURL=placeholderProcessor.d.ts.map

package/dist/utils/placeholderProcessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"placeholderProcessor.d.ts","sourceRoot":"","sources":["../../src/utils/placeholderProcessor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,OAAO,EAEP,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,MAAM,CAAC;AACd,OAAO,EAA2B,SAAS,EAAE,MAAM,cAAc,CAAC;AAIlE,KAAK,cAAc,GAAG,OAAO,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,QAAQ,CAAC,EAAE,kBAAkB,KAC1B,OAAO,GAAG,OAAO,EAAE,GAAG,MAAM,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAyC;IAEhE;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAIhE;;OAEG;IACH,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;IAIxD;;OAEG;IACH,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIjC;;OAEG;IACH,MAAM,CAAC,kBAAkB,IAAI,MAAM,EAAE;IAIrC;;OAEG;IACH,MAAM,CAAC,KAAK,IAAI,IAAI;CAGrB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,SAAc,EACzB,OAAO,GAAE,kBAAuB,GAC/B,cAAc,EAAE,CAgDlB;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,SAAc,EACzB,OAAO,GAAE,kBAAuB,GAC/B,cAAc,EAAE,CA6FlB;AAmCD;;GAEG;AACH,wBAAgB,6BAA6B,IAAI,IAAI,CAsEpD"}

package/dist/utils/textParser.d.ts

@@ -0,0 +1,35 @@
+import { TextRun, ExternalHyperlink, InternalHyperlink } from 'docx';
+import { PlaceholderContext } from './placeholderProcessor';
+export interface TextStyle {
+    font?: string;
+    size?: number;
+    color?: string;
+    bold?: boolean;
+    italics?: boolean;
+    underline?: {
+        type?: 'single' | 'double' | 'thick' | 'dotted' | 'dash' | 'dotDash' | 'dotDotDash' | 'wave' | 'none' | 'words' | 'dottedHeavy' | 'dashedHeavy' | 'dashLong' | 'dashLongHeavy' | 'dashDotHeavy' | 'dashDotDotHeavy' | 'wavyHeavy' | 'wavyDouble';
+        color?: string;
+    };
+}
+export interface TextDecoratorOptions {
+    boldColor?: string;
+    placeholderContext?: PlaceholderContext;
+    enableHyperlinks?: boolean;
+}
+/**
+ * Parses text with inline markdown-style decorators, placeholders, and newlines, returning an array of TextRun objects
+ * Supports:
+ * - **bold** or __bold__
+ * - *italic* or _italic_
+ * - ***bold italic*** or ___bold italic___
+ * - \n for line breaks
+ * - {PLACEHOLDER} for dynamic content
+ * - [link text](url) for hyperlinks (when enableHyperlinks is true)
+ *
+ * @param text The text to parse
+ * @param baseStyle The base style to apply to all text runs
+ * @param options Additional options for text decoration
+ * @returns Array of TextRun and hyperlink objects with appropriate styling
+ */
+export declare function parseTextWithDecorators(text: string, baseStyle?: TextStyle, options?: TextDecoratorOptions): (TextRun | ExternalHyperlink | InternalHyperlink)[];
+//# sourceMappingURL=textParser.d.ts.map

package/dist/utils/textParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textParser.d.ts","sourceRoot":"","sources":["../../src/utils/textParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AACrE,OAAO,EAEL,kBAAkB,EACnB,MAAM,wBAAwB,CAAC;AAGhC,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE;QACV,IAAI,CAAC,EACD,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,MAAM,GACN,SAAS,GACT,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,aAAa,GACb,aAAa,GACb,UAAU,GACV,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,WAAW,GACX,YAAY,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,SAAc,EACzB,OAAO,GAAE,oBAAyB,GACjC,CAAC,OAAO,GAAG,iBAAiB,GAAG,iBAAiB,CAAC,EAAE,CAmGrD"}

package/dist/utils/unicode.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Normalize text to NFC so composed accented characters are preserved
+ * consistently across DOCX renderers (including LibreOffice).
+ */
+export declare function normalizeUnicodeText(text: string | null | undefined): string;
+//# sourceMappingURL=unicode.d.ts.map

package/dist/utils/unicode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unicode.d.ts","sourceRoot":"","sources":["../../src/utils/unicode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAE5E"}

package/dist/utils/warningsDocument.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Warnings Document Generator
+ * Utility to generate a document from generation warnings
+ */
+import type { GenerationWarning } from '@json-to-office/shared-docx';
+import type { ReportComponentDefinition } from '../types';
+/**
+ * Generate a report document from warnings
+ * Returns null if there are no warnings
+ */
+export declare function generateWarningsDocument(warnings: GenerationWarning[] | null): ReportComponentDefinition | null;
+/**
+ * Format warnings as plain text
+ * Useful for logging or text output
+ */
+export declare function formatWarningsText(warnings: GenerationWarning[] | null): string;
+//# sourceMappingURL=warningsDocument.d.ts.map

package/dist/utils/warningsDocument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"warningsDocument.d.ts","sourceRoot":"","sources":["../../src/utils/warningsDocument.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAuB,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAE/E;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,iBAAiB,EAAE,GAAG,IAAI,GACnC,yBAAyB,GAAG,IAAI,CA+ElC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,iBAAiB,EAAE,GAAG,IAAI,GACnC,MAAM,CAoCR"}

package/dist/utils/widthUtils.d.ts

@@ -0,0 +1,27 @@
+import { ThemeConfig } from '../styles';
+/**
+ * Compute available page width in twips (page width minus left/right margins)
+ */
+export declare function getAvailableWidthTwips(theme?: ThemeConfig, themeName?: string): number;
+/**
+ * Compute full page width in twips (ignores margins)
+ */
+export declare function getPageWidthTwips(theme?: ThemeConfig, themeName?: string): number;
+/**
+ * Compute available page height in twips (page height minus top/bottom margins)
+ */
+export declare function getAvailableHeightTwips(theme?: ThemeConfig, themeName?: string): number;
+/**
+ * Compute full page height in twips (ignores margins)
+ */
+export declare function getPageHeightTwips(theme?: ThemeConfig, themeName?: string): number;
+/**
+ * Parse a percentage string like "75%" into a fraction 0..1
+ */
+export declare function parsePercentageStringToFraction(value: string): number | undefined;
+/**
+ * Convert a numeric (points) or percentage string to twips using available width
+ */
+export declare function relativeLengthToTwips(value: number | string, availableWidthTwips: number): number;
+export declare const __widthUtils = true;
+//# sourceMappingURL=widthUtils.d.ts.map

package/dist/utils/widthUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"widthUtils.d.ts","sourceRoot":"","sources":["../../src/utils/widthUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAIxC;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,CAAC,EAAE,WAAW,EACnB,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,CAMR;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,CAAC,EAAE,WAAW,EACnB,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,CAGR;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,KAAK,CAAC,EAAE,WAAW,EACnB,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,CAMR;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,CAAC,EAAE,WAAW,EACnB,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,CAGR;AAED;;GAEG;AACH,wBAAgB,+BAA+B,CAC7C,KAAK,EAAE,MAAM,GACZ,MAAM,GAAG,SAAS,CAMpB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,mBAAmB,EAAE,MAAM,GAC1B,MAAM,CAOR;AAED,eAAO,MAAM,YAAY,OAAO,CAAC"}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@json-to-office/core-docx",
+  "version": "0.1.0",
+  "description": "Core DOCX document generation engine",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js",
+      "default": "./dist/*.js"
+    }
+  },
+  "dependencies": {
+    "@sinclair/typebox": "0.34.38",
+    "adm-zip": "0.5.16",
+    "date-fns": "3.6.0",
+    "jszip": "3.10.1",
+    "probe-image-size": "7.2.3",
+    "@json-to-office/shared": "^0.1.0",
+    "@json-to-office/shared-docx": "^0.1.0"
+  },
+  "peerDependencies": {
+    "docx": "9.5.1",
+    "highcharts-export-server": "5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "highcharts-export-server": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/adm-zip": "0.5.7",
+    "@types/jszip": "3.4.1",
+    "@types/node": "20.11.0",
+    "@types/probe-image-size": "7.2.4",
+    "tsup": "8.5.0",
+    "typescript": "5.3.3"
+  },
+  "license": "MIT",
+  "author": "Paolo Barbato",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Wiseair-srl/json-to-office.git",
+    "directory": "packages/core-docx"
+  },
+  "homepage": "https://github.com/Wiseair-srl/json-to-office/tree/main/packages/core-docx",
+  "bugs": {
+    "url": "https://github.com/Wiseair-srl/json-to-office/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "keywords": [
+    "json-to-office",
+    "typescript",
+    "docx",
+    "document",
+    "word"
+  ],
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "tsup && tsc --emitDeclarationOnly --declaration",
+    "build:js": "tsup",
+    "build:types": "tsc --emitDeclarationOnly --declaration",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "format": "prettier --write src/**/*.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage --passWithNoTests"
+  }
+}