@tarojs/taro 3.6.1 → 3.6.2-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarojs/taro",
-  "version": "3.6.1",
+  "version": "3.6.2-canary.0",
   "description": "Taro framework",
   "homepage": "https://github.com/nervjs/taro/tree/master/packages/taro#readme",
   "main": "index.js",
@@ -21,8 +21,8 @@
   "author": "O2Team",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/api": "3.6.1",
-    "@tarojs/runtime": "3.6.1"
+    "@tarojs/api": "3.6.2-canary.0",
+    "@tarojs/runtime": "3.6.2-canary.0"
   },
   "peerDependenciesMeta": {
     "@types/react": {

package/types/api/media/media-recorder.d.ts

@@ -82,11 +82,36 @@ declare module '../../index' {
     }
   }
 
+  namespace createMediaRecorder {
+    /**
+     * createMediaRecorder Option
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/media-recorder/wx.createMediaRecorder.html
+     */
+    interface Option {
+      /** 指定录制的时长（s)，到达自动停止。最大 7200，最小 5
+       * @default 600
+       */
+      duration?: number
+      /** 视频比特率（kbps），最小值 600，最大值 3000
+       * @default 1000
+       */
+      videoBitsPerSecond?: number
+      /** 视频关键帧间隔
+       * @default 12
+       */
+      gop?: number
+      /** 视频 fps
+       * @default 24
+       */
+      fps?: number
+    }
+  }
+
   interface TaroStatic {
     /** 创建 WebGL 画面录制器，可逐帧录制在 WebGL 上渲染的画面并导出视频文件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/media-recorder/wx.createMediaRecorder.html
      */
-    createMediaRecorder(): MediaRecorder
+    createMediaRecorder(canvas?: Canvas | OffscreenCanvas, option?: createMediaRecorder.Option): MediaRecorder
   }
 }

package/types/api/media/video.d.ts

@@ -322,6 +322,8 @@ declare module '../../index' {
       video
       /** 只能拍摄图片或从相册选择图片 */
       image
+      /** 可同时选择图片和视频 */
+      mix
     }
     interface sourceType {
       /** 从相册选择 */

package/types/api/open-api/favorites.d.ts

@@ -31,6 +31,22 @@ declare module '../../index' {
     }
   }
 
+  namespace checkIsAddedToMyMiniProgram {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /**是否被添加至 「我的小程序」 */
+      added: boolean
+    }
+  }
+
   interface TaroStatic {
     /** 收藏视频
      * @supported weapp
@@ -96,5 +112,11 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/favorites/wx.addFileToFavorites.html
      */
     addFileToFavorites(option?: addFileToFavorites.Option): Promise<TaroGeneral.CallbackResult>
+    /**
+     * 检查小程序是否被添加至 「我的小程序」
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/my-miniprogram/wx.checkIsAddedToMyMiniProgram.html
+     */
+    checkIsAddedToMyMiniProgram(option?: checkIsAddedToMyMiniProgram.Option):Promise<checkIsAddedToMyMiniProgram.SuccessCallbackResult>
   }
 }

package/types/api/qq/index.d.ts

@@ -0,0 +1,49 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace openQzonePublish {
+    interface Option {
+      /** 传递的文字内容 */
+      text: string
+      /** 传递的视频/图片内容，显示顺序为元素下标顺序 */
+      media: Media[]
+      /** 说说小尾巴跳转到的页面路径，不填则默认跳到主页 */
+      path: string
+      /** 说说小尾巴显示的文案，不填则默认显示小程序的简介文案 */
+      footnote: string
+    }
+    type Media = {
+      /** 图片填"photo"，视频填"video" */
+      type: MediaType
+      /** 文件路径，必须为本地文件 */
+      path: string
+    }
+    type MediaType = 'photo' | 'video'
+  }
+
+  interface TaroStatic {
+    /**
+     * 此接口可打开手Q说说发表界面，并将文字内容和图片/视频内容传递到手Q说说发表界面。
+     * ```tsx
+     * Taro.openQzonePublish({
+     *   footnote: '使用同款滤镜',
+     *   path: 'pages/index/index',
+     *   text: '我爱中国',
+     *   media: [
+     *     {
+     *       type: 'photo',
+     *       path: 'qqfile://1.png'
+     *     },
+     *     {
+     *       type: 'video',
+     *       path: 'qqfile://2.mp4'
+     *     }
+     *   ]
+     * })
+     * ```
+     * @supported qq
+     * @see https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_openQzonePublish.html
+     */
+    openQzonePublish(option: openQzonePublish.Option): void
+  }
+}

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

