react-native-optimized-pdf 1.0.0

package/.eslintrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+  root: true,
+  extends: ['@react-native-community'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  rules: {
+    'react-hooks/exhaustive-deps': 'warn',
+    '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+    'react-native/no-inline-styles': 'off',
+  },
+};

package/.prettierrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  arrowParens: 'always',
+  bracketSameLine: false,
+  bracketSpacing: true,
+  singleQuote: true,
+  trailingComma: 'all',
+  semi: true,
+  tabWidth: 2,
+  printWidth: 100,
+};

package/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+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]
+
+### 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
+
+### 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
+
+### Fixed
+
+- Memory leaks in useEffect cleanup
+- Proper file:// protocol handling
+- Cache validation logic

package/CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing to React Native Optimized PDF
+
+Thank you for considering contributing to this project! Here are some guidelines to help you get started.
+
+## Development Setup
+
+1. Clone the repository
+
+```bash
+git clone https://github.com/yourusername/react-native-optimized-pdf.git
+cd react-native-optimized-pdf
+```
+
+2. Install dependencies
+
+```bash
+yarn install
+```
+
+3. Install pods (iOS)
+
+```bash
+cd ios && pod install
+```
+
+## Project Structure
+
+```
+react-native-optimized-pdf/
+├── src/
+│   ├── components/          # Reusable UI components
+│   │   ├── PdfNavigationControls.tsx
+│   │   └── PdfOverlays.tsx
+│   ├── services/           # Business logic and utilities
+│   │   └── pdfCache.ts
+│   ├── types/              # TypeScript type definitions
+│   │   └── index.ts
+│   ├── constants.ts        # App constants
+│   ├── OptimizedPdfView.tsx  # Main component
+│   └── index.ts            # Public exports
+├── ios/                    # Native iOS implementation
+├── index.ts                # Package entry point
+└── index.d.ts              # TypeScript declarations
+```
+
+## Code Style
+
+- Use TypeScript for all new code
+- Follow the existing code style (use Prettier and ESLint)
+- Add JSDoc comments for public APIs
+- Write meaningful commit messages
+
+## Testing
+
+Before submitting a PR:
+
+1. Test on a real iOS device or simulator
+2. Verify TypeScript types compile without errors
+3. Check that all exports work correctly
+4. Test with various PDF sources (local, remote, large files)
+
+## Pull Request Process
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Reporting Issues
+
+When reporting issues, please include:
+
+- React Native version
+- iOS version
+- Device/simulator information
+- Steps to reproduce
+- Expected vs actual behavior
+- Error messages or logs
+
+## Feature Requests
+
+We welcome feature requests! Please open an issue and describe:
+
+- The use case
+- Why this would be useful
+- Any implementation ideas
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

package/README.md

