@visulima/email 1.0.0-alpha.9 → 1.0.1

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

@@ -1,64 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Mailjet configuration
- */
-export interface MailjetConfig extends BaseConfig {
-    /**
-     * Mailjet API Key
-     */
-    apiKey: string;
-    /**
-     * Mailjet API Secret
-     */
-    apiSecret: string;
-    /**
-     * Mailjet API endpoint
-     * Defaults to: https://api.mailjet.com
-     */
-    endpoint?: string;
-}
-/**
- * Mailjet-specific email options
- */
-export interface MailjetEmailOptions extends Omit<EmailOptions, "priority"> {
-    /**
-     * Custom campaign name
-     */
-    campaign?: string;
-    /**
-     * Custom ID for tracking
-     */
-    customId?: string;
-    /**
-     * Deduplicate campaign (prevent duplicate emails)
-     */
-    deduplicateCampaign?: boolean;
-    /**
-     * Delivery time (Unix timestamp)
-     */
-    deliveryTime?: number;
-    /**
-     * Event payload (for webhooks)
-     */
-    eventPayload?: string;
-    /**
-     * Priority (1-5, where 1 is highest)
-     */
-    priority?: number;
-    /**
-     * Mailjet template ID for template-based emails
-     */
-    templateId?: number;
-    /**
-     * Template language (for multilingual templates)
-     */
-    templateLanguage?: boolean;
-    /**
-     * Template variables for Mailjet templates
-     */
-    templateVariables?: Record<string, unknown>;
-    /**
-     * URL tags (for tracking)
-     */
-    urlTags?: Record<string, string>;
-}

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

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

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

@@ -1,32 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Mailomat configuration
- */
-export interface MailomatConfig extends BaseConfig {
-    /**
-     * Mailomat API key
-     */
-    apiKey: string;
-    /**
-     * Mailomat API endpoint
-     * Defaults to: https://api.mailomat.com
-     */
-    endpoint?: string;
-}
-/**
- * Mailomat-specific email options
- */
-export interface MailomatEmailOptions extends EmailOptions {
-    /**
-     * Tags for categorization
-     */
-    tags?: string[];
-    /**
-     * Mailomat template ID for template-based emails
-     */
-    templateId?: string;
-    /**
-     * Template variables for Mailomat templates
-     */
-    templateVariables?: Record<string, unknown>;
-}

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

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

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

@@ -1,44 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * MailPace configuration
- */
-export interface MailPaceConfig extends BaseConfig {
-    /**
-     * MailPace API token
-     */
-    apiToken: string;
-    /**
-     * MailPace API endpoint
-     * Defaults to: https://app.mailpace.com/api/v1
-     */
-    endpoint?: string;
-}
-/**
- * MailPace-specific email options
- */
-export interface MailPaceEmailOptions extends Omit<EmailOptions, "attachments"> {
-    /**
-     * Attachments (MailPace specific format)
-     */
-    attachments?: {
-        content: string;
-        content_type?: string;
-        name: string;
-    }[];
-    /**
-     * List unsubscribe header
-     */
-    listUnsubscribe?: string;
-    /**
-     * Tags for categorization
-     */
-    tags?: string[];
-    /**
-     * MailPace template ID for template-based emails
-     */
-    templateId?: number;
-    /**
-     * Template variables for MailPace templates
-     */
-    templateVariables?: Record<string, unknown>;
-}

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

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

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

@@ -1,36 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Mailtrap configuration
- */
-export interface MailtrapConfig extends BaseConfig {
-    /**
-     * Mailtrap API token
-     */
-    apiToken: string;
-    /**
-     * Mailtrap API endpoint
-     * Defaults to: https://send.api.mailtrap.io
-     */
-    endpoint?: string;
-}
-/**
- * Mailtrap-specific email options
- */
-export interface MailtrapEmailOptions extends EmailOptions {
-    /**
-     * Category for categorization
-     */
-    category?: string;
-    /**
-     * Custom variables (key-value pairs)
-     */
-    customVariables?: Record<string, unknown>;
-    /**
-     * Mailtrap template UUID for template-based emails
-     */
-    templateUuid?: string;
-    /**
-     * Template variables for Mailtrap templates
-     */
-    templateVariables?: Record<string, unknown>;
-}

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

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

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

