@nuxt/test-utils 3.3.2 → 3.4.0

package/dist/experimental.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This is a function to render a component directly with the Nuxt server.
+ */
+declare function $fetchComponent(filepath: string, props?: Record<string, any>): Promise<any>;
+declare function componentTestUrl(filepath: string, props?: Record<string, any>): string;
+
+export { $fetchComponent, componentTestUrl };

package/dist/experimental.mjs

@@ -0,0 +1,24 @@
+import { resolve } from 'pathe';
+import { stringifyQuery } from 'ufo';
+import { $ as $fetch, u as useTestContext } from './shared/test-utils.1e170326.mjs';
+import 'execa';
+import 'get-port-please';
+import 'ofetch';
+import '@nuxt/kit';
+import 'node:path';
+import 'defu';
+
+function $fetchComponent(filepath, props) {
+  return $fetch(componentTestUrl(filepath, props));
+}
+function componentTestUrl(filepath, props) {
+  const ctx = useTestContext();
+  filepath = resolve(ctx.options.rootDir, filepath);
+  const path = stringifyQuery({
+    path: filepath,
+    props: JSON.stringify(props)
+  });
+  return `/__nuxt_component_test__/?${path}`;
+}
+
+export { $fetchComponent, componentTestUrl };

package/dist/index.mjs

@@ -1,126 +1,15 @@
+import { u as useTestContext, a as url, c as createTestContext, s as setTestContext, b as stopServer, d as startServer } from './shared/test-utils.1e170326.mjs';
+export { $ as $fetch, e as exposeContextToEnv, f as fetch, i as isDev, r as recoverContextFromEnv } from './shared/test-utils.1e170326.mjs';
+import { consola } from 'consola';
+import { promises, existsSync } from 'node:fs';
 import { resolve } from 'node:path';
 import { defu } from 'defu';
-import { execa } from 'execa';
-import { getRandomPort, waitForPort } from 'get-port-please';
-import { fetch as fetch$1, $fetch as $fetch$1 } from 'ofetch';
 import * as _kit from '@nuxt/kit';
-import consola from 'consola';
-import { promises, existsSync } from 'node:fs';
 import { dirname, resolve as resolve$1 } from 'pathe';
 import { fileURLToPath } from 'node:url';
