@sibiltech/sibil-mail 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Type Definitions
+ *
+ * All TypeScript interfaces and types for the email library.
+ */
+import { Transporter } from 'nodemailer';
+/**
+ * SMTP Configuration
+ * Configuration object for SMTP server connection
+ */
+export interface SmtpConfig {
+    host: string;
+    port: number;
+    secure?: boolean;
+    auth: {
+        user: string;
+        pass: string;
+    };
+    tls?: {
+        rejectUnauthorized?: boolean;
+    };
+}
+/**
+ * Email Options
+ * Configuration for sending an email
+ */
+export interface EmailOptions {
+    from: string;
+    to: string | string[];
+    subject: string;
+    text?: string;
+    html?: string;
+    cc?: string | string[];
+    bcc?: string | string[];
+    replyTo?: string;
+    attachments?: EmailAttachment[];
+}
+/**
+ * Email Attachment
+ * File attachment configuration
+ */
+export interface EmailAttachment {
+    filename: string;
+    path?: string;
+    content?: string | Buffer;
+    contentType?: string;
+    cid?: string;
+}
+/**
+ * Email Result
+ * Result of email sending operation
+ */
+export interface EmailResult {
+    success: boolean;
+    messageId?: string;
+    error?: string;
+    response?: string;
+}
+/**
+ * Transport Factory Function
+ * Creates a nodemailer transporter instance
+ */
+export type TransportFactory = (config: SmtpConfig) => Transporter;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,GAAG,CAAC,EAAE;QACJ,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,UAAU,KAAK,WAAW,CAAC"}

package/dist/types.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Type Definitions
+ *
+ * All TypeScript interfaces and types for the email library.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/dist/utils/email-validator.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Email Validation Utilities
+ *
+ * Helper functions for validating email addresses and email-related data.
+ */
+/**
+ * Validate Email Address
+ *
+ * Validates if a string is a valid email address format.
+ *
+ * @param email - Email address to validate
+ * @returns True if email is valid, false otherwise
+ *
+ * @example
+ * ```typescript
+ * isValidEmail('user@example.com'); // true
+ * isValidEmail('invalid-email');    // false
+ * ```
+ */
+export declare function isValidEmail(email: string): boolean;
+/**
+ * Validate Email Addresses
+ *
+ * Validates an array of email addresses.
+ *
+ * @param emails - Array of email addresses
+ * @returns Object with valid and invalid emails
+ */
+export declare function validateEmails(emails: string[]): {
+    valid: string[];
+    invalid: string[];
+};
+/**
+ * Normalize Email Address
+ *
+ * Normalizes email address by trimming and converting to lowercase.
+ *
+ * @param email - Email address to normalize
+ * @returns Normalized email address
+ */
+export declare function normalizeEmail(email: string): string;
+/**
+ * Extract Domain from Email
+ *
+ * Extracts the domain part from an email address.
+ *
+ * @param email - Email address
+ * @returns Domain part or null if invalid
+ */
+export declare function extractDomain(email: string): string | null;
+//# sourceMappingURL=email-validator.d.ts.map

package/dist/utils/email-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-validator.d.ts","sourceRoot":"","sources":["../../src/utils/email-validator.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAGnD;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG;IAChD,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAaA;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAG1D"}

package/dist/utils/email-validator.js

