新增机器人获取表情表态成员列表接口 (#70)

* feat: 新增机器人获取表情表态成员列表接口

Co-authored-by: joyqwang <[email protected]>

Author: Joy-Wang

src/openapi/v1/reaction.ts

@@ -1,4 +1,4 @@
-import { Config, OpenAPIRequest, ReactionAPI, ReactionObj } from '@src/types';
+import { Config, OpenAPIRequest, ReactionAPI, ReactionObj, ReactionUserListObj } from '@src/types';
 import { RestyResponse } from 'resty-client';
 import { getURL } from './resource';
 
@@ -39,4 +39,28 @@ export default class Reaction implements ReactionAPI {
     };
     return this.request(options);
   }
+
+  // 拉取表情表态用户列表
+  public getReactionUserList(
+    channelId: string,
+    reactionToCreate: ReactionObj,
+    options: ReactionUserListObj,
+  ): Promise<RestyResponse<any>> {
+    if (!options) {
+      return Promise.reject(new Error("'options' required!"));
+    }
+
+    const reqOptions = {
+      method: 'GET' as const,
+      url: getURL('reactionURI'),
+      rest: {
+        channelID: channelId,
+        messageID: reactionToCreate?.message_id,
+        emojiType: reactionToCreate?.emoji_type,
+        emojiID: reactionToCreate?.emoji_id,
+      },
+      params: options,
+    };
+    return this.request(reqOptions);
+  }
 }

src/types/openapi/v1/reaction.ts

@@ -6,10 +6,21 @@ import { RestyResponse } from 'resty-client';
 export interface ReactionAPI {
   postReaction: (channelID: string, reactionToCreate: ReactionObj) => Promise<RestyResponse<any>>;
   deleteReaction: (channelID: string, reactionToDelete: ReactionObj) => Promise<RestyResponse<any>>;
+  getReactionUserList: (
+    channelID: string,
+    reactionToDelete: ReactionObj,
+    options: ReactionUserListObj,
+  ) => Promise<RestyResponse<any>>;
 }
 
 export interface ReactionObj {
   message_id: string;
   emoji_type: number;
   emoji_id: string;
 }
+
+// 拉取表情表态用户列表分页入参
+export interface ReactionUserListObj {
+  cookie: string; // 上次请求返回的cookie，第一次请求无需填写
+  limit: number; // 每次拉取数量，默认20，最多50，只在第一次请求时设置
+}

test/openapi/v1/reaction.spec.ts

@@ -0,0 +1,46 @@
+import { client, channelID, REQUEST_SUCCESS_CODE_WITH_NO_CONTENT } from '../config';
+
+describe('reaction测试', () => {
+  const messageID = '1'
+  const emojiType = 1;
+  const emojiID = '1';
+  const cookie = '';
+  const limit = 20;
+
+  test('【 postReaction方法 】=== 发表表情表态', async () => {
+    // 发表表情表态
+    const params = {
+      message_id: messageID,
+      emoji_type: emojiType,
+      emoji_id: emojiID
+    }
+    const reactionRes = (await client.reactionApi.postReaction(channelID, params)).data;
+    expect(reactionRes?.status).toStrictEqual(REQUEST_SUCCESS_CODE_WITH_NO_CONTENT);
+  });
+
+  test('【 deleteReaction方法 】=== 删除表情表态', async () => {
+    // 删除表情表态
+    const params = {
+      message_id: messageID,
+      emoji_type: emojiType,
+      emoji_id: emojiID
+    }
+    const reactionRes = (await client.reactionApi.deleteReaction(channelID, params)).data;
+    expect(reactionRes?.status).toStrictEqual(REQUEST_SUCCESS_CODE_WITH_NO_CONTENT);
+  });
+
+  test('【 getReactionUserList方法 】=== 拉取表情表态用户列表', async () => {
+    // 拉取表情表态用户列表
+    const params = {
+      message_id: messageID,
+      emoji_type: emojiType,
+      emoji_id: emojiID
+    }
+    const options = {
+      cookie,
+      limit
+    }
+    const reactionRes = (await client.reactionApi.getReactionUserList(channelID, params, options)).data;
+    expect(reactionRes?.status).toStrictEqual(REQUEST_SUCCESS_CODE_WITH_NO_CONTENT);
+  });
+});