@tmsfe/tms-core 0.0.94 → 0.0.96

package/src/md5.js

@@ -1,9 +1,6 @@
 /**
- * @copyright 2017-present, Tencent, Inc. All rights reserved.
  * @author Davis.Lu <davislu@tencent.com>
- *
- * @file crypto tools.
- *
+ * @desc: 基于md5算法对源字符串进行hash，生成hash字符串
 **/
 
 /**

package/src/mpInfo.js

@@ -1,5 +1,5 @@
 /**
- * 支持服务接入相关接口
+ * @desc: 支持服务接入相关接口
  */
 import Request from './request';
 
@@ -11,6 +11,9 @@ import Request from './request';
  * @param {String} mpId 接入服务商渠道标识
  * @param {String} userId 出行用户标识
  * @returns {Promise<String>} 返回 openId，失败时返回空
+ * @example
+ * const { tms } = getApp({ allowDefault: true });
+ * tms.getMpOpenId('xxx', '111')
  */
 async function getMpOpenId(mpId, userId) {
   const { resData } = await new Request().post('user/mpinfo', { userId, mpId });
@@ -25,6 +28,9 @@ async function getMpOpenId(mpId, userId) {
  * @category 服务接入
  * @param {String} apiKey 服务接入方渠道标识
  * @returns {Promise<String>} 返回 openId，失败时返回空
+ * @example
+ * const { tms } = getApp({ allowDefault: true });
+ * tms.getMpOpenId('xxx', '111')
  */
 async function getOuterOpenId(apiKey) {
   const { resData } = await new Request().post('user/mpinfo', { mpId: apiKey });

package/src/navbarUtils.js

@@ -1,8 +1,11 @@
+/**
+ * @desc: 获取导航高度的相关函数
+ */
+import { compareVersion } from './compareVersion';
 let systemInfo = null;
 
 /**
- * 获取系统信息，有缓存
- * 返回数据同wx.getSystemInfoSync
+ * 获取系统信息，有缓存, 返回数据同wx.getSystemInfoSync  {@link https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getSystemInfoSync.html}
  * @returns {Object} 系统信息
  */
 const getSystemInfoSync = () => {
@@ -18,7 +21,7 @@ const getSystemInfoSync = () => {
 };
 
 /**
- * 获取系统信息
+ * 获取系统信息，有缓存, 返回数据同wx.getSystemInfoSync {@link https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getSystemInfoSync.html}
  * @returns {Object} 系统信息
  */
 const getSysInfo = () => {
@@ -34,7 +37,7 @@ const getSysInfo = () => {
 };
 
 /**
- * 获取胶囊位置信息
+ * 获取胶囊位置信息,返回数据同wx.getMenuButtonBoundingClientRect {@link https://developers.weixin.qq.com/miniprogram/dev/api/ui/menu/wx.getMenuButtonBoundingClientRect.html}
  * @returns {Object} 胶囊位置信息
  */
 const getMenuButtonRectInfo = () => {
@@ -51,38 +54,9 @@ const getMenuButtonRectInfo = () => {
   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;
-};
-
 /**
  * 胶囊高度适配，以兼容获取到的胶囊高度值非法的情况
+ * @private
  * @param {Number} height 胶囊高度
  * @param {Boolean} isIOS 是否是ios系统
  * @returns {Number} 胶囊高度
@@ -97,6 +71,7 @@ const formatMenuHeight = (height, isIOS) => {
 
 /**
  * 计算自定义导航栏布局信息
+ * @private
  * @param {Boolean} isIOS          是否是ios平台
  * @param {Number} statusBarHeight 状态栏高度
  * @param {String} apiCategory     API类别
@@ -194,5 +169,4 @@ const getEnterOptions = () => {
 
 export {
   getNavBarConfigData,
-  compareVersion,
 };

package/src/navigator.js

@@ -1,9 +1,7 @@
 
 /**
- * @copyright 2021-present, Tencent, Inc. All rights reserved.
+ * @desc: 小程序跳转相关方法
  * @author Davislu <davislu@tencent.com>
- * @brief navigator provides some function to navigate pages in miniprogram.
- *
  */
 
 /**
@@ -26,7 +24,7 @@ const DEFN = () => {};
  * @param {object} setting.navbar 页面导航栏设置
  * @param {string} setting.navbar.frontColor 导航栏字体颜色
  * @param {string} setting.navbar.backgroundColor 导航栏背景颜色
- * @returns {undefined} 无返回值
+ * @returns {void} 无返回值
 */
 const navigateToWebview = ({ url: webUrl, complete = DEFN, message = DEFN, share = {}, navbar = {} }) => {
   const page = '/modules/x/webcontainer/webcontainer';

package/src/numUtils.js

@@ -1,12 +1,15 @@
+/**
+ * @desc: 数字处理相关函数
+ */
+
 import { roundStr } from './stringUtils';
 /**
  * 四舍五入（支持保留n位小数，n>=0）
- * @param {any} x 原数字
- *                如果n不是合法数字或者无法转换为合法数字，round结果返回NaN
- * @param {any} n 保留几位小数，默认0
- *                如果n不是合法数字或者无法转换为合法数字，round结果返回NaN
- *                如果n小于0，round结果返回NaN
- *                如果n的值包含小数部分，round处理时只关注n的整数部分值
+ * @param {any} x 原数字， 如果n不是合法数字或者无法转换为合法数字，round结果返回NaN
+ * @param {any} n 保留几位小数，默认0；
+ 1. 如果n不是合法数字或者无法转换为合法数字，round结果返回NaN；
+ 2. 如果n小于0，round结果返回NaN；
+ 3. 如果n的值包含小数部分，round处理时只关注n的整数部分值
  * @return {number} 返回一个保留n位小数的数字，异常情况下可能是NaN
  */
 const round = (x, n = 0) => parseFloat(roundStr(x, n, false));

package/src/objUtils.js

@@ -1,6 +1,5 @@
 /**
- * Tencent Inc. All Rights Reserved.
- * Description: Some Functions for Obejct.
+ * @desc: 对象处理相关函数
  */
 
 /**
@@ -32,6 +31,8 @@ export class JsonParseError extends Error {
 
 /**
  * 安全的JSON.parse
+ * @param {object} data JSON.parse的对象
+ * @param {boolean} throwErrIfParseFail 如果解析失败，是否抛出错误
  */
 export function safeJsonParse(data, throwErrIfParseFail = false) {
   try {

package/src/report/clone.ts

@@ -1,10 +1,11 @@
 /**
  * 负责对象的克隆
+ * @private: true
  */
 
 const maxArrLen = 10;
-const maxStrLen = 200;
-const maxFieldLen = 20;
+const maxStrLen = 50;
+const maxFieldLen = 10;
 
 // 字符串字段白名单，白名单内的字段不截断
 const fieldWhiteList = [
@@ -47,9 +48,9 @@ function isArrayType(obj: any): { isArray: boolean, value: any } {
  * @param depth 当前克隆的深度
  * @param maxDepth 最大克隆深度
  */
-function deepClone(obj: any, depth = 0, maxDepth = 5): any {
+function deepClone(obj: any, depth = 0, maxDepth = 2): any {
   if (depth > maxDepth) {
-    return undefined;
+    return '深度超过上限，截断';
   }
   const res1 = isBasicsType(obj);
   if (res1.isBasics) {

package/src/report/formatV1.ts

@@ -1,5 +1,6 @@
 /**
  * 格式化旧埋点
+ * @private: true
  */
 
 // / <reference path='./types.ts'/>

package/src/report/formatV2.ts

@@ -1,5 +1,6 @@
 /**
  * 格式化新埋点
+ * @private: true
  */
 
 // / <reference path='./types.ts'/>

package/src/report/helper.ts

@@ -1,5 +1,6 @@
 /**
  * 埋点辅助函数
+ * @private: true
  */
 
 // / <reference path='./types.ts'/>
@@ -8,7 +9,7 @@ import clone from './clone';
 
 function getTms(): any {
   // 如果是在app.js的onLaunch中调用，则没有getApp().tms为空
-  return getApp()?.tms || wx.tms;
+  return getApp()?.tms || (wx as any).tms;
 }
 
 let initOptions: IInitOptions;

package/src/report/index.ts

@@ -1,5 +1,6 @@
 /**
- * 埋点
+ * @desc: 埋点上报
+ * @module: report
  */
 
 // / <reference path='./types.ts'/>
@@ -8,8 +9,12 @@ import sender from './sender';
 import formatV1 from './formatV1';
 import formatV2 from './formatV2';
 
+const logger = wx.getLogManager({});
+logger.log('report模块代码被装载');
+
 /**
  * 初始化
+ * @private
  */
 function init(options: IInitOptions): void {
   helper.init(options);
@@ -17,20 +22,26 @@ function init(options: IInitOptions): void {
 
 /**
  * 旧埋点
- * @param data { 27: xxxx, 34: xxx }
+ * @param { object } data 上报对象
+ * @example
+ * report({ 27: xxxx, 34: xxx })
  */
 function report(data: IOldParams = {}): void {
   if (helper.canReport()) {
+    logger.log('旧埋点:', data);
     formatV1.formatData(data).then(arr => sender.queue(arr));
   }
 }
 
 /**
  * 旧埋点，快速上报，不依赖用户位置
- * @param data { 27: xxxx, 34: xxx }
+ * @param { object } data 上报对象
+ * @example
+ * fastReport({ 27: xxxx, 34: xxx })
  */
 function fastReport(data: IOldParams = {}): void {
   if (helper.canReport()) {
+    logger.log('旧立即埋点:', data);
     const arr = formatV1.formatFastData(data);
     sender.send(arr);
   }
@@ -38,18 +49,37 @@ function fastReport(data: IOldParams = {}): void {
 
 /**
  * 新埋点
+ * @param {string} 参数1 页面|组件的唯一标志
+ * @param {any}  参数2 埋点属性(会埋在埋点31个字段)
+ * @param {any} 参数3 埋点属性(会埋在埋点32个字段) 依次类推参数4、参数5，最多10个参数
+ * @returns {void}
+ * @example
+ * const { tms } = getApp({ allowDefault: true });
+ * const reporter = tms.getReporter();
+ * reporter.report2('user_security_level', {}, {});
  */
 function report2(...data: any[]): void {
   if (helper.canReport()) {
+    logger.log('新埋点:', data);
     formatV2.formatData(data).then(arr => sender.queue(arr));
   }
 }
 
 /**
- * 新埋点，快速上报，不依赖用户位置
+ * 新埋点，埋点需要立即上报，不依赖用户位置，
+ * fastReport2()上报时携带的"省"、"市"等需要异步请求的基础字段会从缓存中读取，如果无缓存则为空，report2()则一定会携带这些字段
+ * @param {string} 参数1 页面|组件的唯一标志
+ * @param {any}  参数2 埋点属性(会埋在埋点31个字段)
+ * @param {any} 参数3 埋点属性(会埋在埋点32个字段) 依次类推参数4、参数5，最多10个参数
+ * @returns {void}
+ * @example
+ * const { tms } = getApp({ allowDefault: true });
+ * const reporter = tms.getReporter();
+ * reporter.fastReport2('user_security_level', {}, {});
  */
 function fastReport2(...data: any[]): void {
   if (helper.canReport()) {
+    logger.log('新立即埋点:', data);
     const arr = formatV2.formatFastData(data);
     sender.send(arr);
   }

package/src/report/proxy/app.ts

@@ -1,5 +1,6 @@
 /**
  * 负责小程序级的全埋点
+ * @private: true
  */
 
 // / <reference path='./types.ts'/>

package/src/report/proxy/component.ts

@@ -1,5 +1,6 @@
 /**
  * 负责组件的全埋点
+ * @private: true
  */
 
 // / <reference path='./types.ts'/>

package/src/report/proxy/helper.ts

@@ -1,12 +1,13 @@
 /**
  * 全埋点辅助类
+ * @private: true
  */
 
 // / <reference path='./types.ts'/>
 
 function getReporter(): any {
   // 如果是在app.js的onLaunch中调用，则没有getApp().tms为空
-  const tms = getApp()?.tms || wx.tms;
+  const tms = getApp()?.tms || (wx as any).tms;
   return tms.getReporter();
 }
 
@@ -56,7 +57,7 @@ function setLastBindEvent(info: IBindEvent): void {
   const pages = getCurrentPages().reverse();
   const page = pages.find((t: any) => t) || {};
   // eslint-disable-next-line
-  info.pageUrl = page.route;
+  info.pageUrl = (page as any).route;
   lastBindEvent = info;
 }
 

package/src/report/proxy/index.ts

@@ -1,5 +1,6 @@
 /**
  * 负责页面和组件的全埋点
+ * @private: true
  */
 
 import proxyApp from './app';

package/src/report/proxy/page.ts

@@ -1,5 +1,6 @@
 /**
  * 负责页面的全埋点
+ * @private: true
  */
 
 // / <reference path='./types.ts'/>

package/src/report/proxy/types.ts

@@ -2,6 +2,7 @@
 
 /**
  * 绑定的触发事件埋点
+ * @private: true
  */
 interface IBindEvent {
   /**

package/src/report/sender.ts

@@ -1,5 +1,6 @@
 /**
  * 负责发送埋点
+ * @private: true
  */
 
 // / <reference path='./types.ts'/>

package/src/request.js

@@ -1,7 +1,7 @@
 /**
  * @copyright 2021-present, Tencent, Inc. All rights reserved.
  * @brief request.js用于发起网络请求.
- * request模块作为基于 tms-core 的应用的公共请求模块。
+ * @desc: request模块作为基于 tms-core 的应用的公共请求模块。
  * 目前支持在出行服务小程序或基于出行服务的小程序中调用。在后续runtime支持公众号H5后，
  * 将支持在H5中调用。
  *
@@ -9,10 +9,11 @@
  * 框架判断在不同的运行环境，切换调用不同运行环境提供的方法。
  */
 import md5 from './md5';
-import { getLogManager } from './log';
 import { getEnvInfo, getAuthInfo } from './env';
 import { safeJsonParse } from './objUtils';
 
+const logger = wx.getLogManager({});
+
 /**
  * 用于序列化需要签名的参数
  * @private
@@ -144,11 +145,11 @@ export default class Request {
   }
 
   /**
-  * 格式化接口路径
-  * @private
-  * @param {string} path 需要格式化的接口路径
-  * @returns {string} 格式化后的接口路径
-  */
+   * 格式化接口路径
+   * @private
+   * @param {string} path 需要格式化的接口路径
+   * @returns {string} 格式化后的接口路径
+   */
   makeUrl(path) {
     if ((/^http/i).test(path)) return path;
     const host = this.host || Request.defaultHost;
@@ -288,10 +289,10 @@ export default class Request {
   async serialize(path, data = {}) {
     let url = this.makeUrl(path);
     const signData = await composeParam(data, this.withAuth, this.baseParam);
-    const signture = sign(signData);
+    const signature = sign(signData);
     const params = [];
-    Object.keys(signture).forEach((key) => {
-      const val = encodeURIComponent(signture[key]);
+    Object.keys(signature).forEach((key) => {
+      const val = encodeURIComponent(signature[key]);
       params.push(`${key}=${val}`);
     });
     if (params.length) url += (/\?/.test(url) ? '&' : '?') + params.join('&');
@@ -310,23 +311,46 @@ export default class Request {
   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) => {
+    return new Promise((resolve, reject) => {
       wx.request({
         url: this.makeUrl(path),
         header,
         method,
         data,
         success: (res) => {
+          // 埋点已经单独打日志了，接口请求数据日志太长影响分析
+          if (path.indexOf('basic/event/upload') === -1) {
+            let result = JSON.stringify(res?.data);
+            if (result.length > 500) {
+              result = `${result.substring(0, 500)} 内容太长被截断`;
+            }
+            const obj = {
+              path,
+              method,
+              header: JSON.stringify(header),
+              params: JSON.stringify(data),
+              res: result,
+            };
+            const str = JSON.stringify(obj, null, '  ').replace(/\\"/ig, '\'');
+            logger.log(`接口请求成功：\n${str}`);
+          }
+
           resolve(res);
-          logger.log({ path, header, method, param: data, res: res?.data });
         },
         fail: (err) => {
+          const obj = {
+            path,
+            method,
+            header: JSON.stringify(header),
+            params: JSON.stringify(data),
+            err: JSON.stringify(err),
+          };
+          const str = JSON.stringify(obj, null, '  ').replace(/\\"/ig, '\'');
+          logger.error(`接口请求失败：\n${str}`);
+
           reject(err);
-          logger.log({ path, header, method, param: data, err });
         },
       });
     });
-    return res;
   }
 }

package/src/rpx.js

@@ -1,9 +1,13 @@
+/**
+ * @desc: pr\rpx互相转化
+ */
+
 import syncApi from './syncfnmanager';
 
 /**
  * @description rpx to px
  * @param    {Number} rpx 需要转换的rpx数值
- * @returns  {Number}     转换后的rpx数值
+ * @returns  {Number}     转换后的px数值
  */
 const rpxToPx = (rpx) => {
   const sys = syncApi.getSystemInfoSync();
@@ -14,8 +18,8 @@ const rpxToPx = (rpx) => {
 
 /**
  * @description px to rpx
- * @returns  {Number}     转换后的rpx数值
- * @param px
+ * @param {Number} px 需要转换的px数值
+ * @returns {Number}  转换后的rpx数值
  */
 const pxToRpx = (px) => {
   const sys = syncApi.getSystemInfoSync();

package/src/runtime/car.js

@@ -1,3 +1,7 @@
+/**
+ * @module: runtime-car
+ * @desc: 车辆相关
+ */
 let carInfo = {}; // 当前车信息
 let carList = []; // 缓存到的车列表信息
 let getCarListProm = null;

package/src/runtime/index.js

@@ -2,8 +2,8 @@
 
 /**
  * @copyright 2021-present, Tencent, Inc. All rights reserved.
- * @brief  runtime.js is used to initialize a tms based app.
- *
+ * @module: runtime-index
+ * @desc: 集成业务通用接口(登录、车辆、微信支付分)
  */
 import Login from './login';
 import Car from './car';
@@ -74,14 +74,15 @@ const login = async () => {
 };
 
 /**
- * 获取微信支付分授权
- * @param { param.traceSource ？ } 请求来源： 1-订单 2-支付网关 3-车机网关 4-开放平台 6-分账
- * @param { param.subMchId ？ } 商户id
- * @param { param.bussClassify ？ } 请求来源： 1-洗车 2-停车 12-代驾 24-租车 13-保养 3-加油
- * @param { param.payChannel ？ } 请求来源： 1-小程序 2-车机 3-小场景 4-开放平台 5-H5
- * @param { param.wechaId ？ } 公众号id，支付分授权相关一般都用我的车的车公众号
- * @param { param.subAppId ？ } 小程序的id，支付分授权相关一般都用我的车小程序id
- * @param { param.openId ？ } 用户在我的车公众号下面的id
+ * 设置微信支付分授权
+ * @param {Object} params对象类型 以下是params的解释
+ * @param {Number}params.traceSource 请求来源： 1-订单 2-支付网关 3-车机网关 4-开放平台 6-分账
+ * @param {String } param.subMchId 商户id
+ * @param {Number} params.bussClassify 请求来源： 1-洗车 2-停车 12-代驾 24-租车 13-保养 3-加油
+ * @param {Number} params.payChannel  请求来源： 1-小程序 2-车机 3-小场景 4-开放平台 5-H5
+ * @param {String} params.wechaId 公众号id，支付分授权相关一般都用我的车的车公众号
+ * @param {String} params.subAppId 小程序的id，支付分授权相关一般都用我的车小程序id
+ * @param {String} params.openId 用户在我的车公众号下面的id
  * @returns { object } { state: 1, errMsg: 200, errMsg: '', errData: '' }
  */
 async function setPaypointAuth(param = {}) {
@@ -130,8 +131,9 @@ function getRequestInstnce() {
 
 /**
  * 获取微信支付分授权
- * @param { param.traceSource ？ } 请求来源： 1-订单 2-支付网关 3-车机网关 4-开放平台 6-分账
- * @param { param.payChannel ？ } 请求来源： 1-小程序 2-车机 3-小场景 4-开放平台 5-H5
+ * @param {Object} params对象类型 以下是params的解释
+ * @param {Number} params.traceSource 请求来源： 1-订单 2-支付网关 3-车机网关 4-开放平台 6-分账
+ * @param {Number} param.payChannel 请求来源： 1-小程序 2-车机 3-小场景 4-开放平台 5-H5
  * @returns { object } { errMsg: 200, errMsg: '', errData: '' }
  */
 async function getPermissionList(param = {}) {
@@ -150,13 +152,14 @@ async function getPermissionList(param = {}) {
 
 /**
  * 获取微信支付分授权
- * @param { param.traceSource ？ } 请求来源： 1-订单 2-支付网关 3-车机网关 4-开放平台 6-分账
- * @param { param.subMchId ？ } 商户id
- * @param { param.bussClassify ？ } 请求来源： 1-洗车 2-停车 12-代驾 24-租车 13-保养 3-加油
- * @param { param.payChannel ？ } 请求来源： 1-小程序 2-车机 3-小场景 4-开放平台 5-H5
- * @param { param.wechaId ？ } 公众号id，支付分授权相关一般都用我的车的车公众号
- * @param { param.subAppId ？ } 小程序的id，支付分授权相关一般都用我的车小程序id
- * @param { param.openId ？ } 用户在我的车公众号下面的id
+ * @param {Object} params对象类型 以下是params的解释
+ * @param {Number} params.traceSource 请求来源： 1-订单 2-支付网关 3-车机网关 4-开放平台 6-分账
+ * @param {String} params.subMchId 商户id
+ * @param {Number} params.bussClassify请求来源： 1-洗车 2-停车 12-代驾 24-租车 13-保养 3-加油
+ * @param {Number} params.payChannel请求来源： 1-小程序 2-车机 3-小场景 4-开放平台 5-H5
+ * @param {String} params.wechaId 公众号id，支付分授权相关一般都用我的车的车公众号
+ * @param {String} params.subAppId小程序的id，支付分授权相关一般都用我的车小程序id
+ * @param {String} params.openId用户在我的车公众号下面的id
  * @returns { object } { state: 1, errMsg: 200, errMsg: '', errData: '' }
  */
 async function terminatePaypointPermisson(param = {}) {
@@ -183,9 +186,10 @@ async function terminatePaypointPermisson(param = {}) {
 
 /**
  * 获取用户在某个业务中是否授权
- * @param { param.traceSource ？ } 请求来源： 1-订单 2-支付网关 3-车机网关 4-开放平台 6-分账
- * @param { param.bussClassify ？ } 请求来源： 1-洗车 2-停车 12-代驾 24-租车 13-保养 3-加油
- * @param { param.payChannel ？ } 请求来源： 1-小程序 2-车机 3-小场景 4-开放平台 5-H5
+ * @param {Object} params对象类型 以下是params的解释
+ * @param {Number} params.traceSource 请求来源： 1-订单 2-支付网关 3-车机网关 4-开放平台 6-分账
+ * @param {Number} params.bussClassify 请求来源： 1-洗车 2-停车 12-代驾 24-租车 13-保养 3-加油
+ * @param {Number} params.payChannel 请求来源： 1-小程序 2-车机 3-小场景 4-开放平台 5-H5
  * @returns { object } { state: 1, errMsg: 200, errMsg: '', errData: '' }
  */
 async function queryServicePermissions(param = {}) {
@@ -203,6 +207,21 @@ async function queryServicePermissions(param = {}) {
   return res;
 }
 
+/**
+ * @namespace runtimeapi
+ * @description 对外暴露的api
+ * @param {Function} getPhone 获取手机号
+ * @param {Function} login... 详见跳转[runtime-login](#runtime-login)
+ * @param {Function} getLoginInfo 返回 loginInfoPromise
+ * @param {Function} getOpenId 获取openId  详见跳转[runtime-login](#runtime-login)
+ * @param {Function} getMycarPubOpenId 获取用户在我的车公众号下的openId 详见跳转[runtime-login](#runtime-login)
+ * @param {Function} getSinanPubOpenId 获取用户在出行服务公众号下的openId 详见跳转[runtime-login](#runtime-login)
+ * @param {Function} getCarManager 用户获取小程序统一维护的车信息管理器，详见跳转 [runtimt-car](#runtime-car)
+ * @param {Function} setPaypointAuth 设置微信支付分授权
+ * @param {Function} getPermissionList 获取微信支付分授权
+ * @param {Function} terminatePaypointPermisson 获取微信支付分授权
+ * @param {Function} queryServicePermissions 获取用户在某个业务中是否授权
+ */
 const api = {
   getPhone,
   registerPhone,