// JCB: BASED ON https://github.com/CodetrixStudio/CapacitorGoogleAuth

// Work only for the web

Install

1. Install package

npm i jcb-capacitor-googleauth

2. Update capacitor deps

npx cap update

Usage

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

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();

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>

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;

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. |

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. |

License

MIT