@tarojs/runtime 3.5.0-theta.1 → 3.5.0

package/dist/dsl/instance.d.ts

@@ -0,0 +1,85 @@
+import type { Component as Vue3Component } from '@vue/runtime-core';
+import type { Component, ComponentClass } from 'react';
+import VueCtor, { ComponentOptions, VNode } from 'vue';
+import type { CombinedVueInstance } from 'vue/types/vue';
+import type { TaroElement } from '../dom/element';
+import type { Func, MpEvent } from '../interface';
+export interface Instance<T = Record<string, any>> extends Component<T>, Show, PageInstance {
+    tid?: string;
+    $forceUpdate?(): void;
+    $nextTick?(cb: () => void): void;
+    $options: Instance;
+}
+export interface VueAppInstance extends ComponentOptions<VueCtor> {
+    $options: AppInstance;
+}
+export declare 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;
+}
+export interface PageProps {
+    tid?: string;
+}
+export interface ReactPageComponent<T = PageProps> extends ComponentClass<T>, PageInstance {
+}
+export interface ReactPageInstance<T = PageProps> extends Component<T>, PageInstance {
+    componentDidShow?(): void;
+    componentDidHide?(): void;
+}
+export interface ReactAppInstance<T = AppInstance> extends Component<T>, AppInstance {
+}
+export interface PageLifeCycle extends Show {
+    eh?(event: MpEvent): void;
+    onAddToFavorites?(): void;
+    onLoad?(options: Record<string, unknown>, cb?: Func): void;
+    onOptionMenuClick?(): void;
+    onPageScroll?(obj: {
+        scrollTop: number;
+    }): void;
+    onPullDownRefresh?(): void;
+    onPullIntercept?(): void;
+    onPopMenuClick?(): void;
+    onReachBottom?(): void;
+    onReady?(): void;
+    onResize?(options: unknown): void;
+    onSaveExitState?(): void;
+    onShareAppMessage?(obj: {
+        from: string;
+        target?: TaroElement;
+        webViewUrl: string;
+    }): void;
+    onShareTimeline?(): void;
+    onTabItemTap?(obj: {
+        index: string;
+        pagePath: string;
+        text: string;
+    }): void;
+    onTitleClick?(): void;
+    onUnload?(): void;
+}
+export interface PageInstance extends PageLifeCycle {
+    /** 页面的初始数据 */
+    data?: Record<string, unknown>;
+    /** 页面路径 */
+    path?: string;
+    /** 页面的组件选项 */
+    options?: Record<string, unknown>;
+}
+interface Show {
+    componentDidShow?(): void;
+    componentDidHide?(): void;
+    onShow?(): void;
+    onHide?(): void;
+}
+export interface AppInstance extends Show {
+    componentDidShow?(options?: Record<string, unknown>): void;
+    mount?(component: React.ComponentClass | ComponentOptions<VueCtor> | Vue3Component, id: string, cb: (...args: any[]) => void): void;
+    onError?(error: string): void;
+    onLaunch?(options?: Record<string, unknown>): void;
+    onPageNotFound?(res: any): void;
+    onShow?(options?: Record<string, unknown>): void;
+    unmount?(id: string, cb?: () => void): void;
+    taroGlobalData?: Record<any, any>;
+}
+export {};

package/dist/emitter/emitter.d.ts

@@ -0,0 +1,4 @@
+import { Events } from '@tarojs/shared';
+declare const eventCenter: Events;
+export declare type EventsType = typeof Events;
+export { eventCenter, Events };

package/dist/env.d.ts

@@ -0,0 +1,7 @@
+import type { TaroDocument } from './dom/document';
+interface Env {
+    window: any;
+    document: TaroDocument;
+}
+declare const env: Env;
+export default env;

package/dist/hydrate.d.ts

