@kaushverse/rabbitmq-core 1.1.3 → 1.1.6

package/README.md

@@ -1,98 +1,155 @@
-# @kaushverse/rabbitmq-core
+# @kaushverse/rabbitmq-core 🐇
 
-Production-ready RabbitMQ SDK for Node.js microservices.
+🚀 **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.
+`@kaushverse/rabbitmq-core` provides a **clean, opinionated abstraction** over RabbitMQ for Node.js services.
+
+It handles **connections, publishing, consuming, health checks, TLS, logging, and graceful shutdown** — automatically — so you can focus on business logic, not infra glue.
 
 ---
 
-## Features
+## ✨ 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)
+- 🔗 **Single RabbitMQ connection per service**
+- 🔐 Supports `amqp://` and `amqps://` (TLS)
+- 📤 Easy message publishing helpers
+- 📥 Consumer utilities with retry control
+- ❤️ Built-in RabbitMQ health check
+- 🧼 Graceful shutdown (`SIGINT`, `SIGTERM`)
+- 📦 Framework-agnostic (Express, Fastify, NestJS)
+- 📊 Pretty logs in dev, structured JSON logs in prod
 
 ---
 
-## Installation
+## 📦 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.
+## 🏗️ Full Express Service Example
 
 ### Example: `order-service`
 
-```ts
-import "dotenv/config";
-import express from "express";
-import { bootstrap, rabbitHealth } from "@kaushverse/rabbitmq-core";
+This example shows how to bootstrap a production-ready Express service using  
+`@kaushverse/rabbitmq-core`.
 
-const app = express();
-app.use(express.json());
+---
 
-// Health check endpoint
-app.get("/health", (_, res) => {
-  res.json({
-    status: "ok",
-    ...rabbitHealth(),
-  });
-});
+### 📁 `src/index.ts`
+
+```ts
+import "dotenv/config";
+import { bootstrap } from "@kaushverse/rabbitmq-core";
+import { startServer } from "./server.js";
 
-// 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
+      rejectUnauthorized: true,
     },
   },
-  start: () => {
-    app.listen(3000, () => {
-      console.log("🚀 API running on port 3000");
-    });
-  },
+
+  start: startServer,
 });
 ```
+### 📁 src/server.ts
 
-```js
-RABBITMQ_URL=amqps://user:password@mq.example.com:5671/vhost
-RABBITMQ_CA_PATH=./certs/ca.pem
-RABBITMQ_SERVERNAME=mq.example.com
+```ts
+import express from "express";
+import { rabbitHealth } from "@kaushverse/rabbitmq-core";
+import publishRoutes from "./routes/publish.routes.js";
+
+export function startServer() {
+  const app = express();
+  app.use(express.json());
+
+  app.get("/health", (_, res) => {
+    res.json({
+      status: "ok",
+      rabbit: rabbitHealth(),
+    });
+  });
+
+  app.use("/publish", publishRoutes);
+
+  app.listen(3000, () => {
+    console.log("🚀 API running on port 3000");
+  });
+}
 ```
 
-## Publishing Messages
+## 📤 Publishing Messages
 
-Use `publishMessage` to publish events to RabbitMQ.
-The SDK automatically handles channels, serialization, and persistence.
+Use publishMessage to emit events to RabbitMQ.
 
-### Import
+Channels, serialization, exchange declaration, and message persistence are handled automatically.
 
-```js
+```ts
 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",
   },
 });
 ```
+
+## 🔐 Environment Variables
+RABBITMQ_URL=amqps://user:password@mq.example.com:5671/vhost
+RABBITMQ_CA_PATH=./certs/ca.pem
+RABBITMQ_SERVERNAME=mq.example.com
+PORT=3000
+
+## ❤️ Health Check
+
+Built-in RabbitMQ health reporting.
+
+```ts
+import { rabbitHealth } from "@kaushverse/rabbitmq-core";
+
+app.get("/health", (_, res) => {
+  res.json({
+    status: "ok",
+    rabbit: rabbitHealth(),
+  });
+});
+```
+
+## Example Response
+
+{
+  "status": "ok",
+  "rabbit": {
+    "connected": true,
+    "url": "amqps://mq.example.com"
+  }
+}
+
+## 🛡️ Production Best Practices
+
+✅ Always use amqps://
+
+🔐 Keep rejectUnauthorized: true
+
+🔗 One service = one RabbitMQ connection
+
+🔁 Handle retries at consumer level
+
+🧾 Use dedicated users & vhosts per service
+
+📊 Monitor connections & queues via RabbitMQ Management UI

package/dist/index.d.ts

@@ -36,9 +36,10 @@ declare function isRabbitConnected(): boolean;
 
 type BootstrapOptions = {
     serviceName: string;
+    start: () => void | Promise<void>;
     rabbit: RabbitConnectionOptions;
 };
-declare function bootstrap({ serviceName, rabbit }: BootstrapOptions): Promise<void>;
+declare function bootstrap({ serviceName, rabbit, start, }: BootstrapOptions): Promise<void>;
 
 declare function publishMessage({ exchange, type, routingKey, message, headers, }: PublishOptions): Promise<void>;
 

package/dist/index.js

@@ -164,23 +164,32 @@ var logger = {
 };
 
 // src/bootstrap.ts
-async function bootstrap({ serviceName: serviceName2, rabbit }) {
+async function bootstrap({
+  serviceName: serviceName2,
+  rabbit,
+  start
+}) {
   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} ${serviceName2} started successfully`);
     const shutdown = async (signal) => {
       logger.warn("\u{1F6D1} Shutdown signal received", { signal });
       await closeRabbitMQ();
+      logger.info("\u{1F512} RabbitMQ connection closed");
       logger.info("\u{1F44B} Service stopped gracefully");
       process.exit(0);
     };
     process.on("SIGINT", shutdown);
     process.on("SIGTERM", shutdown);
   } catch (err) {
-    logger.error("\u{1F4A5} Bootstrap failed", { err });
+    logger.error("\u{1F4A5} Startup failed", {
+      error: err instanceof Error ? err : err
+    });
     process.exit(1);
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaushverse/rabbitmq-core",
-  "version": "1.1.3",
+  "version": "1.1.6",
   "description": "Reusable RabbitMQ (AMQP / AMQPS) core for Node.js & microservices",
   "author": "Kaushik (KaushVerse)",
   "license": "MIT",