native-update
Advanced tools
Foundation package for building a comprehensive update system for Capacitor apps. Provides architecture and interfaces but requires backend implementation.
⚠️ IMPORTANT: Production-Ready with Complete Examples ⚠️
This package is now feature-complete with significant improvements:
- ✅ Production Backend Example Included - Full server implementation in
production-backend/- ✅ Complete Example App - React + Firebase Functions in
example-app/- ✅ Native Implementations Complete - iOS (Swift) and Android (Kotlin) fully implemented
- ✅ Comprehensive Test Suite - Unit and integration tests with Vitest
- ✅ Development Tools Included - Bundle creator, signer, and CLI tools
- ✅ Security Features Implemented - HTTPS enforcement, signatures, checksums
🚀 Try the complete example app in
example-app/to see all features in action!
A foundation package for building a comprehensive update management plugin for Capacitor that combines Live/OTA updates, native app store updates, and in-app review capabilities. This package provides the architecture, interfaces, and documentation but requires additional implementation work.
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 native-update
npx cap sync
import { NativeUpdate } from 'native-update';
// Initialize on app start
async function initializeApp() {
// Configure the plugin
await NativeUpdate.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 result = await NativeUpdate.sync();
if (result.status === 'UPDATE_AVAILABLE') {
// Download update with progress tracking
const listener = NativeUpdate.addListener('downloadProgress', (progress) => {
console.log(`Downloading: ${progress.percent}%`);
});
// Download the update
const bundle = await NativeUpdate.download({
url: result.url,
version: result.version,
checksum: result.checksum
});
// Set the bundle and reload
await NativeUpdate.set(bundle);
await NativeUpdate.reload();
listener.remove();
}
} catch (error) {
console.error('Update failed:', error);
}
}
// Check for app store updates
async function checkNativeUpdates() {
const result = await NativeUpdate.getAppUpdateInfo();
if (result.updateAvailable) {
if (result.immediateUpdateAllowed) {
// Critical update - must install
await NativeUpdate.startImmediateUpdate();
} else if (result.flexibleUpdateAllowed) {
// Optional update - download in background
await NativeUpdate.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 NativeUpdate.requestReview();
if (result.displayed) {
console.log('Review prompt was shown');
}
}
}
import { Component, OnInit } from '@angular/core';
import { NativeUpdate } from '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 NativeUpdate.sync();
if (liveUpdate.status === 'UPDATE_AVAILABLE' || liveUpdate.status === 'UPDATE_INSTALLED') {
await this.promptLiveUpdate(liveUpdate);
return; // Don't check native if live update is available
}
// 2. Check native updates
const nativeUpdate = await NativeUpdate.getAppUpdateInfo();
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() {
// The sync method already handles download if needed
// Just reload to apply the update
await NativeUpdate.reload(); // App restarts
}
// Request review after positive events
async onPositiveEvent() {
setTimeout(() => {
NativeUpdate.requestReview();
}, 2000);
}
}
{
"plugins": {
"NativeUpdate": {
"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:
The example-app directory contains a complete, production-ready implementation:
🚀 Get started: See example-app/README.md for setup instructions.
We welcome contributions! Please see our Contributing Guide for details.
All tools are available via npx without cloning the repo:
# Quick start
npx native-update init --example
npx native-update backend create express --with-admin
✅ Bundle Management
npx native-update bundle create ./wwwnpx native-update bundle sign bundle.zip --key private.pemnpx native-update bundle verify bundle.zip --key public.pem✅ Key Management
npx native-update keys generate --type rsa --size 4096✅ Backend Templates
npx native-update backend create express --with-adminnpx native-update backend create firebase --with-monitoringnpx native-update backend create vercel✅ Development Tools
npx native-update server start --port 3000npx native-update monitor --server https://your-server.comnpx native-update config check✅ Migration Tools
npx native-update migrate --from codepushSee CLI Reference for complete documentation.
✅ Architecture & Design
✅ Documentation
✅ Foundation Code
❌ Backend Infrastructure
❌ Complete Native Implementation
❌ Testing & Quality Assurance
❌ Tooling & Utilities
Understand the Architecture:
/docs//src/definitions.tsBuild Required Infrastructure:
Complete Native Implementation:
Create Testing Suite:
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
Foundation package for building a comprehensive update system for Capacitor apps. Provides architecture and interfaces but requires backend implementation.
The npm package native-update receives a total of 40 weekly downloads. As such, native-update popularity was classified as not popular.
We found that 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.