@tarojs/runtime 3.5.0-beta.4 → 3.5.0-theta.0

package/dist/runtime.esm.d.ts

@@ -0,0 +1,537 @@
+import { Shortcuts, Events } from "@tarojs/shared";
+import { PageConfig } from "@tarojs/taro";
+import { Component as Vue3Component } from "@vue/runtime-core";
+import { Component, ComponentClass } from "react";
+import VueCtor from "vue";
+import { ComponentOptions, VNode } from "vue";
+import { CombinedVueInstance } from "vue/types/vue";
+declare let document: any;
+interface Attributes {
+    name: string;
+    value: string;
+}
+interface EventOptions {
+    bubbles: boolean;
+    cancelable: boolean;
+}
+type Target = Record<string, unknown> & {
+    dataset: Record<string, unknown>;
+    id: string;
+};
+interface MpEvent {
+    type: string;
+    detail: Record<string, unknown>;
+    target: Target;
+    currentTarget: Target;
+}
+interface EventListenerOptions {
+    capture?: boolean;
+}
+interface AddEventListenerOptions extends EventListenerOptions {
+    once?: boolean;
+    passive?: boolean;
+}
+interface EventHandler extends Function {
+    _stop?: boolean;
+}
+interface MpInstance {
+    config: PageConfig;
+    setData: (data: unknown, cb: () => void) => void;
+    route?: string;
+    __route__: string;
+    $taroParams?: Record<string, unknown>;
+    $taroPath: string;
+    __data__: any;
+    data: any;
+    exitState?: any;
+    selectComponent: (selector: string) => any;
+}
+interface MiniElementData {
+    [Shortcuts.Childnodes]?: MiniData[];
+    [Shortcuts.NodeName]: string;
+    [Shortcuts.Class]?: string;
+    [Shortcuts.Style]?: string;
+    uid?: string;
+    sid: string;
+    [key: string]: unknown;
+}
+interface MiniTextData {
+    [Shortcuts.Text]: string;
+    [Shortcuts.NodeName]: string;
+}
+type MiniData = MiniElementData | MiniTextData;
+type HydratedData = () => MiniData | MiniData[];
+type UpdatePayloadValue = string | boolean | HydratedData;
+type DataTree = Record<string, UpdatePayloadValue | ReturnType<HydratedData>>;
+interface UpdatePayload {
+    path: string;
+    value: UpdatePayloadValue;
+}
+// Taro 事件对象。以 Web 标准的事件对象为基础，加入小程序事件对象中携带的部分信息，并模拟实现事件冒泡。
+declare class TaroEvent {
+    type: string;
+    bubbles: boolean;
+    cancelable: boolean;
+    _stop: boolean;
+    _end: boolean;
+    defaultPrevented: boolean;
+    // 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): void;
+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;
+}
+declare class TaroEventTarget {
+    __handlers: Record<string, EventHandler[]>;
+    addEventListener(type: string, handler: EventHandler, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener(type: string, handler: EventHandler): void;
+    isAnyEventBinded(): boolean;
+}
+declare const enum NodeType {
+    ELEMENT_NODE = 1,
+    ATTRIBUTE_NODE = 2,
+    TEXT_NODE = 3,
+    CDATA_SECTION_NODE = 4,
+    ENTITY_REFERENCE_NODE = 5,
+    COMMENT_NODE = 6,
+    PROCESSING_INSTRUCTION_NODE = 7,
+    DOCUMENT_NODE = 9
+}
+interface RemoveChildOptions {
+    cleanRef?: boolean;
+    doUpdate?: boolean;
+}
+declare class TaroNode extends TaroEventTarget {
+    uid: string;
+    sid: string;
+    nodeType: NodeType;
+    nodeName: string;
+    parentNode: TaroNode | null;
+    childNodes: TaroNode[];
+    constructor();
+    private hydrate;
+    private updateChildNodes;
+    get _root(): TaroRootElement | null;
+    protected findIndex(refChild: TaroNode): number;
+    get _path(): string;
+    get nextSibling(): TaroNode | null;
+    get previousSibling(): TaroNode | null;
+    get parentElement(): TaroElement | null;
+    get firstChild(): TaroNode | null;
+    get lastChild(): TaroNode | null;
+    /**
+     * @textContent 目前只能置空子元素
+     * @TODO 等待完整 innerHTML 实现
+     */
+    // eslint-disable-next-line accessor-pairs
+    set textContent(text: string);
+    /**
+     * @doc https://developer.mozilla.org/zh-CN/docs/Web/API/Node/insertBefore
+     * @scenario
+     * [A,B,C]
+     *   1. insert D before C, D has no parent
+     *   2. insert D before C, D has the same parent of C
+     *   3. insert D before C, D has the different parent of C
+     */
+    insertBefore<T extends TaroNode>(newChild: T, refChild?: TaroNode | null, isReplace?: boolean): T;
+    /**
+     * @doc https://developer.mozilla.org/zh-CN/docs/Web/API/Node/appendChild
+     * @scenario
+     * [A,B,C]
+     *   1. append C, C has no parent
+     *   2. append C, C has the same parent of B
+     *   3. append C, C has the different parent of B
+     */
+    appendChild(newChild: TaroNode): TaroNode;
+    /**
+     * @doc https://developer.mozilla.org/zh-CN/docs/Web/API/Node/replaceChild
+     * @scenario
+     * [A,B,C]
+     *   1. replace B with C, C has no parent
+     *   2. replace B with C, C has no parent, C has the same parent of B
+     *   3. replace B with C, C has no parent, C has the different parent of B
+     */
+    replaceChild(newChild: TaroNode, oldChild: TaroNode): TaroNode | undefined;
+    /**
+     * @doc https://developer.mozilla.org/zh-CN/docs/Web/API/Node/removeChild
+     * @scenario
+     * [A,B,C]
+     *   1. remove A or B
+     *   2. remove C
+     */
+    removeChild<T extends TaroNode>(child: T, options?: RemoveChildOptions): T;
+    remove(options?: RemoveChildOptions): void;
+    hasChildNodes(): boolean;
+    enqueueUpdate(payload: UpdatePayload): void;
+    get ownerDocument(): TaroDocument;
+    static extend(methodName: string, options: Func | Record<string, any>): void;
+}
+declare class TaroText extends TaroNode {
+    _value: string;
+    nodeType: NodeType;
+    nodeName: string;
+    constructor(value: any);
+    set textContent(text: string);
+    get textContent(): string;
+    set nodeValue(text: string);
+    get nodeValue(): string;
+    set data(text: string);
+    get data(): string;
+}
+interface Node {
+    type: string;
+}
+interface Comment extends Node {
+    type: "comment";
+    content: string;
+}
+interface Text extends Node {
+    type: "text";
+    content: string;
+}
+interface Element extends Node {
+    type: "element";
+    tagName: string;
+    children: ChildNode[];
+    attributes: string[];
+}
+type ChildNode = Comment | Text | Element;
+interface Options {
+    prerender: boolean;
+    debug: boolean;
+    html?: {
+        skipElements: Set<string>;
+        voidElements: Set<string>;
+        closingElements: Set<string>;
+        transformText?: (taroText: TaroText, text: Text) => TaroText;
+        transformElement?: (taroElement: TaroElement, element: Element) => TaroElement;
+        renderHTMLTag: boolean;
+    };
+    miniGlobal?: any;
+}
+type Func = (...args: any[]) => any;
+type Ctx = Record<string, any>;
+declare class ClassList extends Set<string> {
+    private el;
+    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;
+    toString(): string;
+    private _update;
+}
+declare class Style {
+    _pending: boolean;
+    _usedStyleProp: Set<string>;
+    _value: Partial<CSSStyleDeclaration>;
+    _element: TaroElement;
+    constructor(element: TaroElement);
+    private setCssVariables;
+    get cssText(): string;
+    set cssText(str: string);
+    setProperty(propertyName: string, value?: string | null): void;
+    removeProperty(propertyName: string): string;
+    getPropertyValue(propertyName: string): any;
+}
+declare class TaroElement extends TaroNode {
+    tagName: string;
+    props: Record<string, any>;
+    style: Style;
+    dataset: Record<string, unknown>;
+    innerHTML: string;
+    constructor();
+    private _stopPropagation;
+    get id(): string;
+    set id(val: string);
+    get className(): string;
+    set className(val: string);
+    get cssText(): string;
+    get classList(): ClassList;
+    get children(): TaroElement[];
+    get attributes(): Attributes[];
+    get textContent(): string;
+    set textContent(text: string);
+    hasAttribute(qualifiedName: string): boolean;
+    hasAttributes(): boolean;
+    get focus(): () => void;
+    // 兼容 Vue3，详情请见：https://github.com/NervJS/taro/issues/10579
+    set focus(value: () => void);
+    blur(): void;
+    setAttribute(qualifiedName: string, value: any): void;
+    removeAttribute(qualifiedName: string): void;
+    getAttribute(qualifiedName: string): string;
+    getElementsByTagName(tagName: string): TaroElement[];
+    getElementsByClassName(className: string): TaroElement[];
+    dispatchEvent(event: TaroEvent): boolean;
+    addEventListener(type: any, handler: any, options: any): void;
+    removeEventListener(type: any, handler: any, sideEffect?: boolean): void;
+    static extend(methodName: string, options: Func | Record<string, any>): void;
+}
+declare function getComputedStyle(element: TaroElement): Style;
+declare const navigator: any;
+// https://github.com/myrne/performance-now
+declare let now: () => number;
+// https://gist.github.com/paulirish/1579671
+// https://gist.github.com/jalbam/5fe05443270fa6d8136238ec72accbc0
+declare const raf: typeof requestAnimationFrame | ((callback: any) => NodeJS.Timeout);
+declare const caf: typeof cancelAnimationFrame;
+declare let window: any;
+// for Vue3
+declare class SVGElement extends TaroElement {
+}
+/**
+ * A MutationRecord represents an individual DOM mutation.
+ * It is the object that is passed to MutationObserver's callback.
+ * @see https://dom.spec.whatwg.org/#interface-mutationrecord
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MutationRecord
+ */
+interface MutationRecord {
+    readonly target: TaroNode;
+    readonly addedNodes?: TaroNode[];
+    readonly removedNodes?: TaroNode[];
+    readonly previousSibling?: TaroNode | null;
+    readonly nextSibling?: TaroNode | null;
+    readonly attributeName?: string | null;
+    readonly attributeNamespace?: string | null;
+    oldValue?: string | null;
+    // extended
+    readonly type: MutationRecordType;
+    readonly value?: string | null;
+}
+declare const enum MutationRecordType {
+    ATTRIBUTES = "attributes",
+    CHARACTER_DATA = "characterData",
+    CHILD_LIST = "childList"
+}
+type MutationCallback = (mutations: MutationRecord[]) => any;
+/**
+ * @see https://dom.spec.whatwg.org/#dictdef-mutationobserverinit
+ */
+interface MutationObserverInit {
+    attributeFilter?: string[];
+    attributeOldValue?: boolean;
+    attributes?: boolean;
+    characterData?: boolean;
+    characterDataOldValue?: boolean;
+    childList?: boolean;
+    subtree?: boolean;
+}
+/**
+ * The MutationObserver provides the ability
+ * to watch for changes being made to the DOM tree.
+ * It will invoke a specified callback function
+ * when DOM changes occur.
+ * @see https://dom.spec.whatwg.org/#mutationobserver
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver
+ */
+declare class MutationObserverImpl {
+    callback: MutationCallback;
+    target: TaroNode | null;
+    options: MutationObserverInit;
+    records: MutationRecord[];
+    constructor(callback: MutationCallback);
+    /**
+     * Configures the MutationObserver
+     * to begin receiving notifications
+     * through its callback function
+     * when DOM changes matching the given options occur.
+     *
+     * Options matching is to be implemented.
+     */
+    observe(target: TaroNode, options?: MutationObserverInit): void;
+    /**
+     * Stop the MutationObserver instance
+     * from receiving further notifications
+     * until and unless observe() is called again.
+     */
+    disconnect(): void;
+    /**
+     * Removes all pending notifications
+     * from the MutationObserver's notification queue
+     * and returns them in a new Array of MutationRecord objects.
+     */
+    takeRecords(): MutationRecord[];
+}
+declare class MutationObserver {
+    core: Pick<MutationObserverImpl, "observe" | "disconnect" | "takeRecords">;
+    constructor(callback: MutationCallback);
+    observe(...args: [
+        TaroNode,
+        MutationObserverInit?
+    ]): void;
+    disconnect(): void;
+    takeRecords(): MutationRecord[];
+    static record(record: MutationRecord): void;
+}
+interface Instance<T = Record<string, any>> extends Component<T>, Show, PageInstance {
+    tid?: string;
+    $forceUpdate?(): void;
+    $nextTick?(cb: () => void): void;
+    $options: Instance;
+}
+interface VueAppInstance extends ComponentOptions<VueCtor> {
+    $options: AppInstance;
+}
+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;
+}
+interface PageProps {
+    tid?: string;
+}
+interface ReactPageComponent<T = PageProps> extends ComponentClass<T>, PageInstance {
+}
+interface ReactPageInstance<T = PageProps> extends Component<T>, PageInstance {
+    componentDidShow?(): void;
+    componentDidHide?(): void;
+}
+interface ReactAppInstance<T = AppInstance> extends Component<T>, AppInstance {
+}
+interface PageLifeCycle extends Show {
+    onPullDownRefresh?(): void;
+    onReachBottom?(): void;
+    onPageScroll?(obj: {
+        scrollTop: number;
+    }): void;
+    onShareAppMessage?(obj: {
+        from: string;
+        target?: TaroElement;
+        webViewUrl: string;
+    }): void;
+    onResize?(options: unknown): void;
+    onTabItemTap?(obj: {
+        index: string;
+        pagePath: string;
+        text: string;
+    }): void;
+    onTitleClick?(): void;
+    onOptionMenuClick?(): void;
+    onPopMenuClick?(): void;
+    onReady?(): void;
+    onPullIntercept?(): void;
+    onShareTimeline?(): void;
+    onAddToFavorites?(): void;
+    onSaveExitState?(): void;
+    eh?(event: MpEvent): void;
+    onLoad?(options: Record<string, unknown>, cb?: Func): void;
+    onUnload?(): void;
+}
+interface PageInstance extends PageLifeCycle {
+    /** 页面的初始数据 */
+    data?: Record<string, unknown>;
+    /** 页面路径 */
+    path?: string;
+    /** 页面的组件选项 */
+    options?: Record<string, unknown>;
+}
+interface Show {
+    componentDidShow?(): void;
+    componentDidHide?(): void;
+    onShow?(): void;
+    onHide?(): void;
+}
+interface AppInstance extends Show {
+    onLaunch?(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, cb: () => void): void;
+    componentDidShow?(options?: Record<string, unknown>): void;
+    onShow?(options?: Record<string, unknown>): void;
+    unmount?(id: string): void;
+    unmount?(id: string, cb: () => void): void;
+    onError?(error: string): void;
+    onPageNotFound?(res: any): void;
+    taroGlobalData?: Record<any, any>;
+}
+interface Router {
+    params: Record<string, unknown>;
+    path: string;
+    $taroPath: string;
+    onReady: string;
+    onHide: string;
+    onShow: string;
+    exitState?: any;
+}
+interface Current {
+    app: AppInstance | null;
+    router: Router | null;
+    page: PageInstance | null;
+    preloadData?: any;
+}
+declare const Current: Current;
+declare const getCurrentInstance: () => Current;
+interface IEventSource extends Map<string | undefined | null, TaroNode> {
+    removeNode(child: TaroNode): void;
+    removeNodeTree(child: TaroNode): void;
+}
+declare const eventSource: IEventSource;
+declare function injectPageInstance(inst: Instance<PageProps>, id: string): void;
+declare function getPageInstance(id: string): Instance | undefined;
+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 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;
+declare const eventCenter: Events;
+type EventsType = typeof Events;
+/**
+ * React also has a fancy function's name for this: `hydrate()`.
+ * You may have been heard `hydrate` as a SSR-related function,
+ * actually, `hydrate` basicly do the `render()` thing, but ignore some properties,
+ * it's a vnode traverser and modifier: that's exactly what Taro's doing in here.
+ */
+declare function hydrate(node: TaroElement | TaroText): MiniData;
+declare const nextTick: (cb: Func, ctx?: Record<string, any> | undefined) => void;
+declare const options: Options;
+declare const incrementId: () => () => string;
+export { hooks } from '@tarojs/shared';
+export { document, getComputedStyle, navigator, caf as cancelAnimationFrame, now, raf as requestAnimationFrame, window, TaroElement, createEvent, eventHandler, TaroEvent, FormElement, TaroNode, TaroRootElement, Style, SVGElement, TaroText, MutationObserver, Current, getCurrentInstance, eventSource, addLeadingSlash, createComponentConfig, createPageConfig, createRecursiveComponentConfig, getPageInstance, injectPageInstance, 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, Func, Ctx };