@mailhooks/sdk 1.1.3 → 2.0.1

package/dist/index.d.ts

@@ -1,7 +1,273 @@
-export { Mailhooks } from './mailhooks';
-export { EmailsResource } from './resources/emails';
-export * from './types';
-export { verifyWebhookSignature, parseWebhookPayload, constructSignature, type WebhookPayload, } from './webhooks';
-import { Mailhooks } from './mailhooks';
-export default Mailhooks;
-//# sourceMappingURL=index.d.ts.map
+import { AxiosInstance } from 'axios';
+
+interface Attachment {
+    id: string;
+    filename: string;
+    contentType: string;
+    size: number;
+}
+interface Email {
+    id: string;
+    from: string;
+    to: string[];
+    subject: string;
+    read: boolean;
+    createdAt: Date;
+    attachments: Attachment[];
+}
+interface EmailContent {
+    html?: string;
+    text?: string;
+}
+interface PaginationResponse {
+    currentPage: number;
+    perPage: number;
+    totalItems: number;
+    totalPages: number;
+    hasNextPage: boolean;
+    nextCursor?: string;
+}
+interface EmailsResponse extends PaginationResponse {
+    data: Email[];
+}
+interface EmailFilter {
+    from?: string;
+    to?: string;
+    subject?: string;
+    startDate?: string;
+    endDate?: string;
+    read?: boolean;
+}
+interface EmailSort {
+    field?: 'createdAt' | 'from' | 'subject';
+    order?: 'asc' | 'desc';
+}
+interface EmailListParams {
+    page?: number;
+    perPage?: number;
+    filter?: EmailFilter;
+    sort?: EmailSort;
+}
+interface MailhooksConfig {
+    apiKey: string;
+    baseUrl?: string;
+}
+interface DownloadResponse {
+    data: ArrayBuffer;
+    filename?: string;
+    contentType?: string;
+}
+interface WaitForOptions {
+    filter?: EmailFilter;
+    timeout?: number;
+    pollInterval?: number;
+    maxRetries?: number;
+    initialDelay?: number;
+    lookbackWindow?: number;
+}
+
+declare class MailhooksClient {
+    private http;
+    constructor(config: MailhooksConfig);
+    private parseDates;
+    protected get<T>(path: string, params?: Record<string, any>): Promise<T>;
+    protected post<T>(path: string, data?: any): Promise<T>;
+    protected put<T>(path: string, data?: any): Promise<T>;
+    protected patch<T>(path: string, data?: any): Promise<T>;
+    protected delete<T>(path: string): Promise<T>;
+    protected downloadFile(path: string): Promise<ArrayBuffer>;
+    protected getAxiosInstance(): AxiosInstance;
+}
+
+declare class EmailsResource extends MailhooksClient {
+    /**
+     * Get a paginated list of emails
+     */
+    list(params?: EmailListParams): Promise<EmailsResponse>;
+    /**
+     * Get a specific email by ID
+     * @param emailId - The ID of the email to retrieve
+     * @param markAsRead - Optional: Mark the email as read when fetching (default: false)
+     */
+    getEmail(emailId: string, markAsRead?: boolean): Promise<Email>;
+    /**
+     * Get the HTML and text content of an email
+     */
+    getContent(emailId: string): Promise<EmailContent>;
+    /**
+     * Download email in EML format
+     */
+    downloadEml(emailId: string): Promise<DownloadResponse>;
+    /**
+     * Download a specific attachment from an email
+     */
+    downloadAttachment(emailId: string, attachmentId: string): Promise<DownloadResponse>;
+    /**
+     * Mark an email as read
+     */
+    markAsRead(emailId: string): Promise<Email>;
+    /**
+     * Mark an email as unread
+     */
+    markAsUnread(emailId: string): Promise<Email>;
+    /**
+     * Wait for an email that matches the given filters
+     *
+     * @param options - Options for waiting including filters, timeouts, and delays
+     * @returns The first email that matches the filters
+     * @throws Error if timeout is reached or max retries exceeded
+     *
+     * @example
+     * // Wait for an email from a specific sender (only considers emails from last 10 seconds)
+     * const email = await mailhooks.emails.waitFor({
+     *   filter: { from: 'test@example.com' },
+     *   timeout: 30000, // 30 seconds
+     *   pollInterval: 2000, // Check every 2 seconds
+     *   lookbackWindow: 10000, // Only consider emails from last 10 seconds
+     * });
+     *
+     * @example
+     * // Wait with initial delay (useful when you know email will take time)
+     * const email = await mailhooks.emails.waitFor({
+     *   filter: { subject: 'Order Confirmation' },
+     *   initialDelay: 5000, // Wait 5 seconds before first check
+     *   timeout: 60000,
+     *   lookbackWindow: 5000, // Only consider very recent emails
+     * });
+     */
+    waitFor(options?: WaitForOptions): Promise<Email>;
+}
+
+declare class Mailhooks {
+    emails: EmailsResource;
+    constructor(config: MailhooksConfig);
+    /**
+     * Create a new Mailhooks SDK instance
+     */
+    static create(config: MailhooksConfig): Mailhooks;
+}
+
+/**
+ * Webhook payload sent by Mailhooks when an email is received.
+ */
+interface WebhookPayload {
+    /** Unique email ID */
+    id: string;
+    /** Sender email address */
+    from: string;
+    /** Array of recipient email addresses */
+    to: string[];
+    /** Email subject line */
+    subject: string;
+    /** Plain text body of the email */
+    body: string;
+    /** HTML body of the email (if available) */
+    html?: string;
+    /** Array of attachment metadata */
+    attachments: Array<{
+        filename: string;
+        contentType: string;
+        size: number;
+    }>;
+    /** ISO 8601 timestamp when the email was received */
+    receivedAt: string;
+    /** SPF authentication result */
+    spfResult?: 'pass' | 'fail' | 'softfail' | 'neutral' | 'none';
+    /** DKIM authentication result */
+    dkimResult?: 'pass' | 'fail' | 'none' | 'temperror' | 'permerror';
+    /** DMARC authentication result */
+    dmarcResult?: 'pass' | 'fail' | 'none' | 'temperror' | 'permerror';
+    /** Overall authentication summary */
+    authSummary?: 'pass' | 'fail' | 'partial';
+    /** Email headers as key-value pairs */
+    headers?: Record<string, string>;
+    /** Authentication diagnostic details */
+    authDiagnostics?: {
+        spf: {
+            clientIp: string;
+            domain: string;
+            record?: string;
+            helo?: string;
+        } | null;
+        dkim: Array<{
+            domain: string;
+            selector?: string;
+            algorithm?: string;
+            aligned?: boolean;
+            result: string;
+        }>;
+        dmarc: {
+            domain: string;
+            policy: string;
+            record?: string;
+            alignment: {
+                spf: {
+                    result: string | false;
+                    strict: boolean;
+                };
+                dkim: {
+                    result: string | false;
+                    strict: boolean;
+                };
+            };
+        } | null;
+    };
+}
+/**
+ * Verifies a webhook signature using HMAC-SHA256.
+ *
+ * Each webhook request from Mailhooks includes an `X-Webhook-Signature` header
+ * containing a hex-encoded HMAC-SHA256 signature of the request body.
+ *
+ * @param payload - The raw request body as a string or Buffer
+ * @param signature - The signature from the `X-Webhook-Signature` header
+ * @param secret - Your webhook secret (starts with `whsec_`)
+ * @returns `true` if the signature is valid, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * import { verifyWebhookSignature } from '@mailhooks/sdk';
+ *
+ * // Express.js with raw body parser
+ * app.post('/webhook', express.raw({ type: 'application/json' }), (req, res) => {
+ *   const signature = req.headers['x-webhook-signature'] as string;
+ *   const payload = req.body.toString();
+ *
+ *   if (!verifyWebhookSignature(payload, signature, process.env.WEBHOOK_SECRET!)) {
+ *     return res.status(401).send('Invalid signature');
+ *   }
+ *
+ *   const event = JSON.parse(payload);
+ *   // Process the webhook...
+ *   res.status(200).send('OK');
+ * });
+ * ```
+ */
+declare function verifyWebhookSignature(payload: string | Buffer, signature: string, secret: string): boolean;
+/**
+ * Parses a webhook payload from a JSON string.
+ *
+ * @param body - The raw request body as a string
+ * @returns The parsed webhook payload
+ * @throws {SyntaxError} If the body is not valid JSON
+ *
+ * @example
+ * ```typescript
+ * import { parseWebhookPayload } from '@mailhooks/sdk';
+ *
+ * const payload = parseWebhookPayload(req.body.toString());
+ * console.log(`Received email from ${payload.from}: ${payload.subject}`);
+ * ```
+ */
+declare function parseWebhookPayload(body: string): WebhookPayload;
+/**
+ * Constructs the expected signature for a webhook payload.
+ * Useful for debugging or manual verification.
+ *
+ * @param payload - The raw request body as a string or Buffer
+ * @param secret - Your webhook secret
+ * @returns The expected HMAC-SHA256 signature as a hex string
+ */
+declare function constructSignature(payload: string | Buffer, secret: string): string;
+
+export { type Attachment, type DownloadResponse, type Email, type EmailContent, type EmailFilter, type EmailListParams, type EmailSort, EmailsResource, type EmailsResponse, Mailhooks, type MailhooksConfig, type PaginationResponse, type WaitForOptions, type WebhookPayload, constructSignature, Mailhooks as default, parseWebhookPayload, verifyWebhookSignature };

