@asciidoctor/core 3.0.4 → 4.0.0-alpha.2

package/types/compliance.d.ts

@@ -0,0 +1,23 @@
+export namespace Compliance {
+    let keys: Set<string>;
+    /** AsciiDoc terminates paragraphs adjacent to block content (delimiter or block attribute list). Compliance value: true */
+    let blockTerminatesParagraph: boolean;
+    /** AsciiDoc does not parse paragraphs with a verbatim style as verbatim content. Compliance value: false (Asciidoctor default: true) */
+    let strictVerbatimParagraphs: boolean;
+    /** AsciiDoc supports both atx (single-line) and setext (underlined) section titles. Compliance value: true */
+    let underlineStyleSectionTitles: boolean;
+    /** Asciidoctor will unwrap the content in a preamble if the document has a title and no sections. Compliance value: false (Asciidoctor default: true) */
+    let unwrapStandalonePreamble: boolean;
+    /** AsciiDoc drops lines that contain references to missing attributes. Possible values: 'skip', 'drop', 'drop-line', 'warn'. Compliance value: 'drop-line' (Asciidoctor default: 'skip') */
+    let attributeMissing: string;
+    /** AsciiDoc drops lines that contain an attribute unassignment. Compliance value: 'drop-line' */
+    let attributeUndefined: string;
+    /** Shorthand syntax for id, role and options on blocks (e.g. #id.role%opt). Compliance value: false (Asciidoctor default: true) */
+    let shorthandPropertySyntax: boolean;
+    /** Resolve cross-reference targets by matching reftext or title. Compliance value: false (Asciidoctor default: true) */
+    let naturalXrefs: boolean;
+    /** Starting counter when generating a unique id on conflict. Compliance value: 2 */
+    let uniqueIdStartIndex: number;
+    /** Recognize commonly-used Markdown syntax where it does not conflict. Compliance value: false (Asciidoctor default: true) */
+    let markdownSyntax: boolean;
+}

package/types/constants.d.ts

