@pipedream/slack_v2 0.0.1

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

@@ -0,0 +1,68 @@
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-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.10",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    slack,
+    userGroup: {
+      propDefinition: [
+        slack,
+        "userGroup",
+      ],
+    },
+    team: {
+      propDefinition: [
+        slack,
+        "team",
+      ],
+      optional: true,
+      description: "Encoded team id where the user group exists, required if org token is used.",
+    },
+    pageSize: {
+      propDefinition: [
+        slack,
+        "pageSize",
+      ],
+    },
+    numPages: {
+      propDefinition: [
+        slack,
+        "numPages",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const members = [];
+    const params = {
+      usergroup: this.userGroup,
+      team_id: this.team,
+      limit: this.pageSize,
+    };
+    let page = 0;
+
+    do {
+      const {
+        users, response_metadata: { next_cursor: nextCursor },
+      } = await this.slack.listGroupMembers(params);
+      members.push(...users);
+      params.cursor = nextCursor;
+      page++;
+    } while (params.cursor && page < this.numPages);
+
+    if (members?.length) {
+      $.export("$summary", `Successfully retrieved ${members.length} user${members.length === 1
+        ? ""
+        : "s"}`);
+    }
+    return members;
+  },
+};

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

@@ -0,0 +1,71 @@
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-list-members-in-channel",
+  name: "List Members in Channel",
+  description: "Retrieve members of a channel. [See the documentation](https://api.slack.com/methods/conversations.members)",
+  version: "0.0.25",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+    returnUsernames: {
+      type: "boolean",
+      label: "Return Usernames",
+      description: "Optionally, return usernames in addition to IDs",
+      optional: true,
+    },
+    pageSize: {
+      propDefinition: [
+        slack,
+        "pageSize",
+      ],
+    },
+    numPages: {
+      propDefinition: [
+        slack,
+        "numPages",
+      ],
+    },
+  },
+  async run({ $ }) {
+    let channelMembers = [];
+    const params = {
+      channel: this.conversation,
+      limit: this.pageSize,
+    };
+    let page = 0;
+
+    do {
+      const {
+        members, response_metadata: { next_cursor: nextCursor },
+      } = await this.slack.listChannelMembers(params);
+      channelMembers.push(...members);
+      params.cursor = nextCursor;
+      page++;
+    } while (params.cursor && page < this.numPages);
+
+    if (this.returnUsernames) {
+      const usernames = await this.slack.userNameLookup(channelMembers);
+      channelMembers = channelMembers?.map((id) => ({
+        id,
+        username: usernames[id],
+      })) || [];
+    }
+
+    $.export("$summary", `Successfully retrieved ${channelMembers.length} member${channelMembers.length === 1
+      ? ""
+      : "s"}`);
+    return channelMembers;
+  },
+};

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

@@ -0,0 +1,74 @@
+import constants from "../../common/constants.mjs";
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-list-replies",
+  name: "List Replies",
+  description: "Retrieve a thread of messages posted to a conversation. [See the documentation](https://api.slack.com/methods/conversations.replies)",
+  version: "0.0.25",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+        () => ({
+          types: [
+            constants.CHANNEL_TYPE.PUBLIC,
+            constants.CHANNEL_TYPE.PRIVATE,
+          ],
+        }),
+      ],
+      description: "Select a public or private channel",
+    },
+    timestamp: {
+      propDefinition: [
+        slack,
+        "messageTs",
+      ],
+    },
+    pageSize: {
+      propDefinition: [
+        slack,
+        "pageSize",
+      ],
+    },
+    numPages: {
+      propDefinition: [
+        slack,
+        "numPages",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const replies = [];
+    const params = {
+      channel: this.conversation,
+      ts: this.timestamp,
+      limit: this.pageSize,
+    };
+    let page = 0;
+
+    do {
+      const {
+        messages, response_metadata: { next_cursor: nextCursor },
+      } = await this.slack.getConversationReplies(params);
+      replies.push(...messages);
+      params.cursor = nextCursor;
+      page++;
+    } while (params.cursor && page < this.numPages);
+
+    $.export("$summary", `Successfully retrieved ${replies.length} reply message${replies.length === 1
+      ? ""
+      : "s"}`);
+    return {
+      messages: replies,
+    };
+  },
+};

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

