@kbapp/js-bridge 0.3.5-alpha.0 → 0.4.1-alpha.0

package/README.MD

@@ -51,6 +51,68 @@ defineComponents({
 
 ## Api
 
+### 总览
+
+| 方法                  | 说明                           |
+| --------------------- | ------------------------------ |
+| checkForNewVersion    | 检测是否有新版本               |
+| closeWebView          | 关闭当前 webview               |
+| definePermissionUsage | 定义隐私权限协议文案           |
+| getDeviceInfo         | 获取设备信息                   |
+| runAction             | 执行 action                    |
+| saveImageToLocal      | 保存图片到本地                 |
+| saveVideoToLocal      | 保存视频到本地                 |
+| setWebViewTitle       | 设置网页标题                   |
+| defineShareModel      | 设置当前页面分享时显示卡片样式 |
+| defineShareModelState | 定义分享面板控件布局           |
+| invokeShareModal      | 主动唤起更多分享模态框         |
+| sharePoster           | 分享海报                       |
+| getAppLoginInfo       | 获取用户登录信息               |
+| generateKBSign        | 生成 kbsign                    |
+
+| 枚举          | 说明             |
+| ------------- | ---------------- |
+| JSBridgeCode  | kbapp 桥接状态码 |
+| AppLoginModel | 登录信息 model   |
+
+### 登录设计
+
+以小程序运行逻辑参考
+
+#### 如果是点击某个按钮再执行登录的情况
+
+提供装饰器, 注入回调函数
+
+```js
+const onTapSomeButton = decorateLogin(() => {
+    // Todo someting
+})
+```
+
+该装饰器执行逻辑为如果未登录, 则执行登录操作(跳转到登录页面, 登录成功后回退到当前页), 并直接抛出异常, 不做 _监听登录成功后执行回调函数_ 操作
+
+> 那岂不是用户登陆完成后回到当页面还需与再点一下
+
+没错, 的确要这么设计, 原因是为了解 如果点击了 2 个通过装饰器包装的按钮, 登陆成功后, 2 个按钮的回调事件将会全部执行(其实也有办法解决, 只是多点代码) 这种情况, 测试较真的话, 真是个问题
+
+#### 如果是某个组件/页面加载的时候就得登录才能正常操作
+
+重新设计一个 onMountedWithLogin
+
+```js
+onMountedWithLogin(() => {
+    // Todo someting
+})
+```
+
+同 onMounted, 只在页面加载的时候执行一次, 只有登录成功后, 才执行回调函数, 如果没有登录, 则执行直接抛出异常, 并执行登录操作
+
+> 那岂不是, 该页面如果没有被销毁的话, 就算登录成功, 页面也不回触发登录回调
+
+是的, 要解决这个问题, 要么执行登录成功的时候, 页面要被销毁重新加载, 要么 onShow 的时候, 也做检查(页面组件似乎没有 onShow)
+
+其中最终的目的就是禁止出现监听登录成功事件无限累加, 曾经在这上面吃了不少的亏
+
 ### saveImageToLocal
 
 > 保存图片到本地
@@ -99,7 +161,11 @@ Promise<{ errCode: JSBridgeCode }>
 
 ---
 
-### invokeMoreShareModal
+### defineShareModelState
+
+---
+
+### invokeShareModal
 
 > 唤起分享更多模态框
 
@@ -243,7 +309,7 @@ if (await canIUse('sharePoster')) {
 
 ---
 
-### defineShareAppMessage
+### defineShareModel
 
 > 定义当前页面分享文案
 
@@ -302,7 +368,7 @@ Promise<{
 
 ### triggerAppLogin
 
-> 唤起app登录. 如果已登录,将直接返回登录信息
+> 唤起 app 登录. 如果已登录,将直接返回登录信息
 
 #### 请求参数
 

package/dist/core/index.d.ts

@@ -1,22 +1,8 @@
-/** 桥接 */
-export declare const $bridge: {
-    registerHandler: (name: any, registerCallback: any) => void;
-    callHandler: (name: any, params: any, callback: any) => void;
-} | {
-    default: undefined;
-    /** 桥接 */
-    callHandler: (method: any, args: any, cb: any) => any;
-    register: (name: any, fun: any, asyn: any) => void;
-    registerHandler: (name: any, fun: any) => void;
-} | {
-    registerHandler(name: string, cb: (data: unknown, cb: (data: Record<string, any>) => void) => void): void;
-    callHandler(name: string, params: any, callback: (...params: any) => void): void;
-};
 /**
  *
  * @description 注册事件 提供给native端调用
  */
-export declare const registerHandler: (name: string, cb: (data: unknown, cb: (data: Record<string, any>) => void) => void) => void;
+export declare const registerHandler: <Data = unknown>(name: string, cb: (data: Data, cb: (data: Record<string, any>) => void) => void) => void;
 /**
  *
  * @description 主动触发 触发native端任务

package/dist/core/index.js

@@ -12,12 +12,12 @@ var __assign = (this && this.__assign) || function () {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.callHandlerPromise = exports.callHandler = exports.registerHandler = exports.$bridge = void 0;
+exports.callHandlerPromise = exports.callHandler = exports.registerHandler = void 0;
 var js_bridge_1 = require("./lib/js-bridge");
 var ds_bridge_1 = require("./lib/ds-bridge");
 var flutter_ds_bridge_1 = require("./lib/flutter-ds-bridge");
 /** 桥接 */
-exports.$bridge = (function (user_agent) {
+var $bridge = (function (user_agent) {
     if (!/(kb)/i.test(user_agent)) {
         return {
             registerHandler: function (name, cb) {
@@ -40,13 +40,13 @@ exports.$bridge = (function (user_agent) {
  *
  * @description 注册事件 提供给native端调用
  */
-exports.registerHandler = exports.$bridge.registerHandler;
+exports.registerHandler = $bridge.registerHandler;
 /**
  *
  * @description 主动触发 触发native端任务
  */
 var callHandler = function (data) {
-    exports.$bridge.callHandler(data.name, data.params, function (res) {
+    $bridge.callHandler(data.name, data.params, function (res) {
         var _a, _b, _c;
         var result;
         try {

package/dist/index.d.ts

@@ -1,9 +1,8 @@
 export * from './lib/can-i-use';
 export * from './lib/check-for-new-version';
 export * from './lib/close-webview';
-export * from './lib/define-share-app-message';
+export * from './lib/share-model';
 export * from './lib/get-device-info';
-export * from './lib/invoke-more-share-modal';
 export * from './lib/js-bridge-code';
 export * from './lib/run-action';
 export * from './lib/save-image-to-local';
@@ -11,3 +10,5 @@ export * from './lib/save-video-to-local';
 export * from './lib/set-webview-title';
 export * from './lib/share-poster';
 export * from './lib/trigger-login';
+export * from './lib/define-permission-usage';
+export * from './lib/generate-kb-sign';

package/dist/index.js

@@ -17,9 +17,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./lib/can-i-use"), exports);
 __exportStar(require("./lib/check-for-new-version"), exports);
 __exportStar(require("./lib/close-webview"), exports);
-__exportStar(require("./lib/define-share-app-message"), exports);
+__exportStar(require("./lib/share-model"), exports);
 __exportStar(require("./lib/get-device-info"), exports);
-__exportStar(require("./lib/invoke-more-share-modal"), exports);
 __exportStar(require("./lib/js-bridge-code"), exports);
 __exportStar(require("./lib/run-action"), exports);
 __exportStar(require("./lib/save-image-to-local"), exports);
@@ -27,3 +26,5 @@ __exportStar(require("./lib/save-video-to-local"), exports);
 __exportStar(require("./lib/set-webview-title"), exports);
 __exportStar(require("./lib/share-poster"), exports);
 __exportStar(require("./lib/trigger-login"), exports);
+__exportStar(require("./lib/define-permission-usage"), exports);
+__exportStar(require("./lib/generate-kb-sign"), exports);

package/dist/lib/can-i-use.d.ts

@@ -1,4 +1,4 @@
-type JSBridgeMethod = 'invokeMoreShareModal' | 'saveImageToLocal' | 'saveVideoToLocal' | 'sharePoster' | 'setWebViewTitle' | 'checkForNewVersion';
+type JSBridgeMethod = 'invokeShareModal' | 'saveImageToLocal' | 'saveVideoToLocal' | 'sharePoster' | 'setWebViewTitle' | 'checkForNewVersion' | 'defineShareModelState';
 /**
  *
  * @description 判断某个桥接能否在当前app版本中使用

package/dist/lib/can-i-use.js

@@ -60,6 +60,8 @@ function canIUse(/** 方法名 */ method) {
                         case 'saveVideoToLocal':
                         case 'saveImageToLocal':
                             return [2 /*return*/, deviceInfo.vcode >= 69011];
+                        case 'defineShareModelState':
+                            return [2 /*return*/, deviceInfo.vcode >= 70601];
                         default:
                             return [2 /*return*/, true];
                     }

package/dist/lib/define-permission-usage.d.ts

@@ -0,0 +1,27 @@
+/**
+ *
+ * @description 相关权限
+ */
+declare enum PermissionUsage {
+    /** 麦克风 */
+    MICROPHONE = "microphone",
+    /** 摄像机 */
+    CAMERA = "camera",
+    /** 地理位置 */
+    LOCATION = "location"
+}
+/**
+ *
+ * @description 定义相关隐私政策文案, 用于网页授权相关权限时候, 提醒用户
+ * @example ```js
+definePermissionUsage({
+    microphone: { description: '用于发帖上传音频' },
+    location: { description: '获取你选择的位置信息，用于线下导航服务' },
+    camera: { description: '收集你选中的照片或视频信息 ，用于 发表评论、分享视频' },
+})
+```
+ */
+export declare function definePermissionUsage(config: Partial<Record<PermissionUsage, {
+    description: string;
+}>>): void;
+export {};

package/dist/lib/define-permission-usage.js

@@ -0,0 +1,41 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.definePermissionUsage = void 0;
+var core_1 = require("../core");
+/**
+ *
+ * @description 相关权限
+ */
+var PermissionUsage;
+(function (PermissionUsage) {
+    /** 麦克风 */
+    PermissionUsage["MICROPHONE"] = "microphone";
+    /** 摄像机 */
+    PermissionUsage["CAMERA"] = "camera";
+    /** 地理位置 */
+    PermissionUsage["LOCATION"] = "location";
+})(PermissionUsage || (PermissionUsage = {}));
+var SelfPermissionUsageDescription = (_a = {},
+    _a[PermissionUsage.MICROPHONE] = { description: '用于发帖上传音频' },
+    _a[PermissionUsage.LOCATION] = { description: '获取你选择的位置信息，用于线下导航服务' },
+    _a[PermissionUsage.CAMERA] = { description: '收集你选中的照片或视频信息 ，用于 发表评论、分享视频' },
+    _a);
+/**
+ *
+ * @description 定义相关隐私政策文案, 用于网页授权相关权限时候, 提醒用户
+ * @example ```js
+definePermissionUsage({
+    microphone: { description: '用于发帖上传音频' },
+    location: { description: '获取你选择的位置信息，用于线下导航服务' },
+    camera: { description: '收集你选中的照片或视频信息 ，用于 发表评论、分享视频' },
+})
+```
+ */
+function definePermissionUsage(config) {
+    Object.assign(SelfPermissionUsageDescription, config);
+    (0, core_1.registerHandler)('getPermissionUsage', function (data, callback) {
+        callback(SelfPermissionUsageDescription[data.permission]);
+    });
+}
+exports.definePermissionUsage = definePermissionUsage;

package/dist/lib/generate-kb-sign.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ * @description 生成kbSign
+ */
+export declare const generateKBSign: (params: {
+    [key: string]: any;
+    kbSignTime: number;
+    kbSignType: number;
+}) => Promise<string>;

package/dist/lib/generate-kb-sign.js

@@ -0,0 +1,75 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+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.generateKBSign = void 0;
+var core_1 = require("src/core");
+/**
+ *
+ * @description 生成kbSign
+ */
+var generateKBSign = function (params) { return __awaiter(void 0, void 0, void 0, function () {
+    var kbKey, tempData, data;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                kbKey = params.kbKey, tempData = __rest(params, ["kbKey"]);
+                return [4 /*yield*/, (0, core_1.callHandlerPromise)({
+                        name: 'OpenActRequest',
+                        params: {
+                            type: 51,
+                            data: tempData,
+                        },
+                    })];
+            case 1:
+                data = (_a.sent()).data;
+                return [2 /*return*/, data];
+        }
+    });
+}); };
+exports.generateKBSign = generateKBSign;

package/dist/lib/js-bridge-code.d.ts

@@ -4,5 +4,7 @@
  */
 export declare enum JSBridgeCode {
     /** 当前版本不支持 */
-    UNSUPPORTED_VERSION = 1001
+    UNSUPPORTED_VERSION = 1001,
+    /** 未登录 */
+    UN_LOGIN = 1002
 }

package/dist/lib/js-bridge-code.js

@@ -9,4 +9,6 @@ var JSBridgeCode;
 (function (JSBridgeCode) {
     /** 当前版本不支持 */
     JSBridgeCode[JSBridgeCode["UNSUPPORTED_VERSION"] = 1001] = "UNSUPPORTED_VERSION";
+    /** 未登录 */
+    JSBridgeCode[JSBridgeCode["UN_LOGIN"] = 1002] = "UN_LOGIN";
 })(JSBridgeCode || (exports.JSBridgeCode = JSBridgeCode = {}));

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

@@ -0,0 +1,69 @@
+/**
+ *
+ * @description 设置当前页面 分享时 显示的文案内容封面等
+ *
+ * **示例代码**
+```js
+import { defineShareModel } from '@kbapp/js-bridge';
+
+defineShareModel({
+    title: '分享标题',
+    content: '分享内容',
+    imgUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png', // 分享图片
+    url: 'http://www.kaiba315.com.cn/' // 分享网页地址
+})
+```
+ */
+export declare function defineShareModel(data: {
+    /** 标题 */
+    title: string;
+    /** 内容 */
+    content: string;
+    /** 封面图片 */
+    imgUrl: string;
+    /** url */
+    url: string;
+    /** qqUrl */
+    qqUrl?: string;
+    /** 天目打点 */
+    tmuTrack?: any;
+}): void;
+/**
+ *
+ * @description 定义页面右上角分享更多按钮显示以及分享面板
+ *
+ */
+export declare function defineShareModelState(params: {
+    /** 显示右上角 ...菜单. 默认true */
+    showMenu: boolean;
+    /** 显示分享面板布局, 0:正常显示. 1:只显示复制链接,浏览器打开相关. 2:只显示分享微信、QQ等. 默认 0 */
+    panelStyle: 0 | 1 | 2;
+}): void;
+/**
+ *
+ * @description 主动唤起更多分享模态框
+ *
+ *
+ * **示例代码**
+```js
+import { invokeShareModal } from '@kbapp/js-bridge';
+
+invokeShareModal({
+    title: '开吧分享',
+    content: '开吧，开汽车上新生活！',
+    url: 'http://www.kaiba315.com.cn/',
+    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png'
+})
+```
+ *
+ */
+export declare function invokeShareModal(data: {
+    /** 分享出去的h5地址 */
+    url: string;
+    /** 分享出去的标题 */
+    title: string;
+    /** 分享出去的正文内容 */
+    content: string;
+    /** 分享出去的封面图片 */
+    imageUrl: string;
+}): void;

package/dist/lib/share-model.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invokeShareModal = exports.defineShareModelState = exports.defineShareModel = void 0;
+var core_1 = require("../core");
+/**
+ *
+ * @description 设置当前页面 分享时 显示的文案内容封面等
+ *
+ * **示例代码**
+```js
+import { defineShareModel } from '@kbapp/js-bridge';
+
+defineShareModel({
+    title: '分享标题',
+    content: '分享内容',
+    imgUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png', // 分享图片
+    url: 'http://www.kaiba315.com.cn/' // 分享网页地址
+})
+```
+ */
+function defineShareModel(data) {
+    (0, core_1.registerHandler)('CommonShare', function (_, callback) {
+        callback({
+            type: 12,
+            data: data,
+        });
+    });
+    (0, core_1.registerHandler)('CommonRequest', function (_, callback) {
+        callback({
+            type: 12,
+            data: data,
+        });
+    });
+}
+exports.defineShareModel = defineShareModel;
+/**
+ *
+ * @description 定义页面右上角分享更多按钮显示以及分享面板
+ *
+ */
+function defineShareModelState(params) {
+    (0, core_1.callHandler)({
+        name: 'OpenActRequest',
+        params: {
+            type: 68,
+            data: {
+                show: params.showMenu || true,
+                showActionMode: params.panelStyle || 0
+            },
+        },
+    });
+}
+exports.defineShareModelState = defineShareModelState;
+/**
+ *
+ * @description 主动唤起更多分享模态框
+ *
+ *
+ * **示例代码**
+```js
+import { invokeShareModal } from '@kbapp/js-bridge';
+
+invokeShareModal({
+    title: '开吧分享',
+    content: '开吧，开汽车上新生活！',
+    url: 'http://www.kaiba315.com.cn/',
+    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png'
+})
+```
+ *
+ */
+function invokeShareModal(data) {
+    (0, core_1.callHandler)({
+        name: 'OpenActRequest',
+        params: {
+            type: 58,
+            data: data,
+        },
+    });
+}
+exports.invokeShareModal = invokeShareModal;

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

@@ -2,11 +2,11 @@
  *
  * @description 登录信息
  */
-export type AppLoginInfo = {
+export declare class AppLoginModel {
     /** 车牌号:例如浙A999999 */
-    carNo: string;
+    carNo?: string;
     /** 未知 */
-    role: number;
+    role?: number;
     /** 手机号 */
     mobile: string;
     /** 性别 */
@@ -20,17 +20,23 @@ export type AppLoginInfo = {
     /** 用户id */
     userId: number;
     /** 用户名 */
-    userName: string;
-};
+    userName?: string;
+}
 /**
  *
  * @description 获取用户登录信息.如果未登录返回null
  */
-export declare function getAppLoginInfo(): Promise<AppLoginInfo | null>;
+export declare function getAppLoginInfo(): Promise<AppLoginModel | null>;
 /**
  *
- * @description 登录完成会触发回调函数,调用该时将会立刻检测当前是否登录
- * @param {(loginInfo: AppLoginInfo) => void} callback 登录成功回调
+ * @description 触发登录
+ * 如果已登录,将直接返回登录信息, 请通过 `watchAppLoginSuccess` 监听登录成功事件
+ */
+export declare function triggerAppLogin(): Promise<AppLoginModel>;
+/**
+ *
+ * @description 注册监听app登录成功, 监听时候立刻执行检测一次, 注意,该函数仅读取登录信息, 不会触发登录
+ * @param {(loginInfo: AppLoginModel) => void} callback 登录成功回调
  * @returns {() => void} 调用该函数取消监听
  *
  * **示例代码**
@@ -42,22 +48,6 @@ const handle = watchAppLoginSuccess(() => {
 })
 
 // handle() 停止监听
-
-```
- */
-export declare const watchAppLoginSuccess: (callback: (loginInfo: AppLoginInfo) => void) => () => void;
-/**
- *
- * @description 触发登录.如果未登录,将会唤起登录弹窗,已登录则返回登录信息
- * @param {(loginInfo: AppLoginInfo) => void} [callback] 可选 登录成功回调,通过 onAppLoginSuccess 实现
- *
- * 该函数返回结果未采用返回promise值,原因在于避免多次进入promise阻塞挂起状态,待登录完成后,无法避免触发多次的情况
- *
- * **示例代码**
-```js
-import { triggerAppLogin } from '@kbapp/js-bridge';
-
-triggerAppLogin()
 ```
  */
-export declare function triggerAppLogin(callback?: (loginInfo: AppLoginInfo) => void): Promise<void>;
+export declare const watchAppLoginSuccess: (callback: (loginInfo: AppLoginModel) => void) => () => void;

package/dist/lib/trigger-login.js

@@ -36,8 +36,19 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.triggerAppLogin = exports.watchAppLoginSuccess = exports.getAppLoginInfo = void 0;
+exports.watchAppLoginSuccess = exports.triggerAppLogin = exports.getAppLoginInfo = exports.AppLoginModel = void 0;
+var js_bridge_code_1 = require("./js-bridge-code");
 var core_1 = require("../core");
+/**
+ *
+ * @description 登录信息
+ */
+var AppLoginModel = /** @class */ (function () {
+    function AppLoginModel() {
+    }
+    return AppLoginModel;
+}());
+exports.AppLoginModel = AppLoginModel;
 /**
  *
  * @description 获取用户登录信息.如果未登录返回null
@@ -103,7 +114,7 @@ var watchAppLoginSuccessTask = (function () {
         };
     })();
     return {
-        /** 监听登录信息,纯粹监听 */
+        /** 注册监听事件(需要通过triggerCheckTask触发检测任务) */
         addTask: function (callback) {
             watchHandles.add(callback);
         },
@@ -114,7 +125,7 @@ var watchAppLoginSuccessTask = (function () {
                 resetCheckTask.stop();
             }
         },
-        /** 触发定时检测任务 */
+        /** 触发定时检测是否登录成功任务 */
         triggerCheckTask: function () {
             resetCheckTask.start();
         },
@@ -122,8 +133,45 @@ var watchAppLoginSuccessTask = (function () {
 })();
 /**
  *
- * @description 登录完成会触发回调函数,调用该时将会立刻检测当前是否登录
- * @param {(loginInfo: AppLoginInfo) => void} callback 登录成功回调
+ * @description 触发登录
+ * 如果已登录,将直接返回登录信息, 请通过 `watchAppLoginSuccess` 监听登录成功事件
+ */
+function triggerAppLogin() {
+    return __awaiter(this, void 0, void 0, function () {
+        var loginInfo;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, getAppLoginInfo()];
+                case 1:
+                    loginInfo = _a.sent();
+                    if (loginInfo) {
+                        return [2 /*return*/, loginInfo];
+                    }
+                    watchAppLoginSuccessTask.triggerCheckTask();
+                    /**
+                     * 当reqiureLogin为true时用户取消登录或者, 第三方登录, 均不会触发回调
+                     * 只有当用户完成登录流程(第三方不支持)才会回调
+                     */
+                    (0, core_1.callHandler)({
+                        name: 'OpenActRequest',
+                        params: { type: 31, data: { requireLogin: true } },
+                        success: function (result) {
+                            var _a;
+                            if ((_a = result.data) === null || _a === void 0 ? void 0 : _a.userId) {
+                                watchAppLoginSuccessTask.triggerCheckTask();
+                            }
+                        },
+                    });
+                    return [2 /*return*/, Promise.reject({ errCode: js_bridge_code_1.JSBridgeCode.UN_LOGIN })];
+            }
+        });
+    });
+}
+exports.triggerAppLogin = triggerAppLogin;
+/**
+ *
+ * @description 注册监听app登录成功, 监听时候立刻执行检测一次, 注意,该函数仅读取登录信息, 不会触发登录
+ * @param {(loginInfo: AppLoginModel) => void} callback 登录成功回调
  * @returns {() => void} 调用该函数取消监听
  *
  * **示例代码**
@@ -135,7 +183,6 @@ const handle = watchAppLoginSuccess(() => {
 })
 
 // handle() 停止监听
-
 ```
  */
 var watchAppLoginSuccess = function (callback) {
@@ -146,42 +193,3 @@ var watchAppLoginSuccess = function (callback) {
     };
 };
 exports.watchAppLoginSuccess = watchAppLoginSuccess;
-/**
- *
- * @description 触发登录.如果未登录,将会唤起登录弹窗,已登录则返回登录信息
- * @param {(loginInfo: AppLoginInfo) => void} [callback] 可选 登录成功回调,通过 onAppLoginSuccess 实现
- *
- * 该函数返回结果未采用返回promise值,原因在于避免多次进入promise阻塞挂起状态,待登录完成后,无法避免触发多次的情况
- *
- * **示例代码**
-```js
-import { triggerAppLogin } from '@kbapp/js-bridge';
-
-triggerAppLogin()
-```
- */
-function triggerAppLogin(callback) {
-    if (callback === void 0) { callback = function () { }; }
-    return __awaiter(this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            watchAppLoginSuccessTask.addTask(callback);
-            watchAppLoginSuccessTask.triggerCheckTask();
-            /**
-             * 当reqiureLogin为true时用户取消登录或者, 第三方登录, 均不会触发回调
-             * 只有当用户完成登录流程(第三方不支持)才会回调
-             */
-            (0, core_1.callHandler)({
-                name: 'OpenActRequest',
-                params: { type: 31, data: { requireLogin: true } },
-                success: function (result) {
-                    var _a;
-                    if ((_a = result.data) === null || _a === void 0 ? void 0 : _a.userId) {
-                        watchAppLoginSuccessTask.triggerCheckTask();
-                    }
-                },
-            });
-            return [2 /*return*/];
-        });
-    });
-}
-exports.triggerAppLogin = triggerAppLogin;

package/package.json

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

package/dist/lib/define-share-app-message.d.ts

@@ -1,30 +0,0 @@
-/**
- *
- * @description 设置当前页面 分享时 显示的文案内容封面等
- *
- * **示例代码**
-```js
-import { defineShareAppMessage } from '@kbapp/js-bridge';
-
-defineShareAppMessage({
-    title: '分享标题',
-    content: '分享内容',
-    imgUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png', // 分享图片
-    url: 'http://www.kaiba315.com.cn/' // 分享网页地址
-})
-```
- */
-export declare function defineShareAppMessage(data: {
-    /** 标题 */
-    title: string;
-    /** 内容 */
-    content: string;
-    /** 封面图片 */
-    imgUrl: string;
-    /** url */
-    url: string;
-    /** qqUrl */
-    qqUrl?: string;
-    /** 天目打点 */
-    tmuTrack?: any;
-}): void;

package/dist/lib/define-share-app-message.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineShareAppMessage = void 0;
-var core_1 = require("../core");
-/**
- *
- * @description 设置当前页面 分享时 显示的文案内容封面等
- *
- * **示例代码**
-```js
-import { defineShareAppMessage } from '@kbapp/js-bridge';
-
-defineShareAppMessage({
-    title: '分享标题',
-    content: '分享内容',
-    imgUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png', // 分享图片
-    url: 'http://www.kaiba315.com.cn/' // 分享网页地址
-})
-```
- */
-function defineShareAppMessage(data) {
-    (0, core_1.registerHandler)('CommonShare', function (_, callback) {
-        callback({
-            type: 12,
-            data: data,
-        });
-    });
-    (0, core_1.registerHandler)('CommonRequest', function (_, callback) {
-        callback({
-            type: 12,
-            data: data,
-        });
-    });
-}
-exports.defineShareAppMessage = defineShareAppMessage;

package/dist/lib/invoke-more-share-modal.d.ts

@@ -1,28 +0,0 @@
-/**
- *
- * @description 唤起更多分享模态框
- *
- *
- * **示例代码**
-```js
-import { invokeMoreShareModal } from '@kbapp/js-bridge';
-
-invokeMoreShareModal({
-    title: '开吧分享',
-    content: '开吧，开汽车上新生活！',
-    url: 'http://www.kaiba315.com.cn/',
-    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png'
-})
-```
- *
- */
-export declare function invokeMoreShareModal(data: {
-    /** 分享出去的h5地址 */
-    url: string;
-    /** 分享出去的标题 */
-    title: string;
-    /** 分享出去的正文内容 */
-    content: string;
-    /** 分享出去的封面图片 */
-    imageUrl: string;
-}): void;

package/dist/lib/invoke-more-share-modal.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.invokeMoreShareModal = void 0;
-var core_1 = require("../core");
-/**
- *
- * @description 唤起更多分享模态框
- *
- *
- * **示例代码**
-```js
-import { invokeMoreShareModal } from '@kbapp/js-bridge';
-
-invokeMoreShareModal({
-    title: '开吧分享',
-    content: '开吧，开汽车上新生活！',
-    url: 'http://www.kaiba315.com.cn/',
-    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png'
-})
-```
- *
- */
-function invokeMoreShareModal(data) {
-    (0, core_1.callHandler)({
-        name: 'OpenActRequest',
-        params: {
-            type: 58,
-            data: data,
-        },
-    });
-}
-exports.invokeMoreShareModal = invokeMoreShareModal;