Unverified Commit c0a7c842 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Add documentation for experimental adapters handling (#83737)

This adds initial documentation for the new adapter interface initially
outlined in this RFC https://github.com/vercel/next.js/discussions/77740

---------
Co-authored-by: 's avatarvercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
Co-authored-by: 's avatarZack Tanner <1939140+ztanner@users.noreply.github.com>
parent a29b4fa5
---
title: experimental.adapterPath
description: Configure a custom adapter for Next.js to hook into the build process with modifyConfig and onBuildComplete callbacks.
---
Next.js provides an experimental API that allows you to create custom adapters to hook into the build process. This is useful for deployment platforms or custom build integrations that need to modify the Next.js configuration or process the build output.
## Configuration
To use an adapter, specify the path to your adapter module in `experimental.adapterPath`:
```js filename="next.config.js"
/** @type {import('next').NextConfig} */
const nextConfig = {
experimental: {
adapterPath: require.resolve('./my-adapter.js'),
},
}
module.exports = nextConfig
```
## Creating an Adapter
An adapter is a module that exports an object implementing the `NextAdapter` interface:
```typescript
export interface NextAdapter {
name: string
modifyConfig?: (
config: NextConfigComplete,
ctx: {
phase: PHASE_TYPE
}
) => Promise<NextConfigComplete> | NextConfigComplete
onBuildComplete?: (ctx: {
routes: {
headers: Array<ManifestHeaderRoute>
redirects: Array<ManifestRedirectRoute>
rewrites: {
beforeFiles: Array<ManifestRewriteRoute>
afterFiles: Array<ManifestRewriteRoute>
fallback: Array<ManifestRewriteRoute>
}
dynamicRoutes: ReadonlyArray<ManifestRoute>
}
outputs: AdapterOutputs
projectDir: string
repoRoot: string
distDir: string
config: NextConfigComplete
nextVersion: string
}) => Promise<void> | void
}
```
### Basic Adapter Structure
Here's a minimal adapter example:
```js filename="my-adapter.js"
/** @type {import('next').NextAdapter} */
const adapter = {
name: 'my-custom-adapter',
async modifyConfig(config, { phase }) {
// Modify the Next.js config based on the build phase
if (phase === 'phase-production-build') {
return {
...config,
// Add your modifications
}
}
return config
},
async onBuildComplete({
routes,
outputs,
projectDir,
repoRoot,
distDir,
config,
nextVersion,
}) {
// Process the build output
console.log('Build completed with', outputs.pages.length, 'pages')
// Access different output types
for (const page of outputs.pages) {
console.log('Page:', page.pathname, 'at', page.filePath)
}
for (const apiRoute of outputs.pagesApi) {
console.log('API Route:', apiRoute.pathname, 'at', apiRoute.filePath)
}
for (const appPage of outputs.appPages) {
console.log('App Page:', appPage.pathname, 'at', appPage.filePath)
}
for (const prerender of outputs.prerenders) {
console.log('Prerendered:', prerender.pathname)
}
},
}
module.exports = adapter
```
## API Reference
### `modifyConfig(config, context)`
Called for any CLI command that loads the next.config to allow modification of the configuration.
**Parameters:**
- `config`: The complete Next.js configuration object
- `context.phase`: The current build phase (see [phases](/docs/app/api-reference/config/next-config-js#phase))
**Returns:** The modified configuration object (can be async)
### `onBuildComplete(context)`
Called after the build process completes with detailed information about routes and outputs.
**Parameters:**
- `routes`: Object containing route manifests for headers, redirects, rewrites, and dynamic routes
- `outputs`: Detailed information about all build outputs organized by type
- `projectDir`: Absolute path to the Next.js project directory
- `repoRoot`: Absolute path to the detected repository root
- `distDir`: Absolute path to the build output directory
- `config`: The final Next.js configuration (with `modifyConfig` applied)
- `nextVersion`: Version of Next.js being used
## Output Types
The `outputs` object contains arrays of different output types:
### Pages (`outputs.pages`)
React pages from the `pages/` directory:
```typescript
{
type: 'PAGES'
id: string // Route identifier
filePath: string // Path to the built file
pathname: string // URL pathname
runtime: 'nodejs' | 'edge'
assets: Record<string, string> // Traced dependencies
config: {
maxDuration?: number
preferredRegion?: string | string[]
}
}
```
### API Routes (`outputs.pagesApi`)
API routes from `pages/api/`:
```typescript
{
type: 'PAGES_API'
id: string
filePath: string
pathname: string
runtime: 'nodejs' | 'edge'
assets: Record<string, string>
config: {
maxDuration?: number
preferredRegion?: string | string[]
}
}
```
### App Pages (`outputs.appPages`)
React pages from the `app/` directory with `page.{js,ts,jsx,tsx}`:
```typescript
{
type: 'APP_PAGE'
id: string
filePath: string
pathname: string
runtime: 'nodejs' | 'edge'
assets: Record<string, string>
config: {
maxDuration?: number
preferredRegion?: string | string[]
}
}
```
### App Routes (`outputs.appRoutes`)
API and metadata routes from `app/` with `route.{js,ts,jsx,tsx}`:
```typescript
{
type: 'APP_ROUTE'
// ... same structure as APP_PAGE
}
```
### Prerenders (`outputs.prerenders`)
ISR-enabled routes and static prerenders:
```typescript
{
type: 'PRERENDER'
id: string
pathname: string
parentOutputId: string // ID of the source page/route
groupId: number // Revalidation group identifier
fallback?: {
filePath: string
initialStatus?: number
initialHeaders?: Record<string, string | string[]>
initialExpiration?: number
initialRevalidate?: number
postponedState?: string // PPR postponed state
}
config: {
allowQuery?: string[] // Allowed query parameters
allowHeader?: string[] // Allowed headers for ISR
bypassFor?: RouteHas[] // Cache bypass conditions
renderingMode?: RenderingMode
bypassToken?: string
}
}
```
### Static Files (`outputs.staticFiles`)
Static assets and auto-statically optimized pages:
```typescript
{
type: 'STATIC_FILE'
id: string
filePath: string
pathname: string
}
```
### Middleware (`outputs.middleware`)
Middleware function (if present):
```typescript
{
type: 'MIDDLEWARE'
id: string
filePath: string
pathname: string
runtime: 'nodejs' | 'edge'
assets: Record<string, string>
config: {
maxDuration?: number
preferredRegion?: string | string[]
matchers?: MiddlewareMatcher[]
}
}
```
## Use Cases
Common use cases for adapters include:
- **Deployment Platform Integration**: Automatically configure build outputs for specific hosting platforms
- **Asset Processing**: Transform or optimize build outputs
- **Monitoring Integration**: Collect build metrics and route information
- **Custom Bundling**: Package outputs in platform-specific formats
- **Build Validation**: Ensure outputs meet specific requirements
---
title: experimental.adapterPath
description: Configure a custom adapter for Next.js to hook into the build process with modifyConfig and buildComplete callbacks.
source: app/api-reference/config/next-config-js/adapterPath
---
{/* DO NOT EDIT. The content of this doc is generated from the source above. To edit the content of this page, navigate to the source page in your editor. You can use the `<PagesOnly>Content</PagesOnly>` component to add content that is specific to the Pages Router. Any shared content should not be wrapped in a component. */}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment