@empiricalrun/playwright-utils 0.19.8 → 0.19.11

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @empiricalrun/playwright-utils
 
+## 0.19.11
+
+### Patch Changes
+
+- 55a70ee: fix: revert to old version of playwright
+- Updated dependencies [55a70ee]
+  - @empiricalrun/test-gen@0.42.3
+
+## 0.19.10
+
+### Patch Changes
+
+- Updated dependencies [87743d9]
+  - @empiricalrun/test-gen@0.42.2
+
+## 0.19.9
+
+### Patch Changes
+
+- 533df57: docs: for fixture methods in playwright-utils
+- Updated dependencies [ce2b8c7]
+  - @empiricalrun/test-gen@0.42.1
+
 ## 0.19.8
 
 ### Patch Changes

package/docs/email.md

@@ -1,8 +1,8 @@
-## Email automation
+# Email automation
 
-### Example usage
+## Example usage
 
-#### Dynamic email
+### Dynamic email
 
 This dynamically generates a random email address that can 
 be used for the test (e.g. invite a new user).
@@ -24,7 +24,7 @@ expect(
 ).toBeTruthy();
 ```
 
-#### Static email
+### Static email
 
 This uses a known (static) email that can be used to login
 into an application.

package/docs/fixtures.md

@@ -0,0 +1,55 @@
+# Fixtures
+
+The playwright-utils package provides fixtures that wrap around Playwright's built-in
+`page`, `context` fixtures to provide a mouse highlighter (which makes it easier to
+see actions taken in a video).
+
+To use this, you probably just want to use the `baseTestFixture` import and use it in your
+fixtures file.
+
+```ts
+import { test as base, Page } from "@playwright/test";
+import { baseTestFixture } from "@empiricalrun/playwright-utils/test";
+
+export const test = baseTestFixture(base);
+export const expect = test.expect;
+```
+
+The packages also expose methods to enable advanced use-cases.
+
+## Get a new browser context
+
+This package provides a fixture `customContextPageProvider` which is a good way to create
+a fresh, new browser context, and a page inside it.
+
+There are two benefits of using this to create contexts or pages:
+1. Videos get recorded and attached to the test report
+2. Mouse highlights are available
+
+```ts
+import { test, expect } from "./fixtures";
+
+test("Example test", async ({ page: builtInPage, customContextPageProvider }) => {
+  // builtInPage is from default browser context
+  const { page: newPage, context } = await customContextPageProvider();
+  // newPage is from this other browser context
+});
+```
+
+## Inject mouse highlighter manually
+
+In some cases, you want to inject mouse highlights to a page. This is useful if the test
+requires `launchPersistentContext`, which means the browser context is created manually.
+
+With `injectLocatorHighlightScripts`, you can still get mouse highlights in any page.
+
+```ts
+import { injectLocatorHighlightScripts, baseTestFixture } from "@empiricalrun/playwright-utils/test";
+
+export const test = baseTestFixture(base).extend<TestOptions>({
+  customPage: async ({ page }, use) => {
+    injectLocatorHighlightScripts(page);
+    await use(page);
+  },
+});
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.19.8",
+  "version": "0.19.11",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -22,7 +22,7 @@
   },
   "author": "Empirical Team <hey@empirical.run>",
   "devDependencies": {
-    "@playwright/test": "1.49.1",
+    "@playwright/test": "1.47.1",
     "@types/async-retry": "^1.4.8",
     "@types/babel__code-frame": "^7.0.6",
     "@types/console-log-level": "^1.4.5",
@@ -37,12 +37,12 @@
     "mailosaur": "^8.6.1",
     "md5": "^2.3.0",
     "mime": "3.0.0",
-    "playwright-core": "1.49.1",
+    "playwright-core": "1.47.1",
     "puppeteer-extra-plugin-recaptcha": "^3.6.8",
     "rimraf": "^6.0.1",
     "@empiricalrun/llm": "^0.9.29",
-    "@empiricalrun/test-gen": "^0.42.0",
-    "@empiricalrun/r2-uploader": "^0.3.8"
+    "@empiricalrun/r2-uploader": "^0.3.8",
+    "@empiricalrun/test-gen": "^0.42.3"
   },
   "scripts": {
     "dev": "tsc --build --watch",