@@ -0,0 +1,302 @@
+# 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.
+
+## 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
+
+## Installation
+
+```bash
+npm install react-native-optimized-pdf
+# or
+yarn add react-native-optimized-pdf
+```
+
+### iOS Setup
+
+```bash
+cd ios && pod install
+```
+
+### Android Setup
+
+No additional setup required! The module will be automatically linked.
+
+## Usage
+
+### Basic Example
+
+```tsx
+import OptimizedPdfView from 'react-native-optimized-pdf';
+
+function App() {
+  return (
+    <OptimizedPdfView source={{ uri: 'https://example.com/sample.pdf' }} style={{ flex: 1 }} />
+  );
+}
+```
+
+### Advanced Example with All Options
+
+```tsx
+import OptimizedPdfView from 'react-native-optimized-pdf';
+
+function App() {
+  return (
+    <OptimizedPdfView
+      source={{
+        uri: 'https://example.com/sample.pdf',
+        cache: true,
+        cacheFileName: 'my-custom-file.pdf',
+        expiration: 86400, // 24 hours in seconds
+        headers: {
+          Authorization: 'Bearer token',
+        },
+      }}
+      maximumZoom={5}
+      enableAntialiasing={true}
+      showNavigationControls={true}
+      style={{ flex: 1 }}
+      onLoadComplete={(page, dimensions) => {
+        console.log(`Loaded page ${page}`, dimensions);
+      }}
+      onPageCount={(count) => {
+        console.log(`Total pages: ${count}`);
+      }}
+      onPageChange={(page) => {
+        console.log(`Changed to page ${page}`);
+      }}
+      onError={(error) => {
+        console.error('PDF Error:', error.nativeEvent.message);
+      }}
+    />
+  );
+}
+```
+
+### Password Protected PDF
+
+```tsx
+import OptimizedPdfView from 'react-native-optimized-pdf';
+import { useState } from 'react';
+
+function App() {
+  const [password, setPassword] = useState('');
+  const [showPasswordPrompt, setShowPasswordPrompt] = useState(false);
+
+  return (
+    <>
+      <OptimizedPdfView
+        source={{ uri: 'https://example.com/protected.pdf' }}
+        password={password}
+        onPasswordRequired={() => {
+          setShowPasswordPrompt(true);
+        }}
+        onError={(error) => {
+          if (error.nativeEvent.message.includes('Invalid password')) {
+            alert('Wrong password, please try again');
+          }
+        }}
+        style={{ flex: 1 }}
+      />
+      {/* Your password input modal */}
+    </>
+  );
+}
+```
+
+### Custom Navigation Controls
+
+```tsx
+import OptimizedPdfView from 'react-native-optimized-pdf';
+import { useState } from 'react';
+import { View, Text } from 'react-native';
+
+function App() {
+  const [currentPage, setCurrentPage] = useState(0);
+  const [totalPages, setTotalPages] = useState(1);
+
+  return (
+    <View style={{ flex: 1 }}>
+      <OptimizedPdfView
+        source={{ uri: 'https://example.com/sample.pdf' }}
+        showNavigationControls={false}
+        onPageCount={setTotalPages}
+        onPageChange={setCurrentPage}
+        style={{ flex: 1 }}
+      />
+
+      {/* Your custom navigation UI */}
+      <Text>
+        Page {currentPage + 1} of {totalPages}
+      </Text>
+    </View>
+  );
+}
+```
+
+### Using Cache Service Directly
+
+```tsx
+import { PdfCacheService } from 'react-native-optimized-pdf';
+
+// Clear specific cache
+await PdfCacheService.clearCache({ uri: 'https://example.com/file.pdf' });
+
+// Clear all cached PDFs
+await PdfCacheService.clearAllCache();
+
+// Get cache size in bytes
+const size = await PdfCacheService.getCacheSize();
+console.log(`Cache size: ${size / 1024 / 1024} MB`);
+
+// Check if cache is valid
+const isValid = await PdfCacheService.isCacheValid({
+  uri: 'https://example.com/file.pdf',
+  expiration: 3600,
+});
+```
+
+## API Reference
+
+### OptimizedPdfView Props
+
+| Prop                     | Type                                                    | Default      | Description                            |
+| ------------------------ | ------------------------------------------------------- | ------------ | -------------------------------------- |
+| `source`                 | `PdfSource`                                             | **required** | PDF source configuration               |
+| `password`               | `string`                                                | -            | Password for encrypted PDF files       |
+| `maximumZoom`            | `number`                                                | `3`          | Maximum zoom level                     |
+| `enableAntialiasing`     | `boolean`                                               | `true`       | Enable antialiasing for better quality |
+| `showNavigationControls` | `boolean`                                               | `true`       | Show built-in navigation controls      |
+| `style`                  | `ViewStyle`                                             | -            | Container style                        |
+| `onLoadComplete`         | `(page: number, dimensions: PdfPageDimensions) => void` | -            | Called when PDF loads                  |
+| `onPageCount`            | `(count: number) => void`                               | -            | Called when page count is available    |
+| `onPageChange`           | `(page: number) => void`                                | -            | Called when page changes               |
+| `onError`                | `(error: PdfErrorEvent) => void`                        | -            | Called on error                        |
+| `onPasswordRequired`     | `() => void`                                            | -            | Called when PDF requires a password    |
+
+### PdfSource
+
+| Property        | Type                     | Default      | Description                                                  |
+| --------------- | ------------------------ | ------------ | ------------------------------------------------------------ |
+| `uri`           | `string`                 | **required** | PDF file URI (remote URL or local path)                      |
+| `cache`         | `boolean`                | `true`       | Enable local caching                                         |
+| `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                                    |
+
+### PdfCacheService
+
+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
+- `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
+
+## Components
+
+### PdfNavigationControls
+
+Reusable navigation controls component:
+
+```tsx
+import { PdfNavigationControls } from 'react-native-optimized-pdf';
+
+<PdfNavigationControls
+  currentPage={0}
+  totalPages={10}
+  onNextPage={() => {}}
+  onPrevPage={() => {}}
+  onPageChange={(page) => {}}
+/>;
+```
+
+### 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 |
+| -------- | --------- | ----------- |
+| iOS      | ✅ Yes    | iOS 12.0+   |
+| Android  | ✅ Yes    | API 24+     |
+
+## Performance Tips
+
+1. **Enable caching** for remote PDFs to avoid re-downloading
+2. **Set cache expiration** for frequently updated documents
+3. **Use custom cache filenames** for better cache management
+4. **Monitor cache size** and clear old files periodically
+5. **Adjust maximum zoom** based on your needs (lower = better performance)
+6. **Hide navigation controls** if implementing custom UI
+
+## Troubleshooting
+
+### PDF not loading
+
+- Check that the URI is accessible
+- Verify network permissions for remote URLs
+- Check console for error messages
+- Ensure file format is valid PDF
+
+### High memory usage
+
+- Reduce `maximumZoom` value
+- Clear cache periodically
+- Use smaller PDF files when possible
+
+### Cache not working
+
+- Verify write permissions
+- Check available storage space
+- Ensure `cache` is not set to `false`
+
+### Password protected PDF not opening
+
+- Use `onPasswordRequired` callback to prompt user for password
+- Pass the password via the `password` prop
+- Check for "Invalid password" in error message to show retry prompt
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## Author
+
+Created with ❤️ for the React Native community

