@pipedream/slack_v2 0.0.1

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

@@ -0,0 +1,124 @@
+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-user-mention",
+  name: "New User Mention (Instant)",
+  version: "0.1.0",
+  description: "Emit new event when a username or specific keyword is mentioned in a channel",
+  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",
+        ];
+      },
+    },
+    user: {
+      propDefinition: [
+        common.props.slack,
+        "user",
+      ],
+    },
+    keyword: {
+      propDefinition: [
+        common.props.slack,
+        "keyword",
+      ],
+      optional: true,
+    },
+    ignoreBot: {
+      propDefinition: [
+        common.props.slack,
+        "ignoreBot",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getSummary() {
+      return "New mention received";
+    },
+    async processEvent(event) {
+      const {
+        type: msgType,
+        subtype,
+        bot_id: botId,
+        text,
+        blocks = [],
+      } = event;
+      const [
+        {
+          elements: [
+            { elements = [] } = {},
+          ] = [],
+        } = {},
+      ] = blocks;
+
+      if (msgType !== "message") {
+        console.log(`Ignoring event with unexpected type "${msgType}"`);
+        return;
+      }
+
+      // 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!!
+      if (subtype && !constants.ALLOWED_SUBTYPES.includes(subtype)) {
+        console.log(`Ignoring message with subtype. "${subtype}"`);
+        return;
+      }
+
+      if ((this.ignoreBot) && (subtype === constants.SUBTYPE.BOT_MESSAGE || botId)) {
+        return;
+      }
+
+      let emitEvent = false;
+      if (elements) {
+        let userMatch = false;
+        for (const item of elements) {
+          if (item.user_id && item.user_id === this.user) {
+            userMatch = true;
+            break;
+          }
+        }
+        if (userMatch && (!this.keyword || text.indexOf(this.keyword) !== -1)) {
+          emitEvent = true;
+        }
+      }
+      if (subtype === constants.SUBTYPE.PD_HISTORY_MESSAGE) {
+        emitEvent = true;
+      }
+
+      if (emitEvent) {
+        return event;
+      }
+    },
+  },
+  sampleEmit,
+};

package/sources/new-user-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"
+}