@mptool/all 0.7.2 → 0.8.0

package/lib/index.d.mts

@@ -648,12 +648,6 @@ interface ExtendedPageMethods<Data extends WechatMiniprogram.IAnyObject, Custom
      * 获取当前页面实例。
      */
     $currentPage(): PageInstance<Data, Custom>;
-    /**
-     * 获得页面简称
-     *
-     * @param url 页面地址
-     */
-    $getName(url: string): string;
     /**
      * 获得页面路径
      *
@@ -807,6 +801,17 @@ interface AppConfigCommonOptions {
     injectPage?(name: string, options: TrivialPageOptions): void;
 }
 interface RoutePathConfig {
+    /**
+     * 当你给出的页面路径或简称无法通过 routeMap 解析时，会回退到此路径
+     *
+     * 填入小程序路径模式，小程序路径模式是一个路径字符串，用 `$name` 表示小程序简称的位置
+     *
+     * 例子: 你可以填入 `/pages/$name/$name` 来表达:
+     *
+     * - `main': '/pages/main/main`
+     * - `user': '/pages/user/user`
+     */
+    defaultPage: string;
     /**
      * 你可以直接以对象形式表示简称到路径的映射。如:
      *
@@ -850,48 +855,29 @@ interface RoutePathConfig {
      * }
      * ```
      *
-     * @description 无法解析的路径会回退到 `defaultRoute`
+     * @description 无法解析的路径会回退到 `defaultPage`
      */
-    routes?: Record<string, string> | [string | string[], string][];
-    /**
-     * 当你给出的页面路径或简称无法通过 routeMap 解析时，会回退到此路径
-     *
-     * 填入小程序路径模式，小程序路径模式是一个路径字符串，用 `$name` 表示小程序简称的位置
-     *
-     * 例子: 你可以填入 `/pages/$name/$name` 来表达:
-     *
-     * - `main': '/pages/main/main`
-     * - `user': '/pages/user/user`
-     */
-    defaultRoute: string;
+    pages?: Record<string, string> | [string | string[], string][];
 }
 interface RouteCustomConfig {
-    /**
-     * 获得页面简称
-     *
-     * @param url 页面路径
-     * @returns 页面名称
-     */
-    getName: (url: string) => string;
     /**
      * 获得页面路径
      *
      * @param pageName 页面简称
      * @returns 页面路径
      */
-    getRoute: (pageName: string) => string;
+    getPath: (pageName: string) => string;
 }
 type AppConfigOptions = AppConfigCommonOptions & (RoutePathConfig | RouteCustomConfig);
 
