react-native-optimized-pdf 1.1.0 → 1.3.1

package/CHANGELOG.md

@@ -5,31 +5,48 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [1.3.1] - 2026-11-01
+
+### Fixed
+
+- Local `file://` URIs and absolute paths are returned directly instead of being passed to the HTTP downloader, fixing local PDF opening on Android.
+
+### Changed
+
+- Replaced the abandoned `react-native-fs` with the maintained `@dr.pogodin/react-native-fs` (`^2.41.0`).
+
+## [1.3.0] - 2026-08-08
 
 ### Added
 
-- Modular architecture with separated concerns
-- `PdfCacheService` for advanced cache management
-- `PdfNavigationControls` as standalone component
-- `PdfLoadingOverlay` and `PdfErrorOverlay` components
-- `showNavigationControls` prop to hide/show built-in controls
-- `onPageChange` callback for page change events
-- Comprehensive TypeScript types in `/src/types`
-- JSDoc comments for better IDE support
-- Cache utility methods (clearCache, clearAllCache, getCacheSize)
-- Accessibility labels for navigation controls
+- Annotation (annots) rendering support on Android and iOS
+- Tile-based PDF rendering for high-quality zoom (Android)
+- 100% automated test coverage for the TypeScript/JavaScript surface with a hard gate
+- CI workflow (GitHub Actions) running lint, typecheck, and coverage-gated tests on every push/PR
+- Test infrastructure: Jest, React Native Testing Library, and coverage thresholds in `jest.config.js`
+- Unit suites for `PdfCacheService`, `PdfNavigationControls`, `PdfOverlays`, and constants
+- Integration suite for `OptimizedPdfView` covering the load state machine, events, navigation, source changes, and platform fallback
 
 ### Changed
 
-- Refactored component structure for better maintainability
-- Improved error handling and messaging
-- Better TypeScript type exports
-- Enhanced documentation with more examples
-- Cleaner imports using ES6 modules consistently
+- Android: migrated to `pdfiumandroid` and replaced previous rendering pipeline with tiled rendering
+- iOS: introduced annotation flattening using PDFKit when needed, while keeping CGPDF rendering for performance
+- Updated dependencies and improved TypeScript configuration
+- Removed unused and dead iOS code (delegate protocol, view/manager methods, error cases, imports)
+- Reconciled `PDF`/`Pdf` naming across the iOS Swift class, `@objc` export, Objective-C manager, and JS registration
+- Extracted duplicated `file://` URL handling into a shared iOS helper
+- Removed the unused `PdfSource.method` field (documented as non-breaking: the field was never consumed)
+- Removed unused `ERROR_MESSAGES.LOAD_FAILED` and `INVALID_SOURCE` entries
+- Aligned the iOS `maximumZoom` default with the JS side
+
+### Improved
+
+- Better zoom quality and rendering performance
+- More efficient memory usage across large documents
+- Minor UI and typing improvements
 
 ### Fixed
 
-- Memory leaks in useEffect cleanup
-- Proper file:// protocol handling
-- Cache validation logic
+- Annotations not being rendered
+- `_cancelled` reset semantics in `TiledPDFPageView`
+- Duplicated imports across iOS sources

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Herbeth Lucas de Sousa Pereira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,20 +1,27 @@
 # React Native Optimized PDF
 
-High-performance PDF viewer for React Native with optimized memory usage. Uses CATiledLayer on iOS and PdfRenderer on Android for smooth rendering with automatic caching.
+High-performance **React Native PDF viewer** for iOS and Android.
+
+- 🚀 Handles large PDFs (1000+ pages) without crashes
+- 🔍 Smooth zoom with tile-based rendering
+- ✍️ Supports annotations (annots)
+- 🧠 Memory-efficient and optimized for performance
+
+If you're looking for a **React Native PDF viewer** that supports large files, zoom, and annotations, this library provides a fast and reliable solution.
 
 ## Features
 
-- 🚀 **Optimized memory usage** with CATiledLayer (iOS) and PdfRenderer (Android)
-- 📦 **Automatic caching** with configurable expiration
-- 📱 **Smooth zoom and scroll** with customizable maximum zoom
-- 🎯 **Built-in page navigation** with optional custom controls
-- 📊 **Comprehensive event callbacks** for load, error, and page events
-- 🎨 **High-quality rendering** with antialiasing support
-- 📈 **Download progress tracking** for remote PDFs
-- ⚡ **TypeScript support** with full type definitions
-- 🔧 **Modular architecture** with exportable utilities
-- 🤖 **Cross-platform** support for iOS and Android
-- 🔒 **Password-protected PDF** support
+- 🚀 Optimized memory usage with CATiledLayer (iOS) and PdfRenderer/Pdfium (Android)
+- ✍️ Annotation (annots) rendering support
+- 📦 Automatic caching with configurable expiration
+- 📱 Smooth zoom and scroll with tiled rendering
+- 🎯 Built-in page navigation with optional custom controls
+- 📊 Event callbacks for load, error, and page changes
+- 🎨 High-quality rendering with antialiasing
+- 📈 Download progress tracking
+- ⚡ Full TypeScript support
+- 🤖 Cross-platform (iOS & Android)
+- 🔒 Password-protected PDFs
 
 ## Installation
 
