Merge branch 'main' of https://github.com/OxfordAbstracts/purescript-graphql-client into remove-ArgGql-from-genned-schema-#102

Author: roryc89

Diff for: .DS_Store

@@ -41,7 +41,7 @@ main =
 -- Run gql query
 queryGql ::
   forall query returns.
-  GqlQuery Schema query returns =>
+  GqlQuery Nil' OpQuery Schema query returns =>
   DecodeJson returns =>
   String -> query -> Aff returns
 queryGql = query_ "http://localhost:4000/graphql" (Proxy :: Proxy Schema) 
@@ -182,9 +182,11 @@ import MySchema (Query, Mutation)
 import GraphQL.Client.BaseClients.Apollo (createClient)
 import GraphQL.Client.Query (query)
 import GraphQL.Client.Types (Client)
+import Type.Data.List (Nil')
+
 ...
 
-    client  :: Client _ Query Mutation Void <- createClient
+    client  :: Client _ Nil' Query Mutation Void <- createClient
       { url: "http://localhost:4000/graphql"
       , authToken: Nothing
       , headers: []
@@ -209,9 +211,11 @@ import MySchema (Query, Subscription, Mutation)
 import GraphQL.Client.BaseClients.Apollo (createSubscriptionClient)
 import GraphQL.Client.Subscription (subscription)
 import GraphQL.Client.Types (Client)
+import Type.Data.List (Nil')
+
 ...
 
-  client :: Client _ Query Mutation Subscription <-
+  client :: Client _ Nil' Query Mutation Subscription <-
     createSubscriptionClient
       { url: "http://localhost:4000/graphql"
       , authToken: Nothing
@@ -411,6 +415,13 @@ This type class specifies their graphql type.
 
 There is a full example in the examples directory.
 
+### Directives
+
+Only top level directives, that have a query, mutation or subscription location are currently supported. 
+
+Please look in the example/12-directives to see an example of this.
+
+
 ### Full responses 
 
 If you wish to get the full response, as per the [GraphQL Spec](https://spec.graphql.org/June2018/#sec-Response) use the "FullRes" versions of the query functions
@@ -421,6 +432,16 @@ If you wish to get the full response, as per the [GraphQL Spec](https://spec.gra
 
 These will include all errors and extensions in the response, even if a response of the correct type has been returned. 
 
+### Full responses as Json
+
+If you wish to get the full response as json use the "Json" versions of the query functions
+
+- `queryJson`
+- `mutationJson`
+- `subscriptionJson`
+
+These will return the raw json returned by the server inside a newtype `GqlResJson` with phanton types for the schema, query and response. These can be useful for creating your own abstractions using that require the unchanged json response.
+
 ### Apollo only features 
 
 With apollo you can make type checked cache updates. To see examples of this look at `examples/6-watch-query` and `examples/7-watch-query-optimistic`. You can also set many options for queries, mutations and subscriptions using , `queryOpts` , `mutationOpts`, `subscriptionOpts` respectively.

Diff for: README.md

@@ -1,8 +1,6 @@
 import fetch from 'node-fetch';
 import {
   getIntrospectionQuery,
-  printSchema,
-  buildClientSchema
 } from 'graphql';
 
 export async function getGqlSchema ({ moduleName, cache, url, token }) {
@@ -26,9 +24,11 @@ export async function getGqlSchema ({ moduleName, cache, url, token }) {
       }
     )
 
-    const { data } = await response.json()
-
-    const schema = printSchema(buildClientSchema(data))
+    const { data: schema, errors } = await response.json()
+    
+    if (errors) {
+      throw new Error(errors)
+    }
 
     return { moduleName, cache, schema }
   } catch (err) {

Diff for: codegen/schema/get-gql-schema.mjs

@@ -12,6 +12,8 @@ export async function generateSchemas  (opts, gqlEndpoints) {
   await rm(opts.dir)
   await mkdirp(opts.dir)
   await mkdirp(opts.dir + '/Schema')
+  await mkdirp(opts.dir + '/Enum')
+  await mkdirp(opts.dir + '/Directives')
   const schemas = await Promise.all(gqlEndpoints.map(getGqlSchema))
 
   return await writePursSchemas(opts, schemas)
@@ -22,4 +24,4 @@ export async function generateSchema (opts) {
   const moduleName = modulePath[modulePath.length - 1]
 
   return generateSchemas({ ...opts, modulePath: modulePath.slice(0, -1) }, [{ moduleName, url }])
-}
+}

Diff for: codegen/schema/index.mjs

@@ -23,9 +23,9 @@ export async function writePursSchemas (opts, gqlSchemas) {
     throw new Error(parseError)
   }
 
-  const { schemas, enums, symbols } = result
+  const { schemas, enums, directives, symbols } = result
 
-  await Promise.all([...schemas, ...enums, symbols].map(({ path, code }) => writeFileRec(path, code)))
+  await Promise.all([...schemas, ...enums, ...directives, symbols].map(({ path, code }) => writeFileRec(path, code)))
 
   return result
 }

Diff for: codegen/schema/write-purs-schema.mjs

@@ -16,6 +16,7 @@
     "express": "^4.17.1",
     "express-graphql": "^0.12.0",
     "graphql": "^15.4.0",
+    "isomorphic-ws": "^5.0.0",
     "xhr2": "^0.2.0"
   }
 }

Diff for: e2e/1-affjax/package-lock.json

@@ -8,9 +8,11 @@ import Effect (Effect)
 import Effect.Aff (Aff, launchAff_)
 import Effect.Class.Console (logShow)
 import GraphQL.Client.Args ((=>>))
+import GraphQL.Client.Operation (OpQuery)
 import GraphQL.Client.BaseClients.Affjax.Node (AffjaxNodeClient(..))
 import GraphQL.Client.Query (query, queryFullRes)
 import GraphQL.Client.Types (class GqlQuery, Client(..))
+import Type.Data.List (Nil')
 import Type.Proxy (Proxy(..))
 
 main :: Effect Unit
@@ -31,13 +33,13 @@ main =
 -- Run gql query
 queryGql ::
   forall query returns.
-  GqlQuery Schema query returns =>
+  GqlQuery Nil' OpQuery Schema query returns =>
   DecodeJson returns =>
   String -> query -> Aff returns
-queryGql = query client 
+queryGql = query client
 
-client :: Client AffjaxNodeClient Schema Void Void
-client = (Client $ AffjaxNodeClient "http://localhost:4000/graphql" []) 
+client :: Client AffjaxNodeClient Nil' Schema Void Void
+client = (Client $ AffjaxNodeClient "http://localhost:4000/graphql" [])
 
 -- Schema
 type Schema
@@ -50,9 +52,9 @@ type Widget
     , id :: Int
     }
 
--- Symbols 
+-- Symbols
 prop :: Proxy "prop"
 prop = Proxy
 
 name :: Proxy "name"
-name = Proxy
+name = Proxy

Diff for: e2e/1-affjax/package.json

@@ -18,6 +18,7 @@
     "express": "4.17.1",
     "express-graphql": "0.12.0",
     "graphql": "15.4.0",
+    "isomorphic-ws": "^5.0.0",
     "mkdirp": "1.0.4",
     "rimraf": "3.0.2",
     "xhr2": "0.2.0"

Diff for: e2e/1-affjax/src/Main.purs

@@ -11,8 +11,10 @@ import Generated.Gql.Schema.Admin (Query)
 import Generated.Gql.Schema.Admin.Enum.Colour (Colour(..))
 import Generated.Gql.Symbols (colour)
 import GraphQL.Client.Args ((=>>))
+import GraphQL.Client.Operation (OpQuery)
 import GraphQL.Client.Query (query_)
 import GraphQL.Client.Types (class GqlQuery)
+import Type.Data.List (Nil')
 import GraphQL.Client.Union (GqlUnion(..))
 import Type.Proxy (Proxy(..))
 
@@ -22,14 +24,14 @@ main =
     { widgets } <-
       queryGql "WidgetColoursWithId1"
         { widgets: { colour: RED } =>> { colour } }
-        
+
     -- Will log [ RED ] as there is one red widget
     logShow $ map _.colour widgets
 
 -- Run gql query
 queryGql ::
   forall query returns.
-  GqlQuery Query query returns =>
+  GqlQuery Nil' OpQuery Query query returns =>
   DecodeJson returns =>
   String -> query -> Aff returns
 queryGql = query_ "http://localhost:4000/graphql" (Proxy :: Proxy Query)