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

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>;
-    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 } from "./types.d.ts";
-/**
- * Round Robin Provider for distributing email sending across multiple providers
- */
-declare const roundRobinProvider: ProviderFactory<RoundRobinConfig>;
-export default roundRobinProvider;

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

@@ -1,19 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Round Robin configuration
- */
-export interface RoundRobinConfig extends BaseConfig {
-    /**
-     * Array of provider instances or provider factories to use for round-robin distribution
-     * Can be Provider instances or ProviderFactory functions
-     */
-    mailers: unknown[];
-    /**
-     * Time in milliseconds to wait before retrying with next provider if current is unavailable (default: 60)
-     */
-    retryAfter?: number;
-}
-/**
- * Round Robin-specific email options
- */
-export type RoundRobinEmailOptions = EmailOptions;

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

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

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

@@ -1,36 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * Scaleway configuration
- */
-export interface ScalewayConfig extends BaseConfig {
-    /**
-     * Scaleway API key
-     */
-    apiKey: string;
-    /**
-     * Scaleway API endpoint
-     * Defaults to: https://api.scaleway.com/transactional-email/v1alpha1
-     */
-    endpoint?: string;
-    /**
-     * Scaleway region (e.g., "fr-par", "nl-ams")
-     */
-    region: string;
-}
-/**
- * Scaleway-specific email options
- */
-export interface ScalewayEmailOptions extends EmailOptions {
-    /**
-     * Project ID (optional)
-     */
-    projectId?: string;
-    /**
-     * Scaleway template ID for template-based emails
-     */
-    templateId?: string;
-    /**
-     * Template variables for Scaleway templates
-     */
-    templateVariables?: Record<string, unknown>;
-}

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

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

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

@@ -1,76 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * SendGrid configuration
- */
-export interface SendGridConfig extends BaseConfig {
-    apiKey: string;
-    endpoint?: string;
-}
-/**
- * SendGrid-specific email options
- */
-export interface SendGridEmailOptions extends EmailOptions {
-    /**
-     * ASM (Advanced Suppression Management) group ID for unsubscribe
-     */
-    asmGroupId?: number;
-    /**
-     * Batch ID for batch sending
-     */
-    batchId?: string;
-    /**
-     * IP pool name
-     */
-    ipPoolName?: string;
-    /**
-     * Mail settings (click tracking, open tracking, etc.)
-     */
-    mailSettings?: {
-        bypassListManagement?: boolean;
-        footer?: {
-            enable?: boolean;
-            html?: string;
-            text?: string;
-        };
-        sandboxMode?: boolean;
-    };
-    /**
-     * Send at timestamp (Unix timestamp)
-     */
-    sendAt?: number;
-    /**
-     * Dynamic template data for SendGrid dynamic templates
-     */
-    templateData?: Record<string, unknown>;
-    /**
-     * SendGrid template ID for template-based emails
-     */
-    templateId?: string;
-    /**
-     * Tracking settings
-     */
-    trackingSettings?: {
-        clickTracking?: {
-            enable?: boolean;
-            enableText?: boolean;
-        };
-        ganalytics?: {
-            enable?: boolean;
-            utmCampaign?: string;
-            utmContent?: string;
-            utmMedium?: string;
-            utmSource?: string;
-            utmTerm?: string;
-        };
-        openTracking?: {
-            enable?: boolean;
-            substitutionTag?: string;
-        };
-        subscriptionTracking?: {
-            enable?: boolean;
-            html?: string;
-            substitutionTag?: string;
-            text?: string;
-        };
-    };
-}

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

@@ -1,7 +0,0 @@
-import type { ProviderFactory } from "../provider.d.ts";
-import type { SmtpConfig } from "./types.d.ts";
-/**
- * SMTP provider for sending emails via SMTP protocol
- */
-declare const smtpProvider: ProviderFactory<SmtpConfig>;
-export default smtpProvider;

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