@@ -0,0 +1,74 @@
+"use strict";
+/**
+ * Email Validation Utilities
+ *
+ * Helper functions for validating email addresses and email-related data.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidEmail = isValidEmail;
+exports.validateEmails = validateEmails;
+exports.normalizeEmail = normalizeEmail;
+exports.extractDomain = extractDomain;
+/**
+ * Validate Email Address
+ *
+ * Validates if a string is a valid email address format.
+ *
+ * @param email - Email address to validate
+ * @returns True if email is valid, false otherwise
+ *
+ * @example
+ * ```typescript
+ * isValidEmail('user@example.com'); // true
+ * isValidEmail('invalid-email');    // false
+ * ```
+ */
+function isValidEmail(email) {
+    const emailRegex = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/;
+    return emailRegex.test(email);
+}
+/**
+ * Validate Email Addresses
+ *
+ * Validates an array of email addresses.
+ *
+ * @param emails - Array of email addresses
+ * @returns Object with valid and invalid emails
+ */
+function validateEmails(emails) {
+    const valid = [];
+    const invalid = [];
+    emails.forEach((email) => {
+        if (isValidEmail(email)) {
+            valid.push(email);
+        }
+        else {
+            invalid.push(email);
+        }
+    });
+    return { valid, invalid };
+}
+/**
+ * Normalize Email Address
+ *
+ * Normalizes email address by trimming and converting to lowercase.
+ *
+ * @param email - Email address to normalize
+ * @returns Normalized email address
+ */
+function normalizeEmail(email) {
+    return email.trim().toLowerCase();
+}
+/**
+ * Extract Domain from Email
+ *
+ * Extracts the domain part from an email address.
+ *
+ * @param email - Email address
+ * @returns Domain part or null if invalid
+ */
+function extractDomain(email) {
+    const match = email.match(/@(.+)$/);
+    return match ? match[1] : null;
+}
+//# sourceMappingURL=email-validator.js.map

package/dist/utils/email-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-validator.js","sourceRoot":"","sources":["../../src/utils/email-validator.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAgBH,oCAGC;AAUD,wCAgBC;AAUD,wCAEC;AAUD,sCAGC;AApED;;;;;;;;;;;;;GAaG;AACH,SAAgB,YAAY,CAAC,KAAa;IACxC,MAAM,UAAU,GAAG,kDAAkD,CAAC;IACtE,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,MAAgB;IAI7C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACvB,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC5B,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,KAAa;IAC1C,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,KAAa;IACzC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACjC,CAAC"}

package/dist/utils/template-engine.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Template Engine Utilities
+ *
+ * Simple template engine for email content.
+ * Supports variable replacement in email templates.
+ */
+/**
+ * Replace Variables in Template
+ *
+ * Replaces {{variable}} placeholders with actual values.
+ *
+ * @param template - Template string with {{variable}} placeholders
+ * @param variables - Object with variable values
+ * @returns Template with replaced variables
+ *
+ * @example
+ * ```typescript
+ * const template = 'Hello {{name}}, welcome to {{company}}!';
+ * const result = replaceVariables(template, {
+ *   name: 'John',
+ *   company: 'Sibil'
+ * });
+ * // Result: 'Hello John, welcome to Sibil!'
+ * ```
+ */
+export declare function replaceVariables(template: string, variables: Record<string, string | number | boolean>): string;
+/**
+ * Replace Variables in HTML Template
+ *
+ * Same as replaceVariables but also escapes HTML in values.
+ *
+ * @param template - HTML template string
+ * @param variables - Object with variable values
+ * @returns HTML template with replaced variables
+ */
+export declare function replaceVariablesInHtml(template: string, variables: Record<string, string | number | boolean>): string;
+/**
+ * Create Email Template
+ *
+ * Creates a complete email template with header and footer.
+ *
+ * @param content - Main content
+ * @param options - Template options
+ * @returns Complete HTML email template
+ */
+export declare function createEmailTemplate(content: string, options?: {
+    header?: string;
+    footer?: string;
+    styles?: string;
+}): string;
+//# sourceMappingURL=template-engine.d.ts.map

package/dist/utils/template-engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-engine.d.ts","sourceRoot":"","sources":["../../src/utils/template-engine.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GACnD,MAAM,CASR;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GACnD,MAAM,CAgBR;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;IACR,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GACA,MAAM,CA8BR"}

package/dist/utils/template-engine.js

