@veloxts/mail 0.6.55 → 0.6.57

package/dist/index.d.ts

@@ -64,3 +64,25 @@ export { createResendTransport, DRIVER_NAME as RESEND_DRIVER } from './transport
 export { createSmtpTransport, DRIVER_NAME as SMTP_DRIVER } from './transports/smtp.js';
 export type { Attachment, EmailAddress, LogConfig, MailConfig, MailDefinitionConfig, MailDriver, MailEnvelope, MailPluginOptions, MailTransport, Recipient, RenderedMail, ResendConfig, SendMailOptions, SendResult, SmtpConfig, } from './types.js';
 export { escapeHtml, formatAddress, isValidEmail, normalizeRecipient, normalizeRecipients, sanitizeHeaderValue, stripHtml, validateRecipient, validateRecipients, validateTemplateName, } from './utils.js';
+/**
+ * DI tokens and providers for @veloxts/mail
+ *
+ * Use these to integrate mail services with the @veloxts/core DI container.
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerMailProviders, MAIL_MANAGER } from '@veloxts/mail';
+ *
+ * const container = new Container();
+ * await registerMailProviders(container, {
+ *   driver: 'log',
+ *   from: { email: 'test@example.com' },
+ * });
+ *
+ * const mail = container.resolve(MAIL_MANAGER);
+ * await mail.send(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * ```
+ */
+export { registerMailProviders } from './providers.js';
+export { MAIL_CONFIG, MAIL_MANAGER, MAIL_TRANSPORT } from './tokens.js';

package/dist/index.js

@@ -68,3 +68,30 @@ export { createResendTransport, DRIVER_NAME as RESEND_DRIVER } from './transport
 export { createSmtpTransport, DRIVER_NAME as SMTP_DRIVER } from './transports/smtp.js';
 // Utilities
 export { escapeHtml, formatAddress, isValidEmail, normalizeRecipient, normalizeRecipients, sanitizeHeaderValue, stripHtml, validateRecipient, validateRecipients, validateTemplateName, } from './utils.js';
+// ============================================================================
+// Dependency Injection
+// ============================================================================
+/**
+ * DI tokens and providers for @veloxts/mail
+ *
+ * Use these to integrate mail services with the @veloxts/core DI container.
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerMailProviders, MAIL_MANAGER } from '@veloxts/mail';
+ *
+ * const container = new Container();
+ * await registerMailProviders(container, {
+ *   driver: 'log',
+ *   from: { email: 'test@example.com' },
+ * });
+ *
+ * const mail = container.resolve(MAIL_MANAGER);
+ * await mail.send(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * ```
+ */
+// Provider exports - factory functions for registering services
+export { registerMailProviders } from './providers.js';
+// Token exports - unique identifiers for DI resolution
+export { MAIL_CONFIG, MAIL_MANAGER, MAIL_TRANSPORT } from './tokens.js';

package/dist/providers.d.ts

@@ -0,0 +1,64 @@
+/**
+ * DI Providers for @veloxts/mail
+ *
+ * Factory provider functions for registering mail services with the DI container.
+ * These providers allow services to be managed by the container for testability and flexibility.
+ *
+ * @module mail/providers
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerMailProviders, MAIL_MANAGER } from '@veloxts/mail';
+ *
+ * const container = new Container();
+ * await registerMailProviders(container, { driver: 'log' });
+ *
+ * const mail = container.resolve(MAIL_MANAGER);
+ * await mail.send(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * ```
+ */
+import type { Container } from '@veloxts/core';
+import type { MailPluginOptions } from './types.js';
+/**
+ * Registers mail providers with a container
+ *
+ * This handles async initialization of the mail manager and registers
+ * the resolved instance directly for synchronous resolution.
+ *
+ * @param container - The DI container to register providers with
+ * @param config - Mail plugin options (driver, from, etc.)
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerMailProviders, MAIL_MANAGER } from '@veloxts/mail';
+ *
+ * const container = new Container();
+ *
+ * // Log driver (development)
+ * await registerMailProviders(container, { driver: 'log' });
+ *
+ * // SMTP driver (production)
+ * await registerMailProviders(container, {
+ *   driver: 'smtp',
+ *   config: {
+ *     host: 'smtp.example.com',
+ *     port: 587,
+ *     auth: { user: '...', pass: '...' },
+ *   },
+ *   from: { email: 'hello@example.com', name: 'My App' },
+ * });
+ *
+ * // Resend driver (production)
+ * await registerMailProviders(container, {
+ *   driver: 'resend',
+ *   config: { apiKey: process.env.RESEND_API_KEY! },
+ *   from: { email: 'hello@example.com', name: 'My App' },
+ * });
+ *
+ * const mail = container.resolve(MAIL_MANAGER);
+ * await mail.send(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * ```
+ */
+export declare function registerMailProviders(container: Container, config?: MailPluginOptions): Promise<void>;

