refactor: exports and rename MatcherPatternPathDynamic

Author: posva

packages/router/src/experimental/index.ts

@@ -19,23 +19,26 @@ export type {
   MatcherQueryParamsValue,
 } from './route-resolver/resolver-abstract'
 export {
-  MatcherPatternPathDynamic,
   MatcherPatternPathStatic,
-  MatcherPatternPathStar,
-  MatcherPatternPathCustomParams,
-  // native param parsers
-  PARAM_PARSER_INT,
+  MatcherPatternPathDynamic,
 } from './route-resolver/matchers/matcher-pattern'
+
 export type {
+  EmptyParams,
   MatcherPattern,
   MatcherPatternHash,
   MatcherPatternPath,
   MatcherPatternQuery,
   MatcherParamsFormatted,
-  EmptyParams,
-  ParamParser,
+  MatcherPatternPathDynamic_ParamOptions,
 } from './route-resolver/matchers/matcher-pattern'
 
+export {
+  PARAM_PARSER_INT,
+  type ParamParser,
+  defineParamParser,
+} from './route-resolver/matchers/param-parsers'
+
 export { miss, MatchMiss } from './route-resolver/matchers/errors'
 
 // in the new experimental router, there are only parents

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

@@ -0,0 +1,38 @@
+import { miss } from './errors'
+import { MatcherPatternPath } from './matcher-pattern'
+
+/**
+ * Allows matching a static path folllowed by anything.
+ *
+ * @example
+ *
+ * ```ts
+ * const matcher = new MatcherPatternPathStar('/team')
+ * matcher.match('/team/123') // { pathMatch: '/123' }
+ * matcher.match('/team/123/more') // { pathMatch: '/123/more' }
+ * matcher.match('/team-123') // { pathMatch: '-123' }
+ * matcher.match('/team') // { pathMatch: '' }
+ * matcher.build({ pathMatch: '/123' }) // '/team/123'
+ * ```
+ */
+export class MatcherPatternPathStar
+  implements MatcherPatternPath<{ pathMatch: string }>
+{
+  private path: string
+  constructor(path: string = '') {
+    this.path = path.toLowerCase()
+  }
+
+  match(path: string): { pathMatch: string } {
+    if (!path.toLowerCase().startsWith(this.path)) {
+      throw miss()
+    }
+    return {
+      pathMatch: path.slice(this.path.length),
+    }
+  }
+
+  build(params: { pathMatch: string }): string {
+    return this.path + params.pathMatch
+  }
+}

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

@@ -1,9 +1,9 @@
 import { describe, expect, it } from 'vitest'
 import {
   MatcherPatternPathStatic,
-  MatcherPatternPathStar,
-  MatcherPatternPathCustomParams,
+  MatcherPatternPathDynamic,
 } from './matcher-pattern'
+import { MatcherPatternPathStar } from './matcher-pattern-path-star'
 
 describe('MatcherPatternPathStatic', () => {
   describe('match()', () => {
@@ -109,7 +109,7 @@ describe('MatcherPatternPathStar', () => {
 
 describe('MatcherPatternPathCustom', () => {
   it('single param', () => {
-    const pattern = new MatcherPatternPathCustomParams(
+    const pattern = new MatcherPatternPathDynamic(
       /^\/teams\/([^/]+?)\/b$/i,
       {
         // all defaults
@@ -131,7 +131,7 @@ describe('MatcherPatternPathCustom', () => {
   })
 
   it('decodes single param', () => {
-    const pattern = new MatcherPatternPathCustomParams(
+    const pattern = new MatcherPatternPathDynamic(
       /^\/teams\/([^/]+?)$/i,
       {
         teamId: {},
@@ -143,7 +143,7 @@ describe('MatcherPatternPathCustom', () => {
   })
 
   it('optional param', () => {
-    const pattern = new MatcherPatternPathCustomParams(
+    const pattern = new MatcherPatternPathDynamic(
       /^\/teams(?:\/([^/]+?))?\/b$/i,
       {
         teamId: {},
@@ -160,7 +160,7 @@ describe('MatcherPatternPathCustom', () => {
   })
 
   it('repeatable param', () => {
-    const pattern = new MatcherPatternPathCustomParams(
+    const pattern = new MatcherPatternPathDynamic(
       /^\/teams\/(.+?)\/b$/i,
       {
         teamId: { repeat: true },
@@ -179,7 +179,7 @@ describe('MatcherPatternPathCustom', () => {
   })
 
   it('repeatable optional param', () => {
-    const pattern = new MatcherPatternPathCustomParams(
+    const pattern = new MatcherPatternPathDynamic(
       /^\/teams(?:\/(.+?))?\/b$/i,
       {
         teamId: { repeat: true },
@@ -202,7 +202,7 @@ describe('MatcherPatternPathCustom', () => {
   })
 
   it('multiple params', () => {
-    const pattern = new MatcherPatternPathCustomParams(
+    const pattern = new MatcherPatternPathDynamic(
       /^\/teams\/([^/]+?)\/([^/]+?)$/i,
       {
         teamId: {},
@@ -224,7 +224,7 @@ describe('MatcherPatternPathCustom', () => {
   })
 
   it('sub segments (params + static)', () => {
-    const pattern = new MatcherPatternPathCustomParams(
+    const pattern = new MatcherPatternPathDynamic(
       /^\/teams\/([^/]+?)-b-([^/]+?)$/i,
       {
         teamId: {},

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

@@ -1,14 +1,12 @@
 import { describe, expectTypeOf, it } from 'vitest'
-import {
-  MatcherPatternPathCustomParams,
-  PARAM_INTEGER_SINGLE,
-  PATH_PARAM_DEFAULT_PARSER,
-  PATH_PARAM_SINGLE_DEFAULT,
-} from './matcher-pattern'
+import { MatcherPatternPathDynamic } from './matcher-pattern'
+import { PARAM_INTEGER_SINGLE } from './param-parsers/numbers'
+import { PATH_PARAM_DEFAULT_PARSER } from './param-parsers'
+import { PATH_PARAM_SINGLE_DEFAULT } from './param-parsers'
 
 describe('MatcherPatternPathCustomParams', () => {
   it('can be generic', () => {
-    const matcher = new MatcherPatternPathCustomParams(
+    const matcher = new MatcherPatternPathDynamic(
       /^\/users\/([^/]+)$/i,
       { userId: { ...PATH_PARAM_DEFAULT_PARSER } },
       ['users', 0]
@@ -33,7 +31,7 @@ describe('MatcherPatternPathCustomParams', () => {
   })
 
   it('can be a simple param', () => {
-    const matcher = new MatcherPatternPathCustomParams(
+    const matcher = new MatcherPatternPathDynamic(
       /^\/users\/([^/]+)\/([^/]+)$/i,
       { userId: { ...PATH_PARAM_SINGLE_DEFAULT, repeat: true } },
       ['users', 0]
@@ -51,7 +49,7 @@ describe('MatcherPatternPathCustomParams', () => {
   })
 
   it('can be a custom type', () => {
-    const matcher = new MatcherPatternPathCustomParams(
+    const matcher = new MatcherPatternPathDynamic(
       /^\/profiles\/([^/]+)$/i,
       {
         userId: {