fix(core): optional url parameters typing without path params (#517)

Author: Gabrola

.changeset/three-pillows-tan.md

@@ -0,0 +1,5 @@
+---
+'@ts-rest/core': patch
+---
+
+Fix optional path parameters showing in types with a question mark if path params are not used

libs/ts-rest/core/src/lib/paths.spec.ts

@@ -22,6 +22,17 @@ expectType<{ id: string; commentId: string; commentId2: string }>(
   type<ParamsFromUrl<typeof urlManyParams>>(),
 );
 
+const urlOptional = '/post/:id?';
+expectType<{
+  id: string;
+}>(type<ParamsFromUrl<typeof urlOptional>>());
+
+const urlManyOptional = '/post/:id?/comments/:commentId?';
+expectType<{
+  id: string;
+  commentId: string;
+}>(type<ParamsFromUrl<typeof urlManyOptional>>());
+
 describe('insertParamsIntoPath', () => {
   it('should insert params into path', () => {
     const path = '/post/:id/comments/:commentId';

libs/ts-rest/core/src/lib/paths.ts

@@ -1,3 +1,5 @@
+type StripOptional<T> = T extends `${infer U}?` ? U : T;
+
 /**
  * @params T - The URL e.g. /posts/:id
  * @params TAcc - Accumulator object
@@ -6,17 +8,21 @@ type RecursivelyExtractPathParams<
   T extends string,
   TAcc extends null | Record<string, string>,
 > = T extends `/:${infer PathParam}/${infer Right}`
-  ? { [key in PathParam]: string } & RecursivelyExtractPathParams<Right, TAcc>
+  ? {
+      [key in StripOptional<PathParam>]: string;
+    } & RecursivelyExtractPathParams<Right, TAcc>
   : T extends `/:${infer PathParam}`
-  ? { [key in PathParam]: string }
+  ? { [key in StripOptional<PathParam>]: string }
   : T extends `/${string}/${infer Right}`
   ? RecursivelyExtractPathParams<Right, TAcc>
   : T extends `/${string}`
   ? TAcc
   : T extends `:${infer PathParam}/${infer Right}`
-  ? { [key in PathParam]: string } & RecursivelyExtractPathParams<Right, TAcc>
+  ? {
+      [key in StripOptional<PathParam>]: string;
+    } & RecursivelyExtractPathParams<Right, TAcc>
   : T extends `:${infer PathParam}`
-  ? TAcc & { [key in PathParam]: string }
+  ? TAcc & { [key in StripOptional<PathParam>]: string }
   : T extends `${string}/${infer Right}`
   ? RecursivelyExtractPathParams<Right, TAcc>
   : TAcc;