@nuxt/test-utils 3.10.0 → 3.12.0

package/dist/config.mjs

@@ -176,6 +176,7 @@ async function getVitestConfigFromNuxt(options, loadNuxtOptions = {}) {
     }
   );
   delete resolvedConfig.define["process.browser"];
+  delete resolvedConfig.customLogger;
   if (!Array.isArray(resolvedConfig.test.setupFiles)) {
     resolvedConfig.test.setupFiles = [resolvedConfig.test.setupFiles].filter(Boolean);
   }

package/dist/e2e.d.mts

@@ -1,55 +1,9 @@
-import * as playwright_core from 'playwright-core';
-import { Browser, BrowserContextOptions, LaunchOptions } from 'playwright-core';
-import { NuxtConfig, Nuxt } from '@nuxt/schema';
-import { ExecaChildProcess } from 'execa';
+import { T as TestOptions, a as TestContext, b as TestHooks } from './shared/test-utils.9059LSjm.mjs';
+export { G as GotoOptions, e as TestRunner, c as createBrowser, d as createPage, g as getBrowser, w as waitForHydration } from './shared/test-utils.9059LSjm.mjs';
 import { FetchOptions } from 'ofetch';
-
-declare function createBrowser(): Promise<void>;
-declare function getBrowser(): Promise<Browser>;
-declare function createPage(path?: string, options?: BrowserContextOptions): Promise<playwright_core.Page>;
-
-type TestRunner = 'vitest' | 'jest' | 'cucumber';
-interface TestOptions {
-    testDir: string;
-    fixture: string;
-    configFile: string;
-    rootDir: string;
-    buildDir: string;
-    nuxtConfig: NuxtConfig;
-    build: boolean;
-    dev: boolean;
-    setupTimeout: number;
-    waitFor: number;
-    browser: boolean;
-    runner: TestRunner;
-    logLevel: number;
-    browserOptions: {
-        type: 'chromium' | 'firefox' | 'webkit';
-        launch?: LaunchOptions;
-    };
-    server: boolean;
-    port?: number;
-}
-interface TestContext {
-    options: TestOptions;
-    nuxt?: Nuxt;
-    browser?: Browser;
-    url?: string;
-    serverProcess?: ExecaChildProcess;
-    mockFn?: Function;
-    /**
-     * Functions to run on the vitest `afterAll` hook.
-     * Useful for removing anything created during the test.
-     */
-    teardown?: (() => void)[];
-}
-interface TestHooks {
-    beforeEach: () => void;
-    afterEach: () => void;
-    afterAll: () => Promise<void>;
-    setup: () => Promise<void>;
-    ctx: TestContext;
-}
+import 'playwright-core';
+import '@nuxt/schema';
+import 'execa';
 
 declare function createTestContext(options: Partial<TestOptions>): TestContext;
 declare function useTestContext(): TestContext;
@@ -97,4 +51,4 @@ interface RunTestOptions {
 }
 declare function runTests(opts: RunTestOptions): Promise<void>;
 
-export { $fetch, type RunTestOptions, type StartServerOptions, type TestContext, type TestHooks, type TestOptions, type TestRunner, buildFixture, createBrowser, createPage, createTest, createTestContext, exposeContextToEnv, fetch, getBrowser, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };
+export { $fetch, type RunTestOptions, type StartServerOptions, TestContext, TestHooks, TestOptions, buildFixture, createTest, createTestContext, exposeContextToEnv, fetch, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };

package/dist/e2e.d.ts

@@ -1,55 +1,9 @@
-import * as playwright_core from 'playwright-core';
-import { Browser, BrowserContextOptions, LaunchOptions } from 'playwright-core';
-import { NuxtConfig, Nuxt } from '@nuxt/schema';
-import { ExecaChildProcess } from 'execa';
+import { T as TestOptions, a as TestContext, b as TestHooks } from './shared/test-utils.9059LSjm.js';
+export { G as GotoOptions, e as TestRunner, c as createBrowser, d as createPage, g as getBrowser, w as waitForHydration } from './shared/test-utils.9059LSjm.js';
 import { FetchOptions } from 'ofetch';
-
-declare function createBrowser(): Promise<void>;
-declare function getBrowser(): Promise<Browser>;
-declare function createPage(path?: string, options?: BrowserContextOptions): Promise<playwright_core.Page>;
-
-type TestRunner = 'vitest' | 'jest' | 'cucumber';
-interface TestOptions {
-    testDir: string;
-    fixture: string;
-    configFile: string;
-    rootDir: string;
-    buildDir: string;
-    nuxtConfig: NuxtConfig;
-    build: boolean;
-    dev: boolean;
-    setupTimeout: number;
-    waitFor: number;
-    browser: boolean;
-    runner: TestRunner;
-    logLevel: number;
-    browserOptions: {
-        type: 'chromium' | 'firefox' | 'webkit';
-        launch?: LaunchOptions;
-    };
-    server: boolean;
-    port?: number;
-}
-interface TestContext {
-    options: TestOptions;
-    nuxt?: Nuxt;
-    browser?: Browser;
-    url?: string;
-    serverProcess?: ExecaChildProcess;
-    mockFn?: Function;
-    /**
-     * Functions to run on the vitest `afterAll` hook.
-     * Useful for removing anything created during the test.
-     */
-    teardown?: (() => void)[];
-}
-interface TestHooks {
-    beforeEach: () => void;
-    afterEach: () => void;
-    afterAll: () => Promise<void>;
-    setup: () => Promise<void>;
-    ctx: TestContext;
-}
+import 'playwright-core';
+import '@nuxt/schema';
+import 'execa';
 
 declare function createTestContext(options: Partial<TestOptions>): TestContext;
 declare function useTestContext(): TestContext;
