docs(examples): fix types issues in code examples

examples/mikro-orm/entities/rate.ts

@@ -1,4 +1,4 @@
-import { Entity, Property, ManyToOne, PrimaryKey } from "@mikro-orm/core";
+import { Entity, Property, ManyToOne, PrimaryKey, OptionalProps } from "@mikro-orm/core";
 import { ObjectType, Field, Int } from "../../../src";
 
 import { User } from "./user";
@@ -24,4 +24,6 @@ export class Rate {
 
   @ManyToOne(type => Recipe)
   recipe: Recipe;
+
+  [OptionalProps]?: "date";
 }

examples/mikro-orm/helpers.ts

@@ -18,11 +18,11 @@ export async function seedDatabase(em: EntityManager) {
     author: defaultUser,
   });
   recipe1.ratings.add(
-    em.create(Rate, { value: 2, user: defaultUser }),
-    em.create(Rate, { value: 4, user: defaultUser }),
-    em.create(Rate, { value: 5, user: defaultUser }),
-    em.create(Rate, { value: 3, user: defaultUser }),
-    em.create(Rate, { value: 4, user: defaultUser }),
+    em.create(Rate, { value: 2, user: defaultUser, recipe: recipe1 }),
+    em.create(Rate, { value: 4, user: defaultUser, recipe: recipe1 }),
+    em.create(Rate, { value: 5, user: defaultUser, recipe: recipe1 }),
+    em.create(Rate, { value: 3, user: defaultUser, recipe: recipe1 }),
+    em.create(Rate, { value: 4, user: defaultUser, recipe: recipe1 }),
   );
   em.persist(recipe1);
 
@@ -31,8 +31,8 @@ export async function seedDatabase(em: EntityManager) {
     author: defaultUser,
   });
   recipe2.ratings.add(
-    em.create(Rate, { value: 2, user: defaultUser }),
-    em.create(Rate, { value: 4, user: defaultUser }),
+    em.create(Rate, { value: 2, user: defaultUser, recipe: recipe2 }),
+    em.create(Rate, { value: 4, user: defaultUser, recipe: recipe2 }),
   );
   em.persist(recipe2);
 

examples/redis-subscriptions/index.ts

@@ -1,6 +1,6 @@
 import "reflect-metadata";
 import { ApolloServer } from "apollo-server";
-import Redis from "ioredis";
+import Redis, { RedisOptions } from "ioredis";
 import { RedisPubSub } from "graphql-redis-subscriptions";
 import { buildSchema } from "../../src";
 
@@ -11,7 +11,7 @@ const REDIS_PORT = 6379;
 
 async function bootstrap() {
   // configure Redis connection options
-  const options: Redis.RedisOptions = {
+  const options: RedisOptions = {
     host: REDIS_HOST,
     port: REDIS_PORT,
     retryStrategy: times => Math.max(times * 100, 3000),

examples/typegoose/entities/recipe.ts

@@ -1,5 +1,5 @@
 import { prop as Property, getModelForClass } from "@typegoose/typegoose";
-import { ObjectId } from "mongodb";
+import { Types } from "mongoose";
 import { Field, ObjectType } from "../../../src";
 
 import { Rate } from "./rate";
@@ -9,7 +9,7 @@ import { Ref } from "../types";
 @ObjectType()
 export class Recipe {
   @Field()
-  readonly _id: ObjectId;
+  readonly _id: Types.ObjectId;
 
   @Field()
   @Property({ required: true })

examples/typegoose/entities/user.ts

@@ -1,11 +1,11 @@
 import { prop as Property, getModelForClass } from "@typegoose/typegoose";
-import { ObjectId } from "mongodb";
+import { Types } from "mongoose";
 import { Field, ObjectType } from "../../../src";
 
 @ObjectType()
 export class User {
   @Field()
-  readonly _id: ObjectId;
+  readonly _id: Types.ObjectId;
 
   @Field()
   @Property({ required: true })

examples/typegoose/helpers.ts

@@ -1,4 +1,4 @@
-import { Recipe, RecipeModel } from "./entities/recipe";
+import { RecipeModel } from "./entities/recipe";
 import { User, UserModel } from "./entities/user";
 
 export async function seedDatabase() {
@@ -30,7 +30,7 @@ export async function seedDatabase() {
         { value: 4, user: defaultUser },
       ],
     },
-  ] as Recipe[]);
+  ]);
 
   return { defaultUser };
 }

