legal-markdown-js
Version:
Node.js implementation of LegalMarkdown for processing legal documents with markdown and YAML - Complete feature parity with Ruby version
63 lines • 2.49 kB
TypeScript
/**
* Modern Browser Entry Point for Legal Markdown Processing
*
* This module provides a browser-optimized version that uses the full
* remark-based processing pipeline. It requires a modern bundler (Vite)
* that can handle ESM dependencies properly.
*
* Features:
* - Full remark AST-based processing
* - All Legal Markdown syntax support
* - Async-only API for better performance
* - No legacy fallbacks
*
* @module browser-modern
*/
import { LegalMarkdownProcessorOptions, LegalMarkdownProcessorResult } from './extensions/remark/legal-markdown-processor.js';
import { markdownToHtmlBody, formatHtml, wrapHtmlDocument } from './utils/html-format.js';
import { generateDocxBuffer } from './extensions/generators/docx-browser.js';
export type { DocxBrowserOptions } from './extensions/generators/docx-browser.js';
export { generateDocxBuffer };
export type { LegalMarkdownProcessorOptions, LegalMarkdownProcessorResult };
/**
* Process Legal Markdown content using the modern remark pipeline
*
* This is the primary API for browser usage. It provides full feature
* parity with the CLI version, including all syntax features and
* processing capabilities.
*
* @param content - The Legal Markdown content to process
* @param options - Processing options
* @returns Promise resolving to processed content and metadata
*
* @example
* ```typescript
* const result = await processLegalMarkdown(content, {
* enableFieldTracking: true,
* debug: false
* });
* console.log(result.content); // Processed markdown
* console.log(result.metadata); // Extracted metadata
* ```
*/
export declare function processLegalMarkdownAsync(content: string, options?: LegalMarkdownProcessorOptions): Promise<LegalMarkdownProcessorResult>;
export declare const processLegalMarkdown: typeof processLegalMarkdownAsync;
/**
* Default export for UMD compatibility
*
* Provides the modern API in a format compatible with script tags
* and legacy module systems.
*/
declare const LegalMarkdown: {
processLegalMarkdownAsync: typeof processLegalMarkdownAsync;
processLegalMarkdown: typeof processLegalMarkdownAsync;
process: typeof processLegalMarkdownAsync;
markdownToHtmlBody: typeof markdownToHtmlBody;
formatHtml: typeof formatHtml;
wrapHtmlDocument: typeof wrapHtmlDocument;
generateDocxBuffer: typeof generateDocxBuffer;
version: string;
isModernBundle: boolean;
};
export default LegalMarkdown;
//# sourceMappingURL=browser-modern.d.ts.map