@upyo/mailgun 0.1.0-dev.14 → 0.1.0-dev.9

package/README.md

@@ -3,17 +3,9 @@
 @upyo/mailgun
 =============
 
-[![JSR][JSR badge]][JSR]
-[![npm][npm badge]][npm]
+[Mailgun] transport for Upyo email library.
 
-[Mailgun] transport for the [Upyo] email library.
-
-[JSR]: https://jsr.io/@upyo/mailgun
-[JSR badge]: https://jsr.io/badges/@upyo/mailgun
-[npm]: https://www.npmjs.com/package/@upyo/mailgun
-[npm badge]: https://img.shields.io/npm/v/@upyo/mailgun?logo=npm
 [Mailgun]: https://www.mailgun.com/
-[Upyo]: https://upyo.org/
 
 
 Installation
@@ -32,35 +24,22 @@ Usage
 -----
 
 ~~~~ typescript
-import { createMessage } from "@upyo/core";
-import { MailgunTransport } from "@upyo/mailgun";
-import fs from "node:fs/promises";
-import process from "node:process";
-
-const message = createMessage({
-  from: "sender@example.com",
-  to: "recipient@example.net",
-  subject: "Hello from Upyo!",
-  content: { text: "This is a test email." },
-  attachments: [
-    new File(
-      [await fs.readFile("image.jpg"), "image.jpg", { type: "image/jpeg" }]
-    )
-  ],
-});
+import { MailgunTransport } from '@upyo/mailgun';
 
 const transport = new MailgunTransport({
-  apiKey: process.env.MAILGUN_KEY!,
-  domain: process.env.MAILGUN_DOMAIN!,
-  region: process.env.MAILGUN_REGION as "us" | "eu",
+  apiKey: 'your-api-key',
+  domain: 'your-domain.com'
 });
 
+const message = {
+  sender: { address: 'sender@example.com' },
+  recipients: [{ address: 'recipient@example.com' }],
+  subject: 'Hello from Mailgun!',
+  content: { text: 'Hello, World!' }
+};
+
 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(", "));
-}
+console.log('Message sent:', receipt.messageId);
 ~~~~
 
 

package/dist/index.cjs

@@ -162,11 +162,11 @@ var MailgunApiError = class extends Error {
 *
 * @example
 * ```typescript
-* const formData = await convertMessage(message, config);
+* const formData = convertMessage(message, config);
 * const response = await fetch(url, { method: 'POST', body: formData });
 * ```
 */
-async function convertMessage(message, config) {
+function convertMessage(message, config) {
 	const formData = new FormData();
 	formData.append("from", formatAddress(message.sender));
 	for (const recipient of message.recipients) formData.append("to", formatAddress(recipient));
@@ -191,7 +191,7 @@ async function convertMessage(message, config) {
 	}
 	for (const tag of message.tags) formData.append("o:tag", tag);
 	for (const [key, value] of message.headers.entries()) if (!isStandardHeader(key)) formData.append(`h:${key}`, value);
-	for (const attachment of message.attachments) await appendAttachment(formData, attachment);
+	for (const attachment of message.attachments) appendAttachment(formData, attachment);
 	if (config.tracking !== void 0) formData.append("o:tracking", config.tracking ? "yes" : "no");
 	if (config.clickTracking !== void 0) formData.append("o:tracking-clicks", config.clickTracking ? "yes" : "no");
 	if (config.openTracking !== void 0) formData.append("o:tracking-opens", config.openTracking ? "yes" : "no");
@@ -216,8 +216,8 @@ function formatAddress(address) {
 * @param formData - The FormData to append to
 * @param attachment - The attachment to append
 */
-async function appendAttachment(formData, attachment) {
-	const blob = new Blob([await attachment.content], { type: attachment.contentType });
+function appendAttachment(formData, attachment) {
+	const blob = new Blob([attachment.content], { type: attachment.contentType });
 	if (attachment.contentId) formData.append("inline", blob, attachment.filename);
 	else formData.append("attachment", blob, attachment.filename);
 }
@@ -263,11 +263,7 @@ function isStandardHeader(headerName) {
 * });
 *
 * 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(', '));
-* }
+* console.log('Message sent:', receipt.messageId);
 * ```
 */
 var MailgunTransport = class {
@@ -318,18 +314,20 @@ var MailgunTransport = class {
 	async send(message, options) {
 		options?.signal?.throwIfAborted();
 		try {
-			const formData = await convertMessage(message, this.config);
+			const formData = convertMessage(message, this.config);
 			options?.signal?.throwIfAborted();
 			const response = await this.httpClient.sendMessage(formData, options?.signal);
 			return {
-				successful: true,
-				messageId: response.id
+				messageId: response.id,
+				errorMessages: [],
+				successful: true
 			};
 		} catch (error) {
 			const errorMessage = error instanceof Error ? error.message : String(error);
 			return {
-				successful: false,
-				errorMessages: [errorMessage]
+				messageId: "",
+				errorMessages: [errorMessage],
+				successful: false
 			};
 		}
 	}

package/dist/index.d.cts

@@ -196,11 +196,7 @@ declare class MailgunApiError extends Error {
  * });
  *
  * 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(', '));
- * }
+ * console.log('Message sent:', receipt.messageId);
  * ```
  */
 declare class MailgunTransport implements Transport {

package/dist/index.d.ts

@@ -196,11 +196,7 @@ declare class MailgunApiError extends Error {
  * });
  *
  * 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(', '));
- * }
+ * console.log('Message sent:', receipt.messageId);
  * ```
  */
 declare class MailgunTransport implements Transport {

package/dist/index.js

@@ -161,11 +161,11 @@ var MailgunApiError = class extends Error {
 *
 * @example
 * ```typescript
