cordova-plugin-hot-updates 2.2.2 → 2.3.0

package/README.md

@@ -1,32 +1,34 @@
-# Cordova Hot Updates Plugin v2.2.2
+# Cordova Hot Updates Plugin v2.3.0
 
-Frontend-controlled manual hot updates for Cordova iOS applications using WebView Reload approach.
-
-## Changelog
-
-### v2.2.2 (2024-11-28)
-- **Fixed**: Failed download no longer corrupts previously downloaded update
-- **Fixed**: Infinite loop when pending update installation fails (flags now cleared)
-- **Fixed**: UserDefaults now saved only after successful download (not before)
-- **Improved**: ZIP file validation with magic bytes check (PK\x03\x04) before extraction
-- **Improved**: Cleaner logs without duplicates and full paths
-- **Improved**: All errors now have consistent format with `ERROR:` prefix
-- **Removed**: Redundant initialization code
+Frontend-controlled manual hot updates for Cordova **iOS and Android** applications using WebView Reload approach.
 
 [![npm version](https://badge.fury.io/js/cordova-plugin-hot-updates.svg)](https://badge.fury.io/js/cordova-plugin-hot-updates)
 [![License](https://img.shields.io/badge/License-Custom%20Non--Commercial-blue.svg)](#license)
+[![Platforms](https://img.shields.io/badge/platforms-iOS%20%7C%20Android-lightgrey.svg)](#platform-support)
+
+This plugin enables **manual, JavaScript-controlled** web content updates for your Cordova applications without requiring App Store/Google Play approval. Your frontend code decides when to check, download, and install updates.
+
+## Platform Support
+
+| Platform | Version | Status | Notes |
+|----------|---------|--------|-------|
+| iOS | 2.1.2+ | Stable | Requires CocoaPods for SSZipArchive |
+| Android | 2.3.0+ | Stable | Built-in ZIP support, no external dependencies |
 
-This plugin enables **manual, JavaScript-controlled** web content updates for your Cordova iOS applications without requiring App Store approval. Your frontend code decides when to check, download, and install updates.
+Both platforms provide 100% API compatibility. The same JavaScript code works on both iOS and Android.
 
 ## Features
 
-- **Frontend Control**: JavaScript decides when to update (no automatic background checking)
-- **Two-Step Updates**: Separate download (`getUpdate`) and install (`forceUpdate`) for better UX
-- **Auto-Install on Launch**: If user ignores update prompt, it installs on next app launch
-- **Canary System**: Automatic rollback if update fails to load (20-second timeout)
-- **IgnoreList**: Tracks problematic versions (information only, does NOT block installation)
-- **Instant Effect**: WebView Reload approach - no app restart needed
-- **Cache Management**: Clears WKWebView cache (disk, memory, Service Worker) before reload
+- **Cross-Platform** - Full support for iOS and Android with 100% API compatibility
+- **Frontend Control** - JavaScript decides when to update (no automatic background checking)
+- **Two-Step Updates** - Separate download and install methods for better UX control
+- **Auto-Install on Launch** - If user ignores update prompt, it installs on next app launch
+- **Canary System** - Automatic rollback if update fails to load (20-second timeout)
+- **IgnoreList** - Tracks problematic versions (information only, does not block installation)
+- **Version History** - Tracks successful versions for progressive data migrations
+- **Instant Effect** - WebView Reload approach, no app restart required
+- **Cache Management** - iOS clears WKWebView cache; Android uses LOAD_NO_CACHE mode
+- **Security** - ZIP magic bytes validation on both platforms
 
 ## Installation
 
@@ -34,9 +36,12 @@ This plugin enables **manual, JavaScript-controlled** web content updates for yo
 # Install from npm
 cordova plugin add cordova-plugin-hot-updates
 
-# Install CocoaPods dependencies (required)
+# For iOS: Install CocoaPods dependencies (required)
 cd platforms/ios
 pod install
+cd ../..
+
+# For Android: No additional dependencies needed!
 ```
 
 Or install from local directory:
@@ -52,11 +57,25 @@ cordova plugin add https://github.com/vladimirDarksy/Cordova_hot_update.git
 ```
 
 **Requirements:**
+
+**iOS:**
 - Cordova >= 7.0.0
 - cordova-ios >= 4.4.0
-- iOS >= 11.2
+- iOS >= 12.0
 - CocoaPods (for SSZipArchive dependency)
 
+**Android:**
+- Cordova >= 7.0.0
+- cordova-android >= 9.0.0
+- Android >= 7.0 (API 24)
+- No external dependencies (uses built-in `java.util.zip`)
+
+**Automatic Configuration:**
+
+The plugin automatically configures required settings during installation:
+- iOS: NSAppTransportSecurity for HTTP connections
+- Android: file scheme, AndroidInsecureFileModeEnabled, LoadUrlTimeoutValue
+
 ## Quick Start
 
 ### 1. Minimal Integration
@@ -279,6 +298,58 @@ window.hotUpdate.getIgnoreList(function(result) {
 
 ---
 
+### window.hotUpdate.getVersionHistory(callback)
+
+Returns list of all successfully installed versions (excluding rolled back ones).
+
+**New in v2.2.3** - Enables progressive data migrations.
+
+When internal data structure changes, you may need to run migrations. This method returns the version history so your app can determine which migrations to run.
+
+**Key behaviors:**
+- **Automatically initialized** with `appBundleVersion` on first launch
+- **Added to history** when update is successfully installed
+- **Removed from history** when version is rolled back (failed canary)
+- **Excludes ignoreList** - only contains successful versions
+
+**Parameters:**
+- `callback` (Function) - `callback(result)`
+  - `result`: `{versions: string[]}` - Array of successful version strings
+
+**Example:**
+```javascript
+window.hotUpdate.getVersionHistory(function(result) {
+    console.log('Version history:', result.versions);
+    // Example: ["2.7.7", "2.7.8", "2.7.9"]
+
+    // Run migrations based on version progression
+    result.versions.forEach((version, index) => {
+        if (index > 0) {
+            const from = result.versions[index - 1];
+            const to = version;
+            runMigration(from, to);
+        }
+    });
+});
+```
+
+**Use Case:**
+```javascript
+// Check for missed critical versions
+window.hotUpdate.getVersionHistory(function(result) {
+    const criticalVersions = ['2.8.0', '3.0.0']; // Versions with important migrations
+    const missed = criticalVersions.filter(v => !result.versions.includes(v));
+
+    if (missed.length > 0) {
+        console.warn('User skipped critical versions:', missed);
+        // Run all missed critical migrations
+        missed.forEach(v => runCriticalMigration(v));
+    }
+});
+```
+
+---
+
 ### window.hotUpdate.getVersionInfo(callback)
 
 Returns version information (debug method).
@@ -384,8 +455,18 @@ document.addEventListener('deviceready', function() {
 
 ### Storage Structure
 
+**iOS:**
 ```
-Documents/
+~/Library/Application Support/[Bundle ID]/Documents/
+├── www/                    // Active version
+├── www_previous/           // Previous version (rollback)
+├── pending_update/         // Next launch auto-install
+└── temp_downloaded_update/ // Immediate install
+```
+
+**Android:**
+```
+/data/data/[package.name]/files/
 ├── www/                    // Active version
 ├── www_previous/           // Previous version (rollback)
 ├── pending_update/         // Next launch auto-install
@@ -394,7 +475,7 @@ Documents/
 
 ### Version Management
 
-- **appBundleVersion** - Native app version from Info.plist
+- **appBundleVersion** - Native app version (Info.plist / build.gradle)
 - **installedVersion** - Current hot update version
 - **previousVersion** - Last working version (rollback)
 
@@ -405,12 +486,13 @@ Your server should provide:
 **Check API:**
 ```
 GET https://your-server.com/api/check-update?version=1.0.0&platform=ios
+GET https://your-server.com/api/check-update?version=1.0.0&platform=android
 
 Response:
 {
   "hasUpdate": true,
   "version": "2.0.0",
-  "downloadUrl": "https://your-server.com/updates/2.0.0.zip",
+  "downloadUrl": "https://your-server.com/updates/ios/2.0.0.zip",
   "minAppVersion": "2.7.0",
   "releaseNotes": "Bug fixes"
 }
@@ -475,7 +557,9 @@ window.hotUpdate.canary(version);
 
 - Check ZIP structure (must have `www/` folder)
 - Check URL accessibility
-- Check Xcode console: `[HotUpdates] ...`
+- Check logs:
+  - iOS: Xcode console `[HotUpdates] ...`
+  - Android: `adb logcat -s HotUpdates:*`
 
 ### Automatic rollback
 
@@ -499,6 +583,86 @@ document.addEventListener('deviceready', function() {
 }, false);
 ```
 
+## Platform-Specific Notes
+
+### iOS
+
+**Technologies:**
+- `NSUserDefaults` for metadata storage
+- `NSTimer` for canary timer (20 seconds)
+- `SSZipArchive` (CocoaPods) for ZIP extraction
+- `WKWebView` with `loadFileURL()`
+
+**Specifics:**
+- Always loads from `file://` scheme
+- ZIP magic bytes validation
+- Cache clearing: disk, memory, Service Worker
+
+### Android
+
+**Technologies:**
+- `SharedPreferences` for metadata storage
+- `Handler + Runnable` for canary timer (20 seconds)
+- `java.util.zip` (built-in) for ZIP extraction
+- `CordovaWebView` with `loadUrlIntoView()`
+
+**Specifics:**
+- Starts from `https://localhost/`, switches to `file://` after update
+- ZIP magic bytes validation
+- Cache management: `LOAD_NO_CACHE` mode
+- WebView file access automatically configured
+
+**Code Structure:**
+- `HotUpdates.java` - Main plugin class (700 lines)
+- `HotUpdatesHelpers.java` - Utility methods (350 lines)
+- `HotUpdatesConstants.java` - Constants (100 lines)
+
+## Testing
+
+### iOS Testing (Safari Web Inspector)
+
+```bash
+# On device: Settings → Safari → Advanced → Web Inspector (ON)
+# On Mac: Safari → Develop → [Device Name] → [App Name]
+
+# In console:
+hotUpdate.getVersionInfo(console.log)
+hotUpdate.canary('1.0.0', console.log)
+```
+
+### Android Testing (Chrome DevTools)
+
+```bash
+# 1. Connect device/emulator
+adb devices
+
+# 2. Open Chrome: chrome://inspect
+
+# 3. Find WebView and click "inspect"
+
+# 4. In console:
+hotUpdate.getVersionInfo(console.log)
+hotUpdate.canary('1.0.0', console.log)
+
+# 5. View logs:
+adb logcat -s HotUpdates:* -v time
+```
+
+## What's New in 2.3.0
+
+### Android Support
+
+Version 2.3.0 adds full Android platform support with the following features:
+
+- Complete Android implementation with 100% iOS API compatibility
+- Same JavaScript interface works on both platforms
+- No external dependencies (uses built-in java.util.zip)
+- Automatic configuration of file scheme and preferences
+- ZIP magic bytes validation for security
+- WebView cache management (LOAD_NO_CACHE mode)
+
+For complete version history, see [CHANGELOG.md](CHANGELOG.md).
+
 ## License
 
 Custom Non-Commercial License - See [LICENSE](LICENSE) file

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "cordova-plugin-hot-updates",
-  "version": "2.2.2",
-  "description": "Frontend-controlled manual hot updates for Cordova iOS apps using WebView Reload approach. Manual updates only, JavaScript controls all decisions.",
+  "version": "2.3.0",
+  "description": "Frontend-controlled manual hot updates for Cordova iOS and Android apps using WebView Reload approach. Manual updates only, JavaScript controls all decisions. 100% API compatibility between platforms.",
   "main": "www/HotUpdates.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "prepublishOnly": "npm run verify",
-    "verify": "node -e \"console.log('Verifying package structure...'); const fs = require('fs'); ['www/HotUpdates.js', 'src/ios/HotUpdates.h', 'src/ios/HotUpdates.m', 'src/ios/HotUpdatesConstants.h', 'src/ios/HotUpdatesConstants.m', 'src/ios/HotUpdates+Helpers.h', 'src/ios/HotUpdates+Helpers.m', 'plugin.xml', 'LICENSE', 'README.md'].forEach(f => { if (!fs.existsSync(f)) throw new Error('Missing required file: ' + f); }); console.log('✓ All required files present');\"",
+    "verify": "node -e \"console.log('Verifying package structure...'); const fs = require('fs'); ['www/HotUpdates.js', 'src/ios/HotUpdates.h', 'src/ios/HotUpdates.m', 'src/ios/HotUpdatesConstants.h', 'src/ios/HotUpdatesConstants.m', 'src/ios/HotUpdates+Helpers.h', 'src/ios/HotUpdates+Helpers.m', 'src/android/HotUpdates.java', 'src/android/HotUpdatesHelpers.java', 'src/android/HotUpdatesConstants.java', 'plugin.xml', 'LICENSE', 'README.md'].forEach(f => { if (!fs.existsSync(f)) throw new Error('Missing required file: ' + f); }); console.log('✓ All required files present');\"",
     "pack-test": "npm pack && echo '\n✓ Package created. Test installation with: cordova plugin add ./cordova-plugin-hot-updates-*.tgz'",
     "preversion": "npm run verify",
     "postversion": "git push && git push --tags"
@@ -26,8 +26,10 @@
     "manual",
     "ecosystem:cordova",
     "cordova-ios",
+    "cordova-android",
     "mobile",
-    "app"
+    "app",
+    "cross-platform"
   ],
   "author": {
     "name": "Mustafin Vladimir",
@@ -45,15 +47,18 @@
   "cordova": {
     "id": "cordova-plugin-hot-updates",
     "platforms": [
-      "ios"
+      "ios",
+      "android"
     ]
   },
   "peerDependencies": {
-    "cordova-ios": ">=4.4.0"
+    "cordova-ios": ">=4.4.0",
+    "cordova-android": ">=9.0.0"
   },
   "devDependencies": {
     "cordova": "^12.0.0",
-    "cordova-ios": "^7.0.0"
+    "cordova-ios": "^7.0.0",
+    "cordova-android": "^12.0.0"
   },
   "files": [
     "www/",

package/plugin.xml

@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='utf-8'?>
 <plugin id="cordova-plugin-hot-updates"
-        version="2.2.2"
+        version="2.3.0"
         xmlns="http://apache.org/cordova/ns/plugins/1.0"
         xmlns:android="http://schemas.android.com/apk/res/android">
 
@@ -8,10 +8,10 @@
     <description>
         Cordova plugin for frontend-controlled manual hot updates using WebView Reload approach.
         Manual updates only, JavaScript controls all decisions.
-        Enables seamless web content updates without requiring App Store approval.
+        Supports iOS and Android with 100% API compatibility.
     </description>
     <license>Custom Non-Commercial</license>
-    <keywords>cordova,hot,updates,ota,over-the-air,webview,reload,manual</keywords>
+    <keywords>cordova,hot,updates,ota,over-the-air,webview,reload,manual,ios,android</keywords>
     <repo>https://github.com/vladimirDarksy/Cordova_hot_update.git</repo>
     <issue>https://github.com/vladimirDarksy/Cordova_hot_update/issues</issue>
 
@@ -20,6 +20,7 @@
     <engines>
         <engine name="cordova" version=">=7.0.0" />
         <engine name="cordova-ios" version=">=4.4.0" />
+        <engine name="cordova-android" version=">=9.0.0" />
     </engines>
 
     <!-- JavaScript interface -->
@@ -69,10 +70,30 @@
         </edit-config>
     </platform>
 
-    <!-- Android platform (placeholder for future implementation) -->
+    <!-- Android platform -->
     <platform name="android">
-        <!-- Android implementation would go here -->
-        <!-- For now, this plugin only supports iOS -->
+        <!-- Plugin configuration -->
+        <config-file target="res/xml/config.xml" parent="/*">
+            <feature name="HotUpdates">
+                <param name="android-package" value="com.getmeback.hotupdates.HotUpdates" />
+                <param name="onload" value="true" />
+            </feature>
+        </config-file>
+
+        <!-- Native Android files -->
+        <source-file src="src/android/HotUpdates.java"
+                     target-dir="src/com/getmeback/hotupdates" />
+        <source-file src="src/android/HotUpdatesHelpers.java"
+                     target-dir="src/com/getmeback/hotupdates" />
+        <source-file src="src/android/HotUpdatesConstants.java"
+                     target-dir="src/com/getmeback/hotupdates" />
+
+        <!-- Critical preferences for file:// scheme support -->
+        <config-file target="res/xml/config.xml" parent="/*">
+            <preference name="scheme" value="file" />
+            <preference name="AndroidInsecureFileModeEnabled" value="true" />
+            <preference name="LoadUrlTimeoutValue" value="120000" />
+        </config-file>
     </platform>
 
     <!-- Plugin hooks (optional) -->