@realtimex/email-automator 2.11.2 → 2.12.0

package/api/src/services/rulePacks/operations.ts

@@ -0,0 +1,183 @@
+/**
+ * Operations Pack - Support & Customer Success
+ *
+ * Designed for operations, support, and customer success teams who need to:
+ * - Organize customer support tickets
+ * - Track internal announcements
+ * - Monitor system health
+ * - Manage receipts and expenses
+ */
+
+import { RulePack } from './types.js';
+
+export const OPERATIONS_PACK: RulePack = {
+  id: 'operations',
+  name: 'Operations Pack',
+  description: 'Organize tickets, internal communications, and operations',
+  icon: '🛠️',
+  enabled_by_default: false,
+  target_roles: ['operations'],
+  rules: [
+    {
+      id: 'ops-support-tickets',
+      name: '🎫 Support Ticket Organizer',
+      intent: 'Organize customer support tickets and cases',
+      description: 'Labels support tickets from Zendesk, Intercom, and other support tools',
+      condition: {
+        or: [
+          {
+            sender_domain: 'zendesk.com'
+          },
+          {
+            sender_domain: 'intercom.io'
+          },
+          {
+            sender_domain: 'freshdesk.com'
+          },
+          {
+            contains_keywords: ['ticket', 'case created', 'support request', 'customer inquiry']
+          },
+          {
+            category: 'support',
+            confidence_gt: 0.7
+          }
+        ]
+      },
+      actions: ['label:Support'],
+      priority: 80,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'ops-urgent-tickets',
+      name: '🚨 Urgent Ticket Highlighter',
+      intent: 'Highlight high-priority and urgent customer issues',
+      description: 'Stars urgent support tickets that need immediate attention',
+      condition: {
+        category: 'support',
+        or: [
+          {
+            contains_keywords: ['urgent', 'emergency', 'critical', 'down', 'not working']
+          },
+          {
+            ai_priority: 'High'
+          }
+        ]
+      },
+      actions: ['star', 'important'],
+      priority: 100,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'ops-system-alerts',
+      name: '⚠️ System Alerts Organizer',
+      intent: 'Organize system monitoring and uptime alerts',
+      description: 'Labels system alerts while starring critical incidents',
+      condition: {
+        or: [
+          {
+            sender_domain: 'pingdom.com'
+          },
+          {
+            sender_domain: 'uptimerobot.com'
+          },
+          {
+            sender_domain: 'statuspage.io'
+          },
+          {
+            sender_domain: 'datadog.com'
+          }
+        ]
+      },
+      actions: ['label:Monitoring'],
+      priority: 70,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'ops-critical-alerts',
+      name: '🔥 Critical Alert Highlighter',
+      intent: 'Highlight critical system incidents',
+      description: 'Stars critical alerts that indicate system downtime or major issues',
+      condition: {
+        or: [
+          {
+            sender_domain: 'pingdom.com',
+            contains_keywords: ['down', 'offline']
+          },
+          {
+            sender_domain: 'datadog.com',
+            contains_keywords: ['critical', 'incident']
+          }
+        ]
+      },
+      actions: ['star', 'important', 'pin'],
+      priority: 100,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'ops-internal-announcements',
+      name: '🏢 Internal Announcements',
+      intent: 'Keep internal company announcements in inbox',
+      description: 'Keeps HR, team, and company-wide announcements visible (doesn\'t archive)',
+      condition: {
+        or: [
+          {
+            category: 'internal',
+            confidence_gt: 0.7
+          },
+          {
+            sender_domain: 'company.com',  // This should be customizable
+            contains_keywords: ['all-hands', 'team announcement', 'company update']
+          }
+        ]
+      },
+      actions: [],  // No actions - keep in inbox
+      priority: 50,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'ops-project-management',
+      name: '🔨 Project Management Organizer',
+      intent: 'Organize project management tool notifications',
+      description: 'Archives project management notifications unless you\'re directly mentioned',
+      condition: {
+        or: [
+          {
+            sender_domain: 'atlassian.net',
+            not: {
+              contains_keywords: ['assigned to you', 'mentioned you']
+            }
+          },
+          {
+            sender_domain: 'asana.com',
+            not: {
+              contains_keywords: ['assigned to you']
+            }
+          },
+          {
+            sender_domain: 'trello.com'
+          },
+          {
+            sender_domain: 'monday.com'
+          }
+        ]
+      },
+      actions: ['label:Tools', 'archive'],
+      priority: 15,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'ops-receipts-invoices',
+      name: '🧾 Receipt & Invoice Labeler',
+      intent: 'Label receipts and invoices for expense tracking',
+      description: 'Labels transactional emails for easy expense reporting',
+      condition: {
+        category: 'transactional',
+        contains_keywords: ['receipt', 'invoice', 'payment', 'order confirmation'],
+        confidence_gt: 0.75
+      },
+      actions: ['label:Finance/Receipts'],
+      priority: 60,
+      is_enabled_by_default: true
+    }
+  ]
+};

