Update

CHANGELOG.md

@@ -1,105 +1,119 @@
-## [2.4.0] - 22 Jul 2021
+## Newest Release
+
+### 3.0.0 - 28 Sep 2021
+
+- Adds the ability to open TIFF images as Image Documents. (#28630)
+- Adds a `setLicenseKeys` method which accepts both Android and iOS license keys. (#30943)
+- Adds support for iOS 15. (#31008)
+- PSPDFKit now requires Flutter 2.5.1 or later. (#30960)
+- PSPDFKit now requires Xcode 13 or later. (#31008)
+- Migrates Flutter APIs to Android embedding v2. (#30680)
+- Removes `path_provider` as a dependency. (#30680)
+
+## Previous Releases
+
+### 2.4.0 - 22 Jul 2021
 
 - Updates to PSPDFKit for Android 7.0. (#30286)
 - Bump minimum SDK version `androidMinSdkVersion` to API 21. (#30286)
 
-## [2.3.3] - 19 Jul 2021
+### 2.3.3 - 19 Jul 2021
 
 - Improves readme file removing `compileOptions` section as not required anymore. (#30258)
 
-## [2.3.2] - 07 Jul 2021
+### 2.3.2 - 07 Jul 2021
 
 - Updates the deployment target of iOS to 13 for PSPDFKit 10.5 for iOS. (#30057)
 
-## [2.3.1] - 03 Jun 2021
+### 2.3.1 - 03 Jun 2021
 
 - Updates readme example to enable running with sound null safety. (#29631)
 - Adds the implementation for the `save` method on iOS. (#29644)
 
-## [2.3.0] - 01 Jun 2021
+### 2.3.0 - 01 Jun 2021
 
 - Removes the need of a trial key for running PSPDFKit Flutter in demo mode. (#28297)
 - Updates to PSPDFKit for Android 6.6.2 (#29523)
 
-## [2.2.2] - 06 May 2021
+### 2.2.2 - 06 May 2021
 
 - Adds a title image for the plugin frontpage. (#29330)
 
-## [2.2.1] - 03 May 2021
+### 2.2.1 - 03 May 2021
 
 - Reverts some unneeded file changes. (#29286)
 
-## [2.2.0] - 03 May 2021
+### 2.2.0 - 03 May 2021
 
 - Updates the minimum required Dart version to 2.12.0. (#29277)
 - Migrates the plugin and the examples to support Sound Null Safety. (#29277)
 
-## [2.1.0] - 20 Apr 2021
+### 2.1.0 - 20 Apr 2021
 
 - Adds a string for the reader view button in iOS so that it can be used in PSPDFViewController's toolbar. (#28465)
 - Fixes dart code formatting. (#28303)
 - Updates the `README` for easier getting started instructions and simpler example code. (#28303)
 - Updates to PSPDFKit for Android 6.6.0. (#28926)
 - Updates example app dependencies to latest: `path_provider` and `cupertino_icons`. (#28926)
 
-## [2.0.1] - 24 Feb 2021
+### 2.0.1 - 24 Feb 2021
 
 - Updates package description for pub.dev. (#28225)
 - Adds pedantic static analysis check and addresses the analysis warnings. (#28225)
 
-## [2.0.0] - 17 Feb 2021
+### 2.0.0 - 17 Feb 2021
 
 - First pub.dev published version. (#28157)
 - Updates the minimum required Flutter SDK version to 1.12.0. (#28157)
 
-## [1.10.6] - 9 Feb 2021
+### 1.10.6 - 9 Feb 2021
 
 - Adds “Migrating from Version 1.10.3” section in the main README. (pspdfkit-flutter:#83)
 - Fixes import in getting started code snippets for iOS and Android. (pspdfkit-flutter:#83)
 - Updates the requirements in the iOS README. (pspdfkit-flutter:#83)
 
-## [1.10.5] - 2 Feb 2021
+### 1.10.5 - 2 Feb 2021
 
 - Fixes the license key in the example project. (pspdfkit-flutter:#82)
 
-## [1.10.4] - 2 Feb 2021
+### 1.10.4 - 2 Feb 2021
 
 - Updates Gradle version and enable AndroidX for Android plugin and example. (pspdfkit-flutter:#80)
 - Updates for PSPDFKit 10.2 for iOS and Xcode 12.4. (pspdfkit-flutter:#81)
 - Changes open source license to modified BSD instead of Apache. (pspdfkit-flutter:#79)
 - Fixes versioning system to not require a manual update in two places. (pspdfkit-flutter:#80)
 
-## [1.10.3] - 11 Jan 2021
+### 1.10.3 - 11 Jan 2021
 
 - Updates copyright year to 2021. (pspdfkit-flutter:#75)
 
-## [1.10.2] - 20 Nov 2020
+### 1.10.2 - 20 Nov 2020
 
 - Updates for PSPDFKit for iOS 10.1 and Xcode 12.2. (pspdfkit-flutter:#74)
 
-## [1.10.1] - 28 Oct 2020
+### 1.10.1 - 28 Oct 2020
 
 - Updates to PSPDFKit for Android 6.5.3. (pspdfkit-flutter:#71)
 
-## [1.10.0] - 9 Oct 2020
+### 1.10.0 - 9 Oct 2020
 
 - Updates to PSPDFKit for Android 6.5. (pspdfkit-flutter:#66)
 
-## [1.9.0] - 3 Mar 2020
+### 1.9.0 - 3 Mar 2020
 
 - Updates to PSPDFKit for Android 6.2. (pspdfkit-flutter:#62)
 
-## [1.8.0] - 21 Jan 2020
+### 1.8.0 - 21 Jan 2020
 
 - Updates to PSPDFKit for Android 6.1.1. (pspdfkit-flutter:#54)
 - Adds Instant JSON document support. (pspdfkit-flutter:#48)
 - Fixes example project. (pspdfkit-flutter:#50, #53)
 
-## [1.7.1] - 26 Nov 2019
+### 1.7.1 - 26 Nov 2019
 
 - Exposes the `pageLayoutMode` and `isFirstPageAlwaysSingle` configuration options. (pspdfkit-flutter:#46)
 
-## [1.7.0] - 8 Oct 2019
+### 1.7.0 - 8 Oct 2019
 
 - Updates to PSPDFKit for Android 6.0. (pspdfkit-flutter:#36)
 - Updates to PSPDFKit for iOS 9. (pspdfkit-flutter:#42)

LICENSE

@@ -1,43 +1,5 @@
-This wrapper is licensed with a modified BSD license.
+All items and source code Copyright © 2010-2021 PSPDFKit GmbH.
 
-In plain language: you're allowed to do whatever you wish with
-the code, modify, redistribute, embed in your products (free or
-commercial), but you must include copyright, terms of usage and
-disclaimer as stated in the license.
+PSPDFKit is a commercial product and requires a license to be used.
 
-You will require a commercial PSPDFKit License to run these examples
-in non-demo mode. Please refer to [email protected] for details.
-
-Copyright (c) 2010-2021, PSPDFKit GmbH.
-All rights reserved.
-
-Redistribution and use in source or binary forms,
-with or without modification, are permitted provided
-that the following conditions are met:
-
-- Redistributions of source code must retain the above copyright
-  notice, this list of conditions and the following disclaimer.
-
-- Redistributions in binary form must reproduce the above copyright
-  notice, this list of conditions and the following disclaimer in the
-  documentation and/or other materials provided with the
-  distribution.
-
-- Redistributions of PSPDFKit Samples must include attribution to
-  PSPDFKit, either in documentation or other appropriate media.
-
-- Neither the name of the PSPDFKit, PSPDFKit GmbH, nor its developers
-  may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+See License-Evaluation.pdf if you are evaluating the demo.

README.md

@@ -2,7 +2,7 @@
 
 ![Flutter Intro](screenshots/flutter-intro.png)
 
-PSPDFKit wrapper for Flutter. Available at [pub.dev](https://pub.dev/packages/pspdfkit_flutter) and [GitHub](https://github.com/PSPDFKit/pspdfkit-flutter).
+PSPDFKit for Flutter is available at [pub.dev](https://pub.dev/packages/pspdfkit_flutter) and [GitHub](https://github.com/PSPDFKit/pspdfkit-flutter).
 
 If you are new to Flutter, make sure to check our Flutter blog posts:
 
@@ -11,7 +11,7 @@ If you are new to Flutter, make sure to check our Flutter blog posts:
 - [Opening a PDF in Flutter](https://pspdfkit.com/blog/2019/opening-a-pdf-in-flutter/).
 - [How to Bridge Native iOS Code to Flutter](https://pspdfkit.com/blog/2021/how-to-bridge-native-ios-code-to-flutter/).
 - [How to Customize Our Flutter PDF SDK for Android](https://pspdfkit.com/blog/2021/how-to-customize-our-flutter-pdf-sdk/).
-- [Advances in Hybrid Wrappers](https://pspdfkit.com/blog/2019/advances-in-hybrid-wrappers/).
+- [Advances in Hybrid Technologies](https://pspdfkit.com/blog/2019/advances-in-hybrid-technologies/).
 - [How We Maintain Our Public Flutter Project Using a Private Monorepo](https://pspdfkit.com/blog/2021/maintaining-open-source-repo-from-monorepo/).
 
 For our quick-start guides, [check out our website](https://pspdfkit.com/getting-started/mobile/?frontend=flutter).
@@ -70,14 +70,13 @@ Platform specific README exists for [Android](android/) and [iOS](ios/).
     open pubspec.yaml
     ```
 
-6. Add the PSPDFKit and `path_provider` dependencies in `pubspec.yaml`:
+6. Add the PSPDFKit dependency in `pubspec.yaml`:
 
     ```diff
      dependencies:
        flutter:
          sdk: flutter
-    +  pspdfkit_flutter:
-    +  path_provider: ^2.0.2
+    +  pspdfkit_flutter: any
     ```
 
 7. From the terminal app, run the following command to get all the packages:
@@ -161,14 +160,13 @@ Platform specific README exists for [Android](android/) and [iOS](ios/).
 
     ![iOS View controller-based status bar appearance](screenshots/ios-info-plist-statusbarappearance.png)
 
-6. Add the PSPDFKit and `path_provider` dependencies in `pubspec.yaml`:
+6. Add the PSPDFKit dependency in `pubspec.yaml`:
 
     ```diff
      dependencies:
        flutter:
          sdk: flutter
     +  pspdfkit_flutter:
-    +  path_provider: ^2.0.2
     ```
 
 7. From the terminal app, run the following command to get all the packages:
@@ -254,15 +252,21 @@ initialize in demo mode, placing a watermark on each PDF and limiting usage to 6
 
 To purchase a license for production use, please reach out to us via https://pspdfkit.com/sales/form/.
 
-To initialize PSPDFKit using a license key, call `Pspdfkit.setLicenseKey("...")` before using any other PSPDFKit APIs or features.
+To initialize PSPDFKit using a license key, call either of the following before using any other PSPDFKit APIs or features:
 
-# Contributing
+To set the license key for both Android and iOS, use:
+```
+await Pspdfkit.setLicenseKeys("YOUR_FLUTTER_ANDROID_LICENSE_KEY_GOES_HERE", "YOUR_FLUTTER_IOS_LICENSE_KEY_GOES_HERE");
+```
 
-Please ensure [you signed our CLA](https://pspdfkit.com/guides/web/current/miscellaneous/contributing/) so we can accept your contributions.
+To set the license key for the currently running platform, use:
+```
+await Pspdfkit.setLicenseKey("YOUR_FLUTTER_LICENSE_KEY_GOES_HERE");
+```
 
 # Migrating from Version 1.10.3
 
-Q: I updated the Flutter plugin and I am getting the following error:
+Q: I updated the Flutter library and I am getting the following error:
 
 ```bash
 lib/main.dart:8:8: Error: Error when reading '../../.pub-cache/git/pspdfkit-flutter-b6241555b1ee3e816a0dce65145991c1a4477d94/lib/pspdfkit.dart': No such file or directory

analysis_options.yaml

@@ -5,7 +5,7 @@
 #   UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES.
 #   This notice may not be removed from this file.
 
-include: package:pedantic/analysis_options.yaml
+include: package:flutter_lints/flutter.yaml
 
 analyzer:
   errors:
@@ -16,3 +16,14 @@ analyzer:
   strong-mode:
     implicit-casts: false
     implicit-dynamic: false
+
+linter:
+  rules:
+    - always_declare_return_types
+    - prefer_single_quotes
+    - sort_child_properties_last
+    - unawaited_futures
+    - unsafe_html
+    - use_full_hex_values_for_flutter_colors
+
+

android/README.md

@@ -6,9 +6,12 @@
 
 In order to build the PSPDFKit Flutter wrapper and example project, you need to prepare a couple of dependencies:
 
-* Flutter SDK
-* Android Studio
-* `local.properties` file
+- The [latest stable version of Android Studio][https://developer.android.com/studio].
+- The [Android NDK][https://developer.android.com/studio/projects/install-ndk].
+- An [Android Virtual Device][https://developer.android.com/studio/run/managing-avds.html] or a hardware device.
+- The [latest stable version of PSPDFKit for Android][https://pspdfkit.com/guides/android/downloads/].
+- The [latest stable version of Flutter][https://flutter.dev/docs/get-started/install].
+- `local.properties` file
 
 #### `local.properties`
 

android/build.gradle

@@ -11,7 +11,7 @@ buildscript {
 
     repositories {
         google()
-        jcenter()
+        mavenCentral()
     }
 
     dependencies {
@@ -28,7 +28,7 @@ rootProject.allprojects {
             url pspdfkitMavenUrl
         }
         google()
-        jcenter()
+        mavenCentral()
     }
 }
 

android/config.gradle

@@ -9,7 +9,7 @@
 
 buildscript {
     repositories {
-        jcenter()
+        mavenCentral()
     }
     dependencies {
         classpath "org.yaml:snakeyaml:1.27"
@@ -53,7 +53,7 @@ def pubspecYaml = new Yaml().load(pubspecFile.newInputStream())
 ext.pspdfkitFlutterVersion = pubspecYaml.version
 
 ext.androidCompileSdkVersion = 29
-ext.androidBuildToolsVersion = '29.0.1'
+ext.androidBuildToolsVersion = '29.0.3'
 ext.androidMinSdkVersion = 21
 ext.androidTargetSdkVersion = 29
 ext.androidGradlePluginVersion = '4.1.1'