mailer-advance 5.0.0 → 7.0.0

package/README.md

@@ -1,4 +1,4 @@
-# 🚀 mailer-advance v5.0
+# 🚀 mailer-advance v7.0
 
 [![npm version](https://img.shields.io/npm/v/mailer-advance.svg?style=flat-square)](https://www.npmjs.com/package/mailer-advance)
 [![license](https://img.shields.io/npm/l/mailer-advance.svg?style=flat-square)](https://www.npmjs.com/package/mailer-advance)
@@ -8,13 +8,13 @@
 
 ---
 
-## ✨ v5.0 Highlights
+## ✨ v7.0 Highlights
 
-- ⚡ **Smart Connection**: No need to pass URIs manually. `connect()` now automatically falls back to `process.env.DB_URI`.
-- 🗄️ **Multi-DB Persistence**: Store configurations in MongoDB, Postgres, or MySQL.
-- 🔄 **Zero-Restart Swapping**: Switch SMTP credentials at runtime via the Dashboard.
+- ⚡ **Smart Connection**: `connect()` automatically falls back to `process.env.DB_URI`.
+- 📖 **Interactive Swagger UI**: Now fully supported in both standalone and **library mode**.
+- 🗄️ **Multi-DB Persistence**: Support for MongoDB, Postgres, and MySQL.
+- 🔄 **Hot-Swapping**: Switch SMTP credentials at runtime via the Dashboard.
 - 🛡️ **Production Ready**: Full STARTTLS support and descriptive error guards.
-- 📖 **Swagger UI**: API docs auto-served at `/api-docs`.
 
 ---
 
@@ -33,6 +33,7 @@ import express from 'express';
 import { 
     contactRoutes, 
     configRoutes, 
+    swaggerRoutes, // ✨ New in v7.0
     dbService, 
     DatabaseFactory 
 } from 'mailer-advance';
@@ -42,18 +43,38 @@ app.use(express.json());
 
 // 1. Initialize Persistence (Smart Fallback to process.env.DB_URI)
 const repository = DatabaseFactory.createRepository(process.env.DB_TYPE || 'mongodb');
-await repository.connect(); // ✨ Automagically uses DB_URI from .env
+await repository.connect(); 
 dbService.setRepository(repository);
 
-// 2. Mount API Routes
+// 2. Mount API Routes & UI
 app.use('/api/mail', contactRoutes);
 app.use('/api/config', configRoutes);
+app.use('/api-docs', swaggerRoutes); // ✨ Mount interactive docs
 
-app.listen(3000, () => console.log('🚀 Engine active at http://localhost:3000'));
+app.listen(3000, () => {
+    console.log('🚀 Engine active at http://localhost:3000');
+    console.log('📖 API Docs: http://localhost:3000/api-docs');
+});
 ```
 
 ---
 
+## 📚 Interactive API Documentation (Swagger)
+
+V7.0.0 enables the **Swagger UI** for library users. Unlike the standalone server where it's pre-mounted, library consumers must explicitly mount it:
+
+👉 **`app.use('/api-docs', swaggerRoutes);`**
+
+Once mounted, navigate to:
+**`http://localhost:3000/api-docs`**
+
+From there, you can:
+- 🔍 **Explore**: See all available endpoints and their data structures.
+- 🧪 **Test**: Send live requests to your mailer engine directly from the browser.
+- 📜 **Spec**: Download the OpenApi spec for use in other tools.
+
+---
+
 ## ⚙️ Environment Configuration (.env)
 
 | Variable | Requirement | Description |
@@ -64,13 +85,12 @@ app.listen(3000, () => console.log('🚀 Engine active at http://localhost:3000'
 | `MAIL_PORT` | Optional | Default SMTP Port (Default: `587`). |
 
 ### 💡 The .env Setup Guide
-For the engine to function correctly as a library, ensure your project's `.env` contains:
 ```env
 # Database
 DB_TYPE=mongodb
 DB_URI=mongodb://127.0.0.1:27017/my_mailer_db
 
-# Fallback SMTP (Initial Setup)
+# Fallback SMTP
 MAIL_HOST=smtp.your-provider.com
 MAIL_PORT=587
 MAIL_USER=admin@example.com
@@ -81,19 +101,9 @@ MAIL_PASS=your-secure-password
 
 ## 🔒 Security & Best Practices
 
-- **App Privacy**: Always wrap the mailer routes/UI with your own authentication middleware in production.
-- **TLS validation**: Ensure `rejectUnauthorized` is `true` for production SMTP connections.
-- **Secrets**: Encrypt your `.env` files using tools like [Dotenvx](https://dotenvx.com).
-
----
-
-## 🛠 Troubleshooting
-
-### `Error: Database connection URI is required`
-This occurs if `process.env.DB_URI` is undefined.
-1. Ensure your `.env` file exists in the root of your project.
-2. Verify you are using `dotenv.config()` BEFORE initializing the mailer.
-3. Check the variable name is exactly `DB_URI`.
+- **App Privacy**: Always wrap the mailer routes/UI with your own authentication middleware.
+- **TLS validation**: Ensure `rejectUnauthorized` is `true` for production SMTP.
+- **Secrets**: Encrypt your `.env` files using [Dotenvx](https://dotenvx.com).
 
 ---
 

package/index.js

@@ -1,5 +1,6 @@
 import contactRoutes from './src/routes/contact.routes.js';
 import configRoutes from './src/routes/config.routes.js';
+import swaggerRoutes from './src/routes/swagger.routes.js';
 import mailService from './src/services/mail.service.js';
 import dbService from './src/services/db.service.js';
 import DatabaseFactory from './src/services/database.factory.js';
@@ -7,6 +8,7 @@ import DatabaseFactory from './src/services/database.factory.js';
 export {
     contactRoutes,
     configRoutes,
+    swaggerRoutes,
     mailService,
     dbService,
     DatabaseFactory
@@ -16,6 +18,7 @@ export {
 export default {
     contactRoutes,
     configRoutes,
+    swaggerRoutes,
     mailService,
     dbService,
     DatabaseFactory

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailer-advance",
-  "version": "5.0.0",
+  "version": "7.0.0",
   "description": "Advanced Node.js email service with dynamic SMTP configuration, multi-database support (MongoDB/SQL), and a built-in UI.",
   "main": "index.js",
   "type": "module",

package/src/routes/swagger.routes.js

@@ -0,0 +1,10 @@
+import express from 'express';
+import swaggerUi from 'swagger-ui-express';
+import swaggerSpec from '../config/swagger.config.js';
+
+const router = express.Router();
+
+router.use('/', swaggerUi.serve);
+router.get('/', swaggerUi.setup(swaggerSpec));
+
+export default router;