@tarojs/taro-h5 3.3.13 → 3.3.17

package/src/api/{fileTransfer/downloadFile.js → network/download.ts}

@@ -1,13 +1,14 @@
-import { createCallbackManager } from '../utils'
+import Taro from '@tarojs/api'
+import { CallbackManager } from '../utils/handler'
 import { NETWORK_TIMEOUT, setHeader, XHR_STATS } from './utils'
 
-const createDownloadTask = ({ url, header, success, error }) => {
+const createDownloadTask = ({ url, header, success, error }): Taro.DownloadTask => {
   let timeout
   const apiName = 'downloadFile'
   const xhr = new XMLHttpRequest()
   const callbackManager = {
-    headersReceived: createCallbackManager(),
-    progressUpdate: createCallbackManager()
+    headersReceived: new CallbackManager(),
+    progressUpdate: new CallbackManager()
   }
 
   xhr.open('GET', url, true)
@@ -47,7 +48,7 @@ const createDownloadTask = ({ url, header, success, error }) => {
     })
   }
 
-  xhr.onerror = e => {
+  xhr.onerror = (e: ProgressEvent<EventTarget> & { message?: string }) => {
     error({
       errMsg: `${apiName}:fail ${e.message}`
     })
@@ -111,41 +112,31 @@ const createDownloadTask = ({ url, header, success, error }) => {
 /**
  * 下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径。使用前请注意阅读相关说明。
  * 注意：请在服务端响应的 header 中指定合理的 Content-Type 字段，以保证客户端正确处理文件类型。
- * @todo 未挂载 task.offHeadersReceived
- * @todo 未挂载 task.offProgressUpdate
- * @param {Object} object 参数
- * @param {string} object.url 下载资源的 url
- * @param {Object} [object.header] HTTP 请求的 Header，Header 中不能设置 Referer
- * @param {string} [object.filePath] *指定文件下载后存储的路径
- * @param {function} [object.success] 接口调用成功的回调函数
- * @param {function} [object.fail] 接口调用失败的回调函数
- * @param {function} [object.complete] 接口调用结束的回调函数（调用成功、失败都会执行）
- * @returns {DownloadTask}
  */
-const downloadFile = ({ url, header, success, fail, complete }) => {
-  let task
-  const promise = new Promise((resolve, reject) => {
+const downloadFile: typeof Taro.downloadFile = ({ url, header, success, fail, complete }) => {
+  let task: Taro.DownloadTask
+  const result: ReturnType<typeof Taro.downloadFile> = new Promise((resolve, reject) => {
     task = createDownloadTask({
       url,
       header,
       success: res => {
         success && success(res)
-        complete && complete()
+        complete && complete(res)
         resolve(res)
       },
       error: res => {
         fail && fail(res)
-        complete && complete()
+        complete && complete(res)
         reject(res)
       }
     })
-  })
 
-  promise.headersReceive = task.onHeadersReceived
-  promise.progress = task.onProgressUpdate
-  promise.abort = task.abort
+    result.headersReceive = task.onHeadersReceived
+    result.progress = task.onProgressUpdate
+    result.abort = task.abort
+  }) as any
 
-  return promise
+  return result
 }
 
 export default downloadFile

package/src/api/network/index.ts

@@ -0,0 +1,7 @@
+export * from './download'
+export * from './mdns'
+export * from './request'
+export * from './tcp'
+export * from './udp'
+export * from './upload'
+export * from './websocket'

package/src/api/network/mdns.ts

@@ -0,0 +1,13 @@
+import { temporarilyNotSupport } from '../utils'
+
+// mDNS
+export const stopLocalServiceDiscovery = temporarilyNotSupport('stopLocalServiceDiscovery')
+export const startLocalServiceDiscovery = temporarilyNotSupport('startLocalServiceDiscovery')
+export const onLocalServiceResolveFail = temporarilyNotSupport('onLocalServiceResolveFail')
+export const onLocalServiceLost = temporarilyNotSupport('onLocalServiceLost')
+export const onLocalServiceFound = temporarilyNotSupport('onLocalServiceFound')
+export const onLocalServiceDiscoveryStop = temporarilyNotSupport('onLocalServiceDiscoveryStop')
+export const offLocalServiceResolveFail = temporarilyNotSupport('offLocalServiceResolveFail')
+export const offLocalServiceLost = temporarilyNotSupport('offLocalServiceLost')
+export const offLocalServiceFound = temporarilyNotSupport('offLocalServiceFound')
+export const offLocalServiceDiscoveryStop = temporarilyNotSupport('offLocalServiceDiscoveryStop')

package/src/api/{request/index.js → network/request/index.ts}

@@ -1,10 +1,13 @@
 import Taro from '@tarojs/api'
 import 'whatwg-fetch'
 import jsonpRetry from 'jsonp-retry'
-import { serializeParams } from '../utils'
+
+import { serializeParams } from '../../utils'
+
+// @ts-ignore
 const { Link } = Taro
 
-function generateRequestUrlWithParams (url, params) {
+function generateRequestUrlWithParams (url: string, params?: unknown) {
   params = typeof params === 'string' ? params : serializeParams(params)
   if (params) {
     url += (~url.indexOf('?') ? '&' : '?') + params
@@ -13,6 +16,7 @@ function generateRequestUrlWithParams (url, params) {
   return url
 }
 
+// FIXME 移除 any 标注
 function _request (options) {
   options = options || {}
   if (typeof options === 'string') {
@@ -22,8 +26,8 @@ function _request (options) {
   }
   const { success, complete, fail } = options
   let url = options.url
-  const params = {}
-  const res = {}
+  const params: any = {}
+  const res: any = {}
   if (options.jsonp) {
     Object.assign(params, options)
     params.params = options.data
@@ -122,6 +126,5 @@ function taroInterceptor (chain) {
 
 const link = new Link(taroInterceptor)
 
-/** @type {TaroH5.request} */
-export const request = link.request.bind(link)
+export const request: typeof Taro.request = link.request.bind(link)
 export const addInterceptor = link.addInterceptor.bind(link)

package/src/api/network/tcp.ts

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils'
+
+// TCP 通信
+export const createTCPSocket = temporarilyNotSupport('createTCPSocket')

package/src/api/network/udp.ts

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils'
+
+// UDP 通信
+export const createUDPSocket = temporarilyNotSupport('createUDPSocket')

package/src/api/{fileTransfer/uploadFile.js → network/upload.ts}

@@ -1,4 +1,6 @@
-import { createCallbackManager } from '../utils'
+import Taro from '@tarojs/api'
+import { temporarilyNotSupport } from '../utils'
+import { CallbackManager } from '../utils/handler'
 import {
   convertObjectUrlToBlob,
   NETWORK_TIMEOUT,
@@ -6,15 +8,15 @@ import {
   XHR_STATS
 } from './utils'
 
-const createUploadTask = ({ url, filePath, formData, name, header, timeout, fileName, success, error }) => {
+const createUploadTask = ({ url, filePath, formData, name, header, timeout, fileName, success, error }): Taro.UploadTask => {
   let timeoutInter
   let formKey
   const apiName = 'uploadFile'
   const xhr = new XMLHttpRequest()
   const form = new FormData()
   const callbackManager = {
-    headersReceived: createCallbackManager(),
-    progressUpdate: createCallbackManager()
+    headersReceived: new CallbackManager(),
+    progressUpdate: new CallbackManager()
   }
 
   xhr.open('POST', url)
@@ -57,7 +59,7 @@ const createUploadTask = ({ url, filePath, formData, name, header, timeout, file
     })
   }
 
-  xhr.onerror = e => {
+  xhr.onerror = (e: ProgressEvent<EventTarget> & { message?: string }) => {
     clearTimeout(timeoutInter)
     error({
       errMsg: `${apiName}:fail ${e.message}`
@@ -88,8 +90,11 @@ const createUploadTask = ({ url, filePath, formData, name, header, timeout, file
   }
 
   convertObjectUrlToBlob(filePath)
-    .then(fileObj => {
-      form.append(name, fileObj, fileName || fileObj.name || `file-${Date.now()}`)
+    .then((fileObj: string | (Blob & { name?: string })) => {
+      if (!fileName) {
+        fileName = typeof fileObj !== 'string' && fileObj.name
+      }
+      form.append(name, fileObj, fileName || `file-${Date.now()}`)
       send()
     })
     .catch(e => {
@@ -120,33 +125,26 @@ const createUploadTask = ({ url, filePath, formData, name, header, timeout, file
    */
   const offProgressUpdate = callbackManager.progressUpdate.remove
 
+  const headersReceived = temporarilyNotSupport('UploadTask.headersReceived')
+  const progress = temporarilyNotSupport('UploadTask.progress')
+
   return {
     abort,
     onHeadersReceived,
     offHeadersReceived,
     onProgressUpdate,
-    offProgressUpdate
+    offProgressUpdate,
+    headersReceived,
+    progress
   }
 }
 
 /**
  * 将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求，其中 content-type 为 multipart/form-data。使用前请注意阅读相关说明。
- * @param {Object} object 参数
- * @param {string} object.url 开发者服务器地址
- * @param {string} object.filePath 要上传文件资源的路径
- * @param {string} object.name 文件对应的 key，开发者在服务端可以通过这个 key 获取文件的二进制内容
- * @param {Object} [object.header] HTTP 请求 Header，Header 中不能设置 Referer
- * @param {Object} [object.formData] HTTP 请求中其他额外的 form data
- * @param {number} [object.timeout] 超时时间，单位为毫秒
- * @param {string} [object.fileName] 上传的文件名
- * @param {function} [object.success] 接口调用成功的回调函数
- * @param {function} [object.fail] 接口调用失败的回调函数
- * @param {function} [object.complete] 接口调用结束的回调函数（调用成功、失败都会执行）
- * @returns {UploadTask}
  */
-const uploadFile = ({ url, filePath, name, header, formData, timeout, fileName, success, fail, complete }) => {
-  let task
-  const promise = new Promise((resolve, reject) => {
+const uploadFile: typeof Taro.uploadFile = ({ url, filePath, name, header, formData, timeout, fileName, success, fail, complete }) => {
+  let task: Taro.UploadTask
+  const result: ReturnType<typeof Taro.uploadFile> = new Promise((resolve, reject) => {
     task = createUploadTask({
       url,
       header,
@@ -157,22 +155,22 @@ const uploadFile = ({ url, filePath, name, header, formData, timeout, fileName,
       fileName,
       success: res => {
         success && success(res)
-        complete && complete()
+        complete && complete(res)
         resolve(res)
       },
       error: res => {
         fail && fail(res)
-        complete && complete()
+        complete && complete(res)
         reject(res)
       }
     })
-  })
 
-  promise.headersReceive = task.onHeadersReceived
-  promise.progress = task.onProgressUpdate
-  promise.abort = task.abort
+    result.headersReceive = task.onHeadersReceived
+    result.progress = task.onProgressUpdate
+    result.abort = task.abort
+  }) as any
 
-  return promise
+  return result
 }
 
 export default uploadFile

package/src/api/{webSocket/index.js → network/websocket/index.ts}

@@ -1,45 +1,62 @@
 import SocketTask from './socketTask'
-import { shouleBeObject, getParameterError } from '../utils'
+import { shouldBeObject, getParameterError } from '../../utils'
+import { MethodHandler } from 'src/api/utils/handler'
 
-let socketTasks = []
+let socketTasks: SocketTask[] = []
 let socketsCounter = 1
 
+function sendSocketMessage () {
+  console.warn('Deprecated.Please use socketTask.send instead.')
+}
+
+function onSocketOpen () {
+  console.warn('Deprecated.Please use socketTask.onOpen instead.')
+}
+
+function onSocketMessage () {
+  console.warn('Deprecated.Please use socketTask.onMessage instead.')
+}
+
+function onSocketError () {
+  console.warn('Deprecated.Please use socketTask.onError instead.')
+}
+
+function onSocketClose () {
+  console.warn('Deprecated.Please use socketTask.onClose instead.')
+}
+
 function connectSocket (options) {
   const name = 'connectSocket'
 
   return new Promise((resolve, reject) => {
     // options must be an Object
-    const isObject = shouleBeObject(options)
-    if (!isObject.res) {
-      const res = { errMsg: `${name}${isObject.msg}` }
+    const isObject = shouldBeObject(options)
+    if (!isObject.flag) {
+      const res = { errMsg: `${name}:fail ${isObject.msg}` }
       console.error(res.errMsg)
       return reject(res)
     }
-
     const { url, protocols, success, fail, complete } = options
-    const res = { errMsg: 'connectSocket:ok' }
+    const handle = new MethodHandler<{
+      socketTaskId?: number
+    }>({ name, success, fail, complete })
 
     // options.url must be String
     if (typeof url !== 'string') {
-      res.errMsg = getParameterError({
-        name,
-        para: 'url',
-        correct: 'String',
-        wrong: url
-      })
-      console.error(res.errMsg)
-      typeof fail === 'function' && fail(res)
-      typeof complete === 'function' && complete(res)
-      return reject(res)
+      return handle.fail({
+        errMsg: getParameterError({
+          para: 'url',
+          correct: 'String',
+          wrong: url
+        })
+      }, reject)
     }
 
     // options.url must be invalid
     if (!url.startsWith('ws://') && !url.startsWith('wss://')) {
-      res.errMsg = `request:fail invalid url "${url}"`
-      console.error(res.errMsg)
-      typeof fail === 'function' && fail(res)
-      typeof complete === 'function' && complete(res)
-      return reject(res)
+      return handle.fail({
+        errMsg: `request:fail invalid url "${url}"`
+      }, reject)
     }
 
     // protocols must be array
@@ -47,11 +64,9 @@ function connectSocket (options) {
 
     // 2 connection at most
     if (socketTasks.length > 1) {
-      res.errMsg = '同时最多发起 2 个 socket 请求，更多请参考文档。'
-      console.error(res.errMsg)
-      typeof fail === 'function' && fail(res)
-      typeof complete === 'function' && complete(res)
-      return reject(res)
+      return handle.fail({
+        errMsg: '同时最多发起 2 个 socket 请求，更多请参考文档。'
+      }, reject)
     }
 
     const task = new SocketTask(url, _protocols)
@@ -60,44 +75,22 @@ function connectSocket (options) {
     }
     socketTasks.push(task)
 
-    res.socketTaskId = socketsCounter++
-    typeof success === 'function' && success(res)
-    typeof complete === 'function' && complete(res)
-
-    return resolve(task)
+    return handle.success({
+      socketTaskId: socketsCounter++
+    }, resolve)
   })
 }
 
-function onSocketOpen () {
-  console.warn('Deprecated.Please use socketTask.onOpen instead.')
-}
-
-function onSocketError () {
-  console.warn('Deprecated.Please use socketTask.onError instead.')
-}
-
-function sendSocketMessage () {
-  console.warn('Deprecated.Please use socketTask.send instead.')
-}
-
-function onSocketMessage () {
-  console.warn('Deprecated.Please use socketTask.onMessage instead.')
-}
-
 function closeSocket () {
   console.warn('Deprecated.Please use socketTask.close instead.')
 }
 
-function onSocketClose () {
-  console.warn('Deprecated.Please use socketTask.onClose instead.')
-}
-
 export {
-  connectSocket,
-  onSocketOpen,
-  onSocketError,
   sendSocketMessage,
+  onSocketOpen,
   onSocketMessage,
-  closeSocket,
-  onSocketClose
+  onSocketError,
+  onSocketClose,
+  connectSocket,
+  closeSocket
 }

package/src/api/{webSocket/socketTask.js → network/websocket/socketTask.ts}

@@ -1,4 +1,14 @@
+import Taro from '@tarojs/api'
+
 export default class SocketTask {
+  ws: WebSocket
+  CONNECTING: number
+  OPEN: number
+  CLOSING: number
+  CLOSED: number
+  closeDetail: { code: any; reason: any }
+  _destroyWhenClose?: () => void
+
   constructor (url, protocols) {
     if (protocols && protocols.length) {
       this.ws = new WebSocket(url, protocols)
@@ -15,10 +25,10 @@ export default class SocketTask {
     return this.ws.readyState
   }
 
-  send (obj = {}) {
-    if (typeof obj !== 'object' || !obj) obj = {}
+  send (opts: Partial<Taro.SocketTask.SendOption> = {}) {
+    if (typeof opts !== 'object' || !opts) opts = {}
 
-    const { data = '', success, fail, complete } = obj
+    const { data = '', success, fail, complete } = opts
 
     if (this.readyState !== 1) {
       const res = { errMsg: 'SocketTask.send:fail SocketTask.readState is not OPEN' }
@@ -36,15 +46,15 @@ export default class SocketTask {
     return Promise.resolve(res)
   }
 
-  close (obj = {}) {
-    if (typeof obj !== 'object' || !obj) obj = {}
+  close (opts: Partial<Taro.SocketTask.CloseOption> = {}) {
+    if (typeof opts !== 'object' || !opts) opts = {}
 
     const {
       code = 1000,
       reason = 'server complete,close',
       success,
       complete
-    } = obj
+    } = opts
 
     this.closeDetail = { code, reason }
     // 主动断开时需要重置链接数

package/src/api/open-api/account.ts

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 帐号信息
+export const getAccountInfoSync = temporarilyNotSupport('getAccountInfoSync')

package/src/api/open-api/address.ts

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 收货地址
+export const chooseAddress = temporarilyNotSupport('chooseAddress')

package/src/api/open-api/authorize.ts

@@ -0,0 +1,5 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 授权
+export const authorizeForMiniProgram = temporarilyNotSupport('authorizeForMiniProgram')
+export const authorize = temporarilyNotSupport('authorize')

package/src/api/open-api/card.ts

@@ -0,0 +1,5 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 卡券
+export const openCard = temporarilyNotSupport('openCard')
+export const addCard = temporarilyNotSupport('addCard')

package/src/api/open-api/channels-live.ts

@@ -0,0 +1,9 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 视频号
+export const reserveChannelsLive = temporarilyNotSupport('reserveChannelsLive')
+export const openChannelsLive = temporarilyNotSupport('openChannelsLive')
+export const openChannelsEvent = temporarilyNotSupport('openChannelsEvent')
+export const openChannelsActivity = temporarilyNotSupport('openChannelsActivity')
+export const getChannelsLiveNoticeInfo = temporarilyNotSupport('getChannelsLiveNoticeInfo')
+export const getChannelsLiveInfo = temporarilyNotSupport('getChannelsLiveInfo')

package/src/api/open-api/customer-service.ts

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 微信客服
+export const openCustomerServiceChat = temporarilyNotSupport('openCustomerServiceChat')

package/src/api/open-api/facial.ts

@@ -0,0 +1,7 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 过往接口
+export const checkIsSupportFacialRecognition = temporarilyNotSupport('checkIsSupportFacialRecognition')
+export const startFacialRecognitionVerify = temporarilyNotSupport('startFacialRecognitionVerify')
+export const startFacialRecognitionVerifyAndUploadVideo = temporarilyNotSupport('startFacialRecognitionVerifyAndUploadVideo')
+export const faceVerifyForPay = temporarilyNotSupport('faceVerifyForPay')

package/src/api/open-api/favorites.ts

@@ -0,0 +1,5 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 收藏
+export const addVideoToFavorites = temporarilyNotSupport('addVideoToFavorites')
+export const addFileToFavorites = temporarilyNotSupport('addFileToFavorites')

package/src/api/open-api/group.ts

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 微信群
+export const getGroupEnterInfo = temporarilyNotSupport('getGroupEnterInfo')

package/src/api/open-api/index.ts

@@ -0,0 +1,18 @@
+export * from './account'
+export * from './address'
+export * from './authorize'
+export * from './card'
+export * from './channels-live'
+export * from './customer-service'
+export * from './facial'
+export * from './favorites'
+export * from './group'
+export * from './invoice'
+export * from './license-plate'
+export * from './login'
+export * from './red-package'
+export * from './settings'
+export * from './soter'
+export * from './subscribe-message'
+export * from './user-info'
+export * from './werun'

package/src/api/open-api/invoice.ts

@@ -0,0 +1,5 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 发票
+export const chooseInvoiceTitle = temporarilyNotSupport('chooseInvoiceTitle')
+export const chooseInvoice = temporarilyNotSupport('chooseInvoice')

package/src/api/open-api/license-plate.ts

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 车牌
+export const chooseLicensePlate = temporarilyNotSupport('chooseLicensePlate')

package/src/api/open-api/login.ts

@@ -0,0 +1,6 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 帐号信息
+export const pluginLogin = temporarilyNotSupport('pluginLogin')
+export const login = temporarilyNotSupport('login')
+export const checkSession = temporarilyNotSupport('checkSession')

package/src/api/open-api/red-package.ts

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 微信红包
+export const showRedPackage = temporarilyNotSupport('showRedPackage')

package/src/api/open-api/settings.ts

@@ -0,0 +1,5 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 设置
+export const openSetting = temporarilyNotSupport('openSetting')
+export const getSetting = temporarilyNotSupport('getSetting')

package/src/api/open-api/soter.ts

@@ -0,0 +1,6 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 生物认证
+export const startSoterAuthentication = temporarilyNotSupport('startSoterAuthentication')
+export const checkIsSupportSoterAuthentication = temporarilyNotSupport('checkIsSupportSoterAuthentication')
+export const checkIsSoterEnrolledInDevice = temporarilyNotSupport('checkIsSoterEnrolledInDevice')

package/src/api/open-api/subscribe-message.ts

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 订阅消息
+export const requestSubscribeMessage = temporarilyNotSupport('requestSubscribeMessage')

package/src/api/open-api/user-info.ts

@@ -0,0 +1,5 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 用户信息
+export const getUserProfile = temporarilyNotSupport('getUserProfile')
+export const getUserInfo = temporarilyNotSupport('getUserInfo')

package/src/api/open-api/werun.ts

@@ -0,0 +1,5 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 微信运动
+export const shareToWeRun = temporarilyNotSupport('shareToWeRun')
+export const getWeRunData = temporarilyNotSupport('getWeRunData')

package/src/api/payment/index.ts

@@ -0,0 +1,5 @@
+import { temporarilyNotSupport } from '../utils'
+
+// 支付
+export const requestPayment = temporarilyNotSupport('requestPayment')
+export const requestOrderPayment = temporarilyNotSupport('requestOrderPayment')

package/src/api/route/index.ts

@@ -0,0 +1,10 @@
+// 路由
+export {
+  switchTab,
+  reLaunch,
+  redirectTo,
+  navigateTo,
+  navigateBack
+} from '@tarojs/router'
+
+// FIXME 方法导出类型未对齐，后续修复