@pipedream/slack_v2 0.0.1

package/LICENSE

@@ -0,0 +1,41 @@
+Pipedream Source Available License Version 1.0
+ 
+This Pipedream Source Available License Agreement Version 1.0 (this “Agreement”) sets forth the terms on which Pipedream, Inc., a Delaware corporation (“Pipedream”) makes available certain software (the “Software”). By installing, downloading, accessing, using or distributing the Software, you agree to the terms of this Agreement. If you do not agree to such terms, you must not use the Software. If you are receiving the Software on behalf of a legal entity, you represent and warrant that you have the actual authority to agree to the terms and conditions of this Agreement on behalf of such entity. “Licensee” means you, an individual, or the entity on whose behalf you are receiving the Software.
+ 
+LICENSE GRANT AND CONDITIONS.
+ 
+1.1  License. Subject to the terms and conditions of this Agreement, Pipedream hereby grants to Licensee a non-exclusive, royalty-free, worldwide, non-transferable, non-sublicenseable license during the term of this Agreement to use, prepare modifications and derivative works, distribute (including without limitation in source code or object code form) and reproduce copies of the Software (the “License”). Licensee is not granted the right to, and Licensee shall not, exercise the License for an Excluded Purpose. For purposes of this Agreement, “Excluded Purpose” means any commercial use of the software including, but not limited to, making available any software-as-a-service, platform-as-a-service, infrastructure-as-a-service or other online service that competes with the Software or any other Pipedream products or services.
+ 
+1.2  Conditions. In consideration of the License, Licensee’s distribution of the Software is subject to the following conditions:
+ 
+a. Licensee must cause any Software modified by Licensee to carry prominent notices stating that Licensee modified the Software.
+ 
+b. On each Software copy, Licensee shall reproduce and not remove or alter all Pipedream or third party copyright or other proprietary notices contained in the Software, and Licensee must provide this with each copy: “This software is made available by Pipedream, Inc., under the terms of the Pipedream Source Available License, Version 1.0 located at https://github.com/PipedreamHQ/pipedream/blob/master/LICENSE. By installing, downloading, accessing, using or distributing the Software, you agree to the terms of such License Agreement.”
+ 
+1.3  Modifications. Licensee may add its own copyright notices to modifications made by Licensee and may provide additional or different license terms and conditions for use, reproduction, or distribution of Licensee’s modifications. While redistributing the Software or modifications thereof, Licensee may choose to offer, for a fee or free of charge, support, warranty, indemnity, or other obligations. Licensee, and not Pipedream, will be responsible for any such obligations.
+ 
+1.4  No Sublicensing. The License does not include the right to sublicense the Software; provided, however, that any recipient to which Licensee provides the Software may exercise the License so long as such recipient agrees to the terms and conditions of this Agreement.
+ 
+TERM AND TERMINATION.
+ 
+This Agreement will continue unless and until earlier terminated as set forth herein. If Licensee breaches any of its conditions or obligations under this Agreement, this Agreement will terminate automatically and the License will terminate automatically and permanently.
+ 
+INTELLECTUAL PROPERTY.
+ 
+As between the parties, Pipedream retains all right, title, and interest in the Software, and all intellectual property rights therein. Pipedream hereby reserves all rights not expressly granted to Licensee in this Agreement. Pipedream reserves all rights in its trademarks and service marks, and no licenses thereto are granted by this Agreement.
+ 
+DISCLAIMER.
+ 
+PIPEDREAM HEREBY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE SOFTWARE.
+ 
+LIMITATION OF LIABILITY.
+ 
+PIPEDREAM WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO, LOST PROFITS OR ANY CONSEQUENTIAL, SPECIAL, INCIDENTAL, INDIRECT, OR DIRECT DAMAGES, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, ARISING OUT OF THIS AGREEMENT. THE FOREGOING SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW.
+ 
+GENERAL.
+ 
+6.1  Governing Law. This Agreement will be governed by and interpreted in accordance with the laws of the state of California, without reference to its conflict of laws principles. If Licensee is located outside of the United States, any dispute, controversy or claim arising out of or relating to this Agreement will be referred to and finally determined by arbitration in accordance with the JAMS International Arbitration Rules. The tribunal will consist of one arbitrator. Judgment upon the award rendered by the arbitrator may be entered in any court having jurisdiction thereof. All disputes including arbitrations shall take place in Santa Clara County, California. The language to be used in any such proceedings shall be English.
+ 
+6.2.  Assignment. Licensee is not authorized to assign its rights under this Agreement to any third party. Pipedream may freely assign its rights under this Agreement to any third party.
+ 
+6.3.  Other. This Agreement is the entire agreement between the parties regarding the subject matter hereof. No amendment or modification of this Agreement will be valid or binding upon the parties unless made in writing and signed by the duly authorized representatives of both parties. In the event that any provision, including without limitation any condition, of this Agreement is held to be unenforceable, this Agreement and all licenses and rights granted hereunder will immediately terminate. Waiver by Pipedream of a breach of any provision of this Agreement or the failure by Pipedream to exercise any right hereunder will not be construed as a waiver of any subsequent breach of that right or as a waiver of any other right.

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

