wikiparser-node 1.4.2-b → 1.4.2

package/dist/src/paramTag/index.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParamTagToken = void 0;
+const lint_1 = require("../../util/lint");
+const debug_1 = require("../../util/debug");
+const constants_1 = require("../../util/constants");
+const singleLine_1 = require("../../mixin/singleLine");
+const index_1 = require("../../index");
+const index_2 = require("../index");
+const atom_1 = require("../atom");
+/**
+ * `<dynamicpagelist>`
+ * @classdesc `{childNodes: ...AtomToken}`
+ */
+class ParamTagToken extends index_2.Token {
+    type = 'ext-inner';
+    /** @class */
+    constructor(wikitext, config = index_1.default.getConfig(), accum = [], acceptable = {}) {
+        super(undefined, config, accum, {
+            SingleLineAtomToken: ':',
+        });
+        if (wikitext) {
+            const SingleLineAtomToken = (0, singleLine_1.singleLine)(atom_1.AtomToken);
+            this.append(...wikitext.split('\n').map(line => new SingleLineAtomToken(line, 'param-line', config, accum, {
+                AstText: ':', ...acceptable,
+            })));
+        }
+    }
+    /** @private */
+    toString() {
+        return super.toString('\n');
+    }
+    /** @override */
+    text() {
+        return super.text('\n');
+    }
+    /** @private */
+    getGaps() {
+        return 1;
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        let rect;
+        return this.childNodes.filter(child => {
+            const { childNodes } = child, i = childNodes.findIndex(({ type }) => type !== 'text'), str = (i >= 0 ? childNodes.slice(0, i).map(String).join('') : String(child)).trim();
+            return str && !(i >= 0 ? /^[a-z]+(?:\[\])?\s*(?:=|$)/iu : /^[a-z]+(?:\[\])?\s*=/iu).test(str);
+        }).map(child => {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            return (0, lint_1.generateForChild)(child, rect, index_1.default.msg('invalid parameter of <$1>', this.name));
+        });
+    }
+    /** @override */
+    print() {
+        return super.print({ sep: '\n' });
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const cloned = this.cloneChildNodes();
+        return debug_1.Shadow.run(() => {
+            const token = new this.constructor(undefined, this.getAttribute('config'));
+            token.append(...cloned);
+            return token;
+        });
+    }
+}
+exports.ParamTagToken = ParamTagToken;
+constants_1.classes['ParamTagToken'] = __filename;

package/dist/src/paramTag/inputbox.d.ts

@@ -0,0 +1,8 @@
+import Parser from '../../index';
+import { ParamTagToken } from './index';
+import type { Token } from '../index';
+/** `<inputbox>` */
+export declare abstract class InputboxToken extends ParamTagToken {
+    /** @class */
+    constructor(wikitext?: string, config?: Parser.Config, accum?: Token[]);
+}

package/dist/src/paramTag/inputbox.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputboxToken = void 0;
+const constants_1 = require("../../util/constants");
+const braces_1 = require("../../parser/braces");
+const index_1 = require("../../index");
+const index_2 = require("./index");
+/** `<inputbox>` */
+class InputboxToken extends index_2.ParamTagToken {
+    /** @class */
+    constructor(wikitext, config = index_1.default.getConfig(), accum = []) {
+        const placeholder = Symbol('InputboxToken');
+        accum.push(placeholder);
+        wikitext &&= (0, braces_1.parseBraces)(wikitext, config, accum);
+        accum.splice(accum.indexOf(placeholder), 1);
+        super(wikitext, config, accum, {
+            ArgToken: ':', TranscludeToken: ':',
+        });
+    }
+}
+exports.InputboxToken = InputboxToken;
+constants_1.classes['InputboxToken'] = __filename;

package/dist/src/parameter.d.ts

