Release 2.18.0

Author: PSPDFKit

CHANGELOG.md

@@ -1,14 +1,25 @@
+## 2.18.0 - 20 May 2025
+
+- Adds the new `AIAssistantConfiguration` class to configure AI Assistant and also add new `aiAssistantButtonItem` option to Toolbar configuration. (J#HYB-743)
+- Adds the new `getPageInfo` API to the `PDFDocument` class. (J#HYB-801)
+- Updates to Nutrient Android SDK 10.2.0.
+- Updates to Nutrient iOS SDK 14.8.0.
+- Fixes an issue where the `setLicenseKeys` API could cause a crash on Android if called too early during the application lifecycle. (J#HYB-790)
+- Fixes an issue where `NotificationCenter` events are not always delivered when running Release build configuration on iOS. (J#HYB-793)
+- Fixes an issue where toolbar button customization was not persisted on Android during component reload. (J#HYB-800)
+- Fixes an issue where the `onAnnotationTapped` callback wasn't called reliably on Android. (J#HYB-805)
+
 ## 2.17.0 - 14 Apr 2025
 
-- Adds new `setPageIndex` API to the `PDFDocument` class. (J#HYB-699)
+- Adds the new `setPageIndex` API to the `PDFDocument` class. (J#HYB-699)
 - Adds the `documentTapped` event to `NotificationCenter` to receive document tap events. (J#HYB-771)
 - Adds support for using multiple `PSPDFKitView` components in the same `View`. (J#HYB-692)
-- Adds TypeScript types for `FormElement` and `FormField` objects and also introduce new APIs to retrieve and update Form annotation data. (J#HYB-612)
-- Adds new `applyTemplate` property to `ToolbarItem` to manage toolbar icon color preservation when being displayed. (J#HYB-741)
+- Adds TypeScript types for `FormElement` and `FormField` objects, and introduces new APIs to retrieve and update form annotation data. (J#HYB-612)
+- Adds the new `applyTemplate` property to `ToolbarItem` to manage toolbar icon color preservation when being displayed. (J#HYB-741)
 - Updates the `addAnnotations` API to accept optional annotation attachments. (J#HYB-782)
 - Updates to Nutrient Android SDK 10.1.1.
 - Updates to Nutrient iOS SDK 14.6.0.
-- Fixes an issue where `selection_tool` was not being added to the `menuItemGrouping` configuration on iOS. (J#HYB-705)
+- Fixes an issue where `selection_tool` wasn't being added to the `menuItemGrouping` configuration on iOS. (J#HYB-705)
 
 ## 2.16.1 - 27 Mar 2025
 

android/build.gradle

@@ -15,7 +15,7 @@
  *   Contains gradle configuration constants
  */
 ext {
-    PSPDFKIT_VERSION = '10.1.1'
+    PSPDFKIT_VERSION = '10.2.0'
 }
 
 buildscript {
@@ -109,8 +109,18 @@ dependencies {
 
     implementation "com.facebook.react:react-native:+"
     implementation 'com.squareup.okhttp3:okhttp:4.9.2'
+    implementation 'com.squareup.okhttp3:logging-interceptor:4.12.0'
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
     implementation "androidx.compose.material:material:1.7.8"
     implementation "androidx.compose.material3:material3:1.3.1"
     implementation "androidx.recyclerview:recyclerview:1.3.2"
+
+    // AI Assistant
+    implementation("io.noties.markwon:core:4.6.2")
+    implementation("io.noties.markwon:html:4.6.2")
+    implementation("io.noties.markwon:linkify:4.6.2")
+    implementation("io.noties.markwon:ext-tables:4.6.2")
+    implementation("io.noties.markwon:ext-strikethrough:4.6.2")
+    implementation("io.socket:socket.io-client:2.1.1")
+    implementation "androidx.lifecycle:lifecycle-viewmodel-compose:2.7.0"
 }

android/src/main/java/com/pspdfkit/react/PDFDocumentModule.kt

@@ -86,6 +86,19 @@ class PDFDocumentModule(reactContext: ReactApplicationContext) : ReactContextBas
         }
     }
 
+    @ReactMethod fun getPageInfo(reference: Int, pageIndex: Int, promise: Promise) {
+        try {
+            val rotation = this.getDocument(reference)?.document?.getPageRotation(pageIndex);
+            val result = Arguments.createMap()
+            if (rotation != null) {
+                result.putInt("savedRotation", rotation)
+            }
+            promise.resolve(result);
+        } catch (e: Throwable) {
+            promise.reject("getPageInfo error", e)
+        }
+    }
+
     @ReactMethod fun getPageCount(reference: Int, promise: Promise) {
         try {
             promise.resolve(this.getDocument(reference)?.document?.pageCount)

android/src/main/java/com/pspdfkit/react/PSPDFKitModule.java

@@ -248,18 +248,19 @@ public void run() {
     public void setLicenseKey(@Nullable String licenseKey, @Nullable Promise promise) {
          try {
              InitializationOptions options = new InitializationOptions(licenseKey, emptyList(), CrossPlatformTechnology.ReactNative, null);
-             Nutrient.initialize(getCurrentActivity(), options);
+             Nutrient.initialize(getReactApplicationContext(), options);
              promise.resolve("Initialised Nutrient");
         } catch (InvalidNutrientLicenseException e) {
             promise.reject(e);
         }
     }
 
-    @ReactMethod
-    public void getDocumentProperties(@Nullable String documentPath, @Nullable Promise promise) {
+    @ReactMethod(isBlockingSynchronousMethod = true)
+    public WritableMap getDocumentProperties(@Nullable String documentPath) {
+        WritableMap properties = Arguments.createMap();
+
         try {
             if (Uri.parse(documentPath).getScheme() == null) {
-                // If there is no scheme it might be a raw path.
                 try {
                     File file = new File(documentPath);
                     documentPath = Uri.fromFile(file).toString();
@@ -269,22 +270,22 @@ public void getDocumentProperties(@Nullable String documentPath, @Nullable Promi
             }
 
             PdfDocument document = PdfDocumentLoader.openDocument(getReactApplicationContext(), Uri.parse(documentPath));
-            WritableMap properties = Arguments.createMap();
+            properties.putString("documentId", document.getDocumentIdString());
             properties.putInt("pageCount", document.getPageCount());
             properties.putBoolean("isEncrypted", document.isEncrypted());
 
-            promise.resolve(properties);
         } catch (IOException e) {
-            // If the document is password protected, return this information to the caller.
             if (e instanceof InvalidPasswordException) {
-                WritableMap properties = Arguments.createMap();
                 properties.putInt("pageCount", 0);
                 properties.putBoolean("isEncrypted", true);
-                promise.resolve(properties);
             } else {
-                promise.reject(e);
+                properties.putString("documentId", null);
+                properties.putInt("pageCount", 0);
+                properties.putBoolean("isEncrypted", false);
             }
         }
+
+        return properties;
     }
 
     @ReactMethod
@@ -293,7 +294,7 @@ public void setLicenseKeys(@Nullable String androidLicenseKey, @Nullable String
         // `iOSLicenseKey` will be used to activate the license on iOS.
         try {
             InitializationOptions options = new InitializationOptions(androidLicenseKey, emptyList(), CrossPlatformTechnology.ReactNative, null);
-            Nutrient.initialize(getCurrentActivity(), options);
+            Nutrient.initialize(getReactApplicationContext(), options);
             promise.resolve("Initialised Nutrient");
         } catch (InvalidNutrientLicenseException e) {
             promise.reject(e);

android/src/main/java/com/pspdfkit/react/ReactPdfViewManager.java

@@ -169,6 +169,9 @@ public void setConfiguration(PdfView view, @NonNull ReadableMap configuration) {
         if (configuration.getArray("measurementValueConfigurations") != null) {
             view.setMeasurementValueConfigurations(configuration.getArray("measurementValueConfigurations"));
         }
+        if (configuration.getMap("aiAssistantConfiguration") != null) {
+            view.setAIAConfiguration(configuration.getMap("aiAssistantConfiguration"));
+        }
     }
 
     @ReactProp(name = "annotationPresets")

android/src/main/java/com/pspdfkit/react/ToolbarMenuItemsAdapter.java

@@ -28,6 +28,7 @@ public class ToolbarMenuItemsAdapter {
     private static final String TOOLBAR_ITEM_BOOKMARKS = "bookmarkButtonItem";
     private static final String TOOLBAR_ITEM_PRINT = "printButtonItem";
     private static final String TOOLBAR_ITEM_ANNOTATION_LIST = "annotationListButtonItem";
+    private static final String TOOLBAR_ITEM_AI_ASSISTANT = "aiAssistantButtonItem";
 
     private final PdfActivityConfiguration.Builder newConfigurations;
 
@@ -48,19 +49,22 @@ public ToolbarMenuItemsAdapter(@NonNull final PdfActivityConfiguration currentCo
             switch (toolbarItem) {
                 case TOOLBAR_ITEM_BOOKMARKS:
                     if (initialConfiguration.isBookmarkListEnabled()) {
-                        configuration.enableBookmarkList();
+                        configuration.bookmarkListEnabled(true);
                     }
                     break;
                 case TOOLBAR_ITEM_PRINT:
                     if (initialConfiguration.isPrintingEnabled()) {
-                        configuration.enablePrinting();
+                        configuration.printingEnabled(true);
                     }
                     break;
                 case TOOLBAR_ITEM_ANNOTATION_LIST:
                     if (initialConfiguration.isAnnotationListEnabled()) {
-                        configuration.enableAnnotationList();
+                        configuration.annotationListEnabled(true);
                     }
                     break;
+                case TOOLBAR_ITEM_AI_ASSISTANT:
+                    configuration.setAiAssistantEnabled(true);
+                    break;
             }
         }
         newConfigurations = configuration;

android/src/main/java/com/pspdfkit/views/PdfView.java

@@ -117,8 +117,12 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.NoSuchElementException;
+import java.util.Objects;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+import io.nutrient.data.models.AiAssistantConfiguration;
+import io.nutrient.domain.ai.AiAssistant;
+import io.nutrient.domain.ai.AiAssistantKt;
 import io.reactivex.rxjava3.android.schedulers.AndroidSchedulers;
 import io.reactivex.rxjava3.core.Completable;
 import io.reactivex.rxjava3.core.Maybe;
@@ -153,6 +157,7 @@ public class PdfView extends FrameLayout {
     private String documentPath;
     private String documentPassword;
     private ReadableMap remoteDocumentConfiguration;
+    private ReadableMap aiaConfiguration;
     private int pageIndex = 0;
     private PdfActivityConfiguration initialConfiguration;
     private ReadableArray pendingToolbarItems;
@@ -316,6 +321,10 @@ public void setRemoteDocumentConfiguration(@Nullable ReadableMap remoteDocumentC
         this.remoteDocumentConfiguration = remoteDocumentConfig;
     }
 
+    public void setAIAConfiguration(@Nullable ReadableMap aiaConfiguration) {
+        this.aiaConfiguration = aiaConfiguration;
+    }
+
     public void setDocument(@Nullable String documentPath, ReactApplicationContext reactApplicationContext) {
         if (documentPath == null) {
             this.document = null;
@@ -585,6 +594,21 @@ private void postFragmentSetup(PdfUiFragment pdfFragment) {
                 pdfFragment.setPageIndex(pageIndex, true);
             }
         }
+        if (aiaConfiguration != null) {
+            try {
+                if (aiaConfiguration.getString("serverURL") != null && aiaConfiguration.getString("jwt") != null && aiaConfiguration.getString("sessionID") != null) {
+                    AiAssistantConfiguration aiaConfig = new AiAssistantConfiguration(
+                            aiaConfiguration.getString("serverURL"),
+                            aiaConfiguration.getString("jwt"),
+                            aiaConfiguration.getString("sessionID"),
+                            aiaConfiguration.getString("userID"));
+                    AiAssistant aiAssistant = AiAssistantKt.standaloneAiAssistant(reactApplicationContext, aiaConfig);
+                    Objects.requireNonNull(pdfFragment.getDocument()).setAiAssistant(aiAssistant);
+                }
+            } catch (Exception e) {
+                Log.w(TAG, "Failed to set AIA Configuration: " + e.getMessage());
+            }
+        }
         pdfUiFragmentGetter.onNext(Collections.singletonList(pdfFragment));
     }
 

android/src/main/java/com/pspdfkit/views/PdfViewDocumentListener.java

@@ -102,14 +102,17 @@ public void onDocumentSaveCancelled(PdfDocument pdfDocument) {
     @SuppressLint("CheckResult")
     @Override
     public boolean onPageClick(@NonNull PdfDocument pdfDocument, int pageIndex, @Nullable MotionEvent motionEvent, @Nullable PointF pointF, @Nullable Annotation annotation) {
+        String documentID = pdfDocument.getDocumentIdString();
         if (NutrientNotificationCenter.INSTANCE.getIsNotificationCenterInUse()) {
-            String documentID = pdfDocument.getDocumentIdString();
             NutrientNotificationCenter.INSTANCE.didTapDocument(pointF, documentID);
-            if (annotation != null) {
+        }
+        if (annotation != null) {
+            if (NutrientNotificationCenter.INSTANCE.getIsNotificationCenterInUse()) {
                 NutrientNotificationCenter.INSTANCE.didTapAnnotation(annotation, pointF, documentID);
-                eventDispatcher.dispatchEvent(new PdfViewAnnotationTappedEvent(parent.getId(), annotation));
             }
+            eventDispatcher.dispatchEvent(new PdfViewAnnotationTappedEvent(parent.getId(), annotation));
         }
+        
         return false;
     }
 

android/src/main/java/com/pspdfkit/views/ReactPdfUiFragment.java

@@ -13,13 +13,13 @@
 
 package com.pspdfkit.views;
 
-import android.content.Context;
 import android.content.res.TypedArray;
 import android.graphics.drawable.Drawable;
 import android.os.Bundle;
 import android.view.Menu;
 import android.view.MenuInflater;
 import android.view.MenuItem;
+import android.view.View;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
@@ -39,6 +39,7 @@
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 /**
  * This {@link PdfUiFragment} provides additional callbacks to improve integration into react native.
@@ -59,6 +60,24 @@ public class ReactPdfUiFragment extends PdfUiFragment {
     private static final String TOOLBAR_ITEM_OUTLINE = "outlineButtonItem";
     private static final String TOOLBAR_ITEM_DOCUMENT_INFO_VIEW = "documentInfoViewButtonItem";
 
+    // Static map to store configurations
+    private static final Map<String, ToolbarConfig> configMap = new HashMap<>();
+
+    // Inner class to hold all three properties together
+    private static class ToolbarConfig {
+        final ArrayList<String> stockToolbarItems;
+        final ArrayList<HashMap> customToolbarItems;
+        final MenuItemListener menuItemListener;
+
+        ToolbarConfig(ArrayList<String> stockToolbarItems,
+                      ArrayList<HashMap> customToolbarItems,
+                      MenuItemListener menuItemListener) {
+            this.stockToolbarItems = new ArrayList<>(stockToolbarItems);
+            this.customToolbarItems = new ArrayList<>(customToolbarItems);
+            this.menuItemListener = menuItemListener;
+        }
+    }
+
     private ArrayList<String> stockToolbarItems = new ArrayList<>();
     private ArrayList<HashMap> customToolbarItems = new ArrayList<>();
     private MenuItemListener menuItemListener;
@@ -75,6 +94,8 @@ public class ReactPdfUiFragment extends PdfUiFragment {
 
     @Nullable private ReactPdfUiFragmentListener reactPdfUiFragmentListener;
 
+    @Nullable private int configSaveId;
+
     private final FragmentManager.FragmentLifecycleCallbacks fragmentLifecycleCallbacks = new FragmentManager.FragmentLifecycleCallbacks() {
         @Override
         public void onFragmentCreated(@NonNull FragmentManager fm, @NonNull Fragment f, @Nullable Bundle savedInstanceState) {
@@ -140,13 +161,36 @@ void setCustomToolbarItems(@NonNull ArrayList<String> stockToolbarItems, @NonNul
         this.stockToolbarItems = stockToolbarItems;
         this.customToolbarItems = customToolbarItems;
         this.menuItemListener = listener;
+
+        int fragmentId = this.configSaveId;
+
+        if (fragmentId != View.NO_ID) {
+            configMap.put(String.valueOf(fragmentId), new ToolbarConfig(stockToolbarItems, customToolbarItems, listener)
+            );
+        }
     }
 
     @Override
-    public List<Integer> onGenerateMenuItemIds(@NonNull List<Integer> menuItems) {
+    public void onCreate(@Nullable Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        this.configSaveId = getId();
+
+        int viewId = getId();
+        if (viewId != View.NO_ID) {
+            ToolbarConfig config = configMap.get(String.valueOf(viewId));
+            if (config != null) {
+                this.stockToolbarItems = new ArrayList<>(config.stockToolbarItems);
+                this.customToolbarItems = new ArrayList<>(config.customToolbarItems);
+                this.menuItemListener = config.menuItemListener;
+            }
+        }
+    }
 
+    @NonNull
+    @Override
+    public List<Integer> onGenerateMenuItemIds(@NonNull List<Integer> menuItems) {
         // No items should be removed / added
-        if (this.stockToolbarItems.size() == 0 && this.customToolbarItems.size() == 0) {
+        if (this.stockToolbarItems.isEmpty() && this.customToolbarItems.isEmpty()) {
             return menuItems;
         }
 
@@ -198,10 +242,7 @@ public List<Integer> onGenerateMenuItemIds(@NonNull List<Integer> menuItems) {
         return menuItems;
     }
 
-    @Override
-    public void onCreateOptionsMenu(@NonNull Menu menu, @NonNull MenuInflater inflater) {
-        super.onCreateOptionsMenu(menu, inflater);
-
+    void setupOptionsMenu(@NonNull Menu menu) {
         for (HashMap item : customToolbarItems) {
             String customId = item.get("id").toString();
             String image = item.get("image").toString();
@@ -238,4 +279,16 @@ public void onCreateOptionsMenu(@NonNull Menu menu, @NonNull MenuInflater inflat
             }
         }
     }
+
+    @Override
+    public void onPrepareOptionsMenu(@NonNull Menu menu) {
+        super.onPrepareOptionsMenu(menu);
+        this.setupOptionsMenu(menu);
+    }
+
+    @Override
+    public void onCreateOptionsMenu(@NonNull Menu menu, @NonNull MenuInflater inflater) {
+        super.onCreateOptionsMenu(menu, inflater);
+        this.setupOptionsMenu(menu);
+    }
 }