@google-cloud/promisify 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -4,6 +4,61 @@
 
 [1]: https://www.npmjs.com/package/nodejs-promisify?activeTab=versions
 
+## v0.4.0
+
+02-12-2019 19:44 PST
+
+### New features
+- feat: add callbackify() and callbackifyAll() methods ([#82](https://github.com/googleapis/nodejs-promisify/pull/82))
+
+### Documentation
+- docs: update contributing path in README ([#86](https://github.com/googleapis/nodejs-promisify/pull/86))
+- chore: move CONTRIBUTING.md to root ([#85](https://github.com/googleapis/nodejs-promisify/pull/85))
+- docs: add lint/fix example to contributing guide ([#83](https://github.com/googleapis/nodejs-promisify/pull/83))
+
+### Internal / Testing Changes
+- build: create docs test npm scripts ([#88](https://github.com/googleapis/nodejs-promisify/pull/88))
+- build: test using @grpc/grpc-js in CI ([#87](https://github.com/googleapis/nodejs-promisify/pull/87))
+- build: ignore googleapis.com in doc link check ([#81](https://github.com/googleapis/nodejs-promisify/pull/81))
+- build: check broken links in generated docs ([#79](https://github.com/googleapis/nodejs-promisify/pull/79))
+- chore(deps): update dependency @types/sinon to v7 ([#78](https://github.com/googleapis/nodejs-promisify/pull/78))
+- chore(build): inject yoshi automation key ([#77](https://github.com/googleapis/nodejs-promisify/pull/77))
+- chore: update nyc and eslint configs ([#76](https://github.com/googleapis/nodejs-promisify/pull/76))
+- chore: fix publish.sh permission +x ([#74](https://github.com/googleapis/nodejs-promisify/pull/74))
+- fix(build): fix Kokoro release script ([#73](https://github.com/googleapis/nodejs-promisify/pull/73))
+- build: add Kokoro configs for autorelease ([#72](https://github.com/googleapis/nodejs-promisify/pull/72))
+- chore: always nyc report before calling codecov ([#69](https://github.com/googleapis/nodejs-promisify/pull/69))
+- chore: nyc ignore build/test by default ([#68](https://github.com/googleapis/nodejs-promisify/pull/68))
+- chore(build): update prettier config ([#66](https://github.com/googleapis/nodejs-promisify/pull/66))
+- fix: get the build passing ([#65](https://github.com/googleapis/nodejs-promisify/pull/65))
+- chore: update license file ([#64](https://github.com/googleapis/nodejs-promisify/pull/64))
+- fix(build): fix system key decryption ([#60](https://github.com/googleapis/nodejs-promisify/pull/60))
+- chore(deps): update dependency @types/sinon to v5.0.7 ([#58](https://github.com/googleapis/nodejs-promisify/pull/58))
+- fix: Pin @types/sinon to last compatible version ([#57](https://github.com/googleapis/nodejs-promisify/pull/57))
+- chore: add synth.metadata
+- chore(deps): update dependency gts to ^0.9.0 ([#54](https://github.com/googleapis/nodejs-promisify/pull/54))
+- chore: update eslintignore config ([#53](https://github.com/googleapis/nodejs-promisify/pull/53))
+- chore: use latest npm on Windows ([#52](https://github.com/googleapis/nodejs-promisify/pull/52))
+- chore: update CircleCI config ([#51](https://github.com/googleapis/nodejs-promisify/pull/51))
+- chore: include build in eslintignore ([#48](https://github.com/googleapis/nodejs-promisify/pull/48))
+- chore: update issue templates ([#44](https://github.com/googleapis/nodejs-promisify/pull/44))
+- chore: remove old issue template ([#42](https://github.com/googleapis/nodejs-promisify/pull/42))
+- build: run tests on node11 ([#41](https://github.com/googleapis/nodejs-promisify/pull/41))
+- chores(build): do not collect sponge.xml from windows builds ([#40](https://github.com/googleapis/nodejs-promisify/pull/40))
+- chores(build): run codecov on continuous builds ([#39](https://github.com/googleapis/nodejs-promisify/pull/39))
+- chore: update new issue template ([#38](https://github.com/googleapis/nodejs-promisify/pull/38))
+- chore(deps): update dependency sinon to v7 ([#33](https://github.com/googleapis/nodejs-promisify/pull/33))
+- build: fix codecov uploading on Kokoro ([#34](https://github.com/googleapis/nodejs-promisify/pull/34))
+- Update kokoro config ([#30](https://github.com/googleapis/nodejs-promisify/pull/30))
+- Update CI config ([#28](https://github.com/googleapis/nodejs-promisify/pull/28))
+- Don't publish sourcemaps ([#26](https://github.com/googleapis/nodejs-promisify/pull/26))
+- Update kokoro config ([#24](https://github.com/googleapis/nodejs-promisify/pull/24))
+- test: remove appveyor config ([#23](https://github.com/googleapis/nodejs-promisify/pull/23))
+- Update CI config ([#22](https://github.com/googleapis/nodejs-promisify/pull/22))
+- Enable prefer-const in the eslint config ([#21](https://github.com/googleapis/nodejs-promisify/pull/21))
+- Enable no-var in eslint ([#19](https://github.com/googleapis/nodejs-promisify/pull/19))
+- Update CI config ([#18](https://github.com/googleapis/nodejs-promisify/pull/18))
+
 ## v0.3.1
 
 ### Internal / Testing Changes

package/LICENSE

@@ -199,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

package/README.md

@@ -1,7 +1,7 @@
 <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
 
 # @google-cloud/promisify
-> A simple utility for promisifying functions and classes.
+> A simple utility for promisifying and callbackifying functions and classes.
 
 Google Cloud Common node.js module contains stuff used by other Cloud API modules.
 
@@ -31,7 +31,7 @@ More Information: [Google Cloud Platform Launch Stages][launch_stages]
 
 ## Contributing
 
-Contributions welcome! See the [Contributing Guide](https://github.com/googlecloudplatform/google-cloud-node/blob/master/.github/CONTRIBUTING.md).
+Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-promisify/blob/master/CONTRIBUTING.md).
 
 ## License
 

package/build/src/index.d.ts

@@ -31,6 +31,15 @@ export interface PromiseMethod extends Function {
 export interface WithPromise {
     Promise?: PromiseConstructor;
 }
+export interface CallbackifyAllOptions {
+    /**
+     * Array of methods to ignore when callbackifying.
+     */
+    exclude?: string[];
+}
+export interface CallbackMethod extends Function {
+    callbackified_?: boolean;
+}
 /**
  * Wraps a callback style function to conditionally return a promise.
  *
@@ -48,3 +57,20 @@ export declare function promisify(originalMethod: PromiseMethod, options?: Promi
  * @param {object=} options - Configuration object.
  */
 export declare function promisifyAll(Class: Function, options?: PromisifyAllOptions): void;
+/**
+ * Wraps a promisy type function to conditionally call a callback function.
+ *
+ * @param {function} originalMethod - The method to callbackify.
+ * @param {object=} options - Callback options.
+ * @param {boolean} options.singular - Pass to the callback a single arg instead of an array.
+ * @return {function} wrapped
+ */
+export declare function callbackify(originalMethod: CallbackMethod): CallbackMethod;
+/**
+ * Callbackifies certain Class methods. This will not callbackify private or
+ * streaming methods.
+ *
+ * @param {module:common/service} Class - Service class.
+ * @param {object=} options - Configuration object.
+ */
+export declare function callbackifyAll(Class: Function, options?: CallbackifyAllOptions): void;

package/build/src/index.js

@@ -101,4 +101,62 @@ function promisifyAll(Class, options) {
     });
 }
 exports.promisifyAll = promisifyAll;
+/**
+ * Wraps a promisy type function to conditionally call a callback function.
+ *
+ * @param {function} originalMethod - The method to callbackify.
+ * @param {object=} options - Callback options.
+ * @param {boolean} options.singular - Pass to the callback a single arg instead of an array.
+ * @return {function} wrapped
+ */
+function callbackify(originalMethod) {
+    if (originalMethod.callbackified_) {
+        return originalMethod;
+    }
+    // tslint:disable-next-line:no-any
+    const wrapper = function () {
+        const context = this;
+        if (typeof arguments[arguments.length - 1] !== 'function') {
+            return originalMethod.apply(context, arguments);
+        }
+        const cb = Array.prototype.pop.call(arguments);
+        originalMethod
+            .apply(context, arguments)
+            // tslint:disable-next-line:no-any
+            .then((res) => {
+            res = Array.isArray(res) ? res : [res];
+            cb(null, ...res);
+        }, (err) => cb(err));
+    };
+    wrapper.callbackified_ = true;
+    return wrapper;
+}
+exports.callbackify = callbackify;
+/**
+ * Callbackifies certain Class methods. This will not callbackify private or
+ * streaming methods.
+ *
+ * @param {module:common/service} Class - Service class.
+ * @param {object=} options - Configuration object.
+ */
+function callbackifyAll(
+// tslint:disable-next-line:variable-name
+Class, options) {
+    const exclude = (options && options.exclude) || [];
+    const ownPropertyNames = Object.getOwnPropertyNames(Class.prototype);
+    const methods = ownPropertyNames.filter((methodName) => {
+        // clang-format off
+        return (typeof Class.prototype[methodName] === 'function' && // is it a function?
+            !/^_|(Stream|_)|^constructor$/.test(methodName) && // is it callbackifyable?
+            exclude.indexOf(methodName) === -1); // is it blacklisted?
+        // clang-format on
+    });
+    methods.forEach((methodName) => {
+        const originalMethod = Class.prototype[methodName];
+        if (!originalMethod.callbackified_) {
+            Class.prototype[methodName] = exports.callbackify(originalMethod);
+        }
+    });
+}
+exports.callbackifyAll = callbackifyAll;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "@google-cloud/promisify",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "A simple utility for promisifying functions and classes.",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "googleapis/nodejs-promisify",
   "scripts": {
-    "test": "npm run test-only",
-    "test-only": "nyc mocha build/test",
-    "codecov": "nyc report --reporter=json && codecov -f coverage/*.json",
+    "test": "nyc mocha build/test",
     "lint": "gts check",
     "clean": "gts clean",
     "compile": "tsc -p .",
@@ -16,34 +14,34 @@
     "prepare": "npm run compile",
     "pretest": "npm run compile",
     "posttest": "npm run lint",
-    "docs": "echo no docs 👻",
+    "docs": "compodoc src/",
     "presystem-test": "npm run compile",
     "samples-test": "cd samples/ && npm link ../ && npm test && cd ../",
-    "system-test": "mocha build/system-test"
+    "system-test": "mocha build/system-test",
+    "docs-test": "blcl docs -r --exclude www.googleapis.com",
+    "predocs-test": "npm run docs"
   },
   "keywords": [],
   "files": [
-    "build/src"
+    "build/src",
+    "!build/src/**/*.map"
   ],
   "author": "Google Inc.",
   "license": "Apache-2.0",
   "devDependencies": {
+    "@compodoc/compodoc": "^1.1.7",
     "@types/mocha": "^5.2.4",
     "@types/node": "^10.5.2",
-    "@types/sinon": "^5.0.1",
+    "@types/sinon": "^7.0.0",
     "codecov": "^3.0.4",
-    "gts": "^0.8.0",
+    "gts": "^0.9.0",
     "hard-rejection": "^1.0.0",
     "intelli-espower-loader": "^1.0.1",
     "mocha": "^5.2.0",
     "nyc": "^13.0.0",
-    "sinon": "^6.1.3",
+    "sinon": "^7.0.0",
     "source-map-support": "^0.5.6",
-    "typescript": "^3.0.0"
-  },
-  "nyc": {
-    "exclude": [
-      "build/test"
-    ]
+    "typescript": "^3.0.0",
+    "broken-link-checker-local": "^0.2.0"
   }
 }

package/build/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;AAwBH;;;;;;;GAOG;AACH,SAAgB,SAAS,CACrB,cAA6B,EAAE,OAA0B;IAC3D,IAAI,cAAc,CAAC,YAAY,EAAE;QAC/B,OAAO,cAAc,CAAC;KACvB;IAED,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;IAExB,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC;IAEpC,kCAAkC;IAClC,MAAM,OAAO,GAAQ;QACnB,MAAM,OAAO,GAAG,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC;QAET,KAAK,IAAI,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE;YACnD,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;YAE5B,IAAI,OAAO,GAAG,KAAK,WAAW,EAAE;gBAC9B,SAAS,CAAE,2BAA2B;aACvC;YAED,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE;gBAC7B,MAAM,CAAE,oCAAoC;aAC7C;YAED,OAAO,cAAc,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;SACjD;QAED,2BAA2B;QAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;QAEhD,yCAAyC;QACzC,IAAI,WAAW,GAAG,OAAO,CAAC;QAE1B,wDAAwD;QACxD,oEAAoE;QACpE,oCAAoC;QACpC,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE;YAC9B,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;SAC/B;QAED,OAAO,IAAI,WAAW,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzC,kCAAkC;YAClC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE;gBAC3B,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACtC,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,EAAE,CAAC;gBAEjC,IAAI,GAAG,EAAE;oBACP,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACpB;gBAED,IAAI,OAAQ,CAAC,QAAQ,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;oBAClD,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;iBAC1B;qBAAM;oBACL,OAAO,CAAC,YAAY,CAAC,CAAC;iBACvB;YACH,CAAC,CAAC,CAAC;YAEH,cAAc,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAC5B,OAAO,OAAO,CAAC;AACjB,CAAC;AAjED,8BAiEC;AAED;;;;;;GAMG;AACH,yCAAyC;AACzC,SAAgB,YAAY,CAAC,KAAe,EAAE,OAA6B;IACzE,MAAM,OAAO,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IACnD,MAAM,gBAAgB,GAAG,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACrE,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;QACrD,mBAAmB;QACnB,OAAO,CACL,OAAO,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,UAAU,IAAI,oBAAoB;YACzE,CAAC,wCAAwC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,oBAAoB;YAClF,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CACnC,CAAC,CAAC,qBAAqB;QACxB,kBAAkB;IACpB,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QAC7B,MAAM,cAAc,GAAG,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnD,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE;YAChC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;SAC1E;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAnBD,oCAmBC"}