v0.9.0

12-06-2018 15:54 PST

This release has breaking changes. Please update with care.

Breaking changes

Dropped support for non-LTS versions of node.js

Node.js versions 4.x and 9.x are explicitly not supported.

Support for es modules

The import syntax for this library has changed to support es modules.

old code

const Resource = require('@google-cloud/resource');
const resource = Resource({...});

new code

const {Resource} = require('@google-cloud/resource');
const resource = Resource({...});

Features

• feat: convert to typescript (#64)

Documentation

• docs: update readme badges (#146)
• docs(samples): updated samples code to use async await (#139)

Fixes

• fix: improve types and fix sample tests (#141)
• fix(typo): LifecylceState => LifecycleState interface (#124)
• fix: improve types, enable noImplicitThis (#90)
• fix: use small HTTP dependency (#80)
• fix: drop support for node.js 4.x and 9.x (#50)

Internal / Testing Changes

• test: disable lifecycle project system test (#142)
• chore: always nyc report before calling codecov (#151)
• chore: nyc ignore build/test by default (#150)
• chore: update license file (#148)
• fix(build): fix system key decryption (#144)
• chore(deps): update dependency typescript to ~3.2.0 (#143)
• chore: add a synth.metadata
• refactor(samples): convert sample tests from ava to mocha (#135)
• chore(deps): update dependency gts to ^0.9.0 (#134)
• chore: update eslintignore config (#133)
• chore(deps): update dependency @google-cloud/nodejs-repo-tools to v3 (#130)
• refactor: drop dependency on extend (#128)
• chore: drop contributors from multiple places (#129)
• fix(deps): update dependency @google-cloud/common to ^0.26.0 (#113)
• chore: use latest npm on Windows (#127)
• chore: update CircleCI config (#126)
• chore: include build in eslintignore (#122)
• chore(deps): update dependency eslint-plugin-node to v8 (#118)
• chore: update issue templates (#117)
• chore: remove old issue template (#115)
• build: run tests on node11 (#114)
• chores(build): do not collect sponge.xml from windows builds (#112)
• chores(build): run codecov on continuous builds (#110)
• chore: update new issue template (#109)
• chore(deps): update dependency sinon to v7 (#105)
• build: fix codecov uploading on Kokoro (#106)
• Update kokoro config (#103)
• chore(deps): update dependency eslint-plugin-prettier to v3 (#102)
• chore(deps): update dependency typescript to ~3.1.0 (#100)
• Update CI config (#99)
• Don't publish sourcemaps (#97)
• Update the kokoro config (#94)
• test: remove appveyor config (#93)
• test: simplify and fix the system tests (#92)
• Update the CI config (#89)
• Enable prefer-const in the eslint config (#88)
• Enable no-var in eslint (#86)
• fix(deps): update dependency @google-cloud/common to ^0.25.0 (#87)
• Update CI config (#83)
• Fix code coverage (#81)
• fix(deps): update dependency @google-cloud/common to ^0.24.0 (#71)
• Update CI config (#78)
• Retry npm install in CI (#79)
• Re-generate library using /synth.py (#77)
• chore(deps): update dependency nyc to v13 (#76)
• Update the CI config (#75)
• chore: update CircleCI config
• chore: enable gts fix (#73)
• chore: convert to es6 (#72)
• chore(deps): update dependency eslint-config-prettier to v3 (#70)
• fix(deps): update dependency @google-cloud/common to ^0.21.0 (#66)
• chore: split the common module (#69)
• chore: ignore package-lock.json (#67)
• chore: update renovate config (#63)
• chore: assert.deelEqual => assert.deepStrictEqual (#60)
• chore(deps): lock file maintenance (#61)
• chore: move mocha options to mocha.opts (#58)
• chore: require node 8 for samples (#59)
• chore(deps): lock file maintenance (#57)
• chore(deps): update dependency eslint-plugin-node to v7 (#55)
• test: use strictEqual in tests (#56)
• fix(deps): update dependency yargs to v12 (#46)
• fix(deps): update dependency @google-cloud/common to ^0.20.0 (#41)
• chore(deps): update dependency sinon to v6 (#44)
• fix(deps): update dependency yargs to v11 (#45)
• chore(deps): update dependency proxyquire to v2 (#43)
• chore(deps): update dependency ava to v0.25.0 (#39)
• Configure Renovate (#33)
• chore(package): update eslint to version 5.0.0 (#34)
• refactor: drop repo-tool as an exec wrapper (#37)
• fix: update linking for samples (#35)
• chore: update sample lockfiles (#36)
• chore(package): update nyc to version 12.0.2 (#32)
• chore: lock files maintenance (#30)
• chore: timeout for system test (#28)
• chore: lock files maintenance (#27)
• chore: test on node10 (#26)
• chore: lock files maintenance (#25)
• chore: one more workaround for repo-tools EPERM (#23)
• chore: workaround for repo-tools EPERM (#22)
• Update @google-cloud/common to the latest version 🚀 (#21)
• Update google-auto-auth (#20)
• chore: setup nighty build in CircleCI (#19)
• Upgrade repo-tools and regenerate scaffoldi...

@google-cloud/resource v0.8.1

Fixes

• Update dependencies to mitigate possible security issues.

@google-cloud/resource v0.8.0

Features

Runnable samples

There are now runnable samples in the samples/ directory. These samples demonstrate the use of this API and offer an additional resource for getting started. These also power the README, and are automatically tested to ensure that they are up-to-date and correct.

Implementation Details

• Change to a new linter (ESLint) and code style formatter (prettify).
• Update docs to use JSDoc 3.
• Migrate to the googleapis/nodejs-resource repository.

Refer to the nodejs-resource API reference documentation for details.

@google-cloud/resource v0.7.3

Dependencies

• Update google-auto-auth to 0.7.1.

@google-cloud/resource v0.7.2

Bugfixes

• Reverted the addition of the trailing dot in FQDNs, as it flatly broke DNS lookups on Android (#2283)

@google-cloud/resource v0.7.1

Features

• Updated FQDNs to include a trailing dot, e.g. googleapis.com. This provides a substantial speed improvement in some use cases. (#2214)

@google-cloud/resource v0.7.0

⚠️ Breaking Changes!

Dropped support for Node v0.12.x

• #2171

We've officially dropped support for Node v0.12.x in all of our APIs. It may still work, but it is not officially supported and may stop working at any time.

@google-cloud/resource v0.5.0

Features

• Auto-detect projectId. See Authentication for more. (#1656)

@google-cloud/resource v0.4.0

⚠️ Breaking Changes!

We've updated to v1 of the upstream Resource Manager API!

• #1795

The upstream Resource Manager API has made a significant change that affects our resource.createProject() method. Previously, when your callback was executed, you knew if the project was created successfully or not. Now, you will be returned an operation object, which you will subscribe to for updates.

Before

resource.createProject(id, function(err, project, apiResponse) {
  if (err) {
    // An API error occurred.
  }

  // Project was created successfully!
});

After

resource.createProject(id, function(err, project, operation, apiResponse) {
  if (err) {
    // An API error occurred.
  }

  // `operation` will emit `error` or `complete` when the status updates.

  operation
    .on('error', function(err) {})
    .on('complete', function() {
      // Project was created successfully!
    });
});

If you are using our promise API, you can use the Operation object as a promise.

resource.createProject(id)
  .then(function(data) {
    var operation = data[1];
    return operation.promise();
  })
  .then(function() {
    // Project was created successfully!
  });

@google-cloud/resource v0.3.0

⚠️ Breaking Changes!

Promises have arrived!

Issue: #551
PR: #1709

It's been a long time coming, but we're finally here. We've shipped promise support in the Google Cloud Resource Manager module!

Do I have to use promises?

Nope, carry on. (But keep reading if you use streams)

How do I use promises?

Don't pass a callback:

var resource = require('@google-cloud/resource')();

resource.getProjects()
  .then(function(data) {
    var projects = data[0];
  })
  .catch(function(err) {});

How do I use a method as a stream?

All of the streaming functionality from our methods have been moved to their own method.

var resource = require('@google-cloud/resource')();

- resource.getProjects()
+ resource.getProjectsStream()
   .on('data', function(project) {})