legal-markdown-js 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,229 @@
+/**
+ * @fileoverview Main Entry Point for Legal Markdown Processing Library
+ *
+ * This module provides the primary API for processing Legal Markdown documents
+ * with support for YAML front matter, cross-references, optional clauses, mixins,
+ * header processing, and multi-format output generation (HTML, PDF).
+ *
+ * Features:
+ * - YAML front matter parsing and metadata extraction
+ * - Cross-reference processing and resolution
+ * - Optional clause conditional rendering
+ * - Mixin system for reusable content blocks
+ * - Header numbering and formatting
+ * - Field tracking for document highlighting
+ * - HTML and PDF generation with styling
+ * - RST and LaTeX preprocessing support
+ * - Metadata export capabilities
+ *
+ * @example
+ * ```typescript
+ * import { processLegalMarkdown, generateHtml, generatePdf } from 'legal-markdown-js';
+ *
+ * // Basic document processing
+ * const result = processLegalMarkdown(content, {
+ *   enableFieldTracking: true,
+ *   basePath: './documents'
+ * });
+ *
+ * // Generate HTML output
+ * const html = await generateHtml(content, {
+ *   title: 'Legal Agreement',
+ *   includeHighlighting: true
+ * });
+ *
+ * // Generate PDF output
+ * const pdf = await generatePdf(content, './output.pdf', {
+ *   format: 'A4',
+ *   includeHighlighting: true
+ * });
+ * ```
+ */
+import { fieldTracker } from './tracking/field-tracker';
+import { LegalMarkdownOptions } from '@types';
+/**
+ * Main function to process a Legal Markdown document (async version)
+ *
+ * This function orchestrates the complete processing pipeline for Legal Markdown
+ * documents, including YAML parsing, content preprocessing, clause processing,
+ * cross-reference resolution, mixin expansion, header formatting, and metadata export.
+ *
+ * @param {string} content - The raw Legal Markdown content to process
+ * @param {LegalMarkdownOptions} [options={}] - Configuration options for processing
+ * @returns {Promise<Object>} Processing result containing processed content, metadata, and reports
+ * @returns {string} returns.content - The processed document content
+ * @returns {Record<string, any>} [returns.metadata] - Extracted YAML metadata
+ * @returns {string[]} [returns.exportedFiles] - Array of exported metadata files
+ * @returns {Object} [returns.fieldReport] - Field tracking report if enabled
+ * @example
+ * ```typescript
+ * const result = await processLegalMarkdownAsync(content, {
+ *   enableFieldTracking: true,
+ *   basePath: './documents',
+ *   noClauses: false,
+ *   noReferences: false
+ * });
+ *
+ * console.log(result.content); // Processed markdown
+ * console.log(result.metadata); // YAML front matter
+ * console.log(result.fieldReport); // Field usage report
+ * ```
+ */
+export declare function processLegalMarkdownAsync(content: string, options?: LegalMarkdownOptions): Promise<{
+    content: string;
+    metadata?: Record<string, any>;
+    exportedFiles?: string[];
+    fieldReport?: ReturnType<typeof fieldTracker.generateReport>;
+}>;
+/**
+ * Main function to process a Legal Markdown document (sync version with fallback)
+ *
+ * This function uses fallback parsers for RST/LaTeX to maintain backward compatibility
+ * and ensure the library works without pandoc dependencies.
+ *
+ * @param {string} content - The raw Legal Markdown content to process
+ * @param {LegalMarkdownOptions} [options={}] - Configuration options for processing
+ * @returns {Object} Processing result containing processed content, metadata, and reports
+ * @returns {string} returns.content - The processed document content
+ * @returns {Record<string, any>} [returns.metadata] - Extracted YAML metadata
+ * @returns {string[]} [returns.exportedFiles] - Array of exported metadata files
+ * @returns {Object} [returns.fieldReport] - Field tracking report if enabled
+ * @example
+ * ```typescript
+ * const result = processLegalMarkdown(content, {
+ *   enableFieldTracking: true,
+ *   basePath: './documents',
+ *   noClauses: false,
+ *   noReferences: false
+ * });
+ *
+ * console.log(result.content); // Processed markdown
+ * console.log(result.metadata); // YAML front matter
+ * console.log(result.fieldReport); // Field usage report
+ * ```
+ */
+export declare function processLegalMarkdown(content: string, options?: LegalMarkdownOptions): {
+    content: string;
+    metadata?: Record<string, any>;
+    exportedFiles?: string[];
+    fieldReport?: ReturnType<typeof fieldTracker.generateReport>;
+};
+/**
+ * Generate HTML from Legal Markdown content
+ *
+ * This function processes Legal Markdown content and generates a complete HTML
+ * document with styling, field highlighting, and responsive design features.
+ * It combines the Legal Markdown processing pipeline with HTML generation.
+ *
+ * @async
+ * @param {string} content - The raw Legal Markdown content to convert
+ * @param {LegalMarkdownOptions & Object} [options={}] - Configuration options
+ * @param {string} [options.cssPath] - Path to custom CSS file
+ * @param {string} [options.highlightCssPath] - Path to field highlighting CSS
+ * @param {boolean} [options.includeHighlighting] - Whether to include field highlighting
+ * @param {string} [options.title] - Document title for HTML
+ * @returns {Promise<string>} A promise that resolves to the complete HTML document
+ * @throws {Error} When HTML generation fails
+ * @example
+ * ```typescript
+ * const html = await generateHtml(content, {
+ *   title: 'Service Agreement',
+ *   cssPath: './custom-styles.css',
+ *   includeHighlighting: true,
+ *   enableFieldTracking: true
+ * });
+ * ```
+ */
+export declare function generateHtml(content: string, options?: LegalMarkdownOptions & {
+    cssPath?: string;
+    highlightCssPath?: string;
+    includeHighlighting?: boolean;
+    title?: string;
+}): Promise<string>;
+/**
+ * Generate PDF from Legal Markdown content
+ *
+ * This function processes Legal Markdown content and generates a PDF document
+ * with professional styling, field highlighting, and customizable page formatting.
+ * It combines the Legal Markdown processing pipeline with PDF generation.
+ *
+ * @async
+ * @param {string} content - The raw Legal Markdown content to convert
+ * @param {string} outputPath - File path where the PDF will be saved
+ * @param {LegalMarkdownOptions & Object} [options={}] - Configuration options
+ * @param {string} [options.cssPath] - Path to custom CSS file
+ * @param {string} [options.highlightCssPath] - Path to field highlighting CSS
+ * @param {boolean} [options.includeHighlighting] - Whether to include field highlighting
+ * @param {string} [options.title] - Document title for PDF
+ * @param {'A4' | 'Letter' | 'Legal'} [options.format] - Page format
+ * @param {boolean} [options.landscape] - Whether to use landscape orientation
+ * @returns {Promise<Buffer>} A promise that resolves to the PDF buffer
+ * @throws {Error} When PDF generation fails
+ * @example
+ * ```typescript
+ * const pdf = await generatePdf(content, './contract.pdf', {
+ *   title: 'Service Agreement',
+ *   format: 'A4',
+ *   includeHighlighting: true,
+ *   enableFieldTracking: true
+ * });
+ * ```
+ */
+export declare function generatePdf(content: string, outputPath: string, options?: LegalMarkdownOptions & {
+    cssPath?: string;
+    highlightCssPath?: string;
+    includeHighlighting?: boolean;
+    title?: string;
+    format?: 'A4' | 'Letter' | 'Legal';
+    landscape?: boolean;
+}): Promise<Buffer>;
+/**
+ * Generate both normal and highlighted PDF versions
+ *
+ * This function creates two PDF versions of the same Legal Markdown document:
+ * one with standard formatting and another with field highlighting enabled.
+ * This is useful for document review processes where both clean and annotated
+ * versions are needed.
+ *
+ * @async
+ * @param {string} content - The raw Legal Markdown content to convert
+ * @param {string} outputPath - Base file path for PDFs (will be modified for each version)
+ * @param {LegalMarkdownOptions & Object} [options={}] - Configuration options
+ * @param {string} [options.cssPath] - Path to custom CSS file
+ * @param {string} [options.highlightCssPath] - Path to field highlighting CSS
+ * @param {string} [options.title] - Document title for PDFs
+ * @param {'A4' | 'Letter' | 'Legal'} [options.format] - Page format
+ * @param {boolean} [options.landscape] - Whether to use landscape orientation
+ * @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
+ * @example
+ * ```typescript
+ * const { normal, highlighted } = await generatePdfVersions(content, './contract.pdf', {
+ *   title: 'Service Agreement',
+ *   format: 'A4'
+ * });
+ * // Creates: contract.pdf and contract.HIGHLIGHT.pdf
+ * ```
+ */
+export declare function generatePdfVersions(content: string, outputPath: string, options?: LegalMarkdownOptions & {
+    cssPath?: string;
+    highlightCssPath?: string;
+    title?: string;
+    format?: 'A4' | 'Letter' | 'Legal';
+    landscape?: boolean;
+}): Promise<{
+    normal: Buffer;
+    highlighted: Buffer;
+}>;
+export * from '@types';
+export * from '@core';
+export * from '@errors';
+export * from '@constants';
+export * from '@lib';
+export * from '@extensions';
+export { fieldTracker } from './tracking/field-tracker';
+export { htmlGenerator } from './generators/html-generator';
+export { pdfGenerator } from './generators/pdf-generator';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAcH,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAGxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAG9C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,yBAAyB,CAC7C,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC;IACT,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,WAAW,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,cAAc,CAAC,CAAC;CAC9D,CAAC,CAoED;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,oBAAyB,GACjC;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,WAAW,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,cAAc,CAAC,CAAC;CAC9D,CAoEA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,YAAY,CAChC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,oBAAoB,GAAG;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;CACX,GACL,OAAO,CAAC,MAAM,CAAC,CAejB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,WAAW,CAC/B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,oBAAoB,GAAG;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,OAAO,CAAC;IACnC,SAAS,CAAC,EAAE,OAAO,CAAC;CAChB,GACL,OAAO,CAAC,MAAM,CAAC,CAiBjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,oBAAoB,GAAG;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,OAAO,CAAC;IACnC,SAAS,CAAC,EAAE,OAAO,CAAC;CAChB,GACL,OAAO,CAAC;IACT,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC,CAUD;AAGD,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,MAAM,CAAC;AACrB,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/index.js

