Release 3.0.0

Author: pspdfkit-ci

CHANGELOG.md

@@ -1,6 +1,11 @@
+## 3.0.0 - 30 Jul 2025
+
+- Adds the `onReady` callback to `NutrientView` to make functional component integration easier. (J#HYB-809)
+- Updates SDK to Nutrient branding. The new package name is now `@nutrient-sdk/react-native`.
+
 ## 2.19.1 - 24 Jul 2025
 
-- Fixes an issue where `PSPDFKitView` component props were not reliably applied on Android. (J#HYB-836)
+- Fixes an issue where `PSPDFKitView` component props weren’t reliably applied on Android. (J#HYB-836)
 
 ## 2.19.0 - 02 Jul 2025
 
@@ -9,8 +14,10 @@
 - Adds the `iOSDocumentInfoOptions` option to `PDFConfiguration` to customize Document Info tabs on iOS. (J#HYB-826)
 - Adds the `setExcludedAnnotations` API to exclude specified annotations completely from selection. (J#HYB-823)
 - Adds the `bookmarksChanged` event to `NotificationCenter` to receive bookmark change events. (J#HYB-818)
-- Adds the `getBookmarks`, `addBookmarks` and `removeBookmarks` APIs to `PDFDocument` for bookmark management. (J#HYB-818)
-- Fixes an issue where the `enterAnnotationCreationMode` API does not honour annotation variant options. (J#HYB-814)
+- Adds the `getBookmarks`, `addBookmarks`, and `removeBookmarks` APIs to `PDFDocument` for bookmark management. (J#HYB-818)
+- Updates to Nutrient Android SDK 10.4.1.
+- Updates to Nutrient iOS SDK 14.10.0.
+- Fixes an issue where the `enterAnnotationCreationMode` API does not honor annotation variant options. (J#HYB-814)
 - Fixes an issue where the `enterAnnotationCreationMode` API on iOS could not change tools when already active. (J#HYB-815)
 - Fixes an issue where `AnnotationsEvent.REMOVED` contained null `name` and `creatorName` properties on Android. (J#HYB-829)
 

PROJECT_CONTEXT.md

@@ -0,0 +1,64 @@
+# Nutrient React Native SDK Project Context
+
+## Project Overview
+This is the official Nutrient React Native SDK repository. It provides React Native components and native modules for viewing, annotating, and manipulating PDF documents on iOS and Android platforms.
+
+## Tech Stack
+- **React Native**: 0.73+ (supports both Legacy and New Architecture)
+- **Nutrient React Native SDK**: Native PDF viewing and annotation library
+- **TypeScript**: Primary language for JavaScript/TypeScript code
+- **iOS**: Swift/Objective-C native modules
+- **Android**: Kotlin/Java native modules
+- **Metro**: React Native bundler
+
+## Architecture
+- **Architecture Support**: Legacy Bridge. New Architecture (Fabric/TurboModules) coming soon.
+- **Native Modules**: Custom Nutrient integration for both platforms
+- **View Components**: NutrientView component with native view implementations
+- **Event System**: Cross-platform event handling for document and annotation events
+
+## Key Directories
+- `/pspdfkit-react-native/`: Main SDK source code
+- `/pspdfkit-react-native/src/`: TypeScript source files
+- `/pspdfkit-react-native/android/`: Android native implementation
+- `/pspdfkit-react-native/ios/`: iOS native implementation
+- `/pspdfkit-react-native/samples/Catalog/`: Example app
+- `/pspdfkit-react-native/types/`: TypeScript type definitions
+
+## Important Files
+- `/pspdfkit-react-native/index.js`: Main SDK entry point and NutrientView component
+- `/pspdfkit-react-native/src/configuration/PDFConfiguration.ts`: Configuration options
+- `/pspdfkit-react-native/android/src/main/java/com/pspdfkit/react/`: Android native modules
+- `/pspdfkit-react-native/ios/RCTPSPDFKit/`: iOS native modules
+
+## Development Conventions
+- **TypeScript First**: All new code should use TypeScript
+- **Dual Architecture**: Support both Legacy and New Architecture simultaneously
+- **Platform Parity**: Ensure iOS and Android implementations are feature-equivalent
+- **Event Consistency**: Use consistent event naming across platforms
+- **Configuration Objects**: Use strongly-typed configuration objects
+
+## Key Components
+- **NutrientView**: Main React Native component for PDF viewing
+- **Nutrient**: Native module for document operations
+- **PDFConfiguration**: Configuration options for PDF behavior
+- **Toolbar**: Customization options for the PDF toolbar
+- **Annotation**: Annotation creation and management
+
+## Migration Context
+- **Legacy Architecture**: Current bridge-based system
+- **New Architecture**: Fabric (rendering) + TurboModules (native modules)
+- **Dual Support**: Must maintain compatibility with both architectures
+- **Gradual Migration**: Users can opt into New Architecture when ready
+
+## Common Patterns
+- **Event Handling**: Use consistent event naming (`onDocumentLoaded`, `onAnnotationTapped`)
+- **Configuration**: Pass configuration objects to customize behavior
+- **Native Modules**: Use platform-specific implementations with shared interfaces
+- **Error Handling**: Consistent error handling across platforms
+
+## Important Notes
+- Nutrient is a commercial SDK requiring license keys
+- Support both trial mode (with watermarks) and licensed mode
+- Maintain backward compatibility during architecture migrations
+- Follow Nutrient's native SDK conventions for consistency 

README.md

@@ -6,8 +6,6 @@ This library requires a valid license of the Nutrient SDK. Licenses are per plat
 
 The Nutrient React Native SDK exposes the most often used APIs from Nutrient. Many of our partners end up forking this repository and adding some custom code to achieve even greater integration with their products, using native code.
 
-Windows is not currently supported, please use version [1.24.9](https://github.com/PSPDFKit/react-native/releases/tag/1.24.9) instead.
-
 ### Nutrient
 
 The [Nutrient SDK](https://nutrient.io/) is a framework that allows you to view, annotate, sign, and fill PDF forms on iOS, Android, Windows, macOS, and Web.
@@ -18,7 +16,7 @@ The [Nutrient SDK](https://nutrient.io/) is a framework that allows you to view,
 
 Nutrient offers support for customers with an active SDK license via https://support.nutrient.io/hc/en-us/requests/new.
 
-Are you evaluating our SDK? That's great, we're happy to help out! The Nutrient React Native  SDK is a commercial product and requires the purchase of a license key when used in production. By default, this library will initialize in demo mode, placing a watermark on each PDF and limiting usage to 60 minutes.
+Are you evaluating our SDK? That's great, we're happy to help out! The Nutrient React Native SDK is a commercial product and requires the purchase of a license key when used in production. By default, this library will initialize in demo mode, placing a watermark on each PDF and limiting usage to 60 minutes.
 
 To purchase a license for production use, please reach out to us via https://www.nutrient.io/sdk/contact-sales.
 
@@ -53,7 +51,7 @@ PSPDFKit.setLicenseKey('YOUR_REACT_NATIVE_LICENSE_KEY_GOES_HERE');
 
 ### Installation
 
-The Nutrient React Native SDK dependency is installed from the GitHub repository and not the `npm` registry. To install the Nutrient React Native SDK, run `yarn add react-native-pspdfkit@github:PSPDFKit/react-native` in your project directory or `npm install github:PSPDFKit/react-native` if you’re using `npm`.
+The Nutrient React Native SDK dependency is installed from the GitHub repository and not the `npm` registry. To install the Nutrient React Native SDK, run `yarn add @nutrient-sdk/react-native` in your project directory or `npm install @nutrient-sdk/react-native` if you’re using `npm`.
 
 ### Getting Started
 
@@ -68,19 +66,19 @@ See our [Getting Started on React Native guide](https://www.nutrient.io/getting-
 1. Create the React Native project by running the following command:
 
    ```bash
-   npx react-native init PSPDFKitDemo
+   npx react-native init NutrientDemo
    ```
 
 1. In the terminal app, change the location of the current working directory inside the newly created project:
 
    ```bash
-   cd PSPDFKitDemo
+   cd NutrientDemo
    ```
 
 1. Add the Nutrient React Native SDK:
 
    ```bash
-   yarn add react-native-pspdfkit@github:PSPDFKit/react-native
+   yarn add @nutrient-sdk/react-native
    ```
 
 1. Install all the dependencies for the project:
@@ -101,9 +99,9 @@ See our [Getting Started on React Native guide](https://www.nutrient.io/getting-
       allprojects {
         repositories {
           mavenLocal()
-    +       maven {
+    +     maven {
     +         url 'https://my.nutrient.io/maven/'
-    +       }
+    +     }
         }
       }
     ```
@@ -117,7 +115,7 @@ See our [Getting Started on React Native guide](https://www.nutrient.io/getting-
     +  compileSdkVersion 35
     ...
       defaultConfig {
-        applicationId "com.pspdfkitdemo"
+        applicationId "com.nutrientdemo"
     -     minSdkVersion rootProject.ext.minSdkVersion
     +     minSdkVersion 21
           targetSdkVersion rootProject.ext.targetSdkVersion
@@ -158,7 +156,7 @@ See our [Getting Started on React Native guide](https://www.nutrient.io/getting-
 1. Open your project’s Workspace in Xcode:
 
    ```bash
-   open PSPDFKitDemo.xcworkspace
+   open NutrientDemo.xcworkspace
    ```
 
 1. Make sure the deployment target is set to 16.0 or higher:
@@ -202,19 +200,19 @@ See our [Getting Started on React Native guide](https://www.nutrient.io/getting-
     ```typescript
     import React, {Component} from 'react';
     import {Platform} from 'react-native';
-    import PSPDFKitView from 'react-native-pspdfkit';
+    import NutrientView from '@nutrient-sdk/react-native';
     import { NativeModules } from 'react-native';
 
-    const PSPDFKit = NativeModules.PSPDFKit;
-    PSPDFKit.setLicenseKey(null);
+    const Nutrient = NativeModules.Nutrient;
+    Nutrient.setLicenseKey(null);
 
     const DOCUMENT =
       Platform.OS === 'ios' ? 'Document.pdf' : 'file:///android_asset/Document.pdf';
-    export default class PSPDFKitDemo extends Component<{}> {
+    export default class NutrientDemo extends Component<{}> {
       render() {
-        var pdfRef: React.RefObject<PSPDFKitView> = React.createRef();
+        var pdfRef: React.RefObject<NutrientView | null> = React.createRef();
         return (
-          <PSPDFKitView
+          <NutrientView
             document={DOCUMENT}
             configuration={{
               showThumbnailBar: 'scrollable',
@@ -246,7 +244,7 @@ Take a look at the instructions to get started [here](/samples/Catalog/README.md
 
 ### Configuration
 
-The behaviour of the `PSPDFKitView` component can be customized using the configuration object. Refer to the [`PDFConfiguration`](https://www.nutrient.io/api/react-native/PDFConfiguration.html) API documentation. The `PDFConfiguration` object can be passed as parameter in when creating the `PSPDFKitView` component, or when using the `PSPDFKit.present()` Native Module API.
+The behaviour of the `NutrientView` component can be customized using the configuration object. Refer to the [`PDFConfiguration`](https://www.nutrient.io/api/react-native/PDFConfiguration.html) API documentation. The `PDFConfiguration` object can be passed as parameter in when creating the `NutrientView` component, or when using the `Nutrient.present()` Native Module API.
 
 ```typescript
 const configuration: PDFConfiguration = {

android/build.gradle

@@ -1,7 +1,7 @@
 /*
  * build.gradle
  *
- *   PSPDFKit
+ *   Nutrient
  *
  *   Copyright © 2021-2025 PSPDFKit GmbH. All rights reserved.
  *
@@ -15,7 +15,7 @@
  *   Contains gradle configuration constants
  */
 ext {
-    PSPDFKIT_VERSION = '10.4.1'
+    NUTRIENT_VERSION = '10.5.0'
 }
 
 buildscript {
@@ -102,7 +102,7 @@ android {
 }
 
 dependencies {
-    api("io.nutrient:nutrient:${PSPDFKIT_VERSION}") {
+    api("io.nutrient:nutrient:${NUTRIENT_VERSION}") {
         exclude group: 'com.google.auto.value', module: 'auto-value'
         exclude group: 'androidx.recyclerview', module: 'recyclerview'
     }

android/src/main/AndroidManifest.xml

@@ -13,7 +13,6 @@
   -->
 
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.pspdfkit.react"
     android:versionCode="1"
     android:versionName="1.0">
 

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

@@ -343,7 +343,7 @@ class PDFDocumentModule(reactContext: ReactApplicationContext) : ReactContextBas
     @ReactMethod fun applyInstantJSON(reference: Int, instantJSON: ReadableMap, promise: Promise) {
         try {
             this.getDocument(reference)?.document?.let {
-                val json = (instantJSON.toHashMap() as Map<*, *>?)?.let { it1 -> JSONObject(it1) }
+                val json = (instantJSON.toHashMap() as? Map<*, *>)?.let { it1 -> JSONObject(it1) }
                 val dataProvider: DataProvider = DocumentJsonDataProvider(json)
                 DocumentJsonFormatter.importDocumentJsonAsync(it, dataProvider)
                     .subscribeOn(Schedulers.io())

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

@@ -109,7 +109,7 @@ public void initialize() {
 
     @Override
     public String getName() {
-        return "PSPDFKit";
+        return "Nutrient";
     }
 
     @ReactMethod
@@ -140,37 +140,37 @@ public void present(@NonNull String document, @NonNull ReadableMap configuration
 
     @ReactMethod
     public void presentPdf(@NonNull String document, @NonNull ReadableMap configuration, @Nullable Promise promise) {
-        if (getCurrentActivity() != null) {
+        if (getReactApplicationContext().getCurrentActivity() != null) {
             if (resumedActivity == null) {
                 // We register an activity lifecycle callback so we can get notified of the current activity.
-                getCurrentActivity().getApplication().registerActivityLifecycleCallbacks(this);
+                getReactApplicationContext().getCurrentActivity().getApplication().registerActivityLifecycleCallbacks(this);
             }
-            ConfigurationAdapter configurationAdapter = new ConfigurationAdapter(getCurrentActivity(), configuration);
+            ConfigurationAdapter configurationAdapter = new ConfigurationAdapter(getReactApplicationContext().getCurrentActivity(), configuration);
             // This is an edge case where file scheme is missing.
             if (Uri.parse(document).getScheme() == null) {
                 document = FILE_SCHEME + document;
             }
 
             lastPresentPromise = promise;
-            PdfActivity.showDocument(getCurrentActivity(), Uri.parse(document), configurationAdapter.build());
+            PdfActivity.showDocument(getReactApplicationContext().getCurrentActivity(), Uri.parse(document), configurationAdapter.build());
         }
     }
 
     @ReactMethod
     public void presentImage(@NonNull String imageDocument, @NonNull ReadableMap configuration, @Nullable Promise promise) {
-        if (getCurrentActivity() != null) {
+        if (getReactApplicationContext().getCurrentActivity() != null) {
             if (resumedActivity == null) {
                 // We register an activity lifecycle callback so we can get notified of the current activity.
-                getCurrentActivity().getApplication().registerActivityLifecycleCallbacks(this);
+                getReactApplicationContext().getCurrentActivity().getApplication().registerActivityLifecycleCallbacks(this);
             }
-            ConfigurationAdapter configurationAdapter = new ConfigurationAdapter(getCurrentActivity(), configuration);
+            ConfigurationAdapter configurationAdapter = new ConfigurationAdapter(getReactApplicationContext().getCurrentActivity(), configuration);
             // This is an edge case where file scheme is missing.
             if (Uri.parse(imageDocument).getScheme() == null) {
                 imageDocument = FILE_SCHEME + imageDocument;
             }
 
             lastPresentPromise = promise;
-            PdfActivity.showImage(getCurrentActivity(), Uri.parse(imageDocument), configurationAdapter.build());
+            PdfActivity.showImage(getReactApplicationContext().getCurrentActivity(), Uri.parse(imageDocument), configurationAdapter.build());
         }
     }
 
@@ -187,12 +187,12 @@ public void presentInstant(@NonNull ReadableMap documentData, @NonNull ReadableM
             return;
         }
 
-        if (getCurrentActivity() != null) {
+        if (getReactApplicationContext().getCurrentActivity() != null) {
             if (resumedActivity == null) {
                 // We register an activity lifecycle callback so we can get notified of the current activity.
-                getCurrentActivity().getApplication().registerActivityLifecycleCallbacks(this);
+                getReactApplicationContext().getCurrentActivity().getApplication().registerActivityLifecycleCallbacks(this);
             }
-            ConfigurationAdapter configurationAdapter = new ConfigurationAdapter(getCurrentActivity(), configuration);
+            ConfigurationAdapter configurationAdapter = new ConfigurationAdapter(getReactApplicationContext().getCurrentActivity(), configuration);
 
             lastPresentPromise = promise;
 
@@ -201,7 +201,7 @@ public void presentInstant(@NonNull ReadableMap documentData, @NonNull ReadableM
                 @Override
                 public void run() {
                     try {
-                        RNInstantPdfActivity.showInstantDocument(getCurrentActivity(), serverUrl, jwt, configurationAdapter.build());
+                        RNInstantPdfActivity.showInstantDocument(getReactApplicationContext().getCurrentActivity(), serverUrl, jwt, configurationAdapter.build());
                     } catch (Exception e) {
                         // Could not start instant
                     }