@@ -97,4 +51,4 @@ interface RunTestOptions {
 }
 declare function runTests(opts: RunTestOptions): Promise<void>;
 
-export { $fetch, type RunTestOptions, type StartServerOptions, type TestContext, type TestHooks, type TestOptions, type TestRunner, buildFixture, createBrowser, createPage, createTest, createTestContext, exposeContextToEnv, fetch, getBrowser, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };
+export { $fetch, type RunTestOptions, type StartServerOptions, TestContext, TestHooks, TestOptions, buildFixture, createTest, createTestContext, exposeContextToEnv, fetch, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };

package/dist/e2e.mjs

@@ -1,52 +1,18 @@
-import { u as useTestContext, a as url, c as createTestContext, s as setTestContext, b as stopServer, d as startServer } from './shared/test-utils.JYxxBhQl.mjs';
-export { $ as $fetch, e as exposeContextToEnv, f as fetch, i as isDev, r as recoverContextFromEnv } from './shared/test-utils.JYxxBhQl.mjs';
+import { d as distDir } from './shared/test-utils.B57u8E0c.mjs';
+export { b as buildFixture, c as createBrowser, a as createPage, e as createTest, g as getBrowser, l as loadFixture, f as setup, s as setupMaps, w as waitForHydration } from './shared/test-utils.B57u8E0c.mjs';
+import { u as useTestContext } from './shared/test-utils.BegIhSnH.mjs';
+export { $ as $fetch, c as createTestContext, e as exposeContextToEnv, f as fetch, i as isDev, r as recoverContextFromEnv, s as setTestContext, a as startServer, b as stopServer, d as url } from './shared/test-utils.BegIhSnH.mjs';
 import { consola } from 'consola';
-import { existsSync, promises } from 'node:fs';
-import { resolve } from 'node:path';
-import { defu } from 'defu';
-import * as _kit from '@nuxt/kit';
-import { dirname, resolve as resolve$1 } from 'pathe';
-import { fileURLToPath } from 'node:url';
+import { resolve } from 'pathe';
+import 'node:fs';
+import 'node:path';
+import 'defu';
+import '@nuxt/kit';
+import 'node:url';
 import 'execa';
 import 'get-port-please';
 import 'ofetch';
 