@@ -0,0 +1,268 @@
+export * from "./rx.js";
+export namespace SafeMode {
+    /**
+     * A safe mode level that disables any of the security features enforced
+     * by Asciidoctor (Node is still subject to its own restrictions).
+     */
+    let UNSAFE: number;
+    /**
+     * A safe mode level that closely parallels safe mode in AsciiDoc. This value
+     * prevents access to files which reside outside the parent directory of
+     * the source file and disables any macro other than the `include::[]` directive.
+     */
+    let SAFE: number;
+    /**
+     * A safe mode level that disallows the document from setting attributes
+     * that would affect the conversion of the document, in addition to all the
+     * security features of {@link SafeMode.SAFE}. For instance, this level forbids
+     * changing the backend or source-highlighter using an attribute defined
+     * in the source document header. This is the most fundamental level of
+     * security for server deployments (hence the name).
+     */
+    let SERVER: number;
+    /**
+     * A safe mode level that disallows the document from attempting to read
+     * files from the file system and including the contents of them into the
+     * document, in additional to all the security features of {@link SafeMode.SERVER}.
+     * For instance, this level disallows use of the `include::[]` directive and the
+     * embedding of binary content (data uri), stylesheets and JavaScripts
+     * referenced by the document. (Asciidoctor and trusted extensions may still
+     * be allowed to embed trusted content into the document).
+     *
+     * Since Asciidoctor is aiming for wide adoption, this level is the default
+     * and is recommended for server deployments.
+     */
+    let SECURE: number;
+    /**
+     * Returns the numeric value for a safe-mode name string, or undefined.
+     * @param {string} name
+     * @returns {number|undefined}
+     */
+    function valueForName(name: string): number | undefined;
+    /**
+     * @param {string} name
+     * @returns {number|undefined}
+     */
+    function getValueForName(name: string): number | undefined;
+    /**
+     * Returns the lowercase name for a numeric safe-mode value, or undefined.
+     * @param {number} value
+     * @returns {string|undefined}
+     */
+    function nameForValue(value: number): string | undefined;
+    /**
+     * @param {number} value
+     * @returns {string|undefined}
+     */
+    function getNameForValue(value: number): string | undefined;
+    /**
+     * Returns all safe-mode names in ascending value order.
+     * @returns {string[]}
+     */
+    function names(): string[];
+    /**
+     * @returns {string[]}
+     */
+    function getNames(): string[];
+}
+export namespace ContentModel {
+    /** The block contains other blocks (sections, sidebars, admonitions, …). */
+    let COMPOUND: string;
+    /** The block holds a paragraph of prose that receives normal substitutions. */
+    let SIMPLE: string;
+    /** The block holds verbatim text displayed as-is with verbatim substitutions (listing, literal). */
+    let VERBATIM: string;
+    /** The block holds unprocessed content passed directly to output with no substitutions (pass). */
+    let RAW: string;
+    /** The block has no content (e.g. image, thematic break). */
+    let EMPTY: string;
+}
+export const LF: "\n";
+export const NULL: "\0";
+export const TAB: "\t";
+export const MAX_INT: 9007199254740991;
+export const DEFAULT_DOCTYPE: "article";
+export const DEFAULT_BACKEND: "html5";
+export const DEFAULT_STYLESHEET_KEYS: Set<string>;
+export const DEFAULT_STYLESHEET_NAME: "asciidoctor.css";
+export namespace BACKEND_ALIASES {
+    let html: string;
+    let docbook: string;
+}
+export namespace DEFAULT_PAGE_WIDTHS {
+    let docbook_1: number;
+    export { docbook_1 as docbook };
+}
+export namespace DEFAULT_EXTENSIONS {
+    let html_1: string;
+    export { html_1 as html };
+    let docbook_2: string;
+    export { docbook_2 as docbook };
+    export let pdf: string;
+    export let epub: string;
+    export let manpage: string;
+    export let asciidoc: string;
+}
+export const ASCIIDOC_EXTENSIONS: {
+    '.adoc': boolean;
+    '.asciidoc': boolean;
+    '.asc': boolean;
+    '.ad': boolean;
+    '.txt': boolean;
+};
+export const SETEXT_SECTION_LEVELS: {
+    '=': number;
+    '-': number;
+    '~': number;
+    '^': number;
+    '+': number;
+};
+export const ADMONITION_STYLES: Set<string>;
+export const ADMONITION_STYLE_HEADS: Set<string>;
+export const PARAGRAPH_STYLES: Set<string>;
+export const VERBATIM_STYLES: Set<string>;
+export const DELIMITED_BLOCKS: {
+    '--': (string | Set<string>)[];
+    '----': (string | Set<string>)[];
+    '....': (string | Set<string>)[];
+    '====': (string | Set<string>)[];
+    '****': (string | Set<any>)[];
+    ____: (string | Set<string>)[];
+    '++++': (string | Set<string>)[];
+    '|===': (string | Set<any>)[];
+    ',===': (string | Set<any>)[];
+    ':===': (string | Set<any>)[];
+    '!===': (string | Set<any>)[];
+    '~~~~': (string | Set<string>)[];
+    '////': (string | Set<any>)[];
+    '```': (string | Set<any>)[];
+};
+export const DELIMITED_BLOCK_HEADS: {
+    [k: string]: boolean;
+};
+export const DELIMITED_BLOCK_TAILS: {
+    [k: string]: string;
+};
+export namespace CAPTION_ATTRIBUTE_NAMES {
+    let example: string;
+    let figure: string;
+    let listing: string;
+    let table: string;
+}
+export const LAYOUT_BREAK_CHARS: {
+    "'": string;
+    '<': string;
+};
+export const MARKDOWN_THEMATIC_BREAK_CHARS: {
+    '-': string;
+    '*': string;
+    _: string;
+};
+export const HYBRID_LAYOUT_BREAK_CHARS: {
+    '-': string;
+    '*': string;
+    _: string;
+    "'": string;
+    '<': string;
+};
+export const NESTABLE_LIST_CONTEXTS: string[];
+export const ORDERED_LIST_STYLES: string[];
+export namespace ORDERED_LIST_KEYWORDS {
+    let loweralpha: string;
+    let lowerroman: string;
+    let upperalpha: string;
+    let upperroman: string;
+}
+export const ATTR_REF_HEAD: "{";
+export const LIST_CONTINUATION: "+";
+export const HARD_LINE_BREAK: " +";
+export const LINE_CONTINUATION: " \\";
+export const LINE_CONTINUATION_LEGACY: " +";
+export namespace BLOCK_MATH_DELIMITERS {
+    let asciimath: string[];
+    let latexmath: string[];
+}
+export namespace INLINE_MATH_DELIMITERS {
+    let asciimath_1: string[];
+    export { asciimath_1 as asciimath };
+    let latexmath_1: string[];
+    export { latexmath_1 as latexmath };
+}
+export namespace STEM_TYPE_ALIASES {
+    let latexmath_2: string;
+    export { latexmath_2 as latexmath };
+    export let latex: string;
+    export let tex: string;
+}
+export const FONT_AWESOME_VERSION: "4.7.0";
+export const HIGHLIGHT_JS_VERSION: "9.18.3";
+export const MATHJAX_VERSION: "2.7.9";
+export const DEFAULT_ATTRIBUTES: {
+    'appendix-caption': string;
+    'appendix-refsig': string;
+    'caution-caption': string;
+    'chapter-refsig': string;
+    'example-caption': string;
+    'figure-caption': string;
+    'important-caption': string;
+    'last-update-label': string;
+    'note-caption': string;
+    'part-refsig': string;
+    prewrap: string;
+    sectids: string;
+    'section-refsig': string;
+    'table-caption': string;
+    'tip-caption': string;
+    'toc-placement': string;
+    'toc-title': string;
+    'untitled-label': string;
+    'version-label': string;
+    'warning-caption': string;
+};
+export const FLEXIBLE_ATTRIBUTES: string[];
+export const INTRINSIC_ATTRIBUTES: {
+    startsb: string;
+    endsb: string;
+    vbar: string;
+    caret: string;
+    asterisk: string;
+    tilde: string;
+    plus: string;
+    backslash: string;
+    backtick: string;
+    blank: string;
+    empty: string;
+    sp: string;
+    'two-colons': string;
+    'two-semicolons': string;
+    nbsp: string;
+    deg: string;
+    zwsp: string;
+    quot: string;
+    apos: string;
+    lsquo: string;
+    rsquo: string;
+    ldquo: string;
+    rdquo: string;
+    wj: string;
+    brvbar: string;
+    pp: string;
+    cpp: string;
+    cxx: string;
+    amp: string;
+    lt: string;
+    gt: string;
+};
+export namespace QUOTE_SUBS {
+    export { _normalQuoteSubs as false };
+    export { _compatQuoteSubs as true };
+}
+export const REPLACEMENTS: (string | RegExp)[][];
+export const BASIC_SUBS: readonly string[];
+export const NORMAL_SUBS: readonly string[];
+export let ROOT_DIR: string;
+export let LIB_DIR: string;
+export let DATA_DIR: string;
+export let USER_HOME: string;
+declare const _normalQuoteSubs: (string | RegExp)[][];
+declare const _compatQuoteSubs: (string | RegExp)[][];

