mailchannels-sdk 1.5.2 → 1.6.0

package/dist/_chunks/mailchannels.mjs

@@ -3,7 +3,7 @@ import { subtle } from "node:crypto";
 import { Buffer } from "node:buffer";
 import mime from "mime";
 var name = "mailchannels-sdk";
-var version = "1.5.2";
+var version = "1.6.0";
 var MailChannelsClient = class MailChannelsClient {
 	static DEFAULT_BASE_URL = "https://api.mailchannels.net";
 	static DEFAULT_TIMEOUT = 12e4;
@@ -114,8 +114,14 @@ const createValidationError = (message) => {
 };
 const validatePagination = (pagination = {}) => {
 	const { limit, offset, max } = pagination;
-	if (typeof limit === "number" && (limit < 1 || max && limit > max)) return createValidationError("The limit value " + (max ? `must be between 1 and ${max}.` : "is invalid. Only positive values are allowed."));
-	if (typeof offset === "number" && offset < 0) return createValidationError("Offset must be greater than or equal to 0.");
+	if (limit !== void 0) {
+		if (!Number.isInteger(limit)) return createValidationError("The limit value must be an integer.");
+		if (limit < 1 || max != null && limit > max) return createValidationError("The limit value " + (max != null ? `must be between 1 and ${max}.` : "is invalid. Only positive values are allowed."));
+	}
+	if (offset !== void 0) {
+		if (!Number.isInteger(offset)) return createValidationError("The offset value must be an integer.");
+		if (offset < 0) return createValidationError("The offset value must be greater than or equal to 0.");
+	}
 	return null;
 };
 const CUSTOM_TRACKING_NAME_PATTERN = /^[a-z0-9-]+$/;
@@ -458,8 +464,17 @@ const mapDkimKey = (key) => ({
 	status: key.status,
 	statusModifiedAt: key.status_modified_at
 });
-var DomainsDkim = class {
+const quoteValues = (values) => {
+	return Array.from(values).map((value) => `'${value}'`).join(", ");
+};
+var DomainsDkim = class DomainsDkim {
 	mailchannels;
+	static UPDATE_STATUS_VALUES = /* @__PURE__ */ new Set([
+		"retired",
+		"revoked",
+		"rotated"
+	]);
+	static STATUS_VALUES = /* @__PURE__ */ new Set(["active", ...DomainsDkim.UPDATE_STATUS_VALUES]);
 	constructor(mailchannels) {
 		this.mailchannels = mailchannels;
 	}
@@ -518,6 +533,13 @@ var DomainsDkim = class {
 				error
 			};
 		}
+		if (options?.status !== void 0 && !DomainsDkim.STATUS_VALUES.has(options.status)) {
+			error = createValidationError(`Status must be one of ${quoteValues(DomainsDkim.STATUS_VALUES)}.`);
+			return {
+				data: null,
+				error
+			};
+		}
 		error = validatePagination({
 			...options,
 			max: 100
@@ -567,6 +589,13 @@ var DomainsDkim = class {
 				error
 			};
 		}
+		if (options?.status !== void 0 && !DomainsDkim.UPDATE_STATUS_VALUES.has(options.status)) {
+			error = createValidationError(`Status must be one of ${quoteValues(DomainsDkim.UPDATE_STATUS_VALUES)}.`);
+			return {
+				success: false,
+				error
+			};
+		}
 		const payload = { status: options.status };
 		await this.mailchannels.patch(`/tx/v1/domains/${encodeURIComponent(domain)}/dkim-keys/${encodeURIComponent(options.selector)}`, {
 			body: payload,
@@ -760,7 +789,7 @@ var DomainsCustomTracking = class DomainsCustomTracking {
 			};
 		}
 		if (!scope || !DomainsCustomTracking.SCOPE_VALUES.has(scope)) {
-			error = createValidationError("Scope must be one of 'click', 'open', or 'unsubscribe'.");
+			error = createValidationError(`Scope must be one of ${quoteValues(DomainsCustomTracking.SCOPE_VALUES)}.`);
 			return {
 				data: null,
 				error
@@ -1036,6 +1065,14 @@ const parseDateInputs = (options) => {
 };
 var Webhooks = class Webhooks {
 	mailchannels;
+	static STATUS_VALUES = /* @__PURE__ */ new Set([
+		"1xx",
+		"2xx",
+		"3xx",
+		"4xx",
+		"5xx",
+		"no_response"
+	]);
 	constructor(mailchannels) {
 		this.mailchannels = mailchannels;
 	}
@@ -1207,14 +1244,27 @@ var Webhooks = class Webhooks {
 			data: null,
 			error
 		};
-		if (options?.statuses && options.statuses.length > 6) return {
-			data: null,
-			error: createValidationError("A maximum of 6 status filters can be provided.")
-		};
-		if (options?.statuses && new Set(options.statuses).size !== options.statuses.length) return {
-			data: null,
-			error: createValidationError("Status filters must be unique.")
-		};
+		if (options?.statuses !== void 0) {
+			if (!Array.isArray(options.statuses)) return {
+				data: null,
+				error: createValidationError("Status filters must be an array.")
+			};
+			if (options.statuses.length > 6) return {
+				data: null,
+				error: createValidationError("A maximum of 6 status filters can be provided.")
+			};
+			if (new Set(options.statuses).size !== options.statuses.length) return {
+				data: null,
+				error: createValidationError("Status filters must be unique.")
+			};
+			if (!options.statuses.every((status) => Webhooks.STATUS_VALUES.has(status))) {
+				const validValues = quoteValues(Webhooks.STATUS_VALUES);
+				return {
+					data: null,
+					error: createValidationError(`Invalid status filter provided. Valid values are: ${validValues}.`)
+				};
+			}
+		}
 		const { dates, error: dateError } = parseDateInputs({
 			createdAfter: options?.createdAfter,
 			createdBefore: options?.createdBefore
@@ -1240,7 +1290,7 @@ var Webhooks = class Webhooks {
 			query: {
 				created_after: dates.createdAfter,
 				created_before: dates.createdBefore,
-				statuses: options?.statuses,
+				statuses: options?.statuses?.join(","),
 				webhook: options?.webhook,
 				limit: options?.limit,
 				offset: options?.offset
@@ -2030,8 +2080,16 @@ var Metrics = class {
 		};
 	}
 };
-var Suppressions = class {
+var Suppressions = class Suppressions {
 	mailchannels;
+	static SOURCE_VALUES = /* @__PURE__ */ new Set([
+		"api",
+		"unsubscribe_link",
+		"list_unsubscribe",
+		"hard_bounce",
+		"spam_complaint"
+	]);
+	static DELETE_SOURCE_VALUES = /* @__PURE__ */ new Set([...Suppressions.SOURCE_VALUES, "all"]);
 	constructor(mailchannels) {
 		this.mailchannels = mailchannels;
 	}
@@ -2072,6 +2130,13 @@ var Suppressions = class {
 	}
 	async delete(recipient, source) {
 		let error = null;
+		if (source !== void 0 && !Suppressions.DELETE_SOURCE_VALUES.has(source)) {
+			error = createValidationError(`Source must be one of ${quoteValues(Suppressions.DELETE_SOURCE_VALUES)}.`);
+			return {
+				success: false,
+				error
+			};
+		}
 		await this.mailchannels.delete(`/tx/v1/suppression-list/recipients/${encodeURIComponent(recipient)}`, {
 			query: { source },
 			onResponseError: async ({ response }) => {
@@ -2094,6 +2159,13 @@ var Suppressions = class {
 				error
 			};
 		}
+		if (options?.source !== void 0 && !Suppressions.SOURCE_VALUES.has(options.source)) {
+			error = createValidationError(`Source must be one of ${quoteValues(Suppressions.SOURCE_VALUES)}.`);
+			return {
+				data: null,
+				error
+			};
+		}
 		const { dates, error: dateError } = parseDateInputs({
 			createdBefore: options?.createdBefore,
 			createdAfter: options?.createdAfter

package/dist/plugins/nodemailer/index.d.mts

@@ -1,9 +1,9 @@
 import { EmailsQueueResponse, EmailsSendOptions, EmailsSendResponse, MailChannelsClientOptions } from "../../_chunks/mailchannels.mjs";
-import { Transport as Transport$1 } from "nodemailer";
+import { Transport, TransportOptions, Transporter } from "nodemailer";
 import MimeNode from "nodemailer/lib/mime-node";
-type MailChannelsTransportSendOptions = Pick<EmailsSendOptions, "campaignId" | "tracking" | "transactional" | "unsubscribe">;
-type MailChannelsTransportSendMode = "sync" | "async";
-interface MailChannelsTransportOptions<T extends MailChannelsTransportSendMode = "async"> extends MailChannelsClientOptions {
+export type MailChannelsTransportSendOptions = Pick<EmailsSendOptions, "campaignId" | "tracking" | "transactional" | "unsubscribe">;
+export type MailChannelsTransportSendMode = "sync" | "async";
+export interface MailChannelsTransportOptions<T extends MailChannelsTransportSendMode = "async"> extends MailChannelsClientOptions {
   /**
    * The MailChannels Email API key.
    */
@@ -14,7 +14,7 @@ interface MailChannelsTransportOptions<T extends MailChannelsTransportSendMode =
    */
   sendMode?: T;
 }
-interface MailChannelsTransportInfo<T extends MailChannelsTransportSendMode> {
+export interface MailChannelsTransportInfo<T extends MailChannelsTransportSendMode> {
   messageId: string | null;
   accepted: string[];
   rejected: string[];
@@ -22,12 +22,14 @@ interface MailChannelsTransportInfo<T extends MailChannelsTransportSendMode> {
   response: (T extends "sync" ? EmailsSendResponse : EmailsQueueResponse) | null;
 }
 declare module "nodemailer" {
-  function createTransport<T>(transport: Transport<T> | TransportOptions, defaults?: TransportOptions): Transporter<T, TransportOptions>;
+  function createTransport<T>(transport: Transport<T> | TransportOptions, defaults?: TransportOptions): Transporter<T>;
+  interface SendMailOptions {
+    mailchannels?: MailChannelsTransportSendOptions;
+  }
 }
 declare module "nodemailer/lib/mailer" {
   interface Options {
     mailchannels?: MailChannelsTransportSendOptions;
   }
 }
-declare const mailchannelsTransport: <T extends MailChannelsTransportSendMode = "async">(options: MailChannelsTransportOptions<T>) => Transport$1<MailChannelsTransportInfo<T>>;
-export { MailChannelsTransportInfo, MailChannelsTransportOptions, MailChannelsTransportSendMode, MailChannelsTransportSendOptions, mailchannelsTransport };
+export declare const mailchannelsTransport: <T extends MailChannelsTransportSendMode = "async">(options: MailChannelsTransportOptions<T>) => Transport<MailChannelsTransportInfo<T>>;

package/dist/plugins/nodemailer/index.mjs

@@ -5,9 +5,10 @@ const parseAddress = (address) => {
 	if (!address) return "";
 	if (Array.isArray(address)) return parseAddress(address[0]);
 	if (typeof address === "string") return address;
+	if (!address.address) return "";
 	return {
 		email: address.address,
-		name: address.name || void 0
+		name: address.name
 	};
 };
 const parseAddresses = (addresses) => {
@@ -41,7 +42,7 @@ const parseDkim = (dkim) => {
 	if ("keys" in dkim) throw new Error("Multiple DKIM signatures are not supported");
 	let privateKey;
 	if (typeof dkim.privateKey === "string") privateKey = dkim.privateKey;
-	else if (dkim.privateKey?.key && dkim.privateKey?.passphrase) try {
+	else if (dkim.privateKey && "key" in dkim.privateKey && "passphrase" in dkim.privateKey) try {
 		privateKey = createPrivateKey({
 			key: dkim.privateKey.key,
 			passphrase: dkim.privateKey.passphrase
@@ -62,7 +63,8 @@ const parseDkim = (dkim) => {
 const parseHeaders = (headers) => {
 	if (!headers) return;
 	if (Array.isArray(headers)) return headers.reduce((acc, { key, value }) => {
-		acc[key] = value;
+		if (value == void 0) return acc;
+		acc[key] = value.toString();
 		return acc;
 	}, {});
 	return Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, Array.isArray(value) ? value.join(",") : value && typeof value === "object" && "value" in value ? String(value.value) : String(value)]));
@@ -94,7 +96,10 @@ const mailchannelsTransport = (options) => {
 				messageId: null,
 				accepted: [],
 				rejected: [],
-				envelope: mail.message.getEnvelope(),
+				envelope: mail.message?.getEnvelope() ?? {
+					from: false,
+					to: []
+				},
 				response: null
 			};
 			mail.normalize(async (err, data) => {

package/dist/simulator/index.d.mts

@@ -1,4 +1,4 @@
-declare const createSimulator: (options?: {
+export declare const createSimulator: (options?: {
   host?: string;
   port?: number;
   silent?: boolean;
@@ -16,5 +16,4 @@ declare const createSimulator: (options?: {
     host?: string;
     port?: number;
   }): Promise<string>;
-};
-export { createSimulator };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailchannels-sdk",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "Node.js SDK to integrate MailChannels Email API into your JavaScript or TypeScript server-side applications.",
   "type": "module",
   "license": "MIT",
@@ -52,19 +52,18 @@
   "devDependencies": {
     "@stylistic/eslint-plugin": "^5.10.0",
     "@types/markdown-it": "^14.2.0",
-    "@types/node": "^26.4.0",
-    "@types/nodemailer": "^8.0.1",
-    "@vitest/coverage-v8": "^4.1.11",
+    "@types/node": "^26.5.0",
+    "@vitest/coverage-v8": "^5.0.0",
     "changelogen": "^0.6.2",
-    "nodemailer": "^9.0.6",
-    "obuild": "^0.4.38",
-    "oxlint": "^1.80.0",
+    "nodemailer": "^10.0.1",
+    "obuild": "^0.4.39",
+    "oxlint": "^1.82.0",
     "scule": "^1.3.0",
     "typescript": "^6.0.3",
-    "vitepress": "^2.0.0-alpha.19",
+    "vitepress": "^2.0.0-alpha.20",
     "vitepress-plugin-group-icons": "^1.7.6",
     "vitepress-plugin-llms": "^1.13.5",
-    "vitest": "^4.1.11"
+    "vitest": "^5.0.0"
   },
   "engines": {
     "node": ">=20"
@@ -72,7 +71,7 @@
   "scripts": {
     "build": "obuild",
     "parity:fixtures": "node scripts/generate-parity-fixtures.ts",
-    "release": "pnpm lint && pnpm test && pnpm build && changelogen --bump",
+    "release": "pnpm lint && pnpm test && pnpm build && changelogen --bump && node scripts/update-examples-sdk-version.ts",
     "cli": "pnpx jiti src/cli/index.ts",
     "simulate": "pnpx jiti src/cli/index.ts simulate",
     "lint": "oxlint",