@kbapp/js-bridge 0.4.0-alpha.0 → 0.4.2-alpha.0

package/README.MD

@@ -68,12 +68,51 @@ defineComponents({
 | 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
 
 > 保存图片到本地

package/dist/index.d.ts

@@ -11,3 +11,4 @@ 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

@@ -27,3 +27,4 @@ __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/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("../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/trigger-login.d.ts

@@ -31,21 +31,11 @@ export declare function getAppLoginInfo(): Promise<AppLoginModel | null>;
  *
  * @description 触发登录
  * 如果已登录,将直接返回登录信息, 请通过 `watchAppLoginSuccess` 监听登录成功事件
- *
- * **示例代码**
-```js
-import { triggerAppLogin } from '@kbapp/js-bridge';
-
-const onTapLoginButton = async () => {
-    await triggerAppLogin()
-    // app已登录
-}
-```
  */
 export declare function triggerAppLogin(): Promise<AppLoginModel>;
 /**
  *
- * @description 注册监听app登录成功, 注册时,立刻执行检测一次
+ * @description 注册监听app登录成功, 监听时候立刻执行检测一次, 注意,该函数仅读取登录信息, 不会触发登录
  * @param {(loginInfo: AppLoginModel) => void} callback 登录成功回调
  * @returns {() => void} 调用该函数取消监听
  *

package/dist/lib/trigger-login.js

@@ -135,16 +135,6 @@ var watchAppLoginSuccessTask = (function () {
  *
  * @description 触发登录
  * 如果已登录,将直接返回登录信息, 请通过 `watchAppLoginSuccess` 监听登录成功事件
- *
- * **示例代码**
-```js
-import { triggerAppLogin } from '@kbapp/js-bridge';
-
-const onTapLoginButton = async () => {
-    await triggerAppLogin()
-    // app已登录
-}
-```
  */
 function triggerAppLogin() {
     return __awaiter(this, void 0, void 0, function () {
@@ -180,7 +170,7 @@ function triggerAppLogin() {
 exports.triggerAppLogin = triggerAppLogin;
 /**
  *
- * @description 注册监听app登录成功, 注册时,立刻执行检测一次
+ * @description 注册监听app登录成功, 监听时候立刻执行检测一次, 注意,该函数仅读取登录信息, 不会触发登录
  * @param {(loginInfo: AppLoginModel) => void} callback 登录成功回调
  * @returns {() => void} 调用该函数取消监听
  *

package/package.json

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