Slack Bot - update Channel prop description (#14062)

michelle0927 · web-flow · commit bb293280a952 · 2024-09-25T14:49:27.000-04:00
* update slack_bot conversation prop description

* versions

* extract description message into constant

* update channelId prop descriptions

* update conversation prop for send-message
diff --git a/components/slack/actions/send-message/send-message.mjs b/components/slack/actions/send-message/send-message.mjs
@@ -6,7 +6,7 @@ export default {
   key: "slack-send-message",
   name: "Send Message",
   description: "Send a message to a user, group, private channel or public channel. [See the documentation](https://api.slack.com/methods/chat.postMessage)",
-  version: "0.0.14",
+  version: "0.0.15",
   type: "action",
   props: {
     slack: common.props.slack,
@@ -21,7 +21,7 @@ export default {
     conversation: {
       propDefinition: [
         common.props.slack,
-        "channelId",
+        "conversation",
         (c) => ({
           types: c.channelType === "Channels"
             ? [
diff --git a/components/slack/package.json b/components/slack/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/slack",
-  "version": "0.6.6",
+  "version": "0.6.7",
   "description": "Pipedream Slack Components",
   "main": "slack.app.mjs",
   "keywords": [
diff --git a/components/slack_bot/actions/add-emoji-reaction/add-emoji-reaction.mjs b/components/slack_bot/actions/add-emoji-reaction/add-emoji-reaction.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-add-emoji-reaction",
   description: "Add an emoji reaction to a message. [See the documentation](https://api.slack.com/methods/reactions.add)",
-  version: "0.0.1",
+  version: "0.0.2",
 };
diff --git a/components/slack_bot/actions/archive-channel/archive-channel.mjs b/components/slack_bot/actions/archive-channel/archive-channel.mjs
@@ -27,5 +27,5 @@ export default {
   }),
   key: "slack_bot-archive-channel",
   description: "Archive a channel (Bot). [See the documentation](https://api.slack.com/methods/conversations.archive)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/create-channel/create-channel.mjs b/components/slack_bot/actions/create-channel/create-channel.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-create-channel",
   description: "Create a new channel (Bot). [See the documentation](https://api.slack.com/methods/conversations.create)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/delete-file/delete-file.mjs b/components/slack_bot/actions/delete-file/delete-file.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-delete-file",
   description: "Delete a file (Bot). [See the documentation](https://api.slack.com/methods/files.delete)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/delete-message/delete-message.mjs b/components/slack_bot/actions/delete-message/delete-message.mjs
@@ -14,5 +14,5 @@ export default {
   }),
   key: "slack_bot-delete-message",
   description: "Delete a message (Bot). [See the documentation](https://api.slack.com/methods/chat.delete)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/find-user-by-email/find-user-by-email.mjs b/components/slack_bot/actions/find-user-by-email/find-user-by-email.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-find-user-by-email",
   description: "Find a user by matching against their email (Bot). [See the documentation](https://api.slack.com/methods/users.lookupByEmail)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/get-file/get-file.mjs b/components/slack_bot/actions/get-file/get-file.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-get-file",
   description: "Return information about a file (Bot). [See the documentation](https://api.slack.com/methods/files.info)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/invite-user-to-channel/invite-user-to-channel.mjs b/components/slack_bot/actions/invite-user-to-channel/invite-user-to-channel.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-invite-user-to-channel",
   description: "Invite a user to an existing channel (Bot). [See the documentation](https://api.slack.com/methods/conversations.invite)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/list-channels/list-channels.mjs b/components/slack_bot/actions/list-channels/list-channels.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-list-channels",
   description: "Return a list of all channels in a workspace (Bot). [See the documentation](https://api.slack.com/methods/conversations.list)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/list-files/list-files.mjs b/components/slack_bot/actions/list-files/list-files.mjs
@@ -30,5 +30,5 @@ export default {
   }),
   key: "slack_bot-list-files",
   description: "Return a list of files within a team (Bot). [See the documentation](https://api.slack.com/methods/files.list)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/list-group-members/list-group-members.mjs b/components/slack_bot/actions/list-group-members/list-group-members.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-list-group-members",
   description: "List all users in a User Group (Bot). [See the documentation](https://api.slack.com/methods/usergroups.users.list)",
-  version: "0.0.1",
+  version: "0.0.2",
 };
diff --git a/components/slack_bot/actions/list-members-in-channel/list-members-in-channel.mjs b/components/slack_bot/actions/list-members-in-channel/list-members-in-channel.mjs
@@ -30,5 +30,5 @@ export default {
   }),
   key: "slack_bot-list-members-in-channel",
   description: "Retrieve members of a channel (Bot). [See the documentation](https://api.slack.com/methods/conversations.members)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/list-replies/list-replies.mjs b/components/slack_bot/actions/list-replies/list-replies.mjs
@@ -39,5 +39,5 @@ export default {
   }),
   key: "slack_bot-list-replies",
   description: "Retrieve a thread of messages posted to a conversation (Bot). [See the documentation](https://api.slack.com/methods/conversations.replies)",
-  version: "0.0.4",
+  version: "0.0.5",
 };
diff --git a/components/slack_bot/actions/list-users/list-users.mjs b/components/slack_bot/actions/list-users/list-users.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-list-users",
   description: "Return a list of all users in a workspace (Bot). [See the documentation](https://api.slack.com/methods/users.list)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/reply-to-a-message/reply-to-a-message.mjs b/components/slack_bot/actions/reply-to-a-message/reply-to-a-message.mjs
@@ -14,5 +14,5 @@ export default {
   }),
   key: "slack_bot-reply-to-a-message",
   description: "Send a message as a threaded reply (Bot). See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.0.4",
+  version: "0.0.5",
 };
