Getting Started

Instalación

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 el guía de inicio rápido principal que cubre tanto la instalación del complemento como Capgo la integración en la nube.

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

Resumen

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

Cómo Funciona

1. Descarga de paquete: El complemento descarga paquetes de actualización (archivos ZIP que contienen sus activos web)
2. Extracción: Los paquetes se extraen al almacenamiento del dispositivo
3. Recarga caliente: La aplicación cambia a la nueva paquetería sin requerir un reinicio
4. Fallback: 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 utilizar 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: 'atBackground',
      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 la 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();

Mostrar paquetes

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

Eliminar un paquete

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

Obtener el paquete actual

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

Escuchadores de eventos

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

Configure el complemento en su capacitor.config.ts:

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

      // Update behavior
      resetWhenUpdate: true,

      // 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

Consulte el guía rápida principal para detalles.

Actualizaciones Autoalojadas

Alquila tu propio servidor de actualizaciones:

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

Tu servidor debe devolver:

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

Ver Modo Autoalojado para obtener detalles completos.

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 llama notifyAppReady() cuando tu aplicación se carga con éxito
• Prueba actualizaciones exhaustivamente antes de enviar a producción
• Implementa un manejo de errores adecuado para fallos de red
• Utiliza números de versión consistentemente
• Mantén los tamaños de paquetes pequeños para descargas más rápidas
• Monitorea las tasas de éxito de actualizaciones

Pasos siguientes

• Referencia del plugin API - Documentación completa de API
• Configuración del plugin - Todas las opciones de configuración
• Eventos - Eventos de actualización disponibles
• Modo de autoalbergue - 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

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar el trabajo de plugin nativo, conectarlo con Usando @capgo/capacitor-actualizador para la capacidad nativa en Usando @capgo/capacitor-actualizador, Directorio de Plugins de Capgo para el flujo de trabajo del producto en Directorio de Plugins de Capgo, Plugins de Capacitor por Capgo para el detalle de implementación en Plugins de Capacitor por Capgo, Agregar o Actualizar Plugins para el detalle de implementación en Agregar o Actualizar Plugins, y Alternativas de Plugins de Empresa de Ionic para el flujo de trabajo del producto en Alternativas de Plugins de Empresa de Ionic.