fix(typed-document-node): accurate typings for client.request() and…

… do not enforce strict variable typing for `string` document (#390)
graffle-js · Sep 22, 2022 · d5599b9 · d5599b9
1 parent 6246ffe
commit d5599b9
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 4 deletions.
diff --git a/examples/typed-document-node.ts b/examples/typed-document-node.ts
@@ -1,7 +1,7 @@
 import { TypedDocumentNode } from '@graphql-typed-document-node/core'
 import { parse } from 'graphql'
 
-import { request } from '../src'
+import { request, GraphQLClient } from '../src'
 ;(async function () {
   const endpoint = 'https://graphql-yoga.com/api/graphql'
 
@@ -17,3 +17,21 @@ import { request } from '../src'
 
   console.log(data.greetings)
 })().catch(console.error)
+;(async function () {
+  const endpoint = 'https://graphql-yoga.com/api/graphql'
+
+  const client = new GraphQLClient(endpoint)
+
+  const query: TypedDocumentNode<{ greetings: string }, never | Record<any, never>> = parse(/* GraphQL */ `
+    query greetings {
+      greetings
+    }
+  `)
+
+  const variables = {}
+
+  const data = await client.request({ document: query })
+  // const data = await client.request({ document: query, variables: { a: 1 } })
+
+  console.log(data.greetings)
+})().catch(console.error)
diff --git a/src/index.ts b/src/index.ts
@@ -286,14 +286,19 @@ export class GraphQLClient {
    * Send a GraphQL document to the server.
    */
   request<T = any, V = Variables>(
-    document: RequestDocument | TypedDocumentNode<T, V>,
+    document: string,
+    variables?: V,
+    requestHeaders?: Dom.RequestInit['headers']
+  ): Promise<T>
+  request<T = any, V = Variables>(
+    document: DocumentNode | TypedDocumentNode<T, V>,
     ..._variablesAndRequestHeaders: V extends Record<any, never> // do we have explicitly no variables allowed?
       ? [variables?: V, requestHeaders?: Dom.RequestInit['headers']]
       : keyof RemoveIndex<V> extends never // do we get an empty variables object?
       ? [variables?: V, requestHeaders?: Dom.RequestInit['headers']]
       : [variables: V, requestHeaders?: Dom.RequestInit['headers']]
   ): Promise<T>
-  request<T = any, V = Variables>(options: RequestOptions<V>): Promise<T>
+  request<T = any, V = Variables>(options: RequestOptions<V, T>): Promise<T>
   request<T = any, V = Variables>(
     documentOrOptions: RequestDocument | TypedDocumentNode<T, V> | RequestOptions<V>,
     ...variablesAndRequestHeaders: V extends Record<any, never> // do we have explicitly no variables allowed?
@@ -562,13 +567,19 @@ export async function rawRequest<T = any, V = Variables>(
  */
 export async function request<T = any, V = Variables>(
   url: string,
-  document: RequestDocument | TypedDocumentNode<T, V>,
+  document: DocumentNode | TypedDocumentNode<T, V>,
   ..._variablesAndRequestHeaders: V extends Record<any, never> // do we have explicitly no variables allowed?
     ? [variables?: V, requestHeaders?: Dom.RequestInit['headers']]
     : keyof RemoveIndex<V> extends never // do we get an empty variables object?
     ? [variables?: V, requestHeaders?: Dom.RequestInit['headers']]
     : [variables: V, requestHeaders?: Dom.RequestInit['headers']]
 ): Promise<T>
+export async function request<T = any, V = Variables>(
+  url: string,
+  document: string,
+  variables?: V,
+  requestHeaders?: Dom.RequestInit['headers']
+): Promise<T>
 export async function request<T = any, V = Variables>(options: RequestExtendedOptions<V, T>): Promise<T>
 export async function request<T = any, V = Variables>(
   urlOrOptions: string | RequestExtendedOptions<V, T>,

diff --git a/tests/typed-document-node.test.ts b/tests/typed-document-node.test.ts
@@ -58,6 +58,12 @@ test('typed-document-node code should TS compile', async () => {
     variables: { str: 1 },
   })
 
+  await request({
+    url: ctx.url,
+    document: 'a graphql query',
+    variables: { whatever: 'not typed' },
+  })
+
   await request({
     url: ctx.url,
     document,