@visulima/email 1.0.0-alpha.16 → 1.0.0-alpha.18

package/dist/mail.d.ts

@@ -1,206 +0,0 @@
-import DraftMailMessage from "./draft-mail-message.d.ts";
-import MailMessage from "./mail-message.d.ts";
-import type { Provider } from "./providers/provider.d.ts";
-import type { EmailAddress, EmailHeaders, EmailOptions, EmailResult, Receipt, Result } from "./types.d.ts";
-/**
- * Type alias for messages that can be sent via Mail.send().
- */
-export type SendableMessage = MailMessage | EmailOptions;
-/**
- * Global email configuration that applies to all emails sent through a Mail instance.
- */
-export interface MailGlobalConfig {
-    /**
-     * Default from address to use if not specified in the message.
-     */
-    from?: EmailAddress;
-    /**
-     * Global headers to add to all emails.
-     * These will be merged with message-specific headers, with message headers taking precedence.
-     */
-    headers?: EmailHeaders;
-    /**
-     * Default reply-to address to use if not specified in the message.
-     */
-    replyTo?: EmailAddress;
-}
-/**
- * Mail class - instance-based email sending.
- */
-export declare class Mail {
-    /**
-     * Extracts error messages from an error object.
-     * @param error Error object to extract messages from.
-     * @returns Array of error messages.
-     * @private
-     */
-    private static extractErrorMessages;
-    private provider;
-    private logger?;
-    private loggerInstance?;
-    private globalConfig?;
-    /**
-     * Creates a new Mail instance with a provider.
-     * @param provider The email provider instance.
-     */
-    constructor(provider: Provider);
-    /**
-     * Sets the logger instance for this mail instance.
-     * @param logger The logger instance (Console) to use for logging.
-     * @returns This instance for method chaining.
-     * @example
-     * ```ts
-     * const mail = createMail(provider);
-     * mail.setLogger(console);
-     * ```
-     */
-    setLogger(logger: Console): this;
-    /**
-     * Sets the default from address for all emails sent through this Mail instance.
-     * @param from Default from address to use if not specified in the message.
-     * @returns This instance for method chaining.
-     * @example
-     * ```ts
-     * const mail = createMail(provider);
-     * mail.setFrom({ email: "noreply@example.com", name: "My App" });
-     * ```
-     */
-    setFrom(from: EmailAddress): this;
-    /**
-     * Sets the default reply-to address for all emails sent through this Mail instance.
-     * @param replyTo Default reply-to address to use if not specified in the message.
-     * @returns This instance for method chaining.
-     * @example
-     * ```ts
-     * const mail = createMail(provider);
-     * mail.setReplyTo({ email: "support@example.com" });
-     * ```
-     */
-    setReplyTo(replyTo: EmailAddress): this;
-    /**
-     * Sets default headers for all emails sent through this Mail instance.
-     * These headers will be merged with message-specific headers, with message headers taking precedence.
-     * @param headers Default headers to add to all emails.
-     * @returns This instance for method chaining.
-     * @example
-     * ```ts
-     * const mail = createMail(provider);
-     * mail.setHeaders({ "X-App-Name": "MyApp", "X-Version": "1.0.0" });
-     * ```
-     */
-    setHeaders(headers: EmailHeaders): this;
-    /**
-     * Creates a draft email in EML (RFC 822) format without sending it.
-     * This is useful for previewing, saving for later, or testing email content.
-     * @param message The message to create a draft from (MailMessage or EmailOptions).
-     * @returns The email in EML (RFC 822) format as a string with X-Unsent: 1 header.
-     * @example
-     * ```ts
-     * // Create a draft from MailMessage
-     * const message = new MailMessage()
-     *   .to("user@example.com")
-     *   .from("sender@example.com")
-     *   .subject("Hello")
-     *   .html("<h1>Hello World</h1>");
-     *
-     * const eml = await mail.draft(message);
-     * console.log("Draft EML:", eml);
-     *
-     * // Save to file
-     * await fs.writeFile("draft.eml", eml);
-     *
-     * // Or send later by parsing the EML back to EmailOptions
-     * ```
-     */
-    draft(message: SendableMessage | DraftMailMessage): Promise<string>;
-    /**
-     * Sends an email message or email options.
-     * @param message The message to send (MailMessage or EmailOptions).
-     * @returns A result object containing the email result or error.
-     * @example
-     * ```ts
-     * // Using MailMessage
-     * const message = new MailMessage()
-     *   .to("user@example.com")
-     *   .from("sender@example.com")
-     *   .subject("Hello")
-     *   .html("<h1>Hello World</h1>");
-     * await mail.send(message);
-     *
-     * // Using EmailOptions
-     * await mail.send({
-     *   to: "user@example.com",
-     *   from: "sender@example.com",
-     *   subject: "Hello",
-     *   html: "<h1>Hello World</h1>"
-     * });
-     * ```
-     */
-    send(message: SendableMessage): Promise<Result<EmailResult>>;
-    /**
-     * Sends multiple messages using the email service.
-     * Returns an async iterable that yields receipts for each sent message.
-     * @example
-     * ```ts
-     * const messages = [
-     *   { from: "sender@example.com", to: "user1@example.com", subject: "Hello 1", html: "<h1>Hello</h1>" },
-     *   { from: "sender@example.com", to: "user2@example.com", subject: "Hello 2", html: "<h1>Hello</h1>" },
-     * ];
-     *
-     * for await (const receipt of mail.sendMany(messages)) {
-     *   if (receipt.successful) {
-     *     console.log("Sent:", receipt.messageId);
-     *   } else {
-     *     console.error("Failed:", receipt.errorMessages);
-     *   }
-     * }
-     * ```
-     * @param messages An iterable of MailMessage instances or email options to send.
-     * @param options Optional parameters for sending.
-     * @param options.signal Abort signal to cancel the operation.
-     * @returns An async iterable that yields receipts for each sent message.
-     */
-    sendMany(messages: Iterable<SendableMessage> | AsyncIterable<SendableMessage>, options?: {
-        signal?: AbortSignal;
-    }): AsyncIterable<Receipt>;
-    /**
-     * Builds email options from a MailMessage instance for draft creation.
-     * Applies global configuration before building to ensure required fields are set.
-     * @param message The MailMessage or DraftMailMessage instance.
-     * @returns Built email options.
-     * @private
-     */
-    private buildDraftFromMessage;
-    /**
-     * Builds email options from EmailOptions for draft creation.
-     * @param options The EmailOptions object.
-     * @returns Email options.
-     * @private
-     */
-    private buildDraftFromOptions;
-    /**
-     * Applies global configuration to a MailMessage instance.
-     * @param message The MailMessage or DraftMailMessage instance.
-     * @private
-     */
-    private applyGlobalConfigToMessage;
-    /**
-     * Applies global configuration to email options.
-     * Global values are only applied if the corresponding field is not already set in the email options.
-     * @param emailOptions The email options to apply global configuration to.
-     * @returns Email options with global configuration applied.
-     * @private
-     */
-    private applyGlobalConfig;
-}
-/**
- * Creates a new Mail instance with a provider.
- * @param provider The email provider instance.
- * @returns A new Mail instance.
- * @example
- * ```ts
- * const mail = createMail(provider);
- * mail.setFrom({ email: "noreply@example.com", name: "My App" });
- * ```
- */
-export declare const createMail: (provider: Provider) => Mail;

