@kreuzberg/html-to-markdown-wasm 3.4.1 → 3.5.0-rc.1

package/pkg/deno/html_to_markdown_wasm.d.ts

@@ -6,16 +6,16 @@
  *
  * Uses internally tagged representation (`"annotation_type": "bold"`) for JSON serialization.
  */
-export enum WasmAnnotationKind {
-    Bold = 0,
-    Italic = 1,
-    Underline = 2,
-    Strikethrough = 3,
-    Code = 4,
-    Subscript = 5,
-    Superscript = 6,
-    Highlight = 7,
-    Link = 8,
+export class WasmAnnotationKind {
+    free(): void;
+    [Symbol.dispose](): void;
+    static default(): WasmAnnotationKind;
+    constructor();
+    annotationType: string;
+    get title(): string | undefined;
+    set title(value: string | null | undefined);
+    get url(): string | undefined;
+    set url(value: string | null | undefined);
 }
 
 /**
@@ -32,38 +32,15 @@ export enum WasmCodeBlockStyle {
 /**
  * Main conversion options for HTML to Markdown conversion.
  *
- * Use [`ConversionOptions::builder()`] to construct, or [`Default::default()`] for defaults.
+ * Use `ConversionOptions.builder()` to construct, or `Default.default()` for defaults.
  *
  * # Example
- *
- * ```text
- * use html_to_markdown_rs::ConversionOptions;
- *
- * let options = ConversionOptions::builder()
- *     .heading_style(HeadingStyle::Atx)
- *     .wrap(true)
- *     .wrap_width(100)
- *     .build();
- * ```
  */
 export class WasmConversionOptions {
     free(): void;
     [Symbol.dispose](): void;
-    /**
-     * Apply a partial update to these conversion options.
-     */
-    applyUpdate(update: WasmConversionOptionsUpdate): void;
-    /**
-     * Create a new builder with default values.
-     */
-    static builder(): WasmConversionOptionsBuilder;
     static default(): WasmConversionOptions;
-    static from(update: WasmConversionOptionsUpdate): WasmConversionOptions;
-    /**
-     * Create from a partial update, applying to defaults.
-     */
-    static fromUpdate(update: WasmConversionOptionsUpdate): WasmConversionOptions;
-    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?: WasmPreprocessingOptions | 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, exclude_selectors?: string[] | null, max_depth?: number | null);
+    constructor(headingStyle?: WasmHeadingStyle | null, listIndentType?: WasmListIndentType | null, listIndentWidth?: number | null, bullets?: string | null, strongEmSymbol?: string | null, escapeAsterisks?: boolean | null, escapeUnderscores?: boolean | null, escapeMisc?: boolean | null, escapeAscii?: boolean | null, codeLanguage?: string | null, autolinks?: boolean | null, defaultTitle?: boolean | null, brInTables?: boolean | null, compactTables?: boolean | null, highlightStyle?: WasmHighlightStyle | null, extractMetadata?: boolean | null, whitespaceMode?: WasmWhitespaceMode | null, stripNewlines?: boolean | null, wrap?: boolean | null, wrapWidth?: number | null, convertAsInline?: boolean | null, subSymbol?: string | null, supSymbol?: string | null, newlineStyle?: WasmNewlineStyle | null, codeBlockStyle?: WasmCodeBlockStyle | null, keepInlineImagesIn?: string[] | null, preprocessing?: WasmPreprocessingOptions | null, encoding?: string | null, debug?: boolean | null, stripTags?: string[] | null, preserveTags?: string[] | null, skipImages?: boolean | null, linkStyle?: WasmLinkStyle | null, outputFormat?: WasmOutputFormat | null, includeDocumentStructure?: boolean | null, extractImages?: boolean | null, maxImageSize?: bigint | null, captureSvg?: boolean | null, inferDimensions?: boolean | null, excludeSelectors?: string[] | null, maxDepth?: number | null);
     autolinks: boolean;
     brInTables: boolean;
     bullets: string;
@@ -71,6 +48,7 @@ export class WasmConversionOptions {
     get codeBlockStyle(): string;
     set codeBlockStyle(value: WasmCodeBlockStyle);
     codeLanguage: string;
+    compactTables: boolean;
     convertAsInline: boolean;
     debug: boolean;
     defaultTitle: boolean;
@@ -117,56 +95,17 @@ export class WasmConversionOptions {
     wrapWidth: number;
 }
 
-/**
- * Builder for [`ConversionOptions`].
- *
- * All fields start with default values. Call `.build()` to produce the final options.
- */
-export class WasmConversionOptionsBuilder {
-    private constructor();
-    free(): void;
-    [Symbol.dispose](): void;
-    /**
-     * Build the final [`ConversionOptions`].
-     */
-    build(): WasmConversionOptions;
-    /**
-     * Set the list of CSS selectors for elements to exclude entirely from output.
-     */
-    excludeSelectors(selectors: string[]): WasmConversionOptionsBuilder;
-    /**
-     * Set the list of HTML tag names whose `<img>` children are kept inline.
-     */
-    keepInlineImagesIn(tags: string[]): WasmConversionOptionsBuilder;
-    /**
-     * Set the pre-processing options applied to the HTML before conversion.
-     */
-    preprocessing(preprocessing: WasmPreprocessingOptions): WasmConversionOptionsBuilder;
-    /**
-     * Set the list of HTML tag names that are preserved verbatim in output.
-     */
-    preserveTags(tags: string[]): 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;
-}
-
 /**
  * Partial update for `ConversionOptions`.
  *
  * Uses `Option<T>` fields for selective updates. Bindings use this to construct
- * options from language-native types. Prefer [`ConversionOptionsBuilder`] for Rust code.
+ * options from language-native types. Prefer `ConversionOptionsBuilder` for Rust code.
  */
 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);
+    constructor(headingStyle?: WasmHeadingStyle | null, listIndentType?: WasmListIndentType | null, listIndentWidth?: number | null, bullets?: string | null, strongEmSymbol?: string | null, escapeAsterisks?: boolean | null, escapeUnderscores?: boolean | null, escapeMisc?: boolean | null, escapeAscii?: boolean | null, codeLanguage?: string | null, autolinks?: boolean | null, defaultTitle?: boolean | null, brInTables?: boolean | null, compactTables?: boolean | null, highlightStyle?: WasmHighlightStyle | null, extractMetadata?: boolean | null, whitespaceMode?: WasmWhitespaceMode | null, stripNewlines?: boolean | null, wrap?: boolean | null, wrapWidth?: number | null, convertAsInline?: boolean | null, subSymbol?: string | null, supSymbol?: string | null, newlineStyle?: WasmNewlineStyle | null, codeBlockStyle?: WasmCodeBlockStyle | null, keepInlineImagesIn?: string[] | null, preprocessing?: WasmPreprocessingOptionsUpdate | null, encoding?: string | null, debug?: boolean | null, stripTags?: string[] | null, preserveTags?: string[] | null, skipImages?: boolean | null, linkStyle?: WasmLinkStyle | null, outputFormat?: WasmOutputFormat | null, includeDocumentStructure?: boolean | null, extractImages?: boolean | null, maxImageSize?: bigint | null, captureSvg?: boolean | null, inferDimensions?: boolean | null, maxDepth?: number | null, excludeSelectors?: string[] | null);
     get autolinks(): boolean | undefined;
     set autolinks(value: boolean | null | undefined);
     get brInTables(): boolean | undefined;
@@ -179,6 +118,8 @@ export class WasmConversionOptionsUpdate {
     set codeBlockStyle(value: WasmCodeBlockStyle | null | undefined);
     get codeLanguage(): string | undefined;
     set codeLanguage(value: string | null | undefined);
+    get compactTables(): boolean | undefined;
+    set compactTables(value: boolean | null | undefined);
     get convertAsInline(): boolean | undefined;
     set convertAsInline(value: boolean | null | undefined);
     get debug(): boolean | undefined;
@@ -289,23 +230,12 @@ export class WasmConversionResult {
  * and browsers for document indexing and presentation.
  *
  * # Examples
- *
- * ```
- * let doc = DocumentMetadata {
- *     title: Some("My Article".to_string()),
- *     description: Some("A great article about Rust".to_string()),
- *     keywords: vec!["rust".to_string(), "programming".to_string()],
- *     ..Default::default()
- * };
- *
- * assert_eq!(doc.title, Some("My Article".to_string()));
- * ```
  */
 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);
+    constructor(keywords?: string[] | null, openGraph?: any | null, twitterCard?: any | null, metaTags?: any | null, title?: string | null, description?: string | null, author?: string | null, canonicalUrl?: string | null, baseHref?: string | null, language?: string | null, textDirection?: WasmTextDirection | null);
     get author(): string | undefined;
     set author(value: string | null | undefined);
     get baseHref(): string | undefined;
@@ -333,13 +263,12 @@ 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);
+    constructor(id: string, content: any, children: Uint32Array, annotations: WasmTextAnnotation[], parent?: number | null, attributes?: any | null);
     annotations: WasmTextAnnotation[];
     get attributes(): any | undefined;
     set attributes(value: any | null | undefined);
     children: Uint32Array;
-    get content(): string;
-    set content(value: WasmNodeContent);
+    content: any;
     id: string;
     get parent(): number | undefined;
     set parent(value: number | null | undefined);
@@ -354,7 +283,7 @@ export class WasmDocumentStructure {
     free(): void;
     [Symbol.dispose](): void;
     static default(): WasmDocumentStructure;
-    constructor(nodes: WasmDocumentNode[], source_format?: string | null);
+    constructor(nodes: WasmDocumentNode[], sourceFormat?: string | null);
     nodes: WasmDocumentNode[];
     get sourceFormat(): string | undefined;
     set sourceFormat(value: string | null | undefined);
@@ -367,7 +296,7 @@ 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);
+    constructor(content: string, row: number, col: number, rowSpan: number, colSpan: number, isHeader: boolean);
     col: number;
     colSpan: number;
     content: string;
@@ -383,19 +312,6 @@ export class WasmGridCell {
  * and position in the document structure.
  *
  * # Examples
- *
- * ```
- * let header = HeaderMetadata {
- *     level: 1,
- *     text: "Main Title".to_string(),
- *     id: Some("main-title".to_string()),
- *     depth: 0,
- *     html_offset: 145,
- * };
- *
- * assert_eq!(header.level, 1);
- * assert!(header.is_valid());
- * ```
  */
 export class WasmHeaderMetadata {
     free(): void;
@@ -409,29 +325,9 @@ export class WasmHeaderMetadata {
      * `true` if level is 1-6, `false` otherwise.
      *
      * # Examples
-     *
-     * ```
-     * let valid = HeaderMetadata {
-     *     level: 3,
-     *     text: "Title".to_string(),
-     *     id: None,
-     *     depth: 2,
-     *     html_offset: 100,
-     * };
-     * assert!(valid.is_valid());
-     *
-     * let invalid = HeaderMetadata {
-     *     level: 7,  // Invalid
-     *     text: "Title".to_string(),
-     *     id: None,
-     *     depth: 2,
-     *     html_offset: 100,
-     * };
-     * assert!(!invalid.is_valid());
-     * ```
      */
     isValid(): boolean;
-    constructor(level: number, text: string, depth: number, html_offset: number, id?: string | null);
+    constructor(level: number, text: string, depth: number, htmlOffset: number, id?: string | null);
     depth: number;
     htmlOffset: number;
     get id(): string | undefined;
@@ -470,24 +366,12 @@ export enum WasmHighlightStyle {
  * suitable for serialization and transmission across language boundaries.
  *
  * # Examples
- *
- * ```
- * let metadata = HtmlMetadata {
- *     document: Default::default(),
- *     headers: Vec::new(),
- *     links: Vec::new(),
- *     images: Vec::new(),
- *     structured_data: Vec::new(),
- * };
- *
- * assert!(metadata.headers.is_empty());
- * ```
  */
 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);
+    constructor(document?: WasmDocumentMetadata | null, headers?: WasmHeaderMetadata[] | null, links?: WasmLinkMetadata[] | null, images?: WasmImageMetadata[] | null, structuredData?: WasmStructuredData[] | null);
     document: WasmDocumentMetadata;
     headers: WasmHeaderMetadata[];
     images: WasmImageMetadata[];
@@ -502,25 +386,12 @@ export class WasmHtmlMetadata {
  * for image analysis and optimization.
  *
  * # Examples
- *
- * ```
- * let img = ImageMetadata {
- *     src: "https://example.com/image.jpg".to_string(),
- *     alt: Some("An example image".to_string()),
- *     title: Some("Example".to_string()),
- *     dimensions: Some((800, 600)),
- *     image_type: ImageType::External,
- *     attributes: Default::default(),
- * };
- *
- * assert_eq!(img.image_type, ImageType::External);
- * ```
  */
 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);
+    constructor(src: string, imageType: WasmImageType, attributes: any, alt?: string | null, title?: string | null, dimensions?: Uint32Array | null);
     get alt(): string | undefined;
     set alt(value: string | null | undefined);
     attributes: any;
@@ -551,47 +422,12 @@ export enum WasmImageType {
  * Represents `<a>` elements with parsed href values, text content, and link type classification.
  *
  * # Examples
- *
- * ```
- * let link = LinkMetadata {
- *     href: "https://example.com".to_string(),
- *     text: "Example".to_string(),
- *     title: Some("Visit Example".to_string()),
- *     link_type: LinkType::External,
- *     rel: vec!["nofollow".to_string()],
- *     attributes: Default::default(),
- * };
- *
- * assert_eq!(link.link_type, LinkType::External);
- * assert_eq!(link.text, "Example");
- * ```
  */
 export class WasmLinkMetadata {
     free(): void;
     [Symbol.dispose](): void;
-    /**
-     * Classify a link based on href value.
-     *
-     * # Arguments
-     *
-     * * `href` - The href attribute value
-     *
-     * # Returns
-     *
-     * Appropriate [`LinkType`] based on protocol and content.
-     *
-     * # Examples
-     *
-     * ```
-     * 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);
-     * assert_eq!(LinkMetadata::classify_link("https://example.com"), LinkType::External);
-     * ```
-     */
-    static classifyLink(href: string): WasmLinkType;
     static default(): WasmLinkMetadata;
-    constructor(href: string, text: string, link_type: WasmLinkType, rel: string[], attributes: any, title?: string | null);
+    constructor(href: string, text: string, linkType: WasmLinkType, rel: string[], attributes: any, title?: string | null);
     attributes: any;
     href: string;
     get linkType(): string;
@@ -652,20 +488,44 @@ export enum WasmNewlineStyle {
  *
  * Uses internally tagged representation (`"node_type": "heading"`) for JSON serialization.
  */
-export enum WasmNodeContent {
-    Heading = 0,
-    Paragraph = 1,
-    List = 2,
-    ListItem = 3,
-    Table = 4,
-    Image = 5,
-    Code = 6,
-    Quote = 7,
-    DefinitionList = 8,
-    DefinitionItem = 9,
-    RawBlock = 10,
-    MetadataBlock = 11,
-    Group = 12,
+export class WasmNodeContent {
+    free(): void;
+    [Symbol.dispose](): void;
+    static default(): WasmNodeContent;
+    constructor();
+    get content(): string | undefined;
+    set content(value: string | null | undefined);
+    get definition(): string | undefined;
+    set definition(value: string | null | undefined);
+    get description(): string | undefined;
+    set description(value: string | null | undefined);
+    get entries(): any | undefined;
+    set entries(value: any | null | undefined);
+    get format(): string | undefined;
+    set format(value: string | null | undefined);
+    get grid(): WasmTableGrid | undefined;
+    set grid(value: WasmTableGrid | null | undefined);
+    get headingLevel(): number | undefined;
+    set headingLevel(value: number | null | undefined);
+    get headingText(): string | undefined;
+    set headingText(value: string | null | undefined);
+    get imageIndex(): number | undefined;
+    set imageIndex(value: number | null | undefined);
+    get label(): string | undefined;
+    set label(value: string | null | undefined);
+    get language(): string | undefined;
+    set language(value: string | null | undefined);
+    get level(): number | undefined;
+    set level(value: number | null | undefined);
+    nodeType: string;
+    get ordered(): boolean | undefined;
+    set ordered(value: boolean | null | undefined);
+    get src(): string | undefined;
+    set src(value: string | null | undefined);
+    get term(): string | undefined;
+    set term(value: string | null | undefined);
+    get text(): string | undefined;
+    set text(value: string | null | undefined);
 }
 
 /**
@@ -678,7 +538,7 @@ 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);
+    constructor(nodeType: WasmNodeType, tagName: string, attributes: any, depth: number, indexInParent: number, isInline: boolean, parentTag?: string | null);
     attributes: any;
     depth: number;
     indexInParent: number;
@@ -804,35 +664,8 @@ export enum WasmOutputFormat {
 export class WasmPreprocessingOptions {
     free(): void;
     [Symbol.dispose](): void;
-    /**
-     * Apply a partial update to these preprocessing options.
-     *
-     * Any specified fields in the update will override the current values.
-     * Unspecified fields (None) are left unchanged.
-     *
-     * # Arguments
-     *
-     * * `update` - Partial preprocessing options update
-     */
-    applyUpdate(update: WasmPreprocessingOptionsUpdate): void;
     static default(): WasmPreprocessingOptions;
-    static from(update: WasmPreprocessingOptionsUpdate): WasmPreprocessingOptions;
-    /**
-     * Create new preprocessing options from a partial update.
-     *
-     * Creates a new `PreprocessingOptions` struct with defaults, then applies the update.
-     * Fields not specified in the update keep their default values.
-     *
-     * # Arguments
-     *
-     * * `update` - Partial preprocessing options update
-     *
-     * # Returns
-     *
-     * New `PreprocessingOptions` with specified updates applied to defaults
-     */
-    static fromUpdate(update: WasmPreprocessingOptionsUpdate): WasmPreprocessingOptions;
-    constructor(enabled?: boolean | null, preset?: WasmPreprocessingPreset | null, remove_navigation?: boolean | null, remove_forms?: boolean | null);
+    constructor(enabled?: boolean | null, preset?: WasmPreprocessingPreset | null, removeNavigation?: boolean | null, removeForms?: boolean | null);
     enabled: boolean;
     get preset(): string;
     set preset(value: WasmPreprocessingPreset);
@@ -844,14 +677,14 @@ export class WasmPreprocessingOptions {
  * Partial update for `PreprocessingOptions`.
  *
  * This struct uses `Option<T>` to represent optional fields that can be selectively updated.
- * Only specified fields (Some values) will override existing options; None values leave the
- * corresponding fields unchanged when applied via [`PreprocessingOptions::apply_update`].
+ * Only specified fields (values) will override existing options; undefined values leave the
+ * corresponding fields unchanged when applied via `PreprocessingOptions.apply_update`.
  */
 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);
+    constructor(enabled?: boolean | null, preset?: WasmPreprocessingPreset | null, removeNavigation?: boolean | null, removeForms?: boolean | null);
     get enabled(): boolean | undefined;
     set enabled(value: boolean | null | undefined);
     get preset(): string | undefined;
@@ -874,7 +707,21 @@ export enum WasmPreprocessingPreset {
 }
 
 /**
- * A non-fatal warning generated during HTML processing.
+ * A non-fatal diagnostic produced during HTML conversion.
+ *
+ * Warnings indicate that conversion completed but some content may have been handled
+ * differently than expected — for example, an image that could not be extracted, a truncated
+ * input, or malformed HTML that was repaired with best-effort parsing.
+ *
+ * Conversion always succeeds (returns `ConversionResult`) even when warnings are
+ * present. Callers should inspect `warnings` and decide how to
+ * handle them based on their tolerance for partial results:
+ *
+ * - **Logging pipelines**: emit each warning at `WARN` level and continue.
+ * - **Strict pipelines**: treat any warning as a hard error by checking
+ *   `result.warnings.is_empty()` before using the output.
+ *
+ * See `WarningKind` for the full taxonomy of warning categories.
  */
 export class WasmProcessingWarning {
     free(): void;
@@ -893,22 +740,12 @@ export class WasmProcessingWarning {
  * JSON-LD blocks are collected as raw JSON strings for flexibility.
  *
  * # Examples
- *
- * ```
- * let schema = StructuredData {
- *     data_type: StructuredDataType::JsonLd,
- *     raw_json: r#"{"@context":"https://schema.org","@type":"Article"}"#.to_string(),
- *     schema_type: Some("Article".to_string()),
- * };
- *
- * assert_eq!(schema.data_type, StructuredDataType::JsonLd);
- * ```
  */
 export class WasmStructuredData {
     free(): void;
     [Symbol.dispose](): void;
     static default(): WasmStructuredData;
-    constructor(data_type: WasmStructuredDataType, raw_json: string, schema_type?: string | null);
+    constructor(dataType: WasmStructuredDataType, rawJson: string, schemaType?: string | null);
     get dataType(): string;
     set dataType(value: WasmStructuredDataType);
     rawJson: string;
@@ -953,18 +790,28 @@ export class WasmTableGrid {
 }
 
 /**
- * An inline text annotation with byte-range offsets.
+ * A styling or semantic annotation that applies to a byte range within a node's text.
+ *
+ * Unlike `DocumentNode`, which captures block-level structure (headings, paragraphs, etc.),
+ * a `TextAnnotation` describes inline-level markup — bold, italic, links, code spans, and
+ * similar — that spans a contiguous run of bytes inside `DocumentNode.content`'s text field.
  *
- * Annotations describe formatting (bold, italic, etc.) and links within a node's text content.
+ * Byte offsets (`start`..`end`) are into the UTF-8 encoded text of the parent node. The range
+ * follows Rust slice conventions: `start` is inclusive and `end` is exclusive, so the annotated
+ * text is `text[start as usize..end as usize]`.
+ *
+ * Multiple annotations on the same node can overlap (e.g. bold-italic text), and they are
+ * stored in the order they are encountered during DOM traversal.
+ *
+ * See `AnnotationKind` for the full list of supported annotation types.
  */
 export class WasmTextAnnotation {
     free(): void;
     [Symbol.dispose](): void;
     static default(): WasmTextAnnotation;
-    constructor(start: number, end: number, kind: WasmAnnotationKind);
+    constructor(start: number, end: number, kind: any);
     end: number;
-    get kind(): string;
-    set kind(value: WasmAnnotationKind);
+    kind: any;
     start: number;
 }
 
@@ -995,11 +842,12 @@ export enum WasmVisitResult {
 }
 
 /**
- * Type alias for a visitor handle (`Arc`-wrapped `Mutex` for thread-safe shared mutation).
+ * Shareable, thread-safe handle to a user-provided HTML visitor implementation.
  *
- * `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.
+ * Pass an instance wrapped in this handle to `ConversionOptions` to
+ * customise how the HTML document is traversed and converted to Markdown.
+ * The handle may be cloned and shared across threads without additional
+ * synchronisation on the caller's side.
  */
 export class WasmVisitorHandle {
     free(): void;
@@ -1030,23 +878,16 @@ export enum WasmWhitespaceMode {
 }
 
 /**
- * Convert HTML to Markdown, returning a [`ConversionResult`] with content, metadata, images,
+ * 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`].
+ * * `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
  *