@@ -0,0 +1,48 @@
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  key: "slack_v2-add-emoji-reaction",
+  name: "Add Emoji Reaction",
+  description: "Add an emoji reaction to a message. [See the documentation](https://api.slack.com/methods/reactions.add)",
+  version: "0.0.17",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+      ],
+      description: "Channel where the message to add reaction to was posted.",
+    },
+    timestamp: {
+      propDefinition: [
+        slack,
+        "messageTs",
+      ],
+      description: "Timestamp of the message to add reaction to. e.g. `1403051575.000407`.",
+    },
+    icon_emoji: {
+      propDefinition: [
+        slack,
+        "icon_emoji",
+      ],
+      description: "Provide an emoji to use as the icon for this reaction. E.g. `fire`",
+      optional: false,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.slack.addReactions({
+      channel: this.conversation,
+      timestamp: this.timestamp,
+      name: this.icon_emoji,
+    });
+    $.export("$summary", `Successfully added ${this.icon_emoji} emoji reaction.`);
+    return response;
+  },
+};

package/actions/approve-workflow/approve-workflow.mjs

@@ -0,0 +1,92 @@
+import slack from "../../slack_v2.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "slack_v2-approve-workflow",
+  name: "Approve Workflow",
+  description: "Suspend the workflow until approved by a Slack message. [See the documentation](https://pipedream.com/docs/code/nodejs/rerun#flowsuspend)",
+  version: "0.0.6",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  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: [
+        slack,
+        "conversation",
+        (c) => ({
+          types: c.channelType === "Channels"
+            ? [
+              constants.CHANNEL_TYPE.PUBLIC,
+              constants.CHANNEL_TYPE.PRIVATE,
+            ]
+            : [
+              c.channelType,
+            ],
+        }),
+      ],
+    },
+    message: {
+      type: "string",
+      label: "Message",
+      description: "Text to include with the Approve and Cancel Buttons",
+    },
+  },
+  async run({ $ }) {
+    const {
+      resume_url, cancel_url,
+    } = $.flow.suspend();
+
+    const response = await this.slack.postChatMessage({
+      text: "Click here to approve or cancel workflow",
+      blocks: [
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: this.message,
+          },
+        },
+        {
+          type: "actions",
+          elements: [
+            {
+              type: "button",
+              text: {
+                type: "plain_text",
+                text: "Approve",
+              },
+              style: "primary",
+              url: resume_url,
+            },
+            {
+              type: "button",
+              text: {
+                type: "plain_text",
+                text: "Cancel",
+              },
+              style: "danger",
+              url: cancel_url,
+            },
+          ],
+        },
+      ],
+      channel: this.conversation,
+    });
+
+    $.export("$summary", "Successfully sent message");
+    return response;
+  },
+};

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

