@empiricalrun/playwright-utils 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @empiricalrun/playwright-utils
 
+## 0.2.0
+
+### Minor Changes
+
+- 4189f0f: feat: add email client for email testing scenarios
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/config.d.ts

@@ -0,0 +1,3 @@
+import { type PlaywrightTestConfig } from "@playwright/test";
+export declare const baseConfig: PlaywrightTestConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,eAAO,MAAM,UAAU,EAAE,oBAiBxB,CAAC"}

package/dist/config.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.baseConfig = void 0;
+exports.baseConfig = {
+    testDir: "./tests",
+    fullyParallel: true,
+    forbidOnly: false,
+    retries: process.env.CI ? 2 : 0,
+    workers: undefined,
+    reporter: [["html"], ["json", { outputFile: "test-results/summary.json" }]],
+    use: {
+        trace: "retain-on-failure",
+        video: "on",
+        viewport: { width: 1366, height: 768 },
+        actionTimeout: 15_000,
+    },
+    expect: {
+        timeout: 15_000,
+    },
+    timeout: 0,
+};

package/dist/email.d.ts

@@ -0,0 +1,20 @@
+import MailosaurClient from "mailosaur";
+type Link = {
+    text?: string;
+    href?: string;
+};
+export type Email = {
+    subject?: string;
+    text?: string;
+    html?: string;
+    links: Link[];
+};
+export declare class EmailClient {
+    address: string;
+    client: MailosaurClient;
+    constructor();
+    getAddress(): string;
+    waitForEmail(): Promise<Email | undefined>;
+}
+export {};
+//# sourceMappingURL=email.d.ts.map

package/dist/email.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../src/email.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,WAAW,CAAC;AAExC,KAAK,IAAI,GAAG;IACV,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,IAAI,EAAE,CAAC;CACf,CAAC;AAIF,qBAAa,WAAW;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,eAAe,CAAC;;IAUxB,UAAU;IAIJ,YAAY,IAAI,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;CAqBjD"}

package/dist/email.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailClient = void 0;
+const mailosaur_1 = __importDefault(require("mailosaur"));
+const serverId = "pnyrwq5o";
+class EmailClient {
+    address;
+    client;
+    constructor() {
+        const randomString = [...Array(7)]
+            .map(() => Math.random().toString(36)[2])
+            .join("");
+        this.address = `${randomString}@${serverId}.mailosaur.net`;
+        this.client = new mailosaur_1.default("");
+    }
+    getAddress() {
+        return this.address;
+    }
+    async waitForEmail() {
+        try {
+            const email = await this.client.messages.get(serverId, {
+                sentTo: this.address,
+            }, { timeout: 30_000 });
+            if (email) {
+                return {
+                    subject: email.subject,
+                    text: email.text?.body,
+                    html: email.html?.body,
+                    links: email.html?.links || [],
+                };
+            }
+        }
+        catch (error) {
+            console.log("Error receiving email");
+        }
+    }
+}
+exports.EmailClient = EmailClient;

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-import { type PlaywrightTestConfig } from "@playwright/test";
-declare const baseConfig: PlaywrightTestConfig;
-export { baseConfig };
+export { baseConfig } from "./config";
+export * from "./email";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,QAAA,MAAM,UAAU,EAAE,oBAiBjB,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -1,22 +1,20 @@
 "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]; } };
+    }
+    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);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.baseConfig = void 0;
-const baseConfig = {
-    testDir: "./tests",
-    fullyParallel: true,
-    forbidOnly: false,
-    retries: process.env.CI ? 2 : 0,
-    workers: undefined,
-    reporter: [["html"], ["json", { outputFile: "test-results/summary.json" }]],
-    use: {
-        trace: "retain-on-failure",
-        video: "on",
-        viewport: { width: 1366, height: 768 },
-        actionTimeout: 15000,
-    },
-    expect: {
-        timeout: 15000,
-    },
-    timeout: 0,
-};
-exports.baseConfig = baseConfig;
+var config_1 = require("./config");
+Object.defineProperty(exports, "baseConfig", { enumerable: true, get: function () { return config_1.baseConfig; } });
+__exportStar(require("./email"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -15,9 +15,12 @@
     "@playwright/test": "^1.44.1",
     "@types/node": "^20.14.9"
   },
+  "dependencies": {
+    "mailosaur": "^8.6.1"
+  },
   "scripts": {
     "dev": "tsc --build --watch",
-    "build": "tsc --build",
+    "build": "tsc --build && node ./../../tools/static-env-vars.js dist",
     "clean": "tsc --build --clean",
     "lint": "eslint .",
     "test": "vitest run",