@pipedream/slack 0.4.28 → 0.4.30

package/README.md

@@ -21,11 +21,11 @@ However, if you'd like to use your own bot registered with the [Slack API](https
 
 The Slack Bot requires a bot token to allow your Pipedream workflows to authenticate as your bot. The extra set up steps allow you to list your custom bot on the Slack Marketplace, or install the bot on other workspaces as your bot's name instead of as Pipedream.
 
-## Getting Started
+# Getting Started
 
 You can install the Pipedream Slack app in the [Accounts](https://pipedream.com/accounts) section of your account, or directly in a workflow
 
-### Accounts
+## Accounts
 
 1. Visit [https://pipedream.com/accounts](https://pipedream.com/accounts).
 2. Click on the **Click Here To Connect An App** button in the top-right.
@@ -33,7 +33,7 @@ You can install the Pipedream Slack app in the [Accounts](https://pipedream.com/
 4. This will open a new window asking you to allow Pipedream access to your Slack workspace. Choose the right workspace where you'd like to install the app, then click **Allow**.
 5. That's it! You can now use this Slack account in any [actions](#workflow-actions), or [link it to any code step](/connected-accounts/#connecting-accounts).
 
-### Within a workflow
+## Within a workflow
 
 1. [Create a new workflow](https://pipedream.com/new).
 2. Select your trigger (HTTP, Cron, etc.).
@@ -42,6 +42,6 @@ You can install the Pipedream Slack app in the [Accounts](https://pipedream.com/
 5. Click the **Connect Account** button near the top of the step. This will prompt you to select any existing Slack accounts you've previously authenticated with Pipedream, or you can select a **New** account. Clicking **New** opens a new window asking you to allow Pipedream access to your Slack workspace. Choose the right workspace where you'd like to install the app, then click **Allow**.
 6. That's it! You can now connect to the Slack API using any of the Slack actions within a Pipedream workflow.
 
-## Troubleshooting
+# Troubleshooting
 
 Please [reach out](https://pipedream.com/support/) to the Pipedream team with any technical issues or questions about the Slack integration. We're happy to help!

package/actions/common/build-blocks.mjs

@@ -0,0 +1,180 @@
+import common from "./send-message.mjs";
+
+/* eslint-disable pipedream/required-properties-key, pipedream/required-properties-name,
+  pipedream/required-properties-version, pipedream/required-properties-description */
+export default {
+  type: "action",
+  props: {
+    passArrayOrConfigure: {
+      type: "string",
+      label: "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",
+        },
+      ],
+      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() {
+    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 == "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

@@ -91,7 +91,7 @@ export default {
       };
     },
   },
-  async run() {
+  async run({ $ }) {
     let blocks = this.blocks;
 
     if (!blocks) {
@@ -167,7 +167,8 @@ export default {
       obj.post_at = this.post_at;
       return await this.slack.sdk().chat.scheduleMessage(obj);
     }
-
-    return await this.slack.sdk().chat.postMessage(obj);
+    const resp = await this.slack.sdk().chat.postMessage(obj);
+    $.export("$summary", "Successfully sent a message to channel ID " + resp.channel);
+    return resp;
   },
 };

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

@@ -6,10 +6,10 @@ 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.16",
+  version: "0.1.18",
   type: "action",
   props: {
-    ...common.props,
+    slack: common.props.slack,
     thread_ts: {
       propDefinition: [
         slack,
@@ -43,5 +43,6 @@ export default {
         "mrkdwn",
       ],
     },
+    ...common.props,
   },
 };

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

@@ -1,27 +1,21 @@
 import common from "../common/send-message.mjs";
+import buildBlocks from "../common/build-blocks.mjs";
 
 export default {
   ...common,
-  key: "slack-send-block-kit-message",
-  name: "Send Message Using Block Kit",
-  description: "Send a message using Slack's Block Kit UI framework 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.15",
+  ...buildBlocks,
+  name: "Build and Send a Block Kit Message (Beta)",
+  description: "Configure custom blocks and send to a channel, group, or user. [See Slack's docs for more info](https://api.slack.com/tools/block-kit-builder).",
+  version: "0.3.0",
   type: "action",
+  key: "slack-send-block-kit-message",
   props: {
-    ...common.props,
+    slack: common.props.slack,
     conversation: {
       propDefinition: [
         common.props.slack,
         "conversation",
       ],
-      optional: false,
-    },
-    blocks: {
-      propDefinition: [
-        common.props.slack,
-        "blocks",
-      ],
-      optional: false,
     },
     text: {
       propDefinition: [
@@ -29,5 +23,21 @@ export default {
         "notificationText",
       ],
     },
+    ...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-custom-message/send-custom-message.mjs

@@ -5,10 +5,10 @@ export default {
   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.15",
+  version: "0.2.17",
   type: "action",
   props: {
-    ...common.props,
+    slack: common.props.slack,
     conversation: {
       propDefinition: [
         common.props.slack,
@@ -75,5 +75,6 @@ export default {
         "thread_ts",
       ],
     },
+    ...common.props,
   },
 };

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

@@ -5,10 +5,10 @@ export default {
   key: "slack-send-direct-message",
   name: "Send a Direct Message",
   description: "Send a direct message to a single user. See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.2.16",
+  version: "0.2.18",
   type: "action",
   props: {
-    ...common.props,
+    slack: common.props.slack,
     conversation: {
       propDefinition: [
         common.props.slack,
@@ -48,5 +48,6 @@ export default {
       ],
       description: "Optionally provide an image URL to use as the bot icon for this message.",
     },
+    ...common.props,
   },
 };

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

@@ -5,10 +5,10 @@ export default {
   key: "slack-send-group-message",
   name: "Send Group Message",
   description: "Send a direct message to a group of users. See [postMessage](https://api.slack.com/methods/chat.postMessage) or [scheduleMessage](https://api.slack.com/methods/chat.scheduleMessage) docs here",
-  version: "0.2.16",
+  version: "0.2.18",
   type: "action",
   props: {
-    ...common.props,
+    slack: common.props.slack,
     conversation: {
       propDefinition: [
         common.props.slack,
@@ -48,5 +48,6 @@ export default {
       ],
       description: "Optionally provide an image URL to use as the bot icon for this message.",
     },
+    ...common.props,
   },
 };

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

@@ -5,10 +5,10 @@ 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.11",
+  version: "0.0.13",
   type: "action",
   props: {
-    ...common.props,
+    slack: common.props.slack,
     conversation: {
       propDefinition: [
         common.props.slack,
@@ -48,6 +48,7 @@ export default {
       ],
       description: "Optionally provide an image URL to use as the bot icon for this message.",
     },
+    ...common.props,
   },
   async run() {
     if (this.include_sent_via_pipedream_flag) {

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

@@ -6,10 +6,10 @@ export default {
   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.16",
+  version: "0.2.18",
   type: "action",
   props: {
-    ...common.props,
+    slack: common.props.slack,
     conversation: {
       propDefinition: [
         common.props.slack,
@@ -54,5 +54,6 @@ export default {
       ],
       description: "Optionally provide an image URL to use as the bot icon for this message.",
     },
+    ...common.props,
   },
 };

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

@@ -6,10 +6,10 @@ export default {
   key: "slack-send-message-public-channel",
   name: "Send Message to a Public Channel",
   description: "Send a message to a public 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.15",
+  version: "0.2.17",
   type: "action",
   props: {
-    ...common.props,
+    slack: common.props.slack,
     conversation: {
       propDefinition: [
         common.props.slack,
@@ -54,5 +54,6 @@ export default {
       ],
       description: "Optionally provide an image URL to use as the bot icon for this message.",
     },
+    ...common.props,
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/slack",
-  "version": "0.4.28",
+  "version": "0.4.30",
   "description": "Pipedream Slack Components",
   "main": "slack.app.mjs",
   "keywords": [