@@ -0,0 +1,38 @@
+import slack from "../../slack_v2.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "slack_v2-archive-channel",
+  name: "Archive Channel",
+  description: "Archive a channel. [See the documentation](https://api.slack.com/methods/conversations.archive)",
+  version: "0.0.25",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    slack,
+    conversation: {
+      propDefinition: [
+        slack,
+        "conversation",
+        () => ({
+          types: [
+            constants.CHANNEL_TYPE.PUBLIC,
+            constants.CHANNEL_TYPE.PRIVATE,
+            constants.CHANNEL_TYPE.MPIM,
+          ],
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.slack.archiveConversations({
+      channel: this.conversation,
+    });
+    $.export("$summary", "Successfully archived channel.");
+    return response;
+  },
+};

package/actions/common/build-blocks.mjs

@@ -0,0 +1,182 @@
+import common from "./send-message.mjs";
+
+export default {
+  props: {
+    passArrayOrConfigure: {
+      type: "string",
+      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: [
+        {
+          label: "Reference an array of blocks",
+          value: "array",
+        },
+        {
+          label: "Configure blocks individually (maximum 5 blocks)",
+          value: "configure",
+        },
+      ],
+      optional: true,
+      reloadProps: true,
+    },
+  },
+  methods: {
+    // This adds a visual separator in the props form between each block
+    separator() {
+      return `
+  
+  ---
+  
+  `;
+    },
+    createBlockProp(type, label, description) {
+      return {
+        type,
+        label,
+        description: `${description} ${this.separator()}`,
+      };
+    },
+    createBlock(type, text) {
+      if (type === "section") {
+        return {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text,
+          },
+        };
+      } else if (type === "context") {
+        const elements = Array.isArray(text)
+          ? text.map((t) => ({
+            type: "mrkdwn",
+            text: t,
+          }))
+          : [
+            {
+              type: "mrkdwn",
+              text,
+            },
+          ];
+        return {
+          type: "context",
+          elements,
+        };
+      } else if (type === "link_button") {
+        const buttons = Object.keys(text).map((buttonText) => ({
+          type: "button",
+          text: {
+            type: "plain_text",
+            text: buttonText,
+            emoji: true,
+          },
+          url: text[buttonText],  // Access the URL using buttonText as the key
+          action_id: `actionId-${Math.random().toString(36)
+            .substr(2, 9)}`,  // Generates a random action_id
+        }));
+
+        return {
+          type: "actions",
+          elements: buttons,
+        };
+      }
+    },
+  },
+  async additionalProps(existingProps) {
+    await common.additionalProps.call(this, existingProps);
+    const props = {};
+    const sectionDescription = "Add a **section** block to your message and configure with plain text or mrkdwn. See [Slack's docs](https://api.slack.com/reference/block-kit/blocks?ref=bk#section) for more info.";
+    const contextDescription = "Add a **context** block to your message and configure with plain text or mrkdwn. Define multiple items if you'd like multiple elements in the context block. See [Slack's docs](https://api.slack.com/reference/block-kit/blocks?ref=bk#context) for more info.";
+    const linkButtonDescription = "Add a **link button** to your message. Enter the button text as the key and the link URL as the value. Configure multiple buttons in the array to render them inline, or add additional Button Link blocks to render them vertically. See [Slack's docs](https://api.slack.com/reference/block-kit/blocks?ref=bk#actions) for more info.";
+    const propsSection = this.createBlockProp("string", "Section Block Text", sectionDescription);
+    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,
+        label: common.props.slack.propDefinitions.blocks.label,
+        description: common.props.slack.propDefinitions.blocks.description,
+      };
+    } else {
+      props.blockType = {
+        type: "string",
+        label: "Block Type",
+        description: "Select the type of block to add. Refer to [Slack's docs](https://api.slack.com/reference/block-kit/blocks) for more info.",
+        options: [
+          {
+            label: "Section",
+            value: "section",
+          },
+          {
+            label: "Context",
+            value: "context",
+          },
+          {
+            label: "Link Button",
+            value: "link_button",
+          },
+        ],
+        reloadProps: true,
+      };}
+    let currentBlockType = this.blockType;
+    for (let i = 1; i <= 5; i++) {
+      if (currentBlockType === "section") {
+        props[`section${i}`] = propsSection;
+      } else if (currentBlockType === "context") {
+        props[`context${i}`] = propsContext;
+      } else if (currentBlockType === "link_button") {
+        props[`linkButton${i}`] = propsLinkButton;
+      }
+
+      if (i < 5 && currentBlockType) {  // Check if currentBlockType is set before adding nextBlockType
+        props[`nextBlockType${i}`] = {
+          type: "string",
+          label: "Next Block Type",
+          options: [
+            {
+              label: "Section",
+              value: "section",
+            },
+            {
+              label: "Context",
+              value: "context",
+            },
+            {
+              label: "Link Button",
+              value: "link_button",
+            },
+          ],
+          optional: true,
+          reloadProps: true,
+        };
+        currentBlockType = this[`nextBlockType${i}`];
+      }
+    }
+    return props;
+  },
+  async run() {
+    let blocks = [];
+    if (this.passArrayOrConfigure === "array") {
+      blocks = this.blocks;
+    } else {
+      for (let i = 1; i <= 5; i++) {
+        if (this[`section${i}`]) {
+          blocks.push(this.createBlock("section", this[`section${i}`]));
+        }
+
+        if (this[`context${i}`]) {
+          blocks.push(this.createBlock("context", this[`context${i}`]));
+        }
+
+        if (this[`linkButton${i}`]) {
+          blocks.push(this.createBlock("link_button", this[`linkButton${i}`]));
+        }
+      }
+    }
+    return blocks;
+  },
+};
+

package/actions/common/send-message.mjs

