@bernierllc/email-manager 0.1.1 → 0.1.4

package/dist/config/types.d.ts

@@ -0,0 +1,826 @@
+/**
+ * Runtime configuration interface for email manager suite
+ * Suite package that orchestrates complete email management functionality
+ */
+export interface EmailManagerRuntimeConfig {
+    /**
+     * Suite-level configuration
+     */
+    /**
+     * Enable/disable the email manager suite
+     * @default true
+     * Environment: EMAIL_MANAGER_ENABLED
+     */
+    enabled?: boolean;
+    /**
+     * Default email provider to use
+     * @default undefined
+     * Environment: EMAIL_MANAGER_DEFAULT_PROVIDER
+     */
+    defaultProvider?: string;
+    /**
+     * Email provider configurations
+     */
+    providers?: {
+        /**
+         * Provider definitions directory
+         * @default './providers'
+         * Environment: EMAIL_MANAGER_PROVIDERS_DIR
+         */
+        configDir?: string;
+        /**
+         * Provider failover configuration
+         */
+        failover?: {
+            /**
+             * Enable automatic failover
+             * @default true
+             * Environment: EMAIL_MANAGER_FAILOVER_ENABLED
+             */
+            enabled?: boolean;
+            /**
+             * Maximum failover attempts
+             * @default 3
+             * Environment: EMAIL_MANAGER_FAILOVER_MAX_ATTEMPTS
+             */
+            maxAttempts?: number;
+            /**
+             * Failover delay between attempts (milliseconds)
+             * @default 5000
+             * Environment: EMAIL_MANAGER_FAILOVER_DELAY_MS
+             */
+            delayMs?: number;
+        };
+        /**
+         * Provider health checking
+         */
+        healthCheck?: {
+            /**
+             * Enable provider health checks
+             * @default true
+             * Environment: EMAIL_MANAGER_HEALTH_CHECK_ENABLED
+             */
+            enabled?: boolean;
+            /**
+             * Health check interval (milliseconds)
+             * @default 300000 (5 minutes)
+             * Environment: EMAIL_MANAGER_HEALTH_CHECK_INTERVAL_MS
+             */
+            intervalMs?: number;
+            /**
+             * Health check timeout (milliseconds)
+             * @default 10000
+             * Environment: EMAIL_MANAGER_HEALTH_CHECK_TIMEOUT_MS
+             */
+            timeoutMs?: number;
+        };
+    };
+    /**
+     * Template management configuration
+     */
+    templates?: {
+        /**
+         * Template storage directory
+         * @default './templates'
+         * Environment: EMAIL_MANAGER_TEMPLATES_DIR
+         */
+        storageDir?: string;
+        /**
+         * Maximum templates per category
+         * @default 100
+         * Environment: EMAIL_MANAGER_TEMPLATES_MAX_PER_CATEGORY
+         */
+        maxPerCategory?: number;
+        /**
+         * Template cache TTL (milliseconds)
+         * @default 3600000 (1 hour)
+         * Environment: EMAIL_MANAGER_TEMPLATES_CACHE_TTL_MS
+         */
+        cacheTtlMs?: number;
+        /**
+         * Enable template versioning
+         * @default true
+         * Environment: EMAIL_MANAGER_TEMPLATES_VERSIONING_ENABLED
+         */
+        versioningEnabled?: boolean;
+        /**
+         * Enable template validation
+         * @default true
+         * Environment: EMAIL_MANAGER_TEMPLATES_VALIDATION_ENABLED
+         */
+        validationEnabled?: boolean;
+        /**
+         * Template compilation settings
+         */
+        compilation?: {
+            /**
+             * Enable template precompilation
+             * @default true
+             * Environment: EMAIL_MANAGER_TEMPLATES_PRECOMPILE
+             */
+            enabled?: boolean;
+            /**
+             * Template engine to use
+             * @default 'handlebars'
+             * Environment: EMAIL_MANAGER_TEMPLATES_ENGINE
+             */
+            engine?: 'handlebars' | 'mustache' | 'pug' | 'ejs';
+            /**
+             * Compilation cache size
+             * @default 1000
+             * Environment: EMAIL_MANAGER_TEMPLATES_COMPILE_CACHE_SIZE
+             */
+            cacheSize?: number;
+        };
+    };
+    /**
+     * Email scheduling configuration
+     */
+    scheduling?: {
+        /**
+         * Enable email scheduling
+         * @default true
+         * Environment: EMAIL_MANAGER_SCHEDULING_ENABLED
+         */
+        enabled?: boolean;
+        /**
+         * Maximum scheduled emails in queue
+         * @default 10000
+         * Environment: EMAIL_MANAGER_SCHEDULING_MAX_QUEUE_SIZE
+         */
+        maxQueueSize?: number;
+        /**
+         * Scheduler polling interval (milliseconds)
+         * @default 60000 (1 minute)
+         * Environment: EMAIL_MANAGER_SCHEDULING_POLL_INTERVAL_MS
+         */
+        pollIntervalMs?: number;
+        /**
+         * Maximum scheduling time ahead (milliseconds)
+         * @default 2592000000 (30 days)
+         * Environment: EMAIL_MANAGER_SCHEDULING_MAX_AHEAD_MS
+         */
+        maxAheadMs?: number;
+        /**
+         * Job persistence configuration
+         */
+        persistence?: {
+            /**
+             * Enable job persistence
+             * @default true
+             * Environment: EMAIL_MANAGER_SCHEDULING_PERSISTENCE_ENABLED
+             */
+            enabled?: boolean;
+            /**
+             * Persistence provider
+             * @default 'file'
+             * Environment: EMAIL_MANAGER_SCHEDULING_PERSISTENCE_PROVIDER
+             */
+            provider?: 'file' | 'database' | 'redis';
+            /**
+             * Persistence storage path/connection
+             * Environment: EMAIL_MANAGER_SCHEDULING_PERSISTENCE_PATH
+             */
+            path?: string;
+        };
+    };
+    /**
+     * Email analytics configuration
+     */
+    analytics?: {
+        /**
+         * Enable email analytics
+         * @default true
+         * Environment: EMAIL_MANAGER_ANALYTICS_ENABLED
+         */
+        enabled?: boolean;
+        /**
+         * Analytics data retention (days)
+         * @default 90
+         * Environment: EMAIL_MANAGER_ANALYTICS_RETENTION_DAYS
+         */
+        retentionDays?: number;
+        /**
+         * Metrics aggregation interval (milliseconds)
+         * @default 300000 (5 minutes)
+         * Environment: EMAIL_MANAGER_ANALYTICS_AGGREGATION_INTERVAL_MS
+         */
+        aggregationIntervalMs?: number;
+        /**
+         * Enable detailed tracking
+         * @default true
+         * Environment: EMAIL_MANAGER_ANALYTICS_DETAILED_TRACKING
+         */
+        detailedTracking?: boolean;
+        /**
+         * Webhook tracking configuration
+         */
+        webhooks?: {
+            /**
+             * Enable webhook event tracking
+             * @default true
+             * Environment: EMAIL_MANAGER_ANALYTICS_WEBHOOKS_ENABLED
+             */
+            enabled?: boolean;
+            /**
+             * Webhook endpoint URL
+             * Environment: EMAIL_MANAGER_ANALYTICS_WEBHOOK_URL
+             */
+            url?: string;
+            /**
+             * Webhook secret for verification
+             * Environment: EMAIL_MANAGER_ANALYTICS_WEBHOOK_SECRET
+             */
+            secret?: string;
+            /**
+             * Events to track
+             * @default ['sent', 'delivered', 'opened', 'clicked', 'bounced', 'complained']
+             */
+            events?: string[];
+        };
+    };
+    /**
+     * Rate limiting and throttling
+     */
+    rateLimiting?: {
+        /**
+         * Enable global rate limiting
+         * @default true
+         * Environment: EMAIL_MANAGER_RATE_LIMITING_ENABLED
+         */
+        enabled?: boolean;
+        /**
+         * Global rate limit (emails per minute)
+         * @default 1000
+         * Environment: EMAIL_MANAGER_RATE_LIMIT_EMAILS_PER_MINUTE
+         */
+        emailsPerMinute?: number;
+        /**
+         * Rate limit window (milliseconds)
+         * @default 60000
+         * Environment: EMAIL_MANAGER_RATE_LIMIT_WINDOW_MS
+         */
+        windowMs?: number;
+        /**
+         * Per-recipient rate limiting
+         */
+        perRecipient?: {
+            /**
+             * Enable per-recipient rate limiting
+             * @default true
+             * Environment: EMAIL_MANAGER_PER_RECIPIENT_RATE_LIMITING
+             */
+            enabled?: boolean;
+            /**
+             * Emails per recipient per hour
+             * @default 10
+             * Environment: EMAIL_MANAGER_PER_RECIPIENT_EMAILS_PER_HOUR
+             */
+            emailsPerHour?: number;
+        };
+        /**
+         * Per-template rate limiting
+         */
+        perTemplate?: {
+            /**
+             * Enable per-template rate limiting
+             * @default false
+             * Environment: EMAIL_MANAGER_PER_TEMPLATE_RATE_LIMITING
+             */
+            enabled?: boolean;
+            /**
+             * Template-specific limits (templateId -> limit per hour)
+             */
+            limits?: Record<string, number>;
+        };
+    };
+    /**
+     * Security and compliance
+     */
+    security?: {
+        /**
+         * Enable DKIM signing
+         * @default false
+         * Environment: EMAIL_MANAGER_SECURITY_DKIM_ENABLED
+         */
+        dkimEnabled?: boolean;
+        /**
+         * DKIM private key path
+         * Environment: EMAIL_MANAGER_SECURITY_DKIM_PRIVATE_KEY_PATH
+         */
+        dkimPrivateKeyPath?: string;
+        /**
+         * DKIM selector
+         * Environment: EMAIL_MANAGER_SECURITY_DKIM_SELECTOR
+         */
+        dkimSelector?: string;
+        /**
+         * Enable SPF checking
+         * @default false
+         * Environment: EMAIL_MANAGER_SECURITY_SPF_CHECK_ENABLED
+         */
+        spfCheckEnabled?: boolean;
+        /**
+         * Content filtering configuration
+         */
+        contentFiltering?: {
+            /**
+             * Enable content filtering
+             * @default true
+             * Environment: EMAIL_MANAGER_CONTENT_FILTERING_ENABLED
+             */
+            enabled?: boolean;
+            /**
+             * Block suspicious content
+             * @default true
+             * Environment: EMAIL_MANAGER_CONTENT_FILTERING_BLOCK_SUSPICIOUS
+             */
+            blockSuspicious?: boolean;
+            /**
+             * Custom content filters directory
+             * Environment: EMAIL_MANAGER_CONTENT_FILTERING_CUSTOM_FILTERS_DIR
+             */
+            customFiltersDir?: string;
+        };
+        /**
+         * Data retention and privacy
+         */
+        privacy?: {
+            /**
+             * Enable PII detection
+             * @default true
+             * Environment: EMAIL_MANAGER_PRIVACY_PII_DETECTION
+             */
+            piiDetection?: boolean;
+            /**
+             * Auto-redact sensitive data in logs
+             * @default true
+             * Environment: EMAIL_MANAGER_PRIVACY_AUTO_REDACT_LOGS
+             */
+            autoRedactLogs?: boolean;
+            /**
+             * Email data retention (days)
+             * @default 30
+             * Environment: EMAIL_MANAGER_PRIVACY_DATA_RETENTION_DAYS
+             */
+            dataRetentionDays?: number;
+        };
+    };
+    /**
+     * Delivery optimization
+     */
+    delivery?: {
+        /**
+         * Enable delivery optimization
+         * @default true
+         * Environment: EMAIL_MANAGER_DELIVERY_OPTIMIZATION_ENABLED
+         */
+        optimizationEnabled?: boolean;
+        /**
+         * Batch processing configuration
+         */
+        batching?: {
+            /**
+             * Enable batch processing
+             * @default true
+             * Environment: EMAIL_MANAGER_DELIVERY_BATCHING_ENABLED
+             */
+            enabled?: boolean;
+            /**
+             * Batch size
+             * @default 100
+             * Environment: EMAIL_MANAGER_DELIVERY_BATCH_SIZE
+             */
+            size?: number;
+            /**
+             * Batch processing interval (milliseconds)
+             * @default 10000
+             * Environment: EMAIL_MANAGER_DELIVERY_BATCH_INTERVAL_MS
+             */
+            intervalMs?: number;
+        };
+        /**
+         * Retry configuration
+         */
+        retry?: {
+            /**
+             * Enable delivery retries
+             * @default true
+             * Environment: EMAIL_MANAGER_DELIVERY_RETRY_ENABLED
+             */
+            enabled?: boolean;
+            /**
+             * Maximum retry attempts
+             * @default 5
+             * Environment: EMAIL_MANAGER_DELIVERY_RETRY_MAX_ATTEMPTS
+             */
+            maxAttempts?: number;
+            /**
+             * Initial retry delay (milliseconds)
+             * @default 30000
+             * Environment: EMAIL_MANAGER_DELIVERY_RETRY_INITIAL_DELAY_MS
+             */
+            initialDelayMs?: number;
+            /**
+             * Maximum retry delay (milliseconds)
+             * @default 3600000
+             * Environment: EMAIL_MANAGER_DELIVERY_RETRY_MAX_DELAY_MS
+             */
+            maxDelayMs?: number;
+            /**
+             * Retry backoff factor
+             * @default 2
+             * Environment: EMAIL_MANAGER_DELIVERY_RETRY_BACKOFF_FACTOR
+             */
+            backoffFactor?: number;
+        };
+    };
+    /**
+     * Cache configuration
+     */
+    cache?: {
+        /**
+         * Enable caching
+         * @default true
+         * Environment: EMAIL_MANAGER_CACHE_ENABLED
+         */
+        enabled?: boolean;
+        /**
+         * Cache provider
+         * @default 'memory'
+         * Environment: EMAIL_MANAGER_CACHE_PROVIDER
+         */
+        provider?: 'memory' | 'redis' | 'memcached';
+        /**
+         * Template cache TTL (milliseconds)
+         * @default 3600000
+         * Environment: EMAIL_MANAGER_CACHE_TEMPLATES_TTL_MS
+         */
+        templatesTtlMs?: number;
+        /**
+         * Provider status cache TTL (milliseconds)
+         * @default 300000
+         * Environment: EMAIL_MANAGER_CACHE_PROVIDER_STATUS_TTL_MS
+         */
+        providerStatusTtlMs?: number;
+        /**
+         * Analytics cache TTL (milliseconds)
+         * @default 900000
+         * Environment: EMAIL_MANAGER_CACHE_ANALYTICS_TTL_MS
+         */
+        analyticsTtlMs?: number;
+        /**
+         * Cache connection URL (for Redis/Memcached)
+         * Environment: EMAIL_MANAGER_CACHE_URL
+         */
+        url?: string;
+    };
+    /**
+     * Database configuration
+     */
+    database?: {
+        /**
+         * Database provider
+         * @default 'sqlite'
+         * Environment: EMAIL_MANAGER_DATABASE_PROVIDER
+         */
+        provider?: 'sqlite' | 'postgresql' | 'mysql' | 'mongodb';
+        /**
+         * Database connection URL
+         * Environment: EMAIL_MANAGER_DATABASE_URL
+         */
+        url?: string;
+        /**
+         * Connection pool configuration
+         */
+        pool?: {
+            /**
+             * Minimum pool size
+             * @default 2
+             * Environment: EMAIL_MANAGER_DATABASE_POOL_MIN
+             */
+            min?: number;
+            /**
+             * Maximum pool size
+             * @default 20
+             * Environment: EMAIL_MANAGER_DATABASE_POOL_MAX
+             */
+            max?: number;
+            /**
+             * Connection timeout (milliseconds)
+             * @default 30000
+             * Environment: EMAIL_MANAGER_DATABASE_POOL_TIMEOUT_MS
+             */
+            timeoutMs?: number;
+        };
+        /**
+         * Enable query logging
+         * @default false
+         * Environment: EMAIL_MANAGER_DATABASE_LOG_QUERIES
+         */
+        logQueries?: boolean;
+    };
+    /**
+     * Logger configuration (integration with @bernierllc/logger)
+     */
+    logger?: {
+        /**
+         * Log level for email manager
+         * @default 'info'
+         * Environment: EMAIL_MANAGER_LOG_LEVEL
+         */
+        level?: 'debug' | 'info' | 'warn' | 'error';
+        /**
+         * Enable logging
+         * @default true
+         * Environment: EMAIL_MANAGER_LOG_ENABLED
+         */
+        enabled?: boolean;
+        /**
+         * Include email addresses in logs (privacy consideration)
+         * @default false
+         * Environment: EMAIL_MANAGER_LOG_INCLUDE_EMAILS
+         */
+        includeEmails?: boolean;
+        /**
+         * Include email content in logs (security consideration)
+         * @default false
+         * Environment: EMAIL_MANAGER_LOG_INCLUDE_CONTENT
+         */
+        includeContent?: boolean;
+        /**
+         * Log email delivery events
+         * @default true
+         * Environment: EMAIL_MANAGER_LOG_DELIVERY_EVENTS
+         */
+        logDeliveryEvents?: boolean;
+        /**
+         * Log template operations
+         * @default true
+         * Environment: EMAIL_MANAGER_LOG_TEMPLATE_OPERATIONS
+         */
+        logTemplateOperations?: boolean;
+    };
+    /**
+     * Monitoring and metrics
+     */
+    monitoring?: {
+        /**
+         * Enable monitoring
+         * @default true
+         * Environment: EMAIL_MANAGER_MONITORING_ENABLED
+         */
+        enabled?: boolean;
+        /**
+         * Metrics collection interval (milliseconds)
+         * @default 60000
+         * Environment: EMAIL_MANAGER_MONITORING_METRICS_INTERVAL_MS
+         */
+        metricsIntervalMs?: number;
+        /**
+         * Enable performance monitoring
+         * @default true
+         * Environment: EMAIL_MANAGER_MONITORING_PERFORMANCE_ENABLED
+         */
+        performanceEnabled?: boolean;
+        /**
+         * Enable alerting
+         * @default true
+         * Environment: EMAIL_MANAGER_MONITORING_ALERTING_ENABLED
+         */
+        alertingEnabled?: boolean;
+        /**
+         * Alert thresholds
+         */
+        alertThresholds?: {
+            /**
+             * Delivery failure rate threshold (percentage)
+             * @default 10
+             * Environment: EMAIL_MANAGER_MONITORING_ALERT_FAILURE_RATE
+             */
+            deliveryFailureRate?: number;
+            /**
+             * Queue size threshold
+             * @default 5000
+             * Environment: EMAIL_MANAGER_MONITORING_ALERT_QUEUE_SIZE
+             */
+            queueSize?: number;
+            /**
+             * Processing delay threshold (milliseconds)
+             * @default 300000
+             * Environment: EMAIL_MANAGER_MONITORING_ALERT_PROCESSING_DELAY_MS
+             */
+            processingDelayMs?: number;
+        };
+    };
+    /**
+     * Core package dependency configurations
+     * Suite packages can override core package configurations
+     */
+    corePackages?: {
+        /**
+         * Email Sender configuration overrides
+         */
+        emailSender?: {
+            /**
+             * Default timeout (milliseconds)
+             * @default 30000
+             * Environment: EMAIL_MANAGER_EMAIL_SENDER_TIMEOUT_MS
+             */
+            timeoutMs?: number;
+            /**
+             * Enable delivery confirmation
+             * @default true
+             * Environment: EMAIL_MANAGER_EMAIL_SENDER_DELIVERY_CONFIRMATION
+             */
+            deliveryConfirmation?: boolean;
+        };
+        /**
+         * Template Engine configuration overrides
+         */
+        templateEngine?: {
+            /**
+             * Enable strict mode
+             * @default true
+             * Environment: EMAIL_MANAGER_TEMPLATE_ENGINE_STRICT_MODE
+             */
+            strictMode?: boolean;
+            /**
+             * Template cache size
+             * @default 1000
+             * Environment: EMAIL_MANAGER_TEMPLATE_ENGINE_CACHE_SIZE
+             */
+            cacheSize?: number;
+        };
+        /**
+         * Crypto Utils configuration overrides
+         */
+        cryptoUtils?: {
+            /**
+             * Default algorithm
+             * @default 'aes-256-gcm'
+             * Environment: EMAIL_MANAGER_CRYPTO_UTILS_ALGORITHM
+             */
+            algorithm?: string;
+        };
+    };
+}
+/**
+ * Resolved configuration after merging defaults, config file, and environment variables
+ */
+export interface ResolvedEmailManagerConfig {
+    enabled: boolean;
+    defaultProvider?: string;
+    providers: {
+        configDir: string;
+        failover: {
+            enabled: boolean;
+            maxAttempts: number;
+            delayMs: number;
+        };
+        healthCheck: {
+            enabled: boolean;
+            intervalMs: number;
+            timeoutMs: number;
+        };
+    };
+    templates: {
+        storageDir: string;
+        maxPerCategory: number;
+        cacheTtlMs: number;
+        versioningEnabled: boolean;
+        validationEnabled: boolean;
+        compilation: {
+            enabled: boolean;
+            engine: 'handlebars' | 'mustache' | 'pug' | 'ejs';
+            cacheSize: number;
+        };
+    };
+    scheduling: {
+        enabled: boolean;
+        maxQueueSize: number;
+        pollIntervalMs: number;
+        maxAheadMs: number;
+        persistence: {
+            enabled: boolean;
+            provider: 'file' | 'database' | 'redis';
+            path?: string;
+        };
+    };
+    analytics: {
+        enabled: boolean;
+        retentionDays: number;
+        aggregationIntervalMs: number;
+        detailedTracking: boolean;
+        webhooks: {
+            enabled: boolean;
+            url?: string;
+            secret?: string;
+            events: string[];
+        };
+    };
+    rateLimiting: {
+        enabled: boolean;
+        emailsPerMinute: number;
+        windowMs: number;
+        perRecipient: {
+            enabled: boolean;
+            emailsPerHour: number;
+        };
+        perTemplate: {
+            enabled: boolean;
+            limits: Record<string, number>;
+        };
+    };
+    security: {
+        dkimEnabled: boolean;
+        dkimPrivateKeyPath?: string;
+        dkimSelector?: string;
+        spfCheckEnabled: boolean;
+        contentFiltering: {
+            enabled: boolean;
+            blockSuspicious: boolean;
+            customFiltersDir?: string;
+        };
+        privacy: {
+            piiDetection: boolean;
+            autoRedactLogs: boolean;
+            dataRetentionDays: number;
+        };
+    };
+    delivery: {
+        optimizationEnabled: boolean;
+        batching: {
+            enabled: boolean;
+            size: number;
+            intervalMs: number;
+        };
+        retry: {
+            enabled: boolean;
+            maxAttempts: number;
+            initialDelayMs: number;
+            maxDelayMs: number;
+            backoffFactor: number;
+        };
+    };
+    cache: {
+        enabled: boolean;
+        provider: 'memory' | 'redis' | 'memcached';
+        templatesTtlMs: number;
+        providerStatusTtlMs: number;
+        analyticsTtlMs: number;
+        url?: string;
+    };
+    database: {
+        provider: 'sqlite' | 'postgresql' | 'mysql' | 'mongodb';
+        url?: string;
+        pool: {
+            min: number;
+            max: number;
+            timeoutMs: number;
+        };
+        logQueries: boolean;
+    };
+    logger: {
+        level: 'debug' | 'info' | 'warn' | 'error';
+        enabled: boolean;
+        includeEmails: boolean;
+        includeContent: boolean;
+        logDeliveryEvents: boolean;
+        logTemplateOperations: boolean;
+    };
+    monitoring: {
+        enabled: boolean;
+        metricsIntervalMs: number;
+        performanceEnabled: boolean;
+        alertingEnabled: boolean;
+        alertThresholds: {
+            deliveryFailureRate: number;
+            queueSize: number;
+            processingDelayMs: number;
+        };
+    };
+    corePackages: {
+        emailSender: {
+            timeoutMs: number;
+            deliveryConfirmation: boolean;
+        };
+        templateEngine: {
+            strictMode: boolean;
+            cacheSize: number;
+        };
+        cryptoUtils: {
+            algorithm: string;
+        };
+    };
+}
+/**
+ * Configuration source tracking for transparency
+ */
+export interface ConfigurationSource {
+    key: string;
+    value: any;
+    source: 'default' | 'file' | 'environment' | 'core-override';
+    description: string;
+}
+//# sourceMappingURL=types.d.ts.map