@kbapp/js-bridge 0.4.5-alpha.0 → 0.4.8-alpha.0

package/README.MD

@@ -59,6 +59,7 @@ defineComponents({
 | closeWebView          | 关闭当前 webview               |
 | definePermissionUsage | 定义隐私权限协议文案           |
 | getDeviceInfo         | 获取设备信息                   |
+| openPostEditor        | 唤起发帖器                     |
 | runAction             | 执行 action                    |
 | saveImageToLocal      | 保存图片到本地                 |
 | saveVideoToLocal      | 保存视频到本地                 |
@@ -73,10 +74,10 @@ defineComponents({
 | reportGetui           | 个推事件上报                   |
 | generateKBSign        | 生成 kbsign                    |
 
-| 枚举          | 说明             |
-| ------------- | ---------------- |
-| JSBridgeCode  | kbapp 桥接状态码 |
-| AppLoginModel | 登录信息 model   |
+| 枚举               | 说明             |
+| ------------------ | ---------------- |
+| JSBridgeCode       | kbapp 桥接状态码 |
+| AppBridgedUserInfo | 登录信息 model   |
 
 ### 登录设计
 
@@ -101,7 +102,7 @@ const onTapSomeButton = decorateLogin(() => {
 
 #### 如果是某个组件/页面加载的时候就得登录才能正常操作
 
-暂时没想好, 反正也是需要禁止无限制事件类型, 小程序情况下, 某个链接点击打开小程序, 然后关闭, 再重新点链接打开小程序, 页面生命周期是重复触发onMounted
+暂时没想好, 反正也是需要禁止无限制事件类型, 小程序情况下, 某个链接点击打开小程序, 然后关闭, 再重新点链接打开小程序, 页面生命周期是重复触发 onMounted
 
 其中最终的目的就是禁止出现监听登录成功事件无限累加, 曾经在这上面吃了不少的亏
 
@@ -310,8 +311,8 @@ if (await canIUse('sharePoster')) {
 | 参数     | 值类型 | 必填? | 说明       |
 | -------- | ------ | ----- | ---------- |
 | title    | string | 必填  | 标题       |
-| content  | string | 必填  | 内容       |
-| imgUrl   | string | 必填  | 图片       |
+| content  | string | 选填  | 内容       |
+| imageUrl | string | 必填  | 图片       |
 | url      | string | 必填  | https 链接 |
 | tmuTrack | any    | 选填  | 天目埋点   |
 | qqUrl    | string | 选填  | 未知       |
@@ -333,26 +334,7 @@ if (await canIUse('sharePoster')) {
 #### 返回值
 
 ```js
-Promise<{
-    /** 车牌号:例如浙A999999 */
-    carNo: string
-    /** 未知 */
-    role: number
-    /** 手机号 */
-    mobile: string
-    /** 性别 */
-    sex: number
-    /** 电台id */
-    siteId: string
-    /** 头像地址 */
-    avatar: string
-    /** token */
-    token: string
-    /** 用户id */
-    userId: number
-    /** 用户名 */
-    userName: string
-} | null>
+Promise<AppBridgedUserInfo | null>
 
 ```
 
@@ -369,26 +351,7 @@ Promise<{
 #### 返回值
 
 ```js
-Promise<{
-    /** 车牌号:例如浙A999999 */
-    carNo: string
-    /** 未知 */
-    role: number
-    /** 手机号 */
-    mobile: string
-    /** 性别 */
-    sex: number
-    /** 电台id */
-    siteId: string
-    /** 头像地址 */
-    avatar: string
-    /** token */
-    token: string
-    /** 用户id */
-    userId: number
-    /** 用户名 */
-    userName: string
-}>
+Promise<AppBridgedUserInfo>
 
 ```
 
@@ -425,6 +388,36 @@ const handle = watchAppLoginSuccess(() => {
 
 ---
 
+### AppBridgedUserInfo
+
+> 登录信息类型
+
+```js
+Promise<{
+    /** 车牌号:例如浙A999999 */
+    carNo?: string
+    /** 未知 */
+    role?: number
+    /** 手机号 */
+    mobile: string
+    /** 性别 */
+    sex: number
+    /** 电台id */
+    siteId: number
+    /** 头像地址 */
+    avatar: string
+    /** token */
+    token: string
+    /** 用户id */
+    userId: number
+    /** 用户名 */
+    userName: string
+}>
+
+```
+
+---
+
 ### JSBridgeCode
 
 > 错误码枚举

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from './core';
 export * from './lib/can-i-use';
 export * from './lib/check-for-new-version';
 export * from './lib/close-webview';
@@ -5,6 +6,7 @@ export * from './lib/define-permission-usage';
 export * from './lib/generate-kb-sign';
 export * from './lib/get-device-info';
 export * from './lib/js-bridge-code';
+export * from './lib/open-post-editor';
 export * from './lib/report-getui';
 export * from './lib/run-action';
 export * from './lib/save-image-to-local';

package/dist/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./core"), exports);
 __exportStar(require("./lib/can-i-use"), exports);
 __exportStar(require("./lib/check-for-new-version"), exports);
 __exportStar(require("./lib/close-webview"), exports);
@@ -21,6 +22,7 @@ __exportStar(require("./lib/define-permission-usage"), exports);
 __exportStar(require("./lib/generate-kb-sign"), exports);
 __exportStar(require("./lib/get-device-info"), exports);
 __exportStar(require("./lib/js-bridge-code"), exports);
+__exportStar(require("./lib/open-post-editor"), exports);
 __exportStar(require("./lib/report-getui"), exports);
 __exportStar(require("./lib/run-action"), exports);
 __exportStar(require("./lib/save-image-to-local"), exports);

package/dist/lib/get-device-info.d.ts

@@ -1,16 +1,8 @@
 /**
  *
- * @description 获取设备信息
- *
- * **示例代码**
-```js
-import { getDeviceInfo } from '@kbapp/js-bridge';
-
-const deviceInfo = await getDeviceInfo()
-deviceInfo.vcode
-```
+ * @description app本地设备信息
  */
-export declare const getDeviceInfo: () => Promise<{
+export declare class AppDeviceInfo {
     /** 例如iOS */
     do: string;
     /** 例如iPhone11,2 */
@@ -21,10 +13,25 @@ export declare const getDeviceInfo: () => Promise<{
     vcode: number;
     /** 版本号.例如6.90.11 */
     v: string;
+    /** 未知 */
+    source: number;
     /** 电台id */
     siteId: number;
     /** 用户id.当登录时返回 */
     userId?: number;
     /** 未知 */
     cid: string;
-}>;
+}
+/**
+ *
+ * @description 获取设备信息
+ *
+ * **示例代码**
+```js
+import { getDeviceInfo } from '@kbapp/js-bridge';
+
+const deviceInfo = await getDeviceInfo()
+deviceInfo.vcode
+```
+ */
+export declare const getDeviceInfo: () => Promise<AppDeviceInfo>;

package/dist/lib/get-device-info.js

@@ -1,8 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDeviceInfo = void 0;
+exports.getDeviceInfo = exports.AppDeviceInfo = void 0;
 var promise_cache_1 = require("../util/promise-cache");
 var core_1 = require("../core");
+/**
+ *
+ * @description app本地设备信息
+ */
+var AppDeviceInfo = /** @class */ (function () {
+    function AppDeviceInfo() {
+    }
+    return AppDeviceInfo;
+}());
+exports.AppDeviceInfo = AppDeviceInfo;
 /**
  *
  * @description 获取设备信息

package/dist/lib/open-post-editor.d.ts

@@ -0,0 +1,110 @@
+/**
+ *
+ * @description 默认显示 image, video, address, audio
+ */
+export declare class PostEditorParams {
+    /** 文本输入框 低下显示的提示文案 */
+    placeholder?: string;
+    /** 初始化文本内容 */
+    initialText?: string;
+    /** 是否启用图片选择器 默认启用 */
+    enableImageUpload: boolean;
+    /** 是否启用音频录制功能 默认启用 */
+    enableAudioUpload: boolean;
+    /** 是否启用普通视频上传功能 默认启用 */
+    enableVideoUpload: boolean;
+    /** 是否启用定位 */
+    enableAddress: boolean;
+    /** 是否启用媒资视频上传功能 默认禁用 */
+    enableMediaVideoUpload: boolean;
+    /** 最少输入多少字符, 默认 0 */
+    minTextLength: number;
+    /** 最多输入多少字符, 默认 1000 */
+    maxTextLength: number;
+    /** 最少上传多少张图片, 默认 0 */
+    minImageCount: number;
+    /** 最多上传多少张图片, 默认 9 */
+    maxImageCount: number;
+    /** 普通音频是否必传. 默认不必传 */
+    isAudioRequired: boolean;
+    /** 普通视频是否必传. 默认不必传 */
+    isVideoRequired: boolean;
+    /** 媒资视频是否必传. 默认不必传 */
+    isMediaVideoRequired: boolean;
+}
+/**
+ *
+ * @description 构造富文本编辑器参数
+ */
+export declare function createPostEditorParams(params?: Partial<PostEditorParams>): {
+    hint: string | undefined;
+    initialText: string | undefined;
+    audio: boolean;
+    image: boolean;
+    video: boolean;
+    address: boolean;
+    asset_video: boolean;
+    text_must: boolean;
+    content_min_length: number;
+    content_max_length: number;
+    image_must: boolean;
+    min_image_count: number;
+    max_image_count: number;
+    audio_must: boolean;
+    video_must: boolean;
+    asset_video_must: boolean;
+};
+/**
+ *
+ * @description 唤起发帖器, 由于原生发帖器桥接参数存在一些小问题, 建议使用 createPostEditorParams 来构造参数
+ */
+export declare function openPostEditor(data?: {
+    /** 文本默认显示内容（placehold） */
+    hint?: string;
+    /** 默认初始化文案 */
+    initialText?: string;
+    /** 是否显示音频按钮, 默认显示 */
+    audio?: boolean;
+    /** 是否显示图片按钮, 默认显示 */
+    image?: boolean;
+    /** 是否显示视频按钮, 默认显示 */
+    video?: boolean;
+    /** 是否显示定位按钮, 默认显示 */
+    address?: boolean;
+    /** 是否显示媒资视频选项；默认不显示 */
+    asset_video?: boolean;
+    /** 音频是否必传 */
+    audio_must?: boolean;
+    /** 图片是否必传 */
+    image_must?: boolean;
+    /** 图片最大张数 */
+    max_image_count?: number;
+    /** 图片最小张数 */
+    min_image_count?: number;
+    /** 视频是否必传 */
+    video_must?: boolean;
+    /** 文本内容是否必传 */
+    text_must?: boolean;
+    /** 文本最大长度 */
+    content_max_length?: number;
+    /** 文本最小长度 */
+    content_min_length?: number;
+    [key: string]: any;
+}): Promise<{
+    content: string;
+    /** 街道信息 */
+    street?: string;
+    /**  音频model */
+    audio?: unknown;
+    /** 视频model */
+    video?: unknown;
+    /** 媒资视频 */
+    mediaVideo?: {
+        mediaId: string;
+    };
+    images: {
+        url: string;
+        width: number;
+        height: number;
+    }[] | undefined;
+}>;

package/dist/lib/open-post-editor.js

@@ -0,0 +1,116 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostEditorParams = void 0;
+exports.createPostEditorParams = createPostEditorParams;
+exports.openPostEditor = openPostEditor;
+var core_1 = require("../core");
+/**
+ *
+ * @description 默认显示 image, video, address, audio
+ */
+var PostEditorParams = /** @class */ (function () {
+    function PostEditorParams() {
+        /** 是否启用图片选择器 默认启用 */
+        this.enableImageUpload = true;
+        /** 是否启用音频录制功能 默认启用 */
+        this.enableAudioUpload = true;
+        /** 是否启用普通视频上传功能 默认启用 */
+        this.enableVideoUpload = true;
+        /** 是否启用定位 */
+        this.enableAddress = true;
+        /** 是否启用媒资视频上传功能 默认禁用 */
+        this.enableMediaVideoUpload = false;
+        /** 最少输入多少字符, 默认 0 */
+        this.minTextLength = 0;
+        /** 最多输入多少字符, 默认 1000 */
+        this.maxTextLength = 1000;
+        /** 最少上传多少张图片, 默认 0 */
+        this.minImageCount = 0;
+        /** 最多上传多少张图片, 默认 9 */
+        this.maxImageCount = 9;
+        /** 普通音频是否必传. 默认不必传 */
+        this.isAudioRequired = false;
+        /** 普通视频是否必传. 默认不必传 */
+        this.isVideoRequired = false;
+        /** 媒资视频是否必传. 默认不必传 */
+        this.isMediaVideoRequired = false;
+    }
+    return PostEditorParams;
+}());
+exports.PostEditorParams = PostEditorParams;
+/**
+ *
+ * @description 构造富文本编辑器参数
+ */
+function createPostEditorParams(params) {
+    var instance = new PostEditorParams();
+    if (params) {
+        var keys = Object.keys(params);
+        keys.forEach(function (key) {
+            // 显式指定this的索引类型
+            ;
+            instance[key] = params[key];
+        });
+    }
+    return {
+        hint: instance.placeholder,
+        initialText: instance.initialText,
+        audio: instance.enableAudioUpload,
+        image: instance.enableImageUpload,
+        video: instance.enableVideoUpload,
+        address: instance.enableAddress,
+        asset_video: instance.enableMediaVideoUpload,
+        text_must: instance.minTextLength > 0,
+        content_min_length: instance.minTextLength,
+        content_max_length: instance.maxTextLength,
+        image_must: instance.minImageCount > 0,
+        min_image_count: instance.minImageCount,
+        max_image_count: instance.maxImageCount,
+        audio_must: instance.isAudioRequired,
+        video_must: instance.isVideoRequired,
+        asset_video_must: instance.isMediaVideoRequired,
+    };
+}
+/**
+ *
+ * @description 唤起发帖器, 由于原生发帖器桥接参数存在一些小问题, 建议使用 createPostEditorParams 来构造参数
+ */
+function openPostEditor(data) {
+    if (data === void 0) { data = {}; }
+    /**
+     *
+     * 经过测试, 设置 text_must: true, 还必须设置 content_min_length: 1 才表示必须填写内容,
+     * 单独设置 text_must: true 或者单独设置 content_min_length:1 都无法要求内容必填
+     * 设置 image_must 和 min_image_count 同理
+     */
+    return (0, core_1.callHandlerPromise)({
+        name: 'OpenActRequest',
+        params: { type: 13, data: data },
+    }).then(function (_a) {
+        var data = _a.data;
+        var images = data.pic, others = __rest(data, ["pic"]);
+        return __assign({ images: images }, others);
+    });
+}

package/dist/lib/run-action.d.ts

@@ -8,11 +8,13 @@ import { runAction } from '@kbapp/js-bridge';
 
 runAction({
     action: 'pageWeb',
-    actionParams: {}
+    actionParams: {
+        url: 'https://www.baidu.com',
+    }
 })
 ```
  */
 export declare function runAction(data: {
     action: string;
-    actionParams: Record<string, any>;
+    actionParams?: Record<string, any>;
 }): void;

package/dist/lib/run-action.js

@@ -12,7 +12,9 @@ import { runAction } from '@kbapp/js-bridge';
 
 runAction({
     action: 'pageWeb',
-    actionParams: {}
+    actionParams: {
+        url: 'https://www.baidu.com',
+    }
 })
 ```
  */

package/dist/lib/share-model.d.ts

@@ -9,7 +9,7 @@ import { defineShareModel } from '@kbapp/js-bridge';
 defineShareModel({
     title: '分享标题',
     content: '分享内容',
-    imgUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png', // 分享图片
+    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png', // 分享图片
     url: 'http://www.kaiba315.com.cn/' // 分享网页地址
 })
 ```
@@ -63,7 +63,7 @@ export declare function invokeShareModal(data: {
     /** 分享出去的标题 */
     title: string;
     /** 分享出去的正文内容 */
-    content: string;
+    content?: string;
     /** 分享出去的封面图片 */
     imageUrl: string;
 }): void;

package/dist/lib/share-model.js

@@ -15,7 +15,7 @@ import { defineShareModel } from '@kbapp/js-bridge';
 defineShareModel({
     title: '分享标题',
     content: '分享内容',
-    imgUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png', // 分享图片
+    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png', // 分享图片
     url: 'http://www.kaiba315.com.cn/' // 分享网页地址
 })
 ```

package/dist/lib/trigger-login.d.ts

@@ -2,7 +2,7 @@
  *
  * @description 登录信息
  */
-export declare class AppLoginModel {
+export declare class AppBridgedUserInfo {
     /** 车牌号:例如浙A999999 */
     carNo?: string;
     /** 未知 */
@@ -12,7 +12,7 @@ export declare class AppLoginModel {
     /** 性别 */
     sex: number;
     /** 电台id */
-    siteId: string;
+    siteId: number;
     /** 头像地址 */
     avatar: string;
     /** token */
@@ -26,17 +26,17 @@ export declare class AppLoginModel {
  *
  * @description 获取用户登录信息.如果未登录返回null
  */
-export declare function getAppLoginInfo(): Promise<AppLoginModel | null>;
+export declare function getAppLoginInfo(): Promise<AppBridgedUserInfo | null>;
 /**
  *
  * @description 触发登录
  * 如果已登录,将直接返回登录信息, 请通过 `watchAppLoginSuccess` 监听登录成功事件
  */
-export declare function triggerAppLogin(): Promise<AppLoginModel>;
+export declare function triggerAppLogin(): Promise<AppBridgedUserInfo>;
 /**
  *
  * @description 注册监听app登录成功, 监听时候立刻执行检测一次, 注意,该函数仅读取登录信息, 不会触发登录
- * @param {(loginInfo: AppLoginModel) => void} callback 登录成功回调
+ * @param {(loginInfo: AppBridgedUserInfo) => void} callback 登录成功回调
  * @returns {() => void} 调用该函数取消监听
  *
  * **示例代码**
@@ -50,4 +50,4 @@ const handle = watchAppLoginSuccess(() => {
 // handle() 停止监听
 ```
  */
-export declare const watchAppLoginSuccess: (callback: (loginInfo: AppLoginModel) => void) => () => void;
+export declare const watchAppLoginSuccess: (callback: (loginInfo: AppBridgedUserInfo) => void) => () => void;

package/dist/lib/trigger-login.js

@@ -36,7 +36,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.watchAppLoginSuccess = exports.AppLoginModel = void 0;
+exports.watchAppLoginSuccess = exports.AppBridgedUserInfo = void 0;
 exports.getAppLoginInfo = getAppLoginInfo;
 exports.triggerAppLogin = triggerAppLogin;
 var js_bridge_code_1 = require("./js-bridge-code");
@@ -45,12 +45,12 @@ var core_1 = require("../core");
  *
  * @description 登录信息
  */
-var AppLoginModel = /** @class */ (function () {
-    function AppLoginModel() {
+var AppBridgedUserInfo = /** @class */ (function () {
+    function AppBridgedUserInfo() {
     }
-    return AppLoginModel;
+    return AppBridgedUserInfo;
 }());
-exports.AppLoginModel = AppLoginModel;
+exports.AppBridgedUserInfo = AppBridgedUserInfo;
 /**
  *
  * @description 获取用户登录信息.如果未登录返回null
@@ -171,7 +171,7 @@ function triggerAppLogin() {
 /**
  *
  * @description 注册监听app登录成功, 监听时候立刻执行检测一次, 注意,该函数仅读取登录信息, 不会触发登录
- * @param {(loginInfo: AppLoginModel) => void} callback 登录成功回调
+ * @param {(loginInfo: AppBridgedUserInfo) => void} callback 登录成功回调
  * @returns {() => void} 调用该函数取消监听
  *
  * **示例代码**

package/package.json

@@ -3,9 +3,8 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.4.5-alpha.0",
+    "version": "0.4.8-alpha.0",
     "description": "开吧客户端桥接",
     "main": "./dist/index.js",
-    "author": "along",
-    "gitHead": "1ae6636e6e5180193f58946cc75766872d786107"
+    "author": "along"
 }