Create GraphQL schema and resolvers with TypeScript, using classes and decorators!
Clone or download
Permalink
Failed to load latest commit information.
.github/ISSUE_TEMPLATE docs(github): fix question issue template Sep 21, 2018
.vscode chore(deps): update graphql types to 0.13 + fix related issues Apr 12, 2018
docs docs(schema): make the text more fluent and easier to read (#194) Nov 12, 2018
examples docs(examples): add example usage of `emitSchemaFile` Oct 17, 2018
src feat(schema): expose `emitSchemaDefinitionFile` helpers Oct 17, 2018
tests test(schema): add emit schema SDL test cases Oct 17, 2018
website docs(schema): add info about emitting schema SDL file Oct 17, 2018
.editorconfig chore: add editor config file Feb 17, 2018
.gitignore chore(test): generate test coverage reports Feb 21, 2018
.prettierrc chore(format): update prettier and tslint settings Apr 14, 2018
.travis.yml chore: exclude Node 9 from Travis Oct 13, 2018
CHANGELOG.md release: 0.15.0 Oct 17, 2018
LICENSE Initial commit Jan 9, 2018
README.md docs(readme): remove ts-node type-check warning Sep 13, 2018
dev.js docs(readme): remove ts-node type-check warning Sep 13, 2018
gulpfile.ts chore(build): fix gulp compile config Aug 7, 2018
jest.config.js chore: update typescript, gulp + change transpile and build config Aug 6, 2018
lint-staged.config.js chore(format): add format on pre-commit hook Aug 15, 2018
logo.png docs(readme): introduce shiny new logo May 1, 2018
package-lock.json release: 0.15.0 Oct 17, 2018
package.json release: 0.15.0 Oct 17, 2018
publish-website.sh docs(website): Configure website autodeploy Apr 5, 2018
tsconfig.json docs(examples): update examples to remove `graphql-yoga` dependency Oct 13, 2018
tslint.json chore(format): update prettier and tslint settings Apr 14, 2018

README.md

logo

TypeGraphQL

npm version Build Status codecov dependencies install size gitter

Create GraphQL schema and resolvers with TypeScript, using classes and decorators!

https://19majkel94.github.io/type-graphql/

Motivation

We all know that GraphQL is so great and solves many problems that we have with REST API, like overfetching and underfetching. But developing a GraphQL API in Node.js with TypeScript is sometimes a bit of pain. Why? Let's take a look at the steps we usually have to make.

At first, we create the all the schema types in SDL. We also create our data models using ORM classes, which represents 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, e.g.:

export const recipesResolver: GraphQLFieldResolver<void, Context, RecipesArgs> =
  async (_, args) => {
    // our business logic, e.g.:
    const repository = getRepository(Recipe);
    return repository.find();
  }

The biggest problem is the 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 with 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.

TypeGraphQL comes to address this issues, based on experience from over a dozen months of developing GraphQL APIs in TypeScript. The main idea is to have only one source of truth by defining the schema using classes and a bit of decorator help. Additional features like dependency injection, validation or auth guards helps with common tasks that normally we would have to handle by ourselves.

Introduction

As I mentioned, TypeGraphQL makes developing a GraphQL API and 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 kind of DTO classes. For example, to declare Recipe type we simply create a class and annotate it with decorators:

@ObjectType()
class Recipe {
  @Field(type => ID)
  id: string;

  @Field()
  title: string;

  @Field(type => [Rate])
  ratings: Rate[];

  @Field({ nullable: true })
  averageRating?: number;
}

And we get corresponding part of schema in SDL:

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 or auth guards:

@Resolver(Recipe)
class RecipeResolver {
  constructor(
    private recipeService: RecipeService,
  ) {}

  @Query(returns => [Recipe])
  recipes() {
    return this.recipeService.findAll();
  }

  @Mutation()
  @Authorized(Roles.Admin)
  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 schema in SDL:

type Query {
  recipes: [Recipe!]!
}
type Mutation {
  removeRecipe(id: String!): Boolean!
}

Getting started

Full getting started guide with a simple walkthrough/tutorial can be found in getting started docs.

Documentation

The documentation with detailed description of the API and the features is available on the website.

Below you can find installation instructions that are also important.

How to use

Installation

  1. Install module:
npm i type-graphql
  1. reflect-metadata shim is required:
npm i reflect-metadata

and make sure to import it on top of your entry file (before you use/import type-graphql or your resolvers):

import "reflect-metadata";

TypeScript configuration

  1. Its important to set these options in tsconfig.json file of your project:
{
  "emitDecoratorMetadata": true,
  "experimentalDecorators": true
}
  1. TypeGraphQL is designed to work with Node.js 6, 8 and latest stable. It uses features from ES7 (ES2016) so you should set your tsconfig.json appropriately:
{
  "target": "es2016" // or newer if your node.js version supports this
}
  1. Due to using graphql-subscription dependency that rely on an AsyncIterator, you may also have to provide the esnext.asynciterable to the lib option:
{
  "lib": ["es2016", "esnext.asynciterable"]
}

All in all, the minimal tsconfig.json file example looks like this:

{
  "compilerOptions": {
    "target": "es2016",
    "module": "commonjs",
    "lib": ["es2016", "esnext.asynciterable"],
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

Examples

You can also check the examples folder on this repository for more examples of usage: simple fields resolvers, DI Container support, TypeORM integration, automatic validation, etc.

The Tests folder might also give you some tips how to get various things done.

Work in progress

Currently released version is a MVP (Minimum Viable Product). It is well tested (95% coverage, 4400 lines of test code) and has 90% of the planned features already implemented. However there's some work to do before 1.0.0 release and it's mostly about documentation (website, api reference and jsdoc).

There are also plans for more features like better TypeORM and dataloader integration or middlewares and custom decorators support - the full list of ideas is available on the GitHub repo. You can also keep track of development's progress on project board.

I encourage you to give it a try and experiment with TypeGraphQL. If you have any question, you can ask about it on gitter. If you find a bug, please report it as an issue on GitHub. If you have an interesting feature request, I will be happy to hear about it.

Contribution

PRs are welcome, but first check, test and build your code before committing it.

If you want to add a new big feature, please create a proposal first, where we can discuss the idea and implementation details. This will prevent wasting of your time if the PR be rejected.