@tmsfe/tms-core 0.0.1 → 0.0.5

package/src/request.js

@@ -0,0 +1,322 @@
+/**
+ * @copyright 2021-present, Tencent, Inc. All rights reserved.
+ * @brief request.js用于发起网络请求.
+ * request模块作为基于 tms-core & tms-runtime 的应用的公共请求模块。
+ * 目前支持在出行服务小程序或基于出行服务的小程序中调用。在后续tms-runtime支持公众号H5后，
+ * 将支持在H5中调用。
+ *
+ * 考虑到对不同运行环境的支持，强依赖运行环境的依赖，比如 wx.request，应通过注入的形式提供。
+ * 框架判断在不同的运行环境，切换调用不同运行环境提供的方法。
+ */
+import md5 from './md5';
+import { getLogManager } from './log';
+import { getEnvInfo, getAuthInfo } from './env';
+
+/**
+ * 用于序列化需要签名的参数
+ * @private
+ * @param {object} param 需要序列化的参数
+ * @returns {string} 序列化之后的参数字符串
+ */
+const seriesParam = (param) => {
+  const keys = Object.keys(param)
+    .filter(key => typeof param[key] !== 'undefined')
+    .sort();
+  const series = keys.map((key) => {
+    const val = param[key];
+    return `${key}${typeof val === 'object' ? JSON.stringify(val) : val}`;
+  });
+  return series.join('');
+};
+
+/**
+ * 用于对request请求对象做签名
+ * @private
+ * @param {object} param 需要做签名的参数
+ * @returns {object} 签名后的参数对象
+ */
+const sign = (param = {}) => {
+  const token = '';
+  const signture = md5(seriesParam(param) + token);
+  return { ...param, sign: signture };
+};
+/**
+ * 用于对request请求对象添加系统参数
+ * @private
+ * @param {object} param 接口调用传入的参数
+ * @param {Boolean} withAuth 是否需要登录参数
+ * @param {object} baseParam request实例定义的基础参数
+ * @returns {object} 全部参数对象
+ */
+const composeParam = async (param = {}, withAuth = true, baseParam = {}) => {
+  const version = '1.0';
+  const { appVersion, wxAppId, client } = getEnvInfo();
+  const nonce = Math.random()
+    .toString(36)
+    .substr(2, 10);
+  const timestamp = Date.now();
+  const random = Math.random()
+    .toString()
+    .slice(2, 7);
+  const sourceId = ['', 'sinan', 'mycar'].indexOf(client) + 7; // 6 未知 7 云函数 8 出行 9 我的车
+  const seqId = `${timestamp}${sourceId}${random}`;
+  const paramsWithAuth = await modifyAuthParam(param, withAuth);
+  const combinedParam = Object.assign(
+    {
+      version,
+      appVersion,
+      nonce,
+      timestamp,
+      seqId,
+      wxAppId,
+    },
+    { ...baseParam },
+    { ...paramsWithAuth },
+  );
+  return combinedParam;
+};
+
+/**
+ * 用于保证业务参数的登录态参数，
+ * 若接口不依赖登录态 如 user/login，则保证参数中不包括userId & token,
+ * 若接口依赖登录态，则保证参数中填充userId & token,
+ * @private
+ * @param {object} param 要校验登录态的业务参数
+ * @param {boolean} withAuth 是否要校验登录态
+ * @returns {object} 增加登录态后的参数
+ */
+const modifyAuthParam = async (param, withAuth) => {
+  const requestParam = { ...param };
+  if (withAuth) {
+    const { userId, token } = await getAuthInfo();
+    requestParam.userId = userId;
+    requestParam.token = token;
+    return requestParam;
+  }
+  delete requestParam.userId;
+  delete requestParam.userid;
+  delete requestParam.token;
+  return requestParam;
+};
+
+/**
+ * @public
+ * @class Request
+ * @classdesc 网络请求类，对签名、鉴权等逻辑进行封装处理，用于向腾讯出行服务平台后台发送网络请求
+ */
+export default class Request {
+  /**
+   * 默认的request host域名
+   * defaultHost 在tms-runtime初始化时进行设置，为出行服务接入层域名
+   * 具体业务模块 new Request() 使用时，不指定自定义 host ，将使用defaultHost
+   */
+  static defaultHost = '';
+
+  host = '';
+  withAuth = true;
+  baseParam = {};
+
+  /**
+   * Request 构造函数
+   * @param {Object} config 构造参数
+   * @param {Object} config.withAuth 是否填充登录态参数
+   * @param {Object} config.host 自定义的host域名
+   * @param {Object} config.baseParam 默认携带的参数
+   */
+  constructor(config = { withAuth: true }) {
+    if (config.host) {
+      this.host = config.host;
+    }
+    if (typeof config.withAuth !== 'undefined') {
+      this.withAuth = !!config.withAuth;
+    }
+    this.baseParam = config.baseParam || {};
+  }
+
+  /**
+  * 格式化接口路径
+  * @private
+  * @param {string} path 需要格式化的接口路径
+  * @returns {string} 格式化后的接口路径
+  */
+  makeUrl(path) {
+    if ((/^http/i).test(path)) return path;
+    const host = this.host || Request.defaultHost;
+    const validHost = (/^http/i).test(host) ? host : `https://${host}`;
+    return `${validHost}/${path}`;
+  };
+
+  /**
+   * @public
+   * @memberof Request
+   * @param {String} path 请求接口路径
+   * @param {Object} [param] 请求参数
+   * @param {Object} [header] 自定义请求头
+   * @returns {Promise} 接口响应
+   * @example
+   * const $ = getApp().tms.createRequest();
+   * $.get(apiPath)
+   *  .then((data) => {
+   *    // data {Object} 响应数据
+   *    // {
+   *    //   errCode {Number} 接口响应状态码
+   *    //   errMsg  {String} 接口响应状态信息
+   *    //   resData {Object} 接口返回数据
+   *    // }
+   *  })
+   *  .catch((e) => {
+   *    // e {Object} 错误信息
+   *  });
+   */
+  get(path, param, header) {
+    return this.doRequest(path, param, 'GET', header);
+  }
+
+  /**
+   * @public
+   * @memberof Request
+   * @param {String} path 请求接口路径
+   * @param {Object} [param] 请求参数
+   * @param {Object} [header] 自定义请求头
+   * @returns {Promise} 接口响应
+   * @example
+   * const $ = getApp().tms.createRequest();
+   * $.post(apiPath)
+   *  .then((data) => {
+   *    // data {Object} 响应数据
+   *    // {
+   *    //   errCode {Number} 接口响应状态码
+   *    //   errMsg  {String} 接口响应状态信息
+   *    //   resData {Object} 接口返回数据
+   *    // }
+   *  })
+   *  .catch((e) => {
+   *    // e {Object} 错误信息
+   *  });
+   */
+  post(path, param, header) {
+    return this.doRequest(path, param, 'POST', header);
+  }
+
+  /**
+   * 发送get方式的请求，该方法会返回wx.request全量的返回值（含data，header，cookies，statusCode）
+   * @memberof Request
+   * @param {string} path 请求接口路径
+   * @param {object} param 业务参数
+   * @param {object} header 自定义请求头
+   * @returns {promise} 接口请求promise
+   */
+  execGet(path, param, header) {
+    return this.createRequestTask(path, param, 'GET', header);
+  }
+
+  /**
+   * 发送post方式的请求，该方法会返回wx.request全量的返回值（含data，header，cookies，statusCode等）
+   * @memberof Request
+   * @param {string} path 请求接口路径
+   * @param {object} param 业务参数
+   * @param {object} header 自定义请求头
+   * @returns {promise} 接口请求promise
+   */
+  execPost(path, param, header) {
+    return this.createRequestTask(path, param, 'POST', header);
+  }
+
+  /**
+   * @memberof Request
+   * @param {String} path 请求接口路径
+   * @param {String} filePath 上传文件的本地路径
+   * @param {Object} param 需要携带的其他参数
+   * @param {Object} header 自定义的请求头
+   * @returns {Object} 接口返回结果
+   */
+  async upload(path, filePath, param, header) {
+    const requestParam = await composeParam(param, this.withAuth, this.baseParam);
+    const res = await new Promise((resolve, reject) => {
+      wx.uploadFile({
+        name: 'content',
+        url: this.makeUrl(path),
+        filePath,
+        formData: sign(requestParam),
+        header,
+        success: resolve,
+        fail: reject,
+      });
+    });
+
+    if (typeof res?.data === 'string') {
+      return JSON.parse(res?.data);
+    }
+    return res?.data;
+  }
+
+  /**
+   * @memberof Request
+   * @param {string} path 请求接口路径
+   * @param {string} param 业务参数
+   * @param {string} method 请求方法 get/post
+   * @param {object} header 自定义的请求头
+   * @returns {object} 接口返回结果
+   */
+  async doRequest(path, param = {}, method = 'POST', header = {}) {
+    const res = await this.createRequestTask(path, param, method, header);
+
+    if (typeof res?.data === 'string') {
+      return JSON.parse(res?.data);
+    }
+
+    return res?.data;
+  }
+
+  /**
+   * 序列化一个 get 请求地址
+   * @memberof Request
+   * @param {string} path 请求接口路径
+   * @param {object} data 业务参数
+   * @returns {Promise} 返回序列化之后的 get 请求地址
+   */
+  async serialize(path, data = {}) {
+    let url = this.makeUrl(path);
+    const signData = await composeParam(data, this.withAuth, this.baseParam);
+    const signture = sign(signData);
+    const params = [];
+    Object.keys(signture).forEach((key) => {
+      const val = encodeURIComponent(signture[key]);
+      params.push(`${key}=${val}`);
+    });
+    if (params.length) url += (/\?/.test(url) ? '&' : '?') + params.join('&');
+    return Promise.resolve({ url });
+  }
+
+  /**
+   * 创建发送请求任务
+   * @memberof Request
+   * @param {string} path 请求接口路径
+   * @param {string} param 业务参数
+   * @param {string} method 请求方法 get/post
+   * @param {object} header 自定义的请求头
+   * @returns {Promise} 接口返回结果
+   */
+  async createRequestTask(path, param = {}, method = 'POST', header = {}) {
+    const requestParam = await composeParam(param, this.withAuth, this.baseParam);
+    const data = sign(requestParam);
+    const logger = getLogManager();
+    const res = await new Promise((resolve, reject) => {
+      wx.request({
+        url: this.makeUrl(path),
+        header,
+        method,
+        data,
+        success: (res) => {
+          resolve(res);
+          logger.log({ path, header, method, param: data, res: res?.data });
+        },
+        fail: (err) => {
+          reject(err);
+          logger.log({ path, header, method, param: data, err });
+        },
+      });
+    });
+    return res;
+  }
+}

