@google-cloud/nodejs-common 2.0.16-alpha → 2.0.16-beta

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "2.0.16-alpha",
+  "version": "2.0.16-beta",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",

package/src/apis/google_ads_api.js

@@ -95,7 +95,9 @@ const {
   getLogger,
   BatchResult,
   extractObject,
+  changeNamingFromSnakeToLowerCamel,
   changeObjectNamingFromSnakeToLowerCamel,
+  changeObjectNamingFromLowerCamelToSnake,
 } = require('../components/utils.js');
 
 /** @type {!ReadonlyArray<string>} */
@@ -438,23 +440,31 @@ class GoogleAdsApi {
    * `results` in JSON format strings with the delimit of a line breaker.
    * @param {string} customerId
    * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @param {string} query
+   * @param {string} query A Google Ads Query string.
+   * @param {boolean} outputSnake Output JSON objects in snake_case.
    * @return {!Promise<string>}
    */
-  async cleanedStreamReport(customerId, loginCustomerId, query) {
+  async cleanedStreamReport(customerId, loginCustomerId, query,
+    outputSnake = false) {
     const cleanReportStream = new Transform({
       writableObjectMode: true,
       transform(chunk, encoding, callback) {
         const { fieldMask: { paths } } = chunk;
-        const extractor = extractObject(paths);
+        const camelPaths = paths.map((path) => {
+          return path.split('.').map(changeNamingFromSnakeToLowerCamel).join('.');
+        });
+        const extractor = extractObject(camelPaths);
+        const results = outputSnake
+          ? chunk.results.map(extractor).map(changeObjectNamingFromLowerCamelToSnake)
+          : chunk.results.map(extractor);
         // Add a line break after each chunk to keep files in proper format.
-        const data = chunk.results.map(extractor).map(JSON.stringify).join('\n')
-          + '\n';
+        const data = results.map(JSON.stringify).join('\n') + '\n';
         callback(null, data);
       }
     });
     const stream = await this.streamReport(customerId, loginCustomerId, query);
-    return stream.pipe(cleanReportStream);
+    return stream.on('error', (error) => cleanReportStream.emit('error', error))
+      .pipe(cleanReportStream);
   }
 
   /**
@@ -1536,6 +1546,7 @@ const debugGoogleAdsFailure = (failures, request) => {
 }
 
 module.exports = {
+  GoogleAdsField,
   ConversionConfig,
   CustomerMatchRecord,
   CustomerMatchConfig,

package/src/components/utils.js

@@ -539,6 +539,16 @@ const changeNamingFromSnakeToLowerCamel = (name) => {
       (initial) => initial.substring(1).toUpperCase());
 };
 
+/**
+ * For more details, see:
+ * https://developers.google.com/google-ads/api/docs/rest/design/json-mappings
+ * @param {string} name Identifiers.
+ * @return {string}
+ */
+const changeNamingFromLowerCamelToSnake = (name) => {
+  return name.replace(/([a-z])([A-Z])/g, '$1_$2').toLowerCase();
+};
+
 /**
  * Converts a JSON object which has snake naming convention to lower camel
  * naming.
@@ -561,6 +571,28 @@ const changeObjectNamingFromSnakeToLowerCamel = (obj) => {
   }
 }
 
+/**
+ * Converts a JSON object which has lower camel naming convention to snake
+ * naming.
+ *
+ * @param {object} obj
+ * @return {object}
+ */
+const changeObjectNamingFromLowerCamelToSnake = (obj) => {
+  if (Array.isArray(obj)) {
+    return obj.map(changeObjectNamingFromLowerCamelToSnake);
+  } else if (typeof obj === 'object') {
+    const newObj = {};
+    Object.keys(obj).forEach((key) => {
+      newObj[changeNamingFromLowerCamelToSnake(key)] =
+        changeObjectNamingFromLowerCamelToSnake(obj[key]);
+    });
+    return newObj;
+  } else {
+    return obj;
+  }
+}
+
 /**
  * Returns the response data for a HTTP request. It will retry the specific
  * times if there was errors happened.
@@ -606,6 +638,8 @@ module.exports = {
   getObjectByPath,
   changeNamingFromSnakeToUpperCamel,
   changeNamingFromSnakeToLowerCamel,
+  changeNamingFromLowerCamelToSnake,
   changeObjectNamingFromSnakeToLowerCamel,
+  changeObjectNamingFromLowerCamelToSnake,
   requestWithRetry,
 };