This repository has been archived by the owner on Nov 22, 2022. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: explain why we have to fork from a Draft PR
- Loading branch information
1 parent
91ca9b1
commit 02900be
Showing
1 changed file
with
5 additions
and
191 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,194 +1,8 @@ | ||
|  | ||
| # TypeGraphQL Draft PR | ||
|
|
||
| # TypeGraphQL | ||
| This is a draft PR for the new major version of Type GraphQL. | ||
| You can see the main repo here https://github.com/MichalLytek/type-graphql | ||
|
|
||
| [](https://badge.fury.io/js/type-graphql) | ||
| [](https://github.com/MichalLytek/type-graphql/actions/workflows/main.yml?query=branch%3Amaster) | ||
| [](https://codecov.io/gh/MichalLytek/type-graphql) | ||
|  | ||
| [](<(https://opencollective.com/typegraphql)>) | ||
| [](https://packagephobia.now.sh/result?p=type-graphql) | ||
| V2 is a draft PR, currently living here https://github.com/MichalLytek/type-graphql/pull/1331 | ||
|
|
||
| Create GraphQL schema and resolvers with TypeScript, using classes and decorators! | ||
|
|
||
| [**https://typegraphql.com/**](https://typegraphql.com/) | ||
| <br> | ||
| <br> | ||
| [](https://opencollective.com/typegraphql) | ||
|
|
||
| ## Introduction | ||
|
|
||
| **TypeGraphQL** makes developing GraphQL APIs an enjoyable process, i.e. by defining the schema using only classes and a bit of decorator magic. | ||
|
|
||
| So, to create types like object type or input type, we use a kind of DTO classes. | ||
| For example, to declare `Recipe` type we simply create a class and annotate it with decorators: | ||
|
|
||
| ```ts | ||
| @ObjectType() | ||
| class Recipe { | ||
| @Field(type => ID) | ||
| id: string; | ||
|
|
||
| @Field() | ||
| title: string; | ||
|
|
||
| @Field(type => [Rate]) | ||
| ratings: Rate[]; | ||
|
|
||
| @Field({ nullable: true }) | ||
| averageRating?: number; | ||
| } | ||
| ``` | ||
|
|
||
| And we get the corresponding part of the schema in SDL: | ||
|
|
||
| ```graphql | ||
| type Recipe { | ||
| id: ID! | ||
| title: String! | ||
| ratings: [Rate!]! | ||
| averageRating: Float | ||
| } | ||
| ``` | ||
|
|
||
| Then we can create queries, mutations and field resolvers. For this purpose we use controller-like classes that are called "resolvers" by convention. We can also use awesome features like dependency injection and auth guards: | ||
|
|
||
| ```ts | ||
| @Resolver(Recipe) | ||
| class RecipeResolver { | ||
| // dependency injection | ||
| constructor(private recipeService: RecipeService) {} | ||
|
|
||
| @Query(returns => [Recipe]) | ||
| recipes() { | ||
| return this.recipeService.findAll(); | ||
| } | ||
|
|
||
| @Mutation() | ||
| @Authorized(Roles.Admin) // auth guard | ||
| removeRecipe(@Arg("id") id: string): boolean { | ||
| return this.recipeService.removeById(id); | ||
| } | ||
|
|
||
| @FieldResolver() | ||
| averageRating(@Root() recipe: Recipe) { | ||
| return recipe.ratings.reduce((a, b) => a + b, 0) / recipe.ratings.length; | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| And in this simple way we get this part of the schema in SDL: | ||
|
|
||
| ```graphql | ||
| type Query { | ||
| recipes: [Recipe!]! | ||
| } | ||
|
|
||
| type Mutation { | ||
| removeRecipe(id: String!): Boolean! | ||
| } | ||
| ``` | ||
|
|
||
| ## Motivation | ||
|
|
||
| We all know that GraphQL is great and solves many problems we have with REST APIs, like overfetching and underfetching. But developing a GraphQL API in Node.js with TypeScript is sometimes a bit of a pain. Why? Let's take a look at the steps we usually have to take. | ||
|
|
||
| First, we create all the GraphQL types in `schema.gql` using SDL. Then we create our data models using [ORM classes](https://github.com/typeorm/typeorm), which represent our db entities. Then we start to write resolvers for our queries, mutations and fields, but this forces us to first create TS interfaces for all arguments, inputs, and even object types. | ||
|
|
||
| Only then can we actually implement the resolvers using weird generic signatures and manually performing common tasks, like validation, authorization and loading dependencies: | ||
|
|
||
| ```ts | ||
| export const getRecipesResolver: GraphQLFieldResolver<void, Context, GetRecipesArgs> = async ( | ||
| _, | ||
| args, | ||
| ctx, | ||
| ) => { | ||
| // common tasks repeatable for almost every resolver | ||
| const repository = TypeORM.getRepository(Recipe); | ||
| const auth = Container.get(AuthService); | ||
| await joi.validate(getRecipesSchema, args); | ||
| if (!auth.check(ctx.user)) { | ||
| throw new NotAuthorizedError(); | ||
| } | ||
|
|
||
| // our business logic, e.g.: | ||
| return repository.find({ skip: args.offset, take: args.limit }); | ||
| }; | ||
| ``` | ||
|
|
||
| The biggest problem is redundancy in our codebase, which makes it difficult to keep things in sync. To add a new field to our entity, we have to jump through all the files - modify an entity class, the schema, as well as the interface. The same goes for inputs or arguments. It's easy to forget to update one piece or make a mistake with a single type. Also, what if we've made a typo in field name? The rename feature (F2) won't work correctly. | ||
|
|
||
| Tools like [GraphQL Code Generator](https://github.com/dotansimha/graphql-code-generator) or [graphqlgen](https://github.com/prisma/graphqlgen) only solve the first part - they generate the corresponding interfaces (and resolvers skeletons) for our GraphQL schema but they don't fix the schema <--> models redundancy and developer experience (F2 rename won't work, you have to remember about the codegen watch task in background, etc.), as well as common tasks like validation, authorization, etc. | ||
|
|
||
| **TypeGraphQL** comes to address these issues, based on experience from a few years of developing GraphQL APIs in TypeScript. The main idea is to have only one source of truth by defining the schema using classes and some help from decorators. Additional features like dependency injection, validation and auth guards help with common tasks that normally we would have to handle ourselves. | ||
|
|
||
| ## Documentation | ||
|
|
||
| The documentation, installation guide, detailed description of the API and all of its features is [available on the website](https://typegraphql.com/). | ||
|
|
||
| ### Getting started | ||
|
|
||
| A full getting started guide with a simple walkthrough (tutorial) can be found at [getting started docs](https://typegraphql.com/docs/getting-started.html). | ||
|
|
||
| ### Video tutorial | ||
|
|
||
| If you prefer video tutorials, you can watch [Ben Awad](https://github.com/benawad)'s [TypeGraphQL video series](https://www.youtube.com/playlist?list=PLN3n1USn4xlma1bBu3Tloe4NyYn9Ko8Gs) on YouTube. | ||
|
|
||
| ### Examples | ||
|
|
||
| You can also check the [examples folder](https://github.com/MichalLytek/type-graphql/tree/master/examples) in this repository for more examples of usage: simple fields resolvers, DI Container support, TypeORM integration, automatic validation, etc. | ||
|
|
||
| The [Tests folder](https://github.com/MichalLytek/type-graphql/tree/master/tests) might also give you some tips how to get various things done. | ||
|
|
||
| ## The future | ||
|
|
||
| The currently released version is a stable 1.0.0 release. It is well tested (95% coverage, 428 test cases) and has most of the planned features already implemented. Plenty of companies and independent developers are using it in production with success. | ||
|
|
||
| However, there are also plans for a lot more features like better TypeORM, Prisma and dataloader integration, custom decorators and metadata annotations support - [the full list of ideas](https://github.com/MichalLytek/type-graphql/issues?q=is%3Aissue+is%3Aopen+label%3A"Enhancement+%3Anew%3A") is available on the GitHub repo. You can also keep track of [development's progress on project board](https://github.com/MichalLytek/type-graphql/projects/1). | ||
|
|
||
| If you have any interesting feature requests, feel free to open an issue on GitHub so we can discuss that! | ||
|
|
||
| ## Support | ||
|
|
||
| TypeGraphQL is an MIT-licensed open source project. This framework is a result of the tremendous amount of work - sleepless nights, busy evenings and weekends. | ||
|
|
||
| It doesn't have a large company that sits behind - its ongoing development is possible only thanks to the support by the community. | ||
|
|
||
| [](https://opencollective.com/typegraphql) | ||
|
|
||
| ### Gold Sponsors 🏆 | ||
|
|
||
| | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/ecad_new.png" width="300">](https://www.ecadlabs.com/) | | ||
| | :-------------------------------------------------------------------------------------------------------------------------------------: | | ||
| | [**ECAD Labs**](https://www.ecadlabs.com/) | | ||
|
|
||
| > Please ask your company to support this open source project by [becoming a gold sponsor](https://opencollective.com/typegraphql/contribute/gold-sponsors-8340) and getting a premium technical support from our core contributors. | ||
| ### Silver Sponsors 🥈 | ||
|
|
||
| | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/gorrion.png" width="250">](https://gorrion.io/) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/lovd.png" width="150">](https://www.lovd.com/) | | ||
| | :------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | | ||
| | [**Gorrion Software House**](https://gorrion.io/) | [**Lovd**](https://www.lovd.com/) | | ||
|
|
||
| ### Bronze Sponsors 🥉 | ||
|
|
||
| | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/live-graphics-system.png" width="55">](https://www.ligrsystems.com/) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/lifex.png" width="60">](https://www.joinlifex.com/) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/swiss-mentor.png" width="115">](https://www.swissmentor.com/) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/flatirons.png" width="50">](https://flatironsdevelopment.com/) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/instinctools.svg" width="100">](https://instinctools.com/manufacturing/) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/slon.png" width="65">](https://slonmedia.com/) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/rubydroid.svg" width="110">](https://rubyroidlabs.com/services/ror_development) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/intexsoft.jpg" width="65">](https://intexsoft.com/ecommerce-development-services/) | | ||
| | :---------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------: | | ||
| | [**Live Graphic Systems**](https://www.ligrsystems.com/) | [**LifeX Aps**](https://www.joinlifex.com/) | [**SwissMentor**](https://www.swissmentor.com/) | [**Flatirons Development**](https://flatironsdevelopment.com/) | [**\*instinctools**](https://instinctools.com/manufacturing/) | [**SLON Media**](https://slonmedia.com/) | [**Rubyroidlabs**](https://rubyroidlabs.com/services/ror_development) | [**Intexsoft**](https://intexsoft.com/ecommerce-development-services/) | | ||
|
|
||
| [](https://opencollective.com/typegraphql) | ||
|
|
||
| ### Members 💪 | ||
|
|
||
| [](https://opencollective.com/typegraphql#contributors) | ||
|
|
||
| ### Backers ☕ | ||
|
|
||
| [](https://opencollective.com/typegraphql#contributors) | ||
|
|
||
| ## Want to help? | ||
|
|
||
| Want to file a bug, contribute some code, or improve documentation? Great! Please read our | ||
| guidelines for [contributing][contributing] and then check out one of our [help wanted issues](https://github.com/MichalLytek/type-graphql/labels/Help%20Wanted%20%3Asos%3A). | ||
|
|
||
| [contributing]: https://github.com/MichalLytek/type-graphql/blob/master/CONTRIBUTING.md | ||
| Because we need to release to Production with the Federation and v1 doesn't support recent versions of GraphQL we'll have to do this until v2 is released. |