json-api-response-js
Version:
JSON API Standard compliant http response library.
317 lines (282 loc) • 14.9 kB
Markdown
# json-api-response-js
JSON API compliant http response library.
[](https://badge.fury.io/js/json-api-response-js)
[](https://travis-ci.org/jmilagroso/typcheckjs)
[](https://coveralls.io/github/jmilagroso/json-api-response-js?branch=master)
## Tech
**json-api-response-js** uses a number of open source projects to work properly:
* [jsonapi-serializer](https://github.com/SeyZ/jsonapi-serializer) - A Node.js framework agnostic library for (de)serializing your data to JSON API (1.0 compliant).
* [typcheckjs](https://github.com/jmilagroso/typcheckjs) - JS data type checking.
### Setup
```sh
npm install --save json-api-response-js
```
### Usage
```sh
const JSONApiResponse = require('json-api-response-js');
// Using axios
...
axios.get(process.env.SOME_URL, {
method: 'POST',
headers: {
...
'Content-Type': 'application/json',
...
},
}).then((response) => {
callback(null, JSONApiResponse.ok({
message: '...',
data: { ... },
}));
}).catch((error) => {
callback(null, JSONAPIResponse.internalServerError({
message: '...',
data: error,
}));
});
...
```
### Sample Output
```sh
// Handling Object Nested Payload
const payload = {
id: 1,
order_id: 10,
name: 'Gwen Hester',
info: {
mobile: '+63 919 123 4567',
age: 25,
status: 'married'
},
};
const response = JSONApiResponse.created(payload);
// Output
{ status: 201,
headers:
{ 'Content-Type': 'application/vnd.api+json',
responseHeaders:
{ 'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Credentials': true } },
body: '{"data":{"type":"serializes","id":"1","attributes":{"id":1,"order-id":10,"name":"Gwen Hester","info":{"mobile":"+63 919 123 1234","age":25,"status":"married"}}}}' }
// Handling Array Nested Payload
const arrayNestedPayload = [{
id: 1,
order_id: 10,
name: 'JL Raymundo',
info: {
mobile: '+63 918 123 4567',
age: 25,
status: 'single'
},
country: {
code: 'PH',
name: 'Philippines'
}
},
{
id: 2,
order_id: 11,
name: 'Eugene Santos',
info: {
mobile: '+63 917 123 4567',
age: 35,
status: 'married'
},
country: {
code: 'PH',
name: 'Philippines'
}
}
];
const response = JSONApiResponse.accepted(arrayNestedPayload);
// Output
{ status: 201,
headers:
{ 'Content-Type': 'application/vnd.api+json',
responseHeaders:
{ 'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Credentials': true } },
body: '{"data":[{"type":"serializes","id":"1","attributes":{"id":1,"order-id":10,"name":"JL Raymundo","info":{"mobile":"+63 918 123 4567","age":25,"status":"single"},"country":{"code":"PH","name":"Philippines"}}},{"type":"serializes","id":"2","attributes":{"id":2,"order-id":11,"name":"Eugene Santos","info":{"mobile":"+63 917 123 4567","age":35,"status":"married"},"country":{"code":"PH","name":"Philippines"}}}]}' }
```
### References
```sh
const JSONApiResponse = require('json-api-response-js');
// Status Code 200, OK
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.ok({...});
// Status Code 201, Created
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.created({...});
// Status Code 202, Accepted
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.accepted({...});
// Status Code 206, Partial Content
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.partialContent({...});
// Status Code 301, Moved Permanently
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.movedPermanently({...});
// Status Code 304, Not Modified
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.notModified({...});
// Status Code 400, Bad Request
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.badRequest({...});
// Status Code 401, Unauthorized
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.unauthorized({...});
// Status Code 403, Forbidden
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.forbidden({...});
// Status Code 404, Not Found
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.notFound({...});
// Status Code 405, Method Not Allowed
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.methodNotAllowed({...});
// Status Code 500, Internal Server Error
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.internalServerError({...});
// Custom. Statue 302, Found
// @param Object data - The object payload. (Default value: {})
// @param string type - The JSON API data type. (Default value: 'response')
// @param integer status - The HTTP response status. (Default value: 200)
// @param string contentType - The HTTP response content type. (Default value: 'application/vnd.api+json')
// @param Object responseHeaders - The HTTP response headers. (Default value: {
// 'Access-Control-Allow-Origin':
// '*','Access-Control-Allow-Credentials': true}
// )
JSONApiResponse.custom({...}, 'custom-response-type', 302, 'application/json', {
'CUSTOM-HEADER': 'VALUE'
}});
```
### Tests
```sh
✘ jay@ThinkPad /usr/share/nginx/html/json-api-response-js npm test
> json-api-response-js@1.0.0 test /usr/share/nginx/html/json-api-response-js
> jest --coverage
PASS __tests__/index.test.js
testing index.js
✓ it should invoke index.ok function with array and return JSON API standard response (5ms)
✓ it should invoke index.ok function with object and return JSON API standard response
✓ it should invoke index.ok function with object (nested) and return JSON API standard response (1ms)
✓ it should invoke index.created function with array and return JSON API standard response (1ms)
✓ it should invoke index.created function with object and return JSON API standard response
✓ it should invoke index.created function with object (nested) and return JSON API standard response (1ms)
✓ it should invoke index.accepted function with array and return JSON API standard response
✓ it should invoke index.accepted function with object and return JSON API standard response
✓ it should invoke index.accepted function with object (nested) and return JSON API standard response (1ms)
✓ it should invoke index.partialContent function with array and return JSON API standard response (1ms)
✓ it should invoke index.partialContent function with object and return JSON API standard response
✓ it should invoke index.partialContent function with object (nested) and return JSON API standard response
✓ it should invoke index.movedPermanently function with array and return JSON API standard response (1ms)
✓ it should invoke index.movedPermanently function with object and return JSON API standard response
✓ it should invoke index.movedPermanently function with object (nested) and return JSON API standard response
✓ it should invoke index.notModified function with array and return JSON API standard response
✓ it should invoke index.notModified function with object and return JSON API standard response
✓ it should invoke index.notModified function with object (nested) and return JSON API standard response
✓ it should invoke index.badRequest function with array and return JSON API standard response (1ms)
✓ it should invoke index.badRequest function with object and return JSON API standard response
✓ it should invoke index.badRequest function with object (nested) and return JSON API standard response
✓ it should invoke index.unauthorized function with array and return JSON API standard response (1ms)
✓ it should invoke index.unauthorized function with object and return JSON API standard response
✓ it should invoke index.unauthorized function with object (nested) and return JSON API standard response
✓ it should invoke index.forbidden function with array and return JSON API standard response (1ms)
✓ it should invoke index.forbidden function with object and return JSON API standard response
✓ it should invoke index.forbidden function with object (nested) and return JSON API standard response
✓ it should invoke index.notFound function with array and return JSON API standard response
✓ it should invoke index.notFound function with object and return JSON API standard response (1ms)
✓ it should invoke index.notFound function with object (nested) and return JSON API standard response
✓ it should invoke index.methodNotAllowed function with array and return JSON API standard response
✓ it should invoke index.methodNotAllowed function with object and return JSON API standard response (1ms)
✓ it should invoke index.methodNotAllowed function with object (nested) and return JSON API standard response
✓ it should invoke index.internalServerError function with array and return JSON API standard response
✓ it should invoke index.internalServerError function with object and return JSON API standard response (1ms)
✓ it should invoke index.internalServerError function with object (nested) and return JSON API standard response
✓ it should invoke index.custom function with array and return JSON API standard response
✓ it should invoke index.custom function with object and return JSON API standard response
✓ it should invoke index.custom function with object (nested) and return JSON API standard response (1ms)
----------|----------|----------|----------|----------|-------------------|
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s |
----------|----------|----------|----------|----------|-------------------|
All files | 100 | 63.27 | 100 | 100 | |
index.js | 100 | 63.27 | 100 | 100 |... 28,138,148,158 |
----------|----------|----------|----------|----------|-------------------|
Test Suites: 1 passed, 1 total
Tests: 39 passed, 39 total
Snapshots: 0 total
Time: 1.094s
Ran all test suites.
```