Press n or j to go to the next uncovered block, b, p or k for the previous block.
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 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 | 21x 21x 21x 18x 16x 3x 21x 18x 18x 2x 2x 16x 1x 15x 15x 13x 15x 1x 1x 1x 14x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 5x 5x 7x 7x 3x 7x 5x 5x 4x 4x 4x 4x 4x 4x 4x 4x 4x 16x 16x 4x 4x 4x 16x | import normalize from 'json-api-normalizer' import { Api } from './Api' import { ApiError, NotFoundApiError } from '../errors/ApiError' import { ModuleBuilder } from '../module/ModuleBuilder' import { ResourceProxy } from './ResourceProxy' import { deref, hasOwn } from '../shared/utils' import { Performance } from '../shared/Performance' export class ResourcefulApi extends Api { /** * Extends `Api::doRequest()` to handle some data preprocessing. * * The api modules don't require access to all of the response * and they expect the response data to be normalized. * * @inheritdoc * @param {String} method * @param {String} url * @param {Object} params * @param {Object} data */ async _doRequest (method, url, params, data) { Iif (data) { data = this.preprocessData(data) } return super._doRequest(method, url, params, data) .then(async (response) => { if (this._shouldDecodeResponseJson(response.status)) { const json = await this._decodeResponseJson(response) return this._parseResponse(response.status, json) } return this._createDatalessResponse(response) }) } _shouldDecodeResponseJson (status) { return [200, 201, 404, 409].includes(status) } async _decodeResponseJson (response) { try { return await response.json() } catch (e) { Eif (response.status === 404) { throw new NotFoundApiError('Resource not found') } throw new ApiError('Failed to decode response json') } } _parseResponse (status, json) { if (!(hasOwn(json, 'data') || hasOwn(json, 'errors'))) { throw new ApiError('Response object must have either a `data` or an `errors` property.') } const parsedResponse = { meta: json.meta ? json.meta : {}, links: json.links ? json.links : {}, status: status } if (json.data) { parsedResponse.data = normalize(json) } if (json.errors) { parsedResponse.errors = json.errors switch (status) { case 404: throw new NotFoundApiError('Resource not found but received error info', json.errors) } } return parsedResponse } _createDatalessResponse (response) { return { data: null, meta: null, links: null, status: response.status } } /** * convert ResourceTypes to uppercase * to follow the json:api spects even if the incoming data is not correct * * this is just a safety net * * @param data * * @return {*} */ preprocessData (data) { data = deref(data) data.data.type = data.data.type.charAt(0).toUpperCase() + data.data.type.slice(1) Eif (data.data.relationships) { const relationships = {} const casingWarning = (type) => { console.warn(`The Resource with type '${type}' is sent in lower camel case. Please send as upper camel case.`) } for (const [name, relationship] of Object.entries(data.data.relationships)) { Iif (Array.isArray(relationship.data)) { relationships[name] = { data: relationship.data.map(itemData => { const startChar = itemData.type.charAt(0) if (startChar === startChar.toLocaleLowerCase()) { casingWarning(itemData.type) } return { id: itemData.id, type: startChar.toUpperCase() + itemData.type.slice(1) } }) } } else Iif (relationship.data !== null) { const startChar = relationship.data.type.charAt(0) if (startChar === startChar.toLocaleLowerCase()) { casingWarning(relationship.data.type) } relationships[name] = { data: { id: relationship.data.id, type: startChar.charAt(0).toUpperCase() + relationship.data.type.slice(1) } } } else Eif (relationship.data === null) { relationships[name] = { data: null } } } data.data.relationships = relationships } return data } /** * Prepare the routable requests * * @param {Router} router */ setupResourcefulRequests (router) { this.router = router Performance.mark('api_setup_routing_start') const routes = router.getRoutes() this.registerableModules = {} for (const routeName of Object.keys(routes)) { const methods = routes[routeName] this.registerResourceMethods(routeName, methods) this.registerableModules[routeName] = methods } Performance.mark('api_setup_routing_end') Performance.measure( 'api: setup resourceful routing', 'api_setup_routing_start', 'api_setup_routing_end' ) } /** * * @param {Vuex.Store} store */ setStore (store) { this.store = store } /** * * @param {Array} apiModulesToRegister */ setupApiModules (apiModulesToRegister = []) { Performance.mark('api_setup_modules_start') apiModulesToRegister.forEach(moduleName => { let resourceProxy = this[moduleName] if (!resourceProxy) { resourceProxy = new ResourceProxy() } this.registerModule(moduleName, resourceProxy) }) Performance.mark('api_setup_modules_end') Performance.measure( 'api: setup api modules', 'api_setup_modules_start', 'api_setup_modules_end' ) } /** * * @param {String} moduleName * @param {Route} methods */ registerModule (moduleName, methods) { // prevent double registration Iif (hasOwn(this.store.state, moduleName)) { return } const moduleBuilder = new ModuleBuilder(this, moduleName, methods) const module = moduleBuilder.build() Eif (moduleName) { this.store.registerModule(moduleName, module) } } /** * * @param {String} routeName * @param {Route} methods */ registerResourceMethods (routeName, methods) { this[routeName] = new ResourceProxy(this) Performance.mark('api_setup_proxies_start') const relationsToBeAdded = [] for (const methodName of Object.keys(methods)) { Iif (this.isRelationMethodName(methodName)) { relationsToBeAdded.push(methodName) continue } this[routeName].addRoute(methods[methodName]) } relationsToBeAdded.forEach(relationToBeAdded => { const [relationIdentifier, relationName] = relationToBeAdded.split('.') this[relationIdentifier].addRelation(relationName, this[relationName]) }) Performance.mark('api_setup_proxies_end') Performance.measure( 'api: add method proxies for route ' + routeName, 'api_setup_proxies_start', 'api_setup_proxies_end' ) } isRelationMethodName (methodName) { return methodName.indexOf('related.') === 0 } /** * Register an api module * * After api initialization, this is the way to register * non-default modules. * * its purpose is to get called from store, where its referenced from the initJsonApiPlugin. * At that point `this` is the store and not the api object * * @param {String} moduleName */ registerApiModule (moduleName) { return this.api.registerModule(moduleName, this.api[moduleName]) } /** * Get a list of available api modules * * A module is available if it has defined routing. * If `onlyUnregistered` is set to false, this list * will also return already registered modules. * * @param {Boolean} onlyUnregistered * @returns {Array} */ getAvailableApiModules (onlyUnregistered = true) { const availableModules = Object.keys(this.registerableModules) if (onlyUnregistered) { return availableModules.filter((moduleName) => { return !hasOwn(this.state, moduleName) }) } return availableModules } } |