hapify-templates-nestjs-graphql

This library host the templates that will be generate to be used with the graphql server

How to generate the files

You can register this module inside your hapifyrc file:

1module.export = {
2  // ...
3  extends: ['@trxn/hapify-templates-nestjs-graphql'],
4  importReplacements: {
5    models: '@trxn/generated-models',
6    'nestjs-models-common': '@trxn/generated-nestjs-models-common',
7  },
8}

You can add the generate target to your nx libs that will handle the generation for you

1{
2  "targets":{
3    "generate": {
4      "executor": "@trxn/schematics:generate",
5      "options": {
6        "cwd": "libs/nestjs/graphql"
7      }
8    }
9  }
10}

You must add a new prisma generator inside your base prisma schema (libs/prisma/prisma/schemas/base.schema) with this minimal configuration:

1generator nestjsGraphql {
2  provider = "prisma-nestjs-graphql"
3  output = "../../../nestjs/graphql/src/generated/prisma-nestjs-graphql"
4  purgeOutput = true
5  reExport = Single
6  fields_Validator_from = "class-validator"
7  fields_Validator_input = true
8}

To finalize the installation you can install some extra packages:

1npm i --save-dev prisma-nestjs-graphql @trxn/hapify-templates-nestjs-graphql

1npm i --save @nestjs/apollo @nestjs/graphql @paljs/plugins @trxn/nestjs-graphql apollo-server-core apollo-server-express

How to use inside your nestjs app

After the generated files you will be able to use the exported graphql module inside your application. In your app.module.ts you should add this lines:

1import { GraphQLModule } from '@nestjs/graphql';
2import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
3import { GraphQLModelsModule } from '@myProject/nestjs-graphql';
4
5@Module({
6  imports: [
7    GraphQLModelsModule,
8    GraphQLModule.forRoot<ApolloDriverConfig>({
9      driver: ApolloDriver,
10      include: [GraphQLModelsModule],
11      autoSchemaFile: 'schema.gql',
12      sortSchema: true,
13      debug: true,
14    }),
15    // ...
16  ]
17  // ...
18})
19export class AppModule {}

:warning: The class validator will validate for you the input but the graphql args is not fully annoted yet. To be able to use this library you should remove this class validator options from your main.ts file

1whitelist: true,
2forbidNonWhitelisted: true,