wikiparser-node 1.0.0-beta.0 → 1.0.0-beta.2

package/config/.schema.json

@@ -116,6 +116,32 @@
 				"type": "string",
 				"pattern": "^[-a-z]+$"
 			}
+		},
+		"conversionTable": {
+			"description": "table of unidirectional conversions",
+			"type": "array",
+			"items": {
+				"type": "array",
+				"items": {
+					"type": "string",
+					"pattern": "^[^ <>[\\]{}|]+$"
+				},
+				"minItems": 2,
+				"maxItems": 2
+			}
+		},
+		"redirects": {
+			"description": "table of redirects",
+			"type": "array",
+			"items": {
+				"type": "array",
+				"items": {
+					"type": "string",
+					"pattern": "^[^ <>[\\]{}|]+$"
+				},
+				"minItems": 2,
+				"maxItems": 2
+			}
 		}
 	},
 	"required": [

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-declare interface Config {
+import type { Title } from './lib/title';
+import type { Token } from './internal';
+export interface Config {
     ext: string[];
     html: [string[], string[], string[]];
     namespaces: Record<string, string>;
@@ -10,8 +12,10 @@ declare interface Config {
     variants: string[];
     interwiki: string[];
     excludes?: string[];
+    conversionTable?: [string, string][];
+    redirects?: [string, string][];
 }
-declare interface LintError {
+export interface LintError {
     message: string;
     severity: 'error' | 'warning';
     startIndex: number;
@@ -26,7 +30,7 @@ declare interface Parser {
     /** @browser */
     config: string | Config;
     /** @browser */
-    i18n: string | Record<string, string> | undefined;
+    i18n?: string | Record<string, string>;
     conversionTable: Map<string, string>;
     redirects: Map<string, string>;
     /**
@@ -39,14 +43,14 @@ declare interface Parser {
      * @param decode 是否需要解码
      * @param selfLink 是否允许selfLink
      */
-    normalizeTitle(title: string, defaultNs?: number, include?: boolean, config?: Config, halfParsed?: boolean, decode?: boolean, selfLink?: boolean): import('./lib/title');
+    normalizeTitle(title: string, defaultNs?: number, include?: boolean, config?: Config, halfParsed?: boolean, decode?: boolean, selfLink?: boolean): Title;
     /**
      * 解析wikitext
      * @browser
      * @param include 是否嵌入
      * @param maxStage 最大解析层级
      */
-    parse(wikitext: string, include?: boolean, maxStage?: number, config?: Config): import('./src');
+    parse(wikitext: string, include?: boolean, maxStage?: number, config?: Config): Token;
     /**
      * 是否是跨维基链接
      * @param title 链接标题
@@ -54,7 +58,5 @@ declare interface Parser {
     isInterwiki(title: string, config?: Config): [string, string] | null;
 }
 declare const Parser: Parser;
-declare namespace Parser {
-    export type { Config, LintError, };
-}
-export = Parser;
+export default Parser;
+export type * from './internal';

package/dist/index.js

@@ -1,4 +1,5 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs");
 const path = require("path");
 /**
@@ -6,10 +7,10 @@ const path = require("path");
  * @param file 文件名
  * @param dir 子路径
  */
-const rootRequire = (file, dir = '') => require(`${file.includes('/') ? '' : `../${dir}`}${file}`);
+const rootRequire = (file, dir = '') => require(`../${file.includes('/') ? '' : dir}${file}`);
+// eslint-disable-next-line @typescript-eslint/no-redeclare
 const Parser = {
     config: 'default',
-    i18n: undefined,
     conversionTable: new Map(),
     redirects: new Map(),
     MAX_STAGE: 11,
@@ -48,12 +49,12 @@ const Parser = {
         'attr-key': ['attribute-key'],
         'attr-value': ['attribute-value', 'attr-val', 'attribute-val'],
         'ext-inner': ['extension-inner'],
-        // triple brackets
+        // triple braces
         arg: ['argument'],
         'arg-name': ['argument-name'],
         'arg-default': ['argument-default'],
         hidden: ['arg-redundant'],
-        // double brackets
+        // double braces
         'magic-word': ['parser-function', 'parser-func'],
         'magic-word-name': ['parser-function-name', 'parser-func-name'],
         'invoke-function': ['invoke-func', 'lua-function', 'lua-func', 'module-function', 'module-func'],
@@ -116,7 +117,6 @@ const Parser = {
         'converter-rule-from': ['convert-rule-from', 'conversion-rule-from'],
         // specific extensions
         'param-line': ['parameter-line'],
-        'charinsert-line': undefined,
         'imagemap-link': ['image-map-link'],
     },
     promises: [Promise.resolve()],
@@ -124,6 +124,13 @@ const Parser = {
     getConfig() {
         if (typeof this.config === 'string') {
             this.config = rootRequire(this.config, 'config/');
+            const { config: { conversionTable, redirects } } = this;
+            if (conversionTable) {
+                this.conversionTable = new Map(conversionTable);
+            }
+            if (redirects) {
+                this.redirects = new Map(redirects);
+            }
             return this.getConfig();
         }
         return { ...this.config, excludes: [] };
@@ -138,36 +145,26 @@ const Parser = {
     },
     /** @implements */
     normalizeTitle(title, defaultNs = 0, include = false, config = Parser.getConfig(), halfParsed = false, decode = false, selfLink = false) {
-        const Title = require('./lib/title');
+        const { Title } = require('./lib/title');
         if (halfParsed) {
             return new Title(title, defaultNs, config, decode, selfLink);
         }
-        const Token = require('./src');
+        const { Token } = require('./src');
         const token = this.run(() => new Token(title, config).parseOnce(0, include).parseOnce()), titleObj = new Title(String(token.firstChild), defaultNs, config, decode, selfLink);
-        /**
-         * 重建部分属性值
-         * @param keys 属性键
-         */
-        const build = (keys) => {
-            for (const key of keys) {
+        this.run(() => {
+            for (const key of ['main', 'fragment']) {
                 if (titleObj[key]?.includes('\0')) {
                     titleObj[key] = token.buildFromStr(titleObj[key], 'text');
                 }
             }
-        };
-        this.run(() => {
-            build(['main', 'fragment']);
         });
-        titleObj.autoConvert(this.conversionTable);
+        titleObj.conversionTable = this.conversionTable;
         titleObj.redirects = this.redirects;
         return titleObj;
     },
     /** @implements */
     parse(wikitext, include, maxStage = Parser.MAX_STAGE, config = Parser.getConfig()) {
-        if (typeof wikitext !== 'string') {
-            throw new TypeError('待解析的内容应为 String！');
-        }
-        const Token = require('./src');
+        const { Token } = require('./src');
         let token;
         this.run(() => {
             token = new Token(wikitext, config);
@@ -194,7 +191,7 @@ const Parser = {
                 process = '渲染HTML';
             }
             if (restored !== wikitext) {
-                const diff = require('./util/diff');
+                const { diff } = require('./util/diff');
                 const { promises: { 0: cur, length } } = this;
                 this.promises.unshift((async () => {
                     await cur;
@@ -260,6 +257,7 @@ const Parser = {
         }
         for (const [name, filePath] of entries) {
             if (name in global) {
+                // @ts-expect-error noImplicitAny
                 global[name] = require(filePath);
             }
         }
@@ -277,7 +275,7 @@ const Parser = {
             throw new RangeError(`找不到对应时间戳的错误记录：${date}`);
         }
         const file = path.join(__dirname, '..', 'errors', main), wikitext = fs.readFileSync(file, 'utf8');
-        const { stage, include, config } = require(`${file}.json`), Token = require('./src');
+        const { stage, include, config } = require(`${file}.json`), { Token } = require('./src');
         this.config = config;
         return this.run(() => {
             const halfParsed = stage < this.MAX_STAGE, token = new Token(wikitext, this.getConfig(), halfParsed);
@@ -304,4 +302,4 @@ for (const key in Parser) {
     }
 }
 Object.defineProperties(Parser, def);
-module.exports = Parser;
+exports.default = Parser;

package/dist/internal.d.ts

@@ -0,0 +1,44 @@
+export type { AstNodes, } from './lib/node';
+export type * from './lib/text';
+export type * from './src';
+export type * from './src/onlyinclude';
+export type * from './src/nowiki/noinclude';
+export type * from './src/tagPair/include';
+export type * from './src/nowiki/comment';
+export type * from './src/atom';
+export type * from './src/attribute';
+export type * from './src/attributes';
+export type * from './src/tagPair/ext';
+export type * from './src/hidden';
+export type * from './src/arg';
+export type * from './src/syntax';
+export type * from './src/parameter';
+export type * from './src/transclude';
+export type * from './src/heading';
+export type * from './src/html';
+export type { TdToken } from './src/table/td';
+export type * from './src/table/tr';
+export type * from './src/table';
+export type * from './src/nowiki/hr';
+export type * from './src/nowiki/doubleUnderscore';
+export type * from './src/link';
+export type * from './src/link/category';
+export type * from './src/imageParameter';
+export type * from './src/link/file';
+export type * from './src/link/galleryImage';
+export type * from './src/nowiki/quote';
+export type * from './src/magicLink';
+export type * from './src/extLink';
+export type * from './src/nowiki/dd';
+export type * from './src/nowiki/list';
+export type * from './src/converterFlags';
+export type * from './src/converterRule';
+export type * from './src/converter';
+export type * from './src/nowiki';
+export type * from './src/pre';
+export type * from './src/paramTag';
+export type * from './src/paramTag/inputbox';
+export type * from './src/nested';
+export type * from './src/gallery';
+export type * from './src/imagemapLink';
+export type * from './src/imagemap';

package/dist/lib/element.d.ts

@@ -1,9 +1,8 @@
-import * as Parser from '../index';
-import * as AstNode from './node';
-import AstText = require('./text');
-import type { AstNodeTypes } from './node';
+import { AstNode } from './node';
+import type { LintError } from '../index';
+import type { AstNodes, AstText, Token } from '../internal';
 /** 类似HTMLElement */
-declare abstract class AstElement extends AstNode {
+export declare abstract class AstElement extends AstNode {
     #private;
     /** @browser */
     name?: string;
@@ -13,23 +12,23 @@ declare abstract class AstElement extends AstNode {
      */
     get length(): number;
     /** 全部非文本子节点 */
-    get children(): import('../src')[];
+    get children(): Token[];
     /** 首位非文本子节点 */
-    get firstElementChild(): import('../src') | undefined;
+    get firstElementChild(): Token | undefined;
     /** 末位非文本子节点 */
-    get lastElementChild(): import('../src') | undefined;
+    get lastElementChild(): Token | undefined;
     /** 非文本子节点总数 */
     get childElementCount(): number;
     /** 父节点 */
-    get parentElement(): import('../src') | undefined;
+    get parentElement(): Token | undefined;
     /** AstElement.prototype.text()的getter写法 */
     get outerText(): string;
     /** 不可见 */
     get hidden(): boolean;
     /** 后一个可见的兄弟节点 */
-    get nextVisibleSibling(): AstNodeTypes | undefined;
+    get nextVisibleSibling(): AstNodes | undefined;
     /** 前一个可见的兄弟节点 */
-    get previousVisibleSibling(): AstNodeTypes | undefined;
+    get previousVisibleSibling(): AstNodes | undefined;
     /** 内部高度 */
     get clientHeight(): number | undefined;
     /** 内部宽度 */
@@ -51,7 +50,7 @@ declare abstract class AstElement extends AstNode {
      * @browser
      * @param i 移除位置
      */
-    removeAt(i: number): AstNodeTypes;
+    removeAt(i: number): AstNodes;
     /**
      * 插入子节点
      * @browser
@@ -59,24 +58,25 @@ declare abstract class AstElement extends AstNode {
      * @param i 插入位置
      * @throws `RangeError` 不能插入祖先节点
      */
-    insertAt<T extends AstNodeTypes>(node: T, i?: number): T;
+    insertAt<T extends AstNodes>(node: T, i?: number): T;
     /**
      * 最近的祖先节点
      * @browser
+     * @param selector 选择器
      */
-    closest(selector: string): import('../src') | undefined;
+    closest(selector: string): Token | undefined;
     /**
      * 在末尾批量插入子节点
      * @browser
      * @param elements 插入节点
      */
-    append(...elements: (AstNodeTypes | string)[]): void;
+    append(...elements: (AstNodes | string)[]): void;
     /**
      * 批量替换子节点
      * @browser
      * @param elements 新的子节点
      */
-    replaceChildren(...elements: (AstNodeTypes | string)[]): void;
+    replaceChildren(...elements: (AstNodes | string)[]): void;
     /**
      * 修改文本子节点
      * @browser
@@ -88,14 +88,16 @@ declare abstract class AstElement extends AstNode {
     /**
      * 还原为wikitext
      * @browser
+     * @param selector
      * @param separator 子节点间的连接符
      */
     toString(selector?: string, separator?: string): string;
     /**
      * Linter
      * @browser
+     * @param start
      */
-    lint(start?: number): Parser.LintError[];
+    lint(start?: number): LintError[];
     /**
      * 以HTML格式打印
      * @browser
@@ -110,27 +112,36 @@ declare abstract class AstElement extends AstNode {
     json(file?: string): unknown;
     /** 销毁 */
     destroy(): void;
-    /** 检查是否符合选择器 */
+    /**
+     * 检查是否符合选择器
+     * @param selector 选择器
+     */
     matches(selector?: string): boolean;
-    /** 符合选择器的第一个后代节点 */
-    querySelector(selector: string): import('../src') | undefined;
-    /** 符合选择器的所有后代节点 */
-    querySelectorAll(selector: string): import('../src')[];
+    /**
+     * 符合选择器的第一个后代节点
+     * @param selector 选择器
+     */
+    querySelector(selector: string): Token | undefined;
+    /**
+     * 符合选择器的所有后代节点
+     * @param selector 选择器
+     */
+    querySelectorAll(selector: string): Token[];
     /**
      * id选择器
      * @param id id名
      */
-    getElementById(id: string): import('../src') | undefined;
+    getElementById(id: string): Token | undefined;
     /**
      * 类选择器
      * @param className 类名之一
      */
-    getElementsByClassName(className: string): import('../src')[];
+    getElementsByClassName(className: string): Token[];
     /**
      * 标签名选择器
      * @param name 标签名
      */
-    getElementsByTagName(name: string): import('../src')[];
+    getElementsByTagName(name: string): Token[];
     /**
      * 获取某一行的wikitext
      * @param n 行号
@@ -140,37 +151,36 @@ declare abstract class AstElement extends AstNode {
      * 在开头批量插入子节点
      * @param elements 插入节点
      */
-    prepend(...elements: (AstNodeTypes | string)[]): void;
+    prepend(...elements: (AstNodes | string)[]): void;
     /**
      * 移除子节点
      * @param node 子节点
      */
-    removeChild<T extends AstNodeTypes>(node: T): T;
+    removeChild<T extends AstNodes>(node: T): T;
     /**
      * 在末尾插入子节点
      * @param node 插入节点
      */
     appendChild(node: string): AstText;
     /** @ignore */
-    appendChild<T extends AstNodeTypes>(node: T): T;
+    appendChild<T extends AstNodes>(node: T): T;
     /**
      * 在指定位置前插入子节点
      * @param child 插入节点
      * @param reference 指定位置处的子节点
      */
-    insertBefore(child: string, reference?: AstNodeTypes): AstText;
+    insertBefore(child: string, reference?: AstNodes): AstText;
     /** @ignore */
-    insertBefore<T extends AstNodeTypes>(child: T, reference?: AstNodeTypes): T;
+    insertBefore<T extends AstNodes>(child: T, reference?: AstNodes): T;
     /**
      * 替换子节点
      * @param newChild 新子节点
      * @param oldChild 原子节点
      */
-    replaceChild<T extends AstNodeTypes>(newChild: AstNodeTypes | string, oldChild: T): T;
+    replaceChild<T extends AstNodes>(newChild: AstNodes | string, oldChild: T): T;
     /**
      * 输出AST
      * @param depth 当前深度
      */
     echo(depth?: number): void;
 }
-export = AstElement;