Add special route types to the link type declaration (vercel#50066)

This PR adds generated type definitions for `Link` hrefs with only search, hash or with a protocol. Closes vercel#49825. fix NEXT-1203
hydRAnger · Jun 12, 2023 · f5092a9 · f5092a9
1 parent 7286132
commit f5092a9
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/packages/next/src/build/webpack/plugins/next-types-plugin.ts b/packages/next/src/build/webpack/plugins/next-types-plugin.ts
@@ -362,6 +362,7 @@ function createRouteDefinitions() {
  */
 declare namespace __next_route_internal_types__ {
   type SearchOrHash = \`?\${string}\` | \`#\${string}\`
+  type WithProtocol = \`\${string}:\${string}\`
 
   type Suffix = '' | SearchOrHash
 
@@ -394,6 +395,8 @@ declare namespace __next_route_internal_types__ {
       // This keeps autocompletion working for static routes.
       '| StaticRoutes'
     }
+    | SearchOrHash
+    | WithProtocol
     | \`\${StaticRoutes}\${SearchOrHash}\`
     | (T extends \`\${DynamicRoutes<infer _>}\${Suffix}\` ? T : never)
     `

diff --git a/test/integration/app-types/src/app/type-checks/link/page.tsx b/test/integration/app-types/src/app/type-checks/link/page.tsx
@@ -62,6 +62,11 @@ export default function page() {
       <Link href="/redirect/v1/guides/x/page">test</Link>
       <Link href="/redirect/guides/x/page">test</Link>
       <Link href={new URL('/about')}>test</Link>
+      <Link href="https://nextjs.org">test</Link>
+      <Link href="http://nextjs.org">test</Link>
+      <Link href="#id">test</Link>
+      <Link href="?page=1">test</Link>
+      <Link href="mailto:foo@example.com">test</Link>
     </>
   )