wikiparser-node 1.22.0 → 1.23.0

package/dist/lib/text.js

@@ -202,7 +202,7 @@ let AstText = (() => {
             const { type, name, parentNode: grandparent } = parentNode;
             if (type === 'attr-value') {
                 const { name: grandName, tag } = grandparent;
-                if (tag === 'ref' && (grandName === 'name' || grandName === 'extends' || grandName === 'follow')
+                if (tag === 'ref' && (grandName === 'name' || grandName === 'follow')
                     || grandName === 'group' && (tag === 'ref' || tag === 'references')
                     || tag === 'choose' && (grandName === 'before' || grandName === 'after')) {
                     return [];

package/dist/lib/title.js

@@ -275,7 +275,7 @@ class Title {
     autoConvert() {
         const { conversionTable } = this;
         if (conversionTable.size > 0) {
-            const regex = new RegExp([...conversionTable.keys()].sort().reverse().map(string_1.escapeRegExp).join('|'), 'gu');
+            const regex = new RegExp([...conversionTable.keys()].sort((a, b) => b.localeCompare(a)).map(string_1.escapeRegExp).join('|'), 'gu');
             this.main = this.main.replace(regex, p => conversionTable.get(p));
         }
     }

package/dist/mixin/attributesParent.js

@@ -9,28 +9,24 @@ const constants_1 = require("../util/constants");
  * @param i AttributesToken子节点的位置
  */
 const attributesParent = (i = 0) => (constructor) => {
-    /** 子节点含有AttributesToken的类 */
+    /* eslint-disable jsdoc/require-jsdoc */
     class AttributesParent extends constructor {
         /* NOT FOR BROWSER */
-        /** @implements */
         get attributes() {
             return this.#getAttributesChild().attributes;
         }
         set attributes(attributes) {
             this.#getAttributesChild().attributes = attributes;
         }
-        /** @implements */
         get className() {
             return this.#getAttributesChild().className;
         }
         set className(className) {
             this.#getAttributesChild().className = className;
         }
-        /** @implements */
         get classList() {
             return this.#getAttributesChild().classList;
         }
-        /** @implements */
         get id() {
             return this.#getAttributesChild().id;
         }
@@ -42,39 +38,33 @@ const attributesParent = (i = 0) => (constructor) => {
         #getAttributesChild() {
             return this.childNodes[i];
         }
-        /** @implements */
         hasAttr(key) {
             return this.#getAttributesChild().hasAttr(key);
         }
-        /** @implements */
         getAttr(key) {
             return this.#getAttributesChild().getAttr(key);
         }
         /* NOT FOR BROWSER */
-        /** @implements */
         getAttrNames() {
             return this.#getAttributesChild().getAttrNames();
         }
-        /** @implements */
         getAttrs() {
             return this.#getAttributesChild().getAttrs();
         }
         setAttr(keyOrProp, value) {
             this.#getAttributesChild().setAttr(keyOrProp, value);
         }
-        /** @implements */
         removeAttr(key) {
             this.#getAttributesChild().removeAttr(key);
         }
-        /** @implements */
         toggleAttr(key, force) {
             this.#getAttributesChild().toggleAttr(key, force);
         }
-        /** @implements */
         css(key, value) {
             return this.#getAttributesChild().css(key, value);
         }
     }
+    /* eslint-enable jsdoc/require-jsdoc */
     (0, debug_1.mixin)(AttributesParent, constructor);
     return AttributesParent;
 };

package/dist/mixin/elementLike.d.ts

@@ -0,0 +1,65 @@
+import type { AstNodes, Token } from '../internal';
+declare type ElementConstructor = abstract new (...args: any[]) => {
+    readonly childNodes: readonly AstNodes[];
+    detach?: () => void;
+};
+export interface ElementLike {
+    /** all child elements / 全部非文本子节点 */
+    readonly children: Token[];
+    /** first child element / 首位非文本子节点 */
+    readonly firstElementChild: Token | undefined;
+    /** last child element / 末位非文本子节点 */
+    readonly lastElementChild: Token | undefined;
+    /** number of child elements / 非文本子节点总数 */
+    readonly childElementCount: number;
+    /**
+     * Get the first descendant that matches the selector
+     *
+     * 符合选择器的第一个后代节点
+     * @param selector selector / 选择器
+     */
+    querySelector<T = Token>(selector: string): T | undefined;
+    /**
+     * Get all descendants that match the selector
+     *
+     * 符合选择器的所有后代节点
+     * @param selector selector / 选择器
+     */
+    querySelectorAll<T = Token>(selector: string): T[];
+    /**
+     * Get all descendants of the types
+     *
+     * 类型选择器
+     * @param types token types / 节点类型
+     */
+    getElementByTypes<T = Token>(types: string): T | undefined;
+    /**
+     * Get the first descendant with the id
+     *
+     * id选择器
+     * @param id id名
+     */
+    getElementById<T = Token>(id: string): T | undefined;
+    /**
+     * Get all descendants with the class
+     *
+     * 类选择器
+     * @param className class name / 类名之一
+     */
+    getElementsByClassName<T = Token>(className: string): T[];
+    /**
+     * Get all descendants with the tag name
+     *
+     * 标签名选择器
+     * @param tag tag name / 标签名
+     */
+    getElementsByTagName<T = Token>(tag: string): T[];
+    /**
+     * Escape `=` and `|`
+     *
+     * 转义 `=` 和 `|`
+     * @since v1.18.3
+     */
+    escape(): void;
+}
+/** @ignore */

package/dist/mixin/elementLike.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.elementLike = void 0;
+const debug_1 = require("../util/debug");
+const selector_1 = require("../parser/selector");
+/* NOT FOR BROWSER */
+const constants_1 = require("../util/constants");
+const element_1 = require("../lib/element");
+/** @ignore */
+const elementLike = (constructor) => {
+    /* eslint-disable jsdoc/require-jsdoc */
+    class ElementLike extends constructor {
+        /* NOT FOR BROWSER */
+        get children() {
+            return this.childNodes.filter((child) => child.type !== 'text');
+        }
+        get firstElementChild() {
+            return this.childNodes.find((child) => child.type !== 'text');
+        }
+        get lastElementChild() {
+            return this.childNodes.findLast((child) => child.type !== 'text');
+        }
+        get childElementCount() {
+            return this.children.length;
+        }
+        /* NOT FOR BROWSER END */
+        #getCondition(selector) {
+            return (0, selector_1.getCondition)(selector, 
+            // eslint-disable-next-line unicorn/no-negated-condition, @stylistic/operator-linebreak
+            !(this instanceof element_1.AstElement) ?
+                undefined : // eslint-disable-line @stylistic/operator-linebreak
+                this);
+        }
+        getElementBy(condition) {
+            for (const child of this.childNodes) {
+                if (child.type === 'text') {
+                    continue;
+                }
+                else if (condition(child)) {
+                    return child;
+                }
+                const descendant = child.getElementBy(condition);
+                if (descendant) {
+                    return descendant;
+                }
+            }
+            return undefined;
+        }
+        querySelector(selector) {
+            return this.getElementBy(this.#getCondition(selector));
+        }
+        getElementsBy(condition, descendants = []) {
+            for (const child of this.childNodes) {
+                if (child.type === 'text') {
+                    continue;
+                }
+                else if (condition(child)) {
+                    descendants.push(child);
+                }
+                child.getElementsBy(condition, descendants);
+            }
+            return descendants;
+        }
+        querySelectorAll(selector) {
+            return this.getElementsBy(this.#getCondition(selector));
+        }
+        /* NOT FOR BROWSER */
+        getElementByTypes(types) {
+            const typeSet = new Set(types.split(',').map(str => str.trim()));
+            return this.getElementBy((({ type }) => typeSet.has(type)));
+        }
+        getElementById(id) {
+            return this.getElementBy((token => 'id' in token && token.id === id));
+        }
+        getElementsByClassName(className) {
+            return this.getElementsBy((token => 'classList' in token && token.classList.has(className)));
+        }
+        getElementsByTagName(tag) {
+            return this.getElementsBy((({ type, name }) => name === tag && (type === 'html' || type === 'ext')));
+        }
+        escape() {
+            for (const child of this.childNodes) {
+                child.escape();
+            }
+            this.detach?.();
+        }
+    }
+    /* eslint-enable jsdoc/require-jsdoc */
+    (0, debug_1.mixin)(ElementLike, constructor);
+    return ElementLike;
+};
+exports.elementLike = elementLike;
+constants_1.mixins['elementLike'] = __filename;

package/dist/mixin/fixed.js

@@ -8,13 +8,11 @@ const constants_1 = require("../util/constants");
  * @ignore
  */
 const fixedToken = (constructor) => {
-    /** 不可增删子节点的类 */
+    /* eslint-disable jsdoc/require-jsdoc */
     class FixedToken extends constructor {
-        /** @private */
         get fixed() {
             return true;
         }
-        /** @override */
         removeAt() {
             this.constructorError('cannot remove child nodes');
         }
@@ -24,6 +22,7 @@ const fixedToken = (constructor) => {
                 : this.constructorError('cannot insert child nodes');
         }
     }
+    /* eslint-enable jsdoc/require-jsdoc */
     (0, debug_1.mixin)(FixedToken, constructor);
     return FixedToken;
 };

package/dist/mixin/gapped.js

@@ -10,13 +10,13 @@ const constants_1 = require("../util/constants");
  * @param gap
  */
 const gapped = (gap = 1) => (constructor) => {
-    /** 不可增删子节点的类 */
+    /* eslint-disable jsdoc/require-jsdoc */
     class GappedToken extends constructor {
-        /** @private */
         getGaps() {
             return gap;
         }
     }
+    /* eslint-enable jsdoc/require-jsdoc */
     (0, debug_1.mixin)(GappedToken, constructor);
     return GappedToken;
 };

package/dist/mixin/hidden.js

@@ -46,7 +46,7 @@ const cached_1 = require("./cached");
  * @param html 是否覆写 toHtml 方法
  */
 const hiddenToken = (linter = true, html = true) => (constructor) => {
-    /** 解析后不可见的类 */
+    /* eslint-disable jsdoc/require-jsdoc */
     let AnyHiddenToken = (() => {
         let _classSuper = constructor;
         let _instanceExtraInitializers = [];
@@ -67,7 +67,6 @@ const hiddenToken = (linter = true, html = true) => (constructor) => {
                 return linter ? [] : super.lint(start);
             }
             /* NOT FOR BROWSER */
-            /** @private */
             dispatchEvent() {
                 //
             }
@@ -80,6 +79,7 @@ const hiddenToken = (linter = true, html = true) => (constructor) => {
             }
         };
     })();
+    /* eslint-enable jsdoc/require-jsdoc */
     (0, debug_1.mixin)(AnyHiddenToken, constructor);
     return AnyHiddenToken;
 };

package/dist/mixin/multiLine.js

@@ -10,7 +10,7 @@ const constants_1 = require("../util/constants");
  * @ignore
  */
 const multiLine = (constructor) => {
-    /** 不可包含换行符的类 */
+    /* eslint-disable jsdoc/require-jsdoc */
     class MultiLineToken extends constructor {
         toString(skip) {
             return super.toString(skip, '\n');
@@ -18,7 +18,6 @@ const multiLine = (constructor) => {
         text() {
             return super.text('\n').replace(/\n\s*\n/gu, '\n');
         }
-        /** @private */
         getGaps() {
             return 1;
         }
@@ -26,6 +25,7 @@ const multiLine = (constructor) => {
             return super.print({ sep: '\n' });
         }
     }
+    /* eslint-enable jsdoc/require-jsdoc */
     (0, debug_1.mixin)(MultiLineToken, constructor);
     return MultiLineToken;
 };

package/dist/mixin/noEscape.js

@@ -8,13 +8,13 @@ const constants_1 = require("../util/constants");
  * @ignore
  */
 const noEscape = (constructor) => {
-    /** 不可包含换行符的类 */
+    /* eslint-disable jsdoc/require-jsdoc */
     class NoEscapeToken extends constructor {
-        /** @private */
         escape() {
             //
         }
     }
+    /* eslint-enable jsdoc/require-jsdoc */
     (0, debug_1.mixin)(NoEscapeToken, constructor);
     return NoEscapeToken;
 };

package/dist/mixin/nodeLike.d.ts

@@ -0,0 +1,17 @@
+import type { Dimension } from '../lib/node';
+import type { AstNodes } from '../internal';
+declare type NodeConstructor = abstract new (...args: any[]) => {
+    readonly childNodes: readonly AstNodes[];
+    getDimension(): Dimension;
+};
+export interface NodeLike {
+    /** first child node / 首位子节点 */
+    readonly firstChild: AstNodes | undefined;
+    /** last child node / 末位子节点 */
+    readonly lastChild: AstNodes | undefined;
+    /** number of lines / 行数 */
+    readonly offsetHeight: number;
+    /** number of columns of the last line / 最后一行的列数 */
+    readonly offsetWidth: number;
+}
+/** @ignore */

package/dist/mixin/nodeLike.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nodeLike = void 0;
+const debug_1 = require("../util/debug");
+/* NOT FOR BROWSER */
+const constants_1 = require("../util/constants");
+/** @ignore */
+const nodeLike = (constructor) => {
+    /* eslint-disable jsdoc/require-jsdoc */
+    class NodeLike extends constructor {
+        get firstChild() {
+            return this.childNodes[0];
+        }
+        get lastChild() {
+            return this.childNodes[this.childNodes.length - 1];
+        }
+        get offsetHeight() {
+            return this.getDimension().height;
+        }
+        get offsetWidth() {
+            return this.getDimension().width;
+        }
+    }
+    /* eslint-enable jsdoc/require-jsdoc */
+    (0, debug_1.mixin)(NodeLike, constructor);
+    return NodeLike;
+};
+exports.nodeLike = nodeLike;
+constants_1.mixins['nodeLike'] = __filename;

package/dist/mixin/padded.js

@@ -11,12 +11,13 @@ const constants_1 = require("../util/constants");
  * @param padding.length
  */
 const padded = ({ length }) => (constructor) => {
-    /** 不可增删子节点的类 */
+    /* eslint-disable jsdoc/require-jsdoc */
     class PaddedToken extends constructor {
         getAttribute(key) {
             return key === 'padding' ? length : super.getAttribute(key);
         }
     }
+    /* eslint-enable jsdoc/require-jsdoc */
     (0, debug_1.mixin)(PaddedToken, constructor);
     return PaddedToken;
 };

package/dist/mixin/readOnly.js

@@ -19,7 +19,9 @@ const readOnly = (readonly = false) =>
         index_1.default.viewOnly = readonly;
     }
     const result = method.apply(this, args);
-    index_1.default.viewOnly = viewOnly;
+    if (!debug_1.Shadow.running) {
+        index_1.default.viewOnly = viewOnly;
+    }
     return result;
 };
 exports.readOnly = readOnly;

package/dist/mixin/singleLine.js

@@ -8,7 +8,7 @@ const constants_1 = require("../util/constants");
  * @param strict 是否严格
  */
 const singleLine = (strict = true) => (constructor) => {
-    /** 不可包含换行符的类 */
+    /* eslint-disable jsdoc/require-jsdoc */
     class SingleLineToken extends constructor {
         toString(skip) {
             if (strict) {
@@ -26,6 +26,7 @@ const singleLine = (strict = true) => (constructor) => {
             return super.text().replaceAll('\n', ' ');
         }
     }
+    /* eslint-enable jsdoc/require-jsdoc */
     (0, debug_1.mixin)(SingleLineToken, constructor);
     return SingleLineToken;
 };

package/dist/mixin/sol.js

@@ -8,9 +8,8 @@ const constants_1 = require("../util/constants");
  * @param self 是否允许同类节点相邻
  */
 const sol = (self) => (constructor) => {
-    /** 只能位于行首的类 */
+    /* eslint-disable jsdoc/require-jsdoc */
     class SolToken extends constructor {
-        /** @implements */
         #prependNewLine() {
             const { previousVisibleSibling, parentNode, type } = this;
             if (previousVisibleSibling) {
@@ -37,6 +36,7 @@ const sol = (self) => (constructor) => {
             return this.#prependNewLine() + super.text();
         }
     }
+    /* eslint-enable jsdoc/require-jsdoc */
     (0, debug_1.mixin)(SolToken, constructor);
     return SolToken;
 };

package/dist/mixin/syntax.js

@@ -9,9 +9,8 @@ const string_1 = require("../util/string");
  * @param pattern 语法正则
  */
 const syntax = (pattern) => (constructor) => {
-    /** 满足特定语法格式的Token */
+    /* eslint-disable jsdoc/require-jsdoc */
     class SyntaxToken extends constructor {
-        /** @class */
         constructor(...args) {
             super(...args); // eslint-disable-line @typescript-eslint/no-unsafe-argument
             if (pattern) {
@@ -37,6 +36,7 @@ const syntax = (pattern) => (constructor) => {
             }
         }
     }
+    /* eslint-enable jsdoc/require-jsdoc */
     (0, debug_1.mixin)(SyntaxToken, constructor);
     return SyntaxToken;
 };

package/dist/parser/selector.js

@@ -15,8 +15,8 @@ const attributes_1 = require("../lib/attributes");
  */
 const basic = (selector, type, name) => {
     if (selector.includes('#')) {
-        const [t, ...names] = selector.split('#');
-        return (!t || t === type) && names.every(n => n === name);
+        const i = selector.indexOf('#');
+        return (i === 0 || selector.slice(0, i) === type) && selector.slice(i + 1) === name;
     }
     return !selector || selector === type;
 };
@@ -168,6 +168,9 @@ const matches = (token, step, scope, has) => {
                 case ':optional':
                     return isProtected(token) === false;
                 case ':scope':
+                    if (!scope) {
+                        throw new SyntaxError('The :scope pseudo-selector must be used with an element node.');
+                    }
                     return token === scope;
                 default:
                     return basic(selector, type, name);
@@ -450,12 +453,14 @@ const checkToken = (selector, scope, has) => (token) => {
  * @param scope 作用对象
  * @param has `:has()`伪选择器
  */
-const getCondition = (selector, scope, has) => (
-/* eslint-disable @stylistic/operator-linebreak */
-/[^a-z\-,#\s]|(?<![\s,])\s+(?![\s,])/u.test(selector.trim()) ?
-    checkToken(selector, scope, has) :
-    ({ type, name }) => selector.split(',').some(str => basic(str.trim(), type, name))
-/* eslint-enable @stylistic/operator-linebreak */
-);
+const getCondition = (selector, scope, has) => {
+    /* NOT FOR BROWSER */
+    if (/[^a-z\-,#\s]|(?<![\s,])\s+(?![\s,])/u.test(selector.trim())) {
+        return checkToken(selector, scope, has);
+    }
+    /* NOT FOR BROWSER END */
+    const parts = selector.split(',');
+    return (({ type, name }) => parts.some(str => basic(str.trim(), type, name)));
+};
 exports.getCondition = getCondition;
 constants_1.parsers['parseSelector'] = __filename;

package/dist/src/atom.d.ts

@@ -12,7 +12,7 @@ export declare class AtomToken extends Token {
     get type(): AtomTypes;
     set type(value: AtomTypes);
     /** @class */
-    constructor(wikitext: string | undefined, type: AtomTypes, config?: Config, accum?: Token[], acceptable?: Acceptable);
+    constructor(wikitext: string | undefined, type: AtomTypes, config?: Config, accum?: Token[], acceptable?: WikiParserAcceptable);
     cloneNode(): this;
 }
 export {};

package/dist/src/html.d.ts

@@ -2,6 +2,7 @@ import { Token } from './index';
 import type { Config, LintError, AST } from '../base';
 import type { AttributesParentBase } from '../mixin/attributesParent';
 import type { AttributesToken } from '../internal';
+import type { AstRange } from '../lib/range';
 export interface HtmlToken extends AttributesParentBase {
 }
 /**
@@ -57,4 +58,11 @@ export declare abstract class HtmlToken extends Token {
      * @throws `Error` 无法修复无效自封闭标签
      */
     fix(): void;
+    /**
+     * Get the range of the HTML tag pair
+     *
+     * 获取HTML标签对的范围
+     * @since v1.23.0
+     */
+    getRange(): AstRange | undefined;
 }

package/dist/src/html.js

@@ -401,6 +401,26 @@ let HtmlToken = (() => {
             }
             return result;
         }
+        /**
+         * Get the range of the HTML tag pair
+         *
+         * 获取HTML标签对的范围
+         * @since v1.23.0
+         */
+        getRange() {
+            const { closing, selfClosing, name } = this, { html: [, selfClosingTags, voidTags] } = this.getAttribute('config');
+            if (voidTags.includes(name) || selfClosing && selfClosingTags.includes(name)) {
+                return undefined;
+            }
+            const matched = this.findMatchingTag();
+            if (!matched) {
+                return undefined;
+            }
+            const range = this.createRange();
+            range.setStartAfter(closing ? matched : this);
+            range.setEndBefore(closing ? this : matched);
+            return range;
+        }
     };
     return HtmlToken = _classThis;
 })();

package/dist/src/index.d.ts

@@ -18,7 +18,7 @@ export declare class Token extends AstElement {
     get type(): TokenTypes;
     set type(value: TokenTypes);
     /** @class */
-    constructor(wikitext?: string, config?: Parser.Config, accum?: Token[], acceptable?: Acceptable);
+    constructor(wikitext?: string, config?: Parser.Config, accum?: Token[], acceptable?: WikiParserAcceptable);
     /**
      * @override
      * @param child node to be inserted / 待插入的子节点

package/dist/src/index.js

@@ -463,7 +463,8 @@ let Token = (() => {
                     break;
                 /* NOT FOR BROWSER */
                 case 'acceptable':
-                    this.#acceptable = value && (() => getAcceptable(value));
+                    this.#acceptable = value
+                        && (() => getAcceptable(value));
                     break;
                 case 'include':
                     this.#include = value;

package/dist/src/link/galleryImage.js

@@ -94,7 +94,7 @@ let GalleryImageToken = (() => {
             if (text !== undefined) {
                 const { length } = accum;
                 token = new index_2.Token(text, config, accum);
-                for (let n = 1; n < constants_1.MAX_STAGE; n++) {
+                for (let n = 0; n < constants_1.MAX_STAGE - 1; n++) {
                     token.parseOnce();
                 }
                 accum.splice(length, 1);

package/dist/src/nested.js

@@ -85,7 +85,7 @@ let NestedToken = (() => {
          */
         constructor(wikitext, regex, tags, config, accum = []) {
             if (typeof regex === 'boolean') {
-                const placeholder = Symbol('InputboxToken'), { length } = accum;
+                const placeholder = Symbol('NestedToken'), { length } = accum;
                 accum.push(placeholder);
                 wikitext &&= (0, commentAndExt_1.parseCommentAndExt)(wikitext, config, accum, regex);
                 wikitext &&= (0, braces_1.parseBraces)(wikitext, config, accum);

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

@@ -23,6 +23,6 @@ export declare abstract class ParamTagToken extends Token {
     abstract get parentElement(): ExtToken | undefined;
     get type(): 'ext-inner';
     /** @class */
-    constructor(include: boolean, wikitext?: string, config?: Parser.Config, accum?: Token[], acceptable?: Acceptable);
+    constructor(include: boolean, wikitext?: string, config?: Parser.Config, accum?: Token[], acceptable?: WikiParserAcceptable);
     cloneNode(): this;
 }

package/dist/src/syntax.d.ts

@@ -16,7 +16,7 @@ export declare class SyntaxToken extends Token {
      * @class
      * @param pattern 语法正则
      */
-    constructor(wikitext: string | undefined, pattern: RegExp, type: SyntaxTypes, config?: Config, accum?: Token[], acceptable?: Acceptable);
+    constructor(wikitext: string | undefined, pattern: RegExp, type: SyntaxTypes, config?: Config, accum?: Token[], acceptable?: WikiParserAcceptable);
     cloneNode(): this;
 }
 export {};