@pipedream/slack 0.5.2 → 0.6.0

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-user-mention/new-user-mention.mjs

@@ -0,0 +1,117 @@
+import common from "../common/base.mjs";
+import constants from "../common/constants.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "slack-new-user-mention",
+  name: "New User Mention (Instant)",
+  version: "0.0.1",
+  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",
+      ],
+      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"
+}

package/actions/add-star/add-star.mjs

@@ -1,43 +0,0 @@
-import slack from "../../slack.app.mjs";
-
-export default {
-  key: "slack-add-star",
-  name: "Add Star",
-  description: "Add a star to an item on behalf of the authenticated user. [See docs here](https://api.slack.com/methods/stars.add)",
-  version: "0.0.15",
-  type: "action",
-  props: {
-    slack,
-    conversation: {
-      propDefinition: [
-        slack,
-        "conversation",
-      ],
-      optional: true,
-      description: "Channel to add star to, or channel where the message to add star to was posted (used with timestamp).",
-    },
-    timestamp: {
-      propDefinition: [
-        slack,
-        "timestamp",
-      ],
-      optional: true,
-      description: "Timestamp of the message to add star to.",
-    },
-    file: {
-      propDefinition: [
-        slack,
-        "file",
-      ],
-      optional: true,
-      description: "File to add star to.",
-    },
-  },
-  async run() {
-    return await this.slack.sdk().stars.add({
-      channel: this.conversation,
-      timestamp: this.timestamp,
-      file: this.file,
-    });
-  },
-};

package/actions/complete-reminder/complete-reminder.mjs

@@ -1,23 +0,0 @@
-import slack from "../../slack.app.mjs";
-
-export default {
-  key: "slack-complete-reminder",
-  name: "Complete Reminder",
-  description: "Complete a reminder. [See docs here](https://api.slack.com/methods/reminders.complete)",
-  version: "0.0.15",
-  type: "action",
-  props: {
-    slack,
-    reminder: {
-      propDefinition: [
-        slack,
-        "reminder",
-      ],
-    },
-  },
-  async run() {
-    return await this.slack.sdk().reminders.complete({
-      reminder: this.reminder,
-    });
-  },
-};

package/actions/delete-reminder/delete-reminder.mjs

@@ -1,23 +0,0 @@
-import slack from "../../slack.app.mjs";
-
-export default {
-  key: "slack-delete-reminder",
-  name: "Delete Reminder",
-  description: "Delete a reminder. [See docs here](https://api.slack.com/methods/reminders.delete)",
-  version: "0.0.15",
-  type: "action",
-  props: {
-    slack,
-    reminder: {
-      propDefinition: [
-        slack,
-        "reminder",
-      ],
-    },
-  },
-  async run() {
-    return await this.slack.sdk().reminders.delete({
-      reminder: this.reminder,
-    });
-  },
-};

package/actions/get-channel/get-channel.mjs

@@ -1,23 +0,0 @@
-import slack from "../../slack.app.mjs";
-
-export default {
-  key: "slack-get-channel",
-  name: "Get Channel",
-  description: "Return information about a workspace channel. [See docs here](https://api.slack.com/methods/conversations.info)",
-  version: "0.0.15",
-  type: "action",
-  props: {
-    slack,
-    conversation: {
-      propDefinition: [
-        slack,
-        "conversation",
-      ],
-    },
-  },
-  async run() {
-    return await this.slack.sdk().conversations.info({
-      channel: this.conversation,
-    });
-  },
-};

package/actions/get-reminder/get-reminder.mjs

@@ -1,23 +0,0 @@
-import slack from "../../slack.app.mjs";
-
-export default {
-  key: "slack-get-reminder",
-  name: "Get Reminder",
-  description: "Return information about a reminder. [See docs here](https://api.slack.com/methods/reminders.info)",
-  version: "0.0.15",
-  type: "action",
-  props: {
-    slack,
-    reminder: {
-      propDefinition: [
-        slack,
-        "reminder",
-      ],
-    },
-  },
-  async run() {
-    return await this.slack.sdk().reminders.info({
-      reminder: this.reminder,
-    });
-  },
-};

package/actions/join-channel/join-channel.mjs

@@ -1,23 +0,0 @@
-import slack from "../../slack.app.mjs";
-
-export default {
-  key: "slack-join-channel",
-  name: "Join Channel",
-  description: "Join an existing channel. [See docs here](https://api.slack.com/methods/conversations.join)",
-  version: "0.0.15",
-  type: "action",
-  props: {
-    slack,
-    conversation: {
-      propDefinition: [
-        slack,
-        "conversation",
-      ],
-    },
-  },
-  async run() {
-    return await this.slack.sdk().conversations.join({
-      channel: this.conversation,
-    });
-  },
-};