package/dist/providers/ahasend/provider.d.ts

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { AhaSendConfig } from "./types.d.ts";
-/**
- * AhaSend Provider for sending emails through AhaSend API
- */
-declare const ahaSendProvider: ProviderFactory<AhaSendConfig>;
-export default ahaSendProvider;

package/dist/providers/ahasend/types.d.ts

@@ -1,28 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * AhaSend configuration
- */
-export interface AhaSendConfig extends BaseConfig {
-    /**
-     * AhaSend API key
-     */
-    apiKey: string;
-    /**
-     * AhaSend API endpoint
-     * Defaults to: https://api.ahasend.com
-     */
-    endpoint?: string;
-}
-/**
- * AhaSend-specific email options
- */
-export interface AhaSendEmailOptions extends EmailOptions {
-    /**
-     * AhaSend template ID for template-based emails
-     */
-    templateId?: string;
-    /**
-     * Template variables for AhaSend templates
-     */
-    templateVariables?: Record<string, unknown>;
-}

package/dist/providers/aws-ses/provider.d.ts

@@ -1,8 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { AwsSesConfig } from "./types.d.ts";
-/**
- * AWS SES Email Provider Implementation - Zero dependency version
- * Uses native Node.js APIs instead of AWS SDK
- */
-declare const awsSesProvider: ProviderFactory<AwsSesConfig>;
-export default awsSesProvider;