package/types/convert.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Parse the AsciiDoc source input into a Document and convert it to the specified backend format.
+ *
+ * Accepts input as a Node.js Readable stream (or any object with a read() method), a String,
+ * or a String Array. If the input is a file-like object with a `.path` property, it is treated
+ * as a file: the output is written to a file adjacent to the input by default.
+ *
+ * If `to_file` is true or omitted and the input is a file-like object, the output is written
+ * next to the input file. If `to_file` is a String path, the output is written there.
+ * If `to_file` is false, the converted String is returned.
+ * If `to_file` is `'/dev/null'`, the document is loaded but neither converted nor written.
+ *
+ * @param {string|string[]|object} input - the AsciiDoc source (String, Array, Readable, or
+ *   file-like object with a `.path` property)
+ * @param {object} [options={}] - a plain Object of options (mirrors Ruby API):
+ *   - `to_file` {string|boolean|object} - String path, Boolean, stream object, or `'/dev/null'`
+ *   - `to_dir` {string} - output directory
+ *   - `mkdirs` {boolean} - create missing directories if true
+ *   - `standalone` {boolean} - include header/footer
+ *   - `header_footer` {boolean} - deprecated alias for `standalone`
+ *   - `base_dir` {string} - base directory
+ * @returns {Promise<import('./document.js').Document|string>} the Document if output was written to a file, otherwise the converted String
+ */
+export function convert(input: string | string[] | object, options?: object): Promise<import("./document.js").Document | string>;
+/**
+ * Parse the contents of the AsciiDoc source file into a Document and convert it
+ * to the specified backend format.
+ *
+ * @param {string} filename - the path to the AsciiDoc source file
+ * @param {object} [options={}] - a plain Object of options (see {@link convert})
+ * @returns {Promise<import('./document.js').Document|string>} the Document if output was written to a file, otherwise the converted String
+ */
+export function convertFile(filename: string, options?: object): Promise<import("./document.js").Document | string>;
+export { convert as render, convertFile as renderFile };

