@astralibx/email-account-manager 2.0.2 → 4.0.0

package/README.md

@@ -52,6 +52,15 @@ app.use('/webhooks/ses', eam.webhookRoutes.ses);
 // Unsubscribe pages (public)
 app.use('/unsubscribe', eam.unsubscribeRoutes);
 
+// Create an account with metadata
+await eam.accounts.create({
+  email: 'outreach@yourdomain.com',
+  senderName: 'Your Company',
+  provider: 'gmail',
+  smtp: { host: 'smtp.gmail.com', port: 587, user: 'outreach@yourdomain.com', pass: 'app-password' },
+  metadata: { sender_names: ['Sales', 'Support'], contact_number: '+1-555-0100' },
+});
+
 // Send an email programmatically
 const result = await eam.smtp.send({
   to: 'recipient@example.com',
@@ -66,7 +75,7 @@ app.listen(3000);
 
 ## Features
 
-- **Multi-account management** -- Gmail and AWS SES providers with credential storage and status tracking. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/account-management.md)
+- **Multi-account management** -- Gmail and AWS SES providers with credential storage, status tracking, and freeform metadata. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/account-management.md)
 - **Health tracking** -- Automatic scoring (+1/-5/-10) with auto-disable on threshold breach. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/health-tracking.md)
 - **Account warmup** -- Phased volume ramp-up with configurable schedules stored per-account. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/warmup-system.md)
 - **Capacity-based rotation** -- Health-weighted account selection with daily limit enforcement. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/capacity-selection.md)

package/dist/index.d.mts

@@ -392,6 +392,7 @@ interface EmailAccount {
     limits: AccountLimits;
     health: AccountHealthData;
     warmup: AccountWarmupData;
+    metadata?: Record<string, unknown>;
     totalEmailsSent: number;
     lastSuccessfulSendAt?: Date;
     createdAt: Date;
@@ -408,6 +409,7 @@ interface CreateEmailAccountInput {
     warmup?: {
         schedule?: WarmupPhase[];
     };
+    metadata?: Record<string, unknown>;
     health?: {
         thresholds?: Partial<HealthThresholds>;
     };
@@ -420,6 +422,7 @@ interface UpdateEmailAccountInput {
     ses?: Partial<SesConfig>;
     limits?: Partial<AccountLimits>;
     warmup?: Partial<AccountWarmupData>;
+    metadata?: Record<string, unknown>;
     health?: {
         thresholds?: Partial<HealthThresholds>;
     };
@@ -484,6 +487,7 @@ interface IEmailAccount {
         currentDay: number;
         schedule: WarmupPhase[];
     };
+    metadata?: Record<string, unknown>;
     totalEmailsSent: number;
     lastSuccessfulSendAt?: Date;
     lastImapCheckAt?: Date;

package/dist/index.d.ts

@@ -392,6 +392,7 @@ interface EmailAccount {
     limits: AccountLimits;
     health: AccountHealthData;
     warmup: AccountWarmupData;
+    metadata?: Record<string, unknown>;
     totalEmailsSent: number;
     lastSuccessfulSendAt?: Date;
     createdAt: Date;
@@ -408,6 +409,7 @@ interface CreateEmailAccountInput {
     warmup?: {
         schedule?: WarmupPhase[];
     };
+    metadata?: Record<string, unknown>;
     health?: {
         thresholds?: Partial<HealthThresholds>;
     };
@@ -420,6 +422,7 @@ interface UpdateEmailAccountInput {
     ses?: Partial<SesConfig>;
     limits?: Partial<AccountLimits>;
     warmup?: Partial<AccountWarmupData>;
+    metadata?: Record<string, unknown>;
     health?: {
         thresholds?: Partial<HealthThresholds>;
     };
@@ -484,6 +487,7 @@ interface IEmailAccount {
         currentDay: number;
         schedule: WarmupPhase[];
     };
+    metadata?: Record<string, unknown>;
     totalEmailsSent: number;
     lastSuccessfulSendAt?: Date;
     lastImapCheckAt?: Date;

package/dist/index.js

@@ -314,6 +314,10 @@ function createEmailAccountSchema(options) {
         required: true,
         _id: false
       },
+      metadata: {
+        type: mongoose.Schema.Types.Mixed,
+        default: {}
+      },
       totalEmailsSent: { type: Number, default: 0 },
       lastSuccessfulSendAt: Date,
       lastImapCheckAt: Date
@@ -2206,6 +2210,16 @@ function createApprovalProcessor(EmailDraft, smtpService, queueService, logger)
 }
 
 // src/controllers/account.controller.ts
+var MAX_METADATA_SIZE = 64e3;
+function sanitizeMetadata(raw) {
+  if (typeof raw !== "object" || raw === null || Array.isArray(raw)) return {};
+  const json2 = JSON.stringify(raw);
+  if (json2.length > MAX_METADATA_SIZE) {
+    throw new Error(`metadata exceeds ${MAX_METADATA_SIZE} byte limit`);
+  }
+  const { __proto__: _a, constructor: _b, prototype: _c, ...safe } = raw;
+  return safe;
+}
 function createAccountController(EmailAccount, capacityManager, healthTracker, warmupManager, smtpService, imapBounceChecker, config) {
   return {
     async list(req, res) {
@@ -2266,6 +2280,7 @@ function createAccountController(EmailAccount, capacityManager, healthTracker, w
             schedule: input.warmup?.schedule || warmupDefaults || []
           },
           status: "warmup",
+          ...input.metadata !== void 0 ? { metadata: sanitizeMetadata(input.metadata) } : {},
           totalEmailsSent: 0
         };
         const account = await EmailAccount.create(accountData);
@@ -2300,6 +2315,7 @@ function createAccountController(EmailAccount, capacityManager, healthTracker, w
           }
         }
         if (input.limits?.dailyMax !== void 0) updates["limits.dailyMax"] = input.limits.dailyMax;
+        if (input.metadata !== void 0) updates.metadata = sanitizeMetadata(input.metadata);
         const account = await EmailAccount.findByIdAndUpdate(
           req.params.id,
           { $set: updates },