@tarojs/plugin-platform-harmony-ets 3.7.0-alpha.27

package/dist/apis/network/downloadFile.ts

@@ -0,0 +1,113 @@
+// HarmonyOS 文档链接：https://developer.harmonyos.com/cn/docs/documentation/doc-references/js-apis-request-0000001123753962#section455311474372
+// WX 文档链接：https://developers.weixin.qq.com/miniprogram/dev/api/network/download/wx.downloadFile.html
+// ✅ wx.downloadFile (BETA)7+,因为使用了 query 和 on('complete')
+// ✅ DownloadTask.abort
+// ✅ DownloadTask.offProgressUpdate
+// ✅ DownloadTask.onProgressUpdate
+// ❌ DownloadTask.onHeadersReceived 此接口 ohos 不支持
+// ❌ DownloadTask.offHeadersReceived 此接口 ohos 不支持
+
+import request from '@ohos.request'
+import Taro, { DownloadTask } from '@tarojs/taro'
+
+import { callAsyncFail, callAsyncSuccess, validateParams } from '../utils'
+
+interface IDownloadConfigOHOS {
+  url: string
+  header?: any
+  filePath?: string
+  enableMetered?: boolean // ohos参数
+  enableRoaming?: boolean // ohos参数
+  description?: string // ohos参数
+  networkType?: number // ohos参数
+  title?: string // ohos参数
+}
+
+const downloadFileSchema = {
+  url: 'String'
+}
+
+export const downloadFile: typeof Taro.downloadFile = function (options) {
+  let downloadTask: any = {}
+
+  const downloadTaskWX: any = new Promise((resolve, reject) => {
+    const { url, header, filePath } = options
+
+    try {
+      validateParams('downloadFile', options, downloadFileSchema)
+    } catch (error) {
+      const res = { errMsg: error.message }
+      return callAsyncFail(reject, res, options)
+    }
+
+    const ohosParams: IDownloadConfigOHOS = {
+      url
+    }
+    if (header) ohosParams.header = header
+    if (filePath) ohosParams.filePath = filePath
+
+    request.download(ohosParams).then((dataDownload:any) => {
+      downloadTask = dataDownload
+
+      // TODO: 建议鸿蒙优化 complete 回调接口。
+      // ohos 的 complete 回调不返回任何下载信息，需要调用 query 查询后，在 complete 和 fail 中调用回调返回
+      downloadTask.query().then(dataQuery => {
+        downloadTask.on('complete', () => {
+          dataQuery.status = dataQuery.statusCode
+          callAsyncSuccess(resolve, dataQuery, options)
+        })
+        downloadTask.on('fail', (err) => {
+          const res = {
+            errMsg: err
+          }
+          callAsyncFail(reject, res, options)
+        })
+      }).catch((err) => {
+        callAsyncFail(reject, err, options)
+      })
+    }).catch((err) => {
+      callAsyncFail(reject, err, options)
+    })
+  })
+  downloadTaskWX.abort = function () {
+    downloadTask.remove((err: any, data: any) => {
+      if (err) {
+        return err
+      }
+      return data
+    })
+  }
+  downloadTaskWX.offProgressUpdate = function offProgressUpdate (callback: DownloadTask.OnProgressUpdateCallback) {
+    validateParams('offProgressUpdate', [callback], ['Function'])
+    downloadTask.off('progress', (receivedSize: number, totalSize: number) => {
+      const totalBytesWritten: number = receivedSize * 1024
+      const totalBytesExpectedToWrite: number = totalSize * 1024
+      // TODO: 进度应该保留几位小数？暂时保留6位
+      const progress: number = +(receivedSize / totalSize).toFixed(6)
+      const progressParams = {
+        totalBytesWritten,
+        totalBytesExpectedToWrite,
+        progress,
+        errMsg: 'Cancel progress listening is done.'
+      }
+      callback(progressParams)
+    })
+  }
+  // wx 单位是 Bytes，ohos 单位是 KBytes
+  downloadTaskWX.onProgressUpdate = function (callback: DownloadTask.OnProgressUpdateCallback) {
+    validateParams('onProgressUpdate', [callback], ['Function'])
+    downloadTask.on('progress', (receivedSize: number, totalSize: number) => {
+      const totalBytesWritten: number = receivedSize * 1024
+      const totalBytesExpectedToWrite: number = totalSize * 1024
+      // TODO: 进度应该保留几位小数？暂时保留6位
+      const progress: number = +(receivedSize / totalSize).toFixed(6)
+      const progressParams: DownloadTask.OnProgressUpdateCallbackResult = {
+        totalBytesWritten,
+        totalBytesExpectedToWrite,
+        progress
+      }
+      callback(progressParams)
+    })
+  }
+  return downloadTaskWX
+}

