Release 3.5.0

Author: PSPDFKit

CHANGELOG.md

@@ -1,12 +1,17 @@
 ## Newest Release
 
+### 3.5.0 - 17 Jan 2023
+- Adds Instant Synchronization support. (#37675) 
+- Updates for PSPDFKit 8.5 for Android. (#38136)
+- Updates for PSPDFKit 12.0.2 for iOS. (#38136)
+
+## Previous Releases
+
 ### 3.4.1 - 18 Nov 2022
 
 - Updates for PSPDFKit 12.0 for iOS. (#37508)
 - Fixes missing header file issue. (#37283) 
 
-## Previous Releases
-
 ### 3.4.0 - 26 Oct 2022
 
 - Adds generating PDF from images, templates and HTML. (#36736)

android/build.gradle

@@ -58,4 +58,5 @@ dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlinVersion"
     implementation "androidx.fragment:fragment-ktx:1.3.6"
     implementation 'androidx.legacy:legacy-support-v4:1.0.0'
+    implementation 'com.squareup.okhttp3:okhttp:4.2.1'
 }

android/config.gradle

@@ -38,7 +38,7 @@ if (pspdfkitMavenUrl == null || pspdfkitMavenUrl == '') {
 
 ext.pspdfkitVersion = localProperties.getProperty('pspdfkit.version')
 if (pspdfkitVersion == null || pspdfkitVersion == '') {
-    ext.pspdfkitVersion = '8.4.1'
+    ext.pspdfkitVersion = '8.5.0'
 }
 
 ext.pspdfkitMavenModuleName = 'pspdfkit'
@@ -52,8 +52,8 @@ if (!pubspecFile.exists()) {
 def pubspecYaml = new Yaml().load(pubspecFile.newInputStream())
 ext.pspdfkitFlutterVersion = pubspecYaml.version
 
-ext.androidCompileSdkVersion = 31
+ext.androidCompileSdkVersion = 33
 ext.androidMinSdkVersion = 21
 ext.androidTargetSdkVersion = 30
 ext.androidGradlePluginVersion = '7.1.1'
-ext.kotlinVersion = "1.5.31"
+ext.kotlinVersion = "1.7.10"

android/src/main/java/com/pspdfkit/flutter/pspdfkit/ConfigurationAdapter.java

@@ -8,13 +8,17 @@
  */
 package com.pspdfkit.flutter.pspdfkit;
 
+import static com.pspdfkit.flutter.pspdfkit.util.Preconditions.requireNotNullNotEmpty;
+import static io.flutter.util.Preconditions.checkNotNull;
+
 import android.content.Context;
 import android.util.Log;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.StyleRes;
 
+import com.pspdfkit.configuration.PdfConfiguration;
 import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
 import com.pspdfkit.configuration.activity.ThumbnailBarMode;
 import com.pspdfkit.configuration.activity.UserInterfaceViewMode;
@@ -25,13 +29,12 @@
 import com.pspdfkit.configuration.settings.SettingsMenuItemType;
 import com.pspdfkit.configuration.sharing.ShareFeatures;
 import com.pspdfkit.configuration.theming.ThemeMode;
+import com.pspdfkit.ui.special_mode.controller.AnnotationTool;
 
 import java.util.ArrayList;
 import java.util.EnumSet;
 import java.util.HashMap;
-
-import static com.pspdfkit.flutter.pspdfkit.util.Preconditions.requireNotNullNotEmpty;
-import static io.flutter.util.Preconditions.checkNotNull;
+import java.util.List;
 
 class ConfigurationAdapter {
     private static final String LOG_TAG = "ConfigurationAdapter";
@@ -117,12 +120,12 @@ class ConfigurationAdapter {
      */
     @Deprecated
     private static final String SHOW_DOCUMENT_LABEL = "showDocumentLabel";
-    /** 
+    /**
      * @deprecated This key word was deprecated with PSPDFKit for Fluttter 3.1.
      * Use {@code FIRST_PAGE_ALWAYS_SINGLE} instead, which replaces it.
      */
     private static final String IS_FIRST_PAGE_ALWAYS_SINGLE = "isFirstPageAlwaysSingle";
-    /** 
+    /**
      * @deprecated This key word was deprecated with PSPDFKit for Fluttter 3.1.
      * Use {@code SHOW_BOOKMARKS_ACTION} instead, which replaces it.
      */
@@ -134,7 +137,7 @@ class ConfigurationAdapter {
     private static final String PAGE_TRANSITION_SCROLL_PER_SPREAD = "scrollPerSpread";
     private static final String PAGE_TRANSITION_SCROLL_CONTINUOUS = "scrollContinuous";
     private static final String PAGE_TRANSITION_CURL = "curl";
-    
+
     // Document Presentation Values
     private static final String PAGE_MODE_AUTOMATIC = "automatic";
     private static final String PAGE_MODE_SINGLE = "single";
@@ -175,8 +178,14 @@ class ConfigurationAdapter {
     private static final String SHOW_THUMBNAIL_BAR_SCRUBBER_BAR = "scrubberBar";
     private static final String SHOW_THUMBNAIL_BAR_SCROLLABLE = "scrollable";
 
-    @NonNull private final PdfActivityConfiguration.Builder configuration;
-    @Nullable private String password = null;
+    // Instant Options
+    private static final String ENABLE_INSTANT_COMMENTS = "enableInstantComments";
+
+    @NonNull
+    private final PdfActivityConfiguration.Builder configuration;
+    @Nullable
+    private String password = null;
+    private boolean enableInstantComments = false;
 
     ConfigurationAdapter(@NonNull Context context,
                          @Nullable HashMap<String, Object> configurationMap) {
@@ -349,6 +358,11 @@ class ConfigurationAdapter {
             if (key != null) {
                 configureAutosaveEnabled(!(Boolean) configurationMap.get(key));
             }
+
+            key = getKeyOfType(configurationMap, ENABLE_INSTANT_COMMENTS, Boolean.class);
+            if (key != null) {
+                enableInstantComments = (boolean) configurationMap.get(key);
+            }
         }
     }
 
@@ -661,27 +675,27 @@ private <T> void configureSettingsMenuItems(@NonNull ArrayList<T> settingsMenuIt
                 case SETTINGS_MENU_ITEM_THEME:
                 case SETTINGS_MENU_ITEM_ANDROID_THEME:
                     settingsMenuItemTypes.add(SettingsMenuItemType.THEME);
-                break;
+                    break;
                 case SETTINGS_MENU_ITEM_SCREEN_AWAKE:
                 case SETTINGS_MENU_ITEM_ANDROID_SCREEN_AWAKE:
                     settingsMenuItemTypes.add(SettingsMenuItemType.SCREEN_AWAKE);
-                break;
+                    break;
                 case SETTINGS_MENU_ITEM_PAGE_LAYOUT:
                 case SETTINGS_MENU_ITEM_ANDROID_PAGE_LAYOUT:
                     settingsMenuItemTypes.add(SettingsMenuItemType.PAGE_LAYOUT);
-                break;
+                    break;
                 case SETTINGS_MENU_ITEM_PAGE_TRANSITION:
                     settingsMenuItemTypes.add(SettingsMenuItemType.PAGE_TRANSITION);
-                break;
+                    break;
                 case SETTINGS_MENU_ITEM_SCROLL_DIRECTION:
                     settingsMenuItemTypes.add(SettingsMenuItemType.SCROLL_DIRECTION);
-                break;
+                    break;
                 case SETTINGS_MENU_ITEM_IOS_APPEARANCE:
                 case SETTINGS_MENU_ITEM_IOS_BRIGHTNESS:
                 case SETTINGS_MENU_ITEM_IOS_PAGE_MODE:
                 case SETTINGS_MENU_ITEM_IOS_SPREAD_FITTING:
                     // NO-OP. Only supported on iOS.
-                break;
+                    break;
                 default:
                     throw new IllegalArgumentException("Undefined settings menu item " + menuType);
             }
@@ -718,13 +732,13 @@ private static <T> void checkCast(Object object, Class<T> clazz, String key) {
      * When reading configuration options, we check not only for the given configuration string,
      * but also for a string with the `android` prefix. For instance if the user enters
      * `androidPageScrollDirection`, it is considered a valid string equal to `pageScrollDirection`.
-     * 
+     * <p>
      * When documenting, we always prefer configuration option strings:
-     * 
+     * <p>
      * - No prefix          : If the key works for both iOS and Android.
      * - `android` prefix   : If the key works only for Android.
      * - `iOS` prefix       : If the key works only for iOS.
-     */ 
+     */
     private String addAndroidPrefix(String key) {
         // Capitalize the first letter.
         String cap = String.valueOf(key.charAt(0)).toUpperCase() + key.substring(1);
@@ -733,8 +747,8 @@ private String addAndroidPrefix(String key) {
 
     @Nullable
     private <T> String getKeyOfType(@NonNull HashMap<String, Object> configurationMap,
-                                @NonNull String key,
-                                @NonNull Class<T> clazz) {
+                                    @NonNull String key,
+                                    @NonNull Class<T> clazz) {
         if (containsKeyOfType(configurationMap, key, clazz)) {
             return key;
         }
@@ -784,6 +798,19 @@ String getPassword() {
     }
 
     PdfActivityConfiguration build() {
+//      Turn on Instant comments;
+        if (enableInstantComments) {
+            PdfConfiguration pdfConfiguration = this.configuration.build().getConfiguration();
+
+            final List<AnnotationTool> annotationTools = pdfConfiguration
+                    .getEnabledAnnotationTools();
+            // Explicitly enable Instant comment markers if your server supports this feature.
+            annotationTools.add(AnnotationTool.INSTANT_COMMENT_MARKER);
+            annotationTools.add(AnnotationTool.INSTANT_HIGHLIGHT_COMMENT);
+            this.configuration
+                    .enabledAnnotationTools(annotationTools);
+        }
+
         return configuration.build();
     }
 }

android/src/main/java/com/pspdfkit/flutter/pspdfkit/EventDispatcher.java

@@ -12,6 +12,8 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
+import java.util.HashMap;
+
 import io.flutter.plugin.common.MethodChannel;
 
 /**
@@ -46,9 +48,42 @@ public void notifyActivityOnPause() {
         sendEvent("flutterPdfActivityOnPause");
     }
 
-    private void sendEvent(@NonNull final String method) {
+    public void notifyInstantSyncStarted(String documentId) {
+        sendEvent("pspdfkitInstantSyncStarted", documentId);
+    }
+
+    public void notifyInstantSyncFinished(String documentId) {
+        sendEvent("pspdfkitInstantSyncFinished", documentId);
+    }
+
+    public void notifyInstantSyncFailed(String documentId, String error) {
+        sendEvent("pspdfkitInstantSyncFailed",new HashMap<String, String>() {{
+            put("documentId", documentId);
+            put("error", error);
+        }});
+    }
+
+    public void notifyInstantAuthenticationFinished(String documentId,String validJWT) {
+        sendEvent("pspdfkitInstantAuthenticationFinished", new HashMap<String, String>() {{
+            put("documentId", documentId);
+            put("jwt", validJWT);
+        }});
+    }
+
+    public void notifyInstantAuthenticationFailed(String documentId, String error) {
+        sendEvent("pspdfkitInstantAuthenticationFailed", new HashMap<String, String>() {{
+            put("documentId", documentId);
+            put("error", error);
+        }});
+    }
+
+    private void sendEvent(String eventName) {
+        sendEvent(eventName, null);
+    }
+
+    private void sendEvent(@NonNull final String method, @Nullable final Object arguments) {
         if (channel != null) {
-            channel.invokeMethod(method, null, null);
+            channel.invokeMethod(method, arguments, null);
         }
     }
 }

android/src/main/java/com/pspdfkit/flutter/pspdfkit/FlutterInstantPdfActivity.kt

@@ -0,0 +1,114 @@
+package com.pspdfkit.flutter.pspdfkit
+
+///  Copyright © 2021-2022 PSPDFKit GmbH. All rights reserved.
+///
+///  THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW
+///  AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE PSPDFKIT LICENSE AGREEMENT.
+///  UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES.
+///  This notice may not be removed from this file.
+///
+
+import android.os.Bundle
+import com.pspdfkit.document.PdfDocument
+import com.pspdfkit.instant.document.InstantPdfDocument
+import com.pspdfkit.instant.exceptions.InstantException
+import com.pspdfkit.instant.ui.InstantPdfActivity
+import io.flutter.plugin.common.MethodChannel
+import java.util.concurrent.atomic.AtomicReference
+
+/**
+ * For communication with the PSPDFKit plugin, we keep a static reference to the current
+ * activity.
+ */
+class FlutterInstantPdfActivity : InstantPdfActivity() {
+    override fun onCreate(bundle: Bundle?) {
+        super.onCreate(bundle)
+        bindActivity()
+    }
+
+    override fun onPause() {
+        // Notify the Flutter PSPDFKit plugin that the activity is going to enter the onPause state.
+        EventDispatcher.getInstance().notifyActivityOnPause()
+        super.onPause()
+    }
+
+    override fun onDestroy() {
+        super.onDestroy()
+        releaseActivity()
+    }
+    
+    override fun onDocumentLoaded(pdfDocument: PdfDocument) {
+        super.onDocumentLoaded(pdfDocument)
+        val result = loadedDocumentResult.getAndSet(null)
+        result?.success(true)
+    }
+
+    override fun onDocumentLoadFailed(throwable: Throwable) {
+        super.onDocumentLoadFailed(throwable)
+        val result = loadedDocumentResult.getAndSet(null)
+        result?.success(false)
+    }
+    
+    override fun onSyncStarted(instantDocument: InstantPdfDocument) {
+        super.onSyncStarted(instantDocument)
+        EventDispatcher.getInstance()
+            .notifyInstantSyncStarted(instantDocument.instantDocumentDescriptor.documentId)
+    }
+
+    override fun onSyncFinished(instantDocument: InstantPdfDocument) {
+        super.onSyncFinished(instantDocument)
+        EventDispatcher.getInstance()
+            .notifyInstantSyncFinished(instantDocument.instantDocumentDescriptor.documentId)
+    }
+
+    override fun onSyncError(instantDocument: InstantPdfDocument, error: InstantException) {
+        super.onSyncError(instantDocument, error)
+        EventDispatcher.getInstance().notifyInstantSyncFailed(
+            instantDocument.instantDocumentDescriptor.documentId,
+            error.message
+        )
+    }
+
+    override fun onAuthenticationFinished(instantDocument: InstantPdfDocument, validJwt: String) {
+        super.onAuthenticationFinished(instantDocument, validJwt)
+        EventDispatcher.getInstance().notifyInstantAuthenticationFinished(
+            instantDocument.instantDocumentDescriptor.documentId,
+            validJwt
+        )
+    }
+
+    override fun onAuthenticationFailed(
+        instantDocument: InstantPdfDocument,
+        error: InstantException
+    ) {
+        super.onAuthenticationFailed(instantDocument, error)
+        EventDispatcher.getInstance().notifyInstantAuthenticationFailed(
+            instantDocument.instantDocumentDescriptor.documentId,
+            error.message
+        )
+    }
+
+    private fun bindActivity() {
+        currentActivity = this
+    }
+
+    private fun releaseActivity() {
+        val result = loadedDocumentResult.getAndSet(null)
+        result?.success(false)
+        currentActivity = null
+    }
+
+    companion object {
+
+        @JvmStatic
+        var currentActivity: FlutterInstantPdfActivity? = null
+            private set
+        private val loadedDocumentResult = AtomicReference<MethodChannel.Result?>()
+
+
+        @JvmStatic
+        fun setLoadedDocumentResult(result: MethodChannel.Result?) {
+            loadedDocumentResult.set(result)
+        }
+    }
+}