@pipedream/slack 0.3.2 → 0.4.1

package/actions/add-star/add-star.mjs

@@ -0,0 +1,43 @@
+import slack from "../../slack.app.mjs";
+
+export default {
+  key: "slack-add-star",
+  name: "Add Star",
+  description: "Add a star to an item on behalf of the authenticated user. [See docs here](https://api.slack.com/methods/stars.add)",
+  version: "0.0.5",
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+      optional: true,
+      description: "Channel to add star to, or channel where the message to add star to was posted (used with timestamp).",
+    },
+    timestamp: {
+      propDefinition: [
+        slack,
+        "timestamp",
+      ],
+      optional: true,
+      description: "Timestamp of the message to add star to.",
+    },
+    file: {
+      propDefinition: [
+        slack,
+        "file",
+      ],
+      optional: true,
+      description: "File to add star to.",
+    },
+  },
+  async run() {
+    return await this.slack.sdk().stars.add({
+      channel: this.conversation,
+      timestamp: this.timestamp,
+      file: this.file,
+    });
+  },
+};

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

@@ -0,0 +1,23 @@
+import slack from "../../slack.app.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.5",
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().conversations.archive({
+      channel: this.conversation,
+    });
+  },
+};

package/actions/common/send-message.mjs

@@ -0,0 +1,170 @@
+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: {
+      propDefinition: [
+        slack,
+        "as_user",
+      ],
+    },
+    username: {
+      propDefinition: [
+        slack,
+        "username",
+      ],
+    },
+    icon_emoji: {
+      propDefinition: [
+        slack,
+        "icon_emoji",
+      ],
+    },
+    icon_url: {
+      propDefinition: [
+        slack,
+        "icon_url",
+      ],
+    },
+    post_at: {
+      propDefinition: [
+        slack,
+        "post_at",
+      ],
+    },
+    include_sent_via_pipedream_flag: {
+      type: "boolean",
+      optional: true,
+      default: true,
+      label: "Include link to workflow",
+      description: "Defaults to `true`, includes a link to the workflow at the end of your Slack message.",
+    },
+    metadata_event_type: {
+      propDefinition: [
+        slack,
+        "metadata_event_type",
+      ],
+    },
+    metadata_event_payload: {
+      propDefinition: [
+        slack,
+        "metadata_event_payload",
+      ],
+    },
+  },
+  methods: {
+    _makeSentViaPipedreamBlock() {
+      const workflowId = process.env.PIPEDREAM_WORKFLOW_ID;
+      // The link is a URL without a protocol to prevent link unfurling. See
+      // https://api.slack.com/reference/messaging/link-unfurling#classic_unfurl
+      const link = `https://pipedream.com/@/${workflowId}?o=a&a=slack`;
+      return {
+        "type": "context",
+        "elements": [
+          {
+            "type": "mrkdwn",
+            "text": `Sent via <${link}|Pipedream>`,
+          },
+        ],
+      };
+    },
+    _makeTextBlock(mrkdwn = true) {
+      const { text } = this;
+      let serializedText = text;
+      // The Slack SDK expects the value of text's "text" property to be a string. If this.text is
+      // anything other than string, number, or boolean, then encode it as a JSON string.
+      if (typeof text !== "string" && typeof text !== "number" && typeof text !== "boolean") {
+        serializedText = JSON.stringify(text);
+      }
+      return {
+        "type": "section",
+        "text": {
+          "type": mrkdwn
+            ? "mrkdwn"
+            : "plain_text",
+          "text": serializedText,
+        },
+      };
+    },
+  },
+  async run() {
+    let blocks = this.blocks;
+
+    if (!blocks) {
+      blocks = [
+        this._makeTextBlock(this.mrkdwn),
+      ];
+    } else if (typeof blocks === "string") {
+      blocks = JSON.parse(blocks);
+    }
+
+    if (this.include_sent_via_pipedream_flag) {
+      const sentViaPipedreamText = this._makeSentViaPipedreamBlock();
+      blocks.push(sentViaPipedreamText);
+    }
+
+    let metadataEventPayload;
+
+    if (this.metadata_event_type) {
+      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 ?? 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,
+    };
+
+    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;
+      return await this.slack.sdk().chat.scheduleMessage(obj);
+    }
+
+    return await this.slack.sdk().chat.postMessage(obj);
+  },
+};

package/actions/complete-reminder/complete-reminder.mjs

@@ -0,0 +1,23 @@
+import slack from "../../slack.app.mjs";
+
+export default {
+  key: "slack-complete-reminder",
+  name: "Complete Reminder",
+  description: "Complete a reminder. [See docs here](https://api.slack.com/methods/reminders.complete)",
+  version: "0.0.5",
+  type: "action",
+  props: {
+    slack,
+    reminder: {
+      propDefinition: [
+        slack,
+        "reminder",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().reminders.complete({
+      reminder: this.reminder,
+    });
+  },
+};

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

@@ -0,0 +1,30 @@
+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.6",
+  type: "action",
+  props: {
+    slack,
+    channelName: {
+      label: "Channel name",
+      description: "Name of the public or private channel to create",
+      type: "string",
+    },
+    isPrivate: {
+      label: "Is private?",
+      type: "boolean",
+      description: "`false` by default. Pass `true` to create a private channel instead of a public one.",
+      default: false,
+      optional: true,
+    },
+  },
+  async run() {
+    return await this.slack.sdk().conversations.create({
+      name: this.channelName,
+      is_private: this.isPrivate,
+    });
+  },
+};

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

@@ -0,0 +1,47 @@
+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.6",
+  type: "action",
+  props: {
+    slack,
+    text: {
+      propDefinition: [
+        slack,
+        "text",
+      ],
+    },
+    timestamp: {
+      propDefinition: [
+        slack,
+        "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: {
+      propDefinition: [
+        slack,
+        "team",
+      ],
+      optional: true,
+    },
+    user: {
+      propDefinition: [
+        slack,
+        "user",
+      ],
+      optional: true,
+    },
+  },
+  async run() {
+    return await this.slack.sdk().reminders.add({
+      text: this.text,
+      team_id: this.team_id,
+      time: this.timestamp,
+      user: this.user,
+    });
+  },
+};

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

@@ -0,0 +1,23 @@
+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.5",
+  type: "action",
+  props: {
+    slack,
+    file: {
+      propDefinition: [
+        slack,
+        "file",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().files.delete({
+      file: this.file,
+    });
+  },
+};

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

@@ -0,0 +1,38 @@
+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.5",
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+    timestamp: {
+      propDefinition: [
+        slack,
+        "timestamp",
+      ],
+    },
+    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.",
+    },
+  },
+  async run() {
+    return await this.slack.sdk().chat.delete({
+      channel: this.conversation,
+      ts: this.timestamp,
+      as_user: this.as_user,
+    });
+  },
+};