package/dist/index.js

@@ -1,30 +1,280 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
+import axios from 'axios';
+import { createHmac, timingSafeEqual } from 'crypto';
+
+// src/client.ts
+var MailhooksClient = class {
+  constructor(config) {
+    this.http = axios.create({
+      baseURL: config.baseUrl ?? "https://mailhooks.dev/api",
+      headers: {
+        "x-api-key": config.apiKey,
+        "Content-Type": "application/json"
+      }
+    });
+    this.http.interceptors.response.use((response) => {
+      if (response.data) {
+        this.parseDates(response.data);
+      }
+      return response;
+    });
+  }
+  parseDates(obj) {
+    if (obj && typeof obj === "object") {
+      if (Array.isArray(obj)) {
+        obj.forEach((item) => this.parseDates(item));
+      } else {
+        Object.keys(obj).forEach((key) => {
+          if (key === "createdAt" || key === "updatedAt") {
+            if (typeof obj[key] === "string") {
+              obj[key] = new Date(obj[key]);
+            }
+          } else if (typeof obj[key] === "object") {
+            this.parseDates(obj[key]);
+          }
+        });
+      }
     }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+  }
+  async get(path, params) {
+    const response = await this.http.get(path, { params });
+    return response.data;
+  }
+  async post(path, data) {
+    const response = await this.http.post(path, data);
+    return response.data;
+  }
+  async put(path, data) {
+    const response = await this.http.put(path, data);
+    return response.data;
+  }
+  async patch(path, data) {
+    const response = await this.http.patch(path, data);
+    return response.data;
+  }
+  async delete(path) {
+    const response = await this.http.delete(path);
+    return response.data;
+  }
+  async downloadFile(path) {
+    const response = await this.http.get(path, {
+      responseType: "arraybuffer"
+    });
+    return response.data;
+  }
+  getAxiosInstance() {
+    return this.http;
+  }
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.constructSignature = exports.parseWebhookPayload = exports.verifyWebhookSignature = exports.EmailsResource = exports.Mailhooks = void 0;
-var mailhooks_1 = require("./mailhooks");
-Object.defineProperty(exports, "Mailhooks", { enumerable: true, get: function () { return mailhooks_1.Mailhooks; } });
-var emails_1 = require("./resources/emails");
-Object.defineProperty(exports, "EmailsResource", { enumerable: true, get: function () { return emails_1.EmailsResource; } });
-__exportStar(require("./types"), exports);
-// Webhook verification utilities
-var webhooks_1 = require("./webhooks");
-Object.defineProperty(exports, "verifyWebhookSignature", { enumerable: true, get: function () { return webhooks_1.verifyWebhookSignature; } });
-Object.defineProperty(exports, "parseWebhookPayload", { enumerable: true, get: function () { return webhooks_1.parseWebhookPayload; } });
-Object.defineProperty(exports, "constructSignature", { enumerable: true, get: function () { return webhooks_1.constructSignature; } });
-// Default export for convenience
-const mailhooks_2 = require("./mailhooks");
-exports.default = mailhooks_2.Mailhooks;
+
+// src/resources/emails.ts
+var EmailsResource = class extends MailhooksClient {
+  /**
+   * Get a paginated list of emails
+   */
+  async list(params) {
+    const queryParams = {
+      page: params?.page || 1,
+      perPage: params?.perPage || 20
+    };
+    if (params?.filter) {
+      if (params.filter.from) queryParams["filter.from"] = params.filter.from;
+      if (params.filter.to) queryParams["filter.to"] = params.filter.to;
+      if (params.filter.subject) queryParams["filter.subject"] = params.filter.subject;
+      if (params.filter.startDate) queryParams["filter.createdAfter"] = params.filter.startDate;
+      if (params.filter.endDate) queryParams["filter.createdBefore"] = params.filter.endDate;
+      if (params.filter.read !== void 0) queryParams["filter.read"] = String(params.filter.read);
+    }
+    if (params?.sort) {
+      if (params.sort.field) queryParams["sort[field]"] = params.sort.field;
+      if (params.sort.order) queryParams["sort[order]"] = params.sort.order;
+    }
+    return super.get("/v1/emails", queryParams);
+  }
+  /**
+   * Get a specific email by ID
+   * @param emailId - The ID of the email to retrieve
+   * @param markAsRead - Optional: Mark the email as read when fetching (default: false)
+   */
+  async getEmail(emailId, markAsRead = false) {
+    const params = markAsRead ? { markAsRead: "true" } : void 0;
+    return super.get(`/v1/emails/${emailId}`, params);
+  }
+  /**
+   * Get the HTML and text content of an email
+   */
+  async getContent(emailId) {
+    return super.get(`/v1/emails/${emailId}/content`);
+  }
+  /**
+   * Download email in EML format
+   */
+  async downloadEml(emailId) {
+    const data = await this.downloadFile(`/v1/emails/${emailId}/eml`);
+    return {
+      data,
+      filename: `email-${emailId}.eml`,
+      contentType: "message/rfc822"
+    };
+  }
+  /**
+   * Download a specific attachment from an email
+   */
+  async downloadAttachment(emailId, attachmentId) {
+    const axios2 = this.getAxiosInstance();
+    const response = await axios2.get(
+      `/v1/emails/${emailId}/attachments/${attachmentId}`,
+      {
+        responseType: "arraybuffer"
+      }
+    );
+    const contentDisposition = response.headers["content-disposition"];
+    const filename = contentDisposition ? contentDisposition.split("filename=")[1]?.replace(/['"]/g, "") : `attachment-${attachmentId}`;
+    return {
+      data: response.data,
+      filename,
+      contentType: response.headers["content-type"]
+    };
+  }
+  /**
+   * Mark an email as read
+   */
+  async markAsRead(emailId) {
+    return super.patch(`/v1/emails/${emailId}/read`);
+  }
+  /**
+   * Mark an email as unread
+   */
+  async markAsUnread(emailId) {
+    return super.patch(`/v1/emails/${emailId}/unread`);
+  }
+  /**
+   * Wait for an email that matches the given filters
+   * 
+   * @param options - Options for waiting including filters, timeouts, and delays
+   * @returns The first email that matches the filters
+   * @throws Error if timeout is reached or max retries exceeded
+   * 
+   * @example
+   * // Wait for an email from a specific sender (only considers emails from last 10 seconds)
+   * const email = await mailhooks.emails.waitFor({
+   *   filter: { from: 'test@example.com' },
+   *   timeout: 30000, // 30 seconds
+   *   pollInterval: 2000, // Check every 2 seconds
+   *   lookbackWindow: 10000, // Only consider emails from last 10 seconds
+   * });
+   * 
+   * @example
+   * // Wait with initial delay (useful when you know email will take time)
+   * const email = await mailhooks.emails.waitFor({
+   *   filter: { subject: 'Order Confirmation' },
+   *   initialDelay: 5000, // Wait 5 seconds before first check
+   *   timeout: 60000,
+   *   lookbackWindow: 5000, // Only consider very recent emails
+   * });
+   */
+  async waitFor(options = {}) {
+    const {
+      filter = {},
+      timeout = 3e4,
+      // Default 30 seconds
+      pollInterval = 1e3,
+      // Default poll every 1 second
+      maxRetries = null,
+      initialDelay = 0,
+      lookbackWindow = 1e4
+      // Default 10 seconds lookback
+    } = options;
+    const startTime = Date.now();
+    let retries = 0;
+    let lastCheckedTime = null;
+    const checkForEmail = async (isFirstCheck = false) => {
+      try {
+        const now = /* @__PURE__ */ new Date();
+        let startDateFilter;
+        if (isFirstCheck && lookbackWindow) {
+          startDateFilter = new Date(now.getTime() - lookbackWindow).toISOString();
+        } else if (lastCheckedTime) {
+          startDateFilter = lastCheckedTime.toISOString();
+        } else {
+          startDateFilter = new Date(now.getTime() - lookbackWindow).toISOString();
+        }
+        const searchFilter = {
+          ...filter,
+          startDate: startDateFilter
+        };
+        const response = await this.list({
+          filter: searchFilter,
+          perPage: 10,
+          sort: { field: "createdAt", order: "desc" }
+        });
+        lastCheckedTime = now;
+        if (response.data.length > 0) {
+          return response.data[0];
+        }
+        return null;
+      } catch (error) {
+        console.warn("Error checking for email:", error);
+        return null;
+      }
+    };
+    const existingEmail = await checkForEmail(true);
+    if (existingEmail) {
+      return existingEmail;
+    }
+    if (initialDelay > 0) {
+      await new Promise((resolve) => setTimeout(resolve, initialDelay));
+    }
+    while (true) {
+      if (timeout && Date.now() - startTime > timeout) {
+        throw new Error(`Timeout waiting for email after ${timeout}ms`);
+      }
+      if (maxRetries !== null && retries >= maxRetries) {
+        throw new Error(`Max retries (${maxRetries}) exceeded waiting for email`);
+      }
+      const email = await checkForEmail();
+      if (email) {
+        return email;
+      }
+      await new Promise((resolve) => setTimeout(resolve, pollInterval));
+      retries++;
+    }
+  }
+};
+
+// src/mailhooks.ts
+var Mailhooks = class _Mailhooks {
+  constructor(config) {
+    this.emails = new EmailsResource(config);
+  }
+  /**
+   * Create a new Mailhooks SDK instance
+   */
+  static create(config) {
+    return new _Mailhooks(config);
+  }
+};
+function verifyWebhookSignature(payload, signature, secret) {
+  if (!payload || !signature || !secret) {
+    return false;
+  }
+  const normalizedSignature = signature.trim().toLowerCase();
+  if (!/^[a-f0-9]{64}$/.test(normalizedSignature)) {
+    return false;
+  }
+  const expectedSignature = createHmac("sha256", secret).update(payload).digest("hex");
+  return timingSafeEqual(
+    Buffer.from(normalizedSignature, "hex"),
+    Buffer.from(expectedSignature, "hex")
+  );
+}
+function parseWebhookPayload(body) {
+  return JSON.parse(body);
+}
+function constructSignature(payload, secret) {
+  return createHmac("sha256", secret).update(payload).digest("hex");
+}
+
+// src/index.ts
+var index_default = Mailhooks;
+
+export { EmailsResource, Mailhooks, constructSignature, index_default as default, parseWebhookPayload, verifyWebhookSignature };

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@mailhooks/sdk",
-  "version": "1.1.3",
+  "version": "2.0.1",
   "description": "TypeScript SDK for Mailhooks API",
   "publishConfig": {
     "access": "public"
   },
+  "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "tsc -p .",
+    "build": "tsup",
     "dev": "tsc -p . --watch",
     "test": "echo \"No tests yet\"",
     "prepublishOnly": "pnpm build"
@@ -26,6 +27,7 @@
   "devDependencies": {
     "@types/node": "^20.19.0",
     "dotenv": "^17.2.1",
+    "tsup": "^8.5.1",
     "typescript": "^5.4.5"
   },
   "files": [
@@ -33,9 +35,9 @@
   ],
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "default": "./dist/index.js"
     }
   }
 }

