wikiparser-node 1.9.3-b → 1.10.0

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

@@ -0,0 +1,54 @@
+import 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 {
+    #private;
+    readonly name: string;
+    abstract get type(): 'link' | 'category' | 'file' | 'gallery-image' | 'imagemap-image' | 'redirect-target';
+    readonly childNodes: readonly [AtomToken, ...Token[]];
+    abstract get firstChild(): AtomToken;
+    abstract get lastChild(): Token;
+    abstract get children(): [AtomToken, ...Token[]];
+    abstract get firstElementChild(): AtomToken;
+    abstract get lastElementChild(): Token;
+    /** 完整链接 */
+    get link(): string | Title;
+    set link(link: string);
+    /** fragment */
+    get fragment(): string | undefined;
+    set fragment(fragment: string | undefined);
+    /** interwiki */
+    get interwiki(): string;
+    /** @throws `RangeError` 非法的跨维基前缀 */
+    set interwiki(interwiki: string);
+    /**
+     * @param link 链接标题
+     * @param linkText 链接显示文字
+     * @param delimiter `|`
+     */
+    constructor(link: string, linkText?: string, config?: Parser.Config, accum?: Token[], delimiter?: string);
+    cloneNode(this: this & {
+        constructor: new (...args: any[]) => unknown;
+    }): this;
+    /**
+     * 设置链接目标
+     * @param link 链接目标
+     */
+    setTarget(link: string): void;
+    /**
+     * 设置fragment
+     * @param fragment fragment
+     */
+    setFragment(fragment?: string): void;
+    /**
+     * 设置链接显示文字
+     * @param linkStr 链接显示文字
+     */
+    setLinkText(linkStr?: string): void;
+}

package/dist/src/link/base.js

