wikiparser-node 0.11.0-b → 0.11.0

package/dist/src/gallery.d.ts

@@ -0,0 +1,33 @@
+export = GalleryToken;
+/**
+ * gallery标签
+ * @classdesc `{childNodes: ...(GalleryImageToken|HiddenToken|AstText)}`
+ */
+declare class GalleryToken extends Token {
+    /**
+     * @param {string} inner 标签内部wikitext
+     * @param {import('../../typings/token').accum} accum
+     */
+    constructor(inner: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    /** 所有图片 */
+    get images(): this[];
+    /**
+     * @override
+     * @param {string} selector
+     */
+    override toString(selector: string): string;
+    /** @override */
+    override text(): string;
+    /** @override */
+    override print(): string;
+    /** @override */
+    override cloneNode(): GalleryToken;
+    /**
+     * 插入图片
+     * @param {string} file 图片文件名
+     * @param {number} i 插入位置
+     * @throws `SyntaxError` 非法的文件名
+     */
+    insertImage(file: string, i?: number): Token;
+}
+import Token = require(".");

package/dist/src/hasNowiki/index.d.ts

@@ -0,0 +1,14 @@
+export = HasNowikiToken;
+/**
+ * `<pre>`
+ * @classdesc `{childNodes: [...AstText|NoincludeToken]}`
+ */
+declare class HasNowikiToken extends Token {
+    /**
+     * @param {string} wikitext wikitext
+     * @param {string} type type
+     * @param {import('../../../typings/token').accum} accum
+     */
+    constructor(wikitext: string, type: string, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
+}
+import Token = require("..");

package/dist/src/hasNowiki/pre.d.ts

@@ -0,0 +1,13 @@
+export = PreToken;
+/**
+ * `<pre>`
+ * @classdesc `{childNodes: [...AstText|NoincludeToken|ConverterToken]}`
+ */
+declare class PreToken extends HasNowikiToken {
+    /**
+     * @param {string} wikitext wikitext
+     * @param {import('../../../typings/token').accum} accum
+     */
+    constructor(wikitext: string, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
+}
+import HasNowikiToken = require(".");

package/dist/src/heading.d.ts

@@ -0,0 +1,44 @@
+export = HeadingToken;
+/**
+ * 章节标题
+ * @classdesc `{childNodes: [Token, SyntaxToken]}`
+ */
+declare class HeadingToken extends Token {
+    /**
+     * @param {number} level 标题层级
+     * @param {string[]} input 标题文字
+     * @param {import('../../typings/token').accum} accum
+     */
+    constructor(level: number, input: string[], config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    /** 内部wikitext */
+    get innerText(): string;
+    /**
+     * @override
+     * @this {{prependNewLine(): ''|'\n'} & HeadingToken}
+     * @param {string} selector
+     * @returns {string}
+     */
+    override toString(this: {
+        prependNewLine(): '' | '\n';
+    } & HeadingToken, selector: string): string;
+    /**
+     * @override
+     * @this {HeadingToken & {prependNewLine(): ''|'\n'}}
+     * @returns {string}
+     */
+    override text(this: HeadingToken & {
+        prependNewLine(): '' | '\n';
+    }): string;
+    /** @override */
+    override print(): string;
+    /** @override */
+    override cloneNode(): HeadingToken;
+    /**
+     * 设置标题层级
+     * @param {number} n 标题层级
+     */
+    setLevel(n: number): void;
+    /** 移除标题后的不可见内容 */
+    removeTrail(): void;
+}
+import Token = require(".");

package/dist/src/html.d.ts

@@ -0,0 +1,56 @@
+export = HtmlToken;
+/**
+ * HTML标签
+ * @classdesc `{childNodes: [AttributesToken]}`
+ */
+declare class HtmlToken extends Token {
+    /**
+     * @param {string} name 标签名
+     * @param {AttributesToken} attr 标签属性
+     * @param {boolean} closing 是否闭合
+     * @param {boolean} selfClosing 是否自封闭
+     * @param {import('../../typings/token').accum} accum
+     */
+    constructor(name: string, attr: AttributesToken, closing: boolean, selfClosing: boolean, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    /** @throws `Error` 自闭合标签或空标签 */
+    set closing(arg: boolean);
+    /** getter */
+    get closing(): boolean;
+    /** @throws `Error` 闭合标签或无效自闭合标签 */
+    set selfClosing(arg: boolean);
+    /** getter */
+    get selfClosing(): boolean;
+    /**
+     * @override
+     * @param {string} selector
+     */
+    override toString(selector: string): string;
+    /** @override */
+    override text(): string;
+    /** @override */
+    override print(): string;
+    /**
+     * 搜索匹配的标签
+     * @complexity `n`
+     * @throws `SyntaxError` 同时闭合和自封闭的标签
+     * @throws `SyntaxError` 无效自封闭标签
+     * @throws `SyntaxError` 未闭合的标签
+     */
+    findMatchingTag(): this | HtmlToken;
+    /** @override */
+    override cloneNode(): HtmlToken;
+    /**
+     * 更换标签名
+     * @param {string} tag 标签名
+     * @throws `RangeError` 非法的HTML标签
+     */
+    replaceTag(tag: string): void;
+    /**
+     * 修复无效自封闭标签
+     * @complexity `n`
+     * @throws `Error` 无法修复无效自封闭标签
+     */
+    fix(): void;
+    #private;
+}
+import Token = require(".");

package/dist/src/imageParameter.d.ts

@@ -0,0 +1,65 @@
+export = ImageParameterToken;
+/**
+ * 图片参数
+ * @classdesc `{childNodes: ...(AstText|Token)}`
+ */
+declare class ImageParameterToken extends Token {
+    /**
+     * @param {string} str 图片参数
+     * @param {import('../../typings/token').accum} accum
+     */
+    constructor(str: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    set link(arg: string | Title);
+    /** 图片链接 */
+    get link(): string | Title;
+    set value(arg: string | true);
+    /** getValue()的getter */
+    get value(): string | true;
+    /** 图片大小 */
+    get size(): {
+        width: string;
+        height: string;
+    };
+    set width(arg: string);
+    /** 图片宽度 */
+    get width(): string;
+    set height(arg: string);
+    /** 图片高度 */
+    get height(): string;
+    /**
+     * @override
+     * @param {string} selector
+     */
+    override toString(selector: string): string;
+    /** @override */
+    override text(): string;
+    /** @override */
+    override print(): string;
+    /** @override */
+    override cloneNode(): ImageParameterToken;
+    /**
+     * @override
+     * @template {Token} T
+     * @param {T} token 待插入的子节点
+     * @param {number} i 插入位置
+     * @complexity `n`
+     * @throws `Error` 不接受自定义输入的图片参数
+     */
+    override insertAt<T extends Token>(token: T, i?: number): T extends Token ? Token : AstText;
+    /**
+     * 获取参数值
+     * @complexity `n`
+     */
+    getValue(): string | true;
+    /**
+     * 设置参数值
+     * @param {string|boolean} value 参数值
+     * @complexity `n`
+     * @throws	SyntaxError` 非法的参数值
+     */
+    setValue(value: string | boolean): void;
+    #private;
+}
+import Token = require(".");
+import Title = require("../lib/title");
+import AstText = require("../lib/text");

package/dist/src/imagemap.d.ts

@@ -0,0 +1,37 @@
+export = ImagemapToken;
+/**
+ * `<imagemap>`
+ * @classdesc `{childNodes: ...NoincludeToken, GalleryImageToken, ...(NoincludeToken|ImagemapLinkToken|AstText)}`
+ */
+declare class ImagemapToken extends Token {
+    /**
+     * @param {string} inner 标签内部wikitext
+     * @param {import('../../typings/token').accum} accum
+     * @throws `SyntaxError` 没有合法图片
+     */
+    constructor(inner: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    /**
+     * 图片
+     * @returns {GalleryImageToken}
+     */
+    get image(): GalleryImageToken;
+    /**
+     * 链接
+     * @returns {ImagemapLinkToken[]}
+     */
+    get links(): ImagemapLinkToken[];
+    /**
+     * @override
+     * @param {string} selector
+     */
+    override toString(selector: string): string;
+    /** @override */
+    override text(): string;
+    /** @override */
+    override print(): string;
+    /** @override */
+    override cloneNode(): ImagemapToken;
+}
+import Token = require(".");
+import GalleryImageToken = require("./link/galleryImage");
+import ImagemapLinkToken = require("./imagemapLink");

package/dist/src/imagemapLink.d.ts

@@ -0,0 +1,21 @@
+export = ImagemapLinkToken;
+/**
+ * `<imagemap>`内的链接
+ * @classdesc `{childNodes: [AstText, LinkToken|ExtLinkToken, NoincludeToken]}`
+ */
+declare class ImagemapLinkToken extends Token {
+    /**
+     * @param {string} pre 链接前的文本
+     * @param {[string, string, string|Title]} linkStuff 内外链接
+     * @param {string} post 链接后的文本
+     * @param {import('../../typings/token').accum} accum
+     */
+    constructor(pre: string, linkStuff: [string, string, string | Title], post: string, config: any, accum: import('../../typings/token').accum);
+    /**
+     * 内外链接
+     * @this {{childNodes: (LinkToken|ExtLinkToken)[]}}
+     */
+    get link(): string | Title;
+}
+import Token = require(".");
+import Title = require("../lib/title");

package/dist/src/index.d.ts

@@ -0,0 +1,186 @@
+export = Token;
+/**
+ * 所有节点的基类
+ * @classdesc `{childNodes: ...(AstText|Token)}`
+ */
+declare class Token extends AstElement {
+    /**
+     * @param {string} wikitext wikitext
+     * @param {import('../../typings/token').accum} accum
+     * @param {acceptable} acceptable 可接受的子节点设置
+     */
+    constructor(wikitext: string, config?: import("../../typings/token").ParserConfig, halfParsed?: boolean, accum?: import('../../typings/token').accum, acceptable?: acceptable);
+    /** 所有图片，包括图库 */
+    get images(): Token[];
+    /** 所有内链、外链和自由外链 */
+    get links(): Token[];
+    /** 所有模板和模块 */
+    get embeds(): Token[];
+    /**
+     * @override
+     * @template {string} T
+     * @param {T} key 属性键
+     * @param {TokenAttribute<T>} value 属性值
+     */
+    override setAttribute<T extends string>(key: T, value: import("../../typings/node").TokenAttribute<T>): Token | this;
+    /** 是否是普通节点 */
+    isPlain(): boolean;
+    /**
+     * @override
+     * @template {string|Token} T
+     * @param {T} token 待插入的子节点
+     * @param {number} i 插入位置
+     * @complexity `n`
+     * @returns {T extends Token ? Token : AstText}
+     * @throws `RangeError` 不可插入的子节点
+     */
+    override insertAt<T_1 extends string | Token>(token: T_1, i?: number): T_1 extends Token ? Token : AstText;
+    /**
+     * 规范化页面标题
+     * @param {string} title 标题（含或不含命名空间前缀）
+     * @param {number} defaultNs 命名空间
+     * @param {boolean} decode 是否需要解码
+     * @param {boolean} selfLink 是否允许selfLink
+     */
+    normalizeTitle(title: string, defaultNs?: number, halfParsed?: boolean, decode?: boolean, selfLink?: boolean): import("../lib/title");
+    /**
+     * @override
+     * @param {number} i 移除位置
+     * @returns {Token}
+     * @complexity `n`
+     * @throws `Error` 不可移除的子节点
+     */
+    override removeAt(i: number): Token;
+    /**
+     * 替换为同类节点
+     * @param {Token} token 待替换的节点
+     * @complexity `n`
+     * @throws `Error` 不存在父节点
+     * @throws `Error` 待替换的节点具有不同属性
+     */
+    safeReplaceWith(token: Token): void;
+    /**
+     * 创建HTML注释
+     * @param {string} data 注释内容
+     */
+    createComment(data?: string): import("./nowiki/comment");
+    /**
+     * 创建标签
+     * @param {string} tagName 标签名
+     * @param {{selfClosing: boolean, closing: boolean}} options 选项
+     * @throws `RangeError` 非法的标签名
+     */
+    createElement(tagName: string, { selfClosing, closing }?: {
+        selfClosing: boolean;
+        closing: boolean;
+    }): any;
+    /**
+     * 创建纯文本节点
+     * @param {string} data 文本内容
+     */
+    createTextNode(data?: string): AstText;
+    /**
+     * 找到给定位置所在的节点
+     * @param {number} index 位置
+     */
+    caretPositionFromIndex(index: number): {
+        offsetNode: Token;
+        offset: number;
+    };
+    /**
+     * 找到给定位置所在的节点
+     * @param {number} x 列数
+     * @param {number} y 行数
+     */
+    caretPositionFromPoint(x: number, y: number): {
+        offsetNode: Token;
+        offset: number;
+    };
+    /**
+     * 找到给定位置所在的最外层节点
+     * @param {number} index 位置
+     * @throws `Error` 不是根节点
+     */
+    elementFromIndex(index: number): this;
+    /**
+     * 找到给定位置所在的最外层节点
+     * @param {number} x 列数
+     * @param {number} y 行数
+     */
+    elementFromPoint(x: number, y: number): this;
+    /**
+     * 找到给定位置所在的所有节点
+     * @param {number} index 位置
+     */
+    elementsFromIndex(index: number): Token[];
+    /**
+     * 找到给定位置所在的所有节点
+     * @param {number} x 列数
+     * @param {number} y 行数
+     */
+    elementsFromPoint(x: number, y: number): Token[];
+    /**
+     * 判断标题是否是跨维基链接
+     * @param {string} title 标题
+     */
+    isInterwiki(title: string): RegExpMatchArray;
+    /**
+     * 深拷贝所有子节点
+     * @complexity `n`
+     * @returns {(AstText|Token)[]}
+     */
+    cloneChildNodes(): (AstText | Token)[];
+    /**
+     * 深拷贝节点
+     * @complexity `n`
+     * @throws `Error` 未定义复制方法
+     */
+    cloneNode(): Token;
+    /**
+     * 获取全部章节
+     * @complexity `n`
+     */
+    sections(): (Token | AstText)[][];
+    /**
+     * 获取指定章节
+     * @param {number} n 章节序号
+     * @complexity `n`
+     */
+    section(n: number): (Token | AstText)[];
+    /**
+     * 获取指定的外层HTML标签
+     * @param {string|undefined} tag HTML标签名
+     * @returns {[Token, Token]}
+     * @complexity `n`
+     * @throws `RangeError` 非法的标签或空标签
+     */
+    findEnclosingHtml(tag: string | undefined): [Token, Token];
+    /**
+     * 获取全部分类
+     * @complexity `n`
+     */
+    getCategories(): any[][];
+    /**
+     * 重新解析单引号
+     * @throws `Error` 不接受QuoteToken作为子节点
+     */
+    redoQuotes(): void;
+    /** 解析部分魔术字 */
+    solveConst(): void;
+    /** 生成部分Token的`name`属性 */
+    afterBuild(): void;
+    /**
+     * 解析、重构、生成部分Token的`name`属性
+     * @param {number} n 最大解析层级
+     * @param {boolean} include 是否嵌入
+     */
+    parse(n?: number, include?: boolean): Token;
+    #private;
+}
+declare namespace Token {
+    export { acceptable, TokenAttribute };
+}
+import AstElement = require("../lib/element");
+import AstText = require("../lib/text");
+type acceptable = import('../../typings/token').acceptable;
+type TokenAttribute<T> = import('../../typings/node').TokenAttribute<T>;

package/dist/src/link/category.d.ts

@@ -0,0 +1,16 @@
+export = CategoryToken;
+/**
+ * 分类
+ * @classdesc `{childNodes: [AtomToken, ?Token]}`
+ */
+declare class CategoryToken extends LinkToken {
+    set sortkey(arg: string);
+    /** 分类排序关键字 */
+    get sortkey(): string;
+    /**
+     * 设置排序关键字
+     * @param {string} text 排序关键字
+     */
+    setSortkey(text: string): void;
+}
+import LinkToken = require(".");

package/dist/src/link/file.d.ts

@@ -0,0 +1,85 @@
+export = FileToken;
+/**
+ * 图片
+ * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
+ */
+declare class FileToken extends LinkToken {
+    set link(arg: string | import("../../lib/title"));
+    /** 图片链接 */
+    get link(): string | import("../../lib/title");
+    /** 图片大小 */
+    get size(): {
+        width: string;
+        height: string;
+    };
+    set width(arg: string);
+    /** 图片宽度 */
+    get width(): string;
+    set height(arg: string);
+    /** 图片高度 */
+    get height(): string;
+    /**
+     * 获取所有图片参数节点
+     * @returns {ImageParameterToken[]}
+     */
+    getAllArgs(): ImageParameterToken[];
+    /**
+     * 获取指定图片参数
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    getArgs(key: string): ImageParameterToken[];
+    /** 获取图片框架属性参数节点 */
+    getFrameArgs(): ImageParameterToken[];
+    /** 获取图片水平对齐参数节点 */
+    getHorizAlignArgs(): ImageParameterToken[];
+    /** 获取图片垂直对齐参数节点 */
+    getVertAlignArgs(): ImageParameterToken[];
+    /**
+     * 获取生效的指定图片参数
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    getArg(key: string): ImageParameterToken;
+    /**
+     * 是否具有指定图片参数
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    hasArg(key: string): boolean;
+    /**
+     * 移除指定图片参数
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    removeArg(key: string): void;
+    /**
+     * 获取图片参数名
+     * @complexity `n`
+     */
+    getKeys(): string[];
+    /**
+     * 获取指定的图片参数值
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    getValues(key: string): (string | true)[];
+    /**
+     * 获取生效的指定图片参数值
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    getValue(key: string): string | true;
+    /**
+     * 设置图片参数
+     * @param {string} key 参数名
+     * @param {string|boolean} value 参数值
+     * @complexity `n`
+     * @throws `RangeError` 未定义的图片参数
+     * @throws `SyntaxError` 非法的参数
+     */
+    setValue(key: string, value: string | boolean): void;
+    #private;
+}
+import LinkToken = require(".");
+import ImageParameterToken = require("../imageParameter");

package/dist/src/link/galleryImage.d.ts

@@ -0,0 +1,15 @@
+export = GalleryImageToken;
+/**
+ * 图片
+ * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
+ */
+declare class GalleryImageToken extends FileToken {
+    /**
+     * @param {string} link 图片文件名
+     * @param {string|undefined} text 图片参数
+     * @param {import('../../../typings/token').accum} accum
+     */
+    constructor(link: string, text: string | undefined, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
+    #private;
+}
+import FileToken = require("./file");

package/dist/src/link/index.d.ts

@@ -0,0 +1,88 @@
+export = LinkToken;
+/**
+ * 内链
+ * @classdesc `{childNodes: [AtomToken, ?Token]}`
+ */
+declare class LinkToken extends Token {
+    /**
+     * @param {string} link 链接标题
+     * @param {string|undefined} linkText 链接显示文字
+     * @param {import('../../../typings/token').accum} accum
+     * @param {string} delimiter `|`
+     */
+    constructor(link: string, linkText: string | undefined, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum, delimiter?: string);
+    set link(arg: import("../../lib/title"));
+    /** 完整链接，和FileToken保持一致 */
+    get link(): import("../../lib/title");
+    set selfLink(arg: boolean);
+    /** 是否链接到自身 */
+    get selfLink(): boolean;
+    set fragment(arg: string);
+    /** fragment */
+    get fragment(): string;
+    set interwiki(arg: string);
+    /** interwiki */
+    get interwiki(): string;
+    /** 链接显示文字 */
+    get innerText(): string;
+    /**
+     * @override
+     * @template {string} T
+     * @param {T} key 属性键
+     * @param {import('../../../typings/node').TokenAttribute<T>} value 属性值
+     */
+    override setAttribute<T extends string>(key: T, value: import("../../../typings/node").TokenAttribute<T>): this | LinkToken;
+    /**
+     * @override
+     * @param {string} selector
+     */
+    override toString(selector: string): string;
+    /** @override */
+    override text(): string;
+    /** @override */
+    override print(): string;
+    /**
+     * @override
+     * @this {LinkToken & {constructor: typeof LinkToken}}
+     */
+    override cloneNode(this: LinkToken & {
+        constructor: typeof LinkToken;
+    }): LinkToken;
+    /**
+     * 设置链接目标
+     * @param {string} link 链接目标
+     * @throws `SyntaxError` 非法的链接目标
+     */
+    setTarget(link: string): void;
+    /**
+     * 设置跨语言链接
+     * @param {string} lang 语言前缀
+     * @param {string} link 页面标题
+     * @throws `SyntaxError` 非法的跨语言链接
+     */
+    setLangLink(lang: string, link: string): void;
+    /**
+     * 设置fragment
+     * @param {string} fragment fragment
+     */
+    setFragment(fragment: string): void;
+    /**
+     * 修改为到自身的链接
+     * @param {string} fragment fragment
+     * @throws `RangeError` 空fragment
+     */
+    asSelfLink(fragment?: string): void;
+    /**
+     * 设置链接显示文字
+     * @param {string} linkText 链接显示文字
+     * @throws `SyntaxError` 非法的链接显示文字
+     */
+    setLinkText(linkText?: string): void;
+    /**
+     * 自动生成管道符后的链接文字
+     * @throws `Error` 带有"#"或"%"时不可用
+     */
+    pipeTrick(): void;
+    #private;
+}
+import Token = require("..");