@tarojs/taro 3.3.11 → 3.3.15

package/types/taro.component.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="react" />
 /// <reference types="vue" />
-/// <reference path="taro.lifecycle.d.ts" />
-/// <reference path="taro.config.d.ts" />
 
-declare namespace Taro {
+import Taro, { ComponentOptions, Config, RouterInfo } from './index'
+
+declare module './index' {
   // Components
   interface ComponentLifecycle<P, S, SS = any> extends NewLifecycle<P, S, SS> {
     componentWillMount?(): void
@@ -60,53 +60,6 @@ declare namespace Taro {
     $scope?: any
   }
 
-  class Component<P, S> {
-    constructor(props?: Readonly<P>)
-    /**
-     * @deprecated
-     * @see https://reactjs.org/docs/legacy-context.html
-     */
-    constructor(props?: P, context?: any)
-
-    config?: Config
-
-    options?: ComponentOptions
-
-    $componentType: 'PAGE' | 'COMPONENT'
-
-    $router: RouterInfo
-
-    $preloadData: any
-
-    /**
-     * 使用 `this.$preload` 函数进行页面跳转传参
-     * @example this.$preload('key', 'val');
-     * @example this.$preload({
-                  x: 1,
-                  y: 2
-                });
-     * @see https://nervjs.github.io/taro/docs/best-practice.html
-     */
-    $preload(key: string, value: any): void
-    $preload(key: object): void
-
-    setState<K extends keyof S>(
-      state: ((prevState: Readonly<S>, props: P) => Pick<S, K> | S) | (Pick<S, K> | S),
-      callback?: () => any
-    ): void
-
-    forceUpdate(callBack?: () => any): void
-
-    render(): React.ReactNode
-
-    readonly props: Readonly<P> & Readonly<{ children?: React.ReactNode }>
-    state: Readonly<S>
-    context: any
-    refs: {
-      [key: string]: any
-    }
-  }
-
   type PropsWithChildren<P> = P & { children?: React.ReactNode }
 
   interface FunctionComponent<P = {}> {
@@ -126,13 +79,6 @@ declare namespace Taro {
 
   type SFC = StatelessFunctionComponent
 
-  class PureComponent<P = {}, S = {}> extends Component<P, S> {}
-
-  function memo<P = {}>(
-    FunctionComponent: FunctionComponent<P>,
-    compare?: (oldProps: P, newProps: P) => Boolean
-  ): FunctionComponent<P>
-
   interface Show {
     componentDidShow?(options?: unknown): void
     componentDidHide?(options?: unknown): void
@@ -208,4 +154,11 @@ declare namespace Taro {
      **/
     clearAnimation?(selector: string, options: ClearAnimationOptions, callback: () => void): void
   }
+
+  interface TaroStatic {
+    memo<P = {}>(
+      FunctionComponent: FunctionComponent<P>,
+      compare?: (oldProps: P, newProps: P) => Boolean
+    ): FunctionComponent<P>
+  }
 }

package/types/taro.config.d.ts

@@ -1,8 +1,10 @@
-declare namespace Taro {
+import Taro from './index'
+
+declare module './index' {
   /**
    * 微信小程序全局 Window 配置和页面配置的公共项目
    */
-  interface CommonPageConfig {
+  interface CommonConfig {
     /**
      * 导航栏背景颜色，HexColor
      * default: #000000
@@ -55,7 +57,7 @@ declare namespace Taro {
     onReachBottomDistance?: number
   }
 
-  interface PageConfig extends CommonPageConfig {
+  interface PageConfig extends CommonConfig {
     /**
      * 设置为 true 则页面整体不能上下滚动；
      * 只在页面配置中有效，无法在 app.json 中设置该项
@@ -85,7 +87,7 @@ declare namespace Taro {
     enableShareTimeline?: boolean
   }
 
-  interface WindowConfig extends CommonPageConfig {
+  interface WindowConfig extends CommonConfig {
     /**
      * 屏幕旋转设置
      * 支持 auto / portrait / landscape
@@ -106,7 +108,7 @@ declare namespace Taro {
     allowsBounceVertical?: 'YES' | 'NO'
   }
 
-  interface TarbarList {
+  interface TabBarItem {
     /**
      * 页面路径，必须在 pages 中先定义
      */
@@ -155,7 +157,7 @@ declare namespace Taro {
      */
     custom?: boolean
 
-    list: TarbarList[]
+    list: TabBarItem[]
   }
 
   interface NetworkTimeout {
@@ -339,4 +341,20 @@ declare namespace Taro {
     cloud?: boolean
     pageOrientation?: 'auto' | 'portrait' | 'landscape'
   }
+
+  interface TaroStatic {
+    CommonConfig: CommonConfig
+    PageConfig: PageConfig
+    WindowConfig: WindowConfig
+    TarBarList: TabBarItem
+    TabBar: TabBar
+    NetworkTimeout: NetworkTimeout
+    SubPackage: SubPackage
+    Plugins: Plugins
+    PreloadRule: PreloadRule
+    Permission: Permission
+    AppConfig: AppConfig
+    Config: Config
+  }
 }
+

package/types/taro.extend.d.ts

@@ -1,60 +1,6 @@
-/// <reference types="react" />
-/// <reference path="taro.component.d.ts" />
-/// <reference path="api/network/request.d.ts" />
-
-declare namespace Taro {
-  // Events
-  class Events {
-    /**
-     * 监听一个事件，接受参数
-     */
-    on(eventName: string, listener: (...args: any[]) => void): this
-
-    /**
-     * 添加一个事件监听，并在事件触发完成之后移除Callbacks链
-     */
-    once(eventName: string, listener: (...args: any[]) => void): this
-
-    /**
-     * 取消监听一个事件
-     */
-    off(eventName: string, listener?: (...args: any[]) => void): this
-
-    /**
-     * 取消监听的所有事件
-     */
-    off(): this
-
-    /**
-     * 触发一个事件，传参
-     */
-    trigger(eventName: string, ...args: any[]): boolean
-  }
-
-  // eventCenter
-
-  const eventCenter: Events
-
-  // ENV_TYPE
-
-  enum ENV_TYPE {
-    WEAPP = 'WEAPP',
-    WEB = 'WEB',
-    RN = 'RN',
-    SWAN = 'SWAN',
-    ALIPAY = 'ALIPAY',
-    TT = 'TT',
-    QQ = 'QQ',
-    JD = 'JD'
-  }
-
-  function getEnv(): ENV_TYPE
-
-  function render(component: Component | JSX.Element, element: Element | null): any
-
-  function internal_safe_set(...arg: any[]): any
-  function internal_safe_get(...arg: any[]): any
+import Taro, { Component } from './index'
 
+declare module './index' {
   type MessageType = 'info' | 'success' | 'error' | 'warning'
 
   interface AtMessageOptions {
@@ -63,11 +9,6 @@ declare namespace Taro {
     duration?: number
   }
 
-  function atMessage(options: AtMessageOptions): void
-
-  function pxTransform(size: number, designWidth?: number): string
-  function initPxTransform(config: { designWidth: number; deviceRatio: object }): void
-
   interface RequestParams extends request.Option<any> {
     [propName: string]: any
   }
@@ -81,21 +22,12 @@ declare namespace Taro {
     proceed(requestParams: RequestParams): any
   }
 
-  namespace interceptors {
-    function logInterceptor(chain: Chain): Promise<any>
+  interface interceptors {
+    logInterceptor(chain: Chain): Promise<any>
 
-    function timeoutInterceptor(chain: Chain): Promise<any>
+    timeoutInterceptor(chain: Chain): Promise<any>
   }
 
-  function addInterceptor(interceptor: interceptor): any
-
-  /**
-   * 小程序引用插件 JS 接口
-   */
-  function requirePlugin(pluginName: string): any
-
-  function setIsUsingDiff (flag: boolean)
-
   interface Current {
     app: AppInstance | null
     router: RouterInfo | null
@@ -110,7 +42,33 @@ declare namespace Taro {
     rnNavigationRef?: React.RefObject<any>
   }
 
-  const Current: Current
+  interface TaroStatic {
+    // eventCenter
+    eventCenter: TaroGeneral.Events
+
+    getEnv(): TaroGeneral.ENV_TYPE
+
+    render(component: Component | JSX.Element, element: Element | null): any
 
-  function getCurrentInstance(): Current
+    internal_safe_set(...arg: any[]): any
+    internal_safe_get(...arg: any[]): any
+
+    atMessage(options: AtMessageOptions): void
+
+    pxTransform(size: number, designWidth?: number): string
+    initPxTransform(config: { designWidth: number; deviceRatio: object }): void
+
+    addInterceptor(interceptor: interceptor): any
+
+    /**
+     * 小程序引用插件 JS 接口
+     */
+    requirePlugin(pluginName: string): any
+
+    setIsUsingDiff (flag: boolean)
+
+    Current: Current
+
+    getCurrentInstance(): Current
+  }
 }

package/types/taro.hooks.d.ts

@@ -1,83 +1,84 @@
-/// <reference path="taro.lifecycle.d.ts" />
-/// <reference path="taro.component.d.ts" />
+import Taro from './index'
 
-declare namespace Taro {
-  /**
-   * 页面展示时的回调。
-   */
-  function useDidShow(callback: () => any): void
+declare module './index' {
+  interface TaroStatic {
+    /**
+     * 页面展示时的回调。
+     */
+    useDidShow(callback: () => any): void
 
-  /**
-   * 页面隐藏时的回调。
-   */
-  function useDidHide(callback: () => any): void
+    /**
+     * 页面隐藏时的回调。
+     */
+    useDidHide(callback: () => any): void
 
-  /**
-   * 下拉刷新时的回调。
-   */
-  function usePullDownRefresh(callback: () => any): void
+    /**
+     * 下拉刷新时的回调。
+     */
+    usePullDownRefresh(callback: () => any): void
 
-  /**
-   * 上拉触底时的回调。
-   */
-  function useReachBottom(callback: () => any): void
+    /**
+     * 上拉触底时的回调。
+     */
+    useReachBottom(callback: () => any): void
 
-  /**
-   * 页面滚动时的回调。
-   */
-  function usePageScroll(callback: (payload: PageScrollObject) => any): void
+    /**
+     * 页面滚动时的回调。
+     */
+    usePageScroll(callback: (payload: PageScrollObject) => any): void
 
-  /**
-   * 页面尺寸改变时的回调。
-   */
-  function useResize(callback: () => any): void
+    /**
+     * 页面尺寸改变时的回调。
+     */
+    useResize(callback: () => any): void
 
-  /**
-   * 页面转发时的回调。
-   */
-  function useShareAppMessage(callback: (payload: ShareAppMessageObject) => ShareAppMessageReturn): void
+    /**
+     * 页面转发时的回调。
+     */
+    useShareAppMessage(callback: (payload: ShareAppMessageObject) => ShareAppMessageReturn): void
 
-  /**
-   * 当前是 tab 页时，tab 被点击时的回调。
-   */
-  function useTabItemTap(callback: (payload: TabItemTapObject) => any): void
+    /**
+     * 当前是 tab 页时，tab 被点击时的回调。
+     */
+    useTabItemTap(callback: (payload: TabItemTapObject) => any): void
 
-  /**
-   * 用户点击右上角菜单“收藏”按钮时的回调。
-   */
-  function useAddToFavorites(callback: (paload: AddToFavoritesObject) => AddToFavoritesReturnObject): void
+    /**
+     * 用户点击右上角菜单“收藏”按钮时的回调。
+     */
+    useAddToFavorites(callback: (paload: AddToFavoritesObject) => AddToFavoritesReturnObject): void
 
-  /**
-   * 用户点击右上角菜单“分享到朋友圈”按钮时的回调。
-   */
-  function useShareTimeline(callback: () => ShareTimelineReturnObject): void
+    /**
+     * 用户点击右上角菜单“分享到朋友圈”按钮时的回调。
+     */
+    useShareTimeline(callback: () => ShareTimelineReturnObject): void
 
-  /**
-   * 页面初次渲染完成的回调。
-   * 此时页面已经准备妥当，可以和视图层进行交互。
-   */
-  function useReady(callback: () => any): void
+    /**
+     * 页面初次渲染完成的回调。
+     * 此时页面已经准备妥当，可以和视图层进行交互。
+     */
+    useReady(callback: () => any): void
 
-  /**
-   * 获取当前路由参数。
-   */
-  function useRouter<TParams extends Partial<Record<string, string>> = Partial<Record<string, string>>>(dynamic?: boolean): RouterInfo<TParams>
+    /**
+     * 获取当前路由参数。
+     */
+    useRouter<TParams extends Partial<Record<string, string>> = Partial<Record<string, string>>>(dynamic?: boolean): RouterInfo<TParams>
 
-  /**
-   * 导航栏的标题被点击时的回调。
-   * **仅支付宝小程序支持。**
-   */
-  function useTitleClick(callback: () => any): void
+    /**
+     * 导航栏的标题被点击时的回调。
+     * **仅支付宝小程序支持。**
+     */
+    useTitleClick(callback: () => any): void
 
-  /**
-   * 导航栏的额外图标被点击时的回调。
-   * **仅支付宝小程序支持。**
-   */
-  function useOptionMenuClick(callback: () => any): void
+    /**
+     * 导航栏的额外图标被点击时的回调。
+     * **仅支付宝小程序支持。**
+     */
+    useOptionMenuClick(callback: () => any): void
 
-  /**
-   * 下拉中断时的回调。
-   * **仅支付宝小程序支持。**
-   */
-  function usePullIntercept(callback: () => any): void
+    /**
+     * 下拉中断时的回调。
+     * **仅支付宝小程序支持。**
+     */
+    usePullIntercept(callback: () => any): void
+  }
 }

package/types/taro.lifecycle.d.ts

@@ -1,4 +1,36 @@
-declare namespace Taro {
+import Taro from './index'
+
+type TaroGetDerivedStateFromProps<P, S> =
+/**
+ * Returns an update to a component's state based on its new props and old state.
+ *
+ * Note: its presence prevents any of the deprecated lifecycle methods from being invoked
+ */
+(nextProps: Readonly<P>, prevState: S) => Partial<S> | null;
+
+interface TaroStaticLifecycle<P, S> {
+  getDerivedStateFromProps?: TaroGetDerivedStateFromProps<P, S>;
+}
+
+interface TaroNewLifecycle<P, S, SS> {
+  /**
+   * Runs before React applies the result of `render` to the document, and
+   * returns an object to be given to componentDidUpdate. Useful for saving
+   * things such as scroll position before `render` causes changes to it.
+   *
+   * Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
+   * lifecycle events from running.
+   */
+  getSnapshotBeforeUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>): SS | null;
+  /**
+   * Called immediately after updating occurs. Not called for the initial render.
+   *
+   * The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
+   */
+  componentDidUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>, snapshot?: SS): void;
+}
+
+declare module './index' {
   interface PageNotFoundObject {
     /**
      * 不存在页面的路径
@@ -8,7 +40,7 @@ declare namespace Taro {
     /**
      * 打开不存在页面的 query
      */
-    query: object
+    query: Record<string, unknown>
 
     /**
      * 是否本次启动的首个页面（例如从分享等入口进来，首个页面是开发者配置的分享页面）
@@ -126,33 +158,20 @@ declare namespace Taro {
     imageUrl?: string
   }
 
-  type GetDerivedStateFromProps<P, S> =
-  /**
-   * Returns an update to a component's state based on its new props and old state.
-   *
-   * Note: its presence prevents any of the deprecated lifecycle methods from being invoked
-   */
-  (nextProps: Readonly<P>, prevState: S) => Partial<S> | null;
+  type GetDerivedStateFromProps<P, S> = TaroGetDerivedStateFromProps<P, S>
 
-  interface StaticLifecycle<P, S> {
-    getDerivedStateFromProps?: GetDerivedStateFromProps<P, S>;
-  }
+  type StaticLifecycle<P, S> = TaroStaticLifecycle<P, S>
 
-  interface NewLifecycle<P, S, SS> {
-    /**
-     * Runs before React applies the result of `render` to the document, and
-     * returns an object to be given to componentDidUpdate. Useful for saving
-     * things such as scroll position before `render` causes changes to it.
-     *
-     * Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
-     * lifecycle events from running.
-     */
-    getSnapshotBeforeUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>): SS | null;
-    /**
-     * Called immediately after updating occurs. Not called for the initial render.
-     *
-     * The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
-     */
-    componentDidUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>, snapshot?: SS): void;
+  type NewLifecycle<P, S, SS> = TaroNewLifecycle<P, S, SS>
+
+  interface TaroStatic {
+    PageNotFoundObject: PageNotFoundObject
+    PageScrollObject: PageScrollObject
+    ShareAppMessageObject: ShareAppMessageObject
+    ShareAppMessageReturn: ShareAppMessageReturn
+    TabItemTapObject: TabItemTapObject
+    AddToFavoritesObject: AddToFavoritesObject
+    AddToFavoritesReturnObject: AddToFavoritesReturnObject
+    ShareTimelineReturnObject: ShareTimelineReturnObject
   }
 }

package/types/api/ad/index.ts

@@ -1,6 +0,0 @@
-declare namespace Taro {
-  // TODO: wx.createRewardedVideoAd
-  // TODO: wx.createInterstitialAd
-  // TODO: InterstitialAd
-  // TODO: RewardedVideoAd
-}

package/types/api/alipay/index.ts

@@ -1,7 +0,0 @@
-declare namespace Taro {
-  /**
-   * @since 10.1.35
-   * 此接口可获取支付宝会员的基础信息
-   */
-  function getOpenUserInfo(): Promise<string>
-}