rename "unstable_prefetch" to "unstable_instant"

Author: lubieowoce

errors/invalid-prefetch-configuration.mdx errors/invalid-instant-configuration.mdxerrors/invalid-prefetch-configuration.mdx renamed to errors/invalid-instant-configuration.mdx

@@ -1,25 +1,25 @@
 ---
-title: Invalid Prefetch Configuration
+title: Invalid Instant Configuration
 ---
 
 ## Why This Message Occurred
 
-You provided an invalid configuration for `export const unstable_prefetch` in a Layout or Page file.
+You provided an invalid configuration for `export const unstable_instant` in a Layout or Page file.
 
 ### Example of Correct Usage
 
 #### Static Prefetching
 
 ```tsx filename="app/.../layout.tsx"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'static',
 }
 ```
 
 #### Runtime Prefetching
 
 ```tsx filename="app/[slug]/page.tsx"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [
     {

errors/next-prerender-runtime-crypto.mdx

@@ -19,7 +19,7 @@ If you are generating a token to talk to a database that itself should be cached
 Before:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -40,7 +40,7 @@ export default async function Page({ params }) {
 After:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -65,7 +65,7 @@ If you require this random value to be unique per Request and an async version o
 Before:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -84,7 +84,7 @@ export default async function Page({ params }) {
 After:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -107,7 +107,7 @@ If you require this random value to be unique per Request and an async version o
 Before:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -122,7 +122,7 @@ export default async function Page({ params }) {
 After:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }

errors/next-prerender-runtime-current-time.mdx

@@ -23,7 +23,7 @@ If you are using the current time for performance tracking with elapsed time use
 Before:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -42,7 +42,7 @@ export default async function Page({ params }) {
 After:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -67,7 +67,7 @@ If you want to read the time when some cache entry is created (such as when a Ne
 Before:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -96,7 +96,7 @@ export default async function Page({ params }) {
 After:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -136,7 +136,7 @@ If you go with this approach you will need to ensure the Client Component which
 Before:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -193,7 +193,7 @@ export function RelativeTime({ when }) {
 ```
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -230,7 +230,7 @@ Next.js enforces that it can always produce at least a partially static initial
 Before:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -249,7 +249,7 @@ export default async function Page() {
 After:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }

errors/next-prerender-runtime-random.mdx

@@ -23,7 +23,7 @@ If your random value is cacheable, move the `Math.random()` call to a `"use cach
 Before:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -40,7 +40,7 @@ export default async function Page({ params }) {
 After:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -68,7 +68,7 @@ If you want the random value to be evaluated on each Request precede it with `aw
 Before:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }
@@ -85,7 +85,7 @@ export default async function Page({ params }) {
 After:
 
 ```jsx filename="app/page.js"
-export const unstable_prefetch = {
+export const unstable_instant = {
   mode: 'runtime',
   samples: [...],
 }

packages/next/errors.json

@@ -986,5 +986,6 @@
   "985": "No response is returned from route handler '%s'. Expected a Response object but received '%s' (method: %s, url: %s). Ensure you return a \\`Response\\` or a \\`NextResponse\\` in all branches of your handler.",
   "986": "Server Action arguments list is too long (%s). Maximum allowed is %s.",
   "987": "Invalid \\`deploymentId\\` configuration: must be a string. See https://nextjs.org/docs/messages/deploymentid-not-a-string",
-  "988": "Invalid \\`deploymentId\\` configuration: contains invalid characters. Only alphanumeric characters, hyphens, and underscores are allowed. See https://nextjs.org/docs/messages/deploymentid-invalid-characters"
+  "988": "Invalid \\`deploymentId\\` configuration: contains invalid characters. Only alphanumeric characters, hyphens, and underscores are allowed. See https://nextjs.org/docs/messages/deploymentid-invalid-characters",
+  "989": "Page \"%s\" cannot use \\`export const unstable_instant = ...\\` without enabling \\`cacheComponents\\`."
 }

packages/next/src/build/analysis/get-page-static-info.ts

@@ -684,9 +684,9 @@ export async function getAppPageStaticInfo({
     )
   }
 
-  if ('unstable_prefetch' in config && !nextConfig.cacheComponents) {
+  if ('unstable_instant' in config && !nextConfig.cacheComponents) {
     throw new Error(
-      `Page "${page}" cannot use \`export const unstable_prefetch = ...\` without enabling \`cacheComponents\`.`
+      `Page "${page}" cannot use \`export const unstable_instant = ...\` without enabling \`cacheComponents\`.`
     )
   }
 

packages/next/src/build/segment-config/app/app-segment-config.ts

@@ -21,15 +21,15 @@ const RuntimeSampleSchema = z
   })
   .strict()
 
-const StaticPrefetchSchema = z
+const InstantConfigStaticSchema = z
   .object({
     mode: z.literal('static'),
     from: z.array(z.string()).optional(),
     expectUnableToVerify: z.boolean().optional(),
   })
   .strict()
 
-const RuntimePrefetchSchema = z
+const InstantConfigRuntimeSchema = z
   .object({
     mode: z.literal('runtime'),
     samples: z.array(RuntimeSampleSchema).min(1),
@@ -38,42 +38,48 @@ const RuntimePrefetchSchema = z
   })
   .strict()
 