@@ -1,79 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Mandrill configuration
- */
-export interface MandrillConfig extends BaseConfig {
-    /**
-     * Mandrill API key
-     */
-    apiKey: string;
-    /**
-     * Mandrill API endpoint
-     * Defaults to: https://mandrillapp.com/api/1.0
-     */
-    endpoint?: string;
-}
-/**
- * Mandrill-specific email options
- */
-export interface MandrillEmailOptions extends EmailOptions {
-    /**
-     * Global merge variables
-     */
-    globalMergeVars?: {
-        content: unknown;
-        name: string;
-    }[];
-    /**
-     * Google Analytics campaign
-     */
-    googleAnalyticsCampaign?: string;
-    /**
-     * Google Analytics domains
-     */
-    googleAnalyticsDomains?: string[];
-    /**
-     * Per-recipient merge variables
-     */
-    mergeVars?: {
-        rcpt: string;
-        vars: {
-            content: unknown;
-            name: string;
-        }[];
-    }[];
-    /**
-     * Metadata (key-value pairs)
-     */
-    metadata?: Record<string, string>;
-    /**
-     * Send at timestamp (ISO 8601 format)
-     */
-    sendAt?: string;
-    /**
-     * Subaccount ID
-     */
-    subaccount?: string;
-    /**
-     * Tags for categorization
-     */
-    tags?: string[];
-    /**
-     * Template content (for template-based emails)
-     */
-    templateContent?: {
-        content: string;
-        name: string;
-    }[];
-    /**
-     * Mandrill template name
-     */
-    templateName?: string;
-    /**
-     * Template variables (merge vars)
-     */
-    templateVariables?: {
-        content: unknown;
-        name: string;
-    }[];
-}

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

@@ -1,8 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { MockConfig, MockEmailEntry, MockEmailOptions } from "./types.d.ts";
-/**
- * Mock Provider for testing emails without actually sending them
- * Stores emails in memory for later retrieval and inspection
- */
-declare const mockProvider: ProviderFactory<MockConfig, MockEmailEntry[], MockEmailOptions>;
-export default mockProvider;

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

@@ -1,50 +0,0 @@
-import type { BaseConfig, EmailOptions, EmailResult, Receipt } from "../../types.d.ts";
-/**
- * Random delay range configuration
- */
-export interface RandomDelayRange {
-    max: number;
-    min: number;
-}
-/**
- * Mock configuration for testing
- */
-export interface MockConfig extends BaseConfig {
-    /**
-     * Default response to return for send operations
-     */
-    defaultResponse?: Receipt;
-    /**
-     * Delay in milliseconds before resolving (default: 0)
-     * Useful for testing async behavior
-     */
-    delay?: number;
-    /**
-     * Failure rate (0-1) for simulating random failures (default: 0)
-     * 0 = never fail, 1 = always fail
-     */
-    failureRate?: number;
-    /**
-     * Random delay range in milliseconds
-     * When set, delay will be randomly chosen between min and max
-     */
-    randomDelayRange?: RandomDelayRange;
-    /**
-     * Whether to simulate failures (default: false)
-     * When true, sendEmail will return an error
-     */
-    simulateFailure?: boolean;
-}
-/**
- * Mock-specific email options
- */
-export type MockEmailOptions = EmailOptions;
-/**
- * Stored email entry in mock provider
- */
-export interface MockEmailEntry {
-    id: string;
-    options: EmailOptions;
-    result: EmailResult;
-    timestamp: Date;
-}

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

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { NodemailerConfig, NodemailerEmailOptions } from "./types.d.ts";
-/**
- * Nodemailer Provider for sending emails via nodemailer
- */
-declare const nodemailerProvider: ProviderFactory<NodemailerConfig, unknown, NodemailerEmailOptions>;
-export default nodemailerProvider;

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