package/api/src/services/rulePacks/sales.ts

@@ -0,0 +1,160 @@
+/**
+ * Sales Pack - Revenue & Customer Communications
+ *
+ * Designed for sales, business development, and customer-facing teams who need to:
+ * - Prioritize leads and customer communications
+ * - Track CRM notifications
+ * - Manage travel for client meetings
+ * - Focus on revenue-generating activities
+ */
+
+import { RulePack } from './types.js';
+
+export const SALES_PACK: RulePack = {
+  id: 'sales',
+  name: 'Sales Pack',
+  description: 'Prioritize leads and customer communications',
+  icon: '💼',
+  enabled_by_default: false,
+  target_roles: ['sales'],
+  rules: [
+    {
+      id: 'sales-vip-clients',
+      name: '⭐ VIP Client Prioritizer',
+      intent: 'Star and prioritize emails from key clients and prospects',
+      description: 'Automatically highlights emails from VIP contacts and hot leads',
+      condition: {
+        or: [
+          {
+            sender_is_vip: true  // From VIP list
+          },
+          {
+            category: 'client',
+            ai_priority: 'High'
+          }
+        ]
+      },
+      actions: ['star', 'important'],
+      priority: 100,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'sales-direct-questions',
+      name: '⚡ Customer Questions Highlighter',
+      intent: 'Highlight customer questions that need responses',
+      description: 'Identifies emails from customers asking questions or requesting information',
+      condition: {
+        recipient_type: 'to',
+        contains_keywords: ['?', 'question', 'wondering', 'can you', 'could you'],
+        not: {
+          category: 'newsletter'
+        }
+      },
+      actions: ['important'],
+      priority: 90,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'sales-crm-notifications',
+      name: '📊 CRM Notification Organizer',
+      intent: 'Organize Salesforce, HubSpot, and CRM notifications',
+      description: 'Archives CRM notifications unless they require direct action',
+      condition: {
+        or: [
+          {
+            sender_domain: 'salesforce.com',
+            not: {
+              contains_keywords: ['assigned to you', 'mentioned you', 'deal closed']
+            }
+          },
+          {
+            sender_domain: 'hubspot.com',
+            not: {
+              contains_keywords: ['new lead', 'hot lead', 'assigned']
+            }
+          },
+          {
+            sender_domain: 'pipedrive.com'
+          }
+        ]
+      },
+      actions: ['label:CRM', 'archive'],
+      priority: 15,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'sales-calendar-responses',
+      name: '📅 Calendar Response Cleaner',
+      intent: 'Clean up calendar accept/decline notifications',
+      description: 'Deletes automatic calendar responses without custom messages',
+      condition: {
+        contains_keywords: ['accepted:', 'declined:', 'tentative:'],
+        not: {
+          recipient_type: 'to'
+        }
+      },
+      actions: ['delete'],
+      priority: 10,
+      is_enabled_by_default: false  // Disabled by default - deletion is aggressive
+    },
+    {
+      id: 'sales-travel-itineraries',
+      name: '✈️ Travel Organizer',
+      intent: 'Organize flight confirmations and hotel bookings',
+      description: 'Labels travel-related emails for easy access before client meetings',
+      condition: {
+        or: [
+          {
+            sender_domain: 'delta.com'
+          },
+          {
+            sender_domain: 'united.com'
+          },
+          {
+            sender_domain: 'aa.com'
+          },
+          {
+            sender_domain: 'hilton.com'
+          },
+          {
+            sender_domain: 'marriott.com'
+          },
+          {
+            sender_domain: 'airbnb.com'
+          },
+          {
+            contains_keywords: ['itinerary', 'flight confirmation', 'booking confirmation', 'reservation confirmed']
+          }
+        ]
+      },
+      actions: ['label:Travel'],
+      priority: 70,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'sales-proposals',
+      name: '📄 Proposal & Contract Highlighter',
+      intent: 'Highlight proposals and contracts',
+      description: 'Stars emails containing proposals, quotes, and contracts',
+      condition: {
+        or: [
+          {
+            sender_domain: 'docusign.com'
+          },
+          {
+            sender_domain: 'hellosign.com'
+          },
+          {
+            sender_domain: 'pandadoc.com'
+          },
+          {
+            contains_keywords: ['proposal', 'quote', 'contract', 'agreement', 'signature required']
+          }
+        ]
+      },
+      actions: ['label:Contracts', 'star'],
+      priority: 85,
+      is_enabled_by_default: true
+    }
+  ]
+};

package/api/src/services/rulePacks/types.ts

