feat: add request data callbacks

This removes the non-conforming type case wrangling
from the library. Uses where this is needed may still
add it in later as a request data processing callback.

The request callbacks receive all request info in reverse
doAction order, meaning callback(data, parameters, url, method).
url is only the path given to one of the method helpers, not yet
the fully build url if a base url is set on the api object.

Author: eFrane

Changelog.md

@@ -1,5 +1,10 @@
 # next version
 
+- **BREAKING**: Requests no longer get automatic type name fixing.
+  This feature did not conform to the spec as there is no requirement
+  for types to always be upper camel cased. If you need to perform
+  this case fixing in your use case, you may re-add it via `ResourcefulApi`'s
+  new `requestCallback`s.
 - **BREAKING**: Success and error callbacks can no longer modify the response data,
   to act on the parsed response data for all requests you **MUST** use
   `ResourcefulApi`'s new `responseCallback`s.

src/api/ResourcefulApi.js

@@ -4,13 +4,16 @@ 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 { hasOwn } from '../shared/utils'
 import { Performance } from '../shared/Performance'
 
 export class ResourcefulApi extends Api {
   constructor () {
     super()
 
+    /** @var {Function[]} */
+    this.requestCallbacks = []
+
     /** @var {Function[]} */
     this.responseCallbacks = []
   }
@@ -20,6 +23,23 @@ export class ResourcefulApi extends Api {
    *
    * @param {Function[]} callbacks
    */
+  setRequestCallbacks (callbacks) {
+    this.requestCallbacks = callbacks
+  }
+
+  addRequestCallback (cb) {
+    this.requestCallbacks.push(cb)
+  }
+
+  resetRequestCallbacks () {
+    this.requestCallbacks = []
+  }
+
+  /**
+   * Functions to be called with the parsed response data.
+   *
+   * @param {Function[]} callbacks
+   */
   setResponseCallbacks (callbacks) {
     this.responseCallbacks = callbacks
   }
@@ -45,8 +65,8 @@ export class ResourcefulApi extends Api {
    * @param {Object} data
    */
   async _doRequest (method, url, params, data) {
-    if (data) {
-      data = this.preprocessData(data)
+    for (const cb of this.requestCallbacks) {
+      data = cb(data, params, url, method)
     }
 
     return super._doRequest(method, url, params, data)
@@ -119,67 +139,6 @@ export class ResourcefulApi extends Api {
     }
   }
 
-  /**
-   * 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)
-
-    if (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)) {
-        if (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 if (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 if (relationship.data === null) {
-          relationships[name] = {
-            data: null
-          }
-        }
-      }
-      data.data.relationships = relationships
-    }
-
-    return data
-  }
-
   /**
    * Prepare the routable requests
    *

src/init/initJsonApiPlugin.js

@@ -29,6 +29,10 @@ export function initJsonApiPlugin (config) {
     api.setErrorCallbacks(config.errorCallbacks)
   }
 
+  if (checkConfigProperty(config, 'requestCallbacks', false)) {
+    api.setRequestCallbacks(config.requestCallbacks)
+  }
+
   if (checkConfigProperty(config, 'responseCallbacks', false)) {
     api.setResponseCallbacks(config.responseCallbacks)
   }

test/api/ResourcefulApi.spec.js

@@ -56,25 +56,6 @@ test('reads the initial module list', () => {
   expect(registerModuleMock.mock.calls.length).toBe(3)
 })
 
-test('keeps null relationships after preprocessing', () => {
-  const testResource = {
-    data: {
-      id: 1,
-      type: 'User',
-      relationships: {
-        hobbies: {
-          data: null
-        }
-      }
-    }
-  }
-
-  const api = new ResourcefulApi()
-
-  const preprocessedData = api.preprocessData(testResource)
-  expect(preprocessedData.data.relationships.hobbies.data).toBe(null)
-})
-
 test('runs response callbacks', async () => {
   const api = new ResourcefulApi()
   api.setBaseUrl('http://api/')
@@ -101,3 +82,18 @@ test('runs response callbacks', async () => {
     status_on_response: 200
   })
 })
+
+test('runs request callbacks', async () => {
+  const api = new ResourcefulApi()
+  api.setBaseUrl('http://api/')
+
+  const cb = jest.fn(data => {
+    return data
+  })
+
+  api.addRequestCallback(cb)
+
+  await api.get('/book/1')
+
+  expect(cb.mock.calls.length).toBe(1)
+})