-interface Config extends Omit<AppConfigOptions, "defaultRoute" | "routes"> {
+interface Config extends Omit<AppConfigOptions, "defaultPage" | "pages"> {
     /**
-     * @returns name
-     */
-    getName: (url: string) => string;
-    /**
-     * @returns route
+     * 获得页面路径
+     *
+     * @param pageName 页面简称
+     * @returns 页面路径
      */
-    getRoute: (pageName: string) => string;
+    getPath: (pageName: string) => string;
 }
 declare const $Config: (config: AppConfigOptions) => void;
 declare const getConfig: () => Config;
@@ -1530,265 +1516,4 @@ interface RequestFactory {
  */
 declare const createRequest: ({ cookieStore, server, responseHandler, errorHandler, ...defaultOptions }?: RequestInitOptions) => RequestFactory;
 
-type AllowTag = "a" | "abbr" | "address" | "article" | "aside" | "b" | "bdi" | "bdo" | "blockquote" | "br" | "caption" | "cite" | "code" | "col" | "colgroup" | "dd" | "del" | "div" | "dl" | "dt" | "em" | "fieldset" | "footer" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "header" | "hr" | "i" | "img" | "ins" | "label" | "legend" | "li" | "mark" | "nav" | "ol" | "p" | "pre" | "q" | "rt" | "ruby" | "s" | "section" | "small" | "span" | "strong" | "sub" | "sup" | "table" | "tbody" | "td" | "tfoot" | "th" | "thead" | "tr" | "tt" | "u" | "ul";
-declare const ALLOWED_TAGS: [
-    tag: AllowTag | "big" | "center" | "font",
-    allowedAttrs?: string[]
-][];
-
-/** Types of elements found in htmlparser2's DOM */
-declare enum ElementType {
-    /** Type for the root element of a document */
-    Root = "root",
-    /** Type for Text */
-    Text = "text",
-    /** Type for <? ... ?> */
-    Directive = "directive",
-    /** Type for <!-- ... --> */
-    Comment = "comment",
-    /** Type for <script> tags */
-    Script = "script",
-    /** Type for <style> tags */
-    Style = "style",
-    /** Type for Any tag */
-    Tag = "tag",
-    /** Type for <![CDATA[ ... ]]> */
-    CDATA = "cdata",
-    /** Type for <!doctype ...> */
-    Doctype = "doctype"
-}
-
-interface SourceCodeLocation {
-    /** One-based line index of the first character. */
-    startLine: number;
-    /** One-based column index of the first character. */
-    startCol: number;
-    /** Zero-based first character index. */
-    startOffset: number;
-    /** One-based line index of the last character. */
-    endLine: number;
-    /** One-based column index of the last character. Points directly *after* the last character. */
-    endCol: number;
-    /** Zero-based last character index. Points directly *after* the last character. */
-    endOffset: number;
-}
-interface TagSourceCodeLocation extends SourceCodeLocation {
-    startTag?: SourceCodeLocation;
-    endTag?: SourceCodeLocation;
-}
-declare type ParentNode = Document | Element | CDATA;
-declare type ChildNode = Text | Comment | ProcessingInstruction | Element | CDATA | Document;
-declare type AnyNode = ParentNode | ChildNode;
-/**
- * This object will be used as the prototype for Nodes when creating a
- * DOM-Level-1-compliant structure.
- */
-declare abstract class Node {
-    /** The type of the node. */
-    abstract readonly type: ElementType;
-    /** Parent of the node */
-    parent: ParentNode | null;
-    /** Previous sibling */
-    prev: ChildNode | null;
-    /** Next sibling */
-    next: ChildNode | null;
-    /** The start index of the node. Requires `withStartIndices` on the handler to be `true. */
-    startIndex: number | null;
-    /** The end index of the node. Requires `withEndIndices` on the handler to be `true. */
-    endIndex: number | null;
-    /**
-     * `parse5` source code location info.
-     *
-     * Available if parsing with parse5 and location info is enabled.
-     */
-    sourceCodeLocation?: SourceCodeLocation | null;
-    /**
-     * [DOM spec](https://dom.spec.whatwg.org/#dom-node-nodetype)-compatible
-     * node {@link type}.
-     */
-    abstract readonly nodeType: number;
-    /**
-     * Same as {@link parent}.
-     * [DOM spec](https://dom.spec.whatwg.org)-compatible alias.
-     */
-    get parentNode(): ParentNode | null;
-    set parentNode(parent: ParentNode | null);
-    /**
-     * Same as {@link prev}.
-     * [DOM spec](https://dom.spec.whatwg.org)-compatible alias.
-     */
-    get previousSibling(): ChildNode | null;
-    set previousSibling(prev: ChildNode | null);
-    /**
-     * Same as {@link next}.
-     * [DOM spec](https://dom.spec.whatwg.org)-compatible alias.
-     */
-    get nextSibling(): ChildNode | null;
-    set nextSibling(next: ChildNode | null);
-    /**
-     * Clone this node, and optionally its children.
-     *
-     * @param recursive Clone child nodes as well.
-     * @returns A clone of the node.
-     */
-    cloneNode<T extends Node>(this: T, recursive?: boolean): T;
-}
-/**
- * A node that contains some data.
- */
-declare abstract class DataNode extends Node {
-    data: string;
-    /**
-     * @param data The content of the data node
-     */
-    constructor(data: string);
-    /**
-     * Same as {@link data}.
-     * [DOM spec](https://dom.spec.whatwg.org)-compatible alias.
-     */
-    get nodeValue(): string;
-    set nodeValue(data: string);
-}
-/**
- * Text within the document.
- */
-declare class Text extends DataNode {
-    type: ElementType.Text;
-    get nodeType(): 3;
-}
-/**
- * Comments within the document.
- */
-declare class Comment extends DataNode {
-    type: ElementType.Comment;
-    get nodeType(): 8;
-}
-/**
- * Processing instructions, including doc types.
- */
-declare class ProcessingInstruction extends DataNode {
-    name: string;
-    type: ElementType.Directive;
-    constructor(name: string, data: string);
-    get nodeType(): 1;
-    /** If this is a doctype, the document type name (parse5 only). */
-    "x-name"?: string;
-    /** If this is a doctype, the document type public identifier (parse5 only). */
-    "x-publicId"?: string;
-    /** If this is a doctype, the document type system identifier (parse5 only). */
-    "x-systemId"?: string;
-}
-/**
- * A `Node` that can have children.
- */
-declare abstract class NodeWithChildren extends Node {
-    children: ChildNode[];
-    /**
-     * @param children Children of the node. Only certain node types can have children.
-     */
-    constructor(children: ChildNode[]);
-    /** First child of the node. */
-    get firstChild(): ChildNode | null;
-    /** Last child of the node. */
-    get lastChild(): ChildNode | null;
-    /**
-     * Same as {@link children}.
-     * [DOM spec](https://dom.spec.whatwg.org)-compatible alias.
-     */
-    get childNodes(): ChildNode[];
-    set childNodes(children: ChildNode[]);
-}
-declare class CDATA extends NodeWithChildren {
-    type: ElementType.CDATA;
-    get nodeType(): 4;
-}
-/**
- * The root node of the document.
- */
-declare class Document extends NodeWithChildren {
-    type: ElementType.Root;
-    get nodeType(): 9;
-    /** [Document mode](https://dom.spec.whatwg.org/#concept-document-limited-quirks) (parse5 only). */
-    "x-mode"?: "no-quirks" | "quirks" | "limited-quirks";
-}
-/**
- * The description of an individual attribute.
- */
-interface Attribute {
-    name: string;
-    value: string;
-    namespace?: string;
-    prefix?: string;
-}
-/**
- * An element within the DOM.
- */
-declare class Element extends NodeWithChildren {
-    name: string;
-    attribs: {
-        [name: string]: string;
-    };
-    type: ElementType.Tag | ElementType.Script | ElementType.Style;
-    /**
-     * @param name Name of the tag, eg. `div`, `span`.
-     * @param attribs Object mapping attribute names to attribute values.
-     * @param children Children of the node.
-     */
-    constructor(name: string, attribs: {
-        [name: string]: string;
-    }, children?: ChildNode[], type?: ElementType.Tag | ElementType.Script | ElementType.Style);
-    get nodeType(): 1;
-    /**
-     * `parse5` source code location info, with start & end tags.
-     *
-     * Available if parsing with parse5 and location info is enabled.
-     */
-    sourceCodeLocation?: TagSourceCodeLocation | null;
-    /**
-     * Same as {@link name}.
-     * [DOM spec](https://dom.spec.whatwg.org)-compatible alias.
-     */
-    get tagName(): string;
-    set tagName(name: string);
-    get attributes(): Attribute[];
-    /** Element namespace (parse5 only). */
-    namespace?: string;
-    /** Element attribute namespaces (parse5 only). */
-    "x-attribsNamespace"?: Record<string, string>;
-    /** Element attribute namespace-related prefixes (parse5 only). */
-    "x-attribsPrefix"?: Record<string, string>;
-}
-
-declare const parseHTML: (content: string) => AnyNode[];
-
-interface ElementNode {
-    type: "node";
-    name: string;
-    attrs?: Record<string, string>;
-    children?: RichTextNode[];
-}
-interface TextNode {
-    type: "text";
-    text: string;
-}
-type RichTextNode = ElementNode | TextNode;
-
-type NodeHandler = (node: ElementNode) => ElementNode | null | Promise<ElementNode | null>;
-interface ParserOptions {
-    /**
-     * 是否附加标签名到 class
-     *
-     * @default true
-     */
-    appendClass?: boolean;
-    /**
-     * 处理 Tag
-     */
-    transform?: Partial<Record<AllowTag, NodeHandler>>;
-}
-
-declare const getRichTextNodes: (content: string | AnyNode[], { appendClass, transform }?: ParserOptions) => Promise<RichTextNode[]>;
-
-declare const getText: (content: string | AnyNode[]) => string;
-
-export { $App, $Component, $Config, $Page, ALLOWED_TAGS, type AllowTag, type AppConfigCommonOptions, type AppConfigOptions, type AppConstructor, type AppInstance, type AppOptions, type ComponentConstructor, type ComponentInstance, type ComponentLifetimes, type ComponentOptions, type Config, Cookie, type CookieMap, type CookieOptions, CookieStore, type CookieStoreType, type CookieType, type ElementNode, Emitter, type EmitterInstance, type EventHandlerList, type EventHandlerMap, type EventType, type ExtendedAppMethods, type ExtendedComponentMethods, type ExtendedComponentProperty, type ExtendedPageLifeCycles, type ExtendedPageMethods, type ExtendedPageProperties, type ExtendsAppOptions, type Handler, Headers, type HeadersInit, type InferFromType, type InferPropType, type InferPropTypes, type PageConstructor, type PageInstance, type PageOptions, type PageQuery, type PageState, type PropItem, type PropOption, type PropType, type Props, type PropsOptions, Queue, type RefMap, type RequestBody, type RequestError, type RequestFactory, type RequestInitOptions, type RequestOptions, type RequestResponse, type RequestType, type RichTextNode, type RouteCustomConfig, type RoutePathConfig, type SetCookieOptions, type StorageData, type Task, type TextNode, type TrivialComponentInstance, type TrivialComponentOptions, type TrivialPageInstance, type TrivialPageOptions, URLSearchParams, type UrlInfo, type WildCardEventHandlerList, type WildcardHandler, appState, check, checkAsync, createRequest, decode as decodeBase64, dirname, userEmitter as emitter, encode as encodeBase64, exists, funcQueue, get, getAsync, getConfig, getCookieOptions, getCookieScopeDomain, getDomain, getRef, getRichTextNodes, getText, handleProperties, isDir, isFile, isFunction, isMp, isQQ, isWx, lock, logger, ls, mkdir, normalizeDomain, once, parseCookieHeader, parseHTML, parseUrl, put, query, readFile, readJSON, remove, removeAsync, removeRef, request, requestCookieStore, rm, saveFile, saveOnlineFile, set, setAsync, setRef, storage, take, type, unzip, wrapFunction, writeFile, writeJSON };
+export { $App, $Component, $Config, $Page, type AppConfigCommonOptions, type AppConfigOptions, type AppConstructor, type AppInstance, type AppOptions, type ComponentConstructor, type ComponentInstance, type ComponentLifetimes, type ComponentOptions, type Config, Cookie, type CookieMap, type CookieOptions, CookieStore, type CookieStoreType, type CookieType, Emitter, type EmitterInstance, type EventHandlerList, type EventHandlerMap, type EventType, type ExtendedAppMethods, type ExtendedComponentMethods, type ExtendedComponentProperty, type ExtendedPageLifeCycles, type ExtendedPageMethods, type ExtendedPageProperties, type ExtendsAppOptions, type Handler, Headers, type HeadersInit, type InferFromType, type InferPropType, type InferPropTypes, type PageConstructor, type PageInstance, type PageOptions, type PageQuery, type PageState, type PropItem, type PropOption, type PropType, type Props, type PropsOptions, Queue, type RefMap, type RequestBody, type RequestError, type RequestFactory, type RequestInitOptions, type RequestOptions, type RequestResponse, type RequestType, type RouteCustomConfig, type RoutePathConfig, type SetCookieOptions, type StorageData, type Task, type TrivialComponentInstance, type TrivialComponentOptions, type TrivialPageInstance, type TrivialPageOptions, URLSearchParams, type UrlInfo, type WildCardEventHandlerList, type WildcardHandler, appState, check, checkAsync, createRequest, decode as decodeBase64, dirname, userEmitter as emitter, encode as encodeBase64, exists, funcQueue, get, getAsync, getConfig, getCookieOptions, getCookieScopeDomain, getDomain, getRef, handleProperties, isDir, isFile, isFunction, isMp, isQQ, isWx, lock, logger, ls, mkdir, normalizeDomain, once, parseCookieHeader, parseUrl, put, query, readFile, readJSON, remove, removeAsync, removeRef, request, requestCookieStore, rm, saveFile, saveOnlineFile, set, setAsync, setRef, storage, take, type, unzip, wrapFunction, writeFile, writeJSON };