package/dist/client.d.ts

@@ -1,15 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { MailhooksConfig } from './types';
-export declare class MailhooksClient {
-    private http;
-    constructor(config: MailhooksConfig);
-    private parseDates;
-    protected get<T>(path: string, params?: Record<string, any>): Promise<T>;
-    protected post<T>(path: string, data?: any): Promise<T>;
-    protected put<T>(path: string, data?: any): Promise<T>;
-    protected patch<T>(path: string, data?: any): Promise<T>;
-    protected delete<T>(path: string): Promise<T>;
-    protected downloadFile(path: string): Promise<ArrayBuffer>;
-    protected getAxiosInstance(): AxiosInstance;
-}
-//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,qBAAa,eAAe;IAC1B,OAAO,CAAC,IAAI,CAAgB;gBAEhB,MAAM,EAAE,eAAe;IAkBnC,OAAO,CAAC,UAAU;cAkBF,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;cAK9D,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;cAK7C,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;cAK5C,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;cAK9C,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;cAKnC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOhE,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAG5C"}

package/dist/client.js

@@ -1,74 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MailhooksClient = void 0;
-const axios_1 = __importDefault(require("axios"));
-class MailhooksClient {
-    constructor(config) {
-        this.http = axios_1.default.create({
-            baseURL: config.baseUrl ?? 'https://mailhooks.dev/api',
-            headers: {
-                'x-api-key': config.apiKey,
-                'Content-Type': 'application/json',
-            },
-        });
-        // Response interceptor to handle date parsing
-        this.http.interceptors.response.use((response) => {
-            if (response.data) {
-                this.parseDates(response.data);
-            }
-            return response;
-        });
-    }
-    parseDates(obj) {
-        if (obj && typeof obj === 'object') {
-            if (Array.isArray(obj)) {
-                obj.forEach(item => this.parseDates(item));
-            }
-            else {
-                Object.keys(obj).forEach(key => {
-                    if (key === 'createdAt' || key === 'updatedAt') {
-                        if (typeof obj[key] === 'string') {
-                            obj[key] = new Date(obj[key]);
-                        }
-                    }
-                    else if (typeof obj[key] === 'object') {
-                        this.parseDates(obj[key]);
-                    }
-                });
-            }
-        }
-    }
-    async get(path, params) {
-        const response = await this.http.get(path, { params });
-        return response.data;
-    }
-    async post(path, data) {
-        const response = await this.http.post(path, data);
-        return response.data;
-    }
-    async put(path, data) {
-        const response = await this.http.put(path, data);
-        return response.data;
-    }
-    async patch(path, data) {
-        const response = await this.http.patch(path, data);
-        return response.data;
-    }
-    async delete(path) {
-        const response = await this.http.delete(path);
-        return response.data;
-    }
-    async downloadFile(path) {
-        const response = await this.http.get(path, {
-            responseType: 'arraybuffer',
-        });
-        return response.data;
-    }
-    getAxiosInstance() {
-        return this.http;
-    }
-}
-exports.MailhooksClient = MailhooksClient;

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,cAAc,SAAS,CAAC;AAGxB,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,KAAK,cAAc,GACpB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,eAAe,SAAS,CAAC"}

