wikiparser-node 0.11.0-b → 0.11.0

package/dist/lib/element.d.ts

@@ -0,0 +1,162 @@
+export = AstElement;
+/** 类似HTMLElement */
+declare class AstElement extends AstNode {
+    /** @type {string} */ name: string;
+    /** 子节点总数 */
+    get length(): number;
+    /**
+     * 全部非文本子节点
+     * @complexity `n`
+     */
+    get children(): AstElement[];
+    /**
+     * 首位非文本子节点
+     * @returns {this}
+     */
+    get firstElementChild(): AstElement;
+    /**
+     * 末位非文本子节点
+     * @complexity `n`
+     */
+    get lastElementChild(): AstElement;
+    /**
+     * 非文本子节点总数
+     * @complexity `n`
+     */
+    get childElementCount(): number;
+    /** 父节点 */
+    get parentElement(): this;
+    /**
+     * AstElement.prototype.text()的getter写法
+     * @complexity `n`
+     */
+    get outerText(): string;
+    /**
+     * 不可见
+     */
+    get hidden(): boolean;
+    /**
+     * 后一个可见的兄弟节点
+     * @complexity `n`
+     */
+    get nextVisibleSibling(): this;
+    /**
+     * 前一个可见的兄弟节点
+     * @complexity `n`
+     */
+    get previousVisibleSibling(): this;
+    /** 内部高度 */
+    get clientHeight(): number;
+    /** 内部宽度 */
+    get clientWidth(): number;
+    /**
+     * 销毁
+     * @complexity `n`
+     */
+    destroy(): void;
+    /**
+     * 检查是否符合选择器
+     * @param {string|SelectorArray[]} selector
+     * @returns {boolean}
+     * @complexity `n`
+     */
+    matches(selector: string | SelectorArray[]): boolean;
+    /**
+     * 符合选择器的第一个后代节点
+     * @param {string} selector
+     * @returns {this|undefined}
+     * @complexity `n`
+     */
+    querySelector(selector: string): this | undefined;
+    /**
+     * 符合选择器的所有后代节点
+     * @param {string} selector
+     * @complexity `n`
+     */
+    querySelectorAll(selector: string): AstElement[];
+    /**
+     * id选择器
+     * @param {string} id id名
+     */
+    getElementById(id: string): AstElement;
+    /**
+     * 类选择器
+     * @param {string} className 类名之一
+     */
+    getElementsByClassName(className: string): AstElement[];
+    /**
+     * 标签名选择器
+     * @param {string} name 标签名
+     */
+    getElementsByTagName(name: string): AstElement[];
+    /**
+     * 获取某一行的wikitext
+     * @param {number} n 行号
+     */
+    getLine(n: number): string;
+    /**
+     * 在开头批量插入子节点
+     * @param {...this} elements 插入节点
+     * @complexity `n`
+     */
+    prepend(...elements: AstElement[]): void;
+    /**
+     * 最近的祖先节点
+     * @param {string} selector
+     */
+    closest(selector: string): this;
+    /**
+     * 在末尾批量插入子节点
+     * @param {...this} elements 插入节点
+     * @complexity `n`
+     */
+    append(...elements: AstElement[]): void;
+    /**
+     * 批量替换子节点
+     * @param {...this} elements 新的子节点
+     * @complexity `n`
+     */
+    replaceChildren(...elements: AstElement[]): void;
+    /**
+     * 修改文本子节点
+     * @param {string} str 新文本
+     * @param {number} i 子节点位置
+     * @throws `RangeError` 对应位置的子节点不是文本节点
+     */
+    setText(str: string, i?: number): string;
+    /**
+     * 还原为wikitext
+     * @param {string} selector
+     * @param {string} separator 子节点间的连接符
+     * @returns {string}
+     */
+    toString(selector: string, separator?: string): string;
+    /**
+     * Linter
+     * @param {number} start 起始位置
+     */
+    lint(start?: number): import("../../typings/token").LintError[];
+    /**
+     * 以HTML格式打印
+     * @param {import('../../typings/node').printOpt} opt 选项
+     * @returns {string}
+     */
+    print(opt?: import('../../typings/node').printOpt): string;
+    /**
+     * 保存为JSON
+     * @param {string} file 文件名
+     * @returns {Record<string, *>}
+     */
+    json(file: string): Record<string, any>;
+    /**
+     * 输出AST
+     * @param {number} depth 当前深度
+     */
+    echo(depth?: number): void;
+    #private;
+}
+declare namespace AstElement {
+    export { SelectorArray };
+}
+import AstNode = require("./node");
+type SelectorArray = import('../../typings/parser').SelectorArray;

