@nuxt/test-utils 3.14.0 → 3.14.1

package/dist/config.d.mts

@@ -18,40 +18,46 @@ declare function getVitestConfigFromNuxt(options?: GetVitestConfigOptions, loadN
 declare function defineVitestConfig(config?: InlineConfig & {
     test?: InlineConfig$1;
 }): vite.UserConfig & Promise<vite.UserConfig> & (vite.UserConfigFnObject & vite.UserConfigExport);
+interface NuxtEnvironmentOptions {
+    rootDir?: string;
+    /**
+     * The starting URL for your Nuxt window environment
+     * @default {http://localhost:3000}
+     */
+    url?: string;
+    /**
+     * You can define how environment options are read when loading the Nuxt configuration.
+     */
+    dotenv?: Partial<DotenvOptions>;
+    /**
+     * Configuration that will override the values in your `nuxt.config` file.
+     */
+    overrides?: NuxtConfig;
+    /**
+     * The id of the root div to which the app should be mounted. You should also set `app.rootId` to the same value.
+     * @default {nuxt-test}
+     */
+    rootId?: string;
+    /**
+     * The name of the DOM environment to use.
+     *
+     * It also needs to be installed as a dev dependency in your project.
+     * @default {happy-dom}
+     */
+    domEnvironment?: 'happy-dom' | 'jsdom';
+    mock?: {
+        intersectionObserver?: boolean;
+        indexedDb?: boolean;
+    };
+}
+declare module 'vitest/node' {
+    interface EnvironmentOptions {
+        nuxt?: NuxtEnvironmentOptions;
+    }
+}
 declare module 'vitest' {
     interface EnvironmentOptions {
-        nuxt?: {
-            rootDir?: string;
-            /**
-             * The starting URL for your Nuxt window environment
-             * @default {http://localhost:3000}
-             */
-            url?: string;
-            /**
-             * You can define how environment options are read when loading the Nuxt configuration.
-             */
-            dotenv?: Partial<DotenvOptions>;
-            /**
-             * Configuration that will override the values in your `nuxt.config` file.
-             */
-            overrides?: NuxtConfig;
-            /**
-             * The id of the root div to which the app should be mounted. You should also set `app.rootId` to the same value.
-             * @default {nuxt-test}
-             */
-            rootId?: string;
-            /**
-             * The name of the DOM environment to use.
-             *
-             * It also needs to be installed as a dev dependency in your project.
-             * @default {happy-dom}
-             */
-            domEnvironment?: 'happy-dom' | 'jsdom';
-            mock?: {
-                intersectionObserver?: boolean;
-                indexedDb?: boolean;
-            };
-        };
+        nuxt?: NuxtEnvironmentOptions;
     }
 }
 

package/dist/config.d.ts

@@ -18,40 +18,46 @@ declare function getVitestConfigFromNuxt(options?: GetVitestConfigOptions, loadN
 declare function defineVitestConfig(config?: InlineConfig & {
     test?: InlineConfig$1;
 }): vite.UserConfig & Promise<vite.UserConfig> & (vite.UserConfigFnObject & vite.UserConfigExport);
+interface NuxtEnvironmentOptions {
+    rootDir?: string;
+    /**
+     * The starting URL for your Nuxt window environment
+     * @default {http://localhost:3000}
+     */
+    url?: string;
+    /**
+     * You can define how environment options are read when loading the Nuxt configuration.
+     */
+    dotenv?: Partial<DotenvOptions>;
+    /**
+     * Configuration that will override the values in your `nuxt.config` file.
+     */
+    overrides?: NuxtConfig;
+    /**
+     * The id of the root div to which the app should be mounted. You should also set `app.rootId` to the same value.
+     * @default {nuxt-test}
+     */
+    rootId?: string;
+    /**
+     * The name of the DOM environment to use.
+     *
+     * It also needs to be installed as a dev dependency in your project.
+     * @default {happy-dom}
+     */
+    domEnvironment?: 'happy-dom' | 'jsdom';
+    mock?: {
+        intersectionObserver?: boolean;
+        indexedDb?: boolean;
+    };
+}
+declare module 'vitest/node' {
+    interface EnvironmentOptions {
+        nuxt?: NuxtEnvironmentOptions;
+    }
+}
 declare module 'vitest' {
     interface EnvironmentOptions {
-        nuxt?: {
-            rootDir?: string;
-            /**
-             * The starting URL for your Nuxt window environment
-             * @default {http://localhost:3000}
-             */
-            url?: string;
-            /**
-             * You can define how environment options are read when loading the Nuxt configuration.
-             */
-            dotenv?: Partial<DotenvOptions>;
-            /**
-             * Configuration that will override the values in your `nuxt.config` file.
-             */
-            overrides?: NuxtConfig;
-            /**
-             * The id of the root div to which the app should be mounted. You should also set `app.rootId` to the same value.
-             * @default {nuxt-test}
-             */
-            rootId?: string;
-            /**
-             * The name of the DOM environment to use.
-             *
-             * It also needs to be installed as a dev dependency in your project.
-             * @default {happy-dom}
-             */
-            domEnvironment?: 'happy-dom' | 'jsdom';
-            mock?: {
-                intersectionObserver?: boolean;
-                indexedDb?: boolean;
-            };
-        };
+        nuxt?: NuxtEnvironmentOptions;
     }
 }
 

package/dist/config.mjs

@@ -44,6 +44,10 @@ async function startNuxtAndGetViteConfig(rootDir = process.cwd(), options = {})
       cwd: rootDir,
       fileName: ".env.test"
     }),