package/dist/apis/network/index.ts

@@ -0,0 +1,4 @@
+export * from './downloadFile'
+export * from './request'
+export * from './uploadFile'
+export * from './webSocket'

package/dist/apis/network/request.ts

@@ -0,0 +1,113 @@
+// HarmonyOS 文档链接：https://developer.harmonyos.com/cn/docs/documentation/doc-references/js-apis-net-http-0000001168304341
+// WX 文档链接：https://developers.weixin.qq.com/miniprogram/dev/api/network/request/wx.request.html
+// ✅ wx.request
+// ✅ RequestTask.abort
+// ✅ RequestTask.offHeadersReceived
+// ✅ RequestTask.onHeadersReceived
+
+import http from '@ohos.net.http'
+import { isString, isUndefined } from '@tarojs/shared'
+import Taro from '@tarojs/taro'
+
+import { callAsyncFail, callAsyncSuccess, validateParams } from '../utils'
+
+const METHOD: string [] = ['OPTIONS', 'GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'CONNECT']
+
+interface IRequestResultOHOS {
+  result: string | any
+  responseCode: number
+  header
+}
+
+interface IRequestParamsOHOS {
+  method?: string
+  header?: any
+  extraData?: any | string
+  readTimeout?: number
+  connectTimeout?: number
+}
+
+const requestSchema = {
+  url: 'String'
+}
+
+export const request: typeof Taro.request = function (options) {
+  let httpRequestOhos: ReturnType<typeof http.createHttp>
+
+  const requestTask: any = new Promise((resolve, reject) => {
+    try {
+      httpRequestOhos = http.createHttp()
+    } catch (error) {
+      const res = { errMsg: error }
+      return callAsyncFail(reject, res, options)
+    }
+
+    const { url, method, header = {}, timeout, dataType, data } = options
+
+    try {
+      validateParams('send', options, requestSchema)
+    } catch (error) {
+      const res = { errMsg: error.message }
+      return callAsyncFail(reject, res, options)
+    }
+
+    const keyOfContentType = Object.keys(header).find(item => item.toLowerCase() === 'content-type')
+
+    if (!keyOfContentType) {
+      header['Content-Type'] = 'application/json'
+    }
+
+    // 检查 Header 是否有 Referer
+    if (isUndefined(header.Referer)) {
+      const error = { errMsg: 'request fail parameter error: the header doesn‘t support Referer property' }
+      callAsyncFail(reject, error, options)
+    }
+
+    // 检查 method 是否正确
+    if (method) {
+      if (!METHOD.includes(method)) {
+        const error = { errMsg: `request fail parameter error: the method value should be one of the ${METHOD.join(',')}` }
+        callAsyncFail(reject, error, options)
+      }
+    }
+
+    const requestParamsOHOS: IRequestParamsOHOS = {
+      method,
+      header,
+      extraData: data as IRequestParamsOHOS['extraData'],
+      readTimeout: timeout,
+      connectTimeout: timeout
+    }
+
+    httpRequestOhos.request(url, requestParamsOHOS).then((requestData: IRequestResultOHOS) => {
+      const reswx = {
+        data: dataType === 'json' && isString(requestData.result) ? JSON.parse(requestData.result) : requestData.result,
+        statusCode: requestData.responseCode,
+        header: requestData.header
+      }
+      callAsyncSuccess(resolve, reswx, options)
+    }).catch(error => {
+      callAsyncFail(reject, error, options)
+    })
+  })
+
+  requestTask.abort = function () {
+    httpRequestOhos.destroy()
+  }
+
+  requestTask.onHeadersReceived = function (callback) {
+    validateParams('onHeadersReceived', [callback], ['Function'])
+    httpRequestOhos.on('headerReceive', (err, res) => {
+      callback(!err ? res : err)
+    })
+  }
+
+  requestTask.offHeadersReceived = function (callback) {
+    validateParams('offHeadersReceived', [callback], ['Function'])
+    httpRequestOhos.off('headerReceive', (err, res) => {
+      callback(!err ? res : err)
+    })
+  }
+
+  return requestTask
+}

package/dist/apis/network/uploadFile.ts

@@ -0,0 +1,158 @@
+// HarmonyOS 文档链接：https://developer.harmonyos.com/cn/docs/documentation/doc-references/js-apis-request-0000001123753962#section455311474372
+// WX 文档链接：https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/wx.uploadFile.html
+// ✅ wx.uploadFile
+// ✅ UploadTask.abort
+// ✅ UploadTask.offHeadersReceived (BETA)7+
+// ✅ UploadTask.offProgressUpdate
+// ✅ UploadTask.onHeadersReceived(BETA)7+
+// ✅ UploadTask.onProgressUpdate
+
+import request from '@ohos.request'
+import { isUndefined } from '@tarojs/shared'
+import Taro, { UploadTask } from '@tarojs/taro'
+
+import { callAsyncFail, callAsyncSuccess, validateParams } from '../utils'
+
+interface IOHOSFileType {
+  filename?: string
+  name?: string
+  url: string // 支持“dataability”和“internal”两种协议类型，但“internal”仅支持临时目录。详见官方文档
+  type?: string
+}
+
+interface IRequestDataOHOS {
+  name?: string
+  value?: string
+}
+
+interface IUploadFileParamsOHOS {
+  url: string // 资源地址
+  header?: any
+  method?: string // POST、PUT。缺省为POST
+  files?: Array<IOHOSFileType> // 请使用 multipart/form-data提交。官方文档提供的demo未传此参数，应该是文档错了。
+  data?: Array<IRequestDataOHOS>
+}
+
+const uploadSchema = {
+  url: 'String'
+  // filePath: 'String',
+  // name: 'String'
+}
+
+// wx 只支持 HTTP POST 请求，OHOS 支持 POST 和 PUT 请求
+// OHOS 不支持 wx 的 timeout，但是支持 file 文件列表上传，wx 是单文件上传
+export const uploadFile: typeof Taro.uploadFile = function (options) {
+  let uploadTask: any = {}
+
+  const UploadTaskWX: any = new Promise((resolve, reject) => {
+    let timer
+    const { url, filePath, name, header, formData, timeout } = options
+
+    try {
+      validateParams('uploadFile', options, uploadSchema)
+    } catch (error) {
+      const res = { errMsg: error.message }
+      return callAsyncFail(reject, res, options)
+    }
+
+    const file: IOHOSFileType = {
+      url: filePath,
+      name
+    }
+    const files: Array<IOHOSFileType> = [file]
+    const ohosParams: IUploadFileParamsOHOS = {
+      url,
+      files,
+      method: 'POST',
+      header
+    }
+
+    if (formData) {
+      const rData: Array<IRequestDataOHOS> = []
+      Object.keys(formData).forEach((key: string) => {
+        const rDataEle: IRequestDataOHOS = {
+          name: key,
+          value: formData[key]
+        }
+        rData.push(rDataEle)
+      })
+      ohosParams.data = rData
+    }
+    if (!isUndefined(timeout)) {
+      timer = setTimeout(() => {
+        const err: {errMsg: string} = {
+          errMsg: 'uploadFile request timeout, please try again later.'
+        }
+        callAsyncFail(reject, err, options)
+      }, timeout)
+    }
+
+    request.upload(ohosParams).then((dataUpload) => {
+      if (timer) {
+        clearTimeout(timer)
+      }
+      uploadTask = dataUpload
+      callAsyncSuccess(resolve, UploadTaskWX, options)
+    }).catch((err) => {
+      if (timer) {
+        clearTimeout(timer)
+      }
+      callAsyncFail(reject, err, options)
+    })
+  })
+
+  UploadTaskWX.abort = function () {
+    uploadTask.remove((err: any, result: any) => {
+      if (err || result) {
+        return err || result
+      }
+      return result
+    })
+  }
+  UploadTaskWX.onHeadersReceived = function (callback: (params) => void) {
+    validateParams('onHeadersReceived', [callback], ['Function'])
+    uploadTask.on('headerReceive', (headers: any) => {
+      callback(headers)
+    })
+  }
+  UploadTaskWX.offHeadersReceived = function (callback: (params) => void) {
+    validateParams('offHeadersReceived', [callback], ['Function'])
+    uploadTask.off('headerReceive', (headers: any) => {
+      callback(headers)
+    })
+  }
+  // wx 单位是 Bytes，ohos 单位是 KBytes
+  UploadTaskWX.onProgressUpdate = function (callback: UploadTask.OnProgressUpdateCallback) {
+    validateParams('onProgressUpdate', [callback], ['Function'])
+    uploadTask.on('progress', (uploadSize: number, totalSize: number) => {
+      const totalBytesSent: number = uploadSize * 1024
+      const totalBytesExpectedToSend: number = totalSize * 1024
+      // TODO: 进度应该保留几位小数？暂时保留6位
+      const progress: number = +(uploadSize / totalSize).toFixed(6)
+      const progressParams: UploadTask.OnProgressUpdateCallbackResult = {
+        totalBytesSent,
+        totalBytesExpectedToSend,
+        progress
+      }
+      callback(progressParams)
+    })
+  }
+  UploadTaskWX.offProgressUpdate = function (callback: UploadTask.OnProgressUpdateCallback) {
+    validateParams('offProgressUpdate', [callback], ['Function'])
+    uploadTask.off('progress', (uploadSize: number, totalSize: number) => {
+      const totalBytesSent: number = uploadSize * 1024
+      const totalBytesExpectedToSend: number = totalSize * 1024
+      // TODO: 进度应该保留几位小数？暂时保留6位
+      const progress: number = +(uploadSize / totalSize).toFixed(6)
+      const progressParams = {
+        totalBytesSent,
+        totalBytesExpectedToSend,
+        progress,
+        errMsg: 'Cancel progress listening is done.'
+      }
+      callback(progressParams)
+    })
+  }
+
+  return UploadTaskWX
+}

package/dist/apis/network/webSocket.ts

@@ -0,0 +1,130 @@
+// OpenHarmony 不支持全局操作 WebSocket
+// HarmonyOS 文档链接：https://developer.harmonyos.com/cn/docs/documentation/doc-references/js-apis-net-websocket-0000001168304641
+// WX 文档链接：https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.sendSocketMessage.html
+// ✅ wx.connectSocket
+// ✅ SocketTask
+// ✅ SocketTask.close
+// ✅ SocketTask.onClose
+// ✅ SocketTask.onError
+// ✅ SocketTask.onMessage
+// ✅ SocketTask.onOpen
+// ✅ SocketTask.send
+
+// ❌ wx.sendSocketMessage
+// ❌ wx.onSocketOpen
+// ❌ wx.onSocketMessage
+// ❌ wx.onSocketError
+// ❌ wx.onSocketClose
+// ❌ wx.closeSocket
+
+import webSocket from '@ohos.net.webSocket'
+import Taro from '@tarojs/taro'
+
+import { callAsyncFail, callAsyncSuccess, validateParams } from '../utils'
+import { IAsyncParams } from '../utils/types'
+
+interface ISendSocketOptions extends IAsyncParams {
+  data: string
+}
+
+const connectSocketSchema = {
+  url: 'String'
+}
+
+// const closetSocketSchema = {
+//   code: 'Number',
+//   reason: 'String'
+// }
+
+const sendSocketSchema = {
+  data: 'String'
+}
+
+export const connectSocket: typeof Taro.connectSocket = function (options) {
+  let ws
+  const SocketTaskWX: any = new Promise((resolve, reject) => {
+    ws = webSocket.createWebSocket()
+
+    const { url, header } = options
+
+    try {
+      validateParams('uploadFile', options, connectSocketSchema)
+    } catch (error) {
+      const res = { errMsg: error.message }
+      return callAsyncFail(reject, res, options)
+    }
+
+    const result = {
+      errMsg: 'websocket connect success'
+    }
+    ws.connect(url, { header }).then((value) => {
+      callAsyncSuccess(resolve, value, options)
+    }).catch((err) => {
+      result.errMsg = 'websocket connect fail'
+      callAsyncFail(reject, err, options)
+    })
+  })
+
+  SocketTaskWX.close = function (closeOptions) {
+    return new Promise((resolve, reject) => {
+      // TODO: 检验非必须参数
+      // try {
+      //   validateParams('close', options, closeSocketSchema)
+      // } catch (error) {
+      //   const res = { errMsg: error.message }
+      //   return callAsyncFail(reject, res, options)
+      // }
+
+      ws.close(closeOptions).then(value => {
+        callAsyncSuccess(resolve, value, closeOptions)
+      }, error => {
+        callAsyncFail(reject, error, closeOptions)
+      })
+    })
+  }
+  SocketTaskWX.onClose = function (onCloseCallback) {
+    validateParams('onClose', [onCloseCallback], ['Function'])
+    ws.on('close', (err, value) => {
+      onCloseCallback(!err ? value : err)
+    })
+  }
+  SocketTaskWX.onError = function (onErrorCallback) {
+    validateParams('onError', [onErrorCallback], ['Function'])
+    ws.on('error', (err) => {
+      onErrorCallback(err)
+    })
+  }
+  SocketTaskWX.onMessage = function (onMessageCallback?: any) {
+    validateParams('onMessage', [onMessageCallback], ['Function'])
+    ws.on('onMessage', (err, value) => {
+      onMessageCallback(!err ? value : err)
+    })
+  }
+  SocketTaskWX.onOpen = function (onOpenCallback) {
+    validateParams('onOpen', [onOpenCallback], ['Function'])
+    ws.on('open', (err, value) => {
+      // TODO：返回数据字段完全不一样，无法兼容，暂不处理
+      // wx:{header, profile}, ohos:{err, value:{status, message}}
+      onOpenCallback(!err ? value : err)
+    })
+  }
+  SocketTaskWX.send = function (sendOptions: ISendSocketOptions) {
+    return new Promise((resolve, reject) => {
+      const { data } = sendOptions
+      try {
+        validateParams('send', sendOptions, sendSocketSchema)
+      } catch (error) {
+        const res = { errMsg: error.message }
+        return callAsyncFail(reject, res, options)
+      }
+
+      ws.send(data).then(value => {
+        callAsyncSuccess(resolve, value, sendOptions)
+      }, error => {
+        callAsyncFail(reject, error, sendOptions)
+      })
+    })
+  }
+
+  return SocketTaskWX
+}

package/dist/apis/open-api/index.ts

@@ -0,0 +1,7 @@
+import { temporarilyNotSupport } from '../utils'
+
+export const login = temporarilyNotSupport('login')
+export const getAccountInfoSync = temporarilyNotSupport('getAccountInfoSync')
+export const requestSubscribeMessage = temporarilyNotSupport('requestSubscribeMessage')
+
+export * from './user-info'

package/dist/apis/open-api/user-info/index.ts

@@ -0,0 +1,85 @@
+/**
+ * 用户相关API， Harmony ACE API 6
+ *
+ * 1. 华为账号场景介绍文档 @see https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/harmonyos-js-login-0000001151310900
+ * 2. 华为账号API参考 @see https://developer.huawei.com/consumer/cn/doc/development/HMSCore-References/harmonyos-js-overview-0000001063532145
+ */
+
+// import hmsJSAccount from '@hmscore/hms-jsb-account'
+import { temporarilyNotSupport } from '../../utils'
+
+/**
+ * 通过Scope数组获取已登录的对应帐号信息(依赖login行为)
+ * @param options
+ */
+export const getUserInfo = temporarilyNotSupport('getUserInfo')
+// export function getUserInfo (options) {
+//   const { success, fail, complete } = options
+//   const res: Record<string, any> = {}
+
+//   // const result = hmsJSAccount.HuaweiIdAuthManager.getAuthResultWithScopes([hmsJSAccount.PROFILE])
+//   const result = null
+
+//   if (result) {
+//     res.data = { userInfo: generateUserInfo(result) }
+//     isFunction(success) && success(res)
+//   } else {
+//     res.errorMsg = 'getUserInfo result data is null'
+//     isFunction(fail) && fail(res)
+//   }
+//   isFunction(complete) && complete(res)
+// }
+
+/**
+ * 获取用户信息
+ */
+export const getUserProfile = temporarilyNotSupport('getUserProfile')
+// export const getUserProfile = (_options) => {
+//   return new Promise((resolve, reject) => {
+//     const res: Record<string, any> = {}
+//     hmsJSAccount.HuaweiIdAuthManager.addAuthScopes([hmsJSAccount.PROFILE])
+//       .then(result => {
+//         if (result) {
+//           res.data = { userInfo: generateUserInfo(result) }
+//           callAsyncSuccess(resolve, res, options)
+//         } else {
+//           res.errorMsg = 'getUserProfile result data is null'
+//           callAsyncFail(reject, res, options)
+//         }
+//       })
+//       .catch(error => {
+//         callAsyncFail(reject, error, options)
+//       })
+//   })
+// }
+
+/**
+ * 提前向用户发起授权请求
+ */
+export const authorize = temporarilyNotSupport('authorize')
+
+/**
+ * 获取用户的当前设置
+ */
+export const getSetting = temporarilyNotSupport('getSetting')
+
+/**
+ * 调起客户端小程序设置界面
+ */
+export const openSetting = temporarilyNotSupport('openSetting')
+
+// function generateUserInfo (hmsAuthInfo) {
+//   const userInfo = {
+//     nickName: String,
+//     avatarUrl: String,
+//     gender: Number,
+//     country: String
+//   }
+//   if (hmsAuthInfo) {
+//     userInfo.nickName = hmsAuthInfo.displayName
+//     userInfo.avatarUrl = hmsAuthInfo.photoUriString
+//     userInfo.gender = hmsAuthInfo.gender
+//     userInfo.country = hmsAuthInfo.country
+//   }
+//   return userInfo
+// }