@empiricalrun/playwright-utils 0.13.12 → 0.13.13

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @empiricalrun/playwright-utils
 
+## 0.13.13
+
+### Patch Changes
+
+- 078c470: chore: add options to highlighter exports to selectively apply
+
 ## 0.13.12
 
 ### Patch Changes

package/dist/test/index.d.ts

@@ -1,7 +1,7 @@
 import type { PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from "@playwright/test";
 import { injectLocatorHighlightScripts } from "./scripts";
-import { EnhancedPlaywrightTestArgs } from "./types";
-export declare const baseTestFixture: (testFn: TestType<EnhancedPlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>) => TestType<EnhancedPlaywrightTestArgs & PlaywrightTestOptions & {
+import { EnhancedPlaywrightTestArgs, HighlighterOpts } from "./types";
+export declare const baseTestFixture: (testFn: TestType<EnhancedPlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>, options?: HighlighterOpts) => TestType<EnhancedPlaywrightTestArgs & PlaywrightTestOptions & {
     [key: string]: any;
 }, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 export { injectLocatorHighlightScripts };

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,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAC;AAErD,eAAO,MAAM,eAAe,WAClB,SACN,0BAA0B,GAAG,qBAAqB,EAClD,oBAAoB,GAAG,uBAAuB,CAC/C;;kDAQF,CAAC;AAEF,OAAO,EAAE,6BAA6B,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,0BAA0B,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAEtE,eAAO,MAAM,eAAe,WAClB,SACN,0BAA0B,GAAG,qBAAqB,EAClD,oBAAoB,GAAG,uBAAuB,CAC/C,YACQ,eAAe;;kDAYzB,CAAC;AAEF,OAAO,EAAE,6BAA6B,EAAE,CAAC"}

package/dist/test/index.js

@@ -3,10 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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) {
+const baseTestFixture = function (testFn, options = {
+    mousePointerHighlighter: true,
+    locatorHighlighter: true,
+    visionMethods: true,
+}) {
     return testFn.extend({
         page: async ({ page }, use) => {
-            (0, scripts_1.injectLocatorHighlightScripts)(page);
+            (0, scripts_1.injectLocatorHighlightScripts)(page, options);
             await use(page);
         },
     });

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

@@ -1,3 +1,4 @@
 import type { Page } from "@playwright/test";
-export declare function injectLocatorHighlightScripts(page: Page): void;
+import { HighlighterOpts } from "../types";
+export declare function injectLocatorHighlightScripts(page: Page, options?: HighlighterOpts): 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;AAM7C,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,IAAI,QAavD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAK3C,wBAAgB,6BAA6B,CAC3C,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,eAIR,QAoBF"}

package/dist/test/scripts/index.js

@@ -4,16 +4,26 @@ exports.injectLocatorHighlightScripts = void 0;
 const locator_highlights_1 = require("./locator-highlights");
 const locator_vision_1 = require("./locator-vision");
 const mouse_pointer_1 = require("./mouse-pointer");
-function injectLocatorHighlightScripts(page) {
+function injectLocatorHighlightScripts(page, options = {
+    mousePointerHighlighter: true,
+    locatorHighlighter: true,
+    visionMethods: true,
+}) {
     // TODO: if this method is used standalone (not through the fixture),
     // then page.locator.query() will throw a type error.
     try {
-        // pointer highlighter and focus highlighter
-        (0, mouse_pointer_1.addMousePointerHighlighter)(page);
-        // playwright locator highlighter
-        (0, locator_highlights_1.addLocatorHighlights)(page);
-        // patch with vision methods
-        (0, locator_vision_1.addLocatorVisionMethods)(page);
+        if (options.mousePointerHighlighter) {
+            // pointer highlighter and focus highlighter
+            (0, mouse_pointer_1.addMousePointerHighlighter)(page);
+        }
+        if (options.locatorHighlighter) {
+            // playwright locator highlighter
+            (0, locator_highlights_1.addLocatorHighlights)(page);
+        }
+        if (options.visionMethods) {
+            // patch with vision methods
+            (0, locator_vision_1.addLocatorVisionMethods)(page);
+        }
     }
     catch (e) {
         console.error("Failed to add mouse pointer highlighter", e);

package/dist/test/types.d.ts

@@ -1,4 +1,9 @@
 import type { Locator, Page, PlaywrightTestArgs } from "@playwright/test";
+export type HighlighterOpts = {
+    mousePointerHighlighter?: boolean;
+    locatorHighlighter?: boolean;
+    visionMethods?: boolean;
+};
 interface EnhancedLocator extends Locator {
     query(instruction: string): Promise<string>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/test/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE1E,UAAU,eAAgB,SAAQ,OAAO;IACvC,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7C;AAED,UAAU,YAAa,SAAQ,IAAI;IAEjC,OAAO,CACL,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;QACR,GAAG,CAAC,EAAE,OAAO,CAAC;QACd,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KAC3B,GACA,eAAe,CAAC;IACnB,SAAS,CACP,IAAI,EACA,OAAO,GACP,aAAa,GACb,aAAa,GACb,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,cAAc,GACd,UAAU,GACV,eAAe,GACf,aAAa,GACb,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,WAAW,GACX,UAAU,GACV,UAAU,GACV,MAAM,GACN,QAAQ,GACR,MAAM,GACN,SAAS,GACT,MAAM,GACN,UAAU,GACV,OAAO,GACP,SAAS,GACT,KAAK,GACL,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,KAAK,GACL,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,MAAM,GACN,SAAS,GACT,UAAU,GACV,kBAAkB,GAClB,eAAe,GACf,YAAY,GACZ,MAAM,GACN,MAAM,GACN,QAAQ,GACR,WAAW,GACX,cAAc,GACd,aAAa,GACb,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,KAAK,GACL,UAAU,GACV,WAAW,GACX,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,aAAa,GACb,QAAQ,GACR,KAAK,GACL,OAAO,GACP,SAAS,GACT,UAAU,GACV,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,SAAS,GACT,SAAS,GACT,MAAM,GACN,UAAU,GACV,UAAU,EACd,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,GACA,eAAe,CAAC;IACnB,UAAU,CACR,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5B,eAAe,CAAC;IACnB,gBAAgB,CACd,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5B,eAAe,CAAC;IACnB,SAAS,CACP,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5B,eAAe,CAAC;IACnB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,eAAe,CAAC;IACtD,YAAY,CACV,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5B,eAAe,CAAC;IACnB,UAAU,CACR,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5B,eAAe,CAAC;CACpB;AAED,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE,IAAI,EAAE,YAAY,CAAC;CACpB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/test/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE1E,MAAM,MAAM,eAAe,GAAG;IAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,UAAU,eAAgB,SAAQ,OAAO;IACvC,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7C;AAED,UAAU,YAAa,SAAQ,IAAI;IAEjC,OAAO,CACL,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;QACR,GAAG,CAAC,EAAE,OAAO,CAAC;QACd,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KAC3B,GACA,eAAe,CAAC;IACnB,SAAS,CACP,IAAI,EACA,OAAO,GACP,aAAa,GACb,aAAa,GACb,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,cAAc,GACd,UAAU,GACV,eAAe,GACf,aAAa,GACb,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,WAAW,GACX,UAAU,GACV,UAAU,GACV,MAAM,GACN,QAAQ,GACR,MAAM,GACN,SAAS,GACT,MAAM,GACN,UAAU,GACV,OAAO,GACP,SAAS,GACT,KAAK,GACL,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,KAAK,GACL,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,MAAM,GACN,SAAS,GACT,UAAU,GACV,kBAAkB,GAClB,eAAe,GACf,YAAY,GACZ,MAAM,GACN,MAAM,GACN,QAAQ,GACR,WAAW,GACX,cAAc,GACd,aAAa,GACb,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,KAAK,GACL,UAAU,GACV,WAAW,GACX,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,aAAa,GACb,QAAQ,GACR,KAAK,GACL,OAAO,GACP,SAAS,GACT,UAAU,GACV,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,SAAS,GACT,SAAS,GACT,MAAM,GACN,UAAU,GACV,UAAU,EACd,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,GACA,eAAe,CAAC;IACnB,UAAU,CACR,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5B,eAAe,CAAC;IACnB,gBAAgB,CACd,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5B,eAAe,CAAC;IACnB,SAAS,CACP,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5B,eAAe,CAAC;IACnB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,eAAe,CAAC;IACtD,YAAY,CACV,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5B,eAAe,CAAC;IACnB,UAAU,CACR,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5B,eAAe,CAAC;CACpB;AAED,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE,IAAI,EAAE,YAAY,CAAC;CACpB"}

package/package.json

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