@coding-blocks/jsonapi-server

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/responseHelper.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../prettify.css" /> <link rel="stylesheet" href="../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../index.html">All files</a> / <a href="index.html">lib</a> responseHelper.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 17.89% Statements 17/95 </div> <div class='fl pad1y space-right2'> 0% Branches 0/42 </div> <div class='fl pad1y space-right2'> 0% Functions 0/21 </div> <div class='fl pad1y space-right2'> 20.99% Lines 17/81 </div> </div> </div> <div class='status-line low'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213</td><td class="line-coverage quiet">  1x   1x       1x 1x 1x 1x   1x     1x       1x                       1x                                           1x                                                   1x       1x                       1x                                                                                                                                   1x                                             1x                           1x                            </td><td class="text"><pre class="prettyprint lang-js">'use strict' const responseHelper = module.exports = { }   const _ = { assign: require('lodash.assign'), pick: require('lodash.pick') } const async = require('async') const pagination = require('./pagination.js') const Joi = require('joi') const debug = require('./debugging.js')   responseHelper.setBaseUrl = baseUrl => { responseHelper._baseUrl = baseUrl } responseHelper.setMetadata = meta => { responseHelper._metadata = meta }   responseHelper._enforceSchemaOnArray = (items, schema, callback) => { if (!(Array.isArray(items))) { items = [ items ] } async.map(items, (item, done) => responseHelper._enforceSchemaOnObject(item, schema, done), (err, results) => { if (err) return callback(err)   results = results.filter(result => !!result) return callback(null, results) }) }   responseHelper._enforceSchemaOnObject = (item, schema, callback) => { debug.validationOutput(JSON.stringify(item)) Joi.validate(item, schema, (err, sanitisedItem) => { if (err) { debug.validationError(err.message, JSON.stringify(item)) const res = { status: '500', code: 'EINVALIDITEM', title: 'Item in response does not validate', detail: { item: item, error: err.message } } return callback(res) }   const dataItem = responseHelper._generateDataItem(sanitisedItem, schema) return callback(null, dataItem) }) }   responseHelper._generateDataItem = (item, schema) => { const isSpecialProperty = value => { if (!(value instanceof Object)) return false if (value._settings) return true return false } const linkProperties = Object.keys(schema).filter(someProperty => isSpecialProperty(schema[someProperty])) const attributeProperties = Object.keys(schema).filter(someProperty => { if (someProperty === 'id') return false if (someProperty === 'type') return false if (someProperty === 'meta') return false return !isSpecialProperty(schema[someProperty]) })   const result = { type: item.type, id: item.id, attributes: _.pick(item, attributeProperties), links: responseHelper._generateLinks(item, schema, linkProperties), relationships: responseHelper._generateRelationships(item, schema, linkProperties), meta: item.meta }   return result }   responseHelper._generateLinks = item => ({ self: `${responseHelper._baseUrl + item.type}/${item.id}` })   responseHelper._generateRelationships = (item, schema, linkProperties) => { if (linkProperties.length === 0) return undefined   const links = { }   linkProperties.forEach(linkProperty => { links[linkProperty] = responseHelper._generateLink(item, schema[linkProperty], linkProperty) })   return links }   responseHelper._generateLink = (item, schemaProperty, linkProperty) => { const link = { meta: { relation: 'primary', // type: schemaProperty._settings.__many || schemaProperty._settings.__one, readOnly: false }, links: { self: `${responseHelper._baseUrl + item.type}/${item.id}/relationships/${linkProperty}`, related: `${responseHelper._baseUrl + item.type}/${item.id}/${linkProperty}` }, data: null }   if (schemaProperty._settings.__many) { // $FlowFixMe: the data property can be either undefined (not present), null or [ ] link.data = [ ] let linkItems = item[linkProperty] if (linkItems) { if (!(Array.isArray(linkItems))) linkItems = [ linkItems ] linkItems.forEach(linkItem => { link.data.push({ type: linkItem.type, id: linkItem.id, meta: linkItem.meta }) }) } }   if (schemaProperty._settings.__one) { const linkItem = item[linkProperty] if (linkItem) { // $FlowFixMe: the data property can be either undefined (not present), null or [ ] link.data = { type: linkItem.type, id: linkItem.id, meta: linkItem.meta } } }   if (schemaProperty._settings.__as) { const relatedResource = (schemaProperty._settings.__one || schemaProperty._settings.__many)[0] // get information about the linkage - list of ids and types // /rest/bookings/relationships/?customer=26aa8a92-2845-4e40-999f-1fa006ec8c63 link.links.self = `${responseHelper._baseUrl + relatedResource}/relationships/?${schemaProperty._settings.__as}=${item.id}` // get full details of all linked resources // /rest/bookings/?filter[customer]=26aa8a92-2845-4e40-999f-1fa006ec8c63 link.links.related = `${responseHelper._baseUrl + relatedResource}/?filter[${schemaProperty._settings.__as}]=${item.id}` if (!item[linkProperty]) { // $FlowFixMe: the data property can be either undefined (not present), null or [ ] link.data = undefined } link.meta = { relation: 'foreign', belongsTo: relatedResource, as: schemaProperty._settings.__as, many: !!schemaProperty._settings.__many, readOnly: true } }   return link }   responseHelper.generateError = (request, err) => { debug.errors(request.route.verb, request.route.combined, JSON.stringify(err)) if (!(Array.isArray(err))) err = [ err ]   const errorResponse = { jsonapi: { version: '1.0' }, meta: responseHelper._generateMeta(request), links: { self: responseHelper._baseUrl + request.route.path }, errors: err.map(error => ({ status: error.status, code: error.code, title: error.title, detail: error.detail })) }   return errorResponse }   responseHelper._generateResponse = (request, resourceConfig, sanitisedData, handlerTotal) => ({ jsonapi: { version: '1.0' },   meta: responseHelper._generateMeta(request, handlerTotal),   links: _.assign({ self: responseHelper._baseUrl + request.route.path + (request.route.query ? ('?' + request.route.query) : '') }, pagination.generatePageLinks(request, handlerTotal)),   data: sanitisedData })   responseHelper._generateMeta = (request, handlerTotal) => { let meta if (typeof responseHelper._metadata === 'function') { meta = responseHelper._metadata(request) } else { meta = _.assign({ }, responseHelper._metadata) }   if (handlerTotal) { meta.page = pagination.generateMetaSummary(request, handlerTotal) }   return meta }  </pre></td></tr> </table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sat Jan 27 2018 19:59:16 GMT+0530 (IST) </div> </div> <script src="../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../sorter.js"></script> </body> </html>