Releases: googleapis/google-auth-library-nodejs
1.3.0
This release has it all. Bug fixes, new features, and improved test coverage! Here are some highlights.
Easy mode
This release includes a bunch of the features available in google-auto-auth. This makes it really easy to get started with service credentials. You can easily grab and use application default credentials:
const { auth } = require('google-auth-library');
async function main() {
const client = await auth.getClient();
const projectId = await auth.getDefaultProjectId();
const url = `https://www.googleapis.com/dns/v1/projects/${projectId}`;
const res = await client.request({ url });
console.log(res.data);
}
main().catch(console.error);Or easily use the client to authorize a request:
const { auth } = require('google-auth-library');
const axios = require('axios');
async function main() {
const client = await auth.getClient();
const projectId = await auth.getDefaultProjectId();
const url = `https://www.googleapis.com/dns/v1/projects/${projectId}`;
const opts = await auth.authorizeRequest();
const res = await axios.get(url, opts);
console.log(res.data);
}
main().catch(console.error);Commits in this release
64a1bd0 feat: add auto auth features (#281)
4d0c49d chore(package): update gcp-metadata to version 0.6.0 (#288)
60c5a1e chore: upgrade to TypeScript 2.7 (#289)
80c439a chore: upgrade all the things (#292)
5699b90 fix: cache GCE credentials (#286)
12feb2c test: improve coverage (#287)
7a951e0 fix: retry connections to gce metadata server (#284)
78d6813 fix: do not retry if a post with readable stream (#279)
3c9efe5 chore: use gcp-metadata (#278)
1.2.1
1.2.0
New Features
0803242 feat: add IAP and additional claims support (#268)
7d89b2c feat: add example of puppeteer (#265)
a570126 feat: Add given_name and family_name to TokenPayload interface (#260)
Bug Fixes
730d4b7 fix: Update GCE metadata token endpoint (#269)
17a56a6 fix: update links in readme (#262)
1.1.0
This release includes a few new features, and a few bug fixes.
New Features
f9950b0 feat: cache JWT tokens in JWTAccess (#254)
7e9a390 feat: Add ability to refresh token automatically before expiration. (#242)
014ce0b feat: export static GoogleAuth (#249)
Fixes
c3ce4f1 fix: Fix samples/jwt.js link in README (#253)
64fb34d fix: update usage of OAuth2Client.verifyIdToken in example (#243)
771bc6c fix: use npm link to run samples (#245)
1.0.0
TL;DR - This release includes a variety of bug fixes, new features, and breaking changes. Please take care.
New Features
TypeScript support
This library now includes a d.ts file by default - no @types package needed.
Promise & Async/Await style APIs
Previous versions of the API were callback only. For every API that was callback based, there is also a Promise or Async/Await style variant. For example:
/**
* You can use an errback style API
**/
auth.getApplicationDefault(function(err, client) {
if (err) {
console.log('Authentication failed because of ', err);
return;
}
// make request...
});
/**
* Or if you're using Babel, TypeScript, or Node.js 8+ you can use async/await
**/
try {
const client = await auth.getApplicationDefault();
// make request...
} catch (err) {
console.log('Authentication failed because of ', err);
}
/**
* Or, you can just use promises
**/
auth.getApplicationDefault()
.then(client => {
// make request
})
.catch(err => {
console.log('Authentication failed because of ', err);
});Ability to set maxExpiry when verifying tokens
The OAuth2Client.verifyIdToken method now accepts an optional maxExpiry field:
const result = await client.verifyIdToken({
idToken: <id Token>,
audience: <audience>,
maxExpiry: <max expiry>
});Support for code_verifier and code_challenge with OAuth2
The OAuth2Client.generateAuthUrl method has been extended to support the code_challenge_method and code_challenge fields. There is also a convenience method to generate a verifier:
// Generate a code_verifier and code_challenge
const codes = oAuth2Client.generateCodeVerifier();
// Generate the url that will be used for the consent dialog.
const authorizeUrl = oAuth2Client.generateAuthUrl({
access_type: 'offline',
scope: 'https://www.googleapis.com/auth/plus.me',
code_challenge_method: 'S256',
code_challenge: codes.codeChallenge
});Breaking changes
There have been multiple API breaking changes with this release. Please test your code accordingly after upgrading.
Default exports
The exports on the google-auth-library have changed. The default export of the library was previously a reference to the GoogleAuth type, which was instantiated as a starting point for all consumers. Now, the module has no default export, but exports several other types common used.
// OLD CODE
var GoogleAuth = require('google-auth-library');
var auth = new GoogleAuth();
var jwtClient = new auth.JWT();
var oAuth2Client = new auth.OAuth2();
...
// NEW CODE
const gal = require('google-auth-library');
const auth = new gal.GoogleAuth();
const jwtClient = new gal.JWT();
const oAuth2Client = new gal.OAuth2Client();
...
// if you're using Node 6+, you might find this convenient:
const {GoogleAuth, JWT, OAuth2Client} = require('google-auth-library');If you're using es6 imports via TypeScript or Babel, you can use es6 style as well:
import {GoogleAuth, OAuth2Client} from 'google-auth-library';
const auth = new GoogleAuth();
...Synchronous methods
Several public methods were switched from asynchronous to synchronous APIs. In all cases, the APIs were not doing anything asynchronous - they were just providing errors in callback form. This has been changed.
// OLD CODE
var auth = new GoogleAuth();
auth.fromJSON(input, function (err, client) {
if (err) {
console.error('Error acquiring client: ' + err);
}
// make request with client ...
});
// NEW CODE
const auth = new GoogleAuth();
const client = auth.fromJSON(input);
// make request with client ...This change was made with the following methods:
GoogleAuth.fromJSONGoogleAuth.fromAPIKeyJWTAccess. getRequestMetadataJWTAccess.fromJSONJWTClient.fromJSONJWTClient.fromAPIKeyUserRefreshClient.fromJSON
Request -> Axios
The underlying transport used for HTTP requests was changed from request to axios. This will result in a number of breaking changes.
Any calls to the client.request(opts) method will both accept different parameters, and have different return types. For the options passed to these methods, they are changing from a request options object to an axios request options object.
In addition to the properties on the opts object changing, the signature of the callback is changing as well. The previous version of the library would return objects with a callback that reversed request's default order: function (err, body, response). The signature of that callback has simply been changed to function (err, response), where the body of the response is available by looking at response.data.
// OLD CODE
oAuth2Client.request({
uri: 'https://www.googleapis.com/plus/v1/people?query=pizza'
}, function (err, body, res) {
console.log('The body of the response was ' + body);
});
// NEW CODE (using callbacks)
oAuth2Client.request({
// note that we're using `url` instead of `uri` here, per the Axios request config.
url: 'https://www.googleapis.com/plus/v1/people?query=pizza'
}, function (err, res) {
// The body isn't returned as part of the callback, and is available from `res.data`
console.log(`The body of the response was ${res.data}`);
});
// NEW CODE (using async/await)
const res = await oAuth2Client.request({
url: 'https://www.googleapis.com/plus/v1/people?query=pizza'
});
console.log(`The body of the response was ${res.data}`);In addition to these changes - the request and axios libraries handle errors differently. request treats any completed request, even if it returns a non 2xx response code, as a success. The err parameter will be null or undefined. axios treats any non 2xx response as an error. Code which may have previous not worked, but also not thrown errors - may now start throwing errors.
Parameter change for verifyIdToken
The parameters to the verifyIdToken method of OAuth2Client have been changed. The function now accepts a single options object, and an optional callback. A function that used to look like this:
oAuth2Client.verifyIdToken(idToken, audience, callback);Would now be rewritten as this:
oAuth2Client.verifyIdToken({
idToken: idToken,
audience: audience
}, callback);1.0.0-alpha.1
TL;DR - This release includes a variety of bug fixes, new features, and breaking changes. Please take care.
New Features
TypeScript support
This library now includes a d.ts file by default - no @types package needed.
Promise & Async/Await style APIs
Previous versions of the API were callback only. For every API that was callback based, there is also a Promise or Async/Await style variant. For example:
/**
* You can use an errback style API
**/
auth.getApplicationDefault(function(err, client) {
if (err) {
console.log('Authentication failed because of ', err);
return;
}
// make request...
});
/**
* Or if you're using Babel, TypeScript, or Node.js 8+ you can use async/await
**/
try {
const client = await auth.getApplicationDefault();
// make request...
} catch (err) {
console.log('Authentication failed because of ', err);
}
/**
* Or, you can just use promises
**/
auth.getApplicationDefault()
.then(client => {
// make request
})
.catch(err => {
console.log('Authentication failed because of ', err);
});Breaking changes
There have been multiple API breaking changes with this release. Please test your code accordingly after upgrading.
Default exports
The exports on the google-auth-library have changed. The default export of the library was previously a reference to the GoogleAuth type, which was instantiated as a starting point for all consumers. Now, the module has no default export, but exports several other types common used.
// OLD CODE
var GoogleAuth = require('google-auth-library');
var auth = new GoogleAuth();
var jwtClient = new auth.JWT();
var oAuth2Client = new auth.OAuth2();
...
// NEW CODE
const gal = require('google-auth-library');
const auth = new gal.GoogleAuth();
const jwtClient = new gal.JWT();
const oAuth2Client = new gal.OAuth2Client();
...If you're using es6 imports via TypeScript or Babel, you can use es6 style as well:
import {GoogleAuth, OAuth2Client} from 'google-auth-library';
const auth = new GoogleAuth();
...Synchronous methods
Several public methods were switched from asynchronous to synchronous APIs. In all cases, the APIs were not doing anything asynchronous - they were just providing errors in callback form. This has been changed.
// OLD CODE
var auth = new GoogleAuth();
auth.fromJSON(input, function (err, client) {
if (err) {
console.error('Error acquiring client: ' + err);
}
// make request with client ...
});
// NEW CODE
const auth = new GoogleAuth();
const client = auth.fromJSON(input);
// make request with client ...This change was made with the following methods:
GoogleAuth.fromJSONGoogleAuth.fromAPIKeyJWTAccess. getRequestMetadataJWTAccess.fromJSONJWTClient.fromJSONJWTClient.fromAPIKeyUserRefreshClient.fromJSON
Request -> Axios
The underlying transport used for HTTP requests was changed from request to axios. This will result in a number of breaking changes.
Any calls to the client.request(opts) method will both accept different parameters, and have different return types. For the options passed to these methods, they are changing from a request options object to an axios request options object.
In addition to the properties on the opts object changing, the signature of the callback is changing as well. The previous version of the library would return objects with a callback that reversed request's default order: function (err, body, response). The signature of that callback has simply been changed to function (err, response), where the body of the response is available by looking at response.data.
// OLD CODE
oAuth2Client.request({
uri: 'https://www.googleapis.com/plus/v1/people?query=pizza'
}, function (err, body, res) {
console.log('The body of the response was ' + body);
});
// NEW CODE (using callbacks)
oAuth2Client.request({
// note that we're using `url` instead of `uri` here, per the Axios request config.
url: 'https://www.googleapis.com/plus/v1/people?query=pizza'
}, function (err, res) {
// The body isn't returned as part of the callback, and is available from `res.data`
console.log(`The body of the response was ${res.data}`);
});
// NEW CODE (using async/await)
const res = await oAuth2Client.request({
url: 'https://www.googleapis.com/plus/v1/people?query=pizza'
});
console.log(`The body of the response was ${res.data}`);In addition to these changes - the request and axios libraries handle errors differently. request treats any completed request, even if it returns a non 2xx response code, as a success. The err parameter will be null or undefined. axios treats any non 2xx response as an error. Code which may have previous not worked, but also not thrown errors - may now start throwing errors.
v0.12.0 getCredentials
Adds a new getCredentials method that can be used to retrieve credentials, either from the previously user provided key, or from the metadata service.
Changes
0.11.0: Now in TypeScript
This is semver major release, but we expect there will be minimal impact to existing users of the library.
Here's a list of notable changes:
- [semver major] Treat 4xx and 5xx responses as errors (#149)
- The module has been migrated to TypeScript. While there has been an effort to ensure that this doesn't introduce semver major differences, there is a possibility that minor differences exist as a result of transpilation.
- In a future release we will no longer support deep loading of files within this module. For example no semver guarantees are being provided for the internal directory layout of the module.
0.10.0
0.9.10
- Detect project ID from default application credentials