Zum Inhalt springen

Apple Sign-In Migration zu @capgo/social-login

GitHub

Dieser Leitfaden beschreibt den Wechsel vom veralteten @capacitor-community/apple-sign-in Plugin zum modernen @capgo/capacitor-social-login Paket. Das neue Plugin bietet eine einheitliche Schnittstelle für mehrere Social-Authentifizierungsanbieter mit verbesserter TypeScript-Unterstützung und aktiver Wartung.

  1. Altes Paket entfernen:

    Terminalfenster
    npm uninstall @capacitor-community/apple-sign-in
  2. Neues Paket installieren:

    Terminalfenster
    npm install @capgo/capacitor-social-login
    npx cap sync
import { SignInWithApple } from '@capacitor-community/apple-sign-in';
import { SocialLogin } from '@capgo/capacitor-social-login';

Wichtige Änderung: Das neue Plugin erfordert einen Initialisierungsschritt, der zuvor nicht nötig war.

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

Wichtiger Hinweis: Für iOS geben Sie eine Basiskonfiguration an, während Android zusätzliche Angaben wie eine Service ID und eine Backend-Callback-URL für webbasierte OAuth-Authentifizierung benötigt.

Der Login-Prozess vereinfacht sich von mehreren Parametern zu einem saubereren API:

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

Das neue Plugin nutzt login() mit provider: 'apple' und optionale Scopes, anstatt einzelne Konfigurationswerte wie clientId und redirectURI.

Die Ergebnisse enthalten nun einen accessToken Objekt mit Ablaufdetails und einer strukturierten profile Abschnitt, der das flachere Antwortformat des ursprünglichen Pakets ersetzt:

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

Das aktualisierte Plugin führt Funktionen ein, die im Vorgänger nicht verfügbar waren:

Login-Status prüfen

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

Logout-Funktionalität

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

Diese Methoden bieten isLoggedIn() um den Authentifizierungsstatus zu überprüfen und logout() Funktionalität.

iOS behält die gewohnten Setup-Abläufe über Xcode-Capabilities bei:

  1. Das iOS Setup bleibt weitgehend gleich. Du musst weiterhin:
    • Die „Sign In with Apple“-Capability in Xcode aktivieren
    • Deine App im Apple Developer Portal konfigurieren
    • Für iOS sind keine zusätzlichen code-Änderungen erforderlich

Android erhält jetzt native Unterstützung über webbasierte OAuth-Authentifizierung:

Das neue Plugin bietet Android-Support out of the box, erfordert aber zusätzliche Einrichtung:

  1. Erstelle eine Services ID im Apple Developer Portal
  2. Konfiguriere einen Endpoint für die Web-Authentifizierung
  3. Richte deine Android-App für den OAuth-Flow ein
  4. Die Konfiguration eines Backend-Service ist erforderlich

Für detaillierte Anweisungen zur Android-Einrichtung siehe die Android-Setup-Anleitung.

Das modernisierte Paket bietet:

  1. Vereinheitlichte APIs über mehrere Social-Provider (Google, Facebook, Apple) hinweg
  2. Verbesserte TypeScript-Typisierung mit besseren Typdefinitionen
  3. Aktive Community-Pflege im Vergleich zur veralteten Version
  4. Integrierte Android-Unterstützung über webbasierte Authentifizierung
  5. Persistente Verwaltung des Login-Status
  6. Bessere Fehlerbehandlung mit konsistenten Fehlertypen
  1. Explizite Initialisierung ist nun erforderlich - keine Standardkonfiguration
  2. Struktur des Response-Objekts hat sich geändert - verschachteltes Ergebnisformat
  3. Android-Implementierung benötigt einen Backend-Dienst für OAuth
  4. Token-Refresh wird anders gehandhabt - verbessertes Token-Management
  5. Fehlerbehandlung und Fehlertypen haben sich geändert - detailliertere Fehler

Detaillierte Setup-Anweisungen findest du in der offiziellen Dokumentation.

Weiter geht's von Apple Sign-In Migration zu @capgo/social-login

Abschnitt mit dem Titel „Weiter geht's von Apple Sign-In Migration zu @capgo/social-login“

Wenn du es nutzt Apple Sign-In Migration zu @capgo/social-login Um Authentifizierungs- und Account-Flows zu planen, verbinde es mit @capgo/capacitor-social-login verwenden für die native Funktion bei der Verwendung von @capgo/capacitor-social-login, @capgo/capacitor-social-login für die Implementierungsdetails in @capgo/capacitor-social-login, @capgo/capacitor-passkey für die Implementierungsdetails in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric für die Implementierungsdetails in @capgo/capacitor-native-biometric, und Zwei-Faktor-Authentifizierung für die Implementierungsdetails zur Zwei-Faktor-Authentifizierung.