@capawesome/capacitor-app-update
v7.0.0-dev.1765885034TypeScript
Capacitor plugin that assists with app updates.
40.2K/weekUpdated 2 weeks agoMITUnpacked: 98.7 KB
Published by Robin Genz
npm install @capawesome/capacitor-app-update@capawesome/capacitor-app-update
Capacitor plugin that assists with native app updates.
It supports retrieving app update information on Android and iOS and supports in-app updates on Android.
> Check out the Capacitor Live Update plugin to update your app remotely in real-time without submitting a new version to the app store. 🚀
Features
We are proud to offer one of the most complete and feature-rich Capacitor plugins for app updates. Here are some of the key features:
- 🖥️ Cross-platform: Supports Android and iOS.
- 📱 App update information: Retrieves current and available app versions.
- ⚡ Immediate in-app updates: Performs immediate updates on Android.
- 📲 Flexible in-app updates: Supports flexible update flows on Android.
- 📈 Update priority: Supports update priority levels on Android.
- 🏪 App store navigation: Opens the app store entry for manual updates.
- 📊 Update state tracking: Monitors flexible update progress with listeners.
- 🔁 Up-to-date: Always supports the latest Capacitor version.
Missing a feature? Just open an issue and we'll take a look!
Newsletter
Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our Capawesome Newsletter.
Compatibility
| Plugin Version | Capacitor Version | Status |
| -------------- | ----------------- | -------------- |
| 8.x.x | >=8.x.x | Active support |
| 7.x.x | 7.x.x | Deprecated |
| 6.x.x | 6.x.x | Deprecated |
| 5.x.x | 5.x.x | Deprecated |
Installation
``bash`
npm install @capawesome/capacitor-app-update
npx cap sync
$3
If needed, you can define the following project variable in your app’s variables.gradle file to change the default version of the dependency:
- $androidPlayAppUpdateVersion version of com.google.android.play:app-update (default: 2.1.0)$androidPlayServicesBaseVersion
- version of com.google.android.gms:play-services-base (default: 18.9.0)
This can be useful if you encounter dependency conflicts with other plugins in your project.
Configuration
No configuration required for this plugin.
Demo
A working example can be found here: robingenz/capacitor-plugin-demo
Usage
`typescript
import { Capacitor } from '@capacitor/core';
import { AppUpdate } from '@capawesome/capacitor-app-update';
const getCurrentAppVersion = async () => {
const result = await AppUpdate.getAppUpdateInfo();
if (Capacitor.getPlatform() === 'android') {
return result.currentVersionCode;
} else {
return result.currentVersionName;
}
};
const getAvailableAppVersion = async () => {
const result = await AppUpdate.getAppUpdateInfo();
if (Capacitor.getPlatform() === 'android') {
return result.availableVersionCode;
} else {
return result.availableVersionName;
}
};
const openAppStore = async () => {
await AppUpdate.openAppStore();
};
const performImmediateUpdate = async () => {
const result = await AppUpdate.getAppUpdateInfo();
if (result.updateAvailability !== AppUpdateAvailability.UPDATE_AVAILABLE) {
return;
}
if (result.immediateUpdateAllowed) {
await AppUpdate.performImmediateUpdate();
}
};
const startFlexibleUpdate = async () => {
const result = await AppUpdate.getAppUpdateInfo();
if (result.updateAvailability !== AppUpdateAvailability.UPDATE_AVAILABLE) {
return;
}
if (result.flexibleUpdateAllowed) {
await AppUpdate.startFlexibleUpdate();
}
};
const completeFlexibleUpdate = async () => {
await AppUpdate.completeFlexibleUpdate();
};
`
API
* getAppUpdateInfo(...)
* openAppStore(...)
* performImmediateUpdate()
* startFlexibleUpdate()
* completeFlexibleUpdate()
* addListener('onFlexibleUpdateStateChange', ...)
* removeAllListeners()
* Interfaces
* Enums
$3
`typescript`
getAppUpdateInfo(options?: GetAppUpdateInfoOptions | undefined) => Promise
Returns app update informations.
Only available on Android and iOS.
| Param | Type |
| ------------- | --------------------------------------------------------------------------- |
| options | GetAppUpdateInfoOptions |
Returns: Promise<AppUpdateInfo>
--------------------
$3
`typescript`
openAppStore(options?: OpenAppStoreOptions | undefined) => Promise
Opens the app store entry of the app in the Play Store (Android) or App Store (iOS).
Only available on Android and iOS.
| Param | Type |
| ------------- | ------------------------------------------------------------------- |
| options | OpenAppStoreOptions |
--------------------
$3
`typescript`
performImmediateUpdate() => Promise
Performs an immediate in-app update.
Only available on Android.
Returns: Promise<AppUpdateResult>
--------------------
$3
`typescript`
startFlexibleUpdate() => Promise
Starts a flexible in-app update.
Only available on Android.
Returns: Promise<AppUpdateResult>
--------------------
$3
`typescript`
completeFlexibleUpdate() => Promise
Completes a flexible in-app update by restarting the app.
Only available on Android.
--------------------
$3
`typescript`
addListener(eventName: 'onFlexibleUpdateStateChange', listenerFunc: (state: FlexibleUpdateState) => void) => Promise
Adds a flexbile in-app update state change listener.
Only available on Android.
| Param | Type |
| ------------------ | --------------------------------------------------------------------------------------- |
| eventName | 'onFlexibleUpdateStateChange' |
| listenerFunc | (state: FlexibleUpdateState) => void |
Returns: Promise<PluginListenerHandle>
--------------------
$3
`typescript`
removeAllListeners() => Promise
Remove all listeners for this plugin.
--------------------
$3
#### AppUpdateInfo
| Prop | Type | Description | Since |
| --------------------------------- | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| currentVersionName | string | The current version name of the app. On Android, this is the versionName from the android/app/build.gradle file. On iOS, this is the CFBundleShortVersionString from the Info.plist file. Only available on Android and iOS. | 5.1.0 |availableVersionName
| | CFBundleShortVersionStringstring | The available version name of the update. On iOS, this is the from the Info.plist file. Only available on iOS. | 5.1.0 |currentVersionCode
| | versionCodestring | The current version code of the app. On Android, this is the from the android/app/build.gradle file. On iOS, this is the CFBundleVersion from the Info.plist file. Only available on Android and iOS. | 5.1.0 |availableVersionCode
| | versionCodestring | The available version code of the update. On Android, this is the from the android/app/build.gradle file. Only available on Android. | 5.1.0 |availableVersionReleaseDate
| | updateAvailabilitystring | Release date of the update in ISO 8601 (UTC) format. Only available on iOS. | |
| | updatePriorityAppUpdateAvailability | The app update availability. Only available on Android and iOS. | |
| | immediateUpdateAllowednumber | In-app update priority for this update, as defined by the developer in the Google Play Developer API. Only available on Android. | |
| | trueboolean | if an immediate update is allowed, otherwise false. Only available on Android. | |flexibleUpdateAllowed
| | trueboolean | if a flexible update is allowed, otherwise false. Only available on Android. | |clientVersionStalenessDays
| | installStatusnumber | Number of days since the Google Play Store app on the user's device has learnt about an available update if an update is available or in progress. Only available on Android. | |
| | minimumOsVersionFlexibleUpdateInstallStatus | Flexible in-app update install status. Only available on Android. | |
| | string | The minimum version of the operating system required for the app to run in iOS. Only available on iOS. | |
#### GetAppUpdateInfoOptions
| Prop | Type | Description |
| ------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| country | string | The two-letter country code for the store you want to search. See http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for a list of ISO Country Codes. Only available on iOS. |
#### OpenAppStoreOptions
| Prop | Type | Description | Since |
| ------------------------ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| androidPackageName | string | The package name of the app to open in the Play Store. On Android, this is the application ID of your app (e.g. com.example.app). You can find the ID in the android/app/build.gradle file. If not provided, the current app's package name will be used. Only available on Android. | 7.2.0 |appId
| | 123456789string | The app ID of the app to open in the App Store. On iOS, this is the Apple ID of your app (e.g. ). You can find the ID in the URL of your app store entry (e.g. https://apps.apple.com/app/id123456789). Only available on iOS. | 6.1.0 |
#### AppUpdateResult
| Prop | Type |
| ---------- | ------------------------------------------------------------------- |
| code | AppUpdateResultCode |
#### PluginListenerHandle
| Prop | Type |
| ------------ | ----------------------------------------- |
| remove | () => Promise<void> |
#### FlexibleUpdateState
| Prop | Type | Description |
| -------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| installStatus | FlexibleUpdateInstallStatus | Flexible in-app update install status. |
| bytesDownloaded | number | Returns the number of bytes downloaded so far. undefined if the install status is other than DOWNLOADING. |totalBytesToDownload
| | undefinednumber | Returns the total number of bytes to be downloaded for this update. if the install status is other than DOWNLOADING. |
$3
#### AppUpdateAvailability
| Members | Value |
| -------------------------- | -------------- |
| UNKNOWN | 0 |
| UPDATE_NOT_AVAILABLE | 1 |
| UPDATE_AVAILABLE | 2 |
| UPDATE_IN_PROGRESS | 3 |
#### FlexibleUpdateInstallStatus
| Members | Value |
| ----------------- | --------------- |
| UNKNOWN | 0 |
| PENDING | 1 |
| DOWNLOADING | 2 |
| INSTALLING | 3 |
| INSTALLED | 4 |
| FAILED | 5 |
| CANCELED | 6 |
| DOWNLOADED | 11 |
#### AppUpdateResultCode
| Members | Value | Description |
| ------------------- | -------------- | ------------------------------------------------------------------------------------------- |
| OK | 0 | The user has accepted the update. |
| CANCELED | 1 | The user has denied or cancelled the update. |
| FAILED | 2 | Some other error prevented either the user from providing consent or the update to proceed. |
| NOT_AVAILABLE | 3 | No update available. |
| NOT_ALLOWED | 4 | Update type not allowed. |
| INFO_MISSING | 5 | App update info missing. You must call getAppUpdateInfo()` before requesting an update. |
Test with internal app-sharing
The Android Developers documentation describes how to test in-app updates using internal app sharing.
Changelog
See CHANGELOG.md.
License
See LICENSE.
Credits
This plugin is based on the Capacitor App Update plugin.
Thanks to everyone who contributed to the project!