Rename applyErrorMappingToFormFromUnprocessableEntityResponseResponse

Author: tcannonfodder

jsdoc.config.js

@@ -5,6 +5,7 @@ module.exports = {
     "source": {
       "include": [
           "src",
+          "src/plugins",
           "README.md"
       ],
     }

src/plugins/mrujs.js

@@ -1,5 +1,12 @@
-import {applyErrorMappingToFormFromEntityResponseResponse} from '../request-processing.js'
+import {applyErrorMappingToFormFromUnprocessableEntityResponseResponse} from '../request-processing.js'
 
+/**
+ * Calls {@link applyErrorMappingToFormFromUnprocessableEntityResponseResponse}, passing along the
+ * `element` and `response` from the given `event`
+ * @param {Event} event - The event that was fired for a fetch response, ideally `ajax:response:error`
+ * @param {FormElement} event.detail.element - The `form` event that triggered the event
+ * @param {Response} event.detail.response - The `Response` from the fetch request
+ */
 export async function unprocessableEntityResponseHandler(event) {
-  await applyErrorMappingToFormFromEntityResponseResponse(event.detail.element, event.detail.response)
+  await applyErrorMappingToFormFromUnprocessableEntityResponseResponse(event.detail.element, event.detail.response)
 }

src/request-processing.js

@@ -1,6 +1,12 @@
 import { applyErrorMappingToForm } from './error-mapping.js'
 
-export async function applyErrorMappingToFormFromEntityResponseResponse(form, response) {
+/**
+ * Calls {@link applyErrorMappingToForm}, If the given `response` has a `status` of `422`
+ * `element` and `response` from the given `event`
+ * @param {FormElement} form - The `form` event that triggered the event
+ * @param {Response} response - The `Response` from the fetch request
+ */
+export async function applyErrorMappingToFormFromUnprocessableEntityResponseResponse(form, response) {
   if(response.status != 422){ return }
   const errors = await response.json()
   applyErrorMappingToForm(form, errors)

test/request-processing.test.js

@@ -43,7 +43,7 @@ suite('Request Processing', async () => {
 
     const response = new Response(JSON.stringify(errors), {status: 400})
 
-    await RequestProcessing.applyErrorMappingToFormFromEntityResponseResponse(form, response)
+    await RequestProcessing.applyErrorMappingToFormFromUnprocessableEntityResponseResponse(form, response)
 
     assert.equal(2, form.querySelectorAll(`[data-error-type]`).length)
   })
@@ -87,7 +87,7 @@ suite('Request Processing', async () => {
 
     const response = new Response(JSON.stringify(errors), {status: 422})
 
-    await RequestProcessing.applyErrorMappingToFormFromEntityResponseResponse(form, response)
+    await RequestProcessing.applyErrorMappingToFormFromUnprocessableEntityResponseResponse(form, response)
 
     assert.equal(1, form.querySelectorAll(`[data-error-type]`).length)
     assert.equal(1, form.querySelectorAll(`[data-error-type][data-error-type="ad_hoc_server_error_1"]`).length)