fix: remove unused Meta type param from RouteRecordInfo

Author: posva

packages/router/__tests__/routeLocation.test-d.ts

@@ -4,7 +4,6 @@ import type {
   ParamValue,
   ParamValueZeroOrMore,
   RouteRecordInfo,
-  RouteMeta,
   RouteLocationNormalizedTypedList,
 } from '../src'
 
@@ -17,47 +16,41 @@ type RouteNamedMap = {
     '/:other',
     { other: ParamValue<true> },
     { other: ParamValue<false> },
-    RouteMeta,
     never
   >
   '/groups/[gid]': RouteRecordInfo<
     '/groups/[gid]',
     '/:gid',
     { gid: ParamValue<true> },
     { gid: ParamValue<false> },
-    RouteMeta,
     '/groups/[gid]/users' | '/groups/[gid]/users/[uid]'
   >
   '/groups/[gid]/users': RouteRecordInfo<
     '/groups/[gid]/users',
     '/:gid/users',
     { gid: ParamValue<true> },
     { gid: ParamValue<false> },
-    RouteMeta,
     '/groups/[gid]/users/[uid]'
   >
   '/groups/[gid]/users/[uid]': RouteRecordInfo<
     '/groups/[gid]/users/[uid]',
     '/:gid/users/:uid',
     { gid: ParamValue<true>; uid: ParamValue<true> },
     { gid: ParamValue<false>; uid: ParamValue<false> },
-    RouteMeta,
     never
   >
   '/[...path]': RouteRecordInfo<
     '/[...path]',
     '/:path(.*)',
     { path: ParamValue<true> },
     { path: ParamValue<false> },
-    RouteMeta,
     never
   >
   '/deep/nesting/works/[[files]]+': RouteRecordInfo<
     '/deep/nesting/works/[[files]]+',
     '/deep/nesting/works/:files*',
     { files?: ParamValueZeroOrMore<true> },
     { files?: ParamValueZeroOrMore<false> },
-    RouteMeta,
     never
   >
 }

packages/router/src/typed-routes/route-map.ts

@@ -1,9 +1,5 @@
 import type { TypesConfig } from '../config'
-import type {
-  RouteMeta,
-  RouteParamsGeneric,
-  RouteParamsRawGeneric,
-} from '../types'
+import type { RouteParamsGeneric, RouteParamsRawGeneric } from '../types'
 import type { RouteRecord } from '../matcher/types'
 
 /**
@@ -17,24 +13,27 @@ export interface RouteRecordInfo<
   // TODO: could probably be inferred from the Params
   ParamsRaw extends RouteParamsRawGeneric = RouteParamsRawGeneric,
   Params extends RouteParamsGeneric = RouteParamsGeneric,
-  Meta extends RouteMeta = RouteMeta,
+  // NOTE: this is the only type param that feels wrong because its default
+  // value is the default value to avoid breaking changes but it should be the
+  // generic version by default instead (string | symbol)
   ChildrenNames extends string | symbol = never,
+  // TODO: implement meta with a defineRoute macro
+  // Meta extends RouteMeta = RouteMeta,
 > {
   name: Name
   path: Path
   paramsRaw: ParamsRaw
   params: Params
-  // TODO: implement meta with a defineRoute macro
-  meta: Meta
   childrenNames: ChildrenNames
+  // TODO: implement meta with a defineRoute macro
+  // meta: Meta
 }
 
 export type RouteRecordInfoGeneric = RouteRecordInfo<
   string | symbol,
   string,
   RouteParamsRawGeneric,
   RouteParamsGeneric,
-  RouteMeta,
   string | symbol
 >
 

packages/router/src/types/index.ts

@@ -257,7 +257,7 @@ export interface _RouteRecordBase extends PathParserOptions {
  * }
  * ```
  */
-export interface RouteMeta extends Record<string | number | symbol, unknown> {}
+export interface RouteMeta extends Record<PropertyKey, unknown> {}
 
 /**
  * Route Record defining one single component with the `component` option.

packages/router/test-dts/typed-routes.test-d.ts

@@ -4,7 +4,6 @@ import {
   type ParamValue,
   type ParamValueOneOrMore,
   type RouteLocationTyped,
-  type RouteMeta,
   createRouter,
   createWebHistory,
   useRoute,
@@ -19,47 +18,41 @@ export type RouteMap = {
     '/:path(.*)',
     { path: ParamValue<true> },
     { path: ParamValue<false> },
-    RouteMeta,
     never
   >
   '/[a]': RouteRecordInfo<
     '/[a]',
     '/:a',
     { a: ParamValue<true> },
     { a: ParamValue<false> },
-    RouteMeta,
     never
   >
   '/a': RouteRecordInfo<
     '/a',
     '/a',
     Record<never, never>,
     Record<never, never>,
-    RouteMeta,
     '/a/b' | '/a/b/c'
   >
   '/a/b': RouteRecordInfo<
     '/a/b',
     '/a/b',
     Record<never, never>,
     Record<never, never>,
-    RouteMeta,
     '/a/b/c'
   >
   '/a/b/c': RouteRecordInfo<
     '/a/b/c',
     '/a/b/c',
     Record<never, never>,
     Record<never, never>,
-    RouteMeta,
     never
   >
   '/[id]+': RouteRecordInfo<
     '/[id]+',
     '/:id+',
     { id: ParamValueOneOrMore<true> },
     { id: ParamValueOneOrMore<false> },
-    RouteMeta,
     never
   >
 }