SDK-2740 Expose IDV breakdown's process field (#537)

* Added optional 'process' field in BreakdownResponse.
Updated "idv" and "idv-identity-checks" examples view partial "check.ejs".

* Update JSDOC in BreakdownResponse

Author: laurent-yoti

examples/idv-identity-checks/views/pages/partials/check.ejs

@@ -114,6 +114,12 @@ formatString = function (value) {
                             <td><%= breakdown.getResult(); %></td>
                             <% } %>
                         </tr>
+                        <tr>
+                            <% if (breakdown.getProcess()) { %>
+                            <td>Process</td>
+                            <td><%= breakdown.getProcess(); %></td>
+                            <% } %>
+                        </tr>
                         <% if (breakdown.getDetails() && breakdown.getDetails().length > 0) { %>
                         <tr>
                             <td>Details</td>

examples/idv/views/pages/partials/check.ejs

@@ -113,6 +113,12 @@ formatString = function (value) {
                             <td><%= breakdown.getResult(); %></td>
                             <% } %>
                         </tr>
+                        <tr>
+                            <% if (breakdown.getProcess()) { %>
+                            <td>Process</td>
+                            <td><%= breakdown.getProcess(); %></td>
+                            <% } %>
+                        </tr>
                         <% if (breakdown.getDetails() && breakdown.getDetails().length > 0) { %>
                         <tr>
                             <td>Details</td>

src/idv_service/session/retrieve/breakdown.response.js

@@ -13,6 +13,10 @@ class BreakdownResponse {
     /** @private */
     this.result = breakdown.result;
 
+    Validation.isString(breakdown.process, 'process', true);
+    /** @private */
+    this.process = breakdown.process;
+
     if (breakdown.details) {
       Validation.isArrayOfType(breakdown.details, Object, 'details');
       /** @private */
@@ -37,6 +41,13 @@ class BreakdownResponse {
     return this.result;
   }
 
+  /**
+   * @returns {string|undefined} Likely 'AUTOMATED' or 'EXPERT_REVIEW'
+   */
+  getProcess() {
+    return this.process;
+  }
+
   /**
    * @returns {DetailsResponse[]}
    */

tests/idv_service/session/retrieve/breakdown.response.spec.js

@@ -9,6 +9,7 @@ describe('BreakdownResponse', () => {
       sub_check: 'some-sub-check',
       result: 'some-result',
       details: [{}],
+      process: 'AUTOMATED',
     });
   });
 
@@ -24,6 +25,12 @@ describe('BreakdownResponse', () => {
     });
   });
 
+  describe('#getProcess', () => {
+    it('should return result', () => {
+      expect(breakdownResponse.getProcess()).toBe('AUTOMATED');
+    });
+  });
+
   describe('#getDetails', () => {
     describe('when details are available', () => {
       it('should return array of details', () => {

types/src/idv_service/session/retrieve/breakdown.response.d.ts

@@ -6,6 +6,8 @@ declare class BreakdownResponse {
     /** @private */
     private result;
     /** @private */
+    private process;
+    /** @private */
     private details;
     /**
      * @returns {string}
@@ -15,6 +17,10 @@ declare class BreakdownResponse {
      * @returns {string}
      */
     getResult(): string;
+    /**
+     * @returns {string} Likely 'AUTOMATED' or 'EXPERT_REVIEW'
+     */
+    getProcess(): string;
     /**
      * @returns {DetailsResponse[]}
      */