@tarojs/runtime 3.7.0-canary.6 → 3.8.0-canary.1

package/dist/{runtime.cjs.d.ts → index.cjs.d.ts}

@@ -1,5 +1,4 @@
 import { Shortcuts, Events } from "@tarojs/shared";
-import { PageConfig } from "@tarojs/taro";
 import VueCtor from "vue";
 import { ComponentOptions, VNode } from "vue";
 import { Component as Vue3Component } from "@vue/runtime-core";
@@ -45,9 +44,13 @@ interface AddEventListenerOptions extends EventListenerOptions {
     once?: boolean;
     passive?: boolean;
 }
+// eslint-disable-next-line @typescript-eslint/ban-types
 interface EventHandler extends Function {
     _stop?: boolean;
 }
+// Note: @tarojs/runtime 不依赖 @tarojs/taro, 所以不能改为从 @tarojs/taro 引入 (可能导致循环依赖)
+type TFunc = (...args: any[]) => any;
+type PageConfig = Record<string, any>;
 interface MpInstance {
     config: PageConfig;
     setData: (data: unknown, cb: () => void) => void;
@@ -134,8 +137,6 @@ interface Options {
     };
     miniGlobal?: any;
 }
-type Func = (...args: any[]) => any;
-type Ctx = Record<string, any>;
 declare class TaroEventTarget {
     __handlers: Record<string, EventHandler[]>;
     addEventListener(type: string, handler: EventHandler, options?: boolean | AddEventListenerOptions): void;
@@ -151,8 +152,8 @@ declare class TaroRootElement extends TaroElement {
     get _path(): string;
     get _root(): TaroRootElement;
     enqueueUpdate(payload: UpdatePayload): void;
-    performUpdate(initRender?: boolean, prerender?: Func): void;
-    enqueueUpdateCallback(cb: Func, ctx?: Record<string, any>): void;
+    performUpdate(initRender?: boolean, prerender?: TFunc): void;
+    enqueueUpdateCallback(cb: TFunc, ctx?: Record<string, any>): void;
     flushUpdateCallback(): void;
 }
 interface RemoveChildOptions {
@@ -223,7 +224,7 @@ declare class TaroNode extends TaroEventTarget {
     hasChildNodes(): boolean;
     enqueueUpdate(payload: UpdatePayload): void;
     get ownerDocument(): TaroDocument;
-    static extend(methodName: string, options: Func | Record<string, any>): void;
+    static extend(methodName: string, options: TFunc | Record<string, any>): void;
 }
 declare class Style {
     _pending: boolean;
@@ -297,7 +298,7 @@ declare class TaroElement extends TaroNode {
     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;
+    static extend(methodName: string, options: TFunc | Record<string, any>): void;
 }
 declare class FormElement extends TaroElement {
     get type(): string;
@@ -311,6 +312,7 @@ declare class TaroDocument extends TaroElement {
     head: TaroElement;
     body: TaroElement;
     createEvent: typeof createEvent;
+    cookie?: string;
     constructor();
     createElement(type: string): TaroElement | TaroRootElement | FormElement;
     // an ugly fake createElementNS to deal with @vue/runtime-dom's
@@ -329,8 +331,9 @@ interface Env {
     document: TaroDocument;
 }
 declare const env: Env;
-declare let document: any;
-declare function getComputedStyle(element: TaroElement): Style;
+declare const document: TaroDocument;
+type TGetComputedStyle = typeof window.getComputedStyle | ((el: TaroElement) => Style);
+declare const getComputedStyle: TGetComputedStyle;
 declare const eventCenter: Events;
 type EventsType = typeof Events;
 /**
@@ -345,75 +348,60 @@ declare class RuntimeCache<T> {
     get(identifier: string): T | undefined;
     delete(identifier: string): void;
 }
-declare namespace LocationType {
-    const eventCenter: Events;
-    type EventsType = typeof Events;
-    /**
-     * 一个小型缓存池，用于在切换页面时，存储一些上下文信息
-     */
-    class RuntimeCache<T> {
-        name: string;
-        cache: Map<string, T>;
-        constructor(name: string);
-        has(identifier: string): boolean;
-        set(identifier: string, ctx: T): void;
-        get(identifier: string): T | undefined;
-        delete(identifier: string): void;
-    }
-    type Options = {
-        window: any;
-    };
-    type LocationContext = {
-        lastHref: string;
-    };
-    class Location extends Events {
-        #private;
-        constructor(options: Options);
-        /* public property */
-        get protocol(): string;
-        set protocol(val: string);
-        get host(): string;
-        set host(val: string);
-        get hostname(): string;
-        set hostname(val: string);
-        get port(): string;
-        set port(val: string);
-        get pathname(): string;
-        set pathname(val: string);
-        get search(): string;
-        set search(val: string);
-        get hash(): string;
-        // 小程序的navigateTo存在截断hash字符串的问题
-        set hash(val: string);
-        get href(): string;
-        set href(val: string);
-        get origin(): string;
-        set origin(val: string);
-        /* public method */
-        assign(): void;
-        reload(): void;
-        replace(url: string): void;
-        toString(): string;
-        // For debug
-        get cache(): RuntimeCache<LocationContext>;
-    }
+type Options$0 = {
+    window: any;
+};
+type LocationContext = {
+    lastHref: string;
+};
+declare class TaroLocation extends Events {
+    #private;
+    constructor(options: Options$0);
+    /* public property */
+    get protocol(): string;
+    set protocol(val: string);
+    get host(): string;
+    set host(val: string);
+    get hostname(): string;
+    set hostname(val: string);
+    get port(): string;
+    set port(val: string);
+    get pathname(): string;
+    set pathname(val: string);
+    get search(): string;
+    set search(val: string);
+    get hash(): string;
+    // 小程序的navigateTo存在截断hash字符串的问题
+    set hash(val: string);
+    get href(): string;
+    set href(val: string);
+    get origin(): string;
+    set origin(val: string);
+    /* public method */
+    assign(): void;
+    reload(): void;
+    replace(url: string): void;
+    toString(): string;
+    // For debug
+    get cache(): RuntimeCache<LocationContext>;
 }
+declare const Location: typeof TaroLocation;
 interface HistoryState {
     state: Record<string, any> | null;
     title: string;
     url: string;
 }
-type Options$0 = {
+type Options$1 = {
     window: any;
 };
 type HistoryContext = {
-    location: LocationType.Location;
+    location: TaroLocation;
     stack: HistoryState[];
     cur: number;
 };
-declare class History extends Events {
+declare class TaroHistory extends Events {
     #private;
-    constructor(location: LocationType.Location, options: Options$0);
+    constructor(location: TaroLocation, options: Options$1);
     /* public property */
     get length(): number;
     get state(): Record<string, any> | null;
@@ -426,28 +414,15 @@ declare class History extends Events {
     // For debug
     get cache(): RuntimeCache<HistoryContext>;
 }
-declare const nav: any;
+declare const History: typeof TaroHistory;
+declare const nav: typeof window.navigator;
 // 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 class URLSearchParams {
-    #private;
-    constructor(query: any);
-    append(name: string, value: string): void;
-    delete(name: string): void;
-    get(name: string): any;
-    getAll(name: string): any;
-    has(name: string): boolean;
-    keys(): string[];
-    set(name: string, value: string): void;
-    forEach(callback: any, thisArg: any): void;
-    toJSON(): {};
-    toString(): string;
-}
-declare class URL {
+declare class TaroURL {
     #private;
     static createObjectURL(): void;
     static revokeObjectURL(): void;
@@ -488,6 +463,7 @@ declare class URL {
         href: string;
     };
 }
+declare const URL: typeof TaroURL;
 declare function parseUrl(url?: string): {
     href: string;
     origin: string;
@@ -499,9 +475,27 @@ declare function parseUrl(url?: string): {
     search: string;
     hash: string;
 };
-declare let window: any;
-declare const location: any;
-declare const history: any;
+declare const URLSearchParams: any;
+declare class TaroWindow extends Events {
+    navigator: Navigator;
+    requestAnimationFrame: typeof requestAnimationFrame | ((callback: any) => NodeJS.Timeout);
+    cancelAnimationFrame: typeof cancelAnimationFrame;
+    getComputedStyle: TGetComputedStyle;
+    Date: DateConstructor;
+    location: TaroLocation;
+    history: TaroHistory;
+    XMLHttpRequest?: Partial<XMLHttpRequest>;
+    constructor();
+    initEvent(): void;
+    get document(): TaroDocument;
+    addEventListener(event: string, callback: (arg: any) => void): void;
+    removeEventListener(event: string, callback: (arg: any) => void): void;
+    setTimeout(...args: Parameters<typeof setTimeout>): NodeJS.Timeout;
+    clearTimeout(...args: Parameters<typeof clearTimeout>): void;
+}
+declare const window: TaroWindow;
+declare const location: TaroLocation;
+declare const history: TaroHistory;
 // for Vue3
 declare class SVGElement extends TaroElement {
 }
@@ -626,6 +620,7 @@ declare const KEY_CODE = "keyCode";
 declare const TOUCHMOVE = "touchmove";
 declare const DATE = "Date";
 declare const SET_TIMEOUT = "setTimeout";
+declare const COMPILE_MODE = "compileMode";
 declare const CATCHMOVE = "catchMove";
 declare const CATCH_VIEW = "catch-view";
 declare const COMMENT = "comment";
@@ -676,7 +671,7 @@ interface ReactAppInstance<T = AppInstance> extends Component<T>, AppInstance {
 interface PageLifeCycle extends Show {
     eh?(event: MpEvent): void;
     onAddToFavorites?(): void;
-    onLoad?(options: Record<string, unknown>, cb?: Func): void;
+    onLoad?(options: Record<string, unknown>, cb?: TFunc): void;
     onOptionMenuClick?(): void;
     onPageScroll?(obj: {
         scrollTop: number;
@@ -711,6 +706,8 @@ interface PageInstance extends PageLifeCycle {
     options?: Record<string, unknown>;
     /** 页面渲染引擎类型 */
     renderer?: "webview" | "skyline";
+    /** 获得一个 EventChannel 对象，用于页面间通讯 */
+    getOpenerEventChannel?(): Record<string, any>;
 }
 interface Show {
     componentDidShow?(): void;
@@ -727,6 +724,7 @@ interface AppInstance extends Show {
     onPageNotFound?(res: any): void;
     onUnhandledRejection?(error: any): void;
     onShow?(options?: Record<string, unknown>): void;
+    onHide?(options?: Record<string, unknown>): void;
     unmount?(id: string, cb?: () => void): void;
     taroGlobalData?: Record<any, any>;
     config?: Record<any, any>;
@@ -756,7 +754,6 @@ declare const eventSource: IEventSource;
 declare function injectPageInstance(inst: Instance<PageProps>, id: string): void;
 declare function getPageInstance(id: string): Instance | undefined;
 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;
@@ -773,9 +770,19 @@ declare function createRecursiveComponentConfig(componentName?: string): any;
  * 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>) => void;
+declare const nextTick: (cb: TFunc, ctx?: Record<string, any>) => void;
 declare const options: Options;
 declare const incrementId: () => () => string;
 declare function isHasExtractProp(el: TaroElement): boolean;
+// export const removeLeadingSlash = (str = '') => str.replace(/^\.?\//, '')
+// export const removeTrailingSearch = (str = '') => str.replace(/\?[\s\S]*$/, '')
+declare const addLeadingSlash: (url?: string) => string;
+declare const hasBasename: (path?: string, prefix?: string) => boolean;
+declare const stripBasename: (path?: string, prefix?: string) => string;
+declare const stripTrailing: (str?: string) => string;
+declare const stripSuffix: (path?: string, suffix?: string) => string;
+declare const getHomePage: (path?: string, basename?: string, customRoutes?: Record<string, string | string[]>, entryPagePath?: string) => string;
+declare const getCurrentPage: (routerMode?: string, basename?: string) => string;
+declare function handlePolyfill(): void;
 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, 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, isHasExtractProp, 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, COMPILE_MODE, 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, createComponentConfig, createPageConfig, createRecursiveComponentConfig, getOnHideEventKey, getOnReadyEventKey, getOnShowEventKey, getPageInstance, getPath, injectPageInstance, removePageInstance, safeExecute, stringify, EventsType, eventCenter, Events, hydrate, nextTick, options, incrementId, isHasExtractProp, addLeadingSlash, hasBasename, stripBasename, stripTrailing, stripSuffix, getHomePage, getCurrentPage, Instance, VueAppInstance, VueInstance, PageProps, ReactPageComponent, ReactPageInstance, ReactAppInstance, PageLifeCycle, PageInstance, AppInstance, Attributes, EventOptions, MpEvent, EventListenerOptions, AddEventListenerOptions, EventHandler, MpInstance, MiniElementData, MiniTextData, MiniData, HydratedData, UpdatePayloadValue, DataTree, UpdatePayload, Options$1 as Options, TFunc, PageConfig, handlePolyfill };