@microblink/blinkid-react-native 8000.0.0 → 8001.0.0

package/android/src/main/java/com/microblink/blinkid/reactnative/BlinkIdDeserializationUtilities.kt

@@ -4,11 +4,13 @@ import android.graphics.Bitmap
 import android.graphics.BitmapFactory
 import android.util.Base64
 import com.microblink.blinkid.core.BlinkIdSdkSettings
+import com.microblink.blinkid.core.settings.ResourcesConfig
+import com.microblink.blinkid.core.settings.OtaResourcesConfig
 import com.microblink.blinkid.core.result.FieldType
-import com.microblink.blinkid.core.result.classinfo.Country
+import com.microblink.blinkid.core.result.classinfo.CountryId
 import com.microblink.blinkid.core.result.classinfo.DocumentClassInfo
-import com.microblink.blinkid.core.result.classinfo.Region
-import com.microblink.blinkid.core.result.classinfo.Type
+import com.microblink.blinkid.core.result.classinfo.RegionId
+import com.microblink.blinkid.core.result.classinfo.DocumentTypeId
 import com.microblink.blinkid.core.session.BlinkIdSessionSettings
 import com.microblink.blinkid.core.session.ScanningMode
 import com.microblink.blinkid.core.settings.DocumentNumberRedactionSettings
@@ -16,6 +18,8 @@ import com.microblink.blinkid.core.settings.RedactionSettings
 import com.microblink.blinkid.core.settings.RedactionSettingsResolver
 import com.microblink.blinkid.core.settings.ScanningSettings
 import com.microblink.blinkid.core.settings.SensitivityLevel
+import com.microblink.blinkid.core.image.InputImageCropType
+import com.microblink.blinkid.core.image.InputImageSelectionStrategy
 import com.microblink.blinkid.core.settings.scanning.BarcodeModuleSettings
 import com.microblink.blinkid.core.settings.scanning.DocumentCaptureModuleSettings
 import com.microblink.blinkid.core.settings.scanning.MrzModuleSettings
@@ -27,6 +31,7 @@ import com.microblink.blinkid.core.session.InputImageSource
 import com.microblink.blinkid.core.settings.RedactionMode
 import com.microblink.blinkid.ux.camera.CameraLensFacing
 import com.microblink.blinkid.ux.camera.CameraSettings
+import kotlin.time.Duration
 import kotlin.time.Duration.Companion.milliseconds
 import android.os.Parcelable
 import kotlinx.parcelize.Parcelize