@@ -1,30 +0,0 @@
-import type { BaseConfig, EmailAddress, EmailOptions } from "../../types.d.ts";
-/**
- * Nodemailer configuration
- * Accepts any nodemailer transport configuration
- * Common transports: SMTP, Sendmail, SES, etc.
- */
-export interface NodemailerConfig extends BaseConfig {
-    /**
-     * Default from address (optional, can be overridden per email)
-     */
-    defaultFrom?: EmailAddress;
-    /**
-     * Nodemailer transport configuration
-     * Can be a transport object or a transport name (e.g., 'smtp', 'sendmail')
-     * For SMTP: { host, port, secure, auth: { user, pass } }
-     * For Sendmail: { path: '/usr/sbin/sendmail' }
-     * For SES: { SES: { ... } }
-     * See: https://nodemailer.com/transports/
-     */
-    transport: Record<string, unknown> | string;
-}
-/**
- * Nodemailer-specific email options
- */
-export interface NodemailerEmailOptions extends EmailOptions {
-    /**
-     * Override transport for this specific email
-     */
-    transportOverride?: Record<string, unknown> | string;
-}

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

@@ -1,8 +0,0 @@
-import type { EmailOptions } from "../../types.d.ts";
-import type { Provider, ProviderFactory } from "../provider.d.ts";
-import type { OpenTelemetryConfig } from "./types.d.ts";
-/**
- * OpenTelemetry Provider for instrumenting email sending with OpenTelemetry traces and metrics
- */
-declare const opentelemetryProvider: ProviderFactory<OpenTelemetryConfig, Provider<unknown, unknown, EmailOptions>, EmailOptions>;
-export default opentelemetryProvider;

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

@@ -1,31 +0,0 @@
-import type { Tracer } from "@opentelemetry/api";
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-import type { Provider, ProviderFactory } from "../provider.d.ts";
-/**
- * OpenTelemetry configuration
- */
-export interface OpenTelemetryConfig extends BaseConfig {
-    /**
-     * The provider to wrap with OpenTelemetry instrumentation
-     * Can be a Provider instance or ProviderFactory function
-     */
-    provider: Provider | ProviderFactory;
-    /**
-     * Whether to record email content in spans (default: false)
-     * When false, only metadata is recorded
-     */
-    recordContent?: boolean;
-    /**
-     * Service name for OpenTelemetry spans (default: "email")
-     */
-    serviceName?: string;
-    /**
-     * Optional OpenTelemetry tracer instance
-     * If not provided, uses the global tracer
-     */
-    tracer?: Tracer;
-}
-/**
- * OpenTelemetry-specific email options
- */
-export type OpenTelemetryEmailOptions = EmailOptions;

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

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

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

@@ -1,30 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Plunk configuration
- */
-export interface PlunkConfig extends BaseConfig {
-    apiKey: string;
-    endpoint?: string;
-}
-/**
- * Plunk-specific email options
- */
-export interface PlunkEmailOptions extends EmailOptions {
-    /**
-     * Data to pass to the email template
-     */
-    data?: Record<string, unknown>;
-    /**
-     * Subscriber email (used for tracking and analytics)
-     * If not provided, uses the first 'to' address
-     */
-    subscriber?: string;
-    /**
-     * Subscriber ID (optional identifier for the subscriber)
-     */
-    subscriberId?: string;
-    /**
-     * Template ID for template-based emails
-     */
-    templateId?: string;
-}

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

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

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

@@ -1,40 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Postal configuration
- */
-export interface PostalConfig extends BaseConfig {
-    /**
-     * Postal server API key
-     */
-    apiKey: string;
-    /**
-     * Postal API endpoint
-     * Defaults to: https://{host}/api/v1
-     */
-    endpoint?: string;
-    /**
-     * Postal server host
-     */
-    host: string;
-}
-/**
- * Postal-specific email options
- */
-export interface PostalEmailOptions extends EmailOptions {
-    /**
-     * Postal message ID (for tracking)
-     */
-    postalMessageId?: string;
-    /**
-     * Tags for categorization
-     */
-    tags?: string[];
-    /**
-     * Postal template ID for template-based emails
-     */
-    templateId?: number;
-    /**
-     * Template variables for Postal templates
-     */
-    templateVariables?: Record<string, unknown>;
-}

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

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

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