-
-let currentContext;
-function createTestContext(options) {
-  const _options = defu(options, {
-    testDir: resolve(process.cwd(), "test"),
-    fixture: "fixture",
-    configFile: "nuxt.config",
-    setupTimeout: 120 * 1e3,
-    dev: !!JSON.parse(process.env.NUXT_TEST_DEV || "false"),
-    logLevel: 1,
-    server: true,
-    build: options.browser !== false || options.server !== false,
-    nuxtConfig: {},
-    // TODO: auto detect based on process.env
-    runner: "vitest",
-    browserOptions: {
-      type: "chromium"
-    }
-  });
-  return setTestContext({
-    options: _options
-  });
-}
-function useTestContext() {
-  recoverContextFromEnv();
-  if (!currentContext) {
-    throw new Error("No context is available. (Forgot calling setup or createContext?)");
-  }
-  return currentContext;
-}
-function setTestContext(context) {
-  currentContext = context;
-  return currentContext;
-}
-function isDev() {
-  const ctx = useTestContext();
-  return ctx.options.dev;
-}
-function recoverContextFromEnv() {
-  if (!currentContext && process.env.NUXT_TEST_CONTEXT) {
-    setTestContext(JSON.parse(process.env.NUXT_TEST_CONTEXT || "{}"));
-  }
-}
-function exposeContextToEnv() {
-  const { options, browser, url } = currentContext;
-  process.env.NUXT_TEST_CONTEXT = JSON.stringify({ options, browser, url });
-}
-
-const kit$1 = _kit.default || _kit;
-async function startServer() {
-  const ctx = useTestContext();
-  await stopServer();
-  const port = await getRandomPort();
-  ctx.url = "http://127.0.0.1:" + port;
-  if (ctx.options.dev) {
-    const nuxiCLI = await kit$1.resolvePath("nuxi/cli");
-    ctx.serverProcess = execa(nuxiCLI, ["dev"], {
-      cwd: ctx.nuxt.options.rootDir,
-      stdio: "inherit",
-      env: {
-        ...process.env,
-        PORT: String(port),
-        NITRO_PORT: String(port),
-        NODE_ENV: "development"
-      }
-    });
-    await waitForPort(port, { retries: 32 });
-    for (let i = 0; i < 50; i++) {
-      await new Promise((resolve2) => setTimeout(resolve2, 100));
-      try {
-        const res = await $fetch(ctx.nuxt.options.app.baseURL);
-        if (!res.includes("__NUXT_LOADING__")) {
-          return;
-        }
-      } catch {
-      }
-    }
-    ctx.serverProcess.kill();
-    throw new Error("Timeout waiting for dev server!");
-  } else {
-    ctx.serverProcess = execa("node", [
-      resolve(ctx.nuxt.options.nitro.output.dir, "server/index.mjs")
-    ], {
-      stdio: "inherit",
-      env: {
-        ...process.env,
-        PORT: String(port),
-        NITRO_PORT: String(port),
-        NODE_ENV: "test"
-      }
-    });
-    await waitForPort(port, { retries: 8 });
-  }
-}
-async function stopServer() {
-  const ctx = useTestContext();
-  if (ctx.serverProcess) {
-    await ctx.serverProcess.kill();
-  }
-}
-function fetch(path, options) {
-  return fetch$1(url(path), options);
-}
-function $fetch(path, options) {
-  return $fetch$1(url(path), options);
-}
-function url(path) {
-  const ctx = useTestContext();
-  if (!ctx.url) {
-    throw new Error("url is not available (is server option enabled?)");
-  }
-  return ctx.url + path;
-}
+import 'execa';
+import 'get-port-please';
+import 'ofetch';
 
 async function createBrowser() {
   const ctx = useTestContext();
@@ -345,4 +234,4 @@ async function runTests(opts) {
   }
 }
 
-export { $fetch, buildFixture, createBrowser, createPage, createTest, createTestContext, exposeContextToEnv, fetch, getBrowser, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };
+export { buildFixture, createBrowser, createPage, createTest, createTestContext, getBrowser, loadFixture, mockFn, mockLogger, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };

package/dist/shared/test-utils.1e170326.mjs

