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

package/dist/mail/index.d.ts

@@ -0,0 +1,288 @@
+import { e as MailTransport, i as SmtpTransportOptions, d as MailMessage, S as SendResult, R as ResendTransportOptions, h as MemoryTransportOptions, M as MailManager, a as MailAddress, b as MailAttachment } from '../MailManager-DpMvYiP9.js';
+export { c as MailConfig, f as MailTransportConfig, g as MailTransportFactory, j as createMailManager } from '../MailManager-DpMvYiP9.js';
+
+/**
+ * SMTP mail transport using Nodemailer.
+ *
+ * @example
+ * ```ts
+ * const transport = new SmtpTransport({
+ *   host: 'smtp.example.com',
+ *   port: 587,
+ *   auth: {
+ *     user: 'user@example.com',
+ *     pass: 'password',
+ *   },
+ * })
+ *
+ * await transport.send({
+ *   from: { email: 'sender@example.com' },
+ *   to: [{ email: 'recipient@example.com' }],
+ *   subject: 'Hello',
+ *   text: 'Hello World!',
+ * })
+ * ```
+ */
+declare class SmtpTransport implements MailTransport {
+    readonly name = "smtp";
+    private readonly transporter;
+    constructor(options: SmtpTransportOptions);
+    /**
+     * Send an email via SMTP.
+     */
+    send(message: MailMessage): Promise<SendResult>;
+    /**
+     * Verify SMTP connection.
+     */
+    verify(): Promise<boolean>;
+    /**
+     * Close the transport.
+     */
+    close(): void;
+}
+
+/**
+ * Resend mail transport.
+ *
+ * @example
+ * ```ts
+ * const transport = new ResendTransport({
+ *   apiKey: process.env.RESEND_API_KEY,
+ * })
+ *
+ * await transport.send({
+ *   from: { email: 'sender@example.com' },
+ *   to: [{ email: 'recipient@example.com' }],
+ *   subject: 'Hello',
+ *   html: '<p>Hello World!</p>',
+ * })
+ * ```
+ */
+declare class ResendTransport implements MailTransport {
+    readonly name = "resend";
+    private readonly apiKey;
+    private readonly baseUrl;
+    constructor(options: ResendTransportOptions);
+    /**
+     * Format email address for Resend API.
+     */
+    private formatAddress;
+    /**
+     * Send an email via Resend API.
+     */
+    send(message: MailMessage): Promise<SendResult>;
+}
+
+/**
+ * In-memory mail transport for testing.
+ *
+ * Stores all sent messages in memory for inspection.
+ *
+ * @example
+ * ```ts
+ * const transport = new MemoryTransport()
+ *
+ * await transport.send({
+ *   from: { email: 'sender@example.com' },
+ *   to: [{ email: 'recipient@example.com' }],
+ *   subject: 'Hello',
+ *   text: 'Hello World!',
+ * })
+ *
+ * // Inspect sent messages
+ * const messages = transport.getMessages()
+ * console.log(messages[0].subject) // 'Hello'
+ * ```
+ */
+declare class MemoryTransport implements MailTransport {
+    readonly name = "memory";
+    private messages;
+    private simulateFailure;
+    private failureMessage;
+    constructor(options?: MemoryTransportOptions);
+    /**
+     * Send an email (stores in memory).
+     */
+    send(message: MailMessage): Promise<SendResult>;
+    /**
+     * Get all sent messages.
+     */
+    getMessages(): MailMessage[];
+    /**
+     * Get the last sent message.
+     */
+    getLastMessage(): MailMessage | undefined;
+    /**
+     * Find messages by recipient email.
+     */
+    findByRecipient(email: string): MailMessage[];
+    /**
+     * Find messages by subject.
+     */
+    findBySubject(subject: string): MailMessage[];
+    /**
+     * Check if any message was sent to a recipient.
+     */
+    hasSentTo(email: string): boolean;
+    /**
+     * Check if any message was sent with a subject.
+     */
+    hasSentWithSubject(subject: string): boolean;
+    /**
+     * Get the count of sent messages.
+     */
+    count(): number;
+    /**
+     * Clear all stored messages.
+     */
+    clear(): void;
+    /**
+     * Set whether to simulate failures.
+     */
+    setSimulateFailure(simulate: boolean, message?: string): void;
+    /**
+     * Assert that a message was sent to a recipient.
+     * Throws if no message was found.
+     */
+    assertSentTo(email: string): void;
+    /**
+     * Assert that a message was sent with a subject.
+     * Throws if no message was found.
+     */
+    assertSentWithSubject(subject: string): void;
+    /**
+     * Assert that exactly n messages were sent.
+     * Throws if count doesn't match.
+     */
+    assertSentCount(count: number): void;
+}
+
+/**
+ * Fluent mail builder for composing and sending emails.
+ *
+ * @example
+ * ```ts
+ * import { mail, createMailManager } from '@guren/server/mail'
+ *
+ * const manager = createMailManager({ ... })
+ *
+ * // Send a simple email
+ * await mail(manager)
+ *   .to('user@example.com')
+ *   .subject('Hello!')
+ *   .text('Hello World!')
+ *   .send()
+ *
+ * // Send an HTML email with template
+ * await mail(manager)
+ *   .to('user@example.com')
+ *   .subject('Welcome!')
+ *   .html('<h1>Welcome to our app!</h1>')
+ *   .attach({ filename: 'guide.pdf', path: './guide.pdf' })
+ *   .send()
+ *
+ * // Queue the email for async sending
+ * await mail(manager)
+ *   .to('user@example.com')
+ *   .subject('Report')
+ *   .html('<p>Your report is ready</p>')
+ *   .queue('emails')
+ * ```
+ */
+declare class Mail {
+    private readonly manager;
+    private message;
+    private transportName?;
+    constructor(manager: MailManager);
+    /**
+     * Set the sender address.
+     */
+    from(address: string | MailAddress): this;
+    /**
+     * Add a recipient.
+     */
+    to(address: string | MailAddress): this;
+    /**
+     * Add multiple recipients.
+     */
+    toMany(addresses: (string | MailAddress)[]): this;
+    /**
+     * Add a CC recipient.
+     */
+    cc(address: string | MailAddress): this;
+    /**
+     * Add a BCC recipient.
+     */
+    bcc(address: string | MailAddress): this;
+    /**
+     * Set the reply-to address.
+     */
+    replyTo(address: string | MailAddress): this;
+    /**
+     * Set the subject.
+     */
+    subject(subject: string): this;
+    /**
+     * Set the plain text body.
+     */
+    text(content: string): this;
+    /**
+     * Set the HTML body.
+     */
+    html(content: string): this;
+    /**
+     * Render a React component as HTML body.
+     * Requires @react-email/render to be installed.
+     *
+     * @param component - React component function
+     * @param props - Props to pass to the component
+     */
+    template<P extends Record<string, unknown>>(component: (props: P) => unknown, props: P): Promise<this>;
+    /**
+     * Add an attachment.
+     */
+    attach(attachment: MailAttachment): this;
+    /**
+     * Add a custom header.
+     */
+    header(key: string, value: string): this;
+    /**
+     * Specify which transport to use.
+     */
+    via(transport: string): this;
+    /**
+     * Build the final message.
+     */
+    buildMessage(): MailMessage;
+    /**
+     * Send the email immediately.
+     */
+    send(): Promise<SendResult>;
+    /**
+     * Queue the email for async sending.
+     */
+    queue(queueName?: string): Promise<string>;
+}
+/**
+ * Set the global mail manager for queue jobs.
+ */
+declare function setMailManager(manager: MailManager): void;
+/**
+ * Get the global mail manager.
+ */
+declare function getMailManager(): MailManager | null;
+/**
+ * Create a new mail builder.
+ *
+ * @example
+ * ```ts
+ * await mail(manager)
+ *   .to('user@example.com')
+ *   .subject('Hello')
+ *   .text('Hello World!')
+ *   .send()
+ * ```
+ */
+declare function mail(manager: MailManager): Mail;
+
+export { Mail, MailAddress, MailAttachment, MailManager, MailMessage, MailTransport, MemoryTransport, MemoryTransportOptions, ResendTransport, ResendTransportOptions, SendResult, SmtpTransport, SmtpTransportOptions, getMailManager, mail, setMailManager };