feat: add router.matchAll for multiple matches (#602)

Author: stevenle

.changeset/smart-apes-smoke.md

@@ -0,0 +1,5 @@
+---
+'@blinkk/root': patch
+---
+
+feat: add router.matchAll for multiple matches

packages/root/src/render/route-trie.test.ts

@@ -124,3 +124,15 @@ test('walk all routes', async () => {
     expected.sort((a, b) => a[0].localeCompare(b[0]))
   );
 });
+
+test('match all matching routes', () => {
+  routeTrie.add('/[[...slug]]', 'a');
+  routeTrie.add('/foo/[id]', 'b');
+  routeTrie.add('/foo/bar', 'c');
+
+  assert.deepEqual(routeTrie.matchAll('/foo/bar'), [
+    ['c', {}],
+    ['b', {id: 'bar'}],
+    ['a', {slug: 'foo/bar'}],
+  ]);
+});

packages/root/src/render/route-trie.ts

@@ -64,6 +64,15 @@ export class RouteTrie<T> {
     return [route, params];
   }
 
+  /**
+   * Returns all routes that match the given path and their parameter values.
+   */
+  matchAll(path: string): Array<[T, Record<string, string>]> {
+    const matches: Array<[T, Record<string, string>]> = [];
+    this.collectRoutes(path, {}, matches);
+    return matches;
+  }
+
   /**
    * Walks the route trie and calls a callback function for each route.
    */
@@ -165,6 +174,54 @@ export class RouteTrie<T> {
     return undefined;
   }
 
+  private collectRoutes(
+    urlPath: string,
+    params: Record<string, string>,
+    results: Array<[T, Record<string, string>]>
+  ) {
+    urlPath = this.normalizePath(urlPath);
+    if (urlPath === '') {
+      if (this.route) {
+        results.push([this.route, {...params}]);
+      }
+      if (this.optCatchAllNodes) {
+        const optParams = {...params};
+        if (urlPath) {
+          optParams[this.optCatchAllNodes.name] = urlPath;
+        }
+        results.push([this.optCatchAllNodes.route, optParams]);
+      }
+      return;
+    }
+
+    const [head, tail] = this.splitPath(urlPath);
+
+    const child = this.children[head];
+    if (child) {
+      child.collectRoutes(tail, {...params}, results);
+    }
+
+    if (this.paramNodes) {
+      for (const paramChild of Object.values(this.paramNodes)) {
+        const paramParams = {...params, [paramChild.name]: head};
+        paramChild.trie.collectRoutes(tail, paramParams, results);
+      }
+    }
+
+    if (this.catchAllNodes) {
+      const caParams = {...params, [this.catchAllNodes.name]: urlPath};
+      results.push([this.catchAllNodes.route, caParams]);
+    }
+
+    if (this.optCatchAllNodes) {
+      const ocParams = {...params};
+      if (urlPath) {
+        ocParams[this.optCatchAllNodes.name] = urlPath;
+      }
+      results.push([this.optCatchAllNodes.route, ocParams]);
+    }
+  }
+
   /**
    * Normalizes a path for inclusion into the route trie.
    */

packages/root/src/render/router.ts

@@ -21,6 +21,10 @@ export class Router {
     return this.routeTrie.get(url);
   }
 
+  matchAll(url: string) {
+    return this.routeTrie.matchAll(url);
+  }
+
   async walk(cb: (urlPath: string, route: Route) => void | Promise<void>) {
     await this.routeTrie.walk(cb);
   }