docs(examples): add TypeORM usage example

Author: MichalLytek

dev.js

@@ -2,3 +2,4 @@ require("ts-node/register");
 require("./tests/index.ts");
 // require("./examples/01-simple-usage/index.ts");
 // require("./examples/02-using-container/index.ts");
+// require("./examples/03-typeorm-usage/index.ts");

examples/03-typeorm-usage/entities/rate.ts

@@ -0,0 +1,30 @@
+import { GraphQLObjectType, Field, Int} from "../../../src";
+import { Column, Entity, ManyToOne, PrimaryGeneratedColumn } from "typeorm";
+
+import { User } from "./user";
+import { Recipe } from "./recipe";
+import { RelationColumn } from "../helpers";
+
+@Entity()
+@GraphQLObjectType()
+export class Rate {
+  @PrimaryGeneratedColumn()
+  readonly id: number;
+
+  @Field(type => Int)
+  @Column({ type: "int" })
+  value: number;
+
+  @Field(type => User)
+  @ManyToOne(type => User)
+  user: User;
+
+  @RelationColumn()
+  userId: number;
+
+  @ManyToOne(type => Recipe)
+  recipe: Recipe;
+
+  @RelationColumn()
+  recipeId: number;
+}

examples/03-typeorm-usage/entities/recipe.ts

@@ -0,0 +1,33 @@
+import { Field, ID, GraphQLObjectType, Int, Float } from "../../../src";
+import { Entity, PrimaryGeneratedColumn, Column, OneToMany, ManyToOne } from "typeorm";
+
+import { Rate } from "./rate";
+import { User } from "./user";
+import { RelationColumn } from "../helpers";
+
+@Entity()
+@GraphQLObjectType()
+export class Recipe {
+  @PrimaryGeneratedColumn()
+  @Field(type => ID)
+  readonly id: number;
+
+  @Field()
+  @Column()
+  title: string;
+
+  @Field({ nullable: true })
+  @Column({ nullable: true })
+  description?: string;
+
+  @Field(type => Rate)
+  @OneToMany(type => Rate, rate => rate.recipe, { cascadeInsert: true })
+  ratings: Rate[];
+
+  @Field(type => User)
+  @ManyToOne(type => User)
+  author: User;
+
+  @RelationColumn()
+  authorId: number;
+}

examples/03-typeorm-usage/entities/user.ts

@@ -0,0 +1,21 @@
+import { Field, ID, GraphQLObjectType } from "../../../src";
+import { PrimaryGeneratedColumn, Column, Entity } from "typeorm";
+
+@GraphQLObjectType()
+@Entity()
+export class User {
+  @PrimaryGeneratedColumn()
+  @Field(type => ID)
+  readonly id: number;
+
+  @Column()
+  @Field()
+  email: string;
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  nickname?: string;
+
+  @Column()
+  password: string;
+}

examples/03-typeorm-usage/helpers.ts

@@ -0,0 +1,48 @@
+import { getRepository, Column, ColumnOptions } from "typeorm";
+
+import { Recipe } from "./entities/recipe";
+import { Rate } from "./entities/rate";
+import { User } from "./entities/user";
+
+export async function seedDatabase() {
+  const recipeRepository = getRepository(Recipe);
+  const ratingsRepository = getRepository(Rate);
+  const userRepository = getRepository(User);
+
+  const defaultUser = userRepository.create({
+    email: "test@github.com",
+    nickname: "19majkel94",
+    password: "s3cr3tp4ssw0rd",
+  });
+  await userRepository.save(defaultUser);
+
+  const recipes = recipeRepository.create([
+    {
+      title: "Recipe 1",
+      description: "Desc 1",
+      author: defaultUser,
+      ratings: ratingsRepository.create([
+        { value: 2, user: defaultUser },
+        { value: 4, user: defaultUser },
+        { value: 5, user: defaultUser },
+        { value: 3, user: defaultUser },
+        { value: 4, user: defaultUser },
+      ]),
+    },
+    {
+      title: "Recipe 2",
+      author: defaultUser,
+      ratings: ratingsRepository.create([
+        { value: 2, user: defaultUser },
+        { value: 4, user: defaultUser },
+      ]),
+    },
+  ]);
+  await recipeRepository.save(recipes);
+}
+
+export type Lazy<T extends object> = Promise<T> | T;
+
+export function RelationColumn(options?: ColumnOptions) {
+  return Column({ nullable: true, ...options });
+}

examples/03-typeorm-usage/index.ts

