wikiparser-node 0.11.0 → 1.0.0-beta.1

package/dist/lib/text.d.ts

@@ -1,64 +1,72 @@
-export = AstText;
+import * as Parser from '../index';
+import * as AstNode from './node';
 /** 文本节点 */
 declare class AstText extends AstNode {
-    /** @param {string} text 包含文本 */
-    constructor(text?: string);
-    /** @type {string} */ data: string;
+    #private;
+    /** @browser */
+    readonly type = "text";
+    name: undefined;
+    /** @browser */
+    data: string;
     /** 文本长度 */
     get length(): number;
-    /** @override */
-    override text(): string;
+    /**
+     * @browser
+     * @param text 包含文本
+     */
+    constructor(text?: string);
+    /**
+     * 输出字符串
+     * @browser
+     */
+    toString(): string;
+    /**
+     * 可见部分
+     * @browser
+     */
+    text(): string;
     /**
      * Linter
-     * @this {AstText & {parentNode: AstElement}}
-     * @param {number} start 起始位置
-     * @returns {LintError[]}
+     * @browser
      */
-    lint(this: AstText & {
-        parentNode: AstElement;
-    }, start?: number): LintError[];
+    lint(start?: number): Parser.LintError[];
     /**
      * 替换字符串
-     * @param {string} text 替换的字符串
+     * @browser
+     * @param text 替换的字符串
      */
     replaceData(text?: string): void;
     /** 复制 */
     cloneNode(): AstText;
     /**
      * 在后方添加字符串
-     * @param {string} text 添加的字符串
+     * @param text 添加的字符串
      */
     appendData(text: string): void;
     /**
      * 删减字符串
-     * @param {number} offset 起始位置
-     * @param {number} count 删减字符数
+     * @param offset 起始位置
+     * @param count 删减字符数
      */
     deleteData(offset: number, count: number): void;
     /**
      * 插入字符串
-     * @param {number} offset 插入位置
-     * @param {string} text 待插入的字符串
+     * @param offset 插入位置
+     * @param text 待插入的字符串
      */
     insertData(offset: number, text: string): void;
     /**
      * 提取子串
-     * @param {number} offset 起始位置
-     * @param {number} count 字符数
+     * @param offset 起始位置
+     * @param count 字符数
      */
     substringData(offset: number, count: number): string;
     /**
      * 将文本子节点分裂为两部分
-     * @param {number} offset 分裂位置
+     * @param 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;
+export = AstText;

package/dist/lib/text.js

@@ -0,0 +1,215 @@
+"use strict";
+const Parser = require("../index");
+const AstNode = require("./node");
+const errorSyntax = /https?:\/\/|\{+|\}+|\[{2,}|\[(?![^[]*\])|(?<=^|\])([^[]*?)\]+|\]{2,}|<\s*\/?([a-z]\w*)/giu, errorSyntaxUrl = /\{+|\}+|\[{2,}|\[(?![^[]*\])|(?<=^|\])([^[]*?)\]+|\]{2,}|<\s*\/?([a-z]\w*)/giu, disallowedTags = [
+    'html',
+    'base',
+    'head',
+    'style',
+    'title',
+    'body',
+    'menu',
+    'a',
+    'area',
+    'audio',
+    'img',
+    'map',
+    'track',
+    'video',
+    'embed',
+    'iframe',
+    'object',
+    'picture',
+    'source',
+    'canvas',
+    'script',
+    'col',
+    'colgroup',
+    'tbody',
+    'tfoot',
+    'thead',
+    'button',
+    'datalist',
+    'fieldset',
+    'form',
+    'input',
+    'label',
+    'legend',
+    'meter',
+    'optgroup',
+    'option',
+    'output',
+    'progress',
+    'select',
+    'textarea',
+    'details',
+    'dialog',
+    'slot',
+    'template',
+    'dir',
+    'frame',
+    'frameset',
+    'marquee',
+    'param',
+    'xmp',
+];
+/** 文本节点 */
+class AstText extends AstNode {
+    /** @browser */
+    type = 'text';
+    /** @browser */
+    data;
+    /** 文本长度 */
+    get length() {
+        return this.data.length;
+    }
+    /**
+     * @browser
+     * @param text 包含文本
+     */
+    constructor(text = '') {
+        super();
+        Object.defineProperties(this, {
+            data: { value: text, writable: false },
+            childNodes: { enumerable: false, configurable: false },
+            type: { enumerable: false, writable: false, configurable: false },
+        });
+    }
+    /**
+     * 输出字符串
+     * @browser
+     */
+    toString() {
+        return this.data;
+    }
+    /**
+     * 可见部分
+     * @browser
+     */
+    text() {
+        return this.data;
+    }
+    /**
+     * Linter
+     * @browser
+     */
+    lint(start = this.getAbsoluteIndex()) {
+        const { data, parentNode, nextSibling, previousSibling } = this, type = parentNode?.type, name = parentNode?.name, nextType = nextSibling?.type, previousType = previousSibling?.type, errorRegex = type === 'free-ext-link' || type === 'ext-link-url' || type === 'image-parameter' && name === 'link'
+            ? errorSyntaxUrl
+            : errorSyntax, errors = [...data.matchAll(errorRegex)], { ext, html } = this.getRootNode().getAttribute('config');
+        if (errors.length > 0) {
+            const root = this.getRootNode(), { top, left } = root.posFromIndex(start), tags = new Set([ext, html, disallowedTags].flat(2));
+            return errors
+                .map(({ 0: error, 1: prefix, 2: tag, index }) => {
+                if (prefix) {
+                    /* eslint-disable no-param-reassign */
+                    index += prefix.length;
+                    error = error.slice(prefix.length);
+                    /* eslint-enable no-param-reassign */
+                }
+                const startIndex = start + index, lines = data.slice(0, index).split('\n'), startLine = lines.length + top - 1, line = lines.at(-1), startCol = lines.length > 1 ? line.length : left + line.length, { 0: char, length } = error, endIndex = startIndex + length, end = char === '}' || char === ']' ? endIndex + 1 : startIndex + 49, rootStr = String(root), nextChar = rootStr[endIndex], previousChar = rootStr[startIndex - 1], severity = length > 1 && (char !== '<' || /[\s/>]/u.test(nextChar ?? ''))
+                    || char === '{' && (nextChar === char || previousChar === '-')
+                    || char === '}' && (previousChar === char || nextChar === '-')
+                    || char === '[' && (nextChar === char || type === 'ext-link-text'
+                        || !data.slice(index + 1).trim() && nextType === 'free-ext-link')
+                    || char === ']' && (previousChar === char
+                        || !data.slice(0, index).trim() && previousType === 'free-ext-link')
+                    ? 'error'
+                    : 'warning';
+                return (char !== 'h' || index > 0) && (char !== '<' || tags.has(tag.toLowerCase())) && {
+                    message: Parser.msg('lonely "$1"', char === 'h' ? error : char),
+                    severity,
+                    startIndex,
+                    endIndex,
+                    startLine,
+                    endLine: startLine,
+                    startCol,
+                    endCol: startCol + length,
+                    excerpt: rootStr.slice(Math.max(0, end - 50), end),
+                };
+            }).filter(Boolean);
+        }
+        return [];
+    }
+    /**
+     * 修改内容
+     * @browser
+     * @param text 新内容
+     */
+    #setData(text) {
+        const { data } = this, e = new Event('text', { bubbles: true });
+        this.setAttribute('data', text);
+        if (data !== text) {
+            this.dispatchEvent(e, { oldText: data, newText: text });
+        }
+    }
+    /**
+     * 替换字符串
+     * @browser
+     * @param text 替换的字符串
+     */
+    replaceData(text = '') {
+        this.#setData(text);
+    }
+    /** 复制 */
+    cloneNode() {
+        return new AstText(this.data);
+    }
+    /**
+     * 在后方添加字符串
+     * @param text 添加的字符串
+     */
+    appendData(text) {
+        this.#setData(this.data + text);
+    }
+    /**
+     * 删减字符串
+     * @param offset 起始位置
+     * @param count 删减字符数
+     */
+    deleteData(offset, count) {
+        this.#setData(this.data.slice(0, offset) + (offset < 0 && offset + count >= 0 ? '' : this.data.slice(offset + count)));
+    }
+    /**
+     * 插入字符串
+     * @param offset 插入位置
+     * @param text 待插入的字符串
+     */
+    insertData(offset, text) {
+        this.#setData(this.data.slice(0, offset) + text + this.data.slice(offset));
+    }
+    /**
+     * 提取子串
+     * @param offset 起始位置
+     * @param count 字符数
+     */
+    substringData(offset, count) {
+        return this.data.substr(offset, count);
+    }
+    /**
+     * 将文本子节点分裂为两部分
+     * @param offset 分裂位置
+     * @throws `RangeError` 错误的断开位置
+     * @throws `Error` 没有父节点
+     */
+    splitText(offset) {
+        if (!Number.isInteger(offset)) {
+            this.typeError('splitText', 'Number');
+        }
+        else if (offset > this.length || offset < -this.length) {
+            throw new RangeError(`错误的断开位置：${offset}`);
+        }
+        const { parentNode, data } = this;
+        if (!parentNode) {
+            throw new Error('待分裂的文本节点没有父节点！');
+        }
+        const newText = new AstText(data.slice(offset)), childNodes = [...parentNode.childNodes];
+        this.setAttribute('data', data.slice(0, offset));
+        childNodes.splice(childNodes.indexOf(this) + 1, 0, newText);
+        newText.setAttribute('parentNode', parentNode);
+        parentNode.setAttribute('childNodes', childNodes);
+        return newText;
+    }
+}
+Parser.classes['AstText'] = __filename;
+module.exports = AstText;

