feat: verify phone number before update

Author: sdjdd

src/cloudfunction.js

@@ -83,8 +83,7 @@ module.exports = function(AV) {
        * @param {String} data.mobilePhoneNumber
        * @param {String} [data.template] sms template name
        * @param {String} [data.sign] sms signature name
-       * @param {AuthOptions} [options] AuthOptions plus:
-       * @param {String} [options.validateToken] a validate token returned by {@link AV.Cloud.verifyCaptcha}
+       * @param {SMSAuthOptions} [options]
        * @return {Promise} A promise that will be resolved if the request succeed
        */
       requestSmsCode(data, options = {}) {

src/index.js

@@ -46,3 +46,12 @@ module.exports = AV;
  * @property {AV.User} [user] Specify a user to excute the operation as. The user must have _sessionToken. This option will be ignored if sessionToken option provided.
  * @property {Boolean} [useMasterKey] Indicates whether masterKey is used for this operation. Only valid when masterKey is set.
  */
+
+/**
+ * Options to controll the authentication for an SMS operation
+ * @typedef {Object} SMSAuthOptions
+ * @property {String} [sessionToken] Specify a user to excute the operation as.
+ * @property {AV.User} [user] Specify a user to excute the operation as. The user must have _sessionToken. This option will be ignored if sessionToken option provided.
+ * @property {Boolean} [useMasterKey] Indicates whether masterKey is used for this operation. Only valid when masterKey is set.
+ * @property {String} [validateToken] a validate token returned by {@link AV.Cloud.verifyCaptcha}
+ */

src/user.js

@@ -1537,8 +1537,7 @@ module.exports = function(AV) {
        *
        * @param {String} mobilePhoneNumber The mobile phone number associated with the
        *                  user that doesn't verify their mobile phone number.
-       * @param {AuthOptions} [options] AuthOptions plus:
-       * @param {String} [options.validateToken] a validate token returned by {@link AV.Cloud.verifyCaptcha}
+       * @param {SMSAuthOptions} [options]
        * @return {Promise}
        */
       requestMobilePhoneVerify: function(mobilePhoneNumber, options = {}) {
@@ -1566,8 +1565,7 @@ module.exports = function(AV) {
        *
        * @param {String} mobilePhoneNumber The mobile phone number  associated with the
        *                  user that doesn't verify their mobile phone number.
-       * @param {AuthOptions} [options] AuthOptions plus:
-       * @param {String} [options.validateToken] a validate token returned by {@link AV.Cloud.verifyCaptcha}
+       * @param {SMSAuthOptions} [options]
        * @return {Promise}
        */
       requestPasswordResetBySmsCode: function(mobilePhoneNumber, options = {}) {
@@ -1588,6 +1586,45 @@ module.exports = function(AV) {
         return request;
       },
 
+      /**
+       * Requests a change mobile phone number sms code to be sent to the mobilePhoneNumber.
+       * This sms code allows current user to reset it's mobilePhoneNumber by
+       * calling {@link AV.User.changePhoneNumber}
+       * @param {String} mobilePhoneNumber
+       * @param {Number} [ttl] ttl of sms code (default is 6 minutes)
+       * @param {SMSAuthOptions} [options]
+       * @return {Promise}
+       */
+      requestChangePhoneNumber(mobilePhoneNumber, ttl, options) {
+        const data = { mobilePhoneNumber };
+        if (ttl) {
+          data.ttl = options.ttl;
+        }
+        if (options && options.validateToken) {
+          data.validate_token = options.validateToken;
+        }
+        return AVRequest(
+          'requestChangePhoneNumber',
+          null,
+          null,
+          'POST',
+          data,
+          options
+        );
+      },
+
+      /**
+       * Makes a call to reset user's account mobilePhoneNumber by sms code.
+       * The sms code is sent by {@link AV.User.requestChangePhoneNumber}
+       * @param {String} mobilePhoneNumber
+       * @param {String} code The sms code.
+       * @return {Promise}
+       */
+      changePhoneNumber(mobilePhoneNumber, code) {
+        const data = { mobilePhoneNumber, code };
+        return AVRequest('changePhoneNumber', null, null, 'POST', data);
+      },
+
       /**
        * Makes a call to reset user's account password by sms code and new password.
        * The sms code is sent by AV.User.requestPasswordResetBySmsCode.
@@ -1627,8 +1664,7 @@ module.exports = function(AV) {
        *
        * @param {String} mobilePhoneNumber The mobile phone number  associated with the
        *           user that want to login by AV.User.logInWithMobilePhoneSmsCode
-       * @param {AuthOptions} [options] AuthOptions plus:
-       * @param {String} [options.validateToken] a validate token returned by {@link AV.Cloud.verifyCaptcha}
+       * @param {SMSAuthOptions} [options]
        * @return {Promise}
        */
       requestLoginSmsCode: function(mobilePhoneNumber, options = {}) {

storage.d.ts

@@ -787,6 +787,15 @@ export class User extends Object {
     options?: AuthOptions
   ): Promise<User>;
   static verifyMobilePhone(code: string, options?: AuthOptions): Promise<User>;
+  static requestChangePhoneNumber(
+    mobilePhoneNumber: string,
+    ttl?: number,
+    options?: SMSAuthOptions
+  ): Promise<void>;
+  static changePhoneNumber(
+    mobilePhoneNumber: string,
+    code: string
+  ): Promise<void>;
 
   static followerQuery<T extends User>(userObjectId: string): Query<T>;
   static followeeQuery<T extends User>(userObjectId: string): Query<T>;