mailchannels-sdk 0.8.0-0 → 0.8.0-1

package/dist/mailchannels.d.mts

@@ -832,6 +832,79 @@ type WebhooksValidateResponse = DataResponse<{
     } | null;
   }[];
 }>;
+type WebhookEventType = "processed" | "delivered" | "open" | "click" | "hard-bounced" | "soft-bounced" | "dropped" | "complained" | "unsubscribed" | "test";
+interface WebhookEventBase<T extends WebhookEventType> {
+  /**
+   * The sender's email address
+   */
+  email?: string;
+  /**
+   * The MailChannels account ID that generated the webhook.
+   * If the message was sent by a sub-account, this field contains the sub-account handle.
+   */
+  customer_handle: string;
+  /**
+   * The Unix timestamp (in seconds) when the event occurred; the timezone is always UTC
+   */
+  timestamp: number;
+  /**
+   * The Message-Id of the message that generated the event
+   */
+  smtp_id?: string;
+  /**
+   * The type of event that occurred
+   */
+  event: T;
+  /**
+   * A unique identifier generated to track the original HTTP request
+   */
+  request_id?: string;
+  /**
+   * The campaign identifier for the message that generated the event
+   */
+  campaign_id?: string;
+  /**
+   * The recipients of the message
+   */
+  recipients?: string[];
+}
+interface WebhookEventProcessed extends WebhookEventBase<"processed"> {}
+interface WebhookEventDelivered extends WebhookEventBase<"delivered"> {}
+interface WebhookEventWithTracking {
+  /**
+   * The User-Agent header given when the recipient opened the message
+   */
+  user_agent?: string;
+  /**
+   * The IP address of the host that made the HTTP request
+   */
+  ip?: string;
+}
+interface WebhookEventOpen extends WebhookEventBase<"open">, WebhookEventWithTracking {}
+interface WebhookEventClick extends WebhookEventBase<"click">, WebhookEventWithTracking {
+  /**
+   * The URL that was clicked by the recipient
+   */
+  url?: string;
+}
+interface WebhookEventWithStatus {
+  /**
+   * The SMTP status code that caused the bounce
+   */
+  status?: string;
+  /**
+   * A human-readable explanation of why the message hard-bounced
+   */
+  reason?: string;
+}
+interface WebhookEventHardBounced extends WebhookEventBase<"hard-bounced">, WebhookEventWithStatus {}
+interface WebhookEventSoftBounced extends WebhookEventBase<"soft-bounced">, WebhookEventWithStatus {}
+interface WebhookEventDropped extends WebhookEventBase<"dropped">, WebhookEventWithStatus {}
+interface WebhookEventComplained extends WebhookEventBase<"complained"> {}
+interface WebhookEventUnsubscribed extends WebhookEventBase<"unsubscribed"> {}
+interface WebhookEventTest extends Omit<WebhookEventBase<"test">, "recipients" | "campaign_id"> {}
+type WebhookEvent = WebhookEventProcessed | WebhookEventDelivered | WebhookEventOpen | WebhookEventClick | WebhookEventHardBounced | WebhookEventSoftBounced | WebhookEventDropped | WebhookEventComplained | WebhookEventUnsubscribed | WebhookEventTest;
+type WebhookEvents = WebhookEvent[];
 interface WebhooksVerifyOptions {
   /**
    * The raw body of the incoming webhook request as a string. This should be the exact payload received from the webhook, without any modifications or parsing, to ensure accurate signature verification.
@@ -855,6 +928,12 @@ interface WebhooksVerifyOptions {
    */
   cache?: boolean;
 }