@@ -102,6 +102,10 @@ declare module '../../index' {
 
   namespace hideToast {
     interface Option {
+      /** 目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性
+       * @default false
+       */
+      noConflict?: boolean
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -113,6 +117,10 @@ declare module '../../index' {
 
   namespace hideLoading {
     interface Option {
+      /** 目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性
+       * @default false
+       */
+      noConflict?: boolean
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */

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

@@ -60,5 +60,12 @@ declare module '../../index' {
       /** 窗口尺寸变化事件的回调函数 */
       callback: offWindowResize.Callback,
     ): void
+
+    /**
+     * 返回当前是否存在小窗播放（小窗在 video/live-player/live-pusher 下可用）
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.checkIsPictureInPictureActive.html
+     */
+    checkIsPictureInPictureActive(): boolean
   }
 }

package/types/api/wxml/index.d.ts

@@ -304,7 +304,7 @@ declare module '../../index' {
   namespace NodesRef {
     /** 回调函数，在执行 `SelectorQuery.exec` 方法后，节点信息会在 `callback` 中返回。 */
     type BoundingClientRectCallback = (
-      result: BoundingClientRectCallbackResult,
+      result: BoundingClientRectCallbackResult | BoundingClientRectCallbackResult[],
     ) => void
     interface BoundingClientRectCallbackResult {
       /** 节点的下边界坐标 */

package/types/compile/config/h5.d.ts

@@ -40,6 +40,7 @@ export interface IH5Config {
   miniCssExtractPluginOption?: IOption
   esnextModules?: string[]
   useHtmlComponents?: boolean
+  useDeprecatedAdapterComponent?: boolean
 
   postcss?: IPostcssOption
   htmlPluginOption?: HtmlWebpackPlugin.Options

package/types/compile/hooks.d.ts

@@ -1,7 +1,7 @@
 type Tagname = string
 type Attrs = Set<string>
 
-interface IComponentConfig {
+export interface IComponentConfig {
   includes: Set<string>
   exclude: Set<string>
   thirdPartyComponents: Map<Tagname, Attrs>

package/types/taro.api.d.ts

@@ -108,4 +108,5 @@
 /// <reference path="api/open-api/facial.d.ts" />
 
 /// <reference path="api/alipay/index.d.ts" />
+/// <reference path="api/qq/index.d.ts" />
 /// <reference path="api/swan/index.d.ts" />

package/types/taro.extend.d.ts

@@ -69,7 +69,13 @@ declare module './index' {
     /** 尺寸转换初始化
      * @supported global
      */
-    initPxTransform(config: { designWidth: number; deviceRatio: TaroGeneral.TDeviceRatio }): void
+    initPxTransform(config: {
+      baseFontSize?: number
+      deviceRatio?: TaroGeneral.TDeviceRatio
+      designWidth?: number
+      targetUnit?: string
+      unitPrecision?: number
+    }): void
 
     /** 小程序引用插件 JS 接口
      * @supported weapp, alipay, h5, rn, jd, qq, swan, tt, quickapp

package/types/taro.lifecycle.d.ts

@@ -67,25 +67,19 @@ declare module './index' {
      * 转发事件来源
      * `button`：页面内转发按钮
      * `menu`：右上角转发菜单
-     *
-     * @since 1.2.4
      */
     from?: 'button' | 'menu' | string
     /**
      * 如果 `from` 值是 `button`，则 `target` 是触发这次转发事件的 `button`，否则为 `undefined`
-     *
-     * @since 1.2.4
      */
     target?: object
     /**
      * 页面中包含 `<web-view>` 组件时，返回当前 `<web-view>` 的 url
-     *
-     * @since 1.6.4
      */
     webViewUrl?: string
   }
 
-  interface ShareAppMessageReturn {
+  interface ShareAppMessageReturnObject {
     /**
      * 	转发标题，默认为当前小程序名称
      */
@@ -101,12 +95,44 @@ declare module './index' {
      * 支持PNG及JPG
      * 显示图片长宽比是 5:4
      * 默认使用截图
-     *
-     * @since 1.5.0
      */
     imageUrl?: string
   }
 
+  interface WeappShareAppMessageReturnObject extends ShareAppMessageReturnObject {
+    /**
+     * 如果该参数存在，则以 resolve 结果为准，如果三秒内不 resolve，分享会使用上面传入的默认参数
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/reference/api/Page.html#onShareAppMessage-Object-object
+     * @example
+     * ```tsx
+     * import { ShareAppMessageReturnObject, useShareAppMessage } from "@tarojs/taro";
+     * // ... else code
+     * useShareAppMessage(() => {
+     *   const p = new Promise<ShareAppMessageReturnObject>(resolve => {
+     *     setTimeout(() => {
+     *       resolve({
+     *         title: "",
+     *         imageUrl: "",
+     *         path: ""
+     *       })
+     *     }, 2000)
+     *   })
+     *   return {
+     *     title: "",
+     *     imageUrl: "",
+     *     path: "",
+     *     promise: p
+     *   }
+     * });
+     * ```
+     *
+     */
+    promise: Promise<ShareAppMessageReturnObject>
+  }
+
+  type ShareAppMessageReturn = ShareAppMessageReturnObject | Promise<ShareAppMessageReturnObject> | WeappShareAppMessageReturnObject
+
   interface TabItemTapObject {
     /**
      * 被点击tabItem的序号，从 0 开始