@google-cloud/nodejs-common 2.3.0 → 2.3.1

package/package.json

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

package/src/apis/auth_client.js

@@ -48,23 +48,23 @@ const DEFAULT_ENV_KEYFILE = 'API_SERVICE_ACCOUNT';
  *
  * There are two use cases for this authentication helper class:
  * 1. The user only has OAuth access due to some reasons, so ADC can't be used;
- * 2. User-managed service account is requried for external APIs for some
+ * 2. User-managed service account is required for external APIs for some
  * specific considerations, e.g. security. In this case, a file based key file
  * can be used to generate a JWT auth client.
  *
  * To solve these challenges, this class tries to probe the settings from
- * enviroment variables, starts from the name of secret (Secret Manager), OAuth
+ * environment variables, starts from the name of secret (Secret Manager), OAuth
  * token file (deprecated), then service account key file (deprecated). It will
  * fallback to ADC if those probing failed.
- * Note, Secret Manager is the recommanded way to store tokens because it is a
+ * Note, Secret Manager is the recommended way to store tokens because it is a
  * secure and convenient central storage system to manage access across Google
  * Cloud.
  *
  * The recommended environment variable is:
  * SECRET_NAME: the name of secret. The secret can be a oauth token file or a
  * service account key file. This env var is used to offer a global auth for a
- * solution. If different auths are required, the value of passed `env` can be
- * set
+ * solution. If different authentications are required, the value of passed
+ * `env` can be set by the runtime.
  *
  * Alternative environment variable but not recommended for prod environment:
  * OAUTH2_TOKEN_JSON : the oauth token key files, refresh token and proper API
