@tmsfe/tms-core 0.0.1 → 0.0.5

package/src/index.js

@@ -0,0 +1,181 @@
+import Request from './request';
+import FastReport from './fastreport';
+import { getConfig } from './config';
+import syncApi from './syncfnmanager';
+import nav from './navigator';
+import { getLogManager, getRealtimeLogManager } from './log';
+import { setEnvInfo, getEnvInfo, setAuthInfo, setAppPagePaths, isAppPageExist, getHomePage } from './env';
+import md5 from './md5';
+import { callCloudFunc } from './cloudService';
+import { cache as report, startListenApp } from './report';
+import EventDispatcher from './eventDispatcher';
+import { serialize } from './objUtils';
+import { rpxToPx } from './rpx';
+import {
+  formatPlate,
+  subStr,
+  hidePhoneCenter,
+  isValidPhone,
+  isValidPlate,
+  isValidAuthCode,
+  roundStr,
+} from './stringUtils';
+import {
+  formatTime,
+  formatTimeStr,
+  formatTimeWithDetails,
+  dateToString,
+} from './timeUtils';
+import {
+  ipxInit,
+  isIPX,
+  getIpxClass,
+  getIpxConfig,
+} from './ipxHelper';
+import getLocInstance from './location/index.ts';
+import LocationBase from './location/base.ts';
+import { getMpOpenId, getOuterOpenId } from './mpInfo';
+
+/**
+ * @public
+ * @description 创建网络请求对象，用于向腾讯出行服务平台后台发送网络请求
+ * @param {Object} [config] 参数配置
+ * @param {Boolean} [config.withAuth=true] 是否填充登录态参数
+ * @param {String} [config.host] 自定义的host域名
+ * @param {Object} [config.baseParam] 默认携带的参数
+ * @returns {Object} [Request实例](#class-request)
+ * @example
+ * const $ = getApp().tms.createRequest();
+ * $.get(apiPath)
+ *   .then((resp) => {
+ *     // ...
+ *   })
+ *   .catch((err) => {
+ *     // ...
+ *   });
+ */
+const createRequest = (config = {}) => new Request(config);
+/**
+ * @description 埋点上报
+ * @returns {Object} 包含[report方法](#report)的对象
+ * @example
+ * getReporter().report(reportData, reportNow);
+ */
+const getReporter = () => ({ report });
+
+/**
+ * @description 埋点上报(快速上报，不依赖用户userId标识)
+ * @returns {Class} [FastReporter类](#class-fastreport)
+ */
+const getFastReporter = () => FastReport;
+
+/**
+ * @description 自定义事件机制
+ * @returns {Object} [EventDispatcher实例](#class-eventdispatcher)
+ */
+const getEventDispatcher = () => new EventDispatcher();
+
+/**
+ * @description 获取地理位置方法的集合
+ * @returns {Class} [Location类](#class-location)
+ */
+const getLocationManager = () => getLocInstance();
+
+/**
+ * @description 获取位置信息base类(业务无关)
+ * @returns {Class} [Location类](#class-location)
+ */
+const getLocationBaseClass = () => LocationBase;
+
+/**
+ * @description init core包初始化, 小程序已在app.js中对齐初始化
+ * @param {Object} options 初始化
+ * @returns {undefined} 无返回值.
+ */
+const init = (options = {}) => {
+  startListenApp();
+  const { appVersion, wxAppId, client, defaultHost, cloudEnvId, appEnv, appPagePaths, homePage } = options;
+  setEnvInfo({
+    wxAppId,
+    appVersion,
+    appEnv,
+    client,
+    cloudEnvId,
+  });
+  setAppPagePaths(appPagePaths, homePage);
+  Request.defaultHost = defaultHost;
+  // 初始化云环境
+  wx.cloud.init({ env: cloudEnvId });
+};
+
+/**
+ * @description 获取用户位置信息 -- 兼容版 现有业务中有的使用promise， 有的没有， 做一下兼容
+ * @returns { Promise } 位置信息
+ */
+const getUserLocation = () => {
+  const userLocation = getLocInstance().getUserLocation();
+  if (userLocation) {
+    return Promise.resolve(userLocation);
+  }
+  return getLocInstance().getLocationDetail(false);
+};
+
+const api = {
+  init,
+  createRequest,
+  setAuthInfo,
+  getLogManager,
+  getRealtimeLogManager,
+  md5,
+  getReporter,
+  getFastReporter,
+  getLocationManager,
+  getLocationBaseClass,
+  getEventDispatcher,
+  getEnvInfo,
+  getConfig,
+  navigateToWebview: nav.navigateToWebview,
+  isAppPageExist,
+  getHomePage,
+  callCloudFunc,
+  setUserLocation: (loc) => {
+    getLocInstance().setUserLocation(loc);
+  },
+  getUserLocation,
+
+  /* 字符串方法 */
+  formatPlate,
+  subStr,
+  hidePhoneCenter,
+  isValidPhone,
+  isValidPlate,
+  isValidAuthCode,
+  roundStr,
+
+  /* 时间方法 */
+  formatTime,
+  formatTimeStr,
+  formatTimeWithDetails,
+  dateToString,
+
+  /* IPX方法 */
+  ipxInit,
+  isIPX,
+  getIpxClass,
+  getIpxConfig,
+
+  /* 处理对象方法 */
+  serialize,
+
+  /* 获取外部合作商openid */
+  getMpOpenId, // 变更为 getOuterOpenId
+  getOuterOpenId,
+
+  /** rpx转px */
+  rpxToPx,
+
+  ...syncApi,
+};
+
+
+export default api;