package/dist/providers.js

@@ -0,0 +1,81 @@
+/**
+ * DI Providers for @veloxts/mail
+ *
+ * Factory provider functions for registering mail services with the DI container.
+ * These providers allow services to be managed by the container for testability and flexibility.
+ *
+ * @module mail/providers
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerMailProviders, MAIL_MANAGER } from '@veloxts/mail';
+ *
+ * const container = new Container();
+ * await registerMailProviders(container, { driver: 'log' });
+ *
+ * const mail = container.resolve(MAIL_MANAGER);
+ * await mail.send(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * ```
+ */
+import { createMailManager } from './manager.js';
+import { MAIL_CONFIG, MAIL_MANAGER } from './tokens.js';
+// ============================================================================
+// Bulk Registration Helpers
+// ============================================================================
+/**
+ * Registers mail providers with a container
+ *
+ * This handles async initialization of the mail manager and registers
+ * the resolved instance directly for synchronous resolution.
+ *
+ * @param container - The DI container to register providers with
+ * @param config - Mail plugin options (driver, from, etc.)
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerMailProviders, MAIL_MANAGER } from '@veloxts/mail';
+ *
+ * const container = new Container();
+ *
+ * // Log driver (development)
+ * await registerMailProviders(container, { driver: 'log' });
+ *
+ * // SMTP driver (production)
+ * await registerMailProviders(container, {
+ *   driver: 'smtp',
+ *   config: {
+ *     host: 'smtp.example.com',
+ *     port: 587,
+ *     auth: { user: '...', pass: '...' },
+ *   },
+ *   from: { email: 'hello@example.com', name: 'My App' },
+ * });
+ *
+ * // Resend driver (production)
+ * await registerMailProviders(container, {
+ *   driver: 'resend',
+ *   config: { apiKey: process.env.RESEND_API_KEY! },
+ *   from: { email: 'hello@example.com', name: 'My App' },
+ * });
+ *
+ * const mail = container.resolve(MAIL_MANAGER);
+ * await mail.send(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * ```
+ */
+export async function registerMailProviders(container, config = {}) {
+    // Register config
+    container.register({
+        provide: MAIL_CONFIG,
+        useValue: config,
+    });
+    // Create mail manager (async operation)
+    const mailManager = await createMailManager(config);
+    // Register the resolved mail manager instance directly
+    // This allows synchronous resolution from the container
+    container.register({
+        provide: MAIL_MANAGER,
+        useValue: mailManager,
+    });
+}

package/dist/tokens.d.ts

