feat: friendship (#626)

* feat: friendship

* feat(user): getFollowersAndFollowees

Author: sdjdd

changelog.md

@@ -1,5 +1,10 @@
 # Master
 
+### Features
+
+- 好友
+- 添加 `AV.User#getFollowersAndFollowees` 方法用于查询指定用户的 followers 和 followees 。
+
 ### Internal Changes
 
 - 现在保存通过 `AV.File.withURL` 方法创建的文件等同于直接在 \_File 中添加一行数据，不再自动生成 `mime_type`。

src/friendship.js

@@ -0,0 +1,97 @@
+const _ = require('underscore');
+const { request: LCRequest } = require('./request');
+const { getSessionToken } = require('./utils');
+
+module.exports = function(AV) {
+  /**
+   * Contains functions to deal with Friendship in LeanCloud.
+   * @class
+   */
+  AV.Friendship = {
+    /**
+     * Request friendship.
+     * @since 4.8.0
+     * @param {String | AV.User | Object} options if an AV.User or string is given, it will be used as the friend.
+     * @param {AV.User | string} options.friend The friend (or friend's objectId) to follow.
+     * @param {Object} [options.attributes] key-value attributes dictionary to be used as conditions of followeeQuery.
+     * @param {*} [authOptions]
+     * @return {Promise<void>}
+     */
+    request: function(options, authOptions) {
+      if (!AV.User.current()) {
+        throw new Error('Please signin an user.');
+      }
+      let friend;
+      let attributes;
+      if (options.friend) {
+        friend = options.friend;
+        attributes = options.attributes;
+      } else {
+        friend = options;
+      }
+      const friendObject = _.isString(friend)
+        ? AV.Object.createWithoutData('_User', friend)
+        : friend;
+      return LCRequest({
+        method: 'POST',
+        path: '/users/friendshipRequests',
+        data: AV._encode({
+          user: AV.User.current(),
+          friend: friendObject,
+          friendship: attributes,
+        }),
+        authOptions,
+      });
+    },
+
+    /**
+     * Accept a friendship request.
+     * @since 4.8.0
+     * @param {AV.Object | string | Object} options if an AV.Object or string is given, it will be used as the request in _FriendshipRequest.
+     * @param {AV.Object} options.request The request (or it's objectId) to be accepted.
+     * @param {Object} [options.attributes] key-value attributes dictionary to be used as conditions of {@link AV#followeeQuery}.
+     * @param {AuthOptions} [authOptions]
+     * @return {Promise<void>}
+     */
+    acceptRequest: function(options, authOptions = {}) {
+      if (!getSessionToken(authOptions) && !AV.User.current()) {
+        throw new Error('Please signin an user.');
+      }
+      let request;
+      let attributes;
+      if (options.request) {
+        request = options.request;
+        attributes = options.attributes;
+      } else {
+        request = options;
+      }
+      const requestId = _.isString(request) ? request : request.id;
+      return LCRequest({
+        method: 'PUT',
+        path: '/users/friendshipRequests/' + requestId + '/accept',
+        data: {
+          friendship: AV._encode(attributes),
+        },
+        authOptions,
+      });
+    },
+
+    /**
+     * Decline a friendship request.
+     * @param {AV.Object | string} request The request (or it's objectId) to be declined.
+     * @param {AuthOptions} [authOptions]
+     * @return {Promise<void>}
+     */
+    declineRequest: function(request, authOptions = {}) {
+      if (!getSessionToken(authOptions) && !AV.User.current()) {
+        throw new Error('Please signin an user.');
+      }
+      const requestId = _.isString(request) ? request : request.id;
+      return LCRequest({
+        method: 'PUT',
+        path: '/users/friendshipRequests/' + requestId + '/decline',
+        authOptions,
+      });
+    },
+  };
+};

src/index.js

@@ -34,6 +34,7 @@ require('./push')(AV);
 require('./status')(AV);
 require('./search')(AV);
 require('./insight')(AV);
+require('./friendship')(AV);
 
 AV.Conversation = require('./conversation');
 require('./leaderboard');

src/user.js

@@ -787,6 +787,34 @@ module.exports = function(AV) {
         return request;
       },
 
+      /**
+       * Get the user's followers and followees.
+       * @since 4.8.0
+       * @param {Object} [options]
+       * @param {Number} [options.skip]
+       * @param {Number} [options.limit]
+       * @param {AuthOptions} [authOptions]
+       */
+      getFollowersAndFollowees: function(options, authOptions) {
+        if (!this.id) {
+          throw new Error('Please signin.');
+        }
+        return request({
+          method: 'GET',
+          path: `/users/${this.id}/followersAndFollowees`,
+          query: {
+            skip: options && options.skip,
+            limit: options && options.limit,
+            include: 'follower,followee',
+            keys: 'follower,followee',
+          },
+          authOptions,
+        }).then(({ followers, followees }) => ({
+          followers: followers.map(({ follower }) => AV._decode(follower)),
+          followees: followees.map(({ followee }) => AV._decode(followee)),
+        }));
+      },
+
       /**
        *Create a follower query to query the user's followers.
        * @since 0.3.0

storage.d.ts

@@ -881,6 +881,33 @@ export class User extends Object {
   ): Promise<void>;
   followerQuery(): Query<this>;
   followeeQuery(): Query<this>;
+  getFollowersAndFollowees(
+    options?: { skip?: number; limit?: number },
+    authOptions?: AuthOptions
+  ): Promise<{ followers: User[]; followees: User[] }>;
+}
+
+export class Friendship {
+  static request(
+    friend: User | string,
+    authOptions?: AuthOptions
+  ): Promise<void>;
+  static request(
+    options: { friend: User | string; attributes?: object },
+    authOptions?: AuthOptions
+  ): Promise<void>;
+  static acceptRequest(
+    request: Object | string,
+    authOptions?: AuthOptions
+  ): Promise<void>;
+  static acceptRequest(
+    options: { request: Object | string; attributes?: object },
+    authOptions?: AuthOptions
+  ): Promise<void>;
+  static declineRequest(
+    request: Object | string,
+    authOptions?: AuthOptions
+  ): Promise<void>;
 }
 
 export class Captcha {
@@ -1222,7 +1249,12 @@ export namespace Cloud {
   function requestSmsCode(
     data:
       | string
-      | { mobilePhoneNumber: string; template?: string; sign?: string; smsType?: 'sms' | 'voice' },
+      | {
+          mobilePhoneNumber: string;
+          template?: string;
+          sign?: string;
+          smsType?: 'sms' | 'voice';
+        },
     options?: SMSAuthOptions
   ): Promise<void>;
   function verifySmsCode(code: string, phone: string): Promise<void>;