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

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.13-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",