@@ -0,0 +1,10 @@
+import type { TaroElement } from './dom/element';
+import type { TaroText } from './dom/text';
+import type { MiniData } from './interface';
+/**
+ * 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.
+ */
+export declare function hydrate(node: TaroElement | TaroText): MiniData;

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import './dom-external';
+export { hooks } from '@tarojs/shared';
+export { document } from './bom/document';
+export { getComputedStyle } from './bom/getComputedStyle';
+export { nav as navigator } from './bom/navigator';
+export { caf as cancelAnimationFrame, now, raf as requestAnimationFrame } from './bom/raf';
+export { window } from './bom/window';
+export { TaroElement } from './dom/element';
+export { createEvent, eventHandler, TaroEvent } from './dom/event';
+export { FormElement } from './dom/form';
+export { TaroNode } from './dom/node';
+export { TaroRootElement } from './dom/root';
+export { Style } from './dom/style';
+export { SVGElement } from './dom/svg';
+export { TaroText } from './dom/text';
+export { MutationObserver } from './dom-external/mutation-observer';
+export { Current, getCurrentInstance } from './current';
+export { eventSource } from './dom/event-source';
+export { addLeadingSlash, createComponentConfig, createPageConfig, createRecursiveComponentConfig, getPageInstance, injectPageInstance, safeExecute, stringify } from './dsl/common';
+export * from './emitter/emitter';
+export { hydrate } from './hydrate';
+export { nextTick } from './next-tick';
+export { options } from './options';
+export { incrementId } from './utils';
+export * from './dsl/instance';
+export * from './interface';

package/dist/interface/element.d.ts

@@ -0,0 +1,4 @@
+export interface Attributes {
+    name: string;
+    value: string;
+}

package/dist/interface/event-target.d.ts

@@ -0,0 +1,10 @@
+export interface EventListenerOptions {
+    capture?: boolean;
+}
+export interface AddEventListenerOptions extends EventListenerOptions {
+    once?: boolean;
+    passive?: boolean;
+}
+export interface EventHandler extends Function {
+    _stop?: boolean;
+}

package/dist/interface/event.d.ts

@@ -0,0 +1,15 @@
+export interface EventOptions {
+    bubbles: boolean;
+    cancelable: boolean;
+}
+declare type Target = Record<string, unknown> & {
+    dataset: Record<string, unknown>;
+    id: string;
+};
+export interface MpEvent {
+    type: string;
+    detail: Record<string, unknown>;
+    target: Target;
+    currentTarget: Target;
+}
+export {};

package/dist/interface/hydrate.d.ts

@@ -0,0 +1,30 @@
+import type { Shortcuts } from '@tarojs/shared';
+import type { PageConfig } from '@tarojs/taro';
+export 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;
+}
+export 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;
+}
+export declare type MiniData = MiniElementData | MiniTextData;
+export declare type HydratedData = () => MiniData | MiniData[];
+export {};

package/dist/interface/index.d.ts

@@ -0,0 +1,7 @@
+export * from './element';
+export * from './event';
+export * from './event-target';
+export * from './hydrate';
+export * from './node';
+export * from './options';
+export * from './utils';

package/dist/interface/node.d.ts

@@ -0,0 +1,7 @@
+import { HydratedData } from './index';
+export declare type UpdatePayloadValue = string | boolean | HydratedData;
+export declare type DataTree = Record<string, UpdatePayloadValue | ReturnType<HydratedData>>;
+export interface UpdatePayload {
+    path: string;
+    value: UpdatePayloadValue;
+}

package/dist/interface/options.d.ts

@@ -0,0 +1,16 @@
+import type { TaroElement } from '../dom/element';
+import type { TaroText } from '../dom/text';
+import type { Element, Text } from '../dom-external/inner-html/parser';
+export 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;
+}

package/dist/interface/utils.d.ts

@@ -0,0 +1,2 @@
+export declare type Func = (...args: any[]) => any;
+export declare type Ctx = Record<string, any>;

package/dist/next-tick.d.ts

@@ -0,0 +1,2 @@
+import type { Func } from './interface';
+export declare const nextTick: (cb: Func, ctx?: Record<string, any>) => void;

package/dist/options.d.ts

@@ -0,0 +1,2 @@
+import type { Options } from './interface';
+export declare const options: Options;

package/dist/perf.d.ts

@@ -0,0 +1,7 @@
+declare class Performance {
+    private recorder;
+    start(id: string): void;
+    stop(id: string): void;
+}
+export declare const perf: Performance;
+export {};

