import { PluginWithOptions } from 'markdown-it'

/**
 * Options of md-plugin-headers
 */
interface HeadersPluginOptions {
  /**
   * A custom slugification function
   *
   * Should use the same slugify function with markdown-it-anchor
   * to ensure the link is matched
   */
  slugify?: (str: string) => string
  /**
   * A function for formatting header title
   */
  format?: (str: string) => string
  /**
   * Heading level that going to be extracted
   *
   * Should be a subset of markdown-it-anchor's `level` option
   * to ensure the slug is existed
   *
   * @default [2,3]
   */
  level?: number[]
  /**
   * Should allow headers inside nested blocks or not
   *
   * If set to `true`, headers inside blockquote, list, etc. would also be extracted.
   *
   * @default false
   */
  shouldAllowNested?: boolean
  /**
   * Should allow API headers
   *
   * If set to `true`, headers for `<MarkdownAPI>` title would also be extracted.
   *
   * @default true
   */
  shouldAllowApi?: boolean
  /**
   * Should allow Example headers
   *
   * If set to `true`, headers for `<MarkdownExample>` title would also be extracted.
   *
   * @default true
   */
  shouldAllowExample?: boolean
}

interface TocItem {
  id: string
  title: string
  sub?: boolean
  deep?: boolean
}

declare module '@md-plugins/shared' {
  interface MarkdownItEnv {
    /**
     * The toc that are extracted by `md-plugin-headers`
     */
    toc?: TocItem[]
  }
}

declare const headersPlugin: PluginWithOptions<HeadersPluginOptions>

export { type HeadersPluginOptions, type TocItem, headersPlugin }