@@ -0,0 +1,384 @@
+"use strict";
+/**
+ * @fileoverview Main Entry Point for Legal Markdown Processing Library
+ *
+ * This module provides the primary API for processing Legal Markdown documents
+ * with support for YAML front matter, cross-references, optional clauses, mixins,
+ * header processing, and multi-format output generation (HTML, PDF).
+ *
+ * Features:
+ * - YAML front matter parsing and metadata extraction
+ * - Cross-reference processing and resolution
+ * - Optional clause conditional rendering
+ * - Mixin system for reusable content blocks
+ * - Header numbering and formatting
+ * - Field tracking for document highlighting
+ * - HTML and PDF generation with styling
+ * - RST and LaTeX preprocessing support
+ * - Metadata export capabilities
+ *
+ * @example
+ * ```typescript
+ * import { processLegalMarkdown, generateHtml, generatePdf } from 'legal-markdown-js';
+ *
+ * // Basic document processing
+ * const result = processLegalMarkdown(content, {
+ *   enableFieldTracking: true,
+ *   basePath: './documents'
+ * });
+ *
+ * // Generate HTML output
+ * const html = await generateHtml(content, {
+ *   title: 'Legal Agreement',
+ *   includeHighlighting: true
+ * });
+ *
+ * // Generate PDF output
+ * const pdf = await generatePdf(content, './output.pdf', {
+ *   format: 'A4',
+ *   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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pdfGenerator = exports.htmlGenerator = exports.fieldTracker = void 0;
+exports.processLegalMarkdownAsync = processLegalMarkdownAsync;
+exports.processLegalMarkdown = processLegalMarkdown;
+exports.generateHtml = generateHtml;
+exports.generatePdf = generatePdf;
+exports.generatePdfVersions = generatePdfVersions;
+const yaml_parser_1 = require("./core/parsers/yaml-parser");
+const header_processor_1 = require("./core/processors/header-processor");
+const clause_processor_1 = require("./core/processors/clause-processor");
+const reference_processor_1 = require("./core/processors/reference-processor");
+const import_processor_1 = require("./core/processors/import-processor");
+const mixin_processor_1 = require("./core/processors/mixin-processor");
+const metadata_exporter_1 = require("./core/exporters/metadata-exporter");
+const rst_parser_1 = require("./extensions/rst-parser");
+const latex_parser_1 = require("./extensions/latex-parser");
+const field_tracker_1 = require("./tracking/field-tracker");
+const html_generator_1 = require("./generators/html-generator");
+const pdf_generator_1 = require("./generators/pdf-generator");
+const path_1 = __importDefault(require("path"));
+/**
+ * Main function to process a Legal Markdown document (async version)
+ *
+ * This function orchestrates the complete processing pipeline for Legal Markdown
+ * documents, including YAML parsing, content preprocessing, clause processing,
+ * cross-reference resolution, mixin expansion, header formatting, and metadata export.
+ *
+ * @param {string} content - The raw Legal Markdown content to process
+ * @param {LegalMarkdownOptions} [options={}] - Configuration options for processing
+ * @returns {Promise<Object>} Processing result containing processed content, metadata, and reports
+ * @returns {string} returns.content - The processed document content
+ * @returns {Record<string, any>} [returns.metadata] - Extracted YAML metadata
+ * @returns {string[]} [returns.exportedFiles] - Array of exported metadata files
+ * @returns {Object} [returns.fieldReport] - Field tracking report if enabled
+ * @example
+ * ```typescript
+ * const result = await processLegalMarkdownAsync(content, {
+ *   enableFieldTracking: true,
+ *   basePath: './documents',
+ *   noClauses: false,
+ *   noReferences: false
+ * });
+ *
+ * console.log(result.content); // Processed markdown
+ * console.log(result.metadata); // YAML front matter
+ * console.log(result.fieldReport); // Field usage report
+ * ```
+ */
+async function processLegalMarkdownAsync(content, options = {}) {
+    // Clear field tracker for new document
+    field_tracker_1.fieldTracker.clear();
+    // Convert RST or LaTeX to legal markdown if needed (before YAML parsing)
+    let preprocessedContent = await (0, rst_parser_1.convertRstToLegalMarkdown)(content);
+    preprocessedContent = await (0, latex_parser_1.convertLatexToLegalMarkdown)(preprocessedContent);
+    // Parse YAML Front Matter
+    const { content: contentWithoutYaml, metadata } = (0, yaml_parser_1.parseYamlFrontMatter)(preprocessedContent, options.throwOnYamlError);
+    // If only processing YAML, return early
+    if (options.yamlOnly) {
+        return { content: contentWithoutYaml, metadata };
+    }
+    // Process partial imports (must be done early)
+    let processedContent = contentWithoutYaml;
+    let exportedFiles = [];
+    if (!options.noImports) {
+        const importResult = (0, import_processor_1.processPartialImports)(processedContent, options.basePath);
+        processedContent = importResult.content;
+        exportedFiles = importResult.importedFiles;
+    }
+    // Process optional clauses
+    if (!options.noClauses) {
+        processedContent = (0, clause_processor_1.processOptionalClauses)(processedContent, metadata);
+    }
+    // Process cross references
+    if (!options.noReferences) {
+        processedContent = (0, reference_processor_1.processCrossReferences)(processedContent, metadata);
+    }
+    // Process mixins
+    if (!options.noMixins) {
+        processedContent = (0, mixin_processor_1.processMixins)(processedContent, metadata, options);
+    }
+    // Process headers (numbering, etc)
+    if (!options.noHeaders) {
+        processedContent = (0, header_processor_1.processHeaders)(processedContent, metadata, {
+            noReset: options.noReset,
+            noIndent: options.noIndent,
+        });
+    }
+    // Export metadata if requested or specified in metadata
+    if (options.exportMetadata || metadata['meta-yaml-output'] || metadata['meta-json-output']) {
+        const exportResult = (0, metadata_exporter_1.exportMetadata)(metadata, options.exportFormat, options.exportPath);
+        exportedFiles = [...exportedFiles, ...exportResult.exportedFiles];
+    }
+    // Apply field tracking to content if highlighting is enabled
+    if (options.enableFieldTracking) {
+        processedContent = field_tracker_1.fieldTracker.applyFieldTracking(processedContent);
+    }
+    return {
+        content: processedContent,
+        metadata,
+        exportedFiles,
+        fieldReport: options.enableFieldTracking ? field_tracker_1.fieldTracker.generateReport() : undefined,
+    };
+}
+/**
+ * Main function to process a Legal Markdown document (sync version with fallback)
+ *
+ * This function uses fallback parsers for RST/LaTeX to maintain backward compatibility
+ * and ensure the library works without pandoc dependencies.
+ *
+ * @param {string} content - The raw Legal Markdown content to process
+ * @param {LegalMarkdownOptions} [options={}] - Configuration options for processing
+ * @returns {Object} Processing result containing processed content, metadata, and reports
+ * @returns {string} returns.content - The processed document content
+ * @returns {Record<string, any>} [returns.metadata] - Extracted YAML metadata
+ * @returns {string[]} [returns.exportedFiles] - Array of exported metadata files
+ * @returns {Object} [returns.fieldReport] - Field tracking report if enabled
+ * @example
+ * ```typescript
+ * const result = processLegalMarkdown(content, {
+ *   enableFieldTracking: true,
+ *   basePath: './documents',
+ *   noClauses: false,
+ *   noReferences: false
+ * });
+ *
+ * console.log(result.content); // Processed markdown
+ * console.log(result.metadata); // YAML front matter
+ * console.log(result.fieldReport); // Field usage report
+ * ```
+ */
+function processLegalMarkdown(content, options = {}) {
+    // Clear field tracker for new document
+    field_tracker_1.fieldTracker.clear();
+    // Convert RST or LaTeX to legal markdown if needed (before YAML parsing)
+    let preprocessedContent = (0, rst_parser_1.convertRstToLegalMarkdownSync)(content);
+    preprocessedContent = (0, latex_parser_1.convertLatexToLegalMarkdownSync)(preprocessedContent);
+    // Parse YAML Front Matter
+    const { content: contentWithoutYaml, metadata } = (0, yaml_parser_1.parseYamlFrontMatter)(preprocessedContent, options.throwOnYamlError);
+    // If only processing YAML, return early
+    if (options.yamlOnly) {
+        return { content: contentWithoutYaml, metadata };
+    }
+    // Process partial imports (must be done early)
+    let processedContent = contentWithoutYaml;
+    let exportedFiles = [];
+    if (!options.noImports) {
+        const importResult = (0, import_processor_1.processPartialImports)(processedContent, options.basePath);
+        processedContent = importResult.content;
+        exportedFiles = importResult.importedFiles;
+    }
+    // Process optional clauses
+    if (!options.noClauses) {
+        processedContent = (0, clause_processor_1.processOptionalClauses)(processedContent, metadata);
+    }
+    // Process cross references
+    if (!options.noReferences) {
+        processedContent = (0, reference_processor_1.processCrossReferences)(processedContent, metadata);
+    }
+    // Process mixins
+    if (!options.noMixins) {
+        processedContent = (0, mixin_processor_1.processMixins)(processedContent, metadata, options);
+    }
+    // Process headers (numbering, etc)
+    if (!options.noHeaders) {
+        processedContent = (0, header_processor_1.processHeaders)(processedContent, metadata, {
+            noReset: options.noReset,
+            noIndent: options.noIndent,
+        });
+    }
+    // Export metadata if requested or specified in metadata
+    if (options.exportMetadata || metadata['meta-yaml-output'] || metadata['meta-json-output']) {
+        const exportResult = (0, metadata_exporter_1.exportMetadata)(metadata, options.exportFormat, options.exportPath);
+        exportedFiles = [...exportedFiles, ...exportResult.exportedFiles];
+    }
+    // Apply field tracking to content if highlighting is enabled
+    if (options.enableFieldTracking) {
+        processedContent = field_tracker_1.fieldTracker.applyFieldTracking(processedContent);
+    }
+    return {
+        content: processedContent,
+        metadata,
+        exportedFiles,
+        fieldReport: options.enableFieldTracking ? field_tracker_1.fieldTracker.generateReport() : undefined,
+    };
+}
+/**
+ * Generate HTML from Legal Markdown content
+ *
+ * This function processes Legal Markdown content and generates a complete HTML
+ * document with styling, field highlighting, and responsive design features.
+ * It combines the Legal Markdown processing pipeline with HTML generation.
+ *
+ * @async
+ * @param {string} content - The raw Legal Markdown content to convert
+ * @param {LegalMarkdownOptions & Object} [options={}] - Configuration options
+ * @param {string} [options.cssPath] - Path to custom CSS file
+ * @param {string} [options.highlightCssPath] - Path to field highlighting CSS
+ * @param {boolean} [options.includeHighlighting] - Whether to include field highlighting
+ * @param {string} [options.title] - Document title for HTML
+ * @returns {Promise<string>} A promise that resolves to the complete HTML document
+ * @throws {Error} When HTML generation fails
+ * @example
+ * ```typescript
+ * const html = await generateHtml(content, {
+ *   title: 'Service Agreement',
+ *   cssPath: './custom-styles.css',
+ *   includeHighlighting: true,
+ *   enableFieldTracking: true
+ * });
+ * ```
+ */
+async function generateHtml(content, options = {}) {
+    // Process the legal markdown first (use async version for better RST/LaTeX support)
+    const processed = await processLegalMarkdownAsync(content, {
+        ...options,
+        enableFieldTracking: options.includeHighlighting,
+    });
+    // Generate HTML
+    return html_generator_1.htmlGenerator.generateHtml(processed.content, {
+        cssPath: options.cssPath,
+        highlightCssPath: options.highlightCssPath || path_1.default.join(__dirname, '../styles/highlight.css'),
+        includeHighlighting: options.includeHighlighting,
+        title: options.title,
+        metadata: processed.metadata,
+    });
+}
+/**
+ * Generate PDF from Legal Markdown content
+ *
+ * This function processes Legal Markdown content and generates a PDF document
+ * with professional styling, field highlighting, and customizable page formatting.
+ * It combines the Legal Markdown processing pipeline with PDF generation.
+ *
+ * @async
+ * @param {string} content - The raw Legal Markdown content to convert
+ * @param {string} outputPath - File path where the PDF will be saved
+ * @param {LegalMarkdownOptions & Object} [options={}] - Configuration options
+ * @param {string} [options.cssPath] - Path to custom CSS file
+ * @param {string} [options.highlightCssPath] - Path to field highlighting CSS
+ * @param {boolean} [options.includeHighlighting] - Whether to include field highlighting
+ * @param {string} [options.title] - Document title for PDF
+ * @param {'A4' | 'Letter' | 'Legal'} [options.format] - Page format
+ * @param {boolean} [options.landscape] - Whether to use landscape orientation
+ * @returns {Promise<Buffer>} A promise that resolves to the PDF buffer
+ * @throws {Error} When PDF generation fails
+ * @example
+ * ```typescript
+ * const pdf = await generatePdf(content, './contract.pdf', {
+ *   title: 'Service Agreement',
+ *   format: 'A4',
+ *   includeHighlighting: true,
+ *   enableFieldTracking: true
+ * });
+ * ```
+ */
+async function generatePdf(content, outputPath, options = {}) {
+    // Process the legal markdown first (use async version for better RST/LaTeX support)
+    const processed = await processLegalMarkdownAsync(content, {
+        ...options,
+        enableFieldTracking: options.includeHighlighting,
+    });
+    // Generate PDF
+    return pdf_generator_1.pdfGenerator.generatePdf(processed.content, outputPath, {
+        cssPath: options.cssPath,
+        highlightCssPath: options.highlightCssPath || path_1.default.join(__dirname, '../styles/highlight.css'),
+        includeHighlighting: options.includeHighlighting,
+        title: options.title,
+        metadata: processed.metadata,
+        format: options.format,
+        landscape: options.landscape,
+    });
+}
+/**
+ * Generate both normal and highlighted PDF versions
+ *
+ * This function creates two PDF versions of the same Legal Markdown document:
+ * one with standard formatting and another with field highlighting enabled.
+ * This is useful for document review processes where both clean and annotated
+ * versions are needed.
+ *
+ * @async
+ * @param {string} content - The raw Legal Markdown content to convert
+ * @param {string} outputPath - Base file path for PDFs (will be modified for each version)
+ * @param {LegalMarkdownOptions & Object} [options={}] - Configuration options
+ * @param {string} [options.cssPath] - Path to custom CSS file
+ * @param {string} [options.highlightCssPath] - Path to field highlighting CSS
+ * @param {string} [options.title] - Document title for PDFs
+ * @param {'A4' | 'Letter' | 'Legal'} [options.format] - Page format
+ * @param {boolean} [options.landscape] - Whether to use landscape orientation
+ * @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
+ * @example
+ * ```typescript
+ * const { normal, highlighted } = await generatePdfVersions(content, './contract.pdf', {
+ *   title: 'Service Agreement',
+ *   format: 'A4'
+ * });
+ * // Creates: contract.pdf and contract.HIGHLIGHT.pdf
+ * ```
+ */
+async function generatePdfVersions(content, outputPath, options = {}) {
+    const normalPath = outputPath;
+    const highlightedPath = outputPath.replace('.pdf', '.HIGHLIGHT.pdf');
+    const [normal, highlighted] = await Promise.all([
+        generatePdf(content, normalPath, { ...options, includeHighlighting: false }),
+        generatePdf(content, highlightedPath, { ...options, includeHighlighting: true }),
+    ]);
+    return { normal, highlighted };
+}
+// Export all sub-modules
+__exportStar(require("./types.js"), exports);
+__exportStar(require("./core/index.js"), exports);
+__exportStar(require("./errors/index.js"), exports);
+__exportStar(require("./constants/index.js"), exports);
+__exportStar(require("./lib/index.js"), exports);
+__exportStar(require("./extensions/index.js"), exports);
+var field_tracker_2 = require("./tracking/field-tracker");
+Object.defineProperty(exports, "fieldTracker", { enumerable: true, get: function () { return field_tracker_2.fieldTracker; } });
+var html_generator_2 = require("./generators/html-generator");
+Object.defineProperty(exports, "htmlGenerator", { enumerable: true, get: function () { return html_generator_2.htmlGenerator; } });
+var pdf_generator_2 = require("./generators/pdf-generator");
+Object.defineProperty(exports, "pdfGenerator", { enumerable: true, get: function () { return pdf_generator_2.pdfGenerator; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;;;;;;;;;;;;;;;;;;;;AAgDH,8DA4EC;AA6BD,oDA4EC;AA4BD,oCAuBC;AA+BD,kCA4BC;AAgCD,kDAuBC;AAxYD,2DAAiE;AACjE,wEAAmE;AACnE,wEAA2E;AAC3E,8EAA8E;AAC9E,wEAA0E;AAC1E,sEAAiE;AACjE,yEAAmE;AACnE,uDAAkG;AAClG,2DAGkC;AAClC,4DAAwD;AACxD,gEAA4D;AAC5D,8DAA0D;AAE1D,gDAAwB;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,KAAK,UAAU,yBAAyB,CAC7C,OAAe,EACf,UAAgC,EAAE;IAOlC,uCAAuC;IACvC,4BAAY,CAAC,KAAK,EAAE,CAAC;IACrB,yEAAyE;IACzE,IAAI,mBAAmB,GAAG,MAAM,IAAA,sCAAyB,EAAC,OAAO,CAAC,CAAC;IACnE,mBAAmB,GAAG,MAAM,IAAA,0CAA2B,EAAC,mBAAmB,CAAC,CAAC;IAE7E,0BAA0B;IAC1B,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,GAAG,IAAA,kCAAoB,EACpE,mBAAmB,EACnB,OAAO,CAAC,gBAAgB,CACzB,CAAC;IAEF,wCAAwC;IACxC,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,CAAC;IACnD,CAAC;IAED,+CAA+C;IAC/C,IAAI,gBAAgB,GAAG,kBAAkB,CAAC;IAC1C,IAAI,aAAa,GAAa,EAAE,CAAC;IAEjC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,YAAY,GAAG,IAAA,wCAAqB,EAAC,gBAAgB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/E,gBAAgB,GAAG,YAAY,CAAC,OAAO,CAAC;QACxC,aAAa,GAAG,YAAY,CAAC,aAAa,CAAC;IAC7C,CAAC;IAED,2BAA2B;IAC3B,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,gBAAgB,GAAG,IAAA,yCAAsB,EAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,2BAA2B;IAC3B,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;QAC1B,gBAAgB,GAAG,IAAA,4CAAsB,EAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,iBAAiB;IACjB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,gBAAgB,GAAG,IAAA,+BAAa,EAAC,gBAAgB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,mCAAmC;IACnC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,gBAAgB,GAAG,IAAA,iCAAc,EAAC,gBAAgB,EAAE,QAAQ,EAAE;YAC5D,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,wDAAwD;IACxD,IAAI,OAAO,CAAC,cAAc,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC3F,MAAM,YAAY,GAAG,IAAA,kCAAc,EAAC,QAAQ,EAAE,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACxF,aAAa,GAAG,CAAC,GAAG,aAAa,EAAE,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;IACpE,CAAC;IAED,6DAA6D;IAC7D,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;QAChC,gBAAgB,GAAG,4BAAY,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IACvE,CAAC;IAED,OAAO;QACL,OAAO,EAAE,gBAAgB;QACzB,QAAQ;QACR,aAAa;QACb,WAAW,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,4BAAY,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS;KACrF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,oBAAoB,CAClC,OAAe,EACf,UAAgC,EAAE;IAOlC,uCAAuC;IACvC,4BAAY,CAAC,KAAK,EAAE,CAAC;IACrB,yEAAyE;IACzE,IAAI,mBAAmB,GAAG,IAAA,0CAA6B,EAAC,OAAO,CAAC,CAAC;IACjE,mBAAmB,GAAG,IAAA,8CAA+B,EAAC,mBAAmB,CAAC,CAAC;IAE3E,0BAA0B;IAC1B,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,GAAG,IAAA,kCAAoB,EACpE,mBAAmB,EACnB,OAAO,CAAC,gBAAgB,CACzB,CAAC;IAEF,wCAAwC;IACxC,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,CAAC;IACnD,CAAC;IAED,+CAA+C;IAC/C,IAAI,gBAAgB,GAAG,kBAAkB,CAAC;IAC1C,IAAI,aAAa,GAAa,EAAE,CAAC;IAEjC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,YAAY,GAAG,IAAA,wCAAqB,EAAC,gBAAgB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/E,gBAAgB,GAAG,YAAY,CAAC,OAAO,CAAC;QACxC,aAAa,GAAG,YAAY,CAAC,aAAa,CAAC;IAC7C,CAAC;IAED,2BAA2B;IAC3B,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,gBAAgB,GAAG,IAAA,yCAAsB,EAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,2BAA2B;IAC3B,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;QAC1B,gBAAgB,GAAG,IAAA,4CAAsB,EAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,iBAAiB;IACjB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,gBAAgB,GAAG,IAAA,+BAAa,EAAC,gBAAgB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,mCAAmC;IACnC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,gBAAgB,GAAG,IAAA,iCAAc,EAAC,gBAAgB,EAAE,QAAQ,EAAE;YAC5D,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,wDAAwD;IACxD,IAAI,OAAO,CAAC,cAAc,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC3F,MAAM,YAAY,GAAG,IAAA,kCAAc,EAAC,QAAQ,EAAE,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACxF,aAAa,GAAG,CAAC,GAAG,aAAa,EAAE,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;IACpE,CAAC;IAED,6DAA6D;IAC7D,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;QAChC,gBAAgB,GAAG,4BAAY,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IACvE,CAAC;IAED,OAAO;QACL,OAAO,EAAE,gBAAgB;QACzB,QAAQ;QACR,aAAa;QACb,WAAW,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,4BAAY,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS;KACrF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,KAAK,UAAU,YAAY,CAChC,OAAe,EACf,UAKI,EAAE;IAEN,oFAAoF;IACpF,MAAM,SAAS,GAAG,MAAM,yBAAyB,CAAC,OAAO,EAAE;QACzD,GAAG,OAAO;QACV,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;KACjD,CAAC,CAAC;IAEH,gBAAgB;IAChB,OAAO,8BAAa,CAAC,YAAY,CAAC,SAAS,CAAC,OAAO,EAAE;QACnD,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,yBAAyB,CAAC;QAC7F,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;QAChD,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,QAAQ,EAAE,SAAS,CAAC,QAAQ;KAC7B,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,WAAW,CAC/B,OAAe,EACf,UAAkB,EAClB,UAOI,EAAE;IAEN,oFAAoF;IACpF,MAAM,SAAS,GAAG,MAAM,yBAAyB,CAAC,OAAO,EAAE;QACzD,GAAG,OAAO;QACV,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;KACjD,CAAC,CAAC;IAEH,eAAe;IACf,OAAO,4BAAY,CAAC,WAAW,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,EAAE;QAC7D,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,yBAAyB,CAAC;QAC7F,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;QAChD,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,SAAS,EAAE,OAAO,CAAC,SAAS;KAC7B,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,KAAK,UAAU,mBAAmB,CACvC,OAAe,EACf,UAAkB,EAClB,UAMI,EAAE;IAKN,MAAM,UAAU,GAAG,UAAU,CAAC;IAC9B,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAErE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC9C,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,mBAAmB,EAAE,KAAK,EAAE,CAAC;QAC5E,WAAW,CAAC,OAAO,EAAE,eAAe,EAAE,EAAE,GAAG,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAC;KACjF,CAAC,CAAC;IAEH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;AACjC,CAAC;AAED,yBAAyB;AACzB,yCAAuB;AACvB,wCAAsB;AACtB,0CAAwB;AACxB,6CAA2B;AAC3B,uCAAqB;AACrB,8CAA4B;AAC5B,0DAAwD;AAA/C,6GAAA,YAAY,OAAA;AACrB,8DAA4D;AAAnD,+GAAA,aAAa,OAAA;AACtB,4DAA0D;AAAjD,6GAAA,YAAY,OAAA"}