Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trevorblades/hapi-format-validation
⚠️ Formats validation errors in Hapi
https://github.com/trevorblades/hapi-format-validation
api error-handling error-messages hapi joi sequelize
Last synced: 2 months ago
JSON representation
⚠️ Formats validation errors in Hapi
- Host: GitHub
- URL: https://github.com/trevorblades/hapi-format-validation
- Owner: trevorblades
- Created: 2017-10-24T03:54:25.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-30T00:23:03.000Z (about 6 years ago)
- Last Synced: 2024-09-17T00:29:08.201Z (3 months ago)
- Topics: api, error-handling, error-messages, hapi, joi, sequelize
- Language: JavaScript
- Homepage: https://npm.im/hapi-format-validation
- Size: 86.9 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hapi-format-validation
[](https://travis-ci.com/trevorblades/hapi-format-validation)
This [Hapi](https://hapijs.com/) plugin formats validation errors in a way that is consistent, simple, and easy to render in client-side forms. Take your typical [Joi](https://github.com/hapijs/joi) validation error reply for instance...
#### Before `hapi-format-validation` 😿
```js
{
statusCode: 400,
error: 'Bad Request',
// this message should get formatted before displaying it to a user
message: 'child "name" fails because ["name" is not allowed to be empty]. child "email" fails because ["email" must be a valid email]',
validation: {
source: 'payload',
// extra work required of the client to link these keys to error messages :(
keys: [
'name',
'email'
]
}
}
```
#### After `hapi-format-validation` 😍
```js
{
statusCode: 400,
error: 'Bad Request',
// a newline-separated string, ready-to-use if necessary
message: '"name" is not allowed to be empty↵"email" must be a valid email',
validation: {
source: 'payload',
// a simple key-value mapping of fields and their errors
errors: {
name: '"name" is not allowed to be empty',
email: '"email" must be a valid email'
}
}
}
```
## Installation
```shell
$ npm install --save hapi-format-validation
```
## Usage
```js
const FormatValidation = require('hapi-format-validation');
server.register(FormatValidation, err => {
// server fun times
});
```
## Options
- **`stripQuotes`**: (optional) if `true`, strips double quotation marks from around the path name in error messages
- **`capitalize`**: (optional) if `true`, capitalizes the first letter of each error message
- **`sequelize`**: (optional) pass a `Sequelize` instance to format unique key violations (more information below)
## Sequelize integration
`hapi-format-validation` also handles Sequelize unique key violation errors, which would otherwise be a `500 Internal Server Error`. Pass your `Sequelize` instance ([sold separately](http://docs.sequelizejs.com/)) as an option to the plugin when you register it to enable this feature.
```js
const FormatValidation = require('hapi-format-validation');
const Sequelize = require('sequelize');
const sequelize = new Sequelize(...);
server.register(
{
register: FormatValidation,
options: {sequelize}
},
err => {
// do your server stuff
}
);
```
#### Before
```js
{
statusCode: 500,
error: 'Internal Server Error',
message: 'An internal server error occurred'
}
```
#### After
```js
{
'statusCode': 400,
'error': 'Bad Request',
'message': '"username" must be unique',
'validation': {
'source': 'payload',
'errors': {
'username': '"username" must be unique'
}
}
}
```
## Acknowledgements 👊
- [joi-errors-for-forms](https://github.com/eddyystop/joi-errors-for-forms) for the validation payload format inspiration
- [This article](https://medium.com/@andv/hapi-transforming-an-internal-server-error-occured-into-correct-boom-errors-1a2a72e6ffff) by [Andrey Viktorov](https://medium.com/@andv) for the idea around using the `onPreResponse` hook and checking for Sequelize errors