@kbapp/js-bridge 0.2.1-alpha.0 → 0.2.3-alpha.0

package/README.MD

@@ -7,28 +7,45 @@
 npm:
 
 ```js
-npm i '@kbapp/js-bridge'
+npm i @kbapp/js-bridge
 ```
 
 yarn:
 
 ```js
-yarn add '@kbapp/js-bridge'
+yarn add @kbapp/js-bridge
 ```
 
 pnpm:
 
 ```js
-pnpm add '@kbapp/js-bridge'
+pnpm add @kbapp/js-bridge
 ```
 
 ## 示例
 
 ```js
-import { saveImageToLocal } from '@kbapp/js-bridge'
-
-saveImageToLocal({
-    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png',
+import { saveImageToLocal, JSBridgeCode } from '@kbapp/js-bridge'
+
+defineComponents({
+    /** 保存图片案例 */
+    async saveImageHandle() {
+        try {
+            await saveImageToLocal({
+                imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png',
+            })
+        } catch (error) {
+            switch (error.errCode) {
+                case JSBridgeCode.UNSUPPORTED_VERSION:
+                    // 用户当前版本为支持该桥接,此时应当引导用户升级app
+                    // 用户同意后,可以调用 checkForNewVersion()或者前往应用商城
+                    return
+
+                default:
+                    return
+            }
+        }
+    },
 })
 ```
 
