fix: batchRequests type constraint (#462)

Also update dependency vitest to ^0.29.0 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Jason Kuhrt <[email protected]>
jasonkuhrt · Feb 25, 2023 · d5a4012 · d5a4012
1 parent 0fb7062
commit d5a4012
Show file tree

Hide file tree

Showing 11 changed files with 170 additions and 54 deletions.
diff --git a/README.md b/README.md
@@ -41,9 +41,9 @@ Minimal GraphQL client supporting Node and browsers for scripts or simple apps
     - [Ignore](#ignore)
     - [All](#all)
 - [FAQ](#faq)
-    - [Why do I have to install `graphql`?](#why-do-i-have-to-install-graphql)
-    - [Do I need to wrap my GraphQL documents inside the `gql` template exported by `graphql-request`?](#do-i-need-to-wrap-my-graphql-documents-inside-the-gql-template-exported-by-graphql-request)
-    - [What's the difference between `graphql-request`, Apollo and Relay?](#whats-the-difference-between-graphql-request-apollo-and-relay)
+  - [Why do I have to install `graphql`?](#why-do-i-have-to-install-graphql)
+  - [Do I need to wrap my GraphQL documents inside the `gql` template exported by `graphql-request`?](#do-i-need-to-wrap-my-graphql-documents-inside-the-gql-template-exported-by-graphql-request)
+  - [What's the difference between `graphql-request`, Apollo and Relay?](#whats-the-difference-between-graphql-request-apollo-and-relay)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 

diff --git a/examples/typed-document-node.ts b/examples/typed-document-node.ts
@@ -1,4 +1,4 @@
-import { GraphQLClient,request } from '../src/index.js'
+import { GraphQLClient, request } from '../src/index.js'
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core'
 import { parse } from 'graphql'
 ;(async function () {

diff --git a/package.json b/package.json
@@ -100,7 +100,7 @@
     "prettier": "^2.8.3",
     "type-fest": "^3.5.3",
     "typescript": "^4.9.4",
-    "vitest": "^0.28.2",
+    "vitest": "^0.29.0",
     "ws": "^8.12.0"
   },
   "prettier": "@prisma-labs/prettier-config"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/graphql-ws.ts b/src/graphql-ws.ts
@@ -1,6 +1,6 @@
 import { resolveRequestDocument } from './resolveRequestDocument.js'
 import type * as Dom from './types.dom.js'
-import type { RequestDocument, Variables } from './types.js';
+import type { RequestDocument, Variables } from './types.js'
 import { ClientError } from './types.js'
 // import type WebSocket from 'ws'
 

diff --git a/src/index.ts b/src/index.ts
@@ -3,7 +3,6 @@ import { defaultJsonSerializer } from './defaultJsonSerializer.js'
 import { HeadersInstanceToPlainObject, uppercase } from './helpers.js'
 import {
   parseBatchRequestArgs,
-  parseBatchRequestsExtendedArgs,
   parseRawRequestArgs,
   parseRawRequestExtendedArgs,
   parseRequestArgs,
@@ -33,6 +32,7 @@ import {
 } from './types.js'
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core'
 import crossFetch, * as CrossFetch from 'cross-fetch'
+import type { T, V } from 'vitest/dist/types-7cd96283.js'
 
 export {
   BatchRequestDocument,
@@ -310,12 +310,12 @@ export class GraphQLClient {
   /**
    * Send GraphQL documents in batch to the server.
    */
-  batchRequests<T = unknown, V extends Variables = Variables>(
-    documents: BatchRequestDocument<V>[],
-    requestHeaders?: Dom.RequestInit['headers']
-  ): Promise<T>
-  batchRequests<T = unknown, V extends Variables = Variables>(options: BatchRequestsOptions<V>): Promise<T>
-  batchRequests<T = unknown, V extends Variables = Variables>(
+  // prettier-ignore
+  batchRequests<T extends BatchResult, V extends Variables = Variables>(documents: BatchRequestDocument<V>[], requestHeaders?: Dom.RequestInit['headers']): Promise<T>
+  // prettier-ignore
+  batchRequests<T extends BatchResult, V extends Variables = Variables>(options: BatchRequestsOptions<V>): Promise<T>
+  // prettier-ignore
+  batchRequests<T extends BatchResult, V extends Variables = Variables>(
     documentsOrOptions: BatchRequestDocument<V>[] | BatchRequestsOptions<V>,
     requestHeaders?: Dom.RequestInit['headers']
   ): Promise<T> {
@@ -573,22 +573,39 @@ export async function request<T, V extends Variables = Variables>(
  * await batchRequests('https://foo.bar/graphql', [{ query: gql`...` }])
  * ```
  */
-export async function batchRequests<T, V extends Variables = Variables>(
-  url: string,
-  documents: BatchRequestDocument<V>[],
-  requestHeaders?: Dom.RequestInit['headers']
-): Promise<T>
-export async function batchRequests<T, V extends Variables = Variables>(
-  options: BatchRequestsExtendedOptions<V>
-): Promise<T>
-export async function batchRequests<T, V extends Variables = Variables>(
-  urlOrOptions: string | BatchRequestsExtendedOptions<V>,
-  documents?: BatchRequestDocument<V>[],
-  requestHeaders?: Dom.RequestInit['headers']
-): Promise<T> {
-  const params = parseBatchRequestsExtendedArgs<V>(urlOrOptions, documents, requestHeaders)
+export const batchRequests: BatchRequests = async (...args: BatchRequestsArgs) => {
+  const params = parseBatchRequestsArgsExtended(args)
   const client = new GraphQLClient(params.url)
-  return client.batchRequests<T, V>(params)
+  return client.batchRequests(params)
+}
+
+interface Result<Data extends object = object> {
+  data: Data
+}
+
+type BatchResult = [Result, ...Result[]]
+
+// prettier-ignore
+interface BatchRequests {
+  <T extends BatchResult, V extends Variables = Variables>(url: string, documents: BatchRequestDocument<V>[], requestHeaders?: Dom.RequestInit['headers']): Promise<T>
+  <T extends BatchResult, V extends Variables = Variables>(options: BatchRequestsExtendedOptions<V>): Promise<T>
+}
+
+type BatchRequestsArgs =
+  | [url: string, documents: BatchRequestDocument[], requestHeaders?: Dom.RequestInit['headers']]
+  | [options: BatchRequestsExtendedOptions]
+
+const parseBatchRequestsArgsExtended = (args: BatchRequestsArgs): BatchRequestsExtendedOptions => {
+  if (args.length === 1) {
+    return args[0]
+  } else {
+    return {
+      url: args[0],
+      documents: args[1],
+      requestHeaders: args[2],
+      signal: undefined,
+    }
+  }
 }
 
 export default request

diff --git a/src/parseArgs.ts b/src/parseArgs.ts
@@ -88,18 +88,3 @@ export const parseRawRequestExtendedArgs = <V extends Variables = Variables>(
         signal: undefined,
       } as unknown as RawRequestExtendedOptions<V>)
 }
-
-export const parseBatchRequestsExtendedArgs = <V extends Variables = Variables>(
-  urlOrOptions: string | BatchRequestsExtendedOptions<V>,
-  documents?: BatchRequestDocument<V>[],
-  requestHeaders?: Dom.RequestInit['headers']
-): BatchRequestsExtendedOptions<V> => {
-  return (urlOrOptions as BatchRequestsExtendedOptions<V>).documents
-    ? (urlOrOptions as BatchRequestsExtendedOptions<V>)
-    : {
-        url: urlOrOptions as string,
-        documents: documents as BatchRequestDocument<V>[],
-        requestHeaders: requestHeaders,
-        signal: undefined,
-      }
-}
diff --git a/src/types.ts b/src/types.ts
@@ -96,7 +96,7 @@ export type RequestOptions<V extends Variables = Variables, T = unknown> = {
   ? { variables?: V }
   : { variables: V })
 
-export type BatchRequestsOptions<V extends Variables = Variables> = {
+export interface BatchRequestsOptions<V extends Variables = Variables> {
   documents: BatchRequestDocument<V>[]
   requestHeaders?: Dom.RequestInit['headers']
   signal?: Dom.RequestInit['signal']
@@ -110,9 +110,10 @@ export type RawRequestExtendedOptions<V extends Variables = Variables> = {
   url: string
 } & RawRequestOptions<V>
 
-export type BatchRequestsExtendedOptions<V extends Variables = Variables> = {
+export interface BatchRequestsExtendedOptions<V extends Variables = Variables>
+  extends BatchRequestsOptions<V> {
   url: string
-} & BatchRequestsOptions<V>
+}
 
 export type RequestMiddleware<V extends Variables = Variables> = (
   request: RequestExtendedInit<V>

diff --git a/tests/__snapshots__/document-node.test.ts.snap b/tests/__snapshots__/document-node.test.ts.snap
@@ -1,4 +1,4 @@
-// Vitest Snapshot v1
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`accepts graphql DocumentNode as alternative to raw string 1`] = `
 {

diff --git a/tests/__snapshots__/gql.test.ts.snap b/tests/__snapshots__/gql.test.ts.snap
@@ -1,4 +1,4 @@
-// Vitest Snapshot v1
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`gql > passthrough allowing benefits of tooling for gql template tag 1`] = `
 {

diff --git a/tests/general.test.ts b/tests/general.test.ts
@@ -1,5 +1,4 @@
 import { GraphQLClient, rawRequest, request } from '../src/index.js'
-import type * as Dom from '../src/types.dom.js'
 import type { RequestConfig } from '../src/types.js'
 import { setupMockServer } from './__helpers.js'
 import { gql } from 'graphql-tag'
@@ -203,7 +202,7 @@ describe(`middleware`, () => {
     })
 
     it(`batchRequests`, async () => {
-      const requestPromise = client.batchRequests<{ result: number }>([{ document: `x` }])
+      const requestPromise = client.batchRequests([{ document: `x` }])
       expect(requestMiddleware).toBeCalledTimes(1)
       await requestPromise
       expect(responseMiddleware).toBeCalledTimes(1)
@@ -250,7 +249,7 @@ describe(`middleware`, () => {
     })
 
     it(`batchRequests`, async () => {
-      const requestPromise = client.batchRequests<{ result: number }>([{ document: `x` }])
+      const requestPromise = client.batchRequests([{ document: `x` }])
       expect(requestMiddleware).toBeCalledTimes(1)
       await requestPromise
     })
@@ -295,7 +294,7 @@ describe(`middleware`, () => {
     })
 
     it(`batchRequests`, async () => {
-      const requestPromise = client.batchRequests<{ result: number }>([{ document: `x` }])
+      const requestPromise = client.batchRequests([{ document: `x` }])
       expect(requestMiddleware).toBeCalledTimes(1)
       await expect(requestPromise).rejects.toThrowError()
       expect(responseMiddleware).toBeCalledTimes(1)