+    defaults: {
+      // suppress compatibility date warning for runtime environment tests
+      compatibilityDate: "2024-04-03"
+    },
     overrides: defu(
       {
         appId: "nuxt-app",

package/dist/e2e.d.mts

@@ -1,10 +1,9 @@
-import { T as TestOptions, a as TestContext, b as TestHooks } from './shared/test-utils.Bfk23aTC.mjs';
-export { $ as $fetch, G as GotoOptions, S as StartServerOptions, h as TestRunner, c as createBrowser, d as createPage, f as fetch, g as getBrowser, s as startServer, e as stopServer, u as url, w as waitForHydration } from './shared/test-utils.Bfk23aTC.mjs';
+import { T as TestOptions, a as TestContext, b as TestHooks } from './shared/test-utils.CyoO8zI7.mjs';
+export { $ as $fetch, G as GotoOptions, S as StartServerOptions, h as TestRunner, c as createBrowser, d as createPage, f as fetch, g as getBrowser, s as startServer, e as stopServer, u as url, w as waitForHydration } from './shared/test-utils.CyoO8zI7.mjs';
 import { LogType } from 'consola';
 import 'playwright-core';
 import '@nuxt/schema';
 import 'execa';
-import 'nitropack';
 
 declare function createTestContext(options: Partial<TestOptions>): TestContext;
 declare function useTestContext(): TestContext;

package/dist/e2e.d.ts

@@ -1,10 +1,9 @@
-import { T as TestOptions, a as TestContext, b as TestHooks } from './shared/test-utils.Bfk23aTC.js';
-export { $ as $fetch, G as GotoOptions, S as StartServerOptions, h as TestRunner, c as createBrowser, d as createPage, f as fetch, g as getBrowser, s as startServer, e as stopServer, u as url, w as waitForHydration } from './shared/test-utils.Bfk23aTC.js';
+import { T as TestOptions, a as TestContext, b as TestHooks } from './shared/test-utils.CyoO8zI7.js';
+export { $ as $fetch, G as GotoOptions, S as StartServerOptions, h as TestRunner, c as createBrowser, d as createPage, f as fetch, g as getBrowser, s as startServer, e as stopServer, u as url, w as waitForHydration } from './shared/test-utils.CyoO8zI7.js';
 import { LogType } from 'consola';
 import 'playwright-core';
 import '@nuxt/schema';
 import 'execa';
-import 'nitropack';
 
 declare function createTestContext(options: Partial<TestOptions>): TestContext;
 declare function useTestContext(): TestContext;

package/dist/e2e.mjs

@@ -1,7 +1,7 @@
-import { d as distDir } from './shared/test-utils.CSumGjP7.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.CSumGjP7.mjs';
-import { u as useTestContext } from './shared/test-utils.iUoJhWDR.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.iUoJhWDR.mjs';
+import { d as distDir } from './shared/test-utils.BZS9cHDP.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.BZS9cHDP.mjs';
+import { u as useTestContext } from './shared/test-utils.BumFEtZ8.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.BumFEtZ8.mjs';
 import { consola } from 'consola';
 import { resolve } from 'pathe';
 import 'node:fs';

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.iUoJhWDR.mjs';
+import { $ as $fetch, u as useTestContext } from './shared/test-utils.BumFEtZ8.mjs';
 import 'execa';
 import 'get-port-please';
 import 'ofetch';

package/dist/module.mjs

@@ -35,7 +35,7 @@ const createMockPlugin = (ctx) => createUnplugin(() => {
         ecmaVersion: "latest",
         ranges: true
       });
-    } catch (e) {
+    } catch {
       return;
     }
     let insertionPoint = 0;
@@ -316,7 +316,7 @@ const NuxtRootStubPlugin = createUnplugin((options) => {
   };
 });
 
