@kbapp/js-bridge 1.0.14-alpha.0 → 1.0.15-alpha.0

package/docs/api/check-for-new-version.md

@@ -0,0 +1,38 @@
+# checkForNewVersion
+
+> 检测是否有新版本
+
+### checkForNewVersion
+
+> 检测是否有新版本可用, iOS 无论是否有最新版本都直接跳转到应用商店, 安卓如果有新版,则弹窗提示,没有的话 toast 提示无新版本
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明     |
+| ---------- | ----------------------------- | ---- | -------- |
+| `success`  | `() => void`                  | 否   | 成功回调 |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调 |
+| `complete` | `() => void`                  | 否   | 完成回调 |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { checkForNewVersion } from '@kbapp/js-bridge'
+
+checkForNewVersion({
+    success() {
+        console.log('检查成功')
+    },
+    fail(error) {
+        console.log('检查失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/close-web-view.md

@@ -0,0 +1,38 @@
+# closeWebView
+
+> 关闭当前 webview
+
+### closeWebView
+
+> 关闭当前 webview
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明     |
+| ---------- | ----------------------------- | ---- | -------- |
+| `success`  | `() => void`                  | 否   | 成功回调 |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调 |
+| `complete` | `() => void`                  | 否   | 完成回调 |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { closeWebView } from '@kbapp/js-bridge'
+
+closeWebView({
+    success() {
+        console.log('关闭成功')
+    },
+    fail(error) {
+        console.log('关闭失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/define-app-share-model.md

@@ -0,0 +1,75 @@
+# defineAppShareModel
+
+> 定义页面分享内容
+
+### defineAppShareModel
+
+> 定义 app 点击转发时候的分享卡片内容
+
+#### 请求参数 方式 1
+
+| 参数       | 类型                          | 必填 | 说明         |
+| ---------- | ----------------------------- | ---- | ------------ |
+| `title`    | `string`                      | 是   | 分享标题     |
+| `content`  | `string`                      | 否   | 分享内容     |
+| `imageUrl` | `string`                      | 是   | 分享图片 URL |
+| `url`      | `string`                      | 是   | 分享链接 URL |
+| `success`  | `() => void`                  | 否   | 成功回调     |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调     |
+| `complete` | `() => void`                  | 否   | 完成回调     |
+
+#### 请求参数 方式 2
+
+| 参数         | 类型                          | 必填 | 说明                                         |
+| ------------ | ----------------------------- | ---- | -------------------------------------------- |
+| `onShareApp` | `() => AppShareModel`         | 是   | 点击分享时触发的函数，返回分享模型（方式 2） |
+| `success`    | `() => void`                  | 否   | 成功回调                                     |
+| `fail`       | `(error: BridgeCode) => void` | 否   | 失败回调                                     |
+| `complete`   | `() => void`                  | 否   | 完成回调                                     |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { defineAppShareModel } from '@kbapp/js-bridge'
+
+// 方式1：直接提供分享模型
+defineAppShareModel({
+    title: '分享标题',
+    content: '分享内容',
+    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png',
+    url: 'http://www.kaiba315.com.cn/',
+    success() {
+        console.log('设置成功')
+    },
+    fail(error) {
+        console.log('设置失败', error)
+    },
+})
+
+// 方式2：提供分享模型函数（点击分享时动态生成分享内容）
+defineAppShareModel({
+    onShareApp() {
+        // 点击页面右上角或分享按钮时触发该回调，动态生成分享内容
+        return {
+            title: '动态生成的分享标题',
+            content: '动态生成的分享内容',
+            imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png',
+            url: 'http://www.kaiba315.com.cn/?t=' + Date.now(),
+        }
+    },
+    success() {
+        console.log('设置成功')
+    },
+    fail(error) {
+        console.log('设置失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/define-app-share-panel-state.md

@@ -0,0 +1,42 @@
+# defineAppSharePanelState
+
+> 定义分享面板控件布局
+
+### defineAppSharePanelState
+
+> 定义页面是否显示右上角分享菜单, 定义分享面板显示的相关状态
+
+#### 请求参数
+
+| 参数         | 类型                          | 必填 | 说明                                                                                          |
+| ------------ | ----------------------------- | ---- | --------------------------------------------------------------------------------------------- |
+| `showMenu`   | `boolean`                     | 是   | 是否显示右上角 ... 菜单                                                                       |
+| `panelStyle` | `0  1  2`                     | 否   | 显示分享面板布局, 0:正常显示. 1:只显示复制链接,浏览器打开相关. 2:只显示分享微信、QQ等. 默认 0 |
+| `success`    | `() => void`                  | 否   | 成功回调                                                                                      |
+| `fail`       | `(error: BridgeCode) => void` | 否   | 失败回调                                                                                      |
+| `complete`   | `() => void`                  | 否   | 完成回调                                                                                      |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { defineAppSharePanelState } from '@kbapp/js-bridge'
+
+defineAppSharePanelState({
+    showMenu: true,
+    panelStyle: 0,
+    success() {
+        console.log('设置成功')
+    },
+    fail(error) {
+        console.log('设置失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/define-bridge-callback.md

@@ -0,0 +1,44 @@
+# defineBridgeCallback
+
+> 定义桥接调用的回调函数
+
+### defineBridgeCallback
+
+> 注册供 Native 调用的桥接回调函数
+
+#### 请求参数
+
+| 参数       | 类型                                  | 必填 | 说明         |
+| ---------- | ------------------------------------- | ---- | ------------ |
+| `name`     | `string`                              | 是   | 任务名称     |
+| `handler`  | `(...params: any[]) => any`           | 是   | 回调函数     |
+| `success`  | `() => void`                          | 否   | 注册成功回调 |
+| `fail`     | `(error: BridgeCode) => void`         | 否   | 注册失败回调 |
+| `complete` | `() => void`                          | 否   | 完成回调     |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { defineBridgeCallback } from '@kbapp/js-bridge'
+
+defineBridgeCallback({
+    name: 'CommonShare',
+    handler(data, callback) {
+        callback({ type: 12, data: { title: '分享标题' } })
+    },
+    success() {
+        console.log('注册成功')
+    },
+    fail(error) {
+        console.log('注册失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/define-permission-usage.md

@@ -0,0 +1,47 @@
+# definePermissionUsage
+
+> 定义隐私权限协议文案
+
+### definePermissionUsage
+
+> 定义相关隐私政策文案，用于网页授权相关权限时提示用户
+
+#### 请求参数
+
+| 参数                     | 类型                          | 必填 | 说明           |
+| ------------------------ | ----------------------------- | ---- | -------------- |
+| `microphone`             | `object`                      | 否   | 麦克风权限说明 |
+| `microphone.description` | `string`                      | 是   | 麦克风权限描述 |
+| `camera`                 | `object`                      | 否   | 相机权限说明   |
+| `camera.description`     | `string`                      | 是   | 相机权限描述   |
+| `location`               | `object`                      | 否   | 位置权限说明   |
+| `location.description`   | `string`                      | 是   | 位置权限描述   |
+| `success`                | `() => void`                  | 否   | 成功回调       |
+| `fail`                   | `(error: BridgeCode) => void` | 否   | 失败回调       |
+| `complete`               | `() => void`                  | 否   | 完成回调       |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { definePermissionUsage } from '@kbapp/js-bridge'
+
+definePermissionUsage({
+    microphone: { description: '用于发帖上传音频' },
+    location: { description: '获取你选择的位置信息，用于线下导航服务' },
+    camera: { description: '收集你选中的照片或视频信息，用于发表评论、分享视频' },
+    success() {
+        console.log('设置成功')
+    },
+    fail(error) {
+        console.log('设置失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/generate-kbsign.md

@@ -0,0 +1,44 @@
+# generateKBSign
+
+> 生成 kbsign
+
+### generateKBSign
+
+> 生成 kbsign
+
+#### 请求参数
+
+| 参数         | 类型                          | 必填 | 说明                   |
+| ------------ | ----------------------------- | ---- | ---------------------- |
+| `kbSignTime` | `number`                      | 是   | 签名时间戳             |
+| `kbSignType` | `number`                      | 是   | 签名类型               |
+| `...`        | `any`                         | 否   | 其他需要签名的参数     |
+| `success`    | `(res: string) => void`       | 否   | 成功回调，返回签名结果 |
+| `fail`       | `(error: BridgeCode) => void` | 否   | 失败回调               |
+| `complete`   | `() => void`                  | 否   | 完成回调               |
+
+#### 返回值
+
+```js
+Promise<string>
+```
+
+#### 示例代码
+
+```js
+import { generateKBSign } from '@kbapp/js-bridge'
+
+generateKBSign({
+    kbSignTime: Date.now(),
+    kbSignType: 1,
+    // 其他参数...
+    success(kbSign) {
+        console.log('签名结果', kbSign)
+    },
+    fail(error) {
+        console.log('签名失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/get-app-base-info.md

@@ -0,0 +1,39 @@
+# getAppBaseInfo
+
+> 获取设备信息
+
+### getAppBaseInfo
+
+> 获取设备信息
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明     |
+| ---------- | ----------------------------- | ---- | -------- |
+| `success`  | `(res: AppBaseInfo) => void`  | 否   | 成功回调 |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调 |
+| `complete` | `() => void`                  | 否   | 完成回调 |
+
+#### 返回值
+
+```js
+Promise<AppBaseInfo>
+```
+
+#### 示例代码
+
+```js
+import { getAppBaseInfo } from '@kbapp/js-bridge'
+
+getAppBaseInfo({
+    success(deviceInfo) {
+        console.log('设备信息', deviceInfo)
+        console.log('版本号', deviceInfo.vcode)
+    },
+    fail(error) {
+        console.log('获取设备信息失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/get-app-login-info.md

@@ -0,0 +1,42 @@
+# getAppLoginInfo
+
+> 获取 app 登录信息
+
+### getAppLoginInfo
+
+> 获取 app 登录信息.如果未登录返回 null
+
+#### 请求参数
+
+| 参数       | 类型                                 | 必填 | 说明     |
+| ---------- | ------------------------------------ | ---- | -------- |
+| `success`  | `(res: AppLoginInfo | null) => void` | 否   | 成功回调 |
+| `fail`     | `(error: BridgeCode) => void`        | 否   | 失败回调 |
+| `complete` | `() => void`                         | 否   | 完成回调 |
+
+#### 返回值
+
+```js
+Promise<AppLoginInfo | null>
+```
+
+#### 示例代码
+
+```js
+import { getAppLoginInfo } from '@kbapp/js-bridge'
+
+getAppLoginInfo({
+    success(loginInfo) {
+        if (loginInfo) {
+            console.log('已登录', loginInfo)
+        } else {
+            console.log('未登录')
+        }
+    },
+    fail(error) {
+        console.log('获取登录信息失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/get-app-subscribe-notify-status.md

@@ -0,0 +1,40 @@
+# getAppSubscribeNotifyStatus
+
+> 获取APP订阅通知状态
+
+### getAppSubscribeNotifyStatus
+
+> 获取 APP 订阅通知状态
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明     |
+| ---------- | ----------------------------- | ---- | -------- |
+| `success`  | `(res: { enabled: 0 | 1 }) => void` | 否   | 成功回调 |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调 |
+| `complete` | `() => void`                  | 否   | 完成回调 |
+
+#### 返回值
+
+```js
+Promise<{ enabled: 0 | 1 }>
+```
+
+`enabled` 含义：`1` 开启，`0` 关闭。
+
+#### 示例代码
+
+```js
+import { getAppSubscribeNotifyStatus } from '@kbapp/js-bridge'
+
+getAppSubscribeNotifyStatus({
+    success(res) {
+        console.log('订阅通知状态', res.enabled)
+    },
+    fail(error) {
+        console.log('获取状态失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/is-app-version-support.md

@@ -0,0 +1,40 @@
+# isAppVersionSupport
+
+> 判断当前版本号是否支持
+
+### isAppVersionSupport
+
+> 判断当前版本号是否支持
+
+#### 请求参数
+
+| 参数         | 类型                          | 必填 | 说明                   |
+| ------------ | ----------------------------- | ---- | ---------------------- |
+| `minVersion` | `number`                      | 是   | 最低支持版本号         |
+| `success`    | `(res: boolean) => void`      | 否   | 成功回调，返回是否支持 |
+| `fail`       | `(error: BridgeCode) => void` | 否   | 失败回调               |
+| `complete`   | `() => void`                  | 否   | 完成回调               |
+
+#### 返回值
+
+```js
+Promise<boolean>
+```
+
+#### 示例代码
+
+```js
+import { isAppVersionSupport } from '@kbapp/js-bridge'
+
+isAppVersionSupport({
+    minVersion: 80711,
+    success(result) {
+        console.log('是否能使用', result)
+    },
+    fail(error) {
+        console.log('检查版本支持失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/on-app-share-panel-show.md

@@ -0,0 +1,32 @@
+# onAppSharePanelShow
+
+> 监听分享面板打开事件
+
+### onAppSharePanelShow
+
+> 监听分享面板打开时触发（主动和被动）
+
+#### 请求参数
+
+| 参数       | 类型        | 说明                 |
+| ---------- | ----------- | -------------------- |
+| `callback` | `()=> void` | 分享面板打开时的回调 |
+
+#### 返回值
+
+```js
+// 返回函数，调用该函数取消监听
+() => void
+```
+
+#### 示例代码
+
+```js
+import { onAppSharePanelShow } from '@kbapp/js-bridge'
+
+const stopHandle = onAppSharePanelShow(() => {
+    console.log('分享面板打开')
+})
+
+// stopHandle() 停止监听
+```

package/docs/api/on-loop-check-app-login.md

@@ -0,0 +1,32 @@
+# onLoopCheckAppLogin
+
+> 启动轮询检查 APP 登录状态
+
+### onLoopCheckAppLogin
+
+> 启动轮询检查 APP 登录状态，查询到已登录后立即触发回调并自动回收回调函数（支持主动取消监听）
+
+#### 请求参数
+
+| 参数       | 类型                                | 说明         |
+| ---------- | ----------------------------------- | ------------ |
+| `callback` | `(loginInfo: AppLoginInfo) => void` | 登录成功回调 |
+
+#### 返回值
+
+```js
+// 返回函数,调用该函数,停止监听
+() => void
+```
+
+#### 示例代码
+
+```js
+import { onLoopCheckAppLogin } from '@kbapp/js-bridge'
+
+const handle = onLoopCheckAppLogin((loginInfo) => {
+    console.log('登录成功', loginInfo)
+})
+
+// handle() 停止监听
+```

package/docs/api/open-app-share-panel.md

@@ -0,0 +1,46 @@
+# openAppSharePanel
+
+> 主动唤起分享面板
+
+### openAppSharePanel
+
+> 主动唤起分享面板
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明         |
+| ---------- | ----------------------------- | ---- | ------------ |
+| `title`    | `string`                      | 是   | 分享标题     |
+| `content`  | `string`                      | 否   | 分享内容     |
+| `imageUrl` | `string`                      | 是   | 分享图片 URL |
+| `url`      | `string`                      | 是   | 分享链接 URL |
+| `success`  | `() => void`                  | 否   | 成功回调     |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调     |
+| `complete` | `() => void`                  | 否   | 完成回调     |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { openAppSharePanel } from '@kbapp/js-bridge'
+
+openAppSharePanel({
+    title: '开吧分享',
+    content: '开吧，开汽车上新生活！',
+    url: 'http://www.kaiba315.com.cn/',
+    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png',
+    success() {
+        console.log('打开分享面板成功')
+    },
+    fail(error) {
+        console.log('打开分享面板失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/open-app-subscribe-notify-settings.md

@@ -0,0 +1,38 @@
+# openAppSubscribeNotifySettings
+
+> 前往/打开 app订阅管理页面
+
+### openAppSubscribeNotifySettings
+
+> 前往/打开 APP 订阅管理页面
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明     |
+| ---------- | ----------------------------- | ---- | -------- |
+| `success`  | `() => void`                  | 否   | 成功回调 |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调 |
+| `complete` | `() => void`                  | 否   | 完成回调 |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { openAppSubscribeNotifySettings } from '@kbapp/js-bridge'
+
+openAppSubscribeNotifySettings({
+    success() {
+        console.log('打开订阅管理页面成功')
+    },
+    fail(error) {
+        console.log('打开订阅管理页面失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/open-post-editor.md

@@ -0,0 +1,91 @@
+# openPostEditor
+
+> 唤起发帖器
+
+### openPostEditor
+
+> 唤起发帖器
+
+#### 请求参数
+
+| 参数                          | 类型                              | 必填 | 说明                         |
+| ----------------------------- | --------------------------------- | ---- | ---------------------------- |
+| `postRule.hint`               | `string`                          | 否   | 文本输入框提示文案           |
+| `postRule.initialText`        | `string`                          | 否   | 初始化文本内容               |
+| `postRule.audio`              | `boolean`                         | 否   | 是否显示音频按钮，默认 true  |
+| `postRule.image`              | `boolean`                         | 否   | 是否显示图片按钮，默认 true  |
+| `postRule.video`              | `boolean`                         | 否   | 是否显示视频按钮，默认 true  |
+| `postRule.address`            | `boolean`                         | 否   | 是否显示定位按钮，默认 true  |
+| `postRule.asset_video`        | `boolean`                         | 否   | 是否显示媒资视频，默认 false |
+| `postRule.audio_must`         | `boolean`                         | 否   | 音频是否必传                 |
+| `postRule.image_must`         | `boolean`                         | 否   | 图片是否必传                 |
+| `postRule.max_image_count`    | `number`                          | 否   | 图片最大张数，默认 9         |
+| `postRule.min_image_count`    | `number`                          | 否   | 图片最小张数，默认 0         |
+| `postRule.video_must`         | `boolean`                         | 否   | 视频是否必传                 |
+| `postRule.text_must`          | `boolean`                         | 否   | 文本内容是否必传             |
+| `postRule.content_max_length` | `number`                          | 否   | 文本最大长度，默认 1000      |
+| `postRule.content_min_length` | `number`                          | 否   | 文本最小长度，默认 0         |
+| `success`                     | `(res: PostEditorResult) => void` | 否   | 成功回调                     |
+| `fail`                        | `(error: BridgeCode) => void`     | 否   | 失败回调                     |
+| `complete`                    | `() => void`                      | 否   | 完成回调                     |
+
+#### 返回值
+
+```js
+Promise<{
+    content: string
+    street?: string
+    audio?: unknown
+    video?: unknown
+    images?: { url: string; width: number; height: number }[]
+}>
+```
+
+#### 示例代码
+
+推荐使用 `generatePostEditorParamsByThreadPostRule` 构造参数
+
+```js
+import { generatePostEditorParamsByThreadPostRule, openPostEditor, KbRequirement } from '@kbapp/js-bridge'
+
+openPostEditor({
+    postRule: generatePostEditorParamsByThreadPostRule({
+        textMin: 0,
+        textMax: 1000,
+        /** 帖子中, 图片的最大张数 */
+        imageMax: 9,
+
+        /** 帖子中, 图片的最小张数 */
+        imageMin: 0,
+
+        /** 音频限制 */
+        audioRqr: KbRequirement.FREE,
+
+        /** 视频限制 */
+        videoRqr: KbRequirement.FREE,
+
+        /** 媒资限制 */
+        mediaRqr: KbRequirement.FORBID,
+
+        /** 位置-逆地理信息限制 */
+        streetRqr: KbRequirement.FREE
+    }),
+})
+
+openPostEditor({
+    postRule: {
+        hint: '请输入内容',
+        initialText: '默认内容',
+        image: true,
+        max_image_count: 9,
+    },
+    success(result) {
+        console.log('发帖内容', result)
+    },
+    fail(error) {
+        console.log('打开发帖器失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/report-daevent.md

@@ -0,0 +1,43 @@
+# reportDAEvent
+
+> 上报数据埋点
+
+### reportDAEvent
+
+> 上报数据埋点
+
+#### 请求参数
+
+| 参数          | 类型                          | 必填 | 说明             |
+| ------------- | ----------------------------- | ---- | ---------------- |
+| `eventName`   | `string`                      | 是   | 事件名           |
+| `eventParams` | `object`                      | 否   | 上报参数         |
+| `eventType`   | `string`                      | 否   | 开始结束类型传递 |
+| `success`     | `() => void`                  | 否   | 成功回调         |
+| `fail`        | `(error: BridgeCode) => void` | 否   | 失败回调         |
+| `complete`    | `() => void`                  | 否   | 完成回调         |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { reportDAEvent } from '@kbapp/js-bridge'
+
+reportDAEvent({
+    eventName: 'page_view',
+    eventParams: { page: 'home' },
+    success() {
+        console.log('上报数据成功')
+    },
+    fail(error) {
+        console.log('上报数据失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/run-action.md

@@ -0,0 +1,44 @@
+# runAction
+
+> 执行 action
+
+### runAction
+
+> app 执行 Action
+
+#### 请求参数
+
+| 参数           | 类型                          | 必填 | 说明         |
+| -------------- | ----------------------------- | ---- | ------------ |
+| `action`       | `string`                      | 是   | action       |
+| `actionParams` | `object`                      | 否   | actionParams |
+| `success`      | `() => void`                  | 否   | 成功回调     |
+| `fail`         | `(error: BridgeCode) => void` | 否   | 失败回调     |
+| `complete`     | `() => void`                  | 否   | 完成回调     |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { runAction } from '@kbapp/js-bridge'
+
+runAction({
+    action: 'pageWeb',
+    actionParams: {
+        url: 'https://www.baidu.com',
+    },
+    success() {
+        console.log('执行成功')
+    },
+    fail(error) {
+        console.log('执行失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/run-bridge-api-response.md

@@ -0,0 +1,46 @@
+# runBridgeApiResponse
+
+> 执行桥接(等待响应)
+
+### runBridgeApiResponse
+
+> 执行 app 桥接方法（等待响应）
+
+#### 请求参数
+
+| 参数       | 类型                                  | 必填 | 说明                     |
+| ---------- | ------------------------------------- | ---- | ------------------------ |
+| `name`     | `string`                              | 是   | 任务名称                 |
+| `params`   | `{ type: number; data?: any }`        | 是   | 任务参数                 |
+| `timeout`  | `number`                              | 否   | 超时时间（毫秒）         |
+| `success`  | `(result: Result) => void`            | 否   | 执行成功回调             |
+| `fail`     | `(error: BridgeCode) => void`         | 否   | 执行失败回调             |
+| `complete` | `() => void`                          | 否   | 完成回调（成功/失败均触发） |
+
+#### 返回值
+
+```js
+Promise<Result>
+```
+
+#### 示例代码
+
+```js
+import { runBridgeApiResponse } from '@kbapp/js-bridge'
+
+runBridgeApiResponse({
+    name: 'OpenActRequest',
+    params: {
+        type: 60001,
+        data: {},
+    },
+    success(result) {
+        console.log('成功', result)
+    },
+    fail(error) {
+        console.log('失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/run-bridge-api.md

@@ -0,0 +1,34 @@
+# runBridgeApi
+
+> 执行桥接(无返回值)
+
+### runBridgeApi
+
+> 执行 app 桥接方法（无响应）
+
+#### 请求参数
+
+| 参数     | 类型                         | 必填 | 说明             |
+| -------- | ---------------------------- | ---- | ---------------- |
+| `name`   | `string`                     | 是   | 任务名称         |
+| `params` | `{ type: number; data?: any }` | 是   | 桥接参数         |
+
+#### 返回值
+
+```js
+void
+```
+
+#### 示例代码
+
+```js
+import { runBridgeApi } from '@kbapp/js-bridge'
+
+runBridgeApi({
+    name: 'OpenActRequest',
+    params: {
+        type: 60001,
+        data: {},
+    },
+})
+```

package/docs/api/save-image-to-local.md

@@ -0,0 +1,46 @@
+# saveImageToLocal
+
+> 保存图片到本地
+
+### saveImageToLocal
+
+> 保存图片到本地
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明         |
+| ---------- | ----------------------------- | ---- | ------------ |
+| `imageUrl` | `string`                      | 是   | 图片网络地址 |
+| `success`  | `() => void`                  | 否   | 成功回调     |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调     |
+| `complete` | `() => void`                  | 否   | 完成回调     |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 异常返回值
+
+```js
+Promise<{ errCode: BridgeCode }>
+```
+
+#### 示例代码
+
+```js
+import { saveImageToLocal, BridgeCode } from '@kbapp/js-bridge'
+
+saveImageToLocal({
+    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png',
+    success() {
+        console.log('保存图片成功')
+    },
+    fail(error) {
+        console.log('保存图片失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/save-video-to-local.md

@@ -0,0 +1,46 @@
+# saveVideoToLocal
+
+> 保存视频到本地
+
+### saveVideoToLocal
+
+> 保存视频到本地
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明         |
+| ---------- | ----------------------------- | ---- | ------------ |
+| `videoUrl` | `string`                      | 是   | 视频网络地址 |
+| `success`  | `() => void`                  | 否   | 成功回调     |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调     |
+| `complete` | `() => void`                  | 否   | 完成回调     |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 异常返回值
+
+```js
+Promise<{ errCode: BridgeCode }>
+```
+
+#### 示例代码
+
+```js
+import { saveVideoToLocal } from '@kbapp/js-bridge'
+
+saveVideoToLocal({
+    videoUrl: 'https://example.com/video.mp4',
+    success() {
+        console.log('保存视频成功')
+    },
+    fail(error) {
+        console.log('保存视频失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/scan-qrcode.md

@@ -0,0 +1,38 @@
+# scanQRCode
+
+> 扫描二维码
+
+### scanQRCode
+
+> 扫描二维码
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明                   |
+| ---------- | ----------------------------- | ---- | ---------------------- |
+| `success`  | `(res: string) => void`       | 否   | 成功回调，返回扫描结果 |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调               |
+| `complete` | `() => void`                  | 否   | 完成回调               |
+
+#### 返回值
+
+```js
+Promise<string>
+```
+
+#### 示例代码
+
+```js
+import { scanQRCode } from '@kbapp/js-bridge'
+
+scanQRCode({
+    success(result) {
+        console.log('扫描结果', result)
+    },
+    fail(error) {
+        console.log('扫描失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/set-screen-orientation.md

@@ -0,0 +1,52 @@
+# setScreenOrientation
+
+> 设置屏幕方向
+
+### setScreenOrientation
+
+> 设置屏幕方向
+
+#### 请求参数
+
+| 参数          | 类型                          | 必填 | 说明                   |
+| ------------- | ----------------------------- | ---- | ---------------------- |
+| `orientation` | `number`                      | 是   | 屏幕方向 0:竖屏 1:横屏 |
+| `success`     | `() => void`                  | 否   | 成功回调               |
+| `fail`        | `(error: BridgeCode) => void` | 否   | 失败回调               |
+| `complete`    | `() => void`                  | 否   | 完成回调               |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { setScreenOrientation } from '@kbapp/js-bridge'
+
+// 设置为横屏
+setScreenOrientation({
+    orientation: 1,
+    success() {
+        console.log('设置横屏成功')
+    },
+    fail(error) {
+        console.log('设置横屏失败', error)
+    },
+})
+
+// 设置为竖屏
+setScreenOrientation({
+    orientation: 0,
+    success() {
+        console.log('设置竖屏成功')
+    },
+    fail(error) {
+        console.log('设置竖屏失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/set-web-view-title.md

@@ -0,0 +1,46 @@
+# setWebViewTitle
+
+> 设置网页标题
+
+### setWebViewTitle
+
+> 设置网页标题(建议通过 document.title 设置)
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明             |
+| ---------- | ----------------------------- | ---- | ---------------- |
+| `title`    | `string`                      | 是   | webview 标题文案 |
+| `success`  | `() => void`                  | 否   | 成功回调         |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调         |
+| `complete` | `() => void`                  | 否   | 完成回调         |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 异常返回值
+
+```js
+Promise<{ errCode: BridgeCode }>
+```
+
+#### 示例代码
+
+```js
+import { setWebViewTitle } from '@kbapp/js-bridge'
+
+setWebViewTitle({
+    title: '页面标题',
+    success() {
+        console.log('设置标题成功')
+    },
+    fail(error) {
+        console.log('设置标题失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/share-image.md

@@ -0,0 +1,46 @@
+# shareImage
+
+> 分享海报
+
+### shareImage
+
+> 分享海报
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明                                  |
+| ---------- | ----------------------------- | ---- | ------------------------------------- |
+| `imageUrl` | `string`                      | 是   | 分享的图片链接,仅支持网络地址,png/jpg |
+| `success`  | `() => void`                  | 否   | 成功回调                              |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调                              |
+| `complete` | `() => void`                  | 否   | 完成回调                              |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 异常返回值
+
+```js
+Promise<{ errCode: BridgeCode }>
+```
+
+#### 示例代码
+
+```js
+import { shareImage } from '@kbapp/js-bridge'
+
+shareImage({
+    imageUrl: 'https://example.com/poster.png',
+    success() {
+        console.log('分享海报成功')
+    },
+    fail(error) {
+        console.log('分享海报失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/docs/api/trigger-app-login.md

@@ -0,0 +1,45 @@
+# triggerAppLogin
+
+> 触发 app 登录
+
+### triggerAppLogin
+
+> 触发 app 登录
+
+#### 请求参数
+
+| 参数       | 类型                          | 必填 | 说明     |
+| ---------- | ----------------------------- | ---- | -------- |
+| `success`  | `() => void`                  | 否   | 成功回调 |
+| `fail`     | `(error: BridgeCode) => void` | 否   | 失败回调 |
+| `complete` | `() => void`                  | 否   | 完成回调 |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 示例代码
+
+```js
+import { triggerAppLogin, onLoopCheckAppLogin } from '@kbapp/js-bridge'
+
+// 监听登录成功
+const handle = onLoopCheckAppLogin((loginInfo) => {
+    console.log('登录成功', loginInfo)
+    handle() // 停止监听
+})
+
+// 触发登录
+triggerAppLogin({
+    success() {
+        console.log('触发登录成功')
+    },
+    fail(error) {
+        console.log('触发登录失败', error)
+    },
+})
+```
+
+> 支持 Promise 风格调用

package/package.json

@@ -3,7 +3,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "1.0.14-alpha.0",
+    "version": "1.0.15-alpha.0",
     "description": "开吧客户端桥接",
     "author": "along",
     "main": "./dist/umd/index.js",
@@ -28,7 +28,8 @@
         "dist",
         "package.json",
         "README.md",
-        "examples"
+        "examples",
+        "docs"
     ],
     "devDependencies": {
         "@vitest/ui": "^4.1.2",