@@ -1,63 +0,0 @@
-import type { BaseConfig, EmailOptions } from "../../types.d.ts";
-/**
- * SMTP configuration
- */
-export interface SmtpConfig extends BaseConfig {
-    authMethod?: "LOGIN" | "PLAIN" | "CRAM-MD5" | "OAUTH2";
-    dkim?: {
-        domainName: string;
-        keySelector: string;
-        privateKey: string;
-    };
-    host: string;
-    maxConnections?: number;
-    oauth2?: {
-        accessToken?: string;
-        clientId: string;
-        clientSecret: string;
-        expires?: number;
-        refreshToken: string;
-        user: string;
-    };
-    password?: string;
-    pool?: boolean;
-    port: number;
-    rejectUnauthorized?: boolean;
-    secure?: boolean;
-    user?: string;
-}
-/**
- * SMTP-specific email options
- */
-export interface SmtpEmailOptions extends EmailOptions {
-    /**
-     * Delivery Status Notification options
-     */
-    dsn?: {
-        /** Request notification on delay */
-        delay?: boolean;
-        /** Request notification on failure */
-        failure?: boolean;
-        /** Request successful delivery notification */
-        success?: boolean;
-    };
-    /** Special Google Mail headers */
-    googleMailHeaders?: {
-        /** Category for email organization */
-        category?: "primary" | "social" | "promotions" | "updates" | "forums";
-        /** Feedback ID for engagement tracking */
-        feedbackId?: string;
-        /** Mark as promotional content */
-        promotionalContent?: boolean;
-    };
-    /** Reference to a previous message ID (for threading) */
-    inReplyTo?: string;
-    /** List-Unsubscribe header for easy unsubscribe functionality */
-    listUnsubscribe?: string | string[];
-    /** Message priority: 'high', 'normal', or 'low' */
-    priority?: "high" | "normal" | "low";
-    /** References to related message IDs */
-    references?: string | string[];
-    /** Whether to sign the email with DKIM */
-    useDkim?: boolean;
-}

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

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

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

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

package/dist/providers/utils/address-formatter.d.ts

