compdfkit(rn) - v2.3.0

Author: xiaolongrick

API.md

@@ -401,6 +401,33 @@ Promise Parameters:
 const saveResult = await pdfReaderRef.current.save();
 ```
 
+#### saveAs
+
+Saves the document to the specified directory.
+
+Parameters:
+
+| Name           | Type    | Description                                                  |
+| -------------- | ------- | ------------------------------------------------------------ |
+| savePath       | string  | Specifies the path where the document should be saved.       |
+| removeSecurity | boolean | Whether to remove the document's password.                   |
+| fontSubset     | boolean | Whether to embed font subsets into PDF. Defaults to **true**. |
+
+Returns a Promise.
+
+| Name   | Type | Description                                                  |
+| ------ | ---- | ------------------------------------------------------------ |
+| result | bool | Returns `true` if the document is saved successfully, otherwise `false`. |
+
+```tsx
+const savePath = '/data/user/0/com.compdfkit.flutter.example/cache/temp/PDF_Document.pdf';
+// android platfrom support uri, for example:
+const savePath = 'content://media/external/file/1000045118';
+const removeSecurity = false;
+const fontSubset = true;
+const result = await pdfReaderRef.current?._pdfDocument.saveAs(savePath, removeSecurity, fontSubset);
+```
+
 #### onSaveDocument
 
 function, optional
@@ -992,6 +1019,78 @@ Promise Parameters:
 const pageCount = await pdfReaderRef.current?._pdfDocument.getPageCount();
 ```
 
+#### importDocument
+
+Imports another PDF document and inserts it at a specified position in the current document.
+
+Parameters:
+
+| Name           | Type          | Description                                                  |
+| -------------- | ------------- | ------------------------------------------------------------ |
+| filePath       | string        | The path of the PDF document to import. Must be a valid, accessible path on the device. |
+| pages          | Array[number] | The collection of pages to import, represented as an array of integers. If `null` or an empty array is passed, the entire document will be imported. |
+| insertPosition | number        | The position to insert the external document into the current document. This value must be provided. If not specified, the document will be inserted at the end of the current document. |
+| password       | string        | The password for the document, if it is encrypted. If the document is not encrypted, an empty string `''` can be passed. |
+
+Returns a Promise.
+
+| Name   | Type | Description                                                  |
+| ------ | ---- | ------------------------------------------------------------ |
+| result | bool | Returns a `Promise<boolean>` indicating whether the document import was successful.<br>\- `true` indicates success<br>\- `false` or an error indicates failure |
+
+```tsx
+// Define the file path of the document to import
+// For local files (e.g., from app cache):
+const filePath = '/data/user/0/com.compdfkit.flutter.example/cache/temp/PDF_Document.pdf';
+// For Android content URIs (e.g., from media storage):
+const filePath = 'content://media/external/file/1000045118';
+
+// Specify the pages to import. An empty array [] imports all pages.
+// In this example, only the first page (index 0) is imported.
+const pages = [0]; 
+
+// Define the position to insert the imported pages.
+// 0 means inserting at the beginning of the document.
+const insertPosition = 0; 
+
+// Provide the document password if encrypted. Leave empty if not required.
+const password = '';
+
+// Import the document into the PDF reader.
+const importResult = await pdfReaderRef.current?._pdfDocument.importDocument(
+  filePath, 
+  pages, 
+  insertPosition, 
+  password
+);
+```
+
+#### splitDocumentPages
+
+Splits the specified pages from the current document and saves them as a new document.
+
+This function extracts the given pages from the current PDF document and saves them as a new document at the provided save path.
+
+Parameters:
+
+| Name     | Type          | Description                                    |
+| -------- | ------------- | ---------------------------------------------- |
+| savePath | string        | The path where the new document will be saved. |
+| pages    | Array[number] | Pages to extract from the current document.    |
+
+Returns a Promise.
+
+| Name   | Type | Description                                                  |
+| ------ | ---- | ------------------------------------------------------------ |
+| result | bool | A Promise that resolves to `true` if the operation is successful, or `false` if it fails. |
+
+```tsx
+const savePath = '/data/user/0/com.compdfkit.flutter.example/cache/temp/PDF_Document.pdf';
+// Pages to extract from the current document
+const pages = [0, 1, 2]; 
+const result = await pdfReaderRef.current?.splitDocumentPages(savePath, pages);
+```
+
 ### Annotations
 
 #### import Annotations
