@pipedream/slack_v2 0.0.1

package/actions/send-message-to-user-or-group/send-message-to-user-or-group.mjs

@@ -0,0 +1,93 @@
+import common from "../common/send-message.mjs";
+import constants from "../../common/constants.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  ...common,
+  key: "slack_v2-send-message-to-user-or-group",
+  name: "Send Message to User or Group",
+  description: "Send a message to a user or group. [See the documentation](https://api.slack.com/methods/chat.postMessage)",
+  version: "0.1.0",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack: common.props.slack,
+    users: {
+      propDefinition: [
+        common.props.slack,
+        "user",
+      ],
+      type: "string[]",
+      label: "Users",
+      description: "Select the user(s) to message",
+      optional: true,
+    },
+    conversation: {
+      propDefinition: [
+        common.props.slack,
+        "conversation",
+        () => ({
+          types: [
+            constants.CHANNEL_TYPE.MPIM,
+          ],
+        }),
+      ],
+      description: "Select the group to message",
+      optional: true,
+    },
+    text: {
+      propDefinition: [
+        common.props.slack,
+        "text",
+      ],
+    },
+    mrkdwn: {
+      propDefinition: [
+        common.props.slack,
+        "mrkdwn",
+      ],
+    },
+    ...common.props,
+    // eslint-disable-next-line pipedream/props-label
+    as_user: {
+      ...common.props.as_user,
+      description: "Optionally pass `true` to post the message as the authenticated user, instead of as a bot. Defaults to `true`.",
+      // Default to true since bots can't message users unless the "Messages"
+      // tab is enabled, and can't message groups unless the bot is a member.
+      default: true,
+    },
+    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
+    addToChannel: {
+      type: "boolean",
+      ...common.props.addToChannel,
+      disabled: true,
+      hidden: true,
+    },
+  },
+  methods: {
+    ...common.methods,
+    openConversation(args = {}) {
+      return this.slack.makeRequest({
+        method: "conversations.open",
+        ...args,
+      });
+    },
+    async getChannelId() {
+      if (!this.conversation && !this.users?.length) {
+        throw new ConfigurationError("Must select a group or user(s) to message");
+      }
+
+      if (this.conversation) {
+        return this.conversation;
+      }
+      const { channel: { id } } = await this.openConversation({
+        users: this.users.join(),
+      });
+      return id;
+    },
+  },
+};

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

