@capgo/capacitor-social-login 8.1.1 → 8.2.1

package/android/src/main/java/ee/forgr/capacitor/social/login/SocialLoginPlugin.java

@@ -19,7 +19,7 @@ import org.json.JSONObject;
 @CapacitorPlugin(name = "SocialLogin")
 public class SocialLoginPlugin extends Plugin {
 
-    private final String pluginVersion = "8.1.1";
+    private final String pluginVersion = "8.2.1";
 
     public static String LOG_TAG = "CapgoSocialLogin";
 
@@ -162,6 +162,23 @@ public class SocialLoginPlugin extends Plugin {
             }
         }
 
+        JSObject oauth2 = call.getObject("oauth2");
+        if (oauth2 != null && oauth2.length() > 0) {
+            // oauth2 is now a map of providerId -> config: { "github": {...}, "azure": {...} }
+            OAuth2Provider oauth2Provider = new OAuth2Provider(this.getActivity(), this.getContext());
+            try {
+                java.util.List<String> errors = oauth2Provider.initializeProviders(oauth2);
+                if (!errors.isEmpty()) {
+                    call.reject(String.join(", ", errors));
+                    return;
+                }
+                this.socialProviderHashMap.put("oauth2", oauth2Provider);
+            } catch (JSONException e) {
+                call.reject("Failed to initialize OAuth2 provider: " + e.getMessage());
+                return;
+            }
+        }
+
         call.resolve();
     }
 
@@ -390,6 +407,15 @@ public class SocialLoginPlugin extends Plugin {
             }
         }
 
+        SocialProvider oauth2Provider = socialProviderHashMap.get("oauth2");
+        if (oauth2Provider instanceof OAuth2Provider) {
+            boolean handled = ((OAuth2Provider) oauth2Provider).handleActivityResult(requestCode, resultCode, data);
+            if (handled) {
+                Log.d(LOG_TAG, "OAuth2 activity result handled");
+                return;
+            }
+        }
+
         // Handle other providers' activity results if needed
         Log.d(LOG_TAG, "Activity result not handled by any provider");
     }

package/dist/docs.json

@@ -30,12 +30,12 @@
       },
       {
         "name": "login",
-        "signature": "<T extends \"apple\" | \"google\" | \"facebook\" | \"twitter\">(options: Extract<LoginOptions, { provider: T; }>) => Promise<{ provider: T; result: ProviderResponseMap[T]; }>",
+        "signature": "<T extends \"apple\" | \"google\" | \"facebook\" | \"twitter\" | \"oauth2\">(options: Extract<LoginOptions, { provider: T; }>) => Promise<{ provider: T; result: ProviderResponseMap[T]; }>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "Extract<{ provider: 'facebook'; options: FacebookLoginOptions; }, { provider: T; }> | Extract<{ provider: 'google'; options: GoogleLoginOptions; }, { provider: T; }> | Extract<{ provider: 'apple'; options: AppleProviderOptions; }, { provider: T; }> | Extract<{ provider: 'twitter'; options: TwitterLoginOptions; }, { provider: T; }>"
+            "type": "Extract<{ provider: 'facebook'; options: FacebookLoginOptions; }, { provider: T; }> | Extract<{ provider: 'google'; options: GoogleLoginOptions; }, { provider: T; }> | Extract<{ provider: 'apple'; options: AppleProviderOptions; }, { provider: T; }> | Extract<{ provider: 'twitter'; options: TwitterLoginOptions; }, { provider: T; }> | Extract<{ provider: 'oauth2'; options: OAuth2LoginOptions; }, { provider: T; }>"
           }
         ],
         "returns": "Promise<{ provider: T; result: ProviderResponseMap[T]; }>",
@@ -56,12 +56,12 @@
       },
       {
         "name": "logout",
-        "signature": "(options: { provider: 'apple' | 'google' | 'facebook' | 'twitter'; }) => Promise<void>",
+        "signature": "(options: { provider: 'apple' | 'google' | 'facebook' | 'twitter' | 'oauth2'; providerId?: string; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ provider: 'apple' | 'google' | 'facebook' | 'twitter'; }"
+            "type": "{ provider: 'apple' | 'google' | 'facebook' | 'twitter' | 'oauth2'; providerId?: string | undefined; }"
           }
         ],
         "returns": "Promise<void>",
