slack-logs 1.3.0 → 1.3.1

package/dist/index.js

@@ -0,0 +1,111 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.slack = exports.LogColor = exports.LogLevel = void 0;
+const axios_1 = __importDefault(require("axios"));
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["DEFAULT"] = "DEFAULT";
+    LogLevel["SUCCESS"] = "SUCCESS";
+    LogLevel["INFO"] = "INFO";
+    LogLevel["WARN"] = "WARN";
+    LogLevel["ERROR"] = "ERROR";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+var LogColor;
+(function (LogColor) {
+    LogColor["DEFAULT"] = "#B4B4B8";
+    LogColor["SUCCESS"] = "#65B741";
+    LogColor["INFO"] = "#40A2D8";
+    LogColor["WARN"] = "#E3651D";
+    LogColor["ERROR"] = "#FF0000";
+})(LogColor || (exports.LogColor = LogColor = {}));
+exports.slack = {
+    async log(label, data) {
+        const messageData = JSON.stringify(data);
+        if (!isValidSlackWebhookUrl()) {
+            // SLACK_WEBHOOK_URL is valid
+            console.error("🚨 Invalid Slack webhook URL. Kindly check 'SLACK_WEBHOOK_URL' in your .env file! 🚨");
+            return null;
+        }
+        const message = `*${label}:* ${messageData}`;
+        let payload = {
+            text: message,
+        };
+        await axiosCall(payload);
+    },
+    async logBlockMessage(label, objectData, error_type = LogLevel.DEFAULT) {
+        if (!isValidSlackWebhookUrl()) {
+            // SLACK_WEBHOOK_URL is valid
+            console.error("🚨 Invalid Slack webhook URL. Kindly check 'SLACK_WEBHOOK_URL' in your .env file! 🚨");
+            return null;
+        }
+        console.log(error_type);
+        const messageBodyColor = LogColor[error_type];
+        const blocks = [];
+        const attachments = [];
+        const attachmentsBlocks = [];
+        blocks.push({
+            type: "divider",
+        });
+        // Label of slack message
+        blocks.push({
+            type: "header",
+            text: {
+                type: "plain_text",
+                text: label,
+                emoji: true,
+            },
+        });
+        blocks.push({
+            type: "divider",
+        });
+        if (objectData?.length) {
+            objectData.forEach((element) => {
+                let value = JSON.stringify(element.value);
+                attachmentsBlocks.push({
+                    type: "section",
+                    text: {
+                        type: "mrkdwn",
+                        text: `*${element.title}:* ${value}`,
+                    },
+                });
+            });
+        }
+        attachments.push({
+            color: messageBodyColor,
+            blocks: attachmentsBlocks,
+        });
+        let payload = {
+            text: label,
+            blocks: blocks,
+            attachments: attachments,
+        };
+        await axiosCall(payload);
+    },
+};
+function isValidSlackWebhookUrl() {
+    const SLACK_WEBHOOK_URL = process.env.SLACK_WEBHOOK_URL;
+    // Check if SLACK_WEBHOOK_URL is not null or undefined
+    if (!SLACK_WEBHOOK_URL ||
+        SLACK_WEBHOOK_URL == null ||
+        typeof SLACK_WEBHOOK_URL == "undefined") {
+        return false;
+    }
+    // Check if SLACK_WEBHOOK_URL starts with "https://"
+    return SLACK_WEBHOOK_URL.startsWith("https://");
+}
+async function axiosCall(payload) {
+    const ENABLE_SLACK_LOGS = (process?.env?.ENABLE_SLACK_LOGS ?? "").toString() === "true";
+    if (ENABLE_SLACK_LOGS)
+        return false;
+    const SLACK_WEBHOOK_URL = process.env.SLACK_WEBHOOK_URL;
+    return await axios_1.default
+        .post(SLACK_WEBHOOK_URL, JSON.stringify(payload), {
+        headers: { "Content-Type": "application/json" },
+    })
+        .catch((error) => {
+        console.error("🚨 Error sending log message to Slack: Webhook URL might be updated!");
+    });
+}

package/dist/index.ts