@@ -0,0 +1,116 @@
+/**
+ * Rule Pack Type Definitions
+ *
+ * Rule packs are pre-configured sets of automation rules designed for specific user roles
+ * or use cases. They enable zero-configuration UX by providing smart defaults.
+ */
+
+export type EmailCategory =
+  | 'newsletter'
+  | 'promotional'
+  | 'spam'
+  | 'transactional'
+  | 'social'
+  | 'support'
+  | 'client'
+  | 'internal'
+  | 'personal'
+  | 'other';
+
+export type EmailAction =
+  | 'delete'
+  | 'archive'
+  | 'draft'
+  | 'read'
+  | 'star'
+  | 'unstar'
+  | 'important'
+  | 'pin'
+  | `label:${string}`
+  | `forward:${string}`;
+
+export type RecipientType = 'to' | 'cc' | 'bcc';
+
+export type EmailSentiment = 'sales' | 'urgent' | 'casual' | 'formal';
+
+export type Priority = 'High' | 'Medium' | 'Low';
+
+/**
+ * Enhanced rule condition supporting AI-powered matching
+ */
+export interface EnhancedRuleCondition {
+  // Legacy field-based matching (kept for backwards compatibility)
+  field?: 'subject' | 'sender' | 'body';
+  operator?: 'equals' | 'contains' | 'domain_equals';
+  value?: string;
+
+  // AI-powered conditions (leverage intelligence service)
+  category?: EmailCategory;          // AI categorization (newsletter, spam, etc.)
+  sentiment?: EmailSentiment;        // AI tone detection
+  confidence_gt?: number;            // Minimum AI confidence (0.0 to 1.0)
+
+  // AI priority and quality
+  ai_priority?: Priority;            // AI-assigned priority
+  is_useless?: boolean;              // AI-detected low-value email
+
+  // Recipient analysis
+  recipient_type?: RecipientType;    // Where user appears (to/cc/bcc)
+  recipient_count_gt?: number;       // Number of recipients threshold
+  is_first_contact?: boolean;        // No prior thread with sender
+
+  // Content matching
+  contains_keywords?: string[];      // Any of these words (case-insensitive)
+  matches_pattern?: string;          // Regex pattern
+
+  // Sender analysis
+  sender_domain?: string;            // Match sender domain
+  sender_in_contacts?: boolean;      // Is sender in user's contacts
+  sender_is_vip?: boolean;           // Is sender in VIP list
+
+  // Time-based
+  older_than_days?: number;          // Email age threshold
+
+  // Logical operators for complex conditions
+  and?: EnhancedRuleCondition[];     // All must match
+  or?: EnhancedRuleCondition[];      // Any must match
+  not?: EnhancedRuleCondition;       // Must NOT match
+}
+
+/**
+ * Rule template definition
+ */
+export interface RuleTemplate {
+  id: string;                        // Unique template ID (e.g., 'universal-newsletters')
+  name: string;                      // Display name with emoji (e.g., '📚 Newsletter Sweeper')
+  intent: string;                    // Human-readable purpose
+  description?: string;              // Detailed explanation
+  condition: EnhancedRuleCondition;  // When this rule applies
+  actions: EmailAction[];            // What to do
+  instructions?: string;             // Draft generation instructions (if action includes 'draft')
+  priority?: number;                 // Evaluation order (higher = first)
+  is_enabled_by_default: boolean;    // Should be enabled when installed
+}
+
+/**
+ * Rule pack definition
+ */
+export interface RulePack {
+  id: string;                        // Pack identifier (e.g., 'universal', 'executive')
+  name: string;                      // Display name (e.g., 'Universal Pack')
+  description: string;               // What this pack does
+  icon?: string;                     // Emoji or icon identifier
+  rules: RuleTemplate[];             // Rule templates in this pack
+  enabled_by_default: boolean;       // Auto-install for matching users
+  target_roles?: string[];           // Which roles this pack is designed for
+}
+
+/**
+ * User role types for personalization
+ */
+export type UserRole =
+  | 'executive'      // Leadership, CEO, VP
+  | 'developer'      // Software engineers, DevOps
+  | 'sales'          // Sales, Business Development
+  | 'operations'     // Support, Operations, Customer Success
+  | 'marketing'      // Marketing, Growth
+  | 'other';         // Manual setup, no personalization

package/api/src/services/rulePacks/universal.ts