@@ -0,0 +1,37 @@
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-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.10",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+    purpose: {
+      propDefinition: [
+        slack,
+        "purpose",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.slack.setChannelDescription({
+      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

@@ -0,0 +1,37 @@
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-set-channel-topic",
+  name: "Set Channel Topic",
+  description: "Set the topic on a selected channel. [See the documentation](https://api.slack.com/methods/conversations.setTopic)",
+  version: "0.0.25",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+    topic: {
+      propDefinition: [
+        slack,
+        "topic",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.slack.setChannelTopic({
+      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,49 @@
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-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.10",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  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.updateProfile({
+      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,72 @@
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-update-group-members",
+  name: "Update Group 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.10",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  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.listGroupMembers({
+      usergroup: userGroup,
+      team_id: team,
+    });
+    users = users.filter((user) => !usersToRemove.includes(user));
+    users.push(...usersToAdd);
+    const response = await this.slack.updateGroupMembers({
+      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

@@ -0,0 +1,59 @@
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-update-message",
+  name: "Update Message",
+  description: "Update a message. [See the documentation](https://api.slack.com/methods/chat.update)",
+  version: "0.2.0",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+    timestamp: {
+      propDefinition: [
+        slack,
+        "messageTs",
+      ],
+    },
+    text: {
+      propDefinition: [
+        slack,
+        "text",
+      ],
+    },
+    as_user: {
+      propDefinition: [
+        slack,
+        "as_user",
+      ],
+      description: "Pass true to update the message as the authed user. Bot users in this context are considered authed users.",
+    },
+    attachments: {
+      propDefinition: [
+        slack,
+        "attachments",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.slack.updateMessage({
+      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

@@ -0,0 +1,94 @@
+import slack from "../../slack_v2.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "slack_v2-update-profile",
+  name: "Update Profile",
+  description: "Update basic profile field such as name or title. [See the documentation](https://api.slack.com/methods/users.profile.set)",
+  version: "0.0.25",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack,
+    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,
+    },
+    user: {
+      propDefinition: [
+        slack,
+        "user",
+      ],
+      description: "ID of user to change. This argument may only be specified by admins on paid teams.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    if (!this.displayName
+      && !this.firstName
+      && !this.lastName
+      && !this.phone
+      && !this.pronouns
+      && !this.title
+      && !this.email
+    ) {
+      throw new ConfigurationError("Please provide at least one value to update");
+    }
+    const response = await this.slack.updateProfile({
+      profile: {
+        display_name: this.displayName,
+        first_name: this.firstName,
+        last_name: this.lastName,
+        phone: this.phone,
+        pronouns: this.pronouns,
+        title: this.title,
+        email: this.email,
+      },
+      user: this.user,
+    });
+    $.export("$summary", "Successfully updated profile");
+    return response;
+  },
+};

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

@@ -0,0 +1,104 @@
+import {
+  ConfigurationError, axios, getFileStreamAndMetadata,
+} from "@pipedream/platform";
+import FormData from "form-data";
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-upload-file",
+  name: "Upload File",
+  description: "Upload a file. [See the documentation](https://api.slack.com/messaging/files#uploading_files)",
+  version: "0.1.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+    content: {
+      propDefinition: [
+        slack,
+        "content",
+      ],
+    },
+    initialComment: {
+      description: "Will be added as an initial comment before the image",
+      propDefinition: [
+        slack,
+        "initial_comment",
+      ],
+      optional: true,
+    },
+    syncDir: {
+      type: "dir",
+      accessMode: "read",
+      sync: true,
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      stream, metadata,
+    } = await getFileStreamAndMetadata(this.content);
+
+    const filename = this.content.split("/").pop();
+
+    // Get an upload URL from Slack
+    const getUploadUrlResponse = await this.slack.getUploadUrl({
+      filename,
+      length: metadata.size,
+    });
+
+    if (!getUploadUrlResponse.ok) {
+      throw new ConfigurationError(`Error getting upload URL: ${JSON.stringify(getUploadUrlResponse)}`);
+    }
+
+    const {
+      upload_url: uploadUrl, file_id: fileId,
+    } = getUploadUrlResponse;
+
+    // Upload the file to the provided URL
+    const formData = new FormData();
+    formData.append("file", stream, {
+      contentType: metadata.contentType,
+      knownLength: metadata.size,
+      filename: metadata.name,
+    });
+    formData.append("filename", filename);
+
+    await axios($, {
+      url: uploadUrl,
+      data: formData,
+      method: "POST",
+      headers: {
+        ...formData.getHeaders(),
+      },
+    });
+
+    // Complete the file upload process in Slack
+    const completeUploadResponse = await this.slack.completeUpload({
+      channel_id: this.conversation,
+      initial_comment: this.initialComment,
+      files: [
+        {
+          id: fileId,
+        },
+      ],
+    });
+
+    if (!completeUploadResponse.ok) {
+      throw new Error(`Error completing upload: ${JSON.stringify(completeUploadResponse)}`);
+    }
+
+    $.export("$summary", "Successfully uploaded file");
+    return completeUploadResponse;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,31 @@
+const MAX_RESOURCES = 800;
+const LIMIT = 250;
+
+const CHANNEL_TYPE = {
+  PUBLIC: "public_channel",
+  PRIVATE: "private_channel",
+  MPIM: "mpim",
+  IM: "im",
+};
+
+const CHANNEL_TYPE_OPTIONS = [
+  {
+    label: "Channels",
+    value: "Channels",
+  },
+  {
+    label: "Group",
+    value: CHANNEL_TYPE.MPIM,
+  },
+  {
+    label: "User / Direct Message",
+    value: CHANNEL_TYPE.IM,
+  },
+];
+
+export default {
+  MAX_RESOURCES,
+  LIMIT,
+  CHANNEL_TYPE,
+  CHANNEL_TYPE_OPTIONS,
+};

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@pipedream/slack_v2",
+  "version": "0.0.1",
+  "description": "Pipedream Slack_v2 Components",
+  "main": "slack_v2.app.mjs",
+  "keywords": [
+    "pipedream",
+    "slack_v2",
+    "slack"
+  ],
+  "homepage": "https://pipedream.com/apps/slack_v2",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.0",
+    "@slack/web-api": "^7.9.0",
+    "async-retry": "^1.3.3",
+    "lodash": "^4.17.21"
+  }
+}