+type WebhooksVerifyResponse = DataResponse<{
+  /**
+   * The type of event that occurred.
+   */
+  event: WebhookEventType;
+}[]>;
 type WebhooksBatchStatus = "1xx" | "2xx" | "3xx" | "4xx" | "5xx" | "no_response";
 type WebhooksBatchResponseStatus = "1xx_response" | "2xx_response" | "3xx_response" | "4xx_response" | "5xx_response" | "no_response";
 interface WebhooksBatchesOptions {
@@ -981,10 +1060,10 @@ declare class Webhooks {
    * @example
    * ```ts
    * const mailchannels = new MailChannels('your-api-key')
-   * const { success, error } = await mailchannels.webhooks.delete()
+   * const { success, error } = await mailchannels.webhooks.deleteAll()
    * ```
    */
-  delete(): Promise<SuccessResponse>;
+  deleteAll(): Promise<SuccessResponse>;
   /**
    * Retrieves the public key used to verify signatures on incoming webhook payloads.
    * @param id - The ID of the key.
@@ -1010,20 +1089,20 @@ declare class Webhooks {
    * @param options - The options for verifying the webhook.
    * @example
    * ```ts
-   * const isValid = await Webhooks.verify({ payload: rawBody, headers })
+   * const { data, error } = await Webhooks.verify({ payload: rawBody, headers })
    * ```
    */
-  static verify(options: WebhooksVerifyOptions): Promise<boolean>;
+  static verify(options: WebhooksVerifyOptions): Promise<WebhooksVerifyResponse>;
   /**
    * Verifies the authenticity of incoming webhook requests by validating their signatures using the provided options.
    * @param options - The options for verifying the webhook.
    * @example
    * ```ts
    * const mailchannels = new MailChannels('your-api-key')
-   * const isValid = await mailchannels.webhooks.verify({ payload: rawBody, headers })
+   * const { data, error } = await mailchannels.webhooks.verify({ payload: rawBody, headers })
    * ```
    */
-  verify(options: WebhooksVerifyOptions): Promise<boolean>;
+  verify(options: WebhooksVerifyOptions): Promise<WebhooksVerifyResponse>;
   /**
    * Retrieves paged webhook batches associated with the customer. The time range specified by `createdAfter` and `createdBefore` must not exceed 31 days. If neither is specified, the default time range is the last 3 days.
    * @param options - The options for listing webhook batches.
@@ -1664,79 +1743,6 @@ declare class Suppressions {
    */
   list(options?: SuppressionsListOptions): Promise<SuppressionsListResponse>;
 }
-type WebhookEventType = "processed" | "delivered" | "open" | "click" | "hard-bounced" | "soft-bounced" | "dropped" | "complained" | "unsubscribed" | "test";
-interface WebhookEventBase<T extends WebhookEventType> {
-  /**
-   * The sender's email address
-   */
-  email?: string;
-  /**
-   * The MailChannels account ID that generated the webhook.
-   * If the message was sent by a sub-account, this field contains the sub-account handle.
-   */
-  customer_handle: string;
-  /**
-   * The Unix timestamp (in seconds) when the event occurred; the timezone is always UTC
-   */
-  timestamp: number;
-  /**
-   * The Message-Id of the message that generated the event
-   */
-  smtp_id?: string;
-  /**
-   * The type of event that occurred
-   */
-  event: T;
-  /**
-   * A unique identifier generated to track the original HTTP request
-   */
-  request_id?: string;
-  /**
-   * The campaign identifier for the message that generated the event
-   */
-  campaign_id?: string;
-  /**
-   * The recipients of the message
-   */
-  recipients?: string[];
-}
-interface WebhookEventProcessed extends WebhookEventBase<"processed"> {}
-interface WebhookEventDelivered extends WebhookEventBase<"delivered"> {}
-interface WebhookEventWithTracking {
-  /**
-   * The User-Agent header given when the recipient opened the message
-   */
-  user_agent?: string;
-  /**
-   * The IP address of the host that made the HTTP request
-   */
-  ip?: string;
-}
-interface WebhookEventOpen extends WebhookEventBase<"open">, WebhookEventWithTracking {}
-interface WebhookEventClick extends WebhookEventBase<"click">, WebhookEventWithTracking {
-  /**
-   * The URL that was clicked by the recipient
-   */
-  url?: string;
-}
-interface WebhookEventWithStatus {
-  /**
-   * The SMTP status code that caused the bounce
-   */
-  status?: string;
-  /**
-   * A human-readable explanation of why the message hard-bounced
-   */
-  reason?: string;
-}
-interface WebhookEventHardBounced extends WebhookEventBase<"hard-bounced">, WebhookEventWithStatus {}
-interface WebhookEventSoftBounced extends WebhookEventBase<"soft-bounced">, WebhookEventWithStatus {}
-interface WebhookEventDropped extends WebhookEventBase<"dropped">, WebhookEventWithStatus {}
-interface WebhookEventComplained extends WebhookEventBase<"complained"> {}
-interface WebhookEventUnsubscribed extends WebhookEventBase<"unsubscribed"> {}
-interface WebhookEventTest extends Omit<WebhookEventBase<"test">, "recipients" | "campaign_id"> {}
-type WebhookEvent = WebhookEventProcessed | WebhookEventDelivered | WebhookEventOpen | WebhookEventClick | WebhookEventHardBounced | WebhookEventSoftBounced | WebhookEventDropped | WebhookEventComplained | WebhookEventUnsubscribed | WebhookEventTest;
-type WebhookEvents = WebhookEvent[];
 declare class MailChannels extends MailChannelsClient {
   readonly emails: Emails;
   readonly domains: Domains;
@@ -1746,4 +1752,4 @@ declare class MailChannels extends MailChannelsClient {
   readonly suppressions: Suppressions;
   constructor(key: string, options?: MailChannelsClientOptions);
 }
-export { DataResponse, Domains, DomainsCheckOptions, DomainsCheckResponse, DomainsCheckVerdict, DomainsDkimCreateOptions, DomainsDkimCreateResponse, DomainsDkimKey, DomainsDkimKeyStatus, DomainsDkimListOptions, DomainsDkimListResponse, DomainsDkimRotateOptions, DomainsDkimRotateResponse, DomainsDkimUpdateOptions, Emails, EmailsSendAsyncResponse, EmailsSendAttachment, EmailsSendContent, EmailsSendDkim, EmailsSendOptions, EmailsSendPersonalization, EmailsSendRecipient, EmailsSendRecipientInput, EmailsSendResponse, EmailsSendTemplate, EmailsSendTemplateType, EmailsSendTemplateValue, EmailsSendTracking, ErrorResponse, MailChannels, MailChannelsClient, MailChannelsClientOptions, Metrics, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, SubAccounts, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, Suppressions, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, WebhookEvent, WebhookEventClick, WebhookEventComplained, WebhookEventDelivered, WebhookEventDropped, WebhookEventHardBounced, WebhookEventOpen, WebhookEventProcessed, WebhookEventSoftBounced, WebhookEventTest, WebhookEventType, WebhookEventUnsubscribed, WebhookEvents, Webhooks, WebhooksBatch, WebhooksBatchResponseStatus, WebhooksBatchStatus, WebhooksBatchesOptions, WebhooksBatchesResponse, WebhooksListResponse, WebhooksResendBatch, WebhooksResendBatchResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse, WebhooksVerifyOptions };
+export { DataResponse, Domains, DomainsCheckOptions, DomainsCheckResponse, DomainsCheckVerdict, DomainsDkimCreateOptions, DomainsDkimCreateResponse, DomainsDkimKey, DomainsDkimKeyStatus, DomainsDkimListOptions, DomainsDkimListResponse, DomainsDkimRotateOptions, DomainsDkimRotateResponse, DomainsDkimUpdateOptions, Emails, EmailsSendAsyncResponse, EmailsSendAttachment, EmailsSendContent, EmailsSendDkim, EmailsSendOptions, EmailsSendPersonalization, EmailsSendRecipient, EmailsSendRecipientInput, EmailsSendResponse, EmailsSendTemplate, EmailsSendTemplateType, EmailsSendTemplateValue, EmailsSendTracking, ErrorResponse, MailChannels, MailChannelsClient, MailChannelsClientOptions, Metrics, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, SubAccounts, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, Suppressions, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, WebhookEvent, WebhookEventClick, WebhookEventComplained, WebhookEventDelivered, WebhookEventDropped, WebhookEventHardBounced, WebhookEventOpen, WebhookEventProcessed, WebhookEventSoftBounced, WebhookEventTest, WebhookEventType, WebhookEventUnsubscribed, WebhookEvents, Webhooks, WebhooksBatch, WebhooksBatchResponseStatus, WebhooksBatchStatus, WebhooksBatchesOptions, WebhooksBatchesResponse, WebhooksListResponse, WebhooksResendBatch, WebhooksResendBatchResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse, WebhooksVerifyOptions, WebhooksVerifyResponse };

package/dist/mailchannels.mjs

@@ -1,7 +1,7 @@
 import { $fetch } from "ofetch";
 import { subtle } from "node:crypto";
 import { Buffer } from "node:buffer";
-var version = "0.8.0-0";
+var version = "0.8.0-1";
 var MailChannelsClient = class MailChannelsClient {
 	static DEFAULT_BASE_URL = "https://api.mailchannels.net";
 	options;
@@ -733,7 +733,7 @@ var Webhooks = class Webhooks {
 			error: null
 		};
 	}
-	async delete() {
+	async deleteAll() {
 		let error = null;
 		await this.mailchannels.delete("/tx/v1/webhook", { onResponseError: async ({ response }) => {
 			error = getStatusError(response);
@@ -805,7 +805,34 @@ var Webhooks = class Webhooks {
 		};
 	}
 	static async verify(options) {
-		return isValidWebhook(options).catch(() => false);
+		let error = null;
+		if (!await isValidWebhook(options).catch(() => false)) {
+			error = createError("Invalid webhook signature.");
+			return {
+				data: null,
+				error
+			};
+		}
+		try {
+			const payload = JSON.parse(options.payload);
+			if (!Array.isArray(payload)) {
+				error = createError("Invalid webhook payload.");
+				return {
+					data: null,
+					error
+				};
+			}
+			return {
+				data: clean(payload.map((event) => ({ event: event.event }))),
+				error: null
+			};
+		} catch {
+			error = createError("Invalid webhook payload.");
+			return {
+				data: null,
+				error
+			};
+		}
 	}
 	async verify(options) {
 		return Webhooks.verify(options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailchannels-sdk",
-  "version": "0.8.0-0",
+  "version": "0.8.0-1",
   "description": "Node.js SDK to integrate MailChannels Email API into your JavaScript or TypeScript server-side applications.",
   "type": "module",
   "license": "MIT",
@@ -47,7 +47,7 @@
     "@vitest/coverage-v8": "^4.1.6",
     "changelogen": "^0.6.2",
     "obuild": "^0.4.35",
-    "oxlint": "^1.64.0",
+    "oxlint": "^1.65.0",
     "scule": "^1.3.0",
     "typescript": "^6.0.3",
     "vitepress": "^2.0.0-alpha.17",