@@ -1048,6 +1147,54 @@ Promise Parameters:
 const removeResult = await pdfReaderRef.current?.removeAllAnnotations();
 ```
 
+#### getAnnotations
+
+Retrieves all annotations on the current page.
+
+This method fetches all annotations present on the current page of the PDF document  and returns a list of corresponding CPDFAnnotation instances.
+
+Promise Parameters:
+
+| Name        | Type             | Description                                                  |
+| ----------- | ---------------- | ------------------------------------------------------------ |
+| annotations | CPDFAnnotation[] | A promise that resolves with all annotations on the current page, or an empty array if retrieval fails. |
+
+```tsx
+// Page index, where 0 represents the first page
+const pageIndex = 0;
+
+// Retrieve the page object from the document
+const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
+
+// Fetch all annotations on the specified page
+const annotations = await page?.getAnnotations();
+```
+
+#### flattenAllPages
+
+Flatten all pages of the current document.
+
+Parameters:
+
+| Name       | Type    | Description                                                  |
+| ---------- | ------- | ------------------------------------------------------------ |
+| savePath   | string  | The path to save the flattened document. On Android, you can pass a Uri. |
+| fontSubset | boolean | Whether to include the font subset when saving.              |
+
+Returns a Promise.
+
+| Name   | Type    | Description                                                  |
+| ------ | ------- | ------------------------------------------------------------ |
+| result | boolean | Returns 'true' if the flattened document is saved successfully, otherwise 'false'. |
+
+```tsx
+const savePath = 'file:///storage/emulated/0/Download/flatten.pdf';
+// or use Uri on the Android Platform.
+const savePath = await ComPDFKit.createUri('flatten_test.pdf', 'compdfkit', 'application/pdf');
+const fontSubset = true;
+const result = await pdfReaderRef.current?._pdfDocument.flattenAllPages(savePath, fontSubset);
+```
+
 ### Forms
 
 #### importWidgets
@@ -1090,6 +1237,95 @@ Promise Parameters:
 const exportXfdfFilePath = await pdfReaderRef.current?.exportWidgets();
 ```
 
+#### getWidgets
+
+Retrieves all form widgets on the current page.
+
+This method fetches all form widgets present on the current page of the PDF document and returns a list of corresponding CPDFWidget instances.
+
+Returns a Promise.
+
+**Promise Parameters:**
+
+| Name    | Type         | Description                                             |
+| ------- | ------------ | ------------------------------------------------------- |
+| widgets | CPDFWidget[] | **true**: import successful,``**false**: import failed. |
+
+```tsx
+const pageIndex = 0;
+const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
+const widgets = await page?.getWidgets();
+```
+
+**Related Widgets**
+
+| Class                 | Description                     |
+| --------------------- | ------------------------------- |
+| CPDFWidget            | Base class for all form widgets |
+| CPDFTextWidget        | Text input field widget         |
+| CPDFSignatureWidget   | Signature widget                |
+| CPDFRadiobuttonWidget | Radio button widget             |
+| CPDFPushbuttonWidget  | Button widget                   |
+| CPDFListboxWidget     | List box widget                 |
+| CPDFCheckboxWidget    | Checkbox widget                 |
+| CPDFComboboxWidget    | Combo box widget                |
+
+#### Fill Form Fields
+
+ComPDFKit supports programmatically filling form fields in a PDF document.
+
+The steps to fill in form fields using code are as follows:
+
+1. Get the page object of the form to be filled in from CPDFDocument.
+
+2. Retrieve all forms from the page object.
+
+3. Traverse all forms to find the one to be filled in.
+
+4. Modify the form field contents as needed.
+
+This example shows how to fill in form fields:
+
+```tsx
+const pageIndex = 0;
+// Retrieve the page object of the first page
+const cpdfPage: CPDFPage = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
+
+// Retrieve all form widgets on the current page
+const widgets = await page?.getWidgets();
+
+// Fill in the text field content
+// Assume that there is a text field form on the current page and retrieve the CPDFTextWidget object
+const textWidget = widgets[0] as CPDFTextWidget;
+// Set the text field content to "Hello World"
+await textWidget.setText('Hello World');
+// Refresh the appearance of the form to apply changes, this step is necessary
+await textWidget.updateAp();
+
+// Modify the radio button's checked state
+const radioButtonWidget = widgets[0] as CPDFRadiobuttonWidget;
+// Set the radio button to checked
+await radioButtonWidget.setChecked(true);
+// Refresh the appearance of the radio button
+await radioButtonWidget.updateAp();
+
+// Modify the checkbox's checked state
+const checkboxWidget = widgets[0] as CPDFCheckboxWidget;
+// Set the checkbox to checked
+await checkboxWidget.setChecked(true);
+// Refresh the appearance of the checkbox
+await checkboxWidget.updateAp();
+
+// Add an electronic signature to the signature form
+const signatureWidget = widgets[0] as CPDFSignatureWidget;
+// Android-supported URI format:
+await signatureWidget.addImageSignature('content://media/external/images/media/123');
+// Or file path:
+await signatureWidget.addImageSignature('/path/to/image');
+// Refresh the appearance of the signature form
+await signatureWidget.updateAp();
+```
+
 ### Security
 
 #### isEncrypted