package/actions/leave-channel/leave-channel.mjs

@@ -1,23 +0,0 @@
-import slack from "../../slack.app.mjs";
-
-export default {
-  key: "slack-leave-channel",
-  name: "Leave Channel",
-  description: "Leave an existing channel. [See docs here](https://api.slack.com/methods/conversations.leave)",
-  version: "0.0.15",
-  type: "action",
-  props: {
-    slack,
-    conversation: {
-      propDefinition: [
-        slack,
-        "conversation",
-      ],
-    },
-  },
-  async run() {
-    return await this.slack.sdk().conversations.leave({
-      channel: this.conversation,
-    });
-  },
-};

package/actions/list-reminders/list-reminders.mjs

@@ -1,24 +0,0 @@
-import slack from "../../slack.app.mjs";
-
-export default {
-  key: "slack-list-reminders",
-  name: "List Reminders",
-  description: "List all reminders for a given user. [See docs here](https://api.slack.com/methods/reminders.list)",
-  version: "0.0.15",
-  type: "action",
-  props: {
-    slack,
-    team_id: {
-      propDefinition: [
-        slack,
-        "team",
-      ],
-      optional: true,
-    },
-  },
-  async run() {
-    return await this.slack.sdk().reminders.list({
-      team_id: this.team_id,
-    });
-  },
-};

package/actions/remove-star/remove-star.mjs

@@ -1,40 +0,0 @@
-import slack from "../../slack.app.mjs";
-
-export default {
-  key: "slack-remove-star",
-  name: "Remove Star",
-  description: "Remove a star from an item on behalf of the authenticated user. [See docs here](https://api.slack.com/methods/stars.remove)",
-  version: "0.0.15",
-  type: "action",
-  props: {
-    slack,
-    conversation: {
-      propDefinition: [
-        slack,
-        "conversation",
-      ],
-      optional: true,
-    },
-    timestamp: {
-      propDefinition: [
-        slack,
-        "timestamp",
-      ],
-      optional: true,
-    },
-    file: {
-      propDefinition: [
-        slack,
-        "file",
-      ],
-      optional: true,
-    },
-  },
-  async run() {
-    return await this.slack.sdk().stars.remove({
-      channel: this.conversation,
-      timestamp: this.timestamp,
-      file: this.file,
-    });
-  },
-};

package/actions/send-block-kit-message/send-block-kit-message.mjs

@@ -1,43 +0,0 @@
-import buildBlocks from "../common/build-blocks.mjs";
-import common from "../common/send-message.mjs";
-
-export default {
-  ...common,
-  ...buildBlocks,
-  name: "Build and Send a Block Kit Message (Beta)",
-  description: "Configure custom blocks and send to a channel, group, or user. [See Slack's docs for more info](https://api.slack.com/tools/block-kit-builder).",
-  version: "0.3.3",
-  type: "action",
-  key: "slack-send-block-kit-message",
-  props: {
-    slack: common.props.slack,
-    conversation: {
-      propDefinition: [
-        common.props.slack,
-        "conversation",
-      ],
-    },
-    text: {
-      propDefinition: [
-        common.props.slack,
-        "notificationText",
-      ],
-    },
-    ...common.props,
-    ...buildBlocks.props,
-  },
-  methods: {
-    ...common.methods,
-    ...buildBlocks.methods,
-    async getGeneratedBlocks() {
-      return await buildBlocks.run.call(this);  // call buildBlocks.run with the current context
-    },
-  },
-  async run({ $ }) {
-    this.blocks = await this.getGeneratedBlocks();  // set the blocks prop for common.run to use
-    const resp = await common.run.call(this, {
-      $,
-    });  // call common.run with the current context
-    return resp;
-  },
-};

package/actions/send-direct-message/send-direct-message.mjs

@@ -1,32 +0,0 @@
-import common from "../common/send-message.mjs";
-
-export default {
-  ...common,
-  key: "slack-send-direct-message",
-  name: "Send a Direct Message",
-  description: "Send a direct message to a single user. See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.2.20",
-  type: "action",
-  props: {
-    slack: common.props.slack,
-    conversation: {
-      propDefinition: [
-        common.props.slack,
-        "user",
-      ],
-    },
-    text: {
-      propDefinition: [
-        common.props.slack,
-        "text",
-      ],
-    },
-    mrkdwn: {
-      propDefinition: [
-        common.props.slack,
-        "mrkdwn",
-      ],
-    },
-    ...common.props,
-  },
-};