package/src/ipxHelper.js

@@ -0,0 +1,75 @@
+/**
+ * Tencent Inc. All Rights Reserved.
+ * @author: petegao@tencent.com
+ * Created: 2019-01-14.
+ *
+ */
+
+import syncfnmanager from './syncfnmanager';
+
+let isInit = false;
+let isIPXSign = false;
+let ipxClass = '';
+
+/**
+ * @returns {undefined}
+ */
+function init() {
+  if (isInit) {
+    return;
+  }
+  isInit = true;
+  const sysInfo = syncfnmanager.getSystemInfoSync();
+  const { model, platform: pl } = sysInfo;
+  if (pl !== 'ios') {
+    return;
+  }
+  if (model.search('iPhone X') > -1 || model.search('iPhone 11') > -1) {
+    isIPXSign = true;
+    ipxClass = 'view__ipx';
+  }
+}
+
+/**
+ * @returns {Boolean} 判断是否是 iPhoneX
+ */
+function isIPX() {
+  init();
+  return isIPXSign;
+}
+
+/**
+ * @returns {String} 返回 ipxClass
+ */
+function getIpxClass() {
+  init();
+  return ipxClass;
+}
+
+/**
+ * @param {Object} config 用户需要合并的IPX的配置
+ * @returns {Object} 合并后的IPX的配置
+ */
+function getIpxConfig(config) {
+  init();
+  return {
+    ...config,
+    data: {
+      ...config.data,
+      isIPX: isIPXSign,
+      ipxClass,
+    },
+  };
+}
+
+// 兼容旧接口，已经没什么用了
+function ipxInit() {
+
+}
+
+export {
+  ipxInit,
+  isIPX,
+  getIpxClass,
+  getIpxConfig,
+};

package/src/location/base.ts

