@tarojs/taro 3.3.13 → 3.3.17

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

@@ -1,109 +1,40 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace stopRecord {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
-  /** 停止录音。
-   * @supported weapp
-   * @example
-   * ```tsx
-   * Taro.startRecord({
-   *   success: function (res) {
-   *     var tempFilePath = res.tempFilePath
-   *   },
-   *   fail: function (res) {
-   *      //录音失败
-   *   }
-   * })
-   * setTimeout(function() {
-   *   //结束录音
-   *   Taro.stopRecord()
-   * }, 10000)
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.stopRecord.html
-   */
-  function stopRecord(option?: stopRecord.Option): void
 
   namespace startRecord {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
-    interface SuccessCallbackResult extends General.CallbackResult {
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 录音文件的临时路径 */
       tempFilePath: string
       /** 调用结果 */
       errMsg: string
     }
   }
-  /** 开始录音。当主动调用`Taro.stopRecord`，或者录音超过1分钟时自动结束录音，返回录音文件的临时文件路径。当用户离开小程序时，此接口无法调用。
-   * **注意：1.6.0 版本开始，本接口不再维护。建议使用能力更强的 [Taro.getRecorderManager](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.getRecorderManager.html) 接口**
-   * 需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.record
-   * @supported weapp
-   * @example
-   * ```tsx
-   * Taro.startRecord({
-   *   success: function (res) {
-   *     const tempFilePath = res.tempFilePath
-   *   }
-   * })
-   * setTimeout(function () {
-   *   Taro.stopRecord() // 结束录音
-   * }, 10000)
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.startRecord.html
-   */
-  function startRecord(option: startRecord.Option): Promise<startRecord.SuccessCallbackResult>
-
-  /** 获取**全局唯一**的录音管理器 RecorderManager
-   * @supported weapp
-   * @example
-   * ```tsx
-   * const recorderManager = Taro.getRecorderManager()
-   * recorderManager.onStart(() => {
-   *   console.log('recorder start')
-   * })
-   * recorderManager.onPause(() => {
-   *   console.log('recorder pause')
-   * })
-   * recorderManager.onStop((res) => {
-   *   console.log('recorder stop', res)
-   *   const { tempFilePath } = res
-   * })
-   * recorderManager.onFrameRecorded((res) => {
-   *   const { frameBuffer } = res
-   *   console.log('frameBuffer.byteLength', frameBuffer.byteLength)
-   * })
-   * const options = {
-   *   duration: 10000,
-   *   sampleRate: 44100,
-   *   numberOfChannels: 1,
-   *   encodeBitRate: 192000,
-   *   format: 'aac',
-   *   frameSize: 50
-   * }
-   * recorderManager.start(options)
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.getRecorderManager.html
-   */
-  function getRecorderManager(): RecorderManager
 
   namespace RecorderManager {
     /** 录音错误事件的回调函数 */
     type OnErrorCallback = (
       result: OnErrorCallbackResult,
     ) => void
-    interface OnErrorCallbackResult extends General.CallbackResult {
+    interface OnErrorCallbackResult extends TaroGeneral.CallbackResult {
       /** 错误信息 */
       errMsg: string
     }
@@ -245,7 +176,7 @@ declare namespace Taro {
      */
     onInterruptionBegin(
       /** 录音因为受到系统占用而被中断开始事件的回调函数 */
-      callback: (res: General.CallbackResult) => void,
+      callback: (res: TaroGeneral.CallbackResult) => void,
     ): void
     /** 监听录音中断结束事件。在收到 interruptionBegin 事件之后，小程序内所有录音会暂停，收到此事件之后才可再次录音成功。
      * @supported weapp
@@ -253,7 +184,7 @@ declare namespace Taro {
      */
     onInterruptionEnd(
       /** 录音中断结束事件的回调函数 */
-      callback: (res: General.CallbackResult) => void,
+      callback: (res: TaroGeneral.CallbackResult) => void,
     ): void
     /** 监听录音暂停事件
      * @supported weapp
@@ -261,7 +192,7 @@ declare namespace Taro {
      */
     onPause(
       /** 录音暂停事件的回调函数 */
-      callback: (res: General.CallbackResult) => void,
+      callback: (res: TaroGeneral.CallbackResult) => void,
     ): void
     /** 监听录音继续事件
      * @supported weapp
@@ -269,7 +200,7 @@ declare namespace Taro {
      */
     onResume(
       /** 录音继续事件的回调函数 */
-      callback: (res: General.CallbackResult) => void,
+      callback: (res: TaroGeneral.CallbackResult) => void,
     ): void
     /** 监听录音开始事件
      * @supported weapp
@@ -277,7 +208,7 @@ declare namespace Taro {
      */
     onStart(
       /** 录音开始事件的回调函数 */
-      callback: (res: General.CallbackResult) => void,
+      callback: (res: TaroGeneral.CallbackResult) => void,
     ): void
     /** 监听录音结束事件
      * @supported weapp
@@ -308,4 +239,79 @@ declare namespace Taro {
      */
     stop(): void
   }
+
+  interface TaroStatic {
+    /** 停止录音。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.startRecord({
+     *   success: function (res) {
+     *     var tempFilePath = res.tempFilePath
+     *   },
+     *   fail: function (res) {
+     *      //录音失败
+     *   }
+     * })
+     * setTimeout(function() {
+     *   //结束录音
+     *   Taro.stopRecord()
+     * }, 10000)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.stopRecord.html
+     */
+    stopRecord(option?: stopRecord.Option): void
+
+    /** 开始录音。当主动调用`Taro.stopRecord`，或者录音超过1分钟时自动结束录音，返回录音文件的临时文件路径。当用户离开小程序时，此接口无法调用。
+     * **注意：1.6.0 版本开始，本接口不再维护。建议使用能力更强的 [Taro.getRecorderManager](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.getRecorderManager.html) 接口**
+     * 需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.record
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.startRecord({
+     *   success: function (res) {
+     *     const tempFilePath = res.tempFilePath
+     *   }
+     * })
+     * setTimeout(function () {
+     *   Taro.stopRecord() // 结束录音
+     * }, 10000)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.startRecord.html
+     */
+    startRecord(option: startRecord.Option): Promise<startRecord.SuccessCallbackResult>
+
+    /** 获取**全局唯一**的录音管理器 RecorderManager
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const recorderManager = Taro.getRecorderManager()
+     * recorderManager.onStart(() => {
+     *   console.log('recorder start')
+     * })
+     * recorderManager.onPause(() => {
+     *   console.log('recorder pause')
+     * })
+     * recorderManager.onStop((res) => {
+     *   console.log('recorder stop', res)
+     *   const { tempFilePath } = res
+     * })
+     * recorderManager.onFrameRecorded((res) => {
+     *   const { frameBuffer } = res
+     *   console.log('frameBuffer.byteLength', frameBuffer.byteLength)
+     * })
+     * const options = {
+     *   duration: 10000,
+     *   sampleRate: 44100,
+     *   numberOfChannels: 1,
+     *   encodeBitRate: 192000,
+     *   format: 'aac',
+     *   frameSize: 50
+     * }
+     * recorderManager.start(options)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.getRecorderManager.html
+     */
+    getRecorderManager(): RecorderManager
+  }
 }

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

@@ -1,10 +1,6 @@
-declare namespace Taro {
-  /** 创建音视频处理容器，最终可将容器中的轨道合成一个视频
-   * @supported weapp
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/wx.createMediaContainer.html
-   */
-  function createMediaContainer(): MediaContainer
+import Taro from '../../index'
 
+declare module '../../index' {
   /** 创建音视频处理容器，最终可将容器中的轨道合成一个视频
    * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/MediaContainer.html
    */
@@ -73,4 +69,12 @@ declare namespace Taro {
       video
     }
   }
+
+  interface TaroStatic {
+    /** 创建音视频处理容器，最终可将容器中的轨道合成一个视频
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/wx.createMediaContainer.html
+     */
+    createMediaContainer(): MediaContainer
+  }
 }

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

@@ -1,78 +1,29 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace saveVideoToPhotosAlbum {
     interface Option {
       /** 视频文件路径，可以是临时文件路径也可以是永久文件路径 */
       filePath: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
-  /**
-   * 保存视频到系统相册。支持mp4视频格式。需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.writePhotosAlbum
-   *
-   * **Bug & Tip：**
-   *
-   * 1.  `tip`: camera 参数在部分 Android 手机下由于系统 ROM 不支持无法生效
-   * @supported weapp, rn
-   * @example
-   ```tsx
-   * Taro.saveVideoToPhotosAlbum({
-   *   filePath: 'wxfile://xxx'
-   *   success: function (res) {
-   *     console.log(res.errMsg)
-   *   }
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.saveVideoToPhotosAlbum.html
-   */
-  function saveVideoToPhotosAlbum(option: saveVideoToPhotosAlbum.Option): Promise<General.CallbackResult>
-
-  /** 创建 video 上下文 VideoContext 对象。
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * videoContext = Taro.createVideoContext('myVideo')
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.createVideoContext.html
-   */
-  function createVideoContext(
-    /** video 组件的 id */
-    id: string,
-    /** 在自定义组件下，当前组件实例的this，以操作组件内 video 组件 */
-    component?: General.IAnyObject,
-  ): VideoContext
-
-  /** 拍摄视频或从手机相册中选视频。
-   * @supported weapp, rn
-   * @example
-   * ```tsx
-   * Taro.chooseVideo({
-   *   sourceType: ['album','camera'],
-   *   maxDuration: 60,
-   *   camera: 'back',
-   *   success: function (res) {
-   *     console.log(res.tempFilePath)
-   *   }
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseVideo.html
-   */
-  function chooseVideo(option: chooseVideo.Option): Promise<void>
 
   namespace chooseVideo {
     interface Option {
       /** 默认拉起的是前置或者后置摄像头。部分 Android 手机下由于系统 ROM 不支持无法生效 */
       camera?: keyof camera
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 是否压缩所选择的视频文件 */
       compressed?: boolean
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 拍摄视频最长拍摄时间，单位秒 */
       maxDuration?: number
       /** 视频选择的来源 */
@@ -80,7 +31,7 @@ declare namespace Taro {
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
-    interface SuccessCallbackResult extends General.CallbackResult {
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 选定视频的时间长度 */
       duration: number
       /** 返回选定视频的高度 */
@@ -188,4 +139,58 @@ declare namespace Taro {
       color?: string
     }
   }
+
+  interface TaroStatic {
+    /**
+     * 保存视频到系统相册。支持mp4视频格式。需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.writePhotosAlbum
+     *
+     * **Bug & Tip：**
+     *
+     * 1.  `tip`: camera 参数在部分 Android 手机下由于系统 ROM 不支持无法生效
+     * @supported weapp, rn
+     * @example
+     ```tsx
+     * Taro.saveVideoToPhotosAlbum({
+     *   filePath: 'wxfile://xxx'
+     *   success: function (res) {
+     *     console.log(res.errMsg)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.saveVideoToPhotosAlbum.html
+     */
+    saveVideoToPhotosAlbum(option: saveVideoToPhotosAlbum.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 创建 video 上下文 VideoContext 对象。
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * videoContext = Taro.createVideoContext('myVideo')
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.createVideoContext.html
+     */
+    createVideoContext(
+      /** video 组件的 id */
+      id: string,
+      /** 在自定义组件下，当前组件实例的this，以操作组件内 video 组件 */
+      component?: TaroGeneral.IAnyObject,
+    ): VideoContext
+
+    /** 拍摄视频或从手机相册中选视频。
+     * @supported weapp, rn
+     * @example
+     * ```tsx
+     * Taro.chooseVideo({
+     *   sourceType: ['album','camera'],
+     *   maxDuration: 60,
+     *   camera: 'back',
+     *   success: function (res) {
+     *     console.log(res.tempFilePath)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseVideo.html
+     */
+    chooseVideo(option: chooseVideo.Option): Promise<chooseVideo.SuccessCallbackResult>
+  }
 }

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

@@ -1,21 +1,23 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace downloadFile {
     interface Option {
       /** 下载资源的 url */
       url: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 指定文件下载后存储的路径 */
       filePath?: string
       /** HTTP 请求的 Header，Header 中不能设置 Referer */
-      header?: General.IAnyObject
+      header?: TaroGeneral.IAnyObject
       /** 接口调用成功的回调函数 */
       success?: (result: FileSuccessCallbackResult) => void
     }
 
-    interface FileSuccessCallbackResult extends General.CallbackResult {
+    interface FileSuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 用户文件路径。传入 filePath 时会返回，跟传入的 filePath 一致 */
       filePath: string
       /** 开发者服务器返回的 HTTP 状态码 */
@@ -27,36 +29,14 @@ declare namespace Taro {
     }
   }
 
-  /** 下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径，单次下载允许的最大文件为 50MB。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。
-   *
-   * 注意：请在服务端响应的 header 中指定合理的 `Content-Type` 字段，以保证客户端正确处理文件类型。
-   * @supported weapp, h5, alipay, swan
-   * @example
-   * ```tsx
-   * Taro.downloadFile({
-   *   url: 'https://example.com/audio/123', //仅为示例，并非真实的资源
-   *   success: function (res) {
-   *     // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
-   *     if (res.statusCode === 200) {
-   *       Taro.playVoice({
-   *         filePath: res.tempFilePath
-   *       })
-   *     }
-   *   }
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/wx.downloadFile.html
-   */
-  function downloadFile(option: downloadFile.Option): DownloadTask
-
   namespace DownloadTask {
     /** HTTP Response Header 事件的回调函数 */
     type OffHeadersReceivedCallback = (
-      res: General.CallbackResult,
+      res: TaroGeneral.CallbackResult,
     ) => void
     /** 下载进度变化事件的回调函数 */
     type OffProgressUpdateCallback = (
-        res: General.CallbackResult,
+        res: TaroGeneral.CallbackResult,
     ) => void
     /** HTTP Response Header 事件的回调函数 */
     type OnHeadersReceivedCallback = (
@@ -68,7 +48,7 @@ declare namespace Taro {
     ) => void
     interface OnHeadersReceivedCallbackResult {
       /** 开发者服务器返回的 HTTP Response Header */
-      header: General.IAnyObject
+      header: TaroGeneral.IAnyObject
     }
     interface OnProgressUpdateCallbackResult {
       /** 下载进度百分比 */
@@ -78,6 +58,12 @@ declare namespace Taro {
       /** 已经下载的数据长度，单位 Bytes */
       totalBytesWritten: number
     }
+
+    type DownloadTaskPromise = Promise<DownloadTask> & {
+      headersReceive: DownloadTask['onHeadersReceived'],
+      progress: DownloadTask['onProgressUpdate'],
+      abort: DownloadTask['abort']
+    }
   }
 
   interface DownloadTask {
@@ -119,4 +105,28 @@ declare namespace Taro {
       callback: DownloadTask.OnProgressUpdateCallback,
     ): void
   }
+
+  interface TaroStatic {
+    /** 下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径，单次下载允许的最大文件为 50MB。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。
+     *
+     * 注意：请在服务端响应的 header 中指定合理的 `Content-Type` 字段，以保证客户端正确处理文件类型。
+     * @supported weapp, h5, alipay, swan
+     * @example
+     * ```tsx
+     * Taro.downloadFile({
+     *   url: 'https://example.com/audio/123', //仅为示例，并非真实的资源
+     *   success: function (res) {
+     *     // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
+     *     if (res.statusCode === 200) {
+     *       Taro.playVoice({
+     *         filePath: res.tempFilePath
+     *       })
+     *     }
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/wx.downloadFile.html
+     */
+    downloadFile(option: downloadFile.Option): DownloadTask.DownloadTaskPromise
+  }
 }