@@ -0,0 +1,263 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinkBaseToken = void 0;
+const lint_1 = require("../../util/lint");
+const constants_1 = require("../../util/constants");
+const debug_1 = require("../../util/debug");
+const string_1 = require("../../util/string");
+const rect_1 = require("../../lib/rect");
+const index_1 = require("../../index");
+const index_2 = require("../index");
+const atom_1 = require("../atom");
+/**
+ * 是否为普通内链
+ * @param type 节点类型
+ */
+const isLink = (type) => type === 'redirect-target' || type === 'link';
+/* NOT FOR BROWSER */
+const fileTypes = new Set(['file', 'gallery-image', 'imagemap-image']);
+/* NOT FOR BROWSER END */
+/**
+ * 内链
+ * @classdesc `{childNodes: [AtomToken, ...Token]}`
+ */
+class LinkBaseToken extends index_2.Token {
+    #bracket = true;
+    #delimiter;
+    #title;
+    /** 完整链接 */
+    get link() {
+        return this.#title;
+    }
+    set link(link) {
+        this.setTarget(link);
+    }
+    /** fragment */
+    get fragment() {
+        return this.#title.fragment;
+    }
+    set fragment(fragment) {
+        this.setFragment(fragment);
+    }
+    /** interwiki */
+    get interwiki() {
+        return this.#title.interwiki;
+    }
+    /** @throws `RangeError` 非法的跨维基前缀 */
+    set interwiki(interwiki) {
+        if (isLink(this.type)) {
+            const { prefix, main, fragment } = this.#title, link = `${interwiki}:${prefix}${main}${fragment === undefined ? '' : `#${fragment}`}`;
+            if (interwiki && !this.isInterwiki(link)) {
+                throw new RangeError(`${interwiki} is not a valid interwiki prefix!`);
+            }
+            this.setTarget(link);
+        }
+    }
+    /* NOT FOR BROWSER END */
+    /**
+     * @param link 链接标题
+     * @param linkText 链接显示文字
+     * @param delimiter `|`
+     */
+    constructor(link, linkText, config = index_1.default.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_2.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;
+        /* NOT FOR BROWSER */
+        this.protectChildren(0);
+    }
+    /** @private */
+    afterBuild() {
+        this.#title = this.getTitle();
+        if (this.#delimiter.includes('\0')) {
+            this.#delimiter = this.buildFromStr(this.#delimiter, constants_1.BuildMethod.String);
+        }
+        this.setAttribute('name', this.#title.title);
+        super.afterBuild();
+        /* NOT FOR BROWSER */
+        const /** @implements */ linkListener = (e, data) => {
+            const { prevTarget } = e;
+            if (prevTarget?.type === 'link-target') {
+                const name = prevTarget.toString(true), titleObj = this.getTitle(), { title, interwiki, ns, valid } = titleObj;
+                if (!valid) {
+                    (0, debug_1.undo)(e, data);
+                    throw new Error(`Invalid link target: ${name}`);
+                }
+                else if (this.type === 'category' && (interwiki || ns !== 14)
+                    || fileTypes.has(this.type) && (interwiki || ns !== 6)) {
+                    (0, debug_1.undo)(e, data);
+                    throw new Error(`${this.type === 'category' ? 'Category' : 'File'} link cannot change namespace: ${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 = value;
+        }
+        else if (key === 'title') {
+            this.#title = value;
+        }
+        else {
+            super.setAttribute(key, value);
+        }
+    }
+    /** @private */
+    toString(skip) {
+        const str = super.toString(skip, this.#delimiter);
+        return this.#bracket ? `[[${str}]]` : str;
+    }
+    /** @private */
+    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;
+    }
+    /** @private */
+    lint(start = this.getAbsoluteIndex(), re) {
+        const errors = super.lint(start, re), { childNodes: [target, linkText], type } = this, { encoded, fragment } = this.#title, rect = new rect_1.BoundingRect(this, start);
+        if (target.childNodes.some(({ type: t }) => t === 'template')) {
+            errors.push((0, lint_1.generateForChild)(target, rect, 'unknown-page', 'template in an internal link target', 'warning'));
+        }
+        if (encoded) {
+            errors.push((0, lint_1.generateForChild)(target, rect, 'url-encoding', 'unnecessary URL encoding in an internal link'));
+        }
+        if (type === 'link' || type === 'category') {
+            const textNode = linkText?.childNodes.find((c) => c.type === 'text' && c.data.includes('|'));
+            if (textNode) {
+                const e = (0, lint_1.generateForChild)(linkText, rect, 'pipe-like', 'additional "|" in the link text', 'warning');
+                e.suggestions = [
+                    {
+                        desc: 'escape',
+                        range: [
+                            e.startIndex + textNode.getRelativeIndex(),
+                            e.startIndex + textNode.getRelativeIndex() + textNode.data.length,
+                        ],
+                        text: textNode.data.replace(/\|/gu, '|'),
+                    },
+                ];
+                errors.push(e);
+            }
+        }
+        if (fragment !== undefined && !isLink(type)) {
+            const e = (0, lint_1.generateForChild)(target, rect, 'no-ignored', 'useless fragment'), textNode = target.childNodes.find((c) => c.type === 'text' && c.data.includes('#'));
+            if (textNode) {
+                e.fix = {
+                    range: [e.startIndex + textNode.getRelativeIndex() + textNode.data.indexOf('#'), e.endIndex],
+                    text: '',
+                };
+            }
+            errors.push(e);
+        }
+        return errors;
+    }
+    /** @private */
+    getTitle(halfParsed) {
+        return this.normalizeTitle(this.firstChild.toString(true), 0, halfParsed, true, true);
+    }
+    /** @private */
+    print() {
+        return super.print(this.#bracket ? { pre: '[[', post: ']]', sep: this.#delimiter } : { sep: this.#delimiter });
+    }
+    /* NOT FOR BROWSER */
+    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);
+            return token;
+        });
+    }
+    /**
+     * 设置链接目标
+     * @param link 链接目标
+     */
+    setTarget(link) {
+        const config = this.getAttribute('config'), { childNodes } = index_1.default.parse(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);
+    }
+    /**
+     * 设置fragment
+     * @param fragment fragment
+     */
+    setFragment(fragment) {
+        const { type, name } = this;
+        if (fragment === undefined || isLink(type)) {
+            fragment &&= (0, string_1.encode)(fragment);
+            this.setTarget(`${name}${fragment === undefined ? '' : `#${fragment}`}`);
+        }
+    }
+    /**
+     * 设置链接显示文字
+     * @param linkStr 链接显示文字
+     */
+    setLinkText(linkStr) {
+        if (linkStr === undefined) {
+            this.childNodes[1]?.remove();
+            return;
+        }
+        const root = index_1.default.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);
+        }
+    }
+    /** @private */
+    toHtml() {
+        if (this.is('link') || this.is('redirect-target')) {
+            const { link, length, lastChild, type } = this;
+            return `<a ${link.interwiki && 'class="extiw" '}href="${link.getUrl()}" title="${link.title.replace(/"/gu, '&quot;')}">${type === 'link' && length > 1 ? lastChild.toHtml(true) : this.innerText}</a>`;
+        }
+        return '';
+    }
+}
+exports.LinkBaseToken = LinkBaseToken;
+constants_1.classes['LinkBaseToken'] = __filename;

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

@@ -0,0 +1,22 @@
+import { LinkBaseToken } from './base';
+import type { Title } from '../../lib/title';
+import type { Token, AtomToken } from '../../internal';
+/**
+ * 分类
+ * @classdesc `{childNodes: [AtomToken, ?Token]}`
+ */
+export declare abstract class CategoryToken extends LinkBaseToken {
+    readonly childNodes: readonly [AtomToken] | readonly [AtomToken, Token];
+    abstract get children(): [AtomToken] | [AtomToken, Token];
+    abstract get link(): Title;
+    abstract set link(link: string);
+    get 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,34 @@
+"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");
+/**
+ * 分类
+ * @classdesc `{childNodes: [AtomToken, ?Token]}`
+ */
+class CategoryToken extends base_1.LinkBaseToken {
+    /* NOT FOR BROWSER END */
+    get type() {
+        return '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,96 @@
+import 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 abstract class FileToken extends LinkBaseToken {
+    #private;
+    readonly childNodes: readonly [AtomToken, ...ImageParameterToken[]];
+    abstract get lastChild(): AtomToken | ImageParameterToken;
+    abstract get children(): [AtomToken, ...ImageParameterToken[]];
+    abstract get lastElementChild(): AtomToken | ImageParameterToken;
+    get type(): 'file' | 'gallery-image' | 'imagemap-image';
+    /** 扩展名 */
+    get extension(): string | undefined;
+    /** 图片链接 */
+    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);
+    /** 获取所有图片参数节点 */
+    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;
+}