feat: better raw (#1165)

Author: jasonkuhrt

examples/10_transport-http/transport-http_abort.ts

@@ -15,15 +15,14 @@ const graffle = Graffle.create({
 const resultPromise = graffle
   .with({ transport: { signal: abortController.signal } })
   //                           ^^^^^^^^^^^^^^^
-  .rawString({
-    document: `
-      {
-        pokemon {
-          name
-        }
+  .gql`
+    {
+      pokemon {
+        name
       }
-    `,
-  })
+    }
+  `
+  .send()
 
 abortController.abort()
 //              ^^^^^

examples/10_transport-http/transport-http_extension_fetch__custom-fetch.ts

@@ -19,6 +19,6 @@ const graffle = Graffle
     })
   )
 
-const data = await graffle.rawString({ document: `{ pokemon { name } }` })
+const data = await graffle.gql`{ pokemon { name } }`.send()
 
 showJson(data)

examples/10_transport-http/transport-http_extension_headers__dynamicHeaders.ts

@@ -25,4 +25,4 @@ const graffle = Graffle
     return exchange()
   })
 
-await graffle.rawString({ document: `{ pokemons { name } }` })
+await graffle.gql`{ pokemons { name } }`.send()

examples/10_transport-http/transport-http_headers_raw__headers.ts

@@ -29,4 +29,4 @@ const graffle = Graffle
     return exchange()
   })
 
-await graffle.rawString({ document: `{ pokemons { name } }` })
+await graffle.gql`{ pokemons { name } }`.send()

examples/10_transport-http/transport-http_method-get.ts

@@ -20,10 +20,8 @@ const graffle = Pokemon
 
 // The following request will use an HTTP POST method because it is
 // using a "mutation" type of operation.
-await graffle.rawString({
-  document: `mutation { addPokemon(attack:0, defense:0, hp:1, name:"Nano", type: grass) { name } }`,
-})
+await graffle.gql`mutation { addPokemon(attack:0, defense:0, hp:1, name:"Nano", type: grass) { name } }`.send()
 
 // The following request will use an HTTP GET method because it
 // is using a "query" type of operation.
-await graffle.rawString({ document: `query { pokemonByName(name: "Nano") { hp } }` })
+await graffle.gql`query { pokemonByName(name: "Nano") { hp } }`.send()

examples/10_transport-http/transport-http_raw.ts

@@ -20,4 +20,4 @@ const graffle = Graffle
     return exchange()
   })
 
-await graffle.rawString({ document: `{ pokemons { name } }` })
+await graffle.gql`{ pokemons { name } }`.send()

examples/20_output/output_preset__standard-graphql.ts

@@ -10,6 +10,6 @@ const graffle = Graffle.create({
   output: Preset.traditionalGraphqlOutput,
 })
 
-const result = await graffle.rawString({ document: `{ query { thisWillError } }` })
+const result = await graffle.gql(`{ query { thisWillError } }`).send()
 
 show(result)

examples/30_raw/raw_rawDocumentNode__raw-document-node.ts renamed to examples/30_gql/gql_gql-document-node.ts

@@ -2,8 +2,9 @@
  * This example shows how to send a request using a Document instance for the GraphQL document.
  */
 
+import { parse } from 'graphql'
 import { Opentelemetry, Throws } from '../../src/entrypoints/extensions.js'
-import { gql, Graffle } from '../../src/entrypoints/main.js'
+import { Graffle } from '../../src/entrypoints/main.js'
 import { publicGraphQLSchemaEndpoints, show } from '../$/helpers.js'
 
 const graffle = Graffle.create({
@@ -12,18 +13,15 @@ const graffle = Graffle.create({
   .use(Throws())
   .use(Opentelemetry())
 
-const data = await graffle.raw({
-  document: gql`
-    query pokemonByName ($Name: String!) {
-      pokemonByName (name: $Name) {
+const data = await graffle.gql(parse(`
+  query pokemonByName ($name: String!) {
+    pokemonByName (name: $name) {
+      name
+      trainer {
         name
-        continent {
-          name
-        }
       }
     }
-  `,
-  variables: { name: `Pikachu` },
-})
+  }
+`)).send({ name: `Pikachu` })
 
 show(data)

examples/30_gql/gql_gql-document-node_gql-typed_gql-document-node-typed__gql-document-node-typed.ts

@@ -0,0 +1,44 @@
+/**
+ * This example shows how to use the TypeScript type "TypedQueryDocumentNode" from the
+ * package `graphql` to make a type safe request with gql method.
+ */
+
+import { parse, type TypedQueryDocumentNode } from 'graphql'
+import { Graffle } from '../../src/entrypoints/main.js'
+import { publicGraphQLSchemaEndpoints, show } from '../$/helpers.js'
+
+const graffle = Graffle.create({
+  schema: publicGraphQLSchemaEndpoints.Pokemon,
+})
+
+type Document = TypedQueryDocumentNode<
+  {
+    pokemonByName: {
+      id: string
+      name: string
+      hp: number
+      attack: number
+      defense: number
+      trainer: { name: string }
+    }
+  },
+  { name: string }
+>
+
+const document = parse(`
+    query ($name: String!) {
+      pokemonByName (name: $name) {
+        name
+        hp
+        attack
+        defense
+        trainer {
+          name
+        }
+      }
+    }
+  `) as Document
+
+const data = await graffle.gql(document).send({ name: `Pikachu` })
+
+show(data?.pokemonByName)

examples/30_raw/raw_rawString__rawString.ts renamed to examples/30_gql/gql_gql-string.ts

@@ -17,6 +17,6 @@ const document = /* gql */ `
   }	
 `
 
-const data = await graffle.rawString({ document })
+const data = await graffle.gql(document).send()
 
 show(data)