feat: Add pathParams for Zod verification

Author: oliverbutler

.changeset/great-countries-argue.md

@@ -0,0 +1,6 @@
+---
+'@ts-rest/core': minor
+'@ts-rest/express': minor
+---
+
+Add support for pathParams Zod verification

apps/example-express/src/http-client.env.json

@@ -0,0 +1,5 @@
+{
+  "dev": {
+    "host": "http://localhost:3333"
+  }
+}

apps/example-express/src/main.ts

@@ -85,6 +85,12 @@ const completedRouter = s.router(apiBlog, {
       body: { message: 'Post deleted' },
     };
   },
+  testPathParams: async ({ params }) => {
+    return {
+      status: 200,
+      body: params,
+    };
+  },
 });
 
 const openapi = generateOpenApi(apiBlog, {
@@ -105,3 +111,5 @@ const server = app.listen(port, () => {
   console.log(`Listening at http://localhost:${port}`);
 });
 server.on('error', console.error);
+
+export default app;

apps/example-express/src/test.http

@@ -1,10 +1,9 @@
-@host = http://localhost:3333
 @contentType = application/json
 
 ### Create Post
 POST {{host}}/posts HTTP/1.1
 content-type: application/json
-  
+
 {
   "title": "Post Title",
   "content": "Post Content"
@@ -13,15 +12,15 @@ content-type: application/json
 ### Create Posts (Bad Body)
 POST {{host}}/posts HTTP/1.1
 content-type: application/json
-  
+
 {
   "title": "Post Title"
 }
 
-  
+
 ### Get Posts
 GET {{host}}/posts HTTP/1.1
 
 ### Search Posts
-GET {{host}}/posts?search=REST HTTP/1.1
+GET {{host}}/posts?search=great&take=10&skip=0 HTTP/1.1
 

apps/example-express/src/tests/posts.spec.ts

@@ -0,0 +1,79 @@
+import * as supertest from 'supertest';
+import app from '../main';
+
+const superTestApp = supertest(app);
+
+describe('Posts Endpoints', () => {
+  it('GET /posts should return an array of posts', async () => {
+    const res = await superTestApp.get('/posts?skip=0&take=10');
+
+    expect(res.status).toStrictEqual(200);
+  });
+
+  it('should transform skip and take into numbers', async () => {
+    const res = await superTestApp.get('/posts?skip=0&take=10');
+
+    expect(res.status).toStrictEqual(200);
+    expect(res.body.skip).toStrictEqual(0);
+    expect(res.body.take).toStrictEqual(10);
+  });
+
+  it('should error if a required query param is missing', async () => {
+    const res = await superTestApp.get('/posts?skip=0');
+
+    expect(res.status).toStrictEqual(400);
+    expect(res.body).toStrictEqual({
+      issues: [
+        {
+          code: 'invalid_type',
+          expected: 'string',
+          message: 'Required',
+          path: ['take'],
+          received: 'undefined',
+        },
+      ],
+      name: 'ZodError',
+    });
+  });
+
+  it('should error if body is incorrect', async () => {
+    const res = await superTestApp.post('/posts').send({
+      title: 'Good title',
+      content: 123,
+    });
+
+    expect(res.status).toStrictEqual(400);
+    expect(res.body).toStrictEqual({
+      issues: [
+        {
+          code: 'invalid_type',
+          expected: 'string',
+          message: 'Expected string, received number',
+          path: ['content'],
+          received: 'number',
+        },
+      ],
+      name: 'ZodError',
+    });
+  });
+
+  it('should transform body correctly', async () => {
+    const res = await superTestApp.post('/posts').send({
+      title: 'Title with extra spaces     ',
+      content: 'content',
+    });
+
+    expect(res.status).toStrictEqual(201);
+    expect(res.body.title).toStrictEqual('Title with extra spaces');
+  });
+
+  it('should format params using pathParams correctly', async () => {
+    const res = await superTestApp.get('/test/123/name');
+
+    expect(res.status).toStrictEqual(200);
+    expect(res.body).toStrictEqual({
+      id: 123,
+      name: 'name',
+    });
+  });
+});

libs/example-contracts/src/lib/contract-blog.ts

@@ -29,7 +29,7 @@ export const apiBlog = c.router({
       201: PostSchema,
     },
     body: z.object({
-      title: z.string(),
+      title: z.string().transform((v) => v.trim()),
       content: z.string(),
       published: z.boolean().optional(),
       description: z.string().optional(),
@@ -86,4 +86,18 @@ export const apiBlog = c.router({
     }),
     summary: 'Get all posts',
   },
+  testPathParams: {
+    method: 'GET',
+    path: '/test/:id/:name',
+    pathParams: z.object({
+      id: z.string().transform(Number),
+      name: z.string(),
+    }),
+    responses: {
+      200: z.object({
+        id: z.number(),
+        name: z.string(),
+      }),
+    },
+  },
 });

libs/example-microservice/util-posts-api/src/lib/example-microservice-util-posts-api.ts

@@ -33,6 +33,7 @@ export const postsApi = c.router({
       }),
     },
   },
+
   updatePostThumbnail: {
     method: 'POST',
     path: '/posts/:id/thumbnail',

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

@@ -10,6 +10,7 @@ export type AppRouteQuery = {
    * e.g. "/posts/:id".
    */
   path: string;
+  pathParams?: unknown;
   query?: unknown;
   summary?: string;
   description?: string;
@@ -28,6 +29,7 @@ export type AppRouteMutation = {
    * e.g. "/posts/:id".
    */
   path: string;
+  pathParams?: unknown;
   contentType?: 'application/json' | 'multipart/form-data';
   body: unknown;
   query?: unknown;

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

@@ -82,9 +82,5 @@ export const convertQueryParamsToUrlString = (
           .join('&')
       : '';
 
-  return queryString.length > 0 &&
-    queryString !== null &&
-    queryString !== undefined
-    ? '?' + queryString
-    : '';
+  return queryString?.length > 0 ? '?' + queryString : '';
 };

libs/ts-rest/core/src/lib/type-utils.ts

@@ -74,6 +74,8 @@ export type With<T, V> = Pick<T, ExcludeKeysWithoutTypeOf<T, V>>;
 
 export type ZodInferOrType<T> = T extends ZodTypeAny ? z.infer<T> : T;
 
+export type Merge<T, U> = Omit<T, keyof U> & U;
+
 type Try<A, B, C> = A extends B ? A : C;
 
 type NarrowRaw<T> =