package/dist/providers/aws-ses/types.d.ts

@@ -1,38 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * AWS SES configuration
- */
-export interface AwsSesConfig extends BaseConfig {
-    accessKeyId: string;
-    apiVersion?: string;
-    endpoint?: string;
-    maxAttempts?: number;
-    region: string;
-    secretAccessKey: string;
-    sessionToken?: string;
-}
-/**
- * AWS SES-specific email options
- */
-export interface AwsSesEmailOptions extends EmailOptions {
-    /**
-     * Configuration set name
-     */
-    configurationSetName?: string;
-    /**
-     * Message tags as key-value pairs
-     */
-    messageTags?: Record<string, string>;
-    /**
-     * Return path email address
-     */
-    returnPath?: string;
-    /**
-     * Return path ARN
-     */
-    returnPathArn?: string;
-    /**
-     * Source ARN for sending authorization
-     */
-    sourceArn?: string;
-}

package/dist/providers/azure/provider.d.ts

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { AzureConfig, AzureEmailOptions } from "./types.d.ts";
-/**
- * Azure Communication Services Provider for sending emails through Azure API
- */
-declare const azureProvider: ProviderFactory<AzureConfig, unknown, AzureEmailOptions>;
-export default azureProvider;

package/dist/providers/azure/types.d.ts

@@ -1,44 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Azure Communication Services configuration
- */
-export interface AzureConfig extends BaseConfig {
-    /**
-     * Azure AD access token (for OAuth2 authentication)
-     */
-    accessToken?: string;
-    /**
-     * Azure Communication Services connection string or access token
-     */
-    connectionString?: string;
-    /**
-     * Azure Communication Services endpoint
-     * Defaults to: https://{region}.communication.azure.com
-     */
-    endpoint?: string;
-    /**
-     * Azure region (e.g., "eastus", "westus")
-     */
-    region: string;
-}
-/**
- * Azure-specific email options
- */
-export interface AzureEmailOptions extends EmailOptions {
-    /**
-     * Custom headers
-     */
-    headers?: Record<string, string>;
-    /**
-     * Importance level (normal, high)
-     */
-    importance?: "normal" | "high";
-    /**
-     * Azure template ID for template-based emails
-     */
-    templateId?: string;
-    /**
-     * Template variables for Azure templates
-     */
-    templateVariables?: Record<string, unknown>;
-}

package/dist/providers/brevo/provider.d.ts

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { BrevoConfig, BrevoEmailOptions } from "./types.d.ts";
-/**
- * Brevo Provider for sending emails through Brevo API
- */
-declare const brevoProvider: ProviderFactory<BrevoConfig, unknown, BrevoEmailOptions>;
-export default brevoProvider;

package/dist/providers/brevo/types.d.ts

