@pipedream/slack 0.5.2 → 0.6.0

package/actions/add-emoji-reaction/add-emoji-reaction.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-add-emoji-reaction",
   name: "Add Emoji Reaction",
-  description: "Add an emoji reaction to a message. [See docs here](https://api.slack.com/methods/reactions.add)",
-  version: "0.0.7",
+  description: "Add an emoji reaction to a message. [See the documentation](https://api.slack.com/methods/reactions.add)",
+  version: "0.0.8",
   type: "action",
   props: {
     slack,
@@ -13,15 +13,16 @@ export default {
         slack,
         "conversation",
       ],
-      optional: false,
-      description: "Channel to add reaction to, or channel where the message to add reaction to was posted (used with timestamp).",
+      description: "Channel where the message to add reaction to was posted.",
     },
     timestamp: {
       propDefinition: [
         slack,
-        "timestamp",
+        "messageTs",
+        (c) => ({
+          channel: c.conversation,
+        }),
       ],
-      optional: false,
       description: "Timestamp of the message to add reaction to.",
     },
     icon_emoji: {
@@ -33,11 +34,13 @@ export default {
       optional: false,
     },
   },
-  async run() {
-    return await this.slack.sdk().reactions.add({
+  async run({ $ }) {
+    const response = await this.slack.sdk().reactions.add({
       channel: this.conversation,
       timestamp: this.timestamp,
       name: this.icon_emoji,
     });
+    $.export("$summary", `Successfully added ${this.icon_emoji} emoji reaction.`);
+    return response;
   },
 };

package/actions/archive-channel/archive-channel.mjs

@@ -1,10 +1,11 @@
 import slack from "../../slack.app.mjs";
+import constants from "../../common/constants.mjs";
 
 export default {
   key: "slack-archive-channel",
   name: "Archive Channel",
-  description: "Archive a channel. [See docs here](https://api.slack.com/methods/conversations.archive)",
-  version: "0.0.15",
+  description: "Archive a channel. [See the documentation](https://api.slack.com/methods/conversations.archive)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -12,12 +13,21 @@ export default {
       propDefinition: [
         slack,
         "conversation",
+        () => ({
+          types: [
+            constants.CHANNEL_TYPE.PUBLIC,
+            constants.CHANNEL_TYPE.PRIVATE,
+            constants.CHANNEL_TYPE.MPIM,
+          ],
+        }),
       ],
     },
   },
-  async run() {
-    return await this.slack.sdk().conversations.archive({
+  async run({ $ }) {
+    const response = await this.slack.sdk().conversations.archive({
       channel: this.conversation,
     });
+    $.export("$summary", "Successfully archived channel.");
+    return response;
   },
 };

package/actions/common/build-blocks.mjs

@@ -1,13 +1,10 @@
 import common from "./send-message.mjs";
 
-/* eslint-disable pipedream/required-properties-key, pipedream/required-properties-name,
-  pipedream/required-properties-version, pipedream/required-properties-description */
 export default {
-  type: "action",
   props: {
     passArrayOrConfigure: {
       type: "string",
-      label: "Reference Existing Blocks Array or Configure Manually?",
+      label: "Add Blocks - Reference Existing Blocks Array or Configure Manually?",
       description: "Would you like to reference an array of blocks from a previous step (for example, `{{steps.blocks.$return_value}}`), or configure them in this action?",
       options: [
         {
@@ -19,6 +16,7 @@ export default {
           value: "configure",
         },
       ],
+      optional: true,
       reloadProps: true,
     },
   },
@@ -92,6 +90,9 @@ export default {
     const propsContext = this.createBlockProp("string[]", "Context Block Text", contextDescription);
     const propsLinkButton = this.createBlockProp("object", "Link Button", linkButtonDescription);
 
+    if (!this.passArrayOrConfigure) {
+      return props;
+    }
     if (this.passArrayOrConfigure == "array") {
       props.blocks = {
         type: common.props.slack.propDefinitions.blocks.type,

package/actions/common/send-message.mjs

@@ -1,9 +1,6 @@
 import slack from "../../slack.app.mjs";
 
-/* eslint-disable pipedream/required-properties-key, pipedream/required-properties-name,
-  pipedream/required-properties-version, pipedream/required-properties-description */
 export default {
-  type: "action",
   props: {
     slack,
     as_user: {
@@ -156,27 +153,8 @@ export default {
       metadata: this.metadata || null,
     };
 
-    console.log({
-      text: this.text,
-      channel: this.conversation ?? this.reply_channel,
-      attachments: this.attachments,
-      unfurl_links: this.unfurl_links,
-      unfurl_media: this.unfurl_media,
-      parse: this.parse,
-      as_user: this.as_user,
-      username: this.username,
-      icon_emoji: this.icon_emoji,
-      icon_url: this.icon_url,
-      mrkdwn: this.mrkdwn,
-      blocks,
-      link_names: this.link_names,
-      reply_broadcast: this.reply_broadcast,
-      thread_ts: this.thread_ts,
-      metadata: this.metadata || null,
-    });
-
     if (this.post_at) {
-      obj.post_at = this.post_at;
+      obj.post_at = Math.floor(new Date(this.post_at).getTime() / 1000);
       return await this.slack.sdk().chat.scheduleMessage(obj);
     }
     const resp = await this.slack.sdk().chat.postMessage(obj);

package/actions/create-channel/create-channel.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-create-channel",
   name: "Create a Channel",
-  description: "Create a new channel. [See docs here](https://api.slack.com/methods/conversations.create)",
-  version: "0.0.16",
+  description: "Create a new channel. [See the documentation](https://api.slack.com/methods/conversations.create)",
+  version: "0.0.17",
   type: "action",
   props: {
     slack,
@@ -21,10 +21,15 @@ export default {
       optional: true,
     },
   },
-  async run() {
-    return await this.slack.sdk().conversations.create({
-      name: this.channelName,
+  async run({ $ }) {
+    // parse name
+    const name = this.channelName.replace(/\s+/g, "-").toLowerCase();
+
+    const response = await this.slack.sdk().conversations.create({
+      name,
       is_private: this.isPrivate,
     });
+    $.export("$summary", `Successfully created channel ${this.channelName}`);
+    return response;
   },
 };

package/actions/create-reminder/create-reminder.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-create-reminder",
   name: "Create Reminder",
-  description: "Create a reminder. [See docs here](https://api.slack.com/methods/reminders.add)",
-  version: "0.0.16",
+  description: "Create a reminder. [See the documentation](https://api.slack.com/methods/reminders.add)",
+  version: "0.0.17",
   type: "action",
   props: {
     slack,
@@ -15,10 +15,8 @@ export default {
       ],
     },
     timestamp: {
-      propDefinition: [
-        slack,
-        "timestamp",
-      ],
+      type: "string",
+      label: "Timestamp",
       description: "When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. in 15 minutes, or every Thursday)",
     },
     team_id: {
@@ -36,12 +34,14 @@ export default {
       optional: true,
     },
   },
-  async run() {
-    return await this.slack.sdk().reminders.add({
+  async run({ $ }) {
+    const response = await this.slack.sdk().reminders.add({
       text: this.text,
       team_id: this.team_id,
       time: this.timestamp,
       user: this.user,
     });
+    $.export("$summary", `Successfully created reminder with ID ${response.reminder.id}`);
+    return response;
   },
 };

package/actions/delete-file/delete-file.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-delete-file",
   name: "Delete File",
-  description: "Delete a file. [See docs here](https://api.slack.com/methods/files.delete)",
-  version: "0.0.15",
+  description: "Delete a file. [See the documentation](https://api.slack.com/methods/files.delete)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -15,9 +15,11 @@ export default {
       ],
     },
   },
-  async run() {
-    return await this.slack.sdk().files.delete({
+  async run({ $ }) {
+    const response = await this.slack.sdk().files.delete({
       file: this.file,
     });
+    $.export("$summary", `Successfully deleted file with ID ${this.file}`);
+    return response;
   },
 };

package/actions/delete-message/delete-message.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-delete-message",
   name: "Delete Message",
-  description: "Delete a message. [See docs here](https://api.slack.com/methods/chat.delete)",
-  version: "0.0.15",
+  description: "Delete a message. [See the documentation](https://api.slack.com/methods/chat.delete)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -17,7 +17,10 @@ export default {
     timestamp: {
       propDefinition: [
         slack,
-        "timestamp",
+        "messageTs",
+        (c) => ({
+          channel: c.conversation,
+        }),
       ],
     },
     as_user: {
@@ -28,11 +31,13 @@ export default {
       description: "Pass true to update the message as the authed user. Bot users in this context are considered authed users.",
     },
   },
-  async run() {
-    return await this.slack.sdk().chat.delete({
+  async run({ $ }) {
+    const response = await this.slack.sdk().chat.delete({
       channel: this.conversation,
       ts: this.timestamp,
       as_user: this.as_user,
     });
+    $.export("$summary", "Successfully deleted message.");
+    return response;
   },
 };

package/actions/find-message/find-message.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-find-message",
   name: "Find Message",
-  description: "Find a Slack message. [See docs here](https://api.slack.com/methods/search.messages)",
-  version: "0.0.15",
+  description: "Find a Slack message. [See the documentation](https://api.slack.com/methods/search.messages)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -14,13 +14,6 @@ export default {
         "query",
       ],
     },
-    count: {
-      propDefinition: [
-        slack,
-        "count",
-      ],
-      optional: true,
-    },
     teamId: {
       propDefinition: [
         slack,
@@ -29,11 +22,26 @@ export default {
       optional: true,
     },
   },
-  async run() {
-    return this.slack.searchMessages({
+  async run({ $ }) {
+    const matches = [];
+    const params = {
       query: this.query,
-      count: this.count,
       team_id: this.teamId,
-    });
+      page: 1,
+    };
+    let hasMore;
+
+    do {
+      const { messages } = await this.slack.searchMessages(params);
+      matches.push(...messages.matches);
+      hasMore = messages?.length;
+      params.page++;
+    } while (hasMore);
+
+    $.export("$summary", `Found ${matches.length} matching message${matches.length === 1
+      ? ""
+      : "s"}`);
+
+    return matches;
   },
 };

package/actions/find-user-by-email/find-user-by-email.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-find-user-by-email",
   name: "Find User by Email",
-  description: "Find a user by matching against their email. [See docs here](https://api.slack.com/methods/users.lookupByEmail)",
-  version: "0.0.15",
+  description: "Find a user by matching against their email. [See the documentation](https://api.slack.com/methods/users.lookupByEmail)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -15,9 +15,13 @@ export default {
       ],
     },
   },
-  async run() {
-    return await this.slack.sdk().users.lookupByEmail({
+  async run({ $ }) {
+    const response = await this.slack.sdk().users.lookupByEmail({
       email: this.email,
     });
+    if (response.ok) {
+      $.export("$summary", `Successfully found user with ID ${response.user.id}`);
+    }
+    return response;
   },
 };

package/actions/get-file/get-file.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-get-file",
   name: "Get File",
-  description: "Return information about a file. [See docs here](https://api.slack.com/methods/files.info)",
-  version: "0.0.15",
+  description: "Return information about a file. [See the documentation](https://api.slack.com/methods/files.info)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -14,17 +14,12 @@ export default {
         "file",
       ],
     },
-    count: {
-      propDefinition: [
-        slack,
-        "count",
-      ],
-    },
   },
-  async run() {
-    return await this.slack.sdk().files.info({
+  async run({ $ }) {
+    const response = await this.slack.sdk().files.info({
       file: this.file,
-      count: this.count,
     });
+    $.export("$summary", `Successfully retrieved file with ID ${this.file}`);
+    return response;
   },
 };

package/actions/invite-user-to-channel/invite-user-to-channel.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-invite-user-to-channel",
   name: "Invite User to Channel",
-  description: "Invite a user to an existing channel. [See docs here](https://api.slack.com/methods/conversations.invite)",
-  version: "0.0.15",
+  description: "Invite a user to an existing channel. [See the documentation](https://api.slack.com/methods/conversations.invite)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -21,10 +21,12 @@ export default {
       ],
     },
   },
-  async run() {
-    return await this.slack.sdk().conversations.invite({
+  async run({ $ }) {
+    const response = await this.slack.sdk().conversations.invite({
       channel: this.conversation,
       users: this.user,
     });
+    $.export("$summary", `Successfully invited user ${this.user} to channel with ID ${this.conversation}`);
+    return response;
   },
 };

package/actions/kick-user/kick-user.mjs

@@ -1,10 +1,11 @@
 import slack from "../../slack.app.mjs";
+import constants from "../../common/constants.mjs";
 
 export default {
   key: "slack-kick-user",
   name: "Kick User",
-  description: "Remove a user from a conversation. [See docs here](https://api.slack.com/methods/conversations.kick)",
-  version: "0.0.15",
+  description: "Remove a user from a conversation. [See the documentation](https://api.slack.com/methods/conversations.kick)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -12,19 +13,31 @@ export default {
       propDefinition: [
         slack,
         "conversation",
+        () => ({
+          types: [
+            constants.CHANNEL_TYPE.PUBLIC,
+            constants.CHANNEL_TYPE.PRIVATE,
+            constants.CHANNEL_TYPE.MPIM,
+          ],
+        }),
       ],
     },
     user: {
       propDefinition: [
         slack,
         "user",
+        (c) => ({
+          channelId: c.conversation,
+        }),
       ],
     },
   },
-  async run() {
-    return await this.slack.sdk().conversations.kick({
+  async run({ $ }) {
+    const response = await this.slack.sdk().conversations.kick({
       channel: this.conversation,
       user: this.user,
     });
+    $.export("$summary", `Successfully kicked user ${this.user} from channel with ID ${this.conversation}`);
+    return response;
   },
 };

package/actions/list-channels/list-channels.mjs

@@ -3,13 +3,17 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-list-channels",
   name: "List Channels",
-  description: "Return a list of all channels in a workspace. [See docs here](https://api.slack.com/methods/conversations.list)",
-  version: "0.0.15",
+  description: "Return a list of all channels in a workspace. [See the documentation](https://api.slack.com/methods/conversations.list)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
   },
-  async run() {
-    return await this.slack.sdk().conversations.list();
+  async run({ $ }) {
+    const response = await this.slack.sdk().conversations.list();
+    $.export("$summary", `Successfully found ${response.length} channel${response.length === 1
+      ? ""
+      : "s"}`);
+    return response;
   },
 };

package/actions/list-files/list-files.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-list-files",
   name: "List Files",
-  description: "Return a list of files within a team. [See docs here](https://api.slack.com/methods/files.list)",
-  version: "0.0.43",
+  description: "Return a list of files within a team. [See the documentation](https://api.slack.com/methods/files.list)",
+  version: "0.0.44",
   type: "action",
   props: {
     slack,
@@ -14,13 +14,6 @@ export default {
         "conversation",
       ],
     },
-    count: {
-      propDefinition: [
-        slack,
-        "count",
-      ],
-      optional: true,
-    },
     team_id: {
       propDefinition: [
         slack,
@@ -36,12 +29,27 @@ export default {
       optional: true,
     },
   },
-  async run() {
-    return await this.slack.sdk().files.list({
+  async run({ $ }) {
+    const allFiles = [];
+    const params = {
       channel: this.conversation,
-      count: this.count,
       user: this.user,
       team_id: this.team_id,
-    });
+      page: 1,
+    };
+    let hasMore;
+
+    do {
+      const { files } = await this.slack.sdk().files.list(params);
+      allFiles.push(...files);
+      hasMore = files.length;
+      params.page++;
+    } while (hasMore);
+
+    $.export("$summary", `Successfully retrieved ${allFiles.length} file${allFiles.length === 1
+      ? ""
+      : "s"}`);
+
+    return allFiles;
   },
 };

package/actions/{list-user-groups-users/list-user-groups-users.mjs → list-group-members/list-group-members.mjs}

@@ -1,10 +1,10 @@
 import slack from "../../slack.app.mjs";
 
 export default {
-  key: "slack-list-user-groups-users",
-  name: "List User Groups Users",
-  description: "List all users in a User Group. [See docs here](https://api.slack.com/methods/usergroups.users.list)",
-  version: "0.0.8",
+  key: "slack-list-group-members",
+  name: "List Group Members",
+  description: "List all users in a User Group. [See the documentation](https://api.slack.com/methods/usergroups.users.list)",
+  version: "0.0.1",
   type: "action",
   props: {
     slack,
@@ -23,14 +23,20 @@ export default {
       description: "Encoded team id where the user group exists, required if org token is used.",
     },
   },
-  async run() {
+  async run({ $ }) {
     const {
       userGroup,
       team,
     } = this;
-    return await this.slack.sdk().usergroups.users.list({
+    const response = await this.slack.sdk().usergroups.users.list({
       usergroup: userGroup,
       team_id: team,
     });
+    if (response.users?.length) {
+      $.export("$summary", `Successfully retrieved ${response.users.length} user${response.users.length === 1
+        ? ""
+        : "s"}`);
+    }
+    return response;
   },
 };

package/actions/list-members-in-channel/list-members-in-channel.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-list-members-in-channel",
   name: "List Members in Channel",
-  description: "Retrieve members of a channel. [See docs here](https://api.slack.com/methods/conversations.members)",
-  version: "0.0.15",
+  description: "Retrieve members of a channel. [See the documentation](https://api.slack.com/methods/conversations.members)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -14,10 +14,28 @@ export default {
         "conversation",
       ],
     },
+    returnUsernames: {
+      type: "boolean",
+      label: "Return Usernames",
+      description: "Optionally, return usernames in addition to IDs",
+      optional: true,
+    },
   },
-  async run() {
-    return await this.slack.sdk().conversations.members({
+  async run({ $ }) {
+    const { members } = await this.slack.sdk().conversations.members({
       channel: this.conversation,
     });
+    let channelMembers = members;
+    if (this.returnUsernames) {
+      const usernames = await this.slack.userNames();
+      channelMembers = channelMembers?.map((id) => ({
+        id,
+        username: usernames[id],
+      })) || [];
+    }
+    $.export("$summary", `Successfully retrieved ${channelMembers.length} member${channelMembers.length === 1
+      ? ""
+      : "s"}`);
+    return channelMembers;
   },
 };