Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pay-k/nestjs-response-utils
https://github.com/pay-k/nestjs-response-utils
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pay-k/nestjs-response-utils
- Owner: pay-k
- License: mit
- Created: 2019-11-17T13:45:29.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-04-29T02:26:41.000Z (almost 3 years ago)
- Last Synced: 2024-04-23T10:45:24.694Z (10 months ago)
- Language: TypeScript
- Size: 122 KB
- Stars: 4
- Watchers: 2
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@payk/nestjs-response-utils
Response (& Request) utils for NestJS
[](https://dev.azure.com/payk/PayK%20Public/_build/latest?definitionId=12&branchName=master)
## Installation
```
npm install @payk/nestjs-response-utils
```
## What does it do?
## Quick Start
Add a decorator on top of your method or controller
```ts
@UseInterceptors(new LoggingInterceptor(), new TransformResponseInterceptor(ResponseKYCDto))
```
The `LogginInterceptor` can also be added globally according to NestJS documentation.
The `TransformResponseInterceptor` accepts in his ctor the object it's supposed to transform and also a mapping function if the properties are named differently.
It's important to always put the logging interceptor first, as he needs to be the first to run and last to catch errors.
## Why & How
Our operation mode is that Dto goes into the controller and then into the service. And the service works with Models (DB Models mainly). The service then returns to the controller the Model and the controller transforms it into a Response DTO. To remove the boilerplate, the service should use a MetaResponse object and the controller the TransformResponseInterceptor that will do the transformation of the MetaResponse into the ResponseDTO.
The Service gets a RequestDTO and returns a `MetaRespone` created by the `MetaResponseGenerator` to the controller.
### MetaResponse
Do create a MetaResponse we have a MetaResponseGenerator class.
```ts
// Return an object (Model) and the require ResponseCode (HttpResponse normally)
MetaResponseGenerator.generateByResponseCode(
dbModel,
ResponseCodes.OK,
);
// Return an Error, no object needed.
MetaResponseGenerator.generateAnErrorResponse(
ResponseCodes.NOT_FOUND,
);
// Return an HttpStatus error
MetaResponseGenerator.generateErrorByStatus(
HttpStatus.OK,
{ error: 'object' }
)
```
### ResponseCode
The ResponseCode object assists in returning errors mainly. A few come by default in the `ResponseCodes` class. More can be initiated using the `ResponseCode` ctor
## LoggingInterceptor
The logging interceptor will log the request and response to the service.
### Masking Data
In order to mask data that shouldn't be logged, the `LoggingInterceptor` supports getting an array in his constructor of property names that should be masked.
```ts
new LoggingInterceptors(['propertyName','properyThatShouldBeMasked'])
```
Assuming the following Json:
```ts
{
name: 'Dan',
test: 'ing',
propertyName: 'I'll be masked',
inner: {
here: 'there',
properyThatShouldBeMasked: 123,
propertyName: 1111999
}
}
```
Will result in the following:
```ts
{
name: 'Dan',
test: 'ing',
propertyName: '--REDACTED--',
inner: {
here: 'there',
properyThatShouldBeMasked: '--REDACTED--',
propertyName: '--REDACTED--'
}
```