wikiparser-node 0.11.0-m → 0.11.0

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

@@ -4,13 +4,270 @@ export = TableToken;
  * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken, ...TrToken, ?SyntaxToken]}`
  */
 declare class TableToken extends TrToken {
+    /**
+     * @param {string} syntax 表格语法
+     * @param {string} attr 表格属性
+     * @param {import('../../../typings/token').accum} accum
+     */
+    constructor(syntax: string, attr?: string, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
+    set closed(arg: boolean);
     /** 表格是否闭合 */
     get closed(): boolean;
+    /**
+     * @override
+     * @template {TrToken|SyntaxToken} T
+     * @param {T} token 待插入的子节点
+     * @param {number} i 插入位置
+     * @returns {T}
+     * @complexity `n`
+     * @throws `SyntaxError` 表格的闭合部分非法
+     */
+    override insertAt<T extends SyntaxToken | TrToken>(token: T, i?: number): T;
     /**
      * 闭合表格语法
      * @complexity `n`
      * @param {string} syntax 表格结尾语法
+     * @throws `SyntaxError` 表格的闭合部分不符合语法
      */
     close(syntax?: string, halfParsed?: boolean): void;
+    /**
+     * @override
+     * @returns {number}
+     * @complexity `n`
+     */
+    override getRowCount(): number;
+    /** @override */
+    override getPreviousRow(): void;
+    /**
+     * @override
+     * @complexity `n`
+     */
+    override getNextRow(): TrToken;
+    /**
+     * 获取第n行
+     * @param {number} n 行号
+     * @param {boolean} force 是否将表格自身视为第一行
+     * @param {boolean} insert 是否用于判断插入新行的位置
+     * @returns {TrToken}
+     * @complexity `n`
+     * @throws `RangeError` 不存在该行
+     */
+    getNthRow(n: number, force: boolean, insert: boolean): TrToken;
+    /**
+     * 获取所有行
+     * @returns {TrToken[]}
+     * @complexity `n`
+     */
+    getAllRows(): TrToken[];
+    /**
+     * 获取指定坐标的单元格
+     * @param {TableCoords & TableRenderedCoords} coords 表格坐标
+     * @complexity `n`
+     */
+    getNthCell(coords: TableCoords & TableRenderedCoords): TdToken;
+    /**
+     * 获取表格布局
+     * @param {TableCoords & TableRenderedCoords} stop 中止条件
+     * @complexity `n`
+     */
+    getLayout(stop?: TableCoords & TableRenderedCoords): Layout;
+    /**
+     * 打印表格布局
+     * @complexity `n`
+     */
+    printLayout(): void;
+    /**
+     * 转换为渲染后的表格坐标
+     * @param {TableCoords} coord wikitext中的表格坐标
+     * @returns {TableRenderedCoords}
+     * @complexity `n`
+     */
+    toRenderedCoords({ row, column }: TableCoords): TableRenderedCoords;
+    /**
+     * 转换为wikitext中的表格坐标
+     * @param {TableRenderedCoords} coord 渲染后的表格坐标
+     * @complexity `n`
+     */
+    toRawCoords({ x, y }: TableRenderedCoords): {
+        row: number;
+        column: any;
+        start: boolean;
+    };
+    /**
+     * 获取完整行
+     * @param {number} y 行号
+     * @complexity `n²`
+     */
+    getFullRow(y: number): Map<TdToken, boolean>;
+    /**
+     * 获取完整列
+     * @param {number} x 列号
+     * @complexity `n`
+     */
+    getFullCol(x: number): Map<TdToken, boolean>;
+    /**
+     * 设置行格式
+     * @param {number} y 行号
+     * @param {string|Record<string, string|boolean>} attr 表格属性
+     * @param {boolean} multiRow 是否对所有单元格设置，或是仅对行首单元格设置
+     * @complexity `n²`
+     */
+    formatTableRow(y: number, attr?: string | Record<string, string | boolean>, multiRow?: boolean): void;
+    /**
+     * 设置列格式
+     * @param {number} x 列号
+     * @param {string|Record<string, string|boolean>} attr 表格属性
+     * @param {boolean} multiCol 是否对所有单元格设置，或是仅对行首单元格设置
+     * @complexity `n`
+     */
+    formatTableCol(x: number, attr?: string | Record<string, string | boolean>, multiCol?: boolean): void;
+    /**
+     * 填补表格行
+     * @param {number} y 行号
+     * @param {string|Token} inner 填充内容
+     * @param {'td'|'th'|'caption'} subtype 单元格类型
+     * @param {Record<string, string>} attr 表格属性
+     * @complexity `n`
+     */
+    fillTableRow(y: number, inner: string | Token, subtype?: 'td' | 'th' | 'caption', attr?: Record<string, string>): void;
+    /**
+     * 填补表格
+     * @param {string|Token} inner 填充内容
+     * @param {'td'|'th'|'caption'} subtype 单元格类型
+     * @param {Record<string, string>} attr 表格属性
+     * @complexity `n`
+     */
+    fillTable(inner: string | Token, subtype?: 'td' | 'th' | 'caption', attr?: Record<string, string>): void;
+    /**
+     * @override
+     * @param {string|Token} inner 单元格内部wikitext
+     * @param {TableCoords & TableRenderedCoords} coords 单元格坐标
+     * @param {'td'|'th'|'caption'} subtype 单元格类型
+     * @param {Record<string, string|boolean>} attr 单元格属性
+     * @returns {TdToken}
+     * @complexity `n`
+     * @throws `RangeError` 指定的坐标不是单元格起始点
+     */
+    override insertTableCell(inner: string | Token, coords: TableCoords & TableRenderedCoords, subtype?: 'td' | 'th' | 'caption', attr?: Record<string, string | boolean>): TdToken;
+    /**
+     * 插入表格行
+     * @param {number} y 行号
+     * @param {Record<string, string|boolean>} attr 表格行属性
+     * @param {string|Token} inner 内部wikitext
+     * @param {'td'|'th'|'caption'} subtype 单元格类型
+     * @param {Record<string, string|boolean>} innerAttr 单元格属性
+     * @complexity `n`
+     */
+    insertTableRow(y: number, attr?: Record<string, string | boolean>, inner?: string | Token, subtype?: 'td' | 'th' | 'caption', innerAttr?: Record<string, string | boolean>): TrToken & import("../attributes");
+    /**
+     * 插入表格列
+     * @param {number} x 列号
+     * @param {string|Token} inner 内部wikitext
+     * @param {'td'|'th'|'caption'} subtype 单元格类型
+     * @param {Record<string, string>} attr 单元格属性
+     * @complexity `n²`
+     * @throws `RangeError` 列号过大
+     */
+    insertTableCol(x: number, inner: string | Token, subtype?: 'td' | 'th' | 'caption', attr?: Record<string, string>): void;
+    /**
+     * 移除表格行
+     * @param {number} y 行号
+     * @complexity `n²`
+     */
+    removeTableRow(y: number): TrToken;
+    /**
+     * 移除表格列
+     * @param {number} x 列号
+     * @complexity `n²`
+     */
+    removeTableCol(x: number): void;
+    /**
+     * 合并单元格
+     * @param {[number, number]} xlim 列范围
+     * @param {[number, number]} ylim 行范围
+     * @complexity `n²`
+     * @throws `RangeError` 待合并区域与外侧区域有重叠
+     */
+    mergeCells(xlim: [number, number], ylim: [number, number]): TdToken;
+    /**
+     * 分裂成多行
+     * @param {TableCoords & TableRenderedCoords} coords 单元格坐标
+     * @complexity `n²`
+     */
+    splitIntoRows(coords: TableCoords & TableRenderedCoords): void;
+    /**
+     * 分裂成多列
+     * @param {TableCoords & TableRenderedCoords} coords 单元格坐标
+     * @complexity `n²`
+     */
+    splitIntoCols(coords: TableCoords & TableRenderedCoords): void;
+    /**
+     * 分裂成单元格
+     * @param {TableCoords & TableRenderedCoords} coords 单元格坐标
+     * @complexity `n²`
+     */
+    splitIntoCells(coords: TableCoords & TableRenderedCoords): void;
+    /**
+     * 复制一行并插入该行之前
+     * @param {number} row 行号
+     * @complexity `n²`
+     */
+    replicateTableRow(row: number): TrToken;
+    /**
+     * 复制一列并插入该列之前
+     * @param {number} x 列号
+     * @complexity `n`
+     */
+    replicateTableCol(x: number): TdToken[];
+    /**
+     * 移动表格行
+     * @param {number} y 行号
+     * @param {number} before 新位置
+     * @complexity `n²`
+     * @throws `RangeError` 无法移动
+     */
+    moveTableRowBefore(y: number, before: number): TrToken;
+    /**
+     * 移动表格行
+     * @param {number} y 行号
+     * @param {number} after 新位置
+     * @complexity `n²`
+     * @throws `RangeError` 无法移动
+     */
+    moveTableRowAfter(y: number, after: number): TrToken;
+    /**
+     * 移动表格列
+     * @param {number} x 列号
+     * @param {number} before 新位置
+     * @complexity `n`
+     */
+    moveTableColBefore(x: number, before: number): void;
+    /**
+     * 移动表格列
+     * @param {number} x 列号
+     * @param {number} after 新位置
+     * @complexity `n`
+     */
+    moveTableColAfter(x: number, after: number): void;
+    #private;
+}
+declare namespace TableToken {
+    export { TableCoords, TableRenderedCoords };
 }
 import TrToken = require("./tr");
+import SyntaxToken = require("../syntax");
+type TableCoords = import('../../../typings/table').TableCoords;
+type TableRenderedCoords = import('../../../typings/table').TableRenderedCoords;
+import TdToken = require("./td");
+/** @extends {Array<TableCoords[]>} */
+declare class Layout extends Array<import("../../../typings/table").TableCoords[]> {
+    constructor(arrayLength?: number);
+    constructor(arrayLength: number);
+    constructor(...items: import("../../../typings/table").TableCoords[][]);
+    /**
+     * 打印表格布局
+     * @complexity `n`
+     */
+    print(): void;
+}
+import Token = require("..");

package/dist/src/table/td.d.ts

@@ -4,36 +4,97 @@ export = TdToken;
  * @classdesc `{childNodes: [SyntaxToken, AttributesToken, Token]}`
  */
 declare class TdToken extends TrToken {
+    /**
+     * 创建新的单元格
+     * @param {string|Token} inner 内部wikitext
+     * @param {'td'|'th'|'caption'} subtype 单元格类型
+     * @param {Record<string, string>} attr 单元格属性
+     * @param {boolean} include 是否嵌入
+     * @throws `RangeError` 非法的单元格类型
+     */
+    static create(inner: string | Token, subtype?: 'td' | 'th' | 'caption', attr?: Record<string, string>, include?: boolean, config?: import("../../../typings/token").ParserConfig): TdToken;
     /**
      * @param {string} syntax 单元格语法
      * @param {string} inner 内部wikitext
      * @param {import('../../../typings/token').accum} accum
      */
     constructor(syntax: string, inner: string, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
+    set subtype(arg: "caption" | "td" | "th");
     /**
      * 单元格类型
      * @complexity `n`
      */
     get subtype(): "caption" | "td" | "th";
+    set rowspan(arg: number);
+    /** rowspan */
+    get rowspan(): number;
+    set colspan(arg: number);
+    /** colspan */
+    get colspan(): number;
+    /** 内部wikitext */
+    get innerText(): string;
+    /** 是否位于行首 */
+    isIndependent(): boolean;
     /**
      * 获取单元格语法信息
-     * @returns {{subtype: 'td'|'th'|'caption'}}
+     * @returns {{subtype: 'td'|'th'|'caption', escape: boolean, correction: boolean}}
      * @complexity `n`
      */
     getSyntax(): {
         subtype: 'td' | 'th' | 'caption';
+        escape: boolean;
+        correction: boolean;
     };
     /**
      * @override
-     * @returns {string}
-     * @complexity `n`
+     * @param {number} i 子节点位置
      */
-    override toString(selector: any): string;
+    override getGaps(i?: number): number;
+    /** @override */
+    override print(): string;
+    /** @override */
+    override cloneNode(): TdToken;
     /**
      * @override
-     * @param {number} i 子节点位置
+     * @template {string} T
+     * @param {T} key 属性键
+     * @param {TokenAttribute<T>} value 属性值
+     * @returns {this}
      */
-    override getGaps(i?: number): number;
+    override setAttribute<T extends string>(key: T, value: import("../../../typings/node").TokenAttribute<T>): this;
+    /**
+     * 改为独占一行
+     * @complexity `n`
+     */
+    independence(): void;
+    /**
+     * 获取单元格属性
+     * @template {string} T
+     * @param {T} key 属性键
+     * @returns {T extends 'rowspan'|'colspan' ? number : string|true}
+     */
+    getAttr<T_1 extends string>(key: T_1): T_1 extends "rowspan" | "colspan" ? number : string | true;
+    /**
+     * 获取全部单元格属性
+     * @returns {{rowspan: number, colspan: number, [key: string]: string|true}}
+     */
+    getAttrs(): {
+        [key: string]: string | true;
+        rowspan: number;
+        colspan: number;
+    };
+    /**
+     * 设置单元格属性
+     * @template {string} T
+     * @param {T} key 属性键
+     * @param {T extends 'rowspan'|'colspan' ? number : string|boolean} value 属性值
+     */
+    setAttr<T_2 extends string>(key: T_2, value: T_2 extends "rowspan" | "colspan" ? number : string | boolean): boolean;
     #private;
 }
+declare namespace TdToken {
+    export { TokenAttribute };
+}
 import TrToken = require("./tr");
+import Token = require("..");
+type TokenAttribute<T> = import('../../../typings/node').TokenAttribute<T>;

package/dist/src/table/tr.d.ts

@@ -13,5 +13,79 @@ declare class TrToken extends Token {
     constructor(syntax: string, attr?: string, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum, pattern?: RegExp);
     /** @override */
     override text(): string;
+    /**
+     * @override
+     * @this {TrToken & {constructor: typeof TrToken}}
+     */
+    override cloneNode(this: TrToken & {
+        constructor: typeof TrToken;
+    }): TrToken;
+    /**
+     * @override
+     * @param {string} selector
+     */
+    override toString(selector: string): string;
+    /**
+     * 转义表格语法
+     * @complexity `n`
+     */
+    escape(): void;
+    /**
+     * 设置表格语法
+     * @param {string} syntax 表格语法
+     * @param {boolean} esc 是否需要转义
+     */
+    setSyntax(syntax: string, esc: boolean): void;
+    /**
+     * @override
+     * @template {AstText|Token} T
+     * @param {T} token 待插入的子节点
+     * @param {number} i 插入位置
+     * @returns {T}
+     * @complexity `n`
+     */
+    override insertAt<T extends Token | AstText>(token: T, i?: number): T;
+    /**
+     * 获取行数
+     * @returns {0|1}
+     * @complexity `n`
+     */
+    getRowCount(): 0 | 1;
+    /**
+     * 获取下一行
+     * @complexity `n`
+     */
+    getNextRow(): Token & TrToken;
+    /**
+     * 获取前一行
+     * @complexity `n`
+     */
+    getPreviousRow(): Token & TrToken;
+    /**
+     * 获取列数
+     * @complexity `n`
+     */
+    getColCount(): number;
+    /**
+     * 获取第n列
+     * @param {number} n 列号
+     * @param {boolean} insert 是否用于判断插入新列的位置
+     * @returns {TdToken}
+     * @complexity `n`
+     * @throws `RangeError` 不存在对应单元格
+     */
+    getNthCol(n: number, insert: boolean): import("./td");
+    /**
+     * 插入新的单元格
+     * @param {string|Token} inner 单元格内部wikitext
+     * @param {import('../../../typings/table').TableCoords} coord 单元格坐标
+     * @param {'td'|'th'|'caption'} subtype 单元格类型
+     * @param {Record<string, string|boolean>} attr 单元格属性
+     * @returns {TdToken}
+     * @complexity `n`
+     */
+    insertTableCell(inner: string | Token, { column }: import('../../../typings/table').TableCoords, subtype?: 'td' | 'th' | 'caption', attr?: Record<string, string | boolean>): import("./td");
+    #private;
 }
 import Token = require("..");
+import AstText = require("../../lib/text");

package/dist/src/tagPair/ext.d.ts

@@ -12,6 +12,7 @@ declare class ExtToken extends TagPairToken {
      * @param {import('../../../typings/token').accum} accum
      */
     constructor(name: string, attr?: string, inner?: string, closed?: string | undefined, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
-    closed: boolean;
+    /** @override */
+    override cloneNode(): ExtToken;
 }
 import TagPairToken = require(".");

package/dist/src/tagPair/include.d.ts

@@ -12,5 +12,14 @@ declare class IncludeToken extends TagPairToken {
      * @param {import('../../../typings/token').accum} accum
      */
     constructor(name: string, attr?: string, inner?: string | undefined, closed?: string | undefined, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
+    /** @override */
+    override cloneNode(): IncludeToken;
+    /**
+     * @override
+     * @param {string} str 新文本
+     */
+    override setText(str: string): string;
+    /** 清除标签属性 */
+    removeAttr(): void;
 }
 import TagPairToken = require(".");

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

@@ -12,17 +12,30 @@ declare class TagPairToken extends Token {
      * @param {import('../../../typings/token').accum} accum
      */
     constructor(name: string, attr: string | Token, inner: string | Token, closed: string | undefined, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
+    set closed(arg: boolean);
     /** getter */
     get closed(): boolean;
+    set selfClosing(arg: boolean);
+    /** getter */
+    get selfClosing(): boolean;
+    /** 内部wikitext */
+    get innerText(): string;
     /**
      * @override
+     * @param {string} selector
      */
-    override toString(selector: any): string;
+    override toString(selector: string): string;
     /**
      * @override
      * @returns {string}
      */
     override text(): string;
+    /** @override */
+    override print(): string;
     #private;
 }
+declare namespace TagPairToken {
+    export { TokenAttribute };
+}
 import Token = require("..");
+type TokenAttribute<T> = import('../../../typings/node').TokenAttribute<T>;

package/dist/src/transclude.d.ts

@@ -13,6 +13,8 @@ declare class TranscludeToken extends Token {
      */
     constructor(title: string, parts: [string, string | undefined][], config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
     modifier: string;
+    /** 是否存在重复参数 */
+    get duplication(): boolean;
     /**
      * 设置引用修饰符
      * @param {string} modifier 引用修饰符
@@ -21,14 +23,17 @@ declare class TranscludeToken extends Token {
     setModifier(modifier?: string): boolean;
     /**
      * @override
+     * @param {string} selector
      */
-    override toString(selector: any): string;
+    override toString(selector: string): string;
     /**
      * @override
      * @returns {string}
      * @complexity `n`
      */
     override text(): string;
+    /** @override */
+    override print(): string;
     /** 是否是模板 */
     isTemplate(): boolean;
     /**
@@ -61,6 +66,7 @@ declare class TranscludeToken extends Token {
      * 获取重名参数
      * @complexity `n`
      * @returns {[string, ParameterToken[]][]}
+     * @throws `Error` 仅用于模板
      */
     getDuplicatedArgs(): [string, ParameterToken[]][];
     /**
@@ -69,6 +75,124 @@ declare class TranscludeToken extends Token {
      * @throws `Error` 不是可接受的魔术字
      */
     getPossibleValues(this: ParameterToken): Token[];
+    /** @override */
+    override cloneNode(): TranscludeToken;
+    /** 替换引用 */
+    subst(): void;
+    /** 安全的替换引用 */
+    safesubst(): void;
+    /**
+     * @override
+     * @param {number} i 移除位置
+     * @complexity `n`
+     */
+    override removeAt(i: number): ParameterToken;
+    /**
+     * 是否具有某参数
+     * @param {string|number} key 参数名
+     * @param {boolean} exact 是否匹配匿名性
+     * @complexity `n`
+     */
+    hasArg(key: string | number, exact: boolean): boolean;
+    /**
+     * 获取生效的指定参数
+     * @param {string|number} key 参数名
+     * @param {boolean} exact 是否匹配匿名性
+     * @complexity `n`
+     */
+    getArg(key: string | number, exact: boolean): ParameterToken;
+    /**
+     * 移除指定参数
+     * @param {string|number} key 参数名
+     * @param {boolean} exact 是否匹配匿名性
+     * @complexity `n`
+     */
+    removeArg(key: string | number, exact: boolean): void;
+    /**
+     * 获取所有参数名
+     * @complexity `n`
+     */
+    getKeys(): string[];
+    /**
+     * 获取参数值
+     * @param {string|number} key 参数名
+     * @complexity `n`
+     */
+    getValues(key: string | number): string[];
+    /**
+     * 获取生效的参数值
+     * @template {string|number|undefined} T
+     * @param {T} key 参数名
+     * @returns {T extends undefined ? Record<string, string> : string}
+     * @complexity `n`
+     */
+    getValue<T extends string | number>(key: T): T extends undefined ? Record<string, string> : string;
+    /**
+     * 插入匿名参数
+     * @param {string} val 参数值
+     * @returns {ParameterToken}
+     * @complexity `n`
+     * @throws `SyntaxError` 非法的匿名参数
+     */
+    newAnonArg(val: string): ParameterToken;
+    /**
+     * 设置参数值
+     * @param {string} key 参数名
+     * @param {string} value 参数值
+     * @complexity `n`
+     * @throws `Error` 仅用于模板
+     * @throws `SyntaxError` 非法的命名参数
+     */
+    setValue(key: string, value: string): void;
+    /**
+     * 将匿名参数改写为命名参数
+     * @complexity `n`
+     * @throws `Error` 仅用于模板
+     */
+    anonToNamed(): void;
+    /**
+     * 替换模板名
+     * @param {string} title 模板名
+     * @throws `Error` 仅用于模板
+     * @throws `SyntaxError` 非法的模板名称
+     */
+    replaceTemplate(title: string): void;
+    /**
+     * 替换模块名
+     * @param {string} title 模块名
+     * @throws `Error` 仅用于模块
+     * @throws `SyntaxError` 非法的模块名称
+     */
+    replaceModule(title: string): void;
+    /**
+     * 替换模块函数
+     * @param {string} func 模块函数名
+     * @throws `Error` 仅用于模块
+     * @throws `Error` 尚未指定模块名称
+     * @throws `SyntaxError` 非法的模块函数名
+     */
+    replaceFunction(func: string): void;
+    /**
+     * 是否存在重名参数
+     * @complexity `n`
+     * @throws `Error` 仅用于模板
+     */
+    hasDuplicatedArgs(): number;
+    /**
+     * 修复重名参数：
+     * `aggressive = false`时只移除空参数和全同参数，优先保留匿名参数，否则将所有匿名参数更改为命名。
+     * `aggressive = true`时还会尝试处理连续的以数字编号的参数。
+     * @param {boolean} aggressive 是否使用有更大风险的修复手段
+     * @complexity `n²`
+     */
+    fixDuplication(aggressive: boolean): string[];
+    /**
+     * 转义模板内的表格
+     * @returns {TranscludeToken}
+     * @complexity `n`
+     * @throws `Error` 转义失败
+     */
+    escapeTables(): TranscludeToken;
     #private;
 }
 import Token = require(".");