@tmsfe/tms-core 0.0.73 → 0.0.76

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tms-core",
-  "version": "0.0.73",
+  "version": "0.0.76",
   "description": "tms运行时框架",
   "repository": {
     "type": "git",

package/src/index-proxy.js

@@ -8,9 +8,10 @@
 import syncApi from './syncfnmanager';
 import AutoReport from './report/proxy/index';
 import md5 from './md5';
-import { rpxToPx } from './rpx';
 import { serialize } from './objUtils';
 import { calCoordinateDistance, formatDistance } from './distanceUtils';
+import { getNavBarConfigData } from './navbarUtils';
+import * as rpxUtil from './rpx';
 import * as stringUtils from './stringUtils';
 import * as timeUtils from './timeUtils';
 import * as ipxHelper from './ipxHelper';
@@ -210,15 +211,16 @@ const api = {
   md5,
   getCarManager,
   getLocationManager,
-  rpxToPx,
   serialize,
   calCoordinateDistance,
   formatDistance,
+  getNavBarConfigData,
   createRequest,
   getEnvInfo,
   isAppPageExist,
   getHomePage,
   storage,
+  ...rpxUtil,
   ...asyncFuncs,
   ...objFuncs,
   ...syncApi,

package/src/index.js

@@ -11,7 +11,8 @@ import { callCloudFunc } from './cloudService';
 import EventDispatcher from './eventDispatcher';
 import { serialize } from './objUtils';
 import { calCoordinateDistance, formatDistance } from './distanceUtils';
-import { rpxToPx } from './rpx';
+import { rpxToPx, pxToRpx } from './rpx';
+import { getNavBarConfigData } from './navbarUtils';
 import {
   formatPlate,
   subStr,
@@ -192,6 +193,9 @@ const api = {
 
   /** rpx转px */
   rpxToPx,
+  pxToRpx,
+
+  getNavBarConfigData,
 
   storage,
 

package/src/navbarUtils.js

@@ -0,0 +1,197 @@
+let systemInfo = null;
+
+/**
+ * 获取系统信息，有缓存
+ * 返回数据同wx.getSystemInfoSync
+ * @returns {Object} 系统信息
+ */
+const getSystemInfoSync = () => {
+  if (systemInfo) return systemInfo;
+  let res;
+  try {
+    systemInfo = wx.getSystemInfoSync();
+    res = systemInfo;
+  } catch (_) {
+    res = {};
+  }
+  return res;
+};
+
+/**
+ * 获取系统信息
+ * @returns {Object} 系统信息
+ */
+const getSysInfo = () => {
+  let sysInfo = {};
+  try {
+    sysInfo = getSystemInfoSync();
+    sysInfo.getSystemInfoSuccess = true;
+  } catch (e) {
+    // 获取系统信息失败时，使用默认数据
+    sysInfo = { getSystemInfoSuccess: false, statusBarHeight: 0, windowWidth: 0 };
+  }
+  return sysInfo;
+};
+
+/**
+ * 获取胶囊位置信息
+ * @returns {Object} 胶囊位置信息
+ */
+const getMenuButtonRectInfo = () => {
+  let menuButtonRectInfo = {};
+
+  try {
+    menuButtonRectInfo = wx.getMenuButtonBoundingClientRect();
+    menuButtonRectInfo.getMenuRectInfoSuccess = true;
+  } catch (e) {
+    // 获取胶囊位置信息失败，使用默认值
+    menuButtonRectInfo = { getMenuRectInfoSuccess: false };
+  }
+
+  return menuButtonRectInfo;
+};
+
+/**
+ * 版本比较函数
+ * @param {String} sourceVersion 作为基准版本号
+ * @param {String} targetVersion 目标比较版本号
+ * @returns {Number} 比较结果
+ * 返回值说明：
+ * 1 : 大于基准版本号
+ * 0 : 等于基准版本号
+ * -1: 小于基准版本号
+ */
+const compareVersion = (sourceVersion, targetVersion) => {
+  if (typeof sourceVersion !== 'string' || typeof targetVersion !== 'string') {
+    throw new Error('版本比较参数类型有误');
+  }
+
+  const toInt = n => parseInt(n, 10); // eslint-disable-line require-jsdoc
+  const sourceArray = sourceVersion.split('.').map(toInt);
+  const targetArray = targetVersion.split('.').map(toInt);
+
+  for (let i = 0; i < sourceArray.length; i += 1) {
+    if (sourceArray[i] > targetArray[i]) {
+      return 1;
+    } if (sourceArray[i] < targetArray[i]) {
+      return -1;
+    }
+  }
+
+  return 0;
+};
+
+/**
+ * 胶囊高度适配，以兼容获取到的胶囊高度值非法的情况
+ * @param {Number} height 胶囊高度
+ * @param {Boolean} isIOS 是否是ios系统
+ * @returns {Number} 胶囊高度
+ */
+const formatMenuHeight = (height, isIOS) => {
+  if (height > 0) {
+    return height;
+  }
+
+  return isIOS ? 32 : 34;
+};
+
+/**
+ * 计算自定义导航栏布局信息
+ * @param {Boolean} isIOS          是否是ios平台
+ * @param {Number} statusBarHeight 状态栏高度
+ * @param {String} apiCategory     API类别
+ * @returns {Object} data                 导航栏布局信息
+ * @returns {Number} data.statusBarHeight 状态栏高度，单位rpx
+ * @returns {Number} data.navBarHeight    导航栏高度（不含状态栏），单位rpx
+ * @returns {Number} data.menuTop         菜单按钮上边距，单位rpx
+ * @returns {Number} data.menuRight       菜单按钮右边缘距离屏幕左边缘的距离，单位rpx
+ * @returns {Number} data.menuWidth       菜单按钮宽度，单位rpx
+ * @returns {Number} data.menuHeight      菜单按钮高度，单位rpx
+ */
+const calculateNavBarLayout = (isIOS, statusBarHeight, apiCategory) => {
+  const data = {};
+  const menuTopOnIos = statusBarHeight + 4;
+  const menuTopOnAndroid = statusBarHeight + 8; // statusBarHeight高度，不同机型差距较大，不适合写死
+  const menuRectInfo = getMenuButtonRectInfo(); // 插件下基础库2.15.0起支持
+  let { right, width, height = 0, top } = menuRectInfo;
+  // 数据有异常时使用默认值
+  if (top <= 0) {
+    top = isIOS ? menuTopOnIos : menuTopOnAndroid;
+  }
+  if (right <= 0) {
+    right = isIOS ? 368 : 383;
+  }
+  if (width < 0) {
+    width = isIOS ? 87 : 94;
+  }
+  height = formatMenuHeight(height, isIOS);
+
+  data.statusBarHeight = calStatusBarHeight(statusBarHeight, apiCategory); // 顶部状态栏高度
+  data.navBarHeight = calNavBarHeight(top, height, statusBarHeight, apiCategory); // 小程序导航栏高度
+  data.menuTop = top; // 菜单按钮上边距
+  data.menuRight = right; // 菜单按钮右边距离屏幕左边缘的距离
+  data.menuWidth = width; // 菜单按钮宽度
+  data.menuHeight = height; // 菜单按钮高度
+  return data;
+};
+
+const calStatusBarHeight = (statusBarHeight, apiCategory) => {
+  if (apiCategory !== 'embedded') return statusBarHeight;
+  return 0;
+};
+
+const calNavBarHeight = (menuTop, menuHeight, statusBarHeight, apiCategory) => {
+  if (apiCategory !== 'embedded') {
+    return menuHeight + ((menuTop - statusBarHeight) * 2);
+  }
+  return menuHeight + (7 * 2);
+};
+
+/**
+ * 获取导航栏相关信息
+ * @returns {Object} data                 导航栏布局信息
+ * @returns {Number} data.enable          是否支持自定义导航栏
+ * @returns {Number} data.statusBarHeight 状态栏高度，单位rpx
+ * @returns {Number} data.navBarHeight    导航栏高度（不含状态栏），单位rpx
+ * @returns {Number} data.menuTop         菜单按钮上边距，单位rpx
+ * @returns {Number} data.menuRight       菜单按钮右边缘距离屏幕左边缘的距离，单位rpx
+ * @returns {Number} data.menuWidth       菜单按钮宽度，单位rpx
+ * @returns {Number} data.menuHeight      菜单按钮高度，单位rpx
+ * @returns {Object} data.enterOptions             启动参数
+ * @returns {Object} data.enterOptions.apiCategory API 类别（不同apiCategory场景下的API有不同限制，UI也有不同）
+ */
+const getNavBarConfigData = () => { // eslint-disable-line require-jsdoc
+  const systemInfo = getSysInfo();
+  const { brand, getSystemInfoSuccess, platform } = systemInfo;
+  const isIOS = platform === 'ios';
+  const StatusBarHeightOnIOS = 44;
+  const StatusBarHeightOnAndroid = 24;
+  let { statusBarHeight, version } = systemInfo;
+  // 获取系统信息失败，给设置一个默认版本
+  if (!getSystemInfoSuccess || !version) {
+    version = '7.0.1';
+  }
+  // 获取状态栏高度失败 | 接口调用成功，但数据为0时，使用默认值
+  if (!getSystemInfoSuccess || (getSystemInfoSuccess && statusBarHeight <= 0)) {
+    statusBarHeight = isIOS ? StatusBarHeightOnIOS : StatusBarHeightOnAndroid;
+  }
+
+  const enable = compareVersion(version, '7.0.0') >= 0 || brand === 'devtools'; // 微信版本是否支持自定义顶栏，不支持时自动隐藏
+  const enterOptions = getEnterOptions();
+  if (enable) {
+    return { enable, ...calculateNavBarLayout(isIOS, statusBarHeight, enterOptions.apiCategory) };
+  }
+
+  return { enable };
+};
+
+// 获取需要对外暴露的启动参数
+const getEnterOptions = () => {
+  const options = wx.getEnterOptionsSync();
+  const { apiCategory = 'default' } = options || {};
+  return { apiCategory };
+};
+
+export {
+  getNavBarConfigData,
+};

package/src/report/README.md

@@ -48,7 +48,7 @@
 #### 页面自动上报事件
 ##### 一、必须上报的生命周期事件：
 1. onLoad: 页面加载
-2. onShow: 页面显示
+2. onShow: 页面显示(曝光)
 3. onReady: 页面初次渲染完成
 4. onHide: 页面隐藏
 5. onUnload: 页面卸载
@@ -56,7 +56,7 @@
 ##### 二、可能会上报的生命周期事件（取决于页面是否实现该函数）：
 1. onPullDownRefresh: 用户下拉动作
 2. onReachBottom: 页面上拉触底
-3. onShareAppMessage: 用户点击右上角转发
+3. onShareAppMessage: 用户点击右上角转发(分享)
 4. onShareTimeline: 用户点击右上角转发到朋友圈
 5. onAddToFavorites: 用户点击右上角收藏
 6. onReportPageTouch: 用户触摸页面 - 如果页面wxml有view节点则会注入该事件

package/src/report/proxy/helper.ts

@@ -68,7 +68,7 @@ function executeFunc(context: any, func: Function, args: any[], callback: Functi
   let value: any;
   try {
     value = func.apply(context, args);
-  } catch(e) {
+  } catch (e) {
     callback();
     throw e;
   }

package/src/rpx.js

@@ -12,6 +12,19 @@ const rpxToPx = (rpx) => {
   return rpx * ratio;
 };
 
+/**
+ * @description px to rpx
+ * @returns  {Number}     转换后的rpx数值
+ * @param px
+ */
+const pxToRpx = (px) => {
+  const sys = syncApi.getSystemInfoSync();
+  const ww = sys.windowWidth;
+  const ratio = 750 / ww;
+  return px * ratio;
+};
+
 export {
   rpxToPx,
+  pxToRpx,
 };