mailer-advance 1.0.2 → 1.0.4

package/README.md

@@ -1,85 +1,104 @@
-# @pranay/mailer-advance
+# mailer-advance
 
-Advanced Node.js email service with dynamic SMTP configuration, multi-database support (MongoDB/PostgreSQL/MySQL), and a built-in UI.
+[![npm version](https://img.shields.io/npm/v/mailer-advance.svg)](https://www.npmjs.com/package/mailer-advance)
+[![license](https://img.shields.io/npm/l/mailer-advance.svg)](https://www.npmjs.com/package/mailer-advance)
 
-## Features
+An advanced, production-ready Node.js email service with dynamic SMTP configuration, multi-database support (MongoDB, PostgreSQL, MySQL), and a premium built-in UI.
 
-- **Multi-DB Support**: Store SMTP settings in MongoDB, PostgreSQL, or MySQL.
-- **Dynamic Configuration**: Change SMTP servers on-the-fly via API or UI.
-- **Built-in UI**: Modern, dark-mode interface for sending emails and managing configurations.
-- **Secure**: TLS support with explicit control over certificate validation.
-- **Attachments**: Full support for file attachments and embedded images.
+## 🚀 Features
 
-## Quick Start
+- **Multi-Database Support**: Seamlessly store SMTP configurations in MongoDB, PostgreSQL, or MySQL.
+- **Dynamic SMTP**: Switch SMTP servers at runtime via API or the built-in management UI.
+- **Premium UI**: Modern dark-mode interfaces for sending emails, listing configurations, and editing settings.
+- **STARTTLS & SSL/TLS**: Full control over secure connections and certificate validation.
+- **Rich Emails**: Support for file attachments and embedded images ($cid$ mapping).
+- **Developer Friendly**: Exported as a reusable module for any Express/Node.js application.
+- **Ultra Lightweight**: Optimized package size (~11KB) with zero build overhead.
 
-### 1. Installation
+## 📦 Installation
 
 ```bash
-git clone https://github.com/your-repo/mailer-advance
-cd mailer-advance
-npm install
+npm install mailer-advance
+```
+
+## 🛠 Usage
+
+### 1. Integration as a Library (Recommended)
+
+Import routes and services directly into your existing Express app:
+
+```javascript
+import express from 'express';
+import { contactRoutes, configRoutes, mailService } from 'mailer-advance';
+
+const app = express();
+app.use(express.json());
+
+// 1. Mount management routes
+app.use('/api/mail', contactRoutes);
+app.use('/api/config', configRoutes);
+
+// 2. Or use the mail service programmatically
+const sendTest = async () => {
+    await mailService.sendEmail({
+        to: 'recipient@example.com',
+        subject: 'Hello World',
+        text: 'Sent via mailer-advance'
+    });
+};
+
+app.listen(3000);
 ```
 
-### 2. Environment Setup
+### 2. Standalone Service
 
-Create a `.env` file in the root:
+If you've cloned the repository, you can run it as a standalone server:
 
 ```bash
+npm install
+npm run dev # Starts on http://localhost:3000
+```
+
+## ⚙️ Configuration
+
+The service uses Environment Variables for default settings. Create a `.env` file:
+
+```env
 PORT=3000
+
+# Database Configuration
 DB_TYPE=mongodb # options: mongodb, postgres, mysql
 DB_URI=mongodb://localhost:27017/mail_service_db
 
-# Default SMTP (Fallback)
+# Default SMTP Fallback
 MAIL_HOST=smtp.example.com
 MAIL_PORT=587
 MAIL_SECURE=false
-MAIL_USER=user@example.com
-MAIL_PASS=password
-MAIL_FROM_NAME="Service Name"
+MAIL_USER=your-user
+MAIL_PASS=your-password
+MAIL_FROM_NAME="System Name"
 MAIL_FROM_EMAIL=noreply@example.com
 ```
 
-### 3. Run the Service
+## 🖥 Built-in UI
 
-```bash
-# Development
-npm run dev
+When running the service, visit:
+- **`http://localhost:3000/contact.html`**: Send test emails with attachments.
+- **`http://localhost:3000/list-configs.html`**: View and manage saved SMTP profiles.
+- **`http://localhost:3000/config.html`**: Add or edit SMTP configurations.
 
-# Production
-npm run build
-npm start
-```
+## 📄 API Reference
 
-## Usage
-
-### 1. Standalone Service
-- **Send Email**: `http://localhost:3000/contact.html`
-- **List Configs**: `http://localhost:3000/list-configs.html`
-- **Add Config**: `http://localhost:3000/config.html`
-
-### 2. Integration into your Node.js App
-You can use this package as a module in your existing Express application:
-
-```javascript
-import express from 'express';
-import { contactRoutes, configRoutes } from 'mailer-advance';
-
-const app = express();
-
-// Mount the mailer routes
-app.use('/api/mail', contactRoutes);
-app.use('/api/config', configRoutes);
-
-app.listen(3001);
-```
+### `POST /api/contact`
+Send an email using standard or dynamic config.
+- **Body**: `name`, `email`, `to`, `message`, `configId` (optional).
+- **Files**: Supports `attachments` (multipart/form-data).
 
-### API Usage
-- `POST /api/contact`: Send email (supports attachments).
-- `GET /api/config`: List all SMTP configurations.
-- `POST /api/config`: Save/Update SMTP configuration.
+### `GET /api/config`
+Returns a JSON list of all stored SMTP configurations.
 
-## Optimization
-The package size is optimized to be extremely lightweight (~KBs) by excluding build artifacts and dev-dependencies from the final NPM bundle.
+### `POST /api/config`
+Save or update an SMTP configuration profile.
 
-## License
-MIT
+## 📜 License
+MIT © Pranay

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailer-advance",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Advanced Node.js email service with dynamic SMTP configuration, multi-database support (MongoDB/SQL), and a built-in UI.",
   "main": "src/server.js",
   "type": "module",
@@ -8,7 +8,8 @@
     "start": "node src/server.js",
     "dev": "nodemon --watch .env --watch src src/server.js",
     "build": "esbuild src/server.js --bundle --platform=node --format=esm --target=node20 --outfile=dist/server.js --external:express --external:nodemailer --external:dotenv --external:cors",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "release": "git add . && git commit -m 'chore: release v1.0.4' && git push && npm publish"
   },
   "publishConfig": {
     "access": "public"