wikiparser-node 1.4.0-b → 1.4.0

package/dist/src/link/base.d.ts

@@ -0,0 +1,51 @@
+import * as Parser from '../../index';
+import { Token } from '../index';
+import { AtomToken } from '../atom';
+import type { LintError } from '../../base';
+import type { Title } from '../../lib/title';
+/**
+ * 内链
+ * @classdesc `{childNodes: [AtomToken, ...Token]}`
+ */
+export declare abstract class LinkBaseToken extends Token {
+    type: 'link' | 'category' | 'file' | 'gallery-image' | 'imagemap-image';
+    readonly name: string;
+    readonly childNodes: readonly [AtomToken, ...Token[]];
+    abstract get children(): [AtomToken, ...Token[]];
+    abstract get firstChild(): AtomToken;
+    abstract get firstElementChild(): AtomToken;
+    abstract get lastChild(): Token;
+    abstract get lastElementChild(): Token;
+    /** 完整链接 */
+    get link(): string | Title;
+    set link(link: string);
+    /** fragment */
+    get fragment(): string | undefined;
+    set fragment(fragment: string | undefined);
+    /**
+     * @param link 链接标题
+     * @param linkText 链接显示文字
+     * @param delimiter `|`
+     */
+    constructor(link: string, linkText?: string, config?: Parser.Config, accum?: Token[], delimiter?: string);
+    /** @override */
+    text(): string;
+    /** @override */
+    lint(start?: number): LintError[];
+    /** @override */
+    print(): string;
+    /** @override */
+    cloneNode(this: this & {
+        constructor: new (...args: any[]) => unknown;
+    }): this;
+    /**
+     * 设置链接目标
+     * @param link 链接目标
+     */
+    setTarget(link: string): void;
+    /**
+     * 设置链接显示文字
+     * @param linkStr 链接显示文字
+     */
+    setLinkText(linkStr?: string): void;
+}

package/dist/src/link/base.js