@@ -0,0 +1,60 @@
+/**
+ * DI Tokens for @veloxts/mail
+ *
+ * Symbol-based tokens for type-safe dependency injection.
+ * These tokens allow mail services to be registered, resolved, and mocked via the DI container.
+ *
+ * @module mail/tokens
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { MAIL_MANAGER, registerMailProviders } from '@veloxts/mail';
+ *
+ * const container = new Container();
+ * await registerMailProviders(container, { driver: 'log' });
+ *
+ * const mail = container.resolve(MAIL_MANAGER);
+ * await mail.send(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * ```
+ */
+import type { MailManager } from './manager.js';
+import type { MailPluginOptions, MailTransport } from './types.js';
+/**
+ * Mail manager token
+ *
+ * The main mail manager instance for sending and rendering emails.
+ *
+ * @example
+ * ```typescript
+ * const mail = container.resolve(MAIL_MANAGER);
+ * await mail.send(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * const rendered = await mail.render(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * ```
+ */
+export declare const MAIL_MANAGER: import("@veloxts/core").SymbolToken<MailManager>;
+/**
+ * Mail transport token
+ *
+ * The underlying mail transport driver (SMTP, Resend, or Log).
+ * Use MAIL_MANAGER for high-level operations; use this for direct transport access.
+ *
+ * @example
+ * ```typescript
+ * const transport = container.resolve(MAIL_TRANSPORT);
+ * await transport.send({ from: {...}, to: [...], subject: '...', html: '...' });
+ * ```
+ */
+export declare const MAIL_TRANSPORT: import("@veloxts/core").SymbolToken<MailTransport>;
+/**
+ * Mail configuration token
+ *
+ * Contains mail plugin options including driver and driver-specific config.
+ *
+ * @example
+ * ```typescript
+ * const config = container.resolve(MAIL_CONFIG);
+ * console.log(config.driver); // 'smtp', 'resend', or 'log'
+ * ```
+ */
+export declare const MAIL_CONFIG: import("@veloxts/core").SymbolToken<MailPluginOptions>;

package/dist/tokens.js

@@ -0,0 +1,65 @@
+/**
+ * DI Tokens for @veloxts/mail
+ *
+ * Symbol-based tokens for type-safe dependency injection.
+ * These tokens allow mail services to be registered, resolved, and mocked via the DI container.
+ *
+ * @module mail/tokens
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { MAIL_MANAGER, registerMailProviders } from '@veloxts/mail';
+ *
+ * const container = new Container();
+ * await registerMailProviders(container, { driver: 'log' });
+ *
+ * const mail = container.resolve(MAIL_MANAGER);
+ * await mail.send(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * ```
+ */
+import { token } from '@veloxts/core';
+// ============================================================================
+// Core Mail Tokens
+// ============================================================================
+/**
+ * Mail manager token
+ *
+ * The main mail manager instance for sending and rendering emails.
+ *
+ * @example
+ * ```typescript
+ * const mail = container.resolve(MAIL_MANAGER);
+ * await mail.send(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * const rendered = await mail.render(WelcomeEmail, { to: 'user@example.com', data: {...} });
+ * ```
+ */
+export const MAIL_MANAGER = token.symbol('MAIL_MANAGER');
+/**
+ * Mail transport token
+ *
+ * The underlying mail transport driver (SMTP, Resend, or Log).
+ * Use MAIL_MANAGER for high-level operations; use this for direct transport access.
+ *
+ * @example
+ * ```typescript
+ * const transport = container.resolve(MAIL_TRANSPORT);
+ * await transport.send({ from: {...}, to: [...], subject: '...', html: '...' });
+ * ```
+ */
+export const MAIL_TRANSPORT = token.symbol('MAIL_TRANSPORT');
+// ============================================================================
+// Configuration Tokens
+// ============================================================================
+/**
+ * Mail configuration token
+ *
+ * Contains mail plugin options including driver and driver-specific config.
+ *
+ * @example
+ * ```typescript
+ * const config = container.resolve(MAIL_CONFIG);
+ * console.log(config.driver); // 'smtp', 'resend', or 'log'
+ * ```
+ */
+export const MAIL_CONFIG = token.symbol('MAIL_CONFIG');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veloxts/mail",
-  "version": "0.6.55",
+  "version": "0.6.57",
   "description": "Email templating and sending for VeloxTS framework",
   "type": "module",
   "main": "./dist/index.js",
@@ -24,7 +24,7 @@
     "nodemailer": "6.10.1",
     "resend": "4.1.2",
     "zod": "3.24.4",
-    "@veloxts/core": "0.6.55"
+    "@veloxts/core": "0.6.57"
   },
   "devDependencies": {
     "@biomejs/biome": "2.0.0",
@@ -36,7 +36,7 @@
     "react": "19.2.3",
     "typescript": "5.8.3",
     "vitest": "4.0.16",
-    "@veloxts/testing": "0.6.55"
+    "@veloxts/testing": "0.6.57"
   },
   "peerDependencies": {
     "fastify": "^5.0.0",