victorgarciaesgi / simple-graphql-to-typescript Goto Github PK

Hi :D

So one last thing: What's the thing about sgtsQL, because I can't find anything about it in the docs.
Since I also use the generated types in some backend-related code, I get ReferenceError: sgtsQL is not defined because there is no import for that function in the generated types file.

Is there some way to omit fragement generation?

First things first: this project looks amazing and I am super excited to use it!

I have a question though and was hoping you could provide some clarification. It looks like the wrong type is being passed into the useQuery call. If right now I have a User model in my graphql schema the code generated will be

useQuery<UseQueryOptions<{ users: User[] }, usersArgs>>(query, variables, options);

But according to the code generated by the react-hooks generator and from what I can tell from the vue-apollo documentation it should be

useQuery<{ users: User[] }, usersArgs>(query, variables, options);

This means that if I try to use the useUsers hook the returned result has the wrong type but the correct contents.

Thanks,
Carter

Will get stuck after it fails to load the (missing) .prettierrc:

sgts -e http://localhost:3000/graphql -o api.ts -G -A
Running Prettier with your config on the generated output
Error: Cannot find module '../../.prettierrc'

First of all, thank you for this great tool! It addresses and solves the exact problems which have prevented me from using other graphql code generators. Great work!

Are there any plans to support union types? Running sgts on my GraphQL endpoint exposing one union type ends in a not-compilable ts file because the type definition for the union type is missing.

GraphQL Schema:

type FileUpload {
  container: String!
  blob: String!
  fileExtension: String!
  originalFilename: String!
  hash: String!
  accessUrl: String!
}

union FileSource = FileUpload // more to come in the near future

The resulting ts file holds an interface for FileUpload and also uses the FileSource type for properties where it's referenced in the GraphQL schema, but there is no type definition for the FileSource type.

Hi Victor, it seems like the --customScalars option didn't work correctly. I've been running sgts like

sgts --endpoint http://localhost:8080/graphql --output src/javascripts/shared/model/generated.ts --suffix Model --customScalars [{ "ObjectIdType": "ObjectIdType" }]

Finally in the output file I have found that all fields with ObjectIdType treats as undefined.

Hi, it's me again, still enjoying your library :)

I just stumbled upon the following thing:
For fields in the graphql schema which are marked as nullable, it generates the interface properties in the following way: someField?: Maybe<string>
Thus, the property value can be either a string, undefined, or null. But from my understanding, graphql doesn't know undefined, just null. So if I query a field which value is not set, I receive null.
The only scenario where an optional interface property would make sense are types which are used in mutation or query arguments, because there an optional field can be omitted.

So in the end, this results in the following questions:

1. Is there any reasoning or necessary to mark nullable fields also as optional in typescript?
2. Would it be possible to distinguish between types used as arguments and types which are returned by queries/mutations?
3. Would it be possible (maybe via a cli flag) to omit the "optional", or would this break too much code on your side which rely on these optional properties?