Merge branch 'release/3.2.0'

Author: hirsch

.env.example

@@ -51,8 +51,7 @@ CONTROLLERS=src/api/controllers/**/*Controller.ts
 MIDDLEWARES=src/api/middlewares/**/*Middleware.ts
 INTERCEPTORS=src/api/interceptors/**/*Interceptor.ts
 SUBSCRIBERS=src/api/subscribers/**/*Subscriber.ts
-QUERIES=src/api/queries/**/*Query.ts
-MUTATIONS=src/api/mutations/**/*Mutation.ts
+RESOLVERS=src/api/resolvers/**/*Resolver.ts
 
 #
 # GraphQL

.env.test

@@ -33,8 +33,7 @@ CONTROLLERS=src/api/controllers/**/*Controller.ts
 MIDDLEWARES=src/api/middlewares/**/*Middleware.ts
 INTERCEPTORS=src/api/interceptors/**/*Interceptor.ts
 SUBSCRIBERS=src/api/subscribers/**/*Subscriber.ts
-QUERIES=src/api/queries/**/*Query.ts
-MUTATIONS=src/api/mutations/**/*Mutation.ts
+RESOLVERS=src/api/resolvers/**/*Resolver.ts
 
 #
 # GraphQL

.gitignore

@@ -15,6 +15,7 @@ yarn-error.log
 .DS_Store
 Thumbs.db
 .tmp/
+src/api/schema.gql
 
 # Typing #
 typings/

README.md

@@ -55,6 +55,7 @@ Try it!! We are happy to hear your feedback or any kind of new features.
 - **Fast Database Building** with simple migration from [TypeORM](https://github.com/typeorm/typeorm).
 - **Easy Data Seeding** with our own factories.
 - **GraphQL** provides as a awesome query language for our api [GraphQL](http://graphql.org/).
+- **TypeGraphQL** thanks to [TypeGraphQL](https://19majkel94.github.io/type-graphql/) we have a some cool decorators to simplify the usage of GraphQL.
 - **DataLoaders** helps with performance thanks to caching and batching [DataLoaders](https://github.com/facebook/dataloader).
 
 ![divider](./w3tec-divider.png)
@@ -69,6 +70,8 @@ Try it!! We are happy to hear your feedback or any kind of new features.
 - [Logging](#-logging)
 - [Event Dispatching](#-event-dispatching)
 - [Seeding](#-seeding)
+- [GraphQL](#-graph-q-l)
+- [Docker](#-docker)
 - [Further Documentations](#-further-documentation)
 - [Related Projects](#-related-projects)
 - [License](#-license)
@@ -209,9 +212,9 @@ The swagger and the monitor route can be altered in the `.env` file.
 | **src/api/services/**             | Service layer |
 | **src/api/subscribers/**          | Event subscribers |
 | **src/api/validators/**           | Custom validators, which can be used in the request classes |
-| **src/api/queries/**              | GraphQL queries |
-| **src/api/mutations/**            | GraphQL mutations |
-| **src/api/types/**                | GraphQL types |
+| **src/api/resolvers/**            | GraphQL resolvers (query, mutation & field-resolver) |
+| **src/api/types/**                | GraphQL types ,input-types and scalar types |
+| **src/api/** schema.gql           | Generated GraphQL schema |
 | **src/api/** swagger.json         | Swagger documentation |
 | **src/auth/**                     | Authentication checkers and services |
 | **src/core/**                     | The core features like logger and env variables |
@@ -392,7 +395,56 @@ yarn start db.seed
 
 ![divider](./w3tec-divider.png)
 
-## ❯ Run in Docker container
+## ❯ GraphQL
+
+For the GraphQL part we used the library [TypeGraphQL](https://19majkel94.github.io/type-graphql/) to build awesome GraphQL API's.
+
+The context(shown below) of the GraphQL is builded in the **graphqlLoader.ts** file. Inside of this loader we create a scoped container for each incoming request.
+
+```typescript
+export interface Context {
+  requestId: number;
+  request: express.Request;
+  response: express.Response;
+  container: ContainerInstance;
+}
+```
+
+### DataLoader
+
+For the usage of the DataLoaders we created a annotation, which automatically creates and registers a new DataLoader to the scoped container.
+
+Here is an example of the **PetResolver**.
+
+```typescript
+import DataLoader from 'dataloader';
+import { DLoader } from '../../decorators/DLoader';
+    ...
+    constructor(
+        private petService: PetService,
+        @Logger(__filename) private log: LoggerInterface,
+        @DLoader(UserModel) private userLoader: DataLoader<string, UserModel>
+    ) { }
+    ...
+```
+
+Or you could use the repository too.
+
+```typescript
+@DLoader(UserRepository) private userLoader: DataLoader<string, UserModel>
+```
+
+Or even use a custom method of your given repository.
+
+```typescript
+@DLoader(PetRepository, {
+    method: 'findByUserIds',
+    key: 'userId',
+    multiple: true,
+}) private petLoader: DataLoader<string, PetModel>
+```
+
+## ❯ Docker
 
 ### Install Docker
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-typescript-boilerplate",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "A delightful way to building a Node.js RESTful API Services with beautiful code written in TypeScript",
   "main": "src/app.ts",
   "scripts": {
@@ -40,7 +40,7 @@
   "dependencies": {
     "bcrypt": "3.0.1",
     "chalk": "^2.4.1",
-    "class-validator": "0.9.1",
+    "class-validator": "^0.9.1",
     "commander": "^2.19.0",
     "compression": "^1.7.1",
     "copyfiles": "^2.1.0",
@@ -71,6 +71,7 @@
     "swagger-ui-express": "4.0.1",
     "ts-node": "7.0.1",
     "tslint": "^5.8.0",
+    "type-graphql": "^0.15.0",
     "typedi": "0.8.0",
     "typeorm": "^0.2.5",
     "typeorm-seeding": "^1.0.0-beta.6",

src/api/Context.ts

@@ -0,0 +1,9 @@
+import express from 'express';
+import { ContainerInstance } from 'typedi';
+
+export interface Context {
+  requestId: number;
+  request: express.Request;
+  response: express.Response;
+  container: ContainerInstance;
+}

src/api/models/Pet.ts

@@ -21,7 +21,7 @@ export class Pet {
         name: 'user_id',
         nullable: true,
     })
-    public userId: number;
+    public userId: string;
 
     @ManyToOne(type => User, user => user.pets)
     @JoinColumn({ name: 'user_id' })