package/src/rpx.js

@@ -0,0 +1,17 @@
+import syncApi from './syncfnmanager';
+
+/**
+ * @description rpx to px
+ * @param    {Number} rpx 需要转换的rpx数值
+ * @returns  {Number}     转换后的rpx数值
+ */
+const rpxToPx = (rpx) => {
+  const sys = syncApi.getSystemInfoSync();
+  const ww = sys.windowWidth;
+  const ratio = ww / 750;
+  return rpx * ratio;
+};
+
+export {
+  rpxToPx,
+};

package/src/stringUtils.js

@@ -0,0 +1,171 @@
+/**
+ * 字符串截断，处理时按可见字符长度进行截断
+ * 可见字符的含义是指：字母、数字、汉字、表情等均等价于一个字符
+ * @param {String} str - 原始字符串
+ * @param {Number} maxLen - 字符串截断后的最大长度
+ * @returns {String} 截断后的字符串；如果确实进行了截断，在最后面加'...'；
+ */
+const subStr = (str, maxLen) => {
+  // 按照码点（codePoint），把原始字符串的前maxLen+1个字符放到chars数组中
+  const chars = [];
+  for (const codePoint of str) { // eslint-disable-line
+    chars.push(codePoint);
+    if (chars.length > maxLen) break;
+  }
+
+  // 如果可见字符数量小于等于字符串截断后的最大长度，无需截断，返回原始字符串
+  if (chars.length <= maxLen) {
+    return str;
+  }
+
+  // 可见字符数量多于字符串截断后的最大长度，需要截断，并在末尾添加...
+  // 注意，此时返回的字符串是 maxLen-2个可见字符 + ...（maxLen-2是因为...占用2个汉字字符位置）
+  return `${chars.splice(0, maxLen - 2).join('')}...`;
+};
+
+/**
+ * 手机号处理，隐藏中间部分位数
+ * 隐藏规则：假设隐藏部分位数后，手机号由ABC构成，其中A、C是可见部分，B是隐藏部分
+ * 1. 隐藏部分（B)占手机号总位数的1/3，且隐藏部分的位数向上取整
+ * 2. 不被隐藏的部分（A、C）要均匀分布在隐藏部分（B）的两侧，即尽量使AC等长
+ * 3. 如果不隐藏部分（A、C）长度无法等长，则使C多显示一位
+ * @param {String} phone 手机号
+ * @returns {String} 隐藏后的手机号
+ */
+const hidePhoneCenter = (phone) => {
+  const len = phone && phone.length;
+  if (!len) {
+    return '';
+  }
+
+  // 各部分位数
+  const center = Math.ceil(len / 3);
+  const left = Math.floor((len - center) / 2);
+  const right = len - center - left;
+  // 各部分字符串
+  const centerStr = phone.substr(left, center).replace(/./g, '*');
+  const leftStr = phone.substr(0, left);
+  const rightStr = phone.substr(-right);
+  return `${leftStr}${centerStr}${rightStr}`;
+};
+
+/**
+ * 格式化车牌
+ * 例如：京A12345 -> 京A·12345
+ * @param {String} plate 车牌号
+ * @returns {String} 格式化后的车牌号
+ */
+const formatPlate = (plate) => {
+  if (!plate || typeof plate !== 'string') {
+    return '';
+  }
+  if (plate.length <= 2 || /·/.test(plate)) {
+    return plate;
+  }
+  return `${plate.substring(0, 2)}·${plate.substring(2)}`;
+};
+
+/**
+ * 检查手机号是否合法
+ * @param {String} phone 手机号
+ * @returns {Boolean} 手机号是否合法
+ */
+const isValidPhone = phone => /^1[\d]{10}$/.test(phone);
+
+/**
+ * 检查验证码是否合法
+ * @param {String} code 验证码
+ * @returns {Boolean} 验证码是否合法
+ */
+const isValidAuthCode = code => /^[\d]{6}$/.test(code);
+
+const validPlateFirstLetters = ['京', '津', '冀', '晋', '蒙', '辽', '吉', '黑', '沪', '苏', '浙', '皖', '闽', '赣', '鲁',
+  '豫', '鄂', '湘', '粤', '桂', '琼', '渝', '川', '贵', '云', '藏', '陕', '甘', '青', '宁', '新', '使', '领'];
+
+/**
+ * 检查车牌是否合法
+ * @param {String} plate 车牌
+ * @returns {Boolean} 车牌是否合法
+ */
+const isValidPlate = (plate) => {
+  if (!plate || typeof plate !== 'string') {
+    return false;
+  }
+
+  // 检查首位是否是合法的汉字
+  const [firstLetter] = plate;
+  if (validPlateFirstLetters.indexOf(firstLetter) === -1) {
+    return false;
+  }
+
+  if (!/[使领警学]/.test(plate)) { // 普通车牌
+    const number = plate.substring(1);
+    return /^[a-zA-Z][0-9a-zA-Z]{5}$/.test(number) // 第一位是字母，后面5位是字母或数字
+    || /^[a-zA-Z][a-zA-Z][0-9a-zA-Z]{5}$/.test(number) // 第一位是字母，第二位是字母，后面再跟5位字母或数字（新能源小车）
+    || /^[a-zA-Z][0-9a-zA-Z]{5}[a-zA-Z]$/.test(number) // 第一位是字母，最后一位是字母，中间5位字母或数字（新能源大车）
+    ||  /^粤Z[0-9a-zA-Z]{4,5}[港澳]{1}/.test(plate); // 广东港澳两地车牌
+  }
+
+  // return /^[^使领警学]{1}[a-zA-Z][0-9a-zA-Z]{3,4}[使领警学]{1}$/.test(plate) || // 使/领/警/学车牌
+  // /^[使领]{1}[0-9a-zA-Z]{5}$/.test(plate); // 使馆领事馆特殊车牌
+  return false;
+};
+
+/**
+ * 四舍五入，并返回格式化的字符串
+ * 支持保留n位小数，n>=0，如 round(1.325, 2)=1.33
+ * 支持格式化字符串时取出末尾的0，如round(1.109, 2, true)=1.1
+ * @param {any} x 原数字
+ *                如果n不是合法数字或者无法转换为合法数字，roundStr结果返回''
+ * @param {any} n 保留几位小数，默认0
+ *                如果n不是合法数字或者无法转换为合法数字，roundStr结果返回''
+ *                如果n小于0，roundStr结果返回''
+ *                如果n的值包含小数部分，roundStr处理时只关注n的整数部分值
+ * @param {boolean} removeTrailingZero 是否移除字符串末尾的无效数字0
+ * @returns {string} 返回四舍五入后的字符串，异常情况下返回空字符串''
+ */
+const roundStr = (x, n = 2, removeTrailingZero = false) => {
+  let xNum = Number(x); // x转换为数字
+  const nNum = Math.floor(Number(n)); // n转换为数字，且只保留整数部分
+
+  // 异常情况，返回''
+  if (isNaN(xNum) || isNaN(nNum) || nNum < 0) return '';
+
+  // 仅保留整数的情况
+  if (nNum === 0) return Math.round(xNum);
+
+  // 保留n位小数的情况
+  const xStr = xNum.toString();
+  const rexExp = new RegExp(`\\.\\d{${nNum}}5`);
+
+  // 1. 大部分情况下，四舍五入使用Number.toFixed即可
+  // 2. 然而，Number.toFixed方法在某些情况下对第n+1位是5的四舍五入存在问题，如1.325保留2小数时结果为1.32（期望为1.33）
+  //    对此种情况下，有两种处理方式：
+  //    2.1 先扩大10^n倍，舍掉小数部分取整数部分，然后加1，最后缩小10^n倍
+  //        但此种情况下，不能处理过大的数字，也不能处理保留小数位数过多的情况，会可能导致数字超过Infinity
+  //    2.2 Number.toFixed是四舍6入，对于第n+1位是5的情况，增加2*10^(-n-1)，保证满足第n+1位>6
+  //        增加2*10^(-n-1)而不是增加1*10^(-n-1)是因为后者不能保证第n+1位>=6，例如1.325+0.001=1.32599999...第n+1位仍然为5
+  // 此处，采用2.2方式，解决Number.toFixed的问题，又能避免2.1方式中数字超过Infinity的问题
+  if (rexExp.test(xStr)) { // 情况2，处理方式2.1：如果小数部分第n+1位是5，增加2*10^(-n-1)
+    xNum += 2 * (10 ** (-nNum - 1));
+  }
+
+  const str = xNum.toFixed(nNum);
+  if (!removeTrailingZero) return str;
+
+  // 去除末尾的0
+  if (/^\d+\.0*$/.test(str)) { // 小数部分全是0
+    return str.replace(/^(\d+)(\.0*)$/, (_m, s1) => s1);
+  }
+  return str.replace(/^(\d+\.\d*[1-9]{1})(0*)$/, (_m, s1) => s1);
+};
+
+export {
+  formatPlate,
+  subStr,
+  hidePhoneCenter,
+  isValidPhone,
+  isValidPlate,
+  isValidAuthCode,
+  roundStr,
+};

