Update types

Author: ospfranco

example/src/App.tsx

@@ -32,11 +32,11 @@ export default function App() {
             </View>
             <View style={styles.row}>
               <Text style={styles.label}>ID Number: </Text>
-              <Text style={styles.text}>{mrzResults.idNumber}</Text>
+              <Text style={styles.text}>{mrzResults.passportNumber}</Text>
             </View>
             <View style={styles.row}>
               <Text style={styles.label}>Doc Expiration: </Text>
-              <Text style={styles.text}>{mrzResults.docExpirationDate}</Text>
+              <Text style={styles.text}>{mrzResults.expiryDate}</Text>
             </View>
             <View style={styles.row}>
               <Text style={styles.label}>Last Name: </Text>
@@ -52,7 +52,7 @@ export default function App() {
             </View>
             <View style={styles.row}>
               <Text style={styles.label}>Date Of Birth: </Text>
-              <Text style={styles.text}>{mrzResults.dob}</Text>
+              <Text style={styles.text}>{mrzResults.birthDate}</Text>
             </View>
           </View>
           <Button

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@op-engineering/op-ocr",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "VisionCamera Frame Processor Plugin to detect and read MRZ data from passports using MLKit Text Recognition.",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/index.d.ts",

src/components/MRZScanner.tsx

@@ -50,15 +50,15 @@ const MRZScanner: FC<PropsWithChildren<MRZScannerProps>> = ({
       return true;
     }
 
-    if (mrzResults.idNumber && idList.length < numQAChecks) {
-      mrzQACheck(idList, mrzResults.idNumber);
+    if (mrzResults.passportNumber && idList.length < numQAChecks) {
+      mrzQACheck(idList, mrzResults.passportNumber);
     }
 
-    if (mrzResults.dob && dobList.length < numQAChecks) {
-      mrzQACheck(dobList, mrzResults.dob);
+    if (mrzResults.birthDate && dobList.length < numQAChecks) {
+      mrzQACheck(dobList, mrzResults.birthDate);
     }
-    if (mrzResults.docExpirationDate && expiryList.length < numQAChecks) {
-      mrzQACheck(expiryList, mrzResults.docExpirationDate);
+    if (mrzResults.expiryDate && expiryList.length < numQAChecks) {
+      mrzQACheck(expiryList, mrzResults.expiryDate);
     }
 
     return false;

src/types/mrzProperties.ts

@@ -36,10 +36,10 @@ export type MRZProperties = {
   issuingCountry?: string;
   givenNames?: string;
   lastNames?: string;
-  idNumber?: string;
+  passportNumber?: string;
   nationality?: string;
-  dob?: string;
+  birthDate?: string;
   gender?: string;
-  docExpirationDate?: string;
+  expiryDate?: string;
   additionalInformation?: string;
 };

src/util/mrzParser.ts

@@ -1,4 +1,5 @@
 // logging import and setup
+import type { MRZProperties } from '../types/mrzProperties';
 import { ListItemData } from '../constants/listItemData';
 
 const countryIsoJson = require('../constants/CountryIsoCodes.json');
@@ -40,7 +41,7 @@ export const checkSum = (text: string) => {
   return value;
 };
 
-export const parseMRZ = (initialLines: string[]) => {
+export const parseMRZ = (initialLines: string[]): MRZProperties | undefined => {
   let lines: string[] = [];
 
   let secondLine = initialLines[initialLines.length - 1];
@@ -96,6 +97,7 @@ export const parseMRZ = (initialLines: string[]) => {
       }
     }
   } // end (lines.length >= 3)
+
   return undefined;
 };
 
@@ -113,16 +115,19 @@ export const parseMRZ = (initialLines: string[]) => {
  * idNumber: idNumber,
  * nationality
  */
-const parse2LineMRZ = (firstRow: string, secondRow: string) => {
+const parse2LineMRZ = (
+  firstRow: string,
+  secondRow: string
+): MRZProperties | undefined => {
   let docType = extractDocType(firstRow);
   let namesFromLine: { givenNames: string[]; lastNames: string[] } =
     extractNamesFromLine(5, firstRow);
   let givenNames: string[] = namesFromLine.givenNames;
   let lastNames: string[] = namesFromLine.lastNames;
 
   // Extract idNumber
-  let idNumber = extractIdNumber(secondRow, 0, 9);
-  if (!idNumber) {
+  let passportNumber = extractIdNumber(secondRow, 0, 9);
+  if (!passportNumber) {
     return undefined;
   }
 
@@ -133,28 +138,27 @@ const parse2LineMRZ = (firstRow: string, secondRow: string) => {
   let nationality = extractCountry(secondRow, 10, 13);
 
   // extract dateOfBirth
-  let dob = extractDateOfBirthFromLine(13, secondRow);
+  let birthDate = extractDateOfBirthFromLine(13, secondRow);
 
   // Extract gender
   // let gender = extractGender(secondRow.charAt(20), issuingCountry, docType);
   let gender = extractGender(secondRow.charAt(20));
   // let gender = secondRow.charAt(20);
 
   // Extract expiration date then assign the YYYY-MM-DD string format to docExpirationDate
-  let docExpirationDate = extractDateOfExpirationFromLine(21, secondRow);
+  let expiryDate = extractDateOfExpirationFromLine(21, secondRow);
 
   return {
     docMRZ: `${firstRow}\n${secondRow}`,
     docType: docType,
     issuingCountry: issuingCountry,
     givenNames: givenNames.join(' ').trim(),
     lastNames: lastNames.join(' ').trim(),
-    idNumber: idNumber,
+    passportNumber,
     nationality: nationality,
-    dob: dob,
-    gender: gender,
-    docExpirationDate: docExpirationDate,
-    additionalInformation: undefined, // TODO remove? (The logic for extracting additional information was deleted since we're not using it)
+    birthDate,
+    gender,
+    expiryDate,
   };
 };
 
@@ -182,29 +186,29 @@ const parse3LineMRZ = (
   firstRow: string,
   secondRow: string,
   thirdRow: string
-) => {
+): MRZProperties | undefined => {
   let docType = extractDocType(firstRow);
   let namesFromLine: { givenNames: string[]; lastNames: string[] } =
     extractNamesFromLine(0, thirdRow);
   let givenNames: string[] = namesFromLine.givenNames;
   let lastNames: string[] = namesFromLine.lastNames;
 
   // Extract idNumber
-  let idNumber = extractIdNumber(firstRow, 5, 14);
-  if (!idNumber) {
+  let passportNumber = extractIdNumber(firstRow, 5, 14);
+  if (!passportNumber) {
     return undefined;
   }
   // Extract issuingCountry
   let issuingCountry = extractCountry(firstRow, 2, 5);
   // Extract nationality
   let nationality = extractCountry(secondRow, 15, 18);
   // Extract date of birth
-  let dob = extractDateOfBirthFromLine(0, secondRow);
+  let birthDate = extractDateOfBirthFromLine(0, secondRow);
   // Extract gender
   let gender = extractGender(secondRow.charAt(7));
 
   // Extract expiration date then store that date as a string in docExpirationDate
-  let docExpirationDate = extractDateOfExpirationFromLine(8, secondRow);
+  let expiryDate = extractDateOfExpirationFromLine(8, secondRow);
   // extract additional information from first and second row
   let additionalInformation = '';
   additionalInformation =
@@ -220,11 +224,11 @@ const parse3LineMRZ = (
     issuingCountry: issuingCountry,
     givenNames: givenNames.join(' ').trim(),
     lastNames: lastNames.join(' ').trim(),
-    idNumber: idNumber,
+    passportNumber,
     nationality: nationality,
-    dob: dob,
-    gender: gender,
-    docExpirationDate: docExpirationDate,
+    birthDate,
+    gender,
+    expiryDate,
     additionalInformation: additionalInformation,
   };
 };