package/actions/delete_reminder/delete-reminder.mjs

@@ -0,0 +1,23 @@
+import slack from "../../slack.app.mjs";
+
+export default {
+  key: "slack-delete-reminder",
+  name: "Delete Reminder",
+  description: "Delete a reminder. [See docs here](https://api.slack.com/methods/reminders.delete)",
+  version: "0.0.5",
+  type: "action",
+  props: {
+    slack,
+    reminder: {
+      propDefinition: [
+        slack,
+        "reminder",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().reminders.delete({
+      reminder: this.reminder,
+    });
+  },
+};

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

@@ -0,0 +1,38 @@
+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.5",
+  type: "action",
+  props: {
+    slack,
+    query: {
+      propDefinition: [
+        slack,
+        "query",
+      ],
+    },
+    count: {
+      propDefinition: [
+        slack,
+        "count",
+      ],
+      optional: true,
+    },
+    team_id: {
+      propDefinition: [
+        slack,
+        "team",
+      ],
+      optional: true,
+    },
+  },
+  async run() {
+    return await this.slack.sdk().search.messages({
+      query: this.query,
+      count: this.count,
+    });
+  },
+};

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

@@ -0,0 +1,23 @@
+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.5",
+  type: "action",
+  props: {
+    slack,
+    email: {
+      propDefinition: [
+        slack,
+        "email",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().users.lookupByEmail({
+      email: this.email,
+    });
+  },
+};

package/actions/get-channel/get-channel.mjs

@@ -0,0 +1,23 @@
+import slack from "../../slack.app.mjs";
+
+export default {
+  key: "slack-get-channel",
+  name: "Get Channel",
+  description: "Return information about a workspace channel. [See docs here](https://api.slack.com/methods/conversations.info)",
+  version: "0.0.5",
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().conversations.info({
+      channel: this.conversation,
+    });
+  },
+};

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

@@ -0,0 +1,30 @@
+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.5",
+  type: "action",
+  props: {
+    slack,
+    file: {
+      propDefinition: [
+        slack,
+        "file",
+      ],
+    },
+    count: {
+      propDefinition: [
+        slack,
+        "count",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().files.info({
+      file: this.file,
+      count: this.count,
+    });
+  },
+};

package/actions/get-reminder/get-reminder.mjs

@@ -0,0 +1,23 @@
+import slack from "../../slack.app.mjs";
+
+export default {
+  key: "slack-get-reminder",
+  name: "Get Reminder",
+  description: "Return information about a reminder. [See docs here](https://api.slack.com/methods/reminders.info)",
+  version: "0.0.5",
+  type: "action",
+  props: {
+    slack,
+    reminder: {
+      propDefinition: [
+        slack,
+        "reminder",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().reminders.info({
+      reminder: this.reminder,
+    });
+  },
+};

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

@@ -0,0 +1,31 @@
+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.5",
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+    user: {
+      propDefinition: [
+        slack,
+        "user",
+      ],
+    },
+
+  },
+  async run() {
+    return await this.slack.sdk().conversations.invite({
+      channel: this.conversation,
+      users: this.user,
+    });
+  },
+};

package/actions/join-channel/join-channel.mjs

@@ -0,0 +1,23 @@
+import slack from "../../slack.app.mjs";
+
+export default {
+  key: "slack-join-channel",
+  name: "Join Channel",
+  description: "Join an existing channel. [See docs here](https://api.slack.com/methods/conversations.join)",
+  version: "0.0.5",
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().conversations.join({
+      channel: this.conversation,
+    });
+  },
+};

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

@@ -0,0 +1,30 @@
+import slack from "../../slack.app.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.5",
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+    user: {
+      propDefinition: [
+        slack,
+        "user",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().conversations.kick({
+      channel: this.conversation,
+      user: this.user,
+    });
+  },
+};

package/actions/leave-channel/leave-channel.mjs

@@ -0,0 +1,23 @@
+import slack from "../../slack.app.mjs";
+
+export default {
+  key: "slack-leave-channel",
+  name: "Leave Channel",
+  description: "Leave an existing channel. [See docs here](https://api.slack.com/methods/conversations.leave)",
+  version: "0.0.5",
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+    },
+  },
+  async run() {
+    return await this.slack.sdk().conversations.leave({
+      channel: this.conversation,
+    });
+  },
+};

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

@@ -0,0 +1,15 @@
+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.5",
+  type: "action",
+  props: {
+    slack,
+  },
+  async run() {
+    return await this.slack.sdk().conversations.list();
+  },
+};