react-native-persona 2.25.2 → 2.26.0

package/lib/typescript/callbacks.d.ts

@@ -0,0 +1,21 @@
+import type { Fields } from './fields';
+import type { InquiryEvent } from './InquiryEvent';
+import type { StepData } from './StepData';
+export type OnCompleteCallback = (inquiryId: string, status: string, fields: Fields, extraData: ExtraData) => void;
+export type OnCanceledCallback = (inquiryId?: string, sessionToken?: string) => void;
+export type OnErrorCallback = (error: Error, errorCode?: string) => void;
+export type OnEventCallback = (event: InquiryEvent) => void;
+export type OnReadyCallback = () => void;
+export interface ExtraData {
+    collectedData: CollectedData | null;
+}
+export interface CollectedData {
+    stepData: StepData[];
+}
+/**
+ * Type for collected data that came directly from iOS/Android.
+ * Needs to be translated to TS classes before returning.
+ */
+export interface ExternalCollectedData {
+    stepData: any[];
+}

package/lib/typescript/index.d.ts

@@ -1,8 +1,13 @@
 import { Fields } from './fields';
-import { InquiryEvent } from './InquiryEvent';
-export { Fields };
+import PersonaInquiryView from './PersonaInquiryView';
 import { Versions } from './versions';
+import type { CollectedData, ExtraData, OnCanceledCallback, OnCompleteCallback, OnErrorCallback, OnEventCallback } from './callbacks';
+import { StepData, Document, UiStepData, SelfieCaptureMethod, SelfieCapture, SelfieStepData, GovernmentIdCaptureFrames, GovernmentIdCaptureSide, GovernmentIdCaptureMethod, GovernmentIdCapture, GovernmentIdStepData, DocumentStepData } from './StepData';
+export { Fields };
+export { PersonaInquiryView };
 export { Versions };
