@empiricalrun/playwright-utils 0.4.2 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @empiricalrun/playwright-utils
 
+## 0.6.0
+
+### Minor Changes
+
+- 59206d0: feat: add highlighter support for textContent
+
+## 0.5.0
+
+### Minor Changes
+
+- 9094774: feat: expose locator highlighter scripts
+
 ## 0.4.2
 
 ### Patch Changes

package/dist/test/index.d.ts

@@ -1,5 +1,7 @@
 import type { PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from "@playwright/test";
+import { injectLocatorHighlightScripts } from "./scripts";
 export declare const baseTestFixture: (testFn: TestType<PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>) => TestType<PlaywrightTestArgs & PlaywrightTestOptions & {
     [key: string]: any;
 }, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+export { injectLocatorHighlightScripts };
 //# sourceMappingURL=index.d.ts.map

package/dist/test/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAI1B,eAAO,MAAM,eAAe,WAClB,SACN,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C;;kDAQF,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAE1D,eAAO,MAAM,eAAe,WAClB,SACN,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C;;kDAQF,CAAC;AAEF,OAAO,EAAE,6BAA6B,EAAE,CAAC"}

package/dist/test/index.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.baseTestFixture = void 0;
+exports.injectLocatorHighlightScripts = exports.baseTestFixture = void 0;
 const scripts_1 = require("./scripts");
+Object.defineProperty(exports, "injectLocatorHighlightScripts", { enumerable: true, get: function () { return scripts_1.injectLocatorHighlightScripts; } });
 const baseTestFixture = function (testFn) {
     return testFn.extend({
         page: async ({ page }, use) => {
-            (0, scripts_1.addCustomScripts)(page);
+            (0, scripts_1.injectLocatorHighlightScripts)(page);
             await use(page);
         },
     });

package/dist/test/scripts/index.d.ts

@@ -1,3 +1,3 @@
 import type { Page } from "@playwright/test";
-export declare function addCustomScripts(page: Page): void;
+export declare function injectLocatorHighlightScripts(page: Page): void;
 //# sourceMappingURL=index.d.ts.map

package/dist/test/scripts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAK7C,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,QAS1C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAK7C,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,IAAI,QASvD"}

package/dist/test/scripts/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addCustomScripts = void 0;
+exports.injectLocatorHighlightScripts = void 0;
 const locator_highlights_1 = require("./locator-highlights");
 const mouse_pointer_1 = require("./mouse-pointer");
-function addCustomScripts(page) {
+function injectLocatorHighlightScripts(page) {
     try {
         // pointer highlighter and focus highlighter
         (0, mouse_pointer_1.addMousePointerHighlighter)(page);
@@ -14,4 +14,4 @@ function addCustomScripts(page) {
         console.error("Failed to add mouse pointer highlighter", e);
     }
 }
-exports.addCustomScripts = addCustomScripts;
+exports.injectLocatorHighlightScripts = injectLocatorHighlightScripts;

package/dist/test/scripts/locator-highlights.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"locator-highlights.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/locator-highlights.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAU7C,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,QAS9C"}
+{"version":3,"file":"locator-highlights.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/locator-highlights.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAW7C,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,QAU9C"}

package/dist/test/scripts/locator-highlights.js

@@ -8,6 +8,7 @@ const input_value_1 = require("./pw-locator-patch/input-value");
 const is_checked_1 = require("./pw-locator-patch/is-checked");
 const is_disabled_1 = require("./pw-locator-patch/is-disabled");
 const is_editable_1 = require("./pw-locator-patch/is-editable");
+const text_content_1 = require("./pw-locator-patch/text-content");
 function addLocatorHighlights(page) {
     const LocatorClass = page.locator("").constructor;
     (0, expect_1.patchExpect)(LocatorClass);
@@ -17,5 +18,6 @@ function addLocatorHighlights(page) {
     (0, is_disabled_1.patchIsDisabled)(LocatorClass);
     (0, hover_1.patchHover)(LocatorClass);
     (0, inner_text_1.patchInnerText)(LocatorClass);
+    (0, text_content_1.patchTextContent)(LocatorClass);
 }
 exports.addLocatorHighlights = addLocatorHighlights;

package/dist/test/scripts/pw-locator-patch/expect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"expect.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/expect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,WAAW,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAyB/D"}
+{"version":3,"file":"expect.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/expect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,WAAW,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QA2B/D"}

package/dist/test/scripts/pw-locator-patch/expect.js

@@ -14,7 +14,9 @@ function patchExpect(LocatorClass) {
                 await this.evaluate((node) => {
                     node.classList.add("empirical-element-grab-highlight");
                     setTimeout(() => {
-                        node.classList.remove("empirical-element-grab-highlight");
+                        if (node.isConnected) {
+                            node.classList.remove("empirical-element-grab-highlight");
+                        }
                     }, 2000);
                 });
             }

package/dist/test/scripts/pw-locator-patch/hover.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hover.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/hover.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,UAAU,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAiB9D"}
+{"version":3,"file":"hover.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/hover.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,UAAU,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAmB9D"}

package/dist/test/scripts/pw-locator-patch/hover.js

@@ -11,7 +11,9 @@ function patchHover(LocatorClass) {
             await this.evaluate((node) => {
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    node.classList.remove("empirical-element-grab-highlight");
+                    if (node.isConnected) {
+                        node.classList.remove("empirical-element-grab-highlight");
+                    }
                 }, 2000);
             });
         }

package/dist/test/scripts/pw-locator-patch/inner-text.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inner-text.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/inner-text.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,cAAc,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAkBlE"}
+{"version":3,"file":"inner-text.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/inner-text.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,cAAc,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBlE"}

package/dist/test/scripts/pw-locator-patch/inner-text.js

@@ -11,7 +11,9 @@ function patchInnerText(LocatorClass) {
             await this.evaluate((node) => {
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    node.classList.remove("empirical-element-grab-highlight");
+                    if (node.isConnected) {
+                        node.classList.remove("empirical-element-grab-highlight");
+                    }
                 }, 2000);
             });
         }