package/dist/lib/node.d.ts

@@ -0,0 +1,291 @@
+export = AstNode;
+/** 类似Node */
+declare class AstNode {
+    /** @type {string} */ type: string;
+    /** @type {this[]} */ childNodes: this[];
+    /** 首位子节点 */
+    get firstChild(): this;
+    /** 末位子节点 */
+    get lastChild(): this;
+    /** 父节点 */
+    get parentNode(): this;
+    /**
+     * 后一个兄弟节点
+     * @complexity `n`
+     */
+    get nextSibling(): this;
+    /**
+     * 前一个兄弟节点
+     * @complexity `n`
+     */
+    get previousSibling(): this;
+    /**
+     * 后一个非文本兄弟节点
+     * @complexity `n`
+     * @returns {this}
+     */
+    get nextElementSibling(): this;
+    /**
+     * 前一个非文本兄弟节点
+     * @complexity `n`
+     * @returns {this}
+     */
+    get previousElementSibling(): this;
+    /** 是否具有根节点 */
+    get isConnected(): any;
+    /** 不是自身的根节点 */
+    get ownerDocument(): any;
+    /**
+     * 后方是否还有其他节点（不含后代）
+     * @returns {boolean}
+     * @complexity `n`
+     */
+    get eof(): boolean;
+    /**
+     * 标记仅用于代码调试的方法
+     * @param {string} method
+     * @throws `Error`
+     */
+    debugOnly(method?: string): void;
+    /**
+     * 抛出`TypeError`
+     * @param {string} method
+     * @param  {...string} types 可接受的参数类型
+     */
+    typeError(method: string, ...types: string[]): never;
+    /**
+     * 冻结部分属性
+     * @param {string|string[]} keys 属性键
+     * @param {boolean} permanent 是否永久
+     */
+    seal(keys: string | string[], permanent: boolean): void;
+    /**
+     * 是否是全同节点
+     * @param {this} node 待比较的节点
+     * @throws `assert.AssertionError`
+     */
+    isEqualNode(node: this): boolean;
+    /**
+     * 是否具有某属性
+     * @param {PropertyKey} key 属性键
+     */
+    hasAttribute(key: PropertyKey): boolean;
+    /**
+     * 获取属性值。除非用于私有属性，否则总是返回字符串。
+     * @template {string} T
+     * @param {T} key 属性键
+     * @returns {TokenAttribute<T>}
+     */
+    getAttribute<T extends string>(key: T): import("../../typings/node").TokenAttribute<T>;
+    /**
+     * 设置属性
+     * @template {string} T
+     * @param {T} key 属性键
+     * @param {TokenAttribute<T>} value 属性值
+     */
+    setAttribute<T_1 extends string>(key: T_1, value: import("../../typings/node").TokenAttribute<T_1>): this;
+    /**
+     * 可见部分
+     * @param {string} separator 子节点间的连接符
+     * @returns {string}
+     * @complexity `n`
+     */
+    text(separator?: string): string;
+    /**
+     * 移除子节点
+     * @param {number} i 移除位置
+     */
+    removeAt(i: number): this;
+    /**
+     * 插入子节点
+     * @template {this} T
+     * @param {T} node 待插入的子节点
+     * @param {number} i 插入位置
+     * @complexity `n`
+     * @throws `RangeError` 不能插入祖先节点
+     */
+    insertAt<T_2 extends AstNode>(node: T_2, i?: number): T_2;
+    /**
+     * 移除子节点
+     * @template {this} T
+     * @param {T} node 子节点
+     * @complexity `n`
+     */
+    removeChild<T_3 extends AstNode>(node: T_3): T_3;
+    /**
+     * 在末尾插入子节点
+     * @template {this} T
+     * @param {T} node 插入节点
+     * @complexity `n`
+     */
+    appendChild<T_4 extends AstNode>(node: T_4): T_4;
+    /**
+     * 在指定位置前插入子节点
+     * @template {this} T
+     * @param {T} child 插入节点
+     * @param {this} reference 指定位置处的子节点
+     * @complexity `n`
+     */
+    insertBefore<T_5 extends AstNode>(child: T_5, reference: AstNode): T_5;
+    /**
+     * 替换子节点
+     * @template {this} T
+     * @param {this} newChild 新子节点
+     * @param {T} oldChild 原子节点
+     * @complexity `n`
+     */
+    replaceChild<T_6 extends AstNode>(newChild: AstNode, oldChild: T_6): T_6;
+    /**
+     * 在后方批量插入兄弟节点
+     * @param {...this} nodes 插入节点
+     * @complexity `n`
+     */
+    after(...nodes: AstNode[]): void;
+    /**
+     * 在前方批量插入兄弟节点
+     * @param {...this} nodes 插入节点
+     * @complexity `n`
+     */
+    before(...nodes: AstNode[]): void;
+    /**
+     * 移除当前节点
+     * @complexity `n`
+     * @throws `Error` 不存在父节点
+     */
+    remove(): void;
+    /**
+     * 将当前节点批量替换为新的节点
+     * @param {...this} nodes 插入节点
+     * @complexity `n`
+     */
+    replaceWith(...nodes: AstNode[]): void;
+    /**
+     * 是自身或后代节点
+     * @param {this} node 待检测节点
+     * @returns {boolean}
+     * @complexity `n`
+     */
+    contains(node: AstNode): boolean;
+    /**
+     * 添加事件监听
+     * @param {string|string[]} types 事件类型
+     * @param {AstListener} listener 监听函数
+     * @param {{once: boolean}} options 选项
+     */
+    addEventListener(types: string | string[], listener: AstListener, options: {
+        once: boolean;
+    }): void;
+    /**
+     * 移除事件监听
+     * @param {string|string[]} types 事件类型
+     * @param {AstListener} listener 监听函数
+     */
+    removeEventListener(types: string | string[], listener: AstListener): void;
+    /**
+     * 移除事件的所有监听
+     * @param {string|string[]} types 事件类型
+     */
+    removeAllEventListeners(types: string | string[]): void;
+    /**
+     * 列举事件监听
+     * @param {string} type 事件类型
+     * @returns {AstListener[]}
+     */
+    listEventListeners(type: string): AstListener[];
+    /**
+     * 触发事件
+     * @param {import('../../typings/event').AstEvent} e 事件对象
+     * @param {*} data 事件数据
+     */
+    dispatchEvent(e: import('../../typings/event').AstEvent, data: any): void;
+    /** 获取所有祖先节点 */
+    getAncestors(): AstNode[];
+    /**
+     * 比较和另一个节点的相对位置
+     * @param {this} other 待比较的节点
+     * @complexity `n`
+     * @throws `Error` 不在同一个语法树
+     */
+    compareDocumentPosition(other: AstNode): number;
+    /**
+     * 合并相邻的文本子节点
+     * @complexity `n`
+     */
+    normalize(): void;
+    /** 获取根节点 */
+    getRootNode(): any;
+    /**
+     * 将字符位置转换为行列号
+     * @param {number} index 字符位置
+     * @complexity `n`
+     */
+    posFromIndex(index: number): {
+        top: number;
+        left: number;
+    };
+    /**
+     * 将行列号转换为字符位置
+     * @param {number} top 行号
+     * @param {number} left 列号
+     * @complexity `n`
+     */
+    indexFromPos(top: number, left: number): number;
+    /** 第一个子节点前的间距 */
+    getPadding(): number;
+    /** 子节点间距 */
+    getGaps(): number;
+    /**
+     * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
+     * @param {number|undefined} j 子节点序号
+     * @complexity `n`
+     */
+    getRelativeIndex(j: number | undefined): number;
+    /**
+     * 获取当前节点的绝对位置
+     * @returns {number}
+     * @complexity `n`
+     */
+    getAbsoluteIndex(): number;
+    /**
+     * 获取当前节点的行列位置和大小
+     * @complexity `n`
+     */
+    getBoundingClientRect(): any;
+    /**
+     * 行数
+     * @complexity `n`
+     */
+    get offsetHeight(): number;
+    /**
+     * 最后一行的列数
+     * @complexity `n`
+     */
+    get offsetWidth(): number;
+    /**
+     * 相对于父容器的行号
+     * @complexity `n`
+     */
+    get offsetTop(): number;
+    /**
+     * 相对于父容器的列号
+     * @complexity `n`
+     */
+    get offsetLeft(): number;
+    /**
+     * 位置、大小和padding
+     * @complexity `n`
+     */
+    get style(): {
+        padding: number;
+        height: number;
+        width: number;
+        top: number;
+        left: number;
+    };
+    #private;
+}
+declare namespace AstNode {
+    export { TokenAttribute, AstListener };
+}
+type AstListener = import('../../typings/event').AstListener;
+type TokenAttribute<T> = import('../../typings/node').TokenAttribute<T>;

