# This file is auto-generated by alef. DO NOT EDIT.
defmodule HtmlToMarkdown do
  @moduledoc "High-level API for html_to_markdown."

  @doc "Convert HTML to Markdown, returning a [`ConversionResult`] with content, metadata, images,"
  @spec convert(String.t()) :: {:ok, String.t() | nil} | {:error, String.t()}
  def convert(html) do
    HtmlToMarkdown.Native.convert(html, nil)
  end

  @doc "Convert HTML to Markdown, returning a [`ConversionResult`] with content, metadata, images,"
  @spec convert(String.t(), String.t() | nil | nil) ::
          {:ok, String.t() | nil} | {:error, String.t()}
  def convert(html, options) do
    HtmlToMarkdown.Native.convert(html, options)
  end

  @doc "Create default metadata configuration."
  @spec metadataconfig_default() :: String.t() | nil
  def metadataconfig_default do
    HtmlToMarkdown.Native.metadataconfig_default()
  end

  @doc "Check if any metadata extraction is enabled."
  @spec metadataconfig_any_enabled(map()) :: boolean()
  def metadataconfig_any_enabled(obj) do
    HtmlToMarkdown.Native.metadataconfig_any_enabled(obj)
  end

  @doc "Validate that the header level is within valid range (1-6)."
  @spec headermetadata_is_valid(map()) :: boolean()
  def headermetadata_is_valid(obj) do
    HtmlToMarkdown.Native.headermetadata_is_valid(obj)
  end

  @doc "Classify a link based on href value."
  @spec linkmetadata_classify_link(String.t()) :: map()
  def linkmetadata_classify_link(href) do
    HtmlToMarkdown.Native.linkmetadata_classify_link(href)
  end

  @doc "Method"
  @spec conversionoptions_default() :: String.t() | nil
  def conversionoptions_default do
    HtmlToMarkdown.Native.conversionoptions_default()
  end

  @doc "Create a new builder with default values."
  @spec conversionoptions_builder() :: reference()
  def conversionoptions_builder do
    HtmlToMarkdown.Native.conversionoptions_builder()
  end

  @doc "Set the list of HTML tag names whose content is stripped from output."
  @spec conversionoptionsbuilder_strip_tags(map(), [String.t()]) :: reference()
  def conversionoptionsbuilder_strip_tags(obj, tags) do
    HtmlToMarkdown.Native.conversionoptionsbuilder_strip_tags(obj, tags)
  end

  @doc "Set the list of HTML tag names that are preserved verbatim in output."
  @spec conversionoptionsbuilder_preserve_tags(map(), [String.t()]) :: reference()
  def conversionoptionsbuilder_preserve_tags(obj, tags) do
    HtmlToMarkdown.Native.conversionoptionsbuilder_preserve_tags(obj, tags)
  end

  @doc "Set the list of HTML tag names whose `<img>` children are kept inline."
  @spec conversionoptionsbuilder_keep_inline_images_in(map(), [String.t()]) :: reference()
  def conversionoptionsbuilder_keep_inline_images_in(obj, tags) do
    HtmlToMarkdown.Native.conversionoptionsbuilder_keep_inline_images_in(obj, tags)
  end

  @doc "Set the pre-processing options applied to the HTML before conversion."
  @spec conversionoptionsbuilder_preprocessing(map(), String.t() | nil) :: reference()
  def conversionoptionsbuilder_preprocessing(obj, preprocessing) do
    HtmlToMarkdown.Native.conversionoptionsbuilder_preprocessing(obj, preprocessing)
  end

  @doc "Build the final [`ConversionOptions`]."
  @spec conversionoptionsbuilder_build(map()) :: String.t() | nil
  def conversionoptionsbuilder_build(obj) do
    HtmlToMarkdown.Native.conversionoptionsbuilder_build(obj)
  end

  @doc "Method"
  @spec preprocessingoptions_default() :: String.t() | nil
  def preprocessingoptions_default do
    HtmlToMarkdown.Native.preprocessingoptions_default()
  end
end