@empiricalrun/playwright-utils 0.47.2 → 0.47.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @empiricalrun/playwright-utils
 
+## 0.47.3
+
+### Patch Changes
+
+- ceeb466: feat: new provider option in email client
+
 ## 0.47.2
 
 ### Patch Changes

package/dist/email.d.ts

@@ -1,18 +1,20 @@
+import { type InboxEmail } from "./inbox-client";
 import { type MailosaurEmail } from "./mailosaur-client";
-export type Email = MailosaurEmail;
+export type Email = MailosaurEmail | InboxEmail;
 type QueryFilter = {
     from?: string;
     subject?: string;
     body?: string;
 };
+type EmailProvider = "inbox" | "mailosaur";
 type EmailClientOptions = {
     timeout?: number;
     emailId?: string;
+    provider?: EmailProvider;
 };
 export declare class EmailClient {
     address: string;
     timeout: number;
-    serverId: string;
     private client;
     constructor(opts?: EmailClientOptions);
     getAddress(): string;

package/dist/email.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../src/email.ts"],"names":[],"mappings":"AAEA,OAAO,EAAmB,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAE1E,MAAM,MAAM,KAAK,GAAG,cAAc,CAAC;AAEnC,KAAK,WAAW,GAAG;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAKF,KAAK,kBAAkB,GAAG;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,qBAAa,WAAW;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,SAAa;IACrB,OAAO,CAAC,MAAM,CAAkB;gBAEpB,IAAI,GAAE,kBAAuB;IAwCzC,UAAU,IAAI,MAAM;IAId,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC;CAGzD"}
+{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../src/email.ts"],"names":[],"mappings":"AAEA,OAAO,EAAe,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAmB,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAE1E,MAAM,MAAM,KAAK,GAAG,cAAc,GAAG,UAAU,CAAC;AAEhD,KAAK,WAAW,GAAG;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAMF,KAAK,aAAa,GAAG,OAAO,GAAG,WAAW,CAAC;AAM3C,KAAK,kBAAkB,GAAG;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF,qBAAa,WAAW;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,MAAM,CAAsB;gBAExB,IAAI,GAAE,kBAAuB;IA+BzC,UAAU,IAAI,MAAM;IAId,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC;CAGzD"}

package/dist/email.js

@@ -2,47 +2,39 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EmailClient = void 0;
 const dashboard_client_1 = require("@empiricalrun/dashboard-client");
+const inbox_client_1 = require("./inbox-client");
 const mailosaur_client_1 = require("./mailosaur-client");
 const DEFAULT_TIMEOUT = 30_000;
-const SERVER_ID = "pnyrwq5o";
+const MAILOSAUR_SERVER_ID = "pnyrwq5o";
+const INBOX_EMAIL_DOMAIN = "empiricalrun.email";
 class EmailClient {
     address;
     timeout;
-    serverId = SERVER_ID;
     client;
     constructor(opts = {}) {
         const { timeout = DEFAULT_TIMEOUT, emailId: knownEmailId } = opts;
         this.timeout = timeout;
-        const empiricalApiKey = process.env.EMPIRICALRUN_API_KEY;
-        if (empiricalApiKey) {
-            const apiClient = new dashboard_client_1.DashboardAPIClient({
-                authType: "project-api-key",
-            });
-            this.client = new mailosaur_client_1.MailosaurClient({
-                apiClient,
-                serverId: this.serverId,
-                timeout: this.timeout,
-            });
+        const provider = opts.provider || "mailosaur";
+        const apiClient = new dashboard_client_1.DashboardAPIClient({
+            authType: "project-api-key",
+        });
+        const emailId = knownEmailId ||
+            [...Array(7)].map(() => Math.random().toString(36)[2]).join("");
+        if (provider === "inbox") {
+            this.client = new inbox_client_1.InboxClient({ apiClient, timeout: this.timeout });
+            this.address = emailId.includes("@")
+                ? emailId
+                : `${emailId}@${INBOX_EMAIL_DOMAIN}`;
         }
         else {
-            const apiKey = process.env.MAILOSAUR_API_KEY;
-            if (!apiKey) {
-                throw new Error("Either EMPIRICALRUN_API_KEY or MAILOSAUR_API_KEY must be set");
-            }
             this.client = new mailosaur_client_1.MailosaurClient({
-                apiKey,
-                serverId: this.serverId,
+                apiClient,
+                serverId: MAILOSAUR_SERVER_ID,
                 timeout: this.timeout,
             });
-        }
-        const emailId = knownEmailId ||
-            [...Array(7)].map(() => Math.random().toString(36)[2]).join("");
-        if (emailId.includes("@")) {
-            this.address = emailId;
-        }
-        else {
-            const emailDomain = `${this.serverId}.mailosaur.net`;
-            this.address = `${emailId}@${emailDomain}`;
+            this.address = emailId.includes("@")
+                ? emailId
+                : `${emailId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
         }
     }
     getAddress() {

package/dist/inbox-client.d.ts

@@ -0,0 +1,32 @@
+import type { IDashboardAPIClient } from "@empiricalrun/shared-types/api/base";
+type Link = {
+    text?: string;
+    href?: string;
+};
+export type InboxEmail = {
+    subject?: string;
+    text?: string;
+    html?: string;
+    links: Link[];
+    codes: string[];
+};
+type InboxClientOptions = {
+    apiClient: IDashboardAPIClient;
+    timeout: number;
+};
+export declare class InboxClient {
+    private apiClient;
+    private timeout;
+    constructor(opts: InboxClientOptions);
+    waitForEmail(address: string, filter?: {
+        from?: string;
+        subject?: string;
+        body?: string;
+    }): Promise<InboxEmail>;
+    private pollForMessage;
+    private parseMessage;
+    private extractLinks;
+    private extractCodes;
+}
+export {};
+//# sourceMappingURL=inbox-client.d.ts.map

package/dist/inbox-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbox-client.d.ts","sourceRoot":"","sources":["../src/inbox-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAE/E,KAAK,IAAI,GAAG;IACV,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAmBF,KAAK,kBAAkB,GAAG;IACxB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,qBAAa,WAAW;IACtB,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,OAAO,CAAS;gBAEZ,IAAI,EAAE,kBAAkB;IAK9B,YAAY,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1D,OAAO,CAAC,UAAU,CAAC;YASR,cAAc;IAgD5B,OAAO,CAAC,YAAY;IAapB,OAAO,CAAC,YAAY;IAwBpB,OAAO,CAAC,YAAY;CAYrB"}

package/dist/inbox-client.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InboxClient = void 0;
+const DEFAULT_POLL_DELAY = 1000;
+class InboxClient {
+    apiClient;
+    timeout;
+    constructor(opts) {
+        this.apiClient = opts.apiClient;
+        this.timeout = opts.timeout;
+    }
+    async waitForEmail(address, filter) {
+        const now = new Date();
+        const bufferPeriod = 5_000;
+        const receivedAfter = new Date(now.getTime() - bufferPeriod);
+        const message = await this.pollForMessage(address, receivedAfter, filter);
+        return this.parseMessage(message);
+    }
+    async pollForMessage(address, receivedAfter, filter) {
+        const startTime = Date.now();
+        while (true) {
+            const params = new URLSearchParams({
+                to: address,
+                received_after: receivedAfter.toISOString(),
+            });
+            if (filter?.from)
+                params.set("from", filter.from);
+            if (filter?.subject)
+                params.set("subject", filter.subject);
+            if (filter?.body)
+                params.set("body", filter.body);
+            const path = `/api/messages?${params.toString()}`;
+            let result;
+            try {
+                result = await this.apiClient.callInboxProxy({
+                    method: "GET",
+                    path,
+                });
+            }
+            catch (err) {
+                console.error("Inbox network error during search:", err);
+                if (err instanceof Error && "status" in err && err.status === 401) {
+                    throw new Error("Email provider error: Authentication error");
+                }
+                throw new Error("Email provider error: Network request failed");
+            }
+            if (result.data?.data) {
+                return result.data.data;
+            }
+            const elapsed = Date.now() - startTime;
+            if (elapsed + DEFAULT_POLL_DELAY > this.timeout) {
+                throw new Error(`Email not received at ${address} within ${this.timeout}ms`);
+            }
+            await new Promise((resolve) => setTimeout(resolve, DEFAULT_POLL_DELAY));
+        }
+    }
+    parseMessage(message) {
+        const links = this.extractLinks(message.html_body, message.text_body);
+        const codes = this.extractCodes(message.html_body, message.text_body);
+        return {
+            subject: message.subject || undefined,
+            text: message.text_body || undefined,
+            html: message.html_body || undefined,
+            links,
+            codes,
+        };
+    }
+    extractLinks(html, text) {
+        const links = [];
+        if (html) {
+            const hrefRegex = /<a[^>]+href="([^"]*)"[^>]*>(.*?)<\/a>/gi;
+            let match;
+            while ((match = hrefRegex.exec(html)) !== null) {
+                links.push({ href: match[1], text: match[2]?.replace(/<[^>]*>/g, "") });
+            }
+        }
+        if (text) {
+            const urlRegex = /https?:\/\/[^\s<>"')\]]+/g;
+            let match;
+            while ((match = urlRegex.exec(text)) !== null) {
+                if (!links.some((l) => l.href === match[0])) {
+                    links.push({ href: match[0] });
+                }
+            }
+        }
+        return links;
+    }
+    extractCodes(html, text) {
+        const codes = [];
+        const content = text || html || "";
+        const codeRegex = /\b(\d{4,8})\b/g;
+        let match;
+        while ((match = codeRegex.exec(content)) !== null) {
+            if (!codes.includes(match[1])) {
+                codes.push(match[1]);
+            }
+        }
+        return codes;
+    }
+}
+exports.InboxClient = InboxClient;

package/dist/mailosaur-client.d.ts

@@ -1,26 +1,5 @@
-export interface IDashboardAPIClient {
-    request<T>(endpoint: string, options: {
-        params?: Record<string, string>;
-        body?: Record<string, unknown>;
-        method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-    }): Promise<T>;
-    callGitHubProxy<T>(opts: {
-        method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
-        url: string;
-        body?: unknown;
-    }): Promise<T>;
-    callMailosaurProxy<T>(opts: {
-        method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
-        path: string;
-        body?: unknown;
-    }): Promise<T>;
-    callWebhookSiteProxy<T>(opts: {
-        method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
-        path: string;
-        body?: unknown;
-    }): Promise<T>;
-    getBaseUrl(): string;
-}
+export type { IDashboardAPIClient } from "@empiricalrun/shared-types/api/base";
+import type { IDashboardAPIClient } from "@empiricalrun/shared-types/api/base";
 type Link = {
     text?: string;
     href?: string;
@@ -33,18 +12,12 @@ export type MailosaurEmail = {
     codes: string[];
 };
 type MailosaurClientOptions = {
+    apiClient: IDashboardAPIClient;
     serverId: string;
     timeout: number;
-} & ({
-    apiKey: string;
-    apiClient?: never;
-} | {
-    apiKey?: never;
-    apiClient: IDashboardAPIClient;
-});
+};
 export declare class MailosaurClient {
-    private apiKey?;
-    private apiClient?;
+    private apiClient;
     private serverId;
     private timeout;
     constructor(opts: MailosaurClientOptions);
@@ -59,5 +32,4 @@ export declare class MailosaurClient {
     private parseEmailResponse;
     private sleep;
 }
-export {};
 //# sourceMappingURL=mailosaur-client.d.ts.map

package/dist/mailosaur-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mailosaur-client.d.ts","sourceRoot":"","sources":["../src/mailosaur-client.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,CAAC,EACP,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;QACP,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC/B,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;KACrD,GACA,OAAO,CAAC,CAAC,CAAC,CAAC;IACd,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE;QACvB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;QACpD,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACf,kBAAkB,CAAC,CAAC,EAAE,IAAI,EAAE;QAC1B,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;QACpD,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACf,oBAAoB,CAAC,CAAC,EAAE,IAAI,EAAE;QAC5B,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;QACpD,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACf,UAAU,IAAI,MAAM,CAAC;CACtB;AAED,KAAK,IAAI,GAAG;IACV,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAkCF,KAAK,sBAAsB,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,CACA;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,KAAK,CAAA;CAAE,GACrC;IAAE,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,SAAS,EAAE,mBAAmB,CAAA;CAAE,CACrD,CAAC;AAEF,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,SAAS,CAAC,CAAsB;IACxC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,OAAO,CAAS;gBAEZ,IAAI,EAAE,sBAAsB;YAW1B,WAAW;IA0CnB,YAAY,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1D,OAAO,CAAC,cAAc,CAAC;YAqBZ,iBAAiB;YA2EjB,cAAc;IA+B5B,OAAO,CAAC,kBAAkB;IAmB1B,OAAO,CAAC,KAAK;CAGd"}
+{"version":3,"file":"mailosaur-client.d.ts","sourceRoot":"","sources":["../src/mailosaur-client.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAE/E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAE/E,KAAK,IAAI,GAAG;IACV,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAiCF,KAAK,sBAAsB,GAAG;IAC5B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,qBAAa,eAAe;IAC1B,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,OAAO,CAAS;gBAEZ,IAAI,EAAE,sBAAsB;YAM1B,WAAW;IAsBnB,YAAY,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1D,OAAO,CAAC,cAAc,CAAC;YAqBZ,iBAAiB;YA2EjB,cAAc;IA+B5B,OAAO,CAAC,kBAAkB;IAmB1B,OAAO,CAAC,KAAK;CAGd"}

package/dist/mailosaur-client.js

@@ -1,51 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MailosaurClient = void 0;
-const MAILOSAUR_BASE_URL = "https://mailosaur.com/api";
 const DEFAULT_POLL_DELAY = 1000;
 class MailosaurClient {
-    apiKey;
     apiClient;
     serverId;
     timeout;
     constructor(opts) {
         this.serverId = opts.serverId;
         this.timeout = opts.timeout;
-        if ("apiClient" in opts && opts.apiClient) {
-            this.apiClient = opts.apiClient;
-        }
-        else {
-            this.apiKey = opts.apiKey;
-        }
+        this.apiClient = opts.apiClient;
     }
     async makeRequest(method, path, body) {
-        if (this.apiClient) {
-            const result = await this.apiClient.callMailosaurProxy({
-                method,
-                path,
-                body,
-            });
-            return {
-                data: result.data,
-                headers: result.headers || {},
-                status: 200,
-            };
-        }
-        const url = `${MAILOSAUR_BASE_URL}${path}`;
-        const response = await fetch(url, {
+        const result = await this.apiClient.callMailosaurProxy({
             method,
-            headers: {
-                Authorization: `Basic ${Buffer.from(`${this.apiKey}:`).toString("base64")}`,
-                "Content-Type": "application/json",
-            },
-            body: body ? JSON.stringify(body) : undefined,
+            path,
+            body,
         });
-        const responseHeaders = {};
-        response.headers.forEach((value, key) => {
-            responseHeaders[key] = value;
-        });
-        const data = await response.json().catch(() => null);
-        return { data, headers: responseHeaders, status: response.status };
+        return {
+            data: result.data,
+            headers: result.headers || {},
+            status: 200,
+        };
     }
     async waitForEmail(address, filter) {
         const now = new Date();

package/docs/email.md

@@ -1,5 +1,14 @@
 # Email automation
 
+## Providers
+
+The `EmailClient` supports two email providers:
+
+- **`mailosaur`** (default) — Uses Mailosaur via the dashboard proxy
+- **`inbox`** — Uses our self-hosted Cloudflare Worker on `empiricalrun.email`
+
+Both providers are accessed through the dashboard proxy, so only `EMPIRICALRUN_API_KEY` is required.
+
 ## Example usage
 
 ### Dynamic email
@@ -12,7 +21,7 @@ import { EmailClient } from "@empiricalrun/playwright-utils";
 import { expect } from "@playwright/test";
 
 const client = new EmailClient();
-const address = client.getAddress();
+const address = client.getAddress(); // e.g. abc1234@empiricalrun.email
 
 // Input the `address` in the application
 // that sends the email.
@@ -30,7 +39,7 @@ This uses a known (static) email that can be used to login
 into an application.
 
 This needs an email id (e.g. `test-login-user`). The email id
-is appended with the domain (managed internally) to get the full
+is appended with the domain (`empiricalrun.email`) to get the full
 email address.
 
 ```ts
@@ -47,3 +56,23 @@ const email = await client.waitForEmail();
 // Get login OTP
 const loginCode = email.codes[0];
 ```
+
+### Using the inbox provider
+
+Pass `provider: "inbox"` to use the self-hosted inbox provider.
+
+```ts
+const client = new EmailClient({ provider: "inbox" });
+```
+
+### Filtering emails
+
+You can filter emails by sender, subject, or body content:
+
+```ts
+const email = await client.waitForEmail({
+  from: "noreply@example.com",
+  subject: "Verify your email",
+  body: "verification code",
+});
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.47.2",
+  "version": "0.47.3",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -52,7 +52,7 @@
   "scripts": {
     "dev": "tsc --build --watch",
     "build": "tsc --build",
-    "clean": "tsc --build --clean",
+    "clean": "rm -rf dist && tsc --build --clean",
     "lint": "biome check --unsafe",
     "test": "vitest run",
     "test-browser": "npx playwright test",

package/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/email.ts","./src/index.ts","./src/kv.ts","./src/logger.ts","./src/mailosaur-client.ts","./src/playwright-extensions.ts","./src/postgres.ts","./src/telemetry.ts","./src/webhook.ts","./src/auth/google.ts","./src/auth/index.ts","./src/auth/types.ts","./src/captcha/index.ts","./src/config/index.ts","./src/config/proxy.ts","./src/config/devices/types.ts","./src/overlay-tests/cache.spec.ts","./src/overlay-tests/click.spec.ts","./src/overlay-tests/fixtures.ts","./src/overlay-tests/patch.spec.ts","./src/reporter/attachment-cleanup-test-reporter.ts","./src/reporter/attachment-cleanup.ts","./src/reporter/blob-utils.ts","./src/reporter/empirical-reporter.ts","./src/reporter/failing-line.ts","./src/reporter/harness.ts","./src/reporter/ibr-utils.ts","./src/reporter/incremental-blob-reporter.ts","./src/reporter/lifecycle-events.ts","./src/reporter/local-test.ts","./src/reporter/reporter-state.ts","./src/reporter/uploader.ts","./src/reporter/util.ts","./src/test/constants.ts","./src/test/coverage.ts","./src/test/index.ts","./src/test/types.ts","./src/test/video-labels.ts","./src/test/expect/index.ts","./src/test/expect/types.ts","./src/test/expect/visual.ts","./src/test/expect/webhook.ts","./src/test/scripts/agent-capabilities.ts","./src/test/scripts/index.ts","./src/test/scripts/locator-highlights.ts","./src/test/scripts/locator-vision.ts","./src/test/scripts/mouse-pointer.ts","./src/test/scripts/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/cache.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/index.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/prompt.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/utils.ts","./src/test/scripts/pw-locator-patch/highlight/click.ts","./src/test/scripts/pw-locator-patch/highlight/expect.ts","./src/test/scripts/pw-locator-patch/highlight/hover.ts","./src/test/scripts/pw-locator-patch/highlight/inner-text.ts","./src/test/scripts/pw-locator-patch/highlight/input-value.ts","./src/test/scripts/pw-locator-patch/highlight/is-checked.ts","./src/test/scripts/pw-locator-patch/highlight/is-disabled.ts","./src/test/scripts/pw-locator-patch/highlight/is-editable.ts","./src/test/scripts/pw-locator-patch/highlight/text-content.ts","./src/test/scripts/pw-locator-patch/utils/index.ts","./src/test/scripts/pw-locator-patch/vision/query.ts"],"version":"5.8.3"}
+{"root":["./src/email.ts","./src/inbox-client.ts","./src/index.ts","./src/kv.ts","./src/logger.ts","./src/mailosaur-client.ts","./src/playwright-extensions.ts","./src/postgres.ts","./src/telemetry.ts","./src/webhook.ts","./src/auth/google.ts","./src/auth/index.ts","./src/auth/types.ts","./src/captcha/index.ts","./src/config/index.ts","./src/config/proxy.ts","./src/config/devices/types.ts","./src/overlay-tests/cache.spec.ts","./src/overlay-tests/click.spec.ts","./src/overlay-tests/fixtures.ts","./src/overlay-tests/patch.spec.ts","./src/reporter/attachment-cleanup-test-reporter.ts","./src/reporter/attachment-cleanup.ts","./src/reporter/blob-utils.ts","./src/reporter/empirical-reporter.ts","./src/reporter/failing-line.ts","./src/reporter/harness.ts","./src/reporter/ibr-utils.ts","./src/reporter/incremental-blob-reporter.ts","./src/reporter/lifecycle-events.ts","./src/reporter/local-test.ts","./src/reporter/reporter-state.ts","./src/reporter/uploader.ts","./src/reporter/util.ts","./src/test/constants.ts","./src/test/coverage.ts","./src/test/index.ts","./src/test/types.ts","./src/test/video-labels.ts","./src/test/expect/index.ts","./src/test/expect/types.ts","./src/test/expect/visual.ts","./src/test/expect/webhook.ts","./src/test/scripts/agent-capabilities.ts","./src/test/scripts/index.ts","./src/test/scripts/locator-highlights.ts","./src/test/scripts/locator-vision.ts","./src/test/scripts/mouse-pointer.ts","./src/test/scripts/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/cache.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/index.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/prompt.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/utils.ts","./src/test/scripts/pw-locator-patch/highlight/click.ts","./src/test/scripts/pw-locator-patch/highlight/expect.ts","./src/test/scripts/pw-locator-patch/highlight/hover.ts","./src/test/scripts/pw-locator-patch/highlight/inner-text.ts","./src/test/scripts/pw-locator-patch/highlight/input-value.ts","./src/test/scripts/pw-locator-patch/highlight/is-checked.ts","./src/test/scripts/pw-locator-patch/highlight/is-disabled.ts","./src/test/scripts/pw-locator-patch/highlight/is-editable.ts","./src/test/scripts/pw-locator-patch/highlight/text-content.ts","./src/test/scripts/pw-locator-patch/utils/index.ts","./src/test/scripts/pw-locator-patch/vision/query.ts"],"version":"5.8.3"}