@@ -213,6 +213,21 @@
       "tags": [],
       "methods": [],
       "properties": [
+        {
+          "name": "oauth2",
+          "tags": [
+            {
+              "text": "{\n  github: { appId: '...', authorizationBaseUrl: 'https://github.com/login/oauth/authorize', ... },\n  azure: { appId: '...', authorizationBaseUrl: 'https://login.microsoftonline.com/.../oauth2/v2.0/authorize', ... }\n}",
+              "name": "example"
+            }
+          ],
+          "docs": "OAuth2 provider configurations.\nSupports multiple providers by using a Record with provider IDs as keys.",
+          "complexTypes": [
+            "Record",
+            "OAuth2ProviderConfig"
+          ],
+          "type": "Record<string, OAuth2ProviderConfig>"
+        },
         {
           "name": "twitter",
           "tags": [],
@@ -243,6 +258,163 @@
         }
       ]
     },
+    {
+      "name": "OAuth2ProviderConfig",
+      "slug": "oauth2providerconfig",
+      "docs": "Configuration for a single OAuth2 provider instance",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "appId",
+          "tags": [
+            {
+              "text": "'your-client-id'",
+              "name": "example"
+            }
+          ],
+          "docs": "The OAuth 2.0 client identifier (App ID / Client ID)",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "authorizationBaseUrl",
+          "tags": [
+            {
+              "text": "'https://accounts.example.com/oauth2/authorize'",
+              "name": "example"
+            }
+          ],
+          "docs": "The base URL of the authorization endpoint",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "accessTokenEndpoint",
+          "tags": [
+            {
+              "text": "'https://accounts.example.com/oauth2/token'",
+              "name": "example"
+            }
+          ],
+          "docs": "The URL to exchange the authorization code for tokens\nRequired for authorization code flow",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "redirectUrl",
+          "tags": [
+            {
+              "text": "'myapp://oauth/callback'",
+              "name": "example"
+            }
+          ],
+          "docs": "Redirect URL that receives the OAuth callback",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "resourceUrl",
+          "tags": [
+            {
+              "text": "'https://api.example.com/userinfo'",
+              "name": "example"
+            }
+          ],
+          "docs": "Optional URL to fetch user profile/resource data after authentication\nThe access token will be sent as Bearer token in the Authorization header",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "responseType",
+          "tags": [
+            {
+              "text": "'code'",
+              "name": "default"
+            }
+          ],
+          "docs": "The OAuth response type\n- 'code': Authorization Code flow (recommended, requires accessTokenEndpoint)\n- 'token': Implicit flow (less secure, tokens returned directly)",
+          "complexTypes": [],
+          "type": "'code' | 'token' | undefined"
+        },
+        {
+          "name": "pkceEnabled",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "Enable PKCE (Proof Key for Code Exchange)\nStrongly recommended for public clients (mobile/web apps)",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "scope",
+          "tags": [
+            {
+              "text": "'openid profile email'",
+              "name": "example"
+            }
+          ],
+          "docs": "Default scopes to request during authorization",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "additionalParameters",
+          "tags": [
+            {
+              "text": "{ prompt: 'consent', login_hint: 'user@example.com' }",
+              "name": "example"
+            }
+          ],
+          "docs": "Additional parameters to include in the authorization request",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, string>"
+        },
+        {
+          "name": "additionalResourceHeaders",
+          "tags": [
+            {
+              "text": "{ 'X-Custom-Header': 'value' }",
+              "name": "example"
+            }
+          ],
+          "docs": "Additional headers to include when fetching the resource URL",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, string>"
+        },
+        {
+          "name": "logoutUrl",
+          "tags": [
+            {
+              "text": "'https://accounts.example.com/logout'",
+              "name": "example"
+            }
+          ],
+          "docs": "Custom logout URL for ending the session",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "logsEnabled",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Enable debug logging",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
     {
       "name": "FacebookLoginResponse",
       "slug": "facebookloginresponse",
@@ -585,6 +757,75 @@
         }
       ]
     },
+    {
+      "name": "OAuth2LoginResponse",
+      "slug": "oauth2loginresponse",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "providerId",
+          "tags": [],
+          "docs": "The provider ID that was used for this login",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "accessToken",
+          "tags": [],
+          "docs": "The access token received from the OAuth provider",
+          "complexTypes": [
+            "AccessToken"
+          ],
+          "type": "AccessToken | null"
+        },
+        {
+          "name": "idToken",
+          "tags": [],
+          "docs": "The ID token (JWT) if provided by the OAuth server (e.g., OpenID Connect)",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "refreshToken",
+          "tags": [],
+          "docs": "The refresh token if provided (requires appropriate scope like offline_access)",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "resourceData",
+          "tags": [],
+          "docs": "Resource data fetched from resourceUrl if configured\nContains the raw JSON response from the resource endpoint",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown> | null"
+        },
+        {
+          "name": "scope",
+          "tags": [],
+          "docs": "The scopes that were granted",
+          "complexTypes": [],
+          "type": "string[]"
+        },
+        {
+          "name": "tokenType",
+          "tags": [],
+          "docs": "Token type (usually 'bearer')",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "expiresIn",
+          "tags": [],
+          "docs": "Token expiration time in seconds",
+          "complexTypes": [],
+          "type": "number | null"
+        }
+      ]
+    },
     {
       "name": "FacebookLoginOptions",
       "slug": "facebookloginoptions",
@@ -901,6 +1142,64 @@
         }
       ]
     },