@@ -0,0 +1,60 @@
+import "reflect-metadata";
+import * as express from "express";
+import * as graphqlHTTP from "express-graphql";
+import { Container } from "typedi";
+import * as TypeGraphQL from "../../src";
+import * as TypeORM from "typeorm";
+
+import { RecipeResolver } from "./resolvers/recipe-resolver";
+import { RateResolver } from "./resolvers/rate-resolver";
+import { Recipe } from "./entities/recipe";
+import { Rate } from "./entities/rate";
+import { User } from "./entities/user";
+import { seedDatabase } from "./helpers";
+
+// register 3rd party IOC container
+TypeGraphQL.useContainer(Container);
+TypeORM.useContainer(Container);
+
+(async () => {
+  try {
+    // create TypeORM connection
+    await TypeORM.createConnection({
+      type: "mysql",
+      database: "type-graphql",
+      username: "root",
+      password: "qwerty123",
+      port: 3306,
+      host: "localhost",
+      entities: [Recipe, Rate, User],
+      synchronize: true,
+      logger: "advanced-console",
+      logging: "all",
+      // logging: ["error"],
+      dropSchema: true,
+    });
+
+    // seed database with some data
+    await seedDatabase();
+
+    // build TypeGraphQL executable schema
+    const schema = TypeGraphQL.buildSchema({
+      resolvers: [RecipeResolver, RateResolver],
+    });
+
+    // create express-based gql endpoint
+    const app = express();
+    app.use(
+      "/graphql",
+      graphqlHTTP({
+        schema,
+        graphiql: true,
+      }),
+    );
+    app.listen(4000, () => {
+      console.log("Running a GraphQL API server at localhost:4000/graphql");
+    });
+  } catch (err) {
+    console.error(err);
+  }
+})();

examples/03-typeorm-usage/resolvers/rate-resolver.ts

@@ -0,0 +1,19 @@
+import { GraphQLResolver, Query, FieldResolver, Arg, Root, Mutation } from "../../../src/index";
+import { Repository } from "typeorm";
+import { OrmRepository } from "typeorm-typedi-extensions";
+
+import { Rate } from "../entities/rate";
+import { User } from "../entities/user";
+
+@GraphQLResolver(() => Rate)
+export class RateResolver {
+  constructor(
+    @OrmRepository(User)
+    private readonly userRepository: Repository<User>,
+  ) {}
+
+  @FieldResolver()
+  async user(@Root() rate: Rate): Promise<User> {
+    return (await this.userRepository.findOneById(rate.userId, { cache: 1000 }))!;
+  }
+}

examples/03-typeorm-usage/resolvers/recipe-resolver.ts

@@ -0,0 +1,52 @@
+import { GraphQLResolver, Query, FieldResolver, Arg, Root, Mutation } from "../../../src/index";
+import { Repository } from "typeorm";
+import { OrmRepository } from "typeorm-typedi-extensions";
+
+import { Recipe } from "../entities/recipe";
+import { Rate } from "../entities/rate";
+import { User } from "../entities/user";
+import { RecipeInput } from "./types/recipe-input";
+
+@GraphQLResolver(() => Recipe)
+export class RecipeResolver {
+  constructor(
+    @OrmRepository(Recipe)
+    private readonly recipeRepository: Repository<Recipe>,
+    @OrmRepository(Rate)
+    private readonly ratingsRepository: Repository<Rate>,
+    @OrmRepository(User)
+    private readonly userRepository: Repository<User>,
+  ) {}
+
+  @Query(returnType => Recipe, { nullable: true })
+  recipe(@Arg("recipeId") recipeId: number) {
+    return this.recipeRepository.findOneById(recipeId);
+  }
+
+  @Query(returnType => Recipe, { array: true })
+  recipes(): Promise<Recipe[]> {
+    return this.recipeRepository.find();
+  }
+
+  @Mutation(returnType => Recipe)
+  addRecipe(@Arg("recipe") recipeInput: RecipeInput): Promise<Recipe> {
+    const recipe = this.recipeRepository.create({
+      ...recipeInput,
+      authorId: 1,
+    });
+    return this.recipeRepository.save(recipe);
+  }
+
+  @FieldResolver()
+  ratings(@Root() recipe: Recipe) {
+    return this.ratingsRepository.find({
+      cache: 1000,
+      where: { recipeId: recipe.id },
+    });
+  }
+
+  @FieldResolver()
+  async author(@Root() recipe: Recipe): Promise<User> {
+    return (await this.userRepository.findOneById(recipe.authorId, { cache: 1000 }))!;
+  }
+}

examples/03-typeorm-usage/resolvers/types/recipe-input.ts

@@ -0,0 +1,12 @@
+import { GraphQLInputType, Field } from "../../../../src";
+
+import { Recipe } from "../../entities/recipe";
+
+@GraphQLInputType()
+export class RecipeInput implements Partial<Recipe> {
+  @Field()
+  title: string;
+
+  @Field({ nullable: true })
+  description: string;
+}