@@ -0,0 +1,209 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinkBaseToken = void 0;
+const lint_1 = require("../../util/lint");
+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");
+/**
+ * 内链
+ * @classdesc `{childNodes: [AtomToken, ...Token]}`
+ */
+class LinkBaseToken extends index_1.Token {
+    #bracket = true;
+    #delimiter;
+    #title;
+    /* NOT FOR BROWSER */
+    /** 完整链接 */
+    get link() {
+        return this.#title;
+    }
+    set link(link) {
+        this.setTarget(link);
+    }
+    /** fragment */
+    get fragment() {
+        return this.#title.fragment;
+    }
+    set fragment(fragment) {
+        if (fragment === undefined) {
+            this.setTarget(this.name);
+        }
+    }
+    /* NOT FOR BROWSER END */
+    /**
+     * @param link 链接标题
+     * @param linkText 链接显示文字
+     * @param delimiter `|`
+     */
+    constructor(link, linkText, config = Parser.getConfig(), accum = [], delimiter = '|') {
+        super(undefined, config, accum, {
+            AtomToken: 0, Token: 1,
+        });
+        this.insertAt(new atom_1.AtomToken(link, 'link-target', config, accum, {
+            'Stage-2': ':', '!ExtToken': '', '!HeadingToken': '',
+        }));
+        if (linkText !== undefined) {
+            const inner = new index_1.Token(linkText, config, accum, {
+                'Stage-5': ':', QuoteToken: ':', ConverterToken: ':',
+            });
+            inner.type = 'link-text';
+            inner.setAttribute('stage', constants_1.MAX_STAGE - 1);
+            this.insertAt(inner);
+        }
+        this.#delimiter = delimiter;
+        this.protectChildren(0);
+    }
+    /** @private */
+    afterBuild() {
+        this.#title = this.getTitle();
+        this.setAttribute('name', this.#title.title);
+        if (this.#delimiter.includes('\0')) {
+            this.#delimiter = this.buildFromStr(this.#delimiter, constants_1.BuildMethod.String);
+        }
+        const /** @implements */ linkListener = (e, data) => {
+            const { prevTarget } = e;
+            if (prevTarget?.type === 'link-target') {
+                const name = prevTarget.text(), titleObj = this.getTitle(), { title, interwiki, ns, valid } = titleObj;
+                if (!valid) {
+                    (0, debug_1.undo)(e, data);
+                    throw new Error(`非法的内链目标：${name}`);
+                }
+                else if (this.type === 'category' && (interwiki || ns !== 14)
+                    || this.type === 'file' && (interwiki || ns !== 6)) {
+                    (0, debug_1.undo)(e, data);
+                    throw new Error(`${this.type === 'file' ? '文件' : '分类'}链接不可更改命名空间：${name}`);
+                }
+                else if (this.type === 'link'
+                    && !interwiki
+                    && (ns === 6 || ns === 14)
+                    && !name.trim().startsWith(':')) {
+                    const { firstChild } = prevTarget;
+                    if (firstChild?.type === 'text') {
+                        firstChild.insertData(0, ':');
+                    }
+                    else {
+                        prevTarget.prepend(':');
+                    }
+                }
+                this.#title = titleObj;
+                this.setAttribute('name', title);
+            }
+        };
+        this.addEventListener(['remove', 'insert', 'replace', 'text'], linkListener);
+    }
+    /** @private */
+    setAttribute(key, value) {
+        if (key === 'bracket') {
+            this.#bracket = Boolean(value);
+        }
+        else if (key === 'title') {
+            this.#title = value;
+        }
+        else {
+            super.setAttribute(key, value);
+        }
+    }
+    /** @private */
+    toString(omit) {
+        const str = super.toString(omit, this.#delimiter);
+        return this.#bracket
+            && !(omit && this.matchesTypes(omit))
+            ? `[[${str}]]`
+            : str;
+    }
+    /** @override */
+    text() {
+        const str = super.text('|');
+        return this.#bracket ? `[[${str}]]` : str;
+    }
+    /** @private */
+    getAttribute(key) {
+        if (key === 'title') {
+            return this.#title;
+        }
+        return key === 'padding' ? 2 : super.getAttribute(key);
+    }
+    /** @private */
+    getGaps(i) {
+        return i === 0 ? this.#delimiter.length : 1;
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        const errors = super.lint(start), { childNodes: [target, linkText], type: linkType } = this, { encoded, fragment } = this.#title;
+        let rect;
+        if (target.childNodes.some(({ type }) => type === 'template')) {
+            rect = { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForChild)(target, rect, 'template in an internal link target', 'warning'));
+        }
+        if (encoded) {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForChild)(target, rect, 'unnecessary URL encoding in an internal link'));
+        }
+        if ((linkType === 'link' || linkType === 'category') && linkText?.childNodes.some(({ type, data }) => type === 'text' && data.includes('|'))) {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForChild)(linkText, rect, 'additional "|" in the link text', 'warning'));
+        }
+        else if (linkType !== 'link' && fragment !== undefined) {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForChild)(target, rect, 'useless fragment'));
+        }
+        return errors;
+    }
+    /** @private */
+    getTitle() {
+        return this.normalizeTitle(this.firstChild.text(), 0, false, true, true);
+    }
+    /** @override */
+    print() {
+        return super.print(this.#bracket ? { pre: '[[', post: ']]', sep: this.#delimiter } : { sep: this.#delimiter });
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const [link, ...linkText] = this.cloneChildNodes();
+        return debug_1.Shadow.run(() => {
+            const token = new this.constructor('', undefined, this.getAttribute('config'));
+            token.firstChild.safeReplaceWith(link);
+            token.append(...linkText);
+            token.afterBuild();
+            return token;
+        });
+    }
+    /**
+     * 设置链接目标
+     * @param link 链接目标
+     */
+    setTarget(link) {
+        const config = this.getAttribute('config'), { childNodes } = Parser.parse(String(link), this.getAttribute('include'), 2, config), token = debug_1.Shadow.run(() => new atom_1.AtomToken(undefined, 'link-target', config, [], {
+            'Stage-2': ':', '!ExtToken': '', '!HeadingToken': '',
+        }));
+        token.append(...childNodes);
+        this.firstChild.safeReplaceWith(token);
+    }
+    /**
+     * 设置链接显示文字
+     * @param linkStr 链接显示文字
+     */
+    setLinkText(linkStr) {
+        if (linkStr === undefined) {
+            this.childNodes[1]?.remove();
+            return;
+        }
+        const root = Parser.parse(linkStr, this.getAttribute('include'), undefined, this.getAttribute('config'));
+        if (this.length === 1) {
+            root.type = 'link-text';
+            root.setAttribute('acceptable', {
+                'Stage-5': ':', QuoteToken: ':', ConverterToken: ':',
+            });
+            this.insertAt(root);
+        }
+        else {
+            this.lastChild.replaceChildren(...root.childNodes);
+        }
+    }
+}
+exports.LinkBaseToken = LinkBaseToken;
+constants_1.classes['LinkBaseToken'] = __filename;

