gtoken - npm Package Compare versions

Comparing version 1.2.3 to 2.0.0

package.json

 {
   "name": "gtoken",
-  "version": "1.2.3",
+  "version": "2.0.0",
   "description": "Node.js Google Authentication Service Account Tokens",
-  "main": "./lib/index.js",
+  "main": "./build/src/index.js",
+  "types": "./build/src/index.d.ts",
   "repository": {
@@ -11,3 +12,11 @@ "type": "git",
   "scripts": {
-    "test": "mocha --timeout 5000"
+    "check": "gts check",
+    "clean": "gts clean",
+    "codecov": "nyc report --reporter=json && codecov -f coverage/*.json",
+    "fix": "gts fix",
+    "compile": "tsc -p .",
+    "test": "nyc mocha build/test --timeout 5000 --require source-map-support/register",
+    "prepare": "npm run compile",
+    "pretest": "npm run compile",
+    "posttest": "npm run check"
   },
@@ -28,10 +37,29 @@ "keywords": [
   "dependencies": {
-    "google-p12-pem": "^0.1.0",
+    "axios": "^0.17.0",
+    "google-p12-pem": "^1.0.0",
     "jws": "^3.0.0",
-    "mime": "^1.4.1",
-    "request": "^2.72.0"
+    "mime": "^2.0.3",
+    "pify": "^3.0.0"
   },
   "devDependencies": {
-    "mocha": "^3.4.2"
-  }
+    "@types/jws": "^3.1.0",
+    "@types/mime": "^2.0.0",
+    "@types/mocha": "^2.2.43",
+    "@types/nock": "^8.2.1",
+    "@types/node": "^8.0.47",
+    "@types/pify": "^3.0.0",
+    "codecov": "^3.0.0",
+    "gts": "^0.5.1",
+    "mocha": "^4.0.1",
+    "nock": "^9.0.27",
+    "nyc": "^11.2.1",
+    "source-map-support": "^0.5.0",
+    "typescript": "~2.6.0"
+  },
+  "files": [
+    "build/src",
+    "LICENSE",
+    "packge.json",
+    "README.md"
+  ]
 }

README.md

 # node-gtoken
 
+[![NPM Version][npm-image]][npm-url]
+[![Build Status][travis-image]][travis-url]
+[![Dependency Status][david-image]][david-url]
+[![devDependency Status][david-dev-image]][david-dev-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![codecov][codecov-image]][codecov-url]
+[![Greenkeeper badge][greenkeeper-image]][greenkeeper-url]
+
 Node.js Google Authentication Service Account Tokens
 
-[![Build Status](https://travis-ci.org/google/node-gtoken.svg?branch=master)](https://travis-ci.org/google/node-gtoken)
-[![dependencies Status](https://david-dm.org/google/node-gtoken/status.svg)](https://david-dm.org/google/node-gtoken)
-[![Known Vulnerabilities](https://snyk.io/test/npm/google-p12-pem/badge.svg)](https://snyk.io/test/npm/google-p12-pem)
-
 ## Installation
@@ -20,4 +24,4 @@
 ``` js
-var GoogleToken = require('gtoken');
-var gtoken = GoogleToken({
+const GoogleToken = require('gtoken');
+const gtoken = new GoogleToken({
   keyFile: 'path/to/key.pem', // or path to .p12 key file
@@ -37,7 +41,24 @@ email: '[e-mail]',
 
+You can also use the async/await style API:
+
+``` js
+const token = await gtoken.getToken()
+console.log(token);
+```
+
+Or use promises:
+
+```js
+gtoken.getToken()
+  .then(token => {
+    console.log(`Token: ${token}`)
+  })
+  .catch(e => console.error);
+```
+
 ### Use with a service account `.json` key file:
 
 ``` js
-var GoogleToken = require('gtoken');
-var gtoken = GoogleToken({
+const GoogleToken = require('gtoken');
+const gtoken = new GoogleToken({
   keyFile: 'path/to/key.json',
@@ -59,5 +80,5 @@ scope: ['https://scope1', 'https://scope2'] // or space-delimited string of scopes
 ``` js
-var key = '-----BEGIN RSA PRIVATE KEY-----\nXXXXXXXXXXX...';
-var GoogleToken = require('gtoken');
-var gtoken = GoogleToken({
+const key = '-----BEGIN RSA PRIVATE KEY-----\nXXXXXXXXXXX...';
+const GoogleToken = require('gtoken');
+const gtoken = new GoogleToken({
   email: '[e-mail]',
@@ -95,5 +116,5 @@ scope: ['https://scope1', 'https://scope2'], // or space-delimited string of scopes
 - `gtoken.token`: The access token.
-- `gtoken.expires_at`: The expiry date as milliseconds since 1970/01/01
+- `gtoken.expiresAt`: The expiry date as milliseconds since 1970/01/01
 - `gtoken.key`: The raw key value.
-- `gtoken.raw_token`: Most recent raw token data received from Google.
+- `gtoken.rawToken`: Most recent raw token data received from Google.
 
@@ -142,6 +163,32 @@ ### .hasExpired()
 
+## Changelog
+
+### 1.2.2 -> 2.0.0
+New features:
+- API now supports callback and promise based workflows
+
+Breaking changes:
+- `GoogleToken` is now a class type, and must be instantiated.
+- `GoogleToken.expires_at` renamed to `GoogleToken.expiresAt`
+- `GoogleToken.raw_token` renamed to `GoogleToken.rawToken`
+- `GoogleToken.token_expires` renamed to `GoogleToken.tokenExpires`
+
 ## License
 
-MIT
+[MIT](LICENSE)
 
 [gdevconsole]: https://console.developers.google.com
+[npm-image]: https://img.shields.io/npm/v/gtoken.svg
+[npm-url]: https://npmjs.org/package/gtoken
+[travis-image]: https://travis-ci.org/google/node-gtoken.svg?branch=master
+[travis-url]: https://travis-ci.org/google/node-gtoken
+[david-image]: https://david-dm.org/google/node-gtoken.svg
+[david-url]: https://david-dm.org/google/node-gtoken
+[david-dev-image]: https://david-dm.org/google/node-gtoken/dev-status.svg
+[david-dev-url]: https://david-dm.org/google/node-gtoken?type=dev
+[snyk-image]: https://snyk.io/test/github/google/node-gtoken/badge.svg
+[snyk-url]: https://snyk.io/test/github/google/node-gtoken
+[codecov-image]: https://codecov.io/gh/google/node-gtoken/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/google/node-gtoken
+[greenkeeper-image]: https://badges.greenkeeper.io/google/node-gtoken.svg
+[greenkeeper-url]: https://greenkeeper.io/

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

190

32.87%

Number of low supply chain risk alerts

2

-33.33%

Worsened metrics

Total package byte prevSize

26436

-4.57%

Dependency count

5

25%

Dev dependency count

13

1200%

Number of package files

6

-40%

Lines of code

319

-44.91%

Dependency changes

• + Added

  axios@^0.17.0

• + Added

  pify@^3.0.0

• + Added

  axios@0.17.1
  (transitive)

• + Added

  follow-redirects@1.15.9
  (transitive)

• + Added

  google-p12-pem@1.0.5
  (transitive)

• + Added

  is-buffer@1.1.6
  (transitive)

• + Added

  mime@2.6.0
  (transitive)

• + Added

  node-forge@0.10.0
  (transitive)

• + Added

  pify@3.0.04.0.1
  (transitive)

• - Removed

  request@^2.72.0

• - Removed

  ajv@6.12.6
  (transitive)

• - Removed

  asn1@0.2.6
  (transitive)

• - Removed

  assert-plus@1.0.0
  (transitive)

• - Removed

  asynckit@0.4.0
  (transitive)

• - Removed

  aws-sign2@0.7.0
  (transitive)

• - Removed

  aws4@1.13.2
  (transitive)

• - Removed

  bcrypt-pbkdf@1.0.2
  (transitive)

• - Removed

  caseless@0.12.0
  (transitive)

• - Removed

  combined-stream@1.0.8
  (transitive)

• - Removed

  core-util-is@1.0.2
  (transitive)

• - Removed

  dashdash@1.14.1
  (transitive)

• - Removed

  delayed-stream@1.0.0
  (transitive)

• - Removed

  ecc-jsbn@0.1.2
  (transitive)

• - Removed

  extend@3.0.2
  (transitive)

• - Removed

  extsprintf@1.3.0
  (transitive)

• - Removed

  fast-deep-equal@3.1.3
  (transitive)

• - Removed

  fast-json-stable-stringify@2.1.0
  (transitive)

• - Removed

  forever-agent@0.6.1
  (transitive)

• - Removed

  form-data@2.3.3
  (transitive)

• - Removed

  getpass@0.1.7
  (transitive)

• - Removed

  google-p12-pem@0.1.2
  (transitive)

• - Removed

  har-schema@2.0.0
  (transitive)

• - Removed

  har-validator@5.1.5
  (transitive)

• - Removed

  http-signature@1.2.0
  (transitive)

• - Removed

  is-typedarray@1.0.0
  (transitive)

• - Removed

  isstream@0.1.2
  (transitive)

• - Removed

  jsbn@0.1.1
  (transitive)

• - Removed

  json-schema@0.4.0
  (transitive)

• - Removed

  json-schema-traverse@0.4.1
  (transitive)

• - Removed

  json-stringify-safe@5.0.1
  (transitive)

• - Removed

  jsprim@1.4.2
  (transitive)

• - Removed

  mime@1.6.0
  (transitive)

• - Removed

  mime-db@1.52.0
  (transitive)

• - Removed

  mime-types@2.1.35
  (transitive)

• - Removed

  node-forge@0.7.6
  (transitive)

• - Removed

  oauth-sign@0.9.0
  (transitive)

• - Removed

  performance-now@2.1.0
  (transitive)

• - Removed

  psl@1.15.0
  (transitive)

• - Removed

  punycode@2.3.1
  (transitive)

• - Removed

  qs@6.5.3
  (transitive)

• - Removed

  request@2.88.2
  (transitive)

• - Removed

  safer-buffer@2.1.2
  (transitive)

• - Removed

  sshpk@1.18.0
  (transitive)

• - Removed

  tough-cookie@2.5.0
  (transitive)

• - Removed

  tunnel-agent@0.6.0
  (transitive)

• - Removed

  tweetnacl@0.14.5
  (transitive)

• - Removed

  uri-js@4.4.1
  (transitive)

• - Removed

  uuid@3.4.0
  (transitive)

• - Removed

  verror@1.10.0
  (transitive)

• Updated

  google-p12-pem@^1.0.0

• Updated

  mime@^2.0.3