legal-markdown-js 0.1.0

package/dist/generators/html-generator.js

@@ -0,0 +1,361 @@
+"use strict";
+/**
+ * @fileoverview HTML Generation Module for Legal Markdown Documents
+ *
+ * This module provides functionality to convert processed Legal Markdown content
+ * into well-formatted HTML documents with CSS styling, accessibility features,
+ * and print optimization.
+ *
+ * Features:
+ * - Markdown to HTML conversion using marked
+ * - DOM manipulation with cheerio for enhanced formatting
+ * - Custom CSS injection and styling
+ * - Field highlighting for document review
+ * - Print-friendly output with page break controls
+ * - Responsive table handling
+ * - Accessibility improvements
+ *
+ * @example
+ * ```typescript
+ * import { htmlGenerator } from './html-generator';
+ *
+ * const html = await htmlGenerator.generateHtml(markdownContent, {
+ *   title: 'Legal Agreement',
+ *   cssPath: './styles.css',
+ *   includeHighlighting: true
+ * });
+ * ```
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.htmlGenerator = exports.HtmlGenerator = void 0;
+const marked_1 = require("marked");
+const cheerio = __importStar(require("cheerio"));
+const fs = __importStar(require("fs/promises"));
+const path = __importStar(require("path"));
+const js_beautify_1 = require("js-beautify");
+const logger_1 = require("../utils/logger");
+/**
+ * HTML Generator for Legal Markdown Documents
+ *
+ * Converts processed Legal Markdown content into formatted HTML documents
+ * with professional styling, accessibility features, and print optimization.
+ *
+ * @class HtmlGenerator
+ * @example
+ * ```typescript
+ * const generator = new HtmlGenerator();
+ * const html = await generator.generateHtml(content, {
+ *   title: 'Contract',
+ *   includeHighlighting: true
+ * });
+ * ```
+ */
+class HtmlGenerator {
+    /**
+     * Creates a new HTML generator instance and configures the markdown parser
+     *
+     * @constructor
+     */
+    constructor() {
+        this.configureMarked();
+    }
+    /**
+     * Configures the marked markdown parser with options optimized for legal documents
+     *
+     * @private
+     * @method configureMarked
+     * @returns {void}
+     */
+    configureMarked() {
+        // Configure marked options
+        marked_1.marked.setOptions({
+            gfm: true,
+            breaks: true,
+            pedantic: false,
+        });
+    }
+    /**
+     * Removes YAML frontmatter from markdown content if present
+     *
+     * @private
+     * @method removeYamlFrontmatter
+     * @param {string} content - The markdown content that may contain YAML frontmatter
+     * @returns {string} Content with YAML frontmatter removed
+     * @example
+     * ```typescript
+     * const content = `---
+     * title: Document
+     * ---
+     * # Content`;
+     * const clean = this.removeYamlFrontmatter(content); // "# Content"
+     * ```
+     */
+    removeYamlFrontmatter(content) {
+        // Check if content starts with YAML frontmatter
+        if (content.startsWith('---')) {
+            // Find the closing --- delimiter (allowing for various line endings)
+            const lines = content.split('\n');
+            let endIndex = -1;
+            // Look for the closing --- starting from line 1 (skip the opening ---)
+            for (let i = 1; i < lines.length; i++) {
+                if (lines[i].trim() === '---') {
+                    endIndex = i;
+                    break;
+                }
+            }
+            if (endIndex !== -1) {
+                // Return content after the frontmatter (skip the closing --- line)
+                return lines
+                    .slice(endIndex + 1)
+                    .join('\n')
+                    .trim();
+            }
+        }
+        return content;
+    }
+    /**
+     * Generates a complete HTML document from Legal Markdown content
+     *
+     * This is the main method that orchestrates the conversion process:
+     * 1. Removes YAML frontmatter
+     * 2. Converts markdown to HTML using marked
+     * 3. Applies DOM transformations for legal document formatting
+     * 4. Injects custom CSS and styling
+     * 5. Builds a complete HTML document
+     *
+     * @async
+     * @method generateHtml
+     * @param {string} markdownContent - The processed Legal Markdown content to convert
+     * @param {HtmlGeneratorOptions} [options={}] - Configuration options for HTML generation
+     * @returns {Promise<string>} A promise that resolves to the complete HTML document
+     * @throws {Error} When HTML generation fails due to parsing or file system errors
+     * @example
+     * ```typescript
+     * const html = await generator.generateHtml(
+     *   '# Contract\n\nThis is a {{party.name}} agreement.',
+     *   {
+     *     title: 'Service Agreement',
+     *     cssPath: './contract-styles.css',
+     *     includeHighlighting: true,
+     *     metadata: {
+     *       author: 'Legal Team',
+     *       version: '1.0'
+     *     }
+     *   }
+     * );
+     * ```
+     */
+    async generateHtml(markdownContent, options = {}) {
+        try {
+            logger_1.logger.debug('Generating HTML from markdown', {
+                contentLength: markdownContent.length,
+                options,
+            });
+            // Remove YAML frontmatter if present
+            const contentWithoutFrontmatter = this.removeYamlFrontmatter(markdownContent);
+            // Convert markdown to HTML
+            const htmlContent = await marked_1.marked.parse(contentWithoutFrontmatter);
+            // Load and manipulate with cheerio
+            const $ = cheerio.load(htmlContent);
+            // Apply DOM transformations
+            this.applyDomTransformations($);
+            // Add CSS if provided
+            let cssContent = '';
+            if (options.cssPath) {
+                cssContent += await this.loadCss(options.cssPath);
+            }
+            if (options.includeHighlighting && options.highlightCssPath) {
+                cssContent += '\n' + (await this.loadCss(options.highlightCssPath));
+            }
+            // Build complete HTML document
+            const completeHtml = await this.buildHtmlDocument({
+                body: $.html(),
+                css: cssContent,
+                title: options.title || 'Legal Document',
+                useDefaultCss: !options.cssPath, // Only use default CSS if no custom CSS is provided
+                metadata: options.metadata,
+            });
+            // Format the HTML for consistent output
+            const formattedHtml = (0, js_beautify_1.html)(completeHtml, {
+                indent_size: 2,
+                indent_char: ' ',
+                max_preserve_newlines: 2,
+                preserve_newlines: true,
+                indent_scripts: 'normal',
+                end_with_newline: true,
+                wrap_line_length: 0,
+                indent_inner_html: true,
+                unformatted: ['pre', 'code'],
+                content_unformatted: ['pre', 'script', 'style'],
+                extra_liners: ['head', 'body', '/html'],
+            });
+            logger_1.logger.debug('HTML generation completed', {
+                htmlLength: formattedHtml.length,
+            });
+            return formattedHtml;
+        }
+        catch (error) {
+            logger_1.logger.error('Error generating HTML', { error });
+            throw new Error(`Failed to generate HTML: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    /**
+     * Applies DOM transformations to enhance the HTML for legal document presentation
+     *
+     * Transformations include:
+     * - Adding no-break classes to short lists for better print layout
+     * - Wrapping tables in responsive containers
+     * - Adding alt attributes to images for accessibility
+     * - Adding print-friendly CSS classes
+     * - Cleaning up paragraph tags in list items
+     *
+     * @private
+     * @method applyDomTransformations
+     * @param {cheerio.CheerioAPI} $ - The cheerio instance with loaded HTML
+     * @returns {void}
+     */
+    applyDomTransformations($) {
+        // Apply list transformations (prevent page breaks in short lists)
+        const maxListItemsNoBreak = 5;
+        $('ul, ol').each((_, element) => {
+            const list = $(element);
+            if (list.children().length < maxListItemsNoBreak) {
+                list.addClass('no-break');
+            }
+        });
+        // Clean up paragraph tags in list items (unwrap single p tags)
+        $('li > p:only-child').each((_, element) => {
+            const p = $(element);
+            const li = p.parent();
+            li.html(p.html() || '');
+        });
+        // Apply table responsiveness
+        $('table').each((_, element) => {
+            const table = $(element);
+            if (!table.parent().hasClass('table-responsive')) {
+                table.wrap('<div class="table-responsive"></div>');
+            }
+        });
+        // Ensure images have alt attributes for accessibility
+        $('img:not([alt])').attr('alt', '');
+        // Add print-friendly classes
+        $('.page-break').addClass('page-break-before');
+    }
+    /**
+     * Loads CSS content from a file path
+     *
+     * @private
+     * @async
+     * @method loadCss
+     * @param {string} cssPath - Path to the CSS file to load
+     * @returns {Promise<string>} A promise that resolves to the CSS content, or empty string on error
+     */
+    async loadCss(cssPath) {
+        try {
+            const cssContent = await fs.readFile(cssPath, 'utf-8');
+            logger_1.logger.debug('CSS file loaded', { cssPath, size: cssContent.length });
+            return cssContent;
+        }
+        catch (error) {
+            logger_1.logger.warn(`Failed to load CSS file: ${cssPath}`, { error });
+            return '';
+        }
+    }
+    /**
+     * Builds a complete HTML document with head, body, and embedded styles
+     *
+     * Creates a well-formed HTML5 document with:
+     * - Proper DOCTYPE and meta tags
+     * - Responsive viewport configuration
+     * - Embedded CSS styles (base + custom)
+     * - SEO-friendly metadata
+     * - Print-optimized styling
+     *
+     * @private
+     * @method buildHtmlDocument
+     * @param {Object} options - Configuration for building the HTML document
+     * @param {string} options.body - The HTML body content
+     * @param {string} options.css - Custom CSS to embed
+     * @param {string} options.title - Document title
+     * @param {Record<string, string>} [options.metadata] - Additional metadata for HTML head
+     * @returns {string} Complete HTML document as string
+     */
+    async buildHtmlDocument(options) {
+        const { body, css, title, metadata = {}, useDefaultCss = true } = options;
+        // Load default CSS only if no custom CSS is provided
+        let defaultCss = '';
+        if (useDefaultCss) {
+            const defaultCssPath = path.join(__dirname, '..', 'styles', 'default.css');
+            defaultCss = await this.loadCss(defaultCssPath);
+        }
+        // Build metadata tags
+        const metaTags = Object.entries(metadata)
+            .map(([name, content]) => `    <meta name="${name}" content="${content}">`)
+            .join('\n');
+        return `<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>${title}</title>
+${metaTags ? metaTags + '\n' : ''}    <style>
+      /* Default CSS */
+      ${defaultCss}
+
+      /* Custom CSS */
+      ${css}
+    </style>
+</head>
+<body>
+${body}
+</body>
+</html>`;
+    }
+}
+exports.HtmlGenerator = HtmlGenerator;
+/**
+ * Singleton instance of HtmlGenerator for convenient importing
+ *
+ * @constant {HtmlGenerator} htmlGenerator
+ * @example
+ * ```typescript
+ * import { htmlGenerator } from './html-generator';
+ * const html = await htmlGenerator.generateHtml(content);
+ * ```
+ */
+// Export singleton instance
+exports.htmlGenerator = new HtmlGenerator();
+//# sourceMappingURL=html-generator.js.map

package/dist/generators/html-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-generator.js","sourceRoot":"","sources":["../../src/generators/html-generator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,mCAAgC;AAChC,iDAAmC;AACnC,gDAAkC;AAClC,2CAA6B;AAC7B,6CAAmD;AACnD,4CAAyC;AAoBzC;;;;;;;;;;;;;;;GAeG;AACH,MAAa,aAAa;IACxB;;;;OAIG;IACH;QACE,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACK,eAAe;QACrB,2BAA2B;QAC3B,eAAM,CAAC,UAAU,CAAC;YAChB,GAAG,EAAE,IAAI;YACT,MAAM,EAAE,IAAI;YACZ,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACK,qBAAqB,CAAC,OAAe;QAC3C,gDAAgD;QAChD,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,qEAAqE;YACrE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC;YAElB,uEAAuE;YACvE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,KAAK,EAAE,CAAC;oBAC9B,QAAQ,GAAG,CAAC,CAAC;oBACb,MAAM;gBACR,CAAC;YACH,CAAC;YAED,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;gBACpB,mEAAmE;gBACnE,OAAO,KAAK;qBACT,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC;qBACnB,IAAI,CAAC,IAAI,CAAC;qBACV,IAAI,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,YAAY,CAAC,eAAuB,EAAE,UAAgC,EAAE;QAC5E,IAAI,CAAC;YACH,eAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE;gBAC5C,aAAa,EAAE,eAAe,CAAC,MAAM;gBACrC,OAAO;aACR,CAAC,CAAC;YAEH,qCAAqC;YACrC,MAAM,yBAAyB,GAAG,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;YAE9E,2BAA2B;YAC3B,MAAM,WAAW,GAAG,MAAM,eAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAElE,mCAAmC;YACnC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAEpC,4BAA4B;YAC5B,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;YAEhC,sBAAsB;YACtB,IAAI,UAAU,GAAG,EAAE,CAAC;YACpB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACpB,UAAU,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACpD,CAAC;YACD,IAAI,OAAO,CAAC,mBAAmB,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC5D,UAAU,IAAI,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;YACtE,CAAC;YAED,+BAA+B;YAC/B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC;gBAChD,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;gBACd,GAAG,EAAE,UAAU;gBACf,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,gBAAgB;gBACxC,aAAa,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,oDAAoD;gBACrF,QAAQ,EAAE,OAAO,CAAC,QAAQ;aAC3B,CAAC,CAAC;YAEH,wCAAwC;YACxC,MAAM,aAAa,GAAG,IAAA,kBAAY,EAAC,YAAY,EAAE;gBAC/C,WAAW,EAAE,CAAC;gBACd,WAAW,EAAE,GAAG;gBAChB,qBAAqB,EAAE,CAAC;gBACxB,iBAAiB,EAAE,IAAI;gBACvB,cAAc,EAAE,QAAQ;gBACxB,gBAAgB,EAAE,IAAI;gBACtB,gBAAgB,EAAE,CAAC;gBACnB,iBAAiB,EAAE,IAAI;gBACvB,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;gBAC5B,mBAAmB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC;gBAC/C,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;aACxC,CAAC,CAAC;YAEH,eAAM,CAAC,KAAK,CAAC,2BAA2B,EAAE;gBACxC,UAAU,EAAE,aAAa,CAAC,MAAM;aACjC,CAAC,CAAC;YAEH,OAAO,aAAa,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,eAAM,CAAC,KAAK,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YACjD,MAAM,IAAI,KAAK,CACb,4BAA4B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACrF,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACK,uBAAuB,CAAC,CAAqB;QACnD,kEAAkE;QAClE,MAAM,mBAAmB,GAAG,CAAC,CAAC;QAC9B,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE;YAC9B,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;YACxB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,MAAM,GAAG,mBAAmB,EAAE,CAAC;gBACjD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,+DAA+D;QAC/D,CAAC,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE;YACzC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;YACrB,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;YACtB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,6BAA6B;QAC7B,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE;YAC7B,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;YACzB,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBACjD,KAAK,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,sDAAsD;QACtD,CAAC,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEpC,6BAA6B;QAC7B,CAAC,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,OAAO,CAAC,OAAe;QACnC,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACvD,eAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;YACtE,OAAO,UAAU,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,eAAM,CAAC,IAAI,CAAC,4BAA4B,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAC9D,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACK,KAAK,CAAC,iBAAiB,CAAC,OAM/B;QACC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,GAAG,EAAE,EAAE,aAAa,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QAE1E,qDAAqD;QACrD,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;YAC3E,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAClD,CAAC;QAED,sBAAsB;QACtB,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;aACtC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,mBAAmB,IAAI,cAAc,OAAO,IAAI,CAAC;aAC1E,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,OAAO;;;;;aAKE,KAAK;EAChB,QAAQ,CAAC,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE;;QAEzB,UAAU;;;QAGV,GAAG;;;;EAIT,IAAI;;QAEE,CAAC;IACP,CAAC;CACF;AAnSD,sCAmSC;AAED;;;;;;;;;GASG;AACH,4BAA4B;AACf,QAAA,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC"}

package/dist/generators/pdf-generator.d.ts

@@ -0,0 +1,165 @@
+/**
+ * @fileoverview PDF Generation Module for Legal Markdown Documents
+ *
+ * This module provides functionality to convert processed Legal Markdown content
+ * into professional PDF documents using Puppeteer for HTML-to-PDF conversion.
+ * It builds upon the HTML generator to create print-ready documents with
+ * customizable formatting, page layouts, and styling options.
+ *
+ * Features:
+ * - HTML-to-PDF conversion using Puppeteer
+ * - Multiple page formats (A4, Letter, Legal)
+ * - Customizable margins and page orientation
+ * - Header and footer template support
+ * - Field highlighting for document review
+ * - Temporary file management and cleanup
+ * - Error handling and logging
+ * - Dual PDF generation (normal and highlighted versions)
+ *
+ * @example
+ * ```typescript
+ * import { pdfGenerator } from './pdf-generator';
+ *
+ * const pdf = await pdfGenerator.generatePdf(markdownContent, './output.pdf', {
+ *   format: 'A4',
+ *   landscape: false,
+ *   includeHighlighting: true,
+ *   margin: { top: '2cm', bottom: '2cm' }
+ * });
+ * ```
+ */
+import { HtmlGeneratorOptions } from './html-generator';
+/**
+ * Configuration options for PDF generation
+ *
+ * @interface PdfGeneratorOptions
+ * @extends HtmlGeneratorOptions
+ */
+export interface PdfGeneratorOptions extends HtmlGeneratorOptions {
+    /** Page format for the PDF */
+    format?: 'A4' | 'Letter' | 'Legal';
+    /** Whether to use landscape orientation */
+    landscape?: boolean;
+    /** Page margins configuration */
+    margin?: {
+        /** Top margin (e.g., '1cm', '0.5in') */
+        top?: string;
+        /** Right margin (e.g., '1cm', '0.5in') */
+        right?: string;
+        /** Bottom margin (e.g., '1cm', '0.5in') */
+        bottom?: string;
+        /** Left margin (e.g., '1cm', '0.5in') */
+        left?: string;
+    };
+    /** Whether to display header and footer */
+    displayHeaderFooter?: boolean;
+    /** HTML template for page headers */
+    headerTemplate?: string;
+    /** HTML template for page footers */
+    footerTemplate?: string;
+    /** Whether to print background colors and images */
+    printBackground?: boolean;
+    /** Whether to prefer CSS page size over format option */
+    preferCSSPageSize?: boolean;
+}
+/**
+ * PDF Generator for Legal Markdown Documents
+ *
+ * Converts processed Legal Markdown content into PDF documents using Puppeteer
+ * for HTML-to-PDF conversion. Provides comprehensive formatting options and
+ * supports both normal and highlighted document versions.
+ *
+ * @class PdfGenerator
+ * @example
+ * ```typescript
+ * const generator = new PdfGenerator();
+ * const pdf = await generator.generatePdf(content, './output.pdf', {
+ *   format: 'A4',
+ *   includeHighlighting: true
+ * });
+ * ```
+ */
+export declare class PdfGenerator {
+    private puppeteerOptions;
+    /**
+     * Creates a new PDF generator instance
+     *
+     * @constructor
+     */
+    constructor();
+    /**
+     * Generates a PDF document from Legal Markdown content
+     *
+     * This method orchestrates the complete PDF generation process:
+     * 1. Converts markdown to HTML using the HTML generator
+     * 2. Creates a temporary HTML file for Puppeteer
+     * 3. Launches a headless Chrome browser
+     * 4. Loads the HTML and generates PDF with specified options
+     * 5. Cleans up temporary files and browser resources
+     *
+     * @async
+     * @param {string} markdownContent - The processed Legal Markdown content
+     * @param {string} outputPath - Path where the PDF will be saved
+     * @param {PdfGeneratorOptions} [options={}] - Configuration options for PDF generation
+     * @returns {Promise<Buffer>} A promise that resolves to the PDF buffer
+     * @throws {Error} When PDF generation fails due to browser, file system, or processing errors
+     * @example
+     * ```typescript
+     * const pdf = await generator.generatePdf(
+     *   markdownContent,
+     *   './contract.pdf',
+     *   {
+     *     format: 'A4',
+     *     landscape: false,
+     *     includeHighlighting: true,
+     *     margin: { top: '2cm', bottom: '2cm' }
+     *   }
+     * );
+     * ```
+     */
+    generatePdf(markdownContent: string, outputPath: string, options?: PdfGeneratorOptions): Promise<Buffer>;
+    /**
+     * Generate two PDF versions: one normal and one with highlighting
+     *
+     * This method creates two PDF versions of the same document:
+     * 1. A normal version without field highlighting
+     * 2. A highlighted version with field annotations
+     *
+     * This is useful for document review processes where both clean and
+     * annotated versions are needed for different purposes.
+     *
+     * @async
+     * @param {string} markdownContent - The processed Legal Markdown content
+     * @param {string} outputPath - Base path for PDF files (will be modified for each version)
+     * @param {PdfGeneratorOptions} [options={}] - Configuration options for PDF generation
+     * @returns {Promise<Object>} A promise that resolves to both PDF buffers
+     * @returns {Buffer} returns.normal - The normal PDF without highlighting
+     * @returns {Buffer} returns.highlighted - The highlighted PDF with field annotations
+     * @throws {Error} When PDF generation fails for either version
+     * @example
+     * ```typescript
+     * const { normal, highlighted } = await generator.generatePdfVersions(
+     *   markdownContent,
+     *   './contract.pdf',
+     *   { format: 'A4' }
+     * );
+     * // Creates: contract.normal.pdf and contract.highlighted.pdf
+     * ```
+     */
+    generatePdfVersions(markdownContent: string, outputPath: string, options?: PdfGeneratorOptions): Promise<{
+        normal: Buffer;
+        highlighted: Buffer;
+    }>;
+}
+/**
+ * Singleton instance of PdfGenerator for convenient importing
+ *
+ * @constant {PdfGenerator} pdfGenerator
+ * @example
+ * ```typescript
+ * import { pdfGenerator } from './pdf-generator';
+ * const pdf = await pdfGenerator.generatePdf(content, './output.pdf');
+ * ```
+ */
+export declare const pdfGenerator: PdfGenerator;
+//# sourceMappingURL=pdf-generator.d.ts.map

package/dist/generators/pdf-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdf-generator.d.ts","sourceRoot":"","sources":["../../src/generators/pdf-generator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAMH,OAAO,EAAiB,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D,8BAA8B;IAC9B,MAAM,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,OAAO,CAAC;IACnC,2CAA2C;IAC3C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iCAAiC;IACjC,MAAM,CAAC,EAAE;QACP,wCAAwC;QACxC,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,0CAA0C;QAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,yCAAyC;QACzC,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,2CAA2C;IAC3C,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,qCAAqC;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qCAAqC;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oDAAoD;IACpD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,gBAAgB,CAYtB;IAEF;;;;OAIG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,WAAW,CACf,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,MAAM,CAAC;IA4FlB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,mBAAmB,CACvB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC;QACT,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CAoBH;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,cAAqB,CAAC"}