Merge pull request #21 from titans-of-code/feature/customNode

Added feature to customize the error response field name

Author: sf-charles

README.md

@@ -12,7 +12,7 @@ The error is converted by this module into the items below.
   - **Error reason**:  *Reason phrase* from the [HTTP RFC 7231 Response Status Codes][http-rfc-7231-6] for [Client Error 4xx][http-rfc-7231-6.5] and [Server Error 5xx][http-rfc-7231-6.6].
   - **Error message**: This can be any text description, array, or object.  It is usually the Mule `error.description` or developer-defined dataweave or text.
 
-A JSON body response example is shown below.
+A JSON body response example is shown below.  Note that the top-level field name, `error`, is customizable.
 
 **StatusCode: 400**
 
@@ -332,7 +332,41 @@ The dataweave should resolve to a string but any type is allowed.  The default v
 error.exception.errorMessage.payload.error.message default ''
 ```
 
-**Note: Leave this field empty if you do not want to propagate previous errors.**
+**Set this field to an empty string if you do not want to propagate previous errors.**
+
+### Response Key Name for Payload
+This field allows you to customize the JSON key name where the error payload is set.  This defaults to `error`, which is shown in the examples.  This only supports changing the name of the top-level key; it does not change any other format.  If you want the error payload to be the top-level element in the response, then set this field to empty string.
+
+**Default Response**: error
+```
+{
+  "error": {
+      "code": 400,
+      "reason": "Bad Request",
+      "message": "Error validating response"
+  }
+}
+```
+
+**Custom Response**: errorDetails
+```
+{
+  "errorDetails": {
+      "code": 400,
+      "reason": "Bad Request",
+      "message": "Error validating response"
+  }
+}
+```
+
+**Custom Response**: empty string
+```
+{
+	"code": 400,
+	"reason": "Bad Request",
+	"message": "Error validating response"
+}
+```
 
 ## Error Handling Tips
 

advanced.png

@@ -4,7 +4,7 @@
 
 	<groupId>ORG_ID_TOKEN</groupId>
 	<artifactId>api-error-handler</artifactId>
-	<version>6.0.0</version>
+	<version>6.1.0</version>
 	<packaging>mule-extension</packaging>
 
 	<name>API Error Handler</name>

pom.xml

@@ -98,7 +98,14 @@
 
 			<parameter name="previousError" type="any" use="OPTIONAL"
 				displayName="Use Previous Error"
-				defaultValue="#[error.exception.errorMessage.typedValue.error.message default '']"
+				defaultValue="#[error.exception.errorMessage.payload.error.message default '']"
+				summary="Script to generate the previous error message.  Usually pulled from the external system's response in the error object.  Set empty string to ignore previous errors."
+				role="BEHAVIOUR" tab="Advanced" />
+				
+			<parameter name="responseKey" type="any" use="OPTIONAL"
+				displayName="Response Key Name for Payload"
+				defaultValue="#['error']"
+				summary="The response key name to which to add the error payload.  Set empty string to set the payload as the root element."
 				role="BEHAVIOUR" tab="Advanced" />
 
 		</parameters>
@@ -134,13 +141,18 @@
 						import * from module_error_handler_plugin::common
 						output application/json
 						var error = getError(vars.errorType, vars.defaultErrors, vars.customErrors default {})
-						---
-						{
-							error: error update {
+						var responseKey = vars.responseKey
+						var responseError = error update {
 								// Use the previous error message if it exists, otherwise use the provided message.
 						        case message at .message -> if (!isEmpty(vars.previousError)) vars.previousError else message
-						    }
-						}
+						    } 
+						---
+						if (!isEmpty(responseKey) and (responseKey is String))
+							{
+								(responseKey): responseError
+							}
+						else
+							responseError
 						]]>
 					</ee:set-payload>
 					<ee:set-attributes><![CDATA[%dw 2.0