-const vitePluginBlocklist = ["vite-plugin-vue-inspector", "vite-plugin-vue-inspector:post", "vite-plugin-inspect"];
+const vitePluginBlocklist = ["vite-plugin-vue-inspector", "vite-plugin-vue-inspector:post", "vite-plugin-inspect", "nuxt:type-check"];
 const module = defineNuxtModule({
   meta: {
     name: "@nuxt/test-utils",

package/dist/playwright.d.mts

@@ -1,10 +1,9 @@
 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.Bfk23aTC.mjs';
+import { T as TestOptions$1, b as TestHooks, G as GotoOptions } from './shared/test-utils.CyoO8zI7.mjs';
 import '@nuxt/schema';
 import 'execa';
-import 'nitropack';
 
 type ConfigOptions = {
     nuxt: Partial<TestOptions$1> | undefined;

package/dist/playwright.d.ts

@@ -1,10 +1,9 @@
 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.Bfk23aTC.js';
+import { T as TestOptions$1, b as TestHooks, G as GotoOptions } from './shared/test-utils.CyoO8zI7.js';
 import '@nuxt/schema';
 import 'execa';
-import 'nitropack';
 
 type ConfigOptions = {
     nuxt: Partial<TestOptions$1> | undefined;

package/dist/playwright.mjs

@@ -1,13 +1,13 @@
 import { test as test$1 } from '@playwright/test';
 export { expect } from '@playwright/test';
-import { e as createTest, w as waitForHydration } from './shared/test-utils.CSumGjP7.mjs';
+import { e as createTest, w as waitForHydration } from './shared/test-utils.BZS9cHDP.mjs';
 import 'node:path';
 import 'defu';
 import 'ufo';
 import 'consola';
 import 'node:fs';
 import '@nuxt/kit';
-import { d as url } from './shared/test-utils.iUoJhWDR.mjs';
+import { d as url } from './shared/test-utils.BumFEtZ8.mjs';
 import 'pathe';
 import 'node:url';
 import 'execa';

package/dist/shared/{test-utils.CSumGjP7.mjs → test-utils.BZS9cHDP.mjs}

@@ -1,4 +1,4 @@
-import { u as useTestContext, d as url, c as createTestContext, s as setTestContext, b as stopServer, a as startServer } from './test-utils.iUoJhWDR.mjs';
+import { u as useTestContext, d as url, c as createTestContext, s as setTestContext, b as stopServer, a as startServer } from './test-utils.BumFEtZ8.mjs';
 import { existsSync, promises } from 'node:fs';
 import { resolve } from 'node:path';
 import { defu } from 'defu';

package/dist/shared/{test-utils.iUoJhWDR.mjs → test-utils.BumFEtZ8.mjs}

@@ -18,7 +18,10 @@ function createTestContext(options) {
     logLevel: 1,
     server: true,
     build: options.browser !== false || options.server !== false,
-    nuxtConfig: {},
+    nuxtConfig: {
+      // suppress compatibility date warning for runtime environment tests
+      compatibilityDate: "2024-04-03"
+    },
     browserOptions: {
       type: "chromium"
     }

package/dist/shared/{test-utils.Bfk23aTC.d.mts → test-utils.CyoO8zI7.d.mts}

@@ -1,7 +1,6 @@
 import { Browser, BrowserContextOptions, Page, Response as Response$1, LaunchOptions } from 'playwright-core';
 import { NuxtConfig, Nuxt } from '@nuxt/schema';
 import { ExecaChildProcess } from 'execa';
-import * as nitropack from 'nitropack';
 
 declare function createBrowser(): Promise<void>;
 declare function getBrowser(): Promise<Browser>;
@@ -21,30 +20,68 @@ interface StartServerOptions {
 declare function startServer(options?: StartServerOptions): Promise<void>;
 declare function stopServer(): Promise<void>;
 declare function fetch(path: string, options?: RequestInit): Promise<Response>;
-declare const $fetch: nitropack.$Fetch<unknown, nitropack.NitroFetchRequest>;
+declare const $fetch: (typeof globalThis)["$fetch"];
 declare function url(path: string): string;
 
 type TestRunner = 'vitest' | 'jest' | 'cucumber';
 interface TestOptions {
     testDir: string;
     fixture: string;
+    /**
+     * Name of the configuration file.
+     * @default `'nuxt.config`
+     */
     configFile: string;
+    /**
+     * Path to a directory with a Nuxt app to be put under test.
+     * @default `'.'`
+     */
     rootDir: string;
     buildDir: string;
     nuxtConfig: NuxtConfig;
+    /**
+     * Whether to run a separate build step.
+     * @default `true` (`false` if `browser` or `server` is disabled, or if a `host` is provided)
+     */
     build: boolean;
     dev: boolean;
+    /**
+     * The amount of time (in milliseconds) to allow for `setupTest` to complete its work (which could include building or generating files for a Nuxt application, depending on the options that are passed).
+     * @default `60000`
+     */
     setupTimeout: number;
     waitFor: number;
+    /**
+     * Under the hood, Nuxt test utils uses [`playwright`](https://playwright.dev) to carry out browser testing. If this option is set, a browser will be launched and can be controlled in the subsequent test suite.
+     * @default `false`
+     */
     browser: boolean;
+    /**
+     * Specify the runner for the test suite. One of `'vitest' | 'jest' | 'cucumber'`.
+     * @default `vitest`
+     */
     runner: TestRunner;
     logLevel: number;
     browserOptions: {
+        /** The type of browser to launch - either `chromium`, `firefox` or `webkit` */
         type: 'chromium' | 'firefox' | 'webkit';
+        /** `object` of options that will be passed to playwright when launching the browser. See [full API reference](https://playwright.dev/docs/api/class-browsertype#browser-type-launch). */
         launch?: LaunchOptions;
     };
+    /**
+     * Whether to launch a server to respond to requests in the test suite.
+     * @default `true` (`false` if a `host` is provided)
+     */
     server: boolean;
+    /**
+     * If provided, a URL to use as the test target instead of building and running a new server. Useful for running "real" end-to-end tests against a deployed version of your application, or against an already running local server.
+     * @default `undefined`
+     */
     host?: string;
+    /**
+     * If provided, set the launched test server port to the value.
+     * @default `undefined`
+     */
     port?: number;
     env?: StartServerOptions['env'];
 }

package/dist/shared/{test-utils.Bfk23aTC.d.ts → test-utils.CyoO8zI7.d.ts}

@@ -1,7 +1,6 @@
 import { Browser, BrowserContextOptions, Page, Response as Response$1, LaunchOptions } from 'playwright-core';
 import { NuxtConfig, Nuxt } from '@nuxt/schema';
 import { ExecaChildProcess } from 'execa';
-import * as nitropack from 'nitropack';
 
 declare function createBrowser(): Promise<void>;
 declare function getBrowser(): Promise<Browser>;
@@ -21,30 +20,68 @@ interface StartServerOptions {
 declare function startServer(options?: StartServerOptions): Promise<void>;
 declare function stopServer(): Promise<void>;
 declare function fetch(path: string, options?: RequestInit): Promise<Response>;
-declare const $fetch: nitropack.$Fetch<unknown, nitropack.NitroFetchRequest>;
+declare const $fetch: (typeof globalThis)["$fetch"];
 declare function url(path: string): string;
 
 type TestRunner = 'vitest' | 'jest' | 'cucumber';
 interface TestOptions {
     testDir: string;
     fixture: string;
+    /**
+     * Name of the configuration file.
+     * @default `'nuxt.config`
+     */
     configFile: string;
+    /**
+     * Path to a directory with a Nuxt app to be put under test.
+     * @default `'.'`
+     */
     rootDir: string;
     buildDir: string;
     nuxtConfig: NuxtConfig;
+    /**
+     * Whether to run a separate build step.
+     * @default `true` (`false` if `browser` or `server` is disabled, or if a `host` is provided)
+     */
     build: boolean;
     dev: boolean;
+    /**
+     * The amount of time (in milliseconds) to allow for `setupTest` to complete its work (which could include building or generating files for a Nuxt application, depending on the options that are passed).
+     * @default `60000`
+     */
     setupTimeout: number;
     waitFor: number;
+    /**
+     * Under the hood, Nuxt test utils uses [`playwright`](https://playwright.dev) to carry out browser testing. If this option is set, a browser will be launched and can be controlled in the subsequent test suite.
+     * @default `false`
+     */
     browser: boolean;
+    /**
+     * Specify the runner for the test suite. One of `'vitest' | 'jest' | 'cucumber'`.
+     * @default `vitest`
+     */
     runner: TestRunner;
     logLevel: number;
     browserOptions: {
+        /** The type of browser to launch - either `chromium`, `firefox` or `webkit` */
         type: 'chromium' | 'firefox' | 'webkit';
+        /** `object` of options that will be passed to playwright when launching the browser. See [full API reference](https://playwright.dev/docs/api/class-browsertype#browser-type-launch). */
         launch?: LaunchOptions;
     };
+    /**
+     * Whether to launch a server to respond to requests in the test suite.
+     * @default `true` (`false` if a `host` is provided)
+     */
     server: boolean;
+    /**
+     * If provided, a URL to use as the test target instead of building and running a new server. Useful for running "real" end-to-end tests against a deployed version of your application, or against an already running local server.
+     * @default `undefined`
+     */
     host?: string;
+    /**
+     * If provided, set the launched test server port to the value.
+     * @default `undefined`
+     */
     port?: number;
     env?: StartServerOptions['env'];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/test-utils",
-  "version": "3.14.0",
+  "version": "3.14.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nuxt/test-utils.git"
@@ -51,7 +51,7 @@
     "fake-indexeddb": "^6.0.0",
     "get-port-please": "^3.1.2",
     "local-pkg": "^0.5.0",
-    "magic-string": "^0.30.10",
+    "magic-string": "^0.30.11",
     "node-fetch-native": "^1.6.4",
     "ofetch": "^1.3.4",
     "pathe": "^1.1.2",
@@ -61,36 +61,38 @@
     "std-env": "^3.7.0",
     "ufo": "^1.5.4",
     "unenv": "^1.10.0",
-    "unplugin": "^1.12.0",
+    "unplugin": "^1.12.1",
     "vitest-environment-nuxt": "^1.0.0"
   },
   "devDependencies": {
     "@cucumber/cucumber": "10.8.0",
     "@jest/globals": "29.7.0",
     "@nuxt/devtools": "1.0.8",
-    "@nuxt/eslint-config": "0.3.13",
-    "@nuxt/module-builder": "0.8.1",
-    "@playwright/test": "1.45.3",
+    "@nuxt/eslint-config": "0.5.0",
+    "@nuxt/module-builder": "0.8.2",
+    "@playwright/test": "1.46.0",
     "@testing-library/vue": "8.1.0",
     "@types/estree": "1.0.5",
     "@types/jsdom": "21.1.7",
     "@types/semver": "7.5.8",
-    "@vitest/ui": "2.0.4",
+    "@vitest/ui": "2.0.5",
     "@vue/test-utils": "2.4.6",
     "changelogen": "0.5.5",
-    "eslint": "9.7.0",
+    "compatx": "0.1.8",
+    "eslint": "9.9.0",
     "h3": "1.12.0",
     "jiti": "1.21.6",
     "nitropack": "2.9.7",
     "nuxt": "3.12.4",
-    "playwright-core": "1.45.3",
-    "rollup": "4.19.0",
+    "playwright-core": "1.46.0",
+    "rollup": "4.20.0",
     "semver": "7.6.3",
+    "typescript": "5.5.4",
     "unbuild": "latest",
-    "unimport": "3.9.0",
-    "vite": "5.3.5",
-    "vitest": "2.0.4",
-    "vue-router": "4.4.0",
+    "unimport": "3.10.0",
+    "vite": "5.4.0",
+    "vitest": "2.0.5",
+    "vue-router": "4.4.3",
     "vue-tsc": "2.0.29"
   },
   "peerDependencies": {
@@ -144,20 +146,18 @@
   },
   "resolutions": {
     "@cucumber/cucumber": "10.8.0",
+    "@nuxt/devtools": "1.0.8",
     "@nuxt/kit": "^3.12.4",
     "@nuxt/schema": "^3.12.4",
     "@nuxt/test-utils": "workspace:*",
-    "rollup": "4.19.0",
-    "vite": "5.3.5",
-    "vue": "^3.4.34"
+    "rollup": "4.20.0",
+    "vite": "5.4.0",
+    "vite-node": "2.0.5",
+    "vitest": "2.0.5",
+    "vue": "^3.4.37"
   },
   "engines": {
     "node": ">=18.20.4"
   },
-  "packageManager": "pnpm@9.6.0",
-  "pnpm": {
-    "patchedDependencies": {
-      "nuxt@3.11.2": "patches/nuxt@3.11.2.patch"
-    }
-  }
+  "packageManager": "pnpm@9.7.0"
 }