@tmsfe/tms-core 0.0.1 → 0.0.5

package/src/location/index.ts

@@ -0,0 +1,286 @@
+import Request from '../request';
+import EventDispatcher from '../eventDispatcher';
+import LocationBase from './base'; // eslint-disable-line
+import { formatCityCode, formatPoi } from './utils'; // eslint-disable-line
+import { WxPostionType } from '../types/object'; // eslint-disable-line
+
+interface PostionType {
+  province: string,
+  cityCode: string,
+  cityName: string,
+  latitude: number,
+  longitude: number,
+}
+
+interface UserLocationType {
+  [key: string]: Promise<PostionType | void>
+}
+
+const request = new Request();
+const event = new EventDispatcher();
+
+const userLocationCache: UserLocationType = {}; // 获取位置缓存
+// 用户手动选择的位置信息（切换城市后的位置信息）
+let userLocation: PostionType | undefined;
+// 用户所在的城市
+let cityTheUserAt = '';
+// 用户城市变化事件名
+const CityChangeEventName = 'loc_city_changed';
+const LocationType = 'gcj02'; // 获取经纬度时的坐标名称
+
+/**
+ * @class Location
+ * @classdesc 基于LocationBase，封装业务侧位置的接口。 将用户经纬度转化为城市等展示信息
+ */
+class Location extends LocationBase {
+  // 默认位置信息
+  public locForNoAuth = {
+    province: '广东省',
+    cityCode: '440300',
+    cityName: '深圳市',
+    latitude: 22.54286,
+    longitude: 114.05956,
+  };
+
+  /**
+   * 构造函数
+   */
+  constructor() { // eslint-disable-line
+    super();
+  }
+
+  /**
+   * 获取解析后的用户位置， 比如城市信息
+   * @param { number } lat 用户纬度信息
+   * @param { number } lng 用户经度信息
+   * @param { number } getPoi 位置
+   * @returns { Promise<PostionType | void> } 获取位置信息的promise
+   */
+  getPoiInfo(lat: number, lng: number, getPoi: number): Promise<PostionType | void> {
+    // 优先查询缓存中是否有位置信息，如果有直接返回
+    const cacheName = `${lat}-${lng}-${getPoi}`;
+
+    // @ts-ignore
+    if (userLocationCache[cacheName]) { // eslint-disable-line
+      return userLocationCache[cacheName];
+    }
+
+    userLocationCache[cacheName] = request.post('basic/lbs/decode', { lat, lng, getPoi }).then((res) => {
+      const { errCode, resData = {} } = res;
+
+      if (errCode === 0) {
+        const { result = {} } = resData;
+        const { ad_info: adInfo = {} } = result;
+
+        const loc = {
+          province: adInfo.province,
+          cityName: adInfo.city,
+          adCode: adInfo.adcode,
+          cityCode: formatCityCode(adInfo.city_code, adInfo.nation_code),
+          latitude: lat,
+          longitude: lng,
+        };
+
+        if (getPoi === 0) {
+          return loc;
+        }
+
+        loc.adCode = adInfo.adcode;
+        (loc as typeof loc & { poi: object }).poi = formatPoi(result);
+        return loc;
+      }
+
+      return Promise.reject(res);
+    })
+      .catch(err => Promise.reject(err));
+
+    return userLocationCache[cacheName];
+  }
+
+  /**
+   * @function
+   * @memberof Location
+   * @description 获取位置、城市信息
+   * @param       {Boolean} showModalWhenCloseAuth 获取位置时，如果用户关闭了位置授权，是否弹窗提示用户打开授权
+   * @param       {String}  type 坐标类型
+   * @param       {String}  content 弹窗内容
+   * @param       {Number}  getPoi 是否获取详细poi信息， 0 - 不获取(不返回poi字段)， 1 - 获取(返回poi字段)
+   * @returns {Promise<POI|ERR>} 返回对象
+   * @example
+   * <caption>POI类型示例</caption>
+   * {
+   *   cityName: '北京市',
+   *   cityCode: '100100',
+   *   province: '北京市',
+   *   latitude: 325.255333,
+   *   longitude: 116.2545454,
+   *   adCode: 1212144,
+   *   poi: {
+   *     id: '1114545554511',
+   *     title: '腾讯北京总部大厦',
+   *     address : '北京市海淀区东北旺西路',
+   *   }
+   * }
+   * @example
+   * <caption>ERR类型示例</caption>
+   * {
+   *   err,
+   *   unAuthed: true,
+   *   locationScopeStatus: false
+   * }
+   */
+  getLocationDetail(showModalWhenCloseAuth = false, type = LocationType, content = '', getPoi = 0) {
+    return this.getLocation(showModalWhenCloseAuth, type, content)
+      .then((res: WxPostionType) => this.getPoiInfo(res.latitude, res.longitude, getPoi))
+      .catch(err => Promise.reject(err));
+  }
+
+  /**
+   * @description 以静默方式获取用户详细位置(经纬度，poi信息， 省市信息)，说明如下：<br>
+   * 1、从未授权情况下 | 用户删除小程序之后调用该方法不会弹微信自带的授权弹窗；<br>
+   * 2、拒绝授权后，调用该方法不会弹窗提示用户去授权（wx.showModal）；<br>
+   * @memberof Location
+   * @param {Number} getPoi 是否获取详细poi信息， 0 - 不获取(不返回poi字段)， 1 - 获取(返回poi字段)
+   * @param {String} type 非必填。坐标类型，默认'gcj02'
+   * @returns {Promise<LOC|ERR>} 返回对象
+   * @example
+   * <caption>LOC类型示例</caption>
+   * {
+   *   cityName: '北京市',
+   *   cityCode: '100100',
+   *   latitude: 325.255333,
+   *   longitude: 116.2545454,
+   *   adCode: 1212144,
+   *   poi: {
+   *     id: '1114545554511',
+   *     title: '腾讯北京总部大厦',
+   *     address : '北京市海淀区东北旺西路',
+   *   }
+   * }
+   * @example
+   * <caption>ERR类型示例</caption>
+   * {
+   *   err,
+   *   unAuthed: true,
+   *   locationScopeStatus: false
+   * }
+   */
+  getLocationDetailSilent(getPoi = 0, type = 'gcj02') {
+    return this.getLocationSilent(type)
+      .then((res: any) => this.getPoiInfo(res.latitude, res.longitude, getPoi))
+      .catch(err => Promise.reject(err));
+  }
+
+  /**
+   * @description 获取用户手动选择的位置信息
+   * @memberof Location
+   * @returns {Null|LOC} 返回用户位置信息
+   * @example
+   * <caption>LOC类型示例</caption>
+   * {
+   *   province: '北京市',
+   *   cityName: '北京市',
+   *   cityCode: '100100',
+   *   latitude: 325.255333,
+   *   longitude: 116.2545454,
+   *   adCode: 1212144,
+   * }
+  */
+  getUserLocation(): PostionType | undefined {
+    return userLocation;
+  }
+
+  /**
+   * @description 设置用户位置（小程序生命周期内有效）
+   * @memberof Location
+   * @param {Object} loc 用户手动选择的位置
+   * @params {String} loc.province 省份
+   * @params {String} loc.cityName 城市
+   * @params {String} loc.cityCode citycode
+   * @params {Number} loc.latitude 纬度
+   * @params {Number} loc.longitude 经度
+   * @params {Number} loc.adCode adCode
+   * @returns {Void} 无返回值
+   * @example
+   * <caption>loc类型示例</caption>
+   * {
+   *   province: '北京市',
+   *   cityName: '北京市',
+   *   cityCode: '100100',
+   *   latitude: 325.255333,
+   *   longitude: 116.2545454,
+   *   adCode: 1212144,
+   * }
+   */
+  setUserLocation(loc: PostionType) {
+    if (!loc || typeof loc !== 'object') {
+      return;
+    }
+
+    // 如果城市发生变化，派发事件
+    const { cityName: curCityName } = loc;
+    if (curCityName && (cityTheUserAt !== curCityName)) {
+      cityTheUserAt = curCityName;
+      userLocation = loc;
+      event.dispatch({ type: CityChangeEventName });
+    }
+  }
+
+  /**
+   * @description 获取用户选择的城市位置信息 或者 用户真实的位置信息（这个方法说明有问题）
+   * @memberof Location
+   * @param {Boolean} showModalWhenCloseAuth 没有授权时是否展示授权弹窗
+   * @returns {Promise} 用户位置信息
+   */
+  async getMergedLocation(showModalWhenCloseAuth = true): Promise<void | PostionType> {
+    const userLocatioin = this.getUserLocation();
+    // 优先用户选择的城市
+    if (userLocatioin) {
+      return userLocatioin;
+    }
+
+    return await this.getLocationDetail(showModalWhenCloseAuth, LocationType);
+  }
+
+  /**
+   * @memberof Location
+   * @description 监听用户城市变化(如: 北京市->深圳市)
+   * @param       {Function} cb 监听事件回调函数
+   * @returns {void}
+   */
+  onCityChange(cb: () => void) {
+    if (cb && typeof cb === 'function') {
+      event.bind(CityChangeEventName, cb);
+    }
+  }
+
+  /**
+   * @memberof Location
+   * @description 获取路线规划
+   * @param       {String} to 目的地坐标，格式：lat,lng
+   * @param       {String} depart 出发地坐标，格式：lat,lng
+   * @param       {String} mode 出行方式， driving 驾车[默认]
+   * @returns     {Object} result.routes 返回数据 [{}, ...]
+   */
+  async getRoute(to: string, depart: string, mode = 'driving') {
+    let from = depart;
+    const coorReg = new RegExp(/(\d+\.\d{6,}),(\d+\.\d{6,})/);
+    if (!coorReg.test(to)) throw Error('目的地参数格式错误');
+    if (!coorReg.test(from)) { // 出发地缺省使用当前位置
+      const { latitude, longitude } = (await this.getMergedLocation() as PostionType);
+      from = `${latitude},${longitude}`;
+    }
+    return request.post('basic/lbs/direction', { from, to, mode });
+  }
+}
+
+// 因为在构造函数中会用到wx的api，所以使用到时才实例化
+let instance: Location;
+function getLocInstance(): Location {
+  if (!instance) {
+    instance = new Location();
+  }
+  return instance;
+}
+
+export default getLocInstance;

