Merge pull request #50 from OxfordAbstracts/allow-custom-type-mappings

Allow custom type mappings #48 #49

Author: roryc89

codegen/schema/README.md

@@ -10,6 +10,8 @@ Argument for generateSchema
 , modulePath :: Nullable (Array String) 
 -- | Whether the schema should use newtypes. Necessary for circular/recursive schemas
 , useNewtypesForRecords :: Nullable Boolean 
+-- | How to map graphQL types to Purescript types. The keys are graphql types and the values are purescript types you want them to be decoded as. Reasonable defaults are provided if you don't specify
+, gqlScalarsToPursTypes :: Nullable (Object String) 
 -- | Extra imports for the generated enums
 , enumImports :: Nullable (Array String) 
 -- | Custom code to add to the generated enums
@@ -66,6 +68,8 @@ Argument for generateSchema
 , modulePath :: Nullable (Array String) 
 -- | Whether the schema should use newtypes. Necessary for circular/recursive schemas
 , useNewtypesForRecords :: Nullable Boolean 
+-- | How to map graphQL types to Purescript types. The keys are graphql types and the values are purescript types you want them to be decoded as. Reasonable defaults are provided if you don't specify
+, gqlScalarsToPursTypes :: Nullable (Object String) 
 -- | Extra imports for the generated enums
 , enumImports :: Nullable (Array String) 
 -- | Custom code to add to the generated enums

examples/8-custom-gql-types/.gitignore

@@ -0,0 +1,11 @@
+/bower_components/
+/node_modules/
+/.pulp-cache/
+/output/
+/generated-docs/
+/.psc-package/
+/.psc*
+/.purs*
+/.psa*
+/.spago
+/src/generated

examples/8-custom-gql-types/README.md

@@ -0,0 +1,4 @@
+A codegen example using custom graphQL types. Look in `generate-purs-schema.js` to 
+see how types are mapped from graphQL to purescript. 
+
+Run `npm t` to see it in action

examples/8-custom-gql-types/generate-purs-schema.js

@@ -0,0 +1,15 @@
+// In your code replace this line with the npm package:
+// const { generateSchema } = require('purescript-graphql-client')
+const { generateSchema } = require('../../codegen/schema')
+
+module.exports = () =>
+  generateSchema({
+    dir: './src/generated',
+    modulePath: ['Generated', 'Gql', 'Admin'],
+    useNewtypesForRecords: false,
+    url: 'http://localhost:4000/graphql',
+    gqlScalarsToPursTypes: {
+      GqlTypeThatIsAString: 'String',
+      GqlTypeThatIsAnInt: 'Int'
+    }
+  })