cordova-plugin-hot-updates 1.0.0

package/LICENSE

@@ -0,0 +1,193 @@
+                    CUSTOM NON-COMMERCIAL LICENSE
+                           Version 1.0, 2025
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (which shall not include communications that are expressly excluded
+      from License by an express written agreement by the copyright owner).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based upon (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and derivative works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control
+      systems, and issue tracking systems that are managed by, or on behalf
+      of, the Licensor for the purpose of discussing and improving the Work,
+      but excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to use, reproduce, modify, distribute, and otherwise
+      create derivative works from the contents of the Work, EXCLUSIVELY FOR
+      NON-COMMERCIAL PURPOSES ONLY.
+
+      COMMERCIAL USE IS STRICTLY PROHIBITED without explicit written
+      permission from the copyright holder. Commercial use includes, but is
+      not limited to: selling, licensing for profit, using in commercial
+      products or services, or any use that generates revenue.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, trademark, patent,
+          attribution and other notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright notice to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. When redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Mustafin Vladimir
+
+   This software is licensed under the Custom Non-Commercial License.
+   You may use, modify, and distribute this software for NON-COMMERCIAL
+   purposes only. Any commercial use is strictly prohibited without
+   explicit written permission from the copyright holder.
+
+   For commercial licensing inquiries, please contact: Mustafin Vladimir
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under this License is provided on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

package/README.md

@@ -0,0 +1,487 @@
+# Cordova Hot Updates Plugin
+
+🔥 **Automatic over-the-air (OTA) hot updates for Cordova 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)
+
+This plugin enables seamless web content updates for your Cordova iOS applications without requiring App Store approval. Updates are downloaded in the background and applied automatically on the next app launch.
+
+## 🚀 Key Features
+
+- **🔄 Automatic Background Updates**: Continuously checks for and downloads updates
+- **⚡ Instant Application**: WebView Reload approach for immediate effect
+- **📦 Semantic Versioning**: Smart version comparison and compatibility checks
+- **🛡️ Rollback Support**: Automatic fallback on corrupted updates
+- **⚙️ Configurable**: Customizable server URLs and check intervals
+- **🎯 Zero Configuration**: Works out of the box with sensible defaults
+
+## 📋 Table of Contents
+
+- [Installation](#-installation)
+- [Quick Start](#-quick-start)
+- [Configuration](#-configuration)
+- [API Reference](#-api-reference)
+- [Server Implementation](#-server-implementation)
+- [How It Works](#-how-it-works)
+- [Troubleshooting](#-troubleshooting)
+- [Contributing](#-contributing)
+- [License](#-license)
+
+## 📦 Installation
+
+### Standard Installation (Recommended)
+
+```bash
+# Install from npm registry
+cordova plugin add cordova-plugin-hot-updates
+
+# Install CocoaPods dependencies (iOS)
+cd platforms/ios
+pod install
+```
+
+### Alternative Installation Methods
+
+```bash
+# Install from GitHub
+cordova plugin add https://github.com/vladimirDarksy/Cordova_hot_update.git
+
+# Install from local path
+cordova plugin add /path/to/cordova-plugin-hot-updates
+
+# Install specific version
+cordova plugin add cordova-plugin-hot-updates@1.0.0
+```
+
+### Installation with pnpm
+
+If your project uses pnpm, you may need additional configuration:
+
+1. Create or update `.npmrc` in your project root:
+
+```
+public-hoist-pattern[]=cordova-plugin-*
+shamefully-hoist=true
+auto-install-peers=true
+```
+
+2. Then install the plugin:
+
+```bash
+cordova plugin add cordova-plugin-hot-updates
+```
+
+**Note**: Cordova CLI internally uses npm, which can sometimes conflict with pnpm's node_modules structure. The above configuration helps resolve this.
+
+## 🚀 Quick Start
+
+### 1. Configure Your Server URL
+
+Add to your `config.xml`:
+
+```xml
+<preference name="hot_updates_server_url" value="https://your-server.com/api/updates" />
+<preference name="hot_updates_check_interval" value="300000" />
+```
+
+### 2. Basic Usage
+
+```javascript
+// Check current version
+HotUpdates.getCurrentVersion(
+  function(version) {
+    console.log('Current version:', version);
+  },
+  function(error) {
+    console.error('Error:', error);
+  }
+);
+
+// Check for pending updates
+HotUpdates.getPendingUpdateInfo(
+  function(info) {
+    if (info.hasPendingUpdate) {
+      console.log('Update ready:', info.pendingVersion);
+      alert('New update will be applied on next app restart');
+    }
+  },
+  function(error) {
+    console.error('Error:', error);
+  }
+);
+
+// Manually check for updates
+HotUpdates.checkForUpdates(
+  function(result) {
+    if (result.hasUpdate) {
+      console.log('Update available:', result.availableVersion);
+      // Optionally download manually
+      HotUpdates.downloadUpdate(
+        result.downloadURL,
+        result.availableVersion,
+        function() {
+          console.log('Download completed');
+        },
+        function(error) {
+          console.error('Download failed:', error);
+        }
+      );
+    }
+  },
+  function(error) {
+    console.error('Check failed:', error);
+  }
+);
+```
+
+## ⚙️ Configuration
+
+### config.xml Preferences
+
+| Preference | Default | Description |
+|------------|---------|-------------|
+| `hot_updates_server_url` | `https://your-server.com/api/updates` | Update server endpoint |
+| `hot_updates_check_interval` | `300000` | Check interval in milliseconds (5 minutes) |
+| `hot_updates_auto_download` | `true` | Enable automatic download |
+| `hot_updates_auto_install` | `true` | Enable automatic installation on restart |
+
+### Example Configuration
+
+```xml
+<widget id="com.yourcompany.yourapp" version="1.0.0">
+  <!-- Hot Updates Configuration -->
+  <preference name="hot_updates_server_url" value="https://updates.yourapp.com/api/check" />
+  <preference name="hot_updates_check_interval" value="600000" />
+  <preference name="hot_updates_auto_download" value="true" />
+  <preference name="hot_updates_auto_install" value="true" />
+
+  <!-- Your other configurations... -->
+</widget>
+```
+
+## 📚 API Reference
+
+### Methods
+
+#### `getCurrentVersion(successCallback, errorCallback)`
+
+Gets the currently active version string.
+
+```javascript
+HotUpdates.getCurrentVersion(
+  function(version) {
+    console.log('Current version:', version); // "1.2.3"
+  },
+  function(error) {
+    console.error('Error getting version:', error);
+  }
+);
+```
+
+#### `getPendingUpdateInfo(successCallback, errorCallback)`
+
+Gets information about downloaded updates waiting to be installed.
+
+```javascript
+HotUpdates.getPendingUpdateInfo(
+  function(info) {
+    // info object contains:
+    // - hasPendingUpdate: boolean
+    // - pendingVersion: string
+    // - appBundleVersion: string
+    // - installedVersion: string
+    // - message: string
+  },
+  function(error) {
+    console.error('Error getting update info:', error);
+  }
+);
+```
+
+#### `checkForUpdates(successCallback, errorCallback)`
+
+Manually triggers an update check.
+
+```javascript
+HotUpdates.checkForUpdates(
+  function(result) {
+    // result object contains:
+    // - hasUpdate: boolean
+    // - currentVersion: string
+    // - availableVersion: string (if hasUpdate is true)
+    // - downloadURL: string (if hasUpdate is true)
+    // - minAppVersion: string (if specified)
+  },
+  function(error) {
+    console.error('Update check failed:', error);
+  }
+);
+```
+
+#### `downloadUpdate(downloadURL, version, successCallback, errorCallback, progressCallback)`
+
+Manually downloads a specific update.
+
+```javascript
+HotUpdates.downloadUpdate(
+  'https://server.com/updates/v2.0.0.zip',
+  '2.0.0',
+  function() {
+    console.log('Download completed');
+  },
+  function(error) {
+    console.error('Download failed:', error);
+  },
+  function(progress) {
+    console.log('Download progress:', progress + '%');
+  }
+);
+```
+
+#### `getConfiguration(successCallback, errorCallback)`
+
+Gets the current plugin configuration.
+
+```javascript
+HotUpdates.getConfiguration(
+  function(config) {
+    // config object contains:
+    // - serverURL: string
+    // - checkInterval: number (milliseconds)
+    // - appBundleVersion: string
+    // - autoDownload: boolean
+  },
+  function(error) {
+    console.error('Error getting config:', error);
+  }
+);
+```
+
+## 🖥️ Server Implementation
+
+Your update server should implement the following API:
+
+### Check for Updates Endpoint
+
+**GET** `/check?version={currentVersion}&platform=ios`
+
+**Response** (when update available):
+```json
+{
+  "hasUpdate": true,
+  "version": "1.2.0",
+  "downloadURL": "https://yourserver.com/updates/v1.2.0.zip",
+  "minAppVersion": "1.0.0",
+  "releaseNotes": "Bug fixes and improvements"
+}
+```
+
+**Response** (when no update available):
+```json
+{
+  "hasUpdate": false,
+  "message": "No updates available"
+}
+```
+
+### Update Package Format
+
+Your update ZIP file should contain a `www` folder with your web content:
+
+```
+update.zip
+└── www/
+    ├── index.html
+    ├── js/
+    ├── css/
+    ├── img/
+    └── ...
+```
+
+### Example Server Implementation (Node.js)
+
+```javascript
+const express = require('express');
+const app = express();
+
+app.get('/api/updates/check', (req, res) => {
+  const { version, platform } = req.query;
+  const currentVersion = version || '1.0.0';
+  const latestVersion = '1.2.0'; // Your latest version
+
+  if (compareVersions(currentVersion, latestVersion) < 0) {
+    res.json({
+      hasUpdate: true,
+      version: latestVersion,
+      downloadURL: `https://yourserver.com/updates/v${latestVersion}.zip`,
+      minAppVersion: '1.0.0',
+      releaseNotes: 'Bug fixes and improvements'
+    });
+  } else {
+    res.json({
+      hasUpdate: false,
+      message: 'No updates available'
+    });
+  }
+});
+
+function compareVersions(version1, version2) {
+  const v1parts = version1.split('.').map(Number);
+  const v2parts = version2.split('.').map(Number);
+
+  for (let i = 0; i < Math.max(v1parts.length, v2parts.length); i++) {
+    const v1part = v1parts[i] || 0;
+    const v2part = v2parts[i] || 0;
+
+    if (v1part < v2part) return -1;
+    if (v1part > v2part) return 1;
+  }
+
+  return 0;
+}
+
+app.listen(3000, () => {
+  console.log('Update server running on port 3000');
+});
+```
+
+## 🔧 How It Works
+
+### WebView Reload Approach
+
+1. **Startup Check**: On app launch, the plugin checks for pending updates
+2. **Installation**: If found, updates are installed to `Documents/www`
+3. **WebView Switch**: The WebView is configured to load from `Documents/www` instead of bundle
+4. **Background Process**: Automatic checking and downloading runs in background
+5. **Next Launch**: New updates are applied on next app restart
+
+### File Structure
+
+```
+Documents/
+├── www/                     # Updated web content (active)
+├── pending_update/          # Downloaded update waiting for installation
+│   └── www/                 # New web content
+└── www_backup/              # Backup of previous version (for rollback)
+```
+
+### Update Lifecycle
+
+```
+[Bundle] -> [Check] -> [Download] -> [Prepare] -> [Install] -> [Reload]
+   ↑                                                             ↓
+   └─────────────────── [Next App Launch] ←──────────────────────┘
+```
+
+## 🐛 Troubleshooting
+
+### Common Issues
+
+**Plugin installation fails or plugin not found**
+- **npm registry**: Ensure plugin is published to npm
+- **pnpm users**: Add hoisting configuration to `.npmrc` (see Installation with pnpm section)
+- **Git installation**: Use full GitHub URL: `cordova plugin add https://github.com/vladimirDarksy/Cordova_hot_update.git`
+- **Verify installation**: Run `cordova plugin list` to check if plugin is installed
+
+**pnpm + Cordova compatibility issues**
+If you're using pnpm and Cordova can't find the plugin:
+
+1. Add to your project's `.npmrc`:
+   ```
+   public-hoist-pattern[]=cordova-plugin-*
+   shamefully-hoist=true
+   ```
+
+2. Remove and reinstall:
+   ```bash
+   cordova plugin remove cordova-plugin-hot-updates
+   rm -rf node_modules
+   pnpm install
+   cordova plugin add cordova-plugin-hot-updates
+   ```
+
+3. If still not working, check that Cordova CLI can access the plugin:
+   ```bash
+   ls node_modules/cordova-plugin-hot-updates
+   ```
+
+**Updates not downloading**
+- Check your server URL in config.xml
+- Verify server is returning correct JSON format
+- Check device network connectivity
+- Enable debugging with `cordova run ios --device --debug`
+
+**WebView not reloading updated content**
+- Ensure `Documents/www/index.html` exists
+- Check iOS device logs for WebView errors
+- Verify ZIP package contains `www` folder
+
+**CocoaPods issues**
+- Run `pod install` in `platforms/ios` directory
+- Update CocoaPods: `sudo gem install cocoapods`
+- Clean and rebuild: `cordova clean ios && cordova build ios`
+
+### Debug Logging
+
+The plugin provides extensive console logging. To view:
+
+```bash
+# iOS Simulator
+cordova run ios --debug
+
+# iOS Device
+# Use Xcode console or Safari Web Inspector
+```
+
+### Reset Plugin State
+
+```javascript
+// Clear all plugin data (for testing)
+localStorage.removeItem('hot_updates_installed_version');
+localStorage.removeItem('hot_updates_pending_version');
+localStorage.removeItem('hot_updates_has_pending');
+```
+
+## ⚠️ Important Notes
+
+- **iOS Only**: Currently supports iOS platform only
+- **HTTPS Required**: Update server should use HTTPS in production
+- **App Store Compliance**: Only update web content, not native code
+- **Testing**: Test thoroughly on real devices before production
+- **Rollback**: Keep ability to rollback via App Store if needed
+
+## 📄 Requirements
+
+- **Cordova**: >= 7.0.0
+- **cordova-ios**: >= 4.4.0
+- **iOS**: >= 11.0
+- **CocoaPods**: For SSZipArchive dependency
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📝 License
+
+This project is licensed under the Custom Non-Commercial License - see the [LICENSE](LICENSE) file for details.
+
+**⚠️ Commercial use is strictly prohibited without explicit written permission from the copyright holder.**
+
+For commercial licensing inquiries, please contact: **Mustafin Vladimir**
+
+## 🙋‍♂️ Support
+
+- **Issues**: [GitHub Issues](https://github.com/vladimirDarksy/Cordova_hot_update/issues)
+- **Documentation**: This README and inline code documentation
+- **Discussions**: [GitHub Discussions](https://github.com/vladimirDarksy/Cordova_hot_update/discussions)
+
+---
+
+**Made with ❤️ by [Mustafin Vladimir](https://github.com/vladimirDarksy)**