Nestjs-yalc library

Nest-yalc stands for Nestjs - Yet Another Library Collection

Features

• Support of the CrudGen filters for the GraphQL endpoints
• Automatic runtime generation of CRUD endpoints using the NestJS dependency factory method
• Parametrized the generation of: Resolver, Service, Dataloader, TypeORM repository based on ORM entities and DTOs.
• Implemented JSON support for TypeORM entities by using decorators
• Possibility to handle MySQL views (read) and their relative table (write) via the same repository
• Custom decorators to extend the NestJS GraphQL library with features such as: field middleware, graphql-typeorm field mapping, nested field resolver with dataloader or join etc.
• Helper methods for jest to be integrated in a monorepo solution
• Utils classes and methods

Documentation

• How to create graphql API with nestjs-yalc/crud-gen

• How to use the Api-Strategy library

• How to use the DefaultError library

• How to use the EventManager module library, Event, Service

• How to use the Logger library

NPM package.json and Workspace

To handle scripts and dependencies between all the libraries of this collection we use a root package.json. At the moment it handles both the devDependencies needed to run the tests and the build process, as well as the dependencies of the libraries itself.

The npm workspace approach must be preferred by the way. It allows us to specify the dependencies and some scripts directly inside the package itself but still having the possibility of managing them from the root package.json. (see aws-sdk library for example)

Unit tests

The main package.json contain some scripts to run the unit test for all the libraries of this collection. It uses the jest projects feature in background configured by jest.config.ts by using a customized mechanism implemented in our @nest-yalc/jest library.

To run the tests with the coverage use npm run test:cov and then you can check the status of the tests by running npm run test:cov:serve Then you should be able to browse the coverage reports via: http://127.0.0.1:8080/lcov-report/

Pipeline

Currently our github pipeline checks that the linter and the tests are passing with 100% of coverage threshold

Directories and file names

the nestjs-yalc directory structure is flat to let it be integrated in other projects easily

• tsconfig.*.json
  • tsconfig.json -> used by the compiler and the IDE
  • tsconfig.test.json -> used by jest
  • tsconfig.dev.json -> used by other dev tools such as eslint
• test.js
• examples/ ->
• docs/ -> used for the the github pages markdown
• [other_libraries]/