alepha 0.13.0 → 0.13.2

package/dist/email/index.d.cts

@@ -1,186 +0,0 @@
-import * as alepha1 from "alepha";
-import { Descriptor, InstantiableClass, KIND } from "alepha";
-import * as alepha_logger0 from "alepha/logger";
-import { Transporter } from "nodemailer";
-
-//#region src/email/providers/EmailProvider.d.ts
-/**
- * Email provider interface.
- *
- * All methods are asynchronous and return promises.
- */
-declare abstract class EmailProvider {
-  /**
-   * Send an email.
-   *
-   * @return Promise that resolves when the email is sent.
-   */
-  abstract send(options: EmailSendOptions): Promise<void>;
-}
-type EmailSendOptions = {
-  to: string | string[];
-  subject: string;
-  body: string;
-};
-//#endregion
-//#region src/email/descriptors/$email.d.ts
-declare const $email: {
-  (options?: EmailDescriptorOptions): EmailDescriptor;
-  [KIND]: typeof EmailDescriptor;
-};
-interface EmailDescriptorOptions {
-  name?: string;
-  provider?: InstantiableClass<EmailProvider> | "memory";
-}
-/**
- * Email descriptor for sending emails through various providers.
- *
- * Usage:
- * ```typescript
- * class MyService {
- *   private readonly welcomeEmail = $email({ name: "welcome" });
- *
- *   async sendWelcome(userEmail: string, userName: string) {
- *     await this.welcomeEmail.send({
- *       to: userEmail,
- *       subject: "Welcome!",
- *       body: `<p>Hello ${userName}!</p>`
- *     });
- *   }
- * }
- * ```
- */
-declare class EmailDescriptor extends Descriptor<EmailDescriptorOptions> {
-  protected readonly provider: EmailProvider;
-  get name(): string;
-  /**
-   * Send an email using the configured provider.
-   */
-  send(options: EmailSendOptions): Promise<void>;
-  protected $provider(): EmailProvider;
-}
-//#endregion
-//#region src/email/errors/EmailError.d.ts
-declare class EmailError extends Error {
-  constructor(message: string, cause?: Error);
-}
-//#endregion
-//#region src/email/providers/LocalEmailProvider.d.ts
-interface LocalEmailProviderOptions {
-  /**
-   * Directory to save email files.
-   */
-  directory?: string;
-}
-declare class LocalEmailProvider implements EmailProvider {
-  protected readonly log: alepha_logger0.Logger;
-  protected readonly directory: string;
-  constructor(options?: LocalEmailProviderOptions);
-  send(options: EmailSendOptions): Promise<void>;
-  createEmailHtml(options: {
-    to: string;
-    subject: string;
-    body: string;
-  }): string;
-  escapeHtml(text: string): string;
-}
-//#endregion
-//#region src/email/providers/MemoryEmailProvider.d.ts
-interface EmailRecord {
-  to: string;
-  subject: string;
-  body: string;
-  sentAt: Date;
-}
-declare class MemoryEmailProvider implements EmailProvider {
-  protected readonly log: alepha_logger0.Logger;
-  records: EmailRecord[];
-  send(options: EmailSendOptions): Promise<void>;
-  /**
-   * Get the last email sent (for testing purposes).
-   */
-  get last(): EmailRecord | undefined;
-}
-//#endregion
-//#region src/email/providers/NodemailerEmailProvider.d.ts
-interface NodemailerEmailProviderOptions {
-  /**
-   * Custom transporter configuration.
-   * If provided, will override environment variables.
-   */
-  transporter?: Transporter;
-  /**
-   * Custom from email address.
-   * If not provided, will use EMAIL_FROM from environment.
-   */
-  from?: string;
-  /**
-   * Additional nodemailer options.
-   */
-  options?: {
-    pool?: boolean;
-    maxConnections?: number;
-    maxMessages?: number;
-    rateDelta?: number;
-    rateLimit?: number;
-  };
-}
-declare class NodemailerEmailProvider implements EmailProvider {
-  protected readonly env: {
-    EMAIL_HOST: string;
-    EMAIL_PORT: number;
-    EMAIL_USER: string;
-    EMAIL_PASS: string;
-    EMAIL_FROM: string;
-    EMAIL_SECURE: boolean;
-  };
-  protected readonly log: alepha_logger0.Logger;
-  protected transporter: Transporter;
-  protected fromAddress: string;
-  readonly options: NodemailerEmailProviderOptions;
-  constructor();
-  send(options: EmailSendOptions): Promise<void>;
-  protected createTransporter(): Transporter;
-  /**
-   * Verify the connection to the email server.
-   */
-  verify(): Promise<boolean>;
-  /**
-   * Close the transporter connection.
-   */
-  close(): void;
-  protected readonly onStart: alepha1.HookDescriptor<"start">;
-  protected readonly onStop: alepha1.HookDescriptor<"stop">;
-}
-//#endregion
-//#region src/email/index.d.ts
-declare module "alepha" {
-  interface Hooks {
-    "email:sending": {
-      to: string | string[];
-      template: string;
-      variables: Record<string, unknown>;
-      provider: EmailProvider;
-      abort(): void;
-    };
-    "email:sent": {
-      to: string | string[];
-      template: string;
-      provider: EmailProvider;
-    };
-  }
-}
-/**
- * Provides email sending capabilities for Alepha applications with multiple provider backends.
- *
- * The email module enables declarative email sending through the `$email` descriptor, allowing you to send
- * emails through different providers: memory (for testing), local file system, or SMTP via Nodemailer.
- * It supports HTML email content and automatic provider selection based on environment configuration.
- *
- * @see {@link EmailProvider}
- * @module alepha.email
- */
-declare const AlephaEmail: alepha1.Service<alepha1.Module>;
-//#endregion
-export { $email, AlephaEmail, EmailDescriptor, EmailDescriptorOptions, EmailError, EmailProvider, EmailRecord, EmailSendOptions, LocalEmailProvider, LocalEmailProviderOptions, MemoryEmailProvider, NodemailerEmailProvider, NodemailerEmailProviderOptions };
-//# sourceMappingURL=index.d.cts.map