wikiparser-node 1.3.1-b → 1.3.2

package/dist/src/gallery.d.ts

@@ -0,0 +1,55 @@
+import * as Parser from '../index';
+import { Token } from './index';
+import { GalleryImageToken } from './link/galleryImage';
+import { NoincludeToken } from './nowiki/noinclude';
+import type { LintError } from '../base';
+import type { AstNodes, AstText, AttributesToken, ExtToken } from '../internal';
+/**
+ * gallery标签
+ * @classdesc `{childNodes: ...(GalleryImageToken|NoincludeToken|AstText)}`
+ */
+export declare class GalleryToken extends Token {
+    #private;
+    readonly type = "ext-inner";
+    readonly name: 'gallery';
+    readonly childNodes: (GalleryImageToken | NoincludeToken | AstText)[];
+    abstract get children(): (GalleryImageToken | NoincludeToken)[];
+    abstract get firstChild(): GalleryImageToken | NoincludeToken | AstText | undefined;
+    abstract get firstElementChild(): GalleryImageToken | NoincludeToken | undefined;
+    abstract get lastChild(): GalleryImageToken | NoincludeToken | AstText | undefined;
+    abstract get lastElementChild(): GalleryImageToken | NoincludeToken | undefined;
+    abstract get nextSibling(): undefined;
+    abstract get nextElementSibling(): undefined;
+    abstract get previousSibling(): AttributesToken;
+    abstract get previousElementSibling(): AttributesToken;
+    abstract get parentNode(): ExtToken | undefined;
+    abstract get parentElement(): ExtToken | undefined;
+    /** 所有图片 */
+    get images(): readonly GalleryImageToken[];
+    /** @param inner 标签内部wikitext */
+    constructor(inner?: string, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** @override */
+    lint(start?: number): LintError[];
+    /** @override */
+    print(): string;
+    /** @override */
+    cloneNode(): this;
+    /**
+     * 插入图片
+     * @param file 图片文件名
+     * @param i 插入位置
+     * @throws `SyntaxError` 非法的文件名
+     */
+    insertImage(file: string, i?: number): GalleryImageToken;
+    /**
+     * @override
+     * @param token 待插入的节点
+     * @param i 插入位置
+     * @throws `RangeError` 插入不可见内容
+     */
+    insertAt(token: string, i?: number): AstText;
+    /** @ignore */
+    insertAt<T extends AstNodes>(token: T, i?: number): T;
+}

package/dist/src/gallery.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GalleryToken = void 0;
+const debug_1 = require("../util/debug");
+const constants_1 = require("../util/constants");
+const Parser = require("../index");
+const index_1 = require("./index");
+const galleryImage_1 = require("./link/galleryImage");
+const noinclude_1 = require("./nowiki/noinclude");
+/**
+ * gallery标签
+ * @classdesc `{childNodes: ...(GalleryImageToken|NoincludeToken|AstText)}`
+ */
+class GalleryToken extends index_1.Token {
+    type = 'ext-inner';
+    /* NOT FOR BROWSER */
+    /** 所有图片 */
+    get images() {
+        return this.childNodes.filter((child) => child.type === 'gallery-image');
+    }
+    /* NOT FOR BROWSER END */
+    /** @param inner 标签内部wikitext */
+    constructor(inner, config = Parser.getConfig(), accum = []) {
+        super(undefined, config, accum, {
+            AstText: ':', GalleryImageToken: ':', NoincludeToken: ':',
+        });
+        for (const line of inner?.split('\n') ?? []) {
+            const matches = /^([^|]+)(?:\|(.*))?/u.exec(line);
+            if (!matches) {
+                super.insertAt((line.trim() ? new noinclude_1.NoincludeToken(line, config) : line));
+                continue;
+            }
+            const [, file, alt] = matches;
+            if (this.#checkFile(file)) {
+                super.insertAt(new galleryImage_1.GalleryImageToken('gallery', file, alt, config, accum));
+            }
+            else {
+                super.insertAt(new noinclude_1.NoincludeToken(line, config));
+            }
+        }
+    }
+    /**
+     * 检查文件名是否有效
+     * @param file 文件名
+     */
+    #checkFile(file) {
+        return this.normalizeTitle(file, 6, true, true).valid;
+    }
+    /** @private */
+    toString(omit) {
+        return super.toString(omit, '\n');
+    }
+    /** @override */
+    text() {
+        return super.text('\n').replace(/\n\s*\n/gu, '\n');
+    }
+    /** @private */
+    getGaps() {
+        return 1;
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        const { top, left } = this.getRootNode().posFromIndex(start), errors = [];
+        for (let i = 0; i < this.length; i++) {
+            const child = this.childNodes[i], str = String(child), { length } = str, trimmed = str.trim(), startLine = top + i, startCol = i ? 0 : left;
+            if (child.type === 'noinclude' && trimmed && !/^<!--.*-->$/u.test(trimmed)) {
+                errors.push({
+                    message: Parser.msg('invalid content in <$1>', 'gallery'),
+                    severity: 'error',
+                    startIndex: start,
+                    endIndex: start + length,
+                    startLine,
+                    endLine: startLine,
+                    startCol,
+                    endCol: startCol + length,
+                });
+            }
+            else if (child.type !== 'noinclude' && child.type !== 'text') {
+                errors.push(...child.lint(start));
+            }
+            start += length + 1;
+        }
+        return errors;
+    }
+    /** @override */
+    print() {
+        return super.print({ sep: '\n' });
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const cloned = this.cloneChildNodes();
+        return debug_1.Shadow.run(() => {
+            const token = new GalleryToken(undefined, this.getAttribute('config'));
+            token.append(...cloned);
+            return token;
+        });
+    }
+    /**
+     * 插入图片
+     * @param file 图片文件名
+     * @param i 插入位置
+     * @throws `SyntaxError` 非法的文件名
+     */
+    insertImage(file, i) {
+        if (this.#checkFile(file)) {
+            const token = debug_1.Shadow.run(() => new galleryImage_1.GalleryImageToken('gallery', file, undefined, this.getAttribute('config')));
+            token.afterBuild();
+            return this.insertAt(token, i);
+        }
+        throw new SyntaxError(`非法的文件名：${file}`);
+    }
+    /** @ignore */
+    insertAt(token, i = this.length) {
+        if (typeof token === 'string' && token.trim() || token instanceof noinclude_1.NoincludeToken) {
+            throw new RangeError('请勿向图库中插入不可见内容！');
+        }
+        return super.insertAt(token, i);
+    }
+}
+exports.GalleryToken = GalleryToken;
+constants_1.classes['GalleryToken'] = __filename;

