@tarojs/taro 3.3.14 → 3.5.0-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarojs/taro",
-  "version": "3.3.14",
+  "version": "3.5.0-canary.0",
   "description": "Taro framework",
   "homepage": "https://github.com/nervjs/taro/tree/master/packages/taro#readme",
   "main": "index.js",
@@ -26,9 +26,9 @@
   "author": "O2Team",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/api": "3.3.14",
-    "@tarojs/runtime": "3.3.14",
-    "@tarojs/taro-h5": "3.3.14"
+    "@tarojs/api": "3.5.0-canary.0",
+    "@tarojs/runtime": "3.5.0-canary.0",
+    "@tarojs/taro-h5": "3.5.0-canary.0"
   },
-  "gitHead": "ffd2b33c2a760094372a9ec69735ab9c4d1877e5"
+  "gitHead": "a0222bc41bc05b0e34413d6db3de963d777a5015"
 }

package/types/api/device/network.d.ts

@@ -41,6 +41,8 @@ declare module '../../index' {
       '3g'
       /** 4g 网络 */
       '4g'
+      /** 5g 网络 */
+      '5g'
       /** Android 下不常见的网络类型 */
       'unknown'
       /** 无网络 */
@@ -48,6 +50,23 @@ declare module '../../index' {
     }
   }
 
+  namespace getLocalIPAddress {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 本机局域网IP地址 */
+      localip: string
+      /** 调用结果 */
+      errMsg: string
+    }
+  }
+
   interface TaroStatic {
     /** 监听网络状态变化。
      * @supported weapp, h5, rn
@@ -89,5 +108,18 @@ declare module '../../index' {
       /** 取消监听网络状态变化事件，参数为空，则取消所有的事件监听 */
       callback?: (...args: any[]) => any,
     ): void
+
+    /** 获取局域网IP地址。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.getLocalIPAddress()
+     *   .then(res => {
+     *     const localip = res.localip
+     *   })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.getLocalIPAddress.html
+     */
+    getLocalIPAddress(option?: getLocalIPAddress.Option): Promise<getLocalIPAddress.SuccessCallbackResult>
   }
 }

package/types/api/device/performance.d.ts

@@ -39,5 +39,15 @@ declare module '../../index' {
       /** 内存不足告警事件的回调函数 */
       callback: onMemoryWarning.Callback,
     ): void
+
+    /** 取消监听内存不足告警事件。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/memory/wx.offMemoryWarning.html
+     */
+    offMemoryWarning(
+      /** 取消监听内存不足告警事件 */
+      callback: (...args: any[]) => any,
+    ): void
+    
   }
 }

package/types/api/ui/interaction.d.ts