package/dist/test/scripts/pw-locator-patch/input-value.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"input-value.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/input-value.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAkBnE"}
+{"version":3,"file":"input-value.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/input-value.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBnE"}

package/dist/test/scripts/pw-locator-patch/input-value.js

@@ -11,7 +11,9 @@ function patchInputValue(LocatorClass) {
             await this.evaluate((node) => {
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    node.classList.remove("empirical-element-grab-highlight");
+                    if (node.isConnected) {
+                        node.classList.remove("empirical-element-grab-highlight");
+                    }
                 }, 2000);
             });
         }

package/dist/test/scripts/pw-locator-patch/is-checked.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-checked.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-checked.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,cAAc,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAkBlE"}
+{"version":3,"file":"is-checked.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-checked.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,cAAc,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBlE"}

package/dist/test/scripts/pw-locator-patch/is-checked.js

@@ -11,7 +11,9 @@ function patchIsChecked(LocatorClass) {
             await this.evaluate((node) => {
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    node.classList.remove("empirical-element-grab-highlight");
+                    if (node.isConnected) {
+                        node.classList.remove("empirical-element-grab-highlight");
+                    }
                 }, 2000);
             });
         }

package/dist/test/scripts/pw-locator-patch/is-disabled.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-disabled.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-disabled.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAkBnE"}
+{"version":3,"file":"is-disabled.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-disabled.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBnE"}

package/dist/test/scripts/pw-locator-patch/is-disabled.js

@@ -11,7 +11,9 @@ function patchIsDisabled(LocatorClass) {
             await this.evaluate((node) => {
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    node.classList.remove("empirical-element-grab-highlight");
+                    if (node.isConnected) {
+                        node.classList.remove("empirical-element-grab-highlight");
+                    }
                 }, 2000);
             });
         }

package/dist/test/scripts/pw-locator-patch/is-editable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-editable.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-editable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAkBnE"}
+{"version":3,"file":"is-editable.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-editable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBnE"}

package/dist/test/scripts/pw-locator-patch/is-editable.js

@@ -11,7 +11,9 @@ function patchIsEditable(LocatorClass) {
             await this.evaluate((node) => {
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    node.classList.remove("empirical-element-grab-highlight");
+                    if (node.isConnected) {
+                        node.classList.remove("empirical-element-grab-highlight");
+                    }
                 }, 2000);
             });
         }

package/dist/test/scripts/pw-locator-patch/text-content.d.ts

@@ -0,0 +1,5 @@
+import type { Locator } from "@playwright/test";
+export declare function patchTextContent(LocatorClass: {
+    prototype: Locator;
+}): void;
+//# sourceMappingURL=text-content.d.ts.map

package/dist/test/scripts/pw-locator-patch/text-content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-content.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/text-content.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,gBAAgB,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBpE"}

package/dist/test/scripts/pw-locator-patch/text-content.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patchTextContent = void 0;
+function patchTextContent(LocatorClass) {
+    const originalTextContent = LocatorClass.prototype.textContent;
+    //ref: https://github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L318
+    LocatorClass.prototype.textContent = async function (options) {
+        const result = await originalTextContent.apply(this, [options]);
+        try {
+            await this.scrollIntoViewIfNeeded();
+            await this.evaluate((node) => {
+                node.classList.add("empirical-element-grab-highlight");
+                setTimeout(() => {
+                    if (node.isConnected) {
+                        node.classList.remove("empirical-element-grab-highlight");
+                    }
+                }, 2000);
+            });
+        }
+        catch (e) {
+            console.log("Failed to add highlight for locator method: textContent", e);
+        }
+        return result;
+    };
+}
+exports.patchTextContent = patchTextContent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.4.2",
+  "version": "0.6.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"