@guidepup/playwright 0.13.2 → 0.14.1

package/README.md

@@ -6,7 +6,6 @@
 
 ## [Documentation](https://guidepup.dev) | [API Reference](https://www.guidepup.dev/docs/api/class-guidepup)
 
-[![MacOS Big Sur Support](https://img.shields.io/badge/macos-Big_Sur-blue.svg?logo=apple)](https://apps.apple.com/id/app/macos-big-sur/id1526878132)
 [![MacOS Monetary Support](https://img.shields.io/badge/macos-Monetary-blue.svg?logo=apple)](https://apps.apple.com/us/app/macos-monterey/id1576738294)
 [![MacOS Ventura Support](https://img.shields.io/badge/macos-Ventura-blue.svg?logo=apple)](https://apps.apple.com/us/app/macos-ventura/id1638787999)
 [![MacOS Sonoma Support](https://img.shields.io/badge/macos-Somona-blue.svg?logo=apple)](https://apps.apple.com/us/app/macos-sonoma/id6450717509)
@@ -20,7 +19,6 @@ This package provides [Guidepup](https://github.com/guidepup/guidepup) integrati
 
 - **Full Control** - If a screen reader has a keyboard command, then Guidepup supports it.
 - **Mirrors Real User Experience** - Assert on what users really do and hear when using screen readers.
-- **Framework Agnostic** - Run with Jest, with Playwright, as an independent script, no vendor lock-in.
 
 ## Getting Started
 
@@ -110,12 +108,30 @@ await nvda.navigateToWebContent();
 
 // ... some commands
 
-// Collect all spoken phrasees
+// Collect all spoken phrases
 const allSpokenPhrases = [...spokenPhrases, ...(await nvda.spokenPhraseLog())];
 
 // ... do something with spoken phrases
 ```
 
+### Providing Screen Reader Start Options
+
+The options provided to `nvda.start([options])` or `voiceOver.start([options])` can be configured using `test.use(config)` as follows:
+
+```ts
+// VoiceOver Example
+import { voiceOverTest as test } from "@guidepup/playwright";
+
+test.use({ voiceOverStartOptions: { capture: "initial" } });
+```
+
+```ts
+// NVDA Example
+import { nvdaTest as test } from "@guidepup/playwright";
+
+test.use({ nvdaStartOptions: { capture: "initial" } });
+```
+
 ### VoiceOver Example
 
 `playwright.config.ts`:

package/lib/nvdaTest.d.ts

@@ -1,4 +1,8 @@
-import type { NVDA } from "@guidepup/guidepup";
+import type { CommandOptions, NVDA } from "@guidepup/guidepup";
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type CaptureCommandOptions = Prettify<Pick<CommandOptions, "capture">>;
 /**
  * [API Reference](https://www.guidepup.dev/docs/api/class-nvda)
  *
@@ -62,4 +66,11 @@ export declare const nvdaTest: import("@playwright/test").TestType<import("@play
      * ```
      */
     nvda: NVDAPlaywright;
+    /**
+     * [API Reference](https://www.guidepup.dev/docs/api/class-command-options)
+     *
+     * Options to start NVDA with, see also [nvda.start([options])](https://www.guidepup.dev/docs/api/class-nvda#nvda-start).
+     */
+    nvdaStartOptions: CaptureCommandOptions;
 }, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export {};

package/lib/nvdaTest.js

@@ -38,7 +38,8 @@ const focusBrowser = async ({ applicationName, }) => {
  * A fresh started NVDA instance `nvda` is provided to each test.
  */
 exports.nvdaTest = test_1.test.extend({
-    nvda: async ({ browserName, page }, use) => {
+    nvdaStartOptions: {},
+    nvda: async ({ browserName, page, nvdaStartOptions }, use) => {
         try {
             const applicationName = applicationNameMap_1.applicationNameMap[browserName];
             if (!applicationName) {
@@ -70,7 +71,7 @@ exports.nvdaTest = test_1.test.extend({
                 await nvdaPlaywright.clearItemTextLog();
                 await nvdaPlaywright.clearSpokenPhraseLog();
             };
-            await nvdaPlaywright.start();
+            await nvdaPlaywright.start(nvdaStartOptions);
             await use(nvdaPlaywright);
         }
         finally {

package/lib/voiceOverTest.d.ts

@@ -1,4 +1,4 @@
-import type { VoiceOver } from "@guidepup/guidepup";
+import type { CommandOptions, VoiceOver } from "@guidepup/guidepup";
 /**
  * [API Reference](https://www.guidepup.dev/docs/api/class-voiceover)
  *
@@ -66,4 +66,10 @@ export declare const voiceOverTest: import("@playwright/test").TestType<import("
      * ```
      */
     voiceOver: VoiceOverPlaywright;
+    /**
+     * [API Reference](https://www.guidepup.dev/docs/api/class-command-options)
+     *
+     * Options to start VoiceOver with, see also [voiceOver.start([options])](https://www.guidepup.dev/docs/api/class-voiceover#voiceover-start).
+     */
+    voiceOverStartOptions: CommandOptions;
 }, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;

package/lib/voiceOverTest.js

@@ -12,7 +12,8 @@ const voiceOverPlaywright = guidepup_1.voiceOver;
  * A fresh started VoiceOver instance `voiceOver` is provided to each test.
  */
 exports.voiceOverTest = test_1.test.extend({
-    voiceOver: async ({ browserName, page }, use) => {
+    voiceOverStartOptions: {},
+    voiceOver: async ({ browserName, page, voiceOverStartOptions }, use) => {
         try {
             const applicationName = applicationNameMap_1.applicationNameMap[browserName];
             if (!applicationName) {
@@ -32,7 +33,7 @@ exports.voiceOverTest = test_1.test.extend({
                 await voiceOverPlaywright.clearItemTextLog();
                 await voiceOverPlaywright.clearSpokenPhraseLog();
             };
-            await voiceOverPlaywright.start();
+            await voiceOverPlaywright.start(voiceOverStartOptions);
             await (0, guidepup_1.macOSActivate)(applicationName);
             await use(voiceOverPlaywright);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guidepup/playwright",
-  "version": "0.13.2",
+  "version": "0.14.1",
   "description": "Screen reader driver for Playwright tests.",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -42,17 +42,18 @@
     "test:voiceover:webkit": "playwright test --config ./examples/playwright-voiceover/webkit.config.ts ./examples/playwright-voiceover/tests/webkit/"
   },
   "devDependencies": {
-    "@guidepup/guidepup": "^0.22.1",
-    "@playwright/test": "^1.41.1",
-    "@types/node": "^20.11.15",
-    "@typescript-eslint/eslint-plugin": "^6.20.0",
-    "@typescript-eslint/parser": "^6.20.0",
+    "@guidepup/guidepup": "^0.24.0",
+    "@guidepup/record": "^0.1.0",
+    "@playwright/test": "^1.47.1",
+    "@types/node": "^22.5.5",
+    "@typescript-eslint/eslint-plugin": "^8.5.0",
+    "@typescript-eslint/parser": "^8.5.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
-    "rimraf": "^5.0.5",
+    "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.25.7",
-    "typescript": "^5.3.3"
+    "typedoc": "^0.26.7",
+    "typescript": "^5.6.2"
   },
   "peerDependencies": {
     "@guidepup/guidepup": "^0.22.1",