package/dist/mailhooks.d.ts

@@ -1,11 +0,0 @@
-import { MailhooksConfig } from './types';
-import { EmailsResource } from './resources/emails';
-export declare class Mailhooks {
-    emails: EmailsResource;
-    constructor(config: MailhooksConfig);
-    /**
-     * Create a new Mailhooks SDK instance
-     */
-    static create(config: MailhooksConfig): Mailhooks;
-}
-//# sourceMappingURL=mailhooks.d.ts.map

package/dist/mailhooks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mailhooks.d.ts","sourceRoot":"","sources":["../src/mailhooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,qBAAa,SAAS;IACb,MAAM,EAAE,cAAc,CAAC;gBAElB,MAAM,EAAE,eAAe;IAInC;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS;CAGlD"}

package/dist/mailhooks.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Mailhooks = void 0;
-const emails_1 = require("./resources/emails");
-class Mailhooks {
-    constructor(config) {
-        this.emails = new emails_1.EmailsResource(config);
-    }
-    /**
-     * Create a new Mailhooks SDK instance
-     */
-    static create(config) {
-        return new Mailhooks(config);
-    }
-}
-exports.Mailhooks = Mailhooks;

package/dist/resources/emails.d.ts

@@ -1,61 +0,0 @@
-import { MailhooksClient } from '../client';
-import { Email, EmailContent, EmailsResponse, EmailListParams, DownloadResponse, WaitForOptions } from '../types';
-export declare class EmailsResource extends MailhooksClient {
-    /**
-     * Get a paginated list of emails
-     */
-    list(params?: EmailListParams): Promise<EmailsResponse>;
-    /**
-     * Get a specific email by ID
-     * @param emailId - The ID of the email to retrieve
-     * @param markAsRead - Optional: Mark the email as read when fetching (default: false)
-     */
-    getEmail(emailId: string, markAsRead?: boolean): Promise<Email>;
-    /**
-     * Get the HTML and text content of an email
-     */
-    getContent(emailId: string): Promise<EmailContent>;
-    /**
-     * Download email in EML format
-     */
-    downloadEml(emailId: string): Promise<DownloadResponse>;
-    /**
-     * Download a specific attachment from an email
-     */
-    downloadAttachment(emailId: string, attachmentId: string): Promise<DownloadResponse>;
-    /**
-     * Mark an email as read
-     */
-    markAsRead(emailId: string): Promise<Email>;
-    /**
-     * Mark an email as unread
-     */
-    markAsUnread(emailId: string): Promise<Email>;
-    /**
-     * Wait for an email that matches the given filters
-     *
-     * @param options - Options for waiting including filters, timeouts, and delays
-     * @returns The first email that matches the filters
-     * @throws Error if timeout is reached or max retries exceeded
-     *
-     * @example
-     * // Wait for an email from a specific sender (only considers emails from last 10 seconds)
-     * const email = await mailhooks.emails.waitFor({
-     *   filter: { from: 'test@example.com' },
-     *   timeout: 30000, // 30 seconds
-     *   pollInterval: 2000, // Check every 2 seconds
-     *   lookbackWindow: 10000, // Only consider emails from last 10 seconds
-     * });
-     *
-     * @example
-     * // Wait with initial delay (useful when you know email will take time)
-     * const email = await mailhooks.emails.waitFor({
-     *   filter: { subject: 'Order Confirmation' },
-     *   initialDelay: 5000, // Wait 5 seconds before first check
-     *   timeout: 60000,
-     *   lookbackWindow: 5000, // Only consider very recent emails
-     * });
-     */
-    waitFor(options?: WaitForOptions): Promise<Email>;
-}
-//# sourceMappingURL=emails.d.ts.map

