wikiparser-node 1.3.7-b → 1.3.7

package/dist/src/attributes.js

@@ -0,0 +1,343 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttributesToken = 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 Parser = require("../index");
+const index_1 = require("./index");
+const atom_1 = require("./atom");
+const attribute_1 = require("./attribute");
+/* NOT FOR BROWSER */
+const stages = { 'ext-attrs': 0, 'html-attrs': 2, 'table-attrs': 3 };
+/**
+ * 将属性类型转换为单属性类型
+ * @param type 属性类型
+ */
+const toAttributeType = (type) => type.slice(0, -1);
+/**
+ * 将属性类型转换为无效属性类型
+ * @param type 属性类型
+ */
+const toDirty = (type) => `${toAttributeType(type)}-dirty`;
+/**
+ * 扩展和HTML标签属性
+ * @classdesc `{childNodes: ...AtomToken|AttributeToken}`
+ */
+class AttributesToken extends index_1.Token {
+    /* NOT FOR BROWSER */
+    /** getAttrs()方法的getter写法 */
+    get attributes() {
+        return this.getAttrs();
+    }
+    set attributes(attrs) {
+        this.replaceChildren();
+        this.setAttr(attrs);
+    }
+    /** 以字符串表示的class属性 */
+    get className() {
+        const attr = this.getAttr('class');
+        return typeof attr === 'string' ? attr : '';
+    }
+    set className(className) {
+        this.setAttr('class', className || false);
+    }
+    /** 以Set表示的class属性 */
+    get classList() {
+        return new Set(this.className.split(/\s/u));
+    }
+    set classList(classList) {
+        this.setAttr('class', [...classList].join(' '));
+    }
+    /** id属性 */
+    get id() {
+        const attr = this.getAttr('id');
+        return typeof attr === 'string' ? attr : '';
+    }
+    set id(id) {
+        this.setAttr('id', id || false);
+    }
+    /** 是否含有无效属性 */
+    get sanitized() {
+        return this.childNodes.filter(child => child instanceof atom_1.AtomToken && child.text().trim()).length === 0;
+    }
+    set sanitized(sanitized) {
+        if (sanitized) {
+            this.sanitize();
+        }
+    }
+    /* NOT FOR BROWSER END */
+    /**
+     * @param attr 标签属性
+     * @param type 标签类型
+     * @param name 标签名
+     */
+    constructor(attr, type, name, config = Parser.getConfig(), accum = []) {
+        super(undefined, config, accum, {
+            AtomToken: ':', AttributeToken: ':',
+        });
+        this.type = type;
+        this.setAttribute('name', name);
+        if (attr) {
+            const regex = new RegExp('([^\\s/](?:(?!\0\\d+~\x7F)[^\\s/=])*)' // 属性名
+                + `(?:${'((?:\\s|\0\\d+c\x7F)*' // `=`前的空白字符
+                    + '(?:=|\0\\d+~\x7F)' // `=`
+                    + '(?:\\s|\0\\d+c\x7F)*)' // `=`后的空白字符
+                    + `(?:(["'])(.*?)(\\3|$)|(\\S*))` // 属性值
+                })?`, 'gsu');
+            let out = '', mt = regex.exec(attr), lastIndex = 0;
+            const insertDirty = /** 插入无效属性 */ () => {
+                if (out) {
+                    super.insertAt(new atom_1.AtomToken(out, toDirty(type), config, accum, {
+                        [`Stage-${stages[type]}`]: ':',
+                    }));
+                    out = '';
+                }
+            };
+            while (mt) {
+                const { index, 0: full, 1: key, 2: equal, 3: quoteStart, 4: quoted, 5: quoteEnd, 6: unquoted } = mt;
+                out += attr.slice(lastIndex, index);
+                if (/^(?:[\w:]|\0\d+[t!~{}+-]\x7F)(?:[\w:.-]|\0\d+[t!~{}+-]\x7F)*$/u.test((0, string_1.removeComment)(key).trim())) {
+                    const value = quoted ?? unquoted, quotes = [quoteStart, quoteEnd], token = new attribute_1.AttributeToken(toAttributeType(type), name, key, equal, value, quotes, config, accum);
+                    insertDirty();
+                    super.insertAt(token);
+                }
+                else {
+                    out += full;
+                }
+                ({ lastIndex } = regex);
+                mt = regex.exec(attr);
+            }
+            out += attr.slice(lastIndex);
+            insertDirty();
+        }
+    }
+    /** @private */
+    afterBuild() {
+        if (this.type === 'table-attrs') {
+            const { parentNode } = this;
+            this.setAttribute('name', parentNode?.type === 'td' && parentNode.subtype === 'caption' ? 'caption' : parentNode?.type);
+        }
+    }
+    /**
+     * 所有指定属性名的AttributeToken
+     * @param key 属性名
+     */
+    getAttrTokens(key) {
+        return this.childNodes.filter((child) => child instanceof attribute_1.AttributeToken && (!key || child.name === key.toLowerCase().trim()));
+    }
+    /**
+     * 指定属性名的最后一个AttributeToken
+     * @param key 属性名
+     */
+    getAttrToken(key) {
+        const tokens = this.getAttrTokens(key);
+        return tokens[tokens.length - 1];
+    }
+    /**
+     * 获取指定属性
+     * @param key 属性键
+     */
+    getAttr(key) {
+        return this.getAttrToken(key)?.getValue();
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        const errors = super.lint(start), { parentNode, length, childNodes } = this, attrs = new Map(), duplicated = new Set();
+        let rect;
+        if (parentNode?.type === 'html' && parentNode.closing && this.text().trim()) {
+            rect = { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForSelf)(this, rect, 'attributes of a closing tag'));
+        }
+        for (let i = 0; i < length; i++) {
+            const attr = childNodes[i];
+            if (attr instanceof atom_1.AtomToken && attr.text().trim()) {
+                rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+                errors.push((0, lint_1.generateForChild)(attr, rect, 'containing invalid attribute'));
+            }
+            else if (attr instanceof attribute_1.AttributeToken) {
+                const { name } = attr;
+                if (attrs.has(name)) {
+                    duplicated.add(name);
+                    attrs.get(name).push(attr);
+                }
+                else if (name !== 'class') {
+                    attrs.set(name, [attr]);
+                }
+            }
+        }
+        if (duplicated.size > 0) {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            for (const key of duplicated) {
+                errors.push(...attrs.get(key).map(attr => (0, lint_1.generateForChild)(attr, rect, Parser.msg('duplicated $1 attribute', key))));
+            }
+        }
+        return errors;
+    }
+    /** @override */
+    print() {
+        return String(this)
+            ? `<span class="wpb-${this.type}">${this.childNodes.map(child => child.print(child instanceof atom_1.AtomToken && child.text().trim() ? { class: 'attr-dirty' } : undefined)).join('')}</span>`
+            : '';
+    }
+    /* NOT FOR BROWSER */
+    /** 清理无效属性 */
+    sanitize() {
+        let dirty = false;
+        for (let i = this.length - 1; i >= 0; i--) {
+            const child = this.childNodes[i];
+            if (child instanceof atom_1.AtomToken && child.text().trim()) {
+                dirty = true;
+                this.removeAt(i);
+            }
+        }
+        if (!debug_1.Shadow.running && dirty) {
+            Parser.warn(`${this.constructor.name}.sanitize 方法将清理无效属性！`);
+        }
+    }
+    /** @override */
+    cloneNode() {
+        const cloned = this.cloneChildNodes();
+        return debug_1.Shadow.run(() => {
+            const token = new AttributesToken(undefined, this.type, this.name, this.getAttribute('config'));
+            token.append(...cloned);
+            token.setAttribute('name', this.name);
+            return token;
+        });
+    }
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     * @throws `RangeError` 标签不匹配
+     */
+    insertAt(token, i = this.length) {
+        if (!(token instanceof attribute_1.AttributeToken)) {
+            if (String(token).trim()) {
+                this.constructorError('只能插入 AttributeToken');
+            }
+            return super.insertAt(token, i);
+        }
+        else if (token.type !== this.type.slice(0, -1) || token.tag !== this.name) {
+            throw new RangeError(`待插入的AttributeToken只可用于${token.tag}标签！`);
+        }
+        else if (i === this.length) {
+            const { lastChild } = this;
+            if (lastChild instanceof attribute_1.AttributeToken) {
+                lastChild.close();
+            }
+        }
+        else {
+            token.close();
+        }
+        if (this.closest('parameter')) {
+            token.escape();
+        }
+        super.insertAt(token, i);
+        const { previousVisibleSibling, nextVisibleSibling } = token, type = toDirty(this.type), config = this.getAttribute('config'), acceptable = { [`Stage-${stages[this.type]}`]: ':' };
+        if (nextVisibleSibling && !/^\s/u.test(String(nextVisibleSibling))) {
+            super.insertAt(debug_1.Shadow.run(() => new atom_1.AtomToken(' ', type, config, [], acceptable)), i + 1);
+        }
+        if (previousVisibleSibling && !/\s$/u.test(String(previousVisibleSibling))) {
+            super.insertAt(debug_1.Shadow.run(() => new atom_1.AtomToken(' ', type, config, [], acceptable)), i);
+        }
+        return token;
+    }
+    setAttr(keyOrProp, value) {
+        if (typeof keyOrProp !== 'string') {
+            for (const [key, val] of Object.entries(keyOrProp)) {
+                this.setAttr(key, val);
+            }
+            return;
+        }
+        else if (this.type === 'ext-attrs' && typeof value === 'string' && value.includes('>')) {
+            throw new RangeError('扩展标签属性不能包含 ">"！');
+        }
+        const key = keyOrProp.toLowerCase().trim(), attr = this.getAttrToken(key);
+        if (attr) {
+            attr.setValue(value);
+            return;
+        }
+        else if (value === false) {
+            return;
+        }
+        const token = debug_1.Shadow.run(() => new attribute_1.AttributeToken(toAttributeType(this.type), this.name, key, value === true ? '' : '=', value === true ? '' : value, ['"', '"'], this.getAttribute('config')));
+        this.insertAt(token);
+    }
+    /**
+     * 标签是否具有某属性
+     * @param key 属性键
+     */
+    hasAttr(key) {
+        return this.getAttrTokens(key).length > 0;
+    }
+    /** 获取全部的属性名 */
+    getAttrNames() {
+        return new Set(this.getAttrTokens().map(({ name }) => name));
+    }
+    /** 获取全部属性 */
+    getAttrs() {
+        return Object.fromEntries(this.getAttrTokens().map(({ name, value }) => [name, value]));
+    }
+    /**
+     * 移除指定属性
+     * @param key 属性键
+     */
+    removeAttr(key) {
+        for (const attr of this.getAttrTokens(key)) {
+            attr.remove();
+        }
+    }
+    /**
+     * 开关指定属性
+     * @param key 属性键
+     * @param force 强制开启或关闭
+     * @throws `RangeError` 不为Boolean类型的属性值
+     */
+    toggleAttr(key, force) {
+        key = key.toLowerCase().trim();
+        const attr = this.getAttrToken(key);
+        if (attr && attr.getValue() !== true) {
+            throw new RangeError(`${key} 属性的值不为 Boolean！`);
+        }
+        else if (attr) {
+            attr.setValue(force === true);
+        }
+        else if (force !== false) {
+            this.setAttr(key, true);
+        }
+    }
+    /**
+     * 生成引导空格
+     * @param str 属性字符串
+     */
+    #leadingSpace(str) {
+        const { type } = this, leadingRegex = { 'ext-attrs': /^\s/u, 'html-attrs': /^[/\s]/u };
+        return str && type !== 'table-attrs' && !leadingRegex[type].test(str) ? ' ' : '';
+    }
+    /** @private */
+    toString(omit) {
+        if (this.type === 'table-attrs') {
+            (0, string_1.normalizeSpace)(this);
+        }
+        const str = super.toString(omit);
+        return `${this.#leadingSpace(str)}${str}`;
+    }
+    /** @private */
+    getAttribute(key) {
+        return key === 'padding'
+            ? this.#leadingSpace(super.toString()).length
+            : super.getAttribute(key);
+    }
+    /** @override */
+    text() {
+        if (this.type === 'table-attrs') {
+            (0, string_1.normalizeSpace)(this);
+        }
+        const str = (0, string_1.text)(this.childNodes.filter(child => child instanceof attribute_1.AttributeToken), ' ');
+        return `${this.#leadingSpace(str)}${str}`;
+    }
+}
+exports.AttributesToken = AttributesToken;
+constants_1.classes['AttributesToken'] = __filename;

package/dist/src/converter.d.ts

@@ -0,0 +1,53 @@
+import * as Parser from '../index';
+import { Token } from './index';
+import { ConverterFlagsToken } from './converterFlags';
+import { ConverterRuleToken } from './converterRule';
+declare const ConverterToken_base: (abstract new (...args: any[]) => {
+    readonly firstChild: Parser.ConverterFlagsToken;
+    readonly firstElementChild: Parser.ConverterFlagsToken;
+    flags: Set<string>;
+    getAllFlags(): Set<string>;
+    getEffectiveFlags(): Set<string>;
+    getUnknownFlags(): Set<string>;
+    hasFlag(flag: string): boolean;
+    hasEffectiveFlag(flag: string): boolean;
+    removeFlag(flag: string): void;
+    setFlag(flag: string): void;
+    toggleFlag(flag: string): void;
+    readonly length: number;
+    toString(omit?: Set<string> | undefined, separator?: string | undefined): string;
+    text(separator?: string | undefined): string;
+    lint(start?: number | undefined): Parser.LintError[];
+    insertAt(token: unknown, i?: number | undefined): unknown;
+    afterBuild(): void;
+    getAttribute<T extends string>(key: T): TokenAttributeGetter<T>;
+    setAttribute<T_1 extends string>(key: T_1, value: TokenAttributeSetter<T_1>): void;
+    addEventListener(events: string | string[], listener: AstListener): void;
+    replaceChildren(...elements: (string | Parser.AstNodes)[]): void;
+    constructorError(msg: string): never;
+}) & typeof Parser.Token;
+/**
+ * 转换
+ * @classdesc `{childNodes: [ConverterFlagsToken, ...ConverterRuleToken]}`
+ */
+export declare class ConverterToken extends ConverterToken_base {
+    readonly type = "converter";
+    readonly childNodes: [ConverterFlagsToken, ...ConverterRuleToken[]];
+    abstract get children(): [ConverterFlagsToken, ...ConverterRuleToken[]];
+    abstract get lastChild(): ConverterFlagsToken | ConverterRuleToken;
+    abstract get lastElementChild(): ConverterFlagsToken | ConverterRuleToken;
+    /** 是否不转换 */
+    get noConvert(): boolean;
+    /**
+     * @param flags 转换类型标记
+     * @param rules 转换规则
+     */
+    constructor(flags: readonly string[], rules: readonly [string, ...string[]], config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** @override */
+    print(): string;
+    /** @override */
+    cloneNode(): this;
+}
+export {};

package/dist/src/converter.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConverterToken = void 0;
+const string_1 = require("../util/string");
+const debug_1 = require("../util/debug");
+const constants_1 = require("../util/constants");
+const flagsParent_1 = require("../mixin/flagsParent");
+const Parser = require("../index");
+const index_1 = require("./index");
+const converterFlags_1 = require("./converterFlags");
+const converterRule_1 = require("./converterRule");
+/**
+ * 转换
+ * @classdesc `{childNodes: [ConverterFlagsToken, ...ConverterRuleToken]}`
+ */
+class ConverterToken extends (0, flagsParent_1.flagsParent)(index_1.Token) {
+    type = 'converter';
+    /* NOT FOR BROWSER */
+    /** 是否不转换 */
+    get noConvert() {
+        return this.hasFlag('R') || this.length === 2 && this.lastChild.length === 1;
+    }
+    /* NOT FOR BROWSER END */
+    /**
+     * @param flags 转换类型标记
+     * @param rules 转换规则
+     */
+    constructor(flags, rules, config = Parser.getConfig(), accum = []) {
+        super(undefined, config, accum);
+        this.append(new converterFlags_1.ConverterFlagsToken(flags, config, accum));
+        const [firstRule] = rules, hasColon = firstRule.includes(':'), firstRuleToken = new converterRule_1.ConverterRuleToken(firstRule, hasColon, config, accum);
+        if (hasColon && firstRuleToken.length === 1) {
+            this.insertAt(new converterRule_1.ConverterRuleToken(rules.join(';'), false, config, accum));
+        }
+        else {
+            this.append(firstRuleToken, ...rules.slice(1).map(rule => new converterRule_1.ConverterRuleToken(rule, true, config, accum)));
+        }
+        this.protectChildren(0);
+    }
+    /** @private */
+    toString(omit) {
+        const { childNodes: [flags, ...rules] } = this;
+        return omit && this.matchesTypes(omit)
+            ? ''
+            : `-{${flags.toString(omit)}${flags.length > 0 ? '|' : ''}${rules.map(rule => rule.toString(omit)).join(';')}}-`;
+    }
+    /** @override */
+    text() {
+        const { childNodes: [flags, ...rules] } = this;
+        return `-{${flags.text()}|${(0, string_1.text)(rules, ';')}}-`;
+    }
+    /** @private */
+    getAttribute(key) {
+        return key === 'padding' ? 2 : super.getAttribute(key);
+    }
+    /** @private */
+    getGaps(i) {
+        return i || this.firstChild.length > 0 ? 1 : 0;
+    }
+    /** @override */
+    print() {
+        const { childNodes: [flags, ...rules] } = this;
+        return `<span class="wpb-converter">-{${flags.print()}${flags.length > 0 ? '|' : ''}${(0, string_1.print)(rules, { sep: ';' })}}-</span>`;
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const [flags, ...rules] = this.cloneChildNodes();
+        return debug_1.Shadow.run(() => {
+            const token = new ConverterToken([], [''], this.getAttribute('config'));
+            token.firstChild.safeReplaceWith(flags);
+            token.removeAt(1);
+            token.append(...rules);
+            return token;
+        });
+    }
+}
+exports.ConverterToken = ConverterToken;
+constants_1.classes['ConverterToken'] = __filename;

package/dist/src/converterFlags.d.ts

@@ -0,0 +1,87 @@
+import * as Parser from '../index';
+import { Token } from './index';
+import { AtomToken } from './atom';
+import type { LintError } from '../base';
+import type { ConverterToken, ConverterRuleToken } from '../internal';
+/**
+ * 转换flags
+ * @classdesc `{childNodes: ...AtomToken}`
+ */
+export declare class ConverterFlagsToken extends Token {
+    #private;
+    readonly type = "converter-flags";
+    readonly childNodes: AtomToken[];
+    abstract get children(): AtomToken[];
+    abstract get firstChild(): AtomToken | undefined;
+    abstract get firstElementChild(): AtomToken | undefined;
+    abstract get lastChild(): AtomToken | undefined;
+    abstract get lastElementChild(): AtomToken | undefined;
+    abstract get parentNode(): ConverterToken | undefined;
+    abstract get parentElement(): ConverterToken | undefined;
+    abstract get previousSibling(): undefined;
+    abstract get previousElementSibling(): undefined;
+    abstract get nextSibling(): ConverterRuleToken | undefined;
+    abstract get nextElementSibling(): ConverterRuleToken | undefined;
+    /** 所有转换类型标记 */
+    get flags(): Set<string>;
+    set flags(value: Set<string>);
+    /** @param flags 转换类型标记 */
+    constructor(flags: readonly string[], config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** 获取未知的转换类型标记 */
+    getUnknownFlags(): Set<string>;
+    /** 获取指定语言变体的转换标记 */
+    getVariantFlags(): Set<string>;
+    /** @override */
+    lint(start?: number): LintError[];
+    /** @override */
+    print(): string;
+    /** @override */
+    cloneNode(): this;
+    /**
+     * @override
+     * @param i 移除位置
+     */
+    removeAt(i: number): AtomToken;
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     */
+    insertAt<T extends AtomToken>(token: T, i?: number): T;
+    /** 获取所有转换类型标记 */
+    getAllFlags(): Set<string>;
+    /**
+     * 获取转换类型标记节点
+     * @param flag 转换类型标记
+     */
+    getFlagTokens(flag: string): readonly AtomToken[];
+    /** 获取有效的转换类型标记 */
+    getEffectiveFlags(): Set<string>;
+    /**
+     * 是否具有某转换类型标记
+     * @param flag 转换类型标记
+     */
+    hasFlag(flag: string): boolean;
+    /**
+     * 是否具有某有效的转换类型标记
+     * @param flag 转换类型标记
+     */
+    hasEffectiveFlag(flag: string): boolean;
+    /**
+     * 移除某转换类型标记
+     * @param flag 转换类型标记
+     */
+    removeFlag(flag: string): void;
+    /**
+     * 设置转换类型标记
+     * @param flag 转换类型标记
+     */
+    setFlag(flag: string): void;
+    /**
+     * 开关转换类型标记
+     * @param flag 转换类型标记
+     */
+    toggleFlag(flag: string): void;
+}