package/dist/src/link/category.d.ts

@@ -0,0 +1,13 @@
+import { LinkBaseToken } from './base';
+/** 分类 */
+export declare class CategoryToken extends LinkBaseToken {
+    readonly type = "category";
+    /** 分类排序关键字 */
+    get sortkey(): string | undefined;
+    set sortkey(text: string | undefined);
+    /**
+     * 设置排序关键字
+     * @param text 排序关键字
+     */
+    setSortkey(text?: string): void;
+}

package/dist/src/link/category.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CategoryToken = void 0;
+const string_1 = require("../../util/string");
+const constants_1 = require("../../util/constants");
+const base_1 = require("./base");
+/** 分类 */
+// @ts-expect-error not implementing all abstract methods
+class CategoryToken extends base_1.LinkBaseToken {
+    type = 'category';
+    /* NOT FOR BROWSER */
+    /** 分类排序关键字 */
+    get sortkey() {
+        const { childNodes: [, child] } = this;
+        return child && (0, string_1.decodeHtml)(child.text());
+    }
+    set sortkey(text) {
+        this.setSortkey(text);
+    }
+    /**
+     * 设置排序关键字
+     * @param text 排序关键字
+     */
+    setSortkey(text) {
+        this.setLinkText(text);
+    }
+}
+exports.CategoryToken = CategoryToken;
+constants_1.classes['CategoryToken'] = __filename;

package/dist/src/link/file.d.ts

@@ -0,0 +1,95 @@
+import * as Parser from '../../index';
+import { LinkBaseToken } from './base';
+import { ImageParameterToken } from '../imageParameter';
+import type { Title } from '../../lib/title';
+import type { LintError } from '../../base';
+import type { Token, AtomToken } from '../../internal';
+/**
+ * 图片
+ * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
+ */
+export declare class FileToken extends LinkBaseToken {
+    readonly type: 'file' | 'gallery-image' | 'imagemap-image';
+    readonly childNodes: readonly [AtomToken, ...ImageParameterToken[]];
+    abstract get children(): [AtomToken, ...ImageParameterToken[]];
+    abstract get lastChild(): AtomToken | ImageParameterToken;
+    abstract get lastElementChild(): AtomToken | ImageParameterToken;
+    /** 图片链接 */
+    get link(): string | Title;
+    set link(value: string);
+    /** 图片大小 */
+    get size(): {
+        width: string;
+        height: string;
+    } | undefined;
+    set size(size: {
+        width: string;
+        height: string;
+    } | undefined);
+    /** 图片宽度 */
+    get width(): string | undefined;
+    set width(width: string | undefined);
+    /** 图片高度 */
+    get height(): string | undefined;
+    set height(height: string | undefined);
+    /**
+     * @param link 文件名
+     * @param text 图片参数
+     * @param delimiter `|`
+     */
+    constructor(link: string, text?: string, config?: Parser.Config, accum?: Token[], delimiter?: string);
+    /** @override */
+    lint(start?: number): LintError[];
+    /** 获取所有图片参数节点 */
+    getAllArgs(): ImageParameterToken[];
+    /**
+     * 获取指定图片参数
+     * @param key 参数名
+     */
+    getArgs(key: string): ImageParameterToken[];
+    /** 获取图片框架属性参数节点 */
+    getFrameArgs(): ImageParameterToken[];
+    /** 获取图片水平对齐参数节点 */
+    getHorizAlignArgs(): ImageParameterToken[];
+    /** 获取图片垂直对齐参数节点 */
+    getVertAlignArgs(): ImageParameterToken[];
+    /**
+     * 获取生效的指定图片参数
+     * @param key 参数名
+     */
+    getArg(key: string): ImageParameterToken | undefined;
+    /**
+     * 获取生效的指定图片参数值
+     * @param key 参数名
+     */
+    getValue(key: string): string | true | undefined;
+    /**
+     * 是否具有指定图片参数
+     * @param key 参数名
+     */
+    hasArg(key: string): boolean;
+    /**
+     * 移除指定图片参数
+     * @param key 参数名
+     */
+    removeArg(key: string): void;
+    /** 获取图片参数名 */
+    getKeys(): Set<string>;
+    /**
+     * 获取指定的图片参数值
+     * @param key 参数名
+     */
+    getValues(key: string): (string | true)[];
+    /**
+     * 设置图片参数
+     * @param key 参数名
+     * @param value 参数值
+     * @throws `RangeError` 未定义的图片参数
+     */
+    setValue(key: string, value?: string | boolean): void;
+    /**
+     * @override
+     * @throws `Error` 不适用于图片
+     */
+    setLinkText(): never;
+}

