feat: raw overload (#968)

jasonkuhrt · web-flow · commit c3a1718a9105 · 2024-07-04T23:03:06.000-04:00
diff --git a/README.md b/README.md
@@ -101,26 +101,26 @@ await client.request(document)
 ## Examples
 
 - Request:
-  - [Authentication via HTTP header](./examples/request-authentication-via-http-header.ts)
-  - [Method GET](./examples/request-method-get.ts)
-  - [Cancellation](./examples/request-cancellation.ts)
-  - [Headers Per Request (static)](./examples/request-headers-static-per-request.ts)
-  - [Headers Per Request (dynamic)](./examples/request-headers-dynamic-per-request.ts)
-  - [Handle Raw Response](./examples/request-handle-raw-response.ts)
+  - [Authentication via HTTP header](./examples/legacy/request-authentication-via-http-header.ts)
+  - [Method GET](./examples/legacy/request-method-get.ts)
+  - [Cancellation](./examples/legacy/request-cancellation.ts)
+  - [Headers Per Request (static)](./examples/legacy/request-headers-static-per-request.ts)
+  - [Headers Per Request (dynamic)](./examples/legacy/request-headers-dynamic-per-request.ts)
+  - [Handle Raw Response](./examples/legacy/request-handle-raw-response.ts)
 - GraphQL:
-  - [Document Variables](./examples/graphql-document-variables.ts)
-  - [Mutation](./examples/graphql-mutations.ts)
-  - [Batching Requests](./examples/graphql-batching-requests.ts)
+  - [Document Variables](./examples/legacy/graphql-document-variables.ts)
+  - [Mutation](./examples/legacy/graphql-mutations.ts)
+  - [Batching Requests](./examples/legacy/graphql-batching-requests.ts)
 - Configuration:
-  - [Fetch: Passing Options](./examples/configuration-fetch-options.ts)
-  - [Custom JSON Serializer](./examples/configuration-request-json-serializer.ts)
-  - [Incremental: Set Endpoint](./examples/configuration-incremental-endpoint.ts)
-  - [Incremental: Set Request Headers](./examples/configuration-incremental-request-headers.ts)
+  - [Fetch: Passing Options](./examples/legacy/configuration-fetch-options.ts)
+  - [Custom JSON Serializer](./examples/legacy/configuration-request-json-serializer.ts)
+  - [Incremental: Set Endpoint](./examples/legacy/configuration-incremental-endpoint.ts)
+  - [Incremental: Set Request Headers](./examples/legacy/configuration-incremental-request-headers.ts)
 - TypeScript:
-  - [Use `TypedDocumentNode`](./examples/typescript-typed-document-node.ts)
+  - [Use `TypedDocumentNode`](./examples/legacy/typescript-typed-document-node.ts)
 - Other:
-  - [Middleware](./examples/other-middleware.ts)
-  - [Error Handling](./examples/other-error-handling.ts)
+  - [Middleware](./examples/legacy/other-middleware.ts)
+  - [Error Handling](./examples/legacy/other-error-handling.ts)
 
 ## Node Version Support
 
@@ -136,7 +136,7 @@ Any issue that exists solely for an unsupported version of Nodejs will be reject
 
 ## Reference
 
-⚠️ This reference is incomplete. Check out the [examples](./examples/) for more reference material.
+⚠️ This reference is incomplete. Check out the [examples](./examples/legacy/) for more reference material.
 
 ### Configuration
 
diff --git a/examples/Graffle.ts b/examples/Graffle.ts
@@ -0,0 +1,21 @@
+import { gql, Graffle } from '../src/entrypoints/alpha/main.js'
+
+const request = Graffle.create({ schema: `https://countries.trevorblades.com/graphql` }).rawOrThrow // eslint-disable-line
+
+// todo typed document node
+// interface Data {
+//   countries: { name }[]
+// }
+// const { data } = await request<Data>(
+
+const { data } = await request(
+  gql`
+		{
+			countries {
+				name
+			}
+		}	
+	`,
+)
+
+console.log(data)
diff --git a/examples/legacy/configuration-fetch-options.ts b/examples/legacy/configuration-fetch-options.ts
@@ -1,4 +1,4 @@
-import { gql, GraphQLClient } from '../src/entrypoints/main.js'
+import { gql, GraphQLClient } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
 
diff --git a/examples/legacy/configuration-incremental-endpoint.ts b/examples/legacy/configuration-incremental-endpoint.ts
@@ -2,7 +2,7 @@
  * If you want to change the endpoint after the GraphQLClient has been initialized, you can use the `setEndpoint()` function.
  */
 
-import { GraphQLClient } from '../src/entrypoints/main.js'
+import { GraphQLClient } from '../../src/entrypoints/main.js'
 
 const client = new GraphQLClient(`https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`)
 
diff --git a/examples/legacy/configuration-incremental-request-headers.ts b/examples/legacy/configuration-incremental-request-headers.ts
@@ -2,7 +2,7 @@
  * If you want to set headers after the GraphQLClient has been initialized, you can use the `setHeader()` or `setHeaders()` functions.
  */
 
-import { GraphQLClient } from '../src/entrypoints/main.js'
+import { GraphQLClient } from '../../src/entrypoints/main.js'
 
 const client = new GraphQLClient(`https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`)
 
diff --git a/examples/legacy/configuration-request-json-serializer.ts b/examples/legacy/configuration-request-json-serializer.ts
@@ -4,7 +4,7 @@
  */
 
 import JSONbig from 'json-bigint'
-import { gql, GraphQLClient } from '../src/entrypoints/main.js'
+import { gql, GraphQLClient } from '../../src/entrypoints/main.js'
 
 const jsonSerializer = JSONbig({ useNativeBigInt: true })
 const graphQLClient = new GraphQLClient(`https://some-api`, { jsonSerializer })
diff --git a/examples/legacy/graphql-batching-requests.ts b/examples/legacy/graphql-batching-requests.ts
@@ -2,7 +2,7 @@
  * It is possible with `graphql-request` to use batching via the `batchRequests()` function.
  * @see https://github.com/graphql/graphql-over-http/blob/main/rfcs/Batching.md
  */
-import { batchRequests, gql } from '../src/entrypoints/main.js'
+import { batchRequests, gql } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.spacex.land/graphql/`
 
diff --git a/examples/legacy/graphql-document-variables.ts b/examples/legacy/graphql-document-variables.ts
@@ -1,4 +1,4 @@
-import { gql, request } from '../src/entrypoints/main.js'
+import { gql, request } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
 
diff --git a/examples/legacy/graphql-mutations.ts b/examples/legacy/graphql-mutations.ts
@@ -1,4 +1,4 @@
-import { gql, GraphQLClient } from '../src/entrypoints/main.js'
+import { gql, GraphQLClient } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
 
diff --git a/examples/legacy/other-error-handling.ts b/examples/legacy/other-error-handling.ts
@@ -1,4 +1,4 @@
-import { gql, request } from '../src/entrypoints/main.js'
+import { gql, request } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
 
diff --git a/examples/legacy/other-middleware.ts b/examples/legacy/other-middleware.ts
@@ -2,8 +2,8 @@
  * It's possible to use a middleware to pre-process any request or handle raw response.
  */
 
-import type { RequestMiddleware, ResponseMiddleware } from '../src/entrypoints/main.js'
-import { GraphQLClient } from '../src/entrypoints/main.js'
+import type { RequestMiddleware, ResponseMiddleware } from '../../src/entrypoints/main.js'
+import { GraphQLClient } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.spacex.land/graphql/`
 
diff --git a/examples/legacy/request-authentication-via-http-header.ts b/examples/legacy/request-authentication-via-http-header.ts
@@ -1,4 +1,4 @@
-import { gql, GraphQLClient } from '../src/entrypoints/main.js'
+import { gql, GraphQLClient } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
 
diff --git a/examples/legacy/request-cancellation.ts b/examples/legacy/request-cancellation.ts
@@ -2,7 +2,7 @@
  * It is possible to cancel a request using an `AbortController` signal.
  */
 
-import { gql, GraphQLClient } from '../src/entrypoints/main.js'
+import { gql, GraphQLClient } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
 
diff --git a/examples/legacy/request-handle-raw-response.ts b/examples/legacy/request-handle-raw-response.ts
@@ -3,7 +3,7 @@
  * If you need to access the `extensions` key you can use the `rawRequest` method:
  */
 
-import { gql, rawRequest } from '../src/entrypoints/main.js'
+import { gql, rawRequest } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
 
diff --git a/examples/legacy/request-headers-dynamic-per-request.ts b/examples/legacy/request-headers-dynamic-per-request.ts
@@ -3,7 +3,7 @@
  * To do that, pass a function that returns the headers to the `headers` property when creating a new `GraphQLClient`.
  */
 
-import { gql, GraphQLClient } from '../src/entrypoints/main.js'
+import { gql, GraphQLClient } from '../../src/entrypoints/main.js'
 
 const client = new GraphQLClient(`https://some-api`, {
   headers: () => ({ 'X-Sent-At-Time': Date.now().toString() }),
diff --git a/examples/legacy/request-headers-static-per-request.ts b/examples/legacy/request-headers-static-per-request.ts
@@ -2,7 +2,7 @@
  * It is possible to pass custom headers for each request. `request()` and `rawRequest()` accept a header object as the third parameter
  */
 
-import { gql, GraphQLClient } from '../src/entrypoints/main.js'
+import { gql, GraphQLClient } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
 
diff --git a/examples/legacy/request-method-get.ts b/examples/legacy/request-method-get.ts
@@ -1,7 +1,7 @@
 /**
  * Queries can be sent as an HTTP GET request:
  */
-import { gql, GraphQLClient } from '../src/entrypoints/main.js'
+import { gql, GraphQLClient } from '../../src/entrypoints/main.js'
 
 const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
 
diff --git a/examples/legacy/schema.graphql b/examples/legacy/schema.graphql
diff --git a/examples/legacy/typescript-typed-document-node.ts b/examples/legacy/typescript-typed-document-node.ts
@@ -1,6 +1,6 @@
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core'
 import { parse } from 'graphql'
-import { gql, GraphQLClient, request } from '../src/entrypoints/main.js'
+import { gql, GraphQLClient, request } from '../../src/entrypoints/main.js'
 
 {
   const endpoint = `https://graphql-yoga.com/api/graphql`
diff --git a/src/entrypoints/alpha/main.ts b/src/entrypoints/alpha/main.ts
@@ -1,3 +1,4 @@
 export { execute } from '../../layers/0_functions/execute.js'
 export { request } from '../../layers/0_functions/request.js'
+export { gql } from '../../legacy/functions/gql.js'
 export * from './__Graffle.js'
diff --git a/src/layers/0_functions/requestOrExecute.ts b/src/layers/0_functions/requestOrExecute.ts
diff --git a/src/layers/5_core/core.ts b/src/layers/5_core/core.ts
@@ -28,25 +28,25 @@ const getRootIndexOrThrow = (context: ContextInterfaceTyped, rootTypeName: strin
 }
 
 // eslint-disable-next-line
-type InterfaceInput<A = {}, B = {}> =
+type InterfaceInput<TypedProperties = {}, RawProperties = {}> =
   | ({
     interface: InterfaceTyped
     context: ContextInterfaceTyped
     rootTypeName: Schema.RootTypeName
-  } & A)
+  } & TypedProperties)
   | ({
     interface: InterfaceRaw
     context: ContextInterfaceRaw
-  } & B)
+  } & RawProperties)
 
 // eslint-disable-next-line
