@impruthvi/nodemail 0.3.0 → 0.4.0

package/examples/with-mailable-templates.ts

@@ -0,0 +1,146 @@
+import { Mailable, Mail } from '../src';
+import { config } from 'dotenv';
+
+config();
+
+/**
+ * Example: Using Mailable class with templates
+ * 
+ * This demonstrates how to create reusable email classes
+ * that use template engines for rendering
+ */
+
+class WelcomeEmail extends Mailable {
+  constructor(
+    private user: { name: string; email: string },
+    private appName: string
+  ) {
+    super();
+  }
+
+  build() {
+    return this.subject(`Welcome to ${this.appName}!`)
+      .view('welcome', {
+        name: this.user.name,
+        email: this.user.email,
+        appName: this.appName,
+        joinDate: new Date().toLocaleDateString(),
+      });
+  }
+}
+
+class InvoiceEmail extends Mailable {
+  constructor(
+    private invoice: {
+      number: string;
+      customer: string;
+      items: Array<{ name: string; quantity: number; price: number }>;
+      total: number;
+    }
+  ) {
+    super();
+  }
+
+  build() {
+    return this.subject(`Invoice #${this.invoice.number}`)
+      .view('invoice', {
+        invoiceNumber: this.invoice.number,
+        customerName: this.invoice.customer,
+        items: this.invoice.items,
+        total: this.invoice.total,
+      });
+  }
+}
+
+async function main() {
+  // Configure with Handlebars for welcome email
+  Mail.configure({
+    default: 'smtp',
+    from: {
+      address: process.env.MAIL_FROM_ADDRESS || 'noreply@example.com',
+      name: process.env.MAIL_FROM_NAME || 'Example App',
+    },
+    mailers: {
+      smtp: {
+        driver: 'smtp',
+        host: process.env.MAIL_HOST || 'smtp.ethereal.email',
+        port: parseInt(process.env.MAIL_PORT || '587'),
+        auth: {
+          user: process.env.MAIL_USERNAME || '',
+          pass: process.env.MAIL_PASSWORD || '',
+        },
+      },
+    },
+    templates: {
+      engine: 'handlebars',
+      viewsPath: './examples/views',
+      cache: true,
+    },
+  });
+
+  try {
+    // Method 1: Laravel-style - Mail.to().send(mailable)
+    console.log('📧 Method 1: Sending welcome email (Laravel-style)...');
+    const welcomeEmail = new WelcomeEmail(
+      { name: 'John Doe', email: 'john@example.com' },
+      'NodeMail'
+    );
+
+    const response1 = await Mail.to('john@example.com').send(welcomeEmail);
+
+    console.log('✅ Welcome email sent!');
+    console.log('Response:', response1);
+
+    // Switch to EJS for invoice email
+    Mail.configure({
+      default: 'smtp',
+      from: {
+        address: process.env.MAIL_FROM_ADDRESS || 'noreply@example.com',
+        name: process.env.MAIL_FROM_NAME || 'Example App',
+      },
+      mailers: {
+        smtp: {
+          driver: 'smtp',
+          host: process.env.MAIL_HOST || 'smtp.ethereal.email',
+          port: parseInt(process.env.MAIL_PORT || '587'),
+          auth: {
+            user: process.env.MAIL_USERNAME || '',
+            pass: process.env.MAIL_PASSWORD || '',
+          },
+        },
+      },
+      templates: {
+        engine: 'ejs',
+        viewsPath: './examples/views',
+        cache: true,
+      },
+    });
+
+    // Method 2: Direct mailable send
+    console.log('\n📧 Method 2: Sending invoice email (Direct)...');
+    const invoiceEmail = new InvoiceEmail({
+      number: 'INV-2025-001',
+      customer: 'Jane Smith',
+      items: [
+        { name: 'Pro Plan', quantity: 1, price: 99.99 },
+        { name: 'Extra Storage', quantity: 2, price: 19.99 },
+      ],
+      total: 139.97,
+    });
+
+    // Set mail manager and send directly
+    invoiceEmail.setMailManager(Mail['getInstance']());
+    const response2 = await invoiceEmail.to('jane@example.com').send();
+
+    console.log('✅ Invoice email sent!');
+    console.log('Response:', response2);
+
+    console.log('\n🎉 Both methods work perfectly!');
+    console.log('✨ Method 1 (Recommended): Mail.to().send(mailable)');
+    console.log('✨ Method 2 (Alternative): mailable.to().send()');
+  } catch (error) {
+    console.error('❌ Failed to send email:', error);
+  }
+}
+
+void main();

