@tmsfe/tms-core 0.0.92 → 0.0.95

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,5 +1,6 @@
 /**
  * 负责对象的克隆
+ * @private: true
  */
 
 const maxArrLen = 10;
@@ -13,8 +14,8 @@ const fieldWhiteList = [
 
 function isBasicsType(obj: any, isConstraintLen = true): { isBasics: boolean, value: any } {
   const type = typeof obj;
-  if (obj === null || obj === undefined
-    || type === 'number' || type === 'boolean' || type === 'bigint') {
+  const arr1 = ['number', 'boolean', 'bigint'];
+  if (obj === null || obj === undefined || arr1.includes(type)) {
     return { isBasics: true, value: obj };
   }
   if (type === 'string') {
@@ -67,9 +68,6 @@ function deepClone(obj: any, depth = 0, maxDepth = 5): any {
     }
     const value = obj[name];
     const isConstraintLen = !fieldWhiteList.includes(name);
-    if (!isConstraintLen) {
-      debugger
-    }
     const res1 = isBasicsType(value, isConstraintLen);
     if (res1.isBasics) {
       // @ts-ignore

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'/>
@@ -10,6 +11,7 @@ import formatV2 from './formatV2';
 
 /**
  * 初始化
+ * @private
  */
 function init(options: IInitOptions): void {
   helper.init(options);
@@ -17,7 +19,9 @@ 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()) {
@@ -27,7 +31,9 @@ function report(data: IOldParams = {}): void {
 
 /**
  * 旧埋点，快速上报，不依赖用户位置
- * @param data { 27: xxxx, 34: xxx }
+ * @param { object } data 上报对象
+ * @example
+ * fastReport({ 27: xxxx, 34: xxx })
  */
 function fastReport(data: IOldParams = {}): void {
   if (helper.canReport()) {
@@ -38,6 +44,14 @@ 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()) {
@@ -46,7 +60,16 @@ function report2(...data: any[]): void {
 }
 
 /**
- * 新埋点，快速上报，不依赖用户位置
+ * 新埋点，埋点需要立即上报，不依赖用户位置，
+ * 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()) {

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中调用。
  *

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,14 +2,14 @@
 
 /**
  * @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';
 import getOpenAppTrafficData from './getopenapptrafficdata';
 
-const { loginFn, getOpenId, getMycarPubOpenId, getSinanPubOpenId, getPhone } = Login;
+const { loginFn, getOpenId, getMycarPubOpenId, getSinanPubOpenId, getPhone, registerPhone } = Login;
 
 /**
  * __resolver__ 用于维护 app.tms.fn 中数据的填充
@@ -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,8 +207,24 @@ 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,
   login,
   getLoginInfo,
   getOpenId,

package/src/runtime/{login.js → login.ts}

@@ -1,6 +1,8 @@
 /* eslint-disable valid-jsdoc */
 /**
  * @copyright 2021-present, Tencent, Inc. All rights reserved.
+ * @module: runtime-login
+ * @desc: 登录相关
  * @brief login.js 用于维护 runtime 框架的用户登录流程，获取用户的登录的可信凭证.
  * runtime初始化时，会调用登录流程，基于runtime的后续业务代码，不必关注用户的登录状态，
  * 当前，登录流程仅支持【腾讯出行服务小程序】，我们计划支持出行服务公众号的H5开发，基于runtime的
@@ -18,6 +20,12 @@
 
 import getOpenAppTrafficData from './getopenapptrafficdata';
 
+interface PhoneRegisterResult {
+  success: boolean,
+  phone: string,
+  errMsg: string,
+}
+
 /**
  * 调用wx.login获取登录code
  * @private
@@ -63,11 +71,15 @@ const loginFn = async () => {
  * @returns { object } resData 用户信息
  */
 async function login() {
-  let userData = {};
+  let userData: {
+    errCode?: any,
+    resData?: any
+  } = {};
 
   try {
     const code = await getCode();
 
+    // @ts-ignore
     const { trafficEntrence: registerSource, scene: sceneId } = getOpenAppTrafficData();
 
     userData = await getApp().tms.createRequest({ withAuth: false }).post('user/login', { code, registerSource, sceneId });
@@ -93,6 +105,7 @@ const getOpenId = async () => {
     return getOpenIdProm;
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-misused-promises
   getOpenIdProm = new Promise(async (resolve, reject) => {
     getApp().tms.callCloudFunc('user', { $url: 'user/getOpenId' })
       .then((res) => {
@@ -192,15 +205,57 @@ const getSinanPubOpenId = () => {
 const getPhone = () => getApp().tms.createRequest({ withAuth: true }).post('user/phone/fetch')
   .then((res) => {
     if (res && res.errCode === 0) {
-      return (res.resData && res.resData.phoneno) || '';
+      return (res.resData?.phoneno) || '';
     }
     return Promise.reject(res);
   });
 
+/**
+ * @description 绑定手机号
+ * @param {Object} data    params 加密数据对象
+ * @param {string} data.encryptedData button组件bindgetphonenumber事件返回的encryptedData字段
+ * @param {string} data.iv button组件bindgetphonenumber事件返回的iv字段
+ * @returns {Object} data    绑定结果回调
+ * @returns {number} data.success 是否绑定成功 boolean类型
+ * @returns {number} data.phone  绑定成功时的手机号，失败则为空
+ * @returns {number} data.errMsg 绑定结果描述信息
+ * @example
+ * const { tms } = getApp({ allowDefault: true });
+ * const res = await tms.registerPhone({ encryptedData, iv })
+ * if(res.success) {
+ *    console.log('phone', res.phone)
+ * } else {
+ *    // 注册失败处理逻辑
+ *    console.log(res.errMsg)
+ * }
+ */
+async function registerPhone({ encryptedData, iv }: {encryptedData: string, iv: string}): Promise<PhoneRegisterResult> {
+  try {
+    const result = await getApp().tms.createRequest().post('user/phone/regist', {
+      iv,
+      isCipher: 1,
+      phoneno: encryptedData,
+    });
+    return {
+      success: result.errCode === 0,
+      phone: result.errCode === 0 ? result.resData.phoneno : '',
+      errMsg: result.errMsg,
+    };
+  } catch (error: any) {
+    console.error(error);
+    return {
+      success: false,
+      phone: '',
+      errMsg: '绑定失败',
+    };
+  }
+}
+
 const runtimeObj = {
   loginFn,
   getOpenId,
   getPhone,
+  registerPhone,
   getMycarPubOpenId,
   getSinanPubOpenId,
 };

package/src/storage.js

@@ -1,3 +1,7 @@
+/**
+ * @desc: 处理localstorage相关函数
+ */
+
 /**
  * 保存数据到localstorage
  * @param key
@@ -17,7 +21,7 @@ function setItem(key, data) {
  * 从localstorage取数据
  * @param key
  * @param defaultValue wx接口报错时返回默认值
- * @returns {null|any}
+ * @returns {any}
  */
 function getItem(key, defaultValue = null) {
   try {
@@ -60,10 +64,10 @@ function cleanTask() {
 }
 
 /**
- * 缓存组件或页面的缓存data
- * @param key
- * @param version 低于该版本号的缓存会被异步清除
- * @param data
+ * 缓存组件或页面的缓存data，会缓存到localStorage里
+ * @param {string} key localStorage的唯一标志
+ * @param {string} version 版本号，低于该版本号的缓存会被异步清除
+ * @param {object} data 页面缓存的数据
  * @returns {boolean}
  */
 function setCacheData(key, version, data) {
@@ -81,10 +85,10 @@ function setCacheData(key, version, data) {
 
 /**
  * 获取组件或页面的缓存data
- * @param key
- * @param version
- * @param defaultData
- * @returns {*|null}
+ * @param {string} key localStorage的唯一标志
+ * @param {string} version 版本号
+ * @param {object} defaultData 接口报错时返回默认值
+ * @returns {any}
  */
 function getCacheData(key, version, defaultData = null) {
   const str = `${key}_v${version}`;