slack-logs 1.1.3 → 1.3.0

package/README.md

@@ -38,7 +38,16 @@ Here is a basic example of how to use the Slack Log package to send a message to
 
 ```
 ...
-SLACK_WEBHOOK_URL="https://hooks.slack.com/services/******/******/********************"
+# Slack Webhook URL for sending logs and notifications.
+# Replace with your actual webhook URL.
+SLACK_WEBHOOK_URL="https://hooks.slack.com/services/******/******/********************
+
+
+# Optional field, defaults to "true".
+# Set to "false" to disable Slack logs globally without changing the code.
+ENABLE_SLACK_LOGS=true
+# Note: No need to define this variable unless you want to disable Slack logs.
+# If variable is not defined, it defaults to "true".
 ...
 ```
 

package/package.json

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

package/src/index.ts

@@ -1,9 +1,12 @@
-import { SLACK_DEBUGGER, SLACK_WEBHOOK_URL } from "./constants/common-variables";
 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>;
+  logBlockMessage(
+    label: string,
+    objectData: BlocksInterface[],
+    error_type?: LogLevel
+  ): Promise<null | undefined>;
 }
 interface BlocksInterface {
   title: string;
@@ -29,7 +32,9 @@ export const slack: Slack = {
     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! 🚨");
+      console.error(
+        "🚨 Invalid Slack webhook URL. Kindly check 'SLACK_WEBHOOK_URL' in your .env file! 🚨"
+      );
       return null;
     }
 
@@ -39,10 +44,16 @@ export const slack: Slack = {
     };
     await axiosCall(payload);
   },
-  async logBlockMessage(label: string, objectData: BlocksInterface[], error_type: LogLevel = LogLevel.DEFAULT) {
+  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! 🚨");
+      console.error(
+        "🚨 Invalid Slack webhook URL. Kindly check 'SLACK_WEBHOOK_URL' in your .env file! 🚨"
+      );
       return null;
     }
     console.log(error_type);
@@ -68,7 +79,7 @@ export const slack: Slack = {
     });
 
     if (objectData?.length) {
-      objectData.forEach(element => {
+      objectData.forEach((element) => {
         let value = JSON.stringify(element.value);
         attachmentsBlocks.push({
           type: "section",
@@ -85,7 +96,7 @@ export const slack: Slack = {
     });
 
     let payload = {
-      text: "Application Error!",
+      text: label,
       blocks: blocks,
       attachments: attachments,
     };
@@ -94,8 +105,13 @@ export const slack: Slack = {
 };
 
 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") {
+  if (
+    !SLACK_WEBHOOK_URL ||
+    SLACK_WEBHOOK_URL == null ||
+    typeof SLACK_WEBHOOK_URL == "undefined"
+  ) {
     return false;
   }
 
@@ -104,16 +120,19 @@ function isValidSlackWebhookUrl(): boolean {
 }
 
 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" },
     })
-    .then(response => {
-      if (SLACK_DEBUGGER) {
-        console.log("✅ Log message sent to Slack successfully");
-      }
-    })
-    .catch(error => {
-      console.error("🚨 Error sending log message to Slack: Webhook URL might be updated!");
+    .catch((error) => {
+      console.error(
+        "🚨 Error sending log message to Slack: Webhook URL might be updated!"
+      );
     });
 }

package/tsconfig.json

@@ -1,13 +1,13 @@
 {
-  "compilerOptions": {
-    "outDir": "./dist",
-    "target": "ESNext",
-    "module": "CommonJS",
-    "lib": ["ESNext"],
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "exclude": ["node_modules", "dist"]
-}
+    "compilerOptions": {
+      "outDir": "./dist",
+      "target": "ESNext",
+      "module": "CommonJS",
+      "lib": ["ESNext"],
+      "strict": true,
+      "esModuleInterop": true,
+      "skipLibCheck": true,
+      "forceConsistentCasingInFileNames": true
+    },
+    "exclude": ["node_modules", "dist"]
+  }

package/dist/constants/common-variables.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SLACK_DEBUGGER = exports.SLACK_WEBHOOK_URL = void 0;
-const SLACK_WEBHOOK_URL = process.env.SLACK_WEBHOOK_URL;
-exports.SLACK_WEBHOOK_URL = SLACK_WEBHOOK_URL;
-const SLACK_DEBUGGER = process?.env?.SLACK_DEBUGGER === "true";
-exports.SLACK_DEBUGGER = SLACK_DEBUGGER;

package/dist/constants/common-variables.ts

@@ -1,4 +0,0 @@
-const SLACK_WEBHOOK_URL = process.env.SLACK_WEBHOOK_URL;
-const SLACK_DEBUGGER: boolean = process?.env?.SLACK_DEBUGGER === "true";
-
-export { SLACK_WEBHOOK_URL, SLACK_DEBUGGER };

package/dist/index.js

@@ -1,110 +0,0 @@
-"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 common_variables_1 = require("./constants/common-variables");
-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: "Application Error!",
-            blocks: blocks,
-            attachments: attachments,
-        };
-        await axiosCall(payload);
-    },
-};
-function isValidSlackWebhookUrl() {
-    // Check if SLACK_WEBHOOK_URL is not null or undefined
-    if (!common_variables_1.SLACK_WEBHOOK_URL || common_variables_1.SLACK_WEBHOOK_URL == null || typeof common_variables_1.SLACK_WEBHOOK_URL == "undefined") {
-        return false;
-    }
-    // Check if SLACK_WEBHOOK_URL starts with "https://"
-    return common_variables_1.SLACK_WEBHOOK_URL.startsWith("https://");
-}
-async function axiosCall(payload) {
-    return await axios_1.default
-        .post(common_variables_1.SLACK_WEBHOOK_URL, JSON.stringify(payload), {
-        headers: { "Content-Type": "application/json" },
-    })
-        .then(response => {
-        if (common_variables_1.SLACK_DEBUGGER) {
-            console.log("✅ Log message sent to Slack successfully");
-        }
-    })
-        .catch(error => {
-        console.error("🚨 Error sending log message to Slack: Webhook URL might be updated!");
-    });
-}

package/dist/index.ts

@@ -1,119 +0,0 @@
-import { SLACK_DEBUGGER, SLACK_WEBHOOK_URL } from "./constants/common-variables";
-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: "Application Error!",
-      blocks: blocks,
-      attachments: attachments,
-    };
-    await axiosCall(payload);
-  },
-};
-
-function isValidSlackWebhookUrl(): boolean {
-  // 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) {
-  return await axios
-    .post(SLACK_WEBHOOK_URL as string, JSON.stringify(payload), {
-      headers: { "Content-Type": "application/json" },
-    })
-    .then(response => {
-      if (SLACK_DEBUGGER) {
-        console.log("✅ Log message sent to Slack successfully");
-      }
-    })
-    .catch(error => {
-      console.error("🚨 Error sending log message to Slack: Webhook URL might be updated!");
-    });
-}

package/src/constants/common-variables.ts

@@ -1,4 +0,0 @@
-const SLACK_WEBHOOK_URL = process.env.SLACK_WEBHOOK_URL;
-const SLACK_DEBUGGER: boolean = process?.env?.SLACK_DEBUGGER === "true";
-
-export { SLACK_WEBHOOK_URL, SLACK_DEBUGGER };