@elliemae/smoked-suite 26.2.21 → 26.2.23

package/dist/cjs/base-page/index.js

@@ -55,4 +55,32 @@ class BasePage {
   getByTitle(text, options) {
     return this.page.getByTitle(text, options);
   }
+  // ─── Action helpers ──────────────────────────────────────────────────────────
+  /**
+   * Click a locator that triggers a navigation (react-router `navigate()`,
+   * browser back/forward, an `<a>` tag, a form submit that redirects, etc.)
+   * and wait for the URL to match before resolving.
+   *
+   * Using this helper instead of an ad-hoc `click()` + `toBeVisible()` pattern
+   * eliminates the race between the router and the DOM assertion — which
+   * manifests as flaky/slow CI runs even though local runs pass.
+   * @param locator - The element to click.
+   * @param urlPattern - Expected post-navigation URL (string or regex).
+   * @param options - Forwarded to `page.waitForURL`.
+   * @example
+   * ```ts
+   * // In a spec
+   * await this.auditPage.clickAndWaitForURL(
+   *   this.auditPage.backButton,
+   *   /\/admin\/oneadmin\/migrate(?:\/)?$/,
+   * );
+   * await expect(this.settingsPage.container).toBeVisible();
+   * ```
+   */
+  async clickAndWaitForURL(locator, urlPattern, options) {
+    await Promise.all([
+      this.page.waitForURL(urlPattern, options),
+      locator.click()
+    ]);
+  }
 }

package/dist/esm/base-page/index.js

@@ -32,6 +32,34 @@ class BasePage {
   getByTitle(text, options) {
     return this.page.getByTitle(text, options);
   }
+  // ─── Action helpers ──────────────────────────────────────────────────────────
+  /**
+   * Click a locator that triggers a navigation (react-router `navigate()`,
+   * browser back/forward, an `<a>` tag, a form submit that redirects, etc.)
+   * and wait for the URL to match before resolving.
+   *
+   * Using this helper instead of an ad-hoc `click()` + `toBeVisible()` pattern
+   * eliminates the race between the router and the DOM assertion — which
+   * manifests as flaky/slow CI runs even though local runs pass.
+   * @param locator - The element to click.
+   * @param urlPattern - Expected post-navigation URL (string or regex).
+   * @param options - Forwarded to `page.waitForURL`.
+   * @example
+   * ```ts
+   * // In a spec
+   * await this.auditPage.clickAndWaitForURL(
+   *   this.auditPage.backButton,
+   *   /\/admin\/oneadmin\/migrate(?:\/)?$/,
+   * );
+   * await expect(this.settingsPage.container).toBeVisible();
+   * ```
+   */
+  async clickAndWaitForURL(locator, urlPattern, options) {
+    await Promise.all([
+      this.page.waitForURL(urlPattern, options),
+      locator.click()
+    ]);
+  }
 }
 export {
   BasePage

package/dist/types/lib/auth/index.d.ts

@@ -1,5 +1,5 @@
-import { Page } from '@playwright/test';
-import { AuthState, Credentials } from '../types.js';
+import type { Page } from '@playwright/test';
+import type { AuthState, Credentials } from '../types.js';
 /**
  * Manages the encw authentication lifecycle.
  *

package/dist/types/lib/base-page/index.d.ts

@@ -1,5 +1,5 @@
-import { Page, Locator } from '@playwright/test';
-import { AppContext, ContextProvider } from '../types.js';
+import type { Page, Locator } from '@playwright/test';
+import type { AppContext, ContextProvider } from '../types.js';
 /**
  * Base page object class for encw apps.
  *
@@ -24,4 +24,26 @@ export declare abstract class BasePage {
     protected getByPlaceholder(text: string | RegExp, options?: Parameters<Page['getByPlaceholder']>[1]): Locator;
     protected getByAltText(text: string | RegExp, options?: Parameters<Page['getByAltText']>[1]): Locator;
     protected getByTitle(text: string | RegExp, options?: Parameters<Page['getByTitle']>[1]): Locator;
+    /**
+     * Click a locator that triggers a navigation (react-router `navigate()`,
+     * browser back/forward, an `<a>` tag, a form submit that redirects, etc.)
+     * and wait for the URL to match before resolving.
+     *
+     * Using this helper instead of an ad-hoc `click()` + `toBeVisible()` pattern
+     * eliminates the race between the router and the DOM assertion — which
+     * manifests as flaky/slow CI runs even though local runs pass.
+     * @param locator - The element to click.
+     * @param urlPattern - Expected post-navigation URL (string or regex).
+     * @param options - Forwarded to `page.waitForURL`.
+     * @example
+     * ```ts
+     * // In a spec
+     * await this.auditPage.clickAndWaitForURL(
+     *   this.auditPage.backButton,
+     *   /\/admin\/oneadmin\/migrate(?:\/)?$/,
+     * );
+     * await expect(this.settingsPage.container).toBeVisible();
+     * ```
+     */
+    clickAndWaitForURL(locator: Locator, urlPattern: string | RegExp, options?: Parameters<Page['waitForURL']>[1]): Promise<void>;
 }

package/dist/types/lib/base-test/index.d.ts

@@ -1,5 +1,5 @@
-import { Page, Expect } from '@playwright/test';
-import { Credentials, GotoOptions } from '../types.js';
+import type { Page, Expect } from '@playwright/test';
+import type { Credentials, GotoOptions } from '../types.js';
 /**
  * Base class for Playwright test specs that run against
  * apps hosted inside the encw (Encompass Web) shell.

package/dist/types/lib/monocartCoverage/index.d.ts

@@ -1,4 +1,4 @@
-import { type Page, PlaywrightTestConfig } from '@playwright/test';
+import type { PlaywrightTestConfig, Page } from '@playwright/test';
 /**
  * Mark coverage as configured. Called by {@link createPlaywrightConfig}
  * when a `coverage` config is provided — no env var needed.

package/dist/types/lib/page-setup/index.d.ts

@@ -1,4 +1,4 @@
-import { Page } from '@playwright/test';
+import type { Page } from '@playwright/test';
 /**
  * Registers init scripts and route blocks on a Playwright page.
  *

package/dist/types/lib/types.d.ts

@@ -1,4 +1,5 @@
-import { Page } from '@playwright/test';
+import type { Page, PlaywrightTestConfig } from '@playwright/test';
+import type { CoverageConfig } from './monocartCoverage/index.js';
 /** Page context for element interaction. */
 export type AppContext = Page;
 /**
@@ -38,7 +39,7 @@ export interface GotoOptions {
  */
 export interface SmokedSuiteConfig {
     /** Partial Playwright config to merge with sensible defaults. */
-    overrides?: import('@playwright/test').PlaywrightTestConfig;
+    overrides?: PlaywrightTestConfig;
     /**
      * When `true` (default), a `globalSetup` function runs once before
      * all workers to authenticate and persist the session to disk.
@@ -73,5 +74,5 @@ export interface SmokedSuiteConfig {
      * });
      * ```
      */
-    coverage?: import('./monocartCoverage/index.js').CoverageConfig[];
+    coverage?: CoverageConfig[];
 }