docs(user): update OAuth login method definitions

and fix some definition issues.

Author: leeyeh

src/user.js

@@ -644,7 +644,6 @@ module.exports = function(AV) {
       /**
        * Calls set("mobilePhoneNumber", phoneNumber, options) and returns the result.
        * @param {String} mobilePhoneNumber
-       * @param {AuthOptions} options
        * @return {Boolean}
        * @see AV.Object#set
        */
@@ -655,7 +654,6 @@ module.exports = function(AV) {
       /**
        * Calls set("username", username, options) and returns the result.
        * @param {String} username
-       * @param {AuthOptions} options
        * @return {Boolean}
        * @see AV.Object#set
        */
@@ -666,7 +664,6 @@ module.exports = function(AV) {
       /**
        * Calls set("password", password, options) and returns the result.
        * @param {String} password
-       * @param {AuthOptions} options
        * @return {Boolean}
        * @see AV.Object#set
        */
@@ -799,8 +796,8 @@ module.exports = function(AV) {
        *
        * @param {String} username The username (or email) to sign up with.
        * @param {String} password The password to sign up with.
-       * @param {Object} attrs Extra fields to set on the new user.
-       * @param {AuthOptions} options
+       * @param {Object} [attrs] Extra fields to set on the new user.
+       * @param {AuthOptions} [options]
        * @return {Promise} A promise that is fulfilled with the user when
        *     the signup completes.
        * @see AV.User#signUp
@@ -820,15 +817,14 @@ module.exports = function(AV) {
        *
        * @param {String} username The username (or email) to log in with.
        * @param {String} password The password to log in with.
-       * @param {AuthOptions} options
        * @return {Promise} A promise that is fulfilled with the user when
        *     the login completes.
        * @see AV.User#logIn
        */
-      logIn: function(username, password, options) {
+      logIn: function(username, password) {
         var user = AV.Object._create('_User');
         user._finishFetch({ username: username, password: password });
-        return user.logIn(options);
+        return user.logIn();
       },
 
       /**
@@ -869,15 +865,14 @@ module.exports = function(AV) {
        *
        * @param {String} mobilePhone The user's mobilePhoneNumber
        * @param {String} smsCode The sms code sent by AV.User.requestLoginSmsCode
-       * @param {AuthOptions} options
        * @return {Promise} A promise that is fulfilled with the user when
        *     the login completes.
        * @see AV.User#logIn
        */
-      logInWithMobilePhoneSmsCode: function(mobilePhone, smsCode, options) {
+      logInWithMobilePhoneSmsCode: function(mobilePhone, smsCode) {
         var user = AV.Object._create('_User');
         user._finishFetch({ mobilePhoneNumber: mobilePhone, smsCode: smsCode });
-        return user.logIn(options);
+        return user.logIn();
       },
 
       /**
@@ -914,18 +909,17 @@ module.exports = function(AV) {
        *
        * @param {String} mobilePhone The user's mobilePhoneNumber
        * @param {String} password The password to log in with.
-       * @param {AuthOptions} options
        * @return {Promise} A promise that is fulfilled with the user when
        *     the login completes.
        * @see AV.User#logIn
        */
-      logInWithMobilePhone: function(mobilePhone, password, options) {
+      logInWithMobilePhone: function(mobilePhone, password) {
         var user = AV.Object._create('_User');
         user._finishFetch({
           mobilePhoneNumber: mobilePhone,
           password: password,
         });
-        return user.logIn(options);
+        return user.logIn();
       },
 
       /**

storage.d.ts

@@ -545,11 +545,17 @@ export class Role extends Object {
   setName(name: string): Role;
 }
 
-interface UnionLoginOptions {
+interface OAuthLoginOptions {
+  failOnNotExist?: boolean;
+}
+
+interface UnionOptions {
   unionIdPlatform?: string;
   asMainAccount?: boolean;
 }
 
+interface UnionLoginOptions extends OAuthLoginOptions, UnionOptions {}
+
 /**
  * @class
  *
@@ -561,35 +567,41 @@ interface UnionLoginOptions {
  */
 export class User extends Object {
   static current(): User;
+  static currentAsync(): Promise<User>;
   static signUp(
     username: string,
     password: string,
-    attrs: any,
-    options?: AuthOptions
-  ): Promise<User>;
-  static logIn(
-    username: string,
-    password: string,
+    attrs?: any,
     options?: AuthOptions
   ): Promise<User>;
+  static logIn(username: string, password: string): Promise<User>;
   static logOut(): Promise<User>;
-  static become(sessionToken: string, options?: AuthOptions): Promise<User>;
+  static become(sessionToken: string): Promise<User>;
 
-  static loginWithWeapp(): Promise<User>;
+  static loginWithWeapp(options?: OAuthLoginOptions): Promise<User>;
   static logInWithMobilePhone(
     mobilePhone: string,
-    password: string,
-    options?: AuthOptions
+    password: string
   ): Promise<User>;
   static logInWithMobilePhoneSmsCode(
     mobilePhone: string,
-    smsCode: string,
-    options?: AuthOptions
+    smsCode: string
+  ): Promise<User>;
+  static loginWithAuthData(
+    authData: Object,
+    platform: string,
+    options?: OAuthLoginOptions
   ): Promise<User>;
   static signUpOrlogInWithAuthData(
-    data: any,
+    authData: Object,
     platform: string,
-    options?: AuthOptions
+    options?: OAuthLoginOptions
+  ): Promise<User>;
+  static loginWithAuthDataAndUnionId(
+    authData: Object,
+    platform: string,
+    unionId: string,
+    unionLoginOptions?: UnionLoginOptions
   ): Promise<User>;
   static signUpOrlogInWithAuthDataAndUnionId(
     authData: Object,
@@ -633,8 +645,21 @@ export class User extends Object {
   static followerQuery(userObjectId: string): FriendShipQuery;
   static followeeQuery(userObjectId: string): FriendShipQuery;
 
+  loginWithWeapp(options?: OAuthLoginOptions): Promise<User>;
+  loginWithAuthData(
+    authData: Object,
+    platform: string,
+    options?: OAuthLoginOptions
+  ): Promise<User>;
+  loginWithAuthDataAndUnionId(
+    authData: Object,
+    platform: string,
+    unionId: string,
+    unionLoginOptions?: UnionLoginOptions
+  ): Promise<User>;
+
   signUp(attrs?: any, options?: AuthOptions): Promise<User>;
-  logIn(options?: AuthOptions): Promise<User>;
+  logIn(): Promise<User>;
   linkWithWeapp(): Promise<User>;
   isAuthenticated(): Promise<boolean>;
   isCurrent(): boolean;
@@ -644,23 +669,20 @@ export class User extends Object {
     authData: Object,
     platform: string,
     unionId: string,
-    unionLoginOptions?: UnionLoginOptions
+    unionLoginOptions?: UnionOptions
   ): Promise<User>;
   dissociateAuthData(platform: string): Promise<User>;
 
   getEmail(): string;
-  setEmail(email: string, options?: AuthOptions): boolean;
+  setEmail(email: string): boolean;
 
-  setMobilePhoneNumber(
-    mobilePhoneNumber: string,
-    options?: AuthOptions
-  ): boolean;
+  setMobilePhoneNumber(mobilePhoneNumber: string): boolean;
   getMobilePhoneNumber(): string;
 
   getUsername(): string;
-  setUsername(username: string, options?: AuthOptions): boolean;
+  setUsername(username: string): boolean;
 
-  setPassword(password: string, options?: AuthOptions): boolean;
+  setPassword(password: string): boolean;
   getSessionToken(): string;
   refreshSessionToken(options?: AuthOptions): Promise<User>;