package/types/converter/composite.d.ts

@@ -0,0 +1,20 @@
+export class CompositeConverter {
+    constructor(backend: any, ...args: any[]);
+    backend: any;
+    converters: any[];
+    _converterCache: Map<any, any>;
+    /**
+     * Delegates to the first converter that handles the given transform.
+     * @param {object} node - the AbstractNode to convert
+     * @param {string|null} [transform=null] - the optional transform (default: node.nodeName)
+     * @param {object|null} [opts=null] - optional hints passed to the delegate's convert method
+     * @returns {Promise<string>} the result from the delegate's convert method
+     */
+    convert(node: object, transform?: string | null, opts?: object | null): Promise<string>;
+    /**
+     * Retrieve the converter for the specified transform (cached).
+     * @param {string} transform
+     * @returns {object} the matching converter
+     */
+    converterFor(transform: string): object;
+}

package/types/converter/docbook5.d.ts

@@ -0,0 +1,41 @@
+export class DocBook5Converter extends ConverterBase {
+    convert_document(node: any): Promise<string>;
+    convert_embedded(node: any): Promise<string>;
+    convert_section(node: any): Promise<string>;
+    convert_admonition(node: any): Promise<string>;
+    convert_audio(_node: any): Promise<string>;
+    convert_colist(node: any): Promise<string>;
+    convert_dlist(node: any): Promise<string>;
+    convert_example(node: any): Promise<string>;
+    convert_floating_title(node: any): Promise<string>;
+    convert_image(node: any): Promise<string>;
+    convert_listing(node: any): Promise<string>;
+    convert_literal(node: any): Promise<string>;
+    convert_pass(node: any): Promise<any>;
+    convert_stem(node: any): Promise<string>;
+    convert_olist(node: any): Promise<string>;
+    convert_open(node: any): Promise<any>;
+    convert_page_break(_node: any): Promise<string>;
+    convert_paragraph(node: any): Promise<string>;
+    convert_preamble(node: any): Promise<any>;
+    convert_quote(node: any): Promise<string>;
+    convert_thematic_break(_node: any): Promise<string>;
+    convert_sidebar(node: any): Promise<string>;
+    convert_table(node: any): Promise<string>;
+    convert_toc(_node: any): Promise<string>;
+    convert_ulist(node: any): Promise<string>;
+    convert_verse(node: any): Promise<string>;
+    convert_video(_node: any): Promise<string>;
+    convert_inline_anchor(node: any): Promise<string>;
+    convert_inline_break(node: any): Promise<string>;
+    convert_inline_button(node: any): Promise<string>;
+    convert_inline_callout(node: any): Promise<string>;
+    convert_inline_footnote(node: any): Promise<string>;
+    convert_inline_image(node: any): Promise<string>;
+    convert_inline_indexterm(node: any): Promise<string>;
+    convert_inline_kbd(node: any): Promise<string>;
+    convert_inline_menu(node: any): Promise<string>;
+    convert_inline_quoted(node: any): Promise<string>;
+}
+export default DocBook5Converter;
+import { ConverterBase } from '../converter.js';

package/types/converter/html5.d.ts

