skyflow-js 1.8.0 → 1.9.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+
+## [1.9.0] - 2022-01-11
+
+### Added
+- `Soap protocol` support for connections
+
 ## [1.8.0] - 2021-12-07
 
 ### Added

package/README.md

@@ -9,6 +9,7 @@ Skyflow’s Javascript SDK can be used to securely collect, tokenize, and reveal
 - [**Securely collecting data client-side**](#Securely-collecting-data-client-side)
 - [**Securely revealing data client-side**](#Securely-revealing-data-client-side)
 - [**Securely invoking Connections client-side**](#Securely-invoking-Connections-client-side)
+- [**Securely invoking Connections client-side using SOAP**](#Securely-invoking-Connections-client-side-using-soap)
 
 ---
 
@@ -1097,7 +1098,7 @@ const response =  skyflowClient.invokeConnection(connectionConfig);
 The values in the above parameters can contain collect elements, reveal elements or actual values. When elements are provided inplace of values, they get replaced with the value entered in the collect elements or value present in the reveal elements
 
 **responseBody**:  
-It is a JSON object that specifies where to render the response in the UI. The values in the responseBody can contain collect elements or reveal elements. 
+It is a JSON object that specifies where to render the response in the UI. The values in the responseBody can contain collect elements or reveal elements. The actual values corresponding to these elements will be stripped out from the actual response, which is then forwarded from the SDK to the client application.
 
 Sample use-cases on using invokeConnection():
 
@@ -1206,4 +1207,162 @@ Sample Response:
 
 `Note`:
 - `token` is optional for creating reveal element, if it is used for invokeConnection
-- responseBody contains collect or reveal elements to render the response from the Connection on UI 
+- responseBody contains collect or reveal elements to render the response from the Connection on UI 
+
+# Securely invoking Connections client-side using SOAP
+
+ To invoke Connections using SOAP, use the `invokeSoapConnection(connectionConfig)` method of the Skyflow client as shown below:
+
+ ```javascript
+const connectionConfig = {
+  connectionURL: string, // connection url received when creating a Skyflow Connection
+  httpHeaders: any,      // optional
+  requestXML: string,
+  responseXML: string,   // optional
+}
+
+const response =  skyflowClient.invokeSoapConnection(connectionConfig);
+```
+
+**httpHeaders** is the JSON object containing key-value pairs that are sent as request headers.
+
+**requestXML** accepts the entire XML request as a string.
+
+The values in the **requestXML** can contain collect element IDs or reveal element IDs or actual values. When the IDs are provided in place of values, they get replaced with the value entered in the collect elements or value present in the reveal elements.
+
+**responseXML** accepts the entire XML request as a string. It specifies where to render the response in the UI. The values in the responseXML can contain collect element IDs or reveal element IDs. The actual values corresponding to these IDs will be stripped out from the actual response, which is then forwarded from the SDK to the client application.
+
+`Note:` If the user needs to use Skyflow Elements in place of values in the requestXML or responseXML, they will pass in an additional tag **Skyflow** containing the ID of the particular element.
+
+Please ensure that the paths configured in the responseXML are present in the actual response. In case of a misconfigured path, the response from the server will be discarded and an error will be thrown.
+
+```javascript
+
+// step 1
+const skyflowClient = skyflow.init({
+	 getBearerToken: '<helperFunc>'
+});
+
+// step 2
+const revealContainer = skyflowClient.container(Skyflow.ContainerType.REVEAL)
+const collectContainer = skyflowClient.container(Skyflow.ContainerType.COLLECT)
+
+
+// step 3
+const cardNumberElement = collectContainer.create({           
+  type: skyflow.ElementType.CARD_NUMBER
+})
+cardNumberElement.mount("#cardNumber")
+
+const expiryDateElement = collectContainer.create({
+    type: skyflow.ElementType.EXPIRATION_DATE
+})
+expiryDateElement.mount("#expirationDate")
+
+const cvvElement = revealContainer.create({
+    altText: "###",
+})
+cvvElement.mount("#cvv")
+
+//step 4
+const cardNumberID = cardNumberElement.getID()  // to get element ID
+const expiryDateID = expiryDateElement.getID()
+const cvvElementID = cvvElement.getID()
+
+// step 5
+const requestXML = `<soapenv:Envelope>
+    <soapenv:Header>
+      <ClientID>1234</ClientID>
+    </soapenv:Header>
+    <soapenv:Body>
+      <GenerateCVV>
+        <CardNumber>
+          <Skyflow>${cardNumberID}</Skyflow>
+        </CardNumber>
+        <ExpiryDate>
+          <Skyflow>${expiryDateID}</Skyflow>
+        </ExpiryDate>
+      </GenerateCVV>
+    </soapenv:Body>
+</soapenv:Envelope>`
+
+
+const responseXML = `<soapenv:Envelope>
+    <soapenv:Header>
+      <HeaderList>
+        <HeaderItem>
+          <Name>NodeId</Name>
+          <Value>
+            <Skyflow>${revealNodeId}</Skyflow>
+          </Value>
+        </HeaderItem>
+        <HeaderItem>
+          <Name>ProgramId</Name>
+          <Value>
+            <Skyflow>${revealProgramId}</Skyflow>
+          </Value>
+        </HeaderItem>
+      </HeaderList>
+      <ClientID>1234</ClientID>
+    </soapenv:Header>
+    <soapenv:Body>
+      <GenerateCVV>
+        <CVV>
+          <Skyflow>${cvvElementID}</Skyflow>
+        </CVV>
+      </GenerateCVV>
+    </soapenv:Body>
+</soapenv:Envelope>`
+
+const headers = {
+ soapAction: '<soap_action>', // any http headers can be added here
+}
+
+const connectionConfig = { 
+  connectionURL: '<connection_url>',
+  httpHeaders: headers,
+  requestXML: requestXML,
+  responseXML: responseXML,
+}
+
+const response =  skyflowClient.invokeSoapConnection(connectionConfig);
+
+```
+
+Sample Response on success:
+
+```xml
+<soapenv:Envelope>
+    <soapenv:Header>
+      <HeaderList>
+        <HeaderItem>
+            <Name>NodeId</Name>
+        </HeaderItem>
+        <HeaderItem>
+            <Name>ProgramId</Name>
+        </HeaderItem>
+      </HeaderList>
+    </soapenv:Header>
+    <soapenv:Body>
+      <GenerateCVV>
+        <ReceivedTimestamp>2019-05-29 21:49:56.625</ReceivedTimestamp>
+      </GenerateCVV>
+    </soapenv:Body>
+</soapenv:Envelope>
+```
+
+Sample Response on failure:
+
+```javascript
+{
+  code: '<error_code>',
+  description: '<error_description>',
+  xml: '<xml_received_from_server>'
+}
+```
+
+`Note`: In responseXML we provide the tags that needs to be rendered in UI and stripped out from the actual response. 
+1. For uniquely identifiable tag, we can give the elementID within a skyflow tag directly corresponding to the actual value.
+Please refer to the CVV tag in the above example. Here, we wish to strip the actual value present within the CVV tag.
+2. For arrays, since we have multiple tags with the same name, we will need to provide identifiers to uniquely identify the required tag.
+Please refer to HeaderItem tag. Here, we have provided NodeId within the Name tag which acts as an identifier and we wish to strip the actual value present in the Value tag.