@dotpress/mailer 0.0.0-stage → 2.0.0-alpha.1

package/dist/index.d.ts

@@ -0,0 +1,97 @@
+import { M as MailProvider, a as MailMessage } from './mailer-CmQCJ0qc.js';
+export { A as Address, D as DataOf, b as DataOption, E as EnvelopeOptions, L as LayoutContext, c as LayoutOptions, d as Localized, e as MailAddress, f as MailAttachment, g as MailFormat, h as MailLayout, i as MailRecipients, j as MailTemplate, k as Mailer, l as MailerLogger, m as MailerOptions, n as MessageOptions, P as ProviderResult, R as RenderMailOptions, o as RenderedMail, S as SendMailOptions, p as SendResult, q as Source, T as TemplateData, r as TemplateOptions, s as TranslateContext, t as Translations, u as createMailer, v as defineLayout, w as defineTemplate, x as formatAddress, y as renderMail } from './mailer-CmQCJ0qc.js';
+export { H as HttpProviderOptions } from './http-B35l9W1d.js';
+import 'zod';
+
+/** Base class of the errors thrown by `@dotpress/mailer`. */
+declare class MailerError extends Error {
+    name: string;
+}
+/** Problem found in the data passed to a template. */
+interface MailDataIssue {
+    /** Path of the invalid value, empty for the data itself. */
+    readonly path: readonly (string | number)[];
+    readonly message: string;
+}
+/** The data passed to a template does not match its schema. */
+declare class MailDataError extends MailerError {
+    /** Name of the template. */
+    readonly template: string;
+    readonly issues: readonly MailDataIssue[];
+    name: string;
+    constructor(
+    /** Name of the template. */
+    template: string, issues: readonly MailDataIssue[]);
+}
+/** A template could not be rendered (MJML, translations, Mustache). */
+declare class MailRenderError extends MailerError {
+    /** Name of the template. */
+    readonly template: string;
+    name: string;
+    constructor(
+    /** Name of the template. */
+    template: string, message: string, options?: ErrorOptions);
+}
+/** Invalid message: address, attachment, header or option. */
+declare class MailMessageError extends MailerError {
+    name: string;
+    constructor(message: string);
+}
+/** Options of `MailSendError`. */
+interface MailSendErrorOptions extends ErrorOptions {
+    /** HTTP status of the provider API, if any. */
+    status?: number | undefined;
+}
+/** The provider failed to send a message. */
+declare class MailSendError extends MailerError {
+    /** Name of the provider. */
+    readonly provider: string;
+    name: string;
+    /** HTTP status of the provider API, if any. */
+    readonly status: number | undefined;
+    constructor(
+    /** Name of the provider. */
+    provider: string, message: string, options?: MailSendErrorOptions);
+}
+
+/** Options of `createConsoleProvider()`. */
+interface ConsoleProviderOptions {
+    /**
+     * Also prints the text version. Off by default: messages often contain
+     * secrets (password reset links, login codes).
+     */
+    body?: boolean | undefined;
+    /** Output function. Defaults to `console.log`. */
+    write?: ((output: string) => void) | undefined;
+}
+/**
+ * Creates a provider that prints messages instead of sending them, for
+ * development. Never use it as a fallback in production: messages would
+ * be lost.
+ */
+declare const createConsoleProvider: (options?: ConsoleProviderOptions) => MailProvider;
+
+/** Provider that keeps messages in memory, for tests. */
+interface MemoryProvider extends MailProvider {
+    /** Sent messages, oldest first. */
+    readonly sent: readonly MailMessage[];
+    /** Last sent message. */
+    last(): MailMessage | undefined;
+    /** Forgets the sent messages. */
+    clear(): void;
+}
+/**
+ * Creates a provider that keeps messages in memory instead of sending
+ * them, for tests.
+ *
+ * ```ts
+ * const outbox = createMemoryProvider()
+ * const mailer = createMailer({ provider: outbox, from: 'noreply@example.com' })
+ * // …
+ * expect(outbox.last()?.subject).toBe('Welcome Ada')
+ * ```
+ */
+declare const createMemoryProvider: () => MemoryProvider;
+
+export { MailDataError, MailMessage, MailMessageError, MailProvider, MailRenderError, MailSendError, MailerError, createConsoleProvider, createMemoryProvider };
+export type { ConsoleProviderOptions, MailDataIssue, MailSendErrorOptions, MemoryProvider };