-async function createBrowser() {
-  const ctx = useTestContext();
-  let playwright;
-  try {
-    playwright = await import(
-      /* vite-ignore */
-      'playwright-core'
-    );
-  } catch {
-    throw new Error(`
-      The dependency 'playwright-core' not found.
-      Please run 'yarn add --dev playwright-core' or 'npm install --save-dev playwright-core'
-    `);
-  }
-  const { type, launch } = ctx.options.browserOptions;
-  if (!playwright[type]) {
-    throw new Error(`Invalid browser '${type}'`);
-  }
-  ctx.browser = await playwright[type].launch(launch);
-}
-async function getBrowser() {
-  const ctx = useTestContext();
-  if (!ctx.browser) {
-    await createBrowser();
-  }
-  return ctx.browser;
-}
-async function createPage(path, options) {
-  const browser = await getBrowser();
-  const page = await browser.newPage(options);
-  if (path) {
-    await page.goto(url(path));
-  }
-  return page;
-}
-
 function mockFn() {
   const ctx = useTestContext();
   return ctx.mockFn;
@@ -60,146 +26,6 @@ function mockLogger() {
   return mocks;
 }
 
-const kit = _kit.default || _kit;
-const isNuxtApp = (dir) => {
-  return existsSync(dir) && (existsSync(resolve(dir, "pages")) || existsSync(resolve(dir, "nuxt.config.js")) || existsSync(resolve(dir, "nuxt.config.mjs")) || existsSync(resolve(dir, "nuxt.config.cjs")) || existsSync(resolve(dir, "nuxt.config.ts")));
-};
-const resolveRootDir = () => {
-  const { options } = useTestContext();
-  const dirs = [
-    options.rootDir,
-    resolve(options.testDir, options.fixture),
-    process.cwd()
-  ];
-  for (const dir of dirs) {
-    if (dir && isNuxtApp(dir)) {
-      return dir;
-    }
-  }
-  throw new Error("Invalid nuxt app. (Please explicitly set `options.rootDir` pointing to a valid nuxt app)");
-};
-async function loadFixture() {
-  const ctx = useTestContext();
-  ctx.options.rootDir = resolveRootDir();
-  if (!ctx.options.dev) {
-    const randomId = Math.random().toString(36).slice(2, 8);
-    const buildDir2 = ctx.options.buildDir || resolve(ctx.options.rootDir, ".nuxt", "test", randomId);
-    ctx.options.nuxtConfig = defu(ctx.options.nuxtConfig, {
-      buildDir: buildDir2,
-      nitro: {
-        output: {
-          dir: resolve(buildDir2, "output")
-        }
-      }
-    });
-  }
-  ctx.nuxt = await kit.loadNuxt({
-    cwd: ctx.options.rootDir,
-    dev: ctx.options.dev,
-    overrides: ctx.options.nuxtConfig,
-    configFile: ctx.options.configFile
-  });
-  const buildDir = ctx.nuxt.options.buildDir;
-  if (!existsSync(buildDir)) {
-    await promises.mkdir(buildDir, { recursive: true });
-    ctx.teardown = ctx.teardown || [];
-    ctx.teardown.push(() => promises.rm(buildDir, { recursive: true, force: true }));
-  }
-}
-async function buildFixture() {
-  const ctx = useTestContext();
-  const prevLevel = kit.logger.level;
-  kit.logger.level = ctx.options.logLevel;
-  await kit.buildNuxt(ctx.nuxt);
-  kit.logger.level = prevLevel;
-}
-
-async function setupCucumber(hooks) {
-  const { After, AfterAll, Before, BeforeAll } = await import('@cucumber/cucumber');
-  BeforeAll({ timeout: hooks.ctx.options.setupTimeout }, hooks.setup);
-  Before(hooks.beforeEach);
-  After(hooks.afterEach);
-  AfterAll(hooks.afterAll);
-}
-
-async function setupJest(hooks) {
-  const { jest, test, beforeEach, afterAll, afterEach } = await import('@jest/globals');
-  hooks.ctx.mockFn = jest.fn;
-  test("setup", hooks.setup, hooks.ctx.options.setupTimeout);
-  beforeEach(hooks.beforeEach);
-  afterEach(hooks.afterEach);
-  afterAll(hooks.afterAll);
-}
-
-async function setupVitest(hooks) {
-  const vitest = await import('vitest');
-  hooks.ctx.mockFn = vitest.vi.fn;
-  vitest.beforeAll(hooks.setup, hooks.ctx.options.setupTimeout);
-  vitest.beforeEach(hooks.beforeEach);
-  vitest.afterEach(hooks.afterEach);
-  vitest.afterAll(hooks.afterAll);
-}
-
-const setupMaps = {
-  cucumber: setupCucumber,
-  jest: setupJest,
-  vitest: setupVitest
-};
-function createTest(options) {
-  const ctx = createTestContext(options);
-  const beforeEach = () => {
-    setTestContext(ctx);
-  };
-  const afterEach = () => {
-    setTestContext(void 0);
-  };
-  const afterAll = async () => {
-    if (ctx.serverProcess) {
-      setTestContext(ctx);
-      await stopServer();
-      setTestContext(void 0);
-    }
-    if (ctx.nuxt && ctx.nuxt.options.dev) {
-      await ctx.nuxt.close();
-    }
-    if (ctx.browser) {
-      await ctx.browser.close();
-    }
-    await Promise.all((ctx.teardown || []).map((fn) => fn()));
-  };
-  const setup2 = async () => {
-    if (ctx.options.fixture) {
-      await loadFixture();
-    }
-    if (ctx.options.build) {
-      await buildFixture();
-    }
-    if (ctx.options.server) {
-      await startServer();
-    }
-    if (ctx.options.waitFor) {
-      await new Promise((resolve) => setTimeout(resolve, ctx.options.waitFor));
-    }
-    if (ctx.options.browser) {
-      await createBrowser();
-    }
-  };
-  return {
-    beforeEach,
-    afterEach,
-    afterAll,
-    setup: setup2,
-    ctx
-  };
-}
-async function setup(options = {}) {
-  const hooks = createTest(options);
-  const setupFn = setupMaps[hooks.ctx.options.runner];
-  await setupFn(hooks);
-}
-
-const distDir = dirname(fileURLToPath(import.meta.url));
-
 const RunTestDefaults = {
   runner: "vitest",
   globalSetup: true
@@ -242,7 +68,7 @@ async function runTests(opts) {
         },
         globals: true,
         globalSetup: [
-          ...opts.globalSetup ? [resolve$1(distDir, "./runtime/global-setup")] : []
+          ...opts.globalSetup ? [resolve(distDir, "./runtime/global-setup")] : []
         ]
       }
     }
@@ -252,4 +78,4 @@ async function runTests(opts) {
   }
 }
 
-export { buildFixture, createBrowser, createPage, createTest, createTestContext, getBrowser, loadFixture, mockFn, mockLogger, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };
+export { mockFn, mockLogger, runTests, useTestContext };

package/dist/experimental.mjs

@@ -1,6 +1,6 @@
 import { resolve } from 'pathe';
 import { stringifyQuery } from 'ufo';
-import { $ as $fetch, u as useTestContext } from './shared/test-utils.JYxxBhQl.mjs';
+import { $ as $fetch, u as useTestContext } from './shared/test-utils.BegIhSnH.mjs';
 import 'execa';
 import 'get-port-please';
 import 'ofetch';

package/dist/module.mjs

