@upyo/smtp 0.1.0-dev.13 → 0.1.0-dev.17

package/README.md

@@ -77,7 +77,11 @@ const message = createMessage({
 });
 
 const receipt = await transport.send(message);
-console.log("Email sent:", receipt.successful);
+if (receipt.successful) {
+  console.log("Message sent with ID:", receipt.messageId);
+} else {
+  console.error("Send failed:", receipt.errorMessages.join(", "));
+}
 ~~~~
 
 ### Sending Multiple Emails
@@ -86,7 +90,11 @@ console.log("Email sent:", receipt.successful);
 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 {
@@ -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.
 	*
@@ -477,16 +473,14 @@ var SmtpTransport = class {
 			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,9 +522,8 @@ 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;
 				}
@@ -539,16 +532,14 @@ var SmtpTransport = class {
 					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,9 +547,8 @@ 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;
 				}
@@ -567,16 +557,14 @@ var SmtpTransport = class {
 					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 {
@@ -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.
 	*
@@ -454,16 +450,14 @@ var SmtpTransport = class {
 			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,9 +499,8 @@ 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;
 				}
@@ -516,16 +509,14 @@ var SmtpTransport = class {
 					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,9 +524,8 @@ 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;
 				}
@@ -544,16 +534,14 @@ var SmtpTransport = class {
 					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.13+aad44636",
+  "version": "0.1.0-dev.17+3ffd074a",
   "description": "SMTP transport for Upyo email library",
   "keywords": [
     "email",
@@ -53,7 +53,7 @@
   },
   "sideEffects": false,
   "peerDependencies": {
-    "@upyo/core": "0.1.0-dev.13+aad44636"
+    "@upyo/core": "0.1.0-dev.17+3ffd074a"
   },
   "devDependencies": {
     "@dotenvx/dotenvx": "^1.47.3",