Breaking change in V6

In the v6 version, clientId in the initialize method is used in priority over other places you could set up. If before you were using this only on the web, unset it on mobile. Or set it conditionally to replicate old behavior.

Contributions

PRs are welcome and much appreciated that keeps this plugin up to date with Capacitor and official Google Auth platform library feature parity.

Try to follow good code practices. You can even help keeping the included demo updated.

PRs for features that are not aligned with the official Google Auth library are discouraged.

(We are beginner-friendly here)

Install

1. Install package

npm i --save @codetrix-studio/capacitor-google-auth

# pnpm 
pnpm add @codetrix-studio/capacitor-google-auth

# yarn 
yarn add @codetrix-studio/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 '@codetrix-studio/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 scopes
• grantOfflineAccess – boolean, default false, 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 "@codetrix-studio/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 '@codetrix-studio/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

1. Create in Google cloud console credential Client ID for iOS and get Client ID and iOS URL scheme

2. Add identifier REVERSED_CLIENT_ID as URL schemes to Info.plist from iOS URL scheme (Xcode: App - Targets/App - Info - URL Types, click plus icon)

3. Set Client ID one of the ways (by order of importance in the plugin):

   1. Set clientId in initialize method
   2. Set iosClientId in capacitor.config.json
   3. Set clientId in capacitor.config.json
   4. Set CLIENT_ID in GoogleService-Info.plist

Android

Set Client ID (by order of importance in the plugin):

1. Set clientId in initialize method
2. Set androidClientId in capacitor.config.json
3. Set clientId in capacitor.config.json
4. Set server_client_id in 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="'@codetrix-studio/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(...)
• signIn()
• refresh()
• signOut()
• Interfaces

initialize(...)

initialize(options?: InitOptions) => void

Initializes the GoogleAuthPlugin, loading the gapi library and setting up the plugin.

| Param | Type | Description | | ------------- | --------------------------------------------------- | ---------------------------------- | | options | InitOptions | - Optional initialization options. |

Since: 3.1.0

signIn()

signIn() => Promise<User>

Initiates the sign-in process and returns a Promise that resolves with the user information.

Returns: Promise<User>

refresh()

refresh() => Promise<Authentication>

Refreshes the authentication token and returns a Promise that resolves with the updated authentication details.

Returns: Promise<Authentication>

signOut()

signOut() => Promise<any>

Signs out the user and returns a Promise.

Returns: Promise<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 | string[] | Specifies the scopes required for accessing Google APIs The default is defined in the configuration. | | 3.4.0-rc.4 | | 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. |

Migration guide

Migrate from 3.3.x to 3.4.x

Install version 3.4.x:

npm i --save @codetrix-studio/capacitor-google-auth@^3.4

Follow instruction for you project Updating to Capacitor 6.

Migrate from 3.2.x to 3.3.x

Install version 3.3.x:

npm i --save @codetrix-studio/capacitor-google-auth^3.3

Follow instruction for you project Updating from Capacitor 4 to Capacitor 5.

Migrate from 3.2.1 to 3.2.2

for Android in file MainActivity.onCreate

- this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
-   add(GoogleAuth.class);
- }});
+ this.registerPlugin(GoogleAuth.class);

Migrate from 3.1.x to 3.2.x

Install version 3.2.x:

npm i --save @codetrix-studio/capacitor-google-auth^3.2

Follow instruction for you project Updating from Capacitor 3 to Capacitor 4.

Migrate from 3.0.2 to 3.1.0

- GoogleAuth.init()
+ GoogleAuth.initialize()

Migrate from 2 to 3

Install version 3.x.x:

npm i --save @codetrix-studio/capacitor-google-auth^3.0

After migrate to Capcitor 3 updating you projects, see diff:

WEB

- import "@codetrix-studio/capacitor-google-auth";
- import { Plugins } from '@capacitor/core';
+ import { GoogleAuth } from '@codetrix-studio/capacitor-google-auth'

- Plugins.GoogleAuth.signIn();
+ GoogleAuth.init()
+ GoogleAuth.signIn()

Migrate from 1 to 2

Install version 2.x.x:

npm i --save @codetrix-studio/capacitor-google-auth@2

for capacitor 2.x.x use instruction

License

MIT