@@ -0,0 +1,51 @@
+export default class Html5Converter extends ConverterBase {
+    /**
+     * Create a new Html5Converter instance.
+     * @param {string} [backend='html5']
+     * @param {Object} [opts={}]
+     * @returns {Html5Converter}
+     */
+    static create(backend?: string, opts?: any): Html5Converter;
+    _xmlMode: boolean;
+    _voidSlash: string;
+    convert_document(node: any): Promise<string>;
+    convert_embedded(node: any): Promise<string>;
+    convert_outline(node: any, opts?: {}): Promise<string>;
+    convert_section(node: any): Promise<string>;
+    convert_admonition(node: any): Promise<string>;
+    convert_audio(node: any): Promise<string>;
+    convert_colist(node: any): Promise<string>;
+    convert_dlist(node: any): Promise<string>;
+    convert_example(node: any): Promise<string>;
+    convert_floating_title(node: any): Promise<string>;
+    convert_image(node: any): Promise<string>;
+    convert_listing(node: any): Promise<string>;
+    convert_literal(node: any): Promise<string>;
+    convert_stem(node: any): Promise<string>;
+    convert_olist(node: any): Promise<string>;
+    convert_open(node: any): Promise<string>;
+    convert_page_break(_node: any): Promise<string>;
+    convert_paragraph(node: any): Promise<string>;
+    convert_pass(node: any): Promise<string>;
+    convert_preamble(node: any): Promise<string>;
+    convert_quote(node: any): Promise<string>;
+    convert_thematic_break(node: any): Promise<string>;
+    convert_sidebar(node: any): Promise<string>;
+    convert_table(node: any): Promise<string>;
+    convert_toc(node: any): Promise<string>;
+    convert_ulist(node: any): Promise<string>;
+    convert_verse(node: any): Promise<string>;
+    convert_video(node: any): Promise<string>;
+    convert_inline_anchor(node: any): Promise<string>;
+    convert_inline_break(node: any): Promise<string>;
+    convert_inline_button(node: any): Promise<string>;
+    convert_inline_callout(node: any): Promise<string>;
+    convert_inline_footnote(node: any): Promise<string>;
+    convert_inline_image(node: any): Promise<string>;
+    convert_inline_indexterm(node: any): Promise<any>;
+    convert_inline_kbd(node: any): Promise<string>;
+    convert_inline_menu(node: any): Promise<string>;
+    convert_inline_quoted(node: any): Promise<string>;
+    readSvgContents(node: any, target: any): Promise<any>;
+}
+import { ConverterBase } from '../converter.js';

package/types/converter/manpage.d.ts

@@ -0,0 +1,59 @@
+export default class ManPageConverter extends ConverterBase {
+    static writeAlternatePages(mannames: any, manvolnum: any, target: any): Promise<void>;
+    convert_document(node: any): Promise<string>;
+    convert_embedded(node: any): Promise<string>;
+    convert_section(node: any): Promise<string>;
+    convert_admonition(node: any): Promise<string>;
+    convert_colist(node: any): Promise<string>;
+    convert_dlist(node: any): Promise<string>;
+    convert_example(node: any): Promise<string>;
+    convert_floating_title(node: any): Promise<string>;
+    convert_image(node: any): Promise<string>;
+    convert_listing(node: any): Promise<string>;
+    convert_literal(node: any): Promise<string>;
+    convert_sidebar(node: any): Promise<string>;
+    convert_olist(node: any): Promise<string>;
+    convert_open(node: any): Promise<any>;
+    convert_page_break(_node: any): Promise<string>;
+    convert_paragraph(node: any): Promise<string>;
+    convert_pass(node: any): Promise<string>;
+    convert_preamble(node: any): Promise<string>;
+    convert_quote(node: any): Promise<string>;
+    convert_stem(node: any): Promise<string>;
+    convert_table(node: any): Promise<string>;
+    convert_thematic_break(_node: any): Promise<string>;
+    convert_toc(_node: any): Promise<void>;
+    convert_ulist(node: any): Promise<string>;
+    convert_verse(node: any): Promise<string>;
+    convert_video(node: any): Promise<string>;
+    convert_inline_anchor(node: any): Promise<any>;
+    convert_inline_break(node: any): Promise<string>;
+    convert_inline_button(node: any): Promise<string>;
+    convert_inline_callout(node: any): Promise<string>;
+    convert_inline_footnote(node: any): Promise<string>;
+    convert_inline_image(node: any): Promise<string>;
+    convert_inline_indexterm(node: any): Promise<any>;
+    convert_inline_kbd(node: any): Promise<string>;
+    convert_inline_menu(node: any): Promise<string>;
+    convert_inline_quoted(node: any): Promise<any>;
+    /**
+     * Converts HTML entity references back to their original form, escapes
+     * special man characters and strips trailing whitespace.
+     *
+     * It's crucial that text only ever pass through manify once.
+     *
+     * @param {string} str - the string to convert
+     * @param {Object} [opts={}] - options to control processing
+     * @param {'preserve'|'normalize'|'collapse'} [opts.whitespace='collapse'] - how to handle whitespace:
+     *   `'preserve'` preserves spaces (only expanding tabs);
+     *   `'normalize'` removes spaces around newlines;
+     *   `'collapse'` collapses adjacent whitespace to a single space
+     * @param {boolean} [opts.append_newline=false] - append a newline to the result
+     * @returns {string} the manified string
+     */
+    manify(str: string, opts?: {
+        whitespace?: "preserve" | "normalize" | "collapse";
+        append_newline?: boolean;
+    }): string;
+}
+import { ConverterBase } from '../converter.js';

