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

package/README.md

@@ -54,7 +54,11 @@ const transport = new SendGridTransport({
 });
 
 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(", "));
+}
 ~~~~
 
 

package/dist/index.cjs

@@ -5,20 +5,11 @@
 *
 * This function takes a partial SendGrid configuration and returns a complete
 * configuration with all optional fields filled with sensible defaults.
+* It is used internally by the SendGrid transport.
 *
 * @param config - The SendGrid configuration with optional fields
 * @returns A resolved configuration with all defaults applied
-*
-* @example
-* ```typescript
-* const resolved = createSendGridConfig({
-*   apiKey: 'your-api-key'
-* });
-*
-* // resolved.baseUrl will be 'https://api.sendgrid.com/v3' (default)
-* // resolved.timeout will be 30000 (default)
-* // resolved.retries will be 3 (default)
-* ```
+* @internal
 */
 function createSendGridConfig(config) {
 	return {
@@ -313,10 +304,17 @@ function isStandardHeader(headerName) {
 * });
 *
 * const receipt = await transport.send(message);
-* console.log('Message sent:', receipt.messageId);
+* if (receipt.successful) {
+*   console.log('Message sent with ID:', receipt.messageId);
+* } else {
+*   console.error('Send failed:', receipt.errorMessages.join(', '));
+* }
 * ```
 */
 var SendGridTransport = class {
+	/**
+	* The resolved SendGrid configuration used by this transport.
+	*/
 	config;
 	httpClient;
 	/**
@@ -369,16 +367,14 @@ var SendGridTransport = class {
 			const response = await this.httpClient.sendMessage(mailData, options?.signal);
 			const messageId = this.extractMessageId(response);
 			return {
-				messageId,
-				errorMessages: [],
-				successful: true
+				successful: true,
+				messageId
 			};
 		} catch (error) {
 			const errorMessage = error instanceof Error ? error.message : String(error);
 			return {
-				messageId: "",
-				errorMessages: [errorMessage],
-				successful: false
+				successful: false,
+				errorMessages: [errorMessage]
 			};
 		}
 	}
@@ -466,5 +462,4 @@ var SendGridTransport = class {
 
 //#endregion
 exports.SendGridApiError = SendGridApiError;
-exports.SendGridTransport = SendGridTransport;
-exports.createSendGridConfig = createSendGridConfig;
+exports.SendGridTransport = SendGridTransport;

package/dist/index.d.cts

@@ -91,102 +91,12 @@ type ResolvedSendGridConfig = Required<SendGridConfig>;
  *
  * This function takes a partial SendGrid configuration and returns a complete
  * configuration with all optional fields filled with sensible defaults.
+ * It is used internally by the SendGrid transport.
  *
  * @param config - The SendGrid configuration with optional fields
  * @returns A resolved configuration with all defaults applied
- *
- * @example
- * ```typescript
- * const resolved = createSendGridConfig({
- *   apiKey: 'your-api-key'
- * });
- *
- * // resolved.baseUrl will be 'https://api.sendgrid.com/v3' (default)
- * // resolved.timeout will be 30000 (default)
- * // resolved.retries will be 3 (default)
- * ```
+ * @internal
  */
-declare function createSendGridConfig(config: SendGridConfig): ResolvedSendGridConfig;
-//#endregion
-//#region src/http-client.d.ts
-/**
- * Response from SendGrid API for sending messages.
- */
-interface SendGridResponse {
-  /**
-   * HTTP status code returned by SendGrid.
-   */
-  readonly statusCode?: number;
-  /**
-   * Response body from SendGrid (usually empty on success).
-   */
-  readonly body?: string;
-  /**
-   * Response headers from SendGrid.
-   */
-  readonly headers?: Record<string, string>;
-}
-/**
- * Error response from SendGrid API.
- */
-
-/**
- * HTTP client wrapper for SendGrid API requests.
- *
- * This class handles authentication, request formatting, error handling,
- * and retry logic for SendGrid API calls.
- */
-declare class SendGridHttpClient {
-  config: ResolvedSendGridConfig;
-  constructor(config: ResolvedSendGridConfig);
-  /**
-   * Sends a message via SendGrid API.
-   *
-   * @param messageData The JSON data to send to SendGrid.
-   * @param signal Optional AbortSignal for cancellation.
-   * @returns Promise that resolves to the SendGrid response.
-   */
-  sendMessage(messageData: Record<string, unknown>, signal?: AbortSignal): Promise<SendGridResponse>;
-  /**
-   * Makes an HTTP request to SendGrid API with retry logic.
-   *
-   * @param url The URL to make the request to.
-   * @param options Fetch options.
-   * @returns Promise that resolves to the parsed response.
-   */
-  makeRequest(url: string, options: RequestInit): Promise<SendGridResponse>;
-  /**
-   * Makes a fetch request with SendGrid authentication.
-   *
-   * @param url The URL to make the request to.
-   * @param options Fetch options.
-   * @returns Promise that resolves to the fetch response.
-   */
-  fetchWithAuth(url: string, options: RequestInit): Promise<Response>;
-  /**
-   * Converts Headers object to a plain Record.
-   *
-   * @param headers The Headers object to convert.
-   * @returns A plain object with header key-value pairs.
-   */
-  headersToRecord(headers: Headers): Record<string, string>;
-}
-/**
- * Custom error class for SendGrid API errors.
- */
-declare class SendGridApiError extends Error {
-  readonly statusCode?: number;
-  readonly errors?: {
-    readonly message: string;
-    readonly field?: string;
-    readonly help?: string;
-  }[];
-  constructor(message: string, statusCode?: number, errors?: Array<{
-    message: string;
-    field?: string;
-    help?: string;
-  }>);
-}
 //#endregion
 //#region src/sendgrid-transport.d.ts
 /**
@@ -206,12 +116,19 @@ declare class SendGridApiError extends Error {
  * });
  *
  * const receipt = await transport.send(message);
- * console.log('Message sent:', receipt.messageId);
+ * if (receipt.successful) {
+ *   console.log('Message sent with ID:', receipt.messageId);
+ * } else {
+ *   console.error('Send failed:', receipt.errorMessages.join(', '));
+ * }
  * ```
  */
 declare class SendGridTransport implements Transport {
-  config: ReturnType<typeof createSendGridConfig>;
-  httpClient: SendGridHttpClient;
+  /**
+   * The resolved SendGrid configuration used by this transport.
+   */
+  config: ResolvedSendGridConfig;
+  private httpClient;
   /**
    * Creates a new SendGrid transport instance.
    *
@@ -317,4 +234,23 @@ declare class SendGridTransport implements Transport {
   private extractMessageId;
 }
 //#endregion
-export { SendGridApiError, SendGridConfig, SendGridTransport, createSendGridConfig };
+//#region src/http-client.d.ts
+
+/**
+ * Custom error class for SendGrid API errors.
+ */
+declare class SendGridApiError extends Error {
+  readonly statusCode?: number;
+  readonly errors?: {
+    readonly message: string;
+    readonly field?: string;
+    readonly help?: string;
+  }[];
+  constructor(message: string, statusCode?: number, errors?: Array<{
+    message: string;
+    field?: string;
+    help?: string;
+  }>);
+}
+//#endregion
+export { SendGridApiError, SendGridConfig, SendGridTransport };

package/dist/index.d.ts

@@ -91,102 +91,12 @@ type ResolvedSendGridConfig = Required<SendGridConfig>;
  *
  * This function takes a partial SendGrid configuration and returns a complete
  * configuration with all optional fields filled with sensible defaults.
+ * It is used internally by the SendGrid transport.
  *
  * @param config - The SendGrid configuration with optional fields
  * @returns A resolved configuration with all defaults applied
- *
- * @example
- * ```typescript
- * const resolved = createSendGridConfig({
- *   apiKey: 'your-api-key'
- * });
- *
- * // resolved.baseUrl will be 'https://api.sendgrid.com/v3' (default)
- * // resolved.timeout will be 30000 (default)
- * // resolved.retries will be 3 (default)
- * ```
+ * @internal
  */
-declare function createSendGridConfig(config: SendGridConfig): ResolvedSendGridConfig;
-//#endregion
-//#region src/http-client.d.ts
-/**
- * Response from SendGrid API for sending messages.
- */
-interface SendGridResponse {
-  /**
-   * HTTP status code returned by SendGrid.
-   */
-  readonly statusCode?: number;
-  /**
-   * Response body from SendGrid (usually empty on success).
-   */
-  readonly body?: string;
-  /**
-   * Response headers from SendGrid.
-   */
-  readonly headers?: Record<string, string>;
-}
-/**
- * Error response from SendGrid API.
- */
-
-/**
- * HTTP client wrapper for SendGrid API requests.
- *
- * This class handles authentication, request formatting, error handling,
- * and retry logic for SendGrid API calls.
- */
-declare class SendGridHttpClient {
-  config: ResolvedSendGridConfig;
-  constructor(config: ResolvedSendGridConfig);
-  /**
-   * Sends a message via SendGrid API.
-   *
-   * @param messageData The JSON data to send to SendGrid.
-   * @param signal Optional AbortSignal for cancellation.
-   * @returns Promise that resolves to the SendGrid response.
-   */
-  sendMessage(messageData: Record<string, unknown>, signal?: AbortSignal): Promise<SendGridResponse>;
-  /**
-   * Makes an HTTP request to SendGrid API with retry logic.
-   *
-   * @param url The URL to make the request to.
-   * @param options Fetch options.
-   * @returns Promise that resolves to the parsed response.
-   */
-  makeRequest(url: string, options: RequestInit): Promise<SendGridResponse>;
-  /**
-   * Makes a fetch request with SendGrid authentication.
-   *
-   * @param url The URL to make the request to.
-   * @param options Fetch options.
-   * @returns Promise that resolves to the fetch response.
-   */
-  fetchWithAuth(url: string, options: RequestInit): Promise<Response>;
-  /**
-   * Converts Headers object to a plain Record.
-   *
-   * @param headers The Headers object to convert.
-   * @returns A plain object with header key-value pairs.
-   */
-  headersToRecord(headers: Headers): Record<string, string>;
-}
-/**
- * Custom error class for SendGrid API errors.
- */
-declare class SendGridApiError extends Error {
-  readonly statusCode?: number;
-  readonly errors?: {
-    readonly message: string;
-    readonly field?: string;
-    readonly help?: string;
-  }[];
-  constructor(message: string, statusCode?: number, errors?: Array<{
-    message: string;
-    field?: string;
-    help?: string;
-  }>);
-}
 //#endregion
 //#region src/sendgrid-transport.d.ts
 /**
@@ -206,12 +116,19 @@ declare class SendGridApiError extends Error {
  * });
  *
  * const receipt = await transport.send(message);
- * console.log('Message sent:', receipt.messageId);
+ * if (receipt.successful) {
+ *   console.log('Message sent with ID:', receipt.messageId);
+ * } else {
+ *   console.error('Send failed:', receipt.errorMessages.join(', '));
+ * }
  * ```
  */
 declare class SendGridTransport implements Transport {
-  config: ReturnType<typeof createSendGridConfig>;
-  httpClient: SendGridHttpClient;
+  /**
+   * The resolved SendGrid configuration used by this transport.
+   */
+  config: ResolvedSendGridConfig;
+  private httpClient;
   /**
    * Creates a new SendGrid transport instance.
    *
@@ -317,4 +234,23 @@ declare class SendGridTransport implements Transport {
   private extractMessageId;
 }
 //#endregion
-export { SendGridApiError, SendGridConfig, SendGridTransport, createSendGridConfig };
+//#region src/http-client.d.ts
+
+/**
+ * Custom error class for SendGrid API errors.
+ */
+declare class SendGridApiError extends Error {
+  readonly statusCode?: number;
+  readonly errors?: {
+    readonly message: string;
+    readonly field?: string;
+    readonly help?: string;
+  }[];
+  constructor(message: string, statusCode?: number, errors?: Array<{
+    message: string;
+    field?: string;
+    help?: string;
+  }>);
+}
+//#endregion
+export { SendGridApiError, SendGridConfig, SendGridTransport };

package/dist/index.js

@@ -4,20 +4,11 @@
 *
 * This function takes a partial SendGrid configuration and returns a complete
 * configuration with all optional fields filled with sensible defaults.
+* It is used internally by the SendGrid transport.
 *
 * @param config - The SendGrid configuration with optional fields
 * @returns A resolved configuration with all defaults applied
-*
-* @example
-* ```typescript
-* const resolved = createSendGridConfig({
-*   apiKey: 'your-api-key'
-* });
-*
-* // resolved.baseUrl will be 'https://api.sendgrid.com/v3' (default)
-* // resolved.timeout will be 30000 (default)
-* // resolved.retries will be 3 (default)
-* ```
+* @internal
 */
 function createSendGridConfig(config) {
 	return {
@@ -312,10 +303,17 @@ function isStandardHeader(headerName) {
 * });
 *
 * const receipt = await transport.send(message);
-* console.log('Message sent:', receipt.messageId);
+* if (receipt.successful) {
+*   console.log('Message sent with ID:', receipt.messageId);
+* } else {
+*   console.error('Send failed:', receipt.errorMessages.join(', '));
+* }
 * ```
 */
 var SendGridTransport = class {
+	/**
+	* The resolved SendGrid configuration used by this transport.
+	*/
 	config;
 	httpClient;
 	/**
@@ -368,16 +366,14 @@ var SendGridTransport = class {
 			const response = await this.httpClient.sendMessage(mailData, options?.signal);
 			const messageId = this.extractMessageId(response);
 			return {
-				messageId,
-				errorMessages: [],
-				successful: true
+				successful: true,
+				messageId
 			};
 		} catch (error) {
 			const errorMessage = error instanceof Error ? error.message : String(error);
 			return {
-				messageId: "",
-				errorMessages: [errorMessage],
-				successful: false
+				successful: false,
+				errorMessages: [errorMessage]
 			};
 		}
 	}
@@ -464,4 +460,4 @@ var SendGridTransport = class {
 };
 
 //#endregion
-export { SendGridApiError, SendGridTransport, createSendGridConfig };
+export { SendGridApiError, SendGridTransport };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upyo/sendgrid",
-  "version": "0.1.0-dev.13+aad44636",
+  "version": "0.1.0-dev.17+3ffd074a",
   "description": "SendGrid 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",