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

package/README.MD

@@ -76,7 +76,7 @@ defineComponents({
 | 枚举          | 说明             |
 | ------------- | ---------------- |
 | JSBridgeCode  | kbapp 桥接状态码 |
-| AppLoginModel | 登录信息 model   |
+| AppBridgedUserInfo | 登录信息 model   |
 
 ### 登录设计
 
@@ -101,7 +101,7 @@ const onTapSomeButton = decorateLogin(() => {
 
 #### 如果是某个组件/页面加载的时候就得登录才能正常操作
 
-暂时没想好, 反正也是需要禁止无限制事件类型, 小程序情况下, 某个链接点击打开小程序, 然后关闭, 再重新点链接打开小程序, 页面生命周期是重复触发onMounted
+暂时没想好, 反正也是需要禁止无限制事件类型, 小程序情况下, 某个链接点击打开小程序, 然后关闭, 再重新点链接打开小程序, 页面生命周期是重复触发 onMounted
 
 其中最终的目的就是禁止出现监听登录成功事件无限累加, 曾经在这上面吃了不少的亏
 
@@ -310,8 +310,8 @@ if (await canIUse('sharePoster')) {
 | 参数     | 值类型 | 必填? | 说明       |
 | -------- | ------ | ----- | ---------- |
 | title    | string | 必填  | 标题       |
-| content  | string | 必填  | 内容       |
-| imgUrl   | string | 必填  | 图片       |
+| content  | string | 选填  | 内容       |
+| imageUrl | string | 必填  | 图片       |
 | url      | string | 必填  | https 链接 |
 | tmuTrack | any    | 选填  | 天目埋点   |
 | qqUrl    | string | 选填  | 未知       |
@@ -333,26 +333,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 +350,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 +387,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/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/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,9 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.4.5-alpha.0",
+    "version": "0.4.6-alpha.0",
     "description": "开吧客户端桥接",
     "main": "./dist/index.js",
     "author": "along",
-    "gitHead": "1ae6636e6e5180193f58946cc75766872d786107"
+    "gitHead": "f06b59b1abcc7630357f087ee5e8cd31791ddf31"
 }