normalized fields and added missing fields (#36)

* refactor: normalized fields and added missing fields

* style: fixed linting errors

* refactor: clened up types

* refactor: removed platform check

Author: Kendall Kelly

README.md

@@ -93,12 +93,14 @@ const onScanID = () => {
   licenseNumber: string;
   expirationDate: string;
   endorsementsCode: string;
+  endorsementsCodeDescription: string;
   issuedBy: string;
   firstName: string;
   middleName: string;
   lastName: string;
   nameSuffix: string;
   restrictionsCode: string;
+  restrictionsCodeDescription: string;
   birthDate: string;
   countryCode: string;
   jurisdictionCode: string;
@@ -111,6 +113,9 @@ const onScanID = () => {
   restrictionCode: string;
   postalCode: string;
   specification: string;
+  hazmateExpDate: string;
+  cardRevisionDate: string;
+  complianceType: string;
 }
 ```
 
@@ -134,6 +139,23 @@ const onScanID = () => {
 }
 ```
 
+### Platform Specific Attributes
+
+## Android
+
+- `restrictionsCodeDescription` 
+- `endorsementsCodeDescription`
+- `restrictionsCode`
+- `specification`
+
+## iOS
+
+- `weight` 
+- `issuerIdNum`
+- `restrictionsNum`
+- `cardRevisionDate`
+- `complianceType`
+
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

src/index.tsx

@@ -50,6 +50,9 @@ export function scan(
   onScanComplete: ScanResult
 ) {
   IdscanSdk.scan(type, apiKeys, (error: object, data: DLData) => {
+    data.birthDate = data.birthDate || data.birthdate;
+    data.IIN = data.IIN || data.iin;
+    data.hazmateExpDate = data.HAZMATEExpDate;
     onScanComplete(error, data);
   });
 }

src/types.tsx

@@ -2,6 +2,7 @@
  * Drivers License Data Format
  */
 export type DLData = {
+  [key: string]: string;
   namePrefix: string;
   IIN: string;
   race: string;
@@ -18,12 +19,14 @@ export type DLData = {
   licenseNumber: string;
   expirationDate: string;
   endorsementsCode: string;
+  endorsementsCodeDescription: string;
   issuedBy: string;
   firstName: string;
   middleName: string;
   lastName: string;
   nameSuffix: string;
   restrictionsCode: string;
+  restrictionsCodeDescription: string;
   birthDate: string;
   countryCode: string;
   jurisdictionCode: string;
@@ -36,6 +39,9 @@ export type DLData = {
   restrictionCode: string;
   postalCode: string;
   specification: string;
+  hazmateExpDate: string;
+  cardRevisiondate: string;
+  complianceType: string;
 };
 
 /**