✨ Expose validation error fields and add error mapping utilities - #172
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Description of the PR
Adds a
fieldsproperty to theValidationError, listing the path to each property that failed validation. Nested objects and arrays are referenced using their full path, e.g.child.idoritems.0.name. The property is populated by thevalidateObjectandparseObjectutilities, and is empty when the validation failed for the payload as a whole.Several utilities mapping business errors to their
ErrorDtocounterpart are also introduced, meant to be used with thetryMaputility and the@TryMapdecorator:incorrectEntityVersionErrorAsDto,validationErrorAsDto, andforbiddenErrorAsDto.validationErrorAsDtoformats the validation messages as a bullet list and returns the failing fields to the caller. It optionally accepts an error type, such that a subclass of theValidationErrorcan be matched instead of the base error.The
forbiddenErrorAsDtoutility maps the newForbiddenError, a business-level error meant to be thrown by authorization logic. Because such logic is usually, but not always, used in an HTTP context, the error itself is defined independently of NestJS. Its message is not returned to the caller, such that it can freely describe why the operation was denied.📋 Check list