@@ -15,9 +15,10 @@ declare module '../../index' {
        *
        * 可选值：
        * - 'success': 显示成功图标，此时 title 文本最多显示 7 个汉字长度;
+       * - 'error': 显示失败图标，此时 title 文本最多显示 7 个汉字长度;
        * - 'loading': 显示加载图标，此时 title 文本最多显示 7 个汉字长度;
        * - 'none': 不显示图标，此时 title 文本最多可显示两行 */
-      icon?: 'success' | 'loading' | 'none'
+      icon?: 'success' | 'error' | 'loading' | 'none'
       /** 自定义图标的本地路径，image 的优先级高于 icon */
       image?: string
       /** 是否显示透明蒙层，防止触摸穿透 */
@@ -121,6 +122,8 @@ declare module '../../index' {
 
   namespace enableAlertBeforeUnload {
     interface Option {
+      /** 询问对话框内容 */
+      message: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -257,7 +260,7 @@ declare module '../../index' {
      * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.enableAlertBeforeUnload.html
      */
-    enableAlertBeforeUnload(option?: enableAlertBeforeUnload.Option): void
+    enableAlertBeforeUnload(option: enableAlertBeforeUnload.Option): void
 
     /** 关闭小程序页面返回询问对话框
      * @supported weapp

package/types/compile.d.ts

@@ -209,10 +209,6 @@ declare enum LogLevel {
   DEBUG = 'debug'
 }
 
-export interface IDeviceRatio {
-  [key: string]: number
-}
-
 export type SystemConfig = {
   /**
    * 打印日志等级，分为 off,error,warn,info,log,debug
@@ -361,7 +357,7 @@ export interface IProjectBaseConfig {
   date?: string,
   designWidth?: number,
   watcher?: any[],
-  deviceRatio?: IDeviceRatio,
+  deviceRatio?: TaroGeneral.TDeviceRatio,
   sourceRoot?: string,
   outputRoot?: string,
   env?: IOption,

package/types/global.d.ts

@@ -347,4 +347,46 @@ declare namespace TaroGeneral {
       extraData: IAnyObject
     }
   }
+
+  // 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
+  }
+
+  // ENV_TYPE
+  enum ENV_TYPE {
+    WEAPP = 'WEAPP',
+    WEB = 'WEB',
+    RN = 'RN',
+    SWAN = 'SWAN',
+    ALIPAY = 'ALIPAY',
+    TT = 'TT',
+    QQ = 'QQ',
+    JD = 'JD'
+  }
+
+  type TDeviceRatio = Record<string, number>
 }

package/types/taro.component.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 /// <reference types="vue" />
 
-import Taro, { ComponentOptions, Config, RouterInfo } from './index'
+import Taro, { Config } from './index'
 
 declare module './index' {
   // Components

package/types/taro.extend.d.ts

@@ -1,51 +1,6 @@
 import Taro, { Component } from './index'
 
-// Events
-export class TaroEvents {
-  /**
-   * 监听一个事件，接受参数
-   */
-  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
-}
-
-// ENV_TYPE
-
-export enum TARO_ENV_TYPE {
-  WEAPP = 'WEAPP',
-  WEB = 'WEB',
-  RN = 'RN',
-  SWAN = 'SWAN',
-  ALIPAY = 'ALIPAY',
-  TT = 'TT',
-  QQ = 'QQ',
-  JD = 'JD'
-}
-
 declare module './index' {
-  type Events = TaroEvents
-
-  type ENV_TYPE = TARO_ENV_TYPE
-
   type MessageType = 'info' | 'success' | 'error' | 'warning'
 
   interface AtMessageOptions {
@@ -87,11 +42,28 @@ declare module './index' {
     rnNavigationRef?: React.RefObject<any>
   }
 
+  interface SetGlobalDataPlugin {
+    install (app: any, data: any): void
+  }
+
+  interface TARO_ENV_TYPE {
+    [TaroGeneral.ENV_TYPE.WEAPP]: TaroGeneral.ENV_TYPE.WEAPP
+    [TaroGeneral.ENV_TYPE.WEB]: TaroGeneral.ENV_TYPE.WEB
+    [TaroGeneral.ENV_TYPE.RN]: TaroGeneral.ENV_TYPE.RN
+    [TaroGeneral.ENV_TYPE.SWAN]: TaroGeneral.ENV_TYPE.SWAN
+    [TaroGeneral.ENV_TYPE.ALIPAY]: TaroGeneral.ENV_TYPE.ALIPAY
+    [TaroGeneral.ENV_TYPE.TT]: TaroGeneral.ENV_TYPE.TT
+    [TaroGeneral.ENV_TYPE.QQ]: TaroGeneral.ENV_TYPE.QQ
+    [TaroGeneral.ENV_TYPE.JD]: TaroGeneral.ENV_TYPE.JD
+  }
+
   interface TaroStatic {
     // eventCenter
-    eventCenter: TaroEvents
+    eventCenter: TaroGeneral.Events
+
+    ENV_TYPE: TARO_ENV_TYPE
 
-    getEnv(): ENV_TYPE
+    getEnv(): TaroGeneral.ENV_TYPE
 
     render(component: Component | JSX.Element, element: Element | null): any
 
@@ -101,7 +73,7 @@ declare module './index' {
     atMessage(options: AtMessageOptions): void
 
     pxTransform(size: number, designWidth?: number): string
-    initPxTransform(config: { designWidth: number; deviceRatio: object }): void
+    initPxTransform(config: { designWidth: number; deviceRatio: TaroGeneral.TDeviceRatio }): void
 
     addInterceptor(interceptor: interceptor): any
 
@@ -115,5 +87,20 @@ declare module './index' {
     Current: Current
 
     getCurrentInstance(): Current
+
+    /**
+     * @desc Vue3 插件，用于设置 `getApp()` 中的全局变量
+     * @example
+     * ```js
+     * // 使用插件
+     * const App = createApp(...)
+     * App.use(setGlobalDataPlugin, {
+     *   xxx: 999
+     * })
+     * // 获取全局变量
+     * Taro.getApp().xxx
+     * ```
+     */
+    setGlobalDataPlugin: SetGlobalDataPlugin
   }
 }