package/types/converter/template.d.ts

@@ -0,0 +1,83 @@
+export class TemplateConverter extends ConverterBase {
+    static _caches: {
+        scans: {};
+        templates: {};
+    };
+    static TemplateEngine: {
+        registry: {};
+        register(names: any, adapter: any): void;
+    };
+    static clearCaches(): void;
+    /** Alias for clearCaches() — matches the Ruby/core API name. */
+    static clearCache(): void;
+    /** Return the class-level cache object. */
+    static getCache(): {
+        scans: {};
+        templates: {};
+    };
+    /**
+     * Async factory — create and fully initialize a TemplateConverter.
+     * @param {string} backend
+     * @param {string|string[]} templateDirs
+     * @param {Object} [opts={}]
+     * @returns {Promise<TemplateConverter>}
+     */
+    static create(backend: string, templateDirs: string | string[], opts?: any): Promise<TemplateConverter>;
+    /**
+     * Construct a new TemplateConverter (synchronous setup only).
+     * Prefer TemplateConverter.create() which also runs the async _scan() step.
+     * @param {string} backend - the backend name (e.g. 'html5')
+     * @param {string|string[]} templateDirs - paths to scan for templates
+     * @param {Object} [opts={}]
+     * @param {string} [opts.template_engine] - engine name restriction (e.g. 'nunjucks')
+     * @param {Object} [opts.template_engine_options] - per-engine option objects
+     * @param {boolean|Object} [opts.template_cache] - true → class-level cache, Object → supplied cache
+     */
+    constructor(backend: string, templateDirs: string | string[], opts?: {
+        template_engine?: string;
+        template_engine_options?: any;
+        template_cache?: boolean | any;
+    });
+    _templates: {};
+    templateDirs: string[];
+    engine: string;
+    engineOptions: any;
+    caches: any;
+    /**
+     * Convert an AbstractNode to the backend format using the named template.
+     *
+     * Note: convert() is async because getContent() / applySubs() in the core package
+     * is async throughout. We pre-resolve content here and expose it synchronously to
+     * template engines (which are all synchronous) via a Proxy wrapper.
+     * @param {object} node - the AbstractNode to convert
+     * @param {string|null} [templateName=null] - the template name to use (default: node.nodeName)
+     * @param {object|null} [opts=null] - optional plain object passed as locals to the template
+     * @returns {Promise<string>}
+     */
+    convert(node: object, templateName?: string | null, opts?: object | null): Promise<string>;
+    /**
+     * Retrieve a shallow copy of the templates map.
+     * @returns {Object} plain object keyed by template name
+     */
+    get templates(): any;
+    /**
+     * Method alias for the templates getter — matches the core/Ruby API.
+     * @returns {Object} plain object keyed by template name
+     */
+    getTemplates(): any;
+    /**
+     * Register a template with this converter (and optionally the template cache).
+     * @param {string} name - the template name
+     * @param {{ render: Function, file: string }} template - the template object
+     * @returns {{ render: Function, file: string }} the template object
+     */
+    register(name: string, template: {
+        render: Function;
+        file: string;
+    }): {
+        render: Function;
+        file: string;
+    };
+}
+export default TemplateConverter;
+import { ConverterBase } from '../converter.js';