@guidepup/playwright 0.19.0 → 0.20.0

package/lib/voiceOverTest.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.voiceOverTest = void 0;
-const test_1 = require("@playwright/test");
 const guidepup_1 = require("@guidepup/guidepup");
-const applicationNameMap_1 = require("./applicationNameMap");
-const delay_1 = require("./delay");
+const applicationIdMap_1 = require("./applicationIdMap");
+const navigateVoiceOverToWebContent_1 = require("./navigateVoiceOverToWebContent");
+const test_1 = require("@playwright/test");
 const voiceOverPlaywright = guidepup_1.voiceOver;
 /**
  * These tests extend the default Playwright environment that launches the
- * browser with a running instance of the VoiceOver screen reader for MacOS.
+ * browser with a running instance of the VoiceOver screen reader for macOS.
  *
  * A fresh started VoiceOver instance `voiceOver` is provided to each test.
  */
@@ -16,82 +16,16 @@ exports.voiceOverTest = test_1.test.extend({
     voiceOverStartOptions: { capture: "initial" },
     voiceOver: async ({ browserName, page, voiceOverStartOptions }, use) => {
         try {
-            const applicationName = applicationNameMap_1.applicationNameMap[browserName];
-            if (!applicationName) {
-                throw new Error(`Browser ${browserName} is not installed.`);
+            const applicationId = applicationIdMap_1.applicationIdMap[browserName];
+            if (!applicationId) {
+                throw new Error(`Browser ${browserName} is not recognised.`);
             }
-            voiceOverPlaywright.navigateToWebContent = async ({ capture } = {}) => {
-                // Ensure application is brought to front and focused.
-                await (0, guidepup_1.macOSActivate)(applicationName);
-                // Cancel auto navigation.
-                await voiceOverPlaywright.perform({ keyCode: guidepup_1.MacOSKeyCodes.Control }, { capture: false });
-                await (0, delay_1.delay)(100);
-                // Ensure the document is ready and focused.
-                await page.bringToFront();
-                await page.locator("body").waitFor();
-                try {
-                    // Add an interactive marker to the page that will force VoiceOver
-                    // to listen to events emitted by Playwright interactions when
-                    // navigated to.
-                    await page.evaluate(() => {
-                        const marker = document.createElement("input");
-                        marker.id = "__guidepup_marker__";
-                        marker.type = "text";
-                        marker.value = "Guidepup Marker";
-                        marker.readOnly = true;
-                        marker.tabIndex = -1;
-                        marker.autocomplete = "off";
-                        marker.setAttribute("aria-label", "Guidepup Marker");
-                        marker.style.cssText = `
-              position: absolute;
-              width: 1px;
-              height: 1px;
-              overflow: hidden;
-              clip: rect(0 0 0 0);
-              white-space: nowrap;
-            `;
-                        document.body.prepend(marker);
-                    });
-                    // Open the web item chooser.
-                    await voiceOverPlaywright.perform(voiceOverPlaywright.keyboardCommands.openItemChooser, { capture: false });
-                    await (0, delay_1.delay)(500);
-                    // Filter by "web content" - currently web content items for all browsers
-                    // are suffixed by "web content".
-                    for (const character of "web content") {
-                        await voiceOverPlaywright.type(character, { capture: false });
-                        await (0, delay_1.delay)(100);
-                    }
-                    // Select the web content window spot.
-                    await voiceOverPlaywright.perform({ keyCode: guidepup_1.MacOSKeyCodes.Enter }, { capture: false });
-                    await (0, delay_1.delay)(100);
-                    // Navigate into web content.
-                    await voiceOverPlaywright.interact({ capture: false });
-                    await (0, delay_1.delay)(100);
-                    // Navigate to the beginning of the web content.
-                    await voiceOverPlaywright.perform(voiceOverPlaywright.keyboardCommands.moveToBeginningOfText, { capture: false });
-                    await (0, delay_1.delay)(100);
-                    // Cancel auto navigation
-                    await voiceOverPlaywright.perform({ keyCode: guidepup_1.MacOSKeyCodes.Control }, { capture: false });
-                    await (0, delay_1.delay)(100);
-                    // Navigate to the Guidepup marker element at beginning of the web
-                    // content.
-                    await voiceOverPlaywright.perform(voiceOverPlaywright.keyboardCommands.moveToBeginningOfText, { capture: false });
-                    await (0, delay_1.delay)(100);
-                    // Navigate to the first element of the page using the provided
-                    // capture settings.
-                    await voiceOverPlaywright.next({ capture });
-                }
-                finally {
-                    // Remove the temporary Guidepup marker element to restore original
-                    // page structure.
-                    await page.evaluate(() => {
-                        const marker = document.querySelector("#__guidepup_marker__");
-                        if (marker) {
-                            document.body.removeChild(marker);
-                        }
-                    });
-                }
-            };
+            voiceOverPlaywright.navigateToWebContent = ({ capture } = {}) => (0, navigateVoiceOverToWebContent_1.navigateVoiceOverToWebContent)({
+                voiceOver: voiceOverPlaywright,
+                page,
+                applicationId,
+                capture,
+            });
             await voiceOverPlaywright.start(voiceOverStartOptions);
             await use(voiceOverPlaywright);
         }

package/lib/withGuidepup.d.ts

@@ -0,0 +1,2 @@
+import type { PlaywrightTestConfig } from "@playwright/test";
+export declare const withGuidepup: (config: PlaywrightTestConfig) => PlaywrightTestConfig;

package/lib/withGuidepup.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withGuidepup = void 0;
+const screenReaderConfig_1 = require("./screenReaderConfig");
+const withGuidepup = (config) => ({
+    ...config,
+    workers: screenReaderConfig_1.screenReaderConfig.workers,
+    fullyParallel: screenReaderConfig_1.screenReaderConfig.fullyParallel,
+    use: {
+        ...config.use,
+        ...screenReaderConfig_1.screenReaderConfig.use,
+    },
+    projects: config.projects?.map((project) => ({
+        ...project,
+        use: {
+            ...project.use,
+            ...screenReaderConfig_1.screenReaderConfig.use,
+        },
+    })),
+});
+exports.withGuidepup = withGuidepup;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guidepup/playwright",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "Screen reader automation library for Playwright testing. ",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -34,19 +34,22 @@
     "prepublish": "yarn build",
     "pretest": "npx playwright install chromium firefox webkit",
     "test:nvda": "yarn test:nvda:chromium && yarn test:nvda:firefox",
-    "test:screenreader": "yarn test:screenreader:chromium",
+    "test:orca": "yarn test:orca:firefox",
+    "test:screenreader": "yarn test:screenreader:chromium && yarn test:screenreader:firefox",
     "test:voiceover": "yarn test:voiceover:chromium && yarn test:voiceover:firefox && yarn test:voiceover:webkit",
     "test:nvda:chromium": "playwright test --config ./examples/playwright-nvda/chromium.config.ts ./examples/playwright-nvda/tests/chromium/",
     "test:nvda:firefox": "playwright test --config ./examples/playwright-nvda/firefox.config.ts ./examples/playwright-nvda/tests/firefox/",
+    "test:orca:firefox": "playwright test --config ./examples/playwright-orca/firefox.config.ts ./examples/playwright-orca/tests/firefox/",
     "test:screenreader:chromium": "playwright test --config ./examples/playwright-screenreader/chromium.config.ts ./examples/playwright-screenreader/tests/chromium/",
+    "test:screenreader:firefox": "playwright test --config ./examples/playwright-screenreader/firefox.config.ts ./examples/playwright-screenreader/tests/firefox/",
     "test:voiceover:chromium": "playwright test --config ./examples/playwright-voiceover/chromium.config.ts ./examples/playwright-voiceover/tests/chromium/",
     "test:voiceover:firefox": "playwright test --config ./examples/playwright-voiceover/firefox.config.ts ./examples/playwright-voiceover/tests/firefox/",
     "test:voiceover:webkit": "playwright test --config ./examples/playwright-voiceover/webkit.config.ts ./examples/playwright-voiceover/tests/webkit/"
   },
   "devDependencies": {
-    "@guidepup/guidepup": "^0.33.0",
-    "@guidepup/record": "^0.1.0",
-    "@playwright/test": "^1.60.0",
+    "@guidepup/guidepup": "^0.36.1",
+    "@guidepup/record": "^0.3.0",
+    "@playwright/test": "^1.62.1",
     "@types/node": "^24.10.1",
     "@typescript-eslint/eslint-plugin": "^8.48.1",
     "@typescript-eslint/parser": "^8.48.1",
@@ -58,8 +61,8 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@guidepup/guidepup": ">=0.33.0",
-    "@playwright/test": "^1.57.0"
+    "@guidepup/guidepup": ">=0.36.1",
+    "@playwright/test": ">=1.62.1"
   },
   "resolutions": {
     "strip-ansi": "6.0.1",