@kreuzberg/html-to-markdown-wasm 2.19.4 → 2.19.6

package/dist/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2024-2025 Na'aman Hirschfeld
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/README.md

@@ -0,0 +1,148 @@
+# html-to-markdown
+
+<div align="center" style="display: flex; flex-wrap: wrap; gap: 8px; justify-content: center; margin: 20px 0;">
+  <!-- Language Bindings -->
+  <a href="https://crates.io/crates/html-to-markdown-rs">
+    <img src="https://img.shields.io/crates/v/html-to-markdown-rs?label=Rust&color=007ec6" alt="Rust">
+  </a>
+  <a href="https://pypi.org/project/html-to-markdown/">
+    <img src="https://img.shields.io/pypi/v/html-to-markdown?label=Python&color=007ec6" alt="Python">
+  </a>
+  <a href="https://www.npmjs.com/package/@kreuzberg/html-to-markdown-node">
+    <img src="https://img.shields.io/npm/v/@kreuzberg/html-to-markdown-node?label=Node.js&color=007ec6" alt="Node.js">
+  </a>
+  <a href="https://www.npmjs.com/package/@kreuzberg/html-to-markdown-wasm">
+    <img src="https://img.shields.io/npm/v/@kreuzberg/html-to-markdown-wasm?label=WASM&color=007ec6" alt="WASM">
+  </a>
+  <a href="https://central.sonatype.com/artifact/dev.kreuzberg/html-to-markdown">
+    <img src="https://img.shields.io/maven-central/v/dev.kreuzberg/html-to-markdown?label=Java&color=007ec6" alt="Java">
+  </a>
+  <a href="https://pkg.go.dev/github.com/kreuzberg-dev/html-to-markdown/packages/go/v2/htmltomarkdown">
+    <img src="https://img.shields.io/badge/Go-v2.19.0-007ec6" alt="Go">
+  </a>
+  <a href="https://www.nuget.org/packages/KreuzbergDev.HtmlToMarkdown/">
+    <img src="https://img.shields.io/nuget/v/KreuzbergDev.HtmlToMarkdown?label=C%23&color=007ec6" alt="C#">
+  </a>
+  <a href="https://packagist.org/packages/goldziher/html-to-markdown">
+    <img src="https://img.shields.io/packagist/v/goldziher/html-to-markdown?label=PHP&color=007ec6" alt="PHP">
+  </a>
+  <a href="https://rubygems.org/gems/html-to-markdown">
+    <img src="https://img.shields.io/gem/v/html-to-markdown?label=Ruby&color=007ec6" alt="Ruby">
+  </a>
+  <a href="https://hex.pm/packages/html_to_markdown">
+    <img src="https://img.shields.io/hexpm/v/html_to_markdown?label=Elixir&color=007ec6" alt="Elixir">
+  </a>
+
+  <!-- Project Info -->
+  <a href="https://github.com/kreuzberg-dev/html-to-markdown/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
+  </a>
+</div>
+
+
+<img width="3384" height="573" alt="Linkedin- Banner" src="https://github.com/user-attachments/assets/1bd52e37-c45d-4f5c-8408-ee12997f6cfd" />
+
+
+<div align="center" style="margin-top: 20px;">
+  <a href="https://discord.gg/pXxagNK2zN">
+      <img height="22" src="https://img.shields.io/badge/Discord-Join%20our%20community-7289da?logo=discord&logoColor=white" alt="Discord">
+  </a>
+</div>
+
+High-performance HTML → Markdown conversion powered by Rust. Shipping as a Rust crate, Python package, PHP extension, Ruby gem, Elixir Rustler NIF, Node.js bindings, WebAssembly, and standalone CLI with identical rendering behavior across all runtimes.
+
+## Key Features
+
+- **Blazing Fast** – Rust-powered core delivers 10-80× faster conversion than pure Python alternatives (150–280 MB/s)
+- **Polyglot** – Native bindings for Rust, Python, TypeScript/Node.js, Ruby, PHP, Go, Java, C#, and Elixir
+- **Smart Conversion** – Handles complex documents including nested tables, code blocks, task lists, and hOCR OCR output
+- **Metadata Extraction** – Extract document metadata (title, description, headers, links, images, structured data) alongside conversion
+- **Visitor Pattern** – Custom callbacks for domain-specific dialects, content filtering, URL rewriting, accessibility validation
+- **Highly Configurable** – Control heading styles, code block fences, list formatting, whitespace handling, and HTML sanitization
+- **Tag Preservation** – Keep specific HTML tags unconverted when markdown isn't expressive enough
+- **Secure by Default** – Built-in HTML sanitization prevents malicious content
+- **Consistent Output** – Identical markdown rendering across all language bindings
+
+**[Try the Live Demo →](https://kreuzberg-dev.github.io/html-to-markdown/)**
+
+## Installation
+
+Each language binding provides comprehensive documentation with installation instructions, examples, and best practices. Choose your platform to get started:
+
+**Scripting Languages:**
+- **[Python](./packages/python/README.md)** – PyPI package, metadata extraction, visitor pattern, CLI included
+- **[Ruby](./packages/ruby/README.md)** – RubyGems package, RBS type definitions, Steep checking
+- **[PHP](./packages/php/README.md)** – Composer package + PIE extension, PHP 8.2+, PHPStan level 9
+- **[Elixir](./packages/elixir/README.md)** – Hex package, Rustler NIF bindings, Elixir 1.19+
+
+**JavaScript/TypeScript:**
+- **[Node.js / TypeScript](./packages/typescript/README.md)** – Native NAPI-RS bindings for Node.js/Bun, fastest performance, WebAssembly for browsers/Deno
+
+**Compiled Languages:**
+- **[Go](./packages/go/v2/README.md)** – Go module with FFI bindings, automatic library download
+- **[Java](./packages/java/README.md)** – Maven Central, Panama Foreign Function & Memory API, Java 24+
+- **[C#](./packages/csharp/README.md)** – NuGet package, .NET 8.0+, P/Invoke FFI bindings
+
+**Native:**
+- **[Rust](./crates/html-to-markdown/README.md)** – Core library, flexible feature flags, zero-copy APIs
+
+**Command-Line:**
+- **[CLI](https://crates.io/crates/html-to-markdown-cli)** – Cross-platform binary via `cargo install html-to-markdown-cli` or [Homebrew](https://formulae.brew.sh/formula/html-to-markdown)
+
+<details>
+<summary><strong>Metadata Extraction</strong></summary>
+
+Extract comprehensive metadata during conversion: title, description, headers, links, images, structured data (JSON-LD, Microdata, RDFa). Use cases: SEO extraction, table-of-contents generation, link validation, accessibility auditing, content migration.
+
+**[Metadata Extraction Guide →](./examples/metadata-extraction/)**
+
+</details>
+
+<details>
+<summary><strong>Visitor Pattern</strong></summary>
+
+Customize HTML→Markdown conversion with callbacks for specific elements. Intercept links, images, headings, lists, and more. Use cases: domain-specific Markdown dialects (Obsidian, Notion), content filtering, URL rewriting, accessibility validation, analytics.
+
+**[Visitor Pattern Guide →](./examples/visitor-pattern/)**
+
+</details>
+
+<details>
+<summary><strong>Performance & Benchmarking</strong></summary>
+
+Rust-powered core delivers 150–280 MB/s throughput (10-80× faster than pure Python alternatives). Includes benchmarking tools, memory profiling, streaming strategies, and optimization tips.
+
+**[Performance Guide →](./examples/performance/)**
+
+</details>
+
+<details>
+<summary><strong>Tag Preservation</strong></summary>
+
+Keep specific HTML tags unconverted when Markdown isn't expressive enough. Useful for tables, SVG, custom elements, or when you need mixed HTML/Markdown output.
+
+See language-specific documentation for `preserveTags` configuration.
+
+</details>
+
+<details>
+<summary><strong>Secure by Default</strong></summary>
+
+Built-in HTML sanitization prevents XSS attacks and malicious content. Powered by ammonia with safe defaults. Configurable via `sanitize` options.
+
+</details>
+
+## Contributing
+
+Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on:
+
+- Setting up the development environment
+- Running tests locally (Rust 95%+ coverage, language bindings 80%+)
+- Submitting pull requests
+- Reporting issues
+
+All contributions must follow code quality standards enforced via pre-commit hooks (prek).
+
+## License
+
+MIT License – see [LICENSE](LICENSE) for details. You can use html-to-markdown freely in both commercial and closed-source products with no obligations, no viral effects, and no licensing restrictions.

package/dist/html_to_markdown_wasm.d.ts

@@ -0,0 +1,200 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export class WasmConversionOptionsHandle {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor(options?: WasmConversionOptions | null);
+}
+
+export class WasmHtmlExtraction {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  readonly inlineImages: WasmInlineImage[];
+  readonly markdown: string;
+  readonly warnings: WasmInlineImageWarning[];
+}
+
+export class WasmInlineImage {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  readonly attributes: Record<string, string>;
+  readonly dimensions: Uint32Array | undefined;
+  readonly description: string | undefined;
+  readonly data: Uint8Array;
+  readonly format: string;
+  readonly source: string;
+  readonly filename: string | undefined;
+}
+
+export class WasmInlineImageConfig {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor(max_decoded_size_bytes?: number | null);
+  set captureSvg(value: boolean);
+  set filenamePrefix(value: string | null | undefined);
+  set inferDimensions(value: boolean);
+}
+
+export class WasmInlineImageWarning {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  readonly index: number;
+  readonly message: string;
+}
+
+export class WasmMetadataConfig {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new metadata configuration with defaults
+   *
+   * All extraction types enabled by default with 1MB structured data limit
+   */
+  constructor();
+  extract_links: boolean;
+  extract_images: boolean;
+  extract_headers: boolean;
+  extract_document: boolean;
+  extract_structured_data: boolean;
+  max_structured_data_size: number;
+}
+
+/**
+ * Convert HTML to Markdown
+ *
+ * # Arguments
+ *
+ * * `html` - The HTML string to convert
+ * * `options` - Optional conversion options (as a JavaScript object)
+ *
+ * # Example
+ *
+ * ```javascript
+ * import { convert } from 'html-to-markdown-wasm';
+ *
+ * const html = '<h1>Hello World</h1>';
+ * const markdown = convert(html);
+ * console.log(markdown); // # Hello World
+ * ```
+ */
+export function convert(html: string, options?: WasmConversionOptions | null): string;
+
+export function convertBytes(html: Uint8Array, options?: WasmConversionOptions | null): string;
+
+export function convertBytesWithInlineImages(html: Uint8Array, options?: WasmConversionOptions | null, image_config?: WasmInlineImageConfig | null): WasmHtmlExtraction;
+
+/**
+ * Convert HTML bytes to Markdown with metadata extraction
+ *
+ * # Arguments
+ *
+ * * `html` - The HTML bytes to convert
+ * * `options` - Optional conversion options (as a JavaScript object)
+ * * `metadata_config` - Metadata extraction configuration
+ *
+ * # Returns
+ *
+ * JavaScript object with `markdown` (string) and `metadata` (object) fields
+ */
+export function convertBytesWithMetadata(html: Uint8Array, options?: WasmConversionOptions | null, metadata_config?: WasmMetadataConfig | null): any;
+
+export function convertBytesWithOptionsHandle(html: Uint8Array, handle: WasmConversionOptionsHandle): string;
+
+export function convertWithInlineImages(html: string, options?: WasmConversionOptions | null, image_config?: WasmInlineImageConfig | null): WasmHtmlExtraction;
+
+/**
+ * Convert HTML to Markdown with metadata extraction
+ *
+ * # Arguments
+ *
+ * * `html` - The HTML string to convert
+ * * `options` - Optional conversion options (as a JavaScript object)
+ * * `metadata_config` - Metadata extraction configuration
+ *
+ * # Returns
+ *
+ * JavaScript object with `markdown` (string) and `metadata` (object) fields
+ *
+ * # Example
+ *
+ * ```javascript
+ * import { convertWithMetadata, WasmMetadataConfig } from 'html-to-markdown-wasm';
+ *
+ * const html = '<h1>Hello World</h1><a href="https://example.com">Link</a>';
+ * const config = new WasmMetadataConfig();
+ * config.extractHeaders = true;
+ * config.extractLinks = true;
+ *
+ * const result = convertWithMetadata(html, null, config);
+ * console.log(result.markdown); // # Hello World\n\n[Link](https://example.com)
+ * console.log(result.metadata.headers); // [{ level: 1, text: "Hello World", ... }]
+ * console.log(result.metadata.links); // [{ href: "https://example.com", text: "Link", ... }]
+ * ```
+ */
+export function convertWithMetadata(html: string, options?: WasmConversionOptions | null, metadata_config?: WasmMetadataConfig | null): any;
+
+export function convertWithOptionsHandle(html: string, handle: WasmConversionOptionsHandle): string;
+
+export function createConversionOptionsHandle(options?: WasmConversionOptions | null): WasmConversionOptionsHandle;
+
+/**
+ * Initialize panic hook for better error messages in the browser
+ */
+export function init(): void;
+
+export declare function initWasm(): Promise<void>;
+export declare const wasmReady: Promise<void>;
+
+
+export type WasmHeadingStyle = "underlined" | "atx" | "atxClosed";
+export type WasmListIndentType = "spaces" | "tabs";
+export type WasmWhitespaceMode = "normalized" | "strict";
+export type WasmNewlineStyle = "spaces" | "backslash";
+export type WasmCodeBlockStyle = "indented" | "backticks" | "tildes";
+export type WasmHighlightStyle = "doubleEqual" | "html" | "bold" | "none";
+export type WasmPreprocessingPreset = "minimal" | "standard" | "aggressive";
+
+export interface WasmPreprocessingOptions {
+  enabled?: boolean;
+  preset?: WasmPreprocessingPreset;
+  removeNavigation?: boolean;
+  removeForms?: boolean;
+}
+
+export interface WasmConversionOptions {
+  headingStyle?: WasmHeadingStyle;
+  listIndentType?: WasmListIndentType;
+  listIndentWidth?: number;
+  bullets?: string;
+  strongEmSymbol?: string;
+  escapeAsterisks?: boolean;
+  escapeUnderscores?: boolean;
+  escapeMisc?: boolean;
+  escapeAscii?: boolean;
+  codeLanguage?: string;
+  autolinks?: boolean;
+  defaultTitle?: boolean;
+  brInTables?: boolean;
+  hocrSpatialTables?: boolean;
+  highlightStyle?: WasmHighlightStyle;
+  extractMetadata?: boolean;
+  whitespaceMode?: WasmWhitespaceMode;
+  stripNewlines?: boolean;
+  wrap?: boolean;
+  wrapWidth?: number;
+  convertAsInline?: boolean;
+  subSymbol?: string;
+  supSymbol?: string;
+  newlineStyle?: WasmNewlineStyle;
+  codeBlockStyle?: WasmCodeBlockStyle;
+  keepInlineImagesIn?: string[];
+  preprocessing?: WasmPreprocessingOptions | null;
+  encoding?: string;
+  debug?: boolean;
+  stripTags?: string[];
+  preserveTags?: string[];
+}

package/dist/html_to_markdown_wasm.js

@@ -0,0 +1,116 @@
+import * as wasmModule from "./html_to_markdown_wasm_bg.wasm";
+export * from "./html_to_markdown_wasm_bg.js";
+import * as imports_mod from "./html_to_markdown_wasm_bg.js";
+
+const notReadyError = () =>
+  new Error("html-to-markdown-wasm: WebAssembly bundle is still initializing. Await initWasm() before calling convert() in runtimes that load WASM asynchronously (e.g., Cloudflare Workers).");
+
+const notReadyProxy = new Proxy({}, {
+  get(_target, prop) {
+    if (prop === "__esModule") {
+      return true;
+    }
+    throw notReadyError();
+  }
+});
+
+let wasmExports;
+let initialized = false;
+let initPromise;
+
+imports_mod.__wbg_set_wasm(notReadyProxy);
+
+function asExports(value) {
+  if (!value) {
+    return null;
+  }
+  if (typeof value.__wbindgen_start === "function") {
+    return value;
+  }
+  if (value instanceof WebAssembly.Instance) {
+    return value.exports;
+  }
+  if (typeof value === "object") {
+    if (value.instance instanceof WebAssembly.Instance) {
+      return value.instance.exports;
+    }
+    if (value.default instanceof WebAssembly.Instance) {
+      return value.default.exports;
+    }
+    if (value.default && value.default.instance instanceof WebAssembly.Instance) {
+      return value.default.instance.exports;
+    }
+  }
+  return null;
+}
+
+function finalize(exports) {
+  wasmExports = exports;
+  imports_mod.__wbg_set_wasm(exports);
+  if (typeof exports.__wbindgen_start === "function") {
+    exports.__wbindgen_start();
+  }
+  initialized = true;
+  return exports;
+}
+
+function trySyncInit() {
+  try {
+    const exports = asExports(wasmModule);
+    if (exports) {
+      finalize(exports);
+    }
+  } catch {
+    // ignore and fall back to async init
+  }
+}
+
+trySyncInit();
+
+async function ensureInitPromise() {
+  if (initialized) {
+    return Promise.resolve(wasmExports);
+  }
+  if (!initPromise) {
+    initPromise = (async () => {
+      let module = wasmModule;
+
+      // Handle promise-wrapped modules
+      if (module && typeof module.then === "function") {
+        module = await module;
+      }
+
+      // Handle function loaders (like @rollup/plugin-wasm)
+      if (module && typeof module.default === "function") {
+        module = await module.default(module);
+      }
+
+      // Handle WebAssembly.Module (Wrangler/esbuild)
+      if (module && module.default instanceof WebAssembly.Module) {
+        const imports = {};
+        imports["./html_to_markdown_wasm_bg.js"] = {};
+        for (const key in imports_mod) {
+          if ((key.startsWith('__wbg_') || key.startsWith('__wbindgen_')) && key !== '__wbg_set_wasm' && typeof imports_mod[key] === 'function') {
+            imports["./html_to_markdown_wasm_bg.js"][key] = imports_mod[key];
+          }
+        }
+        const instance = await WebAssembly.instantiate(module.default, imports);
+        return finalize(instance.exports);
+      }
+
+      // Try standard export detection
+      const exports = asExports(module);
+      if (!exports) {
+        throw new Error("html-to-markdown-wasm: failed to initialize WebAssembly bundle. Call initWasm() with a supported bundler configuration.");
+      }
+      return finalize(exports);
+    })();
+  }
+  return initPromise;
+}
+
+export const wasmReady = ensureInitPromise();
+
+export async function initWasm() {
+  return ensureInitPromise();
+}