@@ -1,57 +0,0 @@
-import type { BaseConfig, EmailAddress, EmailOptions } from "../../types.d.ts";
-/**
- * Brevo configuration
- */
-export interface BrevoConfig extends BaseConfig {
-    /**
-     * Brevo API key
-     */
-    apiKey: string;
-    /**
-     * Brevo API endpoint
-     * Defaults to: https://api.brevo.com/v3
-     */
-    endpoint?: string;
-    /**
-     * Enable hard validation for replyTo addresses.
-     * If true, arrays will be rejected. If false, the first address from an array will be used.
-     * Defaults to: false
-     */
-    hardValidation?: boolean;
-}
-/**
- * Brevo-specific email options
- */
-export interface BrevoEmailOptions extends Omit<EmailOptions, "replyTo"> {
-    /**
-     * Batch ID for batch sending
-     */
-    batchId?: string;
-    /**
-     * Headers (custom headers)
-     */
-    headers?: Record<string, string>;
-    /**
-     * Reply-to email address (can override base replyTo).
-     * Only one address is allowed. If an array is provided and hardValidation is false, the first address will be used.
-     */
-    replyTo?: EmailAddress | EmailAddress[];
-    /**
-     * Scheduled date/time
-     * - If string: ISO 8601 format (e.g., "2025-01-15T10:00:00Z")
-     * - If number: Unix timestamp in seconds (not milliseconds)
-     */
-    scheduledAt?: string | number;
-    /**
-     * Tags for categorization
-     */
-    tags?: string[];
-    /**
-     * Brevo template ID for template-based emails
-     */
-    templateId?: number;
-    /**
-     * Template parameters for Brevo templates
-     */
-    templateParams?: Record<string, unknown>;
-}

package/dist/providers/failover/provider.d.ts

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { FailoverConfig } from "./types.d.ts";
-/**
- * Failover Provider for sending emails with automatic failover to backup providers.
- */
-declare const provider: ProviderFactory<FailoverConfig>;
-export default provider;

package/dist/providers/failover/types.d.ts

@@ -1,19 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Failover configuration
- */
-export interface FailoverConfig extends BaseConfig {
-    /**
-     * Array of provider instances or provider factories to use in failover order
-     * Can be Provider instances or ProviderFactory functions
-     */
-    mailers: unknown[];
-    /**
-     * Time in milliseconds to wait before trying the next provider (default: 60)
-     */
-    retryAfter?: number;
-}
-/**
- * Failover-specific email options
- */
-export type FailoverEmailOptions = EmailOptions;

package/dist/providers/http/provider.d.ts

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { HttpEmailConfig } from "./types.d.ts";
-/**
- * HTTP Email Provider for sending emails via HTTP API.
- */
-declare const httpProvider: ProviderFactory<HttpEmailConfig>;
-export default httpProvider;

package/dist/providers/http/types.d.ts

@@ -1,27 +0,0 @@
-import type { EmailOptions } from "../../types.d.ts";
-/**
- * HTTP email configuration
- */
-export interface HttpEmailConfig {
-    apiKey?: string;
-    endpoint: string;
-    headers?: Record<string, string>;
-    method?: "GET" | "POST" | "PUT";
-}
-/**
- * HTTP-specific email options
- */
-export interface HttpEmailOptions extends EmailOptions {
-    /**
-     * Custom parameters to include in the request payload
-     */
-    customParams?: Record<string, unknown>;
-    /**
-     * Override the endpoint for this specific email
-     */
-    endpointOverride?: string;
-    /**
-     * Override the HTTP method for this specific email
-     */
-    methodOverride?: "GET" | "POST" | "PUT";
-}

package/dist/providers/infobip/provider.d.ts

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { InfobipConfig } from "./types.d.ts";
-/**
- * Infobip Provider for sending emails through Infobip API
- */
-declare const infobipProvider: ProviderFactory<InfobipConfig>;
-export default infobipProvider;