package/src/syncfnmanager.js

@@ -0,0 +1,106 @@
+/**
+ * 本文件负责对小程序调用wx同步方法的管理
+ */
+let systemInfo = null; // 系统信息。
+let launchOptions = null; // 启动参数
+let accountInfo = null; // 小程序账号信息
+
+/**
+ * 获取系统信息。同wx.getSystemInfoSync
+ * @returns {Object} 系统信息
+ */
+const getSystemInfoSync = () => {
+  if (systemInfo) {
+    return systemInfo;
+  }
+
+  try {
+    systemInfo = wx.getSystemInfoSync();
+
+    return systemInfo;
+  } catch (_) {
+    return {};
+  }
+};
+
+/**
+ * 重置系统信息，仅用于单元测试
+ * @returns {undefined}
+ */
+const resetSystemInfoSync = () => {
+  systemInfo = null;
+};
+
+/**
+ * 获取启动参数。同wx.getLaunchOptionsSync
+ * @returns {Object} 启动参数
+ */
+const getLaunchOptionsSync = () => {
+  if (launchOptions) {
+    return launchOptions;
+  }
+
+  try {
+    launchOptions = wx.getLaunchOptionsSync();
+
+    return launchOptions;
+  } catch (_) {
+    return {};
+  }
+};
+
+/**
+ * 获取客户端平台。同wx.getSystemInfoSync().platform
+ * @returns {String} 平台名称
+ */
+const getPlatform = () => {
+  const UNKNOWN = 'unknown';
+
+  try {
+    const systemInfo = getSystemInfoSync();
+    const { platform } = systemInfo;
+    return platform || UNKNOWN;
+  } catch (_) {
+    return UNKNOWN;
+  }
+};
+
+/**
+ * 获取字符串类型的启动参数
+ * @returns {String} 序列化的参数字符串
+ */
+const getLaunchParamOfString = () => {
+  try {
+    const options = getLaunchOptionsSync() || {};
+    return JSON.stringify(options);
+  } catch (_) {
+    return '';
+  }
+};
+
+/**
+ * @description 获取小程序账号信息
+ * @returns {Object} 小程序账号信息,返回内容同wx.getAccountInfoSync()
+ */
+export const getAccountInfoSync = () => {
+  if (accountInfo) {
+    return accountInfo;
+  }
+
+  try {
+    accountInfo = wx.getAccountInfoSync();
+    return accountInfo;
+  } catch (_) {
+    return {};
+  }
+};
+
+const obj = {
+  getPlatform,
+  getSystemInfoSync,
+  getLaunchOptionsSync,
+  getLaunchParamOfString,
+  resetSystemInfoSync,
+  getAccountInfoSync,
+};
+export default obj;