package/dist/lib/title.d.ts

@@ -1,21 +1,35 @@
-export = Title;
+import * as Parser from '../index';
 /** 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);
+    /** @browser */
     valid: boolean;
+    /** @browser */
     ns: number;
-    fragment: string;
+    /** @browser */
+    fragment: string | undefined;
+    /** @browser */
     encoded: boolean;
-    title: string;
     main: string;
     prefix: string;
     interwiki: string;
-    /** @override */
-    override toString(): string;
+    conversionTable: Map<string, string>;
+    redirects: Map<string, string>;
+    /** 完整标题 */
+    get title(): string;
+    /**
+     * @browser
+     * @param str 标题（含或不含命名空间前缀）
+     * @param defaultNs 命名空间
+     * @param decode 是否需要解码
+     * @param selfLink 是否允许selfLink
+     */
+    constructor(str: string, defaultNs?: number, config?: Parser.Config, decode?: boolean, selfLink?: boolean);
+    /** 完整链接 */
+    toString(): string;
+    /**
+     * 转换
+     * @param conversionTable 单向转换表
+     */
+    autoConvert(): void;
 }
+export = Title;

package/dist/lib/title.js

@@ -0,0 +1,108 @@
+"use strict";
+const string_1 = require("../util/string");
+const Parser = require("../index");
+/** MediaWiki页面标题对象 */
+class Title {
+    /** @browser */
+    valid = true;
+    /** @browser */
+    ns = 0;
+    /** @browser */
+    fragment;
+    /** @browser */
+    encoded = false;
+    main = '';
+    prefix = '';
+    interwiki = '';
+    conversionTable = new Map();
+    redirects = new Map();
+    /** 完整标题 */
+    get title() {
+        let title = `${this.interwiki && `${this.interwiki}:`}${this.prefix}${this.main.replaceAll(' ', '_')}`;
+        const redirected = this.redirects.get(title);
+        if (redirected) {
+            return redirected;
+        }
+        this.autoConvert();
+        title = `${this.interwiki && `${this.interwiki}:`}${this.prefix}${this.main.replaceAll(' ', '_')}`;
+        return this.redirects.get(title) ?? title;
+    }
+    /**
+     * @browser
+     * @param str 标题（含或不含命名空间前缀）
+     * @param defaultNs 命名空间
+     * @param decode 是否需要解码
+     * @param selfLink 是否允许selfLink
+     */
+    constructor(str, defaultNs = 0, config = Parser.getConfig(), decode = false, selfLink = false) {
+        const { namespaces, nsid } = config;
+        let namespace = namespaces[defaultNs], title = (0, string_1.decodeHtml)(str);
+        if (decode && title.includes('%')) {
+            try {
+                const encoded = /%(?!21|3[ce]|5[bd]|7[b-d])[\da-f]{2}/iu.test(title);
+                title = decodeURIComponent(title);
+                this.encoded = encoded;
+            }
+            catch { }
+        }
+        title = title.replaceAll('_', ' ').trim();
+        if (title.startsWith(':')) {
+            namespace = '';
+            title = title.slice(1).trim();
+        }
+        const iw = defaultNs ? undefined : Parser.isInterwiki(title, config);
+        if (iw) {
+            this.interwiki = iw[1].toLowerCase();
+            title = title.slice(iw[0].length);
+        }
+        const m = title.split(':');
+        if (m.length > 1) {
+            const ns = nsid[m[0].trim().toLowerCase()], id = ns === undefined ? undefined : namespaces[ns];
+            if (id !== undefined) {
+                namespace = id;
+                title = m.slice(1).join(':').trim();
+            }
+        }
+        this.ns = nsid[namespace.toLowerCase()];
+        const i = title.indexOf('#');
+        let fragment;
+        if (i !== -1) {
+            fragment = title.slice(i + 1).trimEnd();
+            if (fragment.includes('%')) {
+                try {
+                    fragment = decodeURIComponent(fragment);
+                }
+                catch { }
+            }
+            else if (fragment.includes('.')) {
+                try {
+                    fragment = decodeURIComponent(fragment.replaceAll('.', '%'));
+                }
+                catch { }
+            }
+            title = title.slice(0, i).trim();
+        }
+        this.valid = Boolean(title || selfLink && fragment !== undefined || this.interwiki)
+            && !/\0\d+[eh!+-]\x7F|[<>[\]{}|]|%[\da-f]{2}/iu.test(title);
+        this.fragment = fragment;
+        this.main = title && `${title[0].toUpperCase()}${title.slice(1)}`;
+        this.prefix = `${namespace}${namespace && ':'}`;
+    }
+    /** 完整链接 */
+    toString() {
+        return `${this.title}${this.fragment === undefined ? '' : `#${this.fragment}`}`;
+    }
+    /**
+     * 转换
+     * @param conversionTable 单向转换表
+     */
+    autoConvert() {
+        const { conversionTable } = this;
+        if (conversionTable.size > 0) {
+            const regex = new RegExp([...conversionTable.keys()].sort().reverse().map(string_1.escapeRegExp).join('|'), 'gu');
+            this.main = this.main.replace(regex, p => conversionTable.get(p));
+        }
+    }
+}
+Parser.classes['Title'] = __filename;
+module.exports = Title;