package/dist/resources/emails.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"emails.d.ts","sourceRoot":"","sources":["../../src/resources/emails.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EACL,KAAK,EACL,YAAY,EACZ,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,cAAc,EACf,MAAM,UAAU,CAAC;AAElB,qBAAa,cAAe,SAAQ,eAAe;IACjD;;OAEG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IA0B7D;;;;OAIG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,KAAK,CAAC;IAK5E;;OAEG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxD;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAS7D;;OAEG;IACG,kBAAkB,CACtB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,gBAAgB,CAAC;IAqB5B;;OAEG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAIjD;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAInD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,KAAK,CAAC;CA8F5D"}

package/dist/resources/emails.js

@@ -1,200 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmailsResource = void 0;
-const client_1 = require("../client");
-class EmailsResource extends client_1.MailhooksClient {
-    /**
-     * Get a paginated list of emails
-     */
-    async list(params) {
-        // Set defaults
-        const queryParams = {
-            page: params?.page || 1,
-            perPage: params?.perPage || 20,
-        };
-        // Handle filter params
-        if (params?.filter) {
-            if (params.filter.from)
-                queryParams['filter.from'] = params.filter.from;
-            if (params.filter.to)
-                queryParams['filter.to'] = params.filter.to;
-            if (params.filter.subject)
-                queryParams['filter.subject'] = params.filter.subject;
-            if (params.filter.startDate)
-                queryParams['filter.createdAfter'] = params.filter.startDate;
-            if (params.filter.endDate)
-                queryParams['filter.createdBefore'] = params.filter.endDate;
-            if (params.filter.read !== undefined)
-                queryParams['filter.read'] = String(params.filter.read);
-        }
-        // Handle sort params
-        if (params?.sort) {
-            if (params.sort.field)
-                queryParams['sort[field]'] = params.sort.field;
-            if (params.sort.order)
-                queryParams['sort[order]'] = params.sort.order;
-        }
-        return super.get('/v1/emails', queryParams);
-    }
-    /**
-     * Get a specific email by ID
-     * @param emailId - The ID of the email to retrieve
-     * @param markAsRead - Optional: Mark the email as read when fetching (default: false)
-     */
-    async getEmail(emailId, markAsRead = false) {
-        const params = markAsRead ? { markAsRead: 'true' } : undefined;
-        return super.get(`/v1/emails/${emailId}`, params);
-    }
-    /**
-     * Get the HTML and text content of an email
-     */
-    async getContent(emailId) {
-        return super.get(`/v1/emails/${emailId}/content`);
-    }
-    /**
-     * Download email in EML format
-     */
-    async downloadEml(emailId) {
-        const data = await this.downloadFile(`/v1/emails/${emailId}/eml`);
-        return {
-            data,
-            filename: `email-${emailId}.eml`,
-            contentType: 'message/rfc822',
-        };
-    }
-    /**
-     * Download a specific attachment from an email
-     */
-    async downloadAttachment(emailId, attachmentId) {
-        const axios = this.getAxiosInstance();
-        const response = await axios.get(`/v1/emails/${emailId}/attachments/${attachmentId}`, {
-            responseType: 'arraybuffer',
-        });
-        const contentDisposition = response.headers['content-disposition'];
-        const filename = contentDisposition
-            ? contentDisposition.split('filename=')[1]?.replace(/['"]/g, '')
-            : `attachment-${attachmentId}`;
-        return {
-            data: response.data,
-            filename,
-            contentType: response.headers['content-type'],
-        };
-    }
-    /**
-     * Mark an email as read
-     */
-    async markAsRead(emailId) {
-        return super.patch(`/v1/emails/${emailId}/read`);
-    }
-    /**
-     * Mark an email as unread
-     */
-    async markAsUnread(emailId) {
-        return super.patch(`/v1/emails/${emailId}/unread`);
-    }
-    /**
-     * Wait for an email that matches the given filters
-     *
-     * @param options - Options for waiting including filters, timeouts, and delays
-     * @returns The first email that matches the filters
-     * @throws Error if timeout is reached or max retries exceeded
-     *
-     * @example
-     * // Wait for an email from a specific sender (only considers emails from last 10 seconds)
-     * const email = await mailhooks.emails.waitFor({
-     *   filter: { from: 'test@example.com' },
-     *   timeout: 30000, // 30 seconds
-     *   pollInterval: 2000, // Check every 2 seconds
-     *   lookbackWindow: 10000, // Only consider emails from last 10 seconds
-     * });
-     *
-     * @example
-     * // Wait with initial delay (useful when you know email will take time)
-     * const email = await mailhooks.emails.waitFor({
-     *   filter: { subject: 'Order Confirmation' },
-     *   initialDelay: 5000, // Wait 5 seconds before first check
-     *   timeout: 60000,
-     *   lookbackWindow: 5000, // Only consider very recent emails
-     * });
-     */
-    async waitFor(options = {}) {
-        const { filter = {}, timeout = 30000, // Default 30 seconds
-        pollInterval = 1000, // Default poll every 1 second
-        maxRetries = null, initialDelay = 0, lookbackWindow = 10000, // Default 10 seconds lookback
-         } = options;
-        const startTime = Date.now();
-        let retries = 0;
-        let lastCheckedTime = null;
-        // Helper function to check for matching emails
-        const checkForEmail = async (isFirstCheck = false) => {
-            try {
-                // Calculate the time window for filtering
-                const now = new Date();
-                let startDateFilter;
-                if (isFirstCheck && lookbackWindow) {
-                    // On first check, only look back the specified window
-                    startDateFilter = new Date(now.getTime() - lookbackWindow).toISOString();
-                }
-                else if (lastCheckedTime) {
-                    // On subsequent checks, look for emails since last check
-                    startDateFilter = lastCheckedTime.toISOString();
-                }
-                else {
-                    // Fallback to lookback window
-                    startDateFilter = new Date(now.getTime() - lookbackWindow).toISOString();
-                }
-                // Merge the time filter with user-provided filters
-                const searchFilter = {
-                    ...filter,
-                    startDate: startDateFilter,
-                };
-                const response = await this.list({
-                    filter: searchFilter,
-                    perPage: 10,
-                    sort: { field: 'createdAt', order: 'desc' },
-                });
-                // Update last checked time for next iteration
-                lastCheckedTime = now;
-                if (response.data.length > 0) {
-                    // Return the most recent matching email
-                    return response.data[0];
-                }
-                return null;
-            }
-            catch (error) {
-                // Log error but continue polling
-                console.warn('Error checking for email:', error);
-                return null;
-            }
-        };
-        // Check immediately for existing emails (before any delay)
-        const existingEmail = await checkForEmail(true);
-        if (existingEmail) {
-            return existingEmail;
-        }
-        // Apply initial delay if specified
-        if (initialDelay > 0) {
-            await new Promise(resolve => setTimeout(resolve, initialDelay));
-        }
-        // Start polling
-        while (true) {
-            // Check timeout
-            if (timeout && Date.now() - startTime > timeout) {
-                throw new Error(`Timeout waiting for email after ${timeout}ms`);
-            }
-            // Check max retries
-            if (maxRetries !== null && retries >= maxRetries) {
-                throw new Error(`Max retries (${maxRetries}) exceeded waiting for email`);
-            }
-            // Check for email
-            const email = await checkForEmail();
-            if (email) {
-                return email;
-            }
-            // Wait before next poll
-            await new Promise(resolve => setTimeout(resolve, pollInterval));
-            retries++;
-        }
-    }
-}
-exports.EmailsResource = EmailsResource;

package/dist/types.d.ts

@@ -1,66 +0,0 @@
-export interface Attachment {
-    id: string;
-    filename: string;
-    contentType: string;
-    size: number;
-}
-export interface Email {
-    id: string;
-    from: string;
-    to: string[];
-    subject: string;
-    read: boolean;
-    createdAt: Date;
-    attachments: Attachment[];
-}
-export interface EmailContent {
-    html?: string;
-    text?: string;
-}
-export interface PaginationResponse {
-    currentPage: number;
-    perPage: number;
-    totalItems: number;
-    totalPages: number;
-    hasNextPage: boolean;
-    nextCursor?: string;
-}
-export interface EmailsResponse extends PaginationResponse {
-    data: Email[];
-}
-export interface EmailFilter {
-    from?: string;
-    to?: string;
-    subject?: string;
-    startDate?: string;
-    endDate?: string;
-    read?: boolean;
-}
-export interface EmailSort {
-    field?: 'createdAt' | 'from' | 'subject';
-    order?: 'asc' | 'desc';
-}
-export interface EmailListParams {
-    page?: number;
-    perPage?: number;
-    filter?: EmailFilter;
-    sort?: EmailSort;
-}
-export interface MailhooksConfig {
-    apiKey: string;
-    baseUrl?: string;
-}
-export interface DownloadResponse {
-    data: ArrayBuffer;
-    filename?: string;
-    contentType?: string;
-}
-export interface WaitForOptions {
-    filter?: EmailFilter;
-    timeout?: number;
-    pollInterval?: number;
-    maxRetries?: number;
-    initialDelay?: number;
-    lookbackWindow?: number;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,EAAE,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;IAChB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD,IAAI,EAAE,KAAK,EAAE,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IACzC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/dist/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/webhooks.d.ts

@@ -1,123 +0,0 @@
-/**
- * Webhook payload sent by Mailhooks when an email is received.
- */
-export interface WebhookPayload {
-    /** Unique email ID */
-    id: string;
-    /** Sender email address */
-    from: string;
-    /** Array of recipient email addresses */
-    to: string[];
-    /** Email subject line */
-    subject: string;
-    /** Plain text body of the email */
-    body: string;
-    /** HTML body of the email (if available) */
-    html?: string;
-    /** Array of attachment metadata */
-    attachments: Array<{
-        filename: string;
-        contentType: string;
-        size: number;
-    }>;
-    /** ISO 8601 timestamp when the email was received */
-    receivedAt: string;
-    /** SPF authentication result */
-    spfResult?: 'pass' | 'fail' | 'softfail' | 'neutral' | 'none';
-    /** DKIM authentication result */
-    dkimResult?: 'pass' | 'fail' | 'none' | 'temperror' | 'permerror';
-    /** DMARC authentication result */
-    dmarcResult?: 'pass' | 'fail' | 'none' | 'temperror' | 'permerror';
-    /** Overall authentication summary */
-    authSummary?: 'pass' | 'fail' | 'partial';
-    /** Email headers as key-value pairs */
-    headers?: Record<string, string>;
-    /** Authentication diagnostic details */
-    authDiagnostics?: {
-        spf: {
-            clientIp: string;
-            domain: string;
-            record?: string;
-            helo?: string;
-        } | null;
-        dkim: Array<{
-            domain: string;
-            selector?: string;
-            algorithm?: string;
-            aligned?: boolean;
-            result: string;
-        }>;
-        dmarc: {
-            domain: string;
-            policy: string;
-            record?: string;
-            alignment: {
-                spf: {
-                    result: string | false;
-                    strict: boolean;
-                };
-                dkim: {
-                    result: string | false;
-                    strict: boolean;
-                };
-            };
-        } | null;
-    };
-}
-/**
- * Verifies a webhook signature using HMAC-SHA256.
- *
- * Each webhook request from Mailhooks includes an `X-Webhook-Signature` header
- * containing a hex-encoded HMAC-SHA256 signature of the request body.
- *
- * @param payload - The raw request body as a string or Buffer
- * @param signature - The signature from the `X-Webhook-Signature` header
- * @param secret - Your webhook secret (starts with `whsec_`)
- * @returns `true` if the signature is valid, `false` otherwise
- *
- * @example
- * ```typescript
- * import { verifyWebhookSignature } from '@mailhooks/sdk';
- *
- * // Express.js with raw body parser
- * app.post('/webhook', express.raw({ type: 'application/json' }), (req, res) => {
- *   const signature = req.headers['x-webhook-signature'] as string;
- *   const payload = req.body.toString();
- *
- *   if (!verifyWebhookSignature(payload, signature, process.env.WEBHOOK_SECRET!)) {
- *     return res.status(401).send('Invalid signature');
- *   }
- *
- *   const event = JSON.parse(payload);
- *   // Process the webhook...
- *   res.status(200).send('OK');
- * });
- * ```
- */
-export declare function verifyWebhookSignature(payload: string | Buffer, signature: string, secret: string): boolean;
-/**
- * Parses a webhook payload from a JSON string.
- *
- * @param body - The raw request body as a string
- * @returns The parsed webhook payload
- * @throws {SyntaxError} If the body is not valid JSON
- *
- * @example
- * ```typescript
- * import { parseWebhookPayload } from '@mailhooks/sdk';
- *
- * const payload = parseWebhookPayload(req.body.toString());
- * console.log(`Received email from ${payload.from}: ${payload.subject}`);
- * ```
- */
-export declare function parseWebhookPayload(body: string): WebhookPayload;
-/**
- * Constructs the expected signature for a webhook payload.
- * Useful for debugging or manual verification.
- *
- * @param payload - The raw request body as a string or Buffer
- * @param secret - Your webhook secret
- * @returns The expected HMAC-SHA256 signature as a hex string
- */
-export declare function constructSignature(payload: string | Buffer, secret: string): string;
-//# sourceMappingURL=webhooks.d.ts.map

package/dist/webhooks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../src/webhooks.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,EAAE,EAAE,MAAM,EAAE,CAAC;IACb,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,WAAW,EAAE,KAAK,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;IACH,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;IACnB,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,CAAC;IAC9D,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,WAAW,CAAC;IAClE,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,WAAW,CAAC;IACnE,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAC1C,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,wCAAwC;IACxC,eAAe,CAAC,EAAE;QAChB,GAAG,EAAE;YACH,QAAQ,EAAE,MAAM,CAAC;YACjB,MAAM,EAAE,MAAM,CAAC;YACf,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,GAAG,IAAI,CAAC;QACT,IAAI,EAAE,KAAK,CAAC;YACV,MAAM,EAAE,MAAM,CAAC;YACf,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC,CAAC;QACH,KAAK,EAAE;YACL,MAAM,EAAE,MAAM,CAAC;YACf,MAAM,EAAE,MAAM,CAAC;YACf,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,SAAS,EAAE;gBACT,GAAG,EAAE;oBAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;oBAAC,MAAM,EAAE,OAAO,CAAA;iBAAE,CAAC;gBACjD,IAAI,EAAE;oBAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;oBAAC,MAAM,EAAE,OAAO,CAAA;iBAAE,CAAC;aACnD,CAAC;SACH,GAAG,IAAI,CAAC;KACV,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,GACb,OAAO,CAqBT;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAEhE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,MAAM,EAAE,MAAM,GACb,MAAM,CAER"}

package/dist/webhooks.js

@@ -1,81 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyWebhookSignature = verifyWebhookSignature;
-exports.parseWebhookPayload = parseWebhookPayload;
-exports.constructSignature = constructSignature;
-const crypto_1 = require("crypto");
-/**
- * Verifies a webhook signature using HMAC-SHA256.
- *
- * Each webhook request from Mailhooks includes an `X-Webhook-Signature` header
- * containing a hex-encoded HMAC-SHA256 signature of the request body.
- *
- * @param payload - The raw request body as a string or Buffer
- * @param signature - The signature from the `X-Webhook-Signature` header
- * @param secret - Your webhook secret (starts with `whsec_`)
- * @returns `true` if the signature is valid, `false` otherwise
- *
- * @example
- * ```typescript
- * import { verifyWebhookSignature } from '@mailhooks/sdk';
- *
- * // Express.js with raw body parser
- * app.post('/webhook', express.raw({ type: 'application/json' }), (req, res) => {
- *   const signature = req.headers['x-webhook-signature'] as string;
- *   const payload = req.body.toString();
- *
- *   if (!verifyWebhookSignature(payload, signature, process.env.WEBHOOK_SECRET!)) {
- *     return res.status(401).send('Invalid signature');
- *   }
- *
- *   const event = JSON.parse(payload);
- *   // Process the webhook...
- *   res.status(200).send('OK');
- * });
- * ```
- */
-function verifyWebhookSignature(payload, signature, secret) {
-    if (!payload || !signature || !secret) {
-        return false;
-    }
-    // Normalize and validate signature format (should be 64 hex chars for SHA256)
-    const normalizedSignature = signature.trim().toLowerCase();
-    if (!/^[a-f0-9]{64}$/.test(normalizedSignature)) {
-        return false;
-    }
-    const expectedSignature = (0, crypto_1.createHmac)('sha256', secret)
-        .update(payload)
-        .digest('hex');
-    // Use timing-safe comparison to prevent timing attacks
-    // Both buffers are guaranteed to be 32 bytes (64 hex chars)
-    return (0, crypto_1.timingSafeEqual)(Buffer.from(normalizedSignature, 'hex'), Buffer.from(expectedSignature, 'hex'));
-}
-/**
- * Parses a webhook payload from a JSON string.
- *
- * @param body - The raw request body as a string
- * @returns The parsed webhook payload
- * @throws {SyntaxError} If the body is not valid JSON
- *
- * @example
- * ```typescript
- * import { parseWebhookPayload } from '@mailhooks/sdk';
- *
- * const payload = parseWebhookPayload(req.body.toString());
- * console.log(`Received email from ${payload.from}: ${payload.subject}`);
- * ```
- */
-function parseWebhookPayload(body) {
-    return JSON.parse(body);
-}
-/**
- * Constructs the expected signature for a webhook payload.
- * Useful for debugging or manual verification.
- *
- * @param payload - The raw request body as a string or Buffer
- * @param secret - Your webhook secret
- * @returns The expected HMAC-SHA256 signature as a hex string
- */
-function constructSignature(payload, secret) {
-    return (0, crypto_1.createHmac)('sha256', secret).update(payload).digest('hex');
-}