@@ -36,26 +41,45 @@ import org.json.JSONObject
 object BlinkIdDeserializationUtilities {
 
   private const val DEFAULT_RESOURCE_DOWNLOAD_URL = "https://models.cdn.microblink.com/resources"
-  private const val DEFAULT_RESOURCES_LOCAL_FOLDER = "MLModels"
+  private const val DEFAULT_RESOURCES_LOCAL_FOLDER = "microblink/blinkid"
+
+  private const val DEFAULT_OTA_DOWNLOAD_URL = "https://blinkid-ota.microblink.com"
+  private const val DEFAULT_OTA_RESOURCES_LOCAL_FOLDER = "microblink/blinkid/ota"
 
   fun deserializeBlinkIdSdkSettings(blinkIdSdkSettingsMap: JSONObject?): BlinkIdSdkSettings? {
     val licenseKey = blinkIdSdkSettingsMap?.optString("licenseKey")?.takeIf { it.isNotBlank() }
       ?: return null
 
+    val resourcesMap = blinkIdSdkSettingsMap.optJSONObject("resourcesConfig")
+    val otaResourcesMap = blinkIdSdkSettingsMap.optJSONObject("otaResourcesConfig")
+
     return BlinkIdSdkSettings(
       licenseKey = licenseKey,
       licensee = blinkIdSdkSettingsMap.optString("licensee").takeIf { it.isNotBlank() },
-      downloadResources = blinkIdSdkSettingsMap.optBoolean("downloadResources", true),
-      resourceDownloadUrl = blinkIdSdkSettingsMap.optString(
-        "resourceDownloadUrl",
-        DEFAULT_RESOURCE_DOWNLOAD_URL
-      ),
-      resourceLocalFolder = blinkIdSdkSettingsMap.optString(
-        "resourceLocalFolder",
-        DEFAULT_RESOURCES_LOCAL_FOLDER
+      resourcesConfig = ResourcesConfig(
+        download = resourcesMap?.optBoolean("download", true) ?: true,
+        serviceUrl = resourcesMap?.optString("serviceUrl")
+          ?.takeIf { it.isNotBlank() }
+          ?: DEFAULT_RESOURCE_DOWNLOAD_URL,
+        localFolder = resourcesMap?.optString("localFolder")
+          ?.takeIf { it.isNotBlank() }
+          ?: DEFAULT_RESOURCES_LOCAL_FOLDER,
+        requestTimeout = deserializeResourceRequestTimeout(
+          resourcesMap?.opt("requestTimeout")
+        ),
       ),
-      resourceRequestTimeout = deserializeResourceRequestTimeout(
-        blinkIdSdkSettingsMap.opt("resourceRequestTimeout")
+      otaResourcesConfig = OtaResourcesConfig(
+        checkForUpdates = otaResourcesMap?.optBoolean("checkForUpdates", true) ?: true,
+        strict = otaResourcesMap?.optBoolean("strict", false) ?: false,
+        serviceUrl = otaResourcesMap?.optString("serviceUrl")
+          ?.takeIf { it.isNotBlank() }
+          ?: DEFAULT_OTA_DOWNLOAD_URL,
+        localFolder = otaResourcesMap?.optString("localFolder")
+          ?.takeIf { it.isNotBlank() }
+          ?: DEFAULT_OTA_RESOURCES_LOCAL_FOLDER,
+        requestTimeout = deserializeResourceRequestTimeout(
+          otaResourcesMap?.opt("requestTimeout")
+        ),
       ),
       microblinkProxyUrl = blinkIdSdkSettingsMap.optString("microblinkProxyURL")
         .takeIf { it.isNotBlank() },
@@ -219,7 +243,8 @@ object BlinkIdDeserializationUtilities {
     moduleMap: JSONObject
   ): DocumentCaptureModuleSettings {
     return DocumentCaptureModuleSettings(
-      inputImageCropped = moduleMap.optBoolean("inputImageCropped", false),
+      cropType = parseInputImageCropType(moduleMap.optString("cropType", "not-cropped")),
+      inputImageSelectionStrategy = parseInputImageSelectionStrategy(moduleMap.optString("inputImageSelectionStrategy", "balanced")),
       unsupportedDocumentsAllowed = moduleMap.optBoolean("unsupportedDocumentsAllowed", false),
       secondSideWithNoExtractableDataSkipped = moduleMap.optBoolean(
         "secondSideWithNoExtractableDataSkipped",
@@ -263,6 +288,7 @@ object BlinkIdDeserializationUtilities {
       ean13ScanningEnabled = moduleMap.optBoolean("ean13ScanningEnabled", false),
       itfScanningEnabled = moduleMap.optBoolean("itfScanningEnabled", false),
       dataMatrixScanningEnabled = moduleMap.optBoolean("dataMatrixScanningEnabled", false),
+      aztecScanningEnabled = moduleMap.optBoolean("aztecScanningEnabled", false),
     )
   }
 
@@ -298,23 +324,28 @@ object BlinkIdDeserializationUtilities {
   }
 
   private fun deserializeResourceRequestTimeout(timeoutValue: Any?): RequestTimeout {
-    return when (timeoutValue) {
-      is Number -> {
-        val timeout = timeoutValue.toInt().milliseconds
-        RequestTimeout(
-          connectionTimeout = timeout,
-          writeTimeout = timeout,
-          readTimeout = timeout,
-        )
-      }
-      is JSONObject -> RequestTimeout(
-        connectionTimeout = timeoutValue
-          .optInt("connectionTimeoutMilliseconds", 10_000)
-          .milliseconds,
-        writeTimeout = timeoutValue.optInt("writeTimeoutMilliseconds", 10_000).milliseconds,
-        readTimeout = timeoutValue.optInt("readTimeoutMilliseconds", 10_000).milliseconds,
-      )
-      else -> RequestTimeout.DEFAULT
+    val resourceRequestTimeoutMap = timeoutValue as? JSONObject ?: return RequestTimeout.DEFAULT
+    val defaultTimeout = RequestTimeout.DEFAULT
+    return RequestTimeout(
+      connectionTimeout = deserializeTimeoutMilliseconds(
+        resourceRequestTimeoutMap.opt("connectionTimeoutMilliseconds"),
+        defaultTimeout.connectionTimeout,
+      ),
+      writeTimeout = deserializeTimeoutMilliseconds(
+        resourceRequestTimeoutMap.opt("writeTimeoutMilliseconds"),
+        defaultTimeout.writeTimeout,
+      ),
+      readTimeout = deserializeTimeoutMilliseconds(
+        resourceRequestTimeoutMap.opt("readTimeoutMilliseconds"),
+        defaultTimeout.readTimeout,
+      ),
+    )
+  }
+
+  private fun deserializeTimeoutMilliseconds(value: Any?, default: Duration): Duration {
+    return when (value) {
+      is Number -> value.toInt().milliseconds
+      else -> default
     }
   }
 
@@ -325,6 +356,24 @@ object BlinkIdDeserializationUtilities {
     }
   }
 
+  private fun parseInputImageCropType(value: String): InputImageCropType {
+    return when (value.lowercase()) {
+      "cropped" -> InputImageCropType.Cropped
+      "unknown" -> InputImageCropType.Unknown
+      else -> InputImageCropType.NotCropped
+    }
+  }
+
+  private fun parseInputImageSelectionStrategy(value: String): InputImageSelectionStrategy {
+    return when (value.lowercase()) {
+      "single-image" -> InputImageSelectionStrategy.SingleImage
+      "optimize-for-speed" -> InputImageSelectionStrategy.OptimizeForSpeed
+      "balanced" -> InputImageSelectionStrategy.Balanced
+      "optimize-for-quality" -> InputImageSelectionStrategy.OptimizeForQuality
+      else -> InputImageSelectionStrategy.Balanced
+    }
+  }
+
   private fun parseSensitivityLevel(value: String): SensitivityLevel {
     return when (value.lowercase()) {
       "off" -> SensitivityLevel.Off
@@ -390,19 +439,19 @@ object BlinkIdDeserializationUtilities {
     val region = filteredClass.optString("region").takeIf { it.isNotBlank() }
     val documentType = filteredClass.optString("documentType").takeIf { it.isNotBlank() }
 
-    return (country == null || parseCountry(country) == classInfo.country) &&
-      (region == null || parseRegion(region) == classInfo.region) &&
-      (documentType == null || parseDocumentType(documentType) == classInfo.type)
+    return (country == null || parseCountryId(country) == classInfo.country?.id) &&
+      (region == null || parseRegionId(region) == classInfo.region?.id) &&
+      (documentType == null || parseDocumentTypeId(documentType) == classInfo.documentType?.id)
   }
 
-  private fun parseCountry(value: String): Country? =
-    Country.entries.find { it.name.equals(value, ignoreCase = true) }
+  private fun parseCountryId(value: String): CountryId? =
+    BlinkIdClassInfoIdMappings.parseCountryId(value)
 
-  private fun parseRegion(value: String): Region? =
-    Region.entries.find { it.name.equals(value, ignoreCase = true) }
+  private fun parseRegionId(value: String): RegionId? =
+    BlinkIdClassInfoIdMappings.parseRegionId(value)
 
-  private fun parseDocumentType(value: String): Type? =
-    Type.entries.find { it.name.equals(value, ignoreCase = true) }
+  private fun parseDocumentTypeId(value: String): DocumentTypeId? =
+    BlinkIdClassInfoIdMappings.parseDocumentTypeId(value)
 }
 
 @Parcelize

package/android/src/main/java/com/microblink/blinkid/reactnative/BlinkIdSerializationUtilities.kt

@@ -83,6 +83,9 @@ object BlinkIdSerializationUtilities {
         scanningResult?.race?.let {
             scanningResultJson.put("race", serializeStringResult(it))
         }
+        scanningResult?.ethnicity?.let {
+            scanningResultJson.put("ethnicity", serializeStringResult(it))
+        }
         scanningResult?.religion?.let {
             scanningResultJson.put("religion", serializeStringResult(it))
         }
@@ -296,19 +299,23 @@ object BlinkIdSerializationUtilities {
 
     private fun serializeDocumentClassInfo(documentClassInfo: DocumentClassInfo): JSONObject {
         val documentClassInfoJson = JSONObject()
-        // TODO: Align country/region/documentType strings with iOS (rawValue). Android uses
-        // enum.name with only the first character lowercased; values usually match but are not
-        // guaranteed identical for every enum. Prefer shared explicit string mappers on both platforms.
-        documentClassInfo.country?.name?.let {
-            documentClassInfoJson.put("country", it.replaceFirstChar { char -> char.lowercase() })
-        }
-        documentClassInfo.region?.name?.let {
-            documentClassInfoJson.put("region", it.replaceFirstChar { char -> char.lowercase() })
-        }
-        documentClassInfo.type?.name?.let {
-            documentClassInfoJson.put(
-                "documentType",
-                it.replaceFirstChar { char -> char.lowercase() })
+        documentClassInfo.country?.let { country ->
+            documentClassInfoJson.put("country", serializeClassInfoComponent(
+                id = country.id?.let { BlinkIdClassInfoIdMappings.serializeCountryId(it) },
+                rawValue = country.rawValue
+            ))
+        }
+        documentClassInfo.region?.let { region ->
+            documentClassInfoJson.put("region", serializeClassInfoComponent(
+                id = region.id?.let { BlinkIdClassInfoIdMappings.serializeRegionId(it) },
+                rawValue = region.rawValue
+            ))
+        }
+        documentClassInfo.documentType?.let { documentType ->
+            documentClassInfoJson.put("documentType", serializeClassInfoComponent(
+                id = documentType.id?.let { BlinkIdClassInfoIdMappings.serializeDocumentTypeId(it) },
+                rawValue = documentType.rawValue
+            ))
         }
         documentClassInfo.countryName?.let {
             documentClassInfoJson.put("countryName", it)
@@ -322,10 +329,26 @@ object BlinkIdSerializationUtilities {
         documentClassInfo.isoNumericCountryCode?.let {
             documentClassInfoJson.put("isoNumericCountryCode", it)
         }
-        documentClassInfoJson.put("empty", documentClassInfo.isEmpty())
+        documentClassInfoJson.put("empty", isDocumentClassInfoEmpty(documentClassInfo))
         return documentClassInfoJson
     }
 
+    private fun isDocumentClassInfoEmpty(documentClassInfo: DocumentClassInfo): Boolean {
+        val classIds = listOf(
+            documentClassInfo.country?.id?.name,
+            documentClassInfo.region?.id?.name,
+            documentClassInfo.documentType?.id?.name
+        )
+        return classIds.any { it == null } || classIds.all { it == "None" }
+    }
+
+    private fun serializeClassInfoComponent(id: String?, rawValue: String): JSONObject {
+        val json = JSONObject()
+        id?.let { json.put("id", it) }
+        json.put("rawValue", rawValue)
+        return json
+    }
+
     private fun serializeDataMatchResult(dataMatchResult: DataMatchResult): JSONObject {
         val dataMatchResultJson = JSONObject()
 
@@ -731,6 +754,9 @@ object BlinkIdSerializationUtilities {
         vizResult?.race?.let {
             vizResultJson.put("race", serializeStringResult(it))
         }
+        vizResult?.ethnicity?.let {
+            vizResultJson.put("ethnicity", serializeStringResult(it))
+        }
         vizResult?.religion?.let {
             vizResultJson.put("religion", serializeStringResult(it))
         }
@@ -858,6 +884,10 @@ object BlinkIdSerializationUtilities {
             parentInfoJson.put("lastName", serializeStringResult(it))
         }
 
+        parentInfo.fullName?.let {
+            parentInfoJson.put("fullName", serializeStringResult(it))
+        }
+
         return parentInfoJson
     }
 

package/android/src/main/java/com/microblink/blinkid/reactnative/BlinkidReactNativeModule.kt

@@ -234,6 +234,21 @@ class BlinkidReactNativeModule(reactContext: ReactApplicationContext) :
     }
   }
 
+  override fun refreshLicenseLease(promise: Promise?) {
+    CoroutineScope(Dispatchers.Main).launch {
+      try {
+        val sdk = BlinkIdSdk.sdkInstance
+          ?: throw IllegalStateException(
+            "The BlinkID SDK is not initialized. Call loadBlinkIdSdk() first, or perform a scan."
+          )
+        sdk.refreshLicenseLease()
+        promise?.resolve(null)
+      } catch (error: Exception) {
+        promise?.reject(BLINKID_ERROR_RESULT_CODE, error.message)
+      }
+    }
+  }
+
   private suspend fun ensureLoadedSdk(blinkidSdkSettings: JSONObject?): BlinkIdSdk? {
 
     blinkIdSdk?.let { return it }

package/ios/BlinkidReactNative.mm

@@ -58,6 +58,13 @@ RCT_EXPORT_METHOD(performDirectApiScan:(nonnull NSString *)blinkIdSdkSettings bl
     }];
 }
 
+RCT_EXPORT_METHOD(refreshLicenseLease:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject) {
+    [self->moduleImplementation refreshLicenseLeaseOnResolve:^(NSString * _Nonnull) {
+        resolve(@"");
+    } onReject:^(NSString * _Nonnull error) {
+        reject(@"BlinkIdIosError", error, nil);
+    }];
+}
 
 RCT_EXPORT_METHOD(performScan:(NSString *)blinkIdSdkSettings blinkIdSessionSettings:(NSString *)blinkIdSessionSettings blinkIdScanningUxSettings:(NSString *)blinkIdScanningUxSettings classFilter:(NSString *)classFilter redactionSettingsResolver:(NSString *)redactionSettingsResolver resolve:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject) {
     dispatch_async(dispatch_get_main_queue(), ^{

package/ios/BlinkidReactNativeModule.swift

@@ -155,6 +155,28 @@ import BlinkIDUX
             }
         }
     }
+
+    @objc public func refreshLicenseLease(onResolve: @escaping (String) -> Void, onReject: @escaping (String) -> Void) {
+        Task {
+            do {
+                guard blinkIdSdk != nil else {
+                    throw BlinkIdReactNativeError.initError(
+                        "The BlinkID SDK is not initialized. Call the loadBlinkIdSdk() method to pre-load the SDK first, or perform a scan."
+                    )
+                }
+                try await BlinkIDSdk.refreshLicenseLease()
+                onResolve("")
+            } catch let blinkIdError as BlinkIdReactNativeError {
+                onReject(BlinkIdReactNativeError.message(for: blinkIdError))
+            } catch {
+                if let sdkError = error as? InvalidLicenseKeyError {
+                    onReject(sdkError.message)
+                } else {
+                    onReject(BlinkIdReactNativeError.message(for: error))
+                }
+            }
+        }
+    }
     
     private func presentScanningUI(_ model: BlinkIDUXModel, _ rootVc: UIViewController) {
         DispatchQueue.main.async {

package/ios/Frameworks/BlinkID.xcframework/Info.plist

@@ -5,35 +5,31 @@
 	<key>AvailableLibraries</key>
 	<array>
 		<dict>
-			<key>BinaryPath</key>
-			<string>BlinkID.framework/BlinkID</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
+			<string>ios-arm64</string>
 			<key>LibraryPath</key>
 			<string>BlinkID.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
-				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
 		</dict>
 		<dict>
-			<key>BinaryPath</key>
-			<string>BlinkID.framework/BlinkID</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
+			<string>ios-arm64_x86_64-simulator</string>
 			<key>LibraryPath</key>
 			<string>BlinkID.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
+				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
 		</dict>
 	</array>
 	<key>CFBundlePackageType</key>