fix: fix typing for query

Author: Gabrola

.changeset/swift-points-brush.md

@@ -0,0 +1,6 @@
+---
+'@ts-rest/core': patch
+'@ts-rest/react-query': patch
+---
+
+Fix typing for query

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

@@ -135,6 +135,24 @@ describe('client', () => {
       const value = { key: 'value' };
       api.mockResolvedValue({ body: value, status: 200 });
 
+      const result = await client.posts.getPosts({});
+
+      expect(result).toStrictEqual({ body: value, status: 200 });
+
+      expect(api).toHaveBeenCalledWith({
+        method: 'GET',
+        path: 'http://api.com/posts',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body: undefined,
+      });
+    });
+
+    it('w/ no query parameters', async () => {
+      const value = { key: 'value' };
+      api.mockResolvedValue({ body: value, status: 200 });
+
       const result = await client.posts.getPosts({ query: {} });
 
       expect(result).toStrictEqual({ body: value, status: 200 });

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

@@ -6,6 +6,7 @@ import { HTTPStatusCode } from './status-codes';
 import {
   AreAllPropertiesOptional,
   Merge,
+  OptionalIfAllOptional,
   Without,
   ZodInferOrType,
 } from './type-utils';
@@ -43,18 +44,20 @@ type AppRouteBodyOrFormData<T extends AppRouteMutation> =
     ? FormData | AppRouteMutationType<T['body']>
     : AppRouteMutationType<T['body']>;
 
-interface DataReturnArgs<TRoute extends AppRoute> {
+interface DataReturnArgsBase<TRoute extends AppRoute> {
   body: TRoute extends AppRouteMutation
     ? AppRouteBodyOrFormData<TRoute>
     : never;
   params: PathParamsFromUrl<TRoute>;
-  query: AreAllPropertiesOptional<
-    AppRouteMutationType<TRoute['query']>
-  > extends false
+  query: 'query' extends keyof TRoute
     ? AppRouteMutationType<TRoute['query']>
     : never;
 }
 
+type DataReturnArgs<TRoute extends AppRoute> = OptionalIfAllOptional<
+  DataReturnArgsBase<TRoute>
+>;
+
 export type ApiRouteResponse<T> =
   | {
       [K in keyof T]: {

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

@@ -89,8 +89,30 @@ type NarrowNotZod<T> = Try<T, ZodType, NarrowRaw<T>>;
 
 export type Narrow<T> = Try<T, [], NarrowNotZod<T>>;
 
-export type AreAllPropertiesOptional<T> = {
-  [K in keyof T]-?: undefined extends T[K] ? true : false;
-}[keyof T] extends true
-  ? true
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+// https://github.com/ts-essentials/ts-essentials/blob/4c451652ba7c20b0e0b965e0b7755fd4d7844127/lib/types.ts#L228
+type OptionalKeys<T> = T extends unknown
+  ? {
+      [K in keyof T]-?: undefined extends { [K2 in keyof T]: K2 }[K]
+        ? K
+        : never;
+    }[keyof T]
+  : never;
+
+export type AreAllPropertiesOptional<T> = T extends Record<string, unknown>
+  ? Exclude<keyof T, OptionalKeys<T>> extends never
+    ? true
+    : false
   : false;
+
+export type OptionalIfAllOptional<
+  T,
+  Select extends keyof T = keyof T
+> = PartialBy<
+  T,
+  Select &
+    {
+      [K in keyof T]: AreAllPropertiesOptional<T[K]> extends true ? K : never;
+    }[keyof T]
+>;

libs/ts-rest/react-query/src/lib/react-query.ts

@@ -25,6 +25,7 @@ import {
   getRouteQuery,
   HTTPStatusCode,
   isAppRoute,
+  OptionalIfAllOptional,
   PathParamsFromUrl,
   SuccessfulHttpStatusCode,
   Without,
@@ -58,20 +59,24 @@ type UseQueryArgs<TAppRoute extends AppRoute> = {
     : never;
 };
 
-type DataReturnArgs<TRoute extends AppRoute> = {
+type DataReturnArgsBase<TRoute extends AppRoute> = {
   body: TRoute extends AppRouteMutation
     ? AppRouteMutationType<TRoute['body']> extends null
       ? never
       : AppRouteMutationType<TRoute['body']>
     : never;
   params: PathParamsFromUrl<TRoute>;
-  query: AreAllPropertiesOptional<
-    AppRouteMutationType<TRoute['query']>
-  > extends false
-    ? AppRouteMutationType<TRoute['query']>
+  query: 'query' extends keyof TRoute
+    ? AppRouteMutationType<TRoute['query']> extends null
+      ? never
+      : AppRouteMutationType<TRoute['query']>
     : never;
 };
 
+type DataReturnArgs<TRoute extends AppRoute> = OptionalIfAllOptional<
+  DataReturnArgsBase<TRoute>
+>;
+
 /**
  * Split up the data and error to support react-query style
  * useQuery and useMutation error handling
@@ -177,7 +182,7 @@ const getRouteUseQuery = <TAppRoute extends AppRoute>(
 ) => {
   return (
     queryKey: QueryKey,
-    args?: DataReturnArgs<TAppRoute>,
+    args?: DataReturnArgs<any>,
     options?: UseQueryOptions<TAppRoute['responses']>
   ) => {
     const dataFn: QueryFunction<TAppRoute['responses']> = async () => {
@@ -208,7 +213,7 @@ const getRouteUseInfiniteQuery = <TAppRoute extends AppRoute>(
 ) => {
   return (
     queryKey: QueryKey,
-    args: (context: QueryFunctionContext) => DataReturnArgs<TAppRoute>,
+    args: (context: QueryFunctionContext) => DataReturnArgs<any>,
     options?: UseInfiniteQueryOptions<TAppRoute['responses']>
   ) => {
     const dataFn: QueryFunction<TAppRoute['responses']> = async (
@@ -247,7 +252,7 @@ const getRouteUseMutation = <TAppRoute extends AppRoute>(
   clientArgs: ClientArgs
 ) => {
   return (options?: UseMutationOptions<TAppRoute['responses']>) => {
-    const mutationFunction = async (args?: DataReturnArgs<TAppRoute>) => {
+    const mutationFunction = async (args?: DataReturnArgs<any>) => {
       const path = getCompleteUrl(
         args?.query,
         clientArgs.baseUrl,