package/ReactNativeOptimizedPdf.podspec

@@ -0,0 +1,21 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name         = "ReactNativeOptimizedPdf"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.description  = <<-DESC
+                  High-performance PDF viewer for React Native
+                   DESC
+  s.homepage     = "https://github.com/your-username/react-native-optimized-pdf"
+  s.license      = "MIT"
+  s.author       = { "Your Name" => "your-email@example.com" }
+  s.platform     = :ios, "12.0"
+  s.source       = { :git => "https://github.com/your-username/react-native-optimized-pdf.git", :tag => "#{s.version}" }
+  s.source_files = "ios/*.{swift,h,m}"
+  s.requires_arc = true
+  s.swift_version = "5.0"
+  s.dependency "React-Core"
+end

package/android/build.gradle

@@ -0,0 +1,57 @@
+buildscript {
+    ext.safeExtGet = {prop, fallback ->
+        rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+    }
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${safeExtGet('kotlinVersion', '1.9.0')}")
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+android {
+    namespace "com.reactnativeoptimizedpdf"
+    compileSdkVersion safeExtGet('compileSdkVersion', 36)
+
+    defaultConfig {
+        minSdkVersion safeExtGet('minSdkVersion', 24)
+        targetSdkVersion safeExtGet('targetSdkVersion', 36)
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+
+    kotlinOptions {
+        jvmTarget = '17'
+    }
+
+    sourceSets {
+        main {
+            java.srcDirs = ['src/main/kotlin']
+        }
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+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"
+}

package/android/proguard-rules.pro

@@ -0,0 +1,10 @@
+# React Native Optimized PDF - ProGuard Rules
+
+# Keep the native view classes
+-keep class com.reactnativeoptimizedpdf.** { *; }
+
+# Keep React Native classes
+-keep class com.facebook.react.** { *; }
+
+# Keep PDF Renderer
+-keep class android.graphics.pdf.** { *; }

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.reactnativeoptimizedpdf">
+</manifest>