@pipedream/slack_v2 0.0.1

package/sources/new-keyword-mention/test-event.mjs

@@ -0,0 +1,28 @@
+export default {
+  "user": "US676PZLY",
+  "type": "message",
+  "ts": "1716404766.096289",
+  "client_msg_id": "b26387fd-5afe-46a9-bf63-a7aabd6fb40f",
+  "text": "hello",
+  "team": "TS8319547",
+  "blocks": [
+    {
+      "type": "rich_text",
+      "block_id": "aY6KK",
+      "elements": [
+        {
+          "type": "rich_text_section",
+          "elements": [
+            {
+              "type": "text",
+              "text": "hello"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "channel": "CS8319KD5",
+  "event_ts": "1716404766.096289",
+  "channel_type": "channel"
+}

package/sources/new-message-in-channels/new-message-in-channels.mjs

@@ -0,0 +1,106 @@
+import common from "../common/base.mjs";
+import constants from "../common/constants.mjs";
+import sampleEmit from "./test-event.mjs";
+import sharedConstants from "../../common/constants.mjs";
+
+export default {
+  ...common,
+  key: "slack_v2-new-message-in-channels",
+  name: "New Message In Channels (Instant)",
+  version: "1.1.0",
+  description: "Emit new event when a new message is posted to one or more channels",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    conversations: {
+      propDefinition: [
+        common.props.slack,
+        "conversation",
+        () => ({
+          types: [
+            sharedConstants.CHANNEL_TYPE.PUBLIC,
+            sharedConstants.CHANNEL_TYPE.PRIVATE,
+          ],
+        }),
+      ],
+      type: "string[]",
+      label: "Channels",
+      description: "Select one or more channels to monitor for new messages.",
+      optional: true,
+    },
+    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
+    slackApphook: {
+      type: "$.interface.apphook",
+      appProp: "slack",
+      async eventNames() {
+        return this.conversations || [
+          "message",
+        ];
+      },
+    },
+    resolveNames: {
+      propDefinition: [
+        common.props.slack,
+        "resolveNames",
+      ],
+    },
+    ignoreBot: {
+      propDefinition: [
+        common.props.slack,
+        "ignoreBot",
+      ],
+    },
+    ignoreThreads: {
+      type: "boolean",
+      label: "Ignore replies in threads",
+      description: "Ignore replies to messages in threads",
+      optional: true,
+    },
+  },
+  methods: {
+    ...common.methods,
+    getSummary() {
+      return "New message in channel";
+    },
+    async processEvent(event) {
+      if (event.type !== "message") {
+        console.log(`Ignoring event with unexpected type "${event.type}"`);
+        return;
+      }
+      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
+        // This source is designed to just emit an event for each new message received.
+        // Due to inconsistencies with the shape of message_changed and message_deleted
+        // events, we are ignoring them for now. If you want to handle these types of
+        // events, feel free to change this code!!
+        console.log("Ignoring message with subtype.");
+        return;
+      }
+      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
+        return;
+      }
+      // There is no thread message type only the thread_ts field
+      // indicates if the message is part of a thread in the event.
+      if (this.ignoreThreads && event.thread_ts) {
+        console.log("Ignoring reply in thread");
+        return;
+      }
+      if (this.resolveNames) {
+        if (event.user) {
+          event.user_id = event.user;
+          event.user = await this.getUserName(event.user);
+        } else if (event.bot_id) {
+          event.bot = await this.getBotName(event.bot_id);
+        }
+        event.channel_id = event.channel;
+        event.channel = await this.getConversationName(event.channel);
+        if (event.team) {
+          event.team_id = event.team;
+          event.team = await this.getTeamName(event.team);
+        }
+      }
+      return event;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-message-in-channels/test-event.mjs

@@ -0,0 +1,45 @@
+export default  {
+  "client_msg_id": "1a7b4cd8-7c83-4f6e-92f8-bfbd4f77d888",
+  "type": "message",
+  "text": "Hello <@U06MDSMHK7B>, I’ve registered the task here: <https://github.com/DreamPipe/Dreampipe/issues/8395>",
+  "user": "tuleanphuonghh",
+  "ts": "1702506383.129070",
+  "blocks": [
+   {
+    "type": "rich_text",
+    "block_id": "Gh1p",
+    "elements": [
+     {
+      "type": "rich_text_section",
+      "elements": [
+       {
+        "type": "text",
+        "text": "Hello "
+       },
+       {
+        "type": "user",
+        "user_id": "U06MDSMHK7B"
+       },
+       {
+        "type": "text",
+        "text": ", I’ve registered the task here: "
+       },
+       {
+        "type": "link",
+        "url": "https://github.com/DreamPipe/Dreampipe/issues/8395"
+       }
+      ]
+     }
+    ]
+   }
+  ],
+  "team": "Dreampipe Users",
+  "thread_ts": "1702504303.421340",
+  "parent_user_id": "U06MDSMHK7B",
+  "channel": "support",
+  "event_ts": "1702506383.129070",
+  "channel_type": "channel",
+  "user_id": "U04DXTI5SRG",
+  "channel_id": "CPUIZSV6B",
+  "team_id": "TNZFYHTCG"
+ }

package/sources/new-reaction-added/new-reaction-added.mjs

@@ -0,0 +1,119 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "slack_v2-new-reaction-added",
+  name: "New Reaction Added (Instant)",
+  version: "1.2.0",
+  description: "Emit new event when a member has added an emoji reaction to a message",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    conversations: {
+      propDefinition: [
+        common.props.slack,
+        "conversation",
+      ],
+      type: "string[]",
+      label: "Channels",
+      description: "Select one or more channels to monitor for new messages.",
+      optional: true,
+    },
+    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
+    slackApphook: {
+      type: "$.interface.apphook",
+      appProp: "slack",
+      async eventNames() {
+        if (this.conversations?.length) {
+          const conversations = [];
+          for (const conversation of this.conversations) {
+            conversations.push(`reaction_added:${conversation}`);
+          }
+          return conversations;
+        }
+
+        return [
+          "reaction_added",
+        ];
+      },
+    },
+    ignoreBot: {
+      propDefinition: [
+        common.props.slack,
+        "ignoreBot",
+      ],
+    },
+    iconEmoji: {
+      propDefinition: [
+        common.props.slack,
+        "icon_emoji",
+      ],
+      description: "Select one or more emojis to use as a filter. E.g. `fire, email`",
+      type: "string[]",
+      optional: true,
+    },
+    includeUserData: {
+      label: "Include User Data",
+      description: "Include user object in the response. Default `false`",
+      type: "boolean",
+      optional: true,
+      default: false,
+    },
+  },
+  methods: {
+    ...common.methods,
+    getSummary() {
+      return "New reaction added";
+    },
+    async processEvent(event) {
+      let iconEmojiParsed = [];
+
+      try {
+        iconEmojiParsed = typeof this.iconEmoji === "string" ?
+          JSON.parse(this.iconEmoji) :
+          this.iconEmoji;
+      } catch (error) {
+        iconEmojiParsed = this.iconEmoji.replace(/\s+/g, "").split(",");
+      }
+
+      if (
+        ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) ||
+        (iconEmojiParsed?.length > 0 && !iconEmojiParsed.includes(event.reaction))
+      ) {
+        return;
+      }
+
+      if (this.includeUserData) {
+        const promises = [
+          this.slack.usersInfo({
+            user: event.user,
+          }),
+        ];
+        if (event.item_user) {
+          promises.push(this.slack.usersInfo({
+            user: event.item_user,
+          }));
+        }
+        const responses = await Promise.all(promises);
+        event.userInfo = responses[0].user;
+        if (responses[1]) {
+          event.itemUserInfo = responses[1].user;
+        }
+      }
+
+      try {
+        event.message = await this.getMessage({
+          channel: event.item.channel,
+          event_ts: event.item.ts,
+        });
+      } catch (err) {
+        console.log("Error fetching message:", err);
+      }
+
+      return event;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-reaction-added/test-event.mjs

@@ -0,0 +1,193 @@
+export default {
+  "type": "reaction_added",
+  "user": "US676PZLY",
+  "reaction": "squirrel",
+  "item": {
+    "type": "message",
+    "channel": "CS8319KD5",
+    "ts": "1716405857.659549"
+  },
+  "item_user": "US676PZLY",
+  "event_ts": "1716406183.000100",
+  "userInfo": {
+    "id": "US676PZLY",
+    "team_id": "TS8319547",
+    "name": "test.user",
+    "deleted": false,
+    "color": "9f69e7",
+    "real_name": "Test User",
+    "tz": "America/New_York",
+    "tz_label": "Eastern Daylight Time",
+    "tz_offset": -14400,
+    "profile": {
+      "title": "",
+      "phone": "",
+      "skype": "",
+      "real_name": "Test User",
+      "real_name_normalized": "Test User",
+      "display_name": "",
+      "display_name_normalized": "",
+      "fields": null,
+      "status_text": "",
+      "status_emoji": "",
+      "status_emoji_display_info": [],
+      "status_expiration": 0,
+      "avatar_hash": "g010b11df3bb",
+      "email": "test@sample.com",
+      "first_name": "Test",
+      "last_name": "User",
+      "status_text_canonical": "",
+      "team": "TS8319547"
+    },
+    "is_admin": true,
+    "is_owner": true,
+    "is_primary_owner": true,
+    "is_restricted": false,
+    "is_ultra_restricted": false,
+    "is_bot": false,
+    "is_app_user": false,
+    "updated": 1703787612,
+    "is_email_confirmed": true,
+    "has_2fa": false,
+    "who_can_share_contact_card": "EVERYONE"
+  },
+  "itemUserInfo": {
+    "id": "US676PZLY",
+    "team_id": "TS8319547",
+    "name": "test.user",
+    "deleted": false,
+    "color": "9f69e7",
+    "real_name": "Test User",
+    "tz": "America/New_York",
+    "tz_label": "Eastern Daylight Time",
+    "tz_offset": -14400,
+    "profile": {
+      "title": "",
+      "phone": "",
+      "skype": "",
+      "real_name": "Test User",
+      "real_name_normalized": "Test User",
+      "display_name": "",
+      "display_name_normalized": "",
+      "fields": null,
+      "status_text": "",
+      "status_emoji": "",
+      "status_emoji_display_info": [],
+      "status_expiration": 0,
+      "avatar_hash": "g010b11df3bb",
+      "email": "test@sample.com",
+      "first_name": "Test",
+      "last_name": "User",
+      "status_text_canonical": "",
+      "team": "TS8319547"
+    },
+    "is_admin": true,
+    "is_owner": true,
+    "is_primary_owner": true,
+    "is_restricted": false,
+    "is_ultra_restricted": false,
+    "is_bot": false,
+    "is_app_user": false,
+    "updated": 1703787612,
+    "is_email_confirmed": true,
+    "has_2fa": false,
+    "who_can_share_contact_card": "EVERYONE"
+  },
+  "message": {
+    "ok": true,
+    "messages": [
+      {
+        "user": "US676PZLY",
+        "type": "message",
+        "ts": "1716405857.659549",
+        "client_msg_id": "fd68d844-687e-41bf-8475-4215bef572c7",
+        "text": "hello",
+        "team": "TS8319547",
+        "blocks": [
+          {
+            "type": "rich_text",
+            "block_id": "ZL1yL",
+            "elements": [
+              {
+                "type": "rich_text_section",
+                "elements": [
+                  {
+                    "type": "text",
+                    "text": "hello"
+                  }
+                ]
+              }
+            ]
+          }
+        ],
+        "reactions": [
+          {
+            "name": "squirrel",
+            "users": [
+              "US676PZLY"
+            ],
+            "count": 1
+          }
+        ]
+      }
+    ],
+    "has_more": false,
+    "response_metadata": {
+      "scopes": [
+        "identify",
+        "commands",
+        "channels:history",
+        "groups:history",
+        "im:history",
+        "mpim:history",
+        "channels:read",
+        "emoji:read",
+        "files:read",
+        "groups:read",
+        "im:read",
+        "mpim:read",
+        "reactions:read",
+        "reminders:read",
+        "search:read",
+        "stars:read",
+        "team:read",
+        "users:read",
+        "users:read.email",
+        "pins:read",
+        "usergroups:read",
+        "dnd:read",
+        "users.profile:read",
+        "channels:write",
+        "chat:write:user",
+        "chat:write:bot",
+        "files:write:user",
+        "groups:write",
+        "im:write",
+        "mpim:write",
+        "reactions:write",
+        "reminders:write",
+        "stars:write",
+        "users:write",
+        "pins:write",
+        "usergroups:write",
+        "dnd:write",
+        "users.profile:write",
+        "links:read",
+        "links:write",
+        "remote_files:share",
+        "remote_files:read",
+        "bookmarks:write",
+        "calls:write",
+        "calls:read"
+      ],
+      "acceptedScopes": [
+        "channels:history",
+        "groups:history",
+        "mpim:history",
+        "im:history",
+        "read"
+      ]
+    }
+  },
+  "pipedream_msg_id": "pd_1716406186371_xezly8lgzn"
+}

package/sources/new-saved-message/new-saved-message.mjs

@@ -0,0 +1,32 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "slack_v2-new-saved-message",
+  name: "New Saved Message (Instant)",
+  version: "0.0.7",
+  description: "Emit new event when a message is saved. Note: The endpoint is marked as deprecated, and Slack might shut this off at some point down the line.",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
+    slackApphook: {
+      type: "$.interface.apphook",
+      appProp: "slack",
+      async eventNames() {
+        return [
+          "star_added",
+        ];
+      },
+    },
+  },
+  methods: {
+    ...common.methods,
+    getSummary() {
+      return "New saved message";
+    },
+  },
+  sampleEmit,
+};

package/sources/new-saved-message/test-event.mjs

@@ -0,0 +1,37 @@
+export default {
+  "type": "star_added",
+  "user": "US676PZLY",
+  "item": {
+    "type": "message",
+    "channel": "C055ECVUMLN",
+    "message": {
+      "user": "US676PZLY",
+      "type": "message",
+      "ts": "1718379912.272779",
+      "client_msg_id": "def19b3b-4283-47bd-a2da-f32b35c0329c",
+      "text": "hello",
+      "team": "TS8319547",
+      "blocks": [
+        {
+          "type": "rich_text",
+          "block_id": "ZL1yL",
+          "elements": [
+            {
+              "type": "rich_text_section",
+              "elements": [
+                {
+                  "type": "text",
+                  "text": "hello"
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      "permalink": "https://michellestest-j1q3506.slack.com/archives/C055ECVUMLN/p1718379912272779"
+    },
+    "date_create": 1718385156
+  },
+  "event_ts": "1718385156.694322",
+  "pipedream_msg_id": "pd_1718385158733_tl8yx25evl"
+}

package/sources/new-user-added/new-user-added.mjs

@@ -0,0 +1,32 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "slack_v2-new-user-added",
+  name: "New User Added (Instant)",
+  version: "0.0.5",
+  description: "Emit new event when a new member joins a workspace.",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
+    slackApphook: {
+      type: "$.interface.apphook",
+      appProp: "slack",
+      async eventNames() {
+        return [
+          "team_join",
+        ];
+      },
+    },
+  },
+  methods: {
+    ...common.methods,
+    getSummary({ user: { name } }) {
+      return `New User: ${name}`;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-user-added/test-event.mjs

@@ -0,0 +1,48 @@
+export default {
+  "type": "team_join",
+  "user": {
+    "id": "U080GULP8SD",
+    "team_id": "TS8319547",
+    "name": "",
+    "deleted": false,
+    "color": "9b3b45",
+    "real_name": "",
+    "tz": "America/New_York",
+    "tz_label": "Eastern Standard Time",
+    "tz_offset": -18000,
+    "profile": {
+      "title": "",
+      "phone": "",
+      "skype": "",
+      "real_name": "",
+      "real_name_normalized": "",
+      "display_name": "",
+      "display_name_normalized": "",
+      "fields": {},
+      "status_text": "",
+      "status_emoji": "",
+      "status_emoji_display_info": [],
+      "status_expiration": 0,
+      "avatar_hash": "g96b6e8b38c2",
+      "email": "",
+      "first_name": "",
+      "last_name": "",
+      "status_text_canonical": "",
+      "team": "TS8319547"
+    },
+    "is_admin": false,
+    "is_owner": false,
+    "is_primary_owner": false,
+    "is_restricted": false,
+    "is_ultra_restricted": false,
+    "is_bot": false,
+    "is_app_user": false,
+    "updated": 1731094476,
+    "is_email_confirmed": true,
+    "who_can_share_contact_card": "EVERYONE",
+    "presence": "away"
+  },
+  "cache_ts": 1731094476,
+  "event_ts": "1731094477.001400",
+  "pipedream_msg_id": "pd_1731094479305_v1ic236by8"
+}