examples/typegoose/index.ts

@@ -1,7 +1,6 @@
 import "reflect-metadata";
 import { ApolloServer } from "apollo-server";
-import { connect } from "mongoose";
-import { ObjectId } from "mongodb";
+import { connect, Types } from "mongoose";
 import * as path from "path";
 import { buildSchema } from "../../src";
 
@@ -35,7 +34,7 @@ async function bootstrap() {
       // use document converting middleware
       globalMiddlewares: [TypegooseMiddleware],
       // use ObjectId scalar mapping
-      scalarsMap: [{ type: ObjectId, scalar: ObjectIdScalar }],
+      scalarsMap: [{ type: Types.ObjectId, scalar: ObjectIdScalar }],
       validate: false,
     });
 

examples/typegoose/object-id.scalar.ts

@@ -1,25 +1,25 @@
 import { GraphQLScalarType, Kind } from "graphql";
-import { ObjectId } from "mongodb";
+import { Types } from "mongoose";
 
 export const ObjectIdScalar = new GraphQLScalarType({
   name: "ObjectId",
   description: "Mongo object id scalar type",
   serialize(value: unknown): string {
-    if (!(value instanceof ObjectId)) {
+    if (!(value instanceof Types.ObjectId)) {
       throw new Error("ObjectIdScalar can only serialize ObjectId values");
     }
     return value.toHexString();
   },
-  parseValue(value: unknown): ObjectId {
+  parseValue(value: unknown): Types.ObjectId {
     if (typeof value !== "string") {
       throw new Error("ObjectIdScalar can only parse string values");
     }
-    return new ObjectId(value);
+    return new Types.ObjectId(value);
   },
-  parseLiteral(ast): ObjectId {
+  parseLiteral(ast): Types.ObjectId {
     if (ast.kind !== Kind.STRING) {
       throw new Error("ObjectIdScalar can only parse string values");
     }
-    return new ObjectId(ast.value);
+    return new Types.ObjectId(ast.value);
   },
 });

examples/typegoose/resolvers/recipe-resolver.ts

@@ -1,4 +1,4 @@
-import { ObjectId } from "mongodb";
+import { Types } from "mongoose";
 import { Resolver, Query, FieldResolver, Arg, Root, Mutation, Ctx } from "../../../src";
 
 import { Recipe, RecipeModel } from "../entities/recipe";
@@ -12,7 +12,7 @@ import { ObjectIdScalar } from "../object-id.scalar";
 @Resolver(of => Recipe)
 export class RecipeResolver {
   @Query(returns => Recipe, { nullable: true })
-  recipe(@Arg("recipeId", type => ObjectIdScalar) recipeId: ObjectId) {
+  recipe(@Arg("recipeId", type => ObjectIdScalar) recipeId: Types.ObjectId) {
     return RecipeModel.findById(recipeId);
   }
 
@@ -29,7 +29,7 @@ export class RecipeResolver {
     const recipe = new RecipeModel({
       ...recipeInput,
       author: user._id,
-    } as Recipe);
+    });
 
     await recipe.save();
     return recipe;

examples/typegoose/resolvers/types/rate-input.ts

@@ -1,10 +1,10 @@
-import { ObjectId } from "mongodb";
+import { Types } from "mongoose";
 import { InputType, Field, Int } from "../../../../src";
 
 @InputType()
 export class RateInput {
   @Field()
-  recipeId: ObjectId;
+  recipeId: Types.ObjectId;
 
   @Field(type => Int)
   value: number;

examples/typegoose/types.ts

@@ -1,3 +1,3 @@
-import { ObjectId } from "mongodb";
+import { Types } from "mongoose";
 
-export type Ref<T> = T | ObjectId;
+export type Ref<T> = T | Types.ObjectId;

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

@@ -11,6 +11,6 @@ export class RateResolver {
 
   @FieldResolver()
   async user(@Root() rate: Rate): Promise<User> {
-    return (await this.userRepository.findOne(rate.userId, { cache: 1000 }))!;
+    return (await this.userRepository.findOne({ where: { id: rate.userId }, cache: 1000 }))!;
   }
 }

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

@@ -19,7 +19,7 @@ export class RecipeResolver {
 
   @Query(returns => Recipe, { nullable: true })
   recipe(@Arg("recipeId", type => Int) recipeId: number) {
-    return this.recipeRepository.findOne(recipeId);
+    return this.recipeRepository.findOneBy({ id: recipeId });
   }
 
   @Query(returns => [Recipe])
@@ -42,7 +42,8 @@ export class RecipeResolver {
   @Mutation(returns => Recipe)
   async rate(@Arg("rate") rateInput: RateInput, @Ctx() { user }: Context): Promise<Recipe> {
     // find the recipe
-    const recipe = await this.recipeRepository.findOne(rateInput.recipeId, {
+    const recipe = await this.recipeRepository.findOne({
+      where: { id: rateInput.recipeId },
       relations: ["ratings"],
     });
     if (!recipe) {
@@ -72,6 +73,6 @@ export class RecipeResolver {
 
   @FieldResolver()
   async author(@Root() recipe: Recipe): Promise<User> {
-    return (await this.userRepository.findOne(recipe.authorId, { cache: 1000 }))!;
+    return (await this.userRepository.findOne({ where: { id: recipe.authorId }, cache: 1000 }))!;
   }
 }

examples/typeorm-basic-usage/resolvers/types/rate-input.ts

@@ -2,8 +2,8 @@ import { InputType, Field, Int, ID } from "../../../../src";
 
 @InputType()
 export class RateInput {
-  @Field(type => ID)
-  recipeId: string;
+  @Field(type => Int)
+  recipeId: number;
 
   @Field(type => Int)
   value: number;

examples/typeorm-lazy-relations/resolvers/recipe-resolver.ts

@@ -17,7 +17,7 @@ export class RecipeResolver {
 
   @Query(returns => Recipe, { nullable: true })
   recipe(@Arg("recipeId", type => Int) recipeId: number) {
-    return this.recipeRepository.findOne(recipeId);
+    return this.recipeRepository.findOneBy({ id: recipeId });
   }
 
   @Query(returns => [Recipe])
@@ -37,7 +37,8 @@ export class RecipeResolver {
   @Mutation(returns => Recipe)
   async rate(@Ctx() { user }: Context, @Arg("rate") rateInput: RateInput): Promise<Recipe> {
     // find the recipe
-    const recipe = await this.recipeRepository.findOne(rateInput.recipeId, {
+    const recipe = await this.recipeRepository.findOne({
+      where: { id: rateInput.recipeId },
       relations: ["ratings"], // preload the relation as we will modify it
     });
     if (!recipe) {

examples/typeorm-lazy-relations/resolvers/types/rate-input.ts

@@ -1,9 +1,9 @@
-import { InputType, Field, Int, ID } from "../../../../src";
+import { InputType, Field, Int } from "../../../../src";
 
 @InputType()
 export class RateInput {
-  @Field(type => ID)
-  recipeId: string;
+  @Field(type => Int)
+  recipeId: number;
 
   @Field(type => Int)
   value: number;

package.json

@@ -13,7 +13,7 @@
     "check:format": "prettier --check \"{src,tests,examples}/**/*.{ts,js}\" \"docs/**/*.md\"",
     "check:type": "tsc --noEmit && tsc --noEmit -p ./examples/tsconfig.json",
     "check": "npm run check:format && npm run check:type",
-    "//lint": "tslint --project tsconfig.json",
+    "lint": "echo TODO: add ESLint",
     "verify": "npm run check && npm run lint",
     "package": "gulp package",
     "docs": "npm run --prefix website start",