@@ -327,6 +327,7 @@ const module = defineNuxtModule({
     logToConsole: false
   },
   async setup(options, nuxt) {
+    var _a;
     if (nuxt.options.test || nuxt.options.dev) {
       setupImportMocking();
     }
@@ -335,6 +336,13 @@ const module = defineNuxtModule({
       entry: await resolvePath("#app/entry", { alias: nuxt.options.alias }),
       rootStubPath: await resolvePath(resolver.resolve("./runtime/nuxt-root"))
     }));
+    if (!nuxt.options.test && !nuxt.options.dev) {
+      (_a = nuxt.options.vite).define || (_a.define = {});
+      nuxt.options.vite.define["import.meta.vitest"] = "undefined";
+    }
+    nuxt.hook("prepare:types", ({ references }) => {
+      references.push({ types: "vitest/import-meta" });
+    });
     if (!nuxt.options.dev)
       return;
     if (process.env.TEST || process.env.VITE_TEST)

package/dist/playwright.d.mts

@@ -0,0 +1,33 @@
+import * as _playwright_test from '@playwright/test';
+export { expect } from '@playwright/test';
+import { Response } from 'playwright-core';
+import { T as TestOptions$1, b as TestHooks, G as GotoOptions } from './shared/test-utils.9059LSjm.mjs';
+import '@nuxt/schema';
+import 'execa';
+
+type ConfigOptions = {
+    nuxt: Partial<TestOptions$1> | undefined;
+};
+type WorkerOptions = {
+    _nuxtHooks: TestHooks;
+};
+type TestOptions = {
+    goto: (url: string, options?: GotoOptions) => Promise<Response | null>;
+};
+/**
+ * Use a preconfigured Nuxt fixture.
+ *
+ * You can pass a `nuxt: {}` object in your device configuration, in the `use` key of your config file,
+ * or use the following syntax within your test file to configure your Nuxt fixture:
+ *
+  ```ts
+  test.use({
+    nuxt: {
+      rootDir: fileURLToPath(new URL('.', import.meta.url)),
+    }
+  })
+  ```
+ */
+declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & TestOptions, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & WorkerOptions & ConfigOptions>;
+
+export { type ConfigOptions, test };

package/dist/playwright.d.ts

@@ -0,0 +1,33 @@
+import * as _playwright_test from '@playwright/test';
+export { expect } from '@playwright/test';
+import { Response } from 'playwright-core';
+import { T as TestOptions$1, b as TestHooks, G as GotoOptions } from './shared/test-utils.9059LSjm.js';
+import '@nuxt/schema';
+import 'execa';
+
+type ConfigOptions = {
+    nuxt: Partial<TestOptions$1> | undefined;
+};
+type WorkerOptions = {
+    _nuxtHooks: TestHooks;
+};
+type TestOptions = {
+    goto: (url: string, options?: GotoOptions) => Promise<Response | null>;
+};
+/**
+ * Use a preconfigured Nuxt fixture.
+ *
+ * You can pass a `nuxt: {}` object in your device configuration, in the `use` key of your config file,
+ * or use the following syntax within your test file to configure your Nuxt fixture:
+ *
+  ```ts
+  test.use({
+    nuxt: {
+      rootDir: fileURLToPath(new URL('.', import.meta.url)),
+    }
+  })
+  ```
+ */
+declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & TestOptions, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & WorkerOptions & ConfigOptions>;
+
+export { type ConfigOptions, test };

package/dist/playwright.mjs

@@ -0,0 +1,66 @@
+import { test as test$1 } from '@playwright/test';
+export { expect } from '@playwright/test';
+import { e as createTest, w as waitForHydration } from './shared/test-utils.B57u8E0c.mjs';
+import 'node:path';
+import 'defu';
+import 'consola';
+import 'node:fs';
+import '@nuxt/kit';
+import { d as url } from './shared/test-utils.BegIhSnH.mjs';
+import 'pathe';
+import 'node:url';
+import 'execa';
+import 'get-port-please';
+import 'ofetch';
+
+{
+  if (process.env.TEST_WORKER_INDEX) {
+    for (const stream of [process.stdout, process.stderr]) {
+      if (!stream.clearLine) {
+        stream.clearLine = (dir, callback) => {
+          callback?.();
+          return true;
+        };
+      }
+      if (!stream.cursorTo) {
+        stream.cursorTo = (x, y, callback) => {
+          if (callback)
+            callback();
+          else if (y instanceof Function)
+            y();
+          return true;
+        };
+      }
+    }
+  }
+}
+const test = test$1.extend({
+  nuxt: [void 0, { option: true, scope: "worker" }],
+  _nuxtHooks: [
+    async ({ nuxt }, use) => {
+      const hooks = createTest(nuxt || {});
+      await hooks.setup();
+      await use(hooks);
+      await hooks.afterAll();
+    },
+    { scope: "worker" }
+  ],
+  baseURL: async ({ _nuxtHooks }, use) => {
+    _nuxtHooks.beforeEach();
+    await use(url("/"));
+    _nuxtHooks.afterEach();
+  },
+  goto: async ({ page }, use) => {
+    await use(async (url2, options) => {
+      const waitUntil = options?.waitUntil;
+      if (waitUntil && ["hydration", "route"].includes(waitUntil)) {
+        delete options.waitUntil;
+      }
+      const response = await page.goto(url2, options);
+      await waitForHydration(page, url2, waitUntil);
+      return response;
+    });
+  }
+});
+
+export { test };

package/dist/runtime/entry.mjs

@@ -1,3 +1,4 @@
+import { vi } from "vitest";
 if (typeof window !== "undefined" && // @ts-expect-error undefined property
 window.__NUXT_VITEST_ENVIRONMENT__) {
   const { useRouter } = await import("#app/composables/router");
@@ -5,5 +6,6 @@ window.__NUXT_VITEST_ENVIRONMENT__) {
   const nuxtApp = useNuxtApp();
   await nuxtApp.callHook("page:finish");
   useRouter().afterEach(() => nuxtApp.callHook("page:finish"));
+  vi.resetModules();
 }
 export {};

package/dist/shared/test-utils.9059LSjm.d.mts

@@ -0,0 +1,60 @@
+import { Browser, BrowserContextOptions, Page, Response, LaunchOptions } from 'playwright-core';
+import { NuxtConfig, Nuxt } from '@nuxt/schema';
+import { ExecaChildProcess } from 'execa';
+
+declare function createBrowser(): Promise<void>;
+declare function getBrowser(): Promise<Browser>;
+type _GotoOptions = NonNullable<Parameters<Page['goto']>[1]>;
+interface GotoOptions extends Omit<_GotoOptions, 'waitUntil'> {
+    waitUntil?: 'hydration' | 'route' | _GotoOptions['waitUntil'];
+}
+interface NuxtPage extends Omit<Page, 'goto'> {
+    goto: (url: string, options?: GotoOptions) => Promise<Response | null>;
+}
+declare function createPage(path?: string, options?: BrowserContextOptions): Promise<NuxtPage>;
+declare function waitForHydration(page: Page, url: string, waitUntil?: GotoOptions['waitUntil']): Promise<void>;
+
+type TestRunner = 'vitest' | 'jest' | 'cucumber';
+interface TestOptions {
+    testDir: string;
+    fixture: string;
+    configFile: string;
+    rootDir: string;
+    buildDir: string;
+    nuxtConfig: NuxtConfig;
+    build: boolean;
+    dev: boolean;
+    setupTimeout: number;
+    waitFor: number;
+    browser: boolean;
+    runner: TestRunner;
+    logLevel: number;
+    browserOptions: {
+        type: 'chromium' | 'firefox' | 'webkit';
+        launch?: LaunchOptions;
+    };
+    server: boolean;
+    port?: number;
+}
+interface TestContext {
+    options: TestOptions;
+    nuxt?: Nuxt;
+    browser?: Browser;
+    url?: string;
+    serverProcess?: ExecaChildProcess;
+    mockFn?: Function;
+    /**
+     * Functions to run on the vitest `afterAll` hook.
+     * Useful for removing anything created during the test.
+     */
+    teardown?: (() => void)[];
+}
+interface TestHooks {
+    beforeEach: () => void;
+    afterEach: () => void;
+    afterAll: () => Promise<void>;
+    setup: () => Promise<void>;
+    ctx: TestContext;
+}
+
+export { type GotoOptions as G, type TestOptions as T, type TestContext as a, type TestHooks as b, createBrowser as c, createPage as d, type TestRunner as e, getBrowser as g, waitForHydration as w };

package/dist/shared/test-utils.9059LSjm.d.ts

@@ -0,0 +1,60 @@
+import { Browser, BrowserContextOptions, Page, Response, LaunchOptions } from 'playwright-core';
+import { NuxtConfig, Nuxt } from '@nuxt/schema';
+import { ExecaChildProcess } from 'execa';
+
+declare function createBrowser(): Promise<void>;
+declare function getBrowser(): Promise<Browser>;
+type _GotoOptions = NonNullable<Parameters<Page['goto']>[1]>;
+interface GotoOptions extends Omit<_GotoOptions, 'waitUntil'> {
+    waitUntil?: 'hydration' | 'route' | _GotoOptions['waitUntil'];
+}
+interface NuxtPage extends Omit<Page, 'goto'> {
+    goto: (url: string, options?: GotoOptions) => Promise<Response | null>;
+}
+declare function createPage(path?: string, options?: BrowserContextOptions): Promise<NuxtPage>;
+declare function waitForHydration(page: Page, url: string, waitUntil?: GotoOptions['waitUntil']): Promise<void>;
+
+type TestRunner = 'vitest' | 'jest' | 'cucumber';
+interface TestOptions {
+    testDir: string;
+    fixture: string;
+    configFile: string;
+    rootDir: string;
+    buildDir: string;
+    nuxtConfig: NuxtConfig;
+    build: boolean;
+    dev: boolean;
+    setupTimeout: number;
+    waitFor: number;
+    browser: boolean;
+    runner: TestRunner;
+    logLevel: number;
+    browserOptions: {
+        type: 'chromium' | 'firefox' | 'webkit';
+        launch?: LaunchOptions;
+    };
+    server: boolean;
+    port?: number;
+}
+interface TestContext {
+    options: TestOptions;
+    nuxt?: Nuxt;
+    browser?: Browser;
+    url?: string;
+    serverProcess?: ExecaChildProcess;
+    mockFn?: Function;
+    /**
+     * Functions to run on the vitest `afterAll` hook.
+     * Useful for removing anything created during the test.
+     */
+    teardown?: (() => void)[];
+}
+interface TestHooks {
+    beforeEach: () => void;
+    afterEach: () => void;
+    afterAll: () => Promise<void>;
+    setup: () => Promise<void>;
+    ctx: TestContext;
+}
+
+export { type GotoOptions as G, type TestOptions as T, type TestContext as a, type TestHooks as b, createBrowser as c, createPage as d, type TestRunner as e, getBrowser as g, waitForHydration as w };

package/dist/shared/test-utils.B57u8E0c.mjs

@@ -0,0 +1,202 @@
+import { u as useTestContext, d as url, c as createTestContext, s as setTestContext, b as stopServer, a as startServer } from './test-utils.BegIhSnH.mjs';
+import { existsSync, promises } from 'node:fs';
+import { resolve } from 'node:path';
+import { defu } from 'defu';
+import * as _kit from '@nuxt/kit';
+import { fileURLToPath } from 'node:url';
+import { dirname } from 'pathe';
+
+async function createBrowser() {
+  const ctx = useTestContext();
+  let playwright;
+  try {
+    playwright = await import(
+      /* vite-ignore */
+      'playwright-core'
+    );
+  } catch {
+    throw new Error(`
+      The dependency 'playwright-core' not found.
+      Please run 'yarn add --dev playwright-core' or 'npm install --save-dev playwright-core'
+    `);
+  }
+  const { type, launch } = ctx.options.browserOptions;
+  if (!playwright[type]) {
+    throw new Error(`Invalid browser '${type}'`);
+  }
+  ctx.browser = await playwright[type].launch(launch);
+}
+async function getBrowser() {
+  const ctx = useTestContext();
+  if (!ctx.browser) {
+    await createBrowser();
+  }
+  return ctx.browser;
+}
+async function createPage(path, options) {
+  const browser = await getBrowser();
+  const page = await browser.newPage(options);
+  const _goto = page.goto.bind(page);
+  page.goto = async (url2, options2) => {
+    const waitUntil = options2?.waitUntil;
+    if (waitUntil && ["hydration", "route"].includes(waitUntil)) {
+      delete options2.waitUntil;
+    }
+    const res = await _goto(url2, options2);
+    await waitForHydration(page, url2, waitUntil);
+    return res;
+  };
+  if (path) {
+    await page.goto(url(path), { waitUntil: "hydration" });
+  }
+  return page;
+}
+async function waitForHydration(page, url2, waitUntil) {
+  if (waitUntil === "hydration") {
+    await page.waitForFunction(() => window.useNuxtApp?.().isHydrating === false);
+  } else if (waitUntil === "route") {
+    await page.waitForFunction((route) => window.useNuxtApp?.()._route.fullPath === route, url2);
+  }
+}
+
+const kit = _kit.default || _kit;
+const isNuxtApp = (dir) => {
+  return existsSync(dir) && (existsSync(resolve(dir, "pages")) || existsSync(resolve(dir, "nuxt.config.js")) || existsSync(resolve(dir, "nuxt.config.mjs")) || existsSync(resolve(dir, "nuxt.config.cjs")) || existsSync(resolve(dir, "nuxt.config.ts")));
+};
+const resolveRootDir = () => {
+  const { options } = useTestContext();
+  const dirs = [
+    options.rootDir,
+    resolve(options.testDir, options.fixture),
+    process.cwd()
+  ];
+  for (const dir of dirs) {
+    if (dir && isNuxtApp(dir)) {
+      return dir;
+    }
+  }
+  throw new Error("Invalid nuxt app. (Please explicitly set `options.rootDir` pointing to a valid nuxt app)");
+};
+async function loadFixture() {
+  const ctx = useTestContext();
+  ctx.options.rootDir = resolveRootDir();
+  if (!ctx.options.dev) {
+    const randomId = Math.random().toString(36).slice(2, 8);
+    const buildDir2 = ctx.options.buildDir || resolve(ctx.options.rootDir, ".nuxt", "test", randomId);
+    ctx.options.nuxtConfig = defu(ctx.options.nuxtConfig, {
+      buildDir: buildDir2,
+      nitro: {
+        output: {
+          dir: resolve(buildDir2, "output")
+        }
+      }
+    });
+  }
+  ctx.nuxt = await kit.loadNuxt({
+    cwd: ctx.options.rootDir,
+    dev: ctx.options.dev,
+    overrides: ctx.options.nuxtConfig,
+    configFile: ctx.options.configFile
+  });
+  const buildDir = ctx.nuxt.options.buildDir;
+  if (!existsSync(buildDir)) {
+    await promises.mkdir(buildDir, { recursive: true });
+    ctx.teardown = ctx.teardown || [];
+    ctx.teardown.push(() => promises.rm(buildDir, { recursive: true, force: true }));
+  }
+}
+async function buildFixture() {
+  const ctx = useTestContext();
+  const prevLevel = kit.logger.level;
+  kit.logger.level = ctx.options.logLevel;
+  await kit.buildNuxt(ctx.nuxt);
+  kit.logger.level = prevLevel;
+}
+
+async function setupCucumber(hooks) {
+  const { After, AfterAll, Before, BeforeAll } = await import('@cucumber/cucumber');
+  BeforeAll({ timeout: hooks.ctx.options.setupTimeout }, hooks.setup);
+  Before(hooks.beforeEach);
+  After(hooks.afterEach);
+  AfterAll(hooks.afterAll);
+}
+
+async function setupJest(hooks) {
+  const { jest, test, beforeEach, afterAll, afterEach } = await import('@jest/globals');
+  hooks.ctx.mockFn = jest.fn;
+  test("setup", hooks.setup, hooks.ctx.options.setupTimeout);
+  beforeEach(hooks.beforeEach);
+  afterEach(hooks.afterEach);
+  afterAll(hooks.afterAll);
+}
+
+async function setupVitest(hooks) {
+  const vitest = await import('vitest');
+  hooks.ctx.mockFn = vitest.vi.fn;
+  vitest.beforeAll(hooks.setup, hooks.ctx.options.setupTimeout);
+  vitest.beforeEach(hooks.beforeEach);
+  vitest.afterEach(hooks.afterEach);
+  vitest.afterAll(hooks.afterAll);
+}
+
+const setupMaps = {
+  cucumber: setupCucumber,
+  jest: setupJest,
+  vitest: setupVitest
+};
+function createTest(options) {
+  const ctx = createTestContext(options);
+  const beforeEach = () => {
+    setTestContext(ctx);
+  };
+  const afterEach = () => {
+    setTestContext(void 0);
+  };
+  const afterAll = async () => {
+    if (ctx.serverProcess) {
+      setTestContext(ctx);
+      await stopServer();
+      setTestContext(void 0);
+    }
+    if (ctx.nuxt && ctx.nuxt.options.dev) {
+      await ctx.nuxt.close();
+    }
+    if (ctx.browser) {
+      await ctx.browser.close();
+    }
+    await Promise.all((ctx.teardown || []).map((fn) => fn()));
+  };
+  const setup2 = async () => {
+    if (ctx.options.fixture) {
+      await loadFixture();
+    }
+    if (ctx.options.build) {
+      await buildFixture();
+    }
+    if (ctx.options.server) {
+      await startServer();
+    }
+    if (ctx.options.waitFor) {
+      await new Promise((resolve) => setTimeout(resolve, ctx.options.waitFor));
+    }
+    if (ctx.options.browser) {
+      await createBrowser();
+    }
+  };
+  return {
+    beforeEach,
+    afterEach,
+    afterAll,
+    setup: setup2,
+    ctx
+  };
+}
+async function setup(options = {}) {
+  const hooks = createTest(options);
+  const setupFn = setupMaps[hooks.ctx.options.runner];
+  await setupFn(hooks);
+}
+
+const distDir = dirname(fileURLToPath(import.meta.url));
+
+export { createPage as a, buildFixture as b, createBrowser as c, distDir as d, createTest as e, setup as f, getBrowser as g, loadFixture as l, setupMaps as s, waitForHydration as w };

package/dist/shared/{test-utils.JYxxBhQl.mjs → test-utils.BegIhSnH.mjs}

@@ -18,11 +18,15 @@ function createTestContext(options) {
     server: true,
     build: options.browser !== false || options.server !== false,
     nuxtConfig: {},
-    runner: process.env.VITEST === "true" ? "vitest" : "jest",
     browserOptions: {
       type: "chromium"
     }
   });
