google-oauth2-x

Google OAuth2 X

Consent screen

Simply extend the GoogleAuth class and override the openConsentScreen_() method, which should return a Promise<string redirectedUrl>.

Consent screen for electron app

const GoogleAuth = require('google-oauth2-x');
const {shell} = require('electron');
 
class ElectronGoogleAuth extends GoogleAuth {
    openConsentScreen_() {
        return new Promise(resolve => {
            let server = http.createServer((req, res) => {
                resolve(req.url);
                res.end('thanks');
                server.close();
            }).listen();
            let port = server.address().port;
            let endpoint = this.getConsentScreenEndpoint_(`http://localhost:${port}`);
            
            shell.openExternal(endpoint); // electron
        });
    }
}

Consent screen for node app

Replace electron.shell with child_process.exec:

const GoogleAuth = require('google-oauth-2');
const {exec} = require('child_process');
 
class NodeGoogleAuth extends GoogleAuth {
    openConsentScreen_() {
        return new Promise(resolve => {
            let server = http.createServer((req, res) => {
                resolve(req.url);
                res.end('thanks');
                server.close();
            }).listen();
            let port = server.address().port;
            let endpoint = this.getConsentScreenEndpoint_(`http://localhost:${port}`);
            
            exec('start https://google.com') // windows
        });
    }
}

API

new GoogleAuth(string credentialsPath, string tokensPath, string scope)

Promise<string token> getToken()

1. Return the access token if there is one.
2. Otherwise, refresh the access token using the refresh token if there is one.
3. Otherwise, retrieve a refresh token through a consent screen.

Promise<string token> getRefreshedToken(bool force = false)

Same as getToken but will skip directly to step 2. If force is false (default), then multiple calls to getRefreshedToken while a refresh is in progress are safe; i.e. they will not refresh the token multiple times.

Promise<string token> getCleanToken(bool force = false)

Same as getToken but will skip directly to step 3. If force is false (default), then multiple calls to getCleanToken while a clean is in progress are safe; i.e. they will not open multiple consent screens or fetch multiple refresh tokens. This can be used to switch authentication accounts.

Example Usage

let youtubeAuth = new GoogleAuth(
    'resources/credentials.json',
    'appWorkingDir/tokens.json',
    'https://www.googleapis.com/auth/youtube');
 
let main = async () => { 
    console.log(await youtubeAuth.getToken()); // xyz
    console.log(await youtubeAuth.getToken()); // xyz
    console.log(await youtubeAuth.getRefreshedToken()); // uvw
    console.log(await youtubeAuth.getRefreshedToken()); // uvw
    console.log(await youtubeAuth.getToken()); // uvw
    console.log(await youtubeAuth.getRefreshedToken()); // rst
    console.log(await youtubeAuth.getRefreshedToken(true)); // opq
    console.log(await youtubeAuth.getToken()); // opq
};
main();