@oneuptime/common 7.0.3718 → 7.0.3815

package/Server/Utils/Workspace/Slack/Slack.ts

@@ -4,17 +4,152 @@ import URL from "Common/Types/API/URL";
 import { JSONObject } from "Common/Types/JSON";
 import API from "Common/Utils/API";
 import WorkspaceMessagePayload, {
+  WorkspaceCheckboxBlock,
+  WorkspaceDateTimePickerBlock,
+  WorkspaceDropdownBlock,
+  WorkspaceMessageBlock,
   WorkspaceMessagePayloadButton,
+  WorkspaceModalBlock,
+  WorkspacePayloadButtons,
   WorkspacePayloadHeader,
+  WorkspacePayloadImage,
   WorkspacePayloadMarkdown,
+  WorkspaceTextAreaBlock,
+  WorkspaceTextBoxBlock,
 } from "../../../../Types/Workspace/WorkspaceMessagePayload";
 import logger from "../../Logger";
 import Dictionary from "../../../../Types/Dictionary";
 import BadRequestException from "../../../../Types/Exception/BadRequestException";
-import WorkspaceBase, { WorkspaceChannel } from "../WorkspaceBase";
+import WorkspaceBase, {
+  WorkspaceChannel,
+  WorkspaceSendMessageResponse,
+  WorkspaceThread,
+} from "../WorkspaceBase";
 import WorkspaceType from "../../../../Types/Workspace/WorkspaceType";
