feat(user): unionId support

Author: leeyeh

src/user.js

@@ -21,6 +21,17 @@ const getWeappLoginCode = () => {
   });
 };
 
+const mergeUnionDataIntoAuthData = (authData, unionId, { unionIdPlatform = 'weixin', asMainAccount = false } = {}) => {
+  if (typeof unionId !== 'string') throw new AVError(AVError.OTHER_CAUSE, 'unionId is not a string');
+  if (typeof unionIdPlatform !== 'string') throw new AVError(AVError.OTHER_CAUSE, 'unionIdPlatform is not a string');
+
+  return _.extend({}, authData, {
+    platform: unionIdPlatform,
+    unionid: unionId,
+    main_account: Boolean(asMainAccount),
+  });
+};
+
 module.exports = function(AV) {
   /**
    * @class
@@ -180,6 +191,33 @@ module.exports = function(AV) {
       return this._linkWith(platform, authData);
     },
 
+    /**
+     * Associate the user with a third party authData and unionId.
+     * @since 3.5.0
+     * @param {Object} authData The response json data returned from third party token, maybe like { openid: 'abc123', access_token: '123abc', expires_in: 1382686496 }
+     * @param {string} platform Available platform for sign up.
+     * @param {string} unionId
+     * @param {Object} [unionLoginOptions]
+     * @param {string} [unionLoginOptions.unionIdPlatform = 'weixin'] unionId platform
+     * @param {boolean} [unionLoginOptions.asMainAccount = false]
+     * @return {Promise<AV.User>} A promise that is fulfilled with the user when completed.
+     * @example user.associateWithAuthData({
+     *   openid: 'abc123',
+     *   access_token: '123abc',
+     *   expires_in: 1382686496
+     * }, 'weixin', 'union123', {
+     *   unionIdPlatform: 'weixin',
+     *   asMainAccount: false,
+     * }).then(function(user) {
+     *   //Access user here
+     * }).catch(function(error) {
+     *   //console.error("error: ", error);
+     * });
+     */
+    associateWithAuthDataAndUnionId(authData, platform, unionId, unionLoginOptions) {
+      return this._linkWith(platform, mergeUnionDataIntoAuthData(authData, unionId, unionLoginOptions));
+    },
+
     /**
      * 将用户与小程序用户进行关联。适用于为已经在用户系统中存在的用户关联当前使用小程序的微信帐号。
      * 仅在小程序中可用。
@@ -804,7 +842,11 @@ module.exports = function(AV) {
      * @param {string} platform Available platform for sign up.
      * @return {Promise} A promise that is fulfilled with the user when
      *     the login completes.
-     * @example AV.User.signUpOrlogInWithAuthData(authData, platform).then(function(user) {
+     * @example AV.User.signUpOrlogInWithAuthData({
+     *   openid: 'abc123',
+     *   access_token: '123abc',
+     *   expires_in: 1382686496
+     * }, 'weixin').then(function(user) {
      *   //Access user here
      * }).catch(function(error) {
      *   //console.error("error: ", error);
@@ -815,6 +857,33 @@ module.exports = function(AV) {
       return AV.User._logInWith(platform, authData);
     },
 
+    /**
+     * Sign up or logs in a user with a third party authData and unionId.
+     * @since 3.5.0
+     * @param {Object} authData The response json data returned from third party token, maybe like { openid: 'abc123', access_token: '123abc', expires_in: 1382686496 }
+     * @param {string} platform Available platform for sign up.
+     * @param {string} unionId
+     * @param {Object} [unionLoginOptions]
+     * @param {string} [unionLoginOptions.unionIdPlatform = 'weixin'] unionId platform
+     * @param {boolean} [unionLoginOptions.asMainAccount = false]
+     * @return {Promise<AV.User>} A promise that is fulfilled with the user when completed.
+     * @example user.associateWithAuthData({
+     *   openid: 'abc123',
+     *   access_token: '123abc',
+     *   expires_in: 1382686496
+     * }, 'weixin', 'union123', {
+     *   unionIdPlatform: 'weixin',
+     *   asMainAccount: false,
+     * }).then(function(user) {
+     *   //Access user here
+     * }).catch(function(error) {
+     *   //console.error("error: ", error);
+     * });
+     */
+    signUpOrlogInWithAuthDataAndUnionId(authData, platform, unionId, unionLoginOptions) {
+      return this.signUpOrlogInWithAuthData(mergeUnionDataIntoAuthData(authData, unionId, unionLoginOptions), platform);
+    },
+
     /**
      * 使用当前使用小程序的微信用户身份注册或登录，成功后用户的 session 会在设备上持久化保存，之后可以使用 AV.User.current() 获取当前登录用户。
      * 仅在小程序中可用。

storage.d.ts

@@ -537,6 +537,11 @@ export class Role extends Object {
     setName(name: string): Role;
 }
 
+interface UnionLoginOptions {
+  unionIdPlatform?: string;
+  asMainAccount?: boolean;
+}
+
 /**
  * @class
  *
@@ -558,6 +563,7 @@ export class User extends Object {
     static logInWithMobilePhone(mobilePhone: string, password: string, options?: AuthOptions): Promise<User>;
     static logInWithMobilePhoneSmsCode(mobilePhone: string, smsCode: string, options?: AuthOptions): Promise<User>;
     static signUpOrlogInWithAuthData(data: any, platform: string, options?: AuthOptions): Promise<User>;
+    static signUpOrlogInWithAuthDataAndUnionId(authData: Object, platform: string, unionId: string, unionLoginOptions?: UnionLoginOptions): Promise<User>;
     static signUpOrlogInWithMobilePhone(mobilePhoneNumber: string, smsCode: string, attributes?: any, options?: AuthOptions): Promise<User>;
     static requestEmailVerify(email: string, options?: AuthOptions): Promise<User>;
     static requestLoginSmsCode(mobilePhoneNumber: string, options?: SMSAuthOptions): Promise<void>;
@@ -576,8 +582,9 @@ export class User extends Object {
     isAuthenticated(): Promise<boolean>;
     isCurrent(): boolean;
 
-    associateWithAuthData(authData: Object, platform?: string): Promise<User>;
-    dissociateAuthData(platform?: string): Promise<User>;
+    associateWithAuthData(authData: Object, platform: string): Promise<User>;
+    associateWithAuthDataAndUnionId(authData: Object, platform: string, unionId: string, unionLoginOptions?: UnionLoginOptions): Promise<User>;
+    dissociateAuthData(platform: string): Promise<User>;
 
     getEmail(): string;
     setEmail(email: string, options?: AuthOptions): boolean;

test/user.js

@@ -187,6 +187,27 @@ describe("User", function() {
     });
   });
 
+  describe('authData and unionId', () => {
+    it('should login as the same user', () => {
+      const now = Date.now();
+      return AV.User.signUpOrlogInWithAuthDataAndUnionId({
+        openid: 'openid1' + now,
+        access_token: 'access_token',
+        expires_in: 1382686496,
+      }, 'weixin_1', 'unionid' + now, {
+        asMainAccount: true,
+      }).then((user1) => {
+        return AV.User.signUpOrlogInWithAuthDataAndUnionId({
+          openid: 'openid2' + now,
+          access_token: 'access_token',
+          expires_in: 1382686496,
+        }, 'weixin_2', 'unionid' + now).then(user2 => {
+          user2.id.should.be.eql(user1.id);
+        });
+      });
+    });
+  });
+
   describe('associate with authData', function() {
     it('logIn an user, and associate with authData', function() {
       var username = Date.now().toString(36);