rwsdk 1.0.0-alpha.9 → 1.0.0-beta.1

package/dist/lib/e2e/testHarness.d.mts

@@ -1,8 +1,6 @@
-import type { Browser, Page } from "puppeteer-core";
-interface PlaygroundEnvironment {
-    projectDir: string;
-    cleanup: () => Promise<void>;
-}
+import { type Browser, type Page } from "puppeteer-core";
+import { test } from "vitest";
+export type { Browser, Page } from "puppeteer-core";
 interface DevServerInstance {
     url: string;
     stopDev: () => Promise<void>;
@@ -12,39 +10,48 @@ interface DeploymentInstance {
     workerName: string;
     resourceUniqueKey: string;
     projectDir: string;
+    cleanup: () => Promise<void>;
+}
+export interface SetupPlaygroundEnvironmentOptions {
+    /**
+     * The directory of the playground project to set up.
+     * Can be an absolute path, or a `import.meta.url` `file://` string.
+     * If not provided, it will be inferred from the test file's path.
+     */
+    sourceProjectDir?: string;
+    /**
+     * The root directory of the monorepo, if the project is part of one.
+     * This is used to correctly set up the test environment for monorepo projects.
+     */
+    monorepoRoot?: string;
+    /**
+     * Whether to provision a dev server for the test suite.
+     * @default true
+     */
+    dev?: boolean;
+    /**
+     * Whether to provision a deployment for the test suite.
+     * @default true
+     */
+    deploy?: boolean;
 }
 /**
- * Sets up a playground environment for the entire test suite.
- * Automatically registers beforeAll and afterAll hooks.
- *
- * @param sourceProjectDir - Explicit path to playground directory, or import.meta.url to auto-detect
- */
-export declare function setupPlaygroundEnvironment(sourceProjectDir?: string): void;
-/**
- * Gets the current playground environment.
- * Throws if no environment has been set up.
+ * A Vitest hook that sets up a playground environment for a test file.
+ * It creates a temporary directory, copies the playground project into it,
+ * and installs dependencies using a tarball of the SDK.
+ * This ensures that tests run in a clean, isolated environment.
  */
-export declare function getPlaygroundEnvironment(): PlaygroundEnvironment;
+export declare function setupPlaygroundEnvironment(options?: string | SetupPlaygroundEnvironmentOptions): void;
 /**
  * Creates a dev server instance using the shared playground environment.
  * Automatically registers cleanup to run after the test.
  */
-export declare function createDevServer(): Promise<DevServerInstance>;
+export declare function createDevServer(projectDir: string): Promise<DevServerInstance>;
 /**
  * Creates a deployment instance using the shared playground environment.
  * Automatically registers cleanup to run after the test.
  */
-export declare function createDeployment(): Promise<DeploymentInstance>;
-/**
- * Manually cleans up a deployment instance (deletes worker and D1 database).
- * This is optional since cleanup happens automatically after each test.
- */
-export declare function cleanupDeployment(deployment: DeploymentInstance): Promise<void>;
-/**
- * Creates a browser instance for testing.
- * Automatically registers cleanup to run after the test.
- */
-export declare function createBrowser(): Promise<Browser>;
+export declare function createDeployment(projectDir: string): Promise<DeploymentInstance>;
 /**
  * Executes a test function with a retry mechanism for specific error codes.
  * @param name - The name of the test, used for logging.
@@ -53,23 +60,24 @@ export declare function createBrowser(): Promise<Browser>;
  *                     return a cleanup function. The cleanup function will be
  *                     called automatically on failure.
  */
-export declare function runTestWithRetries(name: string, attemptFn: () => Promise<{
-    cleanup: () => Promise<void>;
-}>): Promise<void>;
+export declare function runTestWithRetries(name: string, attemptFn: () => Promise<void>): Promise<void>;
+declare function createTestRunner(testFn: (typeof test | typeof test.only)["concurrent"], envType: "dev" | "deploy"): (name: string, testLogic: (context: {
+    devServer?: DevServerInstance;
+    deployment?: DeploymentInstance;
+    browser: Browser;
+    page: Page;
+    url: string;
+}) => Promise<void>) => void;
 /**
  * High-level test wrapper for dev server tests.
  * Automatically skips if RWSDK_SKIP_DEV=1
  */
-export declare function testDev(name: string, testFn: (context: {
-    devServer: DevServerInstance;
-    browser: Browser;
-    page: Page;
-    url: string;
-}) => Promise<void>): void;
+export declare function testDev(...args: Parameters<ReturnType<typeof createTestRunner>>): void;
 export declare namespace testDev {
     var skip: (name: string, testFn?: any) => void;
-    var only: (name: string, testFn: (context: {
-        devServer: DevServerInstance;
+    var only: (name: string, testLogic: (context: {
+        devServer?: DevServerInstance;
+        deployment?: DeploymentInstance;
         browser: Browser;
         page: Page;
         url: string;
@@ -79,16 +87,12 @@ export declare namespace testDev {
  * High-level test wrapper for deployment tests.
  * Automatically skips if RWSDK_SKIP_DEPLOY=1
  */
-export declare function testDeploy(name: string, testFn: (context: {
-    deployment: DeploymentInstance;
-    browser: Browser;
-    page: Page;
-    url: string;
-}) => Promise<void>): void;
+export declare function testDeploy(...args: Parameters<ReturnType<typeof createTestRunner>>): void;
 export declare namespace testDeploy {
     var skip: (name: string, testFn?: any) => void;
-    var only: (name: string, testFn: (context: {
-        deployment: DeploymentInstance;
+    var only: (name: string, testLogic: (context: {
+        devServer?: DevServerInstance;
+        deployment?: DeploymentInstance;
         browser: Browser;
         page: Page;
         url: string;
@@ -116,8 +120,13 @@ export declare namespace testDevAndDeploy {
     }) => Promise<void>) => void;
 }
 /**
- * Utility function for polling/retrying assertions
+ * Waits for the page to be fully loaded and hydrated.
+ * This should be used before any user interaction is simulated.
  */
-export declare function poll(fn: () => Promise<boolean>, timeout?: number, // 2 minutes
-interval?: number): Promise<void>;
-export {};
+export declare function waitForHydration(page: Page): Promise<void>;
+export declare function trackPageErrors(page: Page): {
+    get: () => {
+        consoleErrors: string[];
+        failedRequests: string[];
+    };
+};