@@ -0,0 +1,102 @@
+"use strict";
+/**
+ * Template Engine Utilities
+ *
+ * Simple template engine for email content.
+ * Supports variable replacement in email templates.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replaceVariables = replaceVariables;
+exports.replaceVariablesInHtml = replaceVariablesInHtml;
+exports.createEmailTemplate = createEmailTemplate;
+/**
+ * Replace Variables in Template
+ *
+ * Replaces {{variable}} placeholders with actual values.
+ *
+ * @param template - Template string with {{variable}} placeholders
+ * @param variables - Object with variable values
+ * @returns Template with replaced variables
+ *
+ * @example
+ * ```typescript
+ * const template = 'Hello {{name}}, welcome to {{company}}!';
+ * const result = replaceVariables(template, {
+ *   name: 'John',
+ *   company: 'Sibil'
+ * });
+ * // Result: 'Hello John, welcome to Sibil!'
+ * ```
+ */
+function replaceVariables(template, variables) {
+    let result = template;
+    Object.entries(variables).forEach(([key, value]) => {
+        const regex = new RegExp(`\\{\\{${key}\\}\\}`, 'g');
+        result = result.replace(regex, String(value));
+    });
+    return result;
+}
+/**
+ * Replace Variables in HTML Template
+ *
+ * Same as replaceVariables but also escapes HTML in values.
+ *
+ * @param template - HTML template string
+ * @param variables - Object with variable values
+ * @returns HTML template with replaced variables
+ */
+function replaceVariablesInHtml(template, variables) {
+    let result = template;
+    Object.entries(variables).forEach(([key, value]) => {
+        const regex = new RegExp(`\\{\\{${key}\\}\\}`, 'g');
+        // Escape HTML in values
+        const escapedValue = String(value)
+            .replace(/&/g, '&')
+            .replace(/</g, '&lt;')
+            .replace(/>/g, '&gt;')
+            .replace(/"/g, '&quot;')
+            .replace(/'/g, '&#039;');
+        result = result.replace(regex, escapedValue);
+    });
+    return result;
+}
+/**
+ * Create Email Template
+ *
+ * Creates a complete email template with header and footer.
+ *
+ * @param content - Main content
+ * @param options - Template options
+ * @returns Complete HTML email template
+ */
+function createEmailTemplate(content, options) {
+    const header = options?.header || '';
+    const footer = options?.footer || '';
+    const styles = options?.styles || '';
+    return `
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <style>
+    ${styles}
+    body {
+      font-family: Arial, sans-serif;
+      line-height: 1.6;
+      color: #333;
+      max-width: 600px;
+      margin: 0 auto;
+      padding: 20px;
+    }
+  </style>
+</head>
+<body>
+  ${header}
+  ${content}
+  ${footer}
+</body>
+</html>
+  `.trim();
+}
+//# sourceMappingURL=template-engine.js.map

package/dist/utils/template-engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-engine.js","sourceRoot":"","sources":["../../src/utils/template-engine.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAqBH,4CAYC;AAWD,wDAmBC;AAWD,kDAqCC;AA7GD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,gBAAgB,CAC9B,QAAgB,EAChB,SAAoD;IAEpD,IAAI,MAAM,GAAG,QAAQ,CAAC;IAEtB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACjD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,SAAS,GAAG,QAAQ,EAAE,GAAG,CAAC,CAAC;QACpD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,sBAAsB,CACpC,QAAgB,EAChB,SAAoD;IAEpD,IAAI,MAAM,GAAG,QAAQ,CAAC;IAEtB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACjD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,SAAS,GAAG,QAAQ,EAAE,GAAG,CAAC,CAAC;QACpD,wBAAwB;QACxB,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC;aAC/B,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC;aACvB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC3B,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CACjC,OAAe,EACf,OAIC;IAED,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC;IACrC,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC;IACrC,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC;IAErC,OAAO;;;;;;;MAOH,MAAM;;;;;;;;;;;;IAYR,MAAM;IACN,OAAO;IACP,MAAM;;;GAGP,CAAC,IAAI,EAAE,CAAC;AACX,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@sibiltech/sibil-mail",
+  "version": "1.0.0",
+  "description": "SMTP Email Sending Library for Sibil Platform",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "dev": "ts-node src/index.ts",
+    "test": "jest",
+    "test:email": "ts-node src/test-email.ts",
+    "test:server": "ts-node src/test-server.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "email",
+    "smtp",
+    "mail",
+    "nodemailer",
+    "sibil"
+  ],
+  "author": "sibiltech",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "dependencies": {
+    "cors": "^2.8.5",
+    "express": "^4.18.2",
+    "nodemailer": "^8.0.0"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.10.0",
+    "@types/nodemailer": "^6.4.14",
+    "dotenv": "^16.3.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
+  }
+}