Fix params type when the route name is an union (#50)

Author: zoontek

docs/docs/utility-types.md

@@ -0,0 +1,21 @@
+---
+title: Utility types
+sidebar_label: Utility types
+---
+
+To easily extract routes types, use `InferRoutes`:
+
+```tsx {1,9}
+import { createRouter, InferRoutes } from "@swan-io/chicane";
+
+export const Router = createRouter({
+  UserList: "/users",
+  UserDetail: "/users/:userId",
+});
+
+// A map of RouteName and its associated RouteParams
+type Routes = InferRoutes<typeof Router>;
+
+export type RouteName = keyof Routes;
+export type RouteParams<T extends RouteName> = Routes[T];
+```

docs/sidebars.js

@@ -28,6 +28,7 @@ const sidebars = {
         "matching-some-routes",
         "linking-to-a-route",
         "server-side-rendering",
+        "utility-types",
       ],
     },
     {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swan-io/chicane",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "license": "MIT",
   "description": "A simple and safe router for React and TypeScript",
   "author": "Mathieu Acthernoene <[email protected]>",

src/createRouter.ts

@@ -22,6 +22,7 @@ import {
   ParseRoutes,
   PrependBasePath,
   RouteObject,
+  UnionToIntersection,
 } from "./types";
 
 export const createRouter = <
@@ -138,12 +139,12 @@ export const createRouter = <
 
   const push = <RouteName extends keyof FiniteRoutes>(
     routeName: RouteName,
-    ...params: ParamsArg<FiniteRoutesParams[RouteName]>
+    ...params: ParamsArg<UnionToIntersection<FiniteRoutesParams[RouteName]>>
   ): void => pushUnsafe(matchToUrl(matchers[routeName], first(params)));
 
   const replace = <RouteName extends keyof FiniteRoutes>(
     routeName: RouteName,
-    ...params: ParamsArg<FiniteRoutesParams[RouteName]>
+    ...params: ParamsArg<UnionToIntersection<FiniteRoutesParams[RouteName]>>
   ): void => replaceUnsafe(matchToUrl(matchers[routeName], first(params)));
 
   return {

src/index.ts

@@ -10,7 +10,7 @@ export {
 } from "./history";
 export { decodeSearch, encodeSearch } from "./search";
 export { ServerUrlProvider } from "./server";
-export type { Location, Search } from "./types";
+export type { InferRoutes, Location, Search } from "./types";
 export { useBlocker } from "./useBlocker";
 export { useFocusReset } from "./useFocusReset";
 export { useLinkProps } from "./useLinkProps";

src/types.ts

@@ -171,6 +171,13 @@ type NonOptionalProperties<T> = Exclude<
   undefined
 >;
 
+// https://github.com/microsoft/TypeScript/issues/13298#issuecomment-1610361208
+export type UnionToIntersection<Union> = (
+  Union extends never ? never : (_: Union) => never
+) extends (_: infer Intersection) => void
+  ? Intersection
+  : never;
+
 export type ParamsArg<Params> =
   Params extends Record<PropertyKey, never>
     ? []
@@ -180,6 +187,26 @@ export type ParamsArg<Params> =
 
 export type GetCreateURLFns<RoutesParams extends Record<string, Params>> = {
   [RouteName in keyof RoutesParams]: (
-    ...params: ParamsArg<RoutesParams[RouteName]>
+    ...params: ParamsArg<UnionToIntersection<RoutesParams[RouteName]>>
   ) => string;
 };
+
+// User land helpers
+
+type RouteLike = {
+  name: string;
+  params: Params;
+};
+
+type RouterLike = {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  getRoute: (...args: any[]) => RouteLike | undefined;
+};
+
+type RemapRoute<Route extends RouteLike> = {
+  [N in Route["name"]]: Extract<Route, { name: N }>["params"];
+};
+
+export type InferRoutes<Router extends RouterLike> = RemapRoute<
+  NonNullable<ReturnType<Router["getRoute"]>>
+>;