-const PrefetchSchema = z.discriminatedUnion('mode', [
-  StaticPrefetchSchema,
-  RuntimePrefetchSchema,
+const InstantConfigSchema = z.discriminatedUnion('mode', [
+  InstantConfigStaticSchema,
+  InstantConfigRuntimeSchema,
 ])
 
-export type Prefetch = StaticPrefetch | RuntimePrefetch
-export type PrefetchForTypeCheckInternal = __GenericPrefetch | Prefetch
+export type InstantConfig = InstantConfigStatic | InstantConfigRuntime
+export type InstantConfigForTypeCheckInternal =
+  | __GenericInstantConfig
+  | InstantConfig
 // the __GenericPrefetch type is used to avoid type widening issues with
 // our choice to make exports the medium for programming a Next.js application
 // With exports the type is controlled by the module and all we can do is assert on it
 // from a consumer. However with string literals in objects these are by default typed widely
 // and thus cannot match the discriminated union type. If we figure out a better way we should
 // delete the __GenericPrefetch member.
-interface __GenericPrefetch {
+interface __GenericInstantConfig {
   mode: string
   samples?: Array<WideRuntimeSample>
   from?: string[]
   expectUnableToVerify?: boolean
 }
-interface StaticPrefetch {
+
+interface InstantConfigStatic {
   mode: 'static'
   from?: string[]
   expectUnableToVerify?: boolean
 }
-interface RuntimePrefetch {
+
+interface InstantConfigRuntime {
   mode: 'runtime'
   samples: Array<RuntimeSample>
   from?: string[]
   expectUnableToVerify?: boolean
 }
+
 type WideRuntimeSample = {
   cookies?: RuntimeSample['cookies']
   headers?: Array<string[]>
   params?: RuntimeSample['params']
   searchParams?: RuntimeSample['searchParams']
 }
+
 type RuntimeSample = {
   cookies?: Array<{
     name: string
@@ -127,7 +133,7 @@ const AppSegmentConfigSchema = z.object({
   /**
    * How this segment should be prefetched.
    */
-  unstable_prefetch: PrefetchSchema.optional(),
+  unstable_instant: InstantConfigSchema.optional(),
 
   /**
    * The preferred region for the page.
@@ -166,10 +172,10 @@ export function parseAppSegmentConfig(
               )} on "${route}", must be a non-negative number or false`,
             }
           }
-          case 'unstable_prefetch': {
+          case 'unstable_instant': {
             return {
               // @TODO replace this link with a link to the docs when they are written
-              message: `Invalid unstable_prefetch value ${JSON.stringify(ctx.data)} on "${route}", must be an object with a mode of "static" or "runtime". Read more at https://nextjs.org/docs/messages/invalid-prefetch-configuration`,
+              message: `Invalid unstable_instant value ${JSON.stringify(ctx.data)} on "${route}", must be an object with a mode of "static" or "runtime". Read more at https://nextjs.org/docs/messages/invalid-instant-configuration`,
             }
           }
           default:
@@ -224,7 +230,7 @@ export type AppSegmentConfig = {
   /**
    * How this segment should be prefetched.
    */
-  unstable_prefetch?: Prefetch
+  unstable_instant?: InstantConfig
 
   /**
    * The preferred region for the page.

packages/next/src/build/webpack/plugins/next-types-plugin/index.ts

@@ -54,7 +54,7 @@ ${
     : `import type { ResolvingMetadata, ResolvingViewport } from 'next/dist/lib/metadata/types/metadata-interface.js'`
 }
 
-import type { PrefetchForTypeCheckInternal } from 'next/dist/build/segment-config/app/app-segment-config.js'
+import type { InstantConfigForTypeCheckInternal } from 'next/dist/build/segment-config/app/app-segment-config.js'
 
 type TEntry = typeof import('${relativePath}.js')
 
@@ -71,7 +71,7 @@ checkFields<Diff<{
   }
   config?: {}
   generateStaticParams?: Function
-  unstable_prefetch?: PrefetchForTypeCheckInternal
+  unstable_instant?: InstantConfigForTypeCheckInternal
   revalidate?: RevalidateRange<TEntry> | false
   dynamic?: 'auto' | 'force-dynamic' | 'error' | 'force-static'
   dynamicParams?: boolean

packages/next/src/server/app-render/create-component-tree.tsx

@@ -225,11 +225,11 @@ async function createComponentTreeInternal(
       })
     : []
 
-  const prefetchConfig = layoutOrPageMod
-    ? (layoutOrPageMod as AppSegmentConfig).unstable_prefetch
+  const instantConfig = layoutOrPageMod
+    ? (layoutOrPageMod as AppSegmentConfig).unstable_instant
     : undefined
   /** Whether this segment should use a runtime prefetch instead of a static prefetch. */
-  const hasRuntimePrefetch = prefetchConfig?.mode === 'runtime'
+  const hasRuntimePrefetch = instantConfig?.mode === 'runtime'
 
   const [Forbidden, forbiddenStyles] =
     authInterrupts && forbidden

packages/next/src/server/app-render/staged-validation.tsx

@@ -9,11 +9,11 @@ export async function anySegmentHasRuntimePrefetchEnabled(
   const { mod: layoutOrPageMod } = await getLayoutOrPageModule(tree)
 
   // TODO(restart-on-cache-miss): Does this work correctly for client page/layout modules?
-  const prefetchConfig = layoutOrPageMod
-    ? (layoutOrPageMod as AppSegmentConfig).unstable_prefetch
+  const instantConfig = layoutOrPageMod
+    ? (layoutOrPageMod as AppSegmentConfig).unstable_instant
     : undefined
   /** Whether this segment should use a runtime prefetch instead of a static prefetch. */
-  const hasRuntimePrefetch = prefetchConfig?.mode === 'runtime'
+  const hasRuntimePrefetch = instantConfig?.mode === 'runtime'
   if (hasRuntimePrefetch) {
     return true
   }