@contentgrowth/content-emailing 0.1.0

package/examples/server.js

@@ -0,0 +1,314 @@
+/**
+ * Example Email Server
+ * 
+ * A standalone Hono server demonstrating the email package functionality.
+ * Uses mock D1 and email sender for testing without real dependencies.
+ * 
+ * Run with: npm start
+ */
+
+import 'dotenv/config'; // Load .env
+import { Hono } from 'hono';
+import { cors } from 'hono/cors';
+import { serveStatic } from '@hono/node-server/serve-static';
+import { serve } from '@hono/node-server';
+
+import { EmailService } from '../src/backend/EmailService.js';
+import { createTemplateRoutes } from '../src/backend/routes/templates.js';
+import { createTrackingRoutes } from '../src/backend/routes/tracking.js';
+import { wrapInEmailTemplate, encodeTrackingLinks, markdownToPlainText } from '../src/common/index.js';
+
+import { createMockEnv, MockD1 } from './mocks/index.js';
+import { mockEmailSender } from './mocks/MockEmailSender.js';
+
+// Server Configuration
+const PORT = process.env.PORT || 3456;
+const USE_REAL_PROVIDER = process.env.EMAIL_PROVIDER && process.env.EMAIL_PROVIDER !== 'mock';
+
+// Create mock environment
+// Skip seeding settings if we have env vars, so we fallback to config defaults
+const env = createMockEnv({ seedSettings: !USE_REAL_PROVIDER });
+
+// Configuration from env
+const emailConfig = {
+    defaults: {
+        fromName: process.env.FROM_NAME || 'Example App',
+        fromAddress: process.env.FROM_ADDRESS || 'noreply@example.com',
+        provider: process.env.EMAIL_PROVIDER || 'mock'
+    },
+    // Pass API keys directly to config (EmailService normalizes these)
+    sendgrid_api_key: process.env.SENDGRID_API_KEY,
+    resend_api_key: process.env.RESEND_API_KEY,
+    sendpulse_client_id: process.env.SENDPULSE_CLIENT_ID,
+    sendpulse_client_secret: process.env.SENDPULSE_CLIENT_SECRET
+};
+
+// Initialize EmailService
+const emailService = new EmailService(env, emailConfig);
+
+// Enhance sendEmail to support both real sending and mock logging
+const originalSendEmail = emailService.sendEmail.bind(emailService);
+
+emailService.sendEmail = async (params) => {
+    // 1. Get current settings to determine provider
+    const settings = await emailService.loadSettings('system');
+    const provider = params.provider || settings.provider || 'mock';
+
+    console.log('[Debug] sendEmail called');
+    console.log('[Debug] params.provider:', params.provider);
+    console.log('[Debug] settings.provider:', settings.provider);
+    console.log('[Debug] Resolved provider:', provider);
+    console.log('[Debug] Settings loaded:', JSON.stringify(settings, null, 2));
+
+    // 2. Always log to MockEmailSender for the UI
+    mockEmailSender.send({
+        to: params.to,
+        from: `${settings.fromName} <${settings.fromAddress}>`,
+        subject: params.subject,
+        html: params.html,
+        text: params.text,
+        status: provider === 'mock' ? 'sent' : 'sending' // UI distinction
+    });
+
+    // 3. If using a real provider, actually send it
+    if (provider !== 'mock') {
+        console.log(`[Server] Sending REAL email via ${provider}...`);
+        return originalSendEmail(params);
+    }
+
+    // 4. Otherwise just return success (MockEmailSender already logged it)
+    return { success: true, messageId: crypto.randomUUID() };
+};
+
+// Create Hono app
+const app = new Hono();
+
+// Enable CORS for portal
+app.use('*', cors());
+
+// Serve static files from portal directory
+// When running from examples folder, root is ./
+app.use('/portal/*', serveStatic({ root: './' }));
+
+// Redirect root to portal
+app.get('/', (c) => c.redirect('/portal/index.html'));
+
+// Health check
+app.get('/health', (c) => c.json({ status: 'ok', timestamp: new Date().toISOString() }));
+
+// Server status (for portal)
+app.get('/api/status', (c) => {
+    return c.json({
+        success: true,
+        useRealProvider: USE_REAL_PROVIDER,
+        provider: emailConfig.defaults.provider,
+        fromAddress: emailConfig.defaults.fromAddress
+    });
+});
+
+// ============ Template API Routes ============
+
+// List templates
+app.get('/api/templates', async (c) => {
+    try {
+        const templates = await emailService.getAllTemplates();
+        return c.json({ success: true, templates });
+    } catch (err) {
+        return c.json({ success: false, error: err.message }, 500);
+    }
+});
+
+// Get single template
+app.get('/api/templates/:id', async (c) => {
+    try {
+        const template = await emailService.getTemplate(c.req.param('id'));
+        if (!template) return c.json({ success: false, error: 'Template not found' }, 404);
+        return c.json({ success: true, template });
+    } catch (err) {
+        return c.json({ success: false, error: err.message }, 500);
+    }
+});
+
+// Create/Update template
+app.post('/api/templates', async (c) => {
+    try {
+        const data = await c.req.json();
+        await emailService.saveTemplate(data, 'admin');
+        return c.json({ success: true, message: 'Template saved' });
+    } catch (err) {
+        return c.json({ success: false, error: err.message }, 500);
+    }
+});
+
+// Delete template
+app.delete('/api/templates/:id', async (c) => {
+    try {
+        await emailService.deleteTemplate(c.req.param('id'));
+        return c.json({ success: true, message: 'Template deleted' });
+    } catch (err) {
+        return c.json({ success: false, error: err.message }, 500);
+    }
+});
+
+// Preview template (render with variables)
+app.post('/api/templates/:id/preview', async (c) => {
+    try {
+        const id = c.req.param('id');
+        const variables = await c.req.json();
+        const result = await emailService.renderTemplate(id, variables);
+        return c.json({ success: true, preview: result });
+    } catch (err) {
+        return c.json({ success: false, error: err.message }, 500);
+    }
+});
+
+// Send test email
+app.post('/api/templates/:id/test', async (c) => {
+    try {
+        const id = c.req.param('id');
+        const { to, variables } = await c.req.json();
+
+        if (!to) {
+            return c.json({ success: false, error: 'Recipient email required' }, 400);
+        }
+
+        const { subject, html, plainText } = await emailService.renderTemplate(id, variables || {});
+
+        // Add tracking (simulated)
+        const sendId = crypto.randomUUID();
+        const trackedHtml = encodeTrackingLinks(html, sendId, env);
+
+        const result = await emailService.sendEmail({
+            to,
+            subject: `[TEST] ${subject}`,
+            html: trackedHtml,
+            text: plainText
+        });
+
+        if (result.success) {
+            return c.json({ success: true, message: 'Test email sent', messageId: result.messageId });
+        } else {
+            return c.json({ success: false, error: result.error }, 500);
+        }
+    } catch (err) {
+        return c.json({ success: false, error: err.message }, 500);
+    }
+});
+
+// ============ Sent Emails API (for demo) ============
+
+// Get all "sent" emails (from mock)
+app.get('/api/sent-emails', (c) => {
+    return c.json({ success: true, emails: mockEmailSender.getSentEmails() });
+});
+
+// Clear sent emails
+app.delete('/api/sent-emails', (c) => {
+    mockEmailSender.clear();
+    return c.json({ success: true, message: 'Cleared' });
+});
+
+// ============ Tracking Routes (demo) ============
+
+// Open tracking pixel
+app.get('/email/track/open/:token', async (c) => {
+    const token = c.req.param('token');
+    console.log(`[Tracking] Email opened: ${token}`);
+
+    // Return 1x1 transparent GIF
+    const pixel = new Uint8Array([
+        0x47, 0x49, 0x46, 0x38, 0x39, 0x61, 0x01, 0x00, 0x01, 0x00,
+        0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0x21,
+        0xF9, 0x04, 0x01, 0x00, 0x00, 0x00, 0x00, 0x2C, 0x00, 0x00,
+        0x00, 0x00, 0x01, 0x00, 0x01, 0x00, 0x00, 0x02, 0x01, 0x44,
+        0x00, 0x3B
+    ]);
+
+    return new Response(pixel, {
+        headers: {
+            'Content-Type': 'image/gif',
+            'Cache-Control': 'no-cache, no-store, must-revalidate'
+        }
+    });
+});
+
+// Click tracking
+app.get('/r/:token', (c) => {
+    const token = c.req.param('token');
+    const encodedUrl = c.req.query('url');
+
+    if (!encodedUrl) {
+        return c.json({ error: 'Missing URL' }, 400);
+    }
+
+    try {
+        const url = Buffer.from(encodedUrl, 'base64').toString('utf-8');
+        console.log(`[Tracking] Link clicked: ${token} -> ${url}`);
+        return c.redirect(url);
+    } catch {
+        return c.json({ error: 'Invalid URL' }, 400);
+    }
+});
+
+// ============ Settings API (for demo) ============
+
+// Get system settings
+app.get('/api/settings', async (c) => {
+    try {
+        const result = await env.DB.prepare('SELECT * FROM system_settings').all();
+        // Convert array of {setting_key, setting_value} to object
+        const settings = {};
+        (result.results || []).forEach(row => {
+            settings[row.setting_key] = row.setting_value;
+        });
+        return c.json({ success: true, settings });
+    } catch (err) {
+        return c.json({ success: false, error: err.message }, 500);
+    }
+});
+
+// Update system settings
+app.post('/api/settings', async (c) => {
+    try {
+        const settings = await c.req.json();
+
+        // Update each setting
+        const stmts = [];
+        for (const [key, value] of Object.entries(settings)) {
+            // Check if exists
+            const exists = await env.DB.prepare('SELECT 1 FROM system_settings WHERE setting_key = ?').bind(key).first();
+
+            if (exists) {
+                stmts.push(env.DB.prepare('UPDATE system_settings SET setting_value = ? WHERE setting_key = ?').bind(value, key));
+            } else {
+                stmts.push(env.DB.prepare('INSERT INTO system_settings (setting_key, setting_value) VALUES (?, ?)').bind(key, value));
+            }
+        }
+
+        await env.DB.batch(stmts);
+        return c.json({ success: true, message: 'Settings updated' });
+    } catch (err) {
+        return c.json({ success: false, error: err.message }, 500);
+    }
+});
+
+// ============ Start Server ============
+
+console.log(`
+╔════════════════════════════════════════════════════════════╗
+║                 Email Package Example Server                ║
+╠════════════════════════════════════════════════════════════╣
+║                                                            ║
+║  Portal:    http://localhost:${PORT}/portal/               ║
+║  API:       http://localhost:${PORT}/api/templates         ║
+║  Health:    http://localhost:${PORT}/health                ║
+║                                                            ║
+║  Provider:  ${USE_REAL_PROVIDER ? emailConfig.defaults.provider.toUpperCase() + ' (REAL)' : 'MOCK (No emails sent)'}    ║
+║                                                            ║
+╚════════════════════════════════════════════════════════════╝
+`);
+
+serve({
+    fetch: app.fetch,
+    port: Number(PORT)
+});

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@contentgrowth/content-emailing",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Unified email delivery and template management system",
+  "main": "src/index.js",
+  "exports": {
+    ".": "./src/index.js",
+    "./backend": "./src/backend/EmailService.js",
+    "./routes": "./src/backend/routes/index.js",
+    "./common": "./src/common/index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "echo '\n📦 Package contents:\n' && npm pack --dry-run && echo '\n⚠️  Review the files above before publishing!\n'"
+  },
+  "author": "Content Growth",
+  "license": "MIT",
+  "dependencies": {
+    "marked": "^9.1.2",
+    "mustache": "^4.2.0",
+    "hono": "^4.0.0"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0",
+    "lucide-react": "^0.292.0",
+    "tailwindcss": "^3.0.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.0.0"
+  }
+}