package/dist/mixin/attributesParent.js

@@ -0,0 +1,90 @@
+"use strict";
+const Parser = require("../index");
+/**
+ * 子节点含有AttributesToken的类
+ * @param constructor 基类
+ * @param i AttributesToken子节点的位置
+ */
+const attributesParent = (constructor, i = 0) => {
+    /** 子节点含有AttributesToken的类 */
+    class AttributesParent extends constructor {
+        /** AttributesToken子节点 */
+        get #attributesChild() {
+            return this.childNodes.at(i);
+        }
+        /** getAttrs()方法的getter写法 */
+        get attributes() {
+            return this.#attributesChild.attributes;
+        }
+        /** 以字符串表示的class属性 */
+        get className() {
+            return this.#attributesChild.className;
+        }
+        set className(className) {
+            this.#attributesChild.className = className;
+        }
+        /** 以Set表示的class属性 */
+        get classList() {
+            return this.#attributesChild.classList;
+        }
+        /** id属性 */
+        get id() {
+            return this.#attributesChild.id;
+        }
+        set id(id) {
+            this.#attributesChild.id = id;
+        }
+        /**
+         * AttributesToken子节点是否具有某属性
+         * @param key 属性键
+         */
+        hasAttr(key) {
+            return this.#attributesChild.hasAttr(key);
+        }
+        /**
+         * 获取AttributesToken子节点的属性
+         * @param key 属性键
+         */
+        getAttr(key) {
+            return this.#attributesChild.getAttr(key);
+        }
+        /** 列举AttributesToken子节点的属性键 */
+        getAttrNames() {
+            return this.#attributesChild.getAttrNames();
+        }
+        /** AttributesToken子节点是否具有任意属性 */
+        hasAttrs() {
+            return this.#attributesChild.hasAttrs();
+        }
+        /** 获取AttributesToken子节点的全部标签属性 */
+        getAttrs() {
+            return this.#attributesChild.getAttrs();
+        }
+        /**
+         * 对AttributesToken子节点设置属性
+         * @param key 属性键
+         * @param value 属性值
+         */
+        setAttr(key, value) {
+            this.#attributesChild.setAttr(key, value);
+        }
+        /**
+         * 移除AttributesToken子节点的某属性
+         * @param key 属性键
+         */
+        removeAttr(key) {
+            this.#attributesChild.removeAttr(key);
+        }
+        /**
+         * 开关AttributesToken子节点的某属性
+         * @param key 属性键
+         * @param force 强制开启或关闭
+         */
+        toggleAttr(key, force) {
+            this.#attributesChild.toggleAttr(key, force);
+        }
+    }
+    return AttributesParent;
+};
+Parser.mixins['attributesParent'] = __filename;
+module.exports = attributesParent;