@@ -0,0 +1,60 @@
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-list-users",
+  name: "List Users",
+  description: "Return a list of all users in a workspace. [See the documentation](https://api.slack.com/methods/users.list)",
+  version: "0.0.25",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    slack,
+    teamId: {
+      propDefinition: [
+        slack,
+        "team",
+      ],
+      optional: true,
+    },
+    pageSize: {
+      propDefinition: [
+        slack,
+        "pageSize",
+      ],
+    },
+    numPages: {
+      propDefinition: [
+        slack,
+        "numPages",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const users = [];
+    const params = {
+      team_id: this.teamId,
+      limit: this.pageSize,
+    };
+    let page = 0;
+
+    do {
+      const {
+        members, response_metadata: { next_cursor: nextCursor },
+      } = await this.slack.usersList(params);
+      users.push(...members);
+      params.cursor = nextCursor;
+      page++;
+    } while (params.cursor && page < (this.numPages ?? 1));
+
+    $.export("$summary", `Successfully retrieved ${users.length} user${users.length === 1
+      ? ""
+      : "s"}`);
+    return {
+      members: users,
+    };
+  },
+};

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

@@ -0,0 +1,54 @@
+import slack from "../../slack_v2.app.mjs";
+import common from "../common/send-message.mjs";
+
+export default {
+  ...common,
+  key: "slack_v2-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.2.0",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack: common.props.slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+    text: {
+      propDefinition: [
+        slack,
+        "text",
+      ],
+    },
+    mrkdwn: {
+      propDefinition: [
+        slack,
+        "mrkdwn",
+      ],
+    },
+    ...common.props,
+    replyToThread: {
+      ...common.props.replyToThread,
+      hidden: true,
+    },
+    thread_ts: {
+      propDefinition: [
+        slack,
+        "messageTs",
+      ],
+    },
+    thread_broadcast: {
+      propDefinition: [
+        slack,
+        "thread_broadcast",
+      ],
+    },
+  },
+};

package/actions/send-block-kit-message/send-block-kit-message.mjs

