capacitor-native-update
Advanced tools
A comprehensive update management plugin for Capacitor that combines Live/OTA updates, native app store updates, and in-app review capabilities in a single, unified solution.
Deploy JavaScript, HTML, and CSS updates instantly without going through app store approval:
Seamlessly manage app store updates with native UI integration:
Increase user engagement with intelligent review prompts:
npm install capacitor-native-update
npx cap sync
import { CapacitorNativeUpdate } from 'capacitor-native-update';
// Initialize on app start
async function initializeApp() {
// Configure the plugin
await CapacitorNativeUpdate.configure({
updateUrl: 'https://updates.yourdomain.com/api/v1',
autoCheck: true,
publicKey: 'your-public-key-for-security',
});
}
// Check and apply live updates
async function checkLiveUpdates() {
try {
const { available, version } = await CapacitorNativeUpdate.checkForUpdate();
if (available) {
// Download update with progress
await CapacitorNativeUpdate.downloadUpdate({
onProgress: (progress) => {
console.log(`Downloading: ${progress.percent}%`);
},
});
// Apply update (app will restart)
await CapacitorNativeUpdate.applyUpdate();
}
} catch (error) {
console.error('Update failed:', error);
}
}
// Check for app store updates
async function checkNativeUpdates() {
const result = await CapacitorNativeUpdate.checkAppUpdate();
if (result.updateAvailable) {
if (result.immediateUpdateAllowed) {
// Critical update - must install
await CapacitorNativeUpdate.startImmediateUpdate();
} else if (result.flexibleUpdateAllowed) {
// Optional update - download in background
await CapacitorNativeUpdate.startFlexibleUpdate();
}
}
}
// Request app review at the right moment
async function requestAppReview() {
// Only ask after positive interactions
const shouldAsk = await checkIfGoodMoment();
if (shouldAsk) {
const result = await CapacitorNativeUpdate.requestReview();
if (result.displayed) {
console.log('Review prompt was shown');
}
}
}
import { Component, OnInit } from '@angular/core';
import { CapacitorNativeUpdate } from 'capacitor-native-update';
import { AlertController } from '@ionic/angular';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
})
export class AppComponent implements OnInit {
constructor(private alertCtrl: AlertController) {}
async ngOnInit() {
// Check for updates on app start
await this.checkAllUpdates();
// Set up periodic checks
setInterval(() => this.checkAllUpdates(), 3600000); // Every hour
}
async checkAllUpdates() {
// 1. Check live updates first (fastest)
const liveUpdate = await CapacitorNativeUpdate.checkForUpdate();
if (liveUpdate.available) {
await this.promptLiveUpdate(liveUpdate);
return; // Don't check native if live update is available
}
// 2. Check native updates
const nativeUpdate = await CapacitorNativeUpdate.checkAppUpdate();
if (nativeUpdate.updateAvailable) {
await this.promptNativeUpdate(nativeUpdate);
}
}
async promptLiveUpdate(update: any) {
const alert = await this.alertCtrl.create({
header: 'Update Available',
message: `Version ${update.version} is ready to install`,
buttons: [
{ text: 'Later', role: 'cancel' },
{
text: 'Update',
handler: () => this.installLiveUpdate(),
},
],
});
await alert.present();
}
async installLiveUpdate() {
// Download and apply
await CapacitorNativeUpdate.downloadUpdate();
await CapacitorNativeUpdate.applyUpdate(); // App restarts
}
// Request review after positive events
async onPositiveEvent() {
setTimeout(() => {
CapacitorNativeUpdate.requestReview();
}, 2000);
}
}
{
"plugins": {
"CapacitorNativeUpdate": {
"updateUrl": "https://updates.yourdomain.com/api/v1",
"autoCheck": true,
"checkInterval": 3600,
"channel": "production",
"publicKey": "YOUR_BASE64_PUBLIC_KEY",
"appStoreId": "123456789",
"enforceMinVersion": true
}
}
}
| Platform | Live Updates | App Updates | App Reviews |
|---|---|---|---|
| iOS | ✅ | ✅ | ✅ |
| Android | ✅ | ✅ | ✅ |
| Web | ✅ | ⚠️ | ⚠️ |
⚠️ = Graceful fallback with limited functionality
This plugin implements multiple security layers:
Check out the example app for a full implementation with:
The server example includes:
# Run the example server
cd server-example
npm install
npm start
We welcome contributions! Please see our Contributing Guide for details.
This package is production-ready and includes:
Install and Configure:
npm install capacitor-native-update
npx cap sync
Follow Security Guide: Implement Security Best Practices
Production Checklist: Complete the Production Readiness checklist
Deploy with Confidence: Your app is ready for production!
This package is open-source and created by Ahsan Mahmood for the developer community. We welcome contributions, feedback, and collaboration.
MIT License - see LICENSE for details.
Ahsan Mahmood
FAQs
Native Update Plugin for Capacitor
The npm package capacitor-native-update receives a total of 38 weekly downloads. As such, capacitor-native-update popularity was classified as not popular.
We found that capacitor-native-update demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.