@@ -1,52 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Postmark configuration
- */
-export interface PostmarkConfig extends BaseConfig {
-    /**
-     * Postmark API endpoint
-     * Defaults to: https://api.postmarkapp.com
-     */
-    endpoint?: string;
-    /**
-     * Postmark Server API Token
-     */
-    serverToken: string;
-}
-/**
- * Postmark-specific email options
- */
-export interface PostmarkEmailOptions extends EmailOptions {
-    /**
-     * Inline CSS for HTML emails
-     */
-    inlineCss?: boolean;
-    /**
-     * Message stream ID
-     */
-    messageStream?: string;
-    /**
-     * Metadata (key-value pairs)
-     */
-    metadata?: Record<string, string>;
-    /**
-     * Postmark template alias (alternative to templateId)
-     */
-    templateAlias?: string;
-    /**
-     * Postmark template ID for template-based emails
-     */
-    templateId?: number;
-    /**
-     * Template model/variables for Postmark templates
-     */
-    templateModel?: Record<string, unknown>;
-    /**
-     * Track links
-     */
-    trackLinks?: "HtmlAndText" | "HtmlOnly" | "TextOnly" | "None";
-    /**
-     * Track opens
-     */
-    trackOpens?: boolean;
-}

package/dist/providers/provider.d.ts

@@ -1,27 +0,0 @@
-import type { EmailOptions, EmailResult, FeatureFlags, MaybePromise, Result } from "../types.d.ts";
-/**
- * Standard provider interface for email services.
- */
-export interface Provider<OptionsT = unknown, InstanceT = unknown, EmailOptionsT extends EmailOptions = EmailOptions> {
-    endpoint?: string;
-    features?: FeatureFlags;
-    getEmail?: (id: string) => MaybePromise<Result<unknown>>;
-    getInstance?: () => InstanceT;
-    initialize: (options?: Record<string, unknown>) => MaybePromise<void>;
-    isAvailable: () => MaybePromise<boolean>;
-    name?: string;
-    options?: OptionsT;
-    sendEmail: (options: EmailOptionsT) => MaybePromise<Result<EmailResult>>;
-    shutdown?: () => MaybePromise<void>;
-    validateCredentials?: () => MaybePromise<boolean>;
-}
-/**
- * Type for provider factory function.
- */
-export type ProviderFactory<OptionsT = unknown, InstanceT = unknown, EmailOptionsT extends EmailOptions = EmailOptions> = (options?: OptionsT) => Provider<OptionsT, InstanceT, EmailOptionsT>;
-/**
- * Helper function to define an email provider.
- * @param factory The provider factory function.
- * @returns The same factory function (for type inference).
- */
-export declare const defineProvider: <OptionsT = unknown, InstanceT = unknown, EmailOptionsT extends EmailOptions = EmailOptions>(factory: ProviderFactory<OptionsT, InstanceT, EmailOptionsT>) => ProviderFactory<OptionsT, InstanceT, EmailOptionsT>;

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

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

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

@@ -1,43 +0,0 @@
-import type { BaseConfig, EmailOptions, EmailTag } from "../../types.d.ts";
-/**
- * Resend configuration
- */
-export interface ResendConfig extends BaseConfig {
-    apiKey: string;
-    endpoint?: string;
-}
-/**
- * Resend-specific email tag type with additional constraints
- */
-export interface ResendEmailTag extends EmailTag {
-    /**
-     * Tag name - must only contain ASCII letters, numbers, underscores, or dashes
-     * Max length: 256 characters
-     */
-    name: string;
-    /**
-     * Tag value - must only contain ASCII letters, numbers, underscores, or dashes
-     */
-    value: string;
-}
-/**
- * Resend-specific email options
- */
-export interface ResendEmailOptions extends Omit<EmailOptions, "tags"> {
-    /**
-     * Schedule email for delivery at a specific time
-     */
-    scheduledAt?: Date | string;
-    /**
-     * Tags for categorizing emails
-     */
-    tags?: ResendEmailTag[];
-    /**
-     * Template data for template-based emails
-     */
-    templateData?: Record<string, unknown>;
-    /**
-     * Template ID for template-based emails
-     */
-    templateId?: string;
-}

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

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { RoundRobinConfig, RoundRobinEmailOptions } from "./types.d.ts";
-/**
- * Round Robin Provider for distributing email sending across multiple providers
- */
-declare const roundRobinProvider: ProviderFactory<RoundRobinConfig, unknown, RoundRobinEmailOptions>;
-export default roundRobinProvider;