-* const formData = await convertMessage(message, config);
+* const formData = convertMessage(message, config);
 * const response = await fetch(url, { method: 'POST', body: formData });
 * ```
 */
-async function convertMessage(message, config) {
+function convertMessage(message, config) {
 	const formData = new FormData();
 	formData.append("from", formatAddress(message.sender));
 	for (const recipient of message.recipients) formData.append("to", formatAddress(recipient));
@@ -190,7 +190,7 @@ async function convertMessage(message, config) {
 	}
 	for (const tag of message.tags) formData.append("o:tag", tag);
 	for (const [key, value] of message.headers.entries()) if (!isStandardHeader(key)) formData.append(`h:${key}`, value);
-	for (const attachment of message.attachments) await appendAttachment(formData, attachment);
+	for (const attachment of message.attachments) appendAttachment(formData, attachment);
 	if (config.tracking !== void 0) formData.append("o:tracking", config.tracking ? "yes" : "no");
 	if (config.clickTracking !== void 0) formData.append("o:tracking-clicks", config.clickTracking ? "yes" : "no");
 	if (config.openTracking !== void 0) formData.append("o:tracking-opens", config.openTracking ? "yes" : "no");
@@ -215,8 +215,8 @@ function formatAddress(address) {
 * @param formData - The FormData to append to
 * @param attachment - The attachment to append
 */
-async function appendAttachment(formData, attachment) {
-	const blob = new Blob([await attachment.content], { type: attachment.contentType });
+function appendAttachment(formData, attachment) {
+	const blob = new Blob([attachment.content], { type: attachment.contentType });
 	if (attachment.contentId) formData.append("inline", blob, attachment.filename);
 	else formData.append("attachment", blob, attachment.filename);
 }
@@ -262,11 +262,7 @@ function isStandardHeader(headerName) {
 * });
 *
 * 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(', '));
-* }
+* console.log('Message sent:', receipt.messageId);
 * ```
 */
 var MailgunTransport = class {
@@ -317,18 +313,20 @@ var MailgunTransport = class {
 	async send(message, options) {
 		options?.signal?.throwIfAborted();
 		try {
-			const formData = await convertMessage(message, this.config);
+			const formData = convertMessage(message, this.config);
 			options?.signal?.throwIfAborted();
 			const response = await this.httpClient.sendMessage(formData, options?.signal);
 			return {
-				successful: true,
-				messageId: response.id
+				messageId: response.id,
+				errorMessages: [],
+				successful: true
 			};
 		} catch (error) {
 			const errorMessage = error instanceof Error ? error.message : String(error);
 			return {
-				successful: false,
-				errorMessages: [errorMessage]
+				messageId: "",
+				errorMessages: [errorMessage],
+				successful: false
 			};
 		}
 	}

package/package.json

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