@kaushverse/rabbitmq-core 1.0.4 → 1.0.6

package/README.md

@@ -0,0 +1,98 @@
+# @kaushverse/rabbitmq-core
+
+Production-ready RabbitMQ SDK for Node.js microservices.
+
+This package provides a clean and opinionated way to **connect**, **publish**, **consume**, and **monitor RabbitMQ**, while handling **TLS**, **logging**, **health checks**, and **graceful shutdown** automatically.
+
+---
+
+## Features
+
+- Single RabbitMQ connection per service
+- Supports `amqp://` and `amqps://`
+- Message publishing and consuming helpers
+- Built-in bootstrap for service lifecycle
+- Structured logger (pretty logs in dev, JSON in prod)
+- Health check helper for monitoring
+- Graceful shutdown (SIGINT / SIGTERM)
+- Framework agnostic (Express, Fastify, NestJS)
+
+---
+
+## Installation
+
+```bash
+npm install @kaushverse/rabbitmq-core
+```
+
+## Full Express Service Example
+
+Below is a complete example showing how to use `@kaushverse/rabbitmq-core`
+inside an Express-based microservice with health checks and publishing routes.
+
+### Example: `order-service`
+
+```ts
+import "dotenv/config";
+import express from "express";
+import { bootstrap, rabbitHealth } from "@kaushverse/rabbitmq-core";
+
+const app = express();
+app.use(express.json());
+
+// Health check endpoint
+app.get("/health", (_, res) => {
+  res.json({
+    status: "ok",
+    ...rabbitHealth(),
+  });
+});
+
+// Bootstrap the service
+bootstrap({
+  serviceName: "order-service",
+  rabbit: {
+    url: process.env.RABBITMQ_URL!,
+    tls: {
+      caPath: process.env.RABBITMQ_CA_PATH,
+      servername: process.env.RABBITMQ_SERVERNAME,
+      rejectUnauthorized: false, // set true in production
+    },
+  },
+  start: () => {
+    app.listen(3000, () => {
+      console.log("🚀 API running on port 3000");
+    });
+  },
+});
+```
+
+```js
+RABBITMQ_URL=amqps://user:password@mq.example.com:5671/vhost
+RABBITMQ_CA_PATH=./certs/ca.pem
+RABBITMQ_SERVERNAME=mq.example.com
+```
+
+## Publishing Messages
+
+Use `publishMessage` to publish events to RabbitMQ.
+The SDK automatically handles channels, serialization, and persistence.
+
+### Import
+
+```js
+import { publishMessage } from "@kaushverse/rabbitmq-core";
+
+await publishMessage({
+  exchange: "order.events",
+  type: "topic",
+  routingKey: "order.created",
+  message: {
+    orderId: "ORD-123",
+    amount: 499,
+  },
+  headers: {
+    source: "order-service",
+  },
+});
+```

package/dist/index.d.ts

@@ -36,13 +36,15 @@ declare function consumeMessage(options: ConsumeOptions, handler: (data: any, ra
 
 declare function publishMessage({ exchange, type, routingKey, message, headers, }: PublishOptions): Promise<void>;
 
-declare function bootstrap({ serviceName, rabbit, start, }: {
+type BootstrapOptions = {
     serviceName: string;
+    start: () => void | Promise<void>;
     rabbit: {
         url: string;
+        tls?: RabbitTLSOptions;
     };
-    start: () => void | Promise<void>;
-}): Promise<void>;
+};
+declare function bootstrap({ serviceName, rabbit, start, }: BootstrapOptions): Promise<void>;
 
 declare function rabbitHealth(): {
     "\uD83D\uDC07": {
@@ -53,6 +55,7 @@ declare function rabbitHealth(): {
 };
 
 declare function setLoggerService(name: string): void;
+declare function setPrettyLogs(enabled: boolean): void;
 declare const logger: {
     info: (msg: string, meta?: any) => void;
     warn: (msg: string, meta?: any) => void;
@@ -60,4 +63,4 @@ declare const logger: {
     debug: (msg: string, meta?: any) => void;
 };
 
-export { type ConsumeOptions, type ExchangeType, type LogLevel, type PublishOptions, type RabbitConnectionOptions, type RabbitTLSOptions, bootstrap, consumeMessage, getChannel, logger, publishMessage, rabbitEvents, rabbitHealth, setLoggerService };
+export { type ConsumeOptions, type ExchangeType, type LogLevel, type PublishOptions, type RabbitConnectionOptions, type RabbitTLSOptions, bootstrap, consumeMessage, getChannel, logger, publishMessage, rabbitEvents, rabbitHealth, setLoggerService, setPrettyLogs };

package/dist/index.js

@@ -37,7 +37,8 @@ __export(index_exports, {
   publishMessage: () => publishMessage,
   rabbitEvents: () => rabbitEvents,
   rabbitHealth: () => rabbitHealth,
-  setLoggerService: () => setLoggerService
+  setLoggerService: () => setLoggerService,
+  setPrettyLogs: () => setPrettyLogs
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -172,11 +173,23 @@ async function publishMessage({
 }
 
 // src/logger/index.ts
-var serviceName = "rabbitmq-core";
+var serviceName = "service";
+var prettyLogs = true;
 function setLoggerService(name) {
   serviceName = name;
 }
+function setPrettyLogs(enabled) {
+  prettyLogs = enabled;
+}
 function log(level, message, meta) {
+  if (prettyLogs) {
+    if (meta) {
+      console[level](`${message}`, meta);
+    } else {
+      console[level](`${message}`);
+    }
+    return;
+  }
   const entry = {
     level,
     service: serviceName,
@@ -201,11 +214,12 @@ async function bootstrap({
 }) {
   try {
     setLoggerService(serviceName2);
+    setPrettyLogs(process.env.NODE_ENV !== "production");
     logger.info("\u{1F9E9} Bootstrap started");
     await connectRabbitMQ(rabbit);
     logger.info("\u{1F407} RabbitMQ connected");
     await start();
-    logger.info("\u{1F680} Service started successfully");
+    logger.info(`\u{1F680} ${serviceName2} started successfully`);
     const shutdown = async (signal) => {
       logger.warn("\u{1F6D1} Shutdown signal received", { signal });
       await closeRabbitMQ();
@@ -243,5 +257,6 @@ function rabbitHealth() {
   publishMessage,
   rabbitEvents,
   rabbitHealth,
-  setLoggerService
+  setLoggerService,
+  setPrettyLogs
 });

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@kaushverse/rabbitmq-core",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Reusable RabbitMQ (AMQP / AMQPS) core for Node.js & microservices",
   "author": "Kaushik (KaushVerse)",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
     "build": "tsup src/index.ts --dts",