wikiparser-node 0.11.0 → 1.0.0-beta.0

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

@@ -0,0 +1,71 @@
+import Title = require('../../lib/title');
+import * as Parser from '../../index';
+import Token = require('..');
+import AtomToken = require('../atom');
+import type { TokenAttributeSetter } from '../../lib/node';
+/**
+ * 内链
+ * @classdesc `{childNodes: [AtomToken, ...Token]}`
+ */
+declare abstract class LinkBaseToken extends Token {
+    #private;
+    type: 'link' | 'category' | 'file' | 'gallery-image' | 'imagemap-image';
+    name: string;
+    childNodes: [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 | Title);
+    /** fragment */
+    get fragment(): string | undefined;
+    /** 链接显示文字 */
+    get innerText(): string | undefined;
+    /**
+     * @browser
+     * @param link 链接标题
+     * @param linkText 链接显示文字
+     * @param delimiter `|`
+     */
+    constructor(link: string, linkText?: string, config?: Parser.Config, accum?: Token[], delimiter?: string);
+    /**
+     * @override
+     * @browser
+     */
+    toString(selector?: string): string;
+    /**
+     * @override
+     * @browser
+     */
+    text(): string;
+    /**
+     * @override
+     * @browser
+     */
+    print(): string;
+    /**
+     * @override
+     * @browser
+     */
+    lint(start?: number): Parser.LintError[];
+    /** @override */
+    cloneNode(this: this & {
+        constructor: new (...args: unknown[]) => unknown;
+    }): this;
+    /**
+     * 设置链接目标
+     * @param link 链接目标
+     * @throws `SyntaxError` 非法的链接目标
+     */
+    setTarget(link: string | Title): void;
+    /**
+     * 设置链接显示文字
+     * @param linkStr 链接显示文字
+     * @throws `SyntaxError` 非法的链接显示文字
+     */
+    setLinkText(linkStr?: string): void;
+}
+export = LinkBaseToken;

package/dist/src/link/base.js

