From b46583ee99cf5b50c467c507fece83d9fa4e9519 Mon Sep 17 00:00:00 2001
From: Cody Olsen <81981+stipsan@users.noreply.github.com>
Date: Mon, 29 Jan 2024 13:02:30 +0100
Subject: [PATCH] fix(typings): relax query params typings to fix regressions
 (#510)

---
 src/SanityClient.ts   | 47 ++++++++++++++++++++++++-------------------
 src/types.ts          | 13 ------------
 test/client.test-d.ts | 24 +++++++++++-----------
 3 files changed, 38 insertions(+), 46 deletions(-)

diff --git a/src/SanityClient.ts b/src/SanityClient.ts
index 22f47342..7ea8a480 100644
--- a/src/SanityClient.ts
+++ b/src/SanityClient.ts
@@ -28,7 +28,6 @@ import type {
   QueryOptions,
   QueryParams,
   QueryParamsLikelyByMistake,
-  QueryParamsParameter,
   QueryParamsWithoutQueryOptions,
   RawQueryResponse,
   RawRequestOptions,
@@ -134,33 +133,36 @@ export class ObservableSanityClient {
    *
    * @param query - GROQ-query to perform
    */
-  fetch<
-    R = Any,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    Q extends never | undefined | Record<string, never> = never,
-  >(query: string): Observable<R>
+  fetch<R = Any>(query: string): Observable<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
    * @param query - GROQ-query to perform
-   * @param params - Optional query parameters
-   * @param options - Optional request options
+   * @param params - Query parameters
+   */
+  fetch<R = Any, Q = QueryParamsWithoutQueryOptions>(query: string, params: Q): Observable<R>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Query parameters
+   * @param options - Request options
    */
   fetch<R = Any, Q = QueryParamsWithoutQueryOptions>(
     query: string,
-    params: QueryParamsParameter<Q>,
-    options?: FilteredResponseQueryOptions,
+    params: Q | undefined,
+    options: FilteredResponseQueryOptions,
   ): Observable<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
    * @param query - GROQ-query to perform
-   * @param params - Optional query parameters
+   * @param params - Query parameters
    * @param options - Request options
    */
   fetch<R = Any, Q = QueryParamsWithoutQueryOptions>(
     query: string,
-    params: QueryParamsParameter<Q>,
+    params: Q | undefined,
     options: UnfilteredResponseQueryOptions,
   ): Observable<RawQueryResponse<R>>
   /**
@@ -793,22 +795,25 @@ export class SanityClient {
    *
    * @param query - GROQ-query to perform
    */
-  fetch<
-    R = Any,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    Q extends never | undefined | Record<string, never> = never,
-  >(query: string): Promise<R>
+  fetch<R = Any>(query: string): Promise<R>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   */
+  fetch<R = Any, Q = QueryParamsWithoutQueryOptions>(query: string, params: Q): Promise<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
    * @param query - GROQ-query to perform
    * @param params - Optional query parameters
-   * @param options - Optional request options
+   * @param options - Request options
    */
   fetch<R = Any, Q = QueryParamsWithoutQueryOptions>(
     query: string,
-    params: QueryParamsParameter<Q>,
-    options?: FilteredResponseQueryOptions,
+    params: Q | undefined,
+    options: FilteredResponseQueryOptions,
   ): Promise<R>
   /**
    * Perform a GROQ-query against the configured dataset.
@@ -819,7 +824,7 @@ export class SanityClient {
    */
   fetch<R = Any, Q = QueryParamsWithoutQueryOptions>(
     query: string,
-    params: QueryParamsParameter<Q>,
+    params: Q | undefined,
     options: UnfilteredResponseQueryOptions,
   ): Promise<RawQueryResponse<R>>
   /**
diff --git a/src/types.ts b/src/types.ts
index 6e3802bf..7bfcd0c9 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -495,19 +495,6 @@ export type QueryParamsWithoutQueryOptions = {
   [K in keyof _QueryParamsLikelyByMistake]: never
 } & QueryParams
 
-/**
- * Transform a QueryParams generic type to a valid parameter type for `client.fetch
- * @public
- */
-export type QueryParamsParameter<QueryParamsParameterType> =
-  QueryParamsParameterType extends QueryParams
-    ? QueryParamsParameterType
-    : QueryParamsParameterType extends Record<string, never>
-      ? Record<string, never>
-      : QueryParamsParameterType extends undefined
-        ? undefined | Record<string, never>
-        : never
-
 /** @internal */
 export type MutationSelection = {query: string; params?: QueryParams} | {id: string | string[]}
 /** @internal */
diff --git a/test/client.test-d.ts b/test/client.test-d.ts
index a002d9ba..f473c7bb 100644
--- a/test/client.test-d.ts
+++ b/test/client.test-d.ts
@@ -50,9 +50,9 @@ describe('client.fetch', () => {
         {type: 'post'},
       ),
     ).toMatchTypeOf<number>()
-    expectTypeOf(
-      await client.fetch<number, never>('count(*[_type == $type])'),
-    ).toMatchTypeOf<number>()
+    // expectTypeOf(
+    // await client.fetch<number, never>('count(*[_type == $type])'),
+    // ).toMatchTypeOf<number>()
     expectTypeOf(
       await client.fetch<number, never>(
         'count(*[_type == $type])',
@@ -67,15 +67,15 @@ describe('client.fetch', () => {
         {},
       ),
     ).toMatchTypeOf<number>()
-    expectTypeOf(
-      await client.fetch<number, undefined>('count(*[_type == $type])'),
-    ).toMatchTypeOf<number>()
+    // expectTypeOf(
+    // await client.fetch<number, undefined>('count(*[_type == $type])'),
+    // ).toMatchTypeOf<number>()
     expectTypeOf(
       await client.fetch<number, undefined>('count(*[_type == $type])', undefined),
     ).toMatchTypeOf<number>()
-    expectTypeOf(
-      await client.fetch<number, undefined>('count(*[_type == $type])', {}),
-    ).toMatchTypeOf<number>()
+    // expectTypeOf(
+    // await client.fetch<number, undefined>('count(*[_type == $type])', {}),
+    // ).toMatchTypeOf<number>()
     expectTypeOf(
       await client.fetch<number, undefined>(
         'count(*[_type == $type])',
@@ -83,9 +83,9 @@ describe('client.fetch', () => {
         {type: 'post'},
       ),
     ).toMatchTypeOf<number>()
-    expectTypeOf(
-      await client.fetch<number, Record<string, never>>('count(*[_type == $type])'),
-    ).toMatchTypeOf<number>()
+    // expectTypeOf(
+    // await client.fetch<number, Record<string, never>>('count(*[_type == $type])'),
+    // ).toMatchTypeOf<number>()
     expectTypeOf(
       await client.fetch<number, Record<string, never>>(
         'count(*[_type == $type])',