@@ -1,139 +0,0 @@
-import type { EmailAddress } from "../../types.d.ts";
-/**
- * Formats a single email address as "Name <email>" or just "email" if no name is provided.
- * @param address The email address object to format.
- * @returns The formatted email address string.
- */
-export declare const formatAddress: (address: EmailAddress) => string;
-/**
- * Formats an array of email addresses or a single address as "Name <email>" format.
- * @param addresses The email address(es) to format (single or array).
- * @returns An array of formatted email address strings.
- */
-export declare const formatAddresses: (addresses: EmailAddress | EmailAddress[]) => string[];
-/**
- * Formats a single email address for SendGrid API format.
- * @param address The email address object to format.
- * @returns An object with email and optional name properties.
- */
-export declare const formatSendGridAddress: (address: EmailAddress) => {
-    email: string;
-    name?: string;
-};
-/**
- * Formats email addresses for SendGrid API format.
- * @param addresses The email address(es) to format (single or array).
- * @returns An array of objects with email and optional name properties.
- */
-export declare const formatSendGridAddresses: (addresses: EmailAddress | EmailAddress[]) => {
-    email: string;
-    name?: string;
-}[];
-/**
- * Formats email addresses as a simple string array containing only email addresses.
- * @param addresses The email address(es) to format (single or array).
- * @returns An array of email address strings.
- */
-export declare const formatAddressEmails: (addresses: EmailAddress | EmailAddress[]) => string[];
-/**
- * Formats an email address for Azure API format.
- * @param address The email address object to format.
- * @returns An object with email and optional displayName properties.
- */
-export declare const formatAzureAddress: (address: EmailAddress) => {
-    displayName?: string;
-    email: string;
-};
-/**
- * Formats email addresses for Azure API format.
- * @param addresses The email address(es) to format (single or array).
- * @returns An array of objects with email and optional displayName properties.
- */
-export declare const formatAzureAddresses: (addresses: EmailAddress | EmailAddress[]) => {
-    displayName?: string;
-    email: string;
-}[];
-/**
- * Formats an email address for Mailjet API format.
- * @param address The email address object to format.
- * @returns An object with Email and optional Name properties.
- */
-export declare const formatMailjetAddress: (address: EmailAddress) => {
-    Email: string;
-    Name?: string;
-};
-/**
- * Formats email addresses for Mailjet API format.
- * @param addresses The email address(es) to format (single or array).
- * @returns An array of objects with Email and optional Name properties.
- */
-export declare const formatMailjetAddresses: (addresses: EmailAddress | EmailAddress[]) => {
-    Email: string;
-    Name?: string;
-}[];
-/**
- * Formats an email address for Mandrill API format.
- * @param address The email address object to format.
- * @param type The recipient type (default: "to").
- * @returns An object with email, optional name, and type properties.
- */
-export declare const formatMandrillAddress: (address: EmailAddress, type?: string) => {
-    email: string;
-    name?: string;
-    type: string;
-};
-/**
- * Formats email addresses for Mandrill API format.
- * @param addresses The email address(es) to format (single or array).
- * @param type The recipient type (default: "to").
- * @returns An array of objects with email, optional name, and type properties.
- */
-export declare const formatMandrillAddresses: (addresses: EmailAddress | EmailAddress[], type?: string) => {
-    email: string;
-    name?: string;
-    type: string;
-}[];
-/**
- * Formats an email address for Postal API format.
- * @param address The email address object to format.
- * @returns An object with address and optional name properties.
- */
-export declare const formatPostalAddress: (address: EmailAddress) => {
-    address: string;
-    name?: string;
-};
-/**
- * Formats email addresses for Postal API format.
- * @param addresses The email address(es) to format (single or array).
- * @returns An array of objects with address and optional name properties.
- */
-export declare const formatPostalAddresses: (addresses: EmailAddress | EmailAddress[]) => {
-    address: string;
-    name?: string;
-}[];
-/**
- * Formats email addresses for MailPace API format as formatted strings.
- * @param addresses The email address(es) to format (single or array).
- * @returns An array of formatted email address strings.
- */
-export declare const formatMailpaceAddresses: (addresses: EmailAddress | EmailAddress[]) => string[];
-/**
- * Formats an email address for Zeptomail API format.
- * @param address The email address object to format.
- * @returns An object with address and optional name properties.
- */
-export declare const formatZeptomailAddress: (address: EmailAddress) => {
-    address: string;
-    name?: string;
-};
-/**
- * Formats email addresses for Zeptomail API format.
- * @param addresses The email address(es) to format (single or array).
- * @returns An array of objects with email_address containing address and optional name properties.
- */
-export declare const formatZeptomailAddresses: (addresses: EmailAddress | EmailAddress[]) => {
-    email_address: {
-        address: string;
-        name?: string;
-    };
-}[];

package/dist/providers/utils/attachment-processor.d.ts

@@ -1,58 +0,0 @@
-import type { Attachment } from "../../types.d.ts";
-/**
- * Processes attachment content and converts it to a base64-encoded string.
- * @param attachment The attachment object to process.
- * @param providerName The name of the provider (for error messages).
- * @returns The base64-encoded string representation of the attachment content.
- * @throws {EmailError} When the attachment has no content.
- */
-export declare const processAttachmentContent: (attachment: Attachment, providerName: string) => Promise<string>;
-/**
- * Creates a standardized attachment object for API payloads.
- * @param attachment The attachment object to standardize.
- * @param providerName The name of the provider (for error messages).
- * @returns A standardized attachment object with content, contentType, disposition, filename, and optional contentId.
- */
-export declare const createStandardAttachment: (attachment: Attachment, providerName: string) => Promise<{
-    content: string;
-    contentId?: string;
-    contentType: string;
-    disposition: string;
-    filename: string;
-}>;
-/**
- * Creates a SendGrid-specific attachment format.
- * @param attachment The attachment object to format.
- * @param providerName The name of the provider (for error messages).
- * @returns A SendGrid-formatted attachment object with content, type, disposition, filename, and optional content_id.
- */
-export declare const createSendGridAttachment: (attachment: Attachment, providerName: string) => Promise<{
-    content: string;
-    content_id?: string;
-    disposition: string;
-    filename: string;
-    type: string;
-}>;
-/**
- * Creates a Postmark-specific attachment format.
- * @param attachment The attachment object to format.
- * @param providerName The name of the provider (for error messages).
- * @returns A Postmark-formatted attachment object with Content, ContentType, Name, and optional ContentID.
- */
-export declare const createPostmarkAttachment: (attachment: Attachment, providerName: string) => Promise<{
-    Content: string;
-    ContentID?: string;
-    ContentType: string;
-    Name: string;
-}>;
-/**
- * Creates a Mailgun-specific attachment format for form data.
- * @param attachment The attachment object to format.
- * @param providerName The name of the provider (for error messages).
- * @param index The index of the attachment in the attachments array.
- * @returns A Mailgun-formatted attachment object with content and key properties.
- */
-export declare const createMailgunAttachment: (attachment: Attachment, providerName: string, index: number) => Promise<{
-    content: string;
-    key: string;
-}>;

