Merge pull request #23 from line/get-member-ids-api

Implement "Group/Room Member IDs" API

Author: Hyunje Jun

docs/pages/api-reference/client.md

@@ -15,6 +15,10 @@ class Client {
   replyMessage(replyToken: string, messages: Message | Message[]): Promise<{}>
   multicast(to: string[], messages: Message | Message[]): Promise<{}>
   getProfile(userId: string): Promise<Profile>
+  getGroupMemberProfile(groupId: string, userId: string): Promise<Profile>
+  getRoomMemberProfile(roomId: string, userId: string): Promise<Profile>
+  getGroupMemberIds(groupId: string): Promise<string[]>
+  getRoomMemberIds(roomId: string): Promise<string[]>
   getMessageContent(messageId: string): Promise<ReadableStream>
   leaveGroup(groupId: string): Promise<{}>
   leaveRoom(roomId: string): Promise<{}>
@@ -23,7 +27,7 @@ class Client {
 
 `Message` is a valid message object. About message object structure, please
 refer to [Send message object](https://devdocs.line.me/en/#send-message-object)
-of the official document.
+of the official documentation.
 
 `ClientConfig` type is like below, except that it also allows fields
 from [MiddlewareConfig](./middleware.md) too.
@@ -39,7 +43,7 @@ type ClientConfig = {
 For a parameter `messages: messages: Message | Message[]`, you can provide a
 message object or an array of message objects. Both will work, but please beware
 that there can be a limit on the number of the messages to be sent
-simultaneously. About the API detail, please refer to [the official document](https://devdocs.line.me/en/#messaging-api).
+simultaneously. About the API detail, please refer to [the official documentation](https://devdocs.line.me/en/#messaging-api).
 
 For functions returning `Promise`, there will be errors thrown if something
 goes wrong, such as HTTP errors or parsing errors. You can catch them with the
@@ -65,7 +69,7 @@ It corresponds to the [Reply message](https://devdocs.line.me/en/#reply-message)
 
 The first argument is a reply token, which is retrieved from a webhook event
 object. For the list of replyable events, please refer to [Webhook event object](https://devdocs.line.me/en/#webhook-event-object)
-of the official document. The second argument is the same with one in `pushMessage()`.
+of the official documentation. The second argument is the same with one in `pushMessage()`.
 
 ``` js
 client.replyMessage(event.replyToken, {
@@ -100,6 +104,64 @@ client.getProfile('user_id').then((profile) => {
 });
 ```
 
+### `getGroupMemberProfile(groupId: string, userId: string): Promise<Profile>`
+
+It corresponds to the [Group/Room Member Profile](https://devdocs.line.me/en/#get-group-room-member-profile) API.
+
+*FYI: This feature is only available for LINE@ Approved accounts or official accounts.*
+
+The arguments are a group ID and an ID of a user in the group. Please refer to
+the official documentation for the difference between this API and `getProfile()`.
+
+``` js
+client.getGroupMemberProfile('group_id', 'user_id').then((profile) => {
+  console.log(profile);
+})
+```
+
+### `getRoomMemberProfile(roomId: string, userId: string): Promise<Profile>`
+
+It corresponds to the [Group/Room Member Profile](https://devdocs.line.me/en/#get-group-room-member-profile) API.
+
+*FYI: This feature is only available for LINE@ Approved accounts or official accounts.*
+
+The arguments are a room ID and an ID of a user in the room. Please refer to the
+official documentation for the difference between this API and `getProfile()`.
+
+``` js
+client.getRoomMemberProfile('room_id', 'user_id').then((profile) => {
+  console.log(profile);
+})
+```
+
+### `getGroupMemberIds(groupId: string): Promise<string[]>`
+
+It corresponds to the [Group/Room Member IDs](https://devdocs.line.me/en/#get-group-room-member-ids) API.
+
+*FYI: This feature is only available for LINE@ Approved accounts or official accounts.*
+
+The argument is a group ID and the method returns a promise of an array of user IDs.
+
+``` js
+client.getGroupMemberIds('group_id').then((ids) => {
+  ids.forEach((id) => console.log(id));
+})
+```
+
+### `getRoomMemberIds(roomId: string): Promise<string[]>`
+
+It corresponds to the [Group/Room Member IDs](https://devdocs.line.me/en/#get-group-room-member-ids) API.
+
+*FYI: This feature is only available for LINE@ Approved accounts or official accounts.*
+
+The argument is a room ID and the method returns a promise of an array of user IDs.
+
+``` js
+client.getRoomMemberIds('room_id').then((ids) => {
+  ids.forEach((id) => console.log(id));
+})
+```
+
 ### `getMessageContent(messageId: string): Promise<ReadableStream>`
 
 It corresponds to the [Content](https://devdocs.line.me/en/#content) API.

lib/client.ts

@@ -46,6 +46,32 @@ export default class Client {
     return this.get(URL.roomMemberProfile(roomId, userId));
   }
 
+  public getGroupMemberIds(groupId: string): Promise<string[]> {
+    const load = (start?: string): Promise<string[]> =>
+      this.get(URL.groupMemberIds(groupId, start))
+      .then((res: { memberIds: string[], next?: string }) => {
+        if (!res.next) {
+          return res.memberIds;
+        }
+
+        return load(res.next).then((extraIds) => res.memberIds.concat(extraIds));
+      });
+    return load();
+  }
+
+  public getRoomMemberIds(roomId: string): Promise<string[]> {
+    const load = (start?: string): Promise<string[]> =>
+      this.get(URL.roomMemberIds(roomId, start))
+      .then((res: { memberIds: string[], next?: string }) => {
+        if (!res.next) {
+          return res.memberIds;
+        }
+
+        return load(res.next).then((extraIds) => res.memberIds.concat(extraIds));
+      });
+    return load();
+  }
+
   public getMessageContent(messageId: string): Promise<NodeJS.ReadableStream> {
     return this.stream(URL.content(messageId));
   }

lib/urls.ts

@@ -1,13 +1,33 @@
+import * as qs from "querystring";
+
 const baseURL: string = process.env.API_BASE_URL || "https://api.line.me/v2/bot/";
 
-const apiURL = (path: string) => baseURL + path;
+const apiURL = (path: string, query?: object) =>
+  baseURL + path + (query ? `?${qs.stringify(query)}` : "");
 
 export const reply: string = apiURL("message/reply");
+
 export const push: string = apiURL("message/push");
+
 export const multicast: string = apiURL("message/multicast");
-export const content = (messageId: string) => apiURL(`message/${messageId}/content`);
+
+export const content = (messageId: string) =>
+  apiURL(`message/${messageId}/content`);
+
 export const profile = (userId: string) => apiURL(`profile/${userId}`);
-export const groupMemberProfile = (groupId: string, userId: string) => apiURL(`group/${groupId}/member/${userId}`);
-export const roomMemberProfile = (roomId: string, userId: string) => apiURL(`room/${roomId}/member/${userId}`);
+
+export const groupMemberProfile = (groupId: string, userId: string) =>
+  apiURL(`group/${groupId}/member/${userId}`);
+
+export const roomMemberProfile = (roomId: string, userId: string) =>
+  apiURL(`room/${roomId}/member/${userId}`);
+
+export const groupMemberIds = (groupId: string, start?: string) =>
+  apiURL(`group/${groupId}/members/ids`, start ? { start } : null);
+
+export const roomMemberIds = (roomId: string, start?: string) =>
+  apiURL(`room/${roomId}/members/ids`, start ? { start } : null);
+
 export const leaveGroup = (groupId: string) => apiURL(`group/${groupId}/leave`);
+
 export const leaveRoom = (roomId: string) => apiURL(`room/${roomId}/leave`);

test/client.spec.ts

@@ -77,6 +77,36 @@ describe("client", () => {
       });
   });
 
+  it("getGroupMemberIds", () => {
+    return client.getGroupMemberIds("test_group_id")
+      .then((ids) => deepEqual(ids, [
+        "group-test_group_id-0",
+        "group-test_group_id-1",
+        "group-test_group_id-2",
+        "group-test_group_id-3",
+        "group-test_group_id-4",
+        "group-test_group_id-5",
+        "group-test_group_id-6",
+        "group-test_group_id-7",
+        "group-test_group_id-8",
+      ]));
+  });
+
+  it("getRoomMemberIds", () => {
+    return client.getRoomMemberIds("test_room_id")
+      .then((ids) => deepEqual(ids, [
+        "room-test_room_id-0",
+        "room-test_room_id-1",
+        "room-test_room_id-2",
+        "room-test_room_id-3",
+        "room-test_room_id-4",
+        "room-test_room_id-5",
+        "room-test_room_id-6",
+        "room-test_room_id-7",
+        "room-test_room_id-8",
+      ]));
+  });
+
   it("getMessageContent", () => {
     return client.getMessageContent("test_message_id")
       .then((s) => getStreamData(s))

test/helpers/test-server.ts

@@ -27,6 +27,23 @@ function listen(port: number, middleware?: express.RequestHandler) {
 
   app.use(bodyParser.json());
 
+  // for getIds API
+  app.get("/:groupOrRoom/:id/members/ids", (req, res) => {
+    const ty: string = req.params.groupOrRoom;
+    const id: string = req.params.id;
+    const start: number = parseInt(req.query.start, 10) || 0;
+
+    const result: { memberIds: string[], next?: string } = {
+      memberIds: [start, start + 1, start + 2].map((i) => `${ty}-${id}-${i}`),
+    };
+
+    if (start / 3 < 2) {
+      result.next = String(start + 3);
+    }
+
+    res.json(result);
+  });
+
   app.use((req: express.Request, res) => {
     if (req.path === "/stream.txt") {
       res.sendFile(join(__dirname, "stream.txt"));