fix: param parsers when dts is not at root

Author: posva

packages/playground-file-based/src/pages/[...path].vue

@@ -3,6 +3,7 @@ import { useRoute, useRouter } from 'vue-router'
 import doc from '../main.ts?raw'
 
 const route = useRoute()
+console.log('route.params', route.params)
 const router = useRouter()
 // router.push({
 //   name: 'not-found',
@@ -49,10 +50,10 @@ definePage({
         default: -1,
       },
 
-      // optionalWhen: {
-      //   parser: 'date',
-      // },
-      //
+      optionalWhen: {
+        parser: 'date',
+      },
+
       when: {
         parser: 'date',
         default: () => new Date(),

packages/playground-file-based/src/routes.d.ts

@@ -16,7 +16,7 @@ import type {
 } from 'vue-router'
 
 // Custom route params parsers
-type Param_date = ReturnType<NonNullable<typeof import('./src/params/date.ts').parser['get']>>
+type Param_date = ReturnType<NonNullable<typeof import('./params/date.ts').parser['get']>>
 
 declare module 'vue-router' {
   interface TypesConfig {
@@ -46,8 +46,8 @@ declare module 'vue-router/auto-routes' {
     'not-found': RouteRecordInfo<
       'not-found',
       '/:path(.*)',
-      { path: string, page?: number, other?: boolean, active?: boolean, multi?: string[], req?: number, when?: Exclude<Param_date, unknown[]> },
-      { path: string, page: number, other: boolean | undefined, active: boolean, multi: string[] | undefined, req: number, when: Exclude<Param_date, unknown[]> },
+      { path: string, page?: number, other?: boolean, active?: boolean, multi?: string[], req?: number, optionalWhen?: Exclude<Param_date, unknown[]>, when?: Exclude<Param_date, unknown[]> },
+      { path: string, page: number, other: boolean | undefined, active: boolean, multi: string[] | undefined, req: number, optionalWhen: Exclude<Param_date, unknown[]> | undefined, when: Exclude<Param_date, unknown[]> },
       | never
     >,
     '/a.[b].c.[d]': RouteRecordInfo<

packages/router/src/unplugin/codegen/generateParamParsers.spec.ts

@@ -97,6 +97,28 @@ describe('generateParamParsersTypesDeclarations', () => {
     )
   })
 
+  it('generates correct import path when parser is outside dts directory', () => {
+    // This tests the case where dts is in a subfolder (e.g., types/typed-router.d.ts)
+    // and parsers are at project root (e.g., parsers/uuid.ts)
+    // The relativePath should be computed relative to the dts directory
+    const paramParsers: ParamParsersMap = new Map([
+      [
+        'uuid',
+        {
+          name: 'uuid',
+          typeName: 'Param_uuid',
+          relativePath: '../parsers/uuid',
+          absolutePath: '/project/parsers/uuid',
+        },
+      ],
+    ])
+
+    const result = generateParamParsersTypesDeclarations(paramParsers)
+    expect(result).toBe(
+      `type Param_uuid = ReturnType<NonNullable<typeof import('../parsers/uuid').parser['get']>>`
+    )
+  })
+
   it('generates multiple param parsers type declarations', () => {
     const paramParsers: ParamParsersMap = new Map([
       [

packages/router/src/unplugin/codegen/generateParamParsers.ts

@@ -41,10 +41,12 @@ export function generateParamParsersTypesDeclarations(
   paramParsers: ParamParsersMap
 ) {
   return Array.from(paramParsers.values())
-    .map(
-      ({ typeName, relativePath }) =>
-        `type ${typeName} = ReturnType<NonNullable<typeof import('./${relativePath}').parser['get']>>`
-    )
+    .map(({ typeName, relativePath }) => {
+      const importPath = relativePath.startsWith('.')
+        ? relativePath
+        : './' + relativePath
+      return `type ${typeName} = ReturnType<NonNullable<typeof import('${importPath}').parser['get']>>`
+    })
     .join('\n')
 }
 

packages/router/src/unplugin/core/context.ts

@@ -38,6 +38,7 @@ export function createRoutesContext(options: ResolvedOptions) {
       : preferDTS === true
         ? resolve(root, 'typed-router.d.ts')
         : resolve(root, preferDTS)
+  const dtsDir = dts ? dirname(dts) : root
 
   const routeTree = new PrefixTree(options)
   const editableRoutes = new EditableTreeNode(routeTree)
@@ -142,7 +143,7 @@ export function createRoutesContext(options: ResolvedOptions) {
               name,
               typeName: `Param_${name}`,
               absolutePath,
-              relativePath: relative(options.root, absolutePath),
+              relativePath: relative(dtsDir, absolutePath),
             })
           }
           logger.log(
@@ -227,7 +228,7 @@ export function createRoutesContext(options: ResolvedOptions) {
           name,
           typeName: `Param_${name}`,
           absolutePath,
-          relativePath: './' + relative(options.root, absolutePath),
+          relativePath: relative(dtsDir, absolutePath),
         })
         writeConfigFiles()
       })