package/examples/with-pug.ts

@@ -0,0 +1,66 @@
+import { Mail } from '../src';
+import { config } from 'dotenv';
+
+config();
+
+/**
+ * Example: Using Pug templates
+ * 
+ * Install dependencies:
+ * npm install pug
+ */
+
+async function main() {
+  // Configure Mail with Pug template engine
+  Mail.configure({
+    default: 'smtp',
+    from: {
+      address: process.env.MAIL_FROM_ADDRESS || 'noreply@example.com',
+      name: process.env.MAIL_FROM_NAME || 'Example App',
+    },
+    mailers: {
+      smtp: {
+        driver: 'smtp',
+        host: process.env.MAIL_HOST || 'smtp.ethereal.email',
+        port: parseInt(process.env.MAIL_PORT || '587'),
+        auth: {
+          user: process.env.MAIL_USERNAME || '',
+          pass: process.env.MAIL_PASSWORD || '',
+        },
+      },
+    },
+    templates: {
+      engine: 'pug',
+      viewsPath: './examples/views',
+      extension: '.pug',
+      cache: true,
+    },
+  });
+
+  try {
+    // Send email using Pug template
+    const response = await Mail.to('user@example.com')
+      .subject('Account Notification')
+      .template('notification')
+      .data({
+        title: 'Account Notification',
+        message: 'Important Account Update',
+        username: 'Alex Johnson',
+        urgent: true,
+        items: [
+          'Password changed successfully',
+          'New device login detected',
+          'Security settings updated',
+        ],
+        timestamp: new Date().toLocaleString(),
+      })
+      .send();
+
+    console.log('✅ Email sent successfully with Pug template!');
+    console.log('Response:', response);
+  } catch (error) {
+    console.error('❌ Failed to send email:', error);
+  }
+}
+
+void main();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@impruthvi/nodemail",
-  "version": "0.3.0",
-  "description": "A unified mail service for Node.js/TypeScript with Laravel-like simplicity. Support for multiple providers (SMTP, SendGrid, AWS SES, Mailgun, Resend, Postmark) - just change environment variables, no code changes needed.",
+  "version": "0.4.0",
+  "description": "A unified mail service for Node.js/TypeScript with Laravel-like simplicity. Support for multiple providers (SMTP, SendGrid, AWS SES, Mailgun, Resend, Postmark) and template engines (Handlebars, EJS, Pug) - just change environment variables, no code changes needed.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -11,8 +11,8 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
-    "lint": "eslint src/**/*.ts",
-    "lint:fix": "eslint src/**/*.ts --fix",
+    "lint": "eslint \"src/**/*.ts\" \"examples/**/*.ts\" \"tests/**/*.ts\"",
+    "lint:fix": "eslint \"src/**/*.ts\" \"examples/**/*.ts\" \"tests/**/*.ts\" --fix",
     "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
     "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
     "prepublishOnly": "npm run build",
@@ -64,9 +64,12 @@
   "peerDependencies": {
     "@aws-sdk/client-ses": "^3.699.0",
     "@sendgrid/mail": "^8.1.4",
+    "ejs": "^3.1.10",
     "form-data": "^4.0.1",
+    "handlebars": "^4.7.8",
     "mailgun.js": "^10.2.3",
     "postmark": "^4.0.5",
+    "pug": "^3.0.3",
     "resend": "^4.0.1"
   },
   "peerDependenciesMeta": {
@@ -87,6 +90,15 @@
     },
     "postmark": {
       "optional": true
+    },
+    "handlebars": {
+      "optional": true
+    },
+    "ejs": {
+      "optional": true
+    },
+    "pug": {
+      "optional": true
     }
   },
   "devDependencies": {