@emailens/engine 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -160,6 +160,68 @@ interface DiffResult {
     introduced: CSSWarning[];
     unchanged: CSSWarning[];
 }
+interface SpamIssue {
+    rule: string;
+    severity: "error" | "warning" | "info";
+    message: string;
+    detail?: string;
+}
+interface SpamReport {
+    score: number;
+    level: "low" | "medium" | "high";
+    issues: SpamIssue[];
+}
+interface LinkIssue {
+    severity: "error" | "warning" | "info";
+    rule: string;
+    message: string;
+    href?: string;
+    text?: string;
+}
+interface LinkReport {
+    totalLinks: number;
+    issues: LinkIssue[];
+    breakdown: {
+        https: number;
+        http: number;
+        mailto: number;
+        tel: number;
+        anchor: number;
+        other: number;
+    };
+}
+interface AccessibilityIssue {
+    severity: "error" | "warning" | "info";
+    rule: string;
+    message: string;
+    element?: string;
+    details?: string;
+}
+interface AccessibilityReport {
+    score: number;
+    issues: AccessibilityIssue[];
+}
+interface ImageIssue {
+    rule: string;
+    severity: "error" | "warning" | "info";
+    message: string;
+    src?: string;
+}
+interface ImageInfo {
+    src: string;
+    alt: string | null;
+    width: string | null;
+    height: string | null;
+    isTrackingPixel: boolean;
+    dataUriBytes: number;
+    issues: string[];
+}
+interface ImageReport {
+    total: number;
+    totalDataUriBytes: number;
+    issues: ImageIssue[];
+    images: ImageInfo[];
+}
 
 declare const EMAIL_CLIENTS: EmailClient[];
 declare function getClient(id: string): EmailClient | undefined;
@@ -313,4 +375,40 @@ declare const AI_FIX_SYSTEM_PROMPT = "You are an expert email developer speciali
  */
 declare const STRUCTURAL_FIX_PROPERTIES: Set<string>;
 
-export { AI_FIX_SYSTEM_PROMPT, type AiFixResult, type AiProvider, type CSSWarning, type CodeFix, type DiffResult, EMAIL_CLIENTS, type EmailClient, type EstimateOptions, type ExportPromptOptions, type ExportScope, type FixType, type Framework, type GenerateAiFixOptions, type InputFormat, type PreviewResult, STRUCTURAL_FIX_PROPERTIES, type SupportLevel, type TokenEstimate, type TokenEstimateWithWarnings, type TransformResult, analyzeEmail, diffResults, estimateAiFixTokens, generateAiFix, generateCompatibilityScore, generateFixPrompt, getClient, getCodeFix, getSuggestion, heuristicTokenCount, simulateDarkMode, transformForAllClients, transformForClient };
+/**
+ * Analyze an HTML email for spam indicators.
+ *
+ * Returns a 0–100 score (100 = clean, 0 = very spammy) and an array
+ * of issues found. Uses heuristic rules modeled after common spam
+ * filter triggers (CAN-SPAM, GDPR, SpamAssassin patterns).
+ */
+declare function analyzeSpam(html: string): SpamReport;
+
+/**
+ * Extract and validate all links from an HTML email.
+ *
+ * Performs static analysis only (no network requests). Checks for
+ * empty/placeholder hrefs, javascript: protocol, insecure HTTP,
+ * generic link text, accessibility issues, and more.
+ */
+declare function validateLinks(html: string): LinkReport;
+
+/**
+ * Audit an HTML email for accessibility issues.
+ *
+ * Checks for missing lang attributes, image alt text, small fonts,
+ * layout table roles, link accessibility, heading hierarchy, and
+ * color contrast. Returns a 0–100 score and detailed issues.
+ */
+declare function checkAccessibility(html: string): AccessibilityReport;
+
+/**
+ * Analyze images in an HTML email for best practices.
+ *
+ * Checks for missing dimensions, oversized data URIs, missing alt
+ * attributes, unsupported formats (WebP, SVG), tracking pixels,
+ * missing display:block, and overall image heaviness.
+ */
+declare function analyzeImages(html: string): ImageReport;
+
+export { AI_FIX_SYSTEM_PROMPT, type AccessibilityIssue, type AccessibilityReport, type AiFixResult, type AiProvider, type CSSWarning, type CodeFix, type DiffResult, EMAIL_CLIENTS, type EmailClient, type EstimateOptions, type ExportPromptOptions, type ExportScope, type FixType, type Framework, type GenerateAiFixOptions, type ImageInfo, type ImageIssue, type ImageReport, type InputFormat, type LinkIssue, type LinkReport, type PreviewResult, STRUCTURAL_FIX_PROPERTIES, type SpamIssue, type SpamReport, type SupportLevel, type TokenEstimate, type TokenEstimateWithWarnings, type TransformResult, analyzeEmail, analyzeImages, analyzeSpam, checkAccessibility, diffResults, estimateAiFixTokens, generateAiFix, generateCompatibilityScore, generateFixPrompt, getClient, getCodeFix, getSuggestion, heuristicTokenCount, simulateDarkMode, transformForAllClients, transformForClient, validateLinks };