Release version 1.11.1

.jazzy.yaml

@@ -5,7 +5,7 @@ xcodebuild_arguments:
 - "-scheme"
 - GiniCaptureSDK
 - "-destination"
-- platform=iOS Simulator,OS=15.0,name=iPhone 13
+- platform=iOS Simulator,OS=16.2,name=iPhone 13
 author: Gini GmbH
 author_url: https://gini.net
 module: GiniCaptureSDK
@@ -19,9 +19,8 @@ abstract: CaptureSDK/GiniCaptureSDK/Documentation/Sections/*.md
 custom_categories:
 - name: Documentation
   children:
-  - Getting started
+  - Installation
   - Integration
-  - Features
   - Integration in a Xamarin Project
   - License
 
@@ -34,22 +33,29 @@ custom_categories:
   - Event tracking guide
   - Error logging guide
   - Migration guide
-  - Migration to version 3.x.x
 
 - name: Classes
   children:
+  - AnalysisViewController
   - AnalysisResult
+  - CameraViewController
   - CustomDocumentValidationError
   - CustomDocumentValidationResult
+  - DocumentPickerCoordinator
   - GiniConfiguration
   - GiniImageDocument
   - GiniPDFDocument
   - GiniQRCodeDocument
   - GiniCapture
   - GiniCaptureDocumentBuilder
   - GiniCaptureDocumentValidator
+  - HelpMenuViewController
+  - ImageAnalysisNoResultsViewController
+  - MultipageReviewViewController
   - OnboardingPage
-
+  - OnboardingViewController
+  - ReviewViewController
+
 - name: Enums
   children:
   - AnalysisError
@@ -62,6 +68,7 @@ custom_categories:
   - GiniCaptureDocumentType
   - ImageAnalysisNoResultsStrings
   - ImageAssetsStrings
+  - NoticeActionType
   - OpaqueViewStyle
   - ReviewError
   - OnboardingScreenEventType
@@ -86,6 +93,7 @@ custom_categories:
   - GiniCaptureError
   - GiniCaptureResultsDelegate
   - HelpMenuViewControllerDelegate
+  - MultipageReviewViewControllerDelegate
   - ReviewViewControllerDelegate
   - UploadDelegate
   - GiniCaptureTrackingDelegate

Documentation/Sections/Documentation.md

@@ -14,8 +14,28 @@ The Gini Capture SDK provides components for capturing, reviewing and analyzing
 
 By integrating this SDK into your application you can allow your users to easily take a picture of a document, review it and getting analysis results from the Gini backend.
 
-We provide pre-defined screens that can be customized in a limited way. The screen and configuration design is based on our long-lasting experience with integration in customer apps.
-
-On *iPhone*, the Gini Capture SDK has been designed for portrait orientation.
-On *iPad* we support portrait and landscape orientations.
-
+The Gini Capture SDK can be integrated in two ways, either by using the *Screen API* or the *Component API*. In the Screen API we provide pre-defined screens that can be customized in a limited way. The screen and configuration design is based on our long-lasting experience with integration in customer apps. In the Component API, we provide independent views so you can design your own application as you wish. We strongly recommend keeping in mind our UI/UX guidelines, however.
+
+On *iPhone*, the Gini Capture SDK has been designed for portrait orientation. In the Screen API, orientation is automatically forced to portrait when being displayed. In case you use the Component API, you should limit the view controllers orientation hosting the Component API's views to portrait orientation. This is specifically true for the camera view.
+
+## Contents
+
+* [Installation](installation.html)
+* [Integration](integration.html)
+* [Integration in a Xamarin Project](integration-in-a-xamarin-project.html)
+* [Changelog](changelog.html)
+* [License](license.html)
+* Guides
+  - [Customization guide](customization-guide.html)
+  - [Import PDFs and Images guide](import-pdfs-and-images-guide.html)
+  - [Open with guide](open-with-guide.html)
+  - [QR Code scanning guide](qr-code-scanning-guide.html)
+  - [Event tracking guide](event-tracking-guide.html)
+  - [Error logging guide](error-logging-guide.html)
+
+## API
+
+* [Classes](Classes.html)
+* [Enums](Enums.html)
+* [Protocols](Protocols.html)
+* [Typealiases](Typealiases.html)

Documentation/Sections/Guides.md

@@ -0,0 +1,6 @@
+  - [Customization guide](customization-guide.html)
+  - [Import PDFs and Images guide](import-pdfs-and-images-guide.html)
+  - [Open with guide](open-with-guide.html)
+  - [QR Code scanning guide](qr-code-scanning-guide.html)
+  - [Event tracking guide](event-tracking-guide.html)
+  - [Error logging guide](error-logging-guide.html)

Documentation/source/Error logging guide.md

@@ -1,11 +1,11 @@
 Error Logging
 =============================
 
-The Gini Capture SDK logs errors to the Gini Bank API when the default networking implementation is used (see the Default Networking (Recommended) section in Integration guide). We log only non-sensitive information like response status codes, headers and error messsages.
+The Gini Capture SDK logs errors to the Gini Bank API when the default networking implementation is used (see the UI with Networking (Recommended) section in Integration guide). We log only non-sensitive information like response status codes, headers and error messsages.
 
-You can disable the default error logging by passing false to `GiniConfiguration.shared.giniErrorLoggerIsOn`.
+You can disable the default error logging by passing false to `GiniConfiguration().giniErrorLoggerIsOn`.
 
-If you would like to get informed of error logging events you need to set `GiniConfiguration.shared.customGiniErrorLoggerDelegate` which confirms to `GiniCaptureErrorLoggerDelegate`:
+If you would like to get informed of error logging events you need to set `GiniConfiguration().customGiniErrorLoggerDelegate` which confirms to `GiniCaptureErrorLoggerDelegate`:
 
 ```swift
 class CustomErrorLogger: GiniCaptureErrorLoggerDelegate {

Documentation/source/Event tracking guide.md

@@ -34,3 +34,17 @@ Event types are partitioned into different domains according to the screens that
 | Analysis Screen | `cancel` || User canceled the process during analysis | ✅ | ❌ |
 | Analysis Screen | `error` | `"message"` | The analysis ended with an error. The error message is supplied under the "message" key. | ✅ | ✅ |
 | Analysis Screen | `retry` || The user decided to retry after an analysis error. | ✅ | ✅ |
+
+## Component API
+
+If you are using the Component API, you may want to implement the remaining events in your coordinator code. In order to report an event, call the `GiniCaptureTrackingDelegate` method relating to the event's domain area and pass the event. 
+
+For instance to report user advancing from the Review Screen, call `onReviewScreenEvent(event:)` passing an `Event<ReviewScreenEventType>` struct. `ReviewScreenEventType` defines the event types available in the Review Screen domain.
+
+The call would look something like this:
+
+```swift
+trackingDelegate?.onReviewScreenEvent(event: Event(type: .next))
+```
+
+

Documentation/source/Import PDFs and images guide.md

@@ -5,7 +5,7 @@ Import PDFs and images
 If you want to add the _File import_ feature on your app, first you need to specify the supported types (`fileImportSupportedTypes `) on the `GiniConfiguration` instance.
 
 ```swift
-let giniConfiguration = GiniConfiguration.shared
+let giniConfiguration = GiniConfiguration()
 giniConfiguration.fileImportSupportedTypes = .pdf_and_images
 ```
 
@@ -26,16 +26,23 @@ giniConfiguration.customDocumentValidations = { document in
 	}
 }
 ```
+#### Only Component API
+
+Additionaly - when using the Component API - you have to use the `DocumentPickerCoordinator` to present both the Photo Gallery and the File Explorer and to handle all the interaction with them.
+To enable _Drag&Drop_, just call the `DocumentPickerCoordinator.setupDragAndDrop(in:)` method, passing the view that will handle the drop interaction (we recommend to pass the `CameraViewController.view`).
+
+Also, with the addition of a custom image picker to support multiple selection, you can start caching the album images by calling the `DocumentPickerCoordinator.startCaching()` method when creating the coordinator, but only if the gallery access permission is granted before (`DocumentPickerCoordinator.isGalleryPermissionGranted`).
+
 
 Import images from camera roll
--------------------------------
+----------------------
 
 To enable your app to import images from **Photo Gallery** and also support **iOS 10** you need to specify the `NSPhotoLibraryUsageDescription ` key in your `Info.plist` file. This key is mandatory for all apps since iOS 10 when accessing the **Photo Gallery**.
 
 Import images and PDFs from other apps
---------------------------------------
+------------------------------------
 
-In order to enable your app to import PDFs and images from other apps like *Files*, *Dropbox* or *Drive*, you need to enable _iCloud document support_ in your app.
+In order to enable your app to import PDFs and images from other apps like *Dropbox*, *iCloud* or *Drive*, you need to enable _iCloud document support_ in your app.
 
 <center><img src="img/icloud_capabilities.png" border="1"/></center>