+export { CollectedData, ExtraData, OnCanceledCallback, OnCompleteCallback, OnErrorCallback, OnEventCallback, };
+export { StepData, Document, UiStepData, SelfieCaptureMethod, SelfieCapture, SelfieStepData, GovernmentIdCaptureFrames, GovernmentIdCaptureSide, GovernmentIdCaptureMethod, GovernmentIdCapture, GovernmentIdStepData, DocumentStepData, };
 declare const Unique: unique symbol;
 export type Opaque<T, Tag> = T & {
     [Unique]: Tag;
@@ -58,72 +63,6 @@ export interface InquiryOptions {
     iosThemeObject?: Object | null;
     themeSource?: ThemeSource | null;
 }
-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();
-}
-type OnCanceledCallback = (inquiryId?: string, sessionToken?: string) => void;
-type OnErrorCallback = (error: Error, errorCode?: string) => void;
-type OnEventCallback = (event: InquiryEvent) => void;
 export declare class Inquiry {
     templateId?: TemplateId;
     templateVersion?: TemplateVersion;
@@ -182,6 +121,25 @@ export declare class Inquiry {
      */
     static fromInquiry(inquiryId: string): InquiryBuilder;
     static onEvent(callback: OnEventCallback): void;
+    toOptionsJson(): {
+        templateId: TemplateId | undefined;
+        templateVersion: TemplateVersion | undefined;
+        inquiryId: InquiryId | undefined;
+        referenceId: string | undefined;
+        accountId: AccountId | undefined;
+        environment: Environment | undefined;
+        environmentId: string | undefined;
+        themeSetId: string | undefined;
+        sessionToken: string | undefined;
+        fields: Fields | null | undefined;
+        returnCollectedData: boolean | undefined;
+        themeSource: ThemeSource | null | undefined;
+        iosTheme: {
+            [key: string]: string;
+        };
+        locale: String | undefined;
+        disablePresentationAnimation: Boolean | undefined;
+    };
     /**
      * Launch the Persona Inquiry.
      */

package/lib/typescript/util.d.ts

@@ -1,3 +1,20 @@
+import type { ExternalCollectedData, OnCanceledCallback, OnCompleteCallback, OnErrorCallback, OnReadyCallback } from './callbacks';
+import { RawInquiryField } from './fields';
 export declare function processThemeValues(themeObject: Object): {
     [key: string]: string;
 };
+export declare function callOnCompleteCallback(event: {
+    inquiryId: string;
+    status: string;
+    fields: Record<string, RawInquiryField>;
+    collectedData: ExternalCollectedData | null;
+}, callback: OnCompleteCallback | undefined): void;
+export declare function callOnCanceledCallback(event: {
+    inquiryId?: string;
+    sessionToken?: string;
+}, callback: OnCanceledCallback | undefined): void;
+export declare function callOnErrorCallback(event: {
+    debugMessage: string;
+    errorCode?: string;
+}, callback: OnErrorCallback | undefined): void;
+export declare function callOnReadyCallback(callback: OnReadyCallback | undefined): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-persona",
   "title": "React Native Persona",
-  "version": "2.25.2",
+  "version": "2.26.0",
   "description": "Launch a mobile native implementation of the Persona inquiry flow from React Native.",
   "homepage": "https://docs.withpersona.com/docs/react-native-sdk-integration",
   "bugs": "https://github.com/persona-id/persona-inquiry-sdk-public",

package/src/PersonaInquiryView.tsx

@@ -0,0 +1,109 @@
+import React, { useCallback, useEffect, useRef } from 'react';
+import { findNodeHandle, UIManager } from 'react-native';
+import { PersonaInquiryViewManager } from './PersonaInquiryViewManager';
+import {
+  callOnCanceledCallback,
+  callOnCompleteCallback,
+  callOnErrorCallback,
+  callOnReadyCallback,
+} from './util';
+import type {
+  OnReadyCallback,
+  OnCanceledCallback,
+  OnCompleteCallback,
+  OnErrorCallback,
+  OnEventCallback,
+} from './callbacks';
+import type { InquiryEvent } from './InquiryEvent';
+
+const create = (viewId: number | null) => {
+  try {
+    const viewManagerConfig =
+      UIManager.getViewManagerConfig('PersonaInquiryView');
+    if (!viewManagerConfig || !viewManagerConfig.Commands) {
+      console.error('PersonaInquiryView config not found');
+      return;
+    }
+    UIManager.dispatchViewManagerCommand(
+      viewId,
+      viewManagerConfig.Commands.create,
+      [viewId]
+    );
+  } catch (error) {
+    console.error('Error dispatching create command:', error);
+  }
+};
+
+let onReadyCalled = false;
+let onReadyCallback = () => {};
+export const onPersonaInquiryViewEvent: OnEventCallback = (
+  event: InquiryEvent
+) => {
+  if (event.type == 'start') {
+    onReadyCalled = false;
+  } else if (event.type == 'page_change' && !onReadyCalled) {
+    onReadyCalled = true;
+
+    setTimeout(function () {
+      onReadyCallback();
+    }, 400);
+  }
+};
+
+export default function PersonaInquiryView(props: {
+  style: any;
+  inquiry: any;
+  onComplete: OnCompleteCallback;
+  onCanceled: OnCanceledCallback;
+  onError: OnErrorCallback;
+  onReady: OnReadyCallback;
+}) {
+  const ref = useRef(null);
+
+  useEffect(() => {
+    const viewId = findNodeHandle(ref.current);
+
+    onReadyCallback = () => {
+      props.onReady();
+    };
+
+    create(viewId);
+  }, []);
+
+  const _onComplete = useCallback(
+    (event: any) => {
+      callOnCompleteCallback(event.nativeEvent, props.onComplete);
+    },
+    [props.onComplete]
+  );
+
+  const _onCanceled = useCallback(
+    (event: any) => {
+      callOnCanceledCallback(event.nativeEvent, props.onCanceled);
+    },
+    [props.onCanceled]
+  );
+
+  const _onError = useCallback(
+    (event: any) => {
+      callOnErrorCallback(event.nativeEvent, props.onError);
+    },
+    [props.onError]
+  );
+
+  const _onReady = useCallback(() => {
+    callOnReadyCallback(props.onReady);
+  }, [props.onReady]);
+
+  return (
+    <PersonaInquiryViewManager
+      style={props.style}
+      inquiry={props.inquiry.toOptionsJson()}
+      onComplete={_onComplete}
+      onCanceled={_onCanceled}
+      onError={_onError}
+      onReady={_onReady}
+      ref={ref}
+    />
+  );
+}

package/src/PersonaInquiryViewManager.ts

@@ -0,0 +1,5 @@
+import { requireNativeComponent } from 'react-native';
+
+// The native module is registered as "PersonaInquiryView" (without Manager suffix)
+export const PersonaInquiryViewManager: any =
+  requireNativeComponent('PersonaInquiryView');

package/src/StepData.ts

@@ -0,0 +1,83 @@
+export class DocumentStepData implements StepData {
+  stepName: string;
+  documents: Document[];
+
+  constructor() {
+    this.stepName = '';
+    this.documents = [];
+  }
+}
+
+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 = {};
+  }
+}
+
+export interface Document {
+  absoluteFilePath: string;
+}
+
+export interface StepData {
+  stepName: string;
+}

package/src/callbacks.ts

@@ -0,0 +1,37 @@
+import type { Fields } from './fields';
+import type { InquiryEvent } from './InquiryEvent';
+import type { StepData } from './StepData';
+
+export type OnCompleteCallback = (
+  inquiryId: string,
+  status: string,
+  fields: Fields,
+  extraData: ExtraData
+) => void;
+
+export type OnCanceledCallback = (
+  inquiryId?: string,
+  sessionToken?: string
+) => void;
+
+export type OnErrorCallback = (error: Error, errorCode?: string) => void;
+
+export type OnEventCallback = (event: InquiryEvent) => void;
+
+export type OnReadyCallback = () => void;
+
+export interface ExtraData {
+  collectedData: CollectedData | null;
+}
+
+export interface CollectedData {
+  stepData: StepData[];
+}
+
+/**
+ * Type for collected data that came directly from iOS/Android.
+ * Needs to be translated to TS classes before returning.
+ */
+export interface ExternalCollectedData {
+  stepData: any[];
+}