https://github.com/mattphillips/io-ts-graphql-codegen
https://github.com/mattphillips/io-ts-graphql-codegen
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mattphillips/io-ts-graphql-codegen
- Owner: mattphillips
- Created: 2021-06-09T15:10:44.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-09T15:20:26.000Z (about 4 years ago)
- Last Synced: 2025-01-29T09:44:59.593Z (5 months ago)
- Language: TypeScript
- Size: 59.6 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# io-ts-graphql-codegen
This plugin for [graphql code generator](https://graphql-code-generator.com) generates types and runtime codecs for a given GraphQL Schema using [io-ts](https://github.com/gcanti/io-ts) to give runtime type safety.
### Missing features:
- Custom codecs for custom Scalars
- Name aliases
- `FragmentSpread` selections
- `subscription` operation types
### Assumptions
- At least one Mutation will be present
- At least one Query will be present
- `__typename` will be generated on all types and selections automatically
### Architecture
The general flow to generate the types is as follows:
1. Parse the schema into an AST
2. Filter to Type Definitions and run topological sort on it so that dependant types appear first (this is crucial to printing the codecs in the correct order).
3. Convert sorted graph to an io-ts AST representation.
4. Build io-ts representation of all selections backing the selections with the above io-ts AST.
5. Build io-ts representation of selection variables again backed with the above io-ts AST.
6. Print all helpers to perform nested selections on codecs.
7. Pretty print all io-ts ASTs.
### Limitations
- `io-ts`'s Intersection type is bound to a minimum of 2 codecs and a maximum of 5. When performing selections and merging them with intersection types these bounds need to be honored. Currently this plugin only supports the merging of 25 codecs.