chore: use latest vue-router

posva · posva · commit 13706a2a1c46 · 2025-04-25T15:22:32.000+02:00
diff --git a/docs/.vitepress/twoslash-files.ts b/docs/.vitepress/twoslash-files.ts
@@ -6,7 +6,6 @@ declare module 'vue-router/auto-routes' {
     ParamValueOneOrMore,
     ParamValueZeroOrMore,
     ParamValueZeroOrOne,
-    RouteMeta,
   } from 'vue-router'
 
   /**
@@ -18,31 +17,27 @@ declare module 'vue-router/auto-routes' {
       '/',
       Record<never, never>,
       Record<never, never>,
-      RouteMeta,
       never
     >
     '/users': RouteRecordInfo<
       '/users',
       '/users',
       Record<never, never>,
       Record<never, never>,
-      RouteMeta,
       never
     >
     '/users/[id]': RouteRecordInfo<
       '/users/[id]',
       '/users/:id',
       { id: ParamValue<true> },
       { id: ParamValue<false> },
-      RouteMeta,
       '/users/[id]/edit'
     >
     '/users/[id]/edit': RouteRecordInfo<
       '/users/[id]/edit',
       '/users/:id/edit',
       { id: ParamValue<true> },
       { id: ParamValue<false> },
-      RouteMeta,
       never
     >
   }
diff --git a/docs/.vitepress/twoslash/code/typed-router.ts b/docs/.vitepress/twoslash/code/typed-router.ts
@@ -5,7 +5,6 @@ declare module 'vue-router/auto-routes' {
     ParamValueOneOrMore,
     ParamValueZeroOrMore,
     ParamValueZeroOrOne,
-    RouteMeta,
   } from 'vue-router'
 
   export interface RouteNamedMap {
@@ -14,31 +13,27 @@ declare module 'vue-router/auto-routes' {
       '/',
       Record<never, never>,
       Record<never, never>,
-      RouteMeta,
       never
     >
     '/users': RouteRecordInfo<
       '/users',
       '/users',
       Record<never, never>,
       Record<never, never>,
-      RouteMeta,
       never
     >
     '/users/[id]': RouteRecordInfo<
       '/users/[id]',
       '/users/:id',
       { id: ParamValue<true> },
       { id: ParamValue<false> },
-      RouteMeta,
       '/users/[id]/edit'
     >
     '/users/[id]/edit': RouteRecordInfo<
       '/users/[id]/edit',
       '/users/:id/edit',
       { id: ParamValue<true> },
       { id: ParamValue<false> },
-      RouteMeta,
       never
     >
   }
diff --git a/docs/guide/typescript.md b/docs/guide/typescript.md
@@ -50,7 +50,6 @@ import type {
   ParamValueOneOrMore,
   ParamValueZeroOrMore,
   ParamValueZeroOrOne,
-  RouteMeta,
 } from 'vue-router'
 declare module 'vue-router/auto-routes' {
   export interface RouteNamedMap {
@@ -62,8 +61,6 @@ declare module 'vue-router/auto-routes' {
       { path: ParamValue<true> },
       // these are the normalized params as found in useRoute().params
       { path: ParamValue<false> },
-      // these are the `meta` fields
-      RouteMeta,
       // this is a union of all children route names
       // if the route does not have nested routes, pass `never` or omit this generic entirely
       'custom-dynamic-child-name'
@@ -73,7 +70,6 @@ declare module 'vue-router/auto-routes' {
       '/added-during-runtime/[...path]/child',
       { path: ParamValue<true> },
       { path: ParamValue<false> },
-      RouteMeta,
       never
     >
   }
@@ -96,7 +92,8 @@ import { useRoute, type RouteLocationNormalizedLoaded } from 'vue-router'
 // of `/users/[id]` in this example.
 
 // Not recommended, since this leaves out any child routes' typings.
-const userRouteWithIdCasted = useRoute() as RouteLocationNormalizedLoaded<'/users/[id]'>
+const userRouteWithIdCasted =
+  useRoute() as RouteLocationNormalizedLoaded<'/users/[id]'>
 userRouteWithIdCasted.params.id
 // Better way, but no autocompletion.
 const userRouteWithIdTypeParam = useRoute<'/users/[id]'>()
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -109,7 +109,6 @@ declare module 'vue-router/auto-routes' {
     ParamValueOneOrMore,
     ParamValueZeroOrMore,
     ParamValueZeroOrOne,
-    RouteMeta,
   } from 'vue-router'
 
   /**
@@ -121,23 +120,20 @@ declare module 'vue-router/auto-routes' {
       '/',
       Record<never, never>,
       Record<never, never>,
-      RouteMeta,
       never
     >
     '/about': RouteRecordInfo<
       '/about',
       '/about',
       Record<never, never>,
       Record<never, never>,
-      RouteMeta,
       never
     >
     '/users/[id]': RouteRecordInfo<
       '/users/[id]',
       '/users/:id',
       { id: ParamValue<true> },
       { id: ParamValue<false> },
-      RouteMeta,
       never
     >
   }
diff --git a/package.json b/package.json
@@ -149,7 +149,7 @@
     "yaml": "^2.7.1"
   },
   "peerDependencies": {
-    "vue-router": "^4.4.0"
+    "vue-router": "^4.5.1"
   },
   "peerDependenciesMeta": {
     "vue-router": {
@@ -193,7 +193,7 @@
     "vitepress": "1.6.3",
     "vitest": "^3.1.2",
     "vue": "^3.5.13",
-    "vue-router": "https://pkg.pr.new/vue-router@2475",
+    "vue-router": "^4.5.1",
     "vue-router-mock": "^1.1.0",
     "vue-tsc": "^2.2.10",
     "vuefire": "^3.2.1",
diff --git a/playground/package.json b/playground/package.json
@@ -21,6 +21,6 @@
     "mande": "^2.0.9",
     "pinia": "^3.0.2",
     "vue": "^3.5.13",
-    "vue-router": "^4.5.0"
+    "vue-router": "^4.5.1"
   }
 }
diff --git a/playground/typed-router.d.ts b/playground/typed-router.d.ts
@@ -19,7 +19,7 @@ declare module 'vue-router/auto-routes' {
    * Route name map generated by unplugin-vue-router
    */
   export interface RouteNamedMap {
-    '/(test-group)': RouteRecordInfo<'/(test-group)', '/', Record<never, never>, Record<never, never>, RouteMeta, '/(test-group)/test-group-child'>,
+    '/(test-group)': RouteRecordInfo<'/(test-group)', '/', Record<never, never>, Record<never, never>, '/(test-group)/test-group-child'>,
     '/(test-group)/test-group-child': RouteRecordInfo<'/(test-group)/test-group-child', '/test-group-child', Record<never, never>, Record<never, never>>,
     'home': RouteRecordInfo<'home', '/', Record<never, never>, Record<never, never>>,
     '/[name]': RouteRecordInfo<'/[name]', '/:name', { name: ParamValue<true> }, { name: ParamValue<false> }>,
@@ -28,7 +28,7 @@ declare module 'vue-router/auto-routes' {
     '/@[profileId]': RouteRecordInfo<'/@[profileId]', '/@:profileId', { profileId: ParamValue<true> }, { profileId: ParamValue<false> }>,
     '/about': RouteRecordInfo<'/about', '/about', Record<never, never>, Record<never, never>>,
     '/about.extra.nested': RouteRecordInfo<'/about.extra.nested', '/about/extra/nested', Record<never, never>, Record<never, never>>,
-    '/articles': RouteRecordInfo<'/articles', '/articles', Record<never, never>, Record<never, never>, RouteMeta, '/articles/' | '/articles/[id]' | '/articles/[id]+'>,
+    '/articles': RouteRecordInfo<'/articles', '/articles', Record<never, never>, Record<never, never>, '/articles/' | '/articles/[id]' | '/articles/[id]+'>,
     '/articles/': RouteRecordInfo<'/articles/', '/articles', Record<never, never>, Record<never, never>>,
     '/articles/[id]': RouteRecordInfo<'/articles/[id]', '/articles/:id', { id: ParamValue<true> }, { id: ParamValue<false> }>,
     '/articles/[id]+': RouteRecordInfo<'/articles/[id]+', '/articles/:id+', { id: ParamValueOneOrMore<true> }, { id: ParamValueOneOrMore<false> }>,
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/codegen/generateRouteMap.spec.ts b/src/codegen/generateRouteMap.spec.ts
@@ -172,7 +172,7 @@ describe('generateRouteNamedMap', () => {
     expect(child.fullPath).toBe('/child')
     expect(formatExports(generateRouteNamedMap(tree))).toMatchInlineSnapshot(`
       "export interface RouteNamedMap {
-        '/parent': RouteRecordInfo<'/parent', '/', Record<never, never>, Record<never, never>, RouteMeta, '/parent/child'>,
+        '/parent': RouteRecordInfo<'/parent', '/', Record<never, never>, Record<never, never>, '/parent/child'>,
         '/parent/child': RouteRecordInfo<'/parent/child', '/child', Record<never, never>, Record<never, never>>,
       }"
     `)
@@ -190,9 +190,9 @@ describe('generateRouteNamedMap', () => {
     tree.insert('parent/other-child', 'parent/other-child.vue')
     expect(formatExports(generateRouteNamedMap(tree))).toMatchInlineSnapshot(`
       "export interface RouteNamedMap {
-        '/parent': RouteRecordInfo<'/parent', '/parent', Record<never, never>, Record<never, never>, RouteMeta, '/parent/child' | '/parent/child/subchild/grandchild' | '/parent/other-child' | '/parent/child/subchild'>,
-        '/parent/child': RouteRecordInfo<'/parent/child', '/parent/child', Record<never, never>, Record<never, never>, RouteMeta, '/parent/child/subchild/grandchild' | '/parent/child/subchild'>,
-        '/parent/child/subchild': RouteRecordInfo<'/parent/child/subchild', '/parent/child/subchild', Record<never, never>, Record<never, never>, RouteMeta, '/parent/child/subchild/grandchild'>,
+        '/parent': RouteRecordInfo<'/parent', '/parent', Record<never, never>, Record<never, never>, '/parent/child' | '/parent/child/subchild/grandchild' | '/parent/other-child' | '/parent/child/subchild'>,
+        '/parent/child': RouteRecordInfo<'/parent/child', '/parent/child', Record<never, never>, Record<never, never>, '/parent/child/subchild/grandchild' | '/parent/child/subchild'>,
+        '/parent/child/subchild': RouteRecordInfo<'/parent/child/subchild', '/parent/child/subchild', Record<never, never>, Record<never, never>, '/parent/child/subchild/grandchild'>,
         '/parent/child/subchild/grandchild': RouteRecordInfo<'/parent/child/subchild/grandchild', '/parent/child/subchild/grandchild', Record<never, never>, Record<never, never>>,
         '/parent/other-child': RouteRecordInfo<'/parent/other-child', '/parent/other-child', Record<never, never>, Record<never, never>>,
       }"
@@ -205,7 +205,7 @@ describe('generateRouteNamedMap', () => {
     tree.insert('parent/child/a/b/c', 'parent/child/a/b/c.vue')
     expect(formatExports(generateRouteNamedMap(tree))).toMatchInlineSnapshot(`
       "export interface RouteNamedMap {
-        '/parent': RouteRecordInfo<'/parent', '/parent', Record<never, never>, Record<never, never>, RouteMeta, '/parent/child/a/b/c'>,
+        '/parent': RouteRecordInfo<'/parent', '/parent', Record<never, never>, Record<never, never>, '/parent/child/a/b/c'>,
         '/parent/child/a/b/c': RouteRecordInfo<'/parent/child/a/b/c', '/parent/child/a/b/c', Record<never, never>, Record<never, never>>,
       }"
     `)
@@ -234,7 +234,7 @@ describe('generateRouteNamedMap', () => {
       "export interface RouteNamedMap {
         '/parent/': RouteRecordInfo<'/parent/', '/parent', Record<never, never>, Record<never, never>>,
         '/parent/a/': RouteRecordInfo<'/parent/a/', '/parent/a', Record<never, never>, Record<never, never>>,
-        '/parent/a/b': RouteRecordInfo<'/parent/a/b', '/parent/a/b', Record<never, never>, Record<never, never>, RouteMeta, '/parent/a/b/' | '/parent/a/b/c'>,
+        '/parent/a/b': RouteRecordInfo<'/parent/a/b', '/parent/a/b', Record<never, never>, Record<never, never>, '/parent/a/b/' | '/parent/a/b/c'>,
         '/parent/a/b/': RouteRecordInfo<'/parent/a/b/', '/parent/a/b', Record<never, never>, Record<never, never>>,
         '/parent/a/b/c': RouteRecordInfo<'/parent/a/b/c', '/parent/a/b/c', Record<never, never>, Record<never, never>>,
       }"
diff --git a/src/codegen/generateRouteMap.ts b/src/codegen/generateRouteMap.ts
@@ -37,7 +37,7 @@ export function generateRouteRecordInfo(node: TreeNode) {
       .map((childRoute) => `'${childRoute.name}'`)
 
     if (deepNamedChildren.length > 0) {
-      typeParams.push('RouteMeta', deepNamedChildren.join(' | '))
+      typeParams.push(deepNamedChildren.join(' | '))
     }
   }
 

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,6 @@`
`21`	`21`	`"mande": "^2.0.9",`
`22`	`22`	`"pinia": "^3.0.2",`
`23`	`23`	`"vue": "^3.5.13",`
`24`		`- "vue-router": "^4.5.0"`
	`24`	`+ "vue-router": "^4.5.1"`
`25`	`25`	`}`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ export function generateRouteRecordInfo(node: TreeNode) {`
`37`	`37`	.map((childRoute) => `'${childRoute.name}'`)
`38`	`38`
`39`	`39`	`if (deepNamedChildren.length > 0) {`
`40`		`- typeParams.push('RouteMeta', deepNamedChildren.join(' \| '))`
	`40`	`+ typeParams.push(deepNamedChildren.join(' \| '))`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`