@@ -0,0 +1,225 @@
+"use strict";
+const lint_1 = require("../../util/lint");
+const string_1 = require("../../util/string");
+const debug_1 = require("../../util/debug");
+const Parser = require("../../index");
+const Token = require("..");
+const AtomToken = require("../atom");
+/**
+ * 内链
+ * @classdesc `{childNodes: [AtomToken, ...Token]}`
+ */
+class LinkBaseToken extends Token {
+    #bracket = true;
+    #delimiter;
+    #fragment;
+    #encoded = false;
+    /** 完整链接 */
+    get link() {
+        return this.#getTitle();
+    }
+    set link(link) {
+        this.setTarget(link);
+    }
+    /** fragment */
+    get fragment() {
+        return this.#getTitle().fragment;
+    }
+    /** 链接显示文字 */
+    get innerText() {
+        if (this.type === 'link') {
+            return this.length > 1
+                ? this.lastChild.text()
+                : this.firstChild.text().replace(/^\s*:/u, '');
+        }
+        return undefined;
+    }
+    /**
+     * @browser
+     * @param link 链接标题
+     * @param linkText 链接显示文字
+     * @param delimiter `|`
+     */
+    constructor(link, linkText, config = Parser.getConfig(), accum = [], delimiter = '|') {
+        super(undefined, config, true, accum, {
+            AtomToken: 0, Token: 1,
+        });
+        this.insertAt(new AtomToken(link, 'link-target', config, accum, {
+            'Stage-2': ':', '!ExtToken': '', '!HeadingToken': '',
+        }));
+        if (linkText !== undefined) {
+            const inner = new Token(linkText, config, true, accum, {
+                'Stage-5': ':', ConverterToken: ':',
+            });
+            inner.type = 'link-text';
+            this.insertAt(inner.setAttribute('stage', Parser.MAX_STAGE - 1));
+        }
+        this.#delimiter = delimiter;
+        this.protectChildren(0);
+    }
+    /** @private */
+    afterBuild() {
+        const titleObj = this.normalizeTitle(this.firstChild.text(), 0, false, true, true);
+        this.setAttribute('name', titleObj.title);
+        this.#fragment = titleObj.fragment;
+        this.#encoded = titleObj.encoded;
+        if (this.#delimiter.includes('\0')) {
+            this.#delimiter = this.buildFromStr(this.#delimiter, 'string');
+        }
+        const /** @implements */ linkListener = (e, data) => {
+            const { prevTarget } = e;
+            if (prevTarget?.type === 'link-target') {
+                const name = prevTarget.text(), { title, interwiki, ns, valid, fragment, encoded } = this.normalizeTitle(name, 0, false, true, true);
+                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.setAttribute('name', title);
+                this.#fragment = fragment;
+                this.#encoded = encoded;
+            }
+        };
+        this.addEventListener(['remove', 'insert', 'replace', 'text'], linkListener);
+    }
+    /** @private */
+    setAttribute(key, value) {
+        if (key === 'bracket') {
+            this.#bracket = Boolean(value);
+            return this;
+        }
+        return super.setAttribute(key, value);
+    }
+    /**
+     * @override
+     * @browser
+     */
+    toString(selector) {
+        const str = super.toString(selector, this.#delimiter);
+        return this.#bracket && !(selector && this.matches(selector)) ? `[[${str}]]` : str;
+    }
+    /**
+     * @override
+     * @browser
+     */
+    text() {
+        const str = super.text('|');
+        return this.#bracket ? `[[${str}]]` : str;
+    }
+    /** @private */
+    getPadding() {
+        return 2;
+    }
+    /** @private */
+    getGaps() {
+        return this.#delimiter.length;
+    }
+    /**
+     * @override
+     * @browser
+     */
+    print() {
+        return super.print(this.#bracket ? { pre: '[[', post: ']]', sep: this.#delimiter } : { sep: this.#delimiter });
+    }
+    /**
+     * @override
+     * @browser
+     */
+    lint(start = this.getAbsoluteIndex()) {
+        const errors = super.lint(start), { childNodes: [target, linkText], type: linkType } = this;
+        let rect;
+        if (linkType === 'link' && 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 (this.#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' && linkText?.childNodes?.some(child => child.type === 'text' && child.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' && this.#fragment !== undefined) {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForChild)(target, rect, 'useless fragment'));
+        }
+        return errors;
+    }
+    /** 生成Title对象 */
+    #getTitle() {
+        return this.normalizeTitle(this.firstChild.text(), 0, false, true, true);
+    }
+    /** @override */
+    cloneNode() {
+        const [link, ...linkText] = this.cloneChildNodes();
+        return Parser.run(() => {
+            const token = new this.constructor('', undefined, this.getAttribute('config'));
+            token.firstChild.safeReplaceWith(link);
+            token.append(...linkText);
+            token.afterBuild();
+            return token;
+        });
+    }
+    /**
+     * 设置链接目标
+     * @param link 链接目标
+     * @throws `SyntaxError` 非法的链接目标
+     */
+    setTarget(link) {
+        let strLink = String(link);
+        if (this.type === 'link' && !/^\s*[:#]/u.test(strLink)) {
+            strLink = `:${strLink}`;
+        }
+        const root = Parser.parse(`[[${strLink}]]`, this.getAttribute('include'), 6, this.getAttribute('config')), { length, firstChild: wikiLink } = root;
+        if (length !== 1 || wikiLink?.type !== this.type || wikiLink.length !== 1) {
+            const msgs = { link: '内链', file: '文件链接', category: '分类' };
+            throw new SyntaxError(`非法的${msgs[this.type]}目标：${strLink}`);
+        }
+        const { firstChild } = wikiLink;
+        wikiLink.destroy();
+        this.firstChild.safeReplaceWith(firstChild);
+    }
+    /**
+     * 设置链接显示文字
+     * @param linkStr 链接显示文字
+     * @throws `SyntaxError` 非法的链接显示文字
+     */
+    setLinkText(linkStr = '') {
+        let lastChild;
+        const config = this.getAttribute('config');
+        if (linkStr) {
+            const root = Parser.parse(`[[${this.type === 'category' ? 'Category:' : ''}L|${linkStr}]]`, this.getAttribute('include'), 6, config), { length, firstChild: wikiLink } = root;
+            if (length !== 1 || wikiLink?.type !== this.type || wikiLink.length !== 2) {
+                throw new SyntaxError(`非法的${this.type === 'link' ? '内链文字' : '分类关键字'}：${(0, string_1.noWrap)(linkStr)}`);
+            }
+            ({ lastChild } = wikiLink);
+        }
+        else {
+            lastChild = Parser.run(() => new Token('', config));
+            lastChild.setAttribute('stage', 7).type = 'link-text';
+        }
+        if (this.length === 1) {
+            this.insertAt(lastChild);
+        }
+        else {
+            this.lastChild.safeReplaceWith(lastChild);
+        }
+    }
+}
+Parser.classes['LinkBaseToken'] = __filename;
+module.exports = LinkBaseToken;

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

@@ -1,16 +1,15 @@
-export = CategoryToken;
-/**
- * 分类
- * @classdesc `{childNodes: [AtomToken, ?Token]}`
- */
-declare class CategoryToken extends LinkToken {
-    set sortkey(arg: string);
+import LinkToken = require('.');
+/** 分类 */
+declare abstract class CategoryToken extends LinkToken {
+    /** @browser */
+    readonly type = "category";
     /** 分类排序关键字 */
-    get sortkey(): string;
+    get sortkey(): string | undefined;
+    set sortkey(text: string | undefined);
     /**
      * 设置排序关键字
-     * @param {string} text 排序关键字
+     * @param text 排序关键字
      */
-    setSortkey(text: string): void;
+    setSortkey(text?: string): void;
 }
-import LinkToken = require(".");
+export = CategoryToken;

package/dist/src/link/category.js

@@ -0,0 +1,26 @@
+"use strict";
+const string_1 = require("../../util/string");
+const Parser = require("../../index");
+const LinkToken = require(".");
+/** 分类 */
+class CategoryToken extends LinkToken {
+    /** @browser */
+    type = 'category';
+    /** 分类排序关键字 */
+    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);
+    }
+}
+Parser.classes['CategoryToken'] = __filename;
+module.exports = CategoryToken;

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

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