Merge pull request #330 from BlinkID/jenkins/stable-build

Jenkins/stable build

CHANGELOG.md

@@ -1,5 +1,180 @@
 # Release notes
 
+## 5.9.0
+
+### New features
+
+- We’ve added a new feedback message to users, prompting them to keep a document fully visible in cases when they accidentally cover a part of it with their finger or an object:
+	- It appears while scanning the document using `MBBlinkIdOverlayViewController`
+	- It will display an error message "Keep the document fully visible".
+	-  It is displayed only if you’re using `MBBlinkIdRecognizer` or `MBBlinkIdCombinedRecognizer` for scanning.
+- We added `Carthage` support
+	- For now, `Carthage` is supported for fat binaries, `.framework`. We will support `.xcframework` as soon `Carthage` is updated.
+	- Please check out our guide for implementation
+- We added `Swift Package Manager` support
+	- Please check out our guide for implementation.
+
+### Note on ARM Macs
+
+- We are supporting `ARM64 Device` slice through our `.xcframework` format.
+- We are still working on supporting the `ARM64 Simulator` slice for newly released ARM Macs. We will update our SDK with `ARM64 Simulator` support as soon as it’s out.
+
+### iOS Version support change:
+
+-  We are no longer supporting **iOS 8**.
+
+### Cocapods support change:
+
+- We are updating our Cocoapods with `.xcframework` format from now on. Please download [Cocoapods 1.10.0](https://github.com/CocoaPods/CocoaPods/releases/tag/1.10.0) or newer to use our SDK.
+
+### Newly supported identity documents
+
+- 53 documents added:
+
+	- ALBANIA - DL (front)
+	- BELGIUM - RESIDENCE PERMIT (front, back)
+	- BOLIVIA - ID (front, back)
+	- BOSNIA AND HERZEGOVINA - PASSPORT
+	- CAMBODIA - PASSPORT
+	- CANADA - RESIDENCE PERMIT (front, back)
+	- CANADA - MANITOBA - ID (front)
+	- CANADA - ONTARIO - HEALTH INSURANCE CARD (front)
+	- CHILE - ALIEN ID (front, back)
+	- CHINA - ID (front, back)
+	- COLOMBIA - MINORS ID (front, back)
+	- CYPRUS - RESIDENCE PERMIT (front, back)
+	- CZECHIA - PASSPORT
+	- GREECE - ID (front)
+	- HAITI - ID (front, back)
+	- ITALY - RESIDENCE PERMIT (front, back)
+	- LATVIA - DL (front)
+	- LATVIA - PASSPORT
+	- LITHUANIA - PASSPORT
+	- LUXEMBOURG - DL (front)
+	- MONTENEGRO - DL (front)
+	- MONTENEGRO - ID (front, back)
+	- MONTENEGRO - PASSPORT
+	- NETHERLANDS - RESIDENCE PERMIT (front, back)
+	- NICARAGUA - ID (front, back)
+	- NIGERIA - ID (front, back)
+	- NORWAY - RESIDENCE PERMIT (front, back)
+	- OMAN - RESIDENT ID (front, back)
+	- PARAGUAY - DL (front, back)
+	- PERU - DL (front, back)
+	- PHILIPPINES - SOCIAL SECURITY CARD (front)
+	- ROMANIA - PASSPORT
+	- RUSSIA - PASSPORT
+	- SERBIA - PASSPORT
+	- SLOVAKIA - PASSPORT
+	- SLOVENIA - PASSPORT
+	- SOUTH KOREA - DL (front)
+	- SPAIN - RESIDENCE PERMIT (front, back)
+	- SWEDEN - RESIDENCE PERMIT (front, back)
+	- THAILAND - PASSPORT
+	- UKRAINE - DL (front)
+	- UKRAINE - PASSPORT
+	- USA - ARKANSAS - ID (front, back)
+	- USA - CONNECTICUT - ID (front, back)
+	- USA - GREEN CARD (front, back)
+	- USA - MARYLAND - ID (front, back)
+	- USA - MINNESOTA - ID (front, back)
+	- USA - NEVADA - ID (front, back)
+	- USA - NEW YORK CITY - ID (front, back)
+	- USA - TEXAS - WEAPON PERMIT (front)
+	- USA - VIRGINIA - ID (front, back)
+	- VENEZUELA - DL (front)
+	- VENEZUELA - PASSPORT
+
+- Beta support added for 46 documents:
+	- ALBANIA - PASSPORT
+	- BAHAMAS - DL (front)
+	- BERMUDA - DL (front)
+	- BOLIVIA - DL (front)
+	- CHILE - DL (front)
+	- COLOMBIA - ALIEN ID (front)
+	- DENMARK - RESIDENCE PERMIT (front, back)
+	- DOMINICAN REPUBLIC - DL (front, back)
+	- ECUADOR - DL (front)
+	- EL SALVADOR - DL (front, back)
+	- ESTONIA - RESIDENCE PERMIT (front, back)
+	- GUATEMALA - DL (front, back)
+	- HAITI - DL (front)
+	- HONDURAS - DL (front, back)
+	- HONDURAS - ID (front, back)
+	- HUNGARY - ADDRESS CARD (front, back)
+	- HUNGARY - RESIDENCE PERMIT (front)
+	- ICELAND - DL (front)
+	- ISRAEL - ID (front, back)
+	- JAPAN - DL (front)
+	- JORDAN - DL (front)
+	- LATVIA - ALIEN PASSPORT
+	- LATVIA - RESIDENCE PERMIT (front, back)
+	- LUXEMBOURG - RESIDENCE PERMIT (front)
+	- MALTA - RESIDENCE PERMIT (front, back)
+	- MEXICO - BAJA CALIFORNIA - DL (front)
+	- MEXICO - CHIHUAHUA - DL (front)
+	- MEXICO - CIUDAD DE MEXICO - DL (front)
+	- MEXICO - PROFESSIONAL DL (front)
+	- MEXICO - GUANAJUATO - DL (front)
+	- MEXICO - MICHOACAN - DL (front)
+	- MEXICO - TAMAULIPAS - DL (front, back)
+	- MEXICO - VERACRUZ - DL (front, back)
+	- PHILIPPINES - TAX ID (front)
+	- PHILIPPINES - VOTER ID (front)
+	- POLAND - RESIDENCE PERMIT (front, back)
+	- PORTUGAL - RESIDENCE PERMIT (front, back)
+	- PUERTO RICO - VOTER ID (front)
+	- SLOVAKIA - RESIDENCE PERMIT (front, back)
+	- SOUTH KOREA - ID (front)
+	- SWITZERLAND - RESIDENCE PERMIT (front, back)
+	- TAIWAN - TEMPORARY RESIDENCE PERMIT (front)
+	- TURKEY - RESIDENCE PERMIT (front)
+	- USA - KANSAS - ID (front, back)
+	- VENEZUELA - ID (front)
+	- VIETNAM - DL (front)
+
+- Added back side support for 7 documents:
+	- ARGENTINA - ID
+	- ECUADOR - ID
+	- FINLAND - ID
+	- NIGERIA - DL
+	- QATAR - RESIDENCE PERMIT
+	- URUGUAY - ID
+	- USA - NEW YORK - DL
+
+- 9 documents are no longer beta:
+	- BRAZIL - DL
+	- CANADA - ALBERTA - ID
+	- MALAYSIA - MyKAS
+	- MEXICO - NUEVO LEON - DL
+	- PANAMA - DL
+	- PORTUGAL - DL
+	- SAUDI ARABIA - ID
+	- SRI LANKA - ID
+	- USA - IDAHO - ID
+
+### New features and updates to the BlinkId(Combined)Recognizer
+
+- We’re now able to read partial MRZ formats (2.5 lines), like the ones found on Switzerland and Liechtenstein DLs.
+- We’ve added `**documentOptionalAdditionalNumber**` to the main part of the result, as well as front and back side VIZ results.
+- We’ve expanded the set of possible recognizer states with `**StageValid**`. This state fixes `MBBlinkIdCombinedRecognizer` timeout issues, and enables better control of the Combined scanning pipeline. It activates when the first side of a document has been successfully scanned and scanning of the second side is required.
+
+### Major API changes:
+
+- We've added an error callback when setting license keys on `MBMicroblinkSDK`
+	- You will be getting error callback containing the reason why you could not unlock the SDK - see `MBLicenseError`
+
+### Minor API changes:
+
+- Swift:
+	- All `unsigned integers` are now `Int`
+
+### Fixes
+
+- We’ve fixed an uncommon bug where you’d get incomplete results upon scanning of the MRZ with the `allowUnparsed` setting enabled.
+- We've fixed some camera session issues
+- We are now handling camera session interruption
+
 ## 5.8.0
 
 ### New features:

Microblink.framework/Headers/MBBlinkIdCombinedRecognizerResult.h

@@ -155,6 +155,11 @@ MB_INIT_UNAVAILABLE
  */
 @property (nonatomic, readonly, nullable) NSString *documentAdditionalNumber;
 
+/**
+ * The one more additional number of the document.
+ */
+@property (nonatomic, readonly, nullable) NSString *documentOptionalAdditionalNumber;
+
 /**
  * The issuing authority of the document.
  */

Microblink.framework/Headers/MBBlinkIdOverlaySettings.h

@@ -123,6 +123,12 @@ MB_CLASS_AVAILABLE_IOS(8.0)
 */
 @property(nonatomic, strong) NSString *retryButtonText;
 
+/**
+* Instructions for the user that is covering some mandatory fields for a scan
+* Default: Keep the document fully visible
+*/
+@property(nonatomic, strong) NSString *errorMandatoryFieldMissing;
+
 /**
  * Designated initializer. Initializes the object with default settings.
  *

Microblink.framework/Headers/MBBlinkIdRecognizerResult.h

@@ -152,6 +152,11 @@ MB_INIT_UNAVAILABLE
  */
 @property (nonatomic, readonly, nullable) NSString *documentAdditionalNumber;
 
+/**
+ * The one more additional number of the document.
+ */
+@property (nonatomic, readonly, nullable) NSString *documentOptionalAdditionalNumber;
+
 /**
  * The issuing authority of the document.
  */

Microblink.framework/Headers/MBCameraSettings.h

@@ -74,7 +74,7 @@ MB_CLASS_AVAILABLE_IOS(8.0)
 /**
  * Camera preset. With this property you can set the resolution of the camera
  *
- * Default: PPCameraPresetOptimal
+ * Default: MBCameraPresetOptimal
  */
 @property (nonatomic, assign) MBCameraPreset cameraPreset;
 
@@ -98,7 +98,7 @@ MB_CLASS_AVAILABLE_IOS(8.0)
 /**
  * Range restriction for camera autofocus.
  *
- * Default: PPCameraAutofocusRestrictionNone
+ * Default: MBCameraAutofocusRestrictionNone
  */
 @property (nonatomic, assign) MBCameraAutofocusRestriction cameraAutofocusRestriction;
 

Microblink.framework/Headers/MBClassInfo.h

@@ -12,7 +12,7 @@
 NS_ASSUME_NONNULL_BEGIN
 
 MB_CLASS_AVAILABLE_IOS(8.0)
-@interface MBClassInfo : NSObject
+@interface MBClassInfo : NSObject <NSSecureCoding>
 
 - (instancetype)init NS_UNAVAILABLE;
 

Microblink.framework/Headers/MBClassInfoTypes.h

@@ -100,7 +100,21 @@ typedef NS_ENUM(NSInteger, MBCountry) {
     MBCountryElSalvador,
     MBCountrySriLanka,
     MBCountryPeru,
-    MBCountryUruguay
+    MBCountryUruguay,
+    MBCountryBahamas,
+    MBCountryBermuda,
+    MBCountryBolivia,
+    MBCountryChina,
+    MBCountryEuropeanUnion,
+    MBCountryHaiti,
+    MBCountryHonduras,
+    MBCountryIceland,
+    MBCountryJapan,
+    MBCountryLuxembourg,
+    MBCountryMontenegro,
+    MBCountryNicaragua,
+    MBCountrySouthKorea,
+    MBCountryVenezuela
 };
 
 typedef NS_ENUM(NSInteger, MBRegion) {
@@ -176,7 +190,16 @@ typedef NS_ENUM(NSInteger, MBRegion) {
     MBRegionCiudadDeMexico,
     MBRegionJalisco,
     MBRegionNewfoundlandAndLabrador,
-    MBRegionNuevoLeon
+    MBRegionNuevoLeon,
+    MBRegionBajaCalifornia,
+    MBRegionChihuahua,
+    MBRegionGuanajuato,
+    MBRegionGuerrero,
+    MBRegionMexico,
+    MBRegionMichoacan,
+    MBRegionNewYorkCity,
+    MBRegionTamaulipas,
+    MBRegionVeracruz
 };
 
 typedef NS_ENUM(NSInteger, MBType) {
@@ -206,7 +229,16 @@ typedef NS_ENUM(NSInteger, MBType) {
     MBTypeSocialSecurityCard,
     MBTypeHealthInsuranceCard,
     MBTypePassport,
-    MBTypeSPass
+    MBTypeSPass,
+    MBTypeAddressCard,
+    MBTypeAlienId,
+    MBTypeAlienPassport,
+    MBTypeGreenCard,
+    MBTypeMinorsId,
+    MBTypePostalId,
+    MBTypeProfessionalDl,
+    MBTypeTaxId,
+    MBTypeWeaponPermit
 };
 
 #endif /* MBClassInfoTypes_h */

Microblink.framework/Headers/MBCombinedRecognizerResult.h

@@ -24,6 +24,13 @@ typedef NS_ENUM(NSInteger, MBDataMatchResult) {
 
 @required
 
+/**
+ * Returns YES if recognizer has finished scanning first side and is now scanning back side,
+ * NO if it's still scanning first side.
+ */
+@property (nonatomic, readonly, assign) BOOL scanningFirstSideDone;
+
+@optional
 /**
  * Returns MBDataMatchResultSuccess if data from scanned parts/sides of the document match,
  * MBDataMatchResultFailed otherwise. For example if date of expiry is scanned from the front and back side
@@ -32,12 +39,6 @@ typedef NS_ENUM(NSInteger, MBDataMatchResult) {
  */
 @property (nonatomic, readonly, assign) MBDataMatchResult documentDataMatch;
 
-/**
- * Returns YES if recognizer has finished scanning first side and is now scanning back side,
- * NO if it's still scanning first side.
- */
-@property (nonatomic, readonly, assign) BOOL scanningFirstSideDone;
-
 @end
 
 #endif /* MBCombinedRecognizerResult_h */

Microblink.framework/Headers/MBCustomOverlayViewController.h

@@ -73,7 +73,7 @@ MB_CLASS_AVAILABLE_IOS(8.0)
 /**
  * Default: UIInterfaceOrientationMaskPortrait
  */
-@property (nonatomic, assign) NSUInteger supportedOrientations;
+@property (nonatomic, assign) UIInterfaceOrientationMask supportedOrientations;
 
 /**
  * Reconfigures current recognizer collection to new recognizer collection. Use this method to reconfigure what you wish to scan.

Microblink.framework/Headers/MBDPIBasedDewarpPolicy.h

@@ -30,14 +30,14 @@ MB_CLASS_AVAILABLE_IOS(8.0) MB_FINAL
 /**
  * @param desiredDPI Desired DPI (dots per inch)
  */
-- (instancetype)initWithDesiredDPI:(NSUInteger)desiredDPI NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithDesiredDPI:(NSInteger)desiredDPI NS_DESIGNATED_INITIALIZER;
 
 /**
  * Returns the desired DPI as defined by this policy.
  *
  * Default: 250
  */
-@property (nonatomic, assign, readonly) NSUInteger desiredDPI;
+@property (nonatomic, assign, readonly) NSInteger desiredDPI;
 
 @end
 

Microblink.framework/Headers/MBDigitalSignatureResult.h

@@ -22,7 +22,7 @@
 /**
  * Version of the digital signature. Available only if enabled with `MBDigitalSignature signResult` property.
  */
-@property (nonatomic, readonly) NSUInteger digitalSignatureVersion;
+@property (nonatomic, readonly) NSInteger digitalSignatureVersion;
 
 @end
 

Microblink.framework/Headers/MBDocumentFaceRecognizer.h

@@ -48,7 +48,7 @@ MB_INIT
  *
  * Default: 6
  */
-@property (nonatomic, assign) NSUInteger numStableDetectionsThreshold;
+@property (nonatomic, assign) NSInteger numStableDetectionsThreshold;
 
 
 @end

Microblink.framework/Headers/MBDotsResultSubview.h

@@ -46,7 +46,7 @@ MB_CLASS_AVAILABLE_IOS(8.0)
  *
  * Default: 50
  */
-@property (assign, nonatomic) NSUInteger dotCount;
+@property (assign, nonatomic) NSInteger dotCount;
 
 @end
 

Microblink.framework/Headers/MBFaceImageDpi.h

@@ -18,7 +18,7 @@
  *
  * Default: 250
  */
-@property (nonatomic, assign) NSUInteger faceImageDpi;
+@property (nonatomic, assign) NSInteger faceImageDpi;
 
 @end