@belongnet/capacitor-google-auth
v6.0.0-rc.0
Published
Google Auth plugin for capacitor.
Downloads
100
Readme
Install
1. Install package
npm i --save @belongnet/capacitor-google-auth
# pnpm
pnpm add @belongnet/capacitor-google-auth
# yarn
yarn add @belongnet/capacitor-google-auth
2. Update capacitor deps
npx cap update
Updating
If need migrate to different Capacitor versions see instruction for migrate plugin to new version.
Usage
WEB
Register plugin and manually initialize
import { GoogleAuth } from '@belongnet/capacitor-google-auth';
// use hook after platform dom ready
GoogleAuth.initialize({
clientId: 'CLIENT_ID.apps.googleusercontent.com',
scopes: ['profile', 'email'],
grantOfflineAccess: true,
});
or if need use meta tags (Optional):
<meta name="google-signin-client_id" content="{your client id here}" />
<meta name="google-signin-scope" content="profile email" />
Options
clientId
- The app's client ID, found and created in the Google Developers Console.scopes
– same as Configure scopesgrantOfflineAccess
– boolean, defaultfalse
, Set if your application needs to refresh access tokens when the user is not present at the browser.
Use it
GoogleAuth.signIn();
Angular
init hook
// app.component.ts
constructor() {
this.initializeApp();
}
initializeApp() {
this.platform.ready().then(() => {
GoogleAuth.initialize()
})
}
sign in function
import { GoogleAuth } from "@belongnet/capacitor-google-auth";
import { Auth, GoogleAuthProvider, signInWithCredential } from '@angular/fire/auth';
async googleSignIn() {
let googleUser = await GoogleAuth.signIn();
/*
If you use Firebase you can forward and use the logged in Google user like this:
*/
constructor(private auth: Auth){}
const googleUser = await GoogleAuth.signIn();
const _credential = GoogleAuthProvider.credential(googleUser.authentication.idToken);
return signInWithCredential(this.auth, _credential);
}
Vue 3
<script setup lang="ts">
import { defineComponent, onMounted } from 'vue';
import { GoogleAuth } from '@belongnet/capacitor-google-auth';
onMounted(() => {
GoogleAuth.initialize();
});
async function logIn() {
const response = await GoogleAuth.signIn();
console.log(response);
}
</script>
or see more CapacitorGoogleAuth-Vue3-example
iOS
Create in Google cloud console credential Client ID for iOS and get Client ID and iOS URL scheme
Add identifier
REVERSED_CLIENT_ID
as URL schemes toInfo.plist
from iOS URL scheme (Xcode: App - Targets/App - Info - URL Types, click plus icon)Set Client ID one of the ways:
- Set in
capacitor.config.json
iosClientId
- specific key for iOSclientId
- or common key for Android and iOS
- Download
GoogleService-Info.plist
file withCLIENT_ID
and copy to ios/App/App necessarily through Xcode for indexing.
- Set in
plugin first use iosClientId
if not found use clientId
if not found use value CLIENT_ID
from file GoogleService-Info.plist
Maybe need re-check structure manually in Info.plist
, it should be like this:
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLName</key>
<string>REVERSED_CLIENT_ID</string>
<key>CFBundleURLSchemes</key>
<array>
<string>com.googleusercontent.apps.xxxxxx-xxxxxxxxxxxxxxxxxx</string>
</array>
</dict>
</array>
Is you don't use capacitor config, you can set clientId in initialize
method specifically for platform:
clientId:
Capacitor.getPlatform() === 'ios'
? import.meta.env.VITE_GOOGLE_CLIENT_ID_IOS
: import.meta.env.VITE_GOOGLE_CLIENT_ID,
Android
Set Client ID :
In
capacitor.config.json
androidClientId
- specific key for AndroidclientId
- or common key for Android and iOS
or set inside your
strings.xml
plugin first use androidClientId
if not found use clientId
if not found use value server_client_id
from file strings.xml
<resources>
<string name="server_client_id">Your Web Client Key</string>
</resources>
Changing Play Services Auth version (Optional) :
This plugin uses com.google.android.gms:play-services-auth:21.2.0
by default, you can override it providing gmsPlayServicesAuthVersion
at variables.gradle
Refresh method
This method should be called when the app is initialized to establish if the user is currently logged in. If true, the method will return an accessToken, idToken and an empty refreshToken.
checkLoggedIn() {
GoogleAuth.refresh()
.then((data) => {
if (data.accessToken) {
this.currentTokens = data;
}
})
.catch((error) => {
if (error.type === 'userLoggedOut') {
this.signin()
}
});
}
Configure
| Name | Type | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------- | | clientId | string | The app's client ID, found and created in the Google Developers Console. | | iosClientId | string | Specific client ID key for iOS | | androidClientId | string | Specific client ID key for Android | | scopes | string[] | Scopes that you might need to request to access Google APIshttps://developers.google.com/identity/protocols/oauth2/scopes | | serverClientId | string | This ClientId used for offline access and server side handling | | forceCodeForRefreshToken | boolean | Force user to select email address to regenerate AuthCode used to get a valid refreshtoken (work on iOS and Android) |
Provide configuration in root capacitor.config.json
{
"plugins": {
"GoogleAuth": {
"scopes": ["profile", "email"],
"serverClientId": "xxxxxx-xxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
"forceCodeForRefreshToken": true
}
}
}
or in capacitor.config.ts
/// <reference types="'@belongnet/capacitor-google-auth'" />
const config: CapacitorConfig = {
plugins: {
GoogleAuth: {
scopes: ['profile', 'email'],
serverClientId: 'xxxxxx-xxxxxxxxxxxxxxxxxx.apps.googleusercontent.com',
forceCodeForRefreshToken: true,
},
},
};
export default config;
Note: scopes can be configured under initialize function.
API
initialize(...)
initialize(options?: InitOptions) => any
Initializes the GoogleAuthPlugin, loading the gapi library and setting up the plugin.
| Param | Type | Description |
| ------------- | --------------------------------------------------- | ---------------------------------- |
| options
| InitOptions | - Optional initialization options. |
Returns: any
Since: 3.1.0
signIn()
signIn() => any
Initiates the sign-in process and returns a Promise that resolves with the user information.
Returns: any
refresh()
refresh() => any
Refreshes the authentication token and returns a Promise that resolves with the updated authentication details.
Returns: any
signOut()
signOut() => any
Signs out the user and returns a Promise.
Returns: any
Interfaces
InitOptions
| Prop | Type | Description | Default | Since |
| ------------------------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ----- |
| clientId
| string | The app's client ID, found and created in the Google Developers Console. Common for Android or iOS. The default is defined in the configuration. | | 3.1.0 |
| scopes
| {} | Specifies the scopes required for accessing Google APIs The default is defined in the configuration. | | |
| grantOfflineAccess
| boolean | Set if your application needs to refresh access tokens when the user is not present at the browser. In response use serverAuthCode
key | false | 3.1.0 |
User
| Prop | Type | Description |
| -------------------- | --------------------------------------------------------- | ------------------------------------------------------------------- |
| id
| string | The unique identifier for the user. |
| email
| string | The email address associated with the user. |
| name
| string | The user's full name. |
| familyName
| string | The family name (last name) of the user. |
| givenName
| string | The given name (first name) of the user. |
| imageUrl
| string | The URL of the user's profile picture. |
| serverAuthCode
| string | The server authentication code. |
| authentication
| Authentication | The authentication details including access, refresh and ID tokens. |
Authentication
| Prop | Type | Description |
| ------------------ | ------------------- | ------------------------------------------------ |
| accessToken
| string | The access token obtained during authentication. |
| idToken
| string | The ID token obtained during authentication. |
| refreshToken
| string | The refresh token. |