@tarojs/taro 3.7.0-alpha.1 → 3.7.0-alpha.11

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

@@ -202,6 +202,98 @@ declare module '../../index' {
     }
   }
 
+  namespace join1v1Chat {
+    interface Caller {
+      /** 昵称 */
+      nickname: string
+      /** 头像 */
+      headImage?: string
+      /** 小程序内 openid */
+      openid: string
+    }
+    interface Listener {
+      /** 昵称 */
+      nickname: string
+      /** 头像 */
+      headImage?: string
+      /** 小程序内 openid */
+      openid: string
+    }
+    interface RoomType {
+      /** 语音通话 */
+      voice
+      /** 视频通话 */
+      video
+    }
+    interface Option {
+      /** 呼叫方信息 */
+      caller: Caller
+      /** 接听方信息 */
+      listener: Listener
+      /** 窗口背景色
+       * @default 0
+       */
+      backgroundType?: keyof setEnable1v1Chat.ColorType
+      /** 通话类型 */
+      roomType?: keyof RoomType
+      /** 小窗样式
+       * @default 1
+       */
+      minWindowType?: keyof setEnable1v1Chat.ColorType
+      /** 不允许切换到语音通话
+       * @default false
+       */
+      disableSwitchVoice?: boolean
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    interface ChatErrCode {
+      /** 未开通双人通话 */
+      [-20000]
+      /** 当前设备不支持 */
+      [-20001]
+      /** 正在通话中 */
+      [-20002]
+      /** 其它小程序正在通话中 */
+      [-20003]
+      /** 内部系统错误 */
+      [-30000]
+      /** 微信缺失相机权限 */
+      [-30001]
+      /** 微信缺失录音权限  */
+      [-30002]
+      /** 小程序缺失录音权限 */
+      [-30003]
+      /** 小程序缺失相机权限 */
+      [-30004]
+      /** 当前已在房间内 */
+      [-1]
+      /** 录音设备被占用，可能是当前正在使用微信内语音通话或系统通话 */
+      [-2]
+      /** 加入会话期间退出（可能是用户主动退出，或者退后台、来电等原因），因此加入失败 */
+      [-3]
+      /** 系统错误 */
+      [-1000]
+    }
+    interface FailCallbackResult extends TaroGeneral.CallbackResult {
+      /** 错误信息 */
+      errMsg: string
+      /** 错误码 */
+      errCode: keyof ChatErrCode
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 错误码 */
+      errCode: number
+      /** 调用结果 */
+      errMsg: string
+    }
+    type Promised = FailCallbackResult | SuccessCallbackResult
+  }
+
   namespace exitVoIPChat {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
@@ -264,6 +356,12 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatStateChanged.html
      */
     offVoIPChatStateChanged(callback: onVoIPChatStateChanged.Callback): void
+    /**
+     * 取消监听实时语音通话成员通话状态变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatSpeakersChanged.html
+     */
+    offVoIPChatSpeakersChanged(callback: onVoIPChatSpeakersChanged.Callback): void
     /** 取消监听实时语音通话成员在线状态变化事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatMembersChanged.html
@@ -281,6 +379,11 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.joinVoIPChat.html
      */
     joinVoIPChat(option: joinVoIPChat.Option): Promise<joinVoIPChat.Promised>
+    /**加入（创建）双人通话
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.join1v1Chat.html
+     */
+    join1v1Chat(option: join1v1Chat.Option): Promise<join1v1Chat.Promised>
     /** 退出（销毁）实时语音通话
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.exitVoIPChat.html

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

@@ -57,14 +57,6 @@ declare module '../../index' {
   }
 
   namespace DownloadTask {
-    /** HTTP Response Header 事件的回调函数 */
-    type OffHeadersReceivedCallback = (
-      res: TaroGeneral.CallbackResult,
-    ) => void
-    /** 下载进度变化事件的回调函数 */
-    type OffProgressUpdateCallback = (
-        res: TaroGeneral.CallbackResult,
-    ) => void
     /** HTTP Response Header 事件的回调函数 */
     type OnHeadersReceivedCallback = (
         result: OnHeadersReceivedCallbackResult,
@@ -135,7 +127,7 @@ declare module '../../index' {
      */
     offProgressUpdate(
       /** 下载进度变化事件的回调函数 */
-      callback: DownloadTask.OffProgressUpdateCallback,
+      callback: DownloadTask.OnProgressUpdateCallback,
     ): void
     /** 监听 HTTP Response Header 事件。会比请求完成事件更早
      * @supported weapp, h5
@@ -151,7 +143,7 @@ declare module '../../index' {
      */
     offHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: DownloadTask.OffHeadersReceivedCallback,
+      callback: DownloadTask.OnHeadersReceivedCallback,
     ): void
   }
 

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

@@ -2,7 +2,7 @@ import Taro from '../../index'
 
 declare module '../../index' {
   namespace request {
-    interface Option <T = any, U extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any > {
+    interface Option<T = any, U extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any> {
       /** 开发者服务器接口地址 */
       url: string
       /** 请求的参数 */
@@ -14,11 +14,11 @@ declare module '../../index' {
       header?: TaroGeneral.IAnyObject
       /** 超时时间，单位为毫秒
        * @default 2000
-       * @supported weapp, h5, tt
+       * @supported weapp, h5, tt, alipay
        */
       timeout?: number
       /** HTTP 请求方法
-       * @default GET
+       * @default "GET"
        */
       method?: keyof Method
       /** 返回的数据格式 */
@@ -54,70 +54,99 @@ declare module '../../index' {
        * @supported weapp
        */
       enableChunked?: boolean
+      /**
+       * wifi下使用移动网络发送请求
+       * @default false
+       * @supported weapp
+       */
+      forceCellularNetwork?: boolean
+      /**
+       * headers 中设置 cookie 字段是否生效。如果为 false，则 headers 中的 cookie 字段将被忽略，请求头中将包含服务端上一次返回的 cookie（如果有）。
+       * @default false
+       * @supported alipay 支付宝: 10.2.33+
+       */
+      enableCookie?: boolean
+      /**
+       * referer 策略，用于控制当前请求 header 对象中 referer 字段格式。该参数默认值可通过 app.json 中的配置进行修改。
+       * @default "querystring"
+       * @supported alipay 支付宝: 10.3.50+ APPX: 2.8.7 开发者工具: 3.5.1
+       * @see https://opendocs.alipay.com/mini/api/owycmh#referrerStrategy%20%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E
+       */
+      referrerStrategy?: keyof ReferrerStrategy
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult<T>) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 设置 H5 端是否使用jsonp方式获取数据
+      /** 设置是否使用 jsonp 方式获取数据
        * @default false
        * @supported h5
        */
-      jsonp?: boolean
-      /** 设置 H5 端 jsonp 请求 url 是否需要被缓存
-       * @default false
+      jsonp?: boolean | string
+      /** 设置 jsonp 请求 url 是否需要被缓存
        * @supported h5
        */
-      jsonpCache?: boolean
-      /** 设置 H5 端是否允许跨域请求
+      jsonpCache?: RequestCache
+      /** 设置是否允许跨域请求
        * @default "same-origin"
        * @supported h5
        */
       mode?: keyof CorsMode
-      /** 设置 H5 端是否携带 Cookie
+      /** 设置是否携带 Cookie
        * @default "omit"
        * @supported h5
        */
       credentials?: keyof Credentials
-      /** 设置 H5 端缓存模式
+      /** 设置缓存模式
        * @default "default"
        * @supported h5
        */
       cache?: keyof Cache
-      /** 设置 H5 端请求重试次数
+      /** 设置请求重试次数
        * @default 2
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       retryTimes?: number
-      /** 设置 H5 端请求的兜底接口
+      /** 设置请求的兜底接口
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       backup?: string | string[]
-      /** 设置 H5 端请求响应的数据校验函数，若返回 false，则请求兜底接口，若无兜底接口，则报请求失败
+      /** 设置请求中止信号
+       * @supported h5
+       */
+      signal?: AbortSignal
+      /** 设置请求响应的数据校验函数，若返回 false，则请求兜底接口，若无兜底接口，则报请求失败
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       dataCheck?(): boolean
-      /** 设置 H5 端请求是否使用缓存
+      /** 设置请求是否使用缓存
        * @default false
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       useStore?: boolean
-      /** 设置 H5 端请求缓存校验的 key
+      /** 设置请求缓存校验的 key
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       storeCheckKey?: string
-      /** 设置 H5 端请求缓存签名
+      /** 设置请求缓存签名
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       storeSign?: string
-      /** 设置 H5 端请求校验函数，一般不需要设置
+      /** 设置请求校验函数，一般不需要设置
        * @supported h5
        */
       storeCheck?(): boolean
     }
 
-    interface SuccessCallbackResult < T extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any > extends TaroGeneral.CallbackResult {
+    interface SuccessCallbackResult<T extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any>
+      extends TaroGeneral.CallbackResult {
       /** 开发者服务器返回的数据 */
       data: T
       /** 开发者服务器返回的 HTTP Response Header */
@@ -132,10 +161,26 @@ declare module '../../index' {
 
     /** 返回的数据格式 */
     interface DataType {
-      /** 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse
+      /**
+       * 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse
        * 其他: 不对返回的内容进行 JSON.parse
        */
       json
+      /**
+       * 返回的数据为文本字符串
+       * @supported alipay
+       */
+      text
+      /**
+       * 返回的数据将转换为 base64 格式字符串
+       * @supported alipay
+       */
+      base64
+      /**
+       * 返回的数据将保持 ArrayBuffer 数据
+       * @supported alipay 支付宝: 10.1.70+
+       */
+      arraybuffer
     }
 
     /** HTTP 请求方法 */
@@ -199,6 +244,21 @@ declare module '../../index' {
       /** 浏览器在其HTTP缓存中寻找匹配的请求 */
       'only-if-cached'
     }
+    /** referer 策略 */
+    interface ReferrerStrategy {
+      /**
+       * referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html
+       */
+      index
+      /**
+       * 保留 page（pages/xxx/yyy），referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html#{page}
+       */
+      page
+      /**
+       * 默认值。会将发起请求时所在页面的 URL 作为 referer 值，会保留 page（pages/xxx/yyy）和 querystring（x=1&y=2）并可能有框架添加的其他参数，referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html#{page}?{querysrtring}{框架其他参数}
+       */
+      querystring
+    }
   }
 
   /** 网络请求任务对象
@@ -266,7 +326,7 @@ declare module '../../index' {
      */
     onHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: RequestTask.onHeadersReceived.Callback,
+      callback: RequestTask.onHeadersReceived.Callback
     ): void
     /** 取消监听 HTTP Response Header 事件
      * @supported weapp
@@ -274,7 +334,7 @@ declare module '../../index' {
      */
     offHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: RequestTask.onHeadersReceived.Callback,
+      callback: RequestTask.onHeadersReceived.Callback
     ): void
     /** 监听 Transfer-Encoding Chunk Received 事件。当接收到新的chunk时触发。
      * @supported weapp
@@ -282,7 +342,7 @@ declare module '../../index' {
      */
     onChunkReceived(
       /** Transfer-Encoding Chunk Received 事件的回调函数 */
-      callback: RequestTask.onChunkReceived.Callback,
+      callback: RequestTask.onChunkReceived.Callback
     ): void
     /** 移除 Transfer-Encoding Chunk Received 事件的监听函数
      * @supported weapp
@@ -290,7 +350,7 @@ declare module '../../index' {
      */
     offChunkReceived(
       /** Transfer-Encoding Chunk Received 事件的回调函数 */
-      callback: RequestTask.onChunkReceived.Callback,
+      callback: RequestTask.onChunkReceived.Callback
     ): void
   }
 

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

@@ -56,14 +56,6 @@ declare module '../../index' {
   }
 
   namespace UploadTask {
-    /** HTTP Response Header 事件的回调函数 */
-    type OffHeadersReceivedCallback = (
-      res: TaroGeneral.CallbackResult,
-    ) => void
-    /** 上传进度变化事件的回调函数 */
-    type OffProgressUpdateCallback = (
-      res: TaroGeneral.CallbackResult,
-    ) => void
     /** HTTP Response Header 事件的回调函数 */
     type OnHeadersReceivedCallback = (
       result: OnHeadersReceivedCallbackResult,
@@ -138,7 +130,7 @@ declare module '../../index' {
      */
     offProgressUpdate(
       /** 上传进度变化事件的回调函数 */
-      callback: UploadTask.OffProgressUpdateCallback,
+      callback: UploadTask.OnProgressUpdateCallback,
     ): void
     /** 监听 HTTP Response Header 事件。会比请求完成事件更早
      * @supported weapp, h5
@@ -154,7 +146,7 @@ declare module '../../index' {
      */
     offHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: UploadTask.OffHeadersReceivedCallback,
+      callback: UploadTask.OnHeadersReceivedCallback,
     ): void
   }
 

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

@@ -4,32 +4,34 @@ declare module '../../index' {
   namespace chooseAddress {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: TaroGeneral.CallbackResult) => void
+      complete?: (res: SuccessCallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
 
-    interface SuccessCallbackResult {
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 收货人姓名 */
+      userName: string
+      /** 邮编 */
+      postalCode: string
+      /** 国标收货地址第一级地址 */
+      provinceName: string
       /** 国标收货地址第二级地址 */
       cityName: string
       /** 国标收货地址第三级地址 */
       countyName: string
+      /** 国标收货地址第四级地址 */
+      streetName: string
       /** 详细收货地址信息 */
       detailInfo: string
-      /** 错误信息 */
-      errMsg: string
+      /** 新选择器详细收货地址信息 */
+      detailInfoNew: string
       /** 收货地址国家码 */
       nationalCode: string
-      /** 邮编 */
-      postalCode: string
-      /** 国标收货地址第一级地址 */
-      provinceName: string
       /** 收货人手机号码 */
       telNumber: string
-      /** 收货人姓名 */
-      userName: string
     }
   }
 

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

@@ -68,6 +68,31 @@ declare module '../../index' {
     }
   }
 
+  namespace getChannelsShareKey {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 分享者 openid  */
+      sharerOpenId: string
+      /** 推广员 */
+      promoter: Promoter
+    }
+    interface Promoter {
+      /** 推广员昵称 */
+      finderNickname: string
+      /** 推广员id */
+      promoterId: string
+      /** 推广员openid */
+      promoterOpenId: string
+    }
+  }
+
   namespace getChannelsLiveNoticeInfo {
     interface Option {
       /** 视频号 id，以“sph”开头的id，可在视频号助手获取 */
@@ -164,6 +189,12 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.openChannelsActivity.html
      */
     openChannelsActivity(option?: openChannelsActivity.Option): Promise<TaroGeneral.CallbackResult>
+    /** 获取视频号直播卡片/视频卡片的分享来源，
+     * 仅当卡片携带了分享信息、同时用户已授权该小程序获取视频号分享信息且启动场景值为 1177、1184、1195、1208 时可用
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.getChannelsShareKey.html
+     */
+    getChannelsShareKey(option?: getChannelsShareKey.Option): Promise<getChannelsShareKey.SuccessCallbackResult>
     /** 获取视频号直播预告信息
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.getChannelsLiveNoticeInfo.html

package/types/api/open-api/device-voip.d.ts

@@ -0,0 +1,63 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace requestDeviceVoIP {
+    interface Option {
+      /** 设备唯一序列号。由厂商分配，长度不能超过128字节。字符只接受数字，大小写字母，下划线（_）和连字符（-） */
+      sn: string
+      /** 设备票据，5分钟内有效 */
+      snTicket: string
+      /** 设备型号 id。通过微信公众平台注册设备获得。 */
+      modelId: string
+      /** 设备名称，将显示在授权弹窗内（长度不超过13）。授权框中「设备名字」= 「deviceName」 + 「modelId 对应设备型号」 */
+      deviceName: string
+      /** 是否为授权设备组，默认 false */
+      isGroup?: boolean
+      /** 设备组的唯一标识 id 。isGroup 为 true 时只需要传该参数，isGroup 为 false 时不需要传该参数，但需要传 sn、snTicket、modelId、deviceName 。 */
+      groupId: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+  }
+
+  namespace getDeviceVoIPList {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      list: DeviceVoIP[]
+    }
+    interface DeviceVoIP {
+      /** 设备唯一序列号。（仅单台设备时） */
+      sn: string
+      /** 设备型号 id。通过微信公众平台注册设备获得。（仅单台设备时）	 */
+      model_id: string
+      /** 设备组的唯一标识 id（仅设备组时）  */
+      group_id: string
+      /** 设备（组）授权状态。0：未授权；1：已授权  */
+      status: number
+    }
+  }
+
+  interface TaroStatic {
+    /** 请求用户授权与设备（组）间进行音视频通话
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/device-voip/wx.requestDeviceVoIP.html
+     */
+    requestDeviceVoIP(option: requestDeviceVoIP.Option): Promise<TaroGeneral.CallbackResult>
+    /** 查询当前用户授权的音视频通话设备（组）信息
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/device-voip/wx.getDeviceVoIPList.html
+     */
+    getDeviceVoIPList(option: getDeviceVoIPList.Option): Promise<getDeviceVoIPList.SuccessCallbackResult>
+  }
+}

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

@@ -156,6 +156,7 @@ declare module '../../index' {
 
     /** 关闭当前页面，跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。
      * @supported weapp, h5, rn, tt
+     * @h5 未针对 tabbar 页面做限制处理
      * @example
      * ```tsx
      * Taro.redirectTo({
@@ -168,6 +169,7 @@ declare module '../../index' {
 
     /** 保留当前页面，跳转到应用内的某个页面。但是不能跳到 tabbar 页面。使用 Taro.navigateBack 可以返回到原页面。小程序中页面栈最多十层。
      * @supported weapp, h5, rn, tt
+     * @h5 未针对 tabbar 页面做限制处理
      * @example
      * ```tsx
      * Taro.navigateTo({

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

@@ -200,7 +200,7 @@ declare module '../../index' {
      * Taro.downloadFile({
      *   url: 'https://res.wx.qq.com/wxdoc/dist/assets/img/demo.ef5c5bef.jpg',
      *   success: (res) => {
-     *     wx.showShareImageMenu({
+     *     Taro.showShareImageMenu({
      *       path: res.tempFilePath
      *     })
      *   }