feature: add getLineRequestId() in the response of reply/push/multicast API (#151)

* feature: add getLineRequestId() in the response of reply/post/multicast API
* docs: modify push/reply/multicast response type

Author: xingoxu

docs/api-reference/client.md

@@ -12,9 +12,9 @@ class Client {
   constructor(config: ClientConfig) {}
 
   // Message
-  pushMessage(to: string, messages: Message | Message[], notificationDisabled: boolean = false): Promise<any>
-  replyMessage(replyToken: string, messages: Message | Message[], notificationDisabled: boolean = false): Promise<any>
-  multicast(to: string[], messages: Message | Message[], notificationDisabled: boolean = false): Promise<any>
+  pushMessage(to: string, messages: Message | Message[], notificationDisabled: boolean = false): Promise<MessageAPIBasicResponse>
+  replyMessage(replyToken: string, messages: Message | Message[], notificationDisabled: boolean = false): Promise<MessageAPIBasicResponse>
+  multicast(to: string[], messages: Message | Message[], notificationDisabled: boolean = false): Promise<MessageAPIBasicResponse>
   broadcast(messages: Message | Message[], notificationDisabled: boolean = false): Promise<any>
   getMessageContent(messageId: string): Promise<Readable>
 
@@ -88,7 +88,7 @@ in [the Client guide](../guide/client.md).
 
 ### Message
 
-#### `pushMessage(to: string, messages: Message | Message[], notificationDisabled: boolean = false): Promise<any>`
+#### `pushMessage(to: string, messages: Message | Message[], notificationDisabled: boolean = false): Promise<MessageAPIBasicResponse>`
 
 It corresponds to the [Push message](https://developers.line.me/en/docs/messaging-api/reference/#send-push-message) API.
 
@@ -101,7 +101,7 @@ client.pushMessage('user_or_group_or_room_id', {
 })
 ```
 
-#### `replyMessage(replyToken: string, messages: Message | Message[], notificationDisabled: boolean = false): Promise<any>`
+#### `replyMessage(replyToken: string, messages: Message | Message[], notificationDisabled: boolean = false): Promise<MessageAPIBasicResponse>`
 
 It corresponds to the [Reply message](https://developers.line.me/en/docs/messaging-api/reference/#send-reply-message) API.
 
@@ -116,7 +116,7 @@ client.replyMessage(event.replyToken, {
 })
 ```
 
-#### `multicast(to: string[], messages: Message | Message[], notificationDisabled: boolean = false): Promise<any>`
+#### `multicast(to: string[], messages: Message | Message[], notificationDisabled: boolean = false): Promise<MessageAPIBasicResponse>`
 
 It corresponds to the [Multicast](https://developers.line.me/en/docs/messaging-api/reference/#send-multicast-messages) API.
 

lib/client.ts

@@ -35,24 +35,44 @@ export default class Client {
     );
   }
 
-  public async pushMessage(
+  private setLineRequestId(response: object, lineRequestId: string): boolean {
+    return Reflect.defineProperty(response, "getLineRequestId", {
+      enumerable: false,
+      value: (): string => {
+        return lineRequestId;
+      },
+    });
+  }
+
+  private async postMessagingAPI(
+    url: string,
+    body?: any,
+  ): Promise<Types.MessageAPIResponseBase> {
+    const res = await this.http.postJson(url, body);
+    // header names are lower-cased
+    // https://nodejs.org/api/http.html#http_message_headers
+    this.setLineRequestId(res.data, res.headers["x-line-request-id"]);
+    return res.data as Types.MessageAPIResponseBase;
+  }
+
+  public pushMessage(
     to: string,
     messages: Types.Message | Types.Message[],
     notificationDisabled: boolean = false,
-  ): Promise<any> {
-    return this.http.post("/message/push", {
+  ): Promise<Types.MessageAPIResponseBase> {
+    return this.postMessagingAPI("/message/push", {
       messages: toArray(messages),
       to,
       notificationDisabled,
     });
   }
 
-  public async replyMessage(
+  public replyMessage(
     replyToken: string,
     messages: Types.Message | Types.Message[],
     notificationDisabled: boolean = false,
-  ): Promise<any> {
-    return this.http.post("/message/reply", {
+  ): Promise<Types.MessageAPIResponseBase> {
+    return this.postMessagingAPI("/message/reply", {
       messages: toArray(messages),
       replyToken,
       notificationDisabled,
@@ -63,8 +83,8 @@ export default class Client {
     to: string[],
     messages: Types.Message | Types.Message[],
     notificationDisabled: boolean = false,
-  ): Promise<any> {
-    return this.http.post("/message/multicast", {
+  ): Promise<Types.MessageAPIResponseBase> {
+    return this.postMessagingAPI("/message/multicast", {
       messages: toArray(messages),
       to,
       notificationDisabled,

lib/http.ts

@@ -1,4 +1,5 @@
 import axios, { AxiosInstance, AxiosError } from "axios";
+import { AxiosResponse } from "axios";
 import { Readable } from "stream";
 import { HTTPError, ReadError, RequestError } from "./exceptions";
 import * as fileType from "file-type";
@@ -35,10 +36,14 @@ export default class HTTPClient {
     return res.data as Readable;
   }
 
-  public async post<T>(url: string, body?: any): Promise<T> {
-    const res = await this.instance.post(url, body, {
+  public postJson(url: string, body?: any): Promise<AxiosResponse> {
+    return this.instance.post(url, body, {
       headers: { "Content-Type": "application/json" },
     });
+  }
+
+  public async post<T>(url: string, body?: any): Promise<T> {
+    const res = await this.postJson(url, body);
     return res.data;
   }
 

lib/types.ts

@@ -1800,3 +1800,7 @@ export type NumberOfSentBroadcastMessages = {
    */
   success?: number;
 };
+
+export type MessageAPIResponseBase = {
+  getLineRequestId: () => string;
+};

test/client.spec.ts

@@ -54,6 +54,7 @@ describe("client", () => {
     equal(req.body.replyToken, "test_reply_token");
     deepEqual(req.body.messages, [testMsg]);
     deepEqual(res, {});
+    equal(res.getLineRequestId(), "X-Line-Request-Id");
   });
 
   it("push", async () => {
@@ -65,6 +66,7 @@ describe("client", () => {
     equal(req.body.to, "test_user_id");
     deepEqual(req.body.messages, [testMsg]);
     deepEqual(res, {});
+    equal(res.getLineRequestId(), "X-Line-Request-Id");
   });
 
   it("multicast", async () => {
@@ -81,6 +83,7 @@ describe("client", () => {
     ]);
     deepEqual(req.body.messages, [testMsg, testMsg]);
     deepEqual(res, {});
+    equal(res.getLineRequestId(), "X-Line-Request-Id");
   });
 
   it("broadcast", async () => {

test/helpers/test-server.ts

@@ -86,6 +86,14 @@ function listen(port: number, middleware?: express.RequestHandler) {
     res.json(result);
   });
 
+  // Simulate the Message API
+  app.use((req, res, next) => {
+    if (req.url.startsWith("/message/")) {
+      res.header("X-Line-Request-Id", "X-Line-Request-Id");
+    }
+    next();
+  });
+
   // return an empty object for others
   app.use((req, res) => res.json({}));