myst-to-jats/dist/types.d.ts

Export from MyST Markdown to JATS

import type { FrontmatterParts, GenericNode, MessageInfo } from 'myst-common';
import type { PageFrontmatter } from 'myst-frontmatter';
import type { Root } from 'myst-spec';
import type { SourceFileKind } from 'myst-spec-ext';
import type { CitationRenderer } from 'citation-js-utils';
import type { SerializationOptions } from 'jats-utils';
export type Attributes = Record<string, string | undefined>;
export type Element = {
    type: 'element' | 'text' | 'cdata';
    name?: string;
    text?: string;
    cdata?: string;
    attributes?: Attributes;
    elements?: Element[];
};
export type Handler<T = any> = (node: T, state: IJatsSerializer, parent: any) => void;
export type MathPlugins = Required<PageFrontmatter>['math'];
export type JatsPart = {
    part: string | string[];
    type?: string;
    title?: string;
};
export declare const ACKNOWLEDGMENT_PARTS: string[];
export declare const ABSTRACT_PARTS: string[];
export type Options = {
    handlers?: Record<string, Handler>;
    isNotebookArticleRep?: boolean;
    isSubArticle?: boolean;
    slug?: string;
    extractAbstract?: boolean;
    abstractParts?: JatsPart[];
    backSections?: JatsPart[];
    frontmatterParts?: FrontmatterParts;
};
export type DocumentOptions = Options & SerializationOptions & {
    subArticles?: ArticleContent[];
    writeFullArticle?: boolean;
};
export type StateData = {
    isInContainer?: boolean;
    isNotebookArticleRep?: boolean;
    slug?: string;
    abstracts?: Element[];
    backSections?: Element[];
    acknowledgments?: Element;
};
export type FrontmatterWithParts = Omit<PageFrontmatter, 'parts'> & {
    parts?: FrontmatterParts;
};
export type ArticleContent = {
    mdast: Root;
    kind: SourceFileKind;
    frontmatter?: FrontmatterWithParts;
    citations?: CitationRenderer;
    slug?: string;
};
export interface IJatsSerializer<D extends Record<string, any> = StateData> {
    data: D;
    mdast: Root;
    stack: Element[];
    footnotes: Element[];
    expressions: Element[];
    referenceOrder: string[];
    render: (ignoreParts?: boolean) => IJatsSerializer;
    text: (value?: string) => void;
    renderChildren: (node: any) => void;
    renderInline: (node: GenericNode, name: string, attributes?: Attributes) => void;
    pushNode: (el?: Element) => void;
    addLeaf: (name: string, attributes?: Attributes) => void;
    openNode: (name: string, attributes?: Attributes) => void;
    closeNode: () => void;
    elements: () => Element[];
    warn: (message: string, node?: GenericNode, source?: string, opts?: MessageInfo) => void;
    error: (message: string, node?: GenericNode, source?: string, opts?: MessageInfo) => void;
}
//# sourceMappingURL=types.d.ts.map