@@ -46,7 +63,15 @@ saveImageToLocal({
 
 #### 返回值
 
-无
+```js
+Promise<void>
+```
+
+#### 异常返回值
+
+```js
+Promise<{ errCode: KbappJsBridgeCode }>
+```
 
 ---
 
@@ -62,7 +87,15 @@ saveImageToLocal({
 
 #### 返回值
 
-无
+```js
+Promise<void>
+```
+
+#### 异常返回值
+
+```js
+Promise<{ errCode: KbappJsBridgeCode }>
+```
 
 ---
 
@@ -81,7 +114,9 @@ saveImageToLocal({
 
 #### 返回值
 
-无
+```js
+void
+```
 
 ---
 
@@ -97,8 +132,96 @@ saveImageToLocal({
 
 #### 返回值
 
+```js
+Promise<void>
+```
+
+#### 异常返回值
+
+```js
+Promise<{ errCode: KbappJsBridgeCode }>
+```
+
+---
+
+### setWebViewTitle
+
+> 设置网页标题(建议通过 document.title 设置)
+
+#### 请求参数
+
+| 参数  | 值类型 | 必填? | 说明             |
+| ----- | ------ | ----- | ---------------- |
+| title | string | 必填  | webview 标题文案 |
+
+#### 返回值
+
+```js
+Promise<void>
+```
+
+#### 异常返回值
+
+```js
+Promise<{ errCode: KbappJsBridgeCode }>
+```
+
+---
+
+### checkForNewVersion
+
+> 检测是否有新版本可用, iOS 无论是否有最新版本都直接跳转到应用商店, 安卓如果有新版,则弹窗提示,没有的话 toast 提示无新版本
+
+#### 请求参数
+
 无
 
+#### 返回值
+
+```js
+void
+```
+
+---
+
+### canIUse
+
+> 检测某个方法能被当前版本使用
+
+#### 请求参数
+
+传入方法名(string)
+
+#### 返回值
+
+```js
+Promise<boolean>
+```
+
+#### 示例
+
+```js
+import { canIUse } from '@kbapp/js-bridge';
+
+if (await canIUse('sharePoster')) {
+    console.log('当前app版本能使用')
+} else {
+    console.log('请升级app')
+}
+```
+
+---
+
+### JSBridgeCode
+
+> 错误码枚举
+
+#### 键值对
+
+| key                 | value | 说明                                                   |
+| ------------------- | ----- | ------------------------------------------------------ |
+| UNSUPPORTED_VERSION | 1001  | 用户当前 app 版本不支持该 桥接(此时请引导用户升级 app) |
+
 ## 常见问题
 
 1. 桥接触发无反应: 请检查当前是否处于开吧 app 内,以及当前网页是否在白名单内

package/dist/core/index.d.ts

@@ -33,3 +33,16 @@ export declare const callHandler: <Result>(data: {
     /** 成功或失败均触发.有且当该任务有回调时触发 */
     complete?: (() => void) | undefined;
 }) => void;
+/**
+ *
+ * @description promise版本 callHandle
+ */
+export declare function callHandlerPromise<Result>(data: {
+    /** 任务名称 */
+    name: string;
+    /** 任务参数 */
+    params: {
+        type: number;
+        data?: any;
+    };
+}): Promise<Result>;

package/dist/core/index.js

@@ -1,6 +1,17 @@
 "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);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.callHandler = exports.registerHandler = exports.$bridge = void 0;
+exports.callHandlerPromise = exports.callHandler = exports.registerHandler = exports.$bridge = 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");
@@ -43,3 +54,13 @@ var callHandler = function (data) {
     });
 };
 exports.callHandler = callHandler;
+/**
+ *
+ * @description promise版本 callHandle
+ */
+function callHandlerPromise(data) {
+    return new Promise(function (resolve, reject) {
+        (0, exports.callHandler)(__assign(__assign({}, data), { success: resolve, fail: reject }));
+    });
+}
+exports.callHandlerPromise = callHandlerPromise;

package/dist/index.d.ts

@@ -1,3 +1,6 @@
+export { JSBridgeCode } from './lib/js-bridge-code';
+export { canIUse } from './lib/can-i-use';
+export { getDeviceInfo } from './lib/get-device-info';
 /**
  *
  * @description 唤起更多分享模态框
@@ -15,7 +18,6 @@ invokeMoreShareModal({
 })
 ```
  *
- * @returns {void} 该函数无返回值
  */
 export declare function invokeMoreShareModal(data: {
     /** 分享出去的h5地址 */
@@ -29,7 +31,7 @@ export declare function invokeMoreShareModal(data: {
 }): void;
 /**
  *
- * @description 保存图片到本地.
+ * @description 保存图片到本地. app版本要求6.90.11
  *
  * **示例代码**
 ```js
@@ -40,15 +42,14 @@ saveImageToLocal({
 })
 ```
  *
- * @returns {void} 无法确认是否正常保存,因此该函数无返回值
  */
-export declare function saveImageToLocal(data: {
+export declare const saveImageToLocal: (data: {
     /** 图片url(仅支持网络地址) */
     imageUrl: string;
-}): void;
+}) => Promise<void>;
 /**
  *
- * @description 保存视频到本地.
+ * @description 保存视频到本地. app版本要求6.90.11
  *
  * **示例代码**
 ```js
@@ -59,15 +60,14 @@ saveVideoToLocal({
 })
 ```
  *
- * @returns {void} 无法确认是否正常保存,因此该函数无返回值
  */
-export declare function saveVideoToLocal(data: {
+export declare const saveVideoToLocal: (data: {
     /** 视频url(仅支持网络地址) */
     videoUrl: string;
-}): void;
+}) => Promise<void>;
 /**
  *
- * @description 分享海报
+ * @description 分享海报 app版本要求6.90.11
  * **示例代码**
 ```js
 import { sharePoster } from '@kbapp/js-bridge';
@@ -77,7 +77,38 @@ sharePoster({
 })
 ```
  */
-export declare function sharePoster(data: {
+export declare const sharePoster: (data: {
     /** 图片(仅支持网络地址,jpg/png) */
     imageUrl: string;
-}): void;
+}) => Promise<void>;
+/**
+ *
+ * @description 设置网页标题(建议通过document.title设置), app版本要求6.90.11
+ *
+ * **示例代码**
+```js
+import { setWebViewTitle } from '@kbapp/js-bridge';
+
+setWebViewTitle({
+    title: '开吧标题'
+})
+```
+ */
+export declare const setWebViewTitle: (data: {
+    /** 网页标题 */
+    title: string;
+}) => Promise<void>;
+/**
+ *
+ * @description 检测是否有新版本可用, iOS无论是否有最新版本都直接跳转到应用商店, 安卓如果有新版, 则弹窗提示, 没有的话toast提示无新版本
+ *
+ * **示例代码**
+```js
+import { checkForNewVersion } from '@kbapp/js-bridge';
+
+checkForNewVersion({
+    title: '开吧标题'
+})
+```
+ */
+export declare function checkForNewVersion(): void;

package/dist/index.js

@@ -1,7 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sharePoster = exports.saveVideoToLocal = exports.saveImageToLocal = exports.invokeMoreShareModal = void 0;
+exports.checkForNewVersion = exports.setWebViewTitle = exports.sharePoster = exports.saveVideoToLocal = exports.saveImageToLocal = exports.invokeMoreShareModal = exports.getDeviceInfo = exports.canIUse = exports.JSBridgeCode = void 0;
+var js_bridge_code_1 = require("./lib/js-bridge-code");
+Object.defineProperty(exports, "JSBridgeCode", { enumerable: true, get: function () { return js_bridge_code_1.JSBridgeCode; } });
+var can_i_use_1 = require("./lib/can-i-use");
+Object.defineProperty(exports, "canIUse", { enumerable: true, get: function () { return can_i_use_1.canIUse; } });
+var get_device_info_1 = require("./lib/get-device-info");
+Object.defineProperty(exports, "getDeviceInfo", { enumerable: true, get: function () { return get_device_info_1.getDeviceInfo; } });
 var core_1 = require("./core");
+var can_i_use_2 = require("./lib/can-i-use");
 /**
  *
  * @description 唤起更多分享模态框
@@ -19,7 +26,6 @@ invokeMoreShareModal({
 })
 ```
  *
- * @returns {void} 该函数无返回值
  */
 function invokeMoreShareModal(data) {
     (0, core_1.callHandler)({
@@ -33,7 +39,7 @@ function invokeMoreShareModal(data) {
 exports.invokeMoreShareModal = invokeMoreShareModal;
 /**
  *
- * @description 保存图片到本地.
+ * @description 保存图片到本地. app版本要求6.90.11
  *
  * **示例代码**
 ```js
@@ -44,9 +50,8 @@ saveImageToLocal({
 })
 ```
  *
- * @returns {void} 无法确认是否正常保存,因此该函数无返回值
  */
-function saveImageToLocal(data) {
+exports.saveImageToLocal = (0, can_i_use_2.decoreateCanIUse)('saveImageToLocal', function (data) {
     (0, core_1.callHandler)({
         name: 'OpenActRequest',
         params: {
@@ -54,11 +59,10 @@ function saveImageToLocal(data) {
             data: data,
         },
     });
-}
-exports.saveImageToLocal = saveImageToLocal;
+});
 /**
  *
- * @description 保存视频到本地.
+ * @description 保存视频到本地. app版本要求6.90.11
  *
  * **示例代码**
 ```js
@@ -69,9 +73,8 @@ saveVideoToLocal({
 })
 ```
  *
- * @returns {void} 无法确认是否正常保存,因此该函数无返回值
  */
-function saveVideoToLocal(data) {
+exports.saveVideoToLocal = (0, can_i_use_2.decoreateCanIUse)('saveVideoToLocal', function (data) {
     (0, core_1.callHandler)({
         name: 'OpenActRequest',
         params: {
@@ -79,11 +82,10 @@ function saveVideoToLocal(data) {
             data: data,
         },
     });
-}
-exports.saveVideoToLocal = saveVideoToLocal;
+});
 /**
  *
- * @description 分享海报
+ * @description 分享海报 app版本要求6.90.11
  * **示例代码**
 ```js
 import { sharePoster } from '@kbapp/js-bridge';
@@ -93,7 +95,7 @@ sharePoster({
 })
 ```
  */
-function sharePoster(data) {
+exports.sharePoster = (0, can_i_use_2.decoreateCanIUse)('sharePoster', function (data) {
     (0, core_1.callHandler)({
         name: 'OpenActRequest',
         params: {
@@ -101,5 +103,49 @@ function sharePoster(data) {
             data: data,
         },
     });
+});
+/**
+ *
+ * @description 设置网页标题(建议通过document.title设置), app版本要求6.90.11
+ *
+ * **示例代码**
+```js
+import { setWebViewTitle } from '@kbapp/js-bridge';
+
+setWebViewTitle({
+    title: '开吧标题'
+})
+```
+ */
+exports.setWebViewTitle = (0, can_i_use_2.decoreateCanIUse)('setWebViewTitle', function (data) {
+    (0, core_1.callHandler)({
+        name: 'OpenActRequest',
+        params: {
+            type: 64,
+            data: data,
+        },
+    });
+});
+/**
+ *
+ * @description 检测是否有新版本可用, iOS无论是否有最新版本都直接跳转到应用商店, 安卓如果有新版, 则弹窗提示, 没有的话toast提示无新版本
+ *
+ * **示例代码**
+```js
+import { checkForNewVersion } from '@kbapp/js-bridge';
+
+checkForNewVersion({
+    title: '开吧标题'
+})
+```
+ */
+function checkForNewVersion() {
+    (0, core_1.callHandler)({
+        name: 'OpenActRequest',
+        params: {
+            type: 56,
+            data: null,
+        },
+    });
 }
-exports.sharePoster = sharePoster;
+exports.checkForNewVersion = checkForNewVersion;

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

@@ -0,0 +1,13 @@
+type JSBridgeMethod = 'invokeMoreShareModal' | 'saveImageToLocal' | 'saveVideoToLocal' | 'sharePoster' | 'setWebViewTitle' | 'checkForNewVersion';
+/**
+ *
+ * @description 判断某个桥接能否在当前app版本中使用
+ * @returns {Promise<boolean>}
+ */
+export declare function canIUse(/** 方法名 */ method: JSBridgeMethod): Promise<boolean | undefined>;
+/**
+ *
+ * @description 装饰器,用于装饰在当前可用的方法
+ */
+export declare function decoreateCanIUse<CALLBACK extends (...params: any[]) => any>(method: JSBridgeMethod, cb: CALLBACK): (...params: Parameters<CALLBACK>) => Promise<ReturnType<CALLBACK>>;
+export {};

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

@@ -0,0 +1,101 @@
+"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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decoreateCanIUse = exports.canIUse = void 0;
+var get_device_info_1 = require("./get-device-info");
+var js_bridge_code_1 = require("./js-bridge-code");
+/**
+ *
+ * @description 判断某个桥接能否在当前app版本中使用
+ * @returns {Promise<boolean>}
+ */
+function canIUse(/** 方法名 */ method) {
+    return __awaiter(this, void 0, void 0, function () {
+        var deviceInfo, error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    return [4 /*yield*/, (0, get_device_info_1.getDeviceInfo)()];
+                case 1:
+                    deviceInfo = _a.sent();
+                    switch (method) {
+                        case 'sharePoster':
+                        case 'setWebViewTitle':
+                        case 'saveVideoToLocal':
+                        case 'saveImageToLocal':
+                            return [2 /*return*/, deviceInfo.vcode >= 69011];
+                        default:
+                            return [2 /*return*/, true];
+                    }
+                    return [3 /*break*/, 3];
+                case 2:
+                    error_1 = _a.sent();
+                    console.error('canIUse.接口异常,模拟结果true');
+                    return [3 /*break*/, 3];
+                case 3: return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.canIUse = canIUse;
+/**
+ *
+ * @description 装饰器,用于装饰在当前可用的方法
+ */
+function decoreateCanIUse(method, cb) {
+    return function () {
+        var params = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            params[_i] = arguments[_i];
+        }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, canIUse(method)];
+                    case 1:
+                        if (_a.sent()) {
+                            return [2 /*return*/, cb.apply(void 0, params)];
+                        }
+                        return [2 /*return*/, Promise.reject({ errCode: js_bridge_code_1.JSBridgeCode.UNSUPPORTED_VERSION })];
+                }
+            });
+        });
+    };
+}
+exports.decoreateCanIUse = decoreateCanIUse;

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

@@ -0,0 +1,5 @@
+/**
+ *
+ * @description 获取设备信息
+ */
+export declare const getDeviceInfo: () => Promise<any>;

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDeviceInfo = void 0;
+var promise_cache_1 = require("../util/promise-cache");
+var core_1 = require("../core");
+/**
+ *
+ * @description 获取设备信息
+ */
+exports.getDeviceInfo = (0, promise_cache_1.decoratePromiseCache)(function () {
+    return (0, core_1.callHandlerPromise)({
+        name: 'OpenActRequest',
+        params: {
+            type: 35,
+            data: {},
+        },
+    }).catch(function (error) {
+        // 历史遗留性问题, 该函数的返回结果不在data内
+        if (error.v) {
+            return error;
+        }
+        return Promise.reject(error);
+    });
+});

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

@@ -0,0 +1,8 @@
+/**
+ *
+ * @description kbapp桥接状态码
+ */
+export declare enum JSBridgeCode {
+    /** 当前版本不支持 */
+    UNSUPPORTED_VERSION = 1001
+}

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JSBridgeCode = void 0;
+/**
+ *
+ * @description kbapp桥接状态码
+ */
+var JSBridgeCode;
+(function (JSBridgeCode) {
+    /** 当前版本不支持 */
+    JSBridgeCode[JSBridgeCode["UNSUPPORTED_VERSION"] = 1001] = "UNSUPPORTED_VERSION";
+})(JSBridgeCode || (exports.JSBridgeCode = JSBridgeCode = {}));

package/dist/util/promise-cache.d.ts

@@ -0,0 +1,5 @@
+/**
+ *
+ * @description 缓存promise结果
+ */
+export declare function decoratePromiseCache<CB extends (...params: any[]) => any>(cb: CB): (...params: Parameters<CB>) => ReturnType<CB>;

package/dist/util/promise-cache.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decoratePromiseCache = void 0;
+/**
+ *
+ * @description 缓存promise结果
+ */
+function decoratePromiseCache(cb) {
+    var promiseResult;
+    return function () {
+        var params = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            params[_i] = arguments[_i];
+        }
+        if (promiseResult) {
+            return promiseResult;
+        }
+        promiseResult = cb.apply(void 0, params);
+        Promise.resolve(promiseResult).catch(function () {
+            promiseResult = undefined;
+        });
+        return promiseResult;
+    };
+}
+exports.decoratePromiseCache = decoratePromiseCache;

package/package.json

@@ -3,7 +3,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.2.1-alpha.0",
+    "version": "0.2.3-alpha.0",
     "description": "开吧客户端桥接",
     "main": "./dist/index.js",
     "author": "along"