Aller au contenu

Premiers pas avec Cordova Updater

GitHub

Ce guide vous montre comment ajouter @capgo/cordova-updater à une application Cordova afin de recevoir des Capgo live updates sur iOS et Android.

  • Cordova CLI 12+
  • Cordova Android 13+ et/ou Cordova iOS 7+
  • Un compte Capgo (capgo.app/register)
  1. Installez le plugin depuis npm et indiquez votre ID d'application Capgo :

    Fenêtre de terminal
    cordova plugin add @capgo/cordova-updater --variable APP_ID=YOUR_CAPGO_APP_ID
  2. Facultatif : surcharger les valeurs par défaut au moment de l'installation (mêmes variables que l'updater Capacitor) :

    Fenêtre de terminal
    cordova plugin add @capgo/cordova-updater \
    --variable APP_ID=YOUR_CAPGO_APP_ID \
    --variable DEFAULT_CHANNEL=production \
    --variable UPDATE_URL=https://plugin.capgo.app/updates \
    --variable AUTO_UPDATE=atBackground
  3. Préparez les projets natifs après modification des variables de plugin :

    Fenêtre de terminal
    cordova prepare android ios
document.addEventListener('deviceready', async () => {
await cordova.plugins.Updater.notifyAppReady();
});
  • N'utilisez pas cordova-plugin-ionic-webview avec ce plugin.
  • Appelez notifyAppReady() dès que votre bundle est chargé — avant que le travail UI intensif ne retarde la fenêtre de rollback.
  • Gardez les paramètres de schéma Cordova corrects.

Après deviceready, le plugin est disponible en tant que cordova.plugins.Updater:

document.addEventListener('deviceready', async () => {
const { Updater } = cordova.plugins;
await Updater.notifyAppReady();
const latest = await Updater.getLatest();
if (latest.url && !latest.error) {
const bundle = await Updater.download({
url: latest.url,
version: latest.version,
checksum: latest.checksum,
});
await Updater.next({ id: bundle.id });
}
});

Les types TypeScript sont livrés avec le package npm :

import type { UpdaterPlugin } from '@capgo/cordova-updater';
declare const cordova: { plugins: { Updater: UpdaterPlugin } };
  • Nécessite Cordova Android 13+ afin que la WebView soit servie par défaut https://localhost/ schéma.
  • Le plugin enregistre un CordovaPluginPathHandler pour servir les assets du bundle téléchargé.

Compilez vos assets web, puis envoyez-les avec le Capgo CLI (même workflow que Capacitor) :

Fenêtre de terminal
bun run build
npx @capgo/cli@latest bundle upload --channel=production
  • Comparez les paramètres avec les Configuration de l’updater Capacitor — la plupart des options correspondent aux plugin.xml variables.
  • Lecture Compatibilité Live update avant de déployer les modifications du plugin natif.
  • Migration vers Capacitor plus tard ? Conservez le même ID d’application Capgo et les mêmes canaux ; seul le package du plugin client change.