@@ -0,0 +1,67 @@
+import Parser from '../index';
+import { Token } from './index';
+import type { LintError } from '../base';
+import type { AtomToken, SyntaxToken, TranscludeToken } from '../internal';
+export declare abstract class ParameterToken extends Token {
+    readonly type = "parameter";
+    readonly name: string;
+    readonly childNodes: readonly [Token, Token];
+    abstract get children(): [Token, Token];
+    abstract get firstChild(): Token;
+    abstract get firstElementChild(): Token;
+    abstract get lastChild(): Token;
+    abstract get lastElementChild(): Token;
+    abstract get parentNode(): TranscludeToken | undefined;
+    abstract get parentElement(): TranscludeToken | undefined;
+    abstract get nextSibling(): this | undefined;
+    abstract get nextElementSibling(): this | undefined;
+    abstract get previousSibling(): AtomToken | SyntaxToken | this;
+    abstract get previousElementSibling(): AtomToken | SyntaxToken | this;
+    /** 是否是匿名参数 */
+    get anon(): boolean;
+    set anon(value: boolean);
+    /** getValue()的getter */
+    get value(): string;
+    set value(value: string);
+    /** 是否是重复参数 */
+    get duplicated(): boolean;
+    set duplicated(value: boolean);
+    /**
+     * @param key 参数名
+     * @param value 参数值
+     */
+    constructor(key?: string | number, value?: string, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** @override */
+    lint(start?: number): LintError[];
+    /** @override */
+    print(): string;
+    /** @override */
+    json(): object;
+    /** @override */
+    cloneNode(): this;
+    /**
+     * @override
+     * @param token 待替换的节点
+     */
+    safeReplaceWith(token: this): void;
+    /** 获取参数值 */
+    getValue(): string;
+    /**
+     * 设置参数值
+     * @param value 参数值
+     */
+    setValue(value: string): void;
+    /**
+     * 修改参数名
+     * @param key 新参数名
+     * @param force 是否无视冲突命名
+     * @throws `Error` 仅用于模板参数
+     * @throws `RangeError` 更名造成重复参数
+     */
+    rename(key: string, force?: boolean): void;
+    /** 转义 `=` */
+    escape(): void;
+}
+export {};

package/dist/src/parameter.js

@@ -0,0 +1,213 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParameterToken = void 0;
+const string_1 = require("../util/string");
+const lint_1 = require("../util/lint");
+const debug_1 = require("../util/debug");
+const constants_1 = require("../util/constants");
+const fixed_1 = require("../mixin/fixed");
+const index_1 = require("../index");
+const index_2 = require("./index");
+/**
+ * 准确获取参数名
+ * @param name 预定的参数名
+ */
+const getName = (name) => name.text().replace(/^[ \t\n\0\v]+|([^ \t\n\0\v])[ \t\n\0\v]+$/gu, '$1');
+/**
+ * 模板或魔术字参数
+ * @classdesc `{childNodes: [Token, Token]}`
+ */
+class ParameterToken extends (0, fixed_1.fixedToken)(index_2.Token) {
+    type = 'parameter';
+    /** 是否是匿名参数 */
+    get anon() {
+        return this.firstChild.length === 0;
+    }
+    /* NOT FOR BROWSER */
+    set anon(value) {
+        if (value) {
+            throw new Error('无法将命名参数转换为匿名参数！');
+        }
+        this.parentNode?.anonToNamed();
+    }
+    /** getValue()的getter */
+    get value() {
+        return this.getValue();
+    }
+    set value(value) {
+        this.setValue(value);
+    }
+    /** 是否是重复参数 */
+    get duplicated() {
+        try {
+            return Boolean(this.parentNode?.getDuplicatedArgs().some(([key]) => key === this.name));
+        }
+        catch {
+            return false;
+        }
+    }
+    set duplicated(value) {
+        if (this.duplicated && !value) {
+            this.parentNode.fixDuplication();
+        }
+    }
+    /* NOT FOR BROWSER END */
+    /**
+     * @param key 参数名
+     * @param value 参数值
+     */
+    constructor(key, value, config = index_1.default.getConfig(), accum = []) {
+        super(undefined, config, accum);
+        const keyToken = new index_2.Token(typeof key === 'number' ? undefined : key, config, accum, {
+            'Stage-11': ':', '!HeadingToken': '',
+        }), token = new index_2.Token(value, config, accum);
+        keyToken.type = 'parameter-key';
+        token.type = 'parameter-value';
+        token.setAttribute('stage', 2);
+        this.append(keyToken, token);
+    }
+    /** @private */
+    afterBuild() {
+        if (!this.anon) {
+            const { parentNode, firstChild } = this, name = getName(firstChild);
+            this.setAttribute('name', name);
+            if (parentNode) {
+                /* NOT FOR BROWSER */
+                parentNode.getAttribute('keys').add(name);
+                /* NOT FOR BROWSER END */
+                parentNode.getArgs(name, false, false).add(this);
+            }
+        }
+        /* NOT FOR BROWSER */
+        const /** @implements */ parameterListener = ({ prevTarget }, data) => {
+            if (!this.anon) { // 匿名参数不管怎么变动还是匿名
+                const { firstChild, name } = this;
+                if (prevTarget === firstChild) {
+                    const newKey = getName(firstChild);
+                    data.oldKey = name;
+                    data.newKey = newKey;
+                    this.setAttribute('name', newKey);
+                }
+            }
+        };
+        this.addEventListener(['remove', 'insert', 'replace', 'text'], parameterListener);
+    }
+    /** @private */
+    toString() {
+        return this.anon ? String(this.lastChild) : super.toString('=');
+    }
+    /** @override */
+    text() {
+        return this.anon ? this.lastChild.text() : super.text('=');
+    }
+    /** @private */
+    getGaps() {
+        return this.anon ? 0 : 1;
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+        /https?:\/\/(?:\[[\da-f:.]+\]|[^[\]<>"\t\n\p{Zs}])(?:[^[\]<>"\0\t\n\p{Zs}]|\0\d+c\x7F)*$/iu;
+        const errors = super.lint(start), { firstChild } = this, link = new RegExp(`https?://${string_1.extUrlCharFirst}${string_1.extUrlChar}$`, 'iu').exec(firstChild.text())?.[0];
+        if (link && new URL(link).search) {
+            const e = (0, lint_1.generateForChild)(firstChild, { start }, 'unescaped query string in an anonymous parameter');
+            errors.push({
+                ...e,
+                startIndex: e.endIndex,
+                endIndex: e.endIndex + 1,
+                startLine: e.endLine,
+                startCol: e.endCol,
+                endCol: e.endCol + 1,
+            });
+        }
+        return errors;
+    }
+    /** @override */
+    print() {
+        return super.print({ sep: this.anon ? '' : '=' });
+    }
+    /** @override */
+    json() {
+        return {
+            ...super.json(),
+            anon: this.anon,
+        };
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const [key, value] = this.cloneChildNodes(), config = this.getAttribute('config');
+        return debug_1.Shadow.run(() => {
+            // @ts-expect-error abstract class
+            const token = new ParameterToken(this.anon ? Number(this.name) : undefined, undefined, config);
+            token.firstChild.safeReplaceWith(key);
+            token.lastChild.safeReplaceWith(value);
+            token.afterBuild();
+            if (this.anon) {
+                token.setAttribute('name', this.name);
+            }
+            return token;
+        });
+    }
+    /**
+     * @override
+     * @param token 待替换的节点
+     */
+    safeReplaceWith(token) {
+        index_1.default.warn(`${this.constructor.name}.safeReplaceWith 方法退化到 replaceWith。`);
+        this.replaceWith(token);
+    }
+    /** 获取参数值 */
+    getValue() {
+        const value = this.lastChild.text();
+        return this.anon && this.parentNode?.isTemplate() !== false ? value : value.trim();
+    }
+    /**
+     * 设置参数值
+     * @param value 参数值
+     */
+    setValue(value) {
+        const { childNodes } = index_1.default.parse(value, this.getAttribute('include'), undefined, this.getAttribute('config'));
+        this.lastChild.replaceChildren(...childNodes);
+    }
+    /**
+     * 修改参数名
+     * @param key 新参数名
+     * @param force 是否无视冲突命名
+     * @throws `Error` 仅用于模板参数
+     * @throws `RangeError` 更名造成重复参数
+     */
+    rename(key, force = false) {
+        const { parentNode, anon } = this;
+        // 必须检测是否是TranscludeToken
+        if (parentNode?.isTemplate() === false) {
+            throw new Error('rename 方法仅用于模板参数！');
+        }
+        else if (anon) {
+            parentNode?.anonToNamed();
+        }
+        const root = index_1.default.parse(key, this.getAttribute('include'), undefined, this.getAttribute('config')), name = getName(root);
+        if (this.name === name) {
+            index_1.default.warn('未改变实际参数名', name);
+        }
+        else if (parentNode?.hasArg(name)) {
+            if (force) {
+                index_1.default.warn('参数更名造成重复参数', name);
+            }
+            else {
+                throw new RangeError(`参数更名造成重复参数：${name}`);
+            }
+        }
+        this.firstChild.replaceChildren(...root.childNodes);
+    }
+    /** 转义 `=` */
+    escape() {
+        for (const child of this.lastChild.childNodes) {
+            if (child.type === 'text') {
+                child.escape();
+            }
+        }
+    }
+}
+exports.ParameterToken = ParameterToken;
+constants_1.classes['ParameterToken'] = __filename;

package/dist/src/pre.d.ts

@@ -0,0 +1,28 @@
+import Parser from '../index';
+import { Token } from './index';
+import { NoincludeToken } from './nowiki/noinclude';
+import type { AstText, AttributesToken, ExtToken, ConverterToken } from '../internal';
+/**
+ * `<pre>`
+ * @classdesc `{childNodes: [...AstText|NoincludeToken|ConverterToken]}`
+ */
+export declare abstract class PreToken extends Token {
+    readonly type = "ext-inner";
+    readonly name: 'pre';
+    readonly childNodes: readonly (AstText | NoincludeToken | ConverterToken)[];
+    abstract get children(): (NoincludeToken | ConverterToken)[];
+    abstract get firstChild(): AstText | NoincludeToken | ConverterToken | undefined;
+    abstract get firstElementChild(): NoincludeToken | ConverterToken | undefined;
+    abstract get lastChild(): AstText | NoincludeToken | ConverterToken | undefined;
+    abstract get lastElementChild(): NoincludeToken | ConverterToken | undefined;
+    abstract get nextSibling(): undefined;
+    abstract get nextElementSibling(): undefined;
+    abstract get previousSibling(): AttributesToken;
+    abstract get previousElementSibling(): AttributesToken;
+    abstract get parentNode(): ExtToken | undefined;
+    abstract get parentElement(): ExtToken | undefined;
+    /** @class */
+    constructor(wikitext?: string, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    cloneNode(): this;
+}

package/dist/src/pre.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PreToken = void 0;
+const constants_1 = require("../util/constants");
+const debug_1 = require("../util/debug");
+const index_1 = require("../index");
+const index_2 = require("./index");
+const noinclude_1 = require("./nowiki/noinclude");
+/**
+ * `<pre>`
+ * @classdesc `{childNodes: [...AstText|NoincludeToken|ConverterToken]}`
+ */
+class PreToken extends index_2.Token {
+    type = 'ext-inner';
+    /** @class */
+    constructor(wikitext, config = index_1.default.getConfig(), accum = []) {
+        if (wikitext) {
+            const opening = '<nowiki>', closing = '</nowiki>', { length } = opening;
+            let i = wikitext.indexOf(opening), j = wikitext.indexOf(closing, i + length), str = '';
+            while (i !== -1 && j !== -1) {
+                // @ts-expect-error abstract class
+                new noinclude_1.NoincludeToken(opening, config, accum);
+                // @ts-expect-error abstract class
+                new noinclude_1.NoincludeToken(closing, config, accum);
+                str += `${wikitext.slice(0, i)}\0${accum.length - 1}c\x7F${wikitext.slice(i + length, j)}\0${accum.length}c\x7F`;
+                wikitext = wikitext.slice(j + length + 1);
+                i = wikitext.indexOf(opening);
+                j = wikitext.indexOf(closing, i + length);
+            }
+            wikitext = `${str}${wikitext}`;
+        }
+        super(wikitext, config, accum, {
+            AstText: ':', NoincludeToken: ':', ConverterToken: ':',
+        });
+        this.setAttribute('stage', constants_1.MAX_STAGE - 1);
+    }
+    /** @private */
+    getAttribute(key) {
+        return (key === 'plain') || super.getAttribute(key);
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const cloned = this.cloneChildNodes();
+        return debug_1.Shadow.run(() => {
+            // @ts-expect-error abstract class
+            const token = new PreToken(undefined, this.getAttribute('config'));
+            token.append(...cloned);
+            return token;
+        });
+    }
+}
+exports.PreToken = PreToken;
+constants_1.classes['PreToken'] = __filename;

package/dist/src/syntax.d.ts

@@ -0,0 +1,14 @@
+import Parser from '../index';
+import { Token } from './index';
+import type { LintError } from '../base';
+declare type SyntaxTypes = 'plain' | 'heading-trail' | 'magic-word-name' | 'table-syntax';
+export declare class SyntaxToken extends Token {
+    type: SyntaxTypes;
+    /** @param pattern 语法正则 */
+    constructor(wikitext: string | undefined, pattern: RegExp, type?: SyntaxTypes, config?: Parser.Config, accum?: Token[], acceptable?: Acceptable);
+    /** @override */
+    lint(): LintError[];
+    /** @override */
+    cloneNode(): this;
+}
+export {};

package/dist/src/syntax.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyntaxToken = void 0;
+const debug_1 = require("../util/debug");
+const constants_1 = require("../util/constants");
+const syntax_1 = require("../mixin/syntax");
+const index_1 = require("../index");
+const index_2 = require("./index");
+/** 满足特定语法格式的plain Token */
+class SyntaxToken extends (0, syntax_1.syntax)(index_2.Token) {
+    /** @param pattern 语法正则 */
+    constructor(wikitext, pattern, type = 'plain', config = index_1.default.getConfig(), accum = [], acceptable) {
+        super(wikitext, config, accum, acceptable);
+        this.type = type;
+        /* NOT FOR BROWSER */
+        this.setAttribute('pattern', pattern);
+    }
+    /** @override */
+    lint() {
+        return [];
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const cloned = this.cloneChildNodes(), config = this.getAttribute('config'), acceptable = this.getAttribute('acceptable'), pattern = this.getAttribute('pattern');
+        return debug_1.Shadow.run(() => {
+            const token = new SyntaxToken(undefined, pattern, this.type, config, [], acceptable);
+            token.append(...cloned);
+            token.afterBuild();
+            return token;
+        });
+    }
+}
+exports.SyntaxToken = SyntaxToken;
+constants_1.classes['SyntaxToken'] = __filename;

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

@@ -0,0 +1,27 @@
+import Parser from '../../index';
+import { Token } from '../index';
+import { SyntaxToken } from '../syntax';
+import { AttributesToken } from '../attributes';
+import type { AttributesParentBase } from '../../mixin/attributesParent';
+export interface TableBaseToken extends AttributesParentBase {
+}
+export declare abstract class TableBaseToken extends Token {
+    type: 'table' | 'tr' | 'td';
+    readonly childNodes: readonly [SyntaxToken, AttributesToken, ...Token[]];
+    abstract get children(): [SyntaxToken, AttributesToken, ...Token[]];
+    abstract get firstChild(): SyntaxToken;
+    abstract get firstElementChild(): SyntaxToken;
+    abstract get lastChild(): Token;
+    abstract get lastElementChild(): Token;
+    /**
+     * @param pattern 表格语法正则
+     * @param syntax 表格语法
+     * @param attr 表格属性
+     */
+    constructor(pattern: RegExp, syntax?: string, attr?: string, config?: Parser.Config, accum?: Token[], acceptable?: Acceptable);
+    /** @override */
+    cloneNode(): this;
+    /** 转义表格语法 */
+    escape(): void;
+}
+export {};

package/dist/src/table/base.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TableBaseToken = void 0;
+const debug_1 = require("../../util/debug");
+const constants_1 = require("../../util/constants");
+const attributesParent_1 = require("../../mixin/attributesParent");
+const index_1 = require("../../index");
+const index_2 = require("../index");
+const syntax_1 = require("../syntax");
+const attributes_1 = require("../attributes");
+/* NOT FOR BROWSER */
+/**
+ * 转义表格语法
+ * @param syntax 表格语法节点
+ */
+const escapeTable = (syntax) => {
+    const wikitext = syntax.childNodes.map(child => child.type === 'text'
+        ? child.data.replace(/\|/gu, '{{!}}')
+        : String(child)).join(''), { childNodes } = index_1.default.parse(wikitext, syntax.getAttribute('include'), 2, syntax.getAttribute('config'));
+    syntax.replaceChildren(...childNodes);
+};
+/* NOT FOR BROWSER END */
+/**
+ * 表格行，含开头的换行，不含结尾的换行
+ * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ...Token]}`
+ */
+class TableBaseToken extends (0, attributesParent_1.attributesParent)(index_2.Token, 1) {
+    /**
+     * @param pattern 表格语法正则
+     * @param syntax 表格语法
+     * @param attr 表格属性
+     */
+    constructor(pattern, syntax, attr, config = index_1.default.getConfig(), accum = [], acceptable = {}) {
+        super(undefined, config, accum, acceptable);
+        this.append(new syntax_1.SyntaxToken(syntax, pattern, 'table-syntax', config, accum, {
+            'Stage-1': ':', '!ExtToken': '', TranscludeToken: ':',
+        }), 
+        // @ts-expect-error abstract class
+        new attributes_1.AttributesToken(attr, 'table-attrs', this.type, config, accum));
+        /* NOT FOR BROWSER */
+        this.protectChildren(0, 1);
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const [syntax, attr, ...cloned] = this.cloneChildNodes();
+        return debug_1.Shadow.run(() => {
+            const { constructor } = this, token = new constructor(undefined, undefined, this.getAttribute('config'));
+            token.firstChild.safeReplaceWith(syntax);
+            token.childNodes[1].safeReplaceWith(attr);
+            if (token.type === 'td') { // TdToken
+                token.childNodes[2].safeReplaceWith(cloned[0]);
+            }
+            else {
+                token.append(...cloned);
+            }
+            return token;
+        });
+    }
+    /** 转义表格语法 */
+    escape() {
+        for (const child of this.childNodes) {
+            if (child instanceof syntax_1.SyntaxToken) {
+                escapeTable(child);
+            }
+            else if (child instanceof TableBaseToken) {
+                child.escape();
+            }
+        }
+    }
+    /** @private */
+    setSyntax(syntax, esc = false) {
+        const { firstChild } = this;
+        firstChild.replaceChildren(syntax);
+        if (esc) {
+            escapeTable(firstChild);
+        }
+    }
+}
+exports.TableBaseToken = TableBaseToken;
+constants_1.classes['TableBaseToken'] = __filename;