@trustchex/react-native-sdk 1.161.0

package/src/Shared/EIDReader/lds/icao/mrzInfo.ts

@@ -0,0 +1,1669 @@
+import { Gender } from '../../data/gender';
+import { ByteArrayInputStream } from '../../java/byteArrayInputStream';
+import { DataInputStream } from '../../java/dataInputStream';
+import { DataOutputStream } from '../../java/dataOutputStream';
+import { InputStream } from '../../java/inputStream';
+import { OutputStream } from '../../java/outputStream';
+import { AbstractLDSInfo } from '../abstractLDSInfo';
+import { Buffer } from 'buffer';
+
+/**
+ * The type of document (MRZ), determining the number of lines,
+ * number of characters per line, and positions and lengths of fields,
+ * and check-digits.
+ */
+export class DocumentType {
+  /** Unspecified document type (do not use, choose ID1 or ID3). */
+  public static UNKNOWN = new DocumentType(0, 'UNKNOWN');
+
+  /** MROTD 3 lines of 30 characters, as per part 5. */
+  public static TD1 = new DocumentType(1, 'TD1');
+
+  /** MROTD 2 lines of 36 characters, as per part 6. */
+  public static TD2 = new DocumentType(2, 'TD2');
+
+  /** MRP 2 lines of 44 characters, as per part 4. */
+  public static TD3 = new DocumentType(3, 'TD3');
+
+  /** MRV type A. */
+  public static MRVA = new DocumentType(4, 'MRVA');
+
+  /** MRV type B. */
+  public static MRVB = new DocumentType(5, 'MRVB');
+
+  /** The code representing the document type. */
+  public code: number;
+
+  /** The string representation of the document type. */
+  public strCode: string;
+
+  /**
+   * Creates a new DocumentType instance.
+   *
+   * @param code The code representing the document type.
+   * @param strCode The string representation of the document type.
+   */
+  constructor(code: number, strCode: string) {
+    this.code = code;
+    this.strCode = strCode;
+  }
+
+  /**
+   * Returns the code representing the document type.
+   *
+   * @return the code representing the document type
+   */
+  getCode(): number {
+    return this.code;
+  }
+
+  /**
+   * Returns the string representation of the document type.
+   *
+   * @return the string representation of the document type
+   */
+  getStrCode(): string {
+    return this.strCode;
+  }
+}
+
+export class MRZInfo extends AbstractLDSInfo {
+  /** All valid characters in MRZ. */
+  private static MRZ_CHARS = '<0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+
+  private documentType!: DocumentType;
+  private documentCode!: string;
+  private issuingState!: string;
+  private primaryIdentifier!: string;
+  private secondaryIdentifier!: string;
+  private nationality!: string;
+  private documentNumber!: string;
+  private dateOfBirth!: string;
+  private gender!: Gender;
+  private dateOfExpiry!: string;
+  private documentNumberCheckDigit!: string;
+  private dateOfBirthCheckDigit!: string;
+  private dateOfExpiryCheckDigit!: string;
+  private personalNumberCheckDigit!: string; /* NOTE: Over optionalData1, but only for TD3. When empty we prefer '<' over '0'. */
+  private compositeCheckDigit!: string;
+  private optionalData1!: string; /* NOTE: For TD1 holds personal number for some issuing states (e.g. NL), but is used to hold (part of) document number for others. */
+  private optionalData2!: string;
+
+  /**
+   * Creates a new MRZ based on an input stream.
+   *
+   * @param inputStream contains the contents (value) of DG1 (without the tag and length)
+   * @param length the length of the MRZInfo structure
+   */
+  static async fromStream(inputStream: InputStream, length: number) {
+    const mrzInfo = new MRZInfo();
+    try {
+      await mrzInfo.readObject(inputStream, length);
+    } catch (error) {
+      throw new Error(`Error reading MRZ: ${error}`);
+    }
+    return mrzInfo;
+  }
+
+  /**
+   * Creates a new MRZ based on the text input.
+   * The text input may contain newlines, which will be ignored.
+   *
+   * @param str input text
+   */
+  static async fromString(str?: string) {
+    const mrzInfo = new MRZInfo();
+    if (str == null) {
+      throw new Error('Null string');
+    }
+    str = str.trim().replace('\n', '');
+    try {
+      await mrzInfo.readObject(
+        new ByteArrayInputStream(Buffer.from(str, 'utf-8')),
+        str.length
+      );
+    } catch (error) {
+      throw new Error(`Error reading MRZ: ${error}`);
+    }
+
+    return mrzInfo;
+  }
+
+  /**
+   * Returns the date of birth of the passport holder.
+   *
+   * @return date of birth
+   */
+  public getDateOfBirth(): string {
+    return this.dateOfBirth;
+  }
+
+  /**
+   * Returns the date of expiry.
+   *
+   * @return the date of expiry
+   */
+  getDateOfExpiry(): string {
+    return this.dateOfExpiry;
+  }
+
+  /**
+   * Returns the document number.
+   *
+   * @return document number
+   */
+  public getDocumentNumber(): string {
+    return this.documentNumber;
+  }
+
+  /**
+   * Returns the document type.
+   *
+   * @return document type
+   *
+   * @deprecated Clients should determine type based on {@link #getDocumentCode()}
+   */
+  public getDocumentType(): DocumentType {
+    return this.documentType;
+  }
+
+  /**
+   * Returns the document code.
+   *
+   * @return document type
+   */
+  getDocumentCode(): string {
+    return this.documentCode;
+  }
+
+  /**
+   * Returns the issuing state as a 3 letter code.
+   *
+   * @return the issuing state
+   */
+  public getIssuingState(): string {
+    return MRZInfo.mrzFormat(this.issuingState, 3);
+  }
+
+  /**
+   * Returns the passport holder's last name.
+   *
+   * @return name
+   */
+  getPrimaryIdentifier(): string {
+    return this.primaryIdentifier;
+  }
+
+  /**
+   * Returns the document holder's first names.
+   *
+   * @return the secondary identifier
+   */
+  getSecondaryIdentifier(): string {
+    return this.secondaryIdentifier;
+  }
+
+  /**
+   * Returns the document holder's first names.
+   *
+   * @return first names
+   */
+  public getSecondaryIdentifierComponents(): string[] {
+    return this.secondaryIdentifier.split(' |<');
+  }
+
+  /**
+   * Returns the passport holder's nationality as a 3 digit code.
+   *
+   * @return a country
+   */
+  public getNationality(): string {
+    return MRZInfo.mrzFormat(this.nationality, 3);
+  }
+
+  /**
+   * Returns the personal number (if a personal number is encoded in optional data 1).
+   *
+   * @return personal number
+   */
+  public getPersonalNumber(): string | null {
+    if (this.optionalData1 == null) {
+      return null;
+    }
+    if (this.optionalData1.length > 14) {
+      return MRZInfo.trimTrailingFillerChars(
+        this.optionalData1.substring(0, 14)
+      );
+    } else {
+      return MRZInfo.trimTrailingFillerChars(this.optionalData1);
+    }
+  }
+
+  /**
+   * Returns the passport holder's gender.
+   *
+   * @return gender
+   */
+  public getGender(): Gender {
+    return this.gender;
+  }
+
+  /**
+   * Returns the contents of the first optional data field for ID-1 and ID-3 style MRZs.
+   *
+   * @return optional data 1
+   */
+  getOptionalData1(): string {
+    return this.optionalData1;
+  }
+
+  /**
+   * Returns the contents of the second optional data field for ID-1 style MRZs.
+   *
+   * @return optional data 2
+   */
+  getOptionalData2(): string {
+    return this.optionalData2;
+  }
+
+  /**
+   * Sets the document code.
+   *
+   * @param documentCode the new document code
+   *
+   * @deprecated Class will become immutable
+   */
+  public setDocumentCode(documentCode: string): void {
+    this.documentCode = documentCode;
+    this.documentType = MRZInfo.getDocumentTypeFromDocumentCode(documentCode);
+    if (this.documentType === DocumentType.TD1 && this.optionalData2 === null) {
+      this.optionalData2 = '';
+    }
+    /* FIXME: need to adjust some other lengths if we go from ID1 to ID3 or back... */
+  }
+
+  /**
+   * Sets the document number.
+   *
+   * @param documentNumber new document number
+   *
+   * @deprecated Class will become immutable
+   */
+  public setDocumentNumber(documentNumber: string): void {
+    this.documentNumber = documentNumber.trim();
+    this.checkDigit();
+  }
+
+  /**
+   * Sets the passport holder's last name.
+   *
+   * @param primaryIdentifier new primary identifier
+   *
+   * @deprecated Class will become immutable
+   */
+  public setPrimaryIdentifier(primaryIdentifier: string): void {
+    this.primaryIdentifier = MRZInfo.trimTrailingFillerChars(
+      primaryIdentifier
+    ).replace('<', ' ');
+    this.checkDigit();
+  }
+
+  /**
+   * Sets the passport holder's first names.
+   *
+   * @param secondaryIdentifiers new secondary identifiers
+   *
+   * @deprecated Class will become immutable
+   */
+  public setSecondaryIdentifierComponents(
+    secondaryIdentifiers: string[]
+  ): void {
+    if (secondaryIdentifiers == null) {
+      this.secondaryIdentifier = '';
+    } else {
+      let stringBuilder = '';
+      for (let i = 0; i < secondaryIdentifiers.length; i++) {
+        stringBuilder += secondaryIdentifiers[i];
+        if (i < secondaryIdentifiers.length - 1) {
+          stringBuilder += '<';
+        }
+      }
+      this.secondaryIdentifier = stringBuilder;
+    }
+    this.checkDigit();
+  }
+
+  /**
+   * Sets the passport holder's first names.
+   *
+   * @param secondaryIdentifiers new secondary identifiers
+   *
+   * @deprecated Class will become immutable
+   */
+  public setSecondaryIdentifiers(secondaryIdentifiers: string): void {
+    this.readSecondaryIdentifiers(secondaryIdentifiers.trim());
+    this.checkDigit();
+  }
+
+  /**
+   * Sets the date of birth.
+   *
+   * @param dateOfBirth new date of birth
+   *
+   * @deprecated Class will become immutable
+   */
+  public setDateOfBirth(dateOfBirth: string): void {
+    this.dateOfBirth = dateOfBirth;
+    this.checkDigit();
+  }
+
+  /**
+   * Sets the date of expiry.
+   *
+   * @param dateOfExpiry new date of expiry
+   *
+   * @deprecated Class will become immutable
+   */
+  public setDateOfExpiry(dateOfExpiry: string): void {
+    this.dateOfExpiry = dateOfExpiry;
+    this.checkDigit();
+  }
+
+  /**
+   * Sets the issuing state.
+   *
+   * @param issuingState new issuing state
+   *
+   * @deprecated Class will become immutable
+   */
+  public setIssuingState(issuingState: string): void {
+    this.issuingState = issuingState;
+    this.checkDigit();
+  }
+
+  /**
+   * Sets the personal number. Replacing any optional data 1.
+   *
+   * @param personalNumber new personal number
+   *
+   * @deprecated Class will become immutable
+   */
+  public setPersonalNumber(personalNumber: string): void {
+    if (personalNumber == null || personalNumber.length > 14) {
+      throw new Error('Wrong personal number');
+    }
+    this.optionalData1 = MRZInfo.mrzFormat(personalNumber, 14);
+    this.personalNumberCheckDigit = MRZInfo.checkDigit(this.optionalData1);
+  }
+
+  /**
+   * Sets the passport holder's nationality.
+   *
+   * @param nationality new nationality
+   *
+   * @deprecated Class will become immutable
+   */
+  public setNationality(nationality: string): void {
+    this.nationality = nationality;
+    this.checkDigit();
+  }
+
+  /**
+   * Sets the contents for the second optional data field for ID-1 style MRZs.
+   *
+   * @param optionalData2 optional data 2
+   *
+   * @deprecated Class will become immutable
+   */
+  public setOptionalData2(optionalData2: string): void {
+    this.optionalData2 = MRZInfo.trimTrailingFillerChars(optionalData2);
+    this.checkDigit();
+  }
+
+  /**
+   * Sets the gender.
+   *
+   * @param gender new gender
+   *
+   * @deprecated Class will become immutable
+   */
+  public setGender(gender: Gender): void {
+    if (gender == null) {
+      throw new Error('Gender must not be null');
+    }
+    this.gender = gender;
+    this.checkDigit();
+  }
+
+  /* ONLY PRIVATE METHODS BELOW */
+
+  /**
+   * Reads the object value from a stream.
+   *
+   * @param inputStream the stream to read from
+   * @param length the length of the value
+   *
+   * @throws IOException on error reading from the stream
+   */
+  private async readObject(
+    inputStream: InputStream,
+    length: number
+  ): Promise<void> {
+    const dataIn: DataInputStream =
+      inputStream instanceof DataInputStream
+        ? (inputStream as DataInputStream)
+        : new DataInputStream(inputStream);
+
+    /* line 1, pos 1 to 2, Document code, all types. */
+    this.documentCode = MRZInfo.trimTrailingFillerChars(
+      await MRZInfo.readString(dataIn, 2)
+    );
+    this.documentType = MRZInfo.getDocumentType(this.documentCode, length);
+    switch (this.documentType) {
+      case DocumentType.TD1:
+        await this.readObjectTD1(dataIn);
+        break;
+      case DocumentType.TD2:
+      /* Fall through... */
+      case DocumentType.MRVB:
+        await this.readObjectTD2orMRVB(dataIn);
+        break;
+      case DocumentType.MRVA:
+      /* Fall through... */
+      case DocumentType.TD3:
+      /* Fall through... */
+      default:
+        /* Assume it's a ID3 document, i.e. 2-line MRZ. */
+        await this.readObjectTD3OrMRVA(dataIn);
+        break;
+    }
+  }
+
+  /**
+   * Reads the object value from a stream after document-code has already
+   * been read, and it is determined that we are dealing with a TD1 style MRZ.
+   *
+   * @param inputStream the stream to read from
+   *
+   * @throws IOException on error reading from the stream
+   */
+  private async readObjectTD1(inputStream: InputStream): Promise<void> {
+    const dataIn: DataInputStream =
+      inputStream instanceof DataInputStream
+        ? (inputStream as DataInputStream)
+        : new DataInputStream(inputStream);
+
+    /* line 1, pos 3 to 5 Issuing State or organization */
+    this.issuingState = await MRZInfo.readCountryCode(dataIn);
+
+    /* line 1, pos 6 to 14 Document number */
+    this.documentNumber = await MRZInfo.readString(dataIn, 9);
+
+    /* line 1, pos 15 Check digit */
+    this.documentNumberCheckDigit = String.fromCharCode(
+      await dataIn.readUnsignedByte()
+    );
+
+    /* line 1, pos 16 to 30, Optional data elements */
+    const rawOptionalData1 = await MRZInfo.readString(dataIn, 15);
+    this.optionalData1 = MRZInfo.trimTrailingFillerChars(rawOptionalData1);
+
+    if (this.documentNumberCheckDigit === '<' && this.optionalData1 !== '') {
+      /* Interpret personal number as part of document number, see note j. */
+      let extendedDocumentNumberEnd: number = this.optionalData1.indexOf('<');
+      if (extendedDocumentNumberEnd < 0) {
+        extendedDocumentNumberEnd = this.optionalData1.length;
+      }
+
+      const documentNumberRemainder: string = this.optionalData1.substring(
+        0,
+        extendedDocumentNumberEnd - 1
+      );
+      this.documentNumber += documentNumberRemainder;
+      this.documentNumberCheckDigit = this.optionalData1.charAt(
+        extendedDocumentNumberEnd - 1
+      );
+
+      this.optionalData1 = this.optionalData1.substring(
+        Math.min(extendedDocumentNumberEnd + 1, this.optionalData1.length)
+      );
+    }
+    this.documentNumber = MRZInfo.trimTrailingFillerChars(this.documentNumber);
+
+    /* line 2, pos 1 to 6, Date of birth */
+    this.dateOfBirth = await this.readDate(dataIn);
+
+    /* line 2, pos 7, Check digit */
+    this.dateOfBirthCheckDigit = String.fromCharCode(
+      await dataIn.readUnsignedByte()
+    );
+
+    /* line 2, pos 8, Sex */
+    this.gender = await this.readGender(dataIn);
+
+    /* line 2, Pos 9 to 14, Date of expiry */
+    this.dateOfExpiry = await this.readDate(dataIn);
+
+    /* line 2, pos 15, Check digit */
+    this.dateOfExpiryCheckDigit = String.fromCharCode(
+      await dataIn.readUnsignedByte()
+    );
+
+    /* line 2, pos 16 to 18, Nationality */
+    this.nationality = await MRZInfo.readCountryCode(dataIn);
+
+    /* line 2, pos 19 to 29, Optional data elements */
+    this.optionalData2 = MRZInfo.trimTrailingFillerChars(
+      await MRZInfo.readString(dataIn, 11)
+    );
+
+    /* line 2, pos 30, Overall check digit */
+    this.compositeCheckDigit = String.fromCharCode(
+      await dataIn.readUnsignedByte()
+    );
+
+    /* line 3 */
+    this.readNameIdentifiers(await MRZInfo.readString(dataIn, 30));
+  }
+
+  /**
+   * Reads the object value from a stream after document-code has already
+   * been read, and it is determined that we are dealing with a TD2 or MRV-B style MRZ.
+   *
+   * @param inputStream the stream to read from
+   *
+   * @throws IOException on error reading from the stream
+   */
+  private async readObjectTD2orMRVB(inputStream: InputStream): Promise<void> {
+    const dataIn: DataInputStream =
+      inputStream instanceof DataInputStream
+        ? (inputStream as DataInputStream)
+        : new DataInputStream(inputStream);
+
+    /* line 1, pos 3 to 5 */
+    this.issuingState = await MRZInfo.readCountryCode(dataIn);
+
+    /* line 1, pos 6 to 36 */
+    this.readNameIdentifiers(await MRZInfo.readString(dataIn, 31));
+
+    /* line 2 */
+    this.documentNumber = MRZInfo.trimTrailingFillerChars(
+      await MRZInfo.readString(dataIn, 9)
+    );
+    this.documentNumberCheckDigit = String.fromCharCode(
+      await dataIn.readUnsignedByte()
+    );
+    this.nationality = await MRZInfo.readCountryCode(dataIn);
+    this.dateOfBirth = await this.readDate(dataIn);
+    this.dateOfBirthCheckDigit = String.fromCharCode(
+      await dataIn.readUnsignedByte()
+    );
+    this.gender = await this.readGender(dataIn);
+    this.dateOfExpiry = await this.readDate(dataIn);
+    this.dateOfExpiryCheckDigit = String.fromCharCode(
+      await dataIn.readUnsignedByte()
+    );
+    if (this.documentType === DocumentType.MRVB) {
+      this.optionalData1 = MRZInfo.trimTrailingFillerChars(
+        await MRZInfo.readString(dataIn, 8)
+      );
+    } else if (this.documentType === DocumentType.TD2) {
+      this.optionalData1 = MRZInfo.trimTrailingFillerChars(
+        await MRZInfo.readString(dataIn, 7)
+      );
+
+      if (
+        this.documentNumberCheckDigit === '<' &&
+        this.optionalData1.length > 0
+      ) {
+        /* Interpret optional data as part of document number, see note j. */
+        this.documentNumber += this.optionalData1.substring(
+          0,
+          this.optionalData1.length - 1
+        );
+        this.documentNumberCheckDigit = this.optionalData1.charAt(
+          this.optionalData1.length - 1
+        );
+        this.optionalData1 = '';
+      }
+    }
+    this.documentNumber = MRZInfo.trimTrailingFillerChars(this.documentNumber);
+
+    if (this.documentType === DocumentType.TD2) {
+      this.compositeCheckDigit = String.fromCharCode(
+        await dataIn.readUnsignedByte()
+      );
+    }
+  }
+
+  /**
+   * Reads the object value from a stream after document-code has already
+   * been read, and it is determined that we are dealing with a TD3 or MRV-A style MRZ.
+   *
+   * @param inputStream the stream to read from
+   *
+   * @throws IOException on error reading from the stream
+   */
+  private async readObjectTD3OrMRVA(inputStream: InputStream): Promise<void> {
+    const dataIn: DataInputStream =
+      inputStream instanceof DataInputStream
+        ? inputStream
+        : new DataInputStream(inputStream);
+
+    /* line 1, pos 3 to 5 */
+    this.issuingState = await MRZInfo.readCountryCode(dataIn);
+
+    /* line 1, pos 6 to 44 */
+    this.readNameIdentifiers(await MRZInfo.readString(dataIn, 39));
+
+    /* line 2 */
+    this.documentNumber = MRZInfo.trimTrailingFillerChars(
+      await MRZInfo.readString(dataIn, 9)
+    );
+    this.documentNumberCheckDigit = String.fromCharCode(
+      await dataIn.readUnsignedByte()
+    );
+    this.nationality = await MRZInfo.readCountryCode(dataIn);
+    this.dateOfBirth = await this.readDate(dataIn);
+    this.dateOfBirthCheckDigit = String.fromCharCode(
+      await dataIn.readUnsignedByte()
+    );
+    this.gender = await this.readGender(dataIn);
+    this.dateOfExpiry = await this.readDate(dataIn);
+    this.dateOfExpiryCheckDigit = String.fromCharCode(
+      await dataIn.readUnsignedByte()
+    );
+    if (this.documentType === DocumentType.MRVA) {
+      this.optionalData1 = MRZInfo.trimTrailingFillerChars(
+        await MRZInfo.readString(dataIn, 16)
+      );
+    } else {
+      this.optionalData1 = MRZInfo.trimTrailingFillerChars(
+        await MRZInfo.readString(dataIn, 14)
+      );
+      this.personalNumberCheckDigit = String.fromCharCode(
+        await dataIn.readUnsignedByte()
+      );
+      this.compositeCheckDigit = String.fromCharCode(
+        await dataIn.readUnsignedByte()
+      );
+    }
+  }
+
+  /**
+   * Writes the MRZ to an output stream.
+   * This just outputs the MRZ characters, and does not add newlines.
+   *
+   * @param outputStream the output stream to write to
+   */
+  public writeObject(outputStream: OutputStream): void {
+    switch (this.documentType) {
+      case DocumentType.TD1:
+        this.writeObjectTD1(outputStream);
+        break;
+      case DocumentType.TD2:
+      /* Fall through. */
+      case DocumentType.MRVB:
+        this.writeObjectTD2OrMRVB(outputStream);
+        break;
+      case DocumentType.TD3:
+      /* Fall through. */
+      case DocumentType.MRVA:
+        this.writeObjectTD3OrMRVA(outputStream);
+        break;
+      default:
+        throw new Error('Unsupported document type');
+    }
+  }
+
+  /**
+   * Tests equality of two MRZ string while ignoring extra filler characters.
+   *
+   * @param str1 an MRZ string
+   * @param str2 another MRZ string
+   *
+   * @return a boolean indicating whether the strings are equal modulo filler characters
+   */
+  static equalsModuloFillerChars(str1: string, str2: string): boolean {
+    if (str1 === str2) {
+      return true;
+    }
+    if (str1 === null) {
+      str1 = '';
+    }
+    if (str2 === null) {
+      str2 = '';
+    }
+
+    const length = Math.max(str1.length, str2.length);
+    return MRZInfo.mrzFormat(str1, length) === MRZInfo.mrzFormat(str2, length);
+  }
+
+  /**
+   * Writes this MRZ to stream.
+   *
+   * @param outputStream the stream to write to
+   *
+   * @throws IOException on error writing to the stream
+   */
+  private writeObjectTD1(outputStream: OutputStream): void {
+    const dataOut: DataOutputStream =
+      outputStream instanceof DataOutputStream
+        ? outputStream
+        : new DataOutputStream(outputStream);
+
+    /* top line */
+    this.writeDocumentType(dataOut);
+    MRZInfo.writeCountryCode(this.issuingState, dataOut);
+
+    const isExtendedDocumentNumber: boolean = this.documentNumber.length > 9;
+    if (isExtendedDocumentNumber) {
+      /*
+       * If document number has more than 9 character, the 9 principal
+       * character shall be shown in the MRZ in character positions 1 to 9.
+       * They shall be followed by a filler character instead of a check
+       * digit to indicate a truncated number. The remaining character of
+       * the document number shall be shown at the beginning of the field
+       * reserved of optional data element (character position 29 to 35 of
+       * the lower machine readable line) followed by a check digit and a
+       * filler character.
+       *
+       * Corresponds to Doc 9303 (pre-seventh edition) pt 3 vol 1 page V-10 (note j) (FIXED by Paulo Assumcao)
+       *
+       * Also see R3-p1_v2_sIV_0041 in Supplement to Doc 9303, release 11.
+       */
+      this.writeString(this.documentNumber.substring(0, 9), dataOut, 9);
+      dataOut.writeUTF('<'); /* NOTE: instead of check digit */
+      this.writeString(
+        this.documentNumber.substring(9) +
+          this.documentNumberCheckDigit +
+          '<' +
+          this.optionalData1,
+        dataOut,
+        15
+      );
+    } else {
+      this.writeString(
+        this.documentNumber,
+        dataOut,
+        9
+      ); /* FIXME: max size of field */
+      dataOut.writeUTF(this.documentNumberCheckDigit);
+      this.writeString(
+        this.optionalData1,
+        dataOut,
+        15
+      ); /* FIXME: max size of field */
+    }
+
+    /* middle line */
+    this.writeDateOfBirth(dataOut);
+    dataOut.writeUTF(this.dateOfBirthCheckDigit);
+    this.writeGender(dataOut);
+    this.writeDateOfExpiry(dataOut);
+    dataOut.writeUTF(this.dateOfExpiryCheckDigit);
+    MRZInfo.writeCountryCode(this.nationality, dataOut);
+    this.writeString(this.optionalData2, dataOut, 11);
+    dataOut.writeUTF(this.compositeCheckDigit);
+
+    /* bottom line */
+    this.writeName(dataOut, 30);
+  }
+
+  /**
+   * Writes this MRZ to stream.
+   *
+   * @param outputStream the stream to write to
+   *
+   * @throws IOException on error writing to the stream
+   */
+  private writeObjectTD2OrMRVB(outputStream: OutputStream): void {
+    const dataOut: DataOutputStream =
+      outputStream instanceof DataOutputStream
+        ? outputStream
+        : new DataOutputStream(outputStream);
+
+    /* top line */
+    this.writeDocumentType(dataOut);
+    MRZInfo.writeCountryCode(this.issuingState, dataOut);
+    this.writeName(dataOut, 31);
+
+    /* bottom line */
+
+    const isExtendedDocumentNumber: boolean =
+      this.documentType === DocumentType.TD2 &&
+      this.documentNumber.length > 9 &&
+      MRZInfo.equalsModuloFillerChars(this.optionalData1, '');
+    if (isExtendedDocumentNumber) {
+      this.writeString(this.documentNumber.substring(0, 9), dataOut, 9);
+      dataOut.writeUTF('<'); /* NOTE: instead of check digit */
+    } else {
+      this.writeString(
+        this.documentNumber,
+        dataOut,
+        9
+      ); /* FIXME: max size of field */
+      dataOut.writeUTF(this.documentNumberCheckDigit);
+    }
+
+    MRZInfo.writeCountryCode(this.nationality, dataOut);
+    this.writeDateOfBirth(dataOut);
+    dataOut.writeUTF(this.dateOfBirthCheckDigit);
+    this.writeGender(dataOut);
+    this.writeDateOfExpiry(dataOut);
+    dataOut.writeUTF(this.dateOfExpiryCheckDigit);
+    if (this.documentType === DocumentType.MRVB) {
+      this.writeString(this.optionalData1, dataOut, 8);
+    } else if (isExtendedDocumentNumber) {
+      this.writeString(
+        this.documentNumber.substring(9) + this.documentNumberCheckDigit + '<',
+        dataOut,
+        7
+      );
+      dataOut.writeUTF(this.compositeCheckDigit);
+    } else {
+      this.writeString(this.optionalData1, dataOut, 7);
+      dataOut.writeUTF(this.compositeCheckDigit);
+    }
+  }
+
+  /**
+   * Writes this MRZ to stream.
+   *
+   * @param outputStream the stream to write to
+   *
+   * @throws IOException on error writing to the stream
+   */
+  private writeObjectTD3OrMRVA(outputStream: OutputStream): void {
+    const dataOut: DataOutputStream =
+      outputStream instanceof DataOutputStream
+        ? outputStream
+        : new DataOutputStream(outputStream);
+
+    /* top line */
+    this.writeDocumentType(dataOut);
+    MRZInfo.writeCountryCode(this.issuingState, dataOut);
+    this.writeName(dataOut, 39);
+
+    /* bottom line */
+    this.writeString(this.documentNumber, dataOut, 9);
+    dataOut.writeUTF(this.documentNumberCheckDigit);
+    MRZInfo.writeCountryCode(this.nationality, dataOut);
+    this.writeDateOfBirth(dataOut);
+    dataOut.writeUTF(this.dateOfBirthCheckDigit);
+    this.writeGender(dataOut);
+    this.writeDateOfExpiry(dataOut);
+    dataOut.writeUTF(this.dateOfExpiryCheckDigit);
+    if (this.documentType === DocumentType.MRVA) {
+      this.writeString(this.optionalData1, dataOut, 16);
+    } else {
+      // Must be TD3.
+      this.writeString(this.optionalData1, dataOut, 14);
+      dataOut.writeUTF(this.personalNumberCheckDigit);
+      dataOut.writeUTF(this.compositeCheckDigit);
+    }
+  }
+
+  /**
+   * Sets the name identifiers (primary and secondary identifier) based on
+   * the name in the MRZ.
+   *
+   * @param mrzNameString the name field as it occurs in the MRZ
+   */
+  private readNameIdentifiers(mrzNameString: string): void {
+    const delimIndex = mrzNameString.indexOf('<<');
+    if (delimIndex < 0) {
+      /* Only a primary identifier. */
+      this.primaryIdentifier = MRZInfo.trimTrailingFillerChars(
+        mrzNameString
+      ).replace('<', ' ');
+      this.secondaryIdentifier = '';
+      return;
+    }
+    this.primaryIdentifier = MRZInfo.trimTrailingFillerChars(
+      mrzNameString.substring(0, delimIndex)
+    ).replace('<', ' ');
+    const rest = mrzNameString.substring(delimIndex + 2);
+    this.readSecondaryIdentifiers(rest);
+  }
+
+  /**
+   * Sets the secondary identifier.
+   *
+   * @param secondaryIdentifier the new secondary identifier
+   */
+  private readSecondaryIdentifiers(secondaryIdentifier: string): void {
+    this.secondaryIdentifier = MRZInfo.trimTrailingFillerChars(
+      secondaryIdentifier
+    ).replace('<', ' ');
+  }
+
+  /**
+   * Writes a MRZ string to a stream, optionally formatting the MRZ string.
+   *
+   * @param str the string to write
+   * @param dataOutputStream the stream to write to
+   * @param width the width of the MRZ field (the string will be augmented with trailing fillers)
+   *
+   * @throws IOException on error writing to the stream
+   */
+  private writeString(
+    str: string,
+    dataOutputStream: DataOutputStream,
+    width: number
+  ): void {
+    dataOutputStream.writeUTF(MRZInfo.mrzFormat(str, width));
+  }
+
+  /**
+   * Writes the issuing state to a stream.
+   *
+   * @param dataOutputStream the stream to write to
+   *
+   * @throws IOException on error writing to the stream
+   */
+  private static writeCountryCode(
+    countryCode: string,
+    dataOutputStream: DataOutputStream
+  ): void {
+    dataOutputStream.writeUTF(MRZInfo.mrzFormat(countryCode, 3));
+  }
+
+  /**
+   * Writes the date of expiry to a stream.
+   *
+   * @param dateOutputStream the stream to write to
+   *
+   * @throws IOException on error writing to the stream
+   */
+  private writeDateOfExpiry(dateOutputStream: DataOutputStream): void {
+    dateOutputStream.writeUTF(this.dateOfExpiry);
+  }
+
+  /**
+   * Writes the gender to a stream.
+   *
+   * @param dataOutputStream the stream to write to
+   *
+   * @throws IOException on error writing to the stream
+   */
+  private writeGender(dataOutputStream: DataOutputStream): void {
+    dataOutputStream.writeUTF(this.gender.getStrCode());
+  }
+
+  /**
+   * Writes the data of birth to a stream.
+   *
+   * @param dataOutputStream the stream to write to
+   *
+   * @throws IOException on error writing to the stream
+   */
+  private writeDateOfBirth(dataOutputStream: DataOutputStream): void {
+    dataOutputStream.writeUTF(this.dateOfBirth);
+  }
+
+  /**
+   * Writes the name to a stream.
+   *
+   * @param dataOutputStream the stream to write to
+   * @param width the width of the field
+   *
+   * @throws IOException on error writing to the stream
+   */
+  private writeName(dataOutputStream: DataOutputStream, width: number): void {
+    dataOutputStream.writeUTF(
+      MRZInfo.nameToString(
+        this.primaryIdentifier,
+        this.secondaryIdentifier,
+        width
+      )
+    );
+  }
+
+  /**
+   * Write the document type to a stream.
+   *
+   * @param dataOutputStream the stream to write to
+   *
+   * @throws IOException on error writing to the stream
+   */
+  private writeDocumentType(dataOutputStream: DataOutputStream): void {
+    this.writeString(this.documentCode, dataOutputStream, 2);
+  }
+
+  /**
+   * Encodes the personal number as optional data in case of TD3 style MRZ.
+   * If the number does not yet include a check-digit it will be added.
+   *
+   * @param personalNumber the personal number (or optional data)
+   *
+   * @return the optional data to include in the MRZ
+   */
+  private static personalNumberToOptionalData(personalNumber: string): string {
+    if (
+      personalNumber == null ||
+      MRZInfo.equalsModuloFillerChars(personalNumber, '')
+    ) {
+      /* optional data field is not used */
+      return '';
+    } else if (personalNumber.length === 15) {
+      /* it's either a personalNumber with check digit included, or some other optional data. FIXME: Is this case possible? */
+      return personalNumber;
+    } else if (personalNumber.length <= 14) {
+      /* we'll assume it's a personalNumber without check digit, and we add the check digit ourselves */
+      return MRZInfo.mrzFormat(personalNumber, 14);
+    } else {
+      throw new Error(`Wrong personal number${personalNumber}`);
+    }
+  }
+
+  /**
+   * Converts the name (primary and secondary identifier) to a single MRZ formatted name
+   * field of the given length.
+   *
+   * @param primaryIdentifier the primary identifier part of the name
+   * @param secondaryIdentifier the secondary identifier part of the name
+   * @param width the width of the resulting MRZ formatted string
+   *
+   * @return the string containing the MRZ formatted name field
+   */
+  private static nameToString(
+    primaryIdentifier: string,
+    secondaryIdentifier: string,
+    width: number
+  ): string {
+    const primaryComponents: string[] = primaryIdentifier.split(' |<');
+    const secondaryComponents: string[] =
+      secondaryIdentifier == null || secondaryIdentifier.trim().length === 0
+        ? []
+        : secondaryIdentifier.split(' |<');
+
+    const name: string[] = [];
+    let isFirstPrimaryComponent: boolean = true;
+    for (const primaryComponent of primaryComponents) {
+      if (isFirstPrimaryComponent) {
+        isFirstPrimaryComponent = false;
+      } else {
+        name.push('<');
+      }
+      name.push(primaryComponent);
+    }
+
+    if (
+      secondaryIdentifier != null &&
+      secondaryIdentifier.trim().length !== 0
+    ) {
+      name.push('<<');
+      let isFirstSecondaryComponent: boolean = true;
+      for (const secondaryComponent of secondaryComponents) {
+        if (isFirstSecondaryComponent) {
+          isFirstSecondaryComponent = false;
+        } else {
+          name.push('<');
+        }
+        name.push(secondaryComponent);
+      }
+    }
+
+    return MRZInfo.mrzFormat(name.join(''), width);
+  }
+
+  /**
+   * Reads the issuing state as a three letter string.
+   *
+   * @param inputStream the stream to read from
+   *
+   * @return a string of length 3 containing an abbreviation
+   *         of the issuing state or organization
+   *
+   * @throws IOException error reading from the stream
+   */
+  private static async readCountryCode(
+    inputStream: DataInputStream
+  ): Promise<string> {
+    return MRZInfo.trimTrailingFillerChars(
+      await MRZInfo.readString(inputStream, 3)
+    );
+  }
+
+  /**
+   * Reads the 1 letter gender information.
+   *
+   * @param inputStream input source
+   *
+   * @return the gender of the passport holder
+   *
+   * @throws IOException if something goes wrong
+   */
+  private async readGender(inputStream: DataInputStream): Promise<Gender> {
+    const genderStr = await MRZInfo.readString(inputStream, 1);
+    if (genderStr.toUpperCase() === 'M') {
+      return Gender.MALE;
+    }
+    if (genderStr.toUpperCase() === 'F') {
+      return Gender.FEMALE;
+    }
+    return Gender.UNKNOWN;
+  }
+
+  /**
+   * Reads a date.
+   * Result is typically in "yyMMdd" format.
+   *
+   * @param inputStream the stream to read from
+   *
+   * @return the date of birth
+   *
+   * @throws IOException if something goes wrong
+   * @throws NumberFormatException if a data could not be constructed
+   */
+  private async readDate(inputStream: DataInputStream): Promise<string> {
+    return await MRZInfo.readString(inputStream, 6);
+  }
+
+  /**
+   * Reads a fixed length string from a stream.
+   *
+   * @param inputStream the stream to read from
+   * @param count the fixed length
+   *
+   * @return the string that was read
+   *
+   * @throws IOException on error reading from the stream
+   */
+  private static async readString(
+    inputStream: DataInputStream,
+    count: number
+  ): Promise<string> {
+    const data = Buffer.alloc(count);
+    await inputStream.readFully(data);
+    return Buffer.from(data).toString('utf8');
+  }
+
+  /**
+   * Returns the composite part over which the composite check digit is computed.
+   *
+   * @param documentType the type of document, either {@code DOC_TYPE_ID1} or {@code DOC_TYPE_ID3}
+   *
+   * @return a string with the composite part
+   */
+  private getComposite(documentType: DocumentType): string | null {
+    const composite: string[] = [];
+    const documentNumberLength: number = this.documentNumber.length;
+
+    switch (documentType) {
+      case DocumentType.TD1:
+        /*
+         * Upper line:
+         * 6-30, i.e., documentNumber, documentNumberCheckDigit, optionaldata1(15)
+         *
+         * Middle line:
+         * 1-7, i.e., dateOfBirth, dateOfBirthCheckDigit
+         * 9-15, i.e., dateOfExpiry, dateOfExpiryCheckDigit
+         * 19-29, i.e., optionalData2(11)
+         */
+        if (documentNumberLength <= 9) {
+          composite.push(MRZInfo.mrzFormat(this.documentNumber, 9));
+          composite.push(this.documentNumberCheckDigit);
+          composite.push(MRZInfo.mrzFormat(this.optionalData1, 15));
+        } else {
+          /* Document number, first 9 characters. */
+          composite.push(this.documentNumber.substring(0, 9));
+          composite.push('<'); /* Filler instead of check digit. */
+
+          /* Remainder of document number. */
+          const documentNumberRemainder: string =
+            this.documentNumber.substring(9);
+          composite.push(documentNumberRemainder);
+          composite.push(this.documentNumberCheckDigit);
+          composite.push('<');
+
+          /* Remainder of optional data 1 (removing any prefix). */
+          const optionalData1Remainder: string = MRZInfo.mrzFormat(
+            this.optionalData1,
+            15 - 2 - documentNumberRemainder.length
+          );
+          composite.push(optionalData1Remainder);
+        }
+        composite.push(this.dateOfBirth);
+        composite.push(this.dateOfBirthCheckDigit);
+        composite.push(this.dateOfExpiry);
+        composite.push(this.dateOfExpiryCheckDigit);
+        composite.push(MRZInfo.mrzFormat(this.optionalData2, 11));
+        return composite.join('');
+      case DocumentType.TD2:
+        /* Composite check digit lower line: 1-10, 14-20, 22-35. */
+        composite.push(this.documentNumber);
+        composite.push(this.documentNumberCheckDigit);
+        composite.push(this.dateOfBirth);
+        composite.push(this.dateOfBirthCheckDigit);
+        composite.push(this.dateOfExpiry);
+        composite.push(this.dateOfExpiryCheckDigit);
+        composite.push(MRZInfo.mrzFormat(this.optionalData1, 7));
+        return composite.join('');
+      case DocumentType.MRVB:
+        /* No composite checkdigit for MRV-B. */
+        return null;
+      case DocumentType.TD3:
+        /* Composite check digit lower line: 1-10, 14-20, 22-43. */
+        composite.push(MRZInfo.mrzFormat(this.documentNumber, 9));
+        composite.push(this.documentNumberCheckDigit);
+        composite.push(this.dateOfBirth);
+        composite.push(this.dateOfBirthCheckDigit);
+        composite.push(this.dateOfExpiry);
+        composite.push(this.dateOfExpiryCheckDigit);
+        composite.push(MRZInfo.mrzFormat(this.optionalData1, 14));
+        composite.push(this.personalNumberCheckDigit);
+        return composite.join('');
+      case DocumentType.MRVA:
+        /* No composite checkdigit for MRV-A. */
+        return null;
+      default:
+        throw new Error('Unsupported document type');
+    }
+  }
+
+  /**
+   * Updates the check digit fields for document number,
+   * date of birth, date of expiry, and composite.
+   */
+  private checkDigit(): void {
+    this.documentNumberCheckDigit = MRZInfo.checkDigit(this.documentNumber);
+    this.dateOfBirthCheckDigit = MRZInfo.checkDigit(this.dateOfBirth);
+    this.dateOfExpiryCheckDigit = MRZInfo.checkDigit(this.dateOfExpiry);
+
+    if (
+      this.documentType === DocumentType.TD3 &&
+      this.optionalData1.length < 15
+    ) {
+      this.personalNumberCheckDigit = MRZInfo.checkDigit(
+        MRZInfo.mrzFormat(this.optionalData1, 14),
+        true
+      ); /* FIXME: Uses '<' over '0'. Where specified? */
+    }
+
+    const composite: string | null = this.getComposite(this.documentType);
+    if (composite != null) {
+      this.compositeCheckDigit = MRZInfo.checkDigit(composite);
+    }
+  }
+
+  /**
+   * Reformats the input string such that it
+   * only contains ['A'-'Z'], ['0'-'9'], '<' characters
+   * by replacing other characters with '<'.
+   * Also extends to the given length by adding '<' to the right.
+   *
+   * @param str the input string
+   * @param width the (minimal) width of the result
+   *
+   * @return the reformatted string
+   */
+  private static mrzFormat(str: string, width: number): string {
+    if (str == null) {
+      return '';
+    }
+    if (str.length > width) {
+      throw new Error(`Argument too wide (${str.length} > ${width})`);
+    }
+    str = str.toUpperCase().trim();
+    let result = '';
+    for (let i = 0; i < str.length; i++) {
+      const c = str.charAt(i);
+      if (MRZInfo.MRZ_CHARS.indexOf(c) === -1) {
+        result += '<';
+      } else {
+        result += c;
+      }
+    }
+    while (result.length < width) {
+      result += '<';
+    }
+    return result;
+  }
+
+  /**
+   * Determines the document-type.
+   *
+   * @param documentCode the document-code
+   * @param length the length of the complete MRZ (excluding whitespace)
+   *
+   * @return the document-type enum value
+   */
+  private static getDocumentType(
+    documentCode: string,
+    length: number
+  ): DocumentType {
+    if (
+      documentCode == null ||
+      documentCode.length < 1 ||
+      documentCode.length > 2
+    ) {
+      throw new Error(
+        'Was expecting 1 or 2 digit document code, got ' + documentCode
+      );
+    }
+
+    switch (length) {
+      case 90:
+        /* Document-code must start with C, I, or A. */
+        return DocumentType.TD1;
+      case 72:
+        if (documentCode.startsWith('V')) {
+          return DocumentType.MRVB;
+        } else {
+          /* Document-code must start with C, I, or A. */
+          return DocumentType.TD2;
+        }
+      case 88:
+        if (documentCode.startsWith('V')) {
+          return DocumentType.MRVA;
+        } else {
+          /* Document-code must start with P. */
+          return DocumentType.TD3;
+        }
+      default:
+        return DocumentType.UNKNOWN;
+    }
+  }
+
+  /*
+   * NOTE: Can be removed once deprecated methods are gone.
+   */
+  /**
+   * Determines the document type based on the document code (the first two characters of the MRZ).
+   *
+   * ICAO Doc 9303 part 3 vol 1 defines MRTDs with 3-line MRZs,
+   * in this case the document code starts with "A", "C", or "I"
+   * according to note j to Section 6.6 (page V-9).
+   *
+   * ICAO Doc 9303 part 2 defines MRVs with 2-line MRZs,
+   * in this case the document code starts with "V".
+   *
+   * ICAO Doc 9303 part 1 vol 1 defines MRPs with 2-line MRZs,
+   * in this case the document code starts with "P"
+   * according to Section 9.6 (page IV-15).
+   *
+   * @param documentCode a two letter code
+   *
+   * @return a document type, one of {@link #DOC_TYPE_ID1}, {@link #DOC_TYPE_ID2},
+   * 			{@link #DOC_TYPE_ID3}, or {@link #DOC_TYPE_UNSPECIFIED}
+   */
+  private static getDocumentTypeFromDocumentCode(
+    documentCode: string
+  ): DocumentType {
+    if (
+      documentCode.startsWith('A') ||
+      documentCode.startsWith('C') ||
+      documentCode.startsWith('I')
+    ) {
+      /* MRTD according to ICAO Doc 9303 (seventh edition) part 5 or 6. NOTE: Could also be TD2. */
+      return DocumentType.TD1;
+    } else if (documentCode.startsWith('V')) {
+      /* MRV according to ICAO Doc 9303 (old) part 2. NOTE: Could also be MRVA. */
+      return DocumentType.MRVB;
+    } else if (documentCode.startsWith('P')) {
+      /* MRP according to ICAO Doc 9303 (old) part 1 vol 1 */
+      return DocumentType.TD3;
+    }
+    return DocumentType.UNKNOWN;
+  }
+
+  /**
+   * Replaces '<' with ' ' and trims leading and trailing whitespace.
+   *
+   * @param str the string to read from
+   *
+   * @return a trimmed string
+   */
+  private static trimTrailingFillerChars(str: string): string {
+    if (str == null) {
+      return '';
+    }
+    return str.replace(/</g, ' ').trim();
+  }
+
+  /**
+   * Checks if the document-code is consistent with the given document-type.
+   *
+   * @param documentType the document-type
+   * @param documentCode the document-code
+   *
+   * @return a boolean
+   */
+  private static isDocumentCodeConsistentWithDocumentType(
+    documentType: DocumentType,
+    documentCode: string
+  ): boolean {
+    if (documentCode == null) {
+      return false;
+    }
+
+    if (documentCode.length !== 1 && documentCode.length !== 2) {
+      return false;
+    }
+
+    switch (documentType) {
+      case DocumentType.TD1:
+      /* Fall through... */
+      case DocumentType.TD2:
+        return (
+          documentCode.startsWith('C') ||
+          documentCode.startsWith('I') ||
+          documentCode.startsWith('A')
+        );
+      case DocumentType.TD3:
+        return documentCode.startsWith('P');
+      case DocumentType.MRVA:
+      /* Fall through... */
+      case DocumentType.MRVB:
+        return documentCode.startsWith('V');
+      default:
+        return false;
+    }
+  }
+
+  /**
+   * Checks if the optional data is consistent with the given document-type.
+   *
+   * @param documentType the document-type
+   * @param optionalData1 optional data 1 or personal number
+   * @param optionalData2 optional data 2 or {@code null} if not present
+   *
+   * @return a boolean
+   */
+  private static isOptionalDataConsistentWithDocumentType(
+    documentType: DocumentType,
+    optionalData1: string,
+    optionalData2: string | null
+  ): boolean {
+    switch (documentType) {
+      case DocumentType.TD1:
+        return (
+          (optionalData1 == null || optionalData1.length <= 15) &&
+          (optionalData2 == null || optionalData2.length <= 11)
+        );
+      case DocumentType.TD2:
+        return (
+          (optionalData1 == null || optionalData1.length <= 7) &&
+          optionalData2 == null
+        );
+      case DocumentType.MRVB:
+        return (
+          (optionalData1 == null || optionalData1.length <= 8) &&
+          optionalData2 == null
+        );
+      case DocumentType.TD3:
+        return (
+          (optionalData1 == null || optionalData1.length <= 15) &&
+          optionalData2 == null
+        );
+      case DocumentType.MRVA:
+        return (
+          (optionalData1 == null || optionalData1.length <= 16) &&
+          optionalData2 == null
+        );
+      default:
+        return false;
+    }
+  }
+
+  /**
+   * Computes the 7-3-1 check digit for part of the MRZ.
+   * If `preferFillerOverZero` is `true` then '<' will be
+   * returned on check digit 0.
+   *
+   * @param str a part of the MRZ
+   * @param preferFillerOverZero a boolean indicating whether fillers should be preferred
+   *
+   * @return the resulting check digit (in '0' - '9', '<')
+   */
+  public static checkDigit(
+    str: string,
+    preferFillerOverZero: boolean = false
+  ): string {
+    try {
+      const chars: number[] =
+        str == null ? [] : Array.from(str, (char) => char.charCodeAt(0));
+      const weights: number[] = [7, 3, 1];
+      let result: number = 0;
+      for (let i = 0; i < chars.length; i++) {
+        result = (result + weights[i % 3] * this.decodeMRZDigit(chars[i])) % 10;
+      }
+      const checkDigitString: string = result.toString();
+      if (checkDigitString.length !== 1) {
+        throw new Error(
+          'Error in computing check digit.'
+        ); /* NOTE: Never happens. */
+      }
+      let checkDigit: string = String.fromCharCode(
+        checkDigitString.charCodeAt(0)
+      );
+      if (preferFillerOverZero && checkDigit === '0') {
+        checkDigit = '<';
+      }
+      return checkDigit;
+    } catch (error) {
+      /* NOTE: never happens. */
+      throw new Error('Error in computing check digit');
+    }
+  }
+
+  /**
+   * Looks up the numerical value for MRZ characters. In order to be able
+   * to compute check digits.
+   *
+   * @param ch a character from the MRZ.
+   *
+   * @return the numerical value of the character.
+   *
+   * @throws NumberFormatException if {@code ch} is not a valid MRZ character
+   */
+  private static decodeMRZDigit(ch: number): number {
+    switch (ch) {
+      case '<'.charCodeAt(0):
+      case '0'.charCodeAt(0):
+        return 0;
+      case '1'.charCodeAt(0):
+        return 1;
+      case '2'.charCodeAt(0):
+        return 2;
+      case '3'.charCodeAt(0):
+        return 3;
+      case '4'.charCodeAt(0):
+        return 4;
+      case '5'.charCodeAt(0):
+        return 5;
+      case '6'.charCodeAt(0):
+        return 6;
+      case '7'.charCodeAt(0):
+        return 7;
+      case '8'.charCodeAt(0):
+        return 8;
+      case '9'.charCodeAt(0):
+        return 9;
+      case 'a'.charCodeAt(0):
+      case 'A'.charCodeAt(0):
+        return 10;
+      case 'b'.charCodeAt(0):
+      case 'B'.charCodeAt(0):
+        return 11;
+      case 'c'.charCodeAt(0):
+      case 'C'.charCodeAt(0):
+        return 12;
+      case 'd'.charCodeAt(0):
+      case 'D'.charCodeAt(0):
+        return 13;
+      case 'e'.charCodeAt(0):
+      case 'E'.charCodeAt(0):
+        return 14;
+      case 'f'.charCodeAt(0):
+      case 'F'.charCodeAt(0):
+        return 15;
+      case 'g'.charCodeAt(0):
+      case 'G'.charCodeAt(0):
+        return 16;
+      case 'h'.charCodeAt(0):
+      case 'H'.charCodeAt(0):
+        return 17;
+      case 'i'.charCodeAt(0):
+      case 'I'.charCodeAt(0):
+        return 18;
+      case 'j'.charCodeAt(0):
+      case 'J'.charCodeAt(0):
+        return 19;
+      case 'k'.charCodeAt(0):
+      case 'K'.charCodeAt(0):
+        return 20;
+      case 'l'.charCodeAt(0):
+      case 'L'.charCodeAt(0):
+        return 21;
+      case 'm'.charCodeAt(0):
+      case 'M'.charCodeAt(0):
+        return 22;
+      case 'n'.charCodeAt(0):
+      case 'N'.charCodeAt(0):
+        return 23;
+      case 'o'.charCodeAt(0):
+      case 'O'.charCodeAt(0):
+        return 24;
+      case 'p'.charCodeAt(0):
+      case 'P'.charCodeAt(0):
+        return 25;
+      case 'q'.charCodeAt(0):
+      case 'Q'.charCodeAt(0):
+        return 26;
+      case 'r'.charCodeAt(0):
+      case 'R'.charCodeAt(0):
+        return 27;
+      case 's'.charCodeAt(0):
+      case 'S'.charCodeAt(0):
+        return 28;
+      case 't'.charCodeAt(0):
+      case 'T'.charCodeAt(0):
+        return 29;
+      case 'u'.charCodeAt(0):
+      case 'U'.charCodeAt(0):
+        return 30;
+      case 'v'.charCodeAt(0):
+      case 'V'.charCodeAt(0):
+        return 31;
+      case 'w'.charCodeAt(0):
+      case 'W'.charCodeAt(0):
+        return 32;
+      case 'x'.charCodeAt(0):
+      case 'X'.charCodeAt(0):
+        return 33;
+      case 'y'.charCodeAt(0):
+      case 'Y'.charCodeAt(0):
+        return 34;
+      case 'z'.charCodeAt(0):
+      case 'Z'.charCodeAt(0):
+        return 35;
+      default:
+        throw new Error(
+          `Could not decode MRZ character ${ch} ('${String.fromCharCode(ch)}')`
+        );
+    }
+  }
+}