@upyo/smtp 0.1.0-dev.9 → 0.1.0

package/README.md

@@ -3,7 +3,16 @@
 @upyo/smtp
 ==========
 
-SMTP transport implementation for the Upyo email library.
+[![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
+
+SMTP transport implementation for the [Upyo] email library.
+
+[JSR]: https://jsr.io/@upyo/smtp
+[JSR badge]: https://jsr.io/badges/@upyo/smtp
+[npm]: https://www.npmjs.com/package/@upyo/smtp
+[npm badge]: https://img.shields.io/npm/v/@upyo/smtp?logo=npm
+[Upyo]: https://upyo.org/
 
 
 Features
@@ -47,8 +56,8 @@ Usage
 ### Basic Email Sending
 
 ~~~~ typescript
+import { createMessage } from "@upyo/core";
 import { SmtpTransport } from "@upyo/smtp";
-import { type Message } from "@upyo/core";
 
 const transport = new SmtpTransport({
   host: "smtp.example.com",
@@ -60,53 +69,19 @@ const transport = new SmtpTransport({
   },
 });
 
-const message: Message = {
-  sender: { name: "John Doe", address: "john@example.com" },
-  recipients: [{ name: "Jane Doe", address: "jane@example.com" }],
-  ccRecipients: [],
-  bccRecipients: [],
-  replyRecipients: [],
+const message = createMessage({
+  from: "sender@example.com",
+  to: "recipient@example.net",
   subject: "Hello from Upyo!",
   content: { text: "This is a test email." },
-  attachments: [],
-  priority: "normal",
-  tags: [],
-  headers: new Headers(),
-};
-
-const receipt = await transport.send(message);
-console.log("Email sent:", receipt.successful);
-~~~~
-
-### HTML Email with Attachments
-
-~~~~ typescript
-const message: Message = {
-  sender: { address: "sender@example.com" },
-  recipients: [{ address: "recipient@example.com" }],
-  ccRecipients: [],
-  bccRecipients: [],
-  replyRecipients: [],
-  subject: "HTML Email with Attachment",
-  content: {
-    html: "<h1>Hello!</h1><p>This is an <strong>HTML</strong> email.</p>",
-    text: "Hello!\nThis is an HTML email.",
-  },
-  attachments: [
-    {
-      filename: "document.pdf",
-      content: new Uint8Array(pdfBytes),
-      contentType: "application/pdf",
-      contentId: "doc1",
-      inline: false,
-    },
-  ],
-  priority: "high",
-  tags: ["newsletter"],
-  headers: new Headers([["X-Campaign-ID", "12345"]]),
-};
+});
 
 const receipt = await transport.send(message);
+if (receipt.successful) {
+  console.log("Message sent with ID:", receipt.messageId);
+} else {
+  console.error("Send failed:", receipt.errorMessages.join(", "));
+}
 ~~~~
 
 ### Sending Multiple Emails
@@ -115,7 +90,11 @@ const receipt = await transport.send(message);
 const messages = [message1, message2, message3];
 
 for await (const receipt of transport.sendMany(messages)) {
-  console.log(`Email ${receipt.messageId}: ${receipt.successful ? "sent" : "failed"}`);
+  if (receipt.successful) {
+    console.log(`Email sent with ID: ${receipt.messageId}`);
+  } else {
+    console.error(`Email failed: ${receipt.errorMessages.join(", ")}`);
+  }
 }
 ~~~~
 

package/dist/index.cjs

@@ -31,21 +31,11 @@ const __upyo_core = __toESM(require("@upyo/core"));
 *
 * This function takes a partial SMTP configuration and returns a complete
 * configuration with all optional fields filled with sensible defaults.
+* It is used internally by the SMTP transport.
 *
 * @param config - The SMTP configuration with optional fields
 * @returns A resolved configuration with all defaults applied
-*
-* @example
-* ```typescript
-* const resolved = createSmtpConfig({
-*   host: 'smtp.example.com',
-*   auth: { user: 'user', pass: 'pass' }
-* });
-*
-* // resolved.port will be 587 (default)
-* // resolved.secure will be true (default)
-* // resolved.poolSize will be 5 (default)
-* ```
+* @internal
 */
 function createSmtpConfig(config) {
 	return {
@@ -266,7 +256,7 @@ var SmtpConnection = class {
 
 //#endregion
 //#region src/message-converter.ts
-function convertMessage(message) {
+async function convertMessage(message) {
 	const envelope = {
 		from: message.sender.address,
 		to: [
@@ -275,13 +265,13 @@ function convertMessage(message) {
 			...message.bccRecipients.map((r) => r.address)
 		]
 	};
-	const raw = buildRawMessage(message);
+	const raw = await buildRawMessage(message);
 	return {
 		envelope,
 		raw
 	};
 }
-function buildRawMessage(message) {
+async function buildRawMessage(message) {
 	const lines = [];
 	const boundary = generateBoundary();
 	const hasAttachments = message.attachments.length > 0;
@@ -346,7 +336,7 @@ function buildRawMessage(message) {
 				lines.push(`Content-ID: <${attachment.contentId}>`);
 			} else lines.push(`Content-Disposition: attachment; filename="${attachment.filename}"`);
 			lines.push("");
-			lines.push(encodeBase64(attachment.content));
+			lines.push(encodeBase64(await attachment.content));
 		}
 		lines.push("");
 		lines.push(`--${boundary}--`);
@@ -428,9 +418,15 @@ function encodeBase64(data) {
 * ```
 */
 var SmtpTransport = class {
+	/**
+	* The SMTP configuration used by this transport.
+	*/
 	config;
-	connectionPool = [];
+	/**
+	* The maximum number of connections in the pool.
+	*/
 	poolSize;
+	connectionPool = [];
 	/**
 	* Creates a new SMTP transport instance.
 	*
@@ -472,21 +468,19 @@ var SmtpTransport = class {
 		const connection = await this.getConnection(options?.signal);
 		try {
 			options?.signal?.throwIfAborted();
-			const smtpMessage = convertMessage(message);
+			const smtpMessage = await convertMessage(message);
 			options?.signal?.throwIfAborted();
 			const messageId = await connection.sendMessage(smtpMessage, options?.signal);
 			await this.returnConnection(connection);
 			return {
-				messageId,
-				errorMessages: [],
-				successful: true
+				successful: true,
+				messageId
 			};
 		} catch (error) {
 			await this.discardConnection(connection);
 			return {
-				messageId: "",
-				errorMessages: [error instanceof Error ? error.message : String(error)],
-				successful: false
+				successful: false,
+				errorMessages: [error instanceof Error ? error.message : String(error)]
 			};
 		}
 	}
@@ -528,27 +522,24 @@ var SmtpTransport = class {
 				options?.signal?.throwIfAborted();
 				if (!connectionValid) {
 					yield {
-						messageId: "",
-						errorMessages: ["Connection is no longer valid"],
-						successful: false
+						successful: false,
+						errorMessages: ["Connection is no longer valid"]
 					};
 					continue;
 				}
 				try {
-					const smtpMessage = convertMessage(message);
+					const smtpMessage = await convertMessage(message);
 					options?.signal?.throwIfAborted();
 					const messageId = await connection.sendMessage(smtpMessage, options?.signal);
 					yield {
-						messageId,
-						errorMessages: [],
-						successful: true
+						successful: true,
+						messageId
 					};
 				} catch (error) {
 					connectionValid = false;
 					yield {
-						messageId: "",
-						errorMessages: [error instanceof Error ? error.message : String(error)],
-						successful: false
+						successful: false,
+						errorMessages: [error instanceof Error ? error.message : String(error)]
 					};
 				}
 			}
@@ -556,27 +547,24 @@ var SmtpTransport = class {
 				options?.signal?.throwIfAborted();
 				if (!connectionValid) {
 					yield {
-						messageId: "",
-						errorMessages: ["Connection is no longer valid"],
-						successful: false
+						successful: false,
+						errorMessages: ["Connection is no longer valid"]
 					};
 					continue;
 				}
 				try {
-					const smtpMessage = convertMessage(message);
+					const smtpMessage = await convertMessage(message);
 					options?.signal?.throwIfAborted();
 					const messageId = await connection.sendMessage(smtpMessage, options?.signal);
 					yield {
-						messageId,
-						errorMessages: [],
-						successful: true
+						successful: true,
+						messageId
 					};
 				} catch (error) {
 					connectionValid = false;
 					yield {
-						messageId: "",
-						errorMessages: [error instanceof Error ? error.message : String(error)],
-						successful: false
+						successful: false,
+						errorMessages: [error instanceof Error ? error.message : String(error)]
 					};
 				}
 			}
@@ -661,5 +649,4 @@ var SmtpTransport = class {
 };
 
 //#endregion
-exports.SmtpTransport = SmtpTransport;
-exports.createSmtpConfig = createSmtpConfig;
+exports.SmtpTransport = SmtpTransport;

package/dist/index.d.cts

@@ -1,6 +1,4 @@
 import { Message, Receipt, Transport, TransportOptions } from "@upyo/core";
-import { Socket } from "node:net";
-import { TLSSocket } from "node:tls";
 
 //#region src/config.d.ts
 
@@ -154,67 +152,6 @@ interface SmtpTlsOptions {
  * This type represents the final configuration after applying defaults,
  * used internally by the SMTP transport implementation.
  */
-type ResolvedSmtpConfig = Omit<Required<SmtpConfig>, "auth" | "tls"> & {
-  readonly auth?: SmtpAuth;
-  readonly tls?: SmtpTlsOptions;
-};
-/**
- * Creates a resolved SMTP configuration by applying default values to optional fields.
- *
- * This function takes a partial SMTP configuration and returns a complete
- * configuration with all optional fields filled with sensible defaults.
- *
- * @param config - The SMTP configuration with optional fields
- * @returns A resolved configuration with all defaults applied
- *
- * @example
- * ```typescript
- * const resolved = createSmtpConfig({
- *   host: 'smtp.example.com',
- *   auth: { user: 'user', pass: 'pass' }
- * });
- *
- * // resolved.port will be 587 (default)
- * // resolved.secure will be true (default)
- * // resolved.poolSize will be 5 (default)
- * ```
- */
-declare function createSmtpConfig(config: SmtpConfig): ResolvedSmtpConfig;
-//#endregion
-//#region src/message-converter.d.ts
-interface SmtpMessage {
-  readonly envelope: SmtpEnvelope;
-  readonly raw: string;
-}
-interface SmtpEnvelope {
-  readonly from: string;
-  readonly to: string[];
-}
-//#endregion
-//#region src/smtp-connection.d.ts
-declare class SmtpConnection {
-  socket: Socket | TLSSocket | null;
-  config: ResolvedSmtpConfig;
-  authenticated: boolean;
-  capabilities: string[];
-  constructor(config: SmtpConfig);
-  connect(signal?: AbortSignal): Promise<void>;
-  sendCommand(command: string, signal?: AbortSignal): Promise<SmtpResponse>;
-  greeting(signal?: AbortSignal): Promise<SmtpResponse>;
-  ehlo(signal?: AbortSignal): Promise<void>;
-  authenticate(signal?: AbortSignal): Promise<void>;
-  private authPlain;
-  authLogin(signal?: AbortSignal): Promise<void>;
-  sendMessage(message: SmtpMessage, signal?: AbortSignal): Promise<string>;
-  extractMessageId(response: string): string;
-  quit(): Promise<void>;
-  reset(signal?: AbortSignal): Promise<void>;
-}
-interface SmtpResponse {
-  readonly code: number;
-  readonly message: string;
-  readonly raw: string;
-}
 //#endregion
 //#region src/smtp-transport.d.ts
 /**
@@ -251,9 +188,15 @@ interface SmtpResponse {
  * ```
  */
 declare class SmtpTransport implements Transport, AsyncDisposable {
+  /**
+   * The SMTP configuration used by this transport.
+   */
   config: SmtpConfig;
-  connectionPool: SmtpConnection[];
+  /**
+   * The maximum number of connections in the pool.
+   */
   poolSize: number;
+  private connectionPool;
   /**
    * Creates a new SMTP transport instance.
    *
@@ -317,10 +260,10 @@ declare class SmtpTransport implements Transport, AsyncDisposable {
    * @returns An async iterable of receipts, one for each message.
    */
   sendMany(messages: Iterable<Message> | AsyncIterable<Message>, options?: TransportOptions): AsyncIterable<Receipt>;
-  getConnection(signal?: AbortSignal): Promise<SmtpConnection>;
-  connectAndSetup(connection: SmtpConnection, signal?: AbortSignal): Promise<void>;
-  returnConnection(connection: SmtpConnection): Promise<void>;
-  discardConnection(connection: SmtpConnection): Promise<void>;
+  private getConnection;
+  private connectAndSetup;
+  private returnConnection;
+  private discardConnection;
   /**
    * Closes all active SMTP connections in the connection pool.
    *
@@ -352,4 +295,4 @@ declare class SmtpTransport implements Transport, AsyncDisposable {
   [Symbol.asyncDispose](): Promise<void>;
 }
 //#endregion
-export { SmtpAuth, SmtpConfig, SmtpTlsOptions, SmtpTransport, createSmtpConfig };
+export { SmtpAuth, SmtpConfig, SmtpTlsOptions, SmtpTransport };

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-import { Socket } from "node:net";
-import { TLSSocket } from "node:tls";
 import { Message, Receipt, Transport, TransportOptions } from "@upyo/core";
 
 //#region src/config.d.ts
@@ -154,67 +152,6 @@ interface SmtpTlsOptions {
  * This type represents the final configuration after applying defaults,
  * used internally by the SMTP transport implementation.
  */
-type ResolvedSmtpConfig = Omit<Required<SmtpConfig>, "auth" | "tls"> & {
-  readonly auth?: SmtpAuth;
-  readonly tls?: SmtpTlsOptions;
-};
-/**
- * Creates a resolved SMTP configuration by applying default values to optional fields.
- *
- * This function takes a partial SMTP configuration and returns a complete
- * configuration with all optional fields filled with sensible defaults.
- *
- * @param config - The SMTP configuration with optional fields
- * @returns A resolved configuration with all defaults applied
- *
- * @example
- * ```typescript
- * const resolved = createSmtpConfig({
- *   host: 'smtp.example.com',
- *   auth: { user: 'user', pass: 'pass' }
- * });
- *
- * // resolved.port will be 587 (default)
- * // resolved.secure will be true (default)
- * // resolved.poolSize will be 5 (default)
- * ```
- */
-declare function createSmtpConfig(config: SmtpConfig): ResolvedSmtpConfig;
-//#endregion
-//#region src/message-converter.d.ts
-interface SmtpMessage {
-  readonly envelope: SmtpEnvelope;
-  readonly raw: string;
-}
-interface SmtpEnvelope {
-  readonly from: string;
-  readonly to: string[];
-}
-//#endregion
-//#region src/smtp-connection.d.ts
-declare class SmtpConnection {
-  socket: Socket | TLSSocket | null;
-  config: ResolvedSmtpConfig;
-  authenticated: boolean;
-  capabilities: string[];
-  constructor(config: SmtpConfig);
-  connect(signal?: AbortSignal): Promise<void>;
-  sendCommand(command: string, signal?: AbortSignal): Promise<SmtpResponse>;
-  greeting(signal?: AbortSignal): Promise<SmtpResponse>;
-  ehlo(signal?: AbortSignal): Promise<void>;
-  authenticate(signal?: AbortSignal): Promise<void>;
-  private authPlain;
-  authLogin(signal?: AbortSignal): Promise<void>;
-  sendMessage(message: SmtpMessage, signal?: AbortSignal): Promise<string>;
-  extractMessageId(response: string): string;
-  quit(): Promise<void>;
-  reset(signal?: AbortSignal): Promise<void>;
-}
-interface SmtpResponse {
-  readonly code: number;
-  readonly message: string;
-  readonly raw: string;
-}
 //#endregion
 //#region src/smtp-transport.d.ts
 /**
@@ -251,9 +188,15 @@ interface SmtpResponse {
  * ```
  */
 declare class SmtpTransport implements Transport, AsyncDisposable {
+  /**
+   * The SMTP configuration used by this transport.
+   */
   config: SmtpConfig;
-  connectionPool: SmtpConnection[];
+  /**
+   * The maximum number of connections in the pool.
+   */
   poolSize: number;
+  private connectionPool;
   /**
    * Creates a new SMTP transport instance.
    *
@@ -317,10 +260,10 @@ declare class SmtpTransport implements Transport, AsyncDisposable {
    * @returns An async iterable of receipts, one for each message.
    */
   sendMany(messages: Iterable<Message> | AsyncIterable<Message>, options?: TransportOptions): AsyncIterable<Receipt>;
-  getConnection(signal?: AbortSignal): Promise<SmtpConnection>;
-  connectAndSetup(connection: SmtpConnection, signal?: AbortSignal): Promise<void>;
-  returnConnection(connection: SmtpConnection): Promise<void>;
-  discardConnection(connection: SmtpConnection): Promise<void>;
+  private getConnection;
+  private connectAndSetup;
+  private returnConnection;
+  private discardConnection;
   /**
    * Closes all active SMTP connections in the connection pool.
    *
@@ -352,4 +295,4 @@ declare class SmtpTransport implements Transport, AsyncDisposable {
   [Symbol.asyncDispose](): Promise<void>;
 }
 //#endregion
-export { SmtpAuth, SmtpConfig, SmtpTlsOptions, SmtpTransport, createSmtpConfig };
+export { SmtpAuth, SmtpConfig, SmtpTlsOptions, SmtpTransport };

package/dist/index.js

@@ -8,21 +8,11 @@ import { formatAddress } from "@upyo/core";
 *
 * This function takes a partial SMTP configuration and returns a complete
 * configuration with all optional fields filled with sensible defaults.
+* It is used internally by the SMTP transport.
 *
 * @param config - The SMTP configuration with optional fields
 * @returns A resolved configuration with all defaults applied
-*
-* @example
-* ```typescript
-* const resolved = createSmtpConfig({
-*   host: 'smtp.example.com',
-*   auth: { user: 'user', pass: 'pass' }
-* });
-*
-* // resolved.port will be 587 (default)
-* // resolved.secure will be true (default)
-* // resolved.poolSize will be 5 (default)
-* ```
+* @internal
 */
 function createSmtpConfig(config) {
 	return {
@@ -243,7 +233,7 @@ var SmtpConnection = class {
 
 //#endregion
 //#region src/message-converter.ts
-function convertMessage(message) {
+async function convertMessage(message) {
 	const envelope = {
 		from: message.sender.address,
 		to: [
@@ -252,13 +242,13 @@ function convertMessage(message) {
 			...message.bccRecipients.map((r) => r.address)
 		]
 	};
-	const raw = buildRawMessage(message);
+	const raw = await buildRawMessage(message);
 	return {
 		envelope,
 		raw
 	};
 }
-function buildRawMessage(message) {
+async function buildRawMessage(message) {
 	const lines = [];
 	const boundary = generateBoundary();
 	const hasAttachments = message.attachments.length > 0;
@@ -323,7 +313,7 @@ function buildRawMessage(message) {
 				lines.push(`Content-ID: <${attachment.contentId}>`);
 			} else lines.push(`Content-Disposition: attachment; filename="${attachment.filename}"`);
 			lines.push("");
-			lines.push(encodeBase64(attachment.content));
+			lines.push(encodeBase64(await attachment.content));
 		}
 		lines.push("");
 		lines.push(`--${boundary}--`);
@@ -405,9 +395,15 @@ function encodeBase64(data) {
 * ```
 */
 var SmtpTransport = class {
+	/**
+	* The SMTP configuration used by this transport.
+	*/
 	config;
-	connectionPool = [];
+	/**
+	* The maximum number of connections in the pool.
+	*/
 	poolSize;
+	connectionPool = [];
 	/**
 	* Creates a new SMTP transport instance.
 	*
@@ -449,21 +445,19 @@ var SmtpTransport = class {
 		const connection = await this.getConnection(options?.signal);
 		try {
 			options?.signal?.throwIfAborted();
-			const smtpMessage = convertMessage(message);
+			const smtpMessage = await convertMessage(message);
 			options?.signal?.throwIfAborted();
 			const messageId = await connection.sendMessage(smtpMessage, options?.signal);
 			await this.returnConnection(connection);
 			return {
-				messageId,
-				errorMessages: [],
-				successful: true
+				successful: true,
+				messageId
 			};
 		} catch (error) {
 			await this.discardConnection(connection);
 			return {
-				messageId: "",
-				errorMessages: [error instanceof Error ? error.message : String(error)],
-				successful: false
+				successful: false,
+				errorMessages: [error instanceof Error ? error.message : String(error)]
 			};
 		}
 	}
@@ -505,27 +499,24 @@ var SmtpTransport = class {
 				options?.signal?.throwIfAborted();
 				if (!connectionValid) {
 					yield {
-						messageId: "",
-						errorMessages: ["Connection is no longer valid"],
-						successful: false
+						successful: false,
+						errorMessages: ["Connection is no longer valid"]
 					};
 					continue;
 				}
 				try {
-					const smtpMessage = convertMessage(message);
+					const smtpMessage = await convertMessage(message);
 					options?.signal?.throwIfAborted();
 					const messageId = await connection.sendMessage(smtpMessage, options?.signal);
 					yield {
-						messageId,
-						errorMessages: [],
-						successful: true
+						successful: true,
+						messageId
 					};
 				} catch (error) {
 					connectionValid = false;
 					yield {
-						messageId: "",
-						errorMessages: [error instanceof Error ? error.message : String(error)],
-						successful: false
+						successful: false,
+						errorMessages: [error instanceof Error ? error.message : String(error)]
 					};
 				}
 			}
@@ -533,27 +524,24 @@ var SmtpTransport = class {
 				options?.signal?.throwIfAborted();
 				if (!connectionValid) {
 					yield {
-						messageId: "",
-						errorMessages: ["Connection is no longer valid"],
-						successful: false
+						successful: false,
+						errorMessages: ["Connection is no longer valid"]
 					};
 					continue;
 				}
 				try {
-					const smtpMessage = convertMessage(message);
+					const smtpMessage = await convertMessage(message);
 					options?.signal?.throwIfAborted();
 					const messageId = await connection.sendMessage(smtpMessage, options?.signal);
 					yield {
-						messageId,
-						errorMessages: [],
-						successful: true
+						successful: true,
+						messageId
 					};
 				} catch (error) {
 					connectionValid = false;
 					yield {
-						messageId: "",
-						errorMessages: [error instanceof Error ? error.message : String(error)],
-						successful: false
+						successful: false,
+						errorMessages: [error instanceof Error ? error.message : String(error)]
 					};
 				}
 			}
@@ -638,4 +626,4 @@ var SmtpTransport = class {
 };
 
 //#endregion
-export { SmtpTransport, createSmtpConfig };
+export { SmtpTransport };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upyo/smtp",
-  "version": "0.1.0-dev.9+a57dde18",
+  "version": "0.1.0",
   "description": "SMTP transport for Upyo email library",
   "keywords": [
     "email",
@@ -53,12 +53,12 @@
   },
   "sideEffects": false,
   "peerDependencies": {
-    "@upyo/core": "0.1.0-dev.9+a57dde18"
+    "@upyo/core": "0.1.0"
   },
   "devDependencies": {
     "@dotenvx/dotenvx": "^1.47.3",
     "tsdown": "^0.12.7",
-    "typescript": "^5.8.3"
+    "typescript": "5.8.3"
   },
   "scripts": {
     "build": "tsdown",