refactor(ts): merge initial TypeScript conversion (googleapis#334)

* refactor(ts): Typescript conversion (initial) (googleapis#255)

* refactor(ts): Rename *.js to .ts

* refactor(ts): setup typescript tools

* refactor(ts): install available @types packages

* refactor(ts): remove .js extension from imports

* refactor(ts): gts fix

* refactor(ts): function to arrow =>

* refactor(ts): for...in => for...of Object.keys(...

* refactor(ts): use native `extends Error` for custom error classes

...instead of relying on package 'create-error-class'

* refactor(ts): module.exports => export { ... }

* refactor(ts): temporarily disable noImplicitAny before augmenting types

* refactor(ts): eof \n

* refactor(ts): use typescipt ~2.9.2

* Revert "refactor(ts): module.exports => export { ... }"

This reverts commit 219ef2f2b4c1f423afd15246bea6735e42b15d3b.

* refactor(ts): temporarily remove posttest npm script

* refactor(ts): internalize class and object members into class (googleapis#260)

* refactor(ts): Acl: internalize static/object properties to class

* refactor(ts): Bucket: internalize static/object properties to class

* refactor(ts): File: internalize static/object properties to class

* refactor(ts): Iam: internalize static/object properties to class

* refactor(ts): File: internalized missed properties to class

* chore: update package-lock.json

* refactor(ts): Storage: internalize class/object properties into class

* refactor(ts): Iam: import Bucket

* refactor(ts): File: internal Acl

* refactor(ts): add 'any' type to suppress compiler error (googleapis#261)

* refactor(ts): Channel: type cast this.metadata as any

* refactor(ts): Bucket: add types to make tsc work

* refactor(ts): Acl: add any types

* refactor(ts): File: add any types

* refactor(ts): Storage: add any types

* refactor(ts): Notification: add any[] type

* refactor(ts): File: add any[] type

* Typescript: use ts-style exports instead of module.exports (googleapis#267)

* refactor(ts): use es6/ts export in project files

* refactor(ts): import from file in project

* refactor(ts): export = Storage; fix import from Storage from other classes

* chore: update gcs-resumable-upload to 0.11.1

* refactor(ts): misc. fixes to make tsc happy (googleapis#268)

* refactor(ts): File: add optional types for uninitialized members

* refactor(ts): Bucket: options is optional in constructor

* refactor(ts): File: various `any` cast; optional callback? and type fixes

* refactor(ts): add Acl#default as a member

* refactor(ts): Bucket: various any cast; optional callback? and type fixes

* refactor(ts): Notification: add any cast; optional callback?

* refactor(ts): Iam: type cast any

* refactor(ts): Acl.default is optional

* refactor(ts): require pumpify

* refactor(ts): !assert this.acl.default exists in bucket

* cleanup: no longer need to set Storage.X

* refactor(ts): export = Storage proxy

* refactor(ts): destructure apply Proxy and call Storage with single argument

* refactor(ts): fix Date comparisons

* cleanup: remove ignore no-class-assign

* refactor(ts): convert tests to typescript (1) (googleapis#272)

* refactor(ts): Tests: *.js => *.ts

* refactor(ts): add missing @types/ in tests

* refactor(ts): iam use ts-style imports

* refactor(ts): test/index.ts use ts-style imports

* refactor(ts): test/file.ts use ts-style imports

* refactor(ts): test/bucket.ts use ts-style imports

* refactor(ts): test/acl.ts use ts-style imports

* refactor(ts): test/acl.ts move fakes inside describe(..)
So tsc won't complain we're redeclaring sth.

* refactor(ts): test/channel.ts use ts-style imports

* refactor(ts): test/notification.ts use ts-style imports

* refactor(ts): move let Acl back to outer scope

* Typescript: setup package.json and .circleci/config.yaml (googleapis#271)

* refactor(ts): update package.json with ts project specify paths

* refactor(ts): add tsc compile step to npm; npm run check instead of lint

* refactor(ts): npm run compile comes after npm install

* refactor(ts): dont need to compile ts explicitly

* refactor(ts): lint should run eslint on js tests, and run gts check on ts

* refactor(es6): ts-ify 2

* refactor(ts): allow implicit this as any temporarily

* refactor(ts): add any-cast and optional arg? to make test/bucket.ts compile

* refactor(ts): add any-cast to test/notification.ts

* refactor(ts): test/file.ts: add any-casts and optional arg? to make it compile

* refactor(ts): test/file.ts: Date comparisons using .valueOf()

* refactor(ts): test/file.ts Request fakes uses class syntax

* refactor(ts): main src is in build/ now so require('..') will not work (googleapis#286)

* refactor(ts): import individual exports from @google-cloud/common (googleapis#287)

* refactor(ts): make test/notification.ts pass (googleapis#290)

* refactor(ts): test/notification.ts: import indiv common exports

* refactor(ts): fix Notification import from named export

* refactor(ts): test/iam.ts: fix proxyquire import

* refactor(ts): test/channel.ts: fix proxyquire import

* refactor(ts): make test/acl.ts pass (googleapis#288)

* TypeScript: make test/index.ts pass (googleapis#292)

* refactor(ts): Storage test: fix relative path

* refactor(ts): Storage test: fix FakeChannel proxyquire

* refactor(ts): test-no-cover should compile ts before running test (googleapis#289)

* build: test-no-cover should compile ts before running test

* refactor(ts): change npm scripts to conform to typescript best practices

* refactor(ts): checkin mocha.opts and add mocha deps

* cleanup(codecov): ignore build/test for code coverage (googleapis#293)

* TypeScript: make Bucket test pass (googleapis#291)

* refactor(ts): test/bucket: fix proxyquire import

* refactor(ts): fix testdata file path

* refactor(ts): test/bucket.ts: fix common util

* refactor(ts): test/bucket.ts: proxyquire async via default import

* refactor(ts): make test/file.ts pass (googleapis#294)

* refactor(ts): assign .name property to custom File error types

* refactor(ts): test/file: FakeRequest#getRequestOptions should be static

* refactor(ts): resumable-upload uses es6 modules, so proxyquire as default

* refactor(ts): run gts fix (googleapis#295)

* refactor(ts): function to arrow => (googleapis#297)

* refactor(ts): function to arrow =>

* style

* Revert "refactor(ts): function to arrow => (googleapis#297)" (googleapis#298)

This reverts commit c35e9ccccf70161ffbae2e5ba18bc06072c80f81.

* refactor(ts): tests function() to arrow => (googleapis#299)

* refactor(ts): function to arrow =>

* style

* refactor(ts): test/acl.ts: replace ref `arguments` in arrow function

* refactor(ts): test/bucket.ts fix arrow function `this` and `arguments` ref

* refactor(ts): test/file.ts fix arrow function `this` and `arguments` ref

* refactor(ts): test/iam.ts fix arrow function `this` ref

* refactor(ts): tslint:disable-next-line:variable-name (googleapis#300)

* Typescript: workaround explicit 'any' cast in tests (googleapis#307)

* ts: avoid using extend to override request methods

* ts: no allowSyntheticDefaultImports (googleapis#316)

* dep: update gts@0.8 and typescript@3.0.1

* ts: no allowSyntheticDefaultImports

* ts: gts fix

* TypeScript: export {Storage} as named export (googleapis#327)

* ts: export Storage as named export - const {Storage} = req...

BREAKING CHANGE:
Storage will need to be imported as a named import:
const { Storage } = require('@google-cloud/storage');

Storage cannot be instantiated without new:
𝘅 const storage = Storage();  // deprecated
✔ const storage = new Storage();

* ts: fix tests now that Storage is named

* ts(docs): fix all in-line samples to use named-exported Storage (googleapis#329)

* ts(docs): fix all in-line samples to use named-exported Storage

* ts: named Storage import in samples and system tests

* dep: Use v0.21.0 of @google-cloud/common (googleapis#330)

* dep: bring in nodejs-common@0.21.0

* install @google-cloud/promisify and paginator and use them

* extract paginator and promisify from proxyquire of @google-cloud/common

* Delete package-lock.json

* ts: more fixes (googleapis#333)

* ts: add interfaces to get rid of any

* ts: strip any

* ts: add interface

* dep: upgrade @google-cloud/common to ^0.21.1

* ts: get rid of any cast in bucket.ts with types

* ts: fix anys

* fix remaining check issues

* ts: fix test

* fix: use new Storage() constructor in system-test

* doc: fix init in README.md quickstart

* fix: arrow functions

* more arrow funcitons

* add ignore no-any for now;

* ts doesnt like for..in, fix it

* gts fix

* fix test

Author: jkwlui

handwritten/storage/.circleci/config.yml

@@ -59,7 +59,7 @@ jobs:
       - image: 'node:6'
         user: node
     steps: &unit_tests_steps
-      - checkout 
+      - checkout
       - run: &npm_install_and_link
           name: Install and link the module
           command: |-
@@ -96,7 +96,7 @@ jobs:
             NPM_CONFIG_PREFIX: /home/node/.npm-global
       - run:
           name: Run linting.
-          command: npm run lint
+          command: npm run check
           environment:
             NPM_CONFIG_PREFIX: /home/node/.npm-global
   docs:
@@ -172,5 +172,4 @@ jobs:
     steps:
       - checkout
       - run: 'echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc'
-      - run: npm publish
-
+      - run: npm publish --access=public

handwritten/storage/.clang-format

@@ -0,0 +1,3 @@
+Language:        JavaScript
+BasedOnStyle:    Google
+ColumnLimit:     80

handwritten/storage/README.md

@@ -66,7 +66,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 
 ```javascript
 // Imports the Google Cloud client library
-const Storage = require('@google-cloud/storage');
+const {Storage} = require('@google-cloud/storage');
 
 // Your Google Cloud Platform project ID
 const projectId = 'YOUR_PROJECT_ID';

handwritten/storage/package.json

@@ -8,9 +8,10 @@
     "node": ">=6.0.0"
   },
   "repository": "googleapis/nodejs-storage",
-  "main": "./src/index.js",
+  "main": "./build/src/index.js",
+  "types": "./build/src/index.t.ds",
   "files": [
-    "src",
+    "build/src",
     "AUTHORS",
     "CONTRIBUTORS",
     "COPYING"
@@ -53,19 +54,31 @@
     "greenkeeper[bot] <greenkeeper[bot]@users.noreply.github.com>"
   ],
   "scripts": {
+    "codecov": "nyc report --reporter=json && codecov -f .coverage/*.json",
     "docs": "jsdoc -c .jsdoc.js",
-    "lint": "eslint src/ samples/ system-test/ test/",
-    "prettier": "prettier --write src/**/*.js samples/*.js samples/**/*.js system-test/**/*.js test/**/*.js",
-    "cover": "nyc --reporter=lcov mocha test/*.js && nyc report",
-    "test-no-cover": "mocha test/",
-    "test": "npm run cover",
-    "samples-test": "npm link && cd samples/ && npm link @google-cloud/storage && npm test && cd ../",
+    "generate-scaffolding": "repo-tools generate all && repo-tools generate lib_samples_readme -l samples/ --config ../.cloud-repo-tools.json",
     "system-test": "mocha system-test/ --timeout 600000",
+    "test-only": "nyc mocha build/test",
+    "test": "npm run test-only",
+    "pretest-only": "npm run compile",
+    "lint": "eslint samples/ system-test/ && gts check",
+    "samples-test": "npm link && cd samples/ && npm link ../ & npm test && cd ../",
     "all-test": "npm test && npm run system-test && npm run samples-test",
-    "generate-scaffolding": "repo-tools generate all && repo-tools generate lib_samples_readme -l samples/ --config ../.cloud-repo-tools.json"
+    "check": "gts check",
+    "clean": "gts clean",
+    "compile": "tsc -p .",
+    "fix": "gts fix",
+    "prepare": "npm run compile"
+  },
+  "nyc": {
+    "exclude": [
+      "build/test"
+    ]
   },
   "dependencies": {
-    "@google-cloud/common": "^0.20.0",
+    "@google-cloud/common": "^0.21.0",
+    "@google-cloud/paginator": "^0.1.0",
+    "@google-cloud/promisify": "^0.3.0",
     "arrify": "^1.0.0",
     "async": "^2.0.1",
     "compressible": "^2.0.12",
@@ -90,11 +103,30 @@
   "devDependencies": {
     "@google-cloud/nodejs-repo-tools": "^2.2.3",
     "@google-cloud/pubsub": "*",
+    "@types/arrify": "^1.0.4",
+    "@types/assert": "0.0.31",
+    "@types/async": "^2.0.49",
+    "@types/compressible": "^2.0.0",
+    "@types/concat-stream": "^1.6.0",
+    "@types/extend": "^3.0.0",
+    "@types/is": "0.0.20",
+    "@types/mime": "^2.0.0",
+    "@types/mime-types": "^2.1.0",
+    "@types/mocha": "^5.2.3",
+    "@types/once": "^1.4.0",
+    "@types/proxyquire": "^1.3.28",
+    "@types/pumpify": "^1.4.1",
+    "@types/request": "^2.47.1",
+    "@types/through2": "^2.0.33",
+    "@types/tmp": "0.0.33",
+    "@types/xdg-basedir": "^2.0.0",
     "codecov": "^3.0.0",
     "eslint": "^5.0.0",
     "eslint-config-prettier": "^3.0.0",
     "eslint-plugin-node": "^7.0.0",
     "eslint-plugin-prettier": "^2.3.1",
+    "gts": "^0.8.0",
+    "hard-rejection": "^1.0.0",
     "ink-docstrap": "https://github.com/docstrap/docstrap/tarball/master",
     "intelli-espower-loader": "^1.0.1",
     "jsdoc": "^3.5.4",
@@ -107,7 +139,9 @@
     "propprop": "^0.3.0",
     "proxyquire": "^2.0.0",
     "semistandard": "^12.0.0",
+    "source-map-support": "^0.5.6",
     "tmp": "^0.0.33",
+    "typescript": "^3.0.1",
     "uuid": "^3.1.0"
   }
 }

handwritten/storage/samples/acl.js

@@ -26,7 +26,7 @@
 function printBucketAcl(bucketName) {
   // [START storage_print_bucket_acl]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -56,7 +56,7 @@ function printBucketAcl(bucketName) {
 function printBucketAclForUser(bucketName, userEmail) {
   // [START storage_print_bucket_acl_for_user]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -90,7 +90,7 @@ function printBucketAclForUser(bucketName, userEmail) {
 function addBucketOwner(bucketName, userEmail) {
   // [START storage_add_bucket_owner]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -122,7 +122,7 @@ function addBucketOwner(bucketName, userEmail) {
 function removeBucketOwner(bucketName, userEmail) {
   // [START storage_remove_bucket_owner]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -151,7 +151,7 @@ function removeBucketOwner(bucketName, userEmail) {
 function addBucketDefaultOwner(bucketName, userEmail) {
   // [START storage_add_bucket_default_owner]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -183,7 +183,7 @@ function addBucketDefaultOwner(bucketName, userEmail) {
 function removeBucketDefaultOwner(bucketName, userEmail) {
   // [START storage_remove_bucket_default_owner]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -212,7 +212,7 @@ function removeBucketDefaultOwner(bucketName, userEmail) {
 function printFileAcl(bucketName, filename) {
   // [START storage_print_file_acl]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -244,7 +244,7 @@ function printFileAcl(bucketName, filename) {
 function printFileAclForUser(bucketName, filename, userEmail) {
   // [START storage_print_file_acl_for_user]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -280,7 +280,7 @@ function printFileAclForUser(bucketName, filename, userEmail) {
 function addFileOwner(bucketName, filename, userEmail) {
   // [START storage_add_file_owner]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -312,7 +312,7 @@ function addFileOwner(bucketName, filename, userEmail) {
 // [START storage_remove_file_owner]
 function removeFileOwner(bucketName, filename, userEmail) {
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();

handwritten/storage/samples/buckets.js

@@ -26,7 +26,7 @@
 function createBucket(bucketName) {
   // [START storage_create_bucket]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -54,7 +54,7 @@ function createBucket(bucketName) {
 function listBuckets() {
   // [START storage_list_buckets]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -79,7 +79,7 @@ function listBuckets() {
 function deleteBucket(bucketName) {
   // [START storage_delete_bucket]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -105,7 +105,7 @@ function deleteBucket(bucketName) {
 function enableDefaultKMSKey(bucketName, defaultKmsKeyName) {
   // [START storage_set_bucket_default_kms_key]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();

handwritten/storage/samples/encryption.js

@@ -51,7 +51,7 @@ function generateEncryptionKey() {
 function uploadEncryptedFile(bucketName, srcFilename, destFilename, key) {
   // [START storage_upload_encrypted_file]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -93,7 +93,7 @@ function uploadEncryptedFile(bucketName, srcFilename, destFilename, key) {
 function downloadEncryptedFile(bucketName, srcFilename, destFilename, key) {
   // [START storage_download_encrypted_file]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -132,7 +132,7 @@ function downloadEncryptedFile(bucketName, srcFilename, destFilename, key) {
 function rotateEncryptionKey(bucketName, fileName, oldKey, newKey) {
   // [START storage_rotate_encryption_key]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();

handwritten/storage/samples/files.js

@@ -26,7 +26,7 @@
 function listFiles(bucketName) {
   // [START storage_list_files]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -57,7 +57,7 @@ function listFiles(bucketName) {
 function listFilesByPrefix(bucketName, prefix, delimiter) {
   // [START storage_list_files_with_prefix]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -117,7 +117,7 @@ function listFilesByPrefix(bucketName, prefix, delimiter) {
 function uploadFile(bucketName, filename) {
   // [START storage_upload_file]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -153,7 +153,7 @@ function uploadFile(bucketName, filename) {
 function uploadFileWithKmsKey(bucketName, filename, kmsKeyName) {
   // [START storage_upload_with_kms_key]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -183,7 +183,7 @@ function uploadFileWithKmsKey(bucketName, filename, kmsKeyName) {
 function downloadFile(bucketName, srcFilename, destFilename) {
   // [START storage_download_file]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -219,7 +219,7 @@ function downloadFile(bucketName, srcFilename, destFilename) {
 function deleteFile(bucketName, filename) {
   // [START storage_delete_file]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -247,7 +247,7 @@ function deleteFile(bucketName, filename) {
 function getMetadata(bucketName, filename) {
   // [START storage_get_metadata]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -297,7 +297,7 @@ function getMetadata(bucketName, filename) {
 function makePublic(bucketName, filename) {
   // [START storage_make_public]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -325,7 +325,7 @@ function makePublic(bucketName, filename) {
 function generateSignedUrl(bucketName, filename) {
   // [START storage_generate_signed_url]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -361,7 +361,7 @@ function generateSignedUrl(bucketName, filename) {
 function moveFile(bucketName, srcFilename, destFilename) {
   // [START storage_move_file]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();
@@ -392,7 +392,7 @@ function moveFile(bucketName, srcFilename, destFilename) {
 function copyFile(srcBucketName, srcFilename, destBucketName, destFilename) {
   // [START storage_copy_file]
   // Imports the Google Cloud client library
-  const Storage = require('@google-cloud/storage');
+  const {Storage} = require('@google-cloud/storage');
 
   // Creates a client
   const storage = new Storage();