+import SlackifyMarkdown from "slackify-markdown";
+import { DropdownOption } from "../../../../UI/Components/Dropdown/Dropdown";
+import OneUptimeDate from "../../../../Types/Date";
 
 export default class SlackUtil extends WorkspaceBase {
+  public static override async getUsernameFromUserId(data: {
+    authToken: string;
+    userId: string;
+  }): Promise<string> {
+    logger.debug("Getting username from user ID with data:");
+    logger.debug(data);
+
+    const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
+      await API.post<JSONObject>(
+        URL.fromString("https://slack.com/api/users.info"),
+        {
+          user: data.userId,
+        },
+        {
+          Authorization: `Bearer ${data.authToken}`,
+          ["Content-Type"]: "application/x-www-form-urlencoded",
+        },
+      );
+
+    logger.debug("Response from Slack API for getting user info:");
+    logger.debug(response);
+
+    if (response instanceof HTTPErrorResponse) {
+      logger.error("Error response from Slack API:");
+      logger.error(response);
+      throw response;
+    }
+
+    // check for ok response
+    if ((response.jsonData as JSONObject)?.["ok"] !== true) {
+      logger.error("Invalid response from Slack API:");
+      logger.error(response.jsonData);
+      throw new BadRequestException("Invalid response");
+    }
+
+    if (
+      !((response.jsonData as JSONObject)?.["user"] as JSONObject)?.["name"]
+    ) {
+      logger.error("Invalid response from Slack API:");
+      logger.error(response.jsonData);
+      throw new Error("Invalid response");
+    }
+
+    const username: string = (
+      (response.jsonData as JSONObject)["user"] as JSONObject
+    )["name"] as string;
+
+    logger.debug("Username obtained:");
+    logger.debug(username);
+    return username;
+  }
+
+  public static override async showModalToUser(data: {
+    authToken: string;
+    triggerId: string;
+    modalBlock: WorkspaceModalBlock;
+  }): Promise<void> {
+    logger.debug("Showing modal to user with data:");
+    logger.debug(data);
+
+    const modalJson: JSONObject = this.getModalBlock({
+      payloadModalBlock: data.modalBlock,
+    });
+
+    logger.debug("Modal JSON generated:");
+    logger.debug(JSON.stringify(modalJson, null, 2));
+
+    // use view.open API to show modal
+    const result: HTTPErrorResponse | HTTPResponse<JSONObject> = await API.post(
+      URL.fromString("https://slack.com/api/views.open"),
+      {
+        trigger_id: data.triggerId,
+        view: modalJson,
+      },
+      {
+        Authorization: `Bearer ${data.authToken}`,
+        ["Content-Type"]: "application/json",
+      },
+    );
+
+    if (result instanceof HTTPErrorResponse) {
+      logger.error("Error response from Slack API:");
+      logger.error(result);
+      throw result;
+    }
+
+    if ((result.jsonData as JSONObject)?.["ok"] !== true) {
+      logger.error("Invalid response from Slack API:");
+      logger.error(result.jsonData);
+      throw new BadRequestException("Invalid response");
+    }
+
+    logger.debug("Modal shown to user successfully.");
+  }
+
+  public static override async sendDirectMessageToUser(data: {
+    authToken: string;
+    workspaceUserId: string;
+    messageBlocks: Array<WorkspaceMessageBlock>;
+  }): Promise<void> {
+    // Send direct message to user
+
+    const blocks: Array<JSONObject> = this.getBlocksFromWorkspaceMessagePayload(
+      {
+        messageBlocks: data.messageBlocks,
+      },
+    );
+
+    await this.sendPayloadBlocksToChannel({
+      authToken: data.authToken,
+      workspaceChannel: {
+        id: data.workspaceUserId,
+        name: "",
+        workspaceType: WorkspaceType.Slack,
+      },
+      blocks: blocks,
+    });
+  }
+
   public static override async joinChannel(data: {
     authToken: string;
     channelId: string;
@@ -59,6 +194,18 @@ export default class SlackUtil extends WorkspaceBase {
     channelId: string;
     workspaceUserId: string;
   }): Promise<void> {
+    // check if already in channel.
+    const isUserInChannel: boolean = await this.isUserInChannel({
+      authToken: data.authToken,
+      channelId: data.channelId,
+      userId: data.workspaceUserId,
+    });
+
+    if (isUserInChannel) {
+      logger.debug("User already in channel.");
+      return;
+    }
+
     logger.debug("Inviting user to channel with data:");
     logger.debug(data);
 
@@ -300,11 +447,72 @@ export default class SlackUtil extends WorkspaceBase {
     return channels;
   }
 
+  public static override getDividerBlock(): JSONObject {
+    return {
+      type: "divider",
+    };
+  }
+
+  public static getValuesFromView(data: {
+    view: JSONObject;
+  }): Dictionary<string | number | Array<string | number> | Date> {
+    logger.debug("Getting values from view with data:");
+    logger.debug(JSON.stringify(data, null, 2));
+
+    const slackView: JSONObject = data.view;
+    const values: Dictionary<string | number | Array<string | number> | Date> =
+      {};
+
+    if (!slackView["state"] || !(slackView["state"] as JSONObject)["values"]) {
+      return {};
+    }
+
+    for (const valueId in (slackView["state"] as JSONObject)[
+      "values"
+    ] as JSONObject) {
+      for (const blockId in (
+        (slackView["state"] as JSONObject)["values"] as JSONObject
+      )[valueId] as JSONObject) {
+        const valueObject: JSONObject = (
+          (slackView["state"] as JSONObject)["values"] as JSONObject
+        )[valueId] as JSONObject;
+        const value: JSONObject = valueObject[blockId] as JSONObject;
+        values[blockId] = value["value"] as string | number;
+
+        if ((value["selected_option"] as JSONObject)?.["value"]) {
+          values[blockId] = (value["selected_option"] as JSONObject)?.[
+            "value"
+          ] as string;
+        }
+
+        if (Array.isArray(value["selected_options"])) {
+          values[blockId] = (
+            value["selected_options"] as Array<JSONObject>
+          ).map((option: JSONObject) => {
+            return option["value"] as string | number;
+          });
+        }
+
+        // if date picker
+        if (value["selected_date_time"]) {
+          values[blockId] = OneUptimeDate.fromUnixTimestamp(
+            value["selected_date_time"] as number,
+          );
+        }
+      }
+    }
+
+    logger.debug("Values obtained from view:");
+    logger.debug(values);
+
+    return values;
+  }
+
   public static override async sendMessage(data: {
     workspaceMessagePayload: WorkspaceMessagePayload;
     authToken: string; // which auth token should we use to send.
     userId: string;
-  }): Promise<void> {
+  }): Promise<WorkspaceSendMessageResponse> {
     logger.debug("Sending message to Slack with data:");
     logger.debug(data);
 
@@ -323,7 +531,7 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug("Existing workspace channels:");
     logger.debug(existingWorkspaceChannels);
 
-    const channelIdsToPostTo: Array<string> = [];
+    const workspaceChannelsToPostTo: Array<WorkspaceChannel> = [];
 
     for (let channelName of data.workspaceMessagePayload.channelNames) {
       if (channelName && channelName.startsWith("#")) {
@@ -338,21 +546,37 @@ export default class SlackUtil extends WorkspaceBase {
       }
 
       if (channel) {
-        channelIdsToPostTo.push(channel.id);
+        workspaceChannelsToPostTo.push(channel);
       } else {
         logger.debug(`Channel ${channelName} does not exist.`);
       }
     }
 
+    // add channel ids.
+    for (const channelId of data.workspaceMessagePayload.channelIds) {
+      const channel: WorkspaceChannel = {
+        id: channelId,
+        name: "",
+        workspaceType: WorkspaceType.Slack,
+      };
+
+      workspaceChannelsToPostTo.push(channel);
+    }
+
     logger.debug("Channel IDs to post to:");
-    logger.debug(channelIdsToPostTo);
+    logger.debug(workspaceChannelsToPostTo);
 
-    for (const channelId of channelIdsToPostTo) {
+    const workspaspaceMessageResponse: WorkspaceSendMessageResponse = {
+      threads: [],
+      workspaceType: WorkspaceType.Slack,
+    };
+
+    for (const channel of workspaceChannelsToPostTo) {
       try {
         // check if the user is in the channel.
         const isUserInChannel: boolean = await this.isUserInChannel({
           authToken: data.authToken,
-          channelId: channelId,
+          channelId: channel.id,
           userId: data.userId,
         });
 
@@ -360,29 +584,36 @@ export default class SlackUtil extends WorkspaceBase {
           // add user to the channel
           await this.joinChannel({
             authToken: data.authToken,
-            channelId: channelId,
+            channelId: channel.id,
           });
         }
 
-        await this.sendPayloadBlocksToChannel({
+        const thread: WorkspaceThread = await this.sendPayloadBlocksToChannel({
           authToken: data.authToken,
-          channelId: channelId,
+          workspaceChannel: channel,
           blocks: blocks,
         });
 
-        logger.debug(`Message sent to channel ID ${channelId} successfully.`);
+        workspaspaceMessageResponse.threads.push(thread);
+
+        logger.debug(`Message sent to channel ID ${channel.id} successfully.`);
       } catch (e) {
-        logger.error(`Error sending message to channel ID ${channelId}:`);
+        logger.error(`Error sending message to channel ID ${channel.id}:`);
         logger.error(e);
       }
     }
+
+    logger.debug("Message sent successfully.");
+    logger.debug(workspaspaceMessageResponse);
+
+    return workspaspaceMessageResponse;
   }
 
   public static override async sendPayloadBlocksToChannel(data: {
     authToken: string;
-    channelId: string;
+    workspaceChannel: WorkspaceChannel;
     blocks: Array<JSONObject>;
-  }): Promise<void> {
+  }): Promise<WorkspaceThread> {
     logger.debug("Sending payload blocks to channel with data:");
     logger.debug(JSON.stringify(data, null, 2));
 
@@ -390,8 +621,9 @@ export default class SlackUtil extends WorkspaceBase {
       await API.post(
         URL.fromString("https://slack.com/api/chat.postMessage"),
         {
-          channel: data.channelId,
+          channel: data.workspaceChannel.id,
           blocks: data.blocks,
+          unfurl_links: false,
         },
         {
           Authorization: `Bearer ${data.authToken}`,
@@ -415,12 +647,44 @@ export default class SlackUtil extends WorkspaceBase {
     }
 
     logger.debug("Payload blocks sent to channel successfully.");
+
+    return {
+      channel: data.workspaceChannel,
+      threadId: (response.jsonData as JSONObject)["ts"] as string,
+    };
+  }
+
+  public static override getButtonsBlock(data: {
+    payloadButtonsBlock: WorkspacePayloadButtons;
+  }): JSONObject {
+    logger.debug("Getting buttons block with data:");
+    logger.debug(data);
+
+    const buttonsBlock: JSONObject = {
+      type: "actions",
+      elements: data.payloadButtonsBlock.buttons.map(
+        (button: WorkspaceMessagePayloadButton) => {
+          return this.getButtonBlock({ payloadButtonBlock: button });
+        },
+      ),
+    };
+
+    logger.debug("Buttons block generated:");
+    logger.debug(buttonsBlock);
+    return buttonsBlock;
   }
 
   public static override async createChannel(data: {
     authToken: string;
     channelName: string;
   }): Promise<WorkspaceChannel> {
+    if (data.channelName && data.channelName.startsWith("#")) {
+      data.channelName = data.channelName.substring(1);
+    }
+
+    // lower case channel name
+    data.channelName = data.channelName.toLowerCase();
+
     logger.debug("Creating channel with data:");
     logger.debug(data);
 
@@ -495,6 +759,275 @@ export default class SlackUtil extends WorkspaceBase {
     return headerBlock;
   }
 
+  public static override getCheckboxBlock(data: {
+    payloadCheckboxBlock: WorkspaceCheckboxBlock;
+  }): JSONObject {
+    logger.debug("Getting checkbox block with data:");
+    logger.debug(data);
+
+    const checkboxBlock: JSONObject = {
+      type: "input",
+      element: {
+        type: "checkboxes",
+        action_id: data.payloadCheckboxBlock.blockId,
+        options: [
+          {
+            text: {
+              type: "plain_text",
+              text: data.payloadCheckboxBlock.label,
+            },
+            value: "value",
+          },
+        ],
+        initial_options: data.payloadCheckboxBlock.initialValue
+          ? [
+              {
+                text: {
+                  type: "plain_text",
+                  text: data.payloadCheckboxBlock.label,
+                },
+                value: "value",
+              },
+            ]
+          : undefined,
+      },
+      label: {
+        type: "plain_text",
+        text: data.payloadCheckboxBlock.label,
+      },
+    };
+
+    // if description then add hint.
+
+    if (data.payloadCheckboxBlock.description) {
+      checkboxBlock["hint"] = {
+        type: "plain_text",
+        text: data.payloadCheckboxBlock.description,
+      };
+    }
+
+    logger.debug("Checkbox block generated:");
+    logger.debug(checkboxBlock);
+    return checkboxBlock;
+  }
+
+  public static override getDateTimePickerBlock(data: {
+    payloadDateTimePickerBlock: WorkspaceDateTimePickerBlock;
+  }): JSONObject {
+    logger.debug("Getting date time picker block with data:");
+    logger.debug(data);
+
+    const dateTimePickerBlock: JSONObject = {
+      type: "input",
+      element: {
+        type: "datetimepicker",
+        action_id: data.payloadDateTimePickerBlock.blockId,
+        initial_date: data.payloadDateTimePickerBlock.initialValue,
+      },
+      label: {
+        type: "plain_text",
+        text: data.payloadDateTimePickerBlock.label,
+      },
+    };
+
+    logger.debug("Date time picker block generated:");
+    logger.debug(dateTimePickerBlock);
+    return dateTimePickerBlock;
+  }
+
+  public static override getTextAreaBlock(data: {
+    payloadTextAreaBlock: WorkspaceTextAreaBlock;
+  }): JSONObject {
+    logger.debug("Getting text area block with data:");
+    logger.debug(data);
+
+    const optional: boolean = data.payloadTextAreaBlock.optional || false;
+
+    const textAreaBlock: JSONObject = {
+      type: "input",
+      optional: optional,
+      element: {
+        type: "plain_text_input",
+        multiline: true,
+        action_id: data.payloadTextAreaBlock.blockId,
+        placeholder: {
+          type: "plain_text",
+          text: data.payloadTextAreaBlock.placeholder,
+        },
+        initial_value: data.payloadTextAreaBlock.initialValue,
+      },
+      label: {
+        type: "plain_text",
+        text: data.payloadTextAreaBlock.label,
+      },
+    };
+
+    // if description then add hint.
+
+    if (data.payloadTextAreaBlock.description) {
+      textAreaBlock["hint"] = {
+        type: "plain_text",
+        text: data.payloadTextAreaBlock.description,
+      };
+    }
+
+    logger.debug("Text area block generated:");
+    logger.debug(textAreaBlock);
+    return textAreaBlock;
+  }
+
+  public static override getTextBoxBlock(data: {
+    payloadTextBoxBlock: WorkspaceTextBoxBlock;
+  }): JSONObject {
+    logger.debug("Getting text box block with data:");
+    logger.debug(data);
+
+    const optional: boolean = data.payloadTextBoxBlock.optional || false;
+
+    const textBoxBlock: JSONObject = {
+      type: "input",
+      optional: optional,
+      element: {
+        type: "plain_text_input",
+        action_id: data.payloadTextBoxBlock.blockId,
+        placeholder: {
+          type: "plain_text",
+          text: data.payloadTextBoxBlock.placeholder,
+        },
+        initial_value: data.payloadTextBoxBlock.initialValue,
+      },
+      label: {
+        type: "plain_text",
+        text: data.payloadTextBoxBlock.label,
+      },
+    };
+
+    // if description then add hint.
+
+    if (data.payloadTextBoxBlock.description) {
+      textBoxBlock["hint"] = {
+        type: "plain_text",
+        text: data.payloadTextBoxBlock.description,
+      };
+    }
+
+    logger.debug("Text box block generated:");
+    logger.debug(textBoxBlock);
+    return textBoxBlock;
+  }
+
+  public static override getImageBlock(data: {
+    payloadImageBlock: WorkspacePayloadImage;
+  }): JSONObject {
+    logger.debug("Getting image block with data:");
+    logger.debug(data);
+
+    const imageBlock: JSONObject = {
+      type: "image",
+      image_url: data.payloadImageBlock.imageUrl.toString(),
+      alt_text: data.payloadImageBlock.altText,
+    };
+
+    logger.debug("Image block generated:");
+    logger.debug(imageBlock);
+    return imageBlock;
+  }
+
+  public static override getDropdownBlock(data: {
+    payloadDropdownBlock: WorkspaceDropdownBlock;
+  }): JSONObject {
+    logger.debug("Getting dropdown block with data:");
+    logger.debug(data);
+
+    const optional: boolean = data.payloadDropdownBlock.optional || false;
+
+    const isMiltiSelect: boolean =
+      data.payloadDropdownBlock.multiSelect || false;
+
+    const dropdownBlock: JSONObject = {
+      type: "input",
+      optional: optional,
+      element: {
+        type: isMiltiSelect ? "multi_static_select" : "static_select",
+        action_id: data.payloadDropdownBlock.blockId,
+        placeholder: {
+          type: "plain_text",
+          text: data.payloadDropdownBlock.placeholder,
+        },
+        options: data.payloadDropdownBlock.options.map(
+          (option: DropdownOption) => {
+            return {
+              text: {
+                type: "plain_text",
+                text: option.label,
+              },
+              value: option.value,
+            };
+          },
+        ),
+        initial_option: data.payloadDropdownBlock.initialValue
+          ? {
+              text: {
+                type: "plain_text",
+                text: data.payloadDropdownBlock.initialValue,
+              },
+              value: data.payloadDropdownBlock.initialValue,
+            }
+          : undefined,
+      },
+
+      label: {
+        type: "plain_text",
+        text: data.payloadDropdownBlock.label,
+      },
+    };
+
+    // if description then add hint.
+
+    if (data.payloadDropdownBlock.description) {
+      dropdownBlock["hint"] = {
+        type: "plain_text",
+        text: data.payloadDropdownBlock.description,
+      };
+    }
+
+    logger.debug("Dropdown block generated:");
+    logger.debug(dropdownBlock);
+    return dropdownBlock;
+  }
+
+  public static override getModalBlock(data: {
+    payloadModalBlock: WorkspaceModalBlock;
+  }): JSONObject {
+    logger.debug("Getting modal block with data:");
+    logger.debug(data);
+
+    const modalBlock: JSONObject = {
+      type: "modal",
+      title: {
+        type: "plain_text",
+        text: data.payloadModalBlock.title,
+      },
+      callback_id: data.payloadModalBlock.actionId,
+      private_metadata: data.payloadModalBlock.actionValue,
+      submit: {
+        type: "plain_text",
+        text: data.payloadModalBlock.submitButtonTitle,
+      },
+      close: {
+        type: "plain_text",
+        text: data.payloadModalBlock.cancelButtonTitle,
+      },
+      blocks: this.getBlocksFromWorkspaceMessagePayload({
+        messageBlocks: data.payloadModalBlock.blocks,
+      }),
+    };
+
+    logger.debug("Modal block generated:");
+    logger.debug(modalBlock);
+    return modalBlock;
+  }
+
   public static override getMarkdownBlock(data: {
     payloadMarkdownBlock: WorkspacePayloadMarkdown;
   }): JSONObject {
@@ -505,7 +1038,9 @@ export default class SlackUtil extends WorkspaceBase {
       type: "section",
       text: {
         type: "mrkdwn",
-        text: data.payloadMarkdownBlock.text,
+        text: data.payloadMarkdownBlock.text
+          ? SlackifyMarkdown(data.payloadMarkdownBlock.text)
+          : "",
       },
     };
 
@@ -514,6 +1049,50 @@ export default class SlackUtil extends WorkspaceBase {
     return markdownBlock;
   }
 
+  public static override async isUserInDirectMessageChannel(data: {
+    authToken: string;
+    userId: string;
+    directMessageChannelId: string;
+  }): Promise<boolean> {
+    // check of the user id is in the direct message channel id
+    const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
+      await API.post(
+        URL.fromString("https://slack.com/api/conversations.info"),
+        {
+          channel: data.directMessageChannelId,
+        },
+        {
+          Authorization: `Bearer ${data.authToken}`,
+          ["Content-Type"]: "application/x-www-form-urlencoded",
+        },
+      );
+
+    if (response instanceof HTTPErrorResponse) {
+      logger.error("Error response from Slack API:");
+      logger.error(response);
+      throw response;
+    }
+
+    // check for ok response
+
+    if ((response.jsonData as JSONObject)?.["ok"] !== true) {
+      logger.error("Invalid response from Slack API:");
+      logger.error(response.jsonData);
+      throw new BadRequestException("Invalid response");
+    }
+
+    // check if the user is in the channel
+    const user: JSONObject = (
+      (response.jsonData as JSONObject)["channel"] as JSONObject
+    )["user"] as JSONObject;
+
+    if (user?.["user_id"]?.toString() === data.userId.toString()) {
+      return true;
+    }
+
+    return false;
+  }
+
   public static override async isUserInChannel(data: {
     authToken: string;
     channelId: string;
@@ -595,9 +1174,13 @@ export default class SlackUtil extends WorkspaceBase {
       text: {
         type: "plain_text",
         text: data.payloadButtonBlock.title,
+        emoji: true,
       },
-      value: data.payloadButtonBlock.title,
-      action_id: data.payloadButtonBlock.title,
+      value: data.payloadButtonBlock.value,
+      action_id: data.payloadButtonBlock.actionId,
+      url: data.payloadButtonBlock.url
+        ? data.payloadButtonBlock.url.toString()
+        : undefined,
     };
 
     logger.debug("Button block generated:");