Adding Message Metadata Support to Bolt JS

src/types/events/base-events.ts

@@ -1,5 +1,5 @@
 import { View, MessageAttachment, KnownBlock, Block } from '@slack/types';
-import { MessageEvent as AllMessageEvents } from './message-events';
+import { MessageEvent as AllMessageEvents, MessageMetadataEvent as AllMessageMetadataEvents } from './message-events';
 
 /**
  * All known event types in Slack's Events API
@@ -54,6 +54,7 @@ export type SlackEvent =
   | MemberJoinedChannelEvent
   | MemberLeftChannelEvent
   | MessageEvent
+  | MessageMetadataEvent
   | PinAddedEvent
   | PinRemovedEvent
   | ReactionAddedEvent
@@ -585,6 +586,8 @@ export interface MemberLeftChannelEvent {
 
 export type MessageEvent = AllMessageEvents;
 
+export type MessageMetadataEvent = AllMessageMetadataEvents;
+
 export interface PinnedMessageItem {
   client_msg_id?: string;
   type: string;

src/types/events/message-events.spec.ts

@@ -1,5 +1,5 @@
 import { assert } from 'chai';
-import { BotMessageEvent, GenericMessageEvent, MessageEvent } from './message-events';
+import { BotMessageEvent, GenericMessageEvent, MessageEvent, MessageMetadataEvent } from './message-events';
 
 describe('Events API payload types (message events)', () => {
   it('should be compatible with bot_message payload', () => {
@@ -182,4 +182,68 @@ describe('Events API payload types (message events)', () => {
     };
     assert.isNotEmpty(payload);
   });
+  it('should be compatible with message_metadata_posted payload', () => {
+    const payload: MessageMetadataEvent = {
+      type: 'message_metadata_posted',
+      app_id: 'A222',
+      bot_id: 'B999',
+      user_id: 'U123',
+      team_id: 'T111',
+      channel_id: 'C111',
+      metadata: {
+        event_type: '',
+        event_payload: {
+          key: 'value',
+        },
+      },
+      message_ts: '',
+      event_ts: '',
+    };
+    assert.isNotEmpty(payload);
+  });
+  it('should be compatible with message_metadata_updated payload', () => {
+    const payload: MessageMetadataEvent = {
+      type: 'message_metadata_updated',
+      channel_id: 'C111',
+      event_ts: '',
+      previous_metadata: {
+        event_type: '',
+        event_payload: {
+          key: 'value',
+        },
+      },
+      app_id: 'A222',
+      bot_id: 'B999',
+      user_id: 'U123',
+      team_id: 'T111',
+      message_ts: '',
+      metadata: {
+        event_type: '',
+        event_payload: {
+          key: 'value',
+        },
+      },
+    };
+    assert.isNotEmpty(payload);
+  });
+  it('should be compatible with message_metadata_deleted payload', () => {
+    const payload: MessageMetadataEvent = {
+      type: 'message_metadata_deleted',
+      channel_id: 'C111',
+      event_ts: '',
+      previous_metadata: {
+        event_type: '',
+        event_payload: {
+          key: 'value',
+        },
+      },
+      app_id: 'A222',
+      bot_id: 'B999',
+      user_id: 'U123',
+      team_id: 'T111',
+      message_ts: '',
+      deleted_ts: ''
+    };
+    assert.isNotEmpty(payload);
+  });
 });

src/types/events/message-events.ts

@@ -1,4 +1,4 @@
-import { MessageAttachment, KnownBlock, Block } from '@slack/types';
+import { MessageAttachment, KnownBlock, Block, MessageMetadata } from '@slack/types';
 
 export type MessageEvent =
   | GenericMessageEvent
@@ -19,6 +19,11 @@ export type MessageEvent =
   | MessageRepliedEvent
   | ThreadBroadcastMessageEvent;
 
+export type MessageMetadataEvent =
+| MessageMetadataPostedEvent
+| MessageMetadataUpdatedEvent
+| MessageMetadataDeletedEvent;
+
 export interface GenericMessageEvent {
   type: 'message';
   subtype: undefined;
@@ -281,6 +286,44 @@ export interface ThreadBroadcastMessageEvent {
   channel_type: channelTypes;
 }
 
+export interface MessageMetadataPostedEvent {
+  type: 'message_metadata_posted';
+  app_id: string;
+  bot_id?: string;
+  user_id: string;
+  team_id: string;
+  channel_id: string;
+  metadata: MessageMetadata;
+  message_ts: string;
+  event_ts: string;
+}
+
+export interface MessageMetadataUpdatedEvent {
+  type: 'message_metadata_updated';
+  channel_id: string;
+  event_ts: string;
+  previous_metadata: MessageMetadata;
+  app_id: string;
+  bot_id?: string;
+  user_id: string;
+  team_id: string;
+  message_ts: string;
+  metadata: MessageMetadata;
+}
+
+export interface MessageMetadataDeletedEvent {
+  type: 'message_metadata_deleted';
+  channel_id: string;
+  event_ts: string;
+  previous_metadata: MessageMetadata;
+  app_id: string;
+  bot_id?: string;
+  user_id: string;
+  team_id: string;
+  message_ts: string;
+  deleted_ts: string;
+}
+
 export type channelTypes = 'channel' | 'group' | 'im' | 'mpim' | 'app_home';
 
 interface BotProfile {