tmui-cli 2.0.3 → 2.0.5

package/data/uni-app-x-docs/api/uni-push.md

@@ -0,0 +1,251 @@
+# uni-push
+
+uni-push是DCloud与合作伙伴个推共同推出的统一推送服务。用于从服务器端推送消息到客户端。
+
+它包括在线推送、离线推送，聚合了Apple、华为、小米、OPPO、VIVO、魅族、荣耀(3.99+)、Google等多个手机厂商的推送通道。
+
+若不使用服务器推送，仅想创建手机通知栏本地消息，也需要使用本模块的API。
+
+它是一个云端一体的业务，涉及多份文档：
+1. 业务介绍：对于未使用过uni-push的新用户，本文必读：[uni-push业务介绍](https://uniapp.dcloud.net.cn/unipush-v2.html)
+2. 客户端API，即本文
+3. 服务器API，[另见](https://doc.dcloud.net.cn/uniCloud/uni-cloud-push/api)
+
+## 注意事项
+* Android离线推送消息，需要开通厂商通道，在UniPush2.0中进行配置 [文档](https://uniapp.dcloud.net.cn/unipush-v2.html#%E7%AC%AC%E4%BA%8C%E6%AD%A5-%E9%85%8D%E7%BD%AE)
+* iOS平台配置证书时，请注意开通推送能力，否则云打包会报错，配置如下图：
+  ![](https://web-ext-storage.dcloud.net.cn/uni-app-x/uni-push/iOS/ios-profile-push-notification.jpg)
+* iOS平台可以通过[info.plist](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-ios.html#usagedescription)配置通知权限描述 
+
+## uni.getPushClientId(options) @getpushclientid
+
+<!-- UTSAPIJSON.getPushClientId.description -->
+
+> HBuilderX5.25及以上版本 Android平台 调整为不再主动申请通知权限，可调用 [uni.requestSystemPermission](../api/request-system-permission.md) 主动申请通知权限
+
+<!-- UTSAPIJSON.getPushClientId.compatibility -->
+
+<!-- UTSAPIJSON.getPushClientId.param -->
+
+<!-- UTSAPIJSON.getPushClientId.returnValue -->
+
+<!-- UTSAPIJSON.getPushClientId.tutorial -->
+
+## uni.onPushMessage(callback) @onpushmessage
+
+<!-- UTSAPIJSON.onPushMessage.description -->
+
+> HBuilderX5.25及以上版本 Android平台 新增 options 参数（requestPermission属性）配置配置是否主动申请通知权限
+
+<!-- UTSAPIJSON.onPushMessage.compatibility -->
+
+<!-- UTSAPIJSON.onPushMessage.param -->
+
+<!-- UTSAPIJSON.onPushMessage.returnValue -->
+
+<!-- UTSAPIJSON.onPushMessage.tutorial -->
+
+### 注意事项
+
+* 如果多次监听`onPushMessage`，那么事件也会多次触发，所以当不需要监听的时候需要`offPushMessage`。
+
+## uni.offPushMessage(callback) @offpushmessage
+
+<!-- UTSAPIJSON.offPushMessage.description -->
+
+<!-- UTSAPIJSON.offPushMessage.compatibility -->
+
+<!-- UTSAPIJSON.offPushMessage.param -->
+
+<!-- UTSAPIJSON.offPushMessage.returnValue -->
+
+<!-- UTSAPIJSON.offPushMessage.tutorial -->
+
+### 注意事项
+
+* 由于各大厂商限制推送频次，当使用厂商离线推送的时，需要在不同品牌手机后台开通自分类权益，[限制数量说明](https://docs.getui.com/getui/mobile/vendor/qps/)
+  - [华为](https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/message-classification-0000001149358835?ha_source=Dcloud&ha_sourceId=89000448)
+  - [小米](https://dev.mi.com/console/doc/detail?pId=2422)
+  - [oppo](https://open.oppomobile.com/new/developmentDoc/info?id=11227)
+  - [vivo](https://dev.vivo.com.cn/documentCenter/doc/359)
+  - [honor](https://developer.hihonor.com/cn/kitdoc?category=%E5%9F%BA%E7%A1%80%E6%9C%8D%E5%8A%A1&kitId=11002&navigation=guides&docId=notification-class.html)
+
+	uni-push从HBuilderX 3.99起支持荣耀推送
+
+  开通自分类权益后，需要客户端创建channel，因此客户端提供了`setPushChannel`来进行channel的创建，通过此Api来创建渠道进行推送。
+  客户端创建渠道成功后，即可通过云函数进行推送，[uni-push2服务端文档](https://doc.dcloud.net.cn/uniCloud/uni-cloud-push/api.html)。
+
+
+* 由于Android通知渠道的机制问题，一旦通知渠道建立，便不能修改此渠道的配置，即使删除渠道后再次创建同channelId名称的渠道，也不会改变原先渠道的配置（除非删除应用），最明显的现象就是铃声动态修改失败，比如调用`setPushChannel`时，第一次的设置参数是`{"channelId":"test","soundName":"pushsound"}` , 这时你想切换铃音，你的channelId就不能再叫test了，而应该为`{"channelId":"test2","soundName":"ring"}` ，此时会新建一个渠道。
+
+
+
+## uni.createPushMessage(options) @createpushmessage
+
+<!-- UTSAPIJSON.createPushMessage.description -->
+
+<!-- UTSAPIJSON.createPushMessage.compatibility -->
+
+<!-- UTSAPIJSON.createPushMessage.param -->
+
+<!-- UTSAPIJSON.createPushMessage.returnValue -->
+
+<!-- UTSAPIJSON.createPushMessage.tutorial -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->
+
+## uni.getPushChannelManager() @getpushchannelmanager
+
+<!-- UTSAPIJSON.getPushChannelManager.description -->
+
+<!-- UTSAPIJSON.getPushChannelManager.compatibility -->
+
+<!-- UTSAPIJSON.getPushChannelManager.param -->
+
+<!-- UTSAPIJSON.getPushChannelManager.returnValue -->
+
+<!-- UTSAPIJSON.getPushChannelManager.example -->
+
+<!-- UTSAPIJSON.getPushChannelManager.tutorial -->
+
+## uni.setAppBadgeNumber(num, options?) @setappbadgenumber
+
+<!-- UTSAPIJSON.setAppBadgeNumber.description -->
+
+<!-- UTSAPIJSON.setAppBadgeNumber.compatibility -->
+
+<!-- UTSAPIJSON.setAppBadgeNumber.param -->
+
+<!-- UTSAPIJSON.setAppBadgeNumber.returnValue -->
+
+<!-- UTSAPIJSON.setAppBadgeNumber.example -->
+
+<!-- UTSAPIJSON.setAppBadgeNumber.tutorial -->
+
+<!-- UTSAPIJSON.getChannelManager.name -->
+
+<!-- UTSAPIJSON.getChannelManager.description -->
+
+<!-- UTSAPIJSON.getChannelManager.compatibility -->
+
+<!-- UTSAPIJSON.getChannelManager.param -->
+
+<!-- UTSAPIJSON.getChannelManager.returnValue -->
+
+<!-- UTSAPIJSON.getChannelManager.tutorial -->
+
+#### 注意事项
+
+- Android原生的系统其实是不支持设置角标的，在原生系统中应用有通知时，会在图标右上角出现圆点，所以原生系统并不适用 `setAppBadgeNumber`。
+- 支持的手机品牌为：小米、华为、荣耀、OPPO、vivo、三星、索尼。
+- 在小米系统上设置角标有个默认的行为，即：app处于前台状态会清空角标数（可以理解为已读），所以小米平台建议在`onHide`中设置角标。
+
+
+<!-- UTSAPIJSON.uni-push.example -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->
+
+
+## app-android平台高级场景用途
+
+### 配置资源
+
+在[nativeResources/android](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#%E5%BA%94%E7%94%A8%E8%B5%84%E6%BA%90)目录可以配置图片和声音的二进制文件资源。
+
+### 关闭自动申请通知权限
+
+为避免应用启动时自动申请通知权限，开发者可以在 `AndroidManifest.xml` 中关闭 Push 模块的自动申请功能(HBuilderX5.23支持)。[配置AndroidManifest.xml](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#%E5%BA%94%E7%94%A8%E6%B8%85%E5%8D%95%E6%96%87%E4%BB%B6-androidmanifest-xml)
+
+在 `<application>` 节点内添加：
+
+```xml
+<application>
+    <meta-data
+        android:name="dcloud_push_auto_request_permission"
+        android:value="false" />
+</application>
+```
+
+配置后：
+
+- 框架不再主动申请 `POST_NOTIFICATIONS` 权限。
+- 通知权限的申请时机和业务逻辑由开发者自行管理。
+- Push SDK 初始化、获取 `clientId` 等功能不受影响。
+- 未获得通知权限时，系统通知可能无法展示。
+
+未配置该项或配置为 `true` 时，框架保持原有行为，自动申请通知权限。
+
+> Android 13（API 33）及以上系统需要申请通知权限。开发者接管权限申请后，应避免在用户拒绝授权时，每次启动应用都重复申请。
+
+
+### 通知栏显示图标自定义
+关于图标的配置，需要创建[nativeResources](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#%E5%BA%94%E7%94%A8%E8%B5%84%E6%BA%90)目录，
+放置对应分辨率的图片资源即可（打包后生效），目录配置如下
+
+```
+├── nativeResources
+│   └── android
+│       └── res
+│           ├── drawable-ldpi
+│           │   ├── push.png            // 分辨率要求48x48
+│           │   └── push_small.png      // 分辨率要求18x18
+│           ├── drawable-mdpi
+│           │   ├── push.png            // 分辨率要求64x64
+│           │   └── push_small.png      // 分辨率要求24x24
+│           ├── drawable-hdpi
+│           │   ├── push.png            // 分辨率要求96x96
+│           │   └── push_small.png      // 分辨率要求36x36
+│           ├── drawable-xhdpi
+│           │   ├── push.png            // 分辨率要求128x128
+│           │   └── push_small.png      // 分辨率要求48x48
+│           ├── drawable-xxhdpi
+│           │   ├── push.png            // 分辨率要求192x192
+│           │   └── push_small.png      // 分辨率要求72x72
+│           ├── drawable-xxxhdpi
+│           │   └── push_small.png      // 分辨率要求96x96
+│           └── raw
+│               └── pushsound.mp3       // 声音文件， 自定义推送铃音时使用
+```
+
+[小图标要求](https://uniapp.dcloud.net.cn/tutorial/app-push-unipush.html#%E6%8E%A8%E9%80%81%E5%B0%8F%E5%9B%BE%E6%A0%87-small-%E8%A6%81%E6%B1%82)
+
+### 通知声音自定义
+
+有些场景，如到账提醒，需要自定义通知声音。
+
+`setPushChannel`设置新建渠道时，`soundName`字段的值为目录nativeResources->android->res->raw中存放的音频文件名称，（打包后生效）
+注意不要带文件的后缀，比如`pushsound.mp3`文件，例：
+```ts
+const channelManager = getChannelManager()
+channelManager.setPushChannel({
+	channelId: "test1",
+	channelDesc: "test1 desc",
+	soundName: "pushsound"
+})
+```
+
+### 在通知栏显示App下载进度
+
+很多Android应用升级下载apk时会在通知栏显示下载进度。
+
+该功能已经内置到[uni升级中心](https://doc.dcloud.net.cn/uniCloud/upgrade-center.html)中，此开源模板可直接使用。
+
+### 在通知栏显示音乐播放条
+
+需要使用uts插件，[见插件市场](https://ext.dcloud.net.cn/search?q=%E9%80%9A%E7%9F%A5%E6%A0%8F&orderBy=Relevance&uni-appx=1)
+
+## 注意事项
+
+* 关于隐私安全问题，由于在调用`getPushClientId`或者`onPushMessage`时，才会初始化个推SDK，所以开发者要确保**弹出隐私框之前不调用此两项API**。
+* 获取手机端app是否拥有push权限，请使用API [uni.getAppAuthorizeSetting](get-app-authorize-setting.md)
+* uni-app x 的push模块仅支持uni-push2，不再支持uni-push1。但不要误会这不是强绑uniCloud的付费行为。而是DCloud的所有云服务都将统一纳入到uniCloud体系管理，开发者在开通uni-push2后，也可以拿到mastersecret，然后在自己的服务器去直接连接个推服务器。另外uniCloud的免费版也足够很多开发者使用。
+* uni-push是一个独立的模块，HBuilderX4.25以前版本标准基座中并不包含，HBuilder4.25及以上版本标准基座中包含，可直接在标准基座体验创建本地通知消息相关业务。由于push消息推送功能需要关联包名及签名信息，完整消息推送功能需打包自定义基座。
+* 创建本地通知栏，理论上可以和个推的服务无关。但目前也都包含在push模块里了。如果您不需要服务器推送，只需要本地创建通知栏，也需要打包push模块才行。
+* 部分手机创建本地通知时，App如果在后台状态，点击通知消息并不会拉起App，原因是厂商增加了后台弹窗权限，需要用户手动打开此权限。
+
+
+    

package/data/uni-app-x-docs/api/unicloud/README.md

@@ -0,0 +1,25 @@
+## 概述
+
+uniCloud是基于serverless的云开发服务，它大幅降低开发者的开发成本和运维成本。业务介绍[详见](https://doc.dcloud.net.cn/uniCloud/)
+
+截止到目前，uni-app x下的uniCloud还不支持：
+
+- 暂不支持schema2code
+- uts插件编译为swift、arkts时插件内不可调用uniCloud
+
+**兼容说明**
+
+- `HBuilderX 3.9+` 支持阿里云，`3.91+`支持腾讯云，`3.98+`支持支付宝小程序云
+- `HBuilderX 3.91+` 支持clientDB
+- `HBuilderX 3.99+` 支持pages.json中的uniIdRouter
+- `HBuilderX 4.71+` 支持安全网络
+
+<!-- UTSUNICLOUDAPIJSON.uniCloud_props.description -->
+
+<!-- UTSUNICLOUDAPIJSON.uniCloud_props.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.uniCloud_props.param -->
+
+<!-- UTSUNICLOUDAPIJSON.uniCloud_props.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.uniCloud_props.tutorial -->

package/data/uni-app-x-docs/api/unicloud/database.md

@@ -0,0 +1,27 @@
+## databaseForJQL() @databaseforjql
+
+uniCloud.databaseForJQL()是客户端访问云数据库的API，即[clientDB](https://doc.dcloud.net.cn/uniCloud/clientdb.html)。
+
+VDOM模式安卓平台有如下限制：
+
+- 暂不支持泛型传递
+- 暂不支持getOne
+- 暂不支持调用`db.command.aggregate`
+- db.command.xxx不支持链式调用，如`db.command.lte(1726934400000).and(db.command.gte(1726848000000))`需改为`db.command.and([db.command.lte(1726934400000),db.command.gte(1726848000000)])`
+
+**和uni-app项目的差异**
+
+- uni-app x项目内不再支持uniCloud.database()方法，仅支持uniCloud.databaseForJQL()。
+- 不再支持action云函数，因为安全问题已经不再推荐使用action云函数。开发者应改用[数据库触发器](https://doc.dcloud.net.cn/uniCloud/jql-schema-ext.html)来实现相关功能。
+
+<!-- UTSUNICLOUDAPIJSON.databaseForJQL.description -->
+
+<!-- UTSUNICLOUDAPIJSON.databaseForJQL.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.databaseForJQL.param -->
+
+<!-- UTSUNICLOUDAPIJSON.databaseForJQL.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.databaseForJQL.tutorial -->
+
+<!-- UTSUNICLOUDAPIJSON.unicloud-database.example -->

package/data/uni-app-x-docs/api/unicloud/function.md

@@ -0,0 +1,58 @@
+## callFunction(options) @callfunction
+
+> 4.13版本起安卓端使用`UniCloudCallFunctionResult`必须传入泛型，比如`UniCloudCallFunctionResult<UTSJSONObject>`，其中泛型类型为其result属性的类型
+
+<!-- UTSUNICLOUDAPIJSON.callFunction.description -->
+
+<!-- UTSUNICLOUDAPIJSON.callFunction.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.callFunction.param -->
+
+<!-- UTSUNICLOUDAPIJSON.callFunction.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.callFunction.tutorial -->
+
+<!-- UTSUNICLOUDAPIJSON.unicloud-call-function.example -->
+
+### 调用云函数时传入泛型
+
+> 4.13版本起支持，仅安卓端会构造对应的泛型的实例，web端和iOS端泛型仅作为类型使用。
+
+用法：`uniCloud.callFunction<泛型类型>({name: 'xxx', data: {}} as UniCloudCallFunctionOptions)`
+
+在不传泛型时callFunction返回的类型为`Promise<UniCloudCallFunctionResult<UTSJSONObject>>`，传入泛型后callFunction返回的类型为`Promise<UniCloudCallFunctionResult<泛型类型>>`
+
+**代码示例**
+
+```ts
+// 云函数fn代码
+'use strict';
+exports.main = async (event, context) => {
+  return {
+    errCode: 0,
+    errMsg: '',
+    detail: 'call function detail'
+  };
+};
+```
+
+```ts
+// 客户端代码
+type CallFunctionResult = {
+  errCode : number,
+  errMsg : string,
+  detail : string
+}
+uniCloud.callFunction<CallFunctionResult>(
+  {
+    name: 'fn',
+    data: { a: 1 } as UTSJSONObject,
+  } as UniCloudCallFunctionOptions
+).then(function (res) {
+  const result = res.result // result的类型为CallFunctionResult
+  const detail = result.detail // 可直接使用.detail访问
+  console.log(detail)
+}).catch(function (err : any | null) {
+  console.error(err)
+})
+```

package/data/uni-app-x-docs/api/unicloud/object.md

@@ -0,0 +1,75 @@
+## importObject(objectName, options?) @importobject
+
+<!-- UTSUNICLOUDAPIJSON.importObject.description -->
+
+<!-- UTSUNICLOUDAPIJSON.importObject.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.importObject.param -->
+
+<!-- UTSUNICLOUDAPIJSON.importObject.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.importObject.tutorial -->
+
+### uni-app x内使用云对象的特殊说明@strictly-typed-object
+
+由于强类型语言的限制，uni-app-x在编译时需要读取本地云对象导出的方法列表生成客户端对象。
+- 请确保调用的云对象在本地包含导出的方法。
+- 请确保本地工程的云对象的方法是正确的。
+- 如由于云函数加密等因素导致`index.obj.js`无法被正确解析，请在云对象目录创建`index.obj.d.ts`声明云对象内包含的方法。`index.obj.d.ts`示例代码如下：
+
+```ts
+// index.obj.d.ts
+type AnyFunction = (...args: any[]) => any;
+
+declare const add: AnyFunction
+declare const update: AnyFunction
+declare const deleteRecord: AnyFunction
+
+export { // 上面的写法可以自己调整，仅需保证export内包含所有方法即可
+  add,
+  update
+  deleteRecord as remove
+}
+```
+
+<!-- UTSUNICLOUDAPIJSON.unicloud-import-object.example -->
+
+### 调用云对象时传入泛型
+
+> 4.13版本起支持，仅安卓端会构造对应的泛型的实例，web端和iOS端泛型仅作为类型使用。
+
+用法：`obj.add<泛型类型>()`
+
+在不传泛型时云对象方法返回的类型为`Promise<UTSJSONObject>`，传入泛型后callFunction返回的类型为`Promise<泛型类型>`
+
+**代码示例**
+
+```ts
+// 云对象todo代码
+'use strict';
+module.exports = {
+  async add(title, content) {
+    return {
+      errCode: 0,
+      errMsg: '',
+      detail: `Todo added, title: ${title}, content: ${content}`
+    }
+  },
+}
+```
+
+```ts
+// 客户端代码
+const todo = uniCloud.importObject('todo')
+type CallObjectResult = {
+  errCode : number
+  errMsg : string
+  detail : string
+}
+todo.add<CallObjectResult>('todo title', 'todo content').then((res) => {
+  const detail = res.detail // res类型为CallObjectResult，可直接通过.detail访问其中detail属性
+  console.log(detail)
+}).catch((err : any | null) => {
+  console.error(err)
+})
+```

package/data/uni-app-x-docs/api/unicloud/sse-channel.md

@@ -0,0 +1,103 @@
+# 云函数请求中的中间状态通知通道
+
+> 新增于HBuilderX 4.71
+
+云函数在执行长时间任务时客户端无法获取云端任务执行状态，用户无法确定云函数是否还在正常执行，有些用户可能直接放弃等待刷新页面重新执行，从而导致浪费了更多的云函数资源。因此在此场景下需要一个云函数通知客户端发送执行状态或中间结果的通道。
+
+在常规web开发时通过云端向响应流多次写入数据的方式来实现，但是云函数不支持这种用法，因此我们基于uni-push实现了这个替代方案。
+
+使用此功能前需要先开通uni-push 2.0，参考文档：[uni-push 2.0](https://uniapp.dcloud.net.cn/unipush-v2.html)。uni-app-x项目使用SSEChannel需要自行配置uni-push模块到manifest.json内，且开发期间需要打包自定义基座进行测试。
+
+但是，在uni-app x中使用AI大模型流式返回数据时，持续保持云函数活跃会产生更多的费用。为此 uni-ai x，支持了云端返回临时token，由客户端直连LLM。除了节省费用，uni-ai x还提供了完整的客户端开源代码。[详见](https://ext.dcloud.net.cn/plugin?name=uni-ai-x)
+
+## 客户端api
+
+### SSEChannel(options) @ssechannel
+
+<!-- UTSUNICLOUDAPIJSON.SSEChannel.description -->
+
+<!-- UTSUNICLOUDAPIJSON.SSEChannel.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.SSEChannel.param -->
+
+<!-- UTSUNICLOUDAPIJSON.SSEChannel.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.SSEChannel.tutorial -->
+
+
+### 客户端代码示例
+
+```javascript
+async function receiveMessage() {
+  const sseChannel = new uniCloud.SSEChannel()
+  sseChannel.on('message', (message?: any | null) => {
+    console.log('message: ' + (message as string)) // message可能是任意类型，需要自行as为实际类型再使用
+  })
+  sseChannel.on('end', (message?: any | null) => {
+    console.log('end: ' + message) // message可能是任意类型，需要自行as为实际类型再使用。此处在云端end事件返回了null。目标语言是js时可能会返回undefined
+  })
+  sseChannel.on('open', () => {
+    console.log('sseChannel open')
+  })
+  sseChannel.on('close', () => {
+    console.log('sseChannel close')
+  })
+  sseChannel.on('error', (error: UniCloudError) => {
+    console.log('sseChannel error: ' + error.message)
+  })
+  await sseChannel.open() // 必须await通道开启，才可以将sseChannel传入云函数
+  const res = await uniCloud.callFunction({
+    name: 'sse',
+    data: {
+      sseChannel
+    }
+  })
+  console.log(res)
+}
+```
+
+## 云函数api
+
+### 反序列化消息通道@cloud-deserialize-channel
+
+将客户端传入的sseChannel反序列化为SSEChannel对象，用于发送消息。
+
+```javascript
+uniCloud.deserializeSSEChannel(sseChannelObj: string): SSEChannel
+```
+
+### sseChannel.write
+
+向客户端发送消息。
+
+```javascript
+sseChannel.write(message: any): Promise<void>
+```
+
+### sseChannel.end
+
+结束消息通道。
+
+```javascript
+sseChannel.end(message: any): Promise<void>
+```
+
+### 云函数代码示例
+
+```javascript
+'use strict';
+exports.main = async (event, context) => {
+  const sseChannelObj = event.sseChannel
+  const sseChannel = uniCloud.deserializeSSEChannel(sseChannelObj)
+  return new Promise(async (resolve, reject) => {
+    await sseChannel.write('message1')
+    await sseChannel.write('message2')
+    setTimeout(async () => {
+      await sseChannel.end()
+      resolve({
+        errCode: 0
+      })
+    }, 300)
+  })
+};
+```

package/data/uni-app-x-docs/api/unicloud/storage.md

@@ -0,0 +1,46 @@
+## uploadFile(options) @uploadfile
+
+<!-- UTSUNICLOUDAPIJSON.uploadFile.description -->
+
+<!-- UTSUNICLOUDAPIJSON.uploadFile.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.uploadFile.param -->
+
+<!-- UTSUNICLOUDAPIJSON.uploadFile.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.uploadFile.tutorial -->
+
+<!-- UTSUNICLOUDAPIJSON.uploadFile.example -->
+
+## chooseAndUploadFile(options) @chooseanduploadfile
+
+<!-- UTSUNICLOUDAPIJSON.chooseAndUploadFile.description -->
+
+<!-- UTSUNICLOUDAPIJSON.chooseAndUploadFile.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.chooseAndUploadFile.param -->
+
+<!-- UTSUNICLOUDAPIJSON.chooseAndUploadFile.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.chooseAndUploadFile.tutorial -->
+
+<!-- UTSUNICLOUDAPIJSON.chooseAndUploadFile.example -->
+
+**注意**
+
+- 4.18之前uni-app-x在app端仅支持选择图片，即type参数仅能设为`image`。
+- 4.18及之后的版本uni-app-x在app端仅支持选择图片、视频，即type参数仅能设为`image`、`video`。
+
+## getTempFileURL(options) @gettempfileurl
+
+<!-- UTSUNICLOUDAPIJSON.getTempFileURL.description -->
+
+<!-- UTSUNICLOUDAPIJSON.getTempFileURL.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.getTempFileURL.param -->
+
+<!-- UTSUNICLOUDAPIJSON.getTempFileURL.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.getTempFileURL.tutorial -->
+
+<!-- UTSUNICLOUDAPIJSON.unicloud-file-api.example -->

package/data/uni-app-x-docs/api/unicloud/utils.md

@@ -0,0 +1,71 @@
+## onResponse(callback) @onresponse
+
+<!-- UTSUNICLOUDAPIJSON.onResponse.description -->
+
+<!-- UTSUNICLOUDAPIJSON.onResponse.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.onResponse.param -->
+
+<!-- UTSUNICLOUDAPIJSON.onResponse.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.onResponse.tutorial -->
+
+## offResponse(callback) @offresponse
+
+<!-- UTSUNICLOUDAPIJSON.offResponse.description -->
+
+<!-- UTSUNICLOUDAPIJSON.offResponse.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.offResponse.param -->
+
+<!-- UTSUNICLOUDAPIJSON.offResponse.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.offResponse.tutorial -->
+
+## onRefreshToken(callback) @onrefreshtoken
+
+<!-- UTSUNICLOUDAPIJSON.onRefreshToken.description -->
+
+<!-- UTSUNICLOUDAPIJSON.onRefreshToken.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.onRefreshToken.param -->
+
+<!-- UTSUNICLOUDAPIJSON.onRefreshToken.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.onRefreshToken.tutorial -->
+
+## offRefreshToken(callback) @offrefreshtoken
+
+<!-- UTSUNICLOUDAPIJSON.offRefreshToken.description -->
+
+<!-- UTSUNICLOUDAPIJSON.offRefreshToken.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.offRefreshToken.param -->
+
+<!-- UTSUNICLOUDAPIJSON.offRefreshToken.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.offRefreshToken.tutorial -->
+
+## getCurrentUserInfo() @getcurrentuserinfo
+
+<!-- UTSUNICLOUDAPIJSON.getCurrentUserInfo.description -->
+
+<!-- UTSUNICLOUDAPIJSON.getCurrentUserInfo.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.getCurrentUserInfo.param -->
+
+<!-- UTSUNICLOUDAPIJSON.getCurrentUserInfo.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.getCurrentUserInfo.tutorial -->
+
+## connectWebSocket() @connectWebSocket
+
+<!-- UTSUNICLOUDAPIJSON.connectWebSocket.description -->
+
+<!-- UTSUNICLOUDAPIJSON.connectWebSocket.compatibility -->
+
+<!-- UTSUNICLOUDAPIJSON.connectWebSocket.param -->
+
+<!-- UTSUNICLOUDAPIJSON.connectWebSocket.returnValue -->
+
+<!-- UTSUNICLOUDAPIJSON.connectWebSocket.tutorial -->