@@ -0,0 +1,264 @@
+import slack from "../../slack_v2.app.mjs";
+
+export default {
+  props: {
+    slack,
+    as_user: {
+      propDefinition: [
+        slack,
+        "as_user",
+      ],
+    },
+    addToChannel: {
+      propDefinition: [
+        slack,
+        "addToChannel",
+      ],
+      description: "If `true`, the app will be added to the specified non-DM channel(s) automatically. If `false`, you must add the app to the channel manually to post to a private channel as a bot. Defaults to `false`.",
+      default: false,
+    },
+    post_at: {
+      propDefinition: [
+        slack,
+        "post_at",
+      ],
+    },
+    include_sent_via_pipedream_flag: {
+      type: "boolean",
+      optional: true,
+      default: true,
+      label: "Include link to Pipedream",
+      description: "Defaults to `true`, includes a link to Pipedream at the end of your Slack message.",
+    },
+    customizeBotSettings: {
+      type: "boolean",
+      label: "Customize Bot Settings",
+      description: "Customize the username and/or icon of the Bot",
+      optional: true,
+      reloadProps: true,
+    },
+    username: {
+      propDefinition: [
+        slack,
+        "username",
+      ],
+      hidden: true,
+    },
+    icon_emoji: {
+      propDefinition: [
+        slack,
+        "icon_emoji",
+      ],
+      hidden: true,
+    },
+    icon_url: {
+      propDefinition: [
+        slack,
+        "icon_url",
+      ],
+      hidden: true,
+    },
+    replyToThread: {
+      type: "boolean",
+      label: "Reply to Thread",
+      description: "Reply to an existing thread",
+      optional: true,
+      reloadProps: true,
+    },
+    thread_ts: {
+      propDefinition: [
+        slack,
+        "messageTs",
+      ],
+      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. e.g. `1403051575.000407`.",
+      optional: true,
+      hidden: true,
+    },
+    thread_broadcast: {
+      propDefinition: [
+        slack,
+        "thread_broadcast",
+      ],
+      hidden: true,
+    },
+    addMessageMetadata: {
+      type: "boolean",
+      label: "Add Message Metadata",
+      description: "Set the metadata event type and payload",
+      optional: true,
+      reloadProps: true,
+    },
+    metadata_event_type: {
+      propDefinition: [
+        slack,
+        "metadata_event_type",
+      ],
+      hidden: true,
+    },
+    metadata_event_payload: {
+      propDefinition: [
+        slack,
+        "metadata_event_payload",
+      ],
+      hidden: true,
+    },
+    configureUnfurlSettings: {
+      type: "boolean",
+      label: "Configure Unfurl Settings",
+      description: "Configure settings for unfurling links and media",
+      optional: true,
+      reloadProps: true,
+    },
+    unfurl_links: {
+      propDefinition: [
+        slack,
+        "unfurl_links",
+      ],
+      hidden: true,
+    },
+    unfurl_media: {
+      propDefinition: [
+        slack,
+        "unfurl_media",
+      ],
+      hidden: true,
+    },
+  },
+  async additionalProps(props) {
+    if (this.conversation && this.replyToThread) {
+      props.thread_ts.hidden = false;
+      props.thread_broadcast.hidden = false;
+    }
+    if (this.customizeBotSettings) {
+      props.username.hidden = false;
+      props.icon_emoji.hidden = false;
+      props.icon_url.hidden = false;
+    }
+    if (this.addMessageMetadata) {
+      props.metadata_event_type.hidden = false;
+      props.metadata_event_payload.hidden = false;
+    }
+    if (this.configureUnfurlSettings) {
+      props.unfurl_links.hidden = false;
+      props.unfurl_media.hidden = false;
+    }
+    return {};
+  },
+  methods: {
+    _makeSentViaPipedreamBlock() {
+      const workflowId = process.env.PIPEDREAM_WORKFLOW_ID;
+      const baseLink = "https://pipedream.com";
+      const linkText = !workflowId
+        ? "Pipedream Connect"
+        : "Pipedream";
+
+      const link = !workflowId
+        ? `${baseLink}/connect`
+        : `${baseLink}/@/${workflowId}?o=a&a=slack`;
+
+      return {
+        "type": "context",
+        "elements": [
+          {
+            "type": "mrkdwn",
+            "text": `Sent via <${link}|${linkText}>`,
+          },
+        ],
+      };
+    },
+    _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,
+        },
+      };
+    },
+    getChannelId() {
+      return this.conversation ?? this.reply_channel;
+    },
+  },
+  async run({ $ }) {
+    const channelId = await this.getChannelId();
+
+    if (this.addToChannel) {
+      await this.slack.maybeAddAppToChannels([
+        channelId,
+      ]);
+    }
+
+    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) {
+
+      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: channelId,
+      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.thread_broadcast,
+      thread_ts: this.thread_ts,
+      metadata: this.metadata || null,
+    };
+
+    if (this.post_at) {
+      obj.post_at = Math.floor(new Date(this.post_at).getTime() / 1000);
+      return await this.slack.scheduleMessage(obj);
+    }
+    const resp = await this.slack.postChatMessage(obj);
+    const { channel } = await this.slack.conversationsInfo({
+      channel: resp.channel,
+    });
+    const channelName = await this.slack.getChannelDisplayName(channel);
+    $.export("$summary", `Successfully sent a message to ${channelName}`);
+    return resp;
+  },
+};