CHANGELOG.md
48.9 KB
Changelog
7.0.4 (2021-04-06)
Bug Fixes
7.0.3 (2021-03-23)
Bug Fixes
7.0.2 (2021-02-10)
Bug Fixes
7.0.1 (2021-02-09)
Bug Fixes
7.0.0 (2021-02-08)
⚠ BREAKING CHANGES
- integrates external_accounts with
GoogleAuthand ADC (#1052) - workload identity federation support (#1131)
Features
- adds service account impersonation to
ExternalAccountClient(#1041) (997f124) - adds text/json credential_source support to IdentityPoolClients (#1059) (997f124)
- defines
ExternalAccountClientused to instantiate external account clients (#1050) (997f124) - defines
IdentityPoolClientused for K8s and Azure workloads (#1042) (997f124) - defines ExternalAccountClient abstract class for external_account credentials (#1030) (997f124)
- get AWS region from environment variable (#1067) (997f124)
- implements AWS signature version 4 for signing requests (#1047) (997f124)
- implements the OAuth token exchange spec based on rfc8693 (#1026) (997f124)
- integrates external_accounts with
GoogleAuthand ADC (#1052) (997f124) - workload identity federation support (#1131) (997f124)
Bug Fixes
- deps: update dependency puppeteer to v6 (#1129) (5240fb0)
- deps: update dependency puppeteer to v7 (#1134) (02d0d73)
6.1.6 (2021-01-27)
Bug Fixes
6.1.5 (2021-01-22)
Bug Fixes
6.1.4 (2020-12-22)
Bug Fixes
6.1.3 (2020-10-22)
Bug Fixes
6.1.2 (2020-10-19)
Bug Fixes
6.1.1 (2020-10-06)
Bug Fixes
6.1.0 (2020-09-22)
Features
6.0.8 (2020-08-13)
Bug Fixes
6.0.7 (2020-08-11)
Bug Fixes
6.0.6 (2020-07-30)
Bug Fixes
6.0.5 (2020-07-13)
Bug Fixes
6.0.4 (2020-07-09)
Bug Fixes
6.0.3 (2020-07-06)
Bug Fixes
6.0.2 (2020-06-16)
Bug Fixes
- deps: update dependency puppeteer to v4 (#976) (9ddfb9b)
- tsc: audience property is not mandatory on verifyIdToken (#972) (17a7e24)
- types: add locale property to idtoken (#974) (ebf9bed), closes #973
6.0.1 (2020-05-21)
Bug Fixes
- deps: update dependency google-auth-library to v6 (#930) (81fdabe)
- apache license URL (#468) (#936) (53831cf)
- deps: update dependency puppeteer to v3 (#944) (4d6fba0)
- fixing tsc error caused by @types/node update (#965) (b94edb0)
- gcp-metadata now warns rather than throwing (#956) (89e16c2)
6.0.0 (2020-03-26)
⚠ BREAKING CHANGES
- typescript@3.7.x introduced some breaking changes in generated code.
- require node 10 in engines field (#926)
- remove deprecated methods (#906)
Features
Bug Fixes
- do not warn for SDK creds (#905) (9536840)
- use iamcredentials API to sign blobs (#908) (7b8e4c5)
- deps: update dependency gaxios to v3 (#917) (1f4bf61)
- deps: update dependency gcp-metadata to v4 (#918) (d337131)
- types: add additional fields to TokenInfo (#907) (5b48eb8)
Build System
Miscellaneous Chores
5.10.1 (2020-02-25)
Bug Fixes
5.10.0 (2020-02-20)
Features
Bug Fixes
5.9.2 (2020-01-28)
Bug Fixes
5.9.1 (2020-01-16)
Bug Fixes
5.9.0 (2020-01-14)
Features
- add methods for fetching and using id tokens (#867) (8036f1a)
- export LoginTicket and TokenPayload (#870) (539ea5e)
5.8.0 (2020-01-06)
Features
Bug Fixes
5.7.0 (2019-12-10)
Features
5.6.1 (2019-12-05)
Bug Fixes
- deps: pin TypeScript below 3.7.0 (#845) (a9c6e92)
- docs: improve types and docs for generateCodeVerifierAsync (#840) (04dae9c)
5.6.0 (2019-12-02)
Features
- populate x-goog-user-project for requestAsync (#837) (5a068fb)
- set x-goog-user-project header, with quota_project from default credentials (#829) (3240d16)
Bug Fixes
- deps: update dependency puppeteer to v2 (#821) (2c04117)
- docs: add jsdoc-region-tag plugin (#826) (558677f)
- expand on x-goog-user-project to handle auth.getClient() (#831) (3646b7f)
- use quota_project_id field instead of quota_project (#832) (8933966)
5.5.1 (2019-10-22)
Bug Fixes
- deps: update gaxios dependency (#817) (6730698)
- don't append x-goog-api-client multiple times (#820) (a46b271)
5.5.0 (2019-10-14)
Features
5.4.1 (2019-10-10)
Bug Fixes
5.4.0 (2019-10-08)
Features
5.3.0 (2019-09-27)
Features
5.2.2 (2019-09-17)
Bug Fixes
5.2.1 (2019-09-06)
Bug Fixes
- deps: nock@next has types that work with our libraries (#783) (a253709)
- docs: fix variable name in README.md (#782) (d8c70b9)
5.2.0 (2019-08-09)
Features
5.1.2 (2019-08-05)
Bug Fixes
5.1.1 (2019-07-29)
Bug Fixes
5.1.0 (2019-07-24)
Features
5.0.0 (2019-07-23)
⚠ BREAKING CHANGES
- getOptions() no longer accepts GoogleAuthOptions (#749)
Code Refactoring
4.2.6 (2019-07-23)
Bug Fixes
4.2.5 (2019-06-26)
Bug Fixes
4.2.4 (2019-06-25)
Bug Fixes
4.2.3 (2019-06-24)
Bug Fixes
4.2.2 (2019-06-18)
Bug Fixes
4.2.1 (2019-06-14)
Bug Fixes
4.2.0 (2019-06-05)
Bug Fixes
Features
4.1.0 (2019-05-29)
Bug Fixes
Features
4.0.0 (2019-05-08)
Bug Fixes
- deps: update dependency arrify to v2 (#684) (1757ee2)
- deps: update dependency gaxios to v2 (#681) (770ad2f)
- deps: update dependency gcp-metadata to v2 (#701) (be20528)
- deps: update dependency gtoken to v3 (#702) (2c538e5)
- re-throw original exception and preserve message in compute client (#668) (dffd1cc)
- surface original stack trace and message with errors (#651) (8fb65eb)
- throw on missing refresh token in all cases (#670) (0a02946)
- throw when adc cannot acquire a projectId (#658) (ba48164)
- deps: update dependency semver to v6 (#655) (ec56c88)
Build System
Features
BREAKING CHANGES
- upgrade engines field to >=8.10.0 (#686)
v3.1.2
03-22-2019 15:38 PDT
Implementation Changes
- fix: getCredential(): load credentials with getClient() (#648)
Internal / Testing Changes
- chore: publish to npm using wombat (#645)
v3.1.1
03-18-2019 08:32 PDT
Bug Fixes
- fix: Avoid loading fast-text-encoding if not in browser environment (#627)
Dependencies
- fix(deps): update dependency gcp-metadata to v1 (#632)
Documentation
- docs: update links in contrib guide (#630)
Internal / Testing Changes
- build: use per-repo publish token (#641)
- build: Add docuploader credentials to node publish jobs (#639)
- build: use node10 to run samples-test, system-test etc (#638)
- build: update release configuration
- chore(deps): update dependency @types/lru-cache to v5 (#635)
- chore(deps): update dependency mocha to v6
- chore: fix lint (#631)
- build: use linkinator for docs test (#628)
- chore(deps): update dependency @types/tmp to 0.0.34 (#629)
- build: create docs test npm scripts (#625)
- build: test using @grpc/grpc-js in CI (#624)
v3.1.0
02-08-2019 08:29 PST
Bug fixes
- fix: use key file when fetching project id (#618)
- fix: Throw error if there is no refresh token despite the necessity of refreshing (#605)
New Features
- feat: allow passing constructor options to getClient (#611)
Documentation
- docs: update contributing path in README (#621)
- chore: move CONTRIBUTING.md to root (#619)
- docs: add lint/fix example to contributing guide (#615)
- docs: use the People API for samples (#609)
Internal / Testing Changes
- chore(deps): update dependency typescript to ~3.3.0 (#612)
- chore(deps): update dependency eslint-config-prettier to v4 (#604)
- build: ignore googleapis.com in doc link check (#602)
- chore(deps): update dependency karma to v4 (#603)
v3.0.1
01-16-2019 21:04 PST
Bug Fixes
- fix(deps): upgrade to the latest gaxios (#596)
v3.0.0
01-16-2019 10:00 PST
Welcome to 3.0 🎉 This release has it all. New features, bug fixes, breaking changes, performance improvements - something for everyone! The biggest addition to this release is support for the browser via Webpack.
This release has breaking changes. This release has a few breaking changes. These changes are unlikely to affect most clients.
BREAKING: Migration from axios to gaxios
The 2.0 version of this library used the axios library for making HTTP requests. In the 3.0 release, this has been replaced by a mostly API compatible library gaxios. The new request library natively supports proxies, and comes with a smaller dependency chain. While this is mostly an implementation detail, the request method was directly exposed via the GoogleAuth.request and OAuth2Client.request methods. The gaxios library aims to provide an API compatible implementation of axios, but that can never be 100% promised. If you run into bugs or differences that cause issues - please do let us know.
BREAKING: generateCodeVerifier is now generateCodeVerifierAsync
The OAuth2Client.generateCodeVerifier method has been replaced by the OAuth2Client.generateCodeVerifierAsync method. It has changed from a synchronous method to an asynchronous method to support async browser crypto APIs required for Webpack support.
BREAKING: verifySignedJwtWithCerts is now verifySignedJwtWithCertsAsync
The OAuth2Client.verifySignedJwtWithCerts method has been replaced by the OAuth2Client.verifySignedJwtWithCertsAsync method. It has changed from a synchronous method to an asynchronous method to support async browser crypto APIs required for Webpack support.
New Features
- feat: make it webpackable (#371)
Bug Fixes
- fix: accept lowercase env vars (#578)
Dependencies
Documentation
Internal / Testing Changes
- refactor(deps): use
gaxiosfor HTTP requests instead ofaxios(#593) - fix: some browser fixes (#590)
- chore(deps): update dependency ts-loader to v5 (#588)
- chore(deps): update dependency karma to v3 (#587)
- build: check broken links in generated docs (#579)
- chore(deps): drop unused dep on typedoc (#583)
- build: add browser test running on Kokoro (#584)
- test: improve samples and add tests (#576)
v2.0.2
12-16-2018 10:48 PST
Fixes
Dependencies
- fix(deps): update dependency lru-cache to v5 (#541)
Documentation
Internal / Testing Changes
- chore(deps): update dependency @types/sinon to v7 (#568)
- refactor: use execa for install tests, run eslint on samples (#559)
- chore(build): inject yoshi automation key (#566)
- chore: update nyc and eslint configs (#565)
- chore: fix publish.sh permission +x (#563)
- fix(build): fix Kokoro release script (#562)
- build: add Kokoro configs for autorelease (#561)
- chore: always nyc report before calling codecov (#557)
- chore: nyc ignore build/test by default (#556)
- chore(build): update the prettier and renovate config (#552)
- chore: update license file (#551)
- fix(build): fix system key decryption (#547)
- chore(deps): update dependency typescript to ~3.2.0 (#546)
- chore(deps): unpin sinon (#544)
- refactor: drop non-required modules (#542)
- chore: add synth.metadata (#537)
- fix: Pin @types/sinon to last compatible version (#538)
- chore(deps): update dependency gts to 0.9.0 (#531)
- chore: update eslintignore config (#530)
- chore: drop contributors from multiple places (#528)
- chore: use latest npm on Windows (#527)
- chore: update CircleCI config (#523)
- chore: include build in eslintignore (#516)
v2.0.1
Implementation Changes
- fix: verifyIdToken will never return null (#488)
- Update the url to application default credentials (#470)
- Update omitted parameter 'hd' (#467)
Dependencies
- chore(deps): update dependency nock to v10 (#501)
- chore(deps): update dependency sinon to v7 (#502)
- chore(deps): update dependency typescript to v3.1.3 (#503)
- chore(deps): update dependency gh-pages to v2 (#499)
- chore(deps): update dependency typedoc to 0.13.0 (#497)
Documentation
- docs: Remove code format from Application Default Credentials (#483)
- docs: replace google/ with googleapis/ in URIs (#472)
- Fix typo in readme (#469)
- Update samples and docs for 2.0 (#459)
Internal / Testing Changes
- chore: update issue templates (#509)
- chore: remove old issue template (#507)
- build: run tests on node11 (#506)
- chore(build): drop hard rejection and update gts in the kitchen test (#504)
- chores(build): do not collect sponge.xml from windows builds (#500)
- chores(build): run codecov on continuous builds (#495)
- chore: update new issue template (#494)
- build: fix codecov uploading on Kokoro (#490)
- test: move kitchen sink tests to system-test (#489)
- Update kokoro config (#482)
- fix: export additional typescript types (#479)
- Don't publish sourcemaps (#478)
- test: remove appveyor config (#477)
- Enable prefer-const in the eslint config (#473)
- Enable no-var in eslint (#471)
- Update CI config (#468)
- Retry npm install in CI (#465)
- Update Kokoro config (#462)
v2.0.0
Well hello 2.0 🎉 This release has multiple breaking changes. It also has a lot of bug fixes.
Breaking Changes
Support for node.js 4.x and 9.x has been dropped
These versions of node.js are no longer supported.
The getRequestMetadata method has been deprecated
The getRequestMetadata method has been deprecated on the IAM, OAuth2, JWT, and JWTAccess classes. The getRequestHeaders method should be used instead. The methods have a subtle difference: the getRequestMetadata method returns an object with a headers property, which contains the authorization header. The getRequestHeaders method simply returns the headers.
Old code
const client = await auth.getClient();
const res = await client.getRequestMetadata();
const headers = res.headers;
New code
const client = await auth.getClient();
const headers = await client.getRequestHeaders();
The createScopedRequired method has been deprecated
The createScopedRequired method has been deprecated on multiple classes. The createScopedRequired and createScoped methods on the JWT class were largely in place to help inform clients when scopes were required in an application default credential scenario. Instead of checking if scopes are required after creating the client, instead scopes should just be passed either into the GoogleAuth.getClient method, or directly into the JWT constructor.
Old code
auth.getApplicationDefault(function(err, authClient) {
if (err) {
return callback(err);
}
if (authClient.createScopedRequired && authClient.createScopedRequired()) {
authClient = authClient.createScoped([
'https://www.googleapis.com/auth/cloud-platform'
]);
}
callback(null, authClient);
});
New code
const client = await auth.getClient({
scopes: ['https://www.googleapis.com/auth/cloud-platform']
});
Deprecate refreshAccessToken
Note: refreshAccessToken is no longer deprecated.
getAccessToken, getRequestMetadata, and request methods will all refresh the token if needed automatically.
You should not need to invoke refreshAccessToken directly except in certain edge-cases.
Features
- Set private_key_id in JWT access token header like other google auth libraries. (#450)
Bug Fixes
- fix: support HTTPS proxies (#405)
- fix: export missing interfaces (#437)
- fix: Use new auth URIs (#434)
- docs: Fix broken link (#423)
- fix: surface file read streams (#413)
- fix: prevent unhandled rejections by avoid .catch (#404)
- fix: use gcp-metadata for compute credentials (#409)
- Add Code of Conduct
- fix: Warn when using user credentials from the Cloud SDK (#399)
- fix: use
Buffer.frominstead ofnew Buffer(#400) - fix: Fix link format in README.md (#385)
Breaking changes
- chore: deprecate getRequestMetadata (#414)
- fix: deprecate the
createScopedRequiredmethods (#410) - fix: drop support for node.js 4.x and 9.x (#417)
- fix: deprecate the
refreshAccessTokenmethods (#411) - fix: deprecate the
getDefaultProjectIdmethod (#402) - fix: drop support for node.js 4 (#401)
Build / Test changes
- Run synth to make build tools consistent (#455)
- Add a package.json for samples and cleanup README (#454)
- chore(deps): update dependency typedoc to 0.12.0 (#453)
- chore: move examples => samples + synth (#448)
- chore(deps): update dependency nyc to v13 (#452)
- chore(deps): update dependency pify to v4 (#447)
- chore(deps): update dependency assert-rejects to v1 (#446)
- chore: ignore package-lock.json (#445)
- chore: update renovate config (#442)
- chore(deps): lock file maintenance (#443)
- chore: remove greenkeeper badge (#440)
- test: throw on deprecation
- chore: add intelli-espower-loader for running tests (#430)
- chore(deps): update dependency typescript to v3 (#432)
- chore(deps): lock file maintenance (#431)
- test: use strictEqual in tests (#425)
- chore(deps): lock file maintenance (#428)
- chore: Configure Renovate (#424)
- chore: Update gts to the latest version 🚀 (#422)
- chore: update gcp-metadata for isAvailable fix (#420)
- refactor: use assert.reject in the tests (#415)
- refactor: cleanup types for certificates (#412)
- test: run tests with hard-rejection (#397)
- cleanup: straighten nested try-catch (#394)
- test: getDefaultProjectId should prefer config (#388)
- chore(package): Update gts to the latest version 🚀 (#387)
- chore(package): update sinon to version 6.0.0 (#386)
Upgrading to 1.x
The 1.x release includes a variety of bug fixes, new features, and breaking changes. Please take care, and see the release notes for a list of breaking changes, and the upgrade guide.