feat: add pathParams transformations

Author: oliverbutler

.changeset/large-gifts-eat.md

@@ -0,0 +1,7 @@
+---
+'@ts-rest/core': minor
+'@ts-rest/nest': minor
+'@ts-rest/next': minor
+---
+
+Add pathParams transformations

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

@@ -6,9 +6,7 @@ import {
   ParamsFromUrl,
 } from './paths';
 import { HTTPStatusCode } from './status-codes';
-import { Without, ZodInferOrType } from './type-utils';
-
-
+import { Merge, Without, ZodInferOrType } from './type-utils';
 
 type RecursiveProxyObj<T extends AppRouter> = {
   [TKey in keyof T]: T[TKey] extends AppRoute
@@ -23,12 +21,20 @@ type AppRouteMutationType<T> = T extends ZodTypeAny ? z.infer<T> : T;
 /**
  * Extract the path params from the path in the contract
  */
-export type PathParams<T extends AppRoute> = ParamsFromUrl<
+export type PathParamsFromUrl<T extends AppRoute> = ParamsFromUrl<
   T['path']
 > extends infer U
   ? U
   : never;
 
+/**
+ * Merge PathParamsFromUrl<T> with pathParams schema if it exists
+ */
+export type PathParamsWithCustomValidators<T extends AppRoute> =
+  T['pathParams'] extends undefined
+    ? PathParamsFromUrl<T>
+    : Merge<PathParamsFromUrl<T>, ZodInferOrType<T['pathParams']>>;
+
 // Allow FormData if the contentType is multipart/form-data
 type AppRouteBodyOrFormData<T extends AppRouteMutation> =
   T['contentType'] extends 'multipart/form-data'
@@ -39,7 +45,7 @@ interface DataReturnArgs<TRoute extends AppRoute> {
   body: TRoute extends AppRouteMutation
     ? AppRouteBodyOrFormData<TRoute>
     : never;
-  params: PathParams<TRoute>;
+  params: PathParamsFromUrl<TRoute>;
   query: TRoute['query'] extends ZodTypeAny
     ? AppRouteMutationType<TRoute['query']>
     : never;
@@ -144,16 +150,13 @@ export const fetchApi = (
 };
 
 export const getCompleteUrl = (
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   query: any,
   baseUrl: string,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   params: any,
   route: AppRoute
 ) => {
   const path = insertParamsIntoPath({
     path: route.path,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     params: params as any,
   });
   const queryComponent = convertQueryParamsToUrlString(query);
@@ -164,7 +167,6 @@ export const getRouteQuery = <TAppRoute extends AppRoute>(
   route: TAppRoute,
   clientArgs: ClientArgs
 ) => {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   return async (inputArgs: DataReturnArgs<any>) => {
     const completeUrl = getCompleteUrl(
       inputArgs.query,
@@ -181,7 +183,6 @@ const createNewProxy = (router: AppRouter, args: ClientArgs) => {
   return new Proxy(
     {},
     {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       get: (target, propKey): any => {
         if (typeof propKey === 'string' && propKey in router) {
           const subRouter = router[propKey];

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

@@ -1,15 +1,17 @@
 import { Narrow } from './type-utils';
 
+/**
+ * The path with colon-prefixed parameters
+ * e.g. "/posts/:id".
+ */
+type Path = string;
+
 /**
  * A query endpoint. In REST terms, one using GET.
  */
 export type AppRouteQuery = {
   method: 'GET';
-  /**
-   * The path with colon-prefixed parameters
-   * e.g. "/posts/:id".
-   */
-  path: string;
+  path: Path;
   pathParams?: unknown;
   query?: unknown;
   summary?: string;
@@ -24,11 +26,7 @@ export type AppRouteQuery = {
  */
 export type AppRouteMutation = {
   method: 'POST' | 'DELETE' | 'PUT' | 'PATCH';
-  /**
-   * The path with colon-prefixed parameters
-   * e.g. "/posts/:id".
-   */
-  path: string;
+  path: Path;
   pathParams?: unknown;
   contentType?: 'application/json' | 'multipart/form-data';
   body: unknown;

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

@@ -35,17 +35,12 @@ export const getPathParamsFromArray = (
   });
 
   // remove pathParams where key doesn't start with :
-  const pathParamsWithoutColons = Object.entries(pathParams).reduce(
-    (acc, [key, value]) => {
-      if (key.startsWith(':')) {
-        const keyWithoutColon = key.slice(1);
-        acc[keyWithoutColon] = value;
-      }
-
-      return acc;
-    },
-    {} as Record<string, string>
-  );
-
-  return pathParamsWithoutColons;
+  return Object.entries(pathParams).reduce((acc, [key, value]) => {
+    if (key.startsWith(':')) {
+      const keyWithoutColon = key.slice(1);
+      acc[keyWithoutColon] = value;
+    }
+
+    return acc;
+  }, {} as Record<string, string>);
 };

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

@@ -50,9 +50,7 @@ export function getValue<
     .split(/[.[\]]/)
     .filter(Boolean)
     .reduce<GetFieldType<TData, TPath>>(
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       (value, key) => (value as any)?.[key],
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       data as any
     );
 
@@ -79,7 +77,6 @@ export type Merge<T, U> = Omit<T, keyof U> & U;
 type Try<A, B, C> = A extends B ? A : C;
 
 type NarrowRaw<T> =
-  // eslint-disable-next-line @typescript-eslint/ban-types
   | (T extends Function ? T : never)
   | (T extends string | number | bigint | boolean ? T : never)
   | (T extends [] ? [] : never)

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

@@ -1,11 +1,8 @@
-import { z, ZodTypeAny } from 'zod';
-import { AppRoute } from './dsl';
+import { z } from 'zod';
 
-const isZodObject = (
+export const isZodObject = (
   body: unknown
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
 ): body is z.ZodObject<any, any, any, any> => {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   return (body as z.ZodObject<any, any, any, any>)?.safeParse !== undefined;
 };
 

libs/ts-rest/express/src/lib/ts-rest-express.ts

@@ -5,13 +5,12 @@ import {
   AppRouteMutation,
   AppRouteQuery,
   AppRouter,
-  isAppRoute,
+  checkZodSchema,
   getValue,
+  isAppRoute,
+  PathParamsWithCustomValidators,
   Without,
   ZodInferOrType,
-  PathParams,
-  checkZodSchema,
-  Merge,
 } from '@ts-rest/core';
 
 export type ApiRouteResponse<T> = {
@@ -24,7 +23,7 @@ export type ApiRouteResponse<T> = {
 type AppRouteQueryImplementation<T extends AppRouteQuery> = (
   input: Without<
     {
-      params: PathParamsWithZod<T>;
+      params: PathParamsWithCustomValidators<T>;
       query: ZodInferOrType<T['query']>;
       headers: IncomingHttpHeaders;
       req: Request;
@@ -38,17 +37,10 @@ type WithoutFileIfMultiPart<T extends AppRouteMutation> =
     ? Without<ZodInferOrType<T['body']>, File>
     : ZodInferOrType<T['body']>;
 
-/**
- * Merge PathParams<T> with pathParams schema if it exists
- */
-type PathParamsWithZod<T extends AppRoute> = T['pathParams'] extends undefined
-  ? PathParams<T>
-  : Merge<PathParams<T>, ZodInferOrType<T['pathParams']>>;
-
 type AppRouteMutationImplementation<T extends AppRouteMutation> = (
   input: Without<
     {
-      params: PathParamsWithZod<T>;
+      params: PathParamsWithCustomValidators<T>;
       query: ZodInferOrType<T['query']>;
       body: WithoutFileIfMultiPart<T>;
       headers: IncomingHttpHeaders;
@@ -82,10 +74,8 @@ export const initServer = () => {
 };
 
 const recursivelyApplyExpressRouter = (
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   router: RecursiveRouterObj<any> | AppRouteImplementation<any>,
   path: string[],
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   routeTransformer: (route: AppRouteImplementation<any>, path: string[]) => void
 ): void => {
   if (typeof router === 'object') {
@@ -102,7 +92,6 @@ const recursivelyApplyExpressRouter = (
 };
 
 const transformAppRouteQueryImplementation = (
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   route: AppRouteQueryImplementation<any>,
   schema: AppRouteQuery,
   app: IRouter
@@ -124,9 +113,7 @@ const transformAppRouteQueryImplementation = (
       return res.status(400).send(paramsResult.error);
     }
 
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     const result = await route({
-      // @ts-ignore
       params: paramsResult.data,
       query: queryResult.data,
       headers: req.headers,
@@ -138,7 +125,6 @@ const transformAppRouteQueryImplementation = (
 };
 
 const transformAppRouteMutationImplementation = (
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   route: AppRouteMutationImplementation<any>,
   schema: AppRouteMutation,
   app: IRouter
@@ -161,18 +147,22 @@ const transformAppRouteMutationImplementation = (
         return res.status(400).send(bodyResult.error);
       }
 
+      const paramsResult = checkZodSchema(req.params, schema.pathParams, {
+        passThroughExtraKeys: true,
+      });
+
+      if (!paramsResult.success) {
+        return res.status(400).send(paramsResult.error);
+      }
+
       const result = await route({
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        params: req.params,
+        params: paramsResult.data,
         body: bodyResult.data,
         query: queryResult.data,
         headers: req.headers,
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
+        // @ts-expect-error
         files: req.files,
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
+        // @ts-expect-error
         file: req.file,
         req: req,
       });
@@ -220,7 +210,6 @@ export const createExpressEndpoints = <
         transformAppRouteMutationImplementation(route, routerViaPath, app);
       } else {
         transformAppRouteQueryImplementation(
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
           route as AppRouteQueryImplementation<any>,
           routerViaPath,
           app

libs/ts-rest/nest/src/lib/api.decorator.ts

@@ -7,7 +7,6 @@ import {
   ExecutionContext,
   Get,
   HttpException,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   Injectable,
   NestInterceptor,
   Patch,
@@ -20,7 +19,7 @@ import {
   AppRouteMutation,
   checkZodSchema,
   getPathParamsFromUrl,
-  PathParams,
+  PathParamsWithCustomValidators,
   Without,
   ZodInferOrType,
 } from '@ts-rest/core';
@@ -33,7 +32,7 @@ type BodyWithoutFileIfMultiPart<T extends AppRouteMutation> =
 
 export type ApiDecoratorShape<TRoute extends AppRoute> = Without<
   {
-    params: PathParams<TRoute>;
+    params: PathParamsWithCustomValidators<TRoute>;
     body: TRoute extends AppRouteMutation
       ? BodyWithoutFileIfMultiPart<TRoute>
       : never;
@@ -54,7 +53,6 @@ const getQueryParams = (url: string): Record<string, string> => {
 };
 
 export const ApiDecorator = createParamDecorator(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   (_: unknown, ctx: ExecutionContext): ApiDecoratorShape<any> => {
     const req = ctx.switchToHttp().getRequest();
 
@@ -84,10 +82,17 @@ export const ApiDecorator = createParamDecorator(
       throw new BadRequestException(bodyResult.error);
     }
 
+    const pathParamsResult = checkZodSchema(pathParams, appRoute.pathParams, {
+      passThroughExtraKeys: true,
+    });
+
+    if (!pathParamsResult.success) {
+      throw new BadRequestException(pathParamsResult.error);
+    }
+
     return {
       query: queryResult.data,
-      // @ts-expect-error because the decorator shape is any
-      params: pathParams,
+      params: pathParamsResult.data,
       body: bodyResult.data,
     };
   }
@@ -112,7 +117,6 @@ const getMethodDecorator = (appRoute: AppRoute) => {
 export class ApiRouteInterceptor implements NestInterceptor {
   constructor(private readonly appRoute: AppRoute) {}
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
     const req = context.switchToHttp().getRequest();
 

libs/ts-rest/nest/src/lib/ts-rest-nest.ts

@@ -2,7 +2,6 @@ import { AppRoute, AppRouter, ApiRouteResponse, Without } from '@ts-rest/core';
 import { ApiDecoratorShape } from './api.decorator';
 
 type AppRouterMethodShape<T extends AppRoute> = (
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   ...args: any[]
 ) => Promise<ApiRouteResponse<T['responses']>>;