@quicktvui/ai 1.0.0

package/rules/.docs/zh-CN/module/broadcast.md

@@ -0,0 +1,77 @@
+---
+title: 广播模块
+lang: zh-CN
+---
+
+# 广播模块
+
+使用此模块可以调用`android`系统中的广播服务。
+
+你可以在 [Android documentation](https://developer.android.google.cn/develop/background-work/background-tasks/broadcasts?hl=zh-cn)
+上查看更详细的介绍。
+
+:::demo ## 基础用法
+
+module/broadcast/es-basic
+
+:::
+
+:::demo ## qt.broadcast 用法 ^(alpha)
+
+module/broadcast/qt-basic
+
+:::
+
+
+## API
+
+### DataStructure
+
+#### ESIntentFilter
+
+`IntentFilter`
+
+| Name          | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| action         | action            | ^[Array<string>]           |   -    |
+| scheme         | scheme            | ^[Array<string>]           |   -    |
+| category       | category            | ^[Array<string>]           |   -    |
+| type           | type            | ^[Array<string>]           |   -    |
+| authority      | authority            | ^[Array<ESIntentDataAuthority>]|   -    |
+| path           | path            | ^[Array<ESIntentDataPath>] |   -    |
+| schemeSpecificPart|schemeSpecificPart| ^[Array<ESIntentDataSchemeSpecificPart>]|   -    |
+
+#### ESIntentDataAuthority
+
+`ESIntentDataAuthority`
+
+| Name          | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| host           | host            | ^[string]                    |   -    |
+| port           | port            | ^[string]                    |   -    |
+
+#### ESIntentDataPath
+
+`ESIntentDataPath`
+
+| Name          | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| path           | path            | ^[string]                    |   -    |
+| type           | type            | ^[number]                    |   -    |
+
+#### ESIntentDataSchemeSpecificPart
+
+`ESIntentDataSchemeSpecificPart`
+
+| Name          | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| ssp            | ssp            | ^[string]                     |   -    |
+| type           | type            | ^[number]                    |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| registerReceiver             | 该方法注册广告接收者          | ^[Function]`registerReceiver(receiver: ESBroadcastReceiver, interFilter: ESIntentFilter) => Promise<number>`   |
+| unregisterReceiver             | 该方法取消注册广告接收者          | ^[Function]`unregisterReceiver(receiver: ESBroadcastReceiver, interFilter: ESIntentFilter) => Promise<number>`   |
+| sendBroadcast             | 该方法发送广播          | ^[Function]`sendBroadcast(paramsArray: Array<Array<any>>) => Promise<boolean>`

package/rules/.docs/zh-CN/module/content-provider.md

@@ -0,0 +1,64 @@
+---
+title: 内容提供者模块
+lang: zh-CN
+---
+
+# 内容提供者模块
+
+使用此模块可以调用`android`系统中的内容提供者服务。
+
+你可以在 [Android documentation](https://developer.android.google.cn/guide/topics/providers/content-provider-basics?hl=zh-cn)
+上查看更详细的介绍。
+
+:::demo ## 基础用法
+
+module/content-provider/es-basic
+
+:::
+
+:::demo ## qt.provider 用法 ^(alpha)
+
+module/content-provider/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESContentValues
+
+内容信息
+
+| Name          | Description        | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| `string`      | `string`类型的key, `value`类型为`any` | ^[any]       |   -    |
+
+#### ESContentProviderInfo
+
+内容信息
+
+| Name          | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| result         | 获取内容结果        | ^[ESContentProviderResult]    |   -    |
+| message        | 消息              | ^[string]                     |   -    |
+| data           | 内容数据           | ^[Array<ESContentValues>]     |   -    |
+
+#### ESContentProviderResult
+
+获取内容结果
+
+| Name          | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| ES_CONTENT_PROVIDER_RESULT_SUCCESS | 获取内容结果成功 | ^[ESContentProviderResult]    |   -    |
+| ES_CONTENT_PROVIDER_RESULT_ERROR   | 获取内容结果失败 | ^[ESContentProviderResult]    |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| insert             | 该方法插入信息          | ^[Function]`insert(uri: string, data: ESContentValues) => Promise<ESContentProviderInfo>`   |
+| query             | 该方法查询信息          | ^[Function]`query(uri: string, projection?: Array<string>, selection?: string, selectionArgs?: Array<string>, sortOrder?: string, data?: ESContentValues) => Promise<ESContentProviderInfo>`   |
+| update             | 该方法更新信息          | ^[Function]`update(uri: string, data: ESContentValues, where: string, selectionArgs: Array<string>) => Promise<ESContentProviderInfo>`   |
+| deleteData             | 该方法删除信息          | ^[Function]`deleteData(uri: string, where: string, selectionArgs: Array<string>) => Promise<ESContentProviderInfo>`   |
+

package/rules/.docs/zh-CN/module/develop.md

@@ -0,0 +1,45 @@
+---
+title: 开发信息模块
+lang: zh-CN
+---
+
+# 开发信息模块
+
+此模块用于获取快应用运行容器的相关信息。
+
+:::demo ## 基础用法
+
+module/develop/es-basic
+
+:::
+
+:::demo ## qt.develop 用法 ^(alpha)
+
+module/develop/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESDevelopInfo
+
+开发者信息
+
+| Name          | Description        | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| versionCode    | 版本号             | ^[number]                    |   -    |
+| versionName    | 版本名称            | ^[string]                    |   -    |
+| packageName    | 包名               | ^[string]                    |   -    |
+| channel        | 渠道               | ^[string]                    |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| getDevelop             | 该方法获取开发者信息          | ^[Function]`getDevelop() => ESDevelopInfo`   |
+| getPackageName             | 该方法获取包名          | ^[Function]`getPackageName() => string`   |
+| getVersionName             | 该方法获取版本名称          | ^[Function]`getVersionName() => string`   |
+| getVersionCode             | 该方法获取版本号          | ^[Function]`getVersionCode() => string`   |
+| getChannel             | 该方法获取版本号          | ^[Function]`getChannel() => string`   |

package/rules/.docs/zh-CN/module/device.md

@@ -0,0 +1,108 @@
+---
+title: 设备信息模块
+lang: zh-CN
+---
+
+# 设备信息模块
+
+此模块用于获取快应用运行设备的信息。
+
+:::demo ## 基础用法
+
+module/device/es-basic
+
+:::
+
+:::demo ## qt.device 用法 ^(alpha)
+
+module/device/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESDeviceInfo
+
+设备信息
+
+| Name                         | Description                           | Type                        |   Default   |
+| --------------------------- | ------------------------------| ----------------------------|---------|
+| ethMac                      | 有线网络MAC地址                 | ^[string]                     |   -    |
+| wifiMac                     | 无线网络MAC地址                 | ^[string]                    |   -    |
+| ipAddress                   | 网络IP地址                     | ^[string]                    |   -    |
+| totalMemory                 | 设备总内存                     | ^[number]                    |   -    |
+| availableMemory             | 设备可用内存                    | ^[number]                    |   -    |
+| screenWidth                 | 屏幕宽度                       | ^[number]                    |   -    |
+| screenHeight                | 屏幕高度                       | ^[number]                    |   -    |
+| resolution                  | 屏幕分辨率                     | ^[string]                    |   -    |
+| density                     | 屏幕像素密度                    | ^[number]                    |   -    |
+| densityDpi                  | 屏幕物理密度                    | ^[number]                    |   -    |
+| scaledDensity               | 屏幕字体缩放比例                 | ^[number]                    |   -    |
+| buildModel                  | buildModel                    | ^[string]                    |   -    |
+| buildBrand                  | buildBrand                    | ^[string]                    |   -    |
+| buildBoard                  | buildBoard                    | ^[string]                    |   -    |
+| buildDevice                 | buildDevice                   | ^[string]                    |   -    |
+| buildProduct                | buildProduct                  | ^[string]                    |   -    |
+| buildHardware               | buildHardware                 | ^[string]                    |   -    |
+| buildManufacturer           | buildManufacturer             | ^[string]                    |   -    |
+| buildSerial                 | buildSerial                   | ^[string]                    |   -    |
+| buildTags                   | buildTags                     | ^[string]                    |   -    |
+| buildId                     | buildId                       | ^[string]                    |   -    |
+| buildTime                   | buildTime                     | ^[number]                    |   -    |
+| buildType                   | buildType                     | ^[string]                    |   -    |
+| buildUser                   | buildUser                     | ^[string]                    |   -    |
+| buildBootloader             | buildBootloader               | ^[string]                    |   -    |
+| buildDisplay                | buildDisplay                  | ^[string]                    |   -    |
+| buildFingerPrint            | buildFingerPrint              | ^[string]                    |   -    |
+| buildVersionRelease         | buildVersionRelease           | ^[string]                    |   -    |
+| buildVersionIncremental     | buildVersionIncremental       | ^[string]                    |   -    |
+| buildVersionBaseOS          | buildVersionBaseOS            | ^[string]                    |   -    |
+| buildVersionCodeName        | buildVersionCodeName          | ^[string]                    |   -    |
+| buildVersionSecurityPatch   | buildVersionSecurityPatch     | ^[string]                   |   -    |
+| buildVersionPreviewSDKInt   | buildVersionPreviewSDKInt     | ^[number]                    |   -    |
+| buildVersionSDKInt          | buildVersionSDKInt            | ^[number]                    |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| getDevice             | 该方法用于获取安卓设备信息          | ^[Function]`getDevice() => ESDeviceInfo`   |
+| getScreenWidth        | 该方法用于获取安卓设备的屏幕宽度     | ^[Function]`getScreenWidth() => number`   |
+| getScreenHeight        | 该方法用于获取安卓设备的屏幕高度     | ^[Function]`getScreenHeight() => number`   |
+| getAndroidAPILevel        | 该方法用于获取安卓设备的API Level     | ^[Function]`getAndroidAPILevel() => string \| null`   |
+| getDeviceEthMac        | 该方法用于获取安卓设备有线MAC地址     | ^[Function]`getDeviceEthMac() => string`   |
+| getDeviceWifiMac        | 该方法用于获取安卓设备无线MAC地址     | ^[Function]`getDeviceWifiMac() => string`   |
+| getDeviceTotalMemory        | 该方法用于获取安卓设备总内存     | ^[Function]`getDeviceTotalMemory() => number`   |
+| getDeviceAvailMemory        | 该方法用于获取安卓设备可用内存     | ^[Function]`getDeviceAvailMemory() => number`   |
+| getScreenWidth        | 该方法用于获取安卓设备屏幕宽度     | ^[Function]`getScreenWidth() => number`   |
+| getScreenHeight        | 该方法用于获取安卓设备屏幕高度     | ^[Function]`getScreenHeight() => number`   |
+| getResolution        | 该方法用于获取安卓设备屏幕分辨率     | ^[Function]`getResolution() => string`   |
+| getDensity        | 该方法用于获取安卓设备屏幕像素密度     | ^[Function]`getDensity() => number`   |
+| getDensityDpi        | 该方法用于获取安卓设备屏幕物理密度     | ^[Function]`getDensityDpi() => number`   |
+| getScaledDensity        | 该方法用于获取安卓设备屏幕字体缩放比例     | ^[Function]`getScaledDensity() => number`   |
+| getIPAddress        | 该方法用于获取安卓设备IP地址     | ^[Function]`getIPAddress() => string`   |
+| getBuildModel        | 该方法用于获取安卓设备BuildModel     | ^[Function]`getBuildModel() => string`   |
+| getBuildBrand        | 该方法用于获取安卓设备BuildBrand     | ^[Function]`getBuildBrand() => string`   |
+| getBuildBoard        | 该方法用于获取安卓设备BuildBoard     | ^[Function]`getBuildBoard() => string`   |
+| getBuildDevice        | 该方法用于获取安卓设备BuildDevice     | ^[Function]`getBuildDevice() => string`   |
+| getBuildProduct        | 该方法用于获取安卓设备BuildProduct     | ^[Function]`getBuildProduct() => string`   |
+| getBuildHardware        | 该方法用于获取安卓设备BuildHardware     | ^[Function]`getBuildHardware() => string`   |
+| getBuildManufacturer        | 该方法用于获取安卓设备BuildManufacturer     | ^[Function]`getBuildManufacturer() => string`   |
+| getBuildSerial        | 该方法用于获取安卓设备BuildSerial     | ^[Function]`getBuildSerial() => string`   |
+| getBuildTags        | 该方法用于获取安卓设备BuildTags     | ^[Function]`getBuildTags() => string`   |
+| getBuildId        | 该方法用于获取安卓设备BuildId     | ^[Function]`getBuildId() => string`   |
+| getBuildTime        | 该方法用于获取安卓设备BuildTime     | ^[Function]`getBuildTime() => number`   |
+| getBuildType        | 该方法用于获取安卓设备BuildType     | ^[Function]`getBuildType() => string`   |
+| getBuildUser        | 该方法用于获取安卓设备BuildUser     | ^[Function]`getBuildUser() => string`   |
+| getBuildBootloader        | 该方法用于获取安卓设备BuildBootloader     | ^[Function]`getBuildBootloader() => string`   |
+| getBuildDisplay        | 该方法用于获取安卓设备BuildDisplay     | ^[Function]`getBuildDisplay() => string`   |
+| getBuildFingerPrint        | 该方法用于获取安卓设备BuildFingerPrint     | ^[Function]`getBuildFingerPrint() => string`   |
+| getBuildVersionIncremental        | 该方法用于获取安卓设备BuildVersionIncremental     | ^[Function]`getBuildVersionIncremental() => string`   |
+| getBuildVersionBaseOS        | 该方法用于获取安卓设备BuildVersionBaseOS     | ^[Function]`getBuildVersionBaseOS() => string`   |
+| getBuildVersionCodeName        | 该方法用于获取安卓设备BuildVersionCodeName     | ^[Function]`getBuildVersionCodeName() => string`   |
+| getBuildVersionSecurityPatch        | 该方法用于获取安卓设备BuildVersionSecurityPatch     | ^[Function]`getBuildVersionSecurityPatch() => string`   |
+| getBuildVersionPreviewSDKInt        | 该方法用于获取安卓设备BuildVersionPreviewSDKInt     | ^[Function]`getBuildVersionPreviewSDKInt() => number`   |
+| getBuildVersionSDKInt        | 该方法用于获取安卓设备BuildVersionSDKInt     | ^[Function]`getBuildVersionSDKInt() => number`   |
+| getBuildVersionRelease        | 该方法用于获取安卓设备BuildVersionRelease     | ^[Function]`getBuildVersionRelease() => string`   |

package/rules/.docs/zh-CN/module/display.md

@@ -0,0 +1,33 @@
+---
+title: Display
+lang: zh-CN
+---
+
+# 显示模块
+
+使用此模块可以获取屏幕的宽高，根据尺寸换算适配的尺寸。
+
+:::demo ## 基础用法
+
+module/display/es-basic
+
+:::
+
+:::demo ## qt.display 用法 ^(alpha)
+
+module/display/qt-basic
+
+:::
+
+## API
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| getDisplayScale                  | 获取尺寸变形比例               | ^[Function]`() => number`   |
+| getDisplaySize                   | 获取屏幕适配的尺寸             | ^[Function]`(size: number) => number`   |
+| getScreenWidth                   | 获取屏幕宽度                  | ^[Function]`() => number`   |
+| getScreenHeight                  | 获取屏幕高度                  | ^[Function]`() => number`   |
+
+

package/rules/.docs/zh-CN/module/download.md

@@ -0,0 +1,97 @@
+---
+title: 文件下载模块
+lang: zh-CN
+---
+
+# 文件下载模块
+
+::: warning 注意：文件只能下载到快应用自身的文件目录
+
+* 快应用自身的文件目录对应的`android`系统路径为：`/data/data/APK包名/app_rpk/apps/快应用包名/files`
+* 默认下载目录为快应用自身的文件目录下的`download`目录：`/data/data/APK包名/app_rpk/apps/快应用包名/files/download`
+* 示例中初始化下载目录方法：`initDownload()`使用默认下载目录：`/data/data/APK包名/app_rpk/apps/快应用包名/files/download`
+* 示例中初始化下载目录方法：`initDownloadPath('/video', 1000)`，自定义了下载目录为：`快应用自身的文件目录/video`
+  目录。既：`/data/data/APK包名/app_rpk/apps/快应用包名/files/video`
+
+:::
+
+:::demo ## 基础用法
+
+module/download/es-basic
+
+:::
+
+:::demo ##  qt.download 用法 ^(alpha)
+
+module/download/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESDownloadInfo
+
+下载信息
+
+| Name          | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| id             | 下载的id           | ^[number]                      |   -    |
+| fileName       | 文件名             | ^[string]                    |   -    |
+| fileMD5        | 文件MD5值          | ^[string]                    |   -    |
+| fileUrl        | 文件下载地址        | ^[string]                    |   -    |
+| fileType       | 文件类型           | ^[string]                    |   -    |
+| fileLength     | 文件长度            | ^[number]                    |   -    |
+| downloadLength | 文件下载的长度       | ^[number]                    |   -    |
+| params         | 下载文件的参数       | ^[ESDownloadParams]          |   -    |
+| filePath       | 文件存储目录         | ^[string]                    |   -    |
+
+#### ESDownloadParams
+
+下载请求参数
+
+| Name          | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| header         | 下载请求header参数  | ^[number]                     |   -    |
+
+#### ESDownloadStatus
+
+下载状态
+
+| Name          | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| state          | 下载状态            | ^[ESDownloadState]           |   -    |
+| download       | 下载信息            | ^[ESDownloadInfo]             |   -    |
+| code           | 下载状态码          | ^[number]                     |   -    |
+| message        | 下载信息            | ^[string]                     |   -    |
+| downloadSize   | 下载文件长度         | ^[number]                     |   -    |
+| totalSize      | 下载文件总长度       | ^[number]                     |   -    |
+
+#### ESDownloadState
+
+下载状态值
+
+| Name          | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| ES_DOWNLOAD_STATE_INIT             | 下载初始化状态                 | ^[number]           |   0    |
+| ES_DOWNLOAD_STATE_START            | 下载开始状态                   | ^[number]             |   1    |
+| ES_DOWNLOAD_STATE_PROGRESS         | 下载进度状态                   | ^[number]                     |   2    |
+| ES_DOWNLOAD_STATE_STOP             | 下载停止状态                   | ^[number]`                     |   3    |
+| ES_DOWNLOAD_STATE_CANCEL           | 下载取消状态                   | ^[number]                     |   4    |
+| ES_DOWNLOAD_STATE_SUCCESS          | 下载成功状态                   | ^[number]                     |   5    |
+| ES_DOWNLOAD_STATE_ERROR            | 下载错误状态                   | ^[number]                     |   6    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| initDownload             | 该方法初始化默认下载设置          | ^[Function]`initDownload() => void`   |
+| initDownloadPath             | 该方法初始化下载设置          | ^[Function]`initDownloadPath(downloadCacheDir: string, interpolator: number) => void`   |
+| download             | 该方法用于下载          | ^[Function]`download(download: ESDownloadInfo) => void`   |
+| start             | 该方法用于开始下载          | ^[Function]`start(download: ESDownloadInfo) => void`   |
+| stop             | 该方法用于停止下载          | ^[Function]`stop(download: ESDownloadInfo) => void`   |
+| cancel             | 该方法用于取消下载          | ^[Function]`cancel(download: ESDownloadInfo) => void`   |
+| release             | 该方法用于回收资源          | ^[Function]`release() => void`   |
+| addListener             | 该方法用于添加监听          | ^[Function]`addListener(download: ESDownloadInfo, listener: ESDownloadListener) => void`   |
+| removeListener             | 该方法用于删除监听          | ^[Function]`removeListener(listener: ESDownloadListener) => void`   |

package/rules/.docs/zh-CN/module/es.md

@@ -0,0 +1,74 @@
+---
+title: ES
+lang: zh-CN
+---
+
+# ES模块
+
+此模块用来获取运行容器`SDK`相关的信息。
+
+::: tip 快应用的文件存储路径（ES App File Path）对应的 android 系统路径为：/data/data/APK包名/app_rpk/apps/快应用包名/files
+
+以 `Runtime` apk 和「八段锦」（`es.com.baduanjin.tv`） 快应用为例，对应的`android`
+路径为: `/data/data/com.extscreen.runtime/app_rpk/apps/es.com.baduanjin.tv/files/`
+
+:::
+
+::: tip 快应用的运行路径（ES App Runtime Path）对应的 android 系统路径为：/data/data/APK包名/app_rpk/apps/快应用包名/版本号/android
+
+以 `Runtime` apk 和 `2.2.2203`版本的「八段锦」（`es.com.baduanjin.tv`） 快应用为例，对应的`android`
+路径为: `/data/data/com.extscreen.runtime/app_rpk/apps/es.com.baduanjin.tv/2.2.2203/android`
+
+:::
+
+:::demo ## 基础用法
+
+module/es/es-basic
+
+:::
+
+:::demo ## qt.es 用法 ^(alpha)
+
+module/es/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESSDKInfo
+
+SDK信息
+
+| Name          | Description                | Type                          |   Default   |
+| ------------------ | ------------------| ----------------------------|---------|
+| cid                | sdk唯一标识符       | ^[string]                    |   -    |
+| IPAddress          | IP地址            | ^[string]                    |   -    |
+| deviceName         | 设备名称           | ^[string]                     |   -    |
+| versionCode        | 版本号             | ^[number]                     |   -    |
+| versionName        | 版本名称           | ^[string]                     |   -    |
+| packageName        | 包名              | ^[string]                     |   -    |
+| eskit_ver_code     | 版本号            | ^[number]                     |   -    |
+| eskit_ver_name     | 版本名称           | ^[string]                     |   -    |
+| miniProgramPath    | 快应用文件路径      | ^[string]                     |   -    |
+| runtimePath        | 快应用路径          | ^[string]                     |   -    |
+| schemes            | 支持的协议          | ^[string]                     |   -    |
+| sdkChannel         | 渠道               | ^[string]                     |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| getESSDKInfo                     | 该方法获取ES SDK的信息          | ^[Function]`() => ESSDKInfo`   |
+| getESId                          | 该方法获取ES SDK的唯一标识符     | ^[Function]`() => string`   |
+| getESName                        | 该方法获取ES SDK的名称          | ^[Function]`() => string`   |
+| getESSDKVersionCode              | 该方法获取ES SDK版本号          | ^[Function]`() => number`   |
+| getESSDKVersionName              | 该方法获取ES SDK版本名称         | ^[Function]`() => string`   |
+| getESPackageName                 | 该方法获取ES SDK包名             | ^[Function]`() => string`   |
+| getESAppFilePath                 | 该方法获取快应用文件存储路径        | ^[Function]`() => string`   |
+| getESAppRuntimePath              | 该方法获取快应用rpk存储运行路径     | ^[Function]`() => string`   |
+| getSupportSchemes                | 该方法获取快应用支持的协议列表     | ^[Function]`() => Array<string>`   |
+| isModuleRegistered               | 该方法判断模块是否注册过          | ^[Function]`(className: string) => Promise<boolean>`   |
+| isComponentRegistered            | 该方法判断组件是否注册过          | ^[Function]`(className: string) => Promise<boolean>`   |
+

package/rules/.docs/zh-CN/module/event-bus.md

@@ -0,0 +1,68 @@
+---
+title: 事件总线模块
+lang: zh-CN
+---
+
+# 事件总线模块
+
+此模块用于快应用内部自身事件通信。
+
+:::demo ## 发送事件
+
+module/event-bus/es-emit
+
+:::
+
+:::demo ## 监听事件
+
+module/event-bus/es-on
+
+:::
+
+:::demo ## 取消监听事件
+
+module/event-bus/es-off
+
+:::
+
+:::demo ## 监听一次事件
+
+module/event-bus/es-once
+
+:::
+
+
+:::demo ## qt.eventBus 发送事件 ^(alpha)
+
+module/event-bus/qt-emit
+
+:::
+
+:::demo ## qt.eventBus 监听事件 ^(alpha)
+
+module/event-bus/qt-on
+
+:::
+
+:::demo ## qt.eventBus 取消监听事件 ^(alpha)
+
+module/event-bus/qt-off
+
+:::
+
+:::demo ## qt.eventBus 监听一次事件 ^(alpha)
+
+module/event-bus/qt-once
+
+:::
+
+## API
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| on             | 该方法注册事件监听          | ^[Function]`on(event: string \| Array<string>, callback: ESEventBusCallback, context?: ESEventBusContext) => void`   |
+| once               | 该方法注册一次事件监听             | ^[Function]`once(event: string, callback: ESEventBusCallback, context?: ESEventBusContext) => void`   |
+| emit               | 该方法发送事件             | ^[Function]`emit(event: string, ...args: ESEventBusArg[]) => void`   |
+| off               | 该方法取消监听事件             | ^[Function]`off(event?: string \| Array<string>, callback?: ESEventBusCallback) => void`   |

package/rules/.docs/zh-CN/module/file.md

@@ -0,0 +1,62 @@
+---
+title: 文件模块
+lang: zh-CN
+---
+
+# 文件模块
+
+::: warning 注意：文件模块只能操作快应用自身的文件目录下的文件
+
+* 快应用自身的文件目录对应的`android`系统路径为：`/data/data/APK包名/app_rpk/apps/快应用包名/files`
+* 示例中初始化文件的方法：`newFile('/file_text.log')`对应`android`目录：`/data/data/APK包名/app_rpk/apps/快应用包名/files/file_text.log`文件。
+
+:::
+
+
+:::demo ## 基础用法
+
+module/file/es-basic
+
+:::
+
+## API
+
+### Exposes
+
+| Name                | Description                 | Type                                           |
+| ------------------- | --------------------------- | -----------------------------------------------|
+| newFile             | 该方法创建文件                 | ^[Function]`newFile(pathname: string) => Promise<number>`|
+| getFileId           | 该方法获取文件唯一标识符          | ^[Function]`getFileId() => number`|
+| getName           | 该方法获取文件名          | ^[Function]`getName() => Promise<string>`|
+| getParent           | 该方法获取文件父目录          | ^[Function]`getParent() => Promise<string>`|
+| getPath           | 该方法获取文件目录          | ^[Function]`getPath() => Promise<string>`|
+| isAbsolute           | 该方法获取抽象路径名是否是绝对路径 | ^[Function]`isAbsolute() => Promise<boolean>`|
+| getCanonicalPath     | 该方法获取文件规范化的绝对路径 | ^[Function]`getCanonicalPath() => Promise<string>`|
+| canRead     | 该方法获取文件是否可读 | ^[Function]`canRead() => Promise<boolean>`|
+| canWrite     | 该方法获取文件是否可写 | ^[Function]`canWrite() => Promise<boolean>`|
+| exists     | 该方法获取文件是否存在 | ^[Function]`exists() => Promise<boolean>`|
+| isDirectory     | 该方法获取文件是否是目录 | ^[Function]`isDirectory() => Promise<boolean>`|
+| isFile     | 该方法获取文件是否是文件 | ^[Function]`isFile() => Promise<boolean>`|
+| isHidden     | 该方法获取文件是否是隐藏文件 | ^[Function]`isHidden() => Promise<boolean>`|
+| lastModified     | 该方法获取文件最近修改日期 | ^[Function]`lastModified() => Promise<number>`|
+| length     | 该方法获取文件长度 | ^[Function]`length() => Promise<number>`|
+| createNewFile     | 该方法创建新文件 | ^[Function]`createNewFile() => Promise<boolean>`|
+| deleteOnExit     | 该方法判断文件是否存在，如果存在则删除 | ^[Function]`deleteOnExit() => Promise<boolean>`|
+| list     | 该方法获取子文件列表 | ^[Function]`list() => Promise<Array<string>>`|
+| mkdir     | 该方法创建文件夹 | ^[Function]`mkdir() => Promise<boolean>`|
+| mkdirs     | 该方法递归创建文件夹 | ^[Function]`mkdirs() => Promise<boolean>`|
+| setLastModified     | 该方法设置文件最后更改时间 | ^[Function]`setLastModified(time: number) => Promise<boolean>`|
+| getTotalSpace     | 该方法返回文件占用空间大小 | ^[Function]`getTotalSpace() => Promise<number>`|
+| getFreeSpace     | 该方法返回目录可用空间大小 | ^[Function]`getFreeSpace() => Promise<number>`|
+| getUsableSpace     | 该方法返回目录已使用空间大小 | ^[Function]`getUsableSpace() => Promise<number>`|
+| delete     | 该方法删除文件 | ^[Function]`delete() => Promise<boolean>`|
+| setReadOnly     | 该方法设置文件只读 | ^[Function]`setReadOnly() => Promise<boolean>`|
+| setWritableOwnerOnly     | 该方法设置文件拥有者只能写 | ^[Function]`setWritableOwnerOnly(writable: boolean, ownerOnly: boolean) => Promise<boolean>`|
+| setWritable     | 该方法设置文件是否可写 | ^[Function]`setWritable(writable: boolean) => Promise<boolean>`|
+| setReadableOwnerOnly     | 该方法设置文件拥有者只读 | ^[Function]`setReadableOwnerOnly(readable: boolean, ownerOnly: boolean) => Promise<boolean>`|
+| setReadable     | 该方法设置文件是否可读 | ^[Function]`setReadable(readable: boolean) => Promise<boolean>`|
+| setExecutableOwnerOnly     | 该方法设置文件拥有者可执行 | ^[Function]`setExecutableOwnerOnly(executable: boolean, ownerOnly: boolean) => Promise<boolean>`|
+| setExecutable     | 该方法设置文件是否可执行 | ^[Function]`setExecutable(executable: boolean) => Promise<boolean>`|
+| canExecute     | 该方法返回文件是否可执行 | ^[Function]`canExecute() => Promise<boolean>`|
+| renameTo     | 该方法重命名文件 | ^[Function]`renameTo(renameFileId: number) => Promise<boolean>`|
+| close     | 该方法关闭文件 | ^[Function]`close() => Promise<boolean>`|