package/dist/src/heading.d.ts

@@ -0,0 +1,74 @@
+import * as Parser from '../index';
+import { Token } from './index';
+import { SyntaxToken } from './syntax';
+import type { LintError } from '../base';
+declare const HeadingToken_base: (abstract new (...args: any[]) => {
+    prependNewLine(): string;
+    toString(omit?: Set<string> | undefined): string;
+    getAttribute<S extends string>(key: S): TokenAttributeGetter<S>;
+    text(): string;
+    readonly length: number;
+    lint(start?: number | undefined): Parser.LintError[];
+    insertAt(token: unknown, i?: number | undefined): unknown;
+    afterBuild(): void;
+    setAttribute<T extends string>(key: T, value: TokenAttributeSetter<T>): void;
+    addEventListener(events: string | string[], listener: AstListener): void;
+    replaceChildren(...elements: (string | Parser.AstNodes)[]): void;
+}) & ((abstract new (...args: any[]) => {
+    removeAt(): never;
+    insertAt(token: string, i?: number | undefined): Parser.AstText;
+    insertAt<T_1 extends Parser.AstNodes>(token: T_1, i?: number | undefined): T_1;
+    readonly length: number;
+    toString(omit?: Set<string> | undefined, separator?: string | undefined): string;
+    text(separator?: string | undefined): string;
+    lint(start?: number | undefined): Parser.LintError[];
+    afterBuild(): void;
+    getAttribute<T_2 extends string>(key: T_2): TokenAttributeGetter<T_2>;
+    setAttribute<T extends string>(key: T, value: TokenAttributeSetter<T>): void;
+    addEventListener(events: string | string[], listener: AstListener): void;
+    replaceChildren(...elements: (string | Parser.AstNodes)[]): void;
+}) & {
+    readonly fixed: true;
+}) & typeof Parser.Token;
+/**
+ * 章节标题
+ * @classdesc `{childNodes: [Token, SyntaxToken]}`
+ */
+export declare class HeadingToken extends HeadingToken_base {
+    #private;
+    readonly type = "heading";
+    readonly childNodes: [Token, SyntaxToken];
+    abstract get children(): [Token, SyntaxToken];
+    abstract get firstChild(): Token;
+    abstract get firstElementChild(): Token;
+    abstract get lastChild(): SyntaxToken;
+    abstract get lastElementChild(): SyntaxToken;
+    /** 标题层级 */
+    get level(): number;
+    set level(n: number);
+    /** 内部wikitext */
+    get innerText(): string;
+    /** @throws `RangeError` 首尾包含`=` */
+    set innerText(text: string);
+    /**
+     * @param level 标题层级
+     * @param input 标题文字
+     */
+    constructor(level: number, input: readonly [string?, string?], config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** @override */
+    lint(start?: number): LintError[];
+    /** @override */
+    print(): string;
+    /** @override */
+    cloneNode(): this;
+    /**
+     * 设置标题层级
+     * @param n 标题层级
+     */
+    setLevel(n: number): void;
+    /** 移除标题后的不可见内容 */
+    removeTrail(): void;
+}
+export {};

package/dist/src/heading.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HeadingToken = void 0;
+const lint_1 = require("../util/lint");
+const debug_1 = require("../util/debug");
+const constants_1 = require("../util/constants");
+const fixed_1 = require("../mixin/fixed");
+const sol_1 = require("../mixin/sol");
+const Parser = require("../index");
+const index_1 = require("./index");
+const syntax_1 = require("./syntax");
+/**
+ * 章节标题
+ * @classdesc `{childNodes: [Token, SyntaxToken]}`
+ */
+class HeadingToken extends (0, sol_1.sol)((0, fixed_1.fixed)(index_1.Token)) {
+    type = 'heading';
+    #level;
+    /** 标题格式的等号 */
+    get #equals() {
+        return '='.repeat(this.level);
+    }
+    /** 标题层级 */
+    get level() {
+        return this.#level;
+    }
+    /* NOT FOR BROWSER */
+    set level(n) {
+        this.setLevel(n);
+    }
+    /** 内部wikitext */
+    get innerText() {
+        return this.firstChild.text();
+    }
+    /** @throws `RangeError` 首尾包含`=` */
+    set innerText(text) {
+        if (text.length > 1 && text.startsWith('=') && text.endsWith('=')) {
+            throw new RangeError(`修改标题层级请使用 ${this.constructor.name}.setLevel 方法！`);
+        }
+        const { childNodes } = Parser.parse(text, this.getAttribute('include'), undefined, this.getAttribute('config'));
+        this.firstChild.replaceChildren(...childNodes);
+    }
+    /* NOT FOR BROWSER END */
+    /**
+     * @param level 标题层级
+     * @param input 标题文字
+     */
+    constructor(level, input, config = Parser.getConfig(), accum = []) {
+        super(undefined, config, accum);
+        this.#level = level;
+        const token = new index_1.Token(input[0], config, accum);
+        token.type = 'heading-title';
+        token.setAttribute('stage', 2);
+        const trail = new syntax_1.SyntaxToken(input[1], /^[^\S\n]*$/u, 'heading-trail', config, accum, {
+            'Stage-1': ':', '!ExtToken': '',
+        });
+        this.append(token, trail);
+    }
+    /** @private */
+    toString(omit) {
+        const equals = this.#equals;
+        return omit && this.matchesTypes(omit)
+            ? ''
+            : `${this.prependNewLine()}${equals}${this.firstChild.toString(omit)}${equals}${this.lastChild.toString(omit)}`;
+    }
+    /** @override */
+    text() {
+        const equals = this.#equals;
+        return `${this.prependNewLine()}${equals}${this.firstChild.text()}${equals}`;
+    }
+    /** @private */
+    getAttribute(key) {
+        return key === 'padding'
+            ? super.getAttribute('padding') + this.level
+            : super.getAttribute(key);
+    }
+    /** @private */
+    getGaps() {
+        return this.level;
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        const errors = super.lint(start), { firstChild } = this, innerStr = String(firstChild);
+        let refError;
+        if (this.level === 1) {
+            refError = (0, lint_1.generateForChild)(firstChild, { start }, '<h1>');
+            errors.push(refError);
+        }
+        if (innerStr.startsWith('=') || innerStr.endsWith('=')) {
+            refError ??= (0, lint_1.generateForChild)(firstChild, { start }, '');
+            errors.push({ ...refError, message: Parser.msg('unbalanced "=" in a section header') });
+        }
+        if (this.closest('html-attrs, table-attrs')) {
+            errors.push({ ...(0, lint_1.generateForSelf)(this, { start }, ''), message: Parser.msg('section header in a HTML tag') });
+        }
+        return errors;
+    }
+    /** @override */
+    print() {
+        const equals = this.#equals;
+        return super.print({ pre: equals, sep: equals });
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const [title, trail] = this.cloneChildNodes();
+        return debug_1.Shadow.run(() => {
+            const token = new HeadingToken(this.level, [], this.getAttribute('config'));
+            token.firstChild.safeReplaceWith(title);
+            token.lastChild.safeReplaceWith(trail);
+            return token;
+        });
+    }
+    /**
+     * 设置标题层级
+     * @param n 标题层级
+     */
+    setLevel(n) {
+        this.#level = Math.min(Math.max(n, 1), 6);
+    }
+    /** 移除标题后的不可见内容 */
+    removeTrail() {
+        this.lastChild.replaceChildren();
+    }
+}
+exports.HeadingToken = HeadingToken;
+constants_1.classes['HeadingToken'] = __filename;