diff --git a/components/slack_bot/actions/send-large-message/send-large-message.mjs b/components/slack_bot/actions/send-large-message/send-large-message.mjs
@@ -14,5 +14,5 @@ export default {
   }),
   key: "slack_bot-send-large-message",
   description: "Send a large message (more than 3000 characters) to a channel, group or user (Bot). See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.0.4",
+  version: "0.0.5",
 };
diff --git a/components/slack_bot/actions/send-message-advanced/send-message-advanced.mjs b/components/slack_bot/actions/send-message-advanced/send-message-advanced.mjs
@@ -14,5 +14,5 @@ export default {
   }),
   key: "slack_bot-send-message-advanced",
   description: "Customize advanced setttings and send a message to a channel, group or user (Bot). See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.0.4",
+  version: "0.0.5",
 };
diff --git a/components/slack_bot/actions/send-message/send-message.mjs b/components/slack_bot/actions/send-message/send-message.mjs
@@ -14,5 +14,5 @@ export default {
   }),
   key: "slack_bot-send-message",
   description: "Send a message to a user, group, private channel or public channel (Bot). See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/set-channel-description/set-channel-description.mjs b/components/slack_bot/actions/set-channel-description/set-channel-description.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-set-channel-description",
   description: "Change the description or purpose of a channel (Bot). [See the documentation](https://api.slack.com/methods/conversations.setPurpose)",
-  version: "0.0.1",
+  version: "0.0.2",
 };
diff --git a/components/slack_bot/actions/set-channel-topic/set-channel-topic.mjs b/components/slack_bot/actions/set-channel-topic/set-channel-topic.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-set-channel-topic",
   description: "Set the topic on a selected channel (Bot). [See the documentation](https://api.slack.com/methods/conversations.setTopic)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/update-group-members/update-group-members.mjs b/components/slack_bot/actions/update-group-members/update-group-members.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-update-group-members",
   description: "Update the list of users for a User Group (Bot). [See docs here](https://api.slack.com/methods/usergroups.users.update)",
-  version: "0.0.1",
+  version: "0.0.2",
 };
diff --git a/components/slack_bot/actions/update-message/update-message.mjs b/components/slack_bot/actions/update-message/update-message.mjs
@@ -14,5 +14,5 @@ export default {
   }),
   key: "slack_bot-update-message",
   description: "Update a message (Bot). [See the documentation](https://api.slack.com/methods/chat.update)",
-  version: "0.0.3",
+  version: "0.0.4",
 };
