datocms-html-to-structured-text/dist/esm/types.d.ts

Convert HTML (or a `hast` syntax tree) to a valid DatoCMS Structured Text `dast` document

import { Node, Root, NodeType, Mark } from 'datocms-structured-text-utils';
export type { Node, Root, NodeType, Mark };
export declare type CreateNodeFunction = (type: NodeType, props: Omit<Node, 'type'>) => Node;
export interface GlobalContext {
    /**
     * Whether the library has found a <base> tag or should not look further.
     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base
     */
    baseUrlFound?: boolean;
    /** <base> tag url. This is used for resolving relative URLs. */
    baseUrl?: string;
}
export interface Context {
    /** The parent `dast` node type. */
    parentNodeType: NodeType;
    /** The parent `hast` node. */
    parentNode: HastNode;
    /** A reference to the current handlers - merged default + user handlers. */
    handlers: Record<string, Handler>;
    /** A reference to the default handlers record (map). */
    defaultHandlers: Record<string, Handler>;
    /** true if the content can include newlines, and false if not (such as in headings). */
    wrapText: boolean;
    /** Marks for span nodes. */
    marks?: Mark[];
    /**
     * Prefix for language detection in code blocks.
     *
     * Detection is done on a class name eg class="language-html".
     * Default is `language-`.
     */
    codePrefix?: string;
    /** Properties in this object are avaliable to every handler as Context
     * is not deeply cloned.
     */
    global: GlobalContext;
}
export declare type Handler<HN extends HastNode = HastNode> = (createNodeFunction: CreateNodeFunction, node: HN, context: Context) => Promise<Node | Array<Node> | void> | Array<Promise<Node | Array<Node> | void>>;
export interface HastProperties {
    className?: string[];
    [key: string]: any;
}
export interface HastTextNode {
    type: 'text';
    value: string;
}
export interface HastElementNode {
    type: 'element';
    tagName: string;
    properties?: HastProperties;
    children?: HastNode[];
}
export interface HastRootNode {
    type: 'root';
    children?: HastNode[];
}
export declare type HastNode = HastTextNode | HastElementNode | HastRootNode;