@igniter-js/mail 0.1.0 → 0.1.1

package/dist/adapters/index.d.mts

@@ -0,0 +1,229 @@
+import { I as IgniterMailAdapter, b as IgniterMailAdapterCredentials, a as IgniterMailAdapterSendParams } from '../adapter-BhnIsrlh.mjs';
+
+/**
+ * Postmark adapter.
+ *
+ * Notes:
+ * - This implementation uses `fetch` (no SDK dependency).
+ * - Designed to be extracted to `@igniter-js/mail/adapters/postmark`.
+ *
+ * @example
+ * ```ts
+ * const adapter = PostmarkMailAdapter.create({
+ *   secret: process.env.POSTMARK_SERVER_TOKEN,
+ *   from: 'no-reply@example.com',
+ * })
+ * await adapter.send({ to: 'user@example.com', subject: 'Hello', html: '<p>Hi</p>', text: 'Hi' })
+ * ```
+ */
+declare class PostmarkMailAdapter implements IgniterMailAdapter {
+    private readonly credentials;
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param credentials - Provider credentials (secret/from).
+     * @returns A Postmark adapter instance.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     * @example
+     * ```ts
+     * const adapter = PostmarkMailAdapter.create({ secret: 'token', from: 'no-reply@acme.com' })
+     * ```
+     */
+    static create(credentials: IgniterMailAdapterCredentials): PostmarkMailAdapter;
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param credentials - Provider credentials (secret/from).
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     */
+    constructor(credentials?: IgniterMailAdapterCredentials);
+    /**
+     * Sends an email using Postmark (HTTP API).
+     *
+     * @param params - Normalized email parameters.
+     * @returns A promise that resolves when the email is accepted.
+     * @throws {IgniterMailError} When configuration is invalid or Postmark rejects the request.
+     * @example
+     * ```ts
+     * await adapter.send({ to: 'user@example.com', subject: 'Hello', html: '<p>Hi</p>', text: 'Hi' })
+     * ```
+     */
+    send(params: IgniterMailAdapterSendParams): Promise<void>;
+}
+
+/**
+ * Resend adapter implementation.
+ *
+ * Notes:
+ * - Uses the Resend SDK.
+ * - Designed to be extracted to `@igniter-js/mail/adapters/resend`.
+ *
+ * @example
+ * ```ts
+ * const adapter = ResendMailAdapter.create({
+ *   secret: process.env.RESEND_API_KEY,
+ *   from: 'no-reply@example.com',
+ * })
+ * await adapter.send({ to: 'user@example.com', subject: 'Hi', html: '<p>Hi</p>', text: 'Hi' })
+ * ```
+ */
+declare class ResendMailAdapter implements IgniterMailAdapter {
+    private readonly credentials;
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param credentials - Adapter credentials including API secret and default from.
+     * @returns A configured Resend adapter.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     * @example
+     * ```ts
+     * const adapter = ResendMailAdapter.create({ secret: 'token', from: 'no-reply@acme.com' })
+     * ```
+     */
+    static create(credentials: IgniterMailAdapterCredentials): ResendMailAdapter;
+    /**
+     * Creates an adapter with credentials.
+     *
+     * @param credentials - Adapter credentials including API secret and default from.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     */
+    constructor(credentials?: IgniterMailAdapterCredentials);
+    /**
+     * Sends an email using Resend.
+     *
+     * @param params - Email payload to send.
+     * @returns Resolves when the email is accepted by Resend.
+     * @throws {IgniterMailError} When credentials are missing or Resend rejects the request.
+     *
+     * @example
+     * ```ts
+     * await adapter.send({ to: 'user@example.com', subject: 'Welcome', html: '<p>Hi</p>', text: 'Hi' })
+     * ```
+     */
+    send(params: IgniterMailAdapterSendParams): Promise<void>;
+}
+
+/**
+ * SendGrid adapter implementation.
+ *
+ * Notes:
+ * - This implementation uses `fetch` (no SDK dependency).
+ * - Designed to be extracted to `@igniter-js/mail/adapters/sendgrid`.
+ *
+ * @example
+ * ```ts
+ * const adapter = SendGridMailAdapter.create({
+ *   secret: process.env.SENDGRID_API_KEY,
+ *   from: 'no-reply@example.com',
+ * })
+ * await adapter.send({ to: 'user@example.com', subject: 'Hello', html: '<p>Hi</p>', text: 'Hi' })
+ * ```
+ */
+declare class SendGridMailAdapter implements IgniterMailAdapter {
+    private readonly credentials;
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param credentials - Adapter credentials including API secret and default from.
+     * @returns A configured SendGrid adapter.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     * @example
+     * ```ts
+     * const adapter = SendGridMailAdapter.create({ secret: 'token', from: 'no-reply@acme.com' })
+     * ```
+     */
+    static create(credentials: IgniterMailAdapterCredentials): SendGridMailAdapter;
+    /**
+     * Creates an adapter with credentials.
+     *
+     * @param credentials - Adapter credentials including API secret and default from.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     */
+    constructor(credentials?: IgniterMailAdapterCredentials);
+    /**
+     * Sends an email using SendGrid (HTTP API).
+     *
+     * @param params - Email payload to send.
+     * @returns Resolves when the email is accepted by SendGrid.
+     * @throws {IgniterMailError} When credentials are missing or the API fails.
+     *
+     * @example
+     * ```ts
+     * await adapter.send({ to: 'user@example.com', subject: 'Hi', html: '<p>Hi</p>', text: 'Hi' })
+     * ```
+     */
+    send(params: IgniterMailAdapterSendParams): Promise<void>;
+}
+
+/**
+ * SMTP adapter implementation.
+ *
+ * Notes:
+ * - Uses Nodemailer.
+ * - `credentials.secret` must be an SMTP connection URL.
+ *
+ * @example
+ * ```ts
+ * const adapter = SmtpMailAdapter.create({
+ *   secret: 'smtps://user:pass@host:465',
+ *   from: 'no-reply@example.com',
+ * })
+ * await adapter.send({ to: 'user@example.com', subject: 'Hi', html: '<p>Hi</p>', text: 'Hi' })
+ * ```
+ */
+declare class SmtpMailAdapter implements IgniterMailAdapter {
+    private readonly credentials;
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param credentials - Adapter credentials including SMTP URL and default from.
+     * @returns A configured SMTP adapter.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     * @example
+     * ```ts
+     * const adapter = SmtpMailAdapter.create({ secret: 'smtps://user:pass@host:465', from: 'no-reply@acme.com' })
+     * ```
+     */
+    static create(credentials: IgniterMailAdapterCredentials): SmtpMailAdapter;
+    /**
+     * Creates an adapter with credentials.
+     *
+     * @param credentials - Adapter credentials including SMTP URL and default from.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     */
+    constructor(credentials?: IgniterMailAdapterCredentials);
+    /**
+     * Sends an email using Nodemailer over SMTP.
+     *
+     * @param params - Email payload to send.
+     * @returns Resolves when the email is sent.
+     * @throws {IgniterMailError} When credentials are missing or the SMTP send fails.
+     *
+     * @example
+     * ```ts
+     * await adapter.send({ to: 'user@example.com', subject: 'Hi', html: '<p>Hi</p>', text: 'Hi' })
+     * ```
+     */
+    send(params: IgniterMailAdapterSendParams): Promise<void>;
+}
+
+/**
+ * In-memory mock adapter for `@igniter-js/mail`.
+ *
+ * Use this in tests to avoid real provider calls.
+ */
+declare class MockMailAdapter implements IgniterMailAdapter {
+    /** Creates a new mock adapter instance. */
+    static create(): MockMailAdapter;
+    /** Tracks all send calls. */
+    readonly sent: IgniterMailAdapterSendParams[];
+    /** Tracks method call counts. */
+    readonly calls: {
+        send: number;
+    };
+    send(params: IgniterMailAdapterSendParams): Promise<void>;
+    /** Clears all tracked state. */
+    clear(): void;
+}
+
+export { IgniterMailAdapter, IgniterMailAdapterCredentials, IgniterMailAdapterSendParams, MockMailAdapter, PostmarkMailAdapter, ResendMailAdapter, SendGridMailAdapter, SmtpMailAdapter };

