refactor: rename methods to keep same names

Author: posva

packages/router/package.json

@@ -120,8 +120,6 @@
     "@vue/devtools-api": "^6.6.4"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.11",
-    "@rollup/plugin-alias": "^5.1.1",
     "@rollup/plugin-commonjs": "^25.0.8",
     "@rollup/plugin-node-resolve": "^15.3.1",
     "@rollup/plugin-replace": "^5.0.7",
@@ -145,7 +143,6 @@
     "nightwatch-helpers": "^1.2.0",
     "rimraf": "^6.0.1",
     "rollup": "^3.29.5",
-    "rollup-plugin-analyzer": "^4.0.0",
     "rollup-plugin-typescript2": "^0.36.0",
     "tsdown": "^0.12.9",
     "tsup": "^8.5.0",

packages/router/src/experimental/route-resolver/matchers/matcher-pattern.ts

@@ -10,9 +10,12 @@ import type { Simplify } from '../../../types/utils'
  *
  * @template TIn - type of the input value to match against the pattern
  * @template TParams - type of the output value after matching
+ * @template TParamsRaw - type of the input value to build the input from
  *
  * In the case of the `path`, the `TIn` is a `string`, but in the case of the
- * query, it's the object of query params.
+ * query, it's the object of query params. `TParamsRaw` allows for a more permissive
+ * type when building the value, for example allowing numbers and strings like
+ * the old params.
  *
  * @internal this is the base interface for all matcher patterns, it shouldn't
  * be used directly

packages/router/src/experimental/route-resolver/matchers/param-parsers/types.ts

@@ -14,7 +14,7 @@ export interface ParamParser<
   // not allow `null` within an array or `undefined`)
   TUrlParam = MatcherQueryParamsValue,
   // the type that can be passed as a location when navigating: `router.push({ params: { }})`
-  // it's sometimes for more permissive than TParam, for example allowing nullish values
+  // it's sometimes more permissive than TParam, for example allowing nullish values
   TParamRaw = TParam,
 > {
   get?: (value: NoInfer<TUrlParam>) => TParam

packages/router/src/experimental/route-resolver/resolver-abstract.ts

@@ -14,7 +14,7 @@ export type RecordName = string | symbol
  * serialization of params, query, and hash.
  *
  * - `TMatcherRecordRaw` represents the raw record type passed to {@link addMatcher}.
- * - `TMatcherRecord` represents the normalized record type returned by {@link getRecords}.
+ * - `TMatcherRecord` represents the normalized record type returned by {@link getRoutes}.
  */
 export interface EXPERIMENTAL_Resolver_Base<TRecord> {
   /**
@@ -44,7 +44,7 @@ export interface EXPERIMENTAL_Resolver_Base<TRecord> {
    */
   resolve(
     location: ResolverLocationAsNamed,
-    // TODO: is this useful?
+    // TODO: is this type strictness useful?
     currentLocation?: undefined
     // currentLocation?: undefined | NEW_LocationResolved<TMatcherRecord>
   ): ResolverLocationResolved<TRecord>
@@ -78,16 +78,15 @@ export interface EXPERIMENTAL_Resolver_Base<TRecord> {
   ): ResolverLocationResolved<TRecord>
 
   /**
-   * Get a list of all resolver records.
-   * Previously named `getRoutes()`
+   * Get a list of all resolver route records.
    */
-  getRecords(): TRecord[]
+  getRoutes(): TRecord[]
 
   /**
    * Get a resolver record by its name.
    * Previously named `getRecordMatcher()`
    */
-  getRecord(name: RecordName): TRecord | undefined
+  getRoute(name: RecordName): TRecord | undefined
 }
 
 /**

packages/router/src/experimental/route-resolver/resolver-fixed.ts

@@ -65,6 +65,9 @@ export interface EXPERIMENTAL_ResolverRecord_Base {
  */
 export interface EXPERIMENTAL_ResolverRecord_Group
   extends EXPERIMENTAL_ResolverRecord_Base {
+  /**
+   * A group route cannot be matched directly and so names are not allowed.
+   */
   name?: undefined
   path?: undefined
   // Query is the only kind of matcher that is non-exclusive
@@ -74,7 +77,8 @@ export interface EXPERIMENTAL_ResolverRecord_Group
 }
 
 /**
- * A matchable record is a record that can be matched by a path, query or hash and will resolve to a location.
+ * A matchable record is a record that can be matched by a path, query or hash
+ * and will resolve to a location.
  */
 export interface EXPERIMENTAL_ResolverRecord_Matchable
   extends EXPERIMENTAL_ResolverRecord_Base {
@@ -324,7 +328,7 @@ export function createFixedResolver<
 
   return {
     resolve,
-    getRecords: () => records,
-    getRecord: name => recordMap.get(name),
+    getRoutes: () => records,
+    getRoute: name => recordMap.get(name),
   }
 }

packages/router/src/experimental/router.ts

@@ -390,6 +390,10 @@ export interface EXPERIMENTAL_RouterOptions
   resolver: EXPERIMENTAL_ResolverFixed<EXPERIMENTAL_RouteRecordNormalized_Matchable>
 }
 
+// TODO: Make the Router extends the resolver so that it automatically exposes
+// getRoutes and resolve. This should make it automatic to have a dynamic
+// resolver
+
 /**
  * Router base instance.
  *
@@ -614,14 +618,6 @@ export function experimental_createRouter(
     history.scrollRestoration = 'manual'
   }
 
-  function getRoutes() {
-    return resolver.getRecords()
-  }
-
-  function hasRoute(name: NonNullable<RouteRecordNameGeneric>): boolean {
-    return !!resolver.getRecord(name)
-  }
-
   // NOTE: to support multiple overloads
   type TRecord = EXPERIMENTAL_RouteRecordNormalized
   type _resolveArgs =
@@ -1290,8 +1286,8 @@ export function experimental_createRouter(
     currentRoute,
     listening: true,
 
-    hasRoute,
-    getRoutes,
+    hasRoute: name => !!resolver.getRoute(name),
+    getRoutes: () => resolver.getRoutes(),
     // @ts-expect-error FIXME: update EXPERIMENTAL_Router types
     resolve,
     options,