@@ -0,0 +1,48 @@
+import buildBlocks from "../common/build-blocks.mjs";
+import common from "../common/send-message.mjs";
+
+export default {
+  ...common,
+  ...buildBlocks,
+  key: "slack_v2-send-block-kit-message",
+  name: "Build and Send a Block Kit Message",
+  description: "Configure custom blocks and send to a channel, group, or user. [See the documentation](https://api.slack.com/tools/block-kit-builder).",
+  version: "0.5.0",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack: common.props.slack,
+    conversation: {
+      propDefinition: [
+        common.props.slack,
+        "conversation",
+      ],
+    },
+    text: {
+      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,
+    },
+    ...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({ $ }) {
+    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

@@ -0,0 +1,95 @@
+import common from "../common/send-message.mjs";
+
+export default {
+  ...common,
+  key: "slack_v2-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.1.0",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack: common.props.slack,
+    conversation: {
+      propDefinition: [
+        common.props.slack,
+        "conversation",
+      ],
+    },
+    text: {
+      propDefinition: [
+        common.props.slack,
+        "text",
+      ],
+    },
+    mrkdwn: {
+      propDefinition: [
+        common.props.slack,
+        "mrkdwn",
+      ],
+    },
+    ...common.props,
+  },
+  async run({ $ }) {
+    if (this.addToChannel) {
+      await this.slack.maybeAddAppToChannels([
+        this.conversation,
+      ]);
+    }
+
+    if (this.include_sent_via_pipedream_flag) {
+      const sentViaPipedreamText = this._makeSentViaPipedreamBlock();
+      this.text += `\n\n\n${sentViaPipedreamText.elements[0].text}`;
+    }
+
+    let metadataEventPayload;
+
+    if (this.metadata_event_type) {
+      if (typeof this.metadata_event_payload === "string") {
+        try {
+          metadataEventPayload = JSON.parse(this.metadata_event_payload);
+        } catch (error) {
+          throw new Error(`Invalid JSON in metadata_event_payload: ${error.message}`);
+        }
+      }
+
+      this.metadata = {
+        event_type: this.metadata_event_type,
+        event_payload: metadataEventPayload,
+      };
+    }
+
+    const obj = {
+      text: this.text,
+      channel: this.conversation,
+      as_user: this.as_user,
+      username: this.username,
+      icon_emoji: this.icon_emoji,
+      icon_url: this.icon_url,
+      mrkdwn: this.mrkdwn,
+      metadata: this.metadata || null,
+      reply_broadcast: this.thread_broadcast,
+      thread_ts: this.thread_ts,
+      unfurl_links: this.unfurl_links,
+      unfurl_media: this.unfurl_media,
+    };
+
+    let response;
+    if (this.post_at) {
+      obj.post_at = this.post_at;
+      response = await this.slack.scheduleMessage(obj);
+    } else {
+      response = await this.slack.postChatMessage(obj);
+    }
+    const { channel } = await this.slack.conversationsInfo({
+      channel: response.channel,
+    });
+    const channelName = await this.slack.getChannelDisplayName(channel);
+    $.export("$summary", `Successfully sent a message to ${channelName}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,56 @@
+import common from "../common/send-message.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  ...common,
+  key: "slack_v2-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.1.0",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  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",
+      async options() {
+        return constants.CHANNEL_TYPE_OPTIONS;
+      },
+    },
+    conversation: {
+      propDefinition: [
+        common.props.slack,
+        "conversation",
+        (c) => ({
+          types: c.channelType === "Channels"
+            ? [
+              constants.CHANNEL_TYPE.PUBLIC,
+              constants.CHANNEL_TYPE.PRIVATE,
+            ]
+            : [
+              c.channelType,
+            ],
+        }),
+      ],
+    },
+    text: {
+      propDefinition: [
+        common.props.slack,
+        "text",
+      ],
+    },
+    mrkdwn: {
+      propDefinition: [
+        common.props.slack,
+        "mrkdwn",
+      ],
+    },
+    ...common.props,
+  },
+};

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

@@ -0,0 +1,75 @@
+import common from "../common/send-message.mjs";
+import buildBlocks from "../common/build-blocks.mjs";
+
+export default {
+  ...common,
+  ...buildBlocks,
+  key: "slack_v2-send-message-advanced",
+  name: "Send Message (Advanced)",
+  description: "Customize advanced settings 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.1.0",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack: common.props.slack,
+    conversation: {
+      propDefinition: [
+        common.props.slack,
+        "conversation",
+      ],
+    },
+    text: {
+      propDefinition: [
+        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: [
+        common.props.slack,
+        "mrkdwn",
+      ],
+    },
+    attachments: {
+      propDefinition: [
+        common.props.slack,
+        "attachments",
+      ],
+    },
+    parse: {
+      propDefinition: [
+        common.props.slack,
+        "parse",
+      ],
+    },
+    link_names: {
+      propDefinition: [
+        common.props.slack,
+        "link_names",
+      ],
+    },
+    ...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-message-to-channel/send-message-to-channel.mjs

@@ -0,0 +1,45 @@
+import common from "../common/send-message.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  ...common,
+  key: "slack_v2-send-message-to-channel",
+  name: "Send Message to Channel",
+  description: "Send a message to a public or private channel. [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,
+    conversation: {
+      propDefinition: [
+        common.props.slack,
+        "conversation",
+        () => ({
+          types: [
+            constants.CHANNEL_TYPE.PUBLIC,
+            constants.CHANNEL_TYPE.PRIVATE,
+          ],
+        }),
+      ],
+      description: "Select a public or private channel",
+    },
+    text: {
+      propDefinition: [
+        common.props.slack,
+        "text",
+      ],
+    },
+    mrkdwn: {
+      propDefinition: [
+        common.props.slack,
+        "mrkdwn",
+      ],
+    },
+    ...common.props,
+  },
+};