Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Salesflare/hapi-csv
Convert response to CSV based on the response schema
https://github.com/Salesflare/hapi-csv
csv hapi hapi-csv hapijs joi
Last synced: 3 months ago
JSON representation
Convert response to CSV based on the response schema
- Host: GitHub
- URL: https://github.com/Salesflare/hapi-csv
- Owner: Salesflare
- License: mit
- Created: 2016-07-08T11:59:34.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-01-15T04:10:20.000Z (12 months ago)
- Last Synced: 2024-10-02T20:47:04.778Z (3 months ago)
- Topics: csv, hapi, hapi-csv, hapijs, joi
- Language: JavaScript
- Homepage:
- Size: 582 KB
- Stars: 6
- Watchers: 7
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- jimsghstars - Salesflare/hapi-csv - Convert response to CSV based on the response schema (JavaScript)
README
# hapi-csv [](https://travis-ci.org/Salesflare/hapi-csv)
## What
Converts the response to csv based on the Joi response schema when the Accept header includes `text/csv` or `application/csv` or the requested route ends with `.csv`.
Converts the response to xlsx (Excel) with the `enableExcel` option when the Accept header includes `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` or the requested route ends with `.xlsx`.
## How
`npm install --save hapi-csv`
Register the hapi-csv plugin on the server
```javascript
await server.register({
plugin: require('hapi-csv'),
options: {
maximumElementsInArray: 5,
separator: ',',
resultKey: 'items'
}
});
```
When you have a route on which a response schema is defined, like in the example below, the plugin will convert the response to csv when the Accept header includes `text/csv` or `application/csv` or the requested route ends with `.csv`
```javascript
const routes = [{
method: 'GET',
path: '/users',
handler: Users.getAll,
config: {
response: {
schema: Joi.object().keys({
first_name: Joi.string(),
last_name: Joi.string(),
age: Joi.number()
})
}
}
}]
```
Either do `GET /users` with header `Accept: text/csv` or `Accept: application/csv`.
Or do `GET /users.csv`.
The header approach is preferred.
When the request path ends in `.csv` the `.csv` part will be stripped and the accept header will be set to `text/csv`.
Currently the `Content-Disposition` header is set to `attachment;` by default since this plugin is intended for exporting purposes, if this hinders you just let us know.
### Paginated responses
To handle typical pagination responses pass the `resultKey` option. The value is the top level key you want to convert to csv.
```json
// paginated response
{
"page": 1,
"items": [
{ "name": "Anton", "age": 22 },
{ "name": "Lisa", "age": 25 }
]
}
```
```javascript
await server.register({
plugin: require('hapi-csv'),
options: {
resultKey: 'items' // We only want the `items` in csv
}
});
```
### Dynamic schemas
hapi-csv supports dynamic response schemas as well.
Imagine one of your property's schema is dynamic but you still want to export the value of it to csv.
You can tell hapi-csv to translate a given key on the fly when it is converting the response to csv (`onPreResponse`).
On the route config set the plugin config to an object like
```javascript
{
'keyPath': async (request) => {
return JoiSchema;
}
}
```
The key is the path of the property you want to resolve dynamically.
E.g.
```javascript
Joi.object().keys({
a: Joi.object(),
b: Joi.object().keys({
c: Joi.object()
})
})
```
If you want to convert `a` the key would be `a`.
For `c` it would be `b.c`.
Full example:
```javascript
server.route([{
...,
config: {
...,
response: {
schema: Joi.object().keys({
first_name: Joi.string(),
last_name: Joi.string(),
age: Joi.number(),
custom: Joi.object(),
deepCustom: Joi.object().keys({
deepestCustom: Joi.object()
})
})
},
plugins: {
'hapi-csv': {
'custom': (request) => {
const schema = Joi.object().keys({
id: Joi.number(),
name: Joi.string()
});
return schema;
},
'deepCustom.deepestCustom': (request) => {
throw new Error('nope');
}
}
}
}
])
```
### Excel
You can also enable Excel conversion.
It will convert the response to xlsx (Excel) when the Accept header includes `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` or the requested route ends with `.xlsx`.
```javascript
await server.register({
plugin: require('hapi-csv'),
options: {
enableExcel: true,
excelWriteOptions: { /* compression: false */ }
}
});
```
`excelWriteOptions` takes anything for [https://github.com/SheetJS/js-xlsx#writing-options](https://github.com/SheetJS/js-xlsx#writing-options)