@pipedream/slack 0.5.2 → 0.6.0

package/actions/list-replies/list-replies.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-list-replies",
   name: "List Replies",
-  description: "Retrieve a thread of messages posted to a conversation. [See docs here](https://api.slack.com/methods/conversations.replies)",
-  version: "0.0.15",
+  description: "Retrieve a thread of messages posted to a conversation. [See the documentation](https://api.slack.com/methods/conversations.replies)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -17,14 +17,21 @@ export default {
     timestamp: {
       propDefinition: [
         slack,
-        "timestamp",
+        "messageTs",
+        (c) => ({
+          channel: c.conversation,
+        }),
       ],
     },
   },
-  async run() {
-    return await this.slack.sdk().conversations.replies({
+  async run({ $ }) {
+    const response = await this.slack.sdk().conversations.replies({
       channel: this.conversation,
       ts: this.timestamp,
     });
+    $.export("$summary", `Successfully retrieved ${response.messages.length} reply message${response.messages.length === 1
+      ? ""
+      : "s"}`);
+    return response;
   },
 };

package/actions/list-users/list-users.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-list-users",
   name: "List Users",
-  description: "Return a list of all users in a workspace. [See docs here](https://api.slack.com/methods/users.list)",
-  version: "0.0.15",
+  description: "Return a list of all users in a workspace. [See the documentation](https://api.slack.com/methods/users.list)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -16,9 +16,13 @@ export default {
       optional: true,
     },
   },
