react-native-persona 2.2.30 → 2.4.0

package/src/index.ts

@@ -103,6 +103,18 @@ export enum Environment {
   PRODUCTION = 'production',
 }
 
+/**
+ * An enum value which determines whether this sdk should use the theme values sent from the server.
+ */
+export enum ThemeSource {
+  SERVER = 'server',
+  /**
+   * @deprecated Client side theming is deprecated, please configure your theme inside
+   * the Persona Dashboard and use SERVER as the theme source.
+   */
+  CLIENT = 'client',
+}
+
 export interface InquiryOptions {
   templateId?: TemplateId;
   templateVersion?: TemplateVersion;
@@ -111,6 +123,7 @@ export interface InquiryOptions {
   accountId?: AccountId;
   environment?: Environment;
   sessionToken?: string;
+  returnCollectedData?: boolean;
 
   // Fields
   fields?: Fields;
@@ -122,14 +135,115 @@ export interface InquiryOptions {
 
   // Customization
   iosThemeObject?: Object | null;
+  themeSource?: ThemeSource | null;
 }
 
 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,8 +257,10 @@ export class Inquiry {
   accountId?: AccountId;
   environment?: Environment;
   sessionToken?: string;
+  returnCollectedData?: boolean;
 
   iosThemeObject?: Object | null;
+  themeSource?: ThemeSource | null;
   fields?: Fields | null;
 
   private readonly onComplete?: OnCompleteCallback;
@@ -163,6 +279,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;
@@ -171,6 +288,7 @@ export class Inquiry {
 
     // Theme object
     this.iosThemeObject = options.iosThemeObject;
+    this.themeSource = options.themeSource;
   }
 
   private clearListeners() {
@@ -231,6 +349,7 @@ export class Inquiry {
         inquiryId: string;
         status: string;
         fields: Record<string, RawInquiryField>;
+        collectedData: ExternalCollectedData | null;
       }) => {
         if (this.onComplete) {
           let fields: Fields = {};
@@ -257,7 +376,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 +441,8 @@ export class Inquiry {
       environment: this.environment,
       sessionToken: this.sessionToken,
       fields: this.fields,
+      returnCollectedData: this.returnCollectedData,
+      themeSource: this.themeSource,
       iosTheme: processThemeValues(this.iosThemeObject || {}),
     });
   }
@@ -302,6 +457,7 @@ class InquiryBuilder {
   private _onCanceled?: OnCanceledCallback;
   private _onError?: OnErrorCallback;
   private _iosThemeObject?: Object;
+  private _themeSource: ThemeSource = ThemeSource.SERVER;
   private _fields?: Fields;
 
   constructor(inquiryId: InquiryId) {
@@ -332,8 +488,19 @@ class InquiryBuilder {
     return this;
   }
 
+  /**
+   * @deprecated Use iosThemeToUse
+   */
   iosTheme(themeObject: Object): InquiryBuilder {
     this._iosThemeObject = themeObject;
+    this._themeSource = ThemeSource.CLIENT;
+
+    return this;
+  }
+
+  iosThemeToUse(themeObject: Object, themeSource: ThemeSource): InquiryBuilder {
+    this._iosThemeObject = themeObject;
+    this._themeSource = themeSource;
 
     return this;
   }
@@ -346,6 +513,7 @@ class InquiryBuilder {
       onCanceled: this._onCanceled,
       onError: this._onError,
       iosThemeObject: this._iosThemeObject,
+      themeSource: this._themeSource,
       fields: this._fields,
     });
   }
@@ -359,6 +527,7 @@ class TemplateBuilder {
   private _environment?: Environment;
   private _fields?: Fields;
   private _sessionToken?: string;
+  private _returnCollectedData?: boolean;
 
   // Callbacks
   private _onComplete?: OnCompleteCallback;
@@ -367,6 +536,7 @@ class TemplateBuilder {
 
   // Customization
   private _iosThemeObject?: Object;
+  private _themeSource: ThemeSource = ThemeSource.SERVER;
 
   constructor(
     templateId?: TemplateId | null,
@@ -384,6 +554,12 @@ class TemplateBuilder {
     return this;
   }
 
+  returnCollectedData(returnCollectedData: boolean) {
+    this._returnCollectedData = returnCollectedData
+
+    return this
+  }
+
   referenceId(referenceId: string): TemplateBuilder {
     this._accountId = undefined;
     this._referenceId = referenceId;
@@ -434,8 +610,19 @@ class TemplateBuilder {
     return this;
   }
 
+  /**
+   * @deprecated Use iosThemeToUse
+   */
   iosTheme(themeObject: Object): TemplateBuilder {
     this._iosThemeObject = themeObject;
+    this._themeSource = ThemeSource.CLIENT;
+
+    return this;
+  }
+
+  iosThemeToUse(themeObject: Object, themeSource: ThemeSource): TemplateBuilder {
+    this._iosThemeObject = themeObject;
+    this._themeSource = themeSource;
 
     return this;
   }
@@ -453,6 +640,8 @@ class TemplateBuilder {
       onCanceled: this._onCanceled,
       onError: this._onError,
       iosThemeObject: this._iosThemeObject,
+      themeSource: this._themeSource,
+      returnCollectedData: this._returnCollectedData,
     });
   }
 }