wikiparser-node 1.16.4 → 1.16.5

package/dist/src/table/index.js

@@ -27,7 +27,11 @@ exports.isRowEnd = isRowEnd;
 /** @extends {Array<TableCoords[]>} */
 class Layout extends Array {
     /* NOT FOR BROWSER */
-    /** 打印表格布局 */
+    /**
+     * Print the table layout
+     *
+     * 打印表格布局
+     */
     print() {
         const hBorders = emptyArray(this.length + 1, i => {
             const prev = this[i - 1] ?? [], next = this[i] ?? [];
@@ -50,15 +54,17 @@ class Layout extends Array {
 }
 exports.Layout = Layout;
 /**
+ * table
+ *
  * 表格
- * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken, ...TrToken, ?SyntaxToken]}`
+ * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken[], ...TrToken[], ?SyntaxToken]}`
  */
 class TableToken extends trBase_1.TrBaseToken {
     /* NOT FOR BROWSER END */
     get type() {
         return 'table';
     }
-    /** 表格是否闭合 */
+    /** whether the table is closed / 表格是否闭合 */
     get closed() {
         return this.lastChild.type === 'table-syntax';
     }
@@ -114,17 +120,19 @@ class TableToken extends trBase_1.TrBaseToken {
         return errors;
     }
     /**
+     * Close the table syntax
+     *
      * 闭合表格语法
-     * @param syntax 表格结尾语法
+     * @param syntax syntax of the table end / 表格结尾语法
      * @param halfParsed
      */
     close(syntax = '\n|}', halfParsed) {
-        const config = this.getAttribute('config'), accum = this.getAttribute('accum'), inner = halfParsed ? [syntax] : index_1.default.parse(syntax, this.getAttribute('include'), 2, config).childNodes;
+        const config = this.getAttribute('config'), accum = this.getAttribute('accum'), inner = halfParsed
+            ? [syntax]
+            : index_1.default.parse(syntax, this.getAttribute('include'), 2, config).childNodes;
         if (this.lastChild.type !== 'table-syntax') {
             debug_1.Shadow.run(() => {
-                const token = new syntax_1.SyntaxToken(undefined, closingPattern, 'table-syntax', config, accum, {
-                    'Stage-1': ':', '!ExtToken': '', TranscludeToken: ':',
-                });
+                const token = new syntax_1.SyntaxToken(undefined, closingPattern, 'table-syntax', config, accum, { 'Stage-1': ':', '!ExtToken': '', TranscludeToken: ':' });
                 super.insertAt(token);
                 if (!halfParsed) {
                     token.afterBuild();
@@ -134,12 +142,14 @@ class TableToken extends trBase_1.TrBaseToken {
         this.lastChild.replaceChildren(...inner);
     }
     /**
+     * Get the table layout
+     *
      * 获取表格布局
-     * @param stop 中止条件
-     * @param stop.row 中止行
-     * @param stop.column 中止列
-     * @param stop.x 中止行
-     * @param stop.y 中止列
+     * @param stop stop condition / 中止条件
+     * @param stop.row stop at the row / 中止行
+     * @param stop.column stop at the column / 中止列
+     * @param stop.x stop at the row / 中止行
+     * @param stop.y stop at the column / 中止列
      */
     getLayout(stop) {
         const rows = this.getAllRows(), { length } = rows, layout = new Layout(...emptyArray(length, () => []));
@@ -186,7 +196,11 @@ class TableToken extends trBase_1.TrBaseToken {
         }
         return layout;
     }
-    /** 获取所有行 */
+    /**
+     * Get all rows
+     *
+     * 获取所有行
+     */
     getAllRows() {
         return [
             ...super.getRowCount() ? [this] : [],
@@ -194,17 +208,6 @@ class TableToken extends trBase_1.TrBaseToken {
                 .filter((child) => child.type === 'tr' && child.getRowCount() > 0),
         ];
     }
-    /**
-     * 获取指定坐标的单元格
-     * @param coords 表格坐标
-     */
-    getNthCell(coords) {
-        let rawCoords = coords;
-        if (coords.row === undefined) {
-            rawCoords = this.toRawCoords(coords);
-        }
-        return rawCoords && this.getNthRow(rawCoords.row, false, false)?.getNthCol(rawCoords.column);
-    }
     getNthRow(n, force, insert) {
         const isRow = super.getRowCount();
         /* NOT FOR BROWSER */
@@ -225,31 +228,32 @@ class TableToken extends trBase_1.TrBaseToken {
             n--;
         }
         for (const child of this.childNodes.slice(2)) {
-            if (child.type === 'tr' && child.getRowCount()) {
+            const { type } = child;
+            if (type === 'tr' && child.getRowCount()) {
                 n--;
                 if (n < 0) {
                     return child;
                 }
                 /* NOT FOR BROWSER */
             }
-            else if (child.type === 'table-syntax') {
+            else if (type === 'table-syntax') {
                 return child;
                 /* NOT FOR BROWSER END */
             }
         }
         return undefined;
     }
-    /** @override */
-    json() {
-        const json = super.json();
+    /** @private */
+    json(_, start = this.getAbsoluteIndex()) {
+        const json = super.json(undefined, start);
         json['closed'] = this.closed;
         return json;
     }
     /* NOT FOR BROWSER */
     /**
      * @override
-     * @param token 待插入的子节点
-     * @param i 插入位置
+     * @param token node to be inserted / 待插入的子节点
+     * @param i position to be inserted at / 插入位置
      * @throws `SyntaxError` 表格的闭合部分非法
      */
     insertAt(token, i = this.length) {
@@ -268,83 +272,120 @@ class TableToken extends trBase_1.TrBaseToken {
     getRowCount() {
         return super.getRowCount() + this.childNodes.filter(child => child.type === 'tr' && child.getRowCount()).length;
     }
-    /** 获取下一行 */
+    /**
+     * Get the next row
+     *
+     * 获取下一行
+     */
     getNextRow() {
         return this.getNthRow(super.getRowCount() ? 1 : 0, false, false);
     }
-    /** 打印表格布局 */
+    /**
+     * Get the cell with the specified coordinates
+     *
+     * 获取指定坐标的单元格
+     * @param coords table coordinates / 表格坐标
+     */
+    getNthCell(coords) {
+        let rawCoords = coords;
+        if (coords.row === undefined) {
+            rawCoords = this.toRawCoords(coords);
+        }
+        return rawCoords && this.getNthRow(rawCoords.row, false, false)?.getNthCol(rawCoords.column);
+    }
+    /**
+     * Print the table layout
+     *
+     * 打印表格布局
+     */
     printLayout() {
         require('../../addon/table');
         this.printLayout();
     }
     /**
+     * Convert to table coordinates after rendering
+     *
      * 转换为渲染后的表格坐标
-     * @param {TableCoords} coord wikitext中的表格坐标
+     * @param {TableCoords} coord table coordinates in wikitext / wikitext中的表格坐标
      */
     toRenderedCoords(coord) {
         require('../../addon/table');
         return this.toRenderedCoords(coord);
     }
     /**
+     * Convert to table coordinates in wikitext
+     *
      * 转换为wikitext中的表格坐标
-     * @param {TableRenderedCoords} coord 渲染后的表格坐标
+     * @param {TableRenderedCoords} coord table coordinates after rendering / 渲染后的表格坐标
      */
     toRawCoords(coord) {
         require('../../addon/table');
         return this.toRawCoords(coord);
     }
     /**
+     * Get the full row
+     *
      * 获取完整行
-     * @param y 行号
+     * @param y row number / 行号
      */
     getFullRow(y) {
         require('../../addon/table');
         return this.getFullRow(y);
     }
     /**
+     * Get the full column
+     *
      * 获取完整列
-     * @param x 列号
+     * @param x column number / 列号
      */
     getFullCol(x) {
         require('../../addon/table');
         return this.getFullCol(x);
     }
     /**
+     * Format the row
+     *
      * 设置行格式
-     * @param y 行号
-     * @param attr 表格属性
-     * @param multiRow 是否对所有单元格设置，或是仅对行首单元格设置
+     * @param y row number / 行号
+     * @param attr table attribute / 表格属性
+     * @param multiRow whether to format multi-row cells / 是否对所有单元格设置，或是仅对行首单元格设置
      */
     formatTableRow(y, attr, multiRow) {
         require('../../addon/table');
         this.formatTableRow(y, attr, multiRow);
     }
     /**
+     * Format the column
+     *
      * 设置列格式
-     * @param x 列号
-     * @param attr 表格属性
-     * @param multiCol 是否对所有单元格设置，或是仅对行首单元格设置
+     * @param x column number / 列号
+     * @param attr table attribute / 表格属性
+     * @param multiCol whether to format multi-column cells / 是否对所有单元格设置，或是仅对行首单元格设置
      */
     formatTableCol(x, attr, multiCol) {
         require('../../addon/table');
         this.formatTableCol(x, attr, multiCol);
     }
     /**
+     * Fill the table row
+     *
      * 填补表格行
-     * @param y 行号
-     * @param inner 填充内容
-     * @param subtype 单元格类型
-     * @param attr 表格属性
+     * @param y row number / 行号
+     * @param inner content to fill / 填充内容
+     * @param subtype type of the cell / 单元格类型
+     * @param attr table attribute / 表格属性
      */
     fillTableRow(y, inner, subtype, attr) {
         require('../../addon/table');
         this.fillTableRow(y, inner, subtype, attr);
     }
     /**
+     * Fill the table
+     *
      * 填补表格
-     * @param inner 填充内容
-     * @param subtype 单元格类型
-     * @param attr 表格属性
+     * @param inner content to fill / 填充内容
+     * @param subtype type of the cell / 单元格类型
+     * @param attr table attribute / 表格属性
      */
     fillTable(inner, subtype, attr) {
         require('../../addon/table');
@@ -360,23 +401,27 @@ class TableToken extends trBase_1.TrBaseToken {
         return this.prependTableRow();
     }
     /**
+     * Insert a table row
+     *
      * 插入表格行
-     * @param y 行号
-     * @param attr 表格行属性
-     * @param inner 内部wikitext
-     * @param subtype 单元格类型
-     * @param innerAttr 单元格属性
+     * @param y row number / 行号
+     * @param attr table row attribute / 表格行属性
+     * @param inner inner wikitext / 内部wikitext
+     * @param subtype type of the cell / 单元格类型
+     * @param innerAttr cell attribute / 单元格属性
      */
     insertTableRow(y, attr, inner, subtype, innerAttr) {
         require('../../addon/table');
         return this.insertTableRow(y, attr, inner, subtype, innerAttr);
     }
     /**
+     * Insert a table column
+     *
      * 插入表格列
-     * @param x 列号
-     * @param inner 内部wikitext
-     * @param subtype 单元格类型
-     * @param attr 单元格属性
+     * @param x column number / 列号
+     * @param inner inner wikitext / 内部wikitext
+     * @param subtype type of the cell / 单元格类型
+     * @param attr cell attribute / 单元格属性
      * @throws `RangeError` 列号过大
      */
     insertTableCol(x, inner, subtype, attr) {
@@ -384,25 +429,31 @@ class TableToken extends trBase_1.TrBaseToken {
         this.insertTableCol(x, inner, subtype, attr);
     }
     /**
+     * Remove a table row
+     *
      * 移除表格行
-     * @param y 行号
+     * @param y row number / 行号
      */
     removeTableRow(y) {
         require('../../addon/table');
         return this.removeTableRow(y);
     }
     /**
+     * Remove a table column
+     *
      * 移除表格列
-     * @param x 列号
+     * @param x column number / 列号
      */
     removeTableCol(x) {
         require('../../addon/table');
         this.removeTableCol(x);
     }
     /**
+     * Marge cells
+     *
      * 合并单元格
-     * @param xlim 列范围
-     * @param ylim 行范围
+     * @param xlim column range / 列范围
+     * @param ylim row range / 行范围
      * @throws `RangeError` 待合并区域与外侧区域有重叠
      */
     mergeCells(xlim, ylim) {
@@ -415,40 +466,50 @@ class TableToken extends trBase_1.TrBaseToken {
         this.split(coords, dirs);
     }
     /**
+     * Split a cell into rows
+     *
      * 分裂成多行
-     * @param coords 单元格坐标
+     * @param coords coordinates of the cell / 单元格坐标
      */
     splitIntoRows(coords) {
         require('../../addon/table');
         this.splitIntoRows(coords);
     }
     /**
+     * Split a cell into columns
+     *
      * 分裂成多列
-     * @param coords 单元格坐标
+     * @param coords coordinates of the cell / 单元格坐标
      */
     splitIntoCols(coords) {
         require('../../addon/table');
         this.splitIntoCols(coords);
     }
     /**
+     * Split a cell into cells
+     *
      * 分裂成单元格
-     * @param coords 单元格坐标
+     * @param coords coordinates of the cell / 单元格坐标
      */
     splitIntoCells(coords) {
         require('../../addon/table');
         this.splitIntoCells(coords);
     }
     /**
+     * Replicate a row and insert the result before the row
+     *
      * 复制一行并插入该行之前
-     * @param row 行号
+     * @param row row number / 行号
      */
     replicateTableRow(row) {
         require('../../addon/table');
         return this.replicateTableRow(row);
     }
     /**
+     * Replicate a column and insert the result before the column
+     *
      * 复制一列并插入该列之前
-     * @param x 列号
+     * @param x column number / 列号
      */
     replicateTableCol(x) {
         require('../../addon/table');
@@ -460,9 +521,11 @@ class TableToken extends trBase_1.TrBaseToken {
         this.moveCol(x, reference, after);
     }
     /**
+     * Move a table row
+     *
      * 移动表格行
-     * @param y 行号
-     * @param before 新位置
+     * @param y row number / 行号
+     * @param before new position / 新位置
      * @throws `RangeError` 无法移动
      */
     moveTableRowBefore(y, before) {
@@ -470,9 +533,11 @@ class TableToken extends trBase_1.TrBaseToken {
         return this.moveTableRowBefore(y, before);
     }
     /**
+     * Move a table row
+     *
      * 移动表格行
-     * @param y 行号
-     * @param after 新位置
+     * @param y row number / 行号
+     * @param after new position / 新位置
      * @throws `RangeError` 无法移动
      */
     moveTableRowAfter(y, after) {
@@ -480,18 +545,22 @@ class TableToken extends trBase_1.TrBaseToken {
         return this.moveTableRowAfter(y, after);
     }
     /**
+     * Move a table column
+     *
      * 移动表格列
-     * @param x 列号
-     * @param before 新位置
+     * @param x column number / 列号
+     * @param before new position / 新位置
      */
     moveTableColBefore(x, before) {
         require('../../addon/table');
         this.moveTableColBefore(x, before);
     }
     /**
+     * Move a table column
+     *
      * 移动表格列
-     * @param x 列号
-     * @param after 新位置
+     * @param x column number / 列号
+     * @param after new position / 新位置
      */
     moveTableColAfter(x, after) {
         require('../../addon/table');
@@ -504,10 +573,9 @@ class TableToken extends trBase_1.TrBaseToken {
          * @param token 表格或表格行
          */
         const filter = (token) => token.childNodes.filter((0, debug_1.isToken)('table-inter'));
-        const { childNodes } = this, tr = childNodes.filter((0, debug_1.isToken)('tr')), newOpt = { ...opt, nowrap: true }, 
-        // eslint-disable-next-line es-x/no-array-prototype-flat
-        inter = [this, ...tr].flatMap(filter).map(token => token.toHtmlInternal(newOpt).trim()).join(' ');
-        return `${inter}<table${childNodes[1].toHtmlInternal()}>${opt?.nowrap ? ' ' : '\n'}<tbody>${super.toHtmlInternal(opt)}${(0, html_1.html)(tr, '', opt)}</tbody></table>`;
+        const { childNodes } = this, tr = childNodes.filter((0, debug_1.isToken)('tr')), newOpt = { ...opt, nowrap: true };
+        return `${[this, ...tr].flatMap(filter) // eslint-disable-line es-x/no-array-prototype-flat
+            .map(token => token.toHtmlInternal(newOpt).trim()).join(' ')}<table${childNodes[1].toHtmlInternal()}>${opt?.nowrap ? ' ' : '\n'}<tbody>${super.toHtmlInternal(opt)}${(0, html_1.html)(tr, '', opt)}</tbody></table>`;
     }
 }
 exports.TableToken = TableToken;

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

@@ -12,7 +12,9 @@ declare type TdAttrGetter<T extends string> = T extends keyof TdSpanAttrs ? numb
 declare type TdAttrSetter<T extends string> = T extends keyof TdSpanAttrs ? number : string | boolean;
 export type TdAttrs = Record<string, string | true> & TdSpanAttrs;
 /**
- * `<td>`、`<th>`和`<caption>`
+ * `<td>`, `<th>` or `<caption>`
+ *
+ * `<td>`、`<th>`或`<caption>`
  * @classdesc `{childNodes: [SyntaxToken, AttributesToken, Token]}`
  */
 export declare abstract class TdToken extends TableBaseToken {
@@ -29,12 +31,12 @@ export declare abstract class TdToken extends TableBaseToken {
     get rowspan(): number;
     /** colspan */
     get colspan(): number;
-    /** 单元格类型 */
+    /** cell type / 单元格类型 */
     get subtype(): TdSubtypes;
     set subtype(subtype: TdSubtypes);
     set rowspan(rowspan: number);
     set colspan(colspan: number);
-    /** 内部wikitext */
+    /** inner wikitext / 内部wikitext */
     get innerText(): string;
     set innerText(text: string);
     /**
@@ -42,20 +44,26 @@ export declare abstract class TdToken extends TableBaseToken {
      * @param inner 内部wikitext
      */
     constructor(syntax: string, inner?: string, config?: Parser.Config, accum?: Token[]);
-    /** 是否位于行首 */
+    /**
+     * Check if the cell is at the beginning of a line
+     *
+     * 是否位于行首
+     */
     isIndependent(): boolean;
     getAttr<T extends string>(key: T): TdAttrGetter<T>;
-    /** @override */
-    json(): AST;
     cloneNode(): this;
-    /** 改为独占一行 */
+    /**
+     * Move to a new line
+     *
+     * 改为独占一行
+     */
     independence(): void;
     getAttrs(): TdAttrs;
     /**
      * @override
-     * @param key 属性键
-     * @param value 属性值
-     * @param prop 属性对象
+     * @param key attribute name / 属性键
+     * @param value attribute value / 属性值
+     * @param prop attribute object / 属性对象
      */
     setAttr<T extends string>(key: T, value: TdAttrSetter<T>): void;
     setAttr(prop: Record<string, string | number | boolean>): void;

package/dist/src/table/td.js

@@ -47,7 +47,9 @@ const string_1 = require("../../util/string");
 const fixed_1 = require("../../mixin/fixed");
 /* NOT FOR BROWSER END */
 /**
- * `<td>`、`<th>`和`<caption>`
+ * `<td>`, `<th>` or `<caption>`
+ *
+ * `<td>`、`<th>`或`<caption>`
  * @classdesc `{childNodes: [SyntaxToken, AttributesToken, Token]}`
  */
 let TdToken = (() => {
@@ -80,7 +82,7 @@ let TdToken = (() => {
         get colspan() {
             return this.getAttr('colspan');
         }
-        /** 单元格类型 */
+        /** cell type / 单元格类型 */
         get subtype() {
             return this.#getSyntax().subtype;
         }
@@ -94,7 +96,7 @@ let TdToken = (() => {
         set colspan(colspan) {
             this.setAttr('colspan', colspan);
         }
-        /** 内部wikitext */
+        /** inner wikitext / 内部wikitext */
         get innerText() {
             return this.lastChild.text().trim();
         }
@@ -155,12 +157,10 @@ let TdToken = (() => {
                 /* NOT FOR BROWSER */
                 const str = previousSibling.lastChild.toString();
                 result.escape ||= esc;
-                result.correction = str.includes('\n') && debug_1.Shadow.run(() => {
-                    const config = this.getAttribute('config'), include = this.getAttribute('include');
-                    return new index_2.Token(str, config).parseOnce(0, include).parseOnce().parseOnce()
-                        .toString()
-                        .includes('\n');
-                });
+                result.correction = str.includes('\n') && debug_1.Shadow.run(() => new index_2.Token(str, this.getAttribute('config'))
+                    .parseOnce(0, this.getAttribute('include')).parseOnce().parseOnce()
+                    .toString()
+                    .includes('\n'));
                 if (subtype === 'th' && result.subtype !== 'th') {
                     result.subtype = 'th';
                     result.correction = true;
@@ -235,7 +235,11 @@ let TdToken = (() => {
             }
             return errors;
         }
-        /** 是否位于行首 */
+        /**
+         * Check if the cell is at the beginning of a line
+         *
+         * 是否位于行首
+         */
         isIndependent() {
             return this.firstChild.text().startsWith('\n');
         }
@@ -249,10 +253,10 @@ let TdToken = (() => {
             const { childNodes: [syntax, attr, inner] } = this;
             return `<span class="wpb-td">${syntax.print()}${attr.print()}${this.#innerSyntax}${inner.print()}</span>`;
         }
-        /** @override */
-        json() {
-            const json = super.json();
-            json['subtype'] = this.subtype;
+        /** @private */
+        json(_, start = this.getAbsoluteIndex()) {
+            const json = super.json(undefined, start);
+            Object.assign(json, { subtype: this.subtype, rowspan: this.rowspan, colspan: this.colspan });
             return json;
         }
         /* NOT FOR BROWSER */
@@ -285,7 +289,11 @@ let TdToken = (() => {
                 this.setSyntax(subtype, escape);
             }
         }
-        /** 改为独占一行 */
+        /**
+         * Move to a new line
+         *
+         * 改为独占一行
+         */
         independence() {
             if (!this.isIndependent()) {
                 const { subtype, escape } = this.#getSyntax();

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

@@ -2,8 +2,10 @@ import { TrBaseToken } from './trBase';
 import type { Config } from '../../base';
 import type { Token, TdToken, TableToken, SyntaxToken, AttributesToken } from '../../internal';
 /**
+ * table row that contains the newline at the beginning but not at the end
+ *
  * 表格行，含开头的换行，不含结尾的换行
- * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken]}`
+ * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken[]]}`
  */
 export declare abstract class TrToken extends TrBaseToken {
     #private;
@@ -23,8 +25,16 @@ export declare abstract class TrToken extends TrBaseToken {
      * @param attr 表格属性
      */
     constructor(syntax: string, attr?: string, config?: Config, accum?: Token[]);
-    /** 获取下一行 */
+    /**
+     * Get the next row
+     *
+     * 获取下一行
+     */
     getNextRow(): TrToken | undefined;
-    /** 获取前一行 */
+    /**
+     * Get the previous row
+     *
+     * 获取前一行
+     */
     getPreviousRow(): TrToken | undefined;
 }