package/dist/adapters/index.d.ts

@@ -0,0 +1,229 @@
+import { I as IgniterMailAdapter, b as IgniterMailAdapterCredentials, a as IgniterMailAdapterSendParams } from '../adapter-BhnIsrlh.js';
+
+/**
+ * Postmark adapter.
+ *
+ * Notes:
+ * - This implementation uses `fetch` (no SDK dependency).
+ * - Designed to be extracted to `@igniter-js/mail/adapters/postmark`.
+ *
+ * @example
+ * ```ts
+ * const adapter = PostmarkMailAdapter.create({
+ *   secret: process.env.POSTMARK_SERVER_TOKEN,
+ *   from: 'no-reply@example.com',
+ * })
+ * await adapter.send({ to: 'user@example.com', subject: 'Hello', html: '<p>Hi</p>', text: 'Hi' })
+ * ```
+ */
+declare class PostmarkMailAdapter implements IgniterMailAdapter {
+    private readonly credentials;
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param credentials - Provider credentials (secret/from).
+     * @returns A Postmark adapter instance.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     * @example
+     * ```ts
+     * const adapter = PostmarkMailAdapter.create({ secret: 'token', from: 'no-reply@acme.com' })
+     * ```
+     */
+    static create(credentials: IgniterMailAdapterCredentials): PostmarkMailAdapter;
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param credentials - Provider credentials (secret/from).
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     */
+    constructor(credentials?: IgniterMailAdapterCredentials);
+    /**
+     * Sends an email using Postmark (HTTP API).
+     *
+     * @param params - Normalized email parameters.
+     * @returns A promise that resolves when the email is accepted.
+     * @throws {IgniterMailError} When configuration is invalid or Postmark rejects the request.
+     * @example
+     * ```ts
+     * await adapter.send({ to: 'user@example.com', subject: 'Hello', html: '<p>Hi</p>', text: 'Hi' })
+     * ```
+     */
+    send(params: IgniterMailAdapterSendParams): Promise<void>;
+}
+
+/**
+ * Resend adapter implementation.
+ *
+ * Notes:
+ * - Uses the Resend SDK.
+ * - Designed to be extracted to `@igniter-js/mail/adapters/resend`.
+ *
+ * @example
+ * ```ts
+ * const adapter = ResendMailAdapter.create({
+ *   secret: process.env.RESEND_API_KEY,
+ *   from: 'no-reply@example.com',
+ * })
+ * await adapter.send({ to: 'user@example.com', subject: 'Hi', html: '<p>Hi</p>', text: 'Hi' })
+ * ```
+ */
+declare class ResendMailAdapter implements IgniterMailAdapter {
+    private readonly credentials;
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param credentials - Adapter credentials including API secret and default from.
+     * @returns A configured Resend adapter.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     * @example
+     * ```ts
+     * const adapter = ResendMailAdapter.create({ secret: 'token', from: 'no-reply@acme.com' })
+     * ```
+     */
+    static create(credentials: IgniterMailAdapterCredentials): ResendMailAdapter;
+    /**
+     * Creates an adapter with credentials.
+     *
+     * @param credentials - Adapter credentials including API secret and default from.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     */
+    constructor(credentials?: IgniterMailAdapterCredentials);
+    /**
+     * Sends an email using Resend.
+     *
+     * @param params - Email payload to send.
+     * @returns Resolves when the email is accepted by Resend.
+     * @throws {IgniterMailError} When credentials are missing or Resend rejects the request.
+     *
+     * @example
+     * ```ts
+     * await adapter.send({ to: 'user@example.com', subject: 'Welcome', html: '<p>Hi</p>', text: 'Hi' })
+     * ```
+     */
+    send(params: IgniterMailAdapterSendParams): Promise<void>;
+}
+
+/**
+ * SendGrid adapter implementation.
+ *
+ * Notes:
+ * - This implementation uses `fetch` (no SDK dependency).
+ * - Designed to be extracted to `@igniter-js/mail/adapters/sendgrid`.
+ *
+ * @example
+ * ```ts
+ * const adapter = SendGridMailAdapter.create({
+ *   secret: process.env.SENDGRID_API_KEY,
+ *   from: 'no-reply@example.com',
+ * })
+ * await adapter.send({ to: 'user@example.com', subject: 'Hello', html: '<p>Hi</p>', text: 'Hi' })
+ * ```
+ */
+declare class SendGridMailAdapter implements IgniterMailAdapter {
+    private readonly credentials;
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param credentials - Adapter credentials including API secret and default from.
+     * @returns A configured SendGrid adapter.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     * @example
+     * ```ts
+     * const adapter = SendGridMailAdapter.create({ secret: 'token', from: 'no-reply@acme.com' })
+     * ```
+     */
+    static create(credentials: IgniterMailAdapterCredentials): SendGridMailAdapter;
+    /**
+     * Creates an adapter with credentials.
+     *
+     * @param credentials - Adapter credentials including API secret and default from.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     */
+    constructor(credentials?: IgniterMailAdapterCredentials);
+    /**
+     * Sends an email using SendGrid (HTTP API).
+     *
+     * @param params - Email payload to send.
+     * @returns Resolves when the email is accepted by SendGrid.
+     * @throws {IgniterMailError} When credentials are missing or the API fails.
+     *
+     * @example
+     * ```ts
+     * await adapter.send({ to: 'user@example.com', subject: 'Hi', html: '<p>Hi</p>', text: 'Hi' })
+     * ```
+     */
+    send(params: IgniterMailAdapterSendParams): Promise<void>;
+}
+
+/**
+ * SMTP adapter implementation.
+ *
+ * Notes:
+ * - Uses Nodemailer.
+ * - `credentials.secret` must be an SMTP connection URL.
+ *
+ * @example
+ * ```ts
+ * const adapter = SmtpMailAdapter.create({
+ *   secret: 'smtps://user:pass@host:465',
+ *   from: 'no-reply@example.com',
+ * })
+ * await adapter.send({ to: 'user@example.com', subject: 'Hi', html: '<p>Hi</p>', text: 'Hi' })
+ * ```
+ */
+declare class SmtpMailAdapter implements IgniterMailAdapter {
+    private readonly credentials;
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param credentials - Adapter credentials including SMTP URL and default from.
+     * @returns A configured SMTP adapter.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     * @example
+     * ```ts
+     * const adapter = SmtpMailAdapter.create({ secret: 'smtps://user:pass@host:465', from: 'no-reply@acme.com' })
+     * ```
+     */
+    static create(credentials: IgniterMailAdapterCredentials): SmtpMailAdapter;
+    /**
+     * Creates an adapter with credentials.
+     *
+     * @param credentials - Adapter credentials including SMTP URL and default from.
+     * @throws {IgniterMailError} Does not throw on creation; errors surface on send.
+     */
+    constructor(credentials?: IgniterMailAdapterCredentials);
+    /**
+     * Sends an email using Nodemailer over SMTP.
+     *
+     * @param params - Email payload to send.
+     * @returns Resolves when the email is sent.
+     * @throws {IgniterMailError} When credentials are missing or the SMTP send fails.
+     *
+     * @example
+     * ```ts
+     * await adapter.send({ to: 'user@example.com', subject: 'Hi', html: '<p>Hi</p>', text: 'Hi' })
+     * ```
+     */
+    send(params: IgniterMailAdapterSendParams): Promise<void>;
+}
+
+/**
+ * In-memory mock adapter for `@igniter-js/mail`.
+ *
+ * Use this in tests to avoid real provider calls.
+ */
+declare class MockMailAdapter implements IgniterMailAdapter {
+    /** Creates a new mock adapter instance. */
+    static create(): MockMailAdapter;
+    /** Tracks all send calls. */
+    readonly sent: IgniterMailAdapterSendParams[];
+    /** Tracks method call counts. */
+    readonly calls: {
+        send: number;
+    };
+    send(params: IgniterMailAdapterSendParams): Promise<void>;
+    /** Clears all tracked state. */
+    clear(): void;
+}
+
+export { IgniterMailAdapter, IgniterMailAdapterCredentials, IgniterMailAdapterSendParams, MockMailAdapter, PostmarkMailAdapter, ResendMailAdapter, SendGridMailAdapter, SmtpMailAdapter };