Empezar

Configuración lista

npm

bun add @capgo/capacitor-updater
bunx cap sync

yarn

yarn add @capgo/capacitor-updater
bunx cap sync

pnpm

pnpm add @capgo/capacitor-updater
bunx cap sync

bun

bun add @capgo/capacitor-updater
bunx cap sync

Inicio rápido

Para la mayoría de los usuarios, recomendamos seguir la guía de inicio rápido principal que cubre tanto la instalación del complemento como la Capgo integración de nube.

Esta guía de inicio rápido se centra en los detalles técnicos del complemento para usuarios avanzados que desean comprender los mecanismos subyacentes o implementar actualizaciones autoadministradas.

Resumen

El complemento de actualización Capacitor permite actualizaciones en el aire (OTA) para sus aplicaciones Capacitor. Esto le permite enviar actualizaciones a su aplicación sin pasar por revisiones de tiendas de aplicaciones.

Cómo funciona

1. Descarga de paquete: El plugin descarga paquetes de actualización (archivos ZIP que contienen tus activos web)
2. Extracción: Los paquetes se extraen en el almacenamiento del dispositivo
3. Recarga caliente: La aplicación cambia a la nueva paquete sin requerir reiniciar
4. Modo de caída: Si una actualización falla, la aplicación reversiona a la versión anterior que funcionaba

Modos de uso

1. Modo de actualización automática (Recomendado)

La forma más sencilla de usar el plugin con gestión de actualizaciones automática:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Plugin handles everything automatically
// Configure in capacitor.config.ts

Agregar a tu capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: true,
      updateUrl: 'https://your-update-server.com/api/updates'
    }
  }
}

2. Modo manual

Para un control avanzado sobre el proceso de actualización:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Download an update
const bundle = await CapacitorUpdater.download({
  url: 'https://your-server.com/updates/v1.0.1.zip',
  version: '1.0.1'
});

// Set the bundle (will be used on next app start)
await CapacitorUpdater.set({
  id: bundle.id
});

// Or reload immediately
await CapacitorUpdater.reload();

Configuración de plataforma

iOS

No se requiere configuración adicional. El plugin funciona de forma predeterminada.

Android

No se requiere configuración adicional. El plugin funciona de forma predeterminada.

Uso básico API

Descargar una actualización

import { CapacitorUpdater } from '@capgo/capacitor-updater';

const bundle = await CapacitorUpdater.download({
  url: 'https://example.com/update.zip',
  version: '1.0.1'
});

console.log('Downloaded bundle:', bundle.id);

Establecer paquete activo

// Set bundle to be used on next app start
await CapacitorUpdater.set({
  id: bundle.id
});

Recargar con Nuevo Paquete

// Reload app immediately with new bundle
await CapacitorUpdater.reload();

Lista de Paquetes

const { bundles } = await CapacitorUpdater.list();
console.log('Available bundles:', bundles);

Eliminar un Paquete

await CapacitorUpdater.delete({
  id: 'bundle-id'
});

Obtener Paquete Actual

const { bundle } = await CapacitorUpdater.current();
console.log('Current bundle:', bundle.version);

Eventos de escucha

Escuchar eventos de actualización:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Listen for download progress
CapacitorUpdater.addListener('download', (info) => {
  console.log('Download progress:', info.percent);
});

// Listen for download completion
CapacitorUpdater.addListener('downloadComplete', (bundle) => {
  console.log('Download complete:', bundle.version);
});

// Listen for update failures
CapacitorUpdater.addListener('updateFailed', (error) => {
  console.error('Update failed:', error);
});

// Listen for successful updates
CapacitorUpdater.addListener('updateAvailable', (info) => {
  console.log('Update available:', info.version);
});

Opciones de configuración

Configura el plugin en tu capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      // Auto-update settings
      autoUpdate: true,
      updateUrl: 'https://api.example.com/updates',

      // Update behavior
      resetWhenUpdate: true,
      directUpdate: false,

      // Version settings
      version: '1.0.0',

      // Security
      allowModifyUrl: false,

      // Stats collection
      statsUrl: 'https://api.example.com/stats',

      // Channel (for Capgo cloud)
      defaultChannel: 'production'
    }
  }
}

Patrones de integración

Con Capgo Cloud

La forma más fácil de empezar:

// Install the Capgo CLI
bun add -g @capgo/cli

// Login to Capgo
npx @capgo/cli login

// Upload your first bundle
npx @capgo/cli bundle upload

// The plugin auto-updates from Capgo cloud

Ver el guía de inicio rápido principal para detalles.

Actualizaciones Autoalojadas

Copiar a portapapeles

// Configure your update endpoint
{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: true,
      updateUrl: 'https://your-server.com/api/check-update'
    }
  }
}

Copiar a portapapeles

{
  "version": "1.0.1",
  "url": "https://your-server.com/updates/1.0.1.zip"
}

Ver el Modo Autohospedado para obtener todos los detalles.

Flujo de Actualización Manual

Control total sobre las actualizaciones:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

async function checkAndUpdate() {
  // Check for updates from your server
  const response = await fetch('https://api.example.com/check-update');
  const { version, url } = await response.json();

  // Download the update
  const bundle = await CapacitorUpdater.download({
    url,
    version
  });

  // Notify bundle is ready
  await CapacitorUpdater.notifyAppReady();

  // Set as next version
  await CapacitorUpdater.set({ id: bundle.id });

  // Reload when ready
  await CapacitorUpdater.reload();
}

Prácticas recomendadas

• Siempre llamar notifyAppReady() cuándo tu aplicación se carga correctamente
• Pruebe las actualizaciones exhaustivamente antes de enviarlas a producción.
• Implementar manejo de errores adecuado para fallos de red
• Usa números de versión de manera consistente
• Mantén los tamaños de paquetes pequeños para descargas más rápidas
• Monitorea las tasas de éxito de actualización

Pasos siguientes

• Referencia del plugin API - Documentación completa del API
• Configuración del plugin - Todas las opciones de configuración
• Eventos - Eventos de actualización disponibles
• Modo autoalojado - Ejecuta tu propio servidor de actualizaciones
• Desarrollo local - Prueba actualizaciones localmente
• Depuración - Guía de depuración

Soporte

• Problemas conocidos - Problemas comunes y soluciones
• GitHub Discusiones - Soporte de la comunidad
• Discord - Chat en tiempo real