@serve.zone/dcrouter 2.12.4 → 5.0.2

package/dist_ts/ts/deliverability/classes.senderreputationmonitor.d.ts

@@ -1,300 +0,0 @@
-/**
- * Domain reputation metrics
- */
-export interface IDomainReputationMetrics {
-    /** Domain being monitored */
-    domain: string;
-    /** Date the metrics were last updated */
-    lastUpdated: Date;
-    /** Sending volume metrics */
-    volume: {
-        /** Total emails sent in the tracking period */
-        sent: number;
-        /** Delivered emails (excluding bounces) */
-        delivered: number;
-        /** Hard bounces */
-        hardBounces: number;
-        /** Soft bounces */
-        softBounces: number;
-        /** Daily sending volume for the last 30 days */
-        dailySendVolume: Record<string, number>;
-    };
-    /** Engagement metrics */
-    engagement: {
-        /** Number of opens */
-        opens: number;
-        /** Number of clicks */
-        clicks: number;
-        /** Calculated open rate (percentage) */
-        openRate: number;
-        /** Calculated click rate (percentage) */
-        clickRate: number;
-        /** Click-to-open rate (percentage) */
-        clickToOpenRate: number;
-    };
-    /** Complaint metrics */
-    complaints: {
-        /** Number of spam complaints */
-        total: number;
-        /** Complaint rate (percentage) */
-        rate: number;
-        /** Domains with highest complaint rates */
-        topDomains: Array<{
-            domain: string;
-            rate: number;
-            count: number;
-        }>;
-    };
-    /** Authentication metrics */
-    authentication: {
-        /** Percentage of emails with valid SPF */
-        spfPassRate: number;
-        /** Percentage of emails with valid DKIM */
-        dkimPassRate: number;
-        /** Percentage of emails with valid DMARC */
-        dmarcPassRate: number;
-        /** Authentication failures */
-        failures: Array<{
-            type: string;
-            domain: string;
-            count: number;
-        }>;
-    };
-    /** Blocklist status */
-    blocklist: {
-        /** Current blocklist status */
-        listed: boolean;
-        /** Blocklists the domain is on, if any */
-        activeListings: Array<{
-            list: string;
-            listedSince: Date;
-        }>;
-        /** Recent delistings */
-        recentDelistings: Array<{
-            list: string;
-            listedFrom: Date;
-            listedTo: Date;
-        }>;
-    };
-    /** Inbox placement estimates */
-    inboxPlacement: {
-        /** Overall inbox placement rate estimate */
-        overall: number;
-        /** Inbox placement rates by major provider */
-        providers: Record<string, number>;
-    };
-    /** Historical reputation scores */
-    historical: {
-        /** Reputation scores for the last 30 days */
-        reputationScores: Record<string, number>;
-        /** Trends in key metrics */
-        trends: {
-            /** Open rate trend (positive or negative percentage) */
-            openRate: number;
-            /** Complaint rate trend */
-            complaintRate: number;
-            /** Bounce rate trend */
-            bounceRate: number;
-            /** Spam listing trend */
-            spamListings: number;
-        };
-    };
-}
-/**
- * Configuration for reputation monitoring
- */
-export interface IReputationMonitorConfig {
-    /** Whether monitoring is enabled */
-    enabled?: boolean;
-    /** Domains to monitor */
-    domains?: string[];
-    /** How frequently to update metrics (ms) */
-    updateFrequency?: number;
-    /** Endpoints for external data sources */
-    dataSources?: {
-        /** Spam list monitoring service */
-        spamLists?: string[];
-        /** Deliverability monitoring service endpoint */
-        deliverabilityMonitor?: string;
-    };
-    /** Alerting thresholds */
-    alertThresholds?: {
-        /** Minimum safe reputation score */
-        minReputationScore?: number;
-        /** Maximum acceptable complaint rate */
-        maxComplaintRate?: number;
-        /** Maximum acceptable bounce rate */
-        maxBounceRate?: number;
-        /** Minimum acceptable open rate */
-        minOpenRate?: number;
-    };
-}
-/**
- * Class for monitoring and tracking sender reputation for domains
- */
-export declare class SenderReputationMonitor {
-    private static instance;
-    private config;
-    private reputationData;
-    private updateTimer;
-    private isInitialized;
-    private storageManager?;
-    /**
-     * Constructor for SenderReputationMonitor
-     * @param config Configuration options
-     * @param storageManager Optional StorageManager instance
-     */
-    constructor(config?: IReputationMonitorConfig, storageManager?: any);
-    /**
-     * Get the singleton instance
-     * @param config Configuration options
-     * @param storageManager Optional StorageManager instance
-     * @returns Singleton instance
-     */
-    static getInstance(config?: IReputationMonitorConfig, storageManager?: any): SenderReputationMonitor;
-    /**
-     * Initialize the reputation monitor
-     */
-    private initialize;
-    /**
-     * Initialize reputation data for a new domain
-     * @param domain Domain to initialize
-     */
-    private initializeDomainData;
-    /**
-     * Schedule regular reputation data updates
-     */
-    private scheduleUpdates;
-    /**
-     * Update metrics for all monitored domains
-     */
-    private updateAllDomainMetrics;
-    /**
-     * Update reputation metrics for a specific domain
-     * @param domain Domain to update
-     */
-    private updateDomainMetrics;
-    /**
-     * Check domain blocklist status
-     * @param domain Domain to check
-     * @param metrics Metrics to update
-     */
-    private checkBlocklistStatus;
-    /**
-     * Check if a domain is on a specific blocklist
-     * @param domain Domain to check
-     * @param list Blocklist to check
-     * @returns Whether the domain is listed
-     */
-    private checkDomainOnBlocklist;
-    /**
-     * Update historical data in metrics
-     * @param metrics Metrics to update
-     */
-    private updateHistoricalData;
-    /**
-     * Calculate reputation score from metrics
-     * @param metrics Domain reputation metrics
-     * @returns Reputation score (0-100)
-     */
-    private calculateReputationScore;
-    /**
-     * Calculate engagement component score
-     * @param metrics Domain metrics
-     * @returns Engagement score (0-100)
-     */
-    private calculateEngagementScore;
-    /**
-     * Calculate complaint component score
-     * @param metrics Domain metrics
-     * @returns Complaint score (0-100)
-     */
-    private calculateComplaintScore;
-    /**
-     * Calculate authentication component score
-     * @param metrics Domain metrics
-     * @returns Authentication score (0-100)
-     */
-    private calculateAuthenticationScore;
-    /**
-     * Calculate volume stability component score
-     * @param metrics Domain metrics
-     * @returns Volume stability score (0-100)
-     */
-    private calculateVolumeStabilityScore;
-    /**
-     * Calculate infrastructure component score
-     * @param metrics Domain metrics
-     * @returns Infrastructure score (0-100)
-     */
-    private calculateInfrastructureScore;
-    /**
-     * Calculate blocklist component score
-     * @param metrics Domain metrics
-     * @returns Blocklist score (0-100)
-     */
-    private calculateBlocklistScore;
-    /**
-     * Calculate trend metrics
-     * @param metrics Domain metrics to update
-     */
-    private calculateTrends;
-    /**
-     * Check if metrics exceed alert thresholds
-     * @param metrics Domain metrics to check
-     */
-    private checkAlertThresholds;
-    /**
-     * Send an alert for a reputation issue
-     * @param domain Domain with the issue
-     * @param alertType Type of alert
-     * @param data Alert data
-     */
-    private sendAlert;
-    /**
-     * Record a send event for domain reputation tracking
-     * @param domain The domain sending the email
-     * @param event Event details
-     */
-    recordSendEvent(domain: string, event: {
-        type: 'sent' | 'delivered' | 'bounce' | 'complaint' | 'open' | 'click';
-        count?: number;
-        hardBounce?: boolean;
-        receivingDomain?: string;
-    }): void;
-    /**
-     * Get reputation data for a domain
-     * @param domain Domain to get data for
-     * @returns Reputation data
-     */
-    getReputationData(domain: string): IDomainReputationMetrics | null;
-    /**
-     * Get summary reputation data for all domains
-     * @returns Summary data for all domains
-     */
-    getReputationSummary(): Array<{
-        domain: string;
-        score: number;
-        status: 'excellent' | 'good' | 'fair' | 'poor' | 'critical';
-        listed: boolean;
-        trend: number;
-    }>;
-    /**
-     * Add a domain to monitor
-     * @param domain Domain to monitor
-     */
-    addDomain(domain: string): void;
-    /**
-     * Remove a domain from monitoring
-     * @param domain Domain to remove
-     */
-    removeDomain(domain: string): void;
-    /**
-     * Load reputation data from storage
-     */
-    private loadReputationData;
-    /**
-     * Save reputation data to storage
-     */
-    private saveReputationData;
-}