package/release.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+echo "🚀 Preparing to release @contentgrowth/content-emailing ..."
+echo ""
+
+# Check for uncommitted changes
+if ! git diff-index --quiet HEAD --; then
+    echo "⚠️  WARNING: You have uncommitted changes!"
+    git status --short
+    echo ""
+    read -p "Continue anyway? (y/N) " -n 1 -r
+    echo ""
+    if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+        echo "❌ Release cancelled."
+        exit 1
+    fi
+fi
+
+# Show what will be published
+echo "📦 Package contents preview:"
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+npm pack --dry-run
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+echo ""
+
+# Security check: Verify no .env files are included
+if npm pack --dry-run 2>&1 | grep -q "\<\.env\>"; then
+    echo "🚨 SECURITY ERROR: .env file detected in package!"
+    echo "❌ Release cancelled for security reasons."
+    exit 1
+fi
+
+# Confirm before publishing
+read -p "Proceed with publishing? (y/N) " -n 1 -r
+echo ""
+if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+    echo "❌ Release cancelled."
+    exit 1
+fi
+
+echo ""
+echo "📤 Publishing to npm..."
+
+# Note: No build step required as this is a pure ES module project
+# If a build step is added later (e.g. TypeScript), add 'npm run build' here
+
+# Publish to npm
+# --access public is required for scoped packages to be public
+npm publish --access public
+
+echo ""
+echo "✅ Release complete!"
+echo "📦 Package published: @contentgrowth/content-emailing@$(node -p "require('./package.json').version")"

