Initial version

Author: MichalLytek

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+build
+package

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "arrowParens": "avoid",
+  "trailingComma": "all"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Michał Lytek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,117 @@
+<p align="center">
+  <img alt="typegraphql logo" src="https://raw.githubusercontent.com/MichalLytek/typegraphql-nestjs/master/typegraphql-logo.png" width="300" height="200">
+  <img alt="nest logo" src="https://nestjs.com/img/logo_text.svg" width="300" height="200">
+</p>
+
+# TypeGraphQL NestJS Module
+
+Basic integration of [TypeGraphQL](https://typegraphql.com/) in [NestJS](https://nestjs.com/).
+
+Allows to use TypeGraphQL features while integrating with NestJS modules system and dependency injector.
+
+## Installation
+
+```sh
+npm i typegraphql-nestjs @nestjs/graphql
+```
+
+or
+
+```sh
+yarn add typegraphql-nestjs @nestjs/graphql
+```
+
+## How to use?
+
+The `typegraphql-nestjs` package exports `TypeGraphQLModule` dynamic module, which is based on the official NestJS `GraphQLModule`.
+
+It exposes two static methods. The first one is `TypeGraphQLModule.forRoot()` which you should call on your root module, just like with `GraphQLModule`.
+
+The only difference is that as its argument you can provide [typical TypeGraphQL `buildSchema` options](https://typegraphql.com/docs/bootstrap.html) like `emitSchemaFile` or `authChecker` apart from the [standard `GqlModuleOptions` from `@nestjs/graphql`](https://docs.nestjs.com/graphql/quick-start#installation) like `installSubscriptionHandlers` or `context`:
+
+```ts
+import { Module } from "@nestjs/common";
+import { TypeGraphQLModule } from "typegraphql-nestjs";
+
+import RecipeModule from "./recipe/module";
+import { authChecker } from "./auth";
+
+@Module({
+  imports: [
+    TypeGraphQLModule.forRoot({
+      emitSchemaFile: true,
+      validate: false,
+      authChecker,
+      dateScalarMode: "timestamp",
+      context: ({ req }) => ({ currentUser: req.user }),
+    }),
+    RecipeModule,
+  ],
+})
+export default class AppModule {}
+```
+
+Then, inside the imported modules (like `RecipeModule`) you just need to register the resolvers classes in the module `providers` array:
+
+```ts
+import { Module } from "@nestjs/common";
+
+import RecipeResolver from "./resolver";
+import RecipeService from "./service";
+
+@Module({
+  providers: [RecipeResolver, RecipeService],
+})
+export default class RecipeModule {}
+```
+
+And that's it! 😁
+
+Notice that the resolvers classes are automatically inferred from your submodules `providers` array, so you don't need to specify `resolvers` property from TypeGraphQL `buildSchema` options inside `TypeGraphQLModule.forRoot()`.
+
+In case of need to provide `orphanedTypes` setting, you should use `TypeGraphQLModule.forFeature()`. The recommended place for that is in the module where the orphaned type (like `SuperRecipe`) belongs:
+
+```ts
+import { Module } from "@nestjs/common";
+import { TypeGraphQLModule } from "typegraphql-nestjs";
+
+import RecipeResolver from "./resolver";
+import RecipeService from "./service";
+import { SuperRecipe } from "./types";
+
+@Module({
+  imports: [
+    TypeGraphQLModule.forFeature({
+      orphanedTypes: [SuperRecipe],
+    }),
+  ],
+  providers: [RecipeResolver, RecipeService],
+})
+export default class RecipeModule {}
+```
+
+Using `.forFeature()` ensures proper schemas isolation and automatically supply `orphanedTypes` option for underlying `buildSchema` from TypeGraphQL - again, there's no need to provide it manually in `.forRoot()` options.
+
+## Caveats
+
+While this integration provides a way to use TypeGraphQL with NestJS modules and dependency injector, for now it doesn't support [other NestJS features](https://docs.nestjs.com/graphql/tooling) like guards, interceptors, filters and pipes.
+
+To achieve the same goals, you can use standard TypeGraphQL equivalents - middlewares, custom decorators, built-in authorization and validation.
+
+Moreover, with `typegraphql-nestjs` you can also take advantage of additional features (comparing to `@nestjs/graphql`) like [inline field resolvers](https://typegraphql.com/docs/resolvers.html#field-resolvers), [interface args and resolvers](https://typegraphql.com/docs/next/interfaces.html#resolvers-and-arguments), [query complexity](https://typegraphql.com/docs/complexity.html) or [Prisma 2 integration](https://github.com/MichalLytek/type-graphql/blob/prisma/Readme.md).
+
+## Examples
+
+You can see some examples of the integration in this repo:
+
+1. [Basics](https://github.com/MichalLytek/typegraphql-nestjs/tree/master/examples/1-basics)
+
+   Basics of the integration, like `TypeGraphQLModule.forRoot` usage
+
+1. [Multiple Servers](https://github.com/MichalLytek/typegraphql-nestjs/tree/master/examples/2-multiple-servers)
+
+   Advanced usage of multiple schemas inside single NestJS app - demonstration of schema isolation in modules and `TypeGraphQLModule.forFeature` usage
+
+You can run them by using `ts-node`, like `npx ts-node ./examples/1-basics/index.ts`.
+
+All folders contain a `query.graphgql` file with some examples operations you can perform on the GraphQL servers.

examples/1-basics/app.module.ts

@@ -0,0 +1,15 @@
+import { Module } from "@nestjs/common";
+import { TypeGraphQLModule } from "../../src";
+
+import RecipeModule from "./recipe/module";
+
+@Module({
+  imports: [
+    TypeGraphQLModule.forRoot({
+      emitSchemaFile: true,
+      validate: false,
+    }),
+    RecipeModule,
+  ],
+})
+export default class AppModule {}

examples/1-basics/index.ts

@@ -0,0 +1,19 @@
+import "reflect-metadata";
+import { NestFactory } from "@nestjs/core";
+import {
+  NestFastifyApplication,
+  FastifyAdapter,
+} from "@nestjs/platform-fastify";
+
+import AppModule from "./app.module";
+
+async function bootstrap() {
+  const app = await NestFactory.create<NestFastifyApplication>(
+    AppModule,
+    new FastifyAdapter(),
+  );
+
+  await app.listen(3000);
+}
+
+bootstrap();

examples/1-basics/query.gql

@@ -0,0 +1,13 @@
+query GetRecipes {
+  recipes {
+    title
+    description
+  }
+}
+
+mutation AddRecipe {
+  addRecipe(input: { title: "My Recipe", description: "My description" }) {
+    title
+    description
+  }
+}

examples/1-basics/recipe/module.ts

@@ -0,0 +1,9 @@
+import { Module } from "@nestjs/common";
+
+import RecipeResolver from "./resolver";
+import RecipeService from "./service";
+
+@Module({
+  providers: [RecipeResolver, RecipeService],
+})
+export default class RecipeModule {}

examples/1-basics/recipe/resolver.ts

@@ -0,0 +1,22 @@
+import { Injectable } from "@nestjs/common";
+import { Resolver, Query, Mutation, Arg } from "type-graphql";
+
+import RecipeService from "./service";
+import Recipe from "./type";
+
+@Injectable()
+@Resolver()
+export default class RecipeResolver {
+  constructor(private readonly recipeService: RecipeService) {}
+
+  @Query(returns => [Recipe])
+  recipes() {
+    return this.recipeService.getRecipes();
+  }
+
+  @Mutation(returns => Recipe)
+  addRecipe(@Arg("input") recipe: Recipe) {
+    this.recipeService.addRecipe(recipe);
+    return recipe;
+  }
+}

examples/1-basics/recipe/service.ts

@@ -0,0 +1,16 @@
+import { Injectable } from "@nestjs/common";
+
+import Recipe from "./type";
+
+@Injectable()
+export default class RecipeService {
+  private readonly recipes: Recipe[] = [];
+
+  getRecipes() {
+    return this.recipes;
+  }
+
+  addRecipe(recipe: Recipe) {
+    this.recipes.push(recipe);
+  }
+}

examples/1-basics/recipe/type.ts

@@ -0,0 +1,11 @@
+import { ObjectType, Field, InputType } from "type-graphql";
+
+@ObjectType()
+@InputType("RecipeInput")
+export default class Recipe {
+  @Field()
+  title!: string;
+
+  @Field({ nullable: true })
+  description?: string;
+}

examples/1-basics/schema.gql

@@ -0,0 +1,22 @@
+# -----------------------------------------------
+# !!! THIS FILE WAS GENERATED BY TYPE-GRAPHQL !!!
+# !!!   DO NOT MODIFY THIS FILE BY YOURSELF   !!!
+# -----------------------------------------------
+
+type Mutation {
+  addRecipe(input: RecipeInput!): Recipe!
+}
+
+type Query {
+  recipes: [Recipe!]!
+}
+
+type Recipe {
+  description: String
+  title: String!
+}
+
+input RecipeInput {
+  description: String
+  title: String!
+}

examples/2-multiple-servers/animal/module.ts

@@ -0,0 +1,16 @@
+import { Module } from "@nestjs/common";
+import { TypeGraphQLModule } from "../../../src";
+
+import AnimalResolver from "./resolver";
+import AnimalService from "./service";
+import { SuperAnimal } from "./types";
+
+@Module({
+  imports: [
+    TypeGraphQLModule.forFeature({
+      orphanedTypes: [SuperAnimal],
+    }),
+  ],
+  providers: [AnimalResolver, AnimalService],
+})
+export default class AnimalModule {}

examples/2-multiple-servers/animal/resolver.ts

@@ -0,0 +1,22 @@
+import { Injectable } from "@nestjs/common";
+import { Resolver, Query, Mutation, Arg } from "type-graphql";
+
+import AnimalService from "./service";
+import { Animal } from "./types";
+
+@Injectable()
+@Resolver()
+export default class AnimalResolver {
+  constructor(private readonly animalService: AnimalService) {}
+
+  @Query(returns => [Animal])
+  animals() {
+    return this.animalService.getAnimals();
+  }
+
+  @Mutation(returns => Animal)
+  addAnimal(@Arg("input") animal: Animal) {
+    this.animalService.addAnimal(animal);
+    return animal;
+  }
+}

examples/2-multiple-servers/animal/service.ts

@@ -0,0 +1,16 @@
+import { Injectable } from "@nestjs/common";
+
+import { Animal } from "./types";
+
+@Injectable()
+export default class AnimalService {
+  private readonly animals: Animal[] = [];
+
+  getAnimals() {
+    return this.animals;
+  }
+
+  addAnimal(animal: Animal) {
+    this.animals.push(animal);
+  }
+}

examples/2-multiple-servers/animal/types.ts

@@ -0,0 +1,17 @@
+import { ObjectType, Field, Int, InputType } from "type-graphql";
+
+@ObjectType()
+@InputType("AnimalInput")
+export class Animal {
+  @Field()
+  name!: string;
+
+  @Field(type => Int)
+  weight!: number;
+}
+
+@ObjectType()
+export class SuperAnimal extends Animal {
+  @Field()
+  isSuperHero!: boolean;
+}

examples/2-multiple-servers/first-query.graphql

@@ -0,0 +1,13 @@
+query GetRecipes {
+  recipes {
+    title
+    description
+  }
+}
+
+mutation AddRecipe {
+  addRecipe(input: { title: "My Recipe", description: "My description" }) {
+    title
+    description
+  }
+}