Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Message Metadata Support to Bolt JS #1508

Merged
merged 10 commits into from
Jul 13, 2022
Merged

Adding Message Metadata Support to Bolt JS #1508

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
86f1ee8
adding message metadata support
dannyhostetler Jun 30, 2022
e2d1229
adding deleted_ts to MessageMetadataDeletedEvent
dannyhostetler Jul 1, 2022
5ff4e3d
adding missing prop deleted_ts to support message_metadata_deleted pa…
dannyhostetler Jul 4, 2022
a2b8f64
adding message metadata simple example
dannyhostetler Jul 9, 2022
48de091
fixing line formatting
dannyhostetler Jul 9, 2022
8279b5f
adding missing await statement for say promise
dannyhostetler Jul 12, 2022
2fea552
bumping @slack\types in package.json
dannyhostetler Jul 12, 2022
8bdc8f9
bumping @slack\types in top-level package.json
dannyhostetler Jul 12, 2022
cd68b23
minor tweak to package.json
dannyhostetler Jul 12, 2022
43beefa
adding README
dannyhostetler Jul 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/types/events/base-events.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -54,6 +54,7 @@ export type SlackEvent =
| MemberJoinedChannelEvent
| MemberLeftChannelEvent
| MessageEvent
| MessageMetadataEvent
| PinAddedEvent
| PinRemovedEvent
| ReactionAddedEvent
Expand Down Expand Up @@ -585,6 +586,8 @@ export interface MemberLeftChannelEvent {

export type MessageEvent = AllMessageEvents;

export type MessageMetadataEvent = AllMessageMetadataEvents;

export interface PinnedMessageItem {
client_msg_id?: string;
type: string;
Expand Down
65 changes: 64 additions & 1 deletion src/types/events/message-events.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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', () => {
Expand Down Expand Up @@ -182,4 +182,67 @@ 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: '',
};
assert.isNotEmpty(payload);
});
});
44 changes: 43 additions & 1 deletion src/types/events/message-events.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { MessageAttachment, KnownBlock, Block } from '@slack/types';
import { MessageAttachment, KnownBlock, Block, MessageMetadata } from '@slack/types';

export type MessageEvent =
| GenericMessageEvent
Expand All @@ -19,6 +19,11 @@ export type MessageEvent =
| MessageRepliedEvent
| ThreadBroadcastMessageEvent;

export type MessageMetadataEvent =
| MessageMetadataPostedEvent
| MessageMetadataUpdatedEvent
| MessageMetadataDeletedEvent;

export interface GenericMessageEvent {
type: 'message';
subtype: undefined;
Expand Down Expand Up @@ -281,6 +286,43 @@ 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;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add deleted_ts: string too?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another good catch, this is done 👍

}

export type channelTypes = 'channel' | 'group' | 'im' | 'mpim' | 'app_home';

interface BotProfile {
Expand Down