@@ -0,0 +1,138 @@
+import axios from "axios";
+
+interface Slack {
+  log(label: string, data: any): Promise<null | undefined>;
+  logBlockMessage(
+    label: string,
+    objectData: BlocksInterface[],
+    error_type?: LogLevel
+  ): Promise<null | undefined>;
+}
+interface BlocksInterface {
+  title: string;
+  value: any;
+}
+
+export enum LogLevel {
+  DEFAULT = "DEFAULT",
+  SUCCESS = "SUCCESS",
+  INFO = "INFO",
+  WARN = "WARN",
+  ERROR = "ERROR",
+}
+export enum LogColor {
+  DEFAULT = "#B4B4B8",
+  SUCCESS = "#65B741",
+  INFO = "#40A2D8",
+  WARN = "#E3651D",
+  ERROR = "#FF0000",
+}
+export const slack: Slack = {
+  async log(label: string, data: any) {
+    const messageData = JSON.stringify(data);
+    if (!isValidSlackWebhookUrl()) {
+      // SLACK_WEBHOOK_URL is valid
+      console.error(
+        "🚨 Invalid Slack webhook URL. Kindly check 'SLACK_WEBHOOK_URL' in your .env file! 🚨"
+      );
+      return null;
+    }
+
+    const message = `*${label}:* ${messageData}`;
+    let payload = {
+      text: message,
+    };
+    await axiosCall(payload);
+  },
+  async logBlockMessage(
+    label: string,
+    objectData: BlocksInterface[],
+    error_type: LogLevel = LogLevel.DEFAULT
+  ) {
+    if (!isValidSlackWebhookUrl()) {
+      // SLACK_WEBHOOK_URL is valid
+      console.error(
+        "🚨 Invalid Slack webhook URL. Kindly check 'SLACK_WEBHOOK_URL' in your .env file! 🚨"
+      );
+      return null;
+    }
+    console.log(error_type);
+    const messageBodyColor = LogColor[error_type];
+
+    const blocks: object[] = [];
+    const attachments: object[] = [];
+    const attachmentsBlocks: object[] = [];
+    blocks.push({
+      type: "divider",
+    });
+    // Label of slack message
+    blocks.push({
+      type: "header",
+      text: {
+        type: "plain_text",
+        text: label,
+        emoji: true,
+      },
+    });
+    blocks.push({
+      type: "divider",
+    });
+
+    if (objectData?.length) {
+      objectData.forEach((element) => {
+        let value = JSON.stringify(element.value);
+        attachmentsBlocks.push({
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: `*${element.title}:* ${value}`,
+          },
+        });
+      });
+    }
+    attachments.push({
+      color: messageBodyColor,
+      blocks: attachmentsBlocks,
+    });
+
+    let payload = {
+      text: label,
+      blocks: blocks,
+      attachments: attachments,
+    };
+    await axiosCall(payload);
+  },
+};
+
+function isValidSlackWebhookUrl(): boolean {
+  const SLACK_WEBHOOK_URL = process.env.SLACK_WEBHOOK_URL;
+  // Check if SLACK_WEBHOOK_URL is not null or undefined
+  if (
+    !SLACK_WEBHOOK_URL ||
+    SLACK_WEBHOOK_URL == null ||
+    typeof SLACK_WEBHOOK_URL == "undefined"
+  ) {
+    return false;
+  }
+
+  // Check if SLACK_WEBHOOK_URL starts with "https://"
+  return SLACK_WEBHOOK_URL.startsWith("https://");
+}
+
+async function axiosCall(payload: any) {
+  const ENABLE_SLACK_LOGS: boolean =
+    (process?.env?.ENABLE_SLACK_LOGS ?? "").toString() === "true";
+
+  if (ENABLE_SLACK_LOGS) return false;
+
+  const SLACK_WEBHOOK_URL = process.env.SLACK_WEBHOOK_URL;
+  return await axios
+    .post(SLACK_WEBHOOK_URL as string, JSON.stringify(payload), {
+      headers: { "Content-Type": "application/json" },
+    })
+    .catch((error) => {
+      console.error(
+        "🚨 Error sending log message to Slack: Webhook URL might be updated!"
+      );
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "slack-logs",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "slack-logs",
   "main": "dist/index.js",
   "types": "dist/index.ts",