@kreuzberg/html-to-markdown-wasm 3.4.0-rc.9 → 3.4.1

package/{dist → pkg/deno}/html_to_markdown_wasm.d.ts

@@ -52,7 +52,7 @@ export class WasmConversionOptions {
     /**
      * Apply a partial update to these conversion options.
      */
-    applyUpdate(_update: WasmConversionOptionsUpdate): void;
+    applyUpdate(update: WasmConversionOptionsUpdate): void;
     /**
      * Create a new builder with default values.
      */
@@ -68,7 +68,8 @@ export class WasmConversionOptions {
     brInTables: boolean;
     bullets: string;
     captureSvg: boolean;
-    codeBlockStyle: WasmCodeBlockStyle;
+    get codeBlockStyle(): string;
+    set codeBlockStyle(value: WasmCodeBlockStyle);
     codeLanguage: string;
     convertAsInline: boolean;
     debug: boolean;
@@ -81,19 +82,25 @@ export class WasmConversionOptions {
     excludeSelectors: string[];
     extractImages: boolean;
     extractMetadata: boolean;
-    headingStyle: WasmHeadingStyle;
-    highlightStyle: WasmHighlightStyle;
+    get headingStyle(): string;
+    set headingStyle(value: WasmHeadingStyle);
+    get highlightStyle(): string;
+    set highlightStyle(value: WasmHighlightStyle);
     includeDocumentStructure: boolean;
     inferDimensions: boolean;
     keepInlineImagesIn: string[];
-    linkStyle: WasmLinkStyle;
-    listIndentType: WasmListIndentType;
+    get linkStyle(): string;
+    set linkStyle(value: WasmLinkStyle);
+    get listIndentType(): string;
+    set listIndentType(value: WasmListIndentType);
     listIndentWidth: number;
     get maxDepth(): number | undefined;
     set maxDepth(value: number | null | undefined);
     maxImageSize: bigint;
-    newlineStyle: WasmNewlineStyle;
-    outputFormat: WasmOutputFormat;
+    get newlineStyle(): string;
+    set newlineStyle(value: WasmNewlineStyle);
+    get outputFormat(): string;
+    set outputFormat(value: WasmOutputFormat);
     preprocessing: WasmPreprocessingOptions;
     preserveTags: string[];
     skipImages: boolean;
@@ -102,7 +109,10 @@ export class WasmConversionOptions {
     strongEmSymbol: string;
     subSymbol: string;
     supSymbol: string;
-    whitespaceMode: WasmWhitespaceMode;
+    get visitor(): WasmVisitorHandle | undefined;
+    set visitor(value: WasmVisitorHandle | null | undefined);
+    get whitespaceMode(): string;
+    set whitespaceMode(value: WasmWhitespaceMode);
     wrap: boolean;
     wrapWidth: number;
 }
@@ -140,6 +150,10 @@ export class WasmConversionOptionsBuilder {
      * Set the list of HTML tag names whose content is stripped from output.
      */
     stripTags(tags: string[]): WasmConversionOptionsBuilder;
+    /**
+     * Set the visitor used during conversion.
+     */
+    visitor(visitor?: WasmVisitorHandle | null): WasmConversionOptionsBuilder;
 }
 
 /**
@@ -151,6 +165,7 @@ export class WasmConversionOptionsBuilder {
 export class WasmConversionOptionsUpdate {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmConversionOptionsUpdate;
     constructor(heading_style?: WasmHeadingStyle | null, list_indent_type?: WasmListIndentType | null, list_indent_width?: number | null, bullets?: string | null, strong_em_symbol?: string | null, escape_asterisks?: boolean | null, escape_underscores?: boolean | null, escape_misc?: boolean | null, escape_ascii?: boolean | null, code_language?: string | null, autolinks?: boolean | null, default_title?: boolean | null, br_in_tables?: boolean | null, highlight_style?: WasmHighlightStyle | null, extract_metadata?: boolean | null, whitespace_mode?: WasmWhitespaceMode | null, strip_newlines?: boolean | null, wrap?: boolean | null, wrap_width?: number | null, convert_as_inline?: boolean | null, sub_symbol?: string | null, sup_symbol?: string | null, newline_style?: WasmNewlineStyle | null, code_block_style?: WasmCodeBlockStyle | null, keep_inline_images_in?: string[] | null, preprocessing?: WasmPreprocessingOptionsUpdate | null, encoding?: string | null, debug?: boolean | null, strip_tags?: string[] | null, preserve_tags?: string[] | null, skip_images?: boolean | null, link_style?: WasmLinkStyle | null, output_format?: WasmOutputFormat | null, include_document_structure?: boolean | null, extract_images?: boolean | null, max_image_size?: bigint | null, capture_svg?: boolean | null, infer_dimensions?: boolean | null, max_depth?: number | null, exclude_selectors?: string[] | null);
     get autolinks(): boolean | undefined;
     set autolinks(value: boolean | null | undefined);
@@ -160,7 +175,7 @@ export class WasmConversionOptionsUpdate {
     set bullets(value: string | null | undefined);
     get captureSvg(): boolean | undefined;
     set captureSvg(value: boolean | null | undefined);
-    get codeBlockStyle(): WasmCodeBlockStyle | undefined;
+    get codeBlockStyle(): string | undefined;
     set codeBlockStyle(value: WasmCodeBlockStyle | null | undefined);
     get codeLanguage(): string | undefined;
     set codeLanguage(value: string | null | undefined);
@@ -186,9 +201,9 @@ export class WasmConversionOptionsUpdate {
     set extractImages(value: boolean | null | undefined);
     get extractMetadata(): boolean | undefined;
     set extractMetadata(value: boolean | null | undefined);
-    get headingStyle(): WasmHeadingStyle | undefined;
+    get headingStyle(): string | undefined;
     set headingStyle(value: WasmHeadingStyle | null | undefined);
-    get highlightStyle(): WasmHighlightStyle | undefined;
+    get highlightStyle(): string | undefined;
     set highlightStyle(value: WasmHighlightStyle | null | undefined);
     get includeDocumentStructure(): boolean | undefined;
     set includeDocumentStructure(value: boolean | null | undefined);
@@ -196,9 +211,9 @@ export class WasmConversionOptionsUpdate {
     set inferDimensions(value: boolean | null | undefined);
     get keepInlineImagesIn(): string[] | undefined;
     set keepInlineImagesIn(value: string[] | null | undefined);
-    get linkStyle(): WasmLinkStyle | undefined;
+    get linkStyle(): string | undefined;
     set linkStyle(value: WasmLinkStyle | null | undefined);
-    get listIndentType(): WasmListIndentType | undefined;
+    get listIndentType(): string | undefined;
     set listIndentType(value: WasmListIndentType | null | undefined);
     get listIndentWidth(): number | undefined;
     set listIndentWidth(value: number | null | undefined);
@@ -206,9 +221,9 @@ export class WasmConversionOptionsUpdate {
     set maxDepth(value: number | null | undefined);
     get maxImageSize(): bigint | undefined;
     set maxImageSize(value: bigint | null | undefined);
-    get newlineStyle(): WasmNewlineStyle | undefined;
+    get newlineStyle(): string | undefined;
     set newlineStyle(value: WasmNewlineStyle | null | undefined);
-    get outputFormat(): WasmOutputFormat | undefined;
+    get outputFormat(): string | undefined;
     set outputFormat(value: WasmOutputFormat | null | undefined);
     get preprocessing(): WasmPreprocessingOptionsUpdate | undefined;
     set preprocessing(value: WasmPreprocessingOptionsUpdate | null | undefined);
@@ -226,7 +241,9 @@ export class WasmConversionOptionsUpdate {
     set subSymbol(value: string | null | undefined);
     get supSymbol(): string | undefined;
     set supSymbol(value: string | null | undefined);
-    get whitespaceMode(): WasmWhitespaceMode | undefined;
+    get visitor(): WasmVisitorHandle | undefined;
+    set visitor(value: WasmVisitorHandle | null | undefined);
+    get whitespaceMode(): string | undefined;
     set whitespaceMode(value: WasmWhitespaceMode | null | undefined);
     get wrap(): boolean | undefined;
     set wrap(value: boolean | null | undefined);
@@ -253,7 +270,8 @@ export class WasmConversionOptionsUpdate {
 export class WasmConversionResult {
     free(): void;
     [Symbol.dispose](): void;
-    constructor(metadata?: WasmHtmlMetadata | null, tables?: WasmTableData[] | null, images?: string[] | null, warnings?: WasmProcessingWarning[] | null, content?: string | null, document?: WasmDocumentStructure | null);
+    static default(): WasmConversionResult;
+    constructor(tables?: WasmTableData[] | null, warnings?: WasmProcessingWarning[] | null, content?: string | null, document?: WasmDocumentStructure | null);
     get content(): string | undefined;
     set content(value: string | null | undefined);
     get document(): WasmDocumentStructure | undefined;
@@ -273,7 +291,6 @@ export class WasmConversionResult {
  * # Examples
  *
  * ```
- * # use html_to_markdown_rs::metadata::DocumentMetadata;
  * let doc = DocumentMetadata {
  *     title: Some("My Article".to_string()),
  *     description: Some("A great article about Rust".to_string()),
@@ -287,6 +304,7 @@ export class WasmConversionResult {
 export class WasmDocumentMetadata {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmDocumentMetadata;
     constructor(keywords?: string[] | null, open_graph?: any | null, twitter_card?: any | null, meta_tags?: any | null, title?: string | null, description?: string | null, author?: string | null, canonical_url?: string | null, base_href?: string | null, language?: string | null, text_direction?: WasmTextDirection | null);
     get author(): string | undefined;
     set author(value: string | null | undefined);
@@ -301,7 +319,7 @@ export class WasmDocumentMetadata {
     set language(value: string | null | undefined);
     metaTags: any;
     openGraph: any;
-    get textDirection(): WasmTextDirection | undefined;
+    get textDirection(): string | undefined;
     set textDirection(value: WasmTextDirection | null | undefined);
     get title(): string | undefined;
     set title(value: string | null | undefined);
@@ -314,12 +332,14 @@ export class WasmDocumentMetadata {
 export class WasmDocumentNode {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmDocumentNode;
     constructor(id: string, content: WasmNodeContent, children: Uint32Array, annotations: WasmTextAnnotation[], parent?: number | null, attributes?: any | null);
     annotations: WasmTextAnnotation[];
     get attributes(): any | undefined;
     set attributes(value: any | null | undefined);
     children: Uint32Array;
-    content: WasmNodeContent;
+    get content(): string;
+    set content(value: WasmNodeContent);
     id: string;
     get parent(): number | undefined;
     set parent(value: number | null | undefined);
@@ -333,6 +353,7 @@ export class WasmDocumentNode {
 export class WasmDocumentStructure {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmDocumentStructure;
     constructor(nodes: WasmDocumentNode[], source_format?: string | null);
     nodes: WasmDocumentNode[];
     get sourceFormat(): string | undefined;
@@ -345,6 +366,7 @@ export class WasmDocumentStructure {
 export class WasmGridCell {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmGridCell;
     constructor(content: string, row: number, col: number, row_span: number, col_span: number, is_header: boolean);
     col: number;
     colSpan: number;
@@ -363,7 +385,6 @@ export class WasmGridCell {
  * # Examples
  *
  * ```
- * # use html_to_markdown_rs::metadata::HeaderMetadata;
  * let header = HeaderMetadata {
  *     level: 1,
  *     text: "Main Title".to_string(),
@@ -379,6 +400,7 @@ export class WasmGridCell {
 export class WasmHeaderMetadata {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmHeaderMetadata;
     /**
      * Validate that the header level is within valid range (1-6).
      *
@@ -389,7 +411,6 @@ export class WasmHeaderMetadata {
      * # Examples
      *
      * ```
-     * # use html_to_markdown_rs::metadata::HeaderMetadata;
      * let valid = HeaderMetadata {
      *     level: 3,
      *     text: "Title".to_string(),
@@ -451,7 +472,6 @@ export enum WasmHighlightStyle {
  * # Examples
  *
  * ```
- * # use html_to_markdown_rs::metadata::HtmlMetadata;
  * let metadata = HtmlMetadata {
  *     document: Default::default(),
  *     headers: Vec::new(),
@@ -466,6 +486,7 @@ export enum WasmHighlightStyle {
 export class WasmHtmlMetadata {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmHtmlMetadata;
     constructor(document?: WasmDocumentMetadata | null, headers?: WasmHeaderMetadata[] | null, links?: WasmLinkMetadata[] | null, images?: WasmImageMetadata[] | null, structured_data?: WasmStructuredData[] | null);
     document: WasmDocumentMetadata;
     headers: WasmHeaderMetadata[];
@@ -483,7 +504,6 @@ export class WasmHtmlMetadata {
  * # Examples
  *
  * ```
- * # use html_to_markdown_rs::metadata::{ImageMetadata, ImageType};
  * let img = ImageMetadata {
  *     src: "https://example.com/image.jpg".to_string(),
  *     alt: Some("An example image".to_string()),
@@ -499,13 +519,15 @@ export class WasmHtmlMetadata {
 export class WasmImageMetadata {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmImageMetadata;
     constructor(src: string, image_type: WasmImageType, attributes: any, alt?: string | null, title?: string | null, dimensions?: Uint32Array | null);
     get alt(): string | undefined;
     set alt(value: string | null | undefined);
     attributes: any;
     get dimensions(): Uint32Array | undefined;
     set dimensions(value: Uint32Array | null | undefined);
-    imageType: WasmImageType;
+    get imageType(): string;
+    set imageType(value: WasmImageType);
     src: string;
     get title(): string | undefined;
     set title(value: string | null | undefined);
@@ -531,7 +553,6 @@ export enum WasmImageType {
  * # Examples
  *
  * ```
- * # use html_to_markdown_rs::metadata::{LinkMetadata, LinkType};
  * let link = LinkMetadata {
  *     href: "https://example.com".to_string(),
  *     text: "Example".to_string(),
@@ -562,7 +583,6 @@ export class WasmLinkMetadata {
      * # Examples
      *
      * ```
-     * # use html_to_markdown_rs::metadata::{LinkMetadata, LinkType};
      * assert_eq!(LinkMetadata::classify_link("#section"), LinkType::Anchor);
      * assert_eq!(LinkMetadata::classify_link("mailto:test@example.com"), LinkType::Email);
      * assert_eq!(LinkMetadata::classify_link("tel:+1234567890"), LinkType::Phone);
@@ -570,10 +590,12 @@ export class WasmLinkMetadata {
      * ```
      */
     static classifyLink(href: string): WasmLinkType;
+    static default(): WasmLinkMetadata;
     constructor(href: string, text: string, link_type: WasmLinkType, rel: string[], attributes: any, title?: string | null);
     attributes: any;
     href: string;
-    linkType: WasmLinkType;
+    get linkType(): string;
+    set linkType(value: WasmLinkType);
     rel: string[];
     text: string;
     get title(): string | undefined;
@@ -655,12 +677,14 @@ export enum WasmNodeContent {
 export class WasmNodeContext {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmNodeContext;
     constructor(node_type: WasmNodeType, tag_name: string, attributes: any, depth: number, index_in_parent: number, is_inline: boolean, parent_tag?: string | null);
     attributes: any;
     depth: number;
     indexInParent: number;
     isInline: boolean;
-    nodeType: WasmNodeType;
+    get nodeType(): string;
+    set nodeType(value: WasmNodeType);
     get parentTag(): string | undefined;
     set parentTag(value: string | null | undefined);
     tagName: string;
@@ -790,7 +814,7 @@ export class WasmPreprocessingOptions {
      *
      * * `update` - Partial preprocessing options update
      */
-    applyUpdate(_update: WasmPreprocessingOptionsUpdate): void;
+    applyUpdate(update: WasmPreprocessingOptionsUpdate): void;
     static default(): WasmPreprocessingOptions;
     static from(update: WasmPreprocessingOptionsUpdate): WasmPreprocessingOptions;
     /**
@@ -810,7 +834,8 @@ export class WasmPreprocessingOptions {
     static fromUpdate(update: WasmPreprocessingOptionsUpdate): WasmPreprocessingOptions;
     constructor(enabled?: boolean | null, preset?: WasmPreprocessingPreset | null, remove_navigation?: boolean | null, remove_forms?: boolean | null);
     enabled: boolean;
-    preset: WasmPreprocessingPreset;
+    get preset(): string;
+    set preset(value: WasmPreprocessingPreset);
     removeForms: boolean;
     removeNavigation: boolean;
 }
@@ -825,10 +850,11 @@ export class WasmPreprocessingOptions {
 export class WasmPreprocessingOptionsUpdate {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmPreprocessingOptionsUpdate;
     constructor(enabled?: boolean | null, preset?: WasmPreprocessingPreset | null, remove_navigation?: boolean | null, remove_forms?: boolean | null);
     get enabled(): boolean | undefined;
     set enabled(value: boolean | null | undefined);
-    get preset(): WasmPreprocessingPreset | undefined;
+    get preset(): string | undefined;
     set preset(value: WasmPreprocessingPreset | null | undefined);
     get removeForms(): boolean | undefined;
     set removeForms(value: boolean | null | undefined);
@@ -853,8 +879,10 @@ export enum WasmPreprocessingPreset {
 export class WasmProcessingWarning {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmProcessingWarning;
     constructor(message: string, kind: WasmWarningKind);
-    kind: WasmWarningKind;
+    get kind(): string;
+    set kind(value: WasmWarningKind);
     message: string;
 }
 
@@ -867,7 +895,6 @@ export class WasmProcessingWarning {
  * # Examples
  *
  * ```
- * # use html_to_markdown_rs::metadata::{StructuredData, StructuredDataType};
  * let schema = StructuredData {
  *     data_type: StructuredDataType::JsonLd,
  *     raw_json: r#"{"@context":"https://schema.org","@type":"Article"}"#.to_string(),
@@ -880,8 +907,10 @@ export class WasmProcessingWarning {
 export class WasmStructuredData {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmStructuredData;
     constructor(data_type: WasmStructuredDataType, raw_json: string, schema_type?: string | null);
-    dataType: WasmStructuredDataType;
+    get dataType(): string;
+    set dataType(value: WasmStructuredDataType);
     rawJson: string;
     get schemaType(): string | undefined;
     set schemaType(value: string | null | undefined);
@@ -904,6 +933,7 @@ export enum WasmStructuredDataType {
 export class WasmTableData {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmTableData;
     constructor(grid: WasmTableGrid, markdown: string);
     grid: WasmTableGrid;
     markdown: string;
@@ -915,6 +945,7 @@ export class WasmTableData {
 export class WasmTableGrid {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmTableGrid;
     constructor(rows?: number | null, cols?: number | null, cells?: WasmGridCell[] | null);
     cells: WasmGridCell[];
     cols: number;
@@ -929,9 +960,11 @@ export class WasmTableGrid {
 export class WasmTextAnnotation {
     free(): void;
     [Symbol.dispose](): void;
+    static default(): WasmTextAnnotation;
     constructor(start: number, end: number, kind: WasmAnnotationKind);
     end: number;
-    kind: WasmAnnotationKind;
+    get kind(): string;
+    set kind(value: WasmAnnotationKind);
     start: number;
 }
 
@@ -961,6 +994,19 @@ export enum WasmVisitResult {
     Error = 4,
 }
 
+/**
+ * Type alias for a visitor handle (`Arc`-wrapped `Mutex` for thread-safe shared mutation).
+ *
+ * `Send + Sync` so that types embedding a `VisitorHandle` (e.g. `ConversionOptions`)
+ * can be shared across threads — required by callers that stash configs inside
+ * axum/rmcp/tokio Send-bound contexts.
+ */
+export class WasmVisitorHandle {
+    free(): void;
+    [Symbol.dispose](): void;
+    constructor(visitor: any);
+}
+
 /**
  * Categories of processing warnings.
  */
@@ -983,132 +1029,27 @@ export enum WasmWhitespaceMode {
     Strict = 1,
 }
 
-export function convert(html: string, options?: WasmConversionOptions | null, visitor?: any | null): WasmConversionResult;
-
-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 type WasmOutputFormat = "markdown" | "djot" | "plain";
-
-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[];
-  skipImages?: boolean;
-  outputFormat?: WasmOutputFormat;
-  includeDocumentStructure?: boolean;
-  extractImages?: boolean;
-  maxImageSize?: number;
-  captureSvg?: boolean;
-  inferDimensions?: boolean;
-}
-
-/** A single cell in a structured table grid. */
-export interface WasmGridCell {
-  content: string;
-  row: number;
-  col: number;
-  rowSpan: number;
-  colSpan: number;
-  isHeader: boolean;
-}
-
-/** Structured table grid with cell-level data. */
-export interface WasmTableGrid {
-  rows: number;
-  cols: number;
-  cells: WasmGridCell[];
-}
-
-/** A table extracted during conversion. */
-export interface WasmConversionTable {
-  grid: WasmTableGrid;
-  markdown: string;
-}
-
-/** Non-fatal warning emitted during conversion. */
-export interface WasmConversionWarning {
-  /** Human-readable warning message. */
-  message: string;
-  /** Warning kind identifier. */
-  kind: string;
-}
-
-/** An extracted inline image from the HTML document. */
-export interface WasmInlineImage {
-  /** Raw image data as a Uint8Array. */
-  data: Uint8Array;
-  /** Image format (png, jpeg, gif, svg, etc.). */
-  format: string;
-  /** Generated or provided filename, or null. */
-  filename: string | null;
-  /** Alt text or description, or null. */
-  description: string | null;
-  /** Image width in pixels, or null if not available. */
-  width: number | null;
-  /** Image height in pixels, or null if not available. */
-  height: number | null;
-  /** Source type ("img_data_uri" or "svg_element"). */
-  source: string;
-  /** HTML attributes from the source element. */
-  attributes: Record<string, string>;
-}
-
-/** Result of the convert() API. */
-export interface WasmConversionResult {
-  /** Converted text output (markdown, djot, or plain text), or null. */
-  content: string | null;
-  /** Structured document tree serialized as a JSON value, or null. */
-  document: unknown | null;
-  /** Extracted HTML metadata serialized as a JSON value, or null. */
-  metadata: unknown | null;
-  /** All tables found in the HTML, in document order. */
-  tables: WasmConversionTable[];
-  /** Extracted inline images (data URIs and SVGs). */
-  images: WasmInlineImage[];
-  /** Non-fatal processing warnings. */
-  warnings: WasmConversionWarning[];
-}
+/**
+ * Convert HTML to Markdown, returning a [`ConversionResult`] with content, metadata, images,
+ * and warnings.
+ *
+ * # Arguments
+ *
+ * * `html` — the HTML string to convert.
+ * * `options` — optional conversion options. Defaults to [`ConversionOptions::default`].
+ *
+ * # Example
+ *
+ * ```
+ * use html_to_markdown_rs::convert;
+ *
+ * let html = "<h1>Hello World</h1>";
+ * let result = convert(html, None).unwrap();
+ * assert!(result.content.as_deref().unwrap_or("").contains("Hello World"));
+ * ```
+ *
+ * # Errors
+ *
+ * Returns an error if HTML parsing fails or if the input contains invalid UTF-8.
+ */
+export function convert(html: string, options?: WasmConversionOptions | null): WasmConversionResult;