feat: better typing for route.pathname (#89)

Author: colinlienard

.changeset/cuddly-ads-lay.md

@@ -0,0 +1,5 @@
+---
+'sv-router': patch
+---
+
+Better typing for route.pathname

src/index.d.ts

@@ -146,7 +146,7 @@ export type RouterApi<T extends Routes> = {
 		 */
 		params: AllParams<T>;
 		/** The reactive pathname of the URL. */
-		pathname: Path<T>;
+		pathname: (Path<T, true> & {}) | (string & {});
 		/** The reactive query string part of the URL. */
 		search: string;
 		/** The reactive history state that can be passed to the `navigate` function. */
@@ -156,8 +156,8 @@ export type RouterApi<T extends Routes> = {
 	};
 };
 
-export type Path<T extends Routes> = RemoveParenthesis<
-	RemoveLastSlash<RecursiveKeys<StripNonRoutes<T>>>
+export type Path<T extends Routes, AnyParam extends boolean = false> = RemoveParenthesis<
+	RemoveLastSlash<RecursiveKeys<StripNonRoutes<T>, '', AnyParam>>
 >;
 
 export type ConstructPathArgs<T extends string> =
@@ -167,9 +167,13 @@ export type IsActiveArgs<T extends string> =
 	PathParams<T> extends never ? [T] : [T] | [T, PathParams<T>];
 
 export type PathParams<T extends string> =
-	ExtractParams<T> extends never ? never : Record<ExtractParams<T>, string>;
+	ExtractParams<RemoveParenthesis<T>> extends never
+		? never
+		: Record<ExtractParams<RemoveParenthesis<T>>, string>;
 
-export type AllParams<T extends Routes> = Partial<Record<ExtractParams<RecursiveKeys<T>>, string>>;
+export type AllParams<T extends Routes> = Partial<
+	Record<ExtractParams<RemoveParenthesis<RecursiveKeys<T>>>, string>
+>;
 
 export type NavigateOptions =
 	| {
@@ -207,14 +211,28 @@ type StripNonRoutes<T extends Routes> = {
 					: K]: T[K] extends Routes ? StripNonRoutes<T[K]> : T[K];
 };
 
-type RecursiveKeys<T extends Routes, Prefix extends string = ''> = {
+type RecursiveKeys<
+	T extends Routes,
+	Prefix extends string = '',
+	AnyParam extends boolean = false,
+> = {
 	[K in keyof T]: K extends string
 		? T[K] extends Routes
-			? RecursiveKeys<T[K], `${Prefix}${K}`>
-			: `${Prefix}${K}`
+			? RecursiveKeys<
+					T[K],
+					`${Prefix}${AnyParam extends true ? ReplaceParamWithString<K> : K}`,
+					AnyParam
+				>
+			: `${Prefix}${AnyParam extends true ? ReplaceParamWithString<K> : K}`
 		: never;
 }[keyof T];
 
+type ReplaceParamWithString<T extends string> = T extends `/:${string}`
+	? `/${string}`
+	: T extends `/(:${string})`
+		? `/${string}`
+		: T;
+
 type RemoveLastSlash<T extends string> = T extends '/' ? T : T extends `${infer R}/` ? R : T;
 
 type RemoveParenthesis<T extends string> = T extends `${infer A}(${infer B})${infer C}`
@@ -223,14 +241,10 @@ type RemoveParenthesis<T extends string> = T extends `${infer A}(${infer B})${in
 
 type ExtractParams<T extends string> = T extends `${string}:${infer Param}/${infer Rest}`
 	? Param | ExtractParams<`/${Rest}`>
-	: T extends `${string}(:${infer Param})`
+	: T extends `${string}:${infer Param}`
 		? Param
-		: T extends `${string}:${infer Param}`
-			? Param
-			: T extends `${string}(*${infer Param})`
-				? Param
-				: T extends `${string}*${infer Param}`
-					? Param extends ''
-						? never
-						: Param
-					: never;
+		: T extends `${string}*${infer Param}`
+			? Param extends ''
+				? never
+				: Param
+			: never;

tests/test-types.d.ts

@@ -26,9 +26,9 @@ type TestRoutes = {
 
 // Path
 
-type test_path = Expect<Equal<test_path_result, test_path_expected>>;
-type test_path_result = Path<TestRoutes>;
-type test_path_expected =
+type test_path_0 = Expect<Equal<test_path_result_0, test_path_expected_0>>;
+type test_path_result_0 = Path<TestRoutes>;
+type test_path_expected_0 =
 	| '/'
 	| '/about'
 	| '/contact/nested'
@@ -38,6 +38,18 @@ type test_path_expected =
 	| `/posts/:id`
 	| `/posts/:id/:commentId`;
 
+type test_path_1 = Expect<Equal<test_path_result_1, test_path_expected_1>>;
+type test_path_result_1 = Path<TestRoutes, true>;
+type test_path_expected_1 =
+	| '/'
+	| '/about'
+	| '/contact/nested'
+	| '/posts'
+	| '/posts/static'
+	| '/posts/nolayout'
+	| `/posts/${string}`
+	| `/posts/${string}/${string}`;
+
 // PathParams
 
 type test_path_params_0 = Expect<Equal<test_path_params_result_0, test_path_params_expected_0>>;