package/dist/lib/ranges.d.ts

@@ -0,0 +1,37 @@
+export = Ranges;
+/** @extends {Array<number|Range>} */
+declare class Ranges extends Array<number | Range> {
+    /**
+     * 检查某个下标是否符合表达式
+     * @param {string} str 表达式
+     * @param {number} i 待检查的下标
+     */
+    static nth(str: string, i: number): boolean;
+    /** @param {number|string|Range|(number|string|Range)[]} arr 表达式数组 */
+    constructor(arr: number | string | Range | (number | string | Range)[]);
+    /**
+     * 将Ranges转换为针对特定Array的下标集
+     * @param {number|*[]} arr 参考数组
+     * @complexity `n`
+     */
+    applyTo(arr: number | any[]): number[];
+}
+/** 模拟Python的Range对象。除`step`至少为`1`外，允许负数、小数或`end < start`的情形。 */
+declare class Range {
+    /**
+     * @param {string|Range} str 表达式
+     * @throws `RangeError` 起点、终点和步长均应为整数
+     * @throws `RangeError` n的系数不能为0
+     * @throws `RangeError` 应使用CSS选择器或Python切片的格式
+     */
+    constructor(str: string | Range);
+    start: number;
+    end: number;
+    step: number;
+    /**
+     * 将Range转换为针对特定数组的下标集
+     * @param {number|*[]} arr 参考数组
+     * @complexity `n`
+     */
+    applyTo(arr: number | any[]): number[];
+}