package/dist/runtime.esm.d.ts

@@ -69,6 +69,8 @@ interface UpdatePayload {
 }
 // Taro 事件对象。以 Web 标准的事件对象为基础，加入小程序事件对象中携带的部分信息，并模拟实现事件冒泡。
 declare class TaroEvent {
+    private cacheTarget;
+    private cacheCurrentTarget;
     type: string;
     bubbles: boolean;
     cancelable: boolean;
@@ -316,13 +318,13 @@ declare class TaroElement extends TaroNode {
     static extend(methodName: string, options: Func | Record<string, any>): void;
 }
 declare function getComputedStyle(element: TaroElement): Style;
-declare const navigator: any;
+declare const nav: 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 const _raf: typeof requestAnimationFrame | ((callback: any) => NodeJS.Timeout);
+declare const _caf: typeof cancelAnimationFrame;
 declare let window: any;
 // for Vue3
 declare class SVGElement extends TaroElement {
@@ -411,7 +413,7 @@ declare class MutationObserver {
     takeRecords(): MutationRecord[];
     static record(record: MutationRecord): void;
 }
-interface Instance<T = Record<string, any>> extends Component<T>, Show, PageInstance {
+interface Instance<T> extends Component<T>, Show, PageInstance {
     tid?: string;
     $forceUpdate?(): void;
     $nextTick?(cb: () => void): void;
@@ -420,7 +422,7 @@ interface Instance<T = Record<string, any>> extends Component<T>, Show, PageInst
 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;
+type VueInstance<M, P> = CombinedVueInstance<VueCtor, Record<string, any>, M, P, Record<never, any>> & VueInternal;
 interface VueInternal {
     _render(): VNode;
     _update(vnode: VNode, hyrate: boolean): void;
@@ -428,41 +430,41 @@ interface VueInternal {
 interface PageProps {
     tid?: string;
 }
-interface ReactPageComponent<T = PageProps> extends ComponentClass<T>, PageInstance {
+interface ReactPageComponent<T> extends ComponentClass<T>, PageInstance {
 }
-interface ReactPageInstance<T = PageProps> extends Component<T>, PageInstance {
+interface ReactPageInstance<T> extends Component<T>, PageInstance {
     componentDidShow?(): void;
     componentDidHide?(): void;
 }
-interface ReactAppInstance<T = AppInstance> extends Component<T>, AppInstance {
+interface ReactAppInstance<T> extends Component<T>, AppInstance {
 }
 interface PageLifeCycle extends Show {
-    onPullDownRefresh?(): void;
-    onReachBottom?(): void;
+    eh?(event: MpEvent): void;
+    onAddToFavorites?(): void;
+    onLoad?(options: Record<string, unknown>, cb?: Func): void;
+    onOptionMenuClick?(): void;
     onPageScroll?(obj: {
         scrollTop: number;
     }): void;
+    onPullDownRefresh?(): void;
+    onPullIntercept?(): void;
+    onPopMenuClick?(): void;
+    onReachBottom?(): void;
+    onReady?(): void;
+    onResize?(options: unknown): void;
+    onSaveExitState?(): void;
     onShareAppMessage?(obj: {
         from: string;
         target?: TaroElement;
         webViewUrl: string;
     }): void;
-    onResize?(options: unknown): void;
+    onShareTimeline?(): 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 {
@@ -480,15 +482,13 @@ interface Show {
     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;
+    mount?(component: React.ComponentClass | ComponentOptions<VueCtor> | Vue3Component, id: string, cb: (...args: any[]) => void): void;
     onError?(error: string): void;
+    onLaunch?(options?: Record<string, unknown>): void;
     onPageNotFound?(res: any): void;
+    onShow?(options?: Record<string, unknown>): void;
+    unmount?(id: string, cb?: () => void): void;
     taroGlobalData?: Record<any, any>;
 }
 interface Router {
@@ -530,8 +530,8 @@ type EventsType = typeof Events;
  * 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 nextTick: (cb: Func, ctx?: Record<string, any>) => 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 };
+export { document, getComputedStyle, nav as 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 };