@capgo/capacitor-social-login 0.0.10

package/CapgoCapacitorSocialLogin.podspec

@@ -0,0 +1,21 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapgoCapacitorSocialLogin'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '13.0'
+  s.dependency 'Capacitor'
+  s.dependency 'FBSDKCoreKit', '17.1.0'
+  s.dependency 'FBSDKLoginKit', '17.1.0'
+  s.dependency 'GoogleSignIn', '~> 8.0.0'
+  s.dependency 'Alamofire'
+  s.swift_version = '5.1'
+end

package/Package.swift

@@ -0,0 +1,37 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapgoCapacitorSocialLogin",
+    platforms: [.iOS(.v13)],
+    products: [
+        .library(
+            name: "CapgoCapacitorSocialLogin",
+            targets: ["SocialLoginPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", branch: "main"),
+        // FBSDKCoreKit and FBSDKLoginKit
+        .package(url: "https://github.com/facebook/facebook-ios-sdk.git", .upToNextMajor(from: "17.1.0")),
+        // Add Google Sign-In dependency
+        .package(url: "https://github.com/google/GoogleSignIn-iOS.git", .upToNextMajor(from: "8.0.0")),
+        // Alamofire
+        .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.9.1"))
+    ],
+    targets: [
+        .target(
+            name: "SocialLoginPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm"),
+                .product(name: "FacebookLogin", package: "facebook-ios-sdk"),
+                .product(name: "GoogleSignIn", package: "GoogleSignIn-iOS"),
+                .product(name: "Alamofire", package: "Alamofire")
+            ],
+            path: "ios/Sources/SocialLoginPlugin"),
+        .testTarget(
+            name: "SocialLoginPluginTests",
+            dependencies: ["SocialLoginPlugin"],
+            path: "ios/Tests/SocialLoginPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,457 @@
+# @capgo/capacitor-social-login
+
+All social logins in one plugin
+
+WIP: Code is ready we ar now polishing documentation
+
+This plugin implement social auth for:
+- Google (with credential manager)
+- Apple (with 0auth on android)
+- Facebook ( with latest SDK)
+
+## Install
+
+```bash
+npm install @capgo/capacitor-social-login
+npx cap sync
+```
+
+## Apple
+
+### Android configuration
+
+For android you need a server to get the callback from the apple login. As we use the web SDK .
+
+Call the `initialize` method with the `apple` provider
+
+```typescript
+await SocialLogin.initialize({
+  apple: {
+    clientId: 'your-client-id',
+    redirectUrl: 'your-redirect-url',
+  },
+});
+const res = await SocialLogin.login({
+  provider: 'apple',
+  options: {
+    scopes: ['email', 'profile'],
+  },
+});
+```
+
+### iOS configuration
+
+call the `initialize` method with the `apple` provider
+
+```typescript
+await SocialLogin.initialize({
+  apple: {
+    clientId: 'your-client-id',
+  },
+});
+const res = await SocialLogin.login({
+  provider: 'apple',
+  options: {
+    scopes: ['email', 'profile'],
+  },
+});
+```
+
+## Facebook
+
+### Android configuration
+
+In file `android/app/src/main/AndroidManifest.xml`, add the following XML elements under `<manifest><application>` :
+
+```xml
+<meta-data android:name="com.facebook.sdk.ApplicationId" android:value="@string/facebook_app_id"/>
+<meta-data android:name="com.facebook.sdk.ClientToken" android:value="@string/facebook_client_token"/>
+```
+
+In file `android/app/src/main/res/values/strings.xml` add the following lines :
+
+```xml
+<string name="facebook_app_id">[APP_ID]</string>
+<string name="facebook_client_token">[CLIENT_TOKEN]</string>
+```
+
+Don't forget to replace `[APP_ID]` and `[CLIENT_TOKEN]` by your Facebook application Id.
+
+More information can be found here: https://developers.facebook.com/docs/android/getting-started
+
+Then call the `initialize` method with the `facebook` provider
+
+```typescript
+await SocialLogin.initialize({
+  facebook: {
+    appId: 'your-app-id',
+  },
+});
+const res = await SocialLogin.login({
+  provider: 'facebook',
+  options: {
+    permissions: ['email', 'public_profile'],
+  },
+});
+```
+
+### iOS configuration
+
+In file `ios/App/App/AppDelegate.swift` add or replace the following:
+
+```swift
+import UIKit
+import Capacitor
+import FBSDKCoreKit
+
+@UIApplicationMain
+class AppDelegate: UIResponder, UIApplicationDelegate {
+
+    var window: UIWindow?
+
+    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
+        // Override point for customization after application launch.
+        FBSDKCoreKit.ApplicationDelegate.shared.application(
+            application,
+            didFinishLaunchingWithOptions: launchOptions
+        )
+
+        return true
+    }
+
+    ...
+
+    func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
+        // Called when the app was launched with a url. Feel free to add additional processing here,
+        // but if you want the App API to support tracking app url opens, make sure to keep this call
+        if (FBSDKCoreKit.ApplicationDelegate.shared.application(
+            app,
+            open: url,
+            sourceApplication: options[UIApplication.OpenURLOptionsKey.sourceApplication] as? String,
+            annotation: options[UIApplication.OpenURLOptionsKey.annotation]
+        )) {
+            return true;
+        } else {
+            return ApplicationDelegateProxy.shared.application(app, open: url, options: options)
+        }
+    }
+}
+
+```
+
+Add the following in the `ios/App/App/info.plist` file inside of the outermost `<dict>`:
+
+```xml
+
+<key>CFBundleURLTypes</key>
+<array>
+    <dict>
+        <key>CFBundleURLSchemes</key>
+        <array>
+            <string>fb[APP_ID]</string>
+        </array>
+    </dict>
+</array>
+<key>FacebookAppID</key>
+<string>[APP_ID]</string>
+<key>FacebookClientToken</key>
+<string>[CLIENT_TOKEN]</string>
+<key>FacebookDisplayName</key>
+<string>[APP_NAME]</string>
+<key>LSApplicationQueriesSchemes</key>
+<array>
+    <string>fbapi</string>
+    <string>fbauth</string>
+    <string>fb-messenger-share-api</string>
+    <string>fbauth2</string>
+    <string>fbshareextension</string>
+</array>
+```
+
+More information can be found here: https://developers.facebook.com/docs/facebook-login/ios
+
+
+Then call the `initialize` method with the `facebook` provider
+
+```typescript
+await SocialLogin.initialize({
+  facebook: {
+    appId: 'your-app-id',
+  },
+});
+const res = await SocialLogin.login({
+  provider: 'facebook',
+  options: {
+    permissions: ['email', 'public_profile'],
+  },
+});
+```
+
+## Google
+
+### Android configuration
+
+Directly call the `initialize` method with the `google` provider
+
+```typescript
+await SocialLogin.initialize({
+  google: {
+    clientId: 'your-client-id', // the web client id
+  },
+});
+const res = await SocialLogin.login({
+  provider: 'google',
+  options: {
+    scopes: ['email', 'profile'],
+  },
+});
+```
+
+### iOS configuration
+
+Call the `initialize` method with the `google` provider
+
+```typescript
+await SocialLogin.initialize({
+  google: {
+    clientId: 'your-client-id', // the web client id
+  },
+});
+const res = await SocialLogin.login({
+  provider: 'google',
+  options: {
+    scopes: ['email', 'profile'],
+  },
+});
+```
+
+## API
+
+<docgen-index>
+
+* [`initialize(...)`](#initialize)
+* [`login(...)`](#login)
+* [`logout(...)`](#logout)
+* [`isLoggedIn(...)`](#isloggedin)
+* [`getAuthorizationCode(...)`](#getauthorizationcode)
+* [`refresh(...)`](#refresh)
+* [Interfaces](#interfaces)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### initialize(...)
+
+```typescript
+initialize(options: InitializeOptions) => Promise<void>
+```
+
+Initialize the plugin
+
+| Param         | Type                                                            |
+| ------------- | --------------------------------------------------------------- |
+| **`options`** | <code><a href="#initializeoptions">InitializeOptions</a></code> |
+
+--------------------
+
+
+### login(...)
+
+```typescript
+login(options: LoginOptions) => Promise<LoginResult>
+```
+
+Login with the selected provider
+
+| Param         | Type                                                  |
+| ------------- | ----------------------------------------------------- |
+| **`options`** | <code><a href="#loginoptions">LoginOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#loginresult">LoginResult</a>&gt;</code>
+
+--------------------
+
+
+### logout(...)
+
+```typescript
+logout(options: { provider: "apple" | "google" | "facebook"; }) => Promise<void>
+```
+
+Logout
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code>{ provider: 'facebook' \| 'google' \| 'apple'; }</code> |
+
+--------------------
+
+
+### isLoggedIn(...)
+
+```typescript
+isLoggedIn(options: isLoggedInOptions) => Promise<{ isLoggedIn: boolean; }>
+```
+
+IsLoggedIn
+
+| Param         | Type                                                            |
+| ------------- | --------------------------------------------------------------- |
+| **`options`** | <code><a href="#isloggedinoptions">isLoggedInOptions</a></code> |
+
+**Returns:** <code>Promise&lt;{ isLoggedIn: boolean; }&gt;</code>
+
+--------------------
+
+
+### getAuthorizationCode(...)
+
+```typescript
+getAuthorizationCode(options: AuthorizationCodeOptions) => Promise<AuthorizationCode>
+```
+
+Get the current access token
+
+| Param         | Type                                                                          |
+| ------------- | ----------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#authorizationcodeoptions">AuthorizationCodeOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#authorizationcode">AuthorizationCode</a>&gt;</code>
+
+--------------------
+
+
+### refresh(...)
+
+```typescript
+refresh(options: LoginOptions) => Promise<void>
+```
+
+Refresh the access token
+
+| Param         | Type                                                  |
+| ------------- | ----------------------------------------------------- |
+| **`options`** | <code><a href="#loginoptions">LoginOptions</a></code> |
+
+--------------------
+
+
+### Interfaces
+
+
+#### InitializeOptions
+
+| Prop           | Type                                                    |
+| -------------- | ------------------------------------------------------- |
+| **`facebook`** | <code>{ appId: string; }</code>                         |
+| **`google`**   | <code>{ clientId: string; }</code>                      |
+| **`apple`**    | <code>{ clientId: string; redirectUrl: string; }</code> |
+
+
+#### LoginResult
+
+| Prop           | Type                                                                                                                                                                                            | Description |
+| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
+| **`provider`** | <code>'facebook' \| 'google' \| 'apple' \| 'twitter'</code>                                                                                                                                     | Provider    |
+| **`result`**   | <code><a href="#facebookloginresponse">FacebookLoginResponse</a> \| <a href="#googleloginresponse">GoogleLoginResponse</a> \| <a href="#appleproviderresponse">AppleProviderResponse</a></code> | Payload     |
+
+
+#### FacebookLoginResponse
+
+| Prop              | Type                                                        |
+| ----------------- | ----------------------------------------------------------- |
+| **`accessToken`** | <code><a href="#accesstoken">AccessToken</a> \| null</code> |
+| **`profile`**     | <code>{ fields: readonly string[]; }</code>                 |
+
+
+#### AccessToken
+
+| Prop                      | Type                  |
+| ------------------------- | --------------------- |
+| **`applicationId`**       | <code>string</code>   |
+| **`declinedPermissions`** | <code>string[]</code> |
+| **`expires`**             | <code>string</code>   |
+| **`isExpired`**           | <code>boolean</code>  |
+| **`lastRefresh`**         | <code>string</code>   |
+| **`permissions`**         | <code>string[]</code> |
+| **`token`**               | <code>string</code>   |
+| **`userId`**              | <code>string</code>   |
+
+
+#### GoogleLoginResponse
+
+| Prop              | Type                                                                                                                                                               |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **`accessToken`** | <code><a href="#accesstoken">AccessToken</a> \| null</code>                                                                                                        |
+| **`idToken`**     | <code>string \| null</code>                                                                                                                                        |
+| **`profile`**     | <code>{ email: string \| null; familyName: string \| null; givenName: string \| null; id: string \| null; name: string \| null; imageUrl: string \| null; }</code> |
+
+
+#### AppleProviderResponse
+
+| Prop                    | Type                        |
+| ----------------------- | --------------------------- |
+| **`user`**              | <code>string \| null</code> |
+| **`email`**             | <code>string \| null</code> |
+| **`givenName`**         | <code>string \| null</code> |
+| **`familyName`**        | <code>string \| null</code> |
+| **`identityToken`**     | <code>string \| null</code> |
+| **`authorizationCode`** | <code>string</code>         |
+
+
+#### LoginOptions
+
+| Prop           | Type                                                                                                                                                                                      | Description |
+| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
+| **`provider`** | <code>'facebook' \| 'google' \| 'apple' \| 'twitter'</code>                                                                                                                               | Provider    |
+| **`options`**  | <code><a href="#facebookloginoptions">FacebookLoginOptions</a> \| <a href="#googleloginoptions">GoogleLoginOptions</a> \| <a href="#appleprovideroptions">AppleProviderOptions</a></code> | Options     |
+
+
+#### FacebookLoginOptions
+
+| Prop              | Type                  | Description |
+| ----------------- | --------------------- | ----------- |
+| **`permissions`** | <code>string[]</code> | Permissions |
+
+
+#### GoogleLoginOptions
+
+| Prop                     | Type                  | Description                                                                                                                              | Default            | Since |
+| ------------------------ | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| **`scopes`**             | <code>string[]</code> | Specifies the scopes required for accessing Google APIs The default is defined in the configuration.                                     |                    |       |
+| **`grantOfflineAccess`** | <code>boolean</code>  | Set if your application needs to refresh access tokens when the user is not present at the browser. In response use `serverAuthCode` key | <code>false</code> | 3.1.0 |
+
+
+#### AppleProviderOptions
+
+| Prop              | Type                  | Description  |
+| ----------------- | --------------------- | ------------ |
+| **`scopes`**      | <code>string[]</code> | Scopes       |
+| **`redirectURI`** | <code>string</code>   | Redirect URI |
+| **`nonce`**       | <code>string</code>   | Nonce        |
+| **`state`**       | <code>string</code>   | State        |
+
+
+#### isLoggedInOptions
+
+| Prop           | Type                                           | Description |
+| -------------- | ---------------------------------------------- | ----------- |
+| **`provider`** | <code>'facebook' \| 'google' \| 'apple'</code> | Provider    |
+
+
+#### AuthorizationCode
+
+| Prop      | Type                | Description |
+| --------- | ------------------- | ----------- |
+| **`jwt`** | <code>string</code> | Jwt         |
+
+
+#### AuthorizationCodeOptions
+
+| Prop           | Type                                           | Description |
+| -------------- | ---------------------------------------------- | ----------- |
+| **`provider`** | <code>'facebook' \| 'google' \| 'apple'</code> | Provider    |
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,64 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.2.1'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "ee.forgr.capacitor.social.login"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation 'com.facebook.android:facebook-login:17.0.0'
+    implementation 'com.squareup.okhttp3:okhttp:4.9.1'
+    implementation 'com.auth0.android:jwtdecode:2.0.2'
+    implementation "androidx.credentials:credentials:1.2.2"
+    implementation "androidx.credentials:credentials-play-services-auth:1.2.2"
+    implementation "com.google.android.libraries.identity.googleid:googleid:1.1.1"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.USE_CREDENTIALS" />
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>