package/dist/mixin/fixed.js

@@ -0,0 +1,29 @@
+"use strict";
+const Parser = require("../index");
+/**
+ * 不可增删子节点的类
+ * @param constructor 基类
+ */
+const fixed = (constructor) => {
+    /** 不可增删子节点的类 */
+    class FixedToken extends constructor {
+        static fixed = true;
+        /**
+         * @override
+         * @throws `Error`
+         */
+        removeAt() {
+            throw new Error(`${this.constructor.name} 不可删除元素！`);
+        }
+        /** @ignore */
+        insertAt(token, i = this.length) {
+            if (Parser.running) {
+                return super.insertAt(token, i);
+            }
+            throw new Error(`${this.constructor.name} 不可插入元素！`);
+        }
+    }
+    return FixedToken;
+};
+Parser.mixins['fixed'] = __filename;
+module.exports = fixed;

package/dist/mixin/hidden.js

@@ -0,0 +1,19 @@
+"use strict";
+const Parser = require("../index");
+/**
+ * 解析后不可见的类
+ * @param constructor 基类
+ */
+const hidden = (constructor) => {
+    /** 解析后不可见的类 */
+    class AnyHiddenToken extends constructor {
+        static hidden = true;
+        /** 没有可见部分 */
+        text() {
+            return '';
+        }
+    }
+    return AnyHiddenToken;
+};
+Parser.mixins['hidden'] = __filename;
+module.exports = hidden;