package/dist/lib/text.d.ts

@@ -0,0 +1,64 @@
+export = AstText;
+/** 文本节点 */
+declare class AstText extends AstNode {
+    /** @param {string} text 包含文本 */
+    constructor(text?: string);
+    /** @type {string} */ data: string;
+    /** 文本长度 */
+    get length(): number;
+    /** @override */
+    override text(): string;
+    /**
+     * Linter
+     * @this {AstText & {parentNode: AstElement}}
+     * @param {number} start 起始位置
+     * @returns {LintError[]}
+     */
+    lint(this: AstText & {
+        parentNode: AstElement;
+    }, start?: number): LintError[];
+    /**
+     * 替换字符串
+     * @param {string} text 替换的字符串
+     */
+    replaceData(text?: string): void;
+    /** 复制 */
+    cloneNode(): AstText;
+    /**
+     * 在后方添加字符串
+     * @param {string} text 添加的字符串
+     */
+    appendData(text: string): void;
+    /**
+     * 删减字符串
+     * @param {number} offset 起始位置
+     * @param {number} count 删减字符数
+     */
+    deleteData(offset: number, count: number): void;
+    /**
+     * 插入字符串
+     * @param {number} offset 插入位置
+     * @param {string} text 待插入的字符串
+     */
+    insertData(offset: number, text: string): void;
+    /**
+     * 提取子串
+     * @param {number} offset 起始位置
+     * @param {number} count 字符数
+     */
+    substringData(offset: number, count: number): string;
+    /**
+     * 将文本子节点分裂为两部分
+     * @param {number} offset 分裂位置
+     * @throws `RangeError` 错误的断开位置
+     * @throws `Error` 没有父节点
+     */
+    splitText(offset: number): AstText;
+    #private;
+}
+declare namespace AstText {
+    export { LintError };
+}
+import AstNode = require("./node");
+import AstElement = require("./element");
+type LintError = import('../../typings/token').LintError;

package/dist/lib/title.d.ts