package/dist/providers/infobip/types.d.ts

@@ -1,48 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Infobip configuration
- */
-export interface InfobipConfig extends BaseConfig {
-    /**
-     * Infobip API key
-     */
-    apiKey: string;
-    /**
-     * Infobip base URL (e.g., "https://api.infobip.com")
-     */
-    baseUrl?: string;
-    /**
-     * Infobip API endpoint
-     * Defaults to: https://{baseUrl}/email/3/send
-     */
-    endpoint?: string;
-}
-/**
- * Infobip-specific email options
- */
-export interface InfobipEmailOptions extends EmailOptions {
-    /**
-     * Intermediate report (for delivery status updates)
-     */
-    intermediateReport?: boolean;
-    /**
-     * Notify URL (for delivery notifications)
-     */
-    notifyUrl?: string;
-    /**
-     * Send at (Unix timestamp in milliseconds)
-     */
-    sendAt?: number;
-    /**
-     * Infobip template ID for template-based emails
-     */
-    templateId?: number;
-    /**
-     * Template variables for Infobip templates
-     */
-    templateVariables?: Record<string, unknown>;
-    /**
-     * Tracking URL (for click tracking)
-     */
-    trackingUrl?: string;
-}

package/dist/providers/mailcrab/provider.d.ts

@@ -1,9 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { MailCrabConfig } from "./types.d.ts";
-/**
- * MailCrab Provider for local email testing
- * MailCrab is a local SMTP server for testing emails during development
- * This is a convenience wrapper around the SMTP provider with MailCrab defaults
- */
-declare const mailCrabProvider: ProviderFactory<MailCrabConfig>;
-export default mailCrabProvider;

package/dist/providers/mailcrab/types.d.ts

@@ -1,22 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * MailCrab configuration (for local development/testing)
- */
-export interface MailCrabConfig extends BaseConfig {
-    /**
-     * MailCrab host (default: localhost)
-     */
-    host?: string;
-    /**
-     * MailCrab port (default: 1025)
-     */
-    port?: number;
-    /**
-     * Use secure connection (default: false)
-     */
-    secure?: boolean;
-}
-/**
- * MailCrab-specific email options
- */
-export type MailCrabEmailOptions = EmailOptions;

package/dist/providers/mailersend/provider.d.ts

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { MailerSendConfig } from "./types.d.ts";
-/**
- * MailerSend Provider for sending emails through MailerSend API
- */
-declare const mailerSendProvider: ProviderFactory<MailerSendConfig>;
-export default mailerSendProvider;

package/dist/providers/mailersend/types.d.ts

@@ -1,43 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * MailerSend configuration
- */
-export interface MailerSendConfig extends BaseConfig {
-    /**
-     * MailerSend API token
-     */
-    apiToken: string;
-    /**
-     * MailerSend API endpoint
-     * Defaults to: https://api.mailersend.com
-     */
-    endpoint?: string;
-}
-/**
- * MailerSend-specific email options
- */
-export interface MailerSendEmailOptions extends EmailOptions {
-    /**
-     * Domain ID (optional, for domain-specific sending)
-     */
-    domainId?: string;
-    /**
-     * Personalization (per-recipient variables)
-     */
-    personalization?: {
-        data: Record<string, unknown>;
-        email: string;
-    }[];
-    /**
-     * Scheduled at (Unix timestamp)
-     */
-    scheduledAt?: number;
-    /**
-     * MailerSend template ID for template-based emails
-     */
-    templateId?: string;
-    /**
-     * Template variables for MailerSend templates
-     */
-    templateVariables?: Record<string, unknown>;
-}

package/dist/providers/mailgun/provider.d.ts

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { MailgunConfig } from "./types.d.ts";
-/**
- * Mailgun Provider for sending emails through Mailgun API
- */
-declare const mailgunProvider: ProviderFactory<MailgunConfig>;
-export default mailgunProvider;