wikiparser-node 1.5.2-b → 1.5.2

package/dist/src/attribute.js

@@ -0,0 +1,502 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttributeToken = void 0;
+const lint_1 = require("../util/lint");
+const string_1 = require("../util/string");
+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");
+const atom_1 = require("./atom");
+/* NOT FOR BROWSER */
+const stages = { 'ext-attr': 0, 'html-attr': 2, 'table-attr': 3 };
+/* NOT FOR BROWSER END */
+const commonHtmlAttrs = new Set([
+    'id',
+    'class',
+    'style',
+    'lang',
+    'dir',
+    'title',
+    'tabindex',
+    'aria-describedby',
+    'aria-flowto',
+    'aria-hidden',
+    'aria-label',
+    'aria-labelledby',
+    'aria-level',
+    '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']), obsoleteTdAttrs = new Set(['axis', 'align', 'bgcolor', 'height', 'width', 'valign']), tdAttrs = new Set([...obsoleteTdAttrs, 'abbr', 'headers', 'scope', 'rowspan', 'colspan']), typeAttrs = new Set(['type']), obsoleteTableAttrs = new Set(['summary', 'align', 'bgcolor', 'cellpadding', 'cellspacing', 'frame', 'rules', 'width']), brAttrs = new Set(['clear']), trAttrs = new Set(['bgcolor', 'align', 'valign']), htmlAttrs = {
+    div: blockAttrs,
+    h1: blockAttrs,
+    h2: blockAttrs,
+    h3: blockAttrs,
+    h4: blockAttrs,
+    h5: blockAttrs,
+    h6: blockAttrs,
+    blockquote: citeAttrs,
+    q: citeAttrs,
+    p: blockAttrs,
+    br: brAttrs,
+    pre: widthAttrs,
+    ins: citeAndAttrs,
+    del: citeAndAttrs,
+    ul: typeAttrs,
+    ol: new Set(['type', 'start', 'reversed']),
+    li: new Set(['type', 'value']),
+    table: new Set([...obsoleteTableAttrs, 'border']),
+    caption: blockAttrs,
+    tr: trAttrs,
+    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'
+    + '|'
+    + '(?:accelerator|-o-link(?:-source)?|-o-replace)\\s*:'
+    + '|'
+    + '(?:url|image(?:-set)?)\\s*\\('
+    + '|'
+    + 'attr\\s*\\([^)]+[\\s,]url', 'u'), obsoleteAttrs = {
+    table: obsoleteTableAttrs,
+    td: new Set([...obsoleteTdAttrs, 'scope']),
+    th: obsoleteTdAttrs,
+    br: brAttrs,
+    caption: blockAttrs,
+    div: blockAttrs,
+    hr: widthAttrs,
+    h1: blockAttrs,
+    h2: blockAttrs,
+    h3: blockAttrs,
+    h4: blockAttrs,
+    h5: blockAttrs,
+    h6: blockAttrs,
+    li: typeAttrs,
+    p: blockAttrs,
+    pre: widthAttrs,
+    tr: trAttrs,
+    ul: typeAttrs,
+};
+/**
+ * 扩展和HTML标签属性
+ * @classdesc `{childNodes: [AtomToken, Token|AtomToken]}`
+ */
+let AttributeToken = (() => {
+    let _classDecorators = [fixed_1.fixedToken];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    let _classSuper = index_2.Token;
+    var AttributeToken = class extends _classSuper {
+        static { _classThis = this; }
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+            AttributeToken = _classThis = _classDescriptor.value;
+            if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+            __runInitializers(_classThis, _classExtraInitializers);
+        }
+        #tag;
+        #equal;
+        #quotes;
+        /* NOT FOR BROWSER END */
+        /** 标签名 */
+        get tag() {
+            return this.#tag;
+        }
+        /** 引号是否匹配 */
+        get balanced() {
+            return !this.#equal || this.#quotes[0] === this.#quotes[1];
+        }
+        /* NOT FOR BROWSER */
+        set balanced(value) {
+            if (value) {
+                this.close();
+            }
+        }
+        /** getValue()的getter */
+        get value() {
+            return this.getValue();
+        }
+        set value(value) {
+            this.setValue(value);
+        }
+        /* NOT FOR BROWSER END */
+        /**
+         * @param type 标签类型
+         * @param tag 标签名
+         * @param key 属性名
+         * @param equal 等号
+         * @param value 属性值
+         * @param quotes 引号
+         */
+        constructor(type, tag, key, equal = '', value, quotes = [], config = index_1.default.getConfig(), accum = []) {
+            const keyToken = new atom_1.AtomToken(key, 'attr-key', config, accum, {
+                [type === 'ext-attr' ? 'AstText' : 'Stage-1']: ':', ArgToken: ':', TranscludeToken: ':',
+            });
+            let valueToken;
+            if (key === 'title' || tag === 'img' && key === 'alt') {
+                valueToken = new index_2.Token(value, config, accum, {
+                    [`Stage-${stages[type]}`]: ':', ConverterToken: ':',
+                });
+                valueToken.type = 'attr-value';
+                valueToken.setAttribute('stage', constants_1.MAX_STAGE - 1);
+            }
+            else if (tag === 'gallery' && key === 'caption') {
+                const newConfig = {
+                    ...config,
+                    excludes: [...config.excludes, 'quote', 'extLink', 'magicLink', 'list'],
+                };
+                valueToken = new index_2.Token(value, newConfig, 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 index_2.Token(value, newConfig, accum, {
+                    ArgToken: ':',
+                    TranscludeToken: ':',
+                    LinkToken: ':',
+                    FileToken: ':',
+                    CategoryToken: ':',
+                    QuoteToken: ':',
+                    ExtLinkToken: ':',
+                    MagicLinkToken: ':',
+                    ConverterToken: ':',
+                });
+                valueToken.type = 'attr-value';
+                valueToken.setAttribute('stage', 1);
+            }
+            else {
+                valueToken = new atom_1.AtomToken(value, 'attr-value', config, accum, {
+                    [`Stage-${stages[type]}`]: ':',
+                });
+            }
+            super(undefined, config, 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, constants_1.BuildMethod.String);
+            }
+            if (this.parentNode) {
+                this.#tag = this.parentNode.name;
+            }
+            this.setAttribute('name', this.firstChild.text().trim().toLowerCase());
+        }
+        /** @private */
+        toString() {
+            const [quoteStart = '', quoteEnd = ''] = this.#quotes;
+            return this.#equal ? `${super.toString(`${this.#equal}${quoteStart}`)}${quoteEnd}` : String(this.firstChild);
+        }
+        /** @override */
+        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 */
+        lint(start = this.getAbsoluteIndex()) {
+            const errors = super.lint(start), { balanced, firstChild, lastChild, type, name, tag } = this, value = this.getValue();
+            let rect;
+            if (!balanced) {
+                const root = this.getRootNode();
+                rect = { start, ...root.posFromIndex(start) };
+                const e = (0, lint_1.generateForChild)(lastChild, rect, 'unclosed-quote', index_1.default.msg('unclosed $1', 'quotes'), 'warning');
+                e.startIndex--;
+                e.startCol--;
+                const fix = {
+                    range: [e.endIndex, e.endIndex],
+                    text: this.#quotes[0],
+                };
+                if (lastChild.childNodes.some(child => child.type === 'text' && /\s/u.test(child.text()))) {
+                    e.suggestions = [
+                        {
+                            desc: 'close',
+                            ...fix,
+                        },
+                    ];
+                }
+                else {
+                    e.fix = fix;
+                }
+                errors.push(e);
+            }
+            const attrs = extAttrs[tag];
+            if (attrs && !attrs.has(name)
+                || (type === 'ext-attr' ? tag in htmlAttrs : !/\{\{[^{]+\}\}/u.test(name))
+                    && !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-attr', 'illegal attribute name'));
+            }
+            else if (obsoleteAttrs[tag]?.has(name)) {
+                rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+                errors.push((0, lint_1.generateForChild)(firstChild, rect, 'obsolete-attr', 'obsolete attribute', 'warning'));
+            }
+            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', 'insecure style'));
+            }
+            else if (name === 'tabindex' && typeof value === 'string' && value.trim() !== '0') {
+                rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+                const e = (0, lint_1.generateForChild)(lastChild, rect, 'illegal-attr', 'nonzero tabindex');
+                e.suggestions = [
+                    {
+                        desc: 'remove',
+                        range: [start, e.endIndex],
+                        text: '',
+                    },
+                    {
+                        desc: '0 tabindex',
+                        range: [e.startIndex, e.endIndex],
+                        text: '0',
+                    },
+                ];
+                errors.push(e);
+            }
+            return errors;
+        }
+        /** 获取属性值 */
+        getValue() {
+            if (this.#equal) {
+                const value = this.lastChild.text();
+                if (this.#quotes[1]) {
+                    return value;
+                }
+                return value[this.#quotes[0] ? 'trimEnd' : 'trim']();
+            }
+            return this.type === 'ext-attr' || '';
+        }
+        /** @override */
+        print() {
+            const [quoteStart = '', quoteEnd = ''] = this.#quotes;
+            return this.#equal ? super.print({ sep: `${this.#equal}${quoteStart}`, post: quoteEnd }) : super.print();
+        }
+        /* NOT FOR BROWSER */
+        /** @private */
+        getAttribute(key) {
+            if (key === 'equal') {
+                return this.#equal;
+            }
+            return key === 'quotes' ? this.#quotes : super.getAttribute(key);
+        }
+        /** @override */
+        cloneNode() {
+            const [key, value] = this.cloneChildNodes(), config = this.getAttribute('config');
+            return debug_1.Shadow.run(() => {
+                // @ts-expect-error abstract class
+                const token = new AttributeToken(this.type, this.tag, '', this.#equal, '', this.#quotes, config);
+                token.firstChild.safeReplaceWith(key);
+                token.lastChild.safeReplaceWith(value);
+                token.setAttribute('name', this.name);
+                return token;
+            });
+        }
+        /** 转义等号 */
+        escape() {
+            this.#equal = '{{=}}';
+        }
+        /** 闭合引号 */
+        close() {
+            const [opening] = this.#quotes;
+            if (opening) {
+                this.#quotes[1] = opening;
+            }
+        }
+        /**
+         * 设置属性值
+         * @param value 参数值
+         * @throws `RangeError` 扩展标签属性不能包含 ">"
+         * @throws `RangeError` 同时包含单引号和双引号
+         */
+        setValue(value) {
+            if (value === false) {
+                this.remove();
+                return;
+            }
+            else if (value === true) {
+                this.#equal = '';
+                return;
+            }
+            else if (this.type === 'ext-attr' && value.includes('>')) {
+                throw new RangeError('扩展标签属性不能包含 ">"！');
+            }
+            else if (value.includes('"') && value.includes(`'`)) {
+                throw new RangeError('属性值不能同时包含单引号和双引号！');
+            }
+            const config = this.getAttribute('config'), { childNodes } = index_1.default.parse(value, this.getAttribute('include'), stages[this.type] + 1, config);
+            this.lastChild.replaceChildren(...childNodes);
+            if (value.includes('"')) {
+                this.#quotes = [`'`, `'`];
+            }
+            else if (value.includes(`'`) || !this.#quotes[0]) {
+                this.#quotes = ['"', '"'];
+            }
+            else {
+                this.close();
+            }
+        }
+        /**
+         * 修改属性名
+         * @param key 新属性名
+         * @throws `Error` title和alt属性不能更名
+         */
+        rename(key) {
+            if (this.name === 'title' || this.name === 'alt' && this.tag === 'img') {
+                throw new Error(`${this.name} 属性不能更名！`);
+            }
+            const config = this.getAttribute('config'), { childNodes } = index_1.default.parse(key, this.getAttribute('include'), stages[this.type] + 1, config);
+            this.firstChild.replaceChildren(...childNodes);
+        }
+    };
+    return AttributeToken = _classThis;
+})();
+exports.AttributeToken = AttributeToken;
+constants_1.classes['AttributeToken'] = __filename;

package/dist/src/attributes.d.ts

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