@trustchex/react-native-sdk 1.481.1 → 1.483.4

package/src/Shared/Types/documentReadResult.ts

@@ -0,0 +1,47 @@
+import type { DocumentData } from './documentData';
+
+/**
+ * How the display name was derived from the raw MRZ ASCII name.
+ *
+ * - `dg11`          — read from the chip's DG11 supplemental data file (exact printed name)
+ * - `reverse_table` — reconstructed via country-aware ICAO 9303 reverse transliteration table
+ * - `raw`           — no conversion applied; display equals the raw MRZ value
+ */
+export type DocumentNameSource = 'dg11' | 'reverse_table' | 'raw';
+
+export interface DocumentName {
+  /** First name exactly as stored in the MRZ (ASCII, OCR-B, e.g. "GOEKHAN"). */
+  rawFirst: string;
+  /** Last name exactly as stored in the MRZ (ASCII, OCR-B, e.g. "OEZTUERK"). */
+  rawLast: string;
+  /** First name in best available Unicode form (e.g. "GÖKHAN"). */
+  displayFirst: string;
+  /** Last name in best available Unicode form (e.g. "ÖZTÜRK"). */
+  displayLast: string;
+  /** How displayFirst / displayLast were derived. */
+  source: DocumentNameSource;
+}
+
+export interface DocumentFaceImage {
+  /** Base64-encoded image data (no data-URI prefix). */
+  data: string;
+  /** MIME type, e.g. "image/jpeg" or "image/png". */
+  mimeType: string;
+}
+
+export interface DocumentReadResult {
+  /** Normalized document data — consistent shape regardless of NFC or OCR source. */
+  document: DocumentData;
+  /**
+   * Name in both raw MRZ ASCII form and best-available Unicode display form.
+   * rawFirst / rawLast mirror document.firstName / document.lastName.
+   * displayFirst / displayLast are the Unicode-converted equivalents.
+   */
+  name: DocumentName;
+  /**
+   * Face image — from the chip's DG2 file on the NFC path, or extracted from
+   * the document photo on the camera OCR path. Optional: only present when a
+   * face image was successfully obtained.
+   */
+  face?: DocumentFaceImage;
+}

package/src/Shared/Types/mrzFields.ts

@@ -7,18 +7,13 @@ export type MRZFieldName =
   | 'documentCode'
   | 'issuingState'
   | 'documentNumber'
-  | 'documentNumberCheckDigit'
   | 'nationality'
   | 'lastName'
   | 'firstName'
   | 'sex'
   | 'birthDate'
-  | 'birthDateCheckDigit'
   | 'expirationDate'
-  | 'expirationDateCheckDigit'
   | 'personalNumber'
-  | 'personalNumberCheckDigit'
-  | 'compositeCheckDigit'
   | 'optional1'
   | 'optional2';
 

package/src/Trustchex.tsx

@@ -28,6 +28,7 @@ import MRZTestScreen from './Screens/Debug/MRZTestScreen';
 import BarcodeTestScreen from './Screens/Debug/BarcodeTestScreen';
 import NFCScanTestScreen from './Screens/Debug/NFCScanTestScreen';
 import AppContext, { type AppContextType } from './Shared/Contexts/AppContext';
+import type { DocumentReadResult } from './Shared/Types/documentReadResult';
 import DebugNavigationPanel from './Shared/Components/DebugNavigationPanel';
 import i18n from './Translation';
 import { initializeTTS } from './Shared/Libs/tts.utils';
@@ -55,6 +56,14 @@ interface TrustchexProps {
   locale?: 'en' | 'tr';
   onCompleted?: () => void;
   onError?: (error: string) => void;
+  /**
+   * Called as soon as document data is available — immediately after a
+   * successful NFC chip read (before the user taps "Approve and Continue")
+   * or after a successful camera OCR scan. Receives MRZ fields (raw,
+   * untouched ASCII), a name object with both raw and best-available Unicode
+   * display form, and optionally the face image.
+   */
+  onDocumentRead?: (result: DocumentReadResult) => void;
   enableAnalytics?: boolean;
   debug?: boolean;
   logLevel?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent';
@@ -74,6 +83,7 @@ const Trustchex: React.FC<TrustchexProps> = ({
   locale: propLocale,
   onCompleted,
   onError,
+  onDocumentRead,
   enableAnalytics = true,
   debug = false,
   logLevel = 'trace',
@@ -86,6 +96,7 @@ const Trustchex: React.FC<TrustchexProps> = ({
   const [isInitialized, setIsInitialized] = useState(false);
   const [analyticsInitialized, setAnalyticsInitialized] = useState(false);
   const [isDemoSession, setIsDemoSession] = useState(false);
+  const [lastDocumentRead, setLastDocumentReadState] = useState<DocumentReadResult | undefined>(undefined);
 
   const branding = useMemo(
     () => ({
@@ -116,6 +127,13 @@ const Trustchex: React.FC<TrustchexProps> = ({
     setIsDemoSession(value);
   }, []);
 
+  const setLastDocumentRead = useCallback((result: DocumentReadResult) => {
+    if (contextRef.current) {
+      contextRef.current.lastDocumentRead = result;
+    }
+    setLastDocumentReadState(result);
+  }, []);
+
   const contextValue = useMemo(() => {
     const prev = contextRef.current;
 
@@ -142,8 +160,11 @@ const Trustchex: React.FC<TrustchexProps> = ({
       currentWorkflowStep: prev?.currentWorkflowStep,
       isDebugNavigated: prev?.isDebugNavigated,
       isTestVideoSession: prev?.isTestVideoSession,
+      lastDocumentRead,
       onCompleted,
       onError,
+      onDocumentRead,
+      setLastDocumentRead,
       setSessionId,
       setBaseUrl,
       setIsDemoSession: setIsDemoSessionAndPersist,
@@ -168,6 +189,7 @@ const Trustchex: React.FC<TrustchexProps> = ({
     onCompleted,
     onError,
     isDemoSession,
+    lastDocumentRead,
     setIsDemoSessionAndPersist,
   ]);
 

package/src/index.tsx

@@ -51,5 +51,12 @@ export type {
 export { default as mrzUtils } from './Shared/Libs/mrz.utils';
 export type { MRZFormat, MRZValidationResult } from './Shared/Libs/mrz.utils';
 export type { MRZFields, MRZFieldName } from './Shared/Types/mrzFields';
+export type { DocumentData } from './Shared/Types/documentData';
+export type {
+  DocumentReadResult,
+  DocumentName,
+  DocumentNameSource,
+  DocumentFaceImage,
+} from './Shared/Types/documentReadResult';
 
 export default Trustchex;

package/src/version.ts

@@ -1,3 +1,3 @@
 // This file is auto-generated. Do not edit manually.
 // Version is synced from package.json during build.
-export const SDK_VERSION = '1.481.1';
+export const SDK_VERSION = '1.483.4';