Migración de Inicio de Sesión de Apple a @capgo/social-login

Resumen

Esta guía describe la transición desde la versión legada @capacitor-community/apple-sign-in plugin a la moderna @capgo/capacitor-social-login paquete. El nuevo plugin proporciona una interfaz unificada para múltiples proveedores de autenticación social con un mejor soporte de TypeScript y mantenimiento activo.

Instalación

1. Eliminar el paquete antiguo:

   npm uninstall @capacitor-community/apple-sign-in

2. Instalar el nuevo paquete:

   npm install @capgo/capacitor-social-login
   npx cap sync

Code Cambios

Importar cambios

import { SignInWithApple } from '@capacitor-community/apple-sign-in';
import { SocialLogin } from '@capgo/capacitor-social-login';

Inicialización

Cambio clave: El nuevo plugin requiere un paso de inicialización que no era necesario antes.

// No initialization needed in old package
// For iOS: Basic configuration
await SocialLogin.initialize({
  apple: {} // Basic iOS configuration
});

// For Android: Additional configuration required
await SocialLogin.initialize({
  apple: {
    clientId: 'YOUR_SERVICE_ID', // Service ID from Apple Developer Portal
    redirectUrl: 'https://your-backend.com/callback' // Your backend callback URL
  }
});

Nota importante: Para iOS, proporciona configuración básica, mientras que Android requiere detalles adicionales, incluido un ID de Servicio y una URL de llamada de retorno del servidor para la autenticación de OAuth basada en web.

Iniciar sesión

El proceso de inicio de sesión se simplifica desde múltiples parámetros a un API: más limpio

const result = await SignInWithApple.authorize({
  clientId: 'com.your.app',
  redirectURI: 'https://your-app.com/callback',
  scopes: 'email name',
  state: '12345',
  nonce: 'nonce'
});

const result = await SocialLogin.login({
  provider: 'apple',
  options: {
    // Optional: Add scopes if needed
    scopes: ['email', 'name'],
    nonce: 'nonce'
  }
});

El nuevo plugin utiliza login() con provider: 'apple' y ámbitos opcionales en lugar de pasar valores de configuración individuales como clientId y redirectURI.

Cambios en el tipo de respuesta

Los resultados ahora incluyen un accessToken objeto con detalles de expiración y una estructura de profile sección, reemplazando el formato de respuesta plano del paquete original:

// Old response type
interface AppleSignInResponse {
  response: {
    user: string;
    email: string | null;
    givenName: string | null;
    familyName: string | null;
    identityToken: string | null;
    authorizationCode: string | null;
  };
}

// New response type
interface SocialLoginResponse {
  provider: 'apple';
  result: {
    accessToken: {
      token: string;
      expiresIn?: number;
      refreshToken?: string;
    } | null;
    idToken: string | null;
    profile: {
      user: string;
      email: string | null;
      givenName: string | null;
      familyName: string | null;
    };
  };
}

Nuevas Funcionalidades

El plugin actualizado introduce funcionalidades que no estaban disponibles en su predecesor:

Verificar el estado de inicio de sesión

// Not available in old package
const status = await SocialLogin.isLoggedIn({
  provider: 'apple'
});

Funcionalidad de cierre de sesión

// Not available in old package
await SocialLogin.logout({
  provider: 'apple'
});

Estos métodos proporcionan isLoggedIn() para verificar el estado de autenticación y logout() funcionalidad.

Cambios específicos de plataforma

Configuración de iOS

iOS Mantiene procedimientos de configuración familiares a través de capacidades de Xcode:

1. La configuración de iOS sigue siendo en gran medida la misma. Todavía necesitas:
   • Habilitar la capacidad “Iniciar sesión con Apple” en Xcode
   • Configurar tu aplicación en el Portal de Desarrolladores de Apple
   • No se requieren cambios adicionales code para iOS

Configuración de Android

Android ahora recibe soporte nativo a través de autenticación de OAuth basada en web:

El nuevo plugin proporciona soporte para Android de forma predeterminada, pero requiere una configuración adicional:

1. Crear un ID de Servicio en el Portal del Desarrollador de Apple
2. Configurar un punto de conexión de autenticación web
3. Configurar su aplicación de Android para manejar el flujo de OAuth
4. Se requiere configuración del servicio de backend

Para obtener instrucciones detalladas de configuración de Android, consulte el Guía de Configuración de Android.

Ventajas clave

El paquete modernizado proporciona:

1. APIs unificadas en múltiples proveedores sociales (Google, Facebook, Apple)
2. Mejoras de tipado de TypeScript con definiciones de tipo mejoradas
3. Mantenimiento de la comunidad activa en comparación con la versión descontinuada
4. Soporte integrado para Android a través de la autenticación basada en la web
5. Administración del estado de inicio de sesión persistente
6. Manejo de errores mejorado con tipos de errores consistentes

Cambios significativos

1. Se requiere inicialización explícita - no configuración por defecto
2. La estructura del objeto de respuesta ha cambiado - formato de resultados anidados
3. La implementación de Android requiere un servicio de backend para OAuth
4. El manejo de tokens es diferente - mejor gestión de tokens
5. El manejo de errores y los tipos de errores han cambiado - errores más detallados

Para obtener instrucciones de configuración más detalladas, consulte la documentación oficial.