package/src/location/utils.ts

@@ -0,0 +1,168 @@
+import EventDispatcher from '../eventDispatcher';
+
+const event = new EventDispatcher();
+
+// 获取位置状态 -- true: 成功 false: 失败
+let getLocationStatus = true; // eslint-disable-line
+
+const LocationScopeKey = 'scope.userLocation';
+
+// 获取授权设置promise
+let getSettingPromise: Promise<any> | null;
+
+const EventName = 'loc_status_changed';
+
+
+/**
+ * @param {string} scopeKey 授权项
+ * @returns {promise} 授权页操作状态
+ */
+export function openSetting(scopeKey = LocationScopeKey) {
+  return new Promise((resolve, reject) => {
+    // 打开设置页
+    wx.openSetting({
+      success: (res) => {
+        // 从authSetting中获取用户的授权结果
+        const { authSetting } = res;
+        const authResult = (authSetting as any)[scopeKey];
+        // 已经打开授权
+        if (authResult) {
+          resolve(res);
+          return;
+        }
+
+        // 未打开授权
+        reject(res);
+      },
+      fail: reject,
+    });
+  });
+}
+
+/**
+ * @description 更新获取位置状态
+ * @param {Boolean} status 成功true或失败false
+ * @returns {Promise<void>} 用户是否授权
+ */
+export async function updateLocStatus(status: boolean): Promise<void> {
+  if (status && !getLocationStatus) {
+    let isAuthed = false;
+
+    try {
+      isAuthed = await getSetting();
+      getLocationStatus = true;
+    } catch (e) {
+      if (isAuthed !== false) {
+        event.dispatch({ type: EventName });
+      }
+
+      const timer = setTimeout(() => {
+        updateLocStatus(status);
+        clearTimeout(timer);
+      }, 200);
+    }
+  } else {
+    getLocationStatus = status;
+  }
+}
+
+/**
+ * 获取用户授权信息
+ * @param { string } scopeKey 是否授权过位置信息
+ * @returns { Promise } 用户授权对象
+ */
+export function getSetting(scopeKey: string = LocationScopeKey) {
+  if (getSettingPromise) { // eslint-disable-line
+    return getSettingPromise;
+  }
+
+  getSettingPromise = new Promise((resolve, reject) => {
+    wx.getSetting({
+      success: ({ authSetting = {} }) => {
+        resolve((authSetting as any)[scopeKey]);
+        getSettingPromise = null;
+      },
+      fail: (err: { errMsg: string }) => {
+        getSettingPromise = null;
+
+        const { errMsg = '' } = err || {};
+        // wx.getSetting接口没有响应时errMsg
+        const reason = 'getSetting:fail data no response';
+        // 部分机型上，wx.getSetting接口没有响应，此时，当做位置开关是打开的来处理
+        if (errMsg.indexOf(reason) > -1) {
+          resolve(true);
+          return;
+        }
+
+        reject(err);
+      },
+    });
+  });
+
+  return getSettingPromise;
+}
+
+/**
+ * getTextByReason 获取提示语文案
+ * @param {*} locationEnabled 是否开启位置授权
+ * @param {*} isSysAndWechatAllowedGetLoc 是否开启微信位置授权
+ * @returns {object} 提示语文案
+ */
+export function getTextByReason(locationEnabled: boolean, isSysAndWechatAllowedGetLoc: boolean) {
+  const authLevelName = locationEnabled ? '微信' : '系统';
+  const confirmText = isSysAndWechatAllowedGetLoc ? '去开启' : '好的';
+
+  return { authLevelName, confirmText };
+};
+
+/**
+* @function
+* @description 获取设备系统信息
+* @returns      {Object} 设备系统信息
+*/
+export function getSystemInfo(): WechatMiniprogram.SystemInfo | undefined {
+  try {
+    const sys: WechatMiniprogram.SystemInfo = wx.getSystemInfoSync();
+    // 方便开发时调试
+    if (sys.platform === 'devtools') {
+      sys.locationEnabled = true;
+      sys.locationAuthorized = true;
+    }
+    return sys;
+  } catch (err) { }
+};
+
+
+/**
+ * @function
+ * @description 格式化城市编码
+ * @param       {String} cityCode 城市编码，以国家编码开始
+ * @param       {String} nationCode 国家编码
+ * @returns      {String} 去掉国家编码后的城市编码
+ */
+export function formatCityCode(cityCode: string, nationCode: string) {
+  let code = cityCode;
+  if (cityCode.startsWith(nationCode)) {
+    code = cityCode.substr(nationCode.length);
+  }
+
+  return code;
+};
+
+/**
+ * 格式化poi数据
+ * @param {Object} geo 逆地址解析接口返回的数据
+ * @returns {object} 格式化后的poi结果
+ */
+export function formatPoi(geo: any) {
+  const { pois = [], address_reference: addressRefer } = geo;
+  if (pois.length) {
+    return pois[0];
+  }
+
+  if (addressRefer?.landmark_l2) {
+    return addressRefer.landmark_l2;
+  }
+
+  return {};
+};