@@ -0,0 +1,236 @@
+import { getSetting, updateLocStatus, getSystemInfo, getTextByReason, openSetting } from './utils';// eslint-disable-line
+import EventDispatcher from '../eventDispatcher';
+import { WxPostionType } from '../types/object'; // eslint-disable-line
+
+const event = new EventDispatcher();
+
+let getLocPromise: null | Promise<any> = null;
+// 用户位置信息缓存
+let userLocationCache: WxPostionType;
+// 默认获取经纬度坐标的名称
+const defaultLocationType = 'gcj02';
+// 派发事件的名称
+const EventName = 'loc_status_changed';
+
+/**
+ * @private 将wx.getLocation获取位置方法用promise封装
+ * @param { string } type 获取位置类型
+ * @returns { Promise<any> } 用户位置信息
+ */
+function getWxLocation(type: string = defaultLocationType): Promise<WxPostionType> {
+  return new Promise((resolve, reject) => {
+    wx.getLocation({
+      type,
+      success: (res: WxPostionType) => {
+        resolve(res);
+      },
+      fail: reject,
+    });
+  });
+}
+
+/**
+ * @class Location
+ * @classdesc 基于微信api，封装location相关的接口。 包括监听位置变化， 获取用户位置信息
+ * 获取位置授权等等。业务无关
+ */
+class LocationBase {
+  /**
+   * @private 构造函数
+   */
+  constructor() {
+    wx.onLocationChange(this.subscribeLocationChnage);
+    wx.startLocationUpdate({});
+  }
+
+  /**
+   * 获取用户当前位置(经纬度)
+   * @memberof Location
+   * @param {boolean} showModalWhenCloseAuth 获取位置时，如果用户关闭了位置授权，是否弹窗提示用户打开授权
+   * @param {string}  type 坐标类型
+   * @param {string}  content 弹窗内容
+   * @param {boolean} showCancel 是否显示取消按钮
+   * @returns {Promise<LOC|ERR>} 返回对象
+   * @returns {Promise<LOC|ERR>} 返回对象
+   */
+  public getLocation(showModalWhenCloseAuth: boolean, type: string, content = '', showCancel = true): Promise<WxPostionType> {
+    // 如果缓存中没有， 并且getLocPromise有值， 说明正在请求中。 返回请求的promise
+    if (!userLocationCache && getLocPromise) {  // eslint-disable-line
+      return getLocPromise;
+    }
+
+    // 如果缓存中没有， 并且getLocPromise没有值，新建一个请求
+    if (!userLocationCache && !getLocPromise) { // eslint-disable-line
+      getLocPromise = this.getWxLocationPromise(showModalWhenCloseAuth, type, content, showCancel);
+      return getLocPromise;
+    }
+
+    // 缓存中有数据， 证明用户已经获取过， 那么直接返回缓存中的位置
+
+    return Promise.resolve(userLocationCache);
+  }
+
+  /**
+   * @description 获取位置(经纬度)底层封装
+   * @memberof Location
+   * @param {boolean} showModalWhenCloseAuth 获取位置时，如果用户关闭了位置授权，是否弹窗提示用户打开授权
+   * @param {string}  type 坐标类型
+   * @param {string}  content 弹窗内容
+   * @param {boolean} showCancel 是否显示取消按钮
+   * @returns {Promise<LOC|ERR>} 返回对象
+   * @example
+   * <caption>LOC类型示例</caption>
+   * {
+   *   cityName: '北京市',
+   *   cityCode: '100100',
+   *   latitude: 325.255333,
+   *   longitude: 116.2545454,
+   *   adCode: 1212144,
+   *   poi: {
+   *     id: '1114545554511',
+   *     title: '腾讯北京总部大厦',
+   *     address : '北京市海淀区东北旺西路',
+   *   }
+   */
+  public getWxLocationPromise(showModalWhenCloseAuth: boolean, type: string, content = '', showCancel = true) {
+    return new Promise((resolve, reject) => {
+      getWxLocation(type).then((res: WxPostionType) => {
+        userLocationCache = res;
+        // 更新用户状态 -- todo
+        updateLocStatus(true);
+        resolve(res);
+      })
+        .catch((err) => {
+          getLocPromise = null;
+          updateLocStatus(false);
+
+          this.openLocationAuth(showModalWhenCloseAuth, type, content, showCancel, err).then((res) => {
+            resolve(res);
+          }, (err) => {
+            reject(err);
+          });
+        });
+    });
+  }
+
+  /**
+   * 如果没有权限，自动开启授权弹窗
+   * @memberof Location
+   * @param {boolean} showModalWhenCloseAuth 获取位置时，如果用户关闭了位置授权，是否弹窗提示用户打开授权
+   * @param {string}  type 坐标类型
+   * @param {string}  content 弹窗内容
+   * @param {boolean} showCancel 是否显示取消按钮
+   * @param {object} err 错误信息
+   * @returns {Promise} 返回对象
+   */
+  openLocationAuth(showModalWhenCloseAuth: boolean, type: string, content: string, showCancel: boolean, err: any) {
+    return new Promise((resolve, reject) => {
+      const { locationEnabled, locationAuthorized } = getSystemInfo()!;
+      // 系统位置定位开关打开 && 允许微信使用位置定位能力开关打开
+      if (locationEnabled && locationAuthorized) {
+        if (err.errMsg.search(/auth [deny|denied]|authorize/) < 0) {
+          reject();
+          return;
+        }
+      }
+
+      if (!showModalWhenCloseAuth) {
+        const rejectData = { ...err, unAuthed: true };
+        reject(rejectData);
+        return;
+      }
+
+      // 控制地理位置开关的名称(系统控制的开关，还是微信层面的开关)
+      const isSysAndWechatAllowedGetLoc = (locationEnabled && locationAuthorized);
+      const { authLevelName, confirmText } = getTextByReason(locationEnabled, isSysAndWechatAllowedGetLoc);
+      wx.showModal({
+        confirmText,
+        title: `未开启${authLevelName}位置信息权限`,
+        content: content || `开启${authLevelName}位置信息权限\n体验更顺畅的出行服务`,
+        showCancel: (showCancel && isSysAndWechatAllowedGetLoc),
+        confirmColor: '#4875fd',
+        success: (res) => {
+        // 用户拒绝去授权
+          if (!res.confirm || !locationEnabled || !locationAuthorized) {
+            const rejectData = { ...err, unAuthed: true };
+            return reject(rejectData);
+          }
+
+          // 用户同意去打开授权(只是打开小程序设置页，用户不一定打开了位置授权，所以需要重新进行获取位置)
+          openSetting()
+            .then(() => {
+              resolve(this.getLocation(showModalWhenCloseAuth, type, content, showCancel));
+            })
+            .catch((err) => {
+              const rejectData = { ...err, unAuthed: true };
+              reject(rejectData);
+            });
+        },
+      });
+    });
+  }
+
+  /**
+   * 订阅用户位置信息变化
+   * @param { object } res 用户位置信息对象
+   * @returns { undefined } no retrurn
+   */
+  public subscribeLocationChnage(res: WxPostionType) {
+    userLocationCache = res;
+  }
+
+  /**
+   * @description
+   * 以静默方式获取用户位置(经纬度)，说明如下：<br>
+   * 1、从未授权情况下 | 用户删除小程序之后调用该方法不会弹微信自带的授权弹窗；<br>
+   * 2、拒绝授权后，调用该方法不会弹窗提示用户去授权（wx.showModal）；<br>
+   * @memberof Location
+   * @param {String} type 非必填。坐标类型，默认'gcj02'
+   * @returns {Promise<LOC|ERR>} 返回位置信息
+   * @example
+   * <caption>LOC类型示例</caption>
+   * {
+   *    latitude: 33.253321,
+   *    longitude: 115.2444,
+   * }
+   * @example
+   * <caption>ERR类型示例</caption>
+   * {
+   *   err,
+   *   unAuthed: true,
+   *   locationScopeStatus: false
+   * }
+   */
+  async getLocationSilent(type: string) {
+    let err = null;
+    let locationScopeStatus;
+    try {
+      locationScopeStatus = await getSetting();
+      // 用户已授权. locationScopeStatus = true
+      if (locationScopeStatus) {
+        return this.getLocation(false, type);
+      }
+    } catch (ex) {
+      err = ex;
+    }
+
+    updateLocStatus(false);
+    // 用户关闭了授权. locationScopeStatus = false
+    // 用户未授权过(删除小程序之后再次打开小程序). locationScopeStatus = undefined
+    return Promise.reject({ err, unAuthed: true, locationScopeStatus });
+  }
+
+  /**
+   * @memberof Location
+   * @description 监听获取位置状态变化(目前只有失败->成功时会触发事件)
+   * @param       {Function} cb 监听事件回调函数
+   * @returns {void}
+   */
+  onLocStatusChange(cb: () => void) {
+    if (cb && typeof cb === 'function') {
+      event.bind(EventName, cb);
+    }
+  }
+}
+
+export default LocationBase;