@@ -1217,3 +1453,4 @@ Returns a Promise.
 ```tsx
 const encryptAlgo = await pdfReaderRef.current?._pdfDocument.getEncryptAlgo();
 ```
+

CHANGELOG.md

@@ -1,5 +1,29 @@
 ## Newest Release
 
+### 2.3.0 - 21 Mar. 2025
+
+1. Added the features support for ComPDFKit PDF SDK for iOS iOS V2.3.0.
+2. Added the features support for ComPDFKit PDF SDK for Android Android V2.3.0.
+3. Added import/export form data API, supporting XFDF format files.
+4. Added the ability to create text input fields and insert images by clicking on a page area in content editing mode.
+5. Added navigation system print API.
+6. Added import PDF document API.
+7. Added split PDF document API.
+8. Added fill form content API.
+9. Added `saveAs` API.
+10. Added API to retrieve all annotations and form data on a page.
+11. Added document flattening API.
+12. Fixed a crash issue when editing or deleting text in certain documents.
+13. Fixed the border display issue after completing a free text annotation.
+14. Fixed an issue where the LaBan Key input method could not delete the last character while editing text.
+15. Fixed text garbling issues in content editing mode.
+16. Fixed an issue where form field content was not displayed in some documents.
+17. Fixed the issue that the zoomed-in page area did not follow the zooming when jumping to draw a rectangular area.
+18. Fixed the issue of Chinese garbled characters in the form name.
+19. Fixed the issue where the prompt did not appear for scanned PDF documents on iOS.
+
+## Previous Release
+
 ### 2.3.0-beta.1 - 28 Feb. 2025
 
 * Added import/export interface for form data in XFDF format files.
@@ -8,13 +32,8 @@
 * Fixed issue where editing or deleting text in some documents caused crashes.
 * Fixed issue with the border appearing after completing FreeText annotation.
 * Fixed issue where the LaBan Key input method deletes the last character when editing text.
-
 * Fixed the issue of text garbling in content editing mode.
 
-
-
-## Previous Release
-
 ### 2.2.2 - 19 Feb. 2025
 
 * Added the features support for ComPDFKit PDF SDK for iOS iOS V2.2.2.

README.md

@@ -115,8 +115,8 @@ open ios/Podfile
 ```diff
 target 'MyApp' do
     # ...
-+    pod "ComPDFKit", podspec:'https://www.compdf.com/download/ios/cocoapods/xcframeworks/compdfkit/2.3.0-beta.podspec'
-+  pod "ComPDFKit_Tools", podspec:'https://www.compdf.com/download/ios/cocoapods/xcframeworks/compdfkit_tools/2.3.0-beta.podspec'
++    pod "ComPDFKit", podspec:'https://www.compdf.com/download/ios/cocoapods/xcframeworks/compdfkit/2.3.0.podspec'
++  pod "ComPDFKit_Tools", podspec:'https://www.compdf.com/download/ios/cocoapods/xcframeworks/compdfkit_tools/2.3.0.podspec'
     # ...
 end
 ```
@@ -126,8 +126,8 @@ end
 ```diff
 target 'MyApp' do
     # ...
-+  pod 'ComPDFKit', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.3.0-beta'
-+  pod 'ComPDFKit_Tools', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.3.0-beta'
++  pod 'ComPDFKit', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.3.0'
++  pod 'ComPDFKit_Tools', :git => 'https://github.com/ComPDFKit/compdfkit-pdf-sdk-ios-swift.git', :tag => '2.3.0'
     # ...
 end
 ```

android/build.gradle

@@ -87,12 +87,14 @@ dependencies {
   compileOnly fileTree(include: ['*.jar','*.aar'], dir: 'libs')
   implementation "com.facebook.react:react-native:+"
 
-  api "com.compdf:compdfkit-tools:2.3.0-SNAPSHOT"
+  api "com.compdf:compdfkit-tools:2.3.0"
   api 'com.github.bumptech.glide:glide:4.15.1'
   annotationProcessor 'com.github.bumptech.glide:compiler:4.15.1'
   api 'androidx.documentfile:documentfile:1.0.1'
   api 'androidx.appcompat:appcompat:1.6.1'
   api 'com.google.android.material:material:1.8.0'
   api 'androidx.constraintlayout:constraintlayout:2.1.4'
 }
+configurations.all { resolutionStrategy.cacheChangingModulesFor 0, 'seconds' }
+