slack-logs 1.0.10

package/dist/constants/common-variables.js

@@ -0,0 +1,7 @@
+"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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,81 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.slack = void 0;
+const common_variables_1 = require("./constants/common-variables");
+const axios_1 = __importDefault(require("axios"));
+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) {
+        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 blocks = [];
+        // Label of slack message
+        blocks.push({
+            type: "header",
+            text: {
+                type: "plain_text",
+                text: label,
+                emoji: true,
+            },
+        });
+        if (objectData?.length) {
+            objectData.forEach((element) => {
+                let value = JSON.stringify(element.value);
+                blocks.push({
+                    type: "section",
+                    text: {
+                        type: "mrkdwn",
+                        text: `*${element.title}:* ${value}`,
+                    },
+                });
+            });
+        }
+        let payload = {
+            text: "Application Error!",
+            blocks: blocks,
+        };
+        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:", error);
+    });
+}

package/dist/index.ts

@@ -0,0 +1,104 @@
+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[]
+  ): Promise<null | undefined>;
+}
+interface BlocksInterface {
+  title: string;
+  value: any;
+}
+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[]) {
+    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 blocks: object[] = [];
+
+    // Label of slack message
+    blocks.push({
+      type: "header",
+      text: {
+        type: "plain_text",
+        text: label,
+        emoji: true,
+      },
+    });
+
+    if (objectData?.length) {
+      objectData.forEach((element) => {
+        let value = JSON.stringify(element.value);
+        blocks.push({
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: `*${element.title}:* ${value}`,
+          },
+        });
+      });
+    }
+
+    let payload = {
+      text: "Application Error!",
+      blocks: blocks,
+    };
+    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:", error);
+    });
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "slack-logs",
+  "version": "1.0.10",
+  "description": "slack-logs",
+  "main": "dist/index.js",
+  "types": "dist/index.ts",
+  "scripts": {
+    "build:js": "tsc",
+    "copy:ts": "ncp src dist",
+    "build": "npm run build:js && npm run copy:ts"
+  },
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.7"
+  },
+  "keywords": [
+    "slack",
+    "logs",
+    "slack-logs",
+    "slack-logger",
+    "logger",
+    "console",
+    "console logs",
+    "jkg",
+    "jaykumar-gohil"
+  ],
+  "devDependencies": {
+    "@types/node": "^20.11.17",
+    "ncp": "^2.0.0",
+    "typescript": "^5.3.3"
+  }
+}

package/src/constants/common-variables.ts

@@ -0,0 +1,4 @@
+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/src/index.ts

@@ -0,0 +1,104 @@
+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[]
+  ): Promise<null | undefined>;
+}
+interface BlocksInterface {
+  title: string;
+  value: any;
+}
+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[]) {
+    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 blocks: object[] = [];
+
+    // Label of slack message
+    blocks.push({
+      type: "header",
+      text: {
+        type: "plain_text",
+        text: label,
+        emoji: true,
+      },
+    });
+
+    if (objectData?.length) {
+      objectData.forEach((element) => {
+        let value = JSON.stringify(element.value);
+        blocks.push({
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: `*${element.title}:* ${value}`,
+          },
+        });
+      });
+    }
+
+    let payload = {
+      text: "Application Error!",
+      blocks: blocks,
+    };
+    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:", error);
+    });
+}

package/tsconfig.json

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