slack-logs 1.8.0 → 2.9.0

package/README.md

@@ -34,27 +34,17 @@ Before you start, ensure you have created an Incoming Webhook in Slack and have
 
 Here is a basic example of how to use the Slack Log package to send a message to your Slack channel:
 
-.env 🚨
+#### Option 1: Use `slackLogConfig(...)`
 
 ```
-...
-# 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".
-...
-```
-
-```
-import { slack } from "slack-logs";
+import { slack, slackLogConfig } from "slack-logs";
 or
-const { slack } = require('slack-logs');
+const { slack, slackLogConfig } = require('slack-logs');
+
+slackLogConfig({
+  webhookUrl: "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
+  enableAlerts: true,
+});
 
 /*Slack Notification with default format*/
 slack.log("Data", [{ title: "1yes!" }]);
@@ -72,6 +62,49 @@ slack.logBlockMessage("Validation Message!", payload);
 
 ```
 
+`slackLogConfig(...)` rules:
+
+- `webhookUrl` and `enableAlerts` are both required
+- if `slackLogConfig(...)` is used, env values are ignored for both fields
+- `slackLogConfig(...)` does not ask for values interactively
+
+#### Option 2: Use environment variables
+
+Use env values only when `slackLogConfig(...)` is not called.
+
+`.env` 🚨
+
+```
+...
+# Slack Webhook URL for sending logs and notifications.
+# Replace with your actual webhook URL.
+SLACK_WEBHOOK_URL="https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
+
+# Optional field.
+# If not defined, logs are sent by default.
+# true / True / TRUE sends logs.
+# false / False / FALSE skips logs.
+ENABLE_SLACK_LOGS=true
+...
+```
+
+`ENABLE_SLACK_LOGS` behavior:
+
+- if not defined, default is `true`
+- `true`, `"true"`, `"True"` and any case variation send logs
+- `false`, `"false"`, `"False"` and any case variation do not send logs
+- any other value is treated as `false`
+
+#### Webhook validation
+
+Expected format:
+
+```
+https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+If webhook URL format is invalid, package logs a console error and skips sending.
+
 ```
 /*Slack Notification with colored block format*/
 
@@ -174,3 +207,57 @@ Contributions are welcome! If you have a feature request, bug report, or a pull
 ### License:
 
 This package is licensed under the MIT License - see the LICENSE file for details.
