wikiparser-node 1.0.0-beta.0 → 1.0.0-beta.2

package/dist/lib/element.js

@@ -1,13 +1,14 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AstElement = void 0;
 const fs = require("fs");
 const path = require("path");
 const string_1 = require("../util/string");
-const Ranges = require("./ranges");
-const { nth } = Ranges;
-const parseSelector = require("../parser/selector");
-const Title = require("./title");
-const Parser = require("../index");
-const AstNode = require("./node");
+const selector_1 = require("../parser/selector");
+const ranges_1 = require("./ranges");
+const title_1 = require("./title");
+const index_1 = require("../index");
+const node_1 = require("./node");
 const lintIgnoredExt = new Set([
     'nowiki',
     'pre',
@@ -25,8 +26,14 @@ const lintIgnoredExt = new Set([
     'templatedata',
     'timeline',
 ]);
+/**
+ * 检查某个下标是否符合表达式
+ * @param str 表达式
+ * @param i 待检查的下标
+ */
+const nth = (str, i) => new ranges_1.Ranges(str.split(',')).applyTo(i + 1).includes(i);
 /** 类似HTMLElement */
-class AstElement extends AstNode {
+class AstElement extends node_1.AstNode {
     /** @browser */
     name;
     /**
@@ -143,16 +150,13 @@ class AstElement extends AstNode {
      * @param i 插入位置
      * @throws `RangeError` 不能插入祖先节点
      */
-    insertAt(node, i = this.childNodes.length) {
-        if (!(node instanceof AstNode)) {
-            return this.typeError('insertAt', 'AstNode');
-        }
-        else if (node.contains(this)) {
-            Parser.error('不能插入祖先节点！', node);
+    insertAt(node, i = this.length) {
+        if (node.contains(this)) {
+            index_1.default.error('不能插入祖先节点！', node);
             throw new RangeError('不能插入祖先节点！');
         }
         this.verifyChild(i, 1);
-        const childNodes = [...this.childNodes], e = new Event('insert', { bubbles: true }), j = Parser.running ? -1 : childNodes.indexOf(node);
+        const childNodes = [...this.childNodes], e = new Event('insert', { bubbles: true }), j = index_1.default.running ? -1 : childNodes.indexOf(node);
         if (j === -1) {
             node.parentNode?.removeChild(node);
             node.setAttribute('parentNode', this);
@@ -162,16 +166,17 @@ class AstElement extends AstNode {
         }
         childNodes.splice(i, 0, node);
         this.setAttribute('childNodes', childNodes);
-        this.dispatchEvent(e, { position: i < 0 ? i + this.childNodes.length - 1 : i, inserted: node });
+        this.dispatchEvent(e, { position: i < 0 ? i + this.length - 1 : i, inserted: node });
         return node;
     }
     /**
      * 最近的祖先节点
      * @browser
+     * @param selector 选择器
      */
     closest(selector) {
         let { parentNode } = this;
-        const stack = parseSelector(selector);
+        const stack = (0, selector_1.parseSelector)(selector);
         while (parentNode) {
             if (parentNode.#matchesStack(stack)) {
                 return parentNode;
@@ -221,6 +226,7 @@ class AstElement extends AstNode {
     /**
      * 还原为wikitext
      * @browser
+     * @param selector
      * @param separator 子节点间的连接符
      */
     toString(selector, separator = '') {
@@ -231,9 +237,10 @@ class AstElement extends AstNode {
     /**
      * Linter
      * @browser
+     * @param start
      */
     lint(start = this.getAbsoluteIndex()) {
-        const SyntaxToken = require('../src/syntax');
+        const { SyntaxToken } = require('../src/syntax');
         if (this instanceof SyntaxToken || this.constructor.hidden
             || this.type === 'ext-inner' && lintIgnoredExt.has(this.name)) {
             return [];
@@ -264,7 +271,7 @@ class AstElement extends AstNode {
     json(file) {
         const json = {
             ...this,
-            childNodes: this.childNodes.map(child => child.type === 'text' ? String(child) : child.json()),
+            childNodes: this.childNodes.map(child => child.type === 'text' ? child.data : child.json()),
         };
         if (typeof file === 'string') {
             fs.writeFileSync(path.join(__dirname.slice(0, -4), '..', 'printed', `${file}${file.endsWith('.json') ? '' : '.json'}`), JSON.stringify(json, null, 2));
@@ -303,7 +310,9 @@ class AstElement extends AstNode {
         }
         if (equal === '~=') {
             const thisVals = typeof thisVal === 'string' ? thisVal.split(/\s/u) : thisVal;
+            // @ts-expect-error noImplicitAny
             return Boolean(thisVals?.[Symbol.iterator])
+                // @ts-expect-error spread unknown
                 && [...thisVals].some(w => typeof w === 'string' && (0, string_1.toCase)(w, i) === v);
         }
         else if (typeof thisVal !== 'string') {
@@ -328,6 +337,7 @@ class AstElement extends AstNode {
     /**
      * 检查是否符合解析后的选择器，不含节点关系
      * @param step 解析后的选择器
+     * @throws `SyntaxError` 错误的正则伪选择器
      * @throws `SyntaxError` 未定义的伪选择器
      */
     #matches(step) {
@@ -352,9 +362,9 @@ class AstElement extends AstNode {
                     case ':only-of-type':
                         return siblingsCountOfType === 1;
                     case ':empty':
-                        return !childNodes.some(child => child.type !== 'text' || String(child));
+                        return !childNodes.some(child => child.type !== 'text' || child.data);
                     case ':parent':
-                        return childNodes.some(child => child.type !== 'text' || String(child));
+                        return childNodes.some(child => child.type !== 'text' || child.data);
                     case ':header':
                         return type === 'heading';
                     case ':hidden':
@@ -368,7 +378,7 @@ class AstElement extends AstNode {
                             || (type === 'file' || type === 'gallery-image' && link);
                     case ':local-link':
                         return (type === 'link' || type === 'file' || type === 'gallery-image')
-                            && link instanceof Title && link.title === '';
+                            && link instanceof title_1.Title && link.title === '';
                     case ':read-only':
                         return fixed;
                     case ':read-write':
@@ -381,7 +391,7 @@ class AstElement extends AstNode {
                         return this.#isProtected() === false;
                     default: {
                         const [t, n] = selector.split('#');
-                        return (!t || t === type || Boolean(Parser.typeAliases[type]?.includes(t)))
+                        return (!t || t === type || Boolean(index_1.default.typeAliases[type]?.includes(t)))
                             && (!n || n === name);
                     }
                 }
@@ -415,7 +425,7 @@ class AstElement extends AstNode {
                 case 'regex': {
                     const mt = /^([^,]+),\s*\/(.+)\/([a-z]*)$/u.exec(s);
                     if (!mt) {
-                        throw new SyntaxError('错误的伪选择器用法。请使用形如 ":regex(attr, /re/i)" 的格式。');
+                        throw new SyntaxError('错误的伪选择器用法。请使用形如 ":regex(\'attr, /re/i\')" 的格式。');
                     }
                     try {
                         const regex = new RegExp(mt[2], mt[3]);
@@ -465,14 +475,12 @@ class AstElement extends AstNode {
     #matchesStack(stack) {
         return stack.some(condition => this.#matchesArray([...condition]));
     }
-    /** 检查是否符合选择器 */
+    /**
+     * 检查是否符合选择器
+     * @param selector 选择器
+     */
     matches(selector) {
-        if (selector === undefined) {
-            return true;
-        }
-        return typeof selector === 'string'
-            ? this.#matchesStack(parseSelector(selector))
-            : this.typeError('matches', 'String');
+        return selector === undefined || this.#matchesStack((0, selector_1.parseSelector)(selector));
     }
     /**
      * 符合组合选择器的第一个后代节点
@@ -490,9 +498,12 @@ class AstElement extends AstNode {
         }
         return undefined;
     }
-    /** 符合选择器的第一个后代节点 */
+    /**
+     * 符合选择器的第一个后代节点
+     * @param selector 选择器
+     */
     querySelector(selector) {
-        return this.#queryStack(parseSelector(selector));
+        return this.#queryStack((0, selector_1.parseSelector)(selector));
     }
     /**
      * 符合组合选择器的所有后代节点
@@ -508,40 +519,35 @@ class AstElement extends AstNode {
         }
         return descendants;
     }
-    /** 符合选择器的所有后代节点 */
+    /**
+     * 符合选择器的所有后代节点
+     * @param selector 选择器
+     */
     querySelectorAll(selector) {
-        return this.#queryStackAll(parseSelector(selector));
+        return this.#queryStackAll((0, selector_1.parseSelector)(selector));
     }
     /**
      * id选择器
      * @param id id名
      */
     getElementById(id) {
-        if (typeof id === 'string') {
-            const eid = id.replace(/(?<!\\)"/gu, '\\"');
-            return this.querySelector(`ext[id="${eid}"], html[id="${eid}"]`);
-        }
-        return this.typeError('getElementById', 'String');
+        const eid = id.replace(/(?<!\\)"/gu, '\\"');
+        return this.querySelector(`ext[id="${eid}"], html[id="${eid}"]`);
     }
     /**
      * 类选择器
      * @param className 类名之一
      */
     getElementsByClassName(className) {
-        return typeof className === 'string'
-            ? this.querySelectorAll(`[className~="${className.replace(/(?<!\\)"/gu, '\\"')}"]`)
-            : this.typeError('getElementsByClassName', 'String');
+        return this.querySelectorAll(`[className~="${className.replace(/(?<!\\)"/gu, '\\"')}"]`);
     }
     /**
      * 标签名选择器
      * @param name 标签名
      */
     getElementsByTagName(name) {
-        if (typeof name === 'string') {
-            const ename = name.replace(/(?<!\\)"/gu, '\\"');
-            return this.querySelectorAll(`ext[name="${ename}"], html[name="${ename}"]`);
-        }
-        return this.typeError('getElementsByTagName', 'String');
+        const ename = name.replace(/(?<!\\)"/gu, '\\"');
+        return this.querySelectorAll(`ext[name="${ename}"], html[name="${ename}"]`);
     }
     /**
      * 获取某一行的wikitext
@@ -567,7 +573,7 @@ class AstElement extends AstNode {
     #getChildIndex(node) {
         const i = this.childNodes.indexOf(node);
         if (i === -1) {
-            Parser.error('找不到子节点！', node);
+            index_1.default.error('找不到子节点！', node);
             throw new RangeError('找不到子节点！');
         }
         return i;
@@ -606,15 +612,12 @@ class AstElement extends AstNode {
      * @param depth 当前深度
      */
     echo(depth = 0) {
-        if (!Number.isInteger(depth) || depth < 0) {
-            this.typeError('print', 'Number');
-        }
         const indent = '  '.repeat(depth), str = String(this), { childNodes, type, length } = this;
         if (childNodes.every(child => child.type === 'text' || !String(child))) {
             console.log(`${indent}\x1B[32m<%s>\x1B[0m${(0, string_1.noWrap)(str)}\x1B[32m</%s>\x1B[0m`, type, type);
             return;
         }
-        Parser.info(`${indent}<${type}>`);
+        index_1.default.info(`${indent}<${type}>`);
         let i = this.getPadding();
         if (i) {
             console.log(`${indent}  ${(0, string_1.noWrap)(str.slice(0, i))}`);
@@ -625,7 +628,7 @@ class AstElement extends AstNode {
                 // pass
             }
             else if (child.type === 'text') {
-                console.log(`${indent}  ${(0, string_1.noWrap)(String(child))}`);
+                console.log(`${indent}  ${(0, string_1.noWrap)(child.data)}`);
             }
             else {
                 child.echo(depth + 1);
@@ -639,9 +642,10 @@ class AstElement extends AstNode {
         if (i < str.length) {
             console.log(`${indent}  ${(0, string_1.noWrap)(str.slice(i))}`);
         }
-        Parser.info(`${indent}</${type}>`);
+        index_1.default.info(`${indent}</${type}>`);
     }
 }
+exports.AstElement = AstElement;
 /**
  * 检测:lang()伪选择器
  * @param node 节点
@@ -652,5 +656,4 @@ const matchesLang = ({ attributes }, regex) => {
     const lang = attributes?.['lang'];
     return typeof lang === 'string' && regex.test(lang);
 };
-Parser.classes['AstElement'] = __filename;
-module.exports = AstElement;
+index_1.default.classes['AstElement'] = __filename;

package/dist/lib/node.d.ts

@@ -1,53 +1,50 @@
-import * as Parser from '../index';
-import type * as Ranges from './ranges';
-declare type AstNodeTypes = import('./text') | import('../src');
-declare type TokenAttribute<T extends string> = T extends 'stage' ? number : T extends 'config' ? Parser.Config : T extends 'accum' ? import('../src')[] : T extends 'parentNode' ? import('../src') | undefined : T extends 'childNodes' ? AstNodeTypes[] : T extends 'bracket' | 'include' ? boolean : T extends 'pattern' ? RegExp : T extends 'tags' | 'flags' ? string[] : T extends 'quotes' ? [string?, string?] : T extends 'optional' | 'keys' ? Set<string> : T extends 'args' ? Record<string, Set<import('../src/parameter')>> : T extends 'protectedChildren' ? Ranges : string;
-declare type TokenAttributeGetter<T extends string> = T extends 'acceptable' ? Record<string, Ranges> | undefined : TokenAttribute<T>;
-declare type TokenAttributeSetter<T extends string> = T extends 'acceptable' ? Acceptable | undefined : TokenAttribute<T> | undefined;
-declare interface Dimension {
+import type { AstText, Token } from '../internal';
+export type AstNodes = AstText | Token;
+export type TokenTypes = 'root' | 'plain' | 'onlyinclude' | 'noinclude' | 'include' | 'comment' | 'ext' | 'ext-attrs' | 'ext-attr-dirty' | 'ext-attr' | 'attr-key' | 'attr-value' | 'ext-inner' | 'arg' | 'arg-name' | 'arg-default' | 'hidden' | 'magic-word' | 'magic-word-name' | 'invoke-function' | 'invoke-module' | 'template' | 'template-name' | 'parameter' | 'parameter-key' | 'parameter-value' | 'heading' | 'heading-title' | 'heading-trail' | 'html' | 'html-attrs' | 'html-attr-dirty' | 'html-attr' | 'table' | 'tr' | 'td' | 'table-syntax' | 'table-attrs' | 'table-attr-dirty' | 'table-attr' | 'table-inter' | 'td-inner' | 'hr' | 'double-underscore' | 'link' | 'link-target' | 'link-text' | 'category' | 'file' | 'gallery-image' | 'imagemap-image' | 'image-parameter' | 'quote' | 'ext-link' | 'ext-link-text' | 'ext-link-url' | 'free-ext-link' | 'list' | 'dd' | 'converter' | 'converter-flags' | 'converter-flag' | 'converter-rule' | 'converter-rule-noconvert' | 'converter-rule-variant' | 'converter-rule-to' | 'converter-rule-from' | 'param-line' | 'imagemap-link';
+export interface Dimension {
     height: number;
     width: number;
 }
-declare interface Position {
+export interface Position {
     top: number;
     left: number;
 }
-declare interface CaretPosition {
-    offsetNode: AstNodeTypes;
+export interface CaretPosition {
+    offsetNode: AstNodes;
     offset: number;
 }
 /** 类似Node */
-declare abstract class AstNode {
+export declare abstract class AstNode {
     #private;
     /** @browser */
-    type: string;
+    type: TokenTypes | 'text';
     /** @browser */
-    readonly childNodes: AstNodeTypes[];
+    readonly childNodes: AstNodes[];
     /**
      * 首位子节点
      * @browser
      */
-    get firstChild(): AstNodeTypes | undefined;
+    get firstChild(): AstNodes | undefined;
     /**
      * 末位子节点
      * @browser
      */
-    get lastChild(): AstNodeTypes | undefined;
+    get lastChild(): AstNodes | undefined;
     /**
      * 父节点
      * @browser
      */
-    get parentNode(): import('../src') | undefined;
+    get parentNode(): Token | undefined;
     /**
      * 后一个兄弟节点
      * @browser
      */
-    get nextSibling(): AstNodeTypes | undefined;
+    get nextSibling(): AstNodes | undefined;
     /**
      * 前一个兄弟节点
      * @browser
      */
-    get previousSibling(): AstNodeTypes | undefined;
+    get previousSibling(): AstNodes | undefined;
     /**
      * 行数
      * @browser
@@ -59,13 +56,13 @@ declare abstract class AstNode {
      */
     get offsetWidth(): number;
     /** 后一个非文本兄弟节点 */
-    get nextElementSibling(): import('../src') | undefined;
+    get nextElementSibling(): Token | undefined;
     /** 前一个非文本兄弟节点 */
-    get previousElementSibling(): import('../src') | undefined;
+    get previousElementSibling(): Token | undefined;
     /** 是否具有根节点 */
     get isConnected(): boolean;
     /** 不是自身的根节点 */
-    get ownerDocument(): import('../src') | undefined;
+    get ownerDocument(): Token | undefined;
     /** 后方是否还有其他节点（不含后代） */
     get eof(): boolean | undefined;
     /** 相对于父容器的行号 */
@@ -81,7 +78,7 @@ declare abstract class AstNode {
      * 获取根节点
      * @browser
      */
-    getRootNode(): import('../src') | this;
+    getRootNode(): Token | this;
     /**
      * 将字符位置转换为行列号
      * @browser
@@ -109,12 +106,12 @@ declare abstract class AstNode {
      * 在后方批量插入兄弟节点
      * @param nodes 插入节点
      */
-    after(...nodes: (AstNodeTypes | string)[]): void;
+    after(...nodes: (AstNodes | string)[]): void;
     /**
      * 在前方批量插入兄弟节点
      * @param nodes 插入节点
      */
-    before(...nodes: (AstNodeTypes | string)[]): void;
+    before(...nodes: (AstNodes | string)[]): void;
     /**
      * 移除当前节点
      * @throws `Error` 不存在父节点
@@ -124,7 +121,7 @@ declare abstract class AstNode {
      * 将当前节点批量替换为新的节点
      * @param nodes 插入节点
      */
-    replaceWith(...nodes: (AstNodeTypes | string)[]): void;
+    replaceWith(...nodes: (AstNodes | string)[]): void;
     /**
      * 是自身或后代节点
      * @param node 待检测节点
@@ -137,7 +134,7 @@ declare abstract class AstNode {
      * @param options 选项
      * @param options.once 仅执行一次
      */
-    addEventListener(types: AstEventType | AstEventType[], listener: AstListener, options?: {
+    addEventListener(types: string | string[], listener: (...args: any[]) => void, options?: {
         once?: boolean;
     }): void;
     /**
@@ -145,31 +142,31 @@ declare abstract class AstNode {
      * @param types 事件类型
      * @param listener 监听函数
      */
-    removeEventListener(types: AstEventType | AstEventType[], listener: AstListener): void;
+    removeEventListener(types: string | string[], listener: (...args: any[]) => void): void;
     /**
      * 移除事件的所有监听
      * @param types 事件类型
      */
-    removeAllEventListeners(types?: AstEventType | AstEventType[]): void;
+    removeAllEventListeners(types?: string | string[]): void;
     /**
      * 列举事件监听
      * @param type 事件类型
      */
-    listEventListeners(type: AstEventType): Function[];
+    listEventListeners(type: string): Function[];
     /**
      * 触发事件
      * @param e 事件对象
      * @param data 事件数据
      */
-    dispatchEvent(e: Event, data: AstEventData): void;
+    dispatchEvent(e: Event, data: unknown): void;
     /** 获取所有祖先节点 */
-    getAncestors(): import('../src')[];
+    getAncestors(): Token[];
     /**
      * 比较和另一个节点的相对位置
      * @param other 待比较的节点
      * @throws `Error` 不在同一个语法树
      */
-    compareDocumentPosition(other: AstNodeTypes): number;
+    compareDocumentPosition(other: AstNodes): number;
     /**
      * 将行列号转换为字符位置
      * @param top 行号
@@ -179,7 +176,3 @@ declare abstract class AstNode {
     /** 获取当前节点的行列位置和大小 */
     getBoundingClientRect(): Dimension & Position;
 }
-declare namespace AstNode {
-    export type { AstNodeTypes, TokenAttributeGetter, TokenAttributeSetter, Dimension, Position, CaretPosition, };
-}
-export = AstNode;