wikiparser-node 1.3.9 → 1.4.0

package/dist/base.d.ts

@@ -27,7 +27,7 @@ export interface LintError {
 /** 类似Node */
 export interface AstNode {
     type: string;
-    readonly childNodes: AstNode[];
+    readonly childNodes: readonly AstNode[];
     /** Linter */
     lint(): LintError[];
     /** 以HTML格式打印 */
@@ -41,6 +41,8 @@ interface AstElement extends AstNode {
 export interface Parser {
     config: string | Config;
     i18n: string | Record<string, string> | undefined;
+    /** 获取解析设置 */
+    getConfig(): Config;
     /**
      * 解析wikitext
      * @param include 是否嵌入

package/dist/lib/element.d.ts

@@ -1,15 +1,14 @@
 import { AstNode } from './node';
 import type { LintError } from '../base';
-import type { AstNodes, AstText, Token, HtmlToken, ExtToken } from '../internal';
+import type { AstNodes, AstText, Token } from '../internal';
 /** 类似HTMLElement */
 export declare abstract class AstElement extends AstNode {
-    #private;
     readonly name?: string;
     readonly data: undefined;
     /** 子节点总数 */
     get length(): number;
     /** 全部非文本子节点 */
-    get children(): readonly Token[];
+    get children(): Token[];
     /** 首位非文本子节点 */
     get firstElementChild(): Token | undefined;
     /** 末位非文本子节点 */
@@ -54,7 +53,7 @@ export declare abstract class AstElement extends AstNode {
      * 最近的祖先节点
      * @param selector 选择器
      */
-    closest<T extends Token>(selector: string): T | undefined;
+    closest<T = Token>(selector: string): T | undefined;
     /**
      * 在末尾批量插入子节点
      * @param elements 插入节点
@@ -93,37 +92,37 @@ export declare abstract class AstElement extends AstNode {
      * 检查是否符合选择器
      * @param selector 选择器
      */
-    matches(selector?: string): boolean;
+    matches<T>(selector?: string): this is T;
     /**
      * 符合选择器的第一个后代节点
      * @param selector 选择器
      */
-    querySelector<T extends Token>(selector: string): T | undefined;
+    querySelector<T = Token>(selector: string): T | undefined;
     /**
      * 类型选择器
      * @param types
      */
-    getElementByTypes<T extends Token>(types: string): T | undefined;
+    getElementByTypes<T = Token>(types: string): T | undefined;
     /**
      * id选择器
      * @param id id名
      */
-    getElementById(id: string): Token | undefined;
+    getElementById<T = Token>(id: string): T | undefined;
     /**
      * 符合选择器的所有后代节点
      * @param selector 选择器
      */
-    querySelectorAll<T extends Token>(selector: string): readonly T[];
+    querySelectorAll<T = Token>(selector: string): T[];
     /**
      * 类选择器
      * @param className 类名之一
      */
-    getElementsByClassName(className: string): readonly Token[];
+    getElementsByClassName<T = Token>(className: string): T[];
     /**
      * 标签名选择器
      * @param tag 标签名
      */
-    getElementsByTagName(tag: string): readonly (HtmlToken | ExtToken)[];
+    getElementsByTagName<T = Token>(tag: string): T[];
     /**
      * 获取某一行的wikitext
      * @param n 行号

package/dist/lib/element.js

@@ -6,6 +6,8 @@ const path = require("path");
 const string_1 = require("../util/string");
 const constants_1 = require("../util/constants");
 const debug_1 = require("../util/debug");
+const debug_2 = require("../util/debug");
+const lint_1 = require("../util/lint");
 const selector_1 = require("../parser/selector");
 const ranges_1 = require("./ranges");
 const title_1 = require("./title");
@@ -156,19 +158,28 @@ class AstElement extends node_1.AstNode {
         return node;
     }
     /**
-     * 最近的祖先节点
+     * 将选择器转化为类型谓词
      * @param selector 选择器
      */
-    closest(selector) {
-        let { parentNode } = this, condition;
+    #getCondition(selector) {
+        let condition;
         if (/[^a-z\-,\s]/u.test(selector)) {
             const stack = (0, selector_1.parseSelector)(selector);
-            condition = /** @implements */ (token) => token.#matchesStack(stack);
+            condition = (token => stack.some(copy => token.#matchesArray(copy)));
         }
         else {
             const types = new Set(selector.split(',').map(str => str.trim()));
-            condition = /** @implements */ (token) => types.has(token.type);
+            condition = (token => types.has(token.type));
         }
+        return condition;
+    }
+    /**
+     * 最近的祖先节点
+     * @param selector 选择器
+     */
+    closest(selector) {
+        const condition = this.#getCondition(selector);
+        let { parentNode } = this;
         while (parentNode) {
             if (condition(parentNode)) {
                 return parentNode;
@@ -225,9 +236,18 @@ class AstElement extends node_1.AstNode {
      */
     lint(start = this.getAbsoluteIndex()) {
         const errors = [];
+        const cats = new Set(), isCategory = (0, debug_2.isToken)('category');
         for (let i = 0, cur = start + this.getAttribute('padding'); i < this.length; i++) {
             const child = this.childNodes[i];
             errors.push(...child.lint(cur));
+            if (isCategory(child)) {
+                if (cats.has(child.name)) {
+                    errors.push((0, lint_1.generateForSelf)(child, { start: cur }, 'duplicated category'));
+                }
+                else {
+                    cats.add(child.name);
+                }
+            }
             cur += String(child).length + this.getGaps(i);
         }
         return errors;
@@ -458,19 +478,12 @@ class AstElement extends node_1.AstNode {
         }
         return false;
     }
-    /**
-     * 检查是否符合解析后的组合选择器
-     * @param stack 解析后的一组选择器
-     */
-    #matchesStack(stack) {
-        return stack.some(condition => this.#matchesArray(condition));
-    }
     /**
      * 检查是否符合选择器
      * @param selector 选择器
      */
     matches(selector) {
-        return selector === undefined || this.#matchesStack((0, selector_1.parseSelector)(selector));
+        return selector === undefined || this.#getCondition(selector)(this);
     }
     /**
      * 符合条件的第一个后代节点
@@ -493,8 +506,8 @@ class AstElement extends node_1.AstNode {
      * @param selector 选择器
      */
     querySelector(selector) {
-        const stack = (0, selector_1.parseSelector)(selector);
-        return this.#getElementBy(token => token.#matchesStack(stack));
+        const condition = this.#getCondition(selector);
+        return this.#getElementBy(condition);
     }
     /**
      * 类型选择器
@@ -502,14 +515,14 @@ class AstElement extends node_1.AstNode {
      */
     getElementByTypes(types) {
         const typeSet = new Set(types.split(',').map(str => str.trim()));
-        return this.#getElementBy(({ type }) => typeSet.has(type));
+        return this.#getElementBy((({ type }) => typeSet.has(type)));
     }
     /**
      * id选择器
      * @param id id名
      */
     getElementById(id) {
-        return this.#getElementBy(token => 'id' in token && token.id === id);
+        return this.#getElementBy((token => 'id' in token && token.id === id));
     }
     /**
      * 符合条件的所有后代节点
@@ -530,22 +543,22 @@ class AstElement extends node_1.AstNode {
      * @param selector 选择器
      */
     querySelectorAll(selector) {
-        const stack = (0, selector_1.parseSelector)(selector);
-        return this.#getElementsBy(token => token.#matchesStack(stack));
+        const condition = this.#getCondition(selector);
+        return this.#getElementsBy(condition);
     }
     /**
      * 类选择器
      * @param className 类名之一
      */
     getElementsByClassName(className) {
-        return this.#getElementsBy(token => 'classList' in token && token.classList.has(className));
+        return this.#getElementsBy((token => 'classList' in token && token.classList.has(className)));
     }
     /**
      * 标签名选择器
      * @param tag 标签名
      */
     getElementsByTagName(tag) {
-        return this.#getElementsBy(({ type, name }) => name === tag && (type === 'html' || type === 'ext'));
+        return this.#getElementsBy((({ type, name }) => name === tag && (type === 'html' || type === 'ext')));
     }
     /**
      * 获取某一行的wikitext

package/dist/lib/node.d.ts

@@ -16,10 +16,9 @@ export interface CaretPosition {
 }
 /** 类似Node */
 export declare abstract class AstNode implements AstNodeBase {
-    #private;
     type: TokenTypes | 'text';
     data?: string | undefined;
-    readonly childNodes: AstNodes[];
+    readonly childNodes: readonly AstNodes[];
     abstract lint(): LintError[];
     abstract print(): string;
     /** 首位子节点 */
@@ -120,7 +119,7 @@ export declare abstract class AstNode implements AstNodeBase {
      * 列举事件监听
      * @param type 事件类型
      */
-    listEventListeners(type: string): readonly Function[];
+    listEventListeners(type: string): Function[];
     /**
      * 触发事件
      * @param e 事件对象

package/dist/lib/node.js

@@ -94,7 +94,7 @@ class AstNode {
     }
     /** @private */
     get fixed() {
-        return 'fixed' in this.constructor;
+        return false;
     }
     constructor() {
         Object.defineProperty(this, 'childNodes', { writable: false });
@@ -203,13 +203,13 @@ class AstNode {
         throw new Error(`${this.constructor.name} ${msg}！`);
     }
     /** @private */
-    seal(key, hidden) {
-        if (!hidden) {
+    seal(key, permanent) {
+        if (!permanent) {
             this.#optional.add(key);
         }
         Object.defineProperty(this, key, {
             writable: false,
-            enumerable: !hidden && Boolean(this[key]),
+            enumerable: !permanent && Boolean(this[key]),
             configurable: true,
         });
     }

package/dist/lib/range.d.ts

@@ -2,7 +2,6 @@ import type { AstNodes } from '../internal';
 import type { Dimension, Position } from './node';
 /** 模拟Range对象 */
 export declare class AstRange {
-    #private;
     /** 起点容器 */
     get startContainer(): AstNodes;
     /** 起点位置 */
@@ -98,7 +97,7 @@ export declare class AstRange {
      */
     insertNode(newNode: AstNodes | string): void;
     /** 获取范围内的全部节点 */
-    extractContents(): readonly AstNodes[];
+    extractContents(): AstNodes[];
     /** 在满足条件时拷贝范围内的全部节点 */
-    cloneContents(): readonly AstNodes[];
+    cloneContents(): AstNodes[];
 }

package/dist/lib/ranges.d.ts

@@ -1,6 +1,5 @@
 /** 模拟Python的Range对象。除`step`至少为`1`外，允许负数、小数或`end < start`的情形。 */
 export declare class Range {
-    #private;
     /**
      * @param s 表达式
      * @throws `RangeError` 起点、终点和步长均应为整数
@@ -12,7 +11,7 @@ export declare class Range {
      * 将Range转换为针对特定数组的下标集
      * @param arr 参考数组`[0, 1, 2, ...]`
      */
-    applyTo(arr: readonly number[]): readonly number[];
+    applyTo(arr: readonly number[]): number[];
 }
 /** @extends {Array<number|Range>} */
 export declare class Ranges extends Array<number | Range> {
@@ -22,5 +21,5 @@ export declare class Ranges extends Array<number | Range> {
      * 将Ranges转换为针对特定Array的下标集
      * @param arr 参考数组
      */
-    applyTo(arr: number | readonly unknown[]): readonly number[];
+    applyTo(arr: number | readonly unknown[]): number[];
 }

package/dist/lib/text.d.ts

@@ -2,7 +2,6 @@ import { AstNode } from './node';
 import type { LintError } from '../base';
 /** 文本节点 */
 export declare class AstText extends AstNode {
-    #private;
     readonly type = "text";
     readonly name: undefined;
     readonly data: string;

package/dist/lib/title.d.ts

@@ -1,7 +1,6 @@
 import * as Parser from '../index';
 /** MediaWiki页面标题对象 */
 export declare class Title {
-    #private;
     readonly valid: boolean;
     ns: number;
     fragment: string | undefined;

package/dist/mixin/attributesParent.d.ts

@@ -0,0 +1,80 @@
+import type { AstNodes, AttributesToken } from '../internal';
+export interface AttributesParentBase {
+    attributes: Record<string, string | true>;
+    className: string;
+    classList: Set<string>;
+    id: string;
+    hasAttr(key: string): boolean;
+    getAttr(key: string): string | true | undefined;
+    getAttrNames(): Set<string>;
+    getAttrs(): Record<string, string | true>;
+    setAttr(key: string, value: string | boolean): void;
+    setAttr(prop: Record<string, string | boolean>): void;
+    removeAttr(key: string): void;
+    toggleAttr(key: string, force?: boolean): void;
+}
+/**
+ * 子节点含有AttributesToken的类
+ * @param constructor 基类
+ * @param i AttributesToken子节点的位置
+ */
+export declare const attributesParent: <T extends AstConstructor>(constructor: T, i?: number) => (abstract new (...args: any[]) => {
+    readonly childNodes: readonly AstNodes[];
+    /** AttributesToken子节点 */
+    readonly "__#7@#attributesChild": AttributesToken;
+    /** getAttrs()方法的getter写法 */
+    attributes: Record<string, string | true>;
+    /** 以字符串表示的class属性 */
+    className: string;
+    /** 以Set表示的class属性 */
+    classList: Set<string>;
+    /** id属性 */
+    id: string;
+    /**
+     * AttributesToken子节点是否具有某属性
+     * @param key 属性键
+     */
+    hasAttr(key: string): boolean;
+    /**
+     * 获取AttributesToken子节点的属性
+     * @param key 属性键
+     */
+    getAttr(key: string): string | true | undefined;
+    /** 列举AttributesToken子节点的属性键 */
+    getAttrNames(): Set<string>;
+    /** 获取AttributesToken子节点的全部标签属性 */
+    getAttrs(): Record<string, string | true>;
+    /**
+     * 对AttributesToken子节点设置属性
+     * @param key 属性键
+     * @param value 属性值
+     * @param prop 属性对象
+     */
+    setAttr(key: string, value: string | boolean): void;
+    /**
+     * 对AttributesToken子节点设置属性
+     * @param key 属性键
+     * @param value 属性值
+     * @param prop 属性对象
+     */
+    setAttr(prop: Record<string, string | boolean>): void;
+    /**
+     * 移除AttributesToken子节点的某属性
+     * @param key 属性键
+     */
+    removeAttr(key: string): void;
+    /**
+     * 开关AttributesToken子节点的某属性
+     * @param key 属性键
+     * @param force 强制开启或关闭
+     */
+    toggleAttr(key: string, force?: boolean): void;
+    toString(omit?: Set<string> | undefined, separator?: string | undefined): string;
+    text(separator?: string | undefined): string;
+    insertAt(token: unknown, i?: number | undefined): unknown;
+    getAttribute<T_1 extends string>(key: T_1): TokenAttributeGetter<T_1>;
+    setAttribute<T_2 extends string>(key: T_2, value: TokenAttributeSetter<T_2>): void;
+    addEventListener(events: string | string[], listener: AstListener): void;
+    replaceChildren(...elements: (string | AstNodes)[]): void;
+    constructorError(msg: string): never;
+}) & T;

package/dist/mixin/fixed.d.ts

@@ -0,0 +1,31 @@
+import type { AstNodes, AstText } from '../internal';
+export interface FixedTokenBase {
+    removeAt(): never;
+}
+/**
+ * 不可增删子节点的类
+ * @param constructor 基类
+ */
+export declare const fixedToken: <S extends AstConstructor>(constructor: S) => (abstract new (...args: any[]) => {
+    /** @override */
+    removeAt(): never;
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     */
+    insertAt(token: string, i?: number): AstText;
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     */
+    insertAt<T extends AstNodes>(token: T, i?: number): T;
+    toString(omit?: Set<string> | undefined, separator?: string | undefined): string;
+    text(separator?: string | undefined): string; /** @private */
+    getAttribute<T_1 extends string>(key: T_1): TokenAttributeGetter<T_1>;
+    setAttribute<T_2 extends string>(key: T_2, value: TokenAttributeSetter<T_2>): void;
+    addEventListener(events: string | string[], listener: AstListener): void;
+    replaceChildren(...elements: (string | AstNodes)[]): void;
+    constructorError(msg: string): never;
+}) & S;

package/dist/mixin/fixed.js

@@ -1,16 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fixed = void 0;
+exports.fixedToken = void 0;
 const debug_1 = require("../util/debug");
 const constants_1 = require("../util/constants");
 /**
  * 不可增删子节点的类
  * @param constructor 基类
  */
-const fixed = (constructor) => {
+const fixedToken = (constructor) => {
     /** 不可增删子节点的类 */
     class FixedToken extends constructor {
-        static fixed = true;
+        /** @private */
+        get fixed() {
+            return true;
+        }
         /** @override */
         removeAt() {
             this.constructorError('不可删除元素');
@@ -21,5 +24,5 @@ const fixed = (constructor) => {
     }
     return FixedToken;
 };
-exports.fixed = fixed;
-constants_1.mixins['fixed'] = __filename;
+exports.fixedToken = fixedToken;
+constants_1.mixins['fixedToken'] = __filename;

package/dist/mixin/flagsParent.d.ts

@@ -0,0 +1,61 @@
+import type { ConverterFlagsToken } from '../src/converterFlags';
+export interface FlagsParentBase {
+    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;
+}
+/**
+ * ConverterToken
+ * @param constructor 基类
+ */
+export declare const flagsParent: <T extends AstConstructor>(constructor: T) => (abstract new (...args: any[]) => {
+    readonly firstChild: ConverterFlagsToken;
+    readonly firstElementChild: ConverterFlagsToken;
+    /** 所有转换类型标记 */
+    flags: Set<string>;
+    /** 获取所有转换类型标记 */
+    getAllFlags(): Set<string>;
+    /** 获取有效的转换类型标记 */
+    getEffectiveFlags(): Set<string>;
+    /** 获取未知的转换类型标记 */
+    getUnknownFlags(): 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;
+    toString(omit?: Set<string> | undefined, separator?: string | undefined): string;
+    text(separator?: string | undefined): string;
+    insertAt(token: unknown, i?: number | undefined): unknown;
+    getAttribute<T_1 extends string>(key: T_1): TokenAttributeGetter<T_1>;
+    setAttribute<T_2 extends string>(key: T_2, value: TokenAttributeSetter<T_2>): void;
+    addEventListener(events: string | string[], listener: AstListener): void;
+    replaceChildren(...elements: (string | import("..").AstNodes)[]): void;
+    constructorError(msg: string): never;
+}) & T;

package/dist/mixin/hidden.d.ts

@@ -0,0 +1,18 @@
+import type { LintError } from '../base';
+/**
+ * 解析后不可见的类
+ * @param constructor 基类
+ */
+export declare const hiddenToken: <T extends AstConstructor>(constructor: T) => (abstract new (...args: any[]) => {
+    /** 没有可见部分 */
+    text(): string;
+    /** @override */
+    lint(): LintError[];
+    toString(omit?: Set<string> | undefined, separator?: string | undefined): string;
+    insertAt(token: unknown, i?: number | undefined): unknown;
+    getAttribute<T_1 extends string>(key: T_1): TokenAttributeGetter<T_1>;
+    setAttribute<T_2 extends string>(key: T_2, value: TokenAttributeSetter<T_2>): void;
+    addEventListener(events: string | string[], listener: AstListener): void;
+    replaceChildren(...elements: (string | import("..").AstNodes)[]): void;
+    constructorError(msg: string): never;
+}) & T;

package/dist/mixin/hidden.js

@@ -1,15 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hidden = void 0;
+exports.hiddenToken = void 0;
 const constants_1 = require("../util/constants");
 /**
  * 解析后不可见的类
  * @param constructor 基类
  */
-const hidden = (constructor) => {
+const hiddenToken = (constructor) => {
     /** 解析后不可见的类 */
     class AnyHiddenToken extends constructor {
-        static hidden = true;
         /** 没有可见部分 */
         text() {
             return '';
@@ -21,5 +20,5 @@ const hidden = (constructor) => {
     }
     return AnyHiddenToken;
 };
-exports.hidden = hidden;
-constants_1.mixins['hidden'] = __filename;
+exports.hiddenToken = hiddenToken;
+constants_1.mixins['hiddenToken'] = __filename;

package/dist/mixin/magicLinkParent.d.ts

@@ -0,0 +1,34 @@
+import type { MagicLinkToken } from '../src/magicLink';
+export interface MagicLinkParentBase {
+    protocol: string | undefined;
+    link: string;
+    getUrl(): URL;
+    setTarget(url: string): void;
+}
+/**
+ * ExtLinkToken
+ * @param constructor 基类
+ */
+export declare const magicLinkParent: <T extends AstConstructor>(constructor: T) => (abstract new (...args: any[]) => {
+    readonly firstChild: MagicLinkToken;
+    readonly firstElementChild: MagicLinkToken;
+    /** 协议 */
+    protocol: string | undefined;
+    /** 和内链保持一致 */
+    link: string;
+    /** 获取网址 */
+    getUrl(): URL;
+    /**
+     * 设置链接目标
+     * @param url 网址
+     */
+    setTarget(url: string): void;
+    toString(omit?: Set<string> | undefined, separator?: string | undefined): string;
+    text(separator?: string | undefined): string;
+    insertAt(token: unknown, i?: number | undefined): unknown;
+    getAttribute<T_1 extends string>(key: T_1): TokenAttributeGetter<T_1>;
+    setAttribute<T_2 extends string>(key: T_2, value: TokenAttributeSetter<T_2>): void;
+    addEventListener(events: string | string[], listener: AstListener): void;
+    replaceChildren(...elements: (string | import("..").AstNodes)[]): void;
+    constructorError(msg: string): never;
+}) & T;

package/dist/mixin/singleLine.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 不可包含换行符的类
+ * @param constructor 基类
+ */
+export declare const singleLine: <T extends AstConstructor>(constructor: T) => (abstract new (...args: any[]) => {
+    /** @override */
+    text(): string;
+    insertAt(token: unknown, i?: number | undefined): unknown;
+    getAttribute<T_1 extends string>(key: T_1): TokenAttributeGetter<T_1>;
+    setAttribute<T_2 extends string>(key: T_2, value: TokenAttributeSetter<T_2>): void;
+    addEventListener(events: string | string[], listener: AstListener): void;
+    replaceChildren(...elements: (string | import("..").AstNodes)[]): void;
+    constructorError(msg: string): never;
+}) & T;

package/dist/mixin/sol.d.ts

@@ -0,0 +1,18 @@
+export interface SolTokenBase {
+    prependNewLine(): string;
+}
+/**
+ * 只能位于行首的类
+ * @param constructor 基类
+ */
+export declare const sol: <T extends AstConstructor>(constructor: T) => (abstract new (...args: any[]) => {
+    /** 在前方插入newline */
+    prependNewLine(): string;
+    /** @override */
+    text(): string;
+    insertAt(token: unknown, i?: number | undefined): unknown;
+    setAttribute<T_1 extends string>(key: T_1, value: TokenAttributeSetter<T_1>): void;
+    addEventListener(events: string | string[], listener: AstListener): void;
+    replaceChildren(...elements: (string | import("..").AstNodes)[]): void; /** @private */
+    constructorError(msg: string): never;
+}) & T;