Add option overrideElementKey to change the key of the wsdl (#1334)

* Update readme

---------

Co-authored-by: Lucas Fellipe Mondini Pereira <[email protected]>

Author: smokhov

Readme.md

@@ -10,7 +10,7 @@ This module lets you connect to web services using SOAP.  It also provides a ser
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [Features:](#features)
+- [Features](#features)
 - [Install](#install)
 - [Support](#support)
 - [Module](#module)
@@ -62,6 +62,7 @@ This module lets you connect to web services using SOAP.  It also provides a ser
   - [Overriding imports relative paths](#overriding-imports-relative-paths)
   - [Overriding import locations](#overriding-import-locations)
   - [Specifying the exact namespace definition of the root element](#specifying-the-exact-namespace-definition-of-the-root-element)
+  - [Overriding element key specification in XML](#overriding-element-key-specification-in-xml)
   - [Custom Deserializer](#custom-deserializer)
   - [Changing the tag formats to use self-closing (empty element) tags](#changing-the-tag-formats-to-use-self-closing-empty-element-tags)
 - [Handling "ignored" namespaces](#handling-ignored-namespaces)
@@ -72,7 +73,7 @@ This module lets you connect to web services using SOAP.  It also provides a ser
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-## Features:
+## Features
 
 * Very simple API
 * Handles both RPC and Document schema types
@@ -1334,6 +1335,24 @@ var wsdlOptions = {
 
 To see it in practice, have a look at the sample files in: [test/request-response-samples/addPets__force_namespaces](https://github.com/vpulim/node-soap/tree/master/test/request-response-samples/addPets__force_namespaces)
 
+### Overriding element key specification in XML
+
+In very rare cases ([external implementation isn't matching exactly the WSDL spec?](https://github.com/vpulim/node-soap/pull/1189)),
+you may want to override element XML keys in requests and/or responses.
+
+You can specify the key definitions by setting the `overrideElementKey` key in the `wsdlOptions` like so:
+```javascript
+var wsdlOptions = {
+  overrideElementKey: {
+    Nom: 'Name',
+    Commande: 'Order',
+    SillyResponse: 'DummyResponse'
+  };
+};
+```
+
+Test sample files covering this are in [test/request-response-samples/Dummy__ref_element_should_have_correct_namespace_with_overrideElementKey](https://github.com/vpulim/node-soap/tree/master/test/request-response-samples/Dummy__ref_element_should_have_correct_namespace_with_overrideElementKey)
+
 ### Custom Deserializer
 
 Sometimes it's useful to handle deserialization in your code instead of letting node-soap do it.

src/client.ts

@@ -189,6 +189,10 @@ export class Client extends EventEmitter {
         }
       }
     }
+
+    if (options.overrideElementKey !== undefined) {
+      this.wsdl.options.overrideElementKey = options.overrideElementKey;
+    }
     if (options.overrideRootElement !== undefined) {
       this.wsdl.options.overrideRootElement = options.overrideRootElement;
     }

src/types.ts

@@ -90,6 +90,7 @@ export interface IWsdlBaseOptions {
   valueKey?: string;
   xmlKey?: string;
   overrideRootElement?: { namespace: string; xmlnsAttributes?: IXmlAttribute[]; };
+  overrideElementKey?: object;
   ignoredNamespaces?: boolean | string[] | { namespaces?: string[]; override?: boolean; };
   ignoreBaseNameSpaces?: boolean;
   /** escape special XML characters in SOAP message (e.g. &, >, < etc), default: true. */

src/wsdl/index.ts

@@ -656,6 +656,17 @@ export class WSDL {
   public objectToXML(obj, name: string, nsPrefix: any, nsURI: string, isFirst?: boolean, xmlnsAttr?, schemaObject?, nsContext?: NamespaceContext) {
     const schema = this.definitions.schemas[nsURI];
 
+    if (this.options.overrideElementKey && Object.keys(this.options.overrideElementKey).length > 0) {
+      for (const key in this.options.overrideElementKey) {
+        const overrideKey = this.options.overrideElementKey[key];
+        if (obj && obj[key]) {
+          Object.defineProperty(obj, overrideKey,
+              Object.getOwnPropertyDescriptor(obj, key));
+          delete obj[key];
+        }
+      }
+    }
+
     let parentNsPrefix = nsPrefix ? nsPrefix.parent : undefined;
     if (typeof parentNsPrefix !== 'undefined') {
       // we got the parentNsPrefix for our array. setting the namespace-variable back to the current namespace string
@@ -1193,6 +1204,9 @@ export class WSDL {
     this.options.forceSoap12Headers = options.forceSoap12Headers;
     this.options.customDeserializer = options.customDeserializer;
 
+    if (options.overrideElementKey !== undefined) {
+      this.options.overrideElementKey = options.overrideElementKey;
+    }
     if (options.overrideRootElement !== undefined) {
       this.options.overrideRootElement = options.overrideRootElement;
     }

test/request-response-samples-test.js

@@ -119,7 +119,7 @@ tests.forEach(function(test){
   requestJSON = require(requestJSON);
 
   //options is optional
-  if (fs.existsSync(options))options = require(options);
+  if (fs.existsSync(options)) options = require(options);
   else options = {};
 
   //wsdlOptions is optional
@@ -150,12 +150,24 @@ function generateTest(name, methodName, wsdlPath, headerJSON, securityJSON, requ
   }
 
   suite[name] = function(done){
-    if(requestXML) requestContext.expectedRequest = requestXML;
+    if (requestXML) {
+      // Override the expect request's keys to match
+      if (wsdlOptions.overrideElementKey) {
+         requestXML = requestXML.replace(/:Commande/g, ':Order');
+         requestXML = requestXML.replace(/:Nom/g, ':Name');
+      }
+      requestContext.expectedRequest = requestXML;
+    }
+
     if (responseXML) {
       if (wsdlOptions.parseReponseAttachments) {//all LF to CRLF
           responseXML = responseXML.replace(/\r\n/g, "\n");
           responseXML = responseXML.replace(/\n/g, "\r\n");
       }
+      // Override the expect request's keys to match
+      if (wsdlOptions.overrideElementKey) {
+         responseXML = responseXML.replace(/SillyResponse/g, 'DummyResponse');
+      }
       requestContext.responseToSend = responseXML;
     }
     requestContext.doneHandler = done;
@@ -171,7 +183,7 @@ function generateTest(name, methodName, wsdlPath, headerJSON, securityJSON, requ
       }
 
       //throw more meaningful error
-      if(typeof client[methodName] !== 'function'){
+      if (typeof client[methodName] !== 'function'){
         throw new Error('method ' + methodName + ' does not exists in wsdl specified in test wsdl: ' + wsdlPath);
       }