wikiparser-node 0.11.0 → 1.0.0-beta.1

package/dist/src/attribute.js

@@ -0,0 +1,433 @@
+"use strict";
+const lint_1 = require("../util/lint");
+const string_1 = require("../util/string");
+const fixed = require("../mixin/fixed");
+const Parser = require("../index");
+const Token = require(".");
+const AtomToken = require("./atom");
+const stages = { 'ext-attr': 0, 'html-attr': 2, 'table-attr': 3 }, pre = { 'ext-attr': '<pre ', 'html-attr': '<p ', 'table-attr': '{|' }, post = { 'ext-attr': '/>', 'html-attr': '>', 'table-attr': '' }, commonHtmlAttrs = new Set([
+    'id',
+    'class',
+    'style',
+    'lang',
+    'dir',
+    'title',
+    'tabindex',
+    'aria-describedby',
+    'aria-flowto',
+    'aria-hidden',
+    'aria-label',
+    'aria-labelledby',
+    'aria-owns',
+    'role',
+    'about',
+    'property',
+    'resource',
+    'datatype',
+    'typeof',
+    'itemid',
+    'itemprop',
+    'itemref',
+    'itemscope',
+    'itemtype',
+]), blockAttrs = new Set(['align']), citeAttrs = new Set(['cite']), citeAndAttrs = new Set(['cite', 'datetime']), widthAttrs = new Set(['width']), tdAttrs = new Set(['align', 'valign', 'abbr', 'axis', 'headers', 'scope', 'rowspan', 'colspan', 'width', 'height', 'bgcolor']), typeAttrs = new Set(['type']), htmlAttrs = {
+    div: blockAttrs,
+    h1: blockAttrs,
+    h2: blockAttrs,
+    h3: blockAttrs,
+    h4: blockAttrs,
+    h5: blockAttrs,
+    h6: blockAttrs,
+    blockquote: citeAttrs,
+    q: citeAttrs,
+    p: blockAttrs,
+    br: new Set(['clear']),
+    pre: widthAttrs,
+    ins: citeAndAttrs,
+    del: citeAndAttrs,
+    ul: typeAttrs,
+    ol: new Set(['type', 'start', 'reversed']),
+    li: new Set(['type', 'value']),
+    table: new Set(['summary', 'width', 'border', 'frame', 'rules', 'cellspacing', 'cellpadding', 'align', 'bgcolor']),
+    caption: blockAttrs,
+    tr: new Set(['bgcolor', 'align', 'valign']),
+    td: tdAttrs,
+    th: tdAttrs,
+    img: new Set(['alt', 'src', 'width', 'height', 'srcset']),
+    font: new Set(['size', 'color', 'face']),
+    hr: widthAttrs,
+    rt: new Set(['rbspan']),
+    data: new Set(['value']),
+    time: new Set(['datetime']),
+    meta: new Set(['itemprop', 'content']),
+    link: new Set(['itemprop', 'href', 'title']),
+    gallery: new Set(['mode', 'showfilename', 'caption', 'perrow', 'widths', 'heights', 'showthumbnails', 'type']),
+    poem: new Set(['compact', 'align']),
+    categorytree: new Set([
+        'align',
+        'hideroot',
+        'onlyroot',
+        'depth',
+        'mode',
+        'hideprefix',
+        'namespaces',
+        'showcount',
+        'notranslations',
+    ]),
+    combooption: new Set(['name', 'for', 'inline', 'align']),
+}, empty = new Set(), extAttrs = {
+    nowiki: empty,
+    indicator: new Set(['name']),
+    langconvert: new Set(['from', 'to']),
+    ref: new Set(['group', 'name', 'extends', 'follow', 'dir']),
+    references: new Set(['group', 'responsive']),
+    charinsert: new Set(['label']),
+    choose: new Set(['uncached', 'before', 'after']),
+    option: new Set(['weight']),
+    imagemap: empty,
+    inputbox: empty,
+    templatestyles: new Set(['src', 'wrapper']),
+    dynamicpagelist: empty,
+    poll: new Set(['id', 'show-results-before-voting']),
+    sm2: typeAttrs,
+    flashmp3: typeAttrs,
+    score: new Set([
+        'line_width_inches',
+        'lang',
+        'override_midi',
+        'raw',
+        'note-language',
+        'override_audio',
+        'override_ogg',
+        'sound',
+        'vorbis',
+    ]),
+    seo: new Set([
+        'title',
+        'title_mode',
+        'title_separator',
+        'keywords',
+        'description',
+        'robots',
+        'google_bot',
+        'image',
+        'image_width',
+        'image_height',
+        'image_alt',
+        'type',
+        'site_name',
+        'locale',
+        'section',
+        'author',
+        'published_time',
+        'twitter_site',
+    ]),
+    tab: new Set([
+        'nested',
+        'name',
+        'index',
+        'class',
+        'block',
+        'inline',
+        'openname',
+        'closename',
+        'collapsed',
+        'dropdown',
+        'style',
+        'bgcolor',
+        'container',
+        'id',
+        'title',
+    ]),
+    tabs: new Set(['plain', 'class', 'container', 'id', 'title', 'style']),
+    combobox: new Set(['placeholder', 'value', 'id', 'class', 'text', 'dropdown', 'style']),
+}, insecureStyle = new RegExp(`${'expression'}|${'(?:filter|accelerator|-o-link(?:-source)?|-o-replace)\\s*:'}|${'(?:url|image(?:-set)?)\\s*\\('}|${'attr\\s*\\([^)]+[\\s,]url'}`, 'u');
+/**
+ * 扩展和HTML标签属性
+ * @classdesc `{childNodes: [AtomToken, Token|AtomToken]}`
+ */
+class AttributeToken extends fixed(Token) {
+    /** @browser */
+    #equal;
+    /** @browser */
+    #quotes;
+    /** @browser */
+    #tag;
+    /**
+     * 引号是否匹配
+     * @browser
+     */
+    get balanced() {
+        return !this.#equal || this.#quotes[0] === this.#quotes[1];
+    }
+    /**
+     * 标签名
+     * @browser
+     */
+    get tag() {
+        return this.#tag;
+    }
+    /**
+     * getValue()的getter
+     * @browser
+     */
+    get value() {
+        return this.getValue();
+    }
+    set value(value) {
+        this.setValue(value);
+    }
+    /**
+     * @browser
+     * @param type 标签类型
+     * @param tag 标签名
+     * @param key 属性名
+     * @param equal 等号
+     * @param value 属性值
+     * @param quotes 引号
+     */
+    constructor(type, tag, key, equal = '', value = '', quotes = [], config = Parser.getConfig(), accum = []) {
+        const keyToken = new AtomToken(key, 'attr-key', config, accum, {
+            [type === 'ext-attr' ? 'AstText' : 'Stage-1']: ':', ArgToken: ':', TranscludeToken: ':',
+        });
+        let valueToken;
+        if (key === 'title') {
+            valueToken = new Token(value, config, true, accum, {
+                [`Stage-${stages[type]}`]: ':', ConverterToken: ':',
+            });
+            valueToken.type = 'attr-value';
+            valueToken.setAttribute('stage', Parser.MAX_STAGE - 1);
+        }
+        else if (tag === 'gallery' && key === 'caption') {
+            const newConfig = { ...config, excludes: [...config.excludes, 'quote', 'extLink', 'magicLink', 'list'] };
+            valueToken = new Token(value, newConfig, true, accum, {
+                AstText: ':', LinkToken: ':', FileToken: ':', CategoryToken: ':', ConverterToken: ':',
+            });
+            valueToken.type = 'attr-value';
+            valueToken.setAttribute('stage', 5);
+        }
+        else if (tag === 'choose' && (key === 'before' || key === 'after')) {
+            const newConfig = { ...config, excludes: [...config.excludes, 'heading', 'html', 'table', 'hr', 'list'] };
+            valueToken = new Token(value, newConfig, true, accum, {
+                ArgToken: ':',
+                TranscludeToken: ':',
+                LinkToken: ':',
+                FileToken: ':',
+                CategoryToken: ':',
+                QuoteToken: ':',
+                ExtLinkToken: ':',
+                MagicLinkToken: ':',
+                ConverterToken: ':',
+            });
+            valueToken.type = 'attr-value';
+            valueToken.setAttribute('stage', 1);
+        }
+        else {
+            valueToken = new AtomToken(value, 'attr-value', config, accum, {
+                [`Stage-${stages[type]}`]: ':',
+            });
+        }
+        super(undefined, config, true, accum);
+        this.type = type;
+        this.append(keyToken, valueToken);
+        this.#equal = equal;
+        this.#quotes = quotes;
+        this.#tag = tag;
+        this.setAttribute('name', (0, string_1.removeComment)(key).trim().toLowerCase());
+    }
+    /** @private */
+    afterBuild() {
+        if (this.#equal.includes('\0')) {
+            this.#equal = this.buildFromStr(this.#equal, 'string');
+        }
+        if (this.parentNode) {
+            this.#tag = this.parentNode.name;
+        }
+        this.setAttribute('name', this.firstChild.text().trim().toLowerCase());
+    }
+    /**
+     * @override
+     * @browser
+     */
+    toString(selector) {
+        if (selector && this.matches(selector)) {
+            return '';
+        }
+        const [quoteStart = '', quoteEnd = ''] = this.#quotes;
+        return this.#equal
+            ? `${super.toString(selector, `${this.#equal}${quoteStart}`)}${quoteEnd}`
+            : this.firstChild.toString(selector);
+    }
+    /**
+     * @override
+     * @browser
+     */
+    text() {
+        return this.#equal ? `${super.text(`${this.#equal.trim()}"`)}"` : this.firstChild.text();
+    }
+    /** @private */
+    getGaps() {
+        return this.#equal ? this.#equal.length + (this.#quotes[0]?.length ?? 0) : 0;
+    }
+    /**
+     * @override
+     * @browser
+     */
+    print() {
+        const [quoteStart = '', quoteEnd = ''] = this.#quotes;
+        return this.#equal ? super.print({ sep: `${this.#equal}${quoteStart}`, post: quoteEnd }) : super.print();
+    }
+    /**
+     * @override
+     * @browser
+     */
+    lint(start = this.getAbsoluteIndex()) {
+        const errors = super.lint(start), { balanced, firstChild, lastChild, type, name, value } = this, tag = this.#tag;
+        let rect;
+        if (!balanced) {
+            const root = this.getRootNode();
+            rect = { start, ...root.posFromIndex(start) };
+            const e = (0, lint_1.generateForChild)(lastChild, rect, 'unclosed quotes', 'warning'), startIndex = e.startIndex - 1, startCol = e.startCol - 1;
+            errors.push({ ...e, startIndex, startCol, excerpt: String(root).slice(startIndex, startIndex + 50) });
+        }
+        if (extAttrs[tag] && !extAttrs[tag].has(name)
+            || (type !== 'ext-attr' && !/\{\{[^{]+\}\}/u.test(name) || tag in htmlAttrs)
+                && !htmlAttrs[tag]?.has(name) && !/^(?:xmlns:[\w:.-]+|data-[^:]*)$/u.test(name)
+                && (tag === 'meta' || tag === 'link' || !commonHtmlAttrs.has(name))) {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForChild)(firstChild, rect, 'illegal attribute name'));
+        }
+        else if (name === 'style' && typeof value === 'string' && insecureStyle.test(value)) {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForChild)(lastChild, rect, 'insecure style'));
+        }
+        else if (name === 'tabindex' && typeof value === 'string' && value.trim() !== '0') {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForChild)(lastChild, rect, 'nonzero tabindex'));
+        }
+        return errors;
+    }
+    /**
+     * 获取属性值
+     * @browser
+     */
+    getValue() {
+        if (this.#equal) {
+            const value = this.lastChild.text();
+            if (this.#quotes[1]) {
+                return value;
+            }
+            return this.#quotes[0] ? value.trimEnd() : value.trim();
+        }
+        return this.type === 'ext-attr' || '';
+    }
+    /** @private */
+    getAttribute(key) {
+        if (key === 'equal') {
+            return this.#equal;
+        }
+        return key === 'quotes' ? this.#quotes : super.getAttribute(key);
+    }
+    /** @private */
+    hasAttribute(key) {
+        return key === 'equal' || key === 'quotes' || super.hasAttribute(key);
+    }
+    /** @override */
+    cloneNode() {
+        const [key, value] = this.cloneChildNodes(), config = this.getAttribute('config');
+        return Parser.run(() => {
+            const token = new AttributeToken(this.type, this.#tag, '', this.#equal, '', this.#quotes, config);
+            token.firstChild.safeReplaceWith(key);
+            token.lastChild.safeReplaceWith(value);
+            token.afterBuild();
+            return token;
+        });
+    }
+    /** 转义等号 */
+    escape() {
+        this.#equal = '{{=}}';
+    }
+    /** 闭合引号 */
+    close() {
+        const [opening] = this.#quotes;
+        if (opening) {
+            this.#quotes[1] = opening;
+        }
+    }
+    /**
+     * 设置属性值
+     * @param value 参数值
+     * @throws `SyntaxError` 非法的标签属性
+     */
+    setValue(value) {
+        if (value === false) {
+            this.remove();
+            return;
+        }
+        else if (value === true) {
+            this.#equal = '';
+            return;
+        }
+        const { type } = this, key = this.name === 'title' ? 'title' : 'data', wikitext = `${pre[type]}${key}="${value}"${post[type]}`, root = Parser.parse(wikitext, this.getAttribute('include'), stages[type] + 1, this.getAttribute('config')), { length, firstChild: tag } = root;
+        let attrs;
+        if (length !== 1 || tag.type !== type.slice(0, -5)) {
+            throw new SyntaxError(`非法的标签属性：${(0, string_1.noWrap)(value)}`);
+        }
+        else if (type === 'table-attr') {
+            if (tag.length !== 2) {
+                throw new SyntaxError(`非法的标签属性：${(0, string_1.noWrap)(value)}`);
+            }
+            attrs = tag.lastChild;
+        }
+        else {
+            attrs = tag.firstChild;
+        }
+        const { firstChild } = attrs;
+        if (attrs.length !== 1 || firstChild.type !== this.type || firstChild.name !== key) {
+            throw new SyntaxError(`非法的标签属性：${(0, string_1.noWrap)(value)}`);
+        }
+        const { lastChild } = firstChild;
+        firstChild.destroy();
+        this.lastChild.safeReplaceWith(lastChild);
+        if (this.#quotes[0]) {
+            this.close();
+        }
+        else {
+            this.#quotes = ['"', '"'];
+        }
+    }
+    /**
+     * 修改属性名
+     * @param key 新属性名
+     * @throws `Error` title属性不能更名
+     * @throws `SyntaxError` 非法的模板参数名
+     */
+    rename(key) {
+        if (this.name === 'title') {
+            throw new Error('title 属性不能更名！');
+        }
+        const { type } = this, wikitext = `${pre[type]}${key}${post[type]}`, root = Parser.parse(wikitext, this.getAttribute('include'), stages[type] + 1, this.getAttribute('config')), { length, firstChild: tag } = root;
+        let attrs;
+        if (length !== 1 || tag.type !== type.slice(0, -5)) {
+            throw new SyntaxError(`非法的标签属性名：${(0, string_1.noWrap)(key)}`);
+        }
+        else if (type === 'table-attr') {
+            if (tag.length !== 2) {
+                throw new SyntaxError(`非法的标签属性名：${(0, string_1.noWrap)(key)}`);
+            }
+            attrs = tag.lastChild;
+        }
+        else {
+            attrs = tag.firstChild;
+        }
+        const { firstChild: attr } = attrs;
+        if (attrs.length !== 1 || attr.type !== this.type || attr.value !== true) {
+            throw new SyntaxError(`非法的标签属性名：${(0, string_1.noWrap)(key)}`);
+        }
+        const { firstChild } = attr;
+        attr.destroy();
+        this.firstChild.safeReplaceWith(firstChild);
+    }
+}
+Parser.classes['AttributeToken'] = __filename;
+module.exports = AttributeToken;

