refactor: update typeAll to typeCombined scanner and parser

Author: ian-wd

ios/IdscanSdk.m

@@ -10,7 +10,7 @@
 @implementation IdscanSdk
 
 // Constants
-const NSString* typeAll = @"all";
+const NSString* typeCombined = @"combined";
 const NSString* typeMRZ = @"mrz";
 const NSString* typePDF = @"pdf";
 
@@ -69,7 +69,7 @@ - (void)returnScanResult:(ScannerViewController *)controller scanResult:(NSStrin
 - (NSDictionary *)constantsToExport
 {
  return @{
-     @"TYPE_ALL": typeAll,
+     @"TYPE_COMBINED": typeCombined,
      @"TYPE_MRZ": typeMRZ,
      @"TYPE_PDF": typePDF
  };

src/index.tsx

@@ -20,12 +20,30 @@ const IdscanSdk = NativeModules.IdscanSdk
 
 // SDK Constants
 const SDKConstants = IdscanSdk.getConstants();
+
 export const IDScanner_Constants = {
-  TYPE_ALL: SDKConstants.TYPE_ALL,
+  /**
+   * Combined PDF and MRZ Scanner
+   */
+  TYPE_COMBINED: SDKConstants.TYPE_COMBINED,
+
+  /**
+   * Scan Passports
+   */
   TYPE_MRZ: SDKConstants.TYPE_MRZ,
+
+  /**
+   * Scan Drivers Licenses
+   */
   TYPE_PDF: SDKConstants.TYPE_PDF,
 };
 
+/**
+ * Scan a Drivers License or Passport
+ * @param type Supported scanner/parser types
+ * @param apiKeys Object containing android and iOS API keys
+ * @param onScanComplete Handle scan complete function
+ */
 export function scan(
   type: IdScannerTypes,
   apiKeys: APIKeys,

src/types.tsx

@@ -47,7 +47,7 @@ export type ScanResult = (error: object, scanData: DLData) => void;
  * Scanner Types
  */
 export enum IdScannerTypes {
-  TYPE_ALL,
+  TYPE_COMBINED,
   TYPE_MRZ,
   TYPE_PDF,
 }