@@ -0,0 +1,125 @@
+import { execa } from 'execa';
+import { getRandomPort, waitForPort } from 'get-port-please';
+import { fetch as fetch$1, $fetch as $fetch$1 } from 'ofetch';
+import * as _kit from '@nuxt/kit';
+import { resolve as resolve$1 } from 'pathe';
+import { resolve } from 'node:path';
+import { defu } from 'defu';
+
+let currentContext;
+function createTestContext(options) {
+  const _options = defu(options, {
+    testDir: resolve(process.cwd(), "test"),
+    fixture: "fixture",
+    configFile: "nuxt.config",
+    setupTimeout: 120 * 1e3,
+    dev: !!JSON.parse(process.env.NUXT_TEST_DEV || "false"),
+    logLevel: 1,
+    server: true,
+    build: options.browser !== false || options.server !== false,
+    nuxtConfig: {},
+    // TODO: auto detect based on process.env
+    runner: "vitest",
+    browserOptions: {
+      type: "chromium"
+    }
+  });
+  return setTestContext({
+    options: _options
+  });
+}
+function useTestContext() {
+  recoverContextFromEnv();
+  if (!currentContext) {
+    throw new Error("No context is available. (Forgot calling setup or createContext?)");
+  }
+  return currentContext;
+}
+function setTestContext(context) {
+  currentContext = context;
+  return currentContext;
+}
+function isDev() {
+  const ctx = useTestContext();
+  return ctx.options.dev;
+}
+function recoverContextFromEnv() {
+  if (!currentContext && process.env.NUXT_TEST_CONTEXT) {
+    setTestContext(JSON.parse(process.env.NUXT_TEST_CONTEXT || "{}"));
+  }
+}
+function exposeContextToEnv() {
+  const { options, browser, url } = currentContext;
+  process.env.NUXT_TEST_CONTEXT = JSON.stringify({ options, browser, url });
+}
+
+const kit = _kit.default || _kit;
+async function startServer() {
+  const ctx = useTestContext();
+  await stopServer();
+  const port = await getRandomPort();
+  ctx.url = "http://127.0.0.1:" + port;
+  if (ctx.options.dev) {
+    const nuxiCLI = await kit.resolvePath("nuxi/cli");
+    ctx.serverProcess = execa(nuxiCLI, ["dev"], {
+      cwd: ctx.nuxt.options.rootDir,
+      stdio: "inherit",
+      env: {
+        ...process.env,
+        PORT: String(port),
+        NITRO_PORT: String(port),
+        NODE_ENV: "development"
+      }
+    });
+    await waitForPort(port, { retries: 32 });
+    for (let i = 0; i < 50; i++) {
+      await new Promise((resolve2) => setTimeout(resolve2, 100));
+      try {
+        const res = await $fetch(ctx.nuxt.options.app.baseURL);
+        if (!res.includes("__NUXT_LOADING__")) {
+          return;
+        }
+      } catch {
+      }
+    }
+    ctx.serverProcess.kill();
+    throw new Error("Timeout waiting for dev server!");
+  } else {
+    ctx.serverProcess = execa("node", [
+      resolve$1(ctx.nuxt.options.nitro.output.dir, "server/index.mjs")
+    ], {
+      stdio: "inherit",
+      env: {
+        ...process.env,
+        PORT: String(port),
+        NITRO_PORT: String(port),
+        NODE_ENV: "test"
+      }
+    });
+    await waitForPort(port, { retries: 8 });
+  }
+}
+async function stopServer() {
+  const ctx = useTestContext();
+  if (ctx.serverProcess) {
+    await ctx.serverProcess.kill();
+  }
+}
+function fetch(path, options) {
+  return fetch$1(url(path), options);
+}
+function $fetch(path, options) {
+  return $fetch$1(url(path), options);
+}
+function url(path) {
+  const ctx = useTestContext();
+  if (!ctx.url) {
+    throw new Error("url is not available (is server option enabled?)");
+  }
+  if (path.startsWith(ctx.url)) {
+    return 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/test-utils",
-  "version": "3.3.2",
+  "version": "3.4.0",
   "repository": "nuxt/nuxt",
   "license": "MIT",
   "type": "module",
@@ -9,26 +9,31 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs"
+    },
+    "./experimental": {
+      "types": "./dist/experimental.d.ts",
+      "import": "./dist/experimental.mjs"
     }
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "3.3.2",
-    "@nuxt/schema": "3.3.2",
-    "consola": "^2.15.3",
+    "consola": "^3.0.1",
     "defu": "^6.1.2",
     "execa": "^7.1.1",
     "get-port-please": "^3.0.1",
     "jiti": "^1.18.2",
     "ofetch": "^1.0.1",
-    "pathe": "^1.1.0"
+    "pathe": "^1.1.0",
+    "ufo": "^1.1.1",
+    "@nuxt/schema": "3.4.0",
+    "@nuxt/kit": "3.4.0"
   },
   "devDependencies": {
-    "playwright": "^1.32.0",
+    "playwright": "^1.32.3",
     "unbuild": "latest",
-    "vitest": "^0.29.7"
+    "vitest": "^0.30.1"
   },
   "peerDependencies": {
     "vue": "^3.2.47"