-type TransportInput<A = {}, B = {}> =
+type TransportInput<HttpProperties = {}, MemoryProperties = {}> =
   | ({
     transport: TransportHttp
-  } & A)
+  } & HttpProperties)
   | ({
     transport: TransportMemory
-  } & B)
+  } & MemoryProperties)
 
 export const hookNamesOrderedBySequence = [`encode`, `pack`, `exchange`, `unpack`, `decode`] as const
 
@@ -56,7 +56,7 @@ export type HookDefEncode = {
   input:
     & InterfaceInput<
       { selection: GraphQLObjectSelection },
-      { document: string | DocumentNode; variables?: StandardScalarVariables }
+      { document: string | DocumentNode; variables?: StandardScalarVariables; operationName?: string }
     >
     & TransportInput<{ schema: string | URL }, { schema: GraphQLSchema }>
   slots: {
@@ -163,6 +163,7 @@ export const anyware = Anyware.create<HookSequence, HookMap, ExecutionResult>({
       run: ({ input, slots }) => {
         let document: string
         let variables: StandardScalarVariables | undefined = undefined
+        let operationName: string | undefined = undefined
 
         switch (input.interface) {
           case `raw`: {
@@ -171,6 +172,7 @@ export const anyware = Anyware.create<HookSequence, HookMap, ExecutionResult>({
               : print(input.document)
             document = documentPrinted
             variables = input.variables
+            operationName = input.operationName
             break
           }
           case `typed`: {
@@ -192,7 +194,7 @@ export const anyware = Anyware.create<HookSequence, HookMap, ExecutionResult>({
             const body = slots.body({
               query: document,
               variables,
-              operationName: `todo`,
+              operationName,
             })
 
             return {
@@ -207,7 +209,7 @@ export const anyware = Anyware.create<HookSequence, HookMap, ExecutionResult>({
               schema: input.schema,
               query: document,
               variables,
-              // operationName: '',
+              operationName,
             }
           }
         }
diff --git a/src/layers/6_client/client.raw.test.ts b/src/layers/6_client/client.raw.test.ts
@@ -1,6 +1,8 @@
-import { expect, test } from 'vitest'
+import { beforeEach, describe, expect } from 'vitest'
+import { test } from '../../../tests/_/helpers.js'
 import { Graffle } from '../../../tests/_/schema/generated/__.js'
 import { schema } from '../../../tests/_/schema/schema.js'
+import { createExtension } from '../5_createExtension/createExtension.js'
 
 // todo test with custom scalars
 
@@ -21,3 +23,31 @@ test(`.raw() returns errors in array`, async () => {
     }
   `)
 })
+
+describe(`memory transport`, () => {
+  let input: object | undefined
+  const peakInput = createExtension({
+    name: `peak`,
+    anyware: ({ exchange }) => {
+      if (exchange.input.transport === `memory`) {
+        input = exchange.input
+      }
+      return exchange()
+    },
+  })
+  beforeEach(() => {
+    input = undefined
+  })
+  describe(`operationName`, () => {
+    test(`undefined by default`, async () => {
+      await graffle.use(peakInput).raw(`query { id }`)
+      expect(input).toMatchObject({ operationName: undefined })
+    })
+    test(`reflects explicit value`, async () => {
+      await graffle.use(peakInput).raw(`query { id }`, { operationName: `foo` })
+      expect(input).toMatchObject({ operationName: `foo` })
+    })
+  })
+})
+
+// todo http transport
diff --git a/src/layers/6_client/client.test.ts b/src/layers/6_client/client.test.ts
@@ -19,8 +19,8 @@ describe(`without schemaIndex only raw is available`, () => {
   })
 
   test(`available methods`, () => {
-    expect(graffle.raw).toBeTypeOf(`function`)
-    expect(graffle.rawOrThrow).toBeTypeOf(`function`)
+    expect(graffle.raw).toBeTypeOf(`function`) // eslint-disable-line
+    expect(graffle.rawOrThrow).toBeTypeOf(`function`) // eslint-disable-line
   })
 })
 
diff --git a/src/layers/6_client/client.ts b/src/layers/6_client/client.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { gql, GraphQLClient } from '../src/entrypoints/main.js'`
	`1`	`+import { gql, GraphQLClient } from '../../src/entrypoints/main.js'`
`2`	`2`
`3`	`3`	const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { gql, request } from '../src/entrypoints/main.js'`
	`1`	`+import { gql, request } from '../../src/entrypoints/main.js'`
`2`	`2`
`3`	`3`	const endpoint = `https://api.graph.cool/simple/v1/cixos23120m0n0173veiiwrjr`
`4`	`4`