@pipedream/slack 0.5.1 → 0.6.0

package/slack.app.mjs

@@ -1,5 +1,6 @@
 import { WebClient } from "@slack/web-api";
 import constants from "./common/constants.mjs";
+import { ConfigurationError } from "@pipedream/platform";
 
 export default {
   type: "app",
@@ -9,17 +10,26 @@ export default {
       type: "string",
       label: "User",
       description: "Select a user",
-      async options({ prevContext }) {
+      async options({
+        prevContext, channelId,
+      }) {
         const types = [
           "im",
         ];
-        const [
+        let [
           userNames,
           conversationsResp,
         ] = await Promise.all([
           prevContext.userNames ?? this.userNames(),
           this.availableConversations(types.join(), prevContext.cursor),
         ]);
+        if (channelId) {
+          const { members } = await this.sdk().conversations.members({
+            channel: channelId,
+          });
+          conversationsResp.conversations = conversationsResp.conversations
+            .filter((c) => members.includes(c.user || c.id));
+        }
         return {
           options: conversationsResp.conversations.map((c) => ({
             label: `@${userNames[c.user]}`,
@@ -55,22 +65,6 @@ export default {
         };
       },
     },
-    users: {
-      type: "string[]",
-      label: "Users",
-      description: "Select users",
-      async options() {
-        const userNames = await this.userNames();
-        const users = [];
-        for (const key of Object.keys(userNames)) {
-          users.push({
-            label: userNames[key],
-            value: key,
-          });
-        }
-        return users;
-      },
-    },
     userGroup: {
       type: "string",
       label: "User Group",
@@ -99,12 +93,16 @@ export default {
       type: "string",
       label: "Channel",
       description: "Select a public or private channel, or a user or group",
-      async options({ prevContext }) {
+      async options({
+        prevContext, types,
+      }) {
         let {
-          types,
           cursor,
           userNames: userNamesOrPromise,
         } = prevContext;
+        if (prevContext?.types) {
+          types = prevContext.types;
+        }
         if (types == null) {
           const { response_metadata: { scopes } } = await this.authTest();
           types = [
@@ -128,8 +126,11 @@ export default {
           userNamesOrPromise,
           this.availableConversations(types.join(), cursor),
         ]);
+        const conversations = userNames
+          ? conversationsResp.conversations
+          : conversationsResp.conversations.filter((c) => !c.is_im);
         return {
-          options: conversationsResp.conversations.map((c) => {
+          options: conversations.map((c) => {
             if (c.is_im) {
               return {
                 label: `Direct messaging with: @${userNames[c.user]}`,
@@ -162,7 +163,10 @@ export default {
       label: "Channel ID",
       description: "Select the channel's id.",
       async options({
-        prevContext, types = [], channelsFilter = (channel) => channel, excludeArchived = true,
+        prevContext,
+        types = Object.values(constants.CHANNEL_TYPE),
+        channelsFilter = (channel) => channel,
+        excludeArchived = true,
       }) {
         const userNames = prevContext.userNames || await this.userNames();
         const {
@@ -217,27 +221,40 @@ export default {
         };
       },
     },
-    notificationText: {
+    messageTs: {
       type: "string",
-      label: "Notification Text",
-      description: "Optionally provide a string for Slack to display as the new message notification (if you do not provide this, notification will be blank).",
-      optional: true,
+      label: "Message Timestamp",
+      description: "Timestamp of a message",
+      async options({
+        channel, prevContext,
+      }) {
+        if (!channel) {
+          throw new ConfigurationError("Provide a Channel ID in order to retrieve Messages.");
+        }
+        const {
+          messages, response_metadata: { next_cursor: cursor },
+        } = await this.conversationsHistory({
+          channel,
+          cursor: prevContext?.cursor,
+        });
+        return {
+          options: messages.map(({
+            ts: value, text: label,
+          }) => ({
+            value,
+            label,
+          })),
+          context: {
+            cursor,
+          },
+        };
+      },
     },
     text: {
       type: "string",
       label: "Text",
       description: "Text of the message to send (see Slack's [formatting docs](https://api.slack.com/reference/surfaces/formatting)). This field is usually necessary, unless you're providing only attachments instead.",
     },
-    name: {
-      type: "string",
-      label: "Name",
-      description: "Name of a single key to set.",
-    },
-    value: {
-      type: "string",
-      label: "Value",
-      description: "Value to set a single key to.",
-    },
     topic: {
       type: "string",
       label: "Topic",
@@ -253,15 +270,24 @@ export default {
       label: "Query",
       description: "Search query.",
     },
-    team_id: {
-      type: "string",
-      label: "Team ID",
-      description: "The ID of the team.",
-    },
     file: {
       type: "string",
       label: "File ID",
       description: "Specify a file by providing its ID.",
+      async options({
+        channel, page,
+      }) {
+        const { files } = await this.sdk().files.list({
+          channel,
+          page: page + 1,
+        });
+        return files?.map(({
+          id: value, name: label,
+        }) => ({
+          value,
+          label,
+        })) || [];
+      },
     },
     attachments: {
       type: "string",
@@ -273,24 +299,26 @@ export default {
       type: "boolean",
       label: "Unfurl Links",
       description: "`TRUE` by default. Pass `FALSE` to disable unfurling of links.",
+      default: true,
       optional: true,
     },
     unfurl_media: {
       type: "boolean",
       label: "Unfurl Media",
       description: "`TRUE` by default. Pass `FALSE` to disable unfurling of media content.",
+      default: true,
       optional: true,
     },
     parse: {
       type: "string",
       label: "Parse",
-      description: "Change how messages are treated. Defaults to none. See below.",
+      description: "Change how messages are treated. Defaults to none. By default, URLs will be hyperlinked. Set `parse` to `none` to remove the hyperlinks. The behavior of `parse` is different for text formatted with `mrkdwn`. By default, or when `parse` is set to `none`, `mrkdwn` formatting is implemented. To ignore `mrkdwn` formatting, set `parse` to full.",
       optional: true,
     },
     as_user: {
       type: "boolean",
       label: "Send as User",
-      description: "Optionally pass `TRUE` to post the message as the authed user, instead of as a bot. Defaults to `FALSE`.",
+      description: "Optionally pass `TRUE` to post the message as the authenticated user, instead of as a bot. Defaults to `FALSE`.",
       default: false,
       optional: true,
     },
@@ -303,8 +331,8 @@ export default {
     },
     post_at: {
       label: "Schedule message",
-      description: "Messages can only be scheduled up to 120 days in advance, and cannot be scheduled for the past. The datetime format should be a unix timestamp (e.g., `1650507616`, [see here](https://www.epochconverter.com/) for help with this format).",
-      type: "integer",
+      description: "Messages can only be scheduled up to 120 days in advance, and cannot be scheduled for the past. The datetime should be in ISO 8601 format. (Example: `2014-01-01T00:00:00Z`)",
+      type: "string",
       optional: true,
     },
     username: {
@@ -334,7 +362,7 @@ export default {
       type: "string",
     },
     link_names: {
-      type: "string",
+      type: "boolean",
       label: "Link Names",
       description: "Find and link channel names and usernames.",
       optional: true,
@@ -352,18 +380,6 @@ export default {
       description: "Provide the channel or conversation ID for the thread to reply to (e.g., if triggering on new Slack messages, enter `{{event.channel}}`). If the channel does not match the thread timestamp, a new message will be posted to this channel.",
       optional: true,
     },
-    thread_ts: {
-      label: "Thread Timestamp",
-      type: "string",
-      description: "Provide another message's `ts` value to make this message a reply (e.g., if triggering on new Slack messages, enter `{{event.ts}}`). Avoid using a reply's `ts` value; use its parent instead.",
-      optional: true,
-    },
-    timestamp: {
-      label: "Timestamp",
-      type: "string",
-      description: "Timestamp of the relevant data.",
-      optional: true,
-    },
     icon_url: {
       type: "string",
       label: "Icon (image URL)",
@@ -376,12 +392,6 @@ export default {
       description: "The message text introducing the file",
       optional: true,
     },
-    count: {
-      type: "integer",
-      label: "Count",
-      description: "Number of items to return per page.",
-      optional: true,
-    },
     email: {
       type: "string",
       label: "Email",
@@ -410,13 +420,6 @@ export default {
       label: "Keyword",
       description: "Keyword to monitor",
     },
-    isUsername: {
-      type: "boolean",
-      label: "Is Username",
-      description: "Filters out mentions of the keyword that are not a username",
-      default: false,
-      optional: true,
-    },
     ignoreBot: {
       type: "boolean",
       label: "Ignore Bots",

package/sources/common/base.mjs

@@ -92,6 +92,15 @@ export default {
         return info.user.name;
       });
     },
+    async getRealName(id) {
+      return this.maybeCached(`users_real_names:${id}`, async () => {
+        const info = await this.slack.sdk().users.info({
+          user: id,
+        });
+        if (!info.ok) throw new Error(info.error);
+        return info.user.real_name;
+      });
+    },
     async getBotName(id) {
       return this.maybeCached(`bots:${id}`, async () => {
         const info = await this.slack.sdk().bots.info({

package/sources/new-channel-created/new-channel-created.mjs

@@ -5,7 +5,7 @@ export default {
   ...common,
   key: "slack-new-channel-created",
   name: "New Channel Created (Instant)",
-  version: "0.0.1",
+  version: "0.0.3",
   description: "Emit new event when a new channel is created.",
   type: "source",
   dedupe: "unique",

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

@@ -1,10 +1,11 @@
 import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
 
 export default {
   ...common,
   key: "slack-new-direct-message",
   name: "New Direct Message (Instant)",
-  version: "1.0.13",
+  version: "1.0.15",
   description: "Emit new event when a message was posted in a direct message channel",
   type: "source",
   dedupe: "unique",
@@ -42,4 +43,5 @@ export default {
       return event;
     },
   },
+  sampleEmit,
 };

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

@@ -0,0 +1,28 @@
+export default {
+  "user": "USLACKBOT",
+  "type": "message",
+  "ts": "1716401124.947359",
+  "text": "Feeling great!",
+  "team": "TS8319547",
+  "blocks": [
+    {
+      "type": "rich_text",
+      "block_id": "bid/",
+      "elements": [
+        {
+          "type": "rich_text_section",
+          "elements": [
+            {
+              "type": "text",
+              "text": "Feeling great!"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "channel": "DS676Q73J",
+  "event_ts": "1716401124.947359",
+  "channel_type": "im",
+  "pipedream_msg_id": "pd_1716401126905_tjxu6josgz"
+}

package/sources/new-interaction-event-received/README.md

@@ -31,21 +31,21 @@ Then select a **************Channel************** you’d like to send the messa
 ```jsx
 [
   {
-    type: "actions",
-    elements: [
+    "type": "actions",
+    "elements": [
       {
-        type: "button",
-        text: {
-          type: "plain_text",
-          text: "Click Me",
-          emoji: true,
+        "type": "button",
+        "text": {
+          "type": "plain_text",
+          "text": "Click Me",
+          "emoji": true
         },
-        value: "click_me_123",
-        action_id: "button_click",
-      },
-    ],
-  },
-];
+        "value": "click_me_123",
+        "action_id": "button_click"
+      }
+    ]
+  }
+]
 ```
 
 Your ******************Slack - Send Message Using Block Kit****************** should look like this:

package/sources/new-interaction-event-received/new-interaction-event-received.mjs

@@ -1,11 +1,11 @@
 import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
 
 export default {
-  name: "New Interaction Events",
-  version: "0.0.11",
+  name: "New Interaction Events (Instant)",
+  version: "0.0.13",
   key: "slack-new-interaction-event-received",
-  description:
-    "Emit new events on new Slack [interactivity events](https://api.slack.com/interactivity) sourced from [Block Kit interactive elements](https://api.slack.com/interactivity/components), [Slash commands](https://api.slack.com/interactivity/slash-commands), or [Shortcuts](https://api.slack.com/interactivity/shortcuts).",
+  description: "Emit new events on new Slack [interactivity events](https://api.slack.com/interactivity) sourced from [Block Kit interactive elements](https://api.slack.com/interactivity/components), [Slash commands](https://api.slack.com/interactivity/slash-commands), or [Shortcuts](https://api.slack.com/interactivity/shortcuts).",
   type: "source",
   props: {
     ...common.props,
@@ -17,8 +17,7 @@ export default {
     action_ids: {
       type: "string[]",
       label: "Action IDs",
-      description:
-        "Filter interaction events by specific `action_id`'s to subscribe for new interaction events. If none are specified, all `action_ids` created via Pipedream will emit new events.",
+      description: "Filter interaction events by specific `action_id`'s to subscribe for new interaction events. If none are specified, all `action_ids` created via Pipedream will emit new events.",
       optional: true,
       default: [],
     },
@@ -29,8 +28,7 @@ export default {
       ],
       type: "string[]",
       label: "Channels",
-      description:
-        "Filter interaction events by one or more channels. If none selected, any interaction event in any channel will emit new events.",
+      description: "Filter interaction events by one or more channels. If none selected, any interaction event in any channel will emit new events.",
       optional: true,
       default: [],
     },
@@ -103,4 +101,5 @@ export default {
       },
     );
   },
+  sampleEmit,
 };

package/sources/new-interaction-event-received/test-event.mjs

@@ -0,0 +1,86 @@
+export default {
+  "event": {
+    "type": "block_actions",
+    "user": {
+      "id": "US676PZLY",
+      "username": "test.user",
+      "name": "test.user",
+      "team_id": "TS8319547"
+    },
+    "api_app_id": "AN9231S6L",
+    "token": "UYc82mtyZWRhvUXQ6TXrv4wq",
+    "container": {
+      "type": "message",
+      "message_ts": "1716402983.247149",
+      "channel_id": "CS8319KD5",
+      "is_ephemeral": false
+    },
+    "trigger_id": "7161731794692.892103311143.4020ed3595908eca11e4076438354dbb",
+    "team": {
+      "id": "TS8319547",
+      "domain": "test-j1q3506"
+    },
+    "enterprise": null,
+    "is_enterprise_install": false,
+    "channel": {
+      "id": "CS8319KD5",
+      "name": "testing"
+    },
+    "message": {
+      "subtype": "bot_message",
+      "text": "Click Me button Sent via <https://pipedream.com/@/p_6lCR5Nx?o=a&amp;a=slack|Pipedream>",
+      "username": "Pipedream",
+      "type": "message",
+      "ts": "1716402983.247149",
+      "bot_id": "BRTDL45RQ",
+      "app_id": "AN9231S6L",
+      "blocks": [
+        {
+          "type": "actions",
+          "block_id": "SJp0j",
+          "elements": [
+            {
+              "type": "button",
+              "action_id": "button_click",
+              "text": {
+                "type": "plain_text",
+                "text": "Click Me",
+                "emoji": true
+              },
+              "value": "click_me_123"
+            }
+          ]
+        },
+        {
+          "type": "context",
+          "block_id": "ysmBN",
+          "elements": [
+            {
+              "type": "mrkdwn",
+              "text": "Sent via <https://pipedream.com/@/p_6lCR5Nx?o=a&amp;a=slack|Pipedream>",
+              "verbatim": false
+            }
+          ]
+        }
+      ]
+    },
+    "state": {
+      "values": {}
+    },
+    "response_url": "https://hooks.slack.com/actions/TS8319547/7156351250101/J0w1NoVIXjChEwp4WQab4tcv",
+    "actions": [
+      {
+        "action_id": "button_click",
+        "block_id": "SJp0j",
+        "text": {
+          "type": "plain_text",
+          "text": "Click Me",
+          "emoji": true
+        },
+        "value": "click_me_123",
+        "type": "button",
+        "action_ts": "1716403200.549150"
+      }
+    ]
+  }
+}

package/sources/{new-mention/new-mention.mjs → new-keyword-mention/new-keyword-mention.mjs}

@@ -1,12 +1,13 @@
 import common from "../common/base.mjs";
 import constants from "../common/constants.mjs";
+import sampleEmit from "./test-event.mjs";
 
 export default {
   ...common,
-  key: "slack-new-mention",
-  name: "New Mention (Instant)",
-  version: "1.0.16",
-  description: "Emit new event when a username or specific keyword is mentioned in a channel",
+  key: "slack-new-keyword-mention",
+  name: "New Keyword Mention (Instant)",
+  version: "0.0.1",
+  description: "Emit new event when a specific keyword is mentioned in a channel",
   type: "source",
   dedupe: "unique",
   props: {
@@ -37,12 +38,6 @@ export default {
         "keyword",
       ],
     },
-    isUsername: {
-      propDefinition: [
-        common.props.slack,
-        "isUsername",
-      ],
-    },
     ignoreBot: {
       propDefinition: [
         common.props.slack,
@@ -90,7 +85,7 @@ export default {
       }
     },
     getSummary() {
-      return "New mention received";
+      return "New keyword mention received";
     },
     async processEvent(event) {
       const {
@@ -98,15 +93,7 @@ export default {
         subtype,
         bot_id: botId,
         text,
-        blocks = [],
       } = event;
-      const [
-        {
-          elements: [
-            { elements = [] } = {},
-          ] = [],
-        } = {},
-      ] = blocks;
 
       if (msgType !== "message") {
         console.log(`Ignoring event with unexpected type "${msgType}"`);
@@ -127,17 +114,7 @@ export default {
       }
 
       let emitEvent = false;
-      if (this.isUsername && elements) {
-        for (const item of elements) {
-          if (item.user_id) {
-            const username = await this.getUserName(item.user_id);
-            if (username === this.keyword) {
-              emitEvent = true;
-              break;
-            }
-          }
-        }
-      } else if (text.indexOf(this.keyword) !== -1) {
+      if (text.indexOf(this.keyword) !== -1) {
         emitEvent = true;
       } else if (subtype === constants.SUBTYPE.PD_HISTORY_MESSAGE) {
         emitEvent = true;
@@ -148,4 +125,5 @@ export default {
       }
     },
   },
+  sampleEmit,
 };

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

@@ -6,7 +6,7 @@ export default {
   ...common,
   key: "slack-new-message-in-channels",
   name: "New Message In Channels (Instant)",
-  version: "1.0.15",
+  version: "1.0.17",
   description: "Emit new event when a new message is posted to one or more channels",
   type: "source",
   dedupe: "unique",

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

@@ -1,10 +1,11 @@
 import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
 
 export default {
   ...common,
   key: "slack-new-reaction-added",
   name: "New Reaction Added (Instant)",
-  version: "1.1.17",
+  version: "1.1.19",
   description: "Emit new event when a member has added an emoji reaction to a message",
   type: "source",
   dedupe: "unique",
@@ -54,6 +55,7 @@ export default {
       optional: true,
     },
     includeUserData: {
+      label: "Include User Data",
       description: "Include user object in the response. Default `false`",
       type: "boolean",
       optional: true,
@@ -103,4 +105,5 @@ export default {
       return event;
     },
   },
+  sampleEmit,
 };