package/dist/mixin/singleLine.js

@@ -0,0 +1,23 @@
+"use strict";
+const Parser = require("../index");
+/**
+ * 不可包含换行符的类
+ * @param constructor 基类
+ */
+const singleLine = (constructor) => {
+    /** 不可包含换行符的类 */
+    class SingleLineToken extends constructor {
+        /** @override */
+        toString(selector) {
+            return super.toString(selector).replaceAll('\n', ' ');
+        }
+        /** @override */
+        text() {
+            return super.text().replaceAll('\n', ' ');
+        }
+    }
+    Object.defineProperty(SingleLineToken, 'name', { value: `SingleLine${constructor.name}` });
+    return SingleLineToken;
+};
+Parser.mixins['singleLine'] = __filename;
+module.exports = singleLine;

package/dist/mixin/sol.js

@@ -0,0 +1,41 @@
+"use strict";
+const Parser = require("../index");
+/**
+ * 只能位于行首的类
+ * @param constructor 基类
+ */
+const sol = (constructor) => {
+    /** 只能位于行首的类 */
+    class SolToken extends constructor {
+        /** 是否可以视为root节点 */
+        #isRoot() {
+            const { parentNode, type } = this;
+            return parentNode?.type === 'root'
+                || type !== 'heading' && parentNode?.type === 'ext-inner' && parentNode.name === 'poem';
+        }
+        /** 在前方插入newline */
+        prependNewLine() {
+            const { previousVisibleSibling } = this;
+            return (previousVisibleSibling ?? !this.#isRoot()) && !String(previousVisibleSibling).endsWith('\n')
+                ? '\n'
+                : '';
+        }
+        /** @override */
+        toString(selector) {
+            return selector && this.matches(selector)
+                ? ''
+                : `${this.prependNewLine()}${super.toString(selector)}`;
+        }
+        /** @override */
+        getPadding() {
+            return this.prependNewLine().length;
+        }
+        /** @override */
+        text() {
+            return `${this.prependNewLine()}${super.text()}`;
+        }
+    }
+    return SolToken;
+};
+Parser.mixins['sol'] = __filename;
+module.exports = sol;