package/dist/src/hidden.d.ts

@@ -0,0 +1,22 @@
+import { Token } from './index';
+declare const HiddenToken_base: ((abstract new (...args: any[]) => {
+    text(): string;
+    lint(): import("..").LintError[];
+    readonly length: number;
+    toString(omit?: Set<string> | undefined, separator?: string | undefined): string;
+    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 | import("..").AstNodes)[]): void;
+}) & {
+    readonly hidden: true;
+}) & typeof Token;
+/** 不可见的节点 */
+export declare class HiddenToken extends HiddenToken_base {
+    readonly type = "hidden";
+    /** @override */
+    cloneNode(): this;
+}
+export {};

package/dist/src/hidden.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HiddenToken = void 0;
+const debug_1 = require("../util/debug");
+const constants_1 = require("../util/constants");
+const hidden_1 = require("../mixin/hidden");
+const index_1 = require("./index");
+/** 不可见的节点 */
+class HiddenToken extends (0, hidden_1.hidden)(index_1.Token) {
+    type = 'hidden';
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const cloned = this.cloneChildNodes(), config = this.getAttribute('config'), acceptable = this.getAttribute('acceptable');
+        return debug_1.Shadow.run(() => {
+            const token = new HiddenToken(undefined, config, [], acceptable);
+            token.append(...cloned);
+            return token;
+        });
+    }
+}
+exports.HiddenToken = HiddenToken;
+constants_1.classes['HiddenToken'] = __filename;