@@ -0,0 +1,21 @@
+export = Title;
+/** MediaWiki页面标题对象 */
+declare class Title {
+    /**
+     * @param {string} title 标题（含或不含命名空间前缀）
+     * @param {number} defaultNs 命名空间
+     * @param {boolean} decode 是否需要解码
+     * @param {boolean} selfLink 是否允许selfLink
+     */
+    constructor(title: string, defaultNs?: number, config?: import("../../typings/token").ParserConfig, decode?: boolean, selfLink?: boolean);
+    valid: boolean;
+    ns: number;
+    fragment: string;
+    encoded: boolean;
+    title: string;
+    main: string;
+    prefix: string;
+    interwiki: string;
+    /** @override */
+    override toString(): string;
+}

package/dist/mixin/attributeParent.d.ts

@@ -0,0 +1,9 @@
+export = attributeParent;
+/**
+ * 子节点含有AttributesToken的类
+ * @template T
+ * @param {T} Constructor 基类
+ * @param {number} i AttributesToken子节点的位置
+ * @returns {T}
+ */
+declare function attributeParent<T>(Constructor: T, i?: number): T;

package/dist/mixin/fixedToken.d.ts

@@ -0,0 +1,8 @@
+export = fixedToken;
+/**
+ * 不可增删子节点的类
+ * @template T
+ * @param {T} Constructor 基类
+ * @returns {T}
+ */
+declare function fixedToken<T>(Constructor: T): T;

package/dist/mixin/hidden.d.ts

@@ -0,0 +1,8 @@
+export = hidden;
+/**
+ * 解析后不可见的类
+ * @template T
+ * @param {T} Constructor 基类
+ * @returns {T}
+ */
+declare function hidden<T>(Constructor: T): T;

package/dist/mixin/singleLine.d.ts

@@ -0,0 +1,8 @@
+export = singleLine;
+/**
+ * 不可包含换行符的类
+ * @template {Function} T
+ * @param {T} Constructor 基类
+ * @returns {T}
+ */
+declare function singleLine<T extends Function>(Constructor: T): T;

package/dist/mixin/sol.d.ts

@@ -0,0 +1,8 @@
+export = sol;
+/**
+ * 只能位于行首的类
+ * @template T
+ * @param {T} Constructor 基类
+ * @returns {T}
+ */
+declare function sol<T>(Constructor: T): T;

package/dist/parser/brackets.d.ts

@@ -0,0 +1,12 @@
+export = parseBrackets;
+/**
+ * 解析花括号
+ * @param {string} text wikitext
+ * @param {import('../../typings/token').accum} accum
+ * @throws TranscludeToken.constructor()
+ */
+declare function parseBrackets(text: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;
+declare namespace parseBrackets {
+    export { BracketExecArray };
+}
+type BracketExecArray = import('../../typings/parser').BracketExecArray;

package/dist/parser/commentAndExt.d.ts

@@ -0,0 +1,8 @@
+export = parseCommentAndExt;
+/**
+ * 解析HTML注释和扩展标签
+ * @param {string} text wikitext
+ * @param {import('../../typings/token').accum} accum
+ * @param {boolean} includeOnly 是否嵌入
+ */
+declare function parseCommentAndExt(text: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum, includeOnly?: boolean): string;

package/dist/parser/converter.d.ts

@@ -0,0 +1,7 @@
+export = parseConverter;
+/**
+ * 解析语言变体转换
+ * @param {string} wikitext wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseConverter(wikitext: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;

package/dist/parser/externalLinks.d.ts

@@ -0,0 +1,7 @@
+export = parseExternalLinks;
+/**
+ * 解析外部链接
+ * @param {string} wikitext wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseExternalLinks(wikitext: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;

package/dist/parser/hrAndDoubleUnderscore.d.ts

@@ -0,0 +1,11 @@
+export = parseHrAndDoubleUnderscore;
+/**
+ * 解析\<hr\>和状态开关
+ * @param {Token & {firstChild: AstText}} root 根节点
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseHrAndDoubleUnderscore({ firstChild: { data }, type, name }: Token & {
+    firstChild: AstText;
+}, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;
+import Token = require("../src");
+import AstText = require("../lib/text");

package/dist/parser/html.d.ts

@@ -0,0 +1,7 @@
+export = parseHtml;
+/**
+ * 解析HTML标签
+ * @param {string} wikitext wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseHtml(wikitext: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;

package/dist/parser/links.d.ts

@@ -0,0 +1,7 @@
+export = parseLinks;
+/**
+ * 解析内部链接
+ * @param {string} wikitext wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseLinks(wikitext: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;