Merge pull request #389 from Yang-33/validate-messages

Add validate message objects APIs

Author: tokuhirom

docs/api-reference/client.md

@@ -30,6 +30,13 @@ class Client {
   broadcast(messages: Message | Message[], notificationDisabled: boolean = false): Promise<MessageAPIResponseBase>
   getMessageContent(messageId: string): Promise<Readable>
 
+  // Validate message objects
+  validatePushMessageObjects(messages: Types.Message | Types.Message[]): Promise<Types.MessageAPIResponseBase>
+  validateReplyMessageObjects(messages: Types.Message | Types.Message[]): Promise<Types.MessageAPIResponseBase>
+  validateMulticastMessageObjects(messages: Types.Message | Types.Message[]): Promise<Types.MessageAPIResponseBase>
+  validateNarrowcastMessageObjects(messages: Types.Message | Types.Message[]): Promise<Types.MessageAPIResponseBase>
+  validateBroadcastMessageObjects(messages: Types.Message | Types.Message[]): Promise<Types.MessageAPIResponseBase>
+
   // Profile
   getProfile(userId: string): Promise<Profile>
 
@@ -308,6 +315,72 @@ client.getMessageContent('message_id')
     stream.pipe(...)
   })
 ```
+### Validate message objects
+
+#### `validatePushMessageObjects(messages: Message | Message[]): Promise<MessageAPIResponseBase>`
+
+It corresponds to the [Validate push message objects](https://developers.line.biz/en/reference/messaging-api/#validate-message-objects-of-push-message) API.
+
+The argument is messages to be sent.
+
+``` js
+client.validatePushMessageObjects({
+  type: 'text',
+  text: 'hello, world',
+})
+```
+
+#### `validateReplyMessageObjects(messages: Message | Message[]): Promise<MessageAPIResponseBase>`
+
+It corresponds to the [Validate reply message objects](https://developers.line.biz/en/reference/messaging-api/#validate-message-objects-of-reply-message) API.
+
+The argument is messages to be sent.
+
+``` js
+client.validateReplyMessageObjects({
+  type: 'text',
+  text: 'hello, world',
+})
+```
+
+#### `validateMulticastMessageObjects(messages: Message | Message[]): Promise<MessageAPIResponseBase>`
+
+It corresponds to the [Validate multicast message objects](https://developers.line.biz/en/reference/messaging-api/#validate-message-objects-of-multicast-message) API.
+
+The argument is messages to be sent.
+
+``` js
+client.validateMulticastMessageObjects({
+  type: 'text',
+  text: 'hello, world',
+})
+```
+
+#### `validateNarrowcastMessageObjects(messages: Message | Message[]): Promise<MessageAPIResponseBase>`
+
+It corresponds to the [Validate narrowcast message objects](https://developers.line.biz/en/reference/messaging-api/#validate-message-objects-of-narrowcast-message) API.
+
+The argument is messages to be sent.
+
+``` js
+client.validateNarrowcastMessageObjects({
+  type: 'text',
+  text: 'hello, world',
+})
+```
+
+#### `validateBroadcastMessageObjects(messages: Message | Message[], notificationDisabled: boolean = false): Promise<any>`
+
+It corresponds to the [Validate broadcast message objects](https://developers.line.biz/en/reference/messaging-api/#validate-message-objects-of-broadcast-message) API.
+
+The argument is messages to be sent.
+
+``` js
+client.validateBroadcastMessageObjects({
+  type: 'text',
+  text: 'hello, world',
+})
+```
 
 ### Profile
 

lib/client.ts

@@ -140,6 +140,62 @@ export default class Client {
     );
   }
 
+  public validatePushMessageObjects(
+    messages: Types.Message | Types.Message[],
+  ): Promise<Types.MessageAPIResponseBase> {
+    return this.http.post(
+      `${MESSAGING_API_PREFIX}/message/validate/push`,
+      {
+        messages: toArray(messages),
+      },
+      this.generateRequestConfig(),
+    );
+  }
+
+  public validateReplyMessageObjects(
+    messages: Types.Message | Types.Message[],
+  ): Promise<Types.MessageAPIResponseBase> {
+    return this.http.post(`${MESSAGING_API_PREFIX}/message/validate/reply`, {
+      messages: toArray(messages),
+    });
+  }
+
+  public async validateMulticastMessageObjects(
+    messages: Types.Message | Types.Message[],
+  ): Promise<Types.MessageAPIResponseBase> {
+    return this.http.post(
+      `${MESSAGING_API_PREFIX}/message/validate/multicast`,
+      {
+        messages: toArray(messages),
+      },
+      this.generateRequestConfig(),
+    );
+  }
+
+  public async validateNarrowcastMessageObjects(
+    messages: Types.Message | Types.Message[],
+  ): Promise<Types.MessageAPIResponseBase> {
+    return this.http.post(
+      `${MESSAGING_API_PREFIX}/message/validate/narrowcast`,
+      {
+        messages: toArray(messages),
+      },
+      this.generateRequestConfig(),
+    );
+  }
+
+  public async validateBroadcastMessageObjects(
+    messages: Types.Message | Types.Message[],
+  ): Promise<Types.MessageAPIResponseBase> {
+    return this.http.post(
+      `${MESSAGING_API_PREFIX}/message/validate/broadcast`,
+      {
+        messages: toArray(messages),
+      },
+      this.generateRequestConfig(),
+    );
+  }
+
   public async getProfile(userId: string): Promise<Types.Profile> {
     const profile = await this.http.get<Types.Profile>(
       `${MESSAGING_API_PREFIX}/profile/${userId}`,

test/client.spec.ts

@@ -1,6 +1,6 @@
 import { readFileSync } from "fs";
 import { join } from "path";
-import { deepEqual, equal, ok } from "assert";
+import { deepEqual, equal, ok, strictEqual } from "assert";
 import { URL } from "url";
 import Client, { OAuth } from "../lib/client";
 import * as Types from "../lib/types";
@@ -153,6 +153,16 @@ describe("client", () => {
     equal(res["x-line-request-id"], "X-Line-Request-Id");
   });
 
+  it("validateReplyMessageObjects", async () => {
+    const scope = mockPost(MESSAGING_API_PREFIX, `/message/validate/reply`, {
+      messages: [testMsg],
+    });
+
+    const res = await client.validateReplyMessageObjects(testMsg);
+    strictEqual(scope.isDone(), true);
+    strictEqual(res["x-line-request-id"], "X-Line-Request-Id");
+  });
+
   it("push", async () => {
     const scope = mockPost(MESSAGING_API_PREFIX, `/message/push`, {
       messages: [testMsg],
@@ -165,6 +175,16 @@ describe("client", () => {
     equal(res["x-line-request-id"], "X-Line-Request-Id");
   });
 
+  it("validatePushMessageObjects", async () => {
+    const scope = mockPost(MESSAGING_API_PREFIX, `/message/validate/push`, {
+      messages: [testMsg],
+    });
+
+    const res = await client.validatePushMessageObjects(testMsg);
+    strictEqual(scope.isDone(), true);
+    strictEqual(res["x-line-request-id"], "X-Line-Request-Id");
+  });
+
   it("multicast", async () => {
     const ids = ["test_user_id_1", "test_user_id_2", "test_user_id_3"];
     const scope = mockPost(MESSAGING_API_PREFIX, `/message/multicast`, {
@@ -178,6 +198,23 @@ describe("client", () => {
     equal(res["x-line-request-id"], "X-Line-Request-Id");
   });
 
+  it("validateMulticastMessageObjects", async () => {
+    const scope = mockPost(
+      MESSAGING_API_PREFIX,
+      `/message/validate/multicast`,
+      {
+        messages: [testMsg, testMsg],
+      },
+    );
+
+    const res = await client.validateMulticastMessageObjects([
+      testMsg,
+      testMsg,
+    ]);
+    strictEqual(scope.isDone(), true);
+    strictEqual(res["x-line-request-id"], "X-Line-Request-Id");
+  });
+
   it("narrowcast", async () => {
     const recipient: Types.ReceieptObject = {
       type: "operator",
@@ -267,6 +304,23 @@ describe("client", () => {
     equal(res["x-line-request-id"], "X-Line-Request-Id");
   });
 
+  it("validateNarrowcastMessageObjects", async () => {
+    const scope = mockPost(
+      MESSAGING_API_PREFIX,
+      `/message/validate/narrowcast`,
+      {
+        messages: [testMsg, testMsg],
+      },
+    );
+
+    const res = await client.validateNarrowcastMessageObjects([
+      testMsg,
+      testMsg,
+    ]);
+    strictEqual(scope.isDone(), true);
+    strictEqual(res["x-line-request-id"], "X-Line-Request-Id");
+  });
+
   it("broadcast", async () => {
     const scope = mockPost(MESSAGING_API_PREFIX, `/message/broadcast`, {
       messages: [testMsg, testMsg],
@@ -278,6 +332,23 @@ describe("client", () => {
     equal(res["x-line-request-id"], "X-Line-Request-Id");
   });
 
+  it("validateBroadcastMessageObjects", async () => {
+    const scope = mockPost(
+      MESSAGING_API_PREFIX,
+      `/message/validate/broadcast`,
+      {
+        messages: [testMsg, testMsg],
+      },
+    );
+
+    const res = await client.validateBroadcastMessageObjects([
+      testMsg,
+      testMsg,
+    ]);
+    strictEqual(scope.isDone(), true);
+    strictEqual(res["x-line-request-id"], "X-Line-Request-Id");
+  });
+
   it("getProfile", async () => {
     const scope = mockGet(MESSAGING_API_PREFIX, "/profile/test_user_id");