Sigue adelante desde Inicio rápido

Instalación

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Luego utiliza el siguiente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-updater` plugin in my project.

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas del plataforma a continuació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 Guía rápida de inicio which covers both the plugin installation and Capgo cloud integration.

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

Resumen

El plugin 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 la tienda de aplicaciones.

Cómo Funciona

1. Descarga de paquete: El plugin 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 se cambia a el nuevo paquete sin requerir reiniciar
4. Modo por defecto: Si una actualización falla, la aplicación regresa 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áticas:

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 del 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 ninguna configuración adicional. El plugin funciona de forma predeterminada.

Android

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

Uso básico de 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();

Listar 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);

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

Configure el plugin en tu 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

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

Actualizaciones Autoalojadas

Almacene su propio servidor de actualizaciones:

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

Su servidor debe devolver:

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

Ver Modo Autoadministrado 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 llamar notifyAppReady() cuando su aplicación se carga con éxito
• Prueba las actualizaciones exhaustivamente antes de enviarlas a producción
• Implementar un manejo de errores adecuado para fallos de red
• Usar números de versión consistentemente
• Mantén los tamaños de paquetes pequeños para descargas más rápidas
• Monitorear las tasas de éxito de actualizaciones

Pasos siguientes

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

Soporte técnico

• 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, conecta con Usando @capgo/capacitor-actualizador para la capacidad nativa en Usando @capgo/capacitor-actualizador, Directorio del plugin Capgo para el flujo de trabajo del producto en Directorio del plugin 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 Ionic Enterprise para el flujo de trabajo del producto en Ionic Enterprise Plugin Alternatives.