feat: add type-graphql for declaring GraphQL schema

Author: samuel27m

package-lock.json

@@ -8,17 +8,20 @@
     "start": "node dist/index.js",
     "start:dev": "ts-node-dev --inspect --transpile-only --ignore-watch node_modules --respawn src/index.ts",
     "test": "jest --runInBand",
-    "test:dev": "node --inspect ./node_modules/jest/bin/jest.js --runInBand" 
+    "test:dev": "node --inspect ./node_modules/jest/bin/jest.js --runInBand"
   },
   "author": "Samuel Caçador",
   "license": "MIT",
   "dependencies": {
     "apollo-server": "^3.6.3",
     "apollo-server-express": "^3.6.3",
+    "class-validator": "^0.13.2",
     "dotenv": "^16.0.0",
     "express": "^4.17.3",
-    "graphql": "^16.3.0",
-    "graphql-playground-middleware-express": "^1.7.23"
+    "graphql": "^15.8.0",
+    "graphql-playground-middleware-express": "^1.7.23",
+    "reflect-metadata": "^0.1.13",
+    "type-graphql": "^1.1.1"
   },
   "devDependencies": {
     "@types/express": "^4.17.13",

package.json

@@ -0,0 +1,13 @@
+import { ObjectType, Field, ID } from 'type-graphql';
+
+@ObjectType()
+export class Recipe {
+    @Field(type => ID)
+    id: string;
+
+    @Field()
+    title: string;
+
+    @Field({ nullable: true })
+    description?: string;
+}

src/entities/Recipe.ts

@@ -1,13 +1,14 @@
+import 'reflect-metadata';
 import 'dotenv/config';
 import express from 'express';
 import router from './router';
-import { apolloServer } from './services/ApolloServices/ApolloServerService';
+import { createApolloServer } from './services/ApolloServices/ApolloServerService';
 
 const app = express();
 
-apolloServer
-    .start()
-    .then(() => {
+createApolloServer()
+    .then(async (apolloServer: { start: () => void; getMiddleware: () => any }) => {
+        await apolloServer.start();
         app.use(express.json());
         app.use(apolloServer.getMiddleware());
         app.use(router);

src/index.ts

@@ -0,0 +1,16 @@
+import { Resolver, Query } from 'type-graphql';
+import { Recipe } from '../entities/Recipe';
+
+@Resolver(Recipe)
+export class RecipeResolver {
+    @Query(() => [Recipe])
+    recipes() {
+        return [
+            {
+                id: '1',
+                title: '123',
+                description: ' lol',
+            },
+        ];
+    }
+}

src/resolvers/RecipeResolver.ts

@@ -1,23 +1,14 @@
-import { ApolloServer, gql } from 'apollo-server-express';
-
-// The GraphQL schema
-const typeDefs = gql`
-    type Query {
-        "A simple type for getting started!"
-        hello: String
-    }
-`;
-
-// A map of functions which return data for the schema.
-const resolvers = {
-    Query: {
-        hello: () => 'world',
-    },
-};
-
-const apolloServer = new ApolloServer({
-    typeDefs,
-    resolvers,
-});
-
-export { apolloServer };
+import { ApolloServer } from 'apollo-server-express';
+import { buildSchema } from 'type-graphql';
+import { RecipeResolver } from '../../resolvers/RecipeResolver';
+
+async function createApolloServer(): Promise<ApolloServer> {
+    const schema = await buildSchema({
+        resolvers: [RecipeResolver],
+    });
+    return new ApolloServer({
+        schema: schema,
+    });
+}
+
+export { createApolloServer };

src/services/ApolloServices/ApolloServerService.ts

@@ -1,15 +1,29 @@
-import { apolloServer } from '../../../src/services/ApolloServices/ApolloServerService';
+import 'reflect-metadata';
+import { createApolloServer } from '../../../src/services/ApolloServices/ApolloServerService';
 
 describe('ApolloServiceService', () => {
-    it('hello resolver', async () => {
-        const query = `{ hello }`;
+    it('recipe resolver', async () => {
+        const apolloServer = await createApolloServer();
+        const query = `{
+          recipes {
+            id
+            title
+            description
+          }
+        }`;
 
         const result = await apolloServer.executeOperation({
             query,
         });
 
         expect(result.data).toMatchObject({
-            hello: 'world',
+            recipes: [
+                {
+                    id: '1',
+                    title: '123',
+                    description: ' lol',
+                },
+            ],
         });
     });
 });

tests/services/ApolloServices/ApolloServerService.spec.ts

@@ -5,10 +5,14 @@
     "rootDir": "./src",
     "allowJs": false,
     "outDir": "./dist",
+    "lib": ["ES2020", "esnext.asynciterable"],
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "strict": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "strictPropertyInitialization": false
   },
   "include": [
     "./src/**/*"