package/dist/providers/utils/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./address-formatter.d.ts";
-export * from "./attachment-processor.d.ts";
-export * from "./payload-builder.d.ts";
-export * from "./provider-base.d.ts";

package/dist/providers/utils/payload-builder.d.ts

@@ -1,78 +0,0 @@
-import type { EmailAddress, EmailOptions } from "../../types.d.ts";
-/**
- * Common payload building utilities for email providers
- */
-export declare class PayloadBuilder {
-    private payload;
-    constructor(initialPayload?: Record<string, unknown>);
-    /**
-     * Sets a field in the payload.
-     * @param key The field key to set.
-     * @param value The field value to set (undefined and null values are ignored).
-     * @returns This instance for method chaining.
-     */
-    set(key: string, value: unknown): this;
-    /**
-     * Sets multiple fields conditionally in the payload.
-     * @param fields An object containing key-value pairs to set.
-     * @returns This instance for method chaining.
-     */
-    setMultiple(fields: Record<string, unknown>): this;
-    /**
-     * Adds recipients (to, cc, bcc) to the payload using a formatter function.
-     * @param emailOptions The email options containing recipient addresses.
-     * @param formatter A function to format the addresses for the specific provider.
-     * @returns This instance for method chaining.
-     */
-    addRecipients(emailOptions: EmailOptions, formatter: (addresses: EmailAddress | EmailAddress[]) => unknown): this;
-    /**
-     * Adds standard email fields (subject, html, text, replyTo) to the payload.
-     * @param emailOptions The email options containing the standard fields.
-     * @returns This instance for method chaining.
-     */
-    addStandardFields(emailOptions: EmailOptions): this;
-    /**
-     * Adds template-related fields to the payload.
-     * @param emailOptions The email options containing template information.
-     * @param templateKey The key name to use for the template ID (default: "template_id").
-     * @returns This instance for method chaining.
-     */
-    addTemplateFields(emailOptions: EmailOptions, templateKey?: string): this;
-    /**
-     * Adds scheduling fields to the payload for delayed sending.
-     * @param emailOptions The email options containing scheduling information.
-     * @returns This instance for method chaining.
-     */
-    addSchedulingFields(emailOptions: EmailOptions): this;
-    /**
-     * Adds tags to the payload for email categorization.
-     * @param emailOptions The email options containing tags.
-     * @param formatter An optional function to format tags for the specific provider.
-     * @returns This instance for method chaining.
-     */
-    addTags(emailOptions: EmailOptions, formatter?: (tags: unknown[]) => unknown): this;
-    /**
-     * Adds custom headers to the payload.
-     * @param emailOptions The email options containing custom headers.
-     * @param formatter An optional function to format headers for the specific provider.
-     * @returns This instance for method chaining.
-     */
-    addHeaders(emailOptions: EmailOptions, formatter?: (headers: Record<string, string>) => unknown): this;
-    /**
-     * Adds a batch ID to the payload for batch email operations.
-     * @param emailOptions The email options containing the batch ID.
-     * @returns This instance for method chaining.
-     */
-    addBatchId(emailOptions: EmailOptions): this;
-    /**
-     * Builds and returns the final payload object.
-     * @returns The complete payload object ready for API submission.
-     */
-    build(): Record<string, unknown>;
-}
-/**
- * Creates a new payload builder instance.
- * @param initialPayload Optional initial payload object to start with.
- * @returns A new PayloadBuilder instance.
- */
-export declare const createPayloadBuilder: (initialPayload?: Record<string, unknown>) => PayloadBuilder;