+
+### Raw body
+
+Use `slack.rawBody(...)` when you want to send a custom Slack payload as-is.
+
+```
+import { slack } from "slack-logs";
+
+const payload = {
+  blocks: [
+    {
+      type: "section",
+      text: {
+        type: "mrkdwn",
+        text: "Hello from custom payload",
+      },
+    },
+    {
+      type: "divider",
+    },
+    {
+      type: "actions",
+      elements: [
+        {
+          type: "button",
+          text: {
+            type: "plain_text",
+            text: "Open",
+            emoji: true,
+          },
+          value: "click_me_123",
+          url: "https://google.com",
+        },
+      ],
+    },
+  ],
+};
+
+slack.rawBody(payload);
+```
+
+`slack.rawBody(...)` expects a plain object payload like:
+
+```
+{
+  "blocks": [...]
+}
+```
+
+If payload is invalid or sending fails, it logs a console error.
+
+Try payload experiments here:
+
+[Slack Block Kit Builder](https://app.slack.com/block-kit-builder/T9D4GM7L0)

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+interface Slack {
+    log(label: string, data: any): Promise<null | undefined>;
+    logBlockMessage(label: string, objectData: BlocksInterface[], error_type?: LogLevel): Promise<null | undefined>;
+    rawBody(payload: Record<string, any>): Promise<null | undefined>;
+}
+export interface SlackLogConfigOptions {
+    webhookUrl: string;
+    enableAlerts: boolean;
+}
+interface BlocksInterface {
+    title: string;
+    value: any;
+}
+export declare enum LogLevel {
+    DEFAULT = "DEFAULT",
+    SUCCESS = "SUCCESS",
+    INFO = "INFO",
+    WARN = "WARN",
+    ERROR = "ERROR"
+}
+export declare enum LogColor {
+    DEFAULT = "#B4B4B8",
+    SUCCESS = "#65B741",
+    INFO = "#40A2D8",
+    WARN = "#E3651D",
+    ERROR = "#FF0000"
+}
+export declare function slackLogConfig(config: SlackLogConfigOptions): void;
+export declare const slack: Slack;
+export {};

package/dist/index.js

@@ -1 +1 @@
-"use strict";function e(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}Object.defineProperty(exports,"__esModule",{value:!0});var t,o,r=e(require("axios"));exports.LogLevel=void 0,(t=exports.LogLevel||(exports.LogLevel={})).DEFAULT="DEFAULT",t.SUCCESS="SUCCESS",t.INFO="INFO",t.WARN="WARN",t.ERROR="ERROR",exports.LogColor=void 0,(o=exports.LogColor||(exports.LogColor={})).DEFAULT="#B4B4B8",o.SUCCESS="#65B741",o.INFO="#40A2D8",o.WARN="#E3651D",o.ERROR="#FF0000";const s={async log(e,t){const o=JSON.stringify(t);if(!n())return console.error("🚨 Invalid Slack webhook URL. Kindly check 'SLACK_WEBHOOK_URL' in your .env file! 🚨"),null;let r={text:`*${e}:* ${o}`};await l(r)},async logBlockMessage(e,t,o=exports.LogLevel.DEFAULT){if(!n())return console.error("🚨 Invalid Slack webhook URL. Kindly check 'SLACK_WEBHOOK_URL' in your .env file! 🚨"),null;console.log(o);const r=exports.LogColor[o],s=[],i=[],c=[];s.push({type:"divider"}),s.push({type:"header",text:{type:"plain_text",text:e,emoji:!0}}),s.push({type:"divider"}),t?.length&&t.forEach((e=>{let t=JSON.stringify(e.value);c.push({type:"section",text:{type:"mrkdwn",text:`*${e.title}:* ${t}`}})})),i.push({color:r,blocks:c});let a={text:e,blocks:s,attachments:i};await l(a)}};function n(){const e=process.env.SLACK_WEBHOOK_URL;return!(!e||null==e||void 0===e)&&e.startsWith("https://")}async function l(e){if("true"===(process?.env?.ENABLE_SLACK_LOGS??"").toString())return!1;const t=process.env.SLACK_WEBHOOK_URL;return await r.default.post(t,JSON.stringify(e),{headers:{"Content-Type":"application/json"}}).catch((e=>{console.error("🚨 Error sending log message to Slack: Webhook URL might be updated!")}))}exports.slack=s;
+"use strict";function e(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}Object.defineProperty(exports,"__esModule",{value:!0});var o,t,r=e(require("axios"));exports.LogLevel=void 0,(o=exports.LogLevel||(exports.LogLevel={})).DEFAULT="DEFAULT",o.SUCCESS="SUCCESS",o.INFO="INFO",o.WARN="WARN",o.ERROR="ERROR",exports.LogColor=void 0,(t=exports.LogColor||(exports.LogColor={})).DEFAULT="#B4B4B8",t.SUCCESS="#65B741",t.INFO="#40A2D8",t.WARN="#E3651D",t.ERROR="#FF0000";const n={};const l={async log(e,o){const t=JSON.stringify(o);if(!s())return console.error("🚨 Invalid Slack webhook URL. Kindly check slackLogConfig(...) or 'SLACK_WEBHOOK_URL' in your .env file! 🚨"),null;let r={text:`*${e}:* ${t}`};await a(r)},async logBlockMessage(e,o,t=exports.LogLevel.DEFAULT){if(!s())return console.error("🚨 Invalid Slack webhook URL. Kindly check slackLogConfig(...) or 'SLACK_WEBHOOK_URL' in your .env file! 🚨"),null;const r=exports.LogColor[t],n=[],l=[],c=[];n.push({type:"divider"}),n.push({type:"header",text:{type:"plain_text",text:e,emoji:!0}}),n.push({type:"divider"}),o?.length&&o.forEach((e=>{let o=JSON.stringify(e.value);c.push({type:"section",text:{type:"mrkdwn",text:`*${e.title}:* ${o}`}})})),l.push({color:r,blocks:c});let i={text:e,blocks:n,attachments:l};await a(i)},rawBody:async e=>s()?function(e){return!!e&&"object"==typeof e&&!Array.isArray(e)}(e)?void await a(e):(console.error('🚨 Invalid Slack payload for rawBody(...). Expected an object like { "blocks": [...] } 🚨'),null):(console.error("🚨 Invalid Slack webhook URL. Kindly check slackLogConfig(...) or 'SLACK_WEBHOOK_URL' in your .env file! 🚨"),null)};function s(){const e=c();if(!e)return!1;return!!/^https:\/\/hooks\.slack\.com\/services\/[A-Za-z0-9]+\/[A-Za-z0-9]+\/[A-Za-z0-9]+$/.test(e)||(console.error(`🚨 Slack webhook URL does not look in correct format. Current value is "${e}", expected format is "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX". 🚨`),!1)}function c(){return n.webhookUrl??process.env.SLACK_WEBHOOK_URL}async function a(e){if(!function(){if("boolean"==typeof n.enableAlerts)return n.enableAlerts;const e=(process?.env?.ENABLE_SLACK_LOGS??"").toString().trim();return!e||"true"===e.toLowerCase()||(e.toLowerCase(),!1)}())return null;const o=c();return await r.default.post(o,JSON.stringify(e),{headers:{"Content-Type":"application/json"}}).catch((e=>{console.error("🚨 Error sending log message to Slack: Webhook URL might be updated!")}))}exports.slack=l,exports.slackLogConfig=function(e){n.webhookUrl=e.webhookUrl,n.enableAlerts=e.enableAlerts};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "slack-logs",
-  "version": "1.8.0",
+  "version": "2.9.0",
   "description": "slack-logs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,8 @@
     "copy:ts": "rollup -c",
     "remove-dist": "rm -rf dist",
     "build": "npm run remove-dist && npm run build:js && npm run copy:ts",
-    "package:deploy": "npm run build && npm pub"
+    "package:deploy": "npm run build && npm pub",
+    "postpublish": "node scripts/release-git.js"
   },
   "author": "",
   "license": "MIT",
@@ -19,7 +20,8 @@
     "tslib": "^2.8.1"
   },
   "files": [
-    "./dist/ README.md"
+    "dist",
+    "README.md"
   ],
   "keywords": [
     "slack-logs",