package/src/log.js

@@ -0,0 +1,171 @@
+/**
+ * 本文件主要负责在小程序中日志打印功能，包含本地日志及实时日志. 主要做了两件事:
+ * 1、参数序列化处理；支持传递任意多个参数，并对类型为对象的参数进行字符串序列化处理(避免打印出来是'[Object Object]'的格式)；
+ * 2、低版本兼容；
+ */
+
+// 低版本不支持getLogManager或者getRealtimeLogManager时，用ManagerForLowerVersionLib来兼容
+const ManagerForLowerVersionLib = {
+  debug: () => {},
+  info: () => {},
+  log: () => {},
+  warn: () => {},
+  error: () => {},
+  addFilterMsg: () => {},
+  setFilterMsg: () => {},
+};
+
+// 小程序基础库2.7.1版本以上支持，所以需要兼容性处理
+let logInstance = null;
+let rtLogInstance = null;
+
+function getLogInstance() {
+  if (logInstance === null) {
+    logInstance = wx.getLogManager ? wx.getLogManager() : ManagerForLowerVersionLib;
+  }
+  return logInstance;
+}
+
+function getRTLogInstance() {
+  if (rtLogInstance === null) {
+    rtLogInstance = wx.getRealtimeLogManager ? wx.getRealtimeLogManager() : ManagerForLowerVersionLib;
+  }
+  return rtLogInstance;
+}
+
+/**
+ * 参数中有对象类型的，将其转换为字符串类型，以便查看
+ * @param {Array<Any>} params 需要格式化的数据
+ * @returns {Array<String>} 字符串序列化后的数据
+ */
+const format = params => params.map(param => (typeof param === 'string' ? param : JSON.stringify(param)));
+
+/**
+ * @namespace LOG
+ * @description 普通日志管理器，将日志记录在小程序日志文件中，用户上传后，可以在小程序后台-反馈管理中看到
+ */
+const LOG = {
+  /**
+   * @description 写debug日志
+   * @param  {...Any} params 需要打印的数据，支持任意多个
+   * @returns {Void} 无返回值
+   */
+  debug(...params) {
+    getLogInstance().debug(...format(params));
+  },
+
+  /**
+   * @description 写info日志
+   * @param  {...Any} params 需要打印的数据，支持任意多个
+   * @returns {Void} 无返回值
+   */
+  info(...params) {
+    getLogInstance().info(...format(params));
+  },
+
+  /**
+   * @description 写log日志
+   * @param  {...Any} params 需要打印的数据，支持任意多个
+   * @returns {Void} 无返回值
+   */
+  log(...params) {
+    getLogInstance().log(...format(params));
+  },
+
+  /**
+   * @description 写warn日志
+   * @param  {...Any} params 需要打印的数据，支持任意多个
+   * @returns {Void} 无返回值
+   */
+  warn(...params) {
+    getLogInstance().warn(...format(params));
+  },
+
+  /**
+   * @description 写warn日志. LogManager并没有error方法，为了兼容旧代码，所以声明一个error方法
+   * @param  {...Any} params 需要打印的数据，支持任意多个
+   * @returns {Void} 无返回值
+   */
+  error(...params) {
+    LOG.warn(...params);
+  },
+};
+
+/**
+ * @namespace RTLOG
+ * @description 实时日志，将日志实时上传至小程序后台-开发-运维中心-实时日志，方便快速排查漏洞，定位问题
+ */
+const RTLOG = {
+  /**
+   * @description 写info日志
+   * @param  {...Any} params 需要打印的数据，支持任意多个
+   * @returns {Void} 无返回值
+   */
+  info(...params) {
+    getRTLogInstance().info(...format(params));
+  },
+
+  /**
+   * @description 写warn日志
+   * @param  {...Any} params 需要打印的数据，支持任意多个
+   * @returns {Void} 无返回值
+   */
+  warn(...params) {
+    getRTLogInstance().warn(...format(params));
+  },
+
+  /**
+   * @description 写error日志
+   * @param  {...Any} params 需要打印的数据，支持任意多个
+   * @returns {Void} 无返回值
+   */
+  error(...params) {
+    getRTLogInstance().error(...format(params));
+  },
+
+  /**
+   * @description 添加过滤关键字
+   * @param {String} msg 关键字
+   * @returns {Void} 无返回值
+   */
+  addFilterMsg(msg) {
+    getRTLogInstance().addFilterMsg(msg);
+  },
+
+  /**
+   * @description 设置过滤关键字
+   * @param {String} msg 关键字
+   * @returns {Void} 无返回值
+   */
+  setFilterMsg(msg) {
+    getRTLogInstance().setFilterMsg(msg);
+  },
+};
+
+/**
+ * @description 获取日志管理器对象，该对象提供的方法同wx.getLogManager()提供的方法，详见微信文档
+ * @returns {Object} [LOG](#namespace-log)
+ * @example
+ * const logger = getLogManager();
+ * logger.log(1, 'str', { a: 1 }, ...);
+ * logger.info(1, 'str', { a: 1 }, ...);
+ * logger.debug(1, 'str', { a: 1 }, ...);
+ * logger.awrn(1, 'str', { a: 1 }, ...);
+ */
+const getLogManager = () => LOG;
+
+/**
+ * @description 获取实时日志管理器对象，该对象提供的方法同wx.getRealtimeLogManager()提供的方法，详见微信文档
+ * @returns {Object} [RTLOG](#namespace-rtlog)
+ * @example
+ * const logger = getRealtimeLogManager();
+ * logger.info(1, 'str', { a: 1 }, ...);
+ * logger.warn(1, 'str', { a: 1 }, ...);
+ * logger.error(1, 'str', { a: 1 }, ...);
+ */
+const getRealtimeLogManager = () => RTLOG;
+
+export {
+  getLogManager,
+  getRealtimeLogManager,
+};

package/src/log.test.js

@@ -0,0 +1,16 @@
+import Log from './log';
+
+describe('Log', () => {
+  beforeAll(() => {
+  });
+
+  it('Log.getLogInstance test', () => {
+    const logger = Log.__get__('getLogInstance')();
+    expect(logger).toBeInstanceOf(Object);
+  });
+
+  it('Log.getRTLogInstance test', () => {
+    const logger = Log.__get__('getRTLogInstance')();
+    expect(logger).toBeInstanceOf(Object);
+  });
+});