-  async run() {
-    return this.slack.usersList({
+  async run({ $ }) {
+    const response = await this.slack.usersList({
       team_id: this.teamId,
     });
+    $.export("$summary", `Successfully retrieved ${response.members.length} user${response.members.length === 1
+      ? ""
+      : "s"}`);
+    return response;
   },
 };

package/actions/reply-to-a-message/reply-to-a-message.mjs

@@ -6,36 +6,36 @@ export default {
   key: "slack-reply-to-a-message",
   name: "Reply to a Message Thread",
   description: "Send a message as a threaded reply. See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.1.20",
+  version: "0.1.21",
   type: "action",
   props: {
     slack: common.props.slack,
-    thread_ts: {
+    conversation: {
       propDefinition: [
         slack,
-        "thread_ts",
+        "conversation",
       ],
-      optional: false,
     },
-    reply_broadcast: {
+    thread_ts: {
       propDefinition: [
         slack,
-        "reply_broadcast",
+        "messageTs",
+        (c) => ({
+          channel: c.conversation,
+        }),
       ],
     },
-    conversation: {
+    reply_broadcast: {
       propDefinition: [
         slack,
-        "conversation",
+        "reply_broadcast",
       ],
-      optional: false,
     },
     text: {
       propDefinition: [
         slack,
         "text",
       ],
-      optional: false,
     },
     mrkdwn: {
       propDefinition: [

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

@@ -1,11 +1,13 @@
 import common from "../common/send-message.mjs";
+import buildBlocks from "../common/build-blocks.mjs";
 
 export default {
   ...common,
+  ...buildBlocks,
   key: "slack-send-custom-message",
   name: "Send a Custom Message",
   description: "Customize advanced setttings and send a message to a channel, group or user. See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.2.19",
+  version: "0.2.20",
   type: "action",
   props: {
     slack: common.props.slack,
@@ -20,6 +22,7 @@ export default {
         common.props.slack,
         "text",
       ],
+      description: "If you're using `blocks`, this is used as a fallback string to display in notifications. If you aren't, this is the main body text of the message. It can be formatted as plain text, or with mrkdwn.",
     },
     mrkdwn: {
       propDefinition: [
@@ -39,12 +42,6 @@ export default {
         "parse",
       ],
     },
-    blocks: {
-      propDefinition: [
-        common.props.slack,
-        "blocks",
-      ],
-    },
     link_names: {
       propDefinition: [
         common.props.slack,
@@ -60,9 +57,31 @@ export default {
     thread_ts: {
       propDefinition: [
         common.props.slack,
-        "thread_ts",
+        "messageTs",
+        (c) => ({
+          channel: c.conversation,
+        }),
       ],
+      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,
     },
     ...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({ $ }) {
+    if (this.passArrayOrConfigure) {
+      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-large-message/send-large-message.mjs

@@ -5,7 +5,7 @@ export default {
   key: "slack-send-large-message",
   name: "Send a Large Message (3000+ characters)",
   description: "Send a large message (more than 3000 characters) to a channel, group or user. See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.0.15",
+  version: "0.0.16",
   type: "action",
   props: {
     slack: common.props.slack,
@@ -29,7 +29,7 @@ export default {
     },
     ...common.props,
   },
-  async run() {
+  async run({ $ }) {
     if (this.include_sent_via_pipedream_flag) {
       const sentViaPipedreamText = this._makeSentViaPipedreamBlock();
       this.text += `\n\n\n${sentViaPipedreamText.elements[0].text}`;
@@ -61,11 +61,15 @@ export default {
       metadata: this.metadata || null,
     };
 
+    let response;
     if (this.post_at) {
       obj.post_at = this.post_at;
-      return this.slack.sdk().chat.scheduleMessage(obj);
+      response = await this.slack.sdk().chat.scheduleMessage(obj);
     }
 
-    return this.slack.sdk().chat.postMessage(obj);
+    response = await this.slack.sdk().chat.postMessage(obj);
+
+    $.export("$summary", "Successfully sent a message to channel ID " + this.conversation);
+    return response;
   },
 };

package/actions/{send-message-private-channel/send-message-private-channel.mjs → send-message/send-message.mjs}

@@ -1,22 +1,28 @@
-import constants from "../../common/constants.mjs";
 import common from "../common/send-message.mjs";
+import constants from "../../common/constants.mjs";
 
 export default {
   ...common,
-  key: "slack-send-message-private-channel",
-  name: "Send Message to a Private Channel",
-  description: "Send a message to a private channel and customize the name and avatar of the bot that posts the message. See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.2.20",
+  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.1",
   type: "action",
   props: {
     slack: common.props.slack,
+    channelType: {
+      type: "string",
+      label: "Channel Type",
+      description: "The type of channel to send to. User/Direct Message (im), Group (mpim), Private Channel or Public Channel",
+      options: Object.values(constants.CHANNEL_TYPE),
+    },
     conversation: {
       propDefinition: [
         common.props.slack,
         "channelId",
-        () => ({
+        (c) => ({
           types: [
-            constants.CHANNEL_TYPE.PRIVATE,
+            c.channelType,
           ],
         }),
       ],

package/actions/set-channel-description/set-channel-description.mjs

@@ -0,0 +1,32 @@
+import slack from "../../slack.app.mjs";
+
+export default {
+  key: "slack-set-channel-description",
+  name: "Set Channel Description",
+  description: "Change the description or purpose of a channel. [See the documentation](https://api.slack.com/methods/conversations.setPurpose)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+    purpose: {
+      propDefinition: [
+        slack,
+        "purpose",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.slack.sdk().conversations.setPurpose({
+      channel: this.conversation,
+      purpose: this.purpose,
+    });
+    $.export("$summary", `Successfully set description for channel with ID ${this.conversation}`);
+    return response;
+  },
+};

package/actions/set-channel-topic/set-channel-topic.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-set-channel-topic",
   name: "Set Channel Topic",
-  description: "Set the topic on a selected channel. [See docs here](https://api.slack.com/methods/conversations.setTopic)",
-  version: "0.0.15",
+  description: "Set the topic on a selected channel. [See the documentation](https://api.slack.com/methods/conversations.setTopic)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
@@ -21,10 +21,12 @@ export default {
       ],
     },
   },
-  async run() {
-    return await this.slack.sdk().conversations.setTopic({
+  async run({ $ }) {
+    const response = await this.slack.sdk().conversations.setTopic({
       channel: this.conversation,
       topic: this.topic,
     });
+    $.export("$summary", `Successfully set topic for channel with ID ${this.conversation}`);
+    return response;
   },
 };

package/actions/set-status/set-status.mjs

@@ -0,0 +1,44 @@
+import slack from "../../slack.app.mjs";
+
+export default {
+  key: "slack-set-status",
+  name: "Set Status",
+  description: "Set the current status for a user. [See the documentation](https://api.slack.com/methods/users.profile.set)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    slack,
+    statusText: {
+      type: "string",
+      label: "Status Text",
+      description: "The displayed text",
+    },
+    statusEmoji: {
+      propDefinition: [
+        slack,
+        "icon_emoji",
+      ],
+      label: "Status Emoji",
+      description: "The emoji to display with the status",
+      optional: true,
+    },
+    statusExpiration: {
+      type: "string",
+      label: "Status Expiration",
+      description: "The datetime of when the status will expire in ISO 8601 format. (Example: `2014-01-01T00:00:00Z`)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.slack.sdk().users.profile.set({
+      profile: {
+        status_text: this.statusText,
+        status_emoji: this.statusEmoji && `:${this.statusEmoji}:`,
+        status_expiration: this.statusExpiration
+          && Math.floor(new Date(this.statusExpiration).getTime() / 1000),
+      },
+    });
+    $.export("$summary", "Successfully updated status.");
+    return response;
+  },
+};

package/actions/update-group-members/update-group-members.mjs

@@ -0,0 +1,67 @@
+import slack from "../../slack.app.mjs";
+
+export default {
+  key: "slack-update-group-members",
+  name: "Update Groups Members",
+  description: "Update the list of users for a User Group. [See the documentation](https://api.slack.com/methods/usergroups.users.update)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    slack,
+    userGroup: {
+      propDefinition: [
+        slack,
+        "userGroup",
+      ],
+    },
+    usersToAdd: {
+      propDefinition: [
+        slack,
+        "user",
+      ],
+      type: "string[]",
+      label: "Users to Add",
+      description: "A list of encoded user IDs that represent the users to add to the group.",
+      optional: true,
+    },
+    usersToRemove: {
+      propDefinition: [
+        slack,
+        "user",
+      ],
+      type: "string[]",
+      label: "Users to Remove",
+      description: "A list of encoded user IDs that represent the users to remove from the group.",
+      optional: true,
+    },
+    team: {
+      propDefinition: [
+        slack,
+        "team",
+      ],
+      optional: true,
+      description: "Encoded team id where the user group exists, required if org token is used.",
+    },
+  },
+  async run({ $ }) {
+    const {
+      userGroup,
+      usersToAdd,
+      usersToRemove,
+      team,
+    } = this;
+    let { users } = await this.slack.sdk().usergroups.users.list({
+      usergroup: userGroup,
+      team_id: team,
+    });
+    users = users.filter((user) => !usersToRemove.includes(user));
+    users.push(...usersToAdd);
+    const response = await this.slack.sdk().usergroups.users.update({
+      usergroup: userGroup,
+      users,
+      team_id: team,
+    });
+    $.export("$summary", `Successfully updated members of group with ID ${this.userGroup}`);
+    return response;
+  },
+};

package/actions/update-message/update-message.mjs

@@ -3,8 +3,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-update-message",
   name: "Update Message",
-  description: "Update a message. [See docs here](https://api.slack.com/methods/chat.update)",
-  version: "0.1.15",
+  description: "Update a message. [See the documentation](https://api.slack.com/methods/chat.update)",
+  version: "0.1.16",
   type: "action",
   props: {
     slack,
@@ -17,7 +17,10 @@ export default {
     timestamp: {
       propDefinition: [
         slack,
-        "timestamp",
+        "messageTs",
+        (c) => ({
+          channel: c.conversation,
+        }),
       ],
     },
     text: {
@@ -40,13 +43,15 @@ export default {
       ],
     },
   },
-  async run() {
-    return await this.slack.sdk().chat.update({
+  async run({ $ }) {
+    const response = await this.slack.sdk().chat.update({
       ts: this.timestamp,
       text: this.text,
       channel: this.conversation,
       as_user: this.as_user,
       attachments: this.attachments,
     });
+    $.export("$summary", "Successfully updated message");
+    return response;
   },
 };

package/actions/update-profile/update-profile.mjs

@@ -1,30 +1,87 @@
 import slack from "../../slack.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
 
 export default {
   key: "slack-update-profile",
   name: "Update Profile",
-  description: "Update basic profile field such as name or title. [See docs here](https://api.slack.com/methods/users.profile.set)",
-  version: "0.0.15",
+  description: "Update basic profile field such as name or title. [See the documentation](https://api.slack.com/methods/users.profile.set)",
+  version: "0.0.16",
   type: "action",
   props: {
     slack,
-    name: {
-      propDefinition: [
-        slack,
-        "name",
-      ],
+    displayName: {
+      type: "string",
+      label: "Display Name",
+      description: "The display name the user has chosen to identify themselves by in their workspace profile",
+      optional: true,
+    },
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "The user's first name",
+      optional: true,
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "The user's last name",
+      optional: true,
+    },
+    phone: {
+      type: "string",
+      label: "Phone",
+      description: "The user's phone number, in any format",
+      optional: true,
+    },
+    pronouns: {
+      type: "string",
+      label: "Pronouns",
+      description: "The user's pronouns",
+      optional: true,
+    },
+    title: {
+      type: "string",
+      label: "Title",
+      description: "The user's title",
+      optional: true,
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The user's email address. You cannot update your own email using this method. This field can only be changed by admins for users on paid teams.",
+      optional: true,
     },
-    value: {
+    user: {
       propDefinition: [
         slack,
-        "value",
+        "user",
       ],
+      description: "ID of user to change. This argument may only be specified by admins on paid teams.",
+      optional: true,
     },
   },
-  async run() {
-    return await this.slack.sdk().users.profile.set({
-      name: this.name,
-      value: this.value,
+  async run({ $ }) {
+    if (!this.displayName
+      && !this.firstName
+      && !this.lastName
+      && !this.phone
+      && !this.pronouns
+      && !this.title
+    ) {
+      throw new ConfigurationError("Please provide at least one value to update");
+    }
+    const response = await this.slack.sdk().users.profile.set({
+      profile: {
+        display_name: this.displayName,
+        first_name: this.firstName,
+        last_name: this.lastName,
+        phone: this.phone,
+        pronouns: this.pronouns,
+        title: this.title,
+      },
+      user: this.user,
     });
+    $.export("$summary", "Successfully updated profile");
+    return response;
   },
 };

package/actions/upload-file/upload-file.mjs

@@ -5,8 +5,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-upload-file",
   name: "Upload File",
-  description: "Upload a file. [See docs here](https://api.slack.com/methods/files.upload)",
-  version: "0.0.18",
+  description: "Upload a file. [See the documentation](https://api.slack.com/methods/files.upload)",
+  version: "0.0.19",
   type: "action",
   props: {
     slack,
@@ -32,15 +32,17 @@ export default {
       optional: true,
     },
   },
-  async run() {
+  async run({ $ }) {
     if (!fs.existsSync(this.content)) {
       throw new ConfigurationError(`\`${this.content}\` not found, is needed a valid \`/tmp\` path`);
     }
 
-    return await this.slack.sdk().files.upload({
+    const response = await this.slack.sdk().files.upload({
       file: fs.createReadStream(this.content),
       channels: this.conversation,
       initial_comment: this.initialComment,
     });
+    $.export("$summary", "Successfully uploaded file");
+    return response;
   },
 };

package/actions/verify-slack-signature/verify-slack-signature.mjs

@@ -4,8 +4,8 @@ import slack from "../../slack.app.mjs";
 export default {
   key: "slack-verify-slack-signature",
   name: "Verify Slack Signature",
-  description: "Verifying requests from Slack, slack signs its requests using a secret that's unique to your app. [See docs here](https://api.slack.com/authentication/verifying-requests-from-slack)",
-  version: "0.0.8",
+  description: "Verifying requests from Slack, slack signs its requests using a secret that's unique to your app. [See the documentation](https://api.slack.com/authentication/verifying-requests-from-slack)",
+  version: "0.0.9",
   type: "action",
   props: {
     slack,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/slack",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "Pipedream Slack Components",
   "main": "slack.app.mjs",
   "keywords": [
@@ -14,6 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@slack/web-api": "^5.15.0"
+    "@pipedream/platform": "^2.0.0",
+    "@slack/web-api": "^7.0.4"
   }
 }