@tarojs/runtime 3.7.0-alpha.2 → 3.7.0-alpha.22

package/dist/runtime.esm.d.ts

@@ -5,18 +5,19 @@ import { ComponentOptions, VNode } from "vue";
 import { Component as Vue3Component } from "@vue/runtime-core";
 import { Component, ComponentClass } from "react";
 import { CombinedVueInstance } from "vue/types/vue";
-declare let document: any;
-declare class ClassList extends Set<string> {
+declare class ClassList {
     private el;
+    private tokenList;
     constructor(className: string, el: TaroElement);
     get value(): string;
-    add(s: string): this;
     get length(): number;
-    remove(s: string): void;
-    toggle(s: string): void;
-    replace(s1: string, s2: string): void;
-    contains(s: string): boolean;
+    add(): void;
+    remove(): void;
+    contains(token: string): boolean;
+    toggle(token: string, force: boolean): boolean;
+    replace(token: string, replacement_token: string): void;
     toString(): string;
+    private checkTokenIsValid;
     private _update;
 }
 interface Attributes {
@@ -102,68 +103,6 @@ declare class TaroText extends TaroNode {
     set data(text: string);
     get data(): string;
 }
-// Taro 事件对象。以 Web 标准的事件对象为基础，加入小程序事件对象中携带的部分信息，并模拟实现事件冒泡。
-declare class TaroEvent {
-    private cacheTarget;
-    private cacheCurrentTarget;
-    type: string;
-    bubbles: boolean;
-    cancelable: boolean;
-    _stop: boolean;
-    _end: boolean;
-    defaultPrevented: boolean;
-    // Mouse Event botton property, it's used in 3rd lib, like react-router. default 0 in general
-    button: number;
-    // timestamp can either be hi-res ( relative to page load) or low-res (relative to UNIX epoch)
-    // here use hi-res timestamp
-    timeStamp: number;
-    mpEvent: MpEvent | undefined;
-    constructor(type: string, opts: EventOptions, event?: MpEvent);
-    stopPropagation(): void;
-    stopImmediatePropagation(): void;
-    preventDefault(): void;
-    get target(): any;
-    get currentTarget(): any;
-}
-declare function createEvent(event: MpEvent | string, node?: TaroElement): TaroEvent;
-// 小程序的事件代理回调函数
-declare function eventHandler(event: MpEvent): any;
-declare class FormElement extends TaroElement {
-    get value(): string | boolean | number | any[];
-    set value(val: string | boolean | number | any[]);
-    dispatchEvent(event: TaroEvent): boolean;
-}
-declare class TaroRootElement extends TaroElement {
-    private updatePayloads;
-    private updateCallbacks;
-    pendingUpdate: boolean;
-    ctx: null | MpInstance;
-    constructor();
-    get _path(): string;
-    get _root(): TaroRootElement;
-    enqueueUpdate(payload: UpdatePayload): void;
-    performUpdate(initRender?: boolean, prerender?: Func): void;
-    enqueueUpdateCallback(cb: Func, ctx?: Record<string, any>): void;
-    flushUpdateCallback(): void;
-}
-declare class TaroDocument extends TaroElement {
-    documentElement: TaroElement;
-    head: TaroElement;
-    body: TaroElement;
-    createEvent: typeof createEvent;
-    constructor();
-    createElement(type: string): TaroElement | TaroRootElement | FormElement;
-    // an ugly fake createElementNS to deal with @vue/runtime-dom's
-    // support mounting app to svg container since vue@3.0.8
-    createElementNS(_svgNS: string, type: string): TaroElement | TaroRootElement | FormElement;
-    createTextNode(text: string): TaroText;
-    getElementById<T extends TaroElement>(id: string | undefined | null): T | null;
-    querySelector<T extends TaroElement>(query: string): T | null;
-    querySelectorAll(): never[];
-    // @TODO: @PERF: 在 hydrate 移除掉空的 node
-    createComment(): TaroText;
-    get defaultView(): any;
-}
 interface Node {
     type: string;
 }
@@ -203,6 +142,19 @@ declare class TaroEventTarget {
     removeEventListener(type: string, handler: EventHandler): void;
     isAnyEventBinded(): boolean;
 }
+declare class TaroRootElement extends TaroElement {
+    private updatePayloads;
+    private updateCallbacks;
+    pendingUpdate: boolean;
+    ctx: null | MpInstance;
+    constructor();
+    get _path(): string;
+    get _root(): TaroRootElement;
+    enqueueUpdate(payload: UpdatePayload): void;
+    performUpdate(initRender?: boolean, prerender?: Func): void;
+    enqueueUpdateCallback(cb: Func, ctx?: Record<string, any>): void;
+    flushUpdateCallback(): void;
+}
 interface RemoveChildOptions {
     cleanRef?: boolean;
     doUpdate?: boolean;
@@ -217,6 +169,7 @@ declare class TaroNode extends TaroEventTarget {
     constructor();
     private hydrate;
     private updateChildNodes;
+    private updateSingleChild;
     get _root(): TaroRootElement | null;
     protected findIndex(refChild: TaroNode): number;
     get _path(): string;
@@ -285,7 +238,34 @@ declare class Style {
     removeProperty(propertyName: string): string;
     getPropertyValue(propertyName: string): any;
 }
+// Taro 事件对象。以 Web 标准的事件对象为基础，加入小程序事件对象中携带的部分信息，并模拟实现事件冒泡。
+declare class TaroEvent {
+    private cacheTarget;
+    private cacheCurrentTarget;
+    type: string;
+    bubbles: boolean;
+    cancelable: boolean;
+    _stop: boolean;
+    _end: boolean;
+    defaultPrevented: boolean;
+    // Mouse Event botton property, it's used in 3rd lib, like react-router. default 0 in general
+    button: number;
+    // timestamp can either be hi-res ( relative to page load) or low-res (relative to UNIX epoch)
+    // here use hi-res timestamp
+    timeStamp: number;
+    mpEvent: MpEvent | undefined;
+    constructor(type: string, opts: EventOptions, event?: MpEvent);
+    stopPropagation(): void;
+    stopImmediatePropagation(): void;
+    preventDefault(): void;
+    get target(): any;
+    get currentTarget(): any;
+}
+declare function createEvent(event: MpEvent | string, node?: TaroElement): TaroEvent;
+// 小程序的事件代理回调函数
+declare function eventHandler(event: MpEvent): any;
 declare class TaroElement extends TaroNode {
+    ctx?: any;
     tagName: string;
     props: Record<string, any>;
     style: Style;
@@ -319,6 +299,37 @@ declare class TaroElement extends TaroNode {
     removeEventListener(type: any, handler: any, sideEffect?: boolean): void;
     static extend(methodName: string, options: Func | Record<string, any>): void;
 }
+declare class FormElement extends TaroElement {
+    get type(): string;
+    set type(val: string);
+    get value(): string | boolean | number | any[];
+    set value(val: string | boolean | number | any[]);
+    dispatchEvent(event: TaroEvent): boolean;
+}
+declare class TaroDocument extends TaroElement {
+    documentElement: TaroElement;
+    head: TaroElement;
+    body: TaroElement;
+    createEvent: typeof createEvent;
+    constructor();
+    createElement(type: string): TaroElement | TaroRootElement | FormElement;
+    // an ugly fake createElementNS to deal with @vue/runtime-dom's
+    // support mounting app to svg container since vue@3.0.8
+    createElementNS(_svgNS: string, type: string): TaroElement | TaroRootElement | FormElement;
+    createTextNode(text: string): TaroText;
+    getElementById<T extends TaroElement>(id: string | undefined | null): T | null;
+    querySelector<T extends TaroElement>(query: string): T | null;
+    querySelectorAll(): never[];
+    // @TODO: @PERF: 在 hydrate 移除掉空的 node
+    createComment(): TaroText;
+    get defaultView(): any;
+}
+interface Env {
+    window: any;
+    document: TaroDocument;
+}
+declare const env: Env;
+declare let document: any;
 declare function getComputedStyle(element: TaroElement): Style;
 declare const eventCenter: Events;
 type EventsType = typeof Events;
@@ -405,7 +416,7 @@ declare class History extends Events {
     constructor(location: LocationType.Location, options: Options$0);
     /* public property */
     get length(): number;
-    get state(): HistoryState;
+    get state(): Record<string, any> | null;
     /* public method */
     go(delta: number): void;
     back(): void;
@@ -578,8 +589,67 @@ declare class MutationObserver {
     takeRecords(): MutationRecord[];
     static record(record: MutationRecord): void;
 }
-interface Instance<T> extends Component<T>, Show, PageInstance {
+declare const PROPERTY_THRESHOLD = 2046;
+declare const TARO_RUNTIME = "Taro runtime";
+declare const HOOKS_APP_ID = "taro-app";
+declare const SET_DATA = "\u5C0F\u7A0B\u5E8F setData";
+declare const PAGE_INIT = "\u9875\u9762\u521D\u59CB\u5316";
+declare const ROOT_STR = "root";
+declare const HTML = "html";
+declare const HEAD = "head";
+declare const BODY = "body";
+declare const APP = "app";
+declare const CONTAINER = "container";
+declare const DOCUMENT_ELEMENT_NAME = "#document";
+declare const DOCUMENT_FRAGMENT = "document-fragment";
+declare const ID = "id";
+declare const UID = "uid";
+declare const CLASS = "class";
+declare const STYLE = "style";
+declare const FOCUS = "focus";
+declare const VIEW = "view";
+declare const STATIC_VIEW = "static-view";
+declare const PURE_VIEW = "pure-view";
+declare const PROPS = "props";
+declare const DATASET = "dataset";
+declare const OBJECT = "object";
+declare const VALUE = "value";
+declare const INPUT = "input";
+declare const CHANGE = "change";
+declare const CUSTOM_WRAPPER = "custom-wrapper";
+declare const TARGET = "target";
+declare const CURRENT_TARGET = "currentTarget";
+declare const TYPE = "type";
+declare const CONFIRM = "confirm";
+declare const TIME_STAMP = "timeStamp";
+declare const KEY_CODE = "keyCode";
+declare const TOUCHMOVE = "touchmove";
+declare const DATE = "Date";
+declare const SET_TIMEOUT = "setTimeout";
+declare const CATCHMOVE = "catchMove";
+declare const CATCH_VIEW = "catch-view";
+declare const COMMENT = "comment";
+declare const ON_LOAD = "onLoad";
+declare const ON_READY = "onReady";
+declare const ON_SHOW = "onShow";
+declare const ON_HIDE = "onHide";
+declare const OPTIONS = "options";
+declare const EXTERNAL_CLASSES = "externalClasses";
+declare const EVENT_CALLBACK_RESULT = "e_result";
+declare const BEHAVIORS = "behaviors";
+declare const A = "a";
+/**
+ * 页面上下文切换时的行为
+ */
+declare enum CONTEXT_ACTIONS {
+    INIT = "0",
+    RESTORE = "1",
+    RECOVER = "2",
+    DESTORY = "3"
+}
+interface Instance<T = Record<string, any>> extends Component<T>, Show, PageInstance {
     tid?: string;
+    node?: TaroElement;
     $forceUpdate?(): void;
     $nextTick?(cb: () => void): void;
     $options: Instance;
@@ -587,7 +657,7 @@ interface Instance<T> extends Component<T>, Show, PageInstance {
 interface VueAppInstance extends ComponentOptions<VueCtor> {
     $options: AppInstance;
 }
-type VueInstance<M, P> = CombinedVueInstance<VueCtor, Record<string, any>, M, P, Record<never, any>> & VueInternal;
+type VueInstance<M = Record<string, any>, P = Record<string, any>> = CombinedVueInstance<VueCtor, Record<string, any>, M, P, Record<never, any>> & VueInternal;
 interface VueInternal {
     _render(): VNode;
     _update(vnode: VNode, hyrate: boolean): void;
@@ -595,13 +665,13 @@ interface VueInternal {
 interface PageProps {
     tid?: string;
 }
-interface ReactPageComponent<T> extends ComponentClass<T>, PageInstance {
+interface ReactPageComponent<T = PageProps> extends ComponentClass<T>, PageInstance {
 }
-interface ReactPageInstance<T> extends Component<T>, PageInstance {
+interface ReactPageInstance<T = PageProps> extends Component<T>, PageInstance {
     componentDidShow?(): void;
     componentDidHide?(): void;
 }
-interface ReactAppInstance<T> extends Component<T>, AppInstance {
+interface ReactAppInstance<T = AppInstance> extends Component<T>, AppInstance {
 }
 interface PageLifeCycle extends Show {
     eh?(event: MpEvent): void;
@@ -639,6 +709,8 @@ interface PageInstance extends PageLifeCycle {
     path?: string;
     /** 页面的组件选项 */
     options?: Record<string, unknown>;
+    /** 页面渲染引擎类型 */
+    renderer?: "webview" | "skyline";
 }
 interface Show {
     componentDidShow?(): void;
@@ -649,6 +721,7 @@ interface Show {
 interface AppInstance extends Show {
     componentDidShow?(options?: Record<string, unknown>): void;
     mount?(component: React.ComponentClass | ComponentOptions<VueCtor> | Vue3Component, id: string, cb: (...args: any[]) => void): void;
+    mount?(component: React.ComponentClass | ComponentOptions<VueCtor> | Vue3Component, id: string, getCtx: (...args: any[]) => void, cb: (...args: any[]) => void): void;
     onError?(error: string): void;
     onLaunch?(options?: Record<string, unknown>): void;
     onPageNotFound?(res: any): void;
@@ -686,6 +759,10 @@ declare function removePageInstance(id: string): void;
 declare function addLeadingSlash(path?: string): string;
 declare function safeExecute(path: string, lifecycle: string, ...args: unknown[]): any;
 declare function stringify(obj?: Record<string, unknown>): string;
+declare function getPath(id: string, options?: Record<string, unknown>): string;
+declare function getOnReadyEventKey(path: string): string;
+declare function getOnShowEventKey(path: string): string;
+declare function getOnHideEventKey(path: string): string;
 declare function createPageConfig(component: any, pageName?: string, data?: Record<string, unknown>, pageConfig?: PageConfig): PageInstance;
 declare function createComponentConfig(component: React.ComponentClass, componentName?: string, data?: Record<string, unknown>): any;
 declare function createRecursiveComponentConfig(componentName?: string): any;
@@ -700,4 +777,4 @@ declare const nextTick: (cb: Func, ctx?: Record<string, any>) => void;
 declare const options: Options;
 declare const incrementId: () => () => string;
 export { hooks } from '@tarojs/shared';
-export { document, getComputedStyle, History, Location, nav as navigator, _caf as cancelAnimationFrame, now, _raf as requestAnimationFrame, parseUrl, URL, URLSearchParams, history, location, window, TaroElement, createEvent, eventHandler, TaroEvent, FormElement, TaroNode, TaroRootElement, Style, SVGElement, TaroText, MutationObserver, Current, getCurrentInstance, eventSource, addLeadingSlash, createComponentConfig, createPageConfig, createRecursiveComponentConfig, getPageInstance, injectPageInstance, removePageInstance, safeExecute, stringify, EventsType, eventCenter, Events, hydrate, nextTick, options, incrementId, Instance, VueAppInstance, VueInstance, PageProps, ReactPageComponent, ReactPageInstance, ReactAppInstance, PageLifeCycle, PageInstance, AppInstance, Attributes, EventOptions, MpEvent, EventListenerOptions, AddEventListenerOptions, EventHandler, MpInstance, MiniElementData, MiniData, HydratedData, UpdatePayloadValue, DataTree, UpdatePayload, Options$0 as Options, Func, Ctx };
+export { document, getComputedStyle, History, Location, nav as navigator, _caf as cancelAnimationFrame, now, _raf as requestAnimationFrame, parseUrl, URL, URLSearchParams, history, location, window, TaroElement, createEvent, eventHandler, TaroEvent, FormElement, TaroNode, TaroRootElement, Style, SVGElement, TaroText, MutationObserver, env, PROPERTY_THRESHOLD, TARO_RUNTIME, HOOKS_APP_ID, SET_DATA, PAGE_INIT, ROOT_STR, HTML, HEAD, BODY, APP, CONTAINER, DOCUMENT_ELEMENT_NAME, DOCUMENT_FRAGMENT, ID, UID, CLASS, STYLE, FOCUS, VIEW, STATIC_VIEW, PURE_VIEW, PROPS, DATASET, OBJECT, VALUE, INPUT, CHANGE, CUSTOM_WRAPPER, TARGET, CURRENT_TARGET, TYPE, CONFIRM, TIME_STAMP, KEY_CODE, TOUCHMOVE, DATE, SET_TIMEOUT, CATCHMOVE, CATCH_VIEW, COMMENT, ON_LOAD, ON_READY, ON_SHOW, ON_HIDE, OPTIONS, EXTERNAL_CLASSES, EVENT_CALLBACK_RESULT, BEHAVIORS, A, CONTEXT_ACTIONS, Current, getCurrentInstance, eventSource, addLeadingSlash, createComponentConfig, createPageConfig, createRecursiveComponentConfig, getOnHideEventKey, getOnReadyEventKey, getOnShowEventKey, getPageInstance, getPath, injectPageInstance, removePageInstance, safeExecute, stringify, EventsType, eventCenter, Events, hydrate, nextTick, options, incrementId, Instance, VueAppInstance, VueInstance, PageProps, ReactPageComponent, ReactPageInstance, ReactAppInstance, PageLifeCycle, PageInstance, AppInstance, Attributes, EventOptions, MpEvent, EventListenerOptions, AddEventListenerOptions, EventHandler, MpInstance, MiniElementData, MiniData, HydratedData, UpdatePayloadValue, DataTree, UpdatePayload, Options$0 as Options, Func, Ctx };