rename type mapping to gqlScalarsToPursTypes for clarity #48

Author: roryc89

codegen/schema/README.md

@@ -11,7 +11,7 @@ Argument for generateSchema
 -- | 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
-, gqlToPursTypes :: Nullable (Object String) 
+, gqlScalarsToPursTypes :: Nullable (Object String) 
 -- | Extra imports for the generated enums
 , enumImports :: Nullable (Array String) 
 -- | Custom code to add to the generated enums
@@ -69,7 +69,7 @@ Argument for generateSchema
 -- | 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
-, gqlToPursTypes :: Nullable (Object String) 
+, 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/generate-purs-schema.js

@@ -8,7 +8,7 @@ module.exports = () =>
     modulePath: ['Generated', 'Gql', 'Admin'],
     useNewtypesForRecords: false,
     url: 'http://localhost:4000/graphql',
-    gqlToPursTypes: {
+    gqlScalarsToPursTypes: {
       GqlTypeThatIsAString: 'String',
       GqlTypeThatIsAnInt: 'Int'
     }

gen-schema-bundled.js

@@ -27,7 +27,7 @@ schemasFromGqlToPursJs = mkFn2 go
     opts =
       { externalTypes: Map.fromFoldableWithIndex (fromNullable mempty optsJs.externalTypes)
       , fieldTypeOverrides: Map.fromFoldableWithIndex <$> Map.fromFoldableWithIndex (fromNullable mempty optsJs.fieldTypeOverrides)
-      , gqlToPursTypes: Map.fromFoldableWithIndex (fromNullable mempty optsJs.gqlToPursTypes)
+      , gqlScalarsToPursTypes: Map.fromFoldableWithIndex (fromNullable mempty optsJs.gqlScalarsToPursTypes)
       , dir: fromNullable "" optsJs.dir
       , modulePath: fromNullable [] optsJs.modulePath
       , isHasura: fromNullable false optsJs.isHasura
@@ -53,7 +53,7 @@ fromNullable :: forall a. a -> Nullable a -> a
 fromNullable a = fromMaybe a <<< toMaybe
 
 type InputOptionsJs
-  = { gqlToPursTypes :: Nullable (Object String)
+  = { gqlScalarsToPursTypes :: Nullable (Object String)
     , externalTypes ::
         Nullable
           ( Object

src/GraphQL/Client/CodeGen/Js.purs

@@ -117,7 +117,7 @@ schemaFromGqlToPurs opts { schema, moduleName } =
           symbols = Array.fromFoldable $ getSymbols ast
         in
           { mainSchemaCode: gqlToPursMainSchemaCode opts ast
-          , enums: gqlToPursEnums opts.gqlToPursTypes ast
+          , enums: gqlToPursEnums opts.gqlScalarsToPursTypes ast
           , symbols
           , moduleName
           }
@@ -141,7 +141,7 @@ toImport mainCode =
     )
 
 gqlToPursMainSchemaCode :: InputOptions -> AST.Document -> String
-gqlToPursMainSchemaCode { gqlToPursTypes, externalTypes, fieldTypeOverrides, useNewtypesForRecords } doc =
+gqlToPursMainSchemaCode { gqlScalarsToPursTypes, externalTypes, fieldTypeOverrides, useNewtypesForRecords } doc =
   imports
     <> guard (imports /= "") "\n"
     <> "\n"
@@ -407,12 +407,12 @@ gqlToPursMainSchemaCode { gqlToPursTypes, externalTypes, fieldTypeOverrides, use
 
   wrapArray s = "(Array " <> s <> ")"
 
-  typeName_ = typeName gqlToPursTypes
+  typeName_ = typeName gqlScalarsToPursTypes
 
-  namedTypeToPurs_ = namedTypeToPurs gqlToPursTypes
+  namedTypeToPurs_ = namedTypeToPurs gqlScalarsToPursTypes
 
 gqlToPursEnums :: Map String String -> AST.Document -> Array GqlEnum
-gqlToPursEnums gqlToPursTypes = unwrap >>> mapMaybe definitionToEnum >>> Array.fromFoldable
+gqlToPursEnums gqlScalarsToPursTypes = unwrap >>> mapMaybe definitionToEnum >>> Array.fromFoldable
   where
   definitionToEnum :: AST.Definition -> Maybe GqlEnum
   definitionToEnum = case _ of
@@ -440,17 +440,17 @@ gqlToPursEnums gqlToPursTypes = unwrap >>> mapMaybe definitionToEnum >>> Array.f
       <#> \(AST.EnumValueDefinition { enumValue }) ->
           unwrap enumValue
 
-  typeName_ = typeName gqlToPursTypes
+  typeName_ = typeName gqlScalarsToPursTypes
 
 namedTypeToPurs :: Map String String -> AST.NamedType -> String
-namedTypeToPurs gqlToPursTypes (AST.NamedType str) = typeName gqlToPursTypes str
+namedTypeToPurs gqlScalarsToPursTypes (AST.NamedType str) = typeName gqlScalarsToPursTypes str
 
 inlineComment :: Maybe String -> String
 inlineComment = foldMap (\str -> "\n{- " <> str <> " -}\n")
 
 typeName :: Map String String -> String -> String
-typeName gqlToPursTypes str =
-  lookup str gqlToPursTypes
+typeName gqlScalarsToPursTypes str =
+  lookup str gqlScalarsToPursTypes
     # fromMaybe' \_ -> case pascalCase str of
         "Id" -> "ID"
         "Float" -> "Number"

src/GraphQL/Client/CodeGen/Schema.purs

@@ -20,7 +20,7 @@ import Effect (Effect)
 import Effect.Aff (Aff)
 
 type InputOptions
-  = { gqlToPursTypes :: Map String String
+  = { gqlScalarsToPursTypes :: Map String String
     , externalTypes ::
         Map String
           { moduleName :: String
@@ -54,7 +54,7 @@ type InputOptions
 defaultInputOptions :: InputOptions
 defaultInputOptions =
   { externalTypes: Map.empty
-  , gqlToPursTypes: Map.empty
+  , gqlScalarsToPursTypes: Map.empty
   , fieldTypeOverrides: Map.empty
   , idImport: Nothing
   , dir: ""

src/GraphQL/Client/CodeGen/Types.purs

@@ -247,7 +247,7 @@ instance argToGqlQuery :: (Newtype Query {| p},  RecordArg p a u) => ArgGql Quer
           ` ( shouldParseToOpts
               { dir: ""
               , cache: Nothing
-              , gqlToPursTypes: Map.empty
+              , gqlScalarsToPursTypes: Map.empty
               , useNewtypesForRecords: true
               , isHasura: false
               , modulePath: []
@@ -357,7 +357,7 @@ instance argToGqlX :: (Newtype X {| p},  RecordArg p a u) => ArgGql X { | a }"""
     shouldParseToOpts
       { dir: ""
       , cache: Nothing
-      , gqlToPursTypes: Map.empty
+      , gqlScalarsToPursTypes: Map.empty
       , useNewtypesForRecords: true
       , isHasura: false
       , modulePath: []
@@ -372,7 +372,7 @@ instance argToGqlX :: (Newtype X {| p},  RecordArg p a u) => ArgGql X { | a }"""
     schemaFromGqlToPurs
       { dir: ""
       , cache: Nothing
-      , gqlToPursTypes: Map.empty
+      , gqlScalarsToPursTypes: Map.empty
       , useNewtypesForRecords: true
       , isHasura: false
       , modulePath: []