Merge pull request #477 from Gasol/quote-messages

Add quote message property to message types

Author: Yang-33

lib/types.ts

@@ -429,7 +429,12 @@ export type TextEventMessage = {
       userId?: string;
     }[];
   };
-} & EventMessageBase;
+  /**
+   * Message ID of a quoted message. Only included when the received message quotes a past message.
+   */
+  quotedMessageId?: string;
+} & QuotableMessage &
+  EventMessageBase;
 
 export type ContentProvider<WithPreview extends boolean = true> =
   | {
@@ -486,7 +491,8 @@ export type ImageEventMessage = {
      */
     total: number;
   };
-} & EventMessageBase;
+} & QuotableMessage &
+  EventMessageBase;
 
 /**
  * Message object which contains the video content sent from the source.
@@ -495,7 +501,8 @@ export type ImageEventMessage = {
 export type VideoEventMessage = {
   type: "video";
   contentProvider: ContentProvider;
-} & EventMessageBase;
+} & QuotableMessage &
+  EventMessageBase;
 
 /**
  * Message object which contains the audio content sent from the source.
@@ -552,7 +559,12 @@ export type StickerEventMessage = {
    * Max character limit: 100
    */
   text?: string;
-} & EventMessageBase;
+  /**
+   * Message ID of a quoted message. Only included when the received message quotes a past message.
+   */
+  quotedMessageId?: string;
+} & QuotableMessage &
+  EventMessageBase;
 
 export type Postback = {
   data: string;
@@ -632,35 +644,50 @@ export type MessageCommon = {
   sender?: Sender;
 };
 
-/**
- * @see [Text message](https://developers.line.biz/en/reference/messaging-api/#text-message)
- */
-export type TextMessage = MessageCommon & {
-  type: "text";
+type QuotableMessage = {
   /**
-   * Message text. You can include the following emoji:
-   *
-   * - LINE emojis. Use a $ character as a placeholder and specify the product ID and emoji ID of the LINE emoji you want to use in the emojis property.
-   * - Unicode emoji
-   * - (Deprecated) LINE original unicode emojis
-   *   ([Unicode codepoint table for LINE original emoji](https://developers.line.biz/media/messaging-api/emoji-list.pdf))
-   *
-   * Max: 5000 characters
+   * Quote token to quote this message.
    */
-  text: string;
+  quoteToken: string;
+};
 
+type CanQuoteMessage = {
   /**
-   * One or more LINE emoji.
-   *
-   * Max: 20 LINE emoji
+   * Quote token of the message you want to quote.
    */
-  emojis?: {
-    index: number;
-    productId: string;
-    emojiId: string;
-  }[];
+  quoteText?: string;
 };
 
+/**
+ * @see [Text message](https://developers.line.biz/en/reference/messaging-api/#text-message)
+ */
+export type TextMessage = MessageCommon &
+  CanQuoteMessage & {
+    type: "text";
+    /**
+     * Message text. You can include the following emoji:
+     *
+     * - LINE emojis. Use a $ character as a placeholder and specify the product ID and emoji ID of the LINE emoji you want to use in the emojis property.
+     * - Unicode emoji
+     * - (Deprecated) LINE original unicode emojis
+     *   ([Unicode codepoint table for LINE original emoji](https://developers.line.biz/media/messaging-api/emoji-list.pdf))
+     *
+     * Max: 5000 characters
+     */
+    text: string;
+
+    /**
+     * One or more LINE emoji.
+     *
+     * Max: 20 LINE emoji
+     */
+    emojis?: {
+      index: number;
+      productId: string;
+      emojiId: string;
+    }[];
+  };
+
 /**
  * @see [Image message](https://developers.line.biz/en/reference/messaging-api/#image-message)
  */
@@ -753,22 +780,23 @@ export type LocationMessage = MessageCommon & {
 /**
  * @see [Sticker message](https://developers.line.biz/en/reference/messaging-api/#sticker-message)
  */
-export type StickerMessage = MessageCommon & {
-  type: "sticker";
-  /**
-   * Package ID for a set of stickers.
-   * For information on package IDs, see the
-   * [Sticker list](https://developers.line.biz/media/messaging-api/sticker_list.pdf).
-   */
-  packageId: string;
-  /**
-   * Sticker ID.
-   * For a list of sticker IDs for stickers that can be sent with the Messaging
-   * API, see the
-   * [Sticker list](https://developers.line.biz/media/messaging-api/sticker_list.pdf).
-   */
-  stickerId: string;
-};
+export type StickerMessage = MessageCommon &
+  CanQuoteMessage & {
+    type: "sticker";
+    /**
+     * Package ID for a set of stickers.
+     * For information on package IDs, see the
+     * [Sticker list](https://developers.line.biz/media/messaging-api/sticker_list.pdf).
+     */
+    packageId: string;
+    /**
+     * Sticker ID.
+     * For a list of sticker IDs for stickers that can be sent with the Messaging
+     * API, see the
+     * [Sticker list](https://developers.line.biz/media/messaging-api/sticker_list.pdf).
+     */
+    stickerId: string;
+  };
 
 /**
  * @see [Imagemap message](https://developers.line.biz/en/reference/messaging-api/#imagemap-message)

test/middleware.spec.ts

@@ -19,6 +19,7 @@ describe("middleware", () => {
     message: {
       id: "test_event_message_id",
       text: "this is test message.😄😅😢😞😄😅😢😞",
+      quoteToken: "test_quote_token",
       type: "text",
     },
     replyToken: "test_reply_token",
@@ -35,7 +36,7 @@ describe("middleware", () => {
     type: "message",
   };
   const webhookSignature = {
-    "X-Line-Signature": "Ey7AjSuSI2GfTDQHICAiRLLJ+GSMseISNYaQ6qXSjrU=",
+    "X-Line-Signature": "eRdWYcVCzZV3MVZ3M9/rHJCl/a3oSbsRb04cLovpVwM=",
   };
 
   const http = (headers: any = { ...webhookSignature }) =>