@@ -34,6 +41,10 @@ cd ios && pod install
 
 No additional setup required! The module will be automatically linked.
 
+### Local files
+
+`source.uri` accepts a remote URL (`http://` or `https://`), a `file://` URI, or an absolute path. Local files are opened directly and are not copied to the cache; only remote URLs are downloaded. Remote downloads use the maintained [`@dr.pogodin/react-native-fs`](https://github.com/birdofpreyru/react-native-fs) package, installed automatically as a dependency.
+
 ## Usage
 
 ### Basic Example
@@ -191,8 +202,8 @@ const isValid = await PdfCacheService.isCacheValid({
 
 | Property        | Type                     | Default      | Description                                                  |
 | --------------- | ------------------------ | ------------ | ------------------------------------------------------------ |
-| `uri`           | `string`                 | **required** | PDF file URI (remote URL or local path)                      |
-| `cache`         | `boolean`                | `true`       | Enable local caching                                         |
+| `uri`           | `string`                 | **required** | PDF file URI (remote URL, `file://` URI, or absolute path) |
+| `cache`         | `boolean`                | `true`       | Enable local caching for remote URLs (ignored for local files) |
 | `cacheFileName` | `string`                 | MD5 of URI   | Custom filename for cached file                              |
 | `expiration`    | `number`                 | -            | Cache expiration in seconds (0 or undefined = no expiration) |
 | `headers`       | `Record<string, string>` | -            | HTTP headers for download                                    |
@@ -203,7 +214,7 @@ Static methods for managing PDF cache:
 
 - `getCacheFilePath(source: PdfSource): string` - Get local cache path
 - `isCacheValid(source: PdfSource): Promise<boolean>` - Check if cache is valid
-- `downloadPdf(source: PdfSource, onProgress?: (percent: number) => void): Promise<string>` - Download and cache PDF
+- `downloadPdf(source: PdfSource, onProgress?: (percent: number) => void): Promise<string>` - Download and cache a remote PDF; local paths are returned directly
 - `clearCache(source: PdfSource): Promise<void>` - Clear specific cached file
 - `clearAllCache(): Promise<void>` - Clear all cached PDFs
 - `getCacheSize(): Promise<number>` - Get total cache size in bytes
@@ -226,26 +237,6 @@ import { PdfNavigationControls } from 'react-native-optimized-pdf';
 />;
 ```
 
-### PdfLoadingOverlay
-
-Loading state component with progress:
-
-```tsx
-import { PdfLoadingOverlay } from 'react-native-optimized-pdf';
-
-<PdfLoadingOverlay progress={75} />;
-```
-
-### PdfErrorOverlay
-
-Error state component:
-
-```tsx
-import { PdfErrorOverlay } from 'react-native-optimized-pdf';
-
-<PdfErrorOverlay error="Failed to load PDF" />;
-```
-
 ## Platform Support
 
 | Platform | Supported | Min Version |
@@ -289,6 +280,26 @@ import { PdfErrorOverlay } from 'react-native-optimized-pdf';
 - Pass the password via the `password` prop
 - Check for "Invalid password" in error message to show retry prompt
 
+## Development
+
+### Commands
+
+```bash
+# Run the test suite
+yarn test
+
+# Run tests with coverage (enforces the 100% gate)
+yarn test:coverage
+
+# Lint the codebase
+yarn lint
+
+# Type-check the codebase
+yarn typecheck
+```
+
+The test suite enforces **100% coverage** (lines, statements, functions, and branches) on the TypeScript/JavaScript surface (`src/**` and `index.ts`). `yarn test:coverage` exits non-zero if any threshold drops below 100%. The thresholds live in `jest.config.js`, and CI (GitHub Actions) runs `yarn lint`, `yarn typecheck`, and `yarn test:coverage` on every push and pull request, blocking merges when the gate fails.
+
 ## License
 
 MIT
@@ -300,3 +311,7 @@ Contributions are welcome! Please open an issue or submit a pull request.
 ## Author
 
 Created with ❤️ for the React Native community
+
+## Keywords
+
+React Native PDF viewer, PDF reader, large PDF, PDF annotations, PDF rendering, iOS PDF, Android PDF, fast PDF viewer

package/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

package/android/build.gradle

@@ -53,5 +53,5 @@ repositories {
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib:${safeExtGet('kotlinVersion', '1.9.0')}"
     implementation "com.facebook.react:react-android:+"
-    implementation "com.tom-roush:pdfbox-android:2.0.27.0"
+    implementation "io.legere:pdfiumandroid:1.0.32"
 }