aamva-parser/src/mappers/fieldMapping.ts

Plugin to parse AAMVA Drivers License Data from the PDF417 barcode

// Define the FieldMapping interface
export interface FieldMapping {
  // A list of AAMVA field designator mappings (e.g. "firstName" => "DAC")
  fields: { [key: string]: string };

  /**
   * Determine the AAMVA field designator for a particular human-readable key.
   *
   * @param key - The human-readable key
   * @returns The AAMVA field designator
   */
  fieldFor(key: string): string;
}

// Standard FieldMapping implementation based on the AAMVA Version 8 standard
export class FieldMapper implements FieldMapping {
  // A list of AAMVA field designator mappings (e.g. "firstName" => "DAC")
  private _fields: { [key: string]: string } = {
    firstName: "DAC",
    lastName: "DCS",
    middleName: "DAD",
    expirationDate: "DBA",
    issueDate: "DBD",
    dateOfBirth: "DBB",
    gender: "DBC",
    eyeColor: "DAY",
    height: "DAU",
    streetAddress: "DAG",
    city: "DAI",
    state: "DAJ",
    postalCode: "DAK",
    driversLicenseId: "DAQ",
    documentId: "DCF",
    country: "DCG",
    middleNameTruncation: "DDG",
    firstNameTruncation: "DDF",
    lastNameTruncation: "DDE",
    streetAddressSupplement: "DAH",
    hairColor: "DAZ",
    placeOfBirth: "DCI",
    auditInformation: "DCJ",
    inventoryControlNumber: "DCK",
    lastNameAlias: "DBN",
    firstNameAlias: "DBG",
    suffixAlias: "DBS",
    suffix: "DCU",
    weight: "DAW"
  };

  // Getter for fields
  public get fields(): { [key: string]: string } {
    return this._fields;
  }

  // Setter for fields
  public set fields(newFields: { [key: string]: string }) {
    this._fields = newFields;
  }

  /**
   * Determine the AAMVA field designator for a particular human-readable key.
   *
   * @param key - The human-readable key
   * @returns The AAMVA field designator
   */
  public fieldFor(key: string): string {
    return this.fields[key] || "";
  }
}