feat: e2e sub-path export

README.md

@@ -61,7 +61,7 @@ A simple example could look like this:
 
 ```ts
 import { describe, expect, it } from 'vitest'
-import { $fetch } from 'nitro-test-utils'
+import { $fetch } from 'nitro-test-utils/e2e'
 
 describe('routes', () => {
   it('responds successfully', async () => {

build.config.ts

@@ -1,7 +1,7 @@
 import { defineBuildConfig } from 'unbuild'
 
 export default defineBuildConfig({
-  entries: ['src/index', 'src/config', 'src/setup'],
+  entries: ['src/index', 'src/e2e', 'src/config', 'src/setup'],
   externals: ['vite', 'vitest', 'vitest/config'],
   clean: true,
   declaration: true,

package.json

@@ -28,6 +28,10 @@
     "./config": {
       "types": "./dist/config.d.mts",
       "import": "./dist/config.mjs"
+    },
+    "./e2e": {
+      "types": "./dist/e2e.d.mts",
+      "import": "./dist/e2e.mjs"
     }
   },
   "types": "./dist/index.d.ts",

src/e2e.ts

@@ -0,0 +1,61 @@
+import { joinURL } from 'ufo'
+import { ofetch } from 'ofetch'
+import type { FetchOptions, ResponseType } from 'ofetch'
+
+export async function $fetch<T = any, R extends ResponseType = 'json'>(
+  url: string,
+  options?: FetchOptions<R>,
+) {
+  const { inject } = await import('vitest')
+  const serverUrl = inject('nitroServerUrl')
+
+  const response = await ofetch.raw<T, R>(
+    joinURL(serverUrl, url),
+    mergeFetchOptions<R>(options, {
+      ignoreResponseError: true,
+      redirect: 'manual',
+      headers: {
+        accept: 'application/json',
+      },
+    }),
+  )
+
+  return {
+    body: response._data as T,
+    status: response.status,
+    headers: Object.fromEntries(response.headers.entries()),
+  }
+}
+
+export function mergeFetchOptions<R extends ResponseType = 'json'>(
+  input: FetchOptions<R> | undefined,
+  defaults: FetchOptions<R> | undefined,
+): FetchOptions<R> {
+  const merged: FetchOptions<R> = {
+    ...defaults,
+    ...input,
+  }
+
+  // Merge params and query
+  if (defaults?.params && input?.params) {
+    merged.params = {
+      ...defaults?.params,
+      ...input?.params,
+    }
+  }
+  if (defaults?.query && input?.query) {
+    merged.query = {
+      ...defaults?.query,
+      ...input?.query,
+    }
+  }
+
+  // Merge headers
+  if (defaults?.headers && input?.headers) {
+    merged.headers = new Headers(defaults?.headers || {})
+    for (const [key, value] of new Headers(input?.headers || {}))
+      merged.headers.set(key, value)
+  }
+
+  return merged
+}

src/index.ts

@@ -1,7 +1,5 @@
 import { resolve } from 'pathe'
-import { joinURL } from 'ufo'
 import { listen } from 'listhen'
-import { ofetch } from 'ofetch'
 import {
   build,
   copyPublicAssets,
@@ -11,9 +9,14 @@ import {
   prerender,
 } from 'nitropack'
 import type { Listener } from 'listhen'
-import type { FetchOptions, ResponseType } from 'ofetch'
 import type { Nitro, NitroOptions } from 'nitropack'
 
+declare module 'vitest' {
+  export interface ProvidedContext {
+    nitroServerUrl: string
+  }
+}
+
 export interface Context {
   preset: NitroOptions['preset']
   nitro?: Nitro
@@ -23,6 +26,8 @@ export interface Context {
   isDev: boolean
 }
 
+export { $fetch } from './e2e'
+
 export async function setupContext({
   preset = 'node',
   // eslint-disable-next-line node/prefer-global/process
@@ -88,38 +93,3 @@ export async function startServer(ctx: Context) {
       await ctx.nitro.close()
   }
 }
-
-export async function $fetch<T = any, R extends ResponseType = 'json'>(
-  url: string,
-  options?: FetchOptions<R>,
-) {
-  const { inject } = await import('vitest')
-  const serverUrl = inject('nitroServerUrl')
-
-  const response = await ofetch.raw<T, R>(joinURL(serverUrl, url), {
-    ...options,
-    ignoreResponseError: true,
-    redirect: 'manual',
-    headers: {
-      // Enforce Nitro error response in JSON when routes fail
-      accept: 'application/json',
-      ...headersToObject(options?.headers),
-    },
-  })
-
-  return {
-    body: response._data as T,
-    status: response.status,
-    headers: Object.fromEntries(response.headers.entries()),
-  }
-}
-
-function headersToObject(headers?: HeadersInit) {
-  return Object.fromEntries(new Headers(headers).entries())
-}
-
-declare module 'vitest' {
-  export interface ProvidedContext {
-    nitroServerUrl: string
-  }
-}