diff --git a/components/slack_bot/actions/upload-file/upload-file.mjs b/components/slack_bot/actions/upload-file/upload-file.mjs
@@ -11,5 +11,5 @@ export default {
   }),
   key: "slack_bot-upload-file",
   description: "Upload a file (Bot). [See the documentation](https://api.slack.com/methods/files.upload)",
-  version: "0.0.4",
+  version: "0.0.5",
 };
diff --git a/components/slack_bot/common/utils.mjs b/components/slack_bot/common/utils.mjs
@@ -1,5 +1,7 @@
 import app from "../slack_bot.app.mjs";
 
+const CONVERSATION_PERMISSION_MESSAGE = "In order to list a Slack channel, **your bot must be a member of that channel**, and in order to list private channels, your bot must have the `groups:read` scope in the `OAuth & Permissions` settings in Slack for this bot.";
+
 async function streamIterator(stream) {
   let resources = [];
   for await (const resource of stream) {
@@ -23,6 +25,12 @@ function buildPropDefinitions({
         };
       }
 
+      if (key === "conversation") {
+        prop.description = prop.description
+          ? `${prop.description} ${CONVERSATION_PERMISSION_MESSAGE}`
+          : `Select a public or private channel, or a user or group. ${CONVERSATION_PERMISSION_MESSAGE}`;
+      }
+
       const [
         , ...propDefinitionItems
       ] = prop.propDefinition;
@@ -87,4 +95,5 @@ function buildAppProps({
 export default {
   streamIterator,
   buildAppProps,
+  CONVERSATION_PERMISSION_MESSAGE,
 };
diff --git a/components/slack_bot/package.json b/components/slack_bot/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/slack_bot",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "Pipedream Slack_bot Components",
   "main": "slack_bot.app.mjs",
   "keywords": [
diff --git a/components/slack_bot/sources/new-direct-message/new-direct-message.mjs b/components/slack_bot/sources/new-direct-message/new-direct-message.mjs
@@ -1,11 +1,12 @@
 import common from "../common/base.mjs";
 import constants from "../../common/constants.mjs";
+import utils from "../../common/utils.mjs";
 
 export default {
   ...common,
   key: "slack_bot-new-direct-message",
   name: "New Direct Message",
-  version: "0.0.3",
+  version: "0.0.4",
   description: "Emit new event when a message is posted in a direct message channel (Bot). To open a conversation, use the Pipedream Action \"Send a Direct Message\" to send a message from the Bot, or enable direct messages to the Bot in your App Settings (Settings->App Home->Show Tabs->Messages Tab), and send a direct message to the Bot.",
   type: "source",
   dedupe: "unique",
@@ -22,7 +23,7 @@ export default {
         }),
       ],
       label: "User Channel",
-      description: "Events will only be emitted for direct messages between this user and the Bot.",
+      description: `Events will only be emitted for direct messages between this user and the Bot. ${utils.CONVERSATION_PERMISSION_MESSAGE}`,
     },
   },
   methods: {
diff --git a/components/slack_bot/sources/new-message-in-channel/new-message-in-channel.mjs b/components/slack_bot/sources/new-message-in-channel/new-message-in-channel.mjs
@@ -1,11 +1,12 @@
 import common from "../common/base.mjs";
 import constants from "../../common/constants.mjs";
+import utils from "../../common/utils.mjs";
 
 export default {
   ...common,
   key: "slack_bot-new-message-in-channel",
   name: "New Message In Channel",
-  version: "0.0.3",
+  version: "0.0.4",
   description: "Emit new event when a new message is posted to a public, private or group channel (Bot)",
   type: "source",
   dedupe: "unique",
@@ -23,6 +24,7 @@ export default {
           ],
         }),
       ],
+      description: `Select the channel's ID. ${utils.CONVERSATION_PERMISSION_MESSAGE}`,
     },
   },
   methods: {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@pipedream/slack",`
`3`		`- "version": "0.6.6",`
	`3`	`+ "version": "0.6.7",`
`4`	`4`	`"description": "Pipedream Slack Components",`
`5`	`5`	`"main": "slack.app.mjs",`
`6`	`6`	`"keywords": [`