package/schema.sql

@@ -0,0 +1,63 @@
+-- Email System Schema
+
+-- System email templates table
+CREATE TABLE IF NOT EXISTS system_email_templates (
+  template_id TEXT PRIMARY KEY,
+  template_name TEXT NOT NULL,
+  template_type TEXT NOT NULL,
+  subject_template TEXT NOT NULL,
+  body_markdown TEXT NOT NULL,
+  variables TEXT, -- JSON array
+  description TEXT,
+  is_active INTEGER NOT NULL DEFAULT 1,
+  created_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now')),
+  updated_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now')),
+  updated_by TEXT
+);
+
+-- System email preferences table
+CREATE TABLE IF NOT EXISTS system_email_preferences (
+  user_id TEXT NOT NULL,
+  tenant_id TEXT NOT NULL,
+  timezone TEXT NOT NULL DEFAULT 'UTC',
+  email_settings TEXT NOT NULL DEFAULT '{}',
+  unsub_token TEXT NOT NULL UNIQUE,
+  created_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now')),
+  updated_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now')),
+  PRIMARY KEY (user_id, tenant_id)
+);
+
+-- System email sends table
+CREATE TABLE IF NOT EXISTS system_email_sends (
+  send_id TEXT PRIMARY KEY,
+  user_id TEXT NOT NULL,
+  tenant_id TEXT NOT NULL,
+  email_kind TEXT NOT NULL,
+  period_key TEXT NOT NULL,
+  status TEXT NOT NULL DEFAULT 'sent',
+  provider_message_id TEXT,
+  error_message TEXT,
+  created_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now')),
+  UNIQUE(user_id, email_kind, period_key)
+);
+
+-- System email events table
+CREATE TABLE IF NOT EXISTS system_email_events (
+  event_id TEXT PRIMARY KEY,
+  send_id TEXT NOT NULL,
+  user_id TEXT NOT NULL,
+  tenant_id TEXT NOT NULL,
+  email_kind TEXT NOT NULL,
+  event_type TEXT NOT NULL,
+  metadata TEXT,
+  created_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now')),
+  FOREIGN KEY (send_id) REFERENCES system_email_sends(send_id) ON DELETE CASCADE
+);
+
+-- Indexes
+CREATE INDEX IF NOT EXISTS idx_system_email_templates_type ON system_email_templates(template_type, is_active);
+CREATE INDEX IF NOT EXISTS idx_system_email_preferences_tenant ON system_email_preferences(tenant_id);
+CREATE INDEX IF NOT EXISTS idx_system_email_preferences_unsub_token ON system_email_preferences(unsub_token);
+CREATE INDEX IF NOT EXISTS idx_system_email_sends_user ON system_email_sends(user_id);
+CREATE INDEX IF NOT EXISTS idx_system_email_sends_period ON system_email_sends(email_kind, period_key);
+CREATE INDEX IF NOT EXISTS idx_system_email_events_send ON system_email_events(send_id);