+    {
+      "name": "OAuth2LoginOptions",
+      "slug": "oauth2loginoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "providerId",
+          "tags": [
+            {
+              "text": "'github', 'azure', 'keycloak'",
+              "name": "example"
+            }
+          ],
+          "docs": "The provider ID as configured in initialize()\nThis is required to identify which OAuth2 provider to use",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "scope",
+          "tags": [],
+          "docs": "Override the scopes for this login request\nIf not provided, uses the scopes from initialization",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "state",
+          "tags": [],
+          "docs": "Custom state parameter for CSRF protection\nIf not provided, a random value is generated",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "codeVerifier",
+          "tags": [],
+          "docs": "Override PKCE code verifier (for testing purposes)\nIf not provided, a secure random verifier is generated",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "redirectUrl",
+          "tags": [],
+          "docs": "Override redirect URL for this login request",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "additionalParameters",
+          "tags": [],
+          "docs": "Additional parameters to add to the authorization URL",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, string>"
+        }
+      ]
+    },
     {
       "name": "isLoggedInOptions",
       "slug": "isloggedinoptions",
@@ -918,7 +1217,19 @@
           ],
           "docs": "Provider",
           "complexTypes": [],
-          "type": "'apple' | 'google' | 'facebook' | 'twitter'"
+          "type": "'apple' | 'google' | 'facebook' | 'twitter' | 'oauth2'"
+        },
+        {
+          "name": "providerId",
+          "tags": [
+            {
+              "text": "The ID used when configuring the OAuth2 provider in initialize()",
+              "name": "description"
+            }
+          ],
+          "docs": "Provider ID for OAuth2 providers (required when provider is 'oauth2')",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ]
     },
@@ -972,7 +1283,19 @@
           ],
           "docs": "Provider",
           "complexTypes": [],
-          "type": "'apple' | 'google' | 'facebook' | 'twitter'"
+          "type": "'apple' | 'google' | 'facebook' | 'twitter' | 'oauth2'"
+        },
+        {
+          "name": "providerId",
+          "tags": [
+            {
+              "text": "The ID used when configuring the OAuth2 provider in initialize()",
+              "name": "description"
+            }
+          ],
+          "docs": "Provider ID for OAuth2 providers (required when provider is 'oauth2')",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ]
     },
@@ -1032,18 +1355,33 @@
   ],
   "enums": [],
   "typeAliases": [
+    {
+      "name": "Record",
+      "slug": "record",
+      "docs": "Construct a type with a set of properties K of type T",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T;\r\n}",
+          "complexTypes": [
+            "K",
+            "T"
+          ]
+        }
+      ]
+    },
     {
       "name": "ProviderResponseMap",
       "slug": "providerresponsemap",
       "docs": "",
       "types": [
         {
-          "text": "{\n  facebook: FacebookLoginResponse;\n  google: GoogleLoginResponse;\n  apple: AppleProviderResponse;\n  twitter: TwitterLoginResponse;\n}",
+          "text": "{\n  facebook: FacebookLoginResponse;\n  google: GoogleLoginResponse;\n  apple: AppleProviderResponse;\n  twitter: TwitterLoginResponse;\n  oauth2: OAuth2LoginResponse;\n}",
           "complexTypes": [
             "FacebookLoginResponse",
             "GoogleLoginResponse",
             "AppleProviderResponse",
-            "TwitterLoginResponse"
+            "TwitterLoginResponse",
+            "OAuth2LoginResponse"
           ]
         }
       ]
@@ -1095,6 +1433,12 @@
           "complexTypes": [
             "TwitterLoginOptions"
           ]
+        },
+        {
+          "text": "{\n      provider: 'oauth2';\n      options: OAuth2LoginOptions;\n    }",
+          "complexTypes": [
+            "OAuth2LoginOptions"
+          ]
         }
       ]
     },
@@ -1167,20 +1511,6 @@
           ]
         }
       ]
-    },
-    {
-      "name": "Record",
-      "slug": "record",
-      "docs": "Construct a type with a set of properties K of type T",
-      "types": [
-        {
-          "text": "{\r\n    [P in K]: T;\r\n}",
-          "complexTypes": [
-            "K",
-            "T"
-          ]
-        }
-      ]
     }
   ],
   "pluginConfigs": []