@guren/server 0.2.0-alpha.7 → 1.0.0-rc.9

package/dist/MailManager-DpMvYiP9.d.ts

@@ -0,0 +1,292 @@
+/**
+ * Email address with optional display name.
+ */
+interface MailAddress {
+    /**
+     * Email address.
+     */
+    email: string;
+    /**
+     * Display name.
+     */
+    name?: string;
+}
+/**
+ * Email attachment.
+ */
+interface MailAttachment {
+    /**
+     * Filename shown to recipient.
+     */
+    filename: string;
+    /**
+     * Attachment content (Buffer or string).
+     */
+    content?: Buffer | string;
+    /**
+     * Path to file to attach.
+     */
+    path?: string;
+    /**
+     * MIME type.
+     */
+    contentType?: string;
+    /**
+     * Content-ID for inline attachments.
+     */
+    cid?: string;
+}
+/**
+ * Email message structure.
+ */
+interface MailMessage {
+    /**
+     * Sender address.
+     */
+    from?: MailAddress;
+    /**
+     * Primary recipients.
+     */
+    to: MailAddress[];
+    /**
+     * Carbon copy recipients.
+     */
+    cc?: MailAddress[];
+    /**
+     * Blind carbon copy recipients.
+     */
+    bcc?: MailAddress[];
+    /**
+     * Reply-to address.
+     */
+    replyTo?: MailAddress;
+    /**
+     * Email subject.
+     */
+    subject: string;
+    /**
+     * Plain text body.
+     */
+    text?: string;
+    /**
+     * HTML body.
+     */
+    html?: string;
+    /**
+     * Attachments.
+     */
+    attachments?: MailAttachment[];
+    /**
+     * Custom headers.
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * Result of sending an email.
+ */
+interface SendResult {
+    /**
+     * Whether the email was sent successfully.
+     */
+    success: boolean;
+    /**
+     * Message ID from the mail server.
+     */
+    messageId?: string;
+    /**
+     * Response from the mail server.
+     */
+    response?: string;
+    /**
+     * Error message if sending failed.
+     */
+    error?: string;
+}
+/**
+ * Mail transport interface.
+ * Implement this to create custom email providers.
+ */
+interface MailTransport {
+    /**
+     * Transport name.
+     */
+    readonly name: string;
+    /**
+     * Send an email message.
+     */
+    send(message: MailMessage): Promise<SendResult>;
+}
+/**
+ * Mail transport factory function.
+ */
+type MailTransportFactory = () => MailTransport;
+/**
+ * Mail transport configuration.
+ */
+interface MailTransportConfig {
+    /**
+     * Transport driver name.
+     */
+    driver: string;
+    /**
+     * Driver-specific options.
+     */
+    [key: string]: unknown;
+}
+/**
+ * Mail configuration.
+ */
+interface MailConfig {
+    /**
+     * Default transport name.
+     * @default 'smtp'
+     */
+    default?: string;
+    /**
+     * Default from address.
+     */
+    from?: MailAddress;
+    /**
+     * Transport configurations.
+     */
+    transports?: Record<string, MailTransportConfig>;
+}
+/**
+ * SMTP transport options.
+ */
+interface SmtpTransportOptions {
+    /**
+     * SMTP server host.
+     */
+    host: string;
+    /**
+     * SMTP server port.
+     * @default 587
+     */
+    port?: number;
+    /**
+     * Use TLS.
+     * @default false
+     */
+    secure?: boolean;
+    /**
+     * Authentication credentials.
+     */
+    auth?: {
+        user: string;
+        pass: string;
+    };
+    /**
+     * Connection pool.
+     * @default true
+     */
+    pool?: boolean;
+    /**
+     * Maximum connections.
+     * @default 5
+     */
+    maxConnections?: number;
+}
+/**
+ * Resend transport options.
+ */
+interface ResendTransportOptions {
+    /**
+     * Resend API key.
+     */
+    apiKey: string;
+}
+/**
+ * Memory transport options (for testing).
+ */
+interface MemoryTransportOptions {
+    /**
+     * Whether to simulate failures.
+     */
+    simulateFailure?: boolean;
+    /**
+     * Error message when simulating failures.
+     */
+    failureMessage?: string;
+}
+
+/**
+ * Mail manager for handling multiple transports.
+ *
+ * @example
+ * ```ts
+ * const mailManager = new MailManager({
+ *   default: 'smtp',
+ *   from: { email: 'noreply@example.com', name: 'MyApp' },
+ *   transports: {
+ *     smtp: {
+ *       driver: 'smtp',
+ *       host: 'smtp.example.com',
+ *       port: 587,
+ *       auth: { user: 'user', pass: 'pass' },
+ *     },
+ *     resend: {
+ *       driver: 'resend',
+ *       apiKey: 'your-api-key',
+ *     },
+ *   },
+ * })
+ *
+ * // Get the default transport
+ * const transport = mailManager.transport()
+ *
+ * // Get a specific transport
+ * const resendTransport = mailManager.transport('resend')
+ * ```
+ */
+declare class MailManager {
+    private readonly defaultTransportName;
+    private readonly defaultFrom?;
+    private readonly transportFactories;
+    private readonly resolvedTransports;
+    constructor(config?: MailConfig);
+    /**
+     * Register built-in transport drivers.
+     */
+    private registerBuiltinDrivers;
+    private driverFactories;
+    /**
+     * Register a driver factory.
+     */
+    private registerDriverFactory;
+    /**
+     * Register a transport from configuration.
+     */
+    private registerTransportFromConfig;
+    /**
+     * Get a mail transport by name.
+     * Returns the default transport if no name is specified.
+     */
+    transport(name?: string): MailTransport;
+    /**
+     * Register a custom transport.
+     */
+    registerTransport(name: string, factory: MailTransportFactory): void;
+    /**
+     * Check if a transport is registered.
+     */
+    hasTransport(name: string): boolean;
+    /**
+     * Get the default transport name.
+     */
+    getDefaultTransportName(): string;
+    /**
+     * Get the default from address.
+     */
+    getDefaultFrom(): MailAddress | undefined;
+    /**
+     * Get all registered transport names.
+     */
+    getTransportNames(): string[];
+}
+/**
+ * Create a mail manager with configuration.
+ */
+declare function createMailManager(config?: MailConfig): MailManager;
+
+export { MailManager as M, type ResendTransportOptions as R, type SendResult as S, type MailAddress as a, type MailAttachment as b, type MailConfig as c, type MailMessage as d, type MailTransport as e, type MailTransportConfig as f, type MailTransportFactory as g, type MemoryTransportOptions as h, type SmtpTransportOptions as i, createMailManager as j };