Migrazione di Apple Sign-In a @capgo/social-login

Panoramica

Questa guida descrive la transizione dalla versione legacy @capacitor-community/apple-sign-in plugin al pacchetto moderno @capgo/capacitor-social-login Il nuovo plugin fornisce un'interfaccia unificata per più provider di autenticazione sociale con supporto migliorato per TypeScript e manutenzione attiva.

Installazione

1. Elimina il vecchio pacchetto:

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

2. Installa il nuovo pacchetto:

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

Code Modifiche

Importa Modifiche

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

Inizializzazione

Chiave di modifica: Il nuovo plugin richiede un passaggio di inizializzazione che non era necessario prima.

// 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: Per iOS, fornite una configurazione di base, mentre l'Android richiede ulteriori dettagli, inclusa una chiave di servizio e l'URL di callback del backend per l'autenticazione OAuth basata su web.

Accedi

Il processo di accesso si semplifica da più parametri a una API: più pulita.

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'
  }
});

Il nuovo plugin utilizza login() con provider: 'apple' Ecco le opzioni di ambito facoltative anziché passare singoli valori di configurazione come clientId e redirectURI.

Tipo di Risposta Modificato

I risultati includono ora un accessToken oggetto con dettagli di scadenza e una struttura profile sezione, sostituendo il formato di risposta più lineare del pacchetto originale:

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

Nuove Funzionalità

L'aggiornamento del plugin introduce funzionalità che non erano disponibili nel predecessore:

Verifica dello stato di accesso

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

Funzionalità di logout

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

Questi metodi forniscono isLoggedIn() per verificare lo stato di autenticazione e logout() funzionalità.

Modifiche specifiche della piattaforma

Configurazione di iOS

iOS mantiene procedure di configurazione familiari grazie alle capacità di Xcode:

1. The impostazione iOS rimane sostanzialmente la stessa. Ancora hai bisogno di:
   • Abilita la capacità di 'Accedi con Apple' in Xcode
   • Configura la tua app nel Portale dello Sviluppatore Apple
   • Non sono richieste ulteriori code modifiche per iOS

Configurazione Android

Android ora riceve il supporto nativo tramite l'autenticazione OAuth basata su web:

La nuova estensione fornisce il supporto Android in modo predefinito, ma richiede una configurazione aggiuntiva:

1. Creare un ID Servizi nel Portale dello Sviluppatore Apple
2. Configura un endpoint di autenticazione web
3. Configura la tua app Android per gestire il flusso OAuth
4. È richiesta la configurazione del servizio backend

Per ulteriori istruzioni di configurazione per Android, si prega di consultare il Guida di configurazione per Android.

Vantaggi chiave

Il pacchetto modernizzato fornisce:

1. API unificate su più provider sociali (Google, Facebook, Apple)
2. Tipi di tipo migliorati con definizioni di tipo migliori
3. Manutenzione della community attiva rispetto alla versione deprecata
4. Supporto Android integrato autenticazione basata su web
5. Gestione dello stato di accesso persistente
6. Miglioramento del trattamento degli errori con tipi di errore coerenti

Cambiamenti significativi

1. L'inizializzazione esplicita è ora richiesta - nessuna configurazione predefinita
2. La struttura dell'oggetto di risposta è cambiata - formato di risultato nidificato
3. La implementazione Android richiede un servizio backend per OAuth
4. Il gestione dei token è diversa - gestione dei token migliorata
5. La gestione degli errori e i tipi di errore sono cambiati - errori più dettagliati

Per ulteriori istruzioni di configurazione dettagliate, si prega di consultare il documento ufficiale.

Continua da Apple Sign-In Migration a @capgo/social-login

Se stai utilizzando Apple Sign-In Migration a @capgo/social-login per pianificare l'autenticazione e i flussi di account, connettilo con Usando @capgo/capacitor-login sociale per la capacità nativa in Usando @capgo/capacitor-login sociale, @capgo/capacitor-login sociale per il dettaglio di implementazione in @capgo/capacitor-login sociale, @capgo/capacitor-passkey per il dettaglio di implementazione in @capgo/capacitor-passkey, @capgo/capacitor-biometria nativa per il dettaglio di implementazione in @capgo/capacitor-biometria nativa, e Autenticazione a due fattori per il dettaglio di implementazione in Autenticazione a due fattori.