@@ -0,0 +1,83 @@
+/**
+ * Universal Pack - Essential Rules for Everyone
+ *
+ * These 4 rules provide immediate value to all users regardless of role.
+ * They're safe, conservative, and focus on noise reduction and organization.
+ */
+
+import { RulePack } from './types.js';
+
+export const UNIVERSAL_PACK: RulePack = {
+  id: 'universal',
+  name: 'Universal Pack',
+  description: 'Essential automation rules that help everyone stay organized',
+  icon: '📦',
+  enabled_by_default: true,
+  target_roles: undefined, // Available to all roles
+  rules: [
+    {
+      id: 'universal-newsletters',
+      name: '📚 Newsletter Sweeper',
+      intent: 'Keep newsletters organized and out of main inbox',
+      description: 'Automatically archives newsletters and mass-marketing emails so you can read them later without inbox clutter',
+      condition: {
+        category: 'newsletter',
+        confidence_gt: 0.7
+      },
+      actions: ['archive', 'read'],
+      priority: 10,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'universal-cold-outreach',
+      name: '❄️ Cold Outreach Filter',
+      intent: 'Filter unsolicited sales and marketing emails',
+      description: 'Identifies and archives cold emails from unknown senders with sales language',
+      condition: {
+        or: [
+          {
+            // High-confidence promotional emails that are first contact
+            category: 'promotional',
+            confidence_gt: 0.85,
+            is_first_contact: true
+          },
+          {
+            // Spam category (very high confidence)
+            category: 'spam',
+            confidence_gt: 0.9
+          }
+        ]
+      },
+      actions: ['archive'],
+      priority: 20,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'universal-cc-organizer',
+      name: '👀 CC/FYI Organizer',
+      intent: 'Keep inbox focused on direct communications',
+      description: 'Archives emails where you\'re CC\'d in group threads, keeping your inbox for direct messages',
+      condition: {
+        recipient_type: 'cc',
+        recipient_count_gt: 3  // Group emails (more than 3 recipients)
+      },
+      actions: ['archive'],
+      priority: 5,
+      is_enabled_by_default: true
+    },
+    {
+      id: 'universal-receipts',
+      name: '🧾 Receipt Organizer',
+      intent: 'Auto-label receipts for easy tax and expense retrieval',
+      description: 'Labels transactional emails (receipts, invoices, confirmations) for easy searching',
+      condition: {
+        category: 'transactional',
+        contains_keywords: ['receipt', 'invoice', 'payment', 'order confirmation', 'purchase'],
+        confidence_gt: 0.75
+      },
+      actions: ['label:Finance/Receipts'],
+      priority: 15,
+      is_enabled_by_default: true
+    }
+  ]
+};

package/api/src/services/supabase.ts

@@ -133,6 +133,10 @@ export interface Rule {
     attachments?: any[];
     is_enabled: boolean;
     created_at: string;
+    // Rule Pack Support (Zero-Config UX)
+    pack?: string | null;              // Pack identifier (e.g., 'universal', 'executive', 'developer')
+    rule_template_id?: string | null;  // Template ID (e.g., 'universal-newsletters')
+    is_system_managed?: boolean;       // If true, part of a pack - can be disabled but not deleted
 }
 
 export interface ProcessingLog {
@@ -158,4 +162,40 @@ export interface UserSettings {
     sync_interval_minutes: number;
     created_at: string;
     updated_at: string;
+    // Zero-Config UX Support
+    user_role?: string | null;           // User role (executive, developer, sales, operations, other)
+    onboarding_completed?: boolean;      // Whether user completed role selection onboarding
+}
+
+// Zero-Config UX: Pack Installation Tracking
+export interface PackInstallation {
+    id: string;
+    user_id: string;
+    pack_id: string;
+    installed_at: string;
+    uninstalled_at: string | null;
+    source: 'onboarding' | 'manual' | 'auto';
+}
+
+// Zero-Config UX: Rule Effectiveness Metrics
+export interface RuleMetrics {
+    rule_id: string;
+    date: string;
+    times_triggered: number;
+    times_undone: number;
+    times_edited: number;
+    enabled: boolean;
+}
+
+// Zero-Config UX: Action History for Undo Capability
+export interface ActionHistory {
+    id: string;
+    email_id: string;
+    rule_id: string | null;
+    action: string;
+    sync_id: string | null;
+    executed_at: string;
+    undone: boolean;
+    undone_at: string | null;
+    metadata: Record<string, unknown> | null;
 }

package/dist/api/src/routes/index.js

@@ -8,6 +8,7 @@ import settingsRoutes from './settings.js';
 import emailsRoutes from './emails.js';
 import migrateRoutes from './migrate.js';
 import sdkRoutes from './sdk.js';
+import rulePacksRoutes from './rulePacks.js';
 const router = Router();
 router.use('/health', healthRoutes);
 router.use('/auth', authRoutes);
@@ -18,4 +19,5 @@ router.use('/settings', settingsRoutes);
 router.use('/emails', emailsRoutes);
 router.use('/migrate', migrateRoutes);
 router.use('/sdk', sdkRoutes);
+router.use('/rule-packs', rulePacksRoutes);
 export default router;