@augment-vir/test 31.50.1 → 31.50.2

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

@@ -1,6 +1,6 @@
 import { RuntimeEnvError } from '@augment-vir/core';
 export { type MenuOptionOptions } from '../test-playwright/get-option.js';
-export { playwrightTeatNameUrlParam, type NavPath } from '../test-playwright/nav.js';
+export { playwrightTeatNameUrlParam, type NavOptions } from '../test-playwright/nav.js';
 export { type LocatorScreenshotOptions, type SaveScreenshotOptions, type TakeScreenshotOptions, } from '../test-playwright/screenshot.js';
 declare function importPlaywrightTestApi(this: void): Promise<RuntimeEnvError | {
     navigation: {

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

@@ -1,21 +1,24 @@
 import { type GenericTreePaths } from 'spa-router-vir';
+import { type UrlOverrides } from 'url-vir';
 import { type UniversalTestContext } from '../augments/universal-testing-suite/universal-test-context.js';
 /**
- * Converts {@link NavPath} into an actionable URL string.
+ * Converts {@link NavOptions} into an actionable URL string.
  *
  * @category Internal
  */
-export declare function extractNavUrl(frontendUrl: string, path: NavPath): string;
+export declare function extractNavUrl(testContext: Readonly<UniversalTestContext>, options: Readonly<NavOptions>): string;
 /**
  * Used for the `path` argument of `testPlaywright.nav`.
  *
  * @category Internal
  */
-export type NavPath = /** A full URL to load, will not be appended to the auto detected frontend url. */ string
-/** Path array to append to the auto detected frontend url. */
- | string[]
-/** Prefer using tree paths with `frontendPathTree` */
- | GenericTreePaths;
+export type NavOptions = Omit<UrlOverrides, 'paths'> & {
+    /** If not provided, the page's current URL will be used. */
+    baseFrontendUrl?: string | undefined;
+    paths?: string[]
+    /** Prefer using tree paths with `frontendPathTree` */
+     | GenericTreePaths;
+};
 /**
  * The test name appended to the frontend when `testPlaywright.nav` is used.
  *
@@ -27,8 +30,4 @@ export declare const playwrightTeatNameUrlParam = "test-name";
  *
  * @category Internal
  */
-export declare function navigateTo(testContext: Readonly<UniversalTestContext>, { path, baseFrontendUrl, }: {
-    path: NavPath;
-    /** If not provided, the page's current URL will be used. */
-    baseFrontendUrl?: string | undefined;
-}): Promise<void>;
+export declare function navigateTo(testContext: Readonly<UniversalTestContext>, options: Readonly<NavOptions>): Promise<void>;

package/dist/test-playwright/nav.js

@@ -1,21 +1,26 @@
 import { check } from '@augment-vir/assert';
+import { omitObjectKeys } from '@augment-vir/common';
 import { buildUrl } from 'url-vir';
-import { assertTestContext, extractTestNameAsDir, TestEnv, } from '../augments/universal-testing-suite/universal-test-context.js';
+import { assertTestContext, assertWrapTestContext, extractTestNameAsDir, TestEnv, } from '../augments/universal-testing-suite/universal-test-context.js';
 /**
- * Converts {@link NavPath} into an actionable URL string.
+ * Converts {@link NavOptions} into an actionable URL string.
  *
  * @category Internal
  */
-export function extractNavUrl(frontendUrl, path) {
-    return check.isString(path)
-        ? path
-        : check.isArray(path)
-            ? buildUrl(frontendUrl, {
-                paths: path,
-            }).href
-            : buildUrl(frontendUrl, {
-                paths: path.fullPaths,
-            }).href;
+export function extractNavUrl(testContext, options) {
+    return buildUrl(options.baseFrontendUrl ||
+        assertWrapTestContext(testContext, TestEnv.Playwright).page.url(), {
+        ...omitObjectKeys(options, ['paths']),
+        ...(options.paths
+            ? check.isArray(options.paths)
+                ? {
+                    paths: options.paths,
+                }
+                : {
+                    paths: options.paths.fullPaths,
+                }
+            : {}),
+    }).href;
 }
 /**
  * The test name appended to the frontend when `testPlaywright.nav` is used.
@@ -28,11 +33,11 @@ export const playwrightTeatNameUrlParam = 'test-name';
  *
  * @category Internal
  */
-export async function navigateTo(testContext, { path, baseFrontendUrl, }) {
+export async function navigateTo(testContext, options) {
     assertTestContext(testContext, TestEnv.Playwright);
     const page = testContext.page;
     const testName = extractTestNameAsDir(testContext);
-    const finalPath = buildUrl(extractNavUrl(baseFrontendUrl || page.url(), path), {
+    const finalPath = buildUrl(extractNavUrl(testContext, options), {
         search: {
             [playwrightTeatNameUrlParam]: [testName],
         },

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/test",
-    "version": "31.50.1",
+    "version": "31.50.2",
     "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.1",
-        "@augment-vir/common": "^31.50.1",
+        "@augment-vir/assert": "^31.50.2",
+        "@augment-vir/common": "^31.50.2",
         "@open-wc/testing-helpers": "^3.0.1",
         "@virmator/test": "^14.2.2",
         "type-fest": "^5.2.0"