package/dist/src/attributes.d.ts

@@ -1,112 +1,118 @@
-export = AttributesToken;
+import * as Parser from '../index';
+import Token = require('.');
+import AtomToken = require('./atom');
+import AttributeToken = require('./attribute');
+declare type AttributesTypes = 'ext-attrs' | 'html-attrs' | 'table-attrs';
 /**
  * 扩展和HTML标签属性
  * @classdesc `{childNodes: ...AtomToken|AttributeToken}`
  */
-declare class AttributesToken extends Token {
-    /**
-     * @param {string} attr 标签属性
-     * @param {'ext-attrs'|'html-attrs'|'table-attrs'} type 标签类型
-     * @param {string} name 标签名
-     * @param {import('../../typings/token').accum} accum
-     */
-    constructor(attr: string, type: 'ext-attrs' | 'html-attrs' | 'table-attrs', name: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+declare abstract class AttributesToken extends Token {
+    #private;
+    type: AttributesTypes;
+    name: string;
+    childNodes: (AtomToken | AttributeToken)[];
+    abstract get children(): (AtomToken | AttributeToken)[];
+    abstract get firstChild(): AtomToken | AttributeToken;
+    abstract get firstElementChild(): AtomToken | AttributeToken;
+    abstract get lastChild(): AtomToken | AttributeToken;
+    abstract get lastElementChild(): AtomToken | AttributeToken;
+    abstract get parentNode(): import('./tagPair/ext') | import('./html') | import('./table/base') | undefined;
+    abstract get parentElement(): import('./tagPair/ext') | import('./html') | import('./table/base') | undefined;
     /** getAttrs()方法的getter写法 */
-    get attributes(): {
-        [k: string]: string | boolean;
-    };
-    set className(arg: string);
+    get attributes(): Record<string, string | true>;
     /** 以字符串表示的class属性 */
     get className(): string;
+    set className(className: string);
     /** 以Set表示的class属性 */
     get classList(): Set<string>;
-    set id(arg: string);
     /** id属性 */
     get id(): string;
+    set id(id: string);
     /** 是否含有无效属性 */
     get sanitized(): boolean;
-    type: "ext-attrs" | "html-attrs" | "table-attrs";
+    /**
+     * @browser
+     * @param attr 标签属性
+     * @param type 标签类型
+     * @param name 标签名
+     */
+    constructor(attr: string | undefined, type: AttributesTypes, name: string, config?: Parser.Config, accum?: Token[]);
     /**
      * 所有指定属性名的AttributeToken
-     * @param {string} key 属性名
-     * @returns {AttributeToken[]}
+     * @browser
+     * @param key 属性名
      */
     getAttrTokens(key: string): AttributeToken[];
     /**
-     * 制定属性名的最后一个AttributeToken
-     * @param {string} key 属性名
+     * 指定属性名的最后一个AttributeToken
+     * @browser
+     * @param key 属性名
      */
-    getAttrToken(key: string): AttributeToken;
+    getAttrToken(key: string): AttributeToken | undefined;
     /**
      * 获取标签属性
-     * @param {string} key 属性键
+     * @browser
+     * @param key 属性键
+     */
+    getAttr(key: string): string | true | undefined;
+    /**
+     * @override
+     * @browser
      */
-    getAttr(key: string): string | true;
+    lint(start?: number): Parser.LintError[];
     /**
      * @override
-     * @this {AttributesToken & {parentNode: HtmlToken}}
+     * @browser
      */
-    override print(this: AttributesToken & {
-        parentNode: import("./html");
-    }): string;
+    print(): string;
     /** 清理标签属性 */
     sanitize(): void;
     /** @override */
-    override cloneNode(): AttributesToken;
-    /**
-     * 所有无效属性
-     * @returns {AtomToken[]}
-     */
+    cloneNode(): this;
+    /** 所有无效属性 */
     getDirtyAttrs(): AtomToken[];
     /**
      * @override
-     * @param {AttributeToken} token 待插入的子节点
-     * @param {number} i 插入位置
+     * @param token 待插入的子节点
+     * @param i 插入位置
      * @throws `RangeError` 不是AttributeToken或标签不匹配
      */
-    override insertAt(token: AttributeToken, i?: number): AttributeToken;
+    insertAt<T extends AttributeToken>(token: T, i?: number): T;
     /**
      * 设置标签属性
-     * @param {string} key 属性键
-     * @param {string|boolean} value 属性值
+     * @param key 属性键
+     * @param value 属性值
      * @throws `RangeError` 扩展标签属性不能包含">"
      * @throws `RangeError` 无效的属性名
      */
     setAttr(key: string, value: string | boolean): void;
     /**
      * 标签是否具有某属性
-     * @param {string} key 属性键
+     * @param key 属性键
      */
     hasAttr(key: string): boolean;
     /** 获取全部的标签属性名 */
-    getAttrNames(): Set<any>;
+    getAttrNames(): Set<string>;
     /** 标签是否具有任意属性 */
     hasAttrs(): boolean;
     /** 获取全部标签属性 */
-    getAttrs(): {
-        [k: string]: string | boolean;
-    };
+    getAttrs(): Record<string, string | true>;
     /**
      * 移除标签属性
-     * @param {string} key 属性键
+     * @param key 属性键
      */
     removeAttr(key: string): void;
     /**
      * 开关标签属性
-     * @param {string} key 属性键
-     * @param {boolean|undefined} force 强制开启或关闭
+     * @param key 属性键
+     * @param force 强制开启或关闭
      * @throws `RangeError` 不为Boolean类型的属性值
      */
-    toggleAttr(key: string, force: boolean | undefined): void;
-    /**
-     * @override
-     * @param {string} selector
-     */
-    override toString(selector: string): string;
+    toggleAttr(key: string, force?: boolean): void;
     /** @override */
-    override text(): string;
-    #private;
+    toString(selector?: string): string;
+    /** @override */
+    text(): string;
 }
-import Token = require(".");
-import AttributeToken = require("./attribute");
-import AtomToken = require("./atom");
+export = AttributesToken;