@payk/nestjs-response-utils
v2.2.2
Published
NestJS Response Transformers, Interceptors and utils
Downloads
5
Readme
Installation
npm install @payk/nestjs-response-utils
What does it do?
Quick Start
Add a decorator on top of your method or controller
@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.
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<Model>
created by the MetaResponseGenerator
to the controller.
MetaResponse
Do create a MetaResponse we have a MetaResponseGenerator class.
// 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.
new LoggingInterceptors(['propertyName','properyThatShouldBeMasked'])
Assuming the following Json:
{
name: 'Dan',
test: 'ing',
propertyName: 'I'll be masked',
inner: {
here: 'there',
properyThatShouldBeMasked: 123,
propertyName: 1111999
}
}
Will result in the following:
{
name: 'Dan',
test: 'ing',
propertyName: '--REDACTED--',
inner: {
here: 'there',
properyThatShouldBeMasked: '--REDACTED--',
propertyName: '--REDACTED--'
}