+  if (process.env.VITEST === "true") {
+    _options.runner || (_options.runner = "vitest");
+  } else if (process.env.JEST_WORKER_ID) {
+    _options.runner || (_options.runner = "jest");
+  }
   return setTestContext({
     options: _options
   });
@@ -129,4 +133,4 @@ function url(path) {
   return ctx.url + path;
 }
 
-export { $fetch as $, url as a, stopServer as b, createTestContext as c, startServer as d, exposeContextToEnv as e, fetch as f, isDev as i, recoverContextFromEnv as r, setTestContext as s, useTestContext as u };
+export { $fetch as $, startServer as a, stopServer as b, createTestContext as c, url as d, exposeContextToEnv as e, fetch as f, isDev as i, recoverContextFromEnv as r, setTestContext as s, useTestContext as u };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/test-utils",
-  "version": "3.10.0",
+  "version": "3.12.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nuxt/test-utils.git"
@@ -13,6 +13,7 @@
     ".": "./dist/e2e.mjs",
     "./config": "./dist/config.mjs",
     "./e2e": "./dist/e2e.mjs",
+    "./playwright": "./dist/playwright.mjs",
     "./experimental": "./dist/experimental.mjs",
     "./module": "./dist/module.mjs",
     "./runtime": "./dist/runtime-utils/index.mjs",