package/dist/src/link/file.js

@@ -0,0 +1,259 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileToken = void 0;
+const string_1 = require("../../util/string");
+const lint_1 = require("../../util/lint");
+const debug_1 = require("../../util/debug");
+const constants_1 = require("../../util/constants");
+const Parser = require("../../index");
+const base_1 = require("./base");
+const imageParameter_1 = require("../imageParameter");
+const frame = new Set(['manualthumb', 'frameless', 'framed', 'thumbnail']), horizAlign = new Set(['left', 'right', 'center', 'none']), vertAlign = new Set(['baseline', 'sub', 'super', 'top', 'text-top', 'middle', 'bottom', 'text-bottom']);
+/**
+ * a more sophisticated string-explode function
+ * @param start start syntax of a nested AST node
+ * @param end end syntax of a nested AST node
+ * @param separator syntax for explosion
+ * @param str string to be exploded
+ */
+const explode = (start, end, separator, str) => {
+    if (str === undefined) {
+        return [];
+    }
+    const regex = new RegExp(`${[start, end, separator].map(string_1.escapeRegExp).join('|')}`, 'gu'), exploded = [];
+    let mt = regex.exec(str), depth = 0, lastIndex = 0;
+    while (mt) {
+        const { 0: match, index } = mt;
+        if (match !== separator) {
+            depth += match === start ? 1 : -1;
+        }
+        else if (depth === 0) {
+            exploded.push(str.slice(lastIndex, index));
+            ({ lastIndex } = regex);
+        }
+        mt = regex.exec(str);
+    }
+    exploded.push(str.slice(lastIndex));
+    return exploded;
+};
+/**
+ * 图片
+ * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
+ */
+// @ts-expect-error not implementing all abstract methods
+class FileToken extends base_1.LinkBaseToken {
+    type = 'file';
+    /* NOT FOR BROWSER */
+    /** 图片链接 */
+    get link() {
+        return this.getArg('link')?.link ?? super.link;
+    }
+    set link(value) {
+        this.setValue('link', value);
+    }
+    /** 图片大小 */
+    get size() {
+        return this.getArg('width')?.size;
+    }
+    set size(size) {
+        this.setValue('width', size && `${size.width}${size.height && 'x'}${size.height}`);
+    }
+    /** 图片宽度 */
+    get width() {
+        return this.size?.width;
+    }
+    set width(width) {
+        const arg = this.getArg('width');
+        if (arg) {
+            arg.width = width;
+        }
+        else {
+            this.setValue('width', width);
+        }
+    }
+    /** 图片高度 */
+    get height() {
+        return this.size?.height;
+    }
+    set height(height) {
+        const arg = this.getArg('width');
+        if (arg) {
+            arg.height = height;
+        }
+        else {
+            this.setValue('width', height && `x${height}`);
+        }
+    }
+    /* NOT FOR BROWSER END */
+    /**
+     * @param link 文件名
+     * @param text 图片参数
+     * @param delimiter `|`
+     */
+    constructor(link, text, config = Parser.getConfig(), accum = [], delimiter = '|') {
+        super(link, undefined, config, accum, delimiter);
+        this.setAttribute('acceptable', { AtomToken: 0, ImageParameterToken: '1:' });
+        this.append(...explode('-{', '}-', '|', text).map(part => new imageParameter_1.ImageParameterToken(part, config, accum)));
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        const errors = super.lint(start), args = this.getAllArgs().filter(({ childNodes }) => {
+            const visibleNodes = childNodes.filter(node => node.text().trim());
+            return visibleNodes.length !== 1 || visibleNodes[0].type !== 'arg';
+        }), keys = [...new Set(args.map(({ name }) => name))].filter(key => key !== 'invalid'), frameKeys = keys.filter(key => frame.has(key)), horizAlignKeys = keys.filter(key => horizAlign.has(key)), vertAlignKeys = keys.filter(key => vertAlign.has(key));
+        if (this.closest('ext-link-text') && this.getValue('link')?.trim() !== '') {
+            errors.push((0, lint_1.generateForSelf)(this, { start }, 'internal link in an external link'));
+        }
+        if (args.length === keys.length
+            && frameKeys.length < 2
+            && horizAlignKeys.length < 2
+            && vertAlignKeys.length < 2) {
+            return errors;
+        }
+        const rect = { start, ...this.getRootNode().posFromIndex(start) };
+        /**
+         * 图片参数到语法错误的映射
+         * @param msg 消息键
+         * @param p1 替换$1
+         */
+        const generate = (msg, p1) => (arg) => (0, lint_1.generateForChild)(arg, rect, Parser.msg(`${msg} image $1 parameter`, p1));
+        for (const key of keys) {
+            let relevantArgs = args.filter(({ name }) => name === key);
+            if (key === 'caption') {
+                relevantArgs = [...relevantArgs.slice(0, -1).filter(arg => arg.text()), ...relevantArgs.slice(-1)];
+            }
+            if (relevantArgs.length > 1) {
+                errors.push(...relevantArgs.map(generate('duplicated', key)));
+            }
+        }
+        if (frameKeys.length > 1) {
+            errors.push(...args.filter(({ name }) => frame.has(name)).map(generate('conflicting', 'frame')));
+        }
+        if (horizAlignKeys.length > 1) {
+            errors.push(...args.filter(({ name }) => horizAlign.has(name)).map(generate('conflicting', 'horizontal-alignment')));
+        }
+        if (vertAlignKeys.length > 1) {
+            errors.push(...args.filter(({ name }) => vertAlign.has(name)).map(generate('conflicting', 'vertical-alignment')));
+        }
+        return errors;
+    }
+    /** 获取所有图片参数节点 */
+    getAllArgs() {
+        return this.childNodes.slice(1);
+    }
+    /**
+     * 获取指定图片参数
+     * @param key 参数名
+     */
+    getArgs(key) {
+        return this.getAllArgs().filter(({ name }) => key === name);
+    }
+    /**
+     * 获取特定类型的图片属性参数节点
+     * @param keys 接受的参数名
+     * @param type 类型名
+     */
+    #getTypedArgs(keys, type) {
+        const args = this.getAllArgs().filter(({ name }) => keys.has(name));
+        if (args.length > 1) {
+            Parser.warn(`图片 ${this.name} 带有 ${args.length} 个${type}参数，只有最后 1 个 ${args[0].name} 会生效！`);
+        }
+        return args;
+    }
+    /** 获取图片框架属性参数节点 */
+    getFrameArgs() {
+        return this.#getTypedArgs(frame, '框架');
+    }
+    /** 获取图片水平对齐参数节点 */
+    getHorizAlignArgs() {
+        return this.#getTypedArgs(horizAlign, '水平对齐');
+    }
+    /** 获取图片垂直对齐参数节点 */
+    getVertAlignArgs() {
+        return this.#getTypedArgs(vertAlign, '垂直对齐');
+    }
+    /**
+     * 获取生效的指定图片参数
+     * @param key 参数名
+     */
+    getArg(key) {
+        const args = this.getArgs(key);
+        return args[args.length - 1];
+    }
+    /**
+     * 获取生效的指定图片参数值
+     * @param key 参数名
+     */
+    getValue(key) {
+        return this.getArg(key)?.getValue();
+    }
+    /* NOT FOR BROWSER */
+    /**
+     * 是否具有指定图片参数
+     * @param key 参数名
+     */
+    hasArg(key) {
+        return this.getArgs(key).length > 0;
+    }
+    /**
+     * 移除指定图片参数
+     * @param key 参数名
+     */
+    removeArg(key) {
+        for (const token of this.getArgs(key)) {
+            this.removeChild(token);
+        }
+    }
+    /** 获取图片参数名 */
+    getKeys() {
+        return new Set(this.getAllArgs().map(({ name }) => name));
+    }
+    /**
+     * 获取指定的图片参数值
+     * @param key 参数名
+     */
+    getValues(key) {
+        return this.getArgs(key).map(token => token.getValue());
+    }
+    /**
+     * 设置图片参数
+     * @param key 参数名
+     * @param value 参数值
+     * @throws `RangeError` 未定义的图片参数
+     */
+    setValue(key, value = false) {
+        if (value === false) {
+            this.removeArg(key);
+            return;
+        }
+        const token = this.getArg(key);
+        if (token) {
+            token.setValue(value);
+            return;
+        }
+        const config = this.getAttribute('config'), syntax = key === 'caption' ? '$1' : Object.entries(config.img).find(([, name]) => name === key)?.[0];
+        if (syntax === undefined) {
+            throw new RangeError(`未定义的图片参数： ${key}`);
+        }
+        const free = syntax.includes('$1');
+        if (value === true && free) {
+            this.typeError('setValue', 'Boolean');
+        }
+        const parameter = debug_1.Shadow.run(() => new imageParameter_1.ImageParameterToken(syntax.replace('$1', ''), config));
+        if (free) {
+            const { childNodes } = Parser.parse(value, this.getAttribute('include'), undefined, config);
+            parameter.replaceChildren(...childNodes);
+        }
+        parameter.afterBuild();
+        this.insertAt(parameter);
+    }
+    /**
+     * @override
+     * @throws `Error` 不适用于图片
+     */
+    setLinkText() {
+        throw new Error('setLinkText 方法不适用于图片！');
+    }
+}
+exports.FileToken = FileToken;
+constants_1.classes['FileToken'] = __filename;

package/dist/src/link/galleryImage.d.ts

@@ -0,0 +1,29 @@
+import * as Parser from '../../index';
+import { Token } from '../index';
+import type { Title } from '../../lib/title';
+import type { LintError } from '../../base';
+import type { AtomToken, ImageParameterToken } from '../../internal';
+import {FileToken} from './file';
+export declare class GalleryImageToken extends FileToken {
+    type: 'gallery-image' | 'imagemap-image';
+    /** 图片链接 */
+    get link(): string | Title;
+    set link(value: string);
+    /**
+     * @param type 图片类型
+     * @param link 图片文件名
+     * @param text 图片参数
+     */
+    constructor(type: 'gallery' | 'imagemap', link: string, text?: string, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    lint(start?: number): LintError[];
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     * @throws `RangeError` 不可插入多余子节点
+     * @throws `TypeError` 不可插入文本节点
+     */
+    insertAt<T extends AtomToken | ImageParameterToken>(child: T, i?: number): T;
+}
+export {};