react-native-persona 2.2.29 → 2.3.0

package/lib/typescript/index.d.ts

@@ -34,13 +34,76 @@ export interface InquiryOptions {
     accountId?: AccountId;
     environment?: Environment;
     sessionToken?: string;
+    returnCollectedData?: boolean;
     fields?: Fields;
     onComplete?: OnCompleteCallback;
     onCanceled?: OnCanceledCallback;
     onError?: OnErrorCallback;
     iosThemeObject?: Object | null;
 }
-declare type OnCompleteCallback = (inquiryId: string, status: string, fields: Fields) => void;
+declare type OnCompleteCallback = (inquiryId: string, status: string, fields: Fields, extraData: ExtraData) => void;
+export interface ExtraData {
+    collectedData: CollectedData | null;
+}
+export interface CollectedData {
+    stepData: StepData[];
+}
+export interface StepData {
+    stepName: string;
+}
+export declare class DocumentStepData implements StepData {
+    stepName: string;
+    documents: Document[];
+    constructor();
+}
+export interface Document {
+    absoluteFilePath: string;
+}
+export declare class GovernmentIdStepData implements StepData {
+    stepName: string;
+    captures: GovernmentIdCapture[];
+    constructor();
+}
+export interface GovernmentIdCapture {
+    idClass: string;
+    captureMethod: GovernmentIdCaptureMethod;
+    side: GovernmentIdCaptureSide;
+    frames: GovernmentIdCaptureFrames[];
+}
+export declare enum GovernmentIdCaptureMethod {
+    Manual = "Manual",
+    Auto = "Auto",
+    Upload = "Upload"
+}
+export declare enum GovernmentIdCaptureSide {
+    Front = "Front",
+    Back = "Back"
+}
+export interface GovernmentIdCaptureFrames {
+    absoluteFilePath: string;
+}
+export declare class SelfieStepData implements StepData {
+    stepName: string;
+    centerCapture: SelfieCapture | null;
+    leftCapture: SelfieCapture | null;
+    rightCapture: SelfieCapture | null;
+    constructor();
+}
+export interface SelfieCapture {
+    captureMethod: SelfieCaptureMethod;
+    absoluteFilePath: string;
+}
+export declare enum SelfieCaptureMethod {
+    Manual = "Manual",
+    Auto = "Auto"
+}
+export declare class UiStepData implements StepData {
+    stepName: string;
+    componentParams: {
+        [key: string]: any;
+    };
+    constructor();
+}
 declare type OnCanceledCallback = (inquiryId?: string, sessionToken?: string) => void;
 declare type OnErrorCallback = (error: Error) => void;
 export declare class Inquiry {
@@ -50,6 +113,7 @@ export declare class Inquiry {
     accountId?: AccountId;
     environment?: Environment;
     sessionToken?: string;
+    returnCollectedData?: boolean;
     iosThemeObject?: Object | null;
     fields?: Fields | null;
     private readonly onComplete?;
@@ -122,11 +186,13 @@ declare class TemplateBuilder {
     private _environment?;
     private _fields?;
     private _sessionToken?;
+    private _returnCollectedData?;
     private _onComplete?;
     private _onCanceled?;
     private _onError?;
     private _iosThemeObject?;
     constructor(templateId?: TemplateId | null, templateVersion?: TemplateVersion | null);
+    returnCollectedData(returnCollectedData: boolean): this;
     referenceId(referenceId: string): TemplateBuilder;
     accountId(accountId: string): TemplateBuilder;
     environment(environment: Environment): TemplateBuilder;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-persona",
   "title": "React Native Persona",
-  "version": "2.2.29",
+  "version": "2.3.0",
   "description": "Launch a mobile native implementation of the Persona inquiry flow from React Native.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/src/index.ts

@@ -111,6 +111,7 @@ export interface InquiryOptions {
   accountId?: AccountId;
   environment?: Environment;
   sessionToken?: string;
+  returnCollectedData?: boolean;
 
   // Fields
   fields?: Fields;
@@ -127,9 +128,109 @@ export interface InquiryOptions {
 type OnCompleteCallback = (
   inquiryId: string,
   status: string,
-  fields: Fields
+  fields: Fields,
+  extraData: ExtraData,
 ) => void;
 
+/**
+ * Type for collected data that came directly from iOS/Android. 
+ * Needs to be translated to TS classes before returning.
+ */
+interface ExternalCollectedData {
+  stepData: any[]
+}
+
+export interface ExtraData {
+  collectedData: CollectedData | null;
+}
+export interface CollectedData {
+  stepData: StepData[]
+}
+
+export interface StepData {
+  stepName: string;
+}
+  
+export class DocumentStepData implements StepData {
+  stepName: string;
+  documents: Document[];
+
+  constructor() {
+    this.stepName = ""
+    this.documents = []
+  }
+}
+  
+export interface Document {
+  absoluteFilePath: string;
+}
+  
+export class GovernmentIdStepData implements StepData {
+  stepName: string;
+  captures: GovernmentIdCapture[];
+
+  constructor() {
+    this.stepName = ""
+    this.captures = []
+  }
+}
+
+export interface GovernmentIdCapture {
+  idClass: string;
+  captureMethod: GovernmentIdCaptureMethod;
+  side: GovernmentIdCaptureSide;
+  frames: GovernmentIdCaptureFrames[];
+}
+
+export enum GovernmentIdCaptureMethod {
+  Manual = "Manual",
+  Auto = "Auto",
+  Upload = "Upload",
+}
+
+export enum GovernmentIdCaptureSide {
+  Front = "Front",
+  Back = "Back",
+}
+
+export interface GovernmentIdCaptureFrames {
+  absoluteFilePath: string;
+}
+
+export class SelfieStepData implements StepData {
+  stepName: string;
+  centerCapture: SelfieCapture | null;
+  leftCapture: SelfieCapture | null;
+  rightCapture: SelfieCapture | null;
+
+  constructor() {
+    this.stepName = ""
+    this.centerCapture = null
+    this.leftCapture = null
+    this.rightCapture = null
+  }
+}
+
+export interface SelfieCapture {
+  captureMethod: SelfieCaptureMethod;
+  absoluteFilePath: string;
+}
+
+export enum SelfieCaptureMethod {
+  Manual = "Manual",
+  Auto = "Auto",
+}
+
+export class UiStepData implements StepData {
+  stepName: string;
+  componentParams: { [key: string]: any }
+
+  constructor() {
+    this.stepName = ""
+    this.componentParams = {}
+  }
+}
+
 type OnCanceledCallback = (inquiryId?: string, sessionToken?: string) => void;
 
 type OnErrorCallback = (error: Error) => void;
@@ -143,6 +244,7 @@ export class Inquiry {
   accountId?: AccountId;
   environment?: Environment;
   sessionToken?: string;
+  returnCollectedData?: boolean;
 
   iosThemeObject?: Object | null;
   fields?: Fields | null;
@@ -163,6 +265,7 @@ export class Inquiry {
     this.environment = options.environment;
     this.sessionToken = options.sessionToken;
     this.fields = options.fields;
+    this.returnCollectedData = options.returnCollectedData;
 
     // Callbacks
     this.onComplete = options.onComplete;
@@ -231,6 +334,7 @@ export class Inquiry {
         inquiryId: string;
         status: string;
         fields: Record<string, RawInquiryField>;
+        collectedData: ExternalCollectedData | null;
       }) => {
         if (this.onComplete) {
           let fields: Fields = {};
@@ -257,7 +361,41 @@ export class Inquiry {
                 break;
             }
           }
-          this.onComplete(event.inquiryId, event.status, fields);
+
+          let collectedData: CollectedData | null = null
+
+          let stepData = event.collectedData?.stepData
+          if (stepData != null) {
+            // Translate the step data from JSON to actual class objects
+            let translatedStepData = []
+
+            for (let stepDatum of stepData) {
+              switch (stepDatum.type) {
+                case 'DocumentStepData':
+                  translatedStepData.push(Object.assign(new DocumentStepData(), stepDatum))
+                  break;
+                case 'GovernmentIdStepData':
+                  translatedStepData.push(Object.assign(new GovernmentIdStepData(), stepDatum))
+                  break;
+                case 'SelfieStepData':
+                  translatedStepData.push(Object.assign(new SelfieStepData(), stepDatum))
+                  break;
+                case 'UiStepData':
+                  translatedStepData.push(Object.assign(new UiStepData(), stepDatum))
+                  break;
+              }
+            }
+
+            collectedData = {
+              stepData: translatedStepData
+            }
+          }
+
+          let extraData: ExtraData = {
+            collectedData: collectedData
+          }
+
+          this.onComplete(event.inquiryId, event.status, fields, extraData);
         }
         this.clearListeners();
       }
@@ -288,6 +426,7 @@ export class Inquiry {
       environment: this.environment,
       sessionToken: this.sessionToken,
       fields: this.fields,
+      returnCollectedData: this.returnCollectedData,
       iosTheme: processThemeValues(this.iosThemeObject || {}),
     });
   }
@@ -359,6 +498,7 @@ class TemplateBuilder {
   private _environment?: Environment;
   private _fields?: Fields;
   private _sessionToken?: string;
+  private _returnCollectedData?: boolean;
 
   // Callbacks
   private _onComplete?: OnCompleteCallback;
@@ -384,6 +524,12 @@ class TemplateBuilder {
     return this;
   }
 
+  returnCollectedData(returnCollectedData: boolean) {
+    this._returnCollectedData = returnCollectedData
+
+    return this
+  }
+
   referenceId(referenceId: string): TemplateBuilder {
     this._accountId = undefined;
     this._referenceId = referenceId;
@@ -453,6 +599,7 @@ class TemplateBuilder {
       onCanceled: this._onCanceled,
       onError: this._onError,
       iosThemeObject: this._iosThemeObject,
+      returnCollectedData: this._returnCollectedData,
     });
   }
 }