@@ -27,29 +28,39 @@
     "runtime.d.ts",
     "vitest-environment.d.ts"
   ],
+  "scripts": {
+    "lint": "eslint --ext .vue,.ts,.js,.mjs .",
+    "lint:fix": "eslint --ext .vue,.ts,.js,.mjs . --fix",
+    "test:examples": "pnpm -r test --filter !nuxt-app-cucumber && pnpm -r test --filter nuxt-app-cucumber",
+    "test:types": "vue-tsc --noEmit",
+    "test:unit": "vitest test/unit --run",
+    "prepack": "unbuild",
+    "dev:prepare": "nuxi prepare && unbuild --stub && pnpm -r dev:prepare",
+    "release": "pnpm prepack && pnpm test:examples && changelogen --release --push"
+  },
   "dependencies": {
-    "@nuxt/kit": "^3.9.3",
-    "@nuxt/schema": "^3.9.3",
-    "c12": "^1.6.1",
+    "@nuxt/kit": "^3.10.3",
+    "@nuxt/schema": "^3.10.3",
+    "c12": "^1.10.0",
     "consola": "^3.2.3",
     "defu": "^6.1.4",
-    "destr": "^2.0.2",
+    "destr": "^2.0.3",
     "estree-walker": "^3.0.3",
     "execa": "^8.0.1",
     "fake-indexeddb": "^5.0.2",
     "get-port-please": "^3.1.2",
     "local-pkg": "^0.5.0",
-    "magic-string": "^0.30.5",
-    "node-fetch-native": "^1.6.1",
+    "magic-string": "^0.30.8",
+    "node-fetch-native": "^1.6.2",
     "ofetch": "^1.3.3",
     "pathe": "^1.1.2",
     "perfect-debounce": "^1.0.0",
-    "radix3": "^1.1.0",
-    "scule": "^1.2.0",
+    "radix3": "^1.1.1",
+    "scule": "^1.3.0",
     "std-env": "^3.7.0",
-    "ufo": "^1.3.2",
+    "ufo": "^1.5.1",
     "unenv": "^1.9.0",
-    "unplugin": "^1.6.0",
+    "unplugin": "^1.10.0",
     "vitest-environment-nuxt": "^1.0.0"
   },
   "devDependencies": {
@@ -58,40 +69,42 @@
     "@nuxt/devtools": "1.0.8",
     "@nuxt/eslint-config": "0.2.0",
     "@nuxt/module-builder": "0.5.5",
-    "@testing-library/vue": "8.0.1",
+    "@playwright/test": "1.42.1",
+    "@testing-library/vue": "8.0.2",
     "@types/estree": "1.0.5",
     "@types/jsdom": "21.1.6",
-    "@types/semver": "7.5.6",
-    "@vitest/ui": "1.1.1",
-    "@vue/test-utils": "2.4.3",
+    "@types/semver": "7.5.8",
+    "@vitest/ui": "1.4.0",
+    "@vue/test-utils": "2.4.5",
     "changelogen": "0.5.5",
-    "eslint": "8.56.0",
+    "eslint": "8.57.0",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jsdoc": "48.0.2",
+    "eslint-plugin-jsdoc": "48.2.1",
     "eslint-plugin-no-only-tests": "3.1.0",
-    "eslint-plugin-unicorn": "50.0.1",
-    "h3": "1.10.0",
+    "eslint-plugin-unicorn": "51.0.1",
+    "h3": "1.11.1",
     "jiti": "1.21.0",
-    "nuxt": "3.9.3",
-    "playwright-core": "1.41.0",
-    "rollup": "4.9.5",
-    "semver": "7.5.4",
+    "nuxt": "3.10.3",
+    "playwright-core": "1.42.1",
+    "rollup": "4.13.0",
+    "semver": "7.6.0",
     "unbuild": "latest",
     "unimport": "3.7.1",
-    "vite": "5.0.11",
-    "vitest": "1.1.1",
-    "vue-router": "4.2.5",
-    "vue-tsc": "1.8.27"
+    "vite": "5.1.6",
+    "vitest": "1.4.0",
+    "vue-router": "4.3.0",
+    "vue-tsc": "2.0.6"
   },
   "peerDependencies": {
     "@cucumber/cucumber": "^10.3.1",
     "@jest/globals": "^29.5.0",
+    "@playwright/test": "^1.42.1",
     "@testing-library/vue": "^7.0.0 || ^8.0.1",
     "@vitest/ui": "^0.34.6 || ^1.0.0",
     "@vue/test-utils": "^2.4.2",
     "h3": "*",
     "happy-dom": "^9.10.9 || ^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0",
-    "jsdom": "^22.0.0 || ^23.0.0",
+    "jsdom": "^22.0.0 || ^23.0.0 || ^24.0.0",
     "playwright-core": "^1.34.3",
     "vite": "*",
     "vitest": "^0.34.6 || ^1.0.0",
@@ -102,6 +115,9 @@
     "@cucumber/cucumber": {
       "optional": true
     },
+    "@playwright/test": {
+      "optional": true
+    },
     "@testing-library/vue": {
       "optional": true
     },
@@ -128,24 +144,15 @@
     }
   },
   "resolutions": {
-    "@nuxt/schema": "^3.9.3",
-    "@nuxt/kit": "^3.9.3",
+    "@nuxt/kit": "^3.10.3",
+    "@nuxt/schema": "^3.10.3",
     "@nuxt/test-utils": "workspace:*",
-    "rollup": "4.9.5",
-    "vite": "5.0.11",
-    "vue": "^3.4.14"
+    "rollup": "4.13.0",
+    "vite": "5.1.6",
+    "vue": "^3.4.21"
   },
   "engines": {
     "node": "^14.18.0 || >=16.10.0"
   },
-  "packageManager": "pnpm@8.14.1",
-  "scripts": {
-    "lint": "eslint --ext .vue,.ts,.js,.mjs .",
-    "lint:fix": "eslint --ext .vue,.ts,.js,.mjs . --fix",
-    "test:examples": "pnpm -r test --filter !nuxt-app-cucumber && pnpm -r test --filter nuxt-app-cucumber",
-    "test:types": "vue-tsc --noEmit",
-    "test:unit": "vitest test/unit --run",
-    "dev:prepare": "nuxi prepare && unbuild --stub && pnpm -r dev:prepare",
-    "release": "pnpm test:examples && pnpm prepack && changelogen --release --push && pnpm publish"
-  }
+  "packageManager": "pnpm@8.15.4"
 }