@changerawr/markdown 1.0.3 → 1.0.5

package/README.md

@@ -299,7 +299,7 @@ const minimalEngine = createMinimalEngine();
 Perfect for Node.js, vanilla JavaScript, or any non-React environment:
 
 ```html
-<script src="https://unpkg.com/@changerawr/markdown/dist/standalone.js"></script>
+<script src="https://unpkg.com/@changerawr/markdown/dist/standalone.browser.js"></script>
 <script>
   const html = ChangerawrMarkdown.renderCum('# Hello World!');
   document.body.innerHTML = html;

package/dist/index.d.mts

@@ -164,6 +164,88 @@ declare function renderToHTMLWithConfig(markdown: string, rendererConfig: {
  */
 declare function renderToHTMLUnsafe(markdown: string): string;
 
+/**
+ * JSON AST output renderer - returns structured token data
+ */
+
+/**
+ * Parse markdown and return the token array as JSON
+ */
+declare function renderToJSON(markdown: string, config?: Omit<EngineConfig, 'renderer'>): MarkdownToken[];
+/**
+ * Parse markdown and return a hierarchical AST structure
+ */
+declare function renderToAST(markdown: string, config?: Omit<EngineConfig, 'renderer'>): JsonAstNode[];
+/**
+ * Convert flat token array to hierarchical AST
+ */
+declare function tokensToAST(tokens: MarkdownToken[]): JsonAstNode[];
+/**
+ * Convert AST back to flat tokens
+ */
+declare function astToTokens(ast: JsonAstNode[]): MarkdownToken[];
+/**
+ * Serialize tokens to JSON string with formatting
+ */
+declare function tokensToJSONString(tokens: MarkdownToken[], pretty?: boolean): string;
+/**
+ * Serialize AST to JSON string with formatting
+ */
+declare function astToJSONString(ast: JsonAstNode[], pretty?: boolean): string;
+/**
+ * Parse JSON string back to tokens
+ */
+declare function parseTokensFromJSON(jsonString: string): MarkdownToken[];
+/**
+ * Parse JSON string back to AST
+ */
+declare function parseASTFromJSON(jsonString: string): JsonAstNode[];
+/**
+ * Get comprehensive statistics from parsed tokens
+ */
+declare function getTokenStats(tokens: MarkdownToken[]): TokenStatistics;
+/**
+ * Get AST-specific statistics
+ */
+declare function getASTStats(ast: JsonAstNode[]): ASTStatistics;
+/**
+ * Compare two token arrays for differences
+ */
+declare function compareTokens(tokensA: MarkdownToken[], tokensB: MarkdownToken[]): TokenComparison;
+interface TokenStatistics {
+    totalTokens: number;
+    tokenTypes: Record<string, number>;
+    extensionTokens: Record<string, number>;
+    totalContent: number;
+    totalRaw: number;
+    tokensWithAttributes: number;
+    averageContentLength: number;
+    averageRawLength: number;
+    attributeUsageRate: number;
+}
+interface ASTStatistics {
+    totalNodes: number;
+    maxDepth: number;
+    nodesWithChildren: number;
+    totalChildren: number;
+    nodeTypes: Record<string, number>;
+    averageChildrenPerParent: number;
+    hierarchyComplexity: number;
+}
+interface TokenDifference {
+    index: number;
+    type: 'added' | 'removed' | 'modified';
+    tokenA?: MarkdownToken;
+    tokenB?: MarkdownToken;
+}
+interface TokenComparison {
+    identical: boolean;
+    differences: TokenDifference[];
+    addedCount: number;
+    removedCount: number;
+    modifiedCount: number;
+}
+
 /**
  * Tailwind CSS output renderer - HTML with Tailwind CSS classes
  */
@@ -185,19 +267,70 @@ declare function renderToTailwindWithConfig(markdown: string, rendererConfig: {
     customClasses?: Record<string, string>;
     debugMode?: boolean;
 }): string;
-
 /**
- * JSON AST output renderer - returns structured token data
+ * Default Tailwind configuration for common use cases
  */
-
+declare const defaultTailwindClasses: {
+    'heading-1': string;
+    'heading-2': string;
+    'heading-3': string;
+    'heading-4': string;
+    'heading-5': string;
+    'heading-6': string;
+    paragraph: string;
+    blockquote: string;
+    'code-inline': string;
+    'code-block': string;
+    link: string;
+    button: string;
+    list: string;
+    'list-item': string;
+    image: string;
+    embed: string;
+    alert: string;
+    'alert-info': string;
+    'alert-warning': string;
+    'alert-error': string;
+    'alert-success': string;
+};
 /**
- * Parse markdown and return the token array as JSON
+ * Prose-friendly Tailwind classes for blog/article content
  */
-declare function renderToJSON(markdown: string, config?: Omit<EngineConfig, 'renderer'>): MarkdownToken[];
+declare const proseClasses: {
+    'heading-1': string;
+    'heading-2': string;
+    'heading-3': string;
+    paragraph: string;
+    blockquote: string;
+    'code-inline': string;
+    'code-block': string;
+    link: string;
+};
 /**
- * Parse markdown and return a hierarchical AST structure
+ * Minimal Tailwind classes for clean, simple styling
  */
-declare function renderToAST(markdown: string, config?: Omit<EngineConfig, 'renderer'>): JsonAstNode[];
+declare const minimalClasses: {
+    'heading-1': string;
+    'heading-2': string;
+    'heading-3': string;
+    paragraph: string;
+    blockquote: string;
+    'code-inline': string;
+    'code-block': string;
+    link: string;
+};
+
+/**
+ * Standalone version of Changerawr Markdown for vanilla JavaScript usage
+ * No React dependencies - works in browser and Node.js environments
+ */
+
+declare function renderCum(markdown: string, config?: EngineConfig): string;
+declare function parseCum(markdown: string, config?: EngineConfig): MarkdownToken[];
+declare function createCumEngine(config?: EngineConfig): ChangerawrMarkdown;
+declare function renderCumToHtml(markdown: string): string;
+declare function renderCumToTailwind(markdown: string): string;
+declare function renderCumToJson(markdown: string): MarkdownToken[];
 
 /**
  * Utility functions for Changerawr Markdown
@@ -214,10 +347,34 @@ declare function generateId(text: string): string;
  * Sanitize HTML content using DOMPurify
  */
 declare function sanitizeHtml(html: string): string;
+/**
+ * Basic HTML sanitization - removes dangerous content
+ */
+declare function basicSanitize(html: string): string;
+/**
+ * Check if code is running in browser environment
+ */
+declare function isBrowser(): boolean;
+/**
+ * Check if code is running in Node.js environment
+ */
+declare function isNode(): boolean;
+/**
+ * Debounce function for performance optimization
+ */
+declare function debounce<T extends (...args: any[]) => any>(func: T, wait: number): (...args: Parameters<T>) => void;
+/**
+ * Deep merge two objects
+ */
+declare function deepMerge<T extends Record<string, any>>(target: T, source: Partial<T>): T;
 /**
  * Extract domain from URL
  */
 declare function extractDomain(url: string): string;
+/**
+ * Check if URL is valid
+ */
+declare function isValidUrl(url: string): boolean;
 /**
  * Parse options string into key-value object
  */
@@ -340,6 +497,8 @@ declare const markdown: {
     readonly createDebugEngine: typeof createDebugEngine;
     readonly createMinimalEngine: typeof createMinimalEngine;
     readonly createCustomEngine: typeof createCustomEngine;
+    readonly renderCum: typeof renderCum;
+    readonly parseCum: typeof parseCum;
     readonly ChangerawrMarkdown: typeof ChangerawrMarkdown;
     readonly extensions: {
         readonly Alert: Extension;
@@ -357,4 +516,70 @@ declare const markdown: {
     };
 };
 
-export { AlertExtension, ButtonExtension, ChangerawrMarkdown, type DebugInfo, EmbedExtension, type EngineConfig, type EngineEvents, type Extension, ExtensionError, type Extension as ExtensionInterface, type ExtensionRegistration, type JsonAstNode, Logger, MarkdownParseError, MarkdownParser, MarkdownRenderError, MarkdownRenderer, type MarkdownToken, type OutputFormat, type ParseRule, type ParserConfig, type PerformanceMetrics, PerformanceTimer, type RenderRule, type RendererConfig, type TokenType, createCustomEngine, createDebugEngine, createEngine, createHTMLEngine, createMinimalEngine, createTailwindEngine, markdown as default, escapeHtml, extractDomain, generateId, markdown, parseMarkdown, parseOptions, renderMarkdown, renderToAST, renderToHTML, renderToHTMLUnsafe, renderToHTMLWithConfig, renderToJSON, renderToTailwind, renderToTailwindWithClasses, renderToTailwindWithConfig, sanitizeHtml };
+/**
+ * Preset configurations for common use cases
+ */
+declare const presets: {
+    /**
+     * Blog/article preset with prose-friendly styling
+     */
+    readonly blog: {
+        readonly renderer: {
+            readonly format: "tailwind";
+            readonly customClasses: {
+                readonly 'heading-1': "text-4xl font-bold tracking-tight mt-10 mb-6";
+                readonly 'heading-2': "text-3xl font-semibold tracking-tight mt-8 mb-4";
+                readonly 'heading-3': "text-2xl font-medium tracking-tight mt-6 mb-3";
+                readonly paragraph: "text-lg leading-8 mb-6";
+                readonly blockquote: "border-l-4 border-gray-300 pl-6 py-2 italic text-gray-700 my-6";
+                readonly 'code-inline': "bg-gray-100 text-gray-800 px-2 py-1 rounded text-sm font-mono";
+                readonly 'code-block': "bg-gray-900 text-gray-100 p-6 rounded-lg overflow-x-auto my-6 text-sm";
+            };
+        };
+    };
+    /**
+     * Documentation preset with clean, technical styling
+     */
+    readonly docs: {
+        readonly renderer: {
+            readonly format: "tailwind";
+            readonly customClasses: {
+                readonly 'heading-1': "text-3xl font-bold border-b border-gray-200 pb-2 mb-6";
+                readonly 'heading-2': "text-2xl font-semibold mt-8 mb-4";
+                readonly 'heading-3': "text-xl font-medium mt-6 mb-3";
+                readonly paragraph: "leading-7 mb-4";
+                readonly 'code-inline': "bg-blue-50 text-blue-800 px-2 py-1 rounded text-sm font-mono";
+                readonly 'code-block': "bg-gray-50 border border-gray-200 p-4 rounded-lg overflow-x-auto my-4 text-sm";
+                readonly alert: "border border-blue-200 bg-blue-50 text-blue-800 p-4 rounded-lg mb-4";
+            };
+        };
+    };
+    /**
+     * Minimal preset with basic styling
+     */
+    readonly minimal: {
+        readonly renderer: {
+            readonly format: "html";
+            readonly sanitize: true;
+        };
+    };
+    /**
+     * Performance preset with minimal processing
+     */
+    readonly fast: {
+        readonly parser: {
+            readonly validateMarkdown: false;
+            readonly maxIterations: 1000;
+        };
+        readonly renderer: {
+            readonly format: "html";
+            readonly sanitize: false;
+        };
+    };
+};
+/**
+ * Create engine with preset configuration
+ */
+declare function createEngineWithPreset(presetName: keyof typeof presets, additionalConfig?: EngineConfig): ChangerawrMarkdown;
+
+export { type ASTStatistics, AlertExtension, ButtonExtension, ChangerawrMarkdown, type DebugInfo, EmbedExtension, type EngineConfig, type EngineEvents, type Extension, ExtensionError, type Extension as ExtensionInterface, type ExtensionRegistration, type JsonAstNode, Logger, MarkdownParseError, MarkdownParser, MarkdownRenderError, MarkdownRenderer, type MarkdownToken, type OutputFormat, type ParseRule, type ParserConfig, type PerformanceMetrics, PerformanceTimer, type RenderRule, type RendererConfig, type TokenComparison, type TokenDifference, type TokenStatistics, type TokenType, astToJSONString, astToTokens, basicSanitize, compareTokens, createCumEngine, createCustomEngine, createDebugEngine, createEngine, createEngineWithPreset, createHTMLEngine, createMinimalEngine, createTailwindEngine, debounce, deepMerge, markdown as default, defaultTailwindClasses, escapeHtml, extractDomain, generateId, getASTStats, getTokenStats, isBrowser, isNode, isValidUrl, markdown, minimalClasses, parseASTFromJSON, parseCum, parseMarkdown, parseOptions, parseTokensFromJSON, presets, proseClasses, renderCum, renderCumToHtml, renderCumToJson, renderCumToTailwind, renderMarkdown, renderToAST, renderToHTML, renderToHTMLUnsafe, renderToHTMLWithConfig, renderToJSON, renderToTailwind, renderToTailwindWithClasses, renderToTailwindWithConfig, sanitizeHtml, tokensToAST, tokensToJSONString };

package/dist/index.d.ts

@@ -164,6 +164,88 @@ declare function renderToHTMLWithConfig(markdown: string, rendererConfig: {
  */
 declare function renderToHTMLUnsafe(markdown: string): string;
 
+/**
+ * JSON AST output renderer - returns structured token data
+ */
+
+/**
+ * Parse markdown and return the token array as JSON
+ */
+declare function renderToJSON(markdown: string, config?: Omit<EngineConfig, 'renderer'>): MarkdownToken[];
+/**
+ * Parse markdown and return a hierarchical AST structure
+ */
+declare function renderToAST(markdown: string, config?: Omit<EngineConfig, 'renderer'>): JsonAstNode[];
+/**
+ * Convert flat token array to hierarchical AST
+ */
+declare function tokensToAST(tokens: MarkdownToken[]): JsonAstNode[];
+/**
+ * Convert AST back to flat tokens
+ */
+declare function astToTokens(ast: JsonAstNode[]): MarkdownToken[];
+/**
+ * Serialize tokens to JSON string with formatting
+ */
+declare function tokensToJSONString(tokens: MarkdownToken[], pretty?: boolean): string;
+/**
+ * Serialize AST to JSON string with formatting
+ */
+declare function astToJSONString(ast: JsonAstNode[], pretty?: boolean): string;
+/**
+ * Parse JSON string back to tokens
+ */
+declare function parseTokensFromJSON(jsonString: string): MarkdownToken[];
+/**
+ * Parse JSON string back to AST
+ */
+declare function parseASTFromJSON(jsonString: string): JsonAstNode[];
+/**
+ * Get comprehensive statistics from parsed tokens
+ */
+declare function getTokenStats(tokens: MarkdownToken[]): TokenStatistics;
+/**
+ * Get AST-specific statistics
+ */
+declare function getASTStats(ast: JsonAstNode[]): ASTStatistics;
+/**
+ * Compare two token arrays for differences
+ */
+declare function compareTokens(tokensA: MarkdownToken[], tokensB: MarkdownToken[]): TokenComparison;
+interface TokenStatistics {
+    totalTokens: number;
+    tokenTypes: Record<string, number>;
+    extensionTokens: Record<string, number>;
+    totalContent: number;
+    totalRaw: number;
+    tokensWithAttributes: number;
+    averageContentLength: number;
+    averageRawLength: number;
+    attributeUsageRate: number;
+}
+interface ASTStatistics {
+    totalNodes: number;
+    maxDepth: number;
+    nodesWithChildren: number;
+    totalChildren: number;
+    nodeTypes: Record<string, number>;
+    averageChildrenPerParent: number;
+    hierarchyComplexity: number;
+}
+interface TokenDifference {
+    index: number;
+    type: 'added' | 'removed' | 'modified';
+    tokenA?: MarkdownToken;
+    tokenB?: MarkdownToken;
+}
+interface TokenComparison {
+    identical: boolean;
+    differences: TokenDifference[];
+    addedCount: number;
+    removedCount: number;
+    modifiedCount: number;
+}
+
 /**
  * Tailwind CSS output renderer - HTML with Tailwind CSS classes
  */
@@ -185,19 +267,70 @@ declare function renderToTailwindWithConfig(markdown: string, rendererConfig: {
     customClasses?: Record<string, string>;
     debugMode?: boolean;
 }): string;
-
 /**
- * JSON AST output renderer - returns structured token data
+ * Default Tailwind configuration for common use cases
  */
-
+declare const defaultTailwindClasses: {
+    'heading-1': string;
+    'heading-2': string;
+    'heading-3': string;
+    'heading-4': string;
+    'heading-5': string;
+    'heading-6': string;
+    paragraph: string;
+    blockquote: string;
+    'code-inline': string;
+    'code-block': string;
+    link: string;
+    button: string;
+    list: string;
+    'list-item': string;
+    image: string;
+    embed: string;
+    alert: string;
+    'alert-info': string;
+    'alert-warning': string;
+    'alert-error': string;
+    'alert-success': string;
+};
 /**
- * Parse markdown and return the token array as JSON
+ * Prose-friendly Tailwind classes for blog/article content
  */
-declare function renderToJSON(markdown: string, config?: Omit<EngineConfig, 'renderer'>): MarkdownToken[];
+declare const proseClasses: {
+    'heading-1': string;
+    'heading-2': string;
+    'heading-3': string;
+    paragraph: string;
+    blockquote: string;
+    'code-inline': string;
+    'code-block': string;
+    link: string;
+};
 /**
- * Parse markdown and return a hierarchical AST structure
+ * Minimal Tailwind classes for clean, simple styling
  */
-declare function renderToAST(markdown: string, config?: Omit<EngineConfig, 'renderer'>): JsonAstNode[];
+declare const minimalClasses: {
+    'heading-1': string;
+    'heading-2': string;
+    'heading-3': string;
+    paragraph: string;
+    blockquote: string;
+    'code-inline': string;
+    'code-block': string;
+    link: string;
+};
+
+/**
+ * Standalone version of Changerawr Markdown for vanilla JavaScript usage
+ * No React dependencies - works in browser and Node.js environments
+ */
+
+declare function renderCum(markdown: string, config?: EngineConfig): string;
+declare function parseCum(markdown: string, config?: EngineConfig): MarkdownToken[];
+declare function createCumEngine(config?: EngineConfig): ChangerawrMarkdown;
+declare function renderCumToHtml(markdown: string): string;
+declare function renderCumToTailwind(markdown: string): string;
+declare function renderCumToJson(markdown: string): MarkdownToken[];
 
 /**
  * Utility functions for Changerawr Markdown
@@ -214,10 +347,34 @@ declare function generateId(text: string): string;
  * Sanitize HTML content using DOMPurify
  */
 declare function sanitizeHtml(html: string): string;
+/**
+ * Basic HTML sanitization - removes dangerous content
+ */
+declare function basicSanitize(html: string): string;
+/**
+ * Check if code is running in browser environment
+ */
+declare function isBrowser(): boolean;
+/**
+ * Check if code is running in Node.js environment
+ */
+declare function isNode(): boolean;
+/**
+ * Debounce function for performance optimization
+ */
+declare function debounce<T extends (...args: any[]) => any>(func: T, wait: number): (...args: Parameters<T>) => void;
+/**
+ * Deep merge two objects
+ */
+declare function deepMerge<T extends Record<string, any>>(target: T, source: Partial<T>): T;
 /**
  * Extract domain from URL
  */
 declare function extractDomain(url: string): string;
+/**
+ * Check if URL is valid
+ */
+declare function isValidUrl(url: string): boolean;
 /**
  * Parse options string into key-value object
  */
@@ -340,6 +497,8 @@ declare const markdown: {
     readonly createDebugEngine: typeof createDebugEngine;
     readonly createMinimalEngine: typeof createMinimalEngine;
     readonly createCustomEngine: typeof createCustomEngine;
+    readonly renderCum: typeof renderCum;
+    readonly parseCum: typeof parseCum;
     readonly ChangerawrMarkdown: typeof ChangerawrMarkdown;
     readonly extensions: {
         readonly Alert: Extension;
@@ -357,4 +516,70 @@ declare const markdown: {
     };
 };
 
-export { AlertExtension, ButtonExtension, ChangerawrMarkdown, type DebugInfo, EmbedExtension, type EngineConfig, type EngineEvents, type Extension, ExtensionError, type Extension as ExtensionInterface, type ExtensionRegistration, type JsonAstNode, Logger, MarkdownParseError, MarkdownParser, MarkdownRenderError, MarkdownRenderer, type MarkdownToken, type OutputFormat, type ParseRule, type ParserConfig, type PerformanceMetrics, PerformanceTimer, type RenderRule, type RendererConfig, type TokenType, createCustomEngine, createDebugEngine, createEngine, createHTMLEngine, createMinimalEngine, createTailwindEngine, markdown as default, escapeHtml, extractDomain, generateId, markdown, parseMarkdown, parseOptions, renderMarkdown, renderToAST, renderToHTML, renderToHTMLUnsafe, renderToHTMLWithConfig, renderToJSON, renderToTailwind, renderToTailwindWithClasses, renderToTailwindWithConfig, sanitizeHtml };
+/**
+ * Preset configurations for common use cases
+ */
+declare const presets: {
+    /**
+     * Blog/article preset with prose-friendly styling
+     */
+    readonly blog: {
+        readonly renderer: {
+            readonly format: "tailwind";
+            readonly customClasses: {
+                readonly 'heading-1': "text-4xl font-bold tracking-tight mt-10 mb-6";
+                readonly 'heading-2': "text-3xl font-semibold tracking-tight mt-8 mb-4";
+                readonly 'heading-3': "text-2xl font-medium tracking-tight mt-6 mb-3";
+                readonly paragraph: "text-lg leading-8 mb-6";
+                readonly blockquote: "border-l-4 border-gray-300 pl-6 py-2 italic text-gray-700 my-6";
+                readonly 'code-inline': "bg-gray-100 text-gray-800 px-2 py-1 rounded text-sm font-mono";
+                readonly 'code-block': "bg-gray-900 text-gray-100 p-6 rounded-lg overflow-x-auto my-6 text-sm";
+            };
+        };
+    };
+    /**
+     * Documentation preset with clean, technical styling
+     */
+    readonly docs: {
+        readonly renderer: {
+            readonly format: "tailwind";
+            readonly customClasses: {
+                readonly 'heading-1': "text-3xl font-bold border-b border-gray-200 pb-2 mb-6";
+                readonly 'heading-2': "text-2xl font-semibold mt-8 mb-4";
+                readonly 'heading-3': "text-xl font-medium mt-6 mb-3";
+                readonly paragraph: "leading-7 mb-4";
+                readonly 'code-inline': "bg-blue-50 text-blue-800 px-2 py-1 rounded text-sm font-mono";
+                readonly 'code-block': "bg-gray-50 border border-gray-200 p-4 rounded-lg overflow-x-auto my-4 text-sm";
+                readonly alert: "border border-blue-200 bg-blue-50 text-blue-800 p-4 rounded-lg mb-4";
+            };
+        };
+    };
+    /**
+     * Minimal preset with basic styling
+     */
+    readonly minimal: {
+        readonly renderer: {
+            readonly format: "html";
+            readonly sanitize: true;
+        };
+    };
+    /**
+     * Performance preset with minimal processing
+     */
+    readonly fast: {
+        readonly parser: {
+            readonly validateMarkdown: false;
+            readonly maxIterations: 1000;
+        };
+        readonly renderer: {
+            readonly format: "html";
+            readonly sanitize: false;
+        };
+    };
+};
+/**
+ * Create engine with preset configuration
+ */
+declare function createEngineWithPreset(presetName: keyof typeof presets, additionalConfig?: EngineConfig): ChangerawrMarkdown;
+
+export { type ASTStatistics, AlertExtension, ButtonExtension, ChangerawrMarkdown, type DebugInfo, EmbedExtension, type EngineConfig, type EngineEvents, type Extension, ExtensionError, type Extension as ExtensionInterface, type ExtensionRegistration, type JsonAstNode, Logger, MarkdownParseError, MarkdownParser, MarkdownRenderError, MarkdownRenderer, type MarkdownToken, type OutputFormat, type ParseRule, type ParserConfig, type PerformanceMetrics, PerformanceTimer, type RenderRule, type RendererConfig, type TokenComparison, type TokenDifference, type TokenStatistics, type TokenType, astToJSONString, astToTokens, basicSanitize, compareTokens, createCumEngine, createCustomEngine, createDebugEngine, createEngine, createEngineWithPreset, createHTMLEngine, createMinimalEngine, createTailwindEngine, debounce, deepMerge, markdown as default, defaultTailwindClasses, escapeHtml, extractDomain, generateId, getASTStats, getTokenStats, isBrowser, isNode, isValidUrl, markdown, minimalClasses, parseASTFromJSON, parseCum, parseMarkdown, parseOptions, parseTokensFromJSON, presets, proseClasses, renderCum, renderCumToHtml, renderCumToJson, renderCumToTailwind, renderMarkdown, renderToAST, renderToHTML, renderToHTMLUnsafe, renderToHTMLWithConfig, renderToJSON, renderToTailwind, renderToTailwindWithClasses, renderToTailwindWithConfig, sanitizeHtml, tokensToAST, tokensToJSONString };