@@ -88,7 +88,7 @@ class AuthClient {
 
   /**
    * Prepares the `oauthToken` object and/or `serviceAccountKey` based on the
-   * settings in enviroment object.
+   * settings in environment object.
    * A secret name is preferred to offer the token of the OAuth or key of a
    * service account.
    * To be compatible, this function also checks the env for oauth token file
@@ -100,10 +100,10 @@ class AuthClient {
       return;
     }
     if (this.env[DEFAULT_ENV_SECRET]) {
-      const secretmanager = new SecretManager({
+      const secretManager = new SecretManager({
         projectId: this.env.GCP_PROJECT,
       });
-      const secret = await secretmanager.access(this.env[DEFAULT_ENV_SECRET]);
+      const secret = await secretManager.access(this.env[DEFAULT_ENV_SECRET]);
       if (secret) {
         const secretObj = JSON.parse(secret);
         if (secretObj.token) this.oauthToken = secretObj;
@@ -127,7 +127,7 @@ class AuthClient {
   }
 
   /**
-   * Factory method to offer a prepared AuthClient intance in an async way.
+   * Factory method to offer a prepared AuthClient instance in an async way.
    * @param {string|!Array<string>|!ReadonlyArray<string>} scopes
    * @param {!Object<string,string>=} env The environment object to hold env
    *     variables.
@@ -163,7 +163,7 @@ class AuthClient {
    * steps:
    * 1. Checks environment variable GOOGLE_APPLICATION_CREDENTIALS to get
    * service account. Returns a JWT if it exists;
-   * 2. Uses default service account of Computer Engine/AppEngige/Cloud
+   * 2. Uses default service account of Computer Engine/AppEngine/Cloud
    * Functions
    * 3. Otherwise, an error occurs.
    * @see https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually

package/src/apis/base/ads_api_common.js

@@ -38,7 +38,7 @@ const END_TAG = '"requestId"';
 
 /**
  * A stream.Transform that can extract properties and convert naming of the
- * reponse of Google/Search Ads report from REST interface.
+ * response of Google/Search Ads report from REST interface.
  */
 class RestSearchStreamTransform extends Transform {
 

package/src/apis/google_ads_api.js

@@ -211,7 +211,7 @@ const MAX_IDENTIFIERS = {
 };
 
 /**
- * Configuration for uploading click conversions, call converions or conversion
+ * Configuration for uploading click conversions, call conversions or conversion
  * adjustments for Google Ads, includes:
  * gclid, conversionAction, conversionDateTime, conversionValue,
  * currencyCode, orderId, externalAttributionData,
@@ -598,7 +598,7 @@ class GoogleAdsApi {
    * e.g. wrong conversion Id, wrong gclid, etc.
    * `Status` has a property `message` that has the general information of the
    * error, however, the detailed information (e.g. the failed conversions and
-   * their reasons) lies in the property named `datails` (an array of
+   * their reasons) lies in the property named `details` (an array of
    * `GoogleAdsFailure`). Each `GoogleAdsFailure` is related to a failed
    * conversion. The function `extraFailedLines_` is used to extract the
    * details.
@@ -612,8 +612,8 @@ class GoogleAdsApi {
    * @param {string} customerId
    * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
    * @param {!ConversionConfig} conversionConfig Default conversion parameters.
-   * @param {string} functionName The name of sending converions function, could
-   *   be `uploadClickConversions`, `uploadCallConversions` or
+   * @param {string} functionName The name of sending conversions function,
+   *   could be `uploadClickConversions`, `uploadCallConversions` or
    *   `uploadConversionAdjustments`.
    * @param {string} propertyForDebug The name of property for debug info.
    * @return {!SendSingleBatch} Function which can send a batch of hits to
@@ -945,8 +945,8 @@ class GoogleAdsApi {
         AND user_list.membership_status = OPEN
         AND user_list.crm_based_user_list.upload_key_type = ${uploadKeyType}
     `;
-    const userlists = await this.getReport(customerId, loginCustomerId, query);
-    return userlists.length === 0 ? undefined : userlists[0].userList.id;
+    const userLists = await this.getReport(customerId, loginCustomerId, query);
+    return userLists.length === 0 ? undefined : userLists[0].userList.id;
   }
 
   /**
@@ -954,8 +954,8 @@ class GoogleAdsApi {
    * Id. The user list would be a CRM_BASED type.
    * Trying to create a list with an used name will fail.
    * The Google Ads service behind this function (UserListService) supports
-   * `partial_failure`. Here, we only create one userlist at one time, so
-   * `partial_failure` is disabled to simplified the error handleing process.
+   * `partial_failure`. Here, we only create one user list at one time, so
+   * `partial_failure` is disabled to simplified the error handling process.
    * @see getUploadConversionFnBase_ for more details of error handling.
    * @param {!CustomerMatchConfig} customerMatchConfig
    * @return {number} The created user list id. Note this is not the resource
@@ -973,7 +973,7 @@ class GoogleAdsApi {
       customerId: getCleanCid(customerId),
       operations: [{ create: userList }],
       validateOnly: this.debugMode, // when true makes no changes
-      partialFailure: false, // Simplify error handling in creating userlist
+      partialFailure: false, // Simplify error handling in creating user list
     });
     const client = await this.getUserListServiceClient_();
     const options = this.getCallOptions_(loginCustomerId);
@@ -984,7 +984,7 @@ class GoogleAdsApi {
        */
       const [response] = await client.mutateUserLists(request, options);
       const { results } = response; // No `partialFailureError` here.
-      this.logger.debug(`Created crm userlist from`, customerMatchConfig);
+      this.logger.debug(`Created crm user list from`, customerMatchConfig);
       if (!results[0]) {
         if (this.debugMode) {
           throw new Error('No UserList was created in DEBUG mode.');
@@ -1139,7 +1139,7 @@ class GoogleAdsApi {
   /**
    * Creates a OfflineUserDataJob and returns resource name.
    * @param {OfflineUserDataJobConfig} offlineUserDataJobConfig
-   * @return {string} The resouce name of the creaed job.
+   * @return {string} The resource name of the created job.
    */
   async createOfflineUserDataJob(offlineUserDataJobConfig) {
     const config = this.getCamelConfig_(offlineUserDataJobConfig);
@@ -1231,7 +1231,7 @@ class GoogleAdsApi {
         this.logger.debug(`Add operation to job batch[${batchId}]`, response);
         const { partialFailureError: failed } = response;
         if (failed) {
-          this.logger.info(`Job[${jobResourceName}] faile:`, failed.message);
+          this.logger.info(`Job[${jobResourceName}] fail:`, failed.message);
           const failures = failed.details.map(
             ({ value }) => GoogleAdsFailure.decode(value));
           this.extraFailedLines_(batchResult, failures, lines, 0);
@@ -1331,7 +1331,7 @@ class GoogleAdsApi {
 
   /**
    * Returns a HTTP header object contains the authentication information for
-   * Google Ads API, include: `developer-token` and `ogin-customer-id`.
+   * Google Ads API, include: `developer-token` and `login-customer-id`.
    * @param {string} loginCustomerId
    * @return {object} The HTTP header object.
    * @private
@@ -1360,7 +1360,7 @@ class GoogleAdsApi {
   }
 
   /**
-   * Prepares the feach data service client instance.
+   * Prepares the fetch data service client instance.
    * @return {!GoogleAdsServiceClient}
    * @private
    */
@@ -1447,8 +1447,8 @@ class GoogleAdsApi {
 }
 
 /**
- * Returns an arrary of UserIdentifier object based the given JSON object.
- * @param {Object} record An object contains user indentifier information.
+ * Returns an array of UserIdentifier object based the given JSON object.
+ * @param {Object} record An object contains user identifier information.
  * @param {!Array<string>} identifierTypes An list of user identifier types that
  *   are supported by the target service.
  * @param {number} maximumNumOfIdentifiers The maximum number of user
@@ -1541,7 +1541,7 @@ const buildConversionJsonList = (lines, config, conversionFields,
     })
 }
 /**
- * Returns an arrary of UserData object based on the given arran of JSON strings.
+ * Returns an array of UserData object based on the given arran of JSON strings.
  * @param {!Array<string>} lines An array of JSON strings of UserData.
  * @param {{
  *   additionalAttributes: (!UserIdentifierSource|undefined)

package/src/apis/spreadsheets.js

@@ -67,15 +67,19 @@ let DimensionRange;
 class Spreadsheets extends GoogleApiClient {
   /**
    * Init Spreadsheets API client.
-   * @param {string} spreadsheetId
+   * @param {string} spreadsheetIdOrUrl
    * @param {!Object<string,string>=} env The environment object to hold env
    *     variables.
    */
-  constructor(spreadsheetId, env = process.env) {
+  constructor(spreadsheetIdOrUrl, env = process.env) {
     super(env);
     this.googleApi = 'sheets';
     /** @const {string} */
-    this.spreadsheetId = spreadsheetId;
+    if (spreadsheetIdOrUrl.startsWith('https://')) {
+      this.spreadsheetId = /spreadsheets\/d\/([^/]*)/.exec(spreadsheetIdOrUrl)[1];
+    } else {
+      this.spreadsheetId = spreadsheetIdOrUrl;
+    }
     this.logger = getLogger('API.GS');
   }
 
@@ -109,7 +113,7 @@ class Spreadsheets extends GoogleApiClient {
   }
 
   /**
-   * Returns whether the sheet with speicified name exists.
+   * Returns whether the sheet with specified name exists.
    * @param {string} sheetName
    * @return {boolean}
    */
@@ -122,7 +126,7 @@ class Spreadsheets extends GoogleApiClient {
   }
 
   /**
-   * Creates a sheet with the gvien name.
+   * Creates a sheet with the given name.
    *
    * @param {string} sheetName
    */
@@ -137,7 +141,7 @@ class Spreadsheets extends GoogleApiClient {
   }
 
   /**
-   * Deletes a sheet with the gvien name.
+   * Deletes a sheet with the given name.
    *
    * @param {string} sheetName
    */
@@ -289,6 +293,23 @@ class Spreadsheets extends GoogleApiClient {
     }
     return batchResult;
   }
+
+  /**
+   * Gets values of first row of the specified sheet.
+   * @param {string} sheetName
+   * @return {!Array<string>}
+   */
+  async getHeadline(sheetName) {
+    const request = {
+      spreadsheetId: this.spreadsheetId,
+      range: `'${sheetName}'!1:1`,
+    };
+    const sheets = await this.getApiClient();
+    const response = await sheets.spreadsheets.values.get(request);
+    const data = response.data;
+    this.logger.debug(`Get: `, data);
+    return data.values[0];
+  }
 }
 
 module.exports = {

package/src/components/firestore/access_base.js

@@ -65,7 +65,7 @@ let Filter;
  */
 class DatastoreDocumentFacade {
   /**
-   * Initializes DocumentFacade for Datasotre.
+   * Initializes DocumentFacade for Datastore.
    * @param {!DatastoreModeEntity} entity
    */
   constructor(entity) {
@@ -87,7 +87,7 @@ class DatastoreDocumentFacade {
  */
 class DatastoreTransactionFacade {
   /**
-   * Initializes Firstore TransactionFacade for Datasotre Transaction.
+   * Initializes Firestore TransactionFacade for Datastore Transaction.
    * @param {!DatastoreModeTransaction} transaction
    * @param {!DatastoreModeEntity} entity
    */
@@ -145,7 +145,7 @@ let Database;
  * interface offers unified operations on the data objects in both of these two
  * modes.
  *
- * Firestore Native mode ('Firestore') and Firestore Datastore mode ('Datatore')
+ * Firestore Native mode ('Firestore') and Firestore Datastore mode ('Datastore')
  * have different interfaces:
  * 1. 'Firestore' has two kinds objects: 'document' stands for an object (data
  * entity) and 'collection' stands for a group of 'documents'. The

package/src/components/firestore/data_access_object.js

@@ -34,7 +34,7 @@ const DatastoreModeAccess = require('./datastore_mode_access.js');
 /**
  * This is data access object base class on Firestore. It seals the details of
  * different underlying databases, Firestore and Datastore.
- * This class relies on an initial parameter in construtor to indicate the
+ * This class relies on an initial parameter in constructor to indicate the
  * Firestore type.
  *
  * Firestore and Datastore have different transaction APIs. In that case,

package/src/components/firestore/datastore_mode_access.js

@@ -33,7 +33,7 @@ const {
 } = require('./access_base.js');
 const {getLogger, wait} = require('../utils.js');
 
-/** @const {number} Max retry times when commit failed in a transcation. */
+/** @const {number} Max retry times when commit failed in a transaction. */
 const MAX_RETRY_TIMES = 5;
 
 /**
@@ -66,7 +66,7 @@ class DatastoreModeAccess {
    * Datastore uses 'Key' to identify entities. A 'Key' composes of Id, entity
    * kind and namespace. The 'id' can be 'undefined' if the next operation is
    * creating a new entity.
-   * The default Id of Datastore is a integar. However, Pub/sub can only send
+   * The default Id of Datastore is an integer. However, Pub/sub can only send
    * attributes with string values. This will cause the Datastore Ids to be
    * converted to strings. So here will try to change the id back to number if
    * possible.
@@ -106,7 +106,7 @@ class DatastoreModeAccess {
   async waitUntilGetObject(id) {
     const entity = await this.getObject(id);
     if (entity) return id;
-    this.logger.debug(`Wait 1 more second until the eneity@${id} is ready`);
+    this.logger.debug(`Wait 1 more second until the entity@${id} is ready`);
     return wait(1000, this.waitUntilGetObject(id));
   }
 

package/src/components/pubsub.js

@@ -129,7 +129,7 @@ class EnhancedPubSub {
 
   /**
    * Using `SubscriberClient` to acknowledge messages.
-   * 2022.11.02 The methon `ack()` in Message doesn't work properly due to a
+   * 2022.11.02 The method `ack()` in Message doesn't work properly due to a
    * unknown reason. Use this function to acknowledge a message for now.
    *
    * @param {string} subscription Subscription name.

package/src/components/scheduler.js

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 /**
- * @fileoverview Cloud Scheduler wrapper class, including: pause/resuem a job.
+ * @fileoverview Cloud Scheduler wrapper class, including: pause/resume a job.
  */
 
 'use strict';

package/src/components/storage.js

@@ -116,7 +116,7 @@ class StorageFile {
    */
   async getLastLineBreaker(start, end, checkPoint = -1) {
     /**
-     * How many characters to look back to find a possbile line breaker. If no
+     * How many characters to look back to find a possible line breaker. If no
      * link break in this range, it will extend to find the last one.
      */
     const possibleLineBreakRange = 1000;

package/src/components/utils.js

@@ -29,7 +29,7 @@ const lodash = require('lodash');
  * data that will be sent out in one single request.
  * Some APIs allows partial failure: it will take those correct data and
  * response with reasons for those failed ones. 'groupedFailed' uses error
- * message as the key, and tthe array of related failed lines(records) as value.
+ * message as the key, and the array of related failed lines(records) as value.
  * Some APIs upload whole file. In this case, there will be not 'numberOfLines'
  * or 'failedLines', etc.
  * @typedef {{