Apple Sign-In 迁移至 @capgo/social-login

复制给 AI

包含安装、同步和源 Markdown 指南。 @capacitor-community/apple-sign-in 概述 @capgo/capacitor-social-login 标题为“概述”的部分

本指南概述了从遗留

1. 包的过渡。新插件提供了多个社交身份验证提供商的统一接口，具有改进的 TypeScript 支持和活跃维护。

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

2. 安装新包：

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

Code 变更

导入变更

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

初始化

Key Change:新插件需要一个初始化步骤，这之前没有必要。

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

重要注意事项:对于iOS，您提供基本配置，而Android需要额外的详细信息，包括Service ID和后端回调URL以支持基于Web的OAuth认证。

Sign In

登录过程从多个参数简化到更干净的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'
  }
});

新插件使用 login() 和可选的范围而不是传递单独的配置值，如 provider: 'apple' with clientId 和 redirectURI.

响应类型变更

结果现在包括一个 accessToken 带有过期详细信息和结构化 profile 部分的对象，取代了原始包的扁平响应格式：

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

新功能

更新的插件引入了前辈中不可用的功能：

复制到剪贴板

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

登出功能

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

这些方法提供 isLoggedIn() 验证身份验证状态和 logout() 功能。

平台特定更改

iOS 设置

iOS 保持熟悉的设置程序通过Xcode功能：

1. iOS设置基本保持不变。您仍然需要：
   • 启用 Xcode 中的“Apple 登录”功能
   • 在 Apple 开发者门户中配置您的应用
   • 不需要为 iOS 进行任何额外的 code 变更

Android 配置

Android 现在通过基于 Web 的 OAuth 认证接收原生支持：

新插件提供了 Android 支持，但需要额外的配置：

1. 在 Apple 开发者门户中创建一个服务 ID
2. 配置一个 Web 认证端点
3. 配置您的 Android 应用以处理 OAuth 流程
4. 需要配置后端服务

请参阅详细的安卓设置指南 安卓设置指南.

关键优势

现代化的包提供：

1. 统一的API 跨多个社交提供商（Google，Facebook，Apple）
2. 改进的TypeScript类型 具有更好的类型定义
3. 活跃的社区维护 与过时版本相比
4. 内置安卓支持 通过基于 Web 的身份验证
5. 持久登录状态管理
6. 更好的错误处理 具有一致错误类型

重大变更

1. 现在需要显式初始化 - 没有默认配置
2. 响应对象结构已更改 - 嵌套结果格式
3. Android 实现需要一个后端服务 为 OAuth
4. Token 刷新处理方式不同 - token 管理改进
5. 错误处理和错误类型已经改变 - 更详细的错误信息

为了获取详细的设置指南，请参阅 官方文档.

从 Apple Sign-In Migration 到 @capgo/social-login

如果您正在使用 Apple Sign-In Migration 到 @capgo/social-login 来规划身份验证和帐户流程，连接它到 使用 @capgo/capacitor-social-login 为使用@capgo/capacitor-social-login的原生能力 @capgo/capacitor-social-login 在@capgo/capacitor-social-login的实现细节中 @capgo/capacitor-passkey 在@capgo/capacitor-passkey的实现细节中 @capgo/capacitor-native-biometric 在@capgo/capacitor-native-biometric的实现细节中， 双因素认证 在双因素认证的实现细节中