@augment-vir/test 31.50.3 → 31.51.0

package/README.md

@@ -1,10 +1,15 @@
 # @augment-vir/test
 
-A universal testing suite that works with Mocha style test runners _and_ Node.js's built-in test runner with the following main exports:
+A universal testing suite that works with Mocha style test runners, Node.js's built-in test runner, and Playwright tests with the following main exports:
 
 -   [`describe`](https://electrovir.github.io/augment-vir/functions/describe.html): the normal describe test suite function, automatically imported based on the current environment.
 -   [`it`](https://electrovir.github.io/augment-vir/functions/it.html): the normal it test function, automatically imported based on the current environment.
 -   [`itCases`](https://electrovir.github.io/augment-vir/functions/itCases.html): a succinct way to test lots of inputs and outputs to a single function.
--   [`testWeb`](https://electrovir.github.io/augment-vir/variables/testWeb.html): a API of web-testing utilities, only available in browser environments.
+-   [`testWeb`](https://electrovir.github.io/augment-vir/variables/testWeb.html): a API of web testing utilities, only available in browser environments.
+-   [`testPlaywright`](https://electrovir.github.io/augment-vir/variables/testPlaywright.html): a API of Playwright testing utilities, only available in Playwright test environments.
 
 See the docs under `Test`, or `Package: @augment-vir/test` here: https://electrovir.github.io/augment-vir
+
+## Caveats
+
+Playwright does not always set the `PLAYWRIGHT_TEST` env var, especially if you have a playwright config file that imports from TypeScript. If your playwright tests aren't working with this package, try setting `PLAYWRIGHT_TEST="1"` as an env var before calling Playwright (`PLAYWRIGHT_TEST="1" playwright test`).

package/dist/augments/test-playwright.d.ts

@@ -14,16 +14,16 @@ declare function importPlaywrightTestApi(this: void): Promise<RuntimeEnvError |
      */
     expectAllVisible: typeof import("../test-playwright/all-visible.js").expectAllVisible;
     /** Clicks a label to select its input and then types the given text. */
-    enterTextByLabel: typeof import("../test-playwright/enter-text").enterTextByLabel;
+    enterTextByLabel: typeof import("../test-playwright/enter-text.js").enterTextByLabel;
     /** Find the matching (or first) element with the "option" role. */
     getMenuOption: typeof import("../test-playwright/get-option.js").getMenuOption;
     /** Checks if a locator contains the given class. */
-    checkHasClass: typeof import("../test-playwright/has-class").checkHasClass;
+    checkHasClass: typeof import("../test-playwright/has-class.js").checkHasClass;
     /**
      * Run the trigger and catch a new page _or_ a new download (sometimes Playwright
      * inconsistently chooses on or the other).
      */
-    handleNewPageOrDownload: typeof import("../test-playwright/new-page-or-download").handleNewPageOrDownload;
+    handleNewPageOrDownload: typeof import("../test-playwright/new-page-or-download.js").handleNewPageOrDownload;
     /** Read from a page's local storage (using `page.evaluate`). */
     readLocalStorage: typeof import("../test-playwright/local-storage.js").readLocalStorage;
     /** Screenshot methods. */

package/dist/augments/test-playwright.js

@@ -4,12 +4,12 @@ async function importPlaywrightTestApi() {
     if (!isInsidePlaywrightTest()) {
         return new RuntimeEnvError("The 'testPlaywright' api cannot be used outside of a Playwright test context.");
     }
-    const { checkHasClass } = await import('../test-playwright/has-class');
-    const { enterTextByLabel } = await import('../test-playwright/enter-text');
+    const { checkHasClass } = await import('../test-playwright/has-class.js');
+    const { enterTextByLabel } = await import('../test-playwright/enter-text.js');
     const { expectAllVisible } = await import('../test-playwright/all-visible.js');
-    const { getMenuOption } = await import('../test-playwright/get-option');
+    const { getMenuOption } = await import('../test-playwright/get-option.js');
     const { getScreenshotPath, takeScreenshot, expectScreenshot } = await import('../test-playwright/screenshot.js');
-    const { handleNewPageOrDownload } = await import('../test-playwright/new-page-or-download');
+    const { handleNewPageOrDownload } = await import('../test-playwright/new-page-or-download.js');
     const { navigateTo, extractNavUrl } = await import('../test-playwright/nav.js');
     const { readLocalStorage } = await import('../test-playwright/local-storage.js');
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/test",
-    "version": "31.50.3",
+    "version": "31.51.0",
     "description": "A universal testing suite that works with Mocha style test runners _and_ Node.js's built-in test runner.",
     "keywords": [
         "test",
@@ -44,8 +44,8 @@
         "test:web": "virmator test --no-deps web 'src/test-web/**/*.test.ts' 'src/augments/universal-testing-suite/**/*.test.ts'"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.50.3",
-        "@augment-vir/common": "^31.50.3",
+        "@augment-vir/assert": "^31.51.0",
+        "@augment-vir/common": "^31.51.0",
         "@open-wc/testing-helpers": "^3.0.1",
         "@virmator/test": "^14.2.2",
         "type-fest": "^5.2.0"