capacitor-updater
Update capacitor app without store review.
You have 3 ways possible :
- use capgo.app a full featured auto update system in 5 min Setup, to manage version, update, revert and see stats.
- use your own server update with auto update system
- use manual methods to zip, upload, download, from JS to do it when you want.
Community
Join the discord to get help.
Documentation
I maintain a more user friendly and complete documentation in GitHub wiki.
install plugin
npm install @capgo/capacitor-updater
npx cap sync
Auto update setup
Create account in capgo.app and get your API key
- Login to CLI
npx @capgo/cli login API_KEY
- Add app with CLI
npx @capgo/cli add
- Upload app to channel production
npx @capgo/cli upload -c production
- Set channel production public
npx @capgo/cli set -c production -s public
- Edit your
capacitor.config.json
like below, setautoUpdate
to true.
// capacitor.config.json
{
"appId": "**.***.**",
"appName": "Name",
"plugins": {
"CapacitorUpdater": {
"autoUpdate": true,
}
}
}
- Add to your main code
import { CapacitorUpdater } from '@capgo/capacitor-updater'
CapacitorUpdater.notifyAppReady()
// To let auto update know you app boot well.
- Do
npm run build && npx cap copy
to copy the build to capacitor. - Run the app and see app auto update after each backgrounding.
- If update fail it will roolback to previous version.
See more there in the Auto update documentation.
Manual setup
Download app update from url when user enter the app install it when user background the app.
In your main code :
import { CapacitorUpdater } from '@capgo/capacitor-updater'
import { SplashScreen } from '@capacitor/splash-screen'
import { App } from '@capacitor/app'
let version = ""
App.addListener('appStateChange', async(state) => {
if (state.isActive) {
// Do the download during user active app time to prevent failed download
version = await CapacitorUpdater.download({
url: 'https://github.com/Cap-go/demo-app/releases/download/0.0.4/dist.zip',
})
}
if (!state.isActive && version !== "") {
// Do the switch when user leave app
SplashScreen.show()
try {
await CapacitorUpdater.set(version)
} catch () {
SplashScreen.hide() // in case the set fail, otherwise the new app will have to hide it
}
}
})
// or do it when click on button
const updateNow = async () => {
const version = await CapacitorUpdater.download({
url: 'https://github.com/Cap-go/demo-app/releases/download/0.0.4/dist.zip',
})
// show the splashscreen to let the update happen
SplashScreen.show()
await CapacitorUpdater.set(version)
SplashScreen.hide() // in case the set fail, otherwise the new app will have to hide it
}
Be extra careful for your update if you send a broken update, the app will crash until the user reinstalls it.
If you need more secure way to update your app, you can use Auto update system.
You can list the version and manage it with the command below.
dist.zip
Packaging Whatever you choose to name the file you download from your release/update server URL, the zip file should contain the full contents of your production Capacitor build output folder, usually {project directory}/dist/
or {project directory}/www/
. This is where index.html
will be located, and it should also contain all bundled JavaScript, CSS, and web resources necessary for your app to run.
Do not password encrypt this file, or it will fail to unpack.
API
download(...)
set(...)
getId()
getPluginVersion()
delete(...)
list()
reset(...)
current()
reload()
versionName()
notifyAppReady()
delayUpdate()
cancelDelay()
addListener('download', ...)
addListener('majorAvailable', ...)
addListener('updateAvailable', ...)
addListener(string, ...)
removeAllListeners()
- Interfaces
- Type Aliases
download(...)
download(options: { url: string; }) => Promise<{ version: string; }>
Download a new version from the provided URL, it should be a zip file, with files inside or with a unique folder inside with all your files
Param | Type |
---|---|
options |
{ url: string; } |
Returns: Promise<{ version: string; }>
set(...)
set(options: { version: string; versionName?: string; }) => Promise<void>
Set version as current version, set will return an error if there are is no index.html file inside the version folder. versionName
is optional and it's a custom value that will be saved for you
Param | Type |
---|---|
options |
{ version: string; versionName?: string; } |
getId()
getId() => Promise<{ id: string; }>
Get unique ID used to identify device into auto update server
Returns: Promise<{ id: string; }>
getPluginVersion()
getPluginVersion() => Promise<{ version: string; }>
Get plugin version used in native code
Returns: Promise<{ version: string; }>
delete(...)
delete(options: { version: string; }) => Promise<void>
Delete version in storage
Param | Type |
---|---|
options |
{ version: string; } |
list()
list() => Promise<{ versions: string[]; }>
Get all available versions
Returns: Promise<{ versions: string[]; }>
reset(...)
reset(options?: { toAutoUpdate?: boolean | undefined; } | undefined) => Promise<void>
Set the builtin
version (the one sent to Apple store / Google play store ) as current version
Param | Type |
---|---|
options |
{ toAutoUpdate?: boolean; } |
current()
current() => Promise<{ current: string; currentNative: string; }>
Get the current version, if none are set it returns builtin
, currentNative is the original version install on the device
Returns: Promise<{ current: string; currentNative: string; }>
reload()
reload() => Promise<void>
Reload the view
versionName()
versionName() => Promise<{ versionName: string; }>
Get the version name, if it was set during the set phase
Returns: Promise<{ versionName: string; }>
notifyAppReady()
notifyAppReady() => Promise<void>
Notify native plugin that the update is working, only in auto-update
delayUpdate()
delayUpdate() => Promise<void>
Skip updates in the next time the app goes into the background, only in auto-update
cancelDelay()
cancelDelay() => Promise<void>
allow update in the next time the app goes into the background, only in auto-update
addListener('download', ...)
addListener(eventName: 'download', listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
Listen for download event in the App, let you know when the download is started, loading and finished
Param | Type |
---|---|
eventName |
'download' |
listenerFunc |
DownloadChangeListener |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
Since: 2.0.11
addListener('majorAvailable', ...)
addListener(eventName: 'majorAvailable', listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle
Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking
Param | Type |
---|---|
eventName |
'majorAvailable' |
listenerFunc |
MajorAvailableListener |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
Since: 2.3.0
addListener('updateAvailable', ...)
addListener(eventName: 'updateAvailable', listenerFunc: UpdateAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle
Listen for update event in the App, let you know when update is ready to install at next app start
Param | Type |
---|---|
eventName |
'updateAvailable' |
listenerFunc |
UpdateAvailableListener |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
Since: 2.3.0
addListener(string, ...)
addListener(eventName: string, listenerFunc: (...args: any[]) => any) => Promise<PluginListenerHandle>
Param | Type |
---|---|
eventName |
string |
listenerFunc |
(...args: any[]) => any |
Returns: Promise<PluginListenerHandle>
removeAllListeners()
removeAllListeners() => Promise<void>
Interfaces
PluginListenerHandle
Prop | Type |
---|---|
remove |
() => Promise<void> |
DownloadEvent
Prop | Type | Description | Since |
---|---|---|---|
percent |
number |
Current status of download, between 0 and 100. | 2.0.11 |
MajorAvailableEvent
Prop | Type | Description | Since |
---|---|---|---|
version |
string |
Emit when a new major version is available. | 2.3.0 |
UpdateAvailableEvent
Prop | Type | Description | Since |
---|---|---|---|
version |
string |
Emit when a new update is available. | 3.0.0 |
Type Aliases
DownloadChangeListener
(state: DownloadEvent): void
MajorAvailableListener
(state: MajorAvailableEvent): void
UpdateAvailableListener
(state: UpdateAvailableEvent): void
Listen to download events
import { CapacitorUpdater } from '@capgo/capacitor-updater';
CapacitorUpdater.addListener('download', (info: any) => {
console.log('download was fired', info.percent);
});
On iOS, Apple don't allow you to show a message when the app is updated, so you can't show a progress bar.
Inspiration
Contributors
jamesyoung1337 Thanks a lot for your guidance and support, it was impossible to make this plugin work without you.