package/dist/src/html.d.ts

@@ -0,0 +1,101 @@
+import * as Parser from '../index';
+import { Token } from './index';
+import type { LintError } from '../base';
+import type { AttributesToken } from '../internal';
+declare const HtmlToken_base: (abstract new (...args: any[]) => {
+    readonly childNodes: Parser.AstNodes[];
+    readonly "__#7@#attributesChild": Parser.AttributesToken;
+    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;
+    removeAttr(key: string): void;
+    toggleAttr(key: string, force?: boolean | undefined): 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;
+}) & ((abstract new (...args: any[]) => {
+    removeAt(): never;
+    insertAt(token: string, i?: number | undefined): Parser.AstText;
+    insertAt<T_2 extends Parser.AstNodes>(token: T_2, i?: number | undefined): T_2;
+    readonly length: number;
+    toString(omit?: Set<string> | undefined, separator?: string | undefined): string;
+    text(separator?: string | undefined): string;
+    lint(start?: number | undefined): Parser.LintError[];
+    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;
+}) & {
+    readonly fixed: true;
+}) & typeof Parser.Token;
+/**
+ * HTML标签
+ * @classdesc `{childNodes: [AttributesToken]}`
+ */
+export declare class HtmlToken extends HtmlToken_base {
+    #private;
+    readonly type = "html";
+    readonly name: string;
+    readonly childNodes: [AttributesToken];
+    abstract get children(): [AttributesToken];
+    abstract get firstChild(): AttributesToken;
+    abstract get firstElementChild(): AttributesToken;
+    abstract get lastChild(): AttributesToken;
+    abstract get lastElementChild(): AttributesToken;
+    /** 是否是闭合标签 */
+    get closing(): boolean;
+    /** @throws `Error` 自封闭标签或空标签 */
+    set closing(value: boolean);
+    /** 是否自封闭 */
+    get selfClosing(): boolean;
+    /** @throws `Error` 闭合标签或无效自封闭标签 */
+    set selfClosing(value: boolean);
+    /**
+     * @param name 标签名
+     * @param attr 标签属性
+     * @param closing 是否闭合
+     * @param selfClosing 是否自封闭
+     */
+    constructor(name: string, attr: AttributesToken, closing: boolean, selfClosing: boolean, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** @override */
+    lint(start?: number): LintError[];
+    /**
+     * 搜索匹配的标签
+     * @throws `SyntaxError` 同时闭合和自封闭的标签
+     * @throws `SyntaxError` 无效自封闭标签
+     * @throws `SyntaxError` 未闭合的标签
+     */
+    findMatchingTag(): this | undefined;
+    /** @override */
+    print(): string;
+    /** @override */
+    cloneNode(): this;
+    /**
+     * 更换标签名
+     * @param tag 标签名
+     * @throws `RangeError` 非法的HTML标签
+     */
+    replaceTag(tag: string): void;
+    /**
+     * 修复无效自封闭标签
+     * @throws `Error` 无法修复无效自封闭标签
+     */
+    fix(): void;
+}
+export {};