@google-cloud/nodejs-common 2.2.2 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",
@@ -16,28 +16,26 @@
   },
   "homepage": "https://github.com/GoogleCloudPlatform/cloud-for-marketing/blob/master/marketing-analytics/activation/common-libs/nodejs-common/README.md",
   "dependencies": {
-    "@google-cloud/aiplatform": "^3.17.0",
+    "@google-cloud/aiplatform": "^3.25.0",
     "@google-cloud/automl": "^4.0.1",
-    "@google-cloud/bigquery": "^7.5.2",
-    "@google-cloud/datastore": "^8.6.0",
-    "@google-cloud/firestore": "^7.5.0",
+    "@google-cloud/bigquery": "^7.8.0",
+    "@google-cloud/datastore": "^9.1.0",
+    "@google-cloud/firestore": "^7.9.0",
     "@google-cloud/logging-winston": "^6.0.0",
-    "@google-cloud/pubsub": "^4.3.3",
-    "@google-cloud/storage": "^7.9.0",
-    "@google-cloud/scheduler": "^4.1.0",
-    "@google-cloud/secret-manager": "^5.2.0",
-    "gaxios": "^6.3.0",
+    "@google-cloud/pubsub": "^4.5.0",
+    "@google-cloud/storage": "^7.12.0",
+    "@google-cloud/scheduler": "^4.3.0",
+    "@google-cloud/secret-manager": "^5.6.0",
+    "gaxios": "^6.7.0",
     "google-ads-nodejs-client": "16.0.0",
-    "google-ads-api": "^14.1.0",
-    "google-ads-node": "^12.0.2",
-    "google-auth-library": "^9.7.0",
-    "googleapis": "^134.0.0",
-    "winston": "^3.13.0",
-    "@grpc/grpc-js": "^1.10.5",
+    "google-auth-library": "^9.11.0",
+    "googleapis": "^140.0.1",
+    "winston": "^3.13.1",
+    "@grpc/grpc-js": "^1.11.1",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "jasmine": "^5.1.0"
+    "jasmine": "^5.2.0"
   },
   "scripts": {
     "test": "node node_modules/jasmine/bin/jasmine"

package/src/apis/base/google_api_client.js

@@ -16,7 +16,7 @@
  * @fileoverview A base class for Google Api client library class.
  */
 const { google } = require('googleapis');
-const { getLogger, getObjectByPath } = require('../../components/utils.js');
+const { getLogger } = require('../../components/utils.js');
 const { AuthRestfulApi } = require('./auth_restful_api.js');
 
 /**

package/src/apis/doubleclick_bidmanager.js

@@ -94,13 +94,13 @@ class DoubleClickBidManager extends GoogleApiClient {
    * Gets a query metadata.
    * See https://developers.google.com/bid-manager/reference/rest/v2/queries/get
    * @param {number} queryId Id of the query.
-   * @return {!Promise<!QueryMetadata>} Query metadata, see
-   *     https://developers.google.com/bid-manager/reference/rest/v2/queries#QueryMetadata
+   * @return {!Promise<!Query>} Query, see
+   *     https://developers.google.com/bid-manager/reference/rest/v2/queries#Query
    */
   async getQuery(queryId) {
     const doubleclickbidmanager = await this.getApiClient();
     const response = await doubleclickbidmanager.queries.get({ queryId });
-    return response.data.metadata;
+    return response.data;
   }
 
   /**

package/src/apis/gmail.js

@@ -0,0 +1,113 @@
+// Copyright 2024 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// 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.
+
+/** @fileoverview Gmail API Client Library. */
+
+'use strict';
+
+const { GoogleApiClient } = require('./base/google_api_client.js');
+
+const API_SCOPES =
+  Object.freeze(['https://www.googleapis.com/auth/gmail.send']);
+const API_VERSION = 'v1';
+
+/**
+ * @typedef {{
+ *     from: string|undefined,
+ *     to: string|Array<string>,
+ *     cc: string|Array<string>|undefined,
+ *     bcc: string|Array<string>|undefined,
+ *     'reply-to': string|Array<string>|undefined,
+ *     subject: string,
+ *     content: string,
+ *     type: 'text/plain'|'text/html'|undefined,
+ * }}
+ */
+let EmailOptions;
+
+/**
+ * Email sending class based on Gmail API.
+ */
+class Gmail extends GoogleApiClient {
+
+  constructor(env = process.env) {
+    super(env);
+    this.googleApi = 'gmail';
+  }
+
+  /** @override */
+  getScope() {
+    return API_SCOPES;
+  }
+
+  /** @override */
+  getVersion() {
+    return API_VERSION;
+  }
+
+  /**
+   * Generates a string for an email in RFC 2822 format.
+   * If 'from' is different from the OAuth token's owner account, it would be
+   * ignored.
+   * @param {!EmailOptions} options
+   * @return {string}
+   * @private
+   */
+  getRawEmail_(options = {}) {
+    const message = [];
+    ['from', 'to', 'cc', 'bcc', 'reply-to', 'subject'].forEach((key) => {
+      if (options[key]) {
+        const value = Array.isArray(options[key])
+          ? options[key].join(',') : options[key];
+        message.push(`${key}: ${value}`);
+      }
+    });
+    if (message.length === 0)
+      throw new Error(`Can not get email from ${options}`);
+    message.push('\n');
+    message.push(options.content);
+    return message.join('\n');
+  }
+
+  /**
+   * Sends a simple email (no attachment).
+   * @see https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send
+   * @param {!EmailOptions} options
+   * @return {!Message}
+   */
+  async sendSimpleEmail(options) {
+    const email = this.getRawEmail_(options);
+
+    const gmail = await this.getApiClient();
+    const message = {
+      userId: 'me',
+      requestBody: { raw: Buffer.from(email).toString('base64') }
+    };
+    try {
+      const response = await gmail.users.messages.send(message);
+      return { responseStatus: response.status };
+    } catch (error) {
+      this.logger.error('Result of sending an email', JSON.stringify(error));
+      return { responseStatus: error.status };
+    }
+  }
+
+}
+
+module.exports = {
+  Gmail,
+  EmailOptions,
+  API_SCOPES,
+  API_VERSION,
+};

package/src/apis/index.js

@@ -99,18 +99,6 @@ exports.doubleclickbidmanager = require('./doubleclick_bidmanager.js');
  */
 exports.bigquery = require('./bigquery.js');
 
-/**
- * APIs integration class for Google Ads.
- * @const {{
- *   GoogleAds:!GoogleAds,
- *   ConversionConfig:!ConversionConfig,
- *   CustomerMatchConfig: !CustomerMatchConfig,
- *   CustomerMatchRecord: !CustomerMatchRecord,
- *   ReportQueryConfig:!ReportQueryConfig,
- * }}
- */
-exports.googleads = require('./google_ads.js');
-
 /**
  * APIs integration class for Google Ads with Google API library.
  * @const {{
@@ -146,9 +134,7 @@ exports.measurementprotocolga4 = require('./measurement_protocol_ga4.js');
 /**
  * APIs integration class for YouTube.
  * @const {{
- *   YouTube:!YouTube,
- *   ListChannelsConfig: !ListChannelsConfig,
- *   ListVideosConfig: !ListVideosConfig,
+ *   YouTube:!YouTube
  * }}
  */
 exports.youtube = require('./youtube.js');
@@ -162,3 +148,12 @@ exports.youtube = require('./youtube.js');
 * }}
 */
 exports.sendgrid = require('./sendgrid.js');
+
+/**
+ * APIs integration class for Gmail.
+ * @const {{
+*   Gmail:!Gmail,
+*   API_VERSION: string,
+* }}
+*/
+exports.gmail = require('./gmail.js');

package/src/apis/sendgrid.js

@@ -18,12 +18,33 @@
 
 'use strict';
 
+const { EmailOptions } = require('./gmail.js');
 const { RestfulApiBase } = require('./base/restful_api_base.js');
 const { getLogger } = require('../components/utils.js');
 
 const API_VERSION = 'v3';
 const API_ENDPOINT = 'https://api.sendgrid.com';
 
+/**
+ * Returns a SendGrid email object based on a given RFC 2822 `mailbox` string.
+ * For `mailbox` @see https://www.rfc-editor.org/rfc/rfc2822#page-15
+ * @param {string} mailbox
+ * @return {{name: string, email: string}} A SendGrid email object.
+ */
+function getSendGridEmail(mailbox) {
+  if (typeof mailbox === 'string') {
+    if (mailbox.indexOf('<') > -1) {
+      const name = mailbox.substring(0, mailbox.indexOf('<')).trim();
+      const email =
+        mailbox.substring(mailbox.indexOf('<') + 1, mailbox.indexOf('>'));
+      return { name, email };
+    } else {
+      return { email: mailbox.trim() };
+    }
+  }
+  return mailbox;
+}
+
 /**
  * SendGrid API access class.
  * @see https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/authentication
@@ -48,11 +69,51 @@ class SendGrid extends RestfulApiBase {
     });
   }
 
+  /**
+   * Generates an email object for Sendgrid.
+   * @param {!EmailOptions} options
+   * @return {object}
+   * @see https://www.twilio.com/docs/sendgrid/api-reference/mail-send/mail-send#reques
+   * @private
+   */
+  getEmail_(options = {}) {
+    const {
+      from,
+      'reply-to': reply_to,
+      subject,
+      content,
+      type = 'text/plain',
+    } = options;
+    const recipientObject = {};
+    ['to', 'cc', 'bcc'].forEach((key) => {
+      if (options[key]) {
+        recipientObject[key] = [options[key]].flat().map(getSendGridEmail);
+      }
+    });
+    const email = {
+      subject,
+      content: [{ type, value: content }],
+      personalizations: [recipientObject],
+    };
+    if (from) email.from = getSendGridEmail(from);
+    //@see https://www.twilio.com/docs/sendgrid/api-reference/mail-send/mail-send#reques
+    if (reply_to) {
+      if (Array.isArray(reply_to)) {
+        email.reply_to_list = reply_to.map(getSendGridEmail);
+      } else {
+        email.reply_to = getSendGridEmail(reply_to);
+      }
+    }
+    return email;
+  }
+
   /**
    * Sends an email.
+   * @param {!EmailOptions} options
    * @see https://docs.sendgrid.com/api-reference/mail-send/mail-send
    */
-  async sendMail(email) {
+  async sendMail(options) {
+    const email = this.getEmail_(options);
     const response = await this.request('mail/send', 'POST', email);
     return response;
   }

package/src/apis/youtube.js

@@ -34,130 +34,9 @@ const API_SCOPES = Object.freeze([
 ]);
 const API_VERSION = 'v3';
 
-/**
- * Configuration for listing youtube channels.
- * @see https://developers.google.com/youtube/v3/docs/channels/list
- * @typedef {{
- *   part: Array<string>,
- *   categoryId: (string|undefined),
- *   forUsername: (string|undefined),
- *   id: (string|undefined),
- *   managedByMe: (boolean|undefined),
- *   mine: (boolean|undefined),
- *   hl: (string|undefined),
- *   onBehalfOfContentOwner: (string|undefined),
- *   pageToken: (string|undefined),
- * }}
- */
-let ListChannelsConfig;
-
-/**
- * Configuration for listing youtube videos.
- * @see https://developers.google.com/youtube/v3/docs/videos/list
- * @typedef {{
- *   part: Array<string>,
- *   id: (string|undefined),
- *   chart: (string|undefined),
- *   hl: (string|undefined),
- *   maxHeight: (unsigned integer|undefined),
- *   maxResults: (unsigned integer|undefined),
- *   maxWidth: (unsigned integer|undefined),
- *   onBehalfOfContentOwner: (string|undefined),
- *   pageToken: (string|undefined),
- *   regionCode: (string|undefined),
- * }}
- */
-let ListVideosConfig;
-
-/**
- * Configuration for listing youtube comment threads by the given id.
- * @see https://developers.google.com/youtube/v3/docs/commentThreads/list
- * @typedef {{
- *   part: Array<string>,
- *   id: (string|undefined),
- *   allThreadsRelatedToChannelId:	(string|undefined),
- *   channelId:	(string|undefined),
- *   videoId:	(string|undefined),
- *   maxResults: (unsigned integer|undefined),
- *   moderationStatus: (string|undefined),
- *   order: (string|undefined),
- *   pageToken: (string|undefined),
- *   searchTerms: (string|undefined),
- *   textFormat: (string|undefined),
- *   limit: (unsigned integer|undefined),
- * }}
- */
-let ListCommentThreadsConfig;
-
-/**
- * Configuration for listing youtube play list.
- * @see https://developers.google.com/youtube/v3/docs/Playlists/list
- * @typedef {{
- *   part: Array<string>,
- *   channelId:	(string|undefined),
- *   id: (string|undefined),
- *   mine:	(boolean|undefined),
- *   hl:	(string|undefined),
- *   maxResults: (unsigned integer|undefined),
- *   onBehalfOfContentOwner: (string|undefined),
- *   onBehalfOfContentOwnerChannel: (string|undefined),
- *   pageToken: (string|undefined)
- * }}
- */
-let ListPlaylistConfig;
-
-/**
- * Configuration for listing youtube search results.
- * @see https://developers.google.com/youtube/v3/docs/search/list
- * @typedef {{
- *   part: Array<string>,
- *   forContentOwner:	(boolean|undefined),
- *   forDeveloper:	(boolean|undefined),
- *   forMine:	(boolean|undefined),
- *   relatedToVideoId:	(string|undefined),
- *   channelId:	(string|undefined),
- *   channelType:	(string|undefined),
- *   eventType:	(string|undefined),
- *   location:	(string|undefined),
- *   locationRadius:	(string|undefined),
- *   maxResults: (unsigned integer|undefined),
- *   onBehalfOfContentOwner:	(string|undefined),
- *   order:	(string|undefined),
- *   pageToken:	(string|undefined),
- *   publishedAfter: (datetime|undefined),
- *   publishedBefore: (datetime|undefined),
- *   q:	(string|undefined),
- *   regionCode:	(string|undefined),
- *   relevanceLanguage:	(string|undefined),
- *   safeSearch:	(string|undefined),
- *   topicId:	(string|undefined),
- *   type:	(string|undefined),
- *   videoCaption:	(string|undefined),
- *   videoCategoryId:	(string|undefined),
- *   videoDefinition:	(string|undefined),
- *   videoDimension:	(string|undefined),
- *   videoDuration:	(string|undefined),
- *   videoEmbeddable:	(string|undefined),
- *   videoLicense:	(string|undefined),
- *   videoSyndicated:	(string|undefined),
- *   videoType:	(string|undefined)
- * }}
- */
-let ListSearchConfig;
-
 /**
  * Youtube API v3 stub.
  * See: https://developers.google.com/youtube/v3/docs
- * Channel list type definition, see:
- * https://developers.google.com/youtube/v3/docs/channels/list
- * Video list type definition, see:
- * https://developers.google.com/youtube/v3/docs/videos/list
- * CommentThread list type definition, see:
- * https://developers.google.com/youtube/v3/docs/commentThreads/list
- * Playlist list type definition, see:
- * https://developers.google.com/youtube/v3/docs/playlists/list
- * Search list type definition, see:
- * https://developers.google.com/youtube/v3/docs/search/list
  */
 class YouTube extends GoogleApiClient {
   /**
@@ -180,173 +59,10 @@ class YouTube extends GoogleApiClient {
   getVersion() {
     return API_VERSION;
   }
-
-  /**
-   * Returns a collection of zero or more channel resources that match the
-   * request criteria.
-   * @see https://developers.google.com/youtube/v3/docs/channels/list
-   * @param {!ListChannelsConfig} config List channels configuration.
-   * @return {!Promise<Array<Schema$Channel>>}
-   */
-  async listChannels(config) {
-    const channelListRequest = Object.assign({}, config);
-    channelListRequest.part = channelListRequest.part.join(',')
-    try {
-      const youtube = await this.getApiClient();
-      const response = await youtube.channels.list(channelListRequest);
-      this.logger.debug('Response: ', response);
-      return response.data.items;
-    } catch (error) {
-      const errorMsg =
-          `Fail to list channels: ${JSON.stringify(channelListRequest)}`;
-      this.logger.error('YouTube list channels failed.', error.message);
-      this.logger.debug('Errors in response:', error);
-      throw new Error(errorMsg);
-    }
-  }
-
-  /**
-   * Returns a list of videos that match the API request parameters.
-   * @see https://developers.google.com/youtube/v3/docs/videos/list
-   * @param {!ListVideosConfig} config List videos configuration.
-   * @return {!Promise<Array<Schema$Video>>}
-   */
-  async listVideos(config) {
-    const videoListRequest = Object.assign({}, config);
-    videoListRequest.part = videoListRequest.part.join(',')
-    try {
-      const youtube = await this.getApiClient();
-      const response = await youtube.videos.list(videoListRequest);
-      this.logger.debug('Response: ', response);
-      return response.data.items;
-    } catch (error) {
-      const errorMsg =
-          `Fail to list videos: ${JSON.stringify(videoListRequest)}`;
-      this.logger.error('YouTube list videos failed.', error.message);
-      this.logger.debug('Errors in response:', error);
-      throw new Error(errorMsg);
-    }
-  }
-
-  /**
-   * Returns a list of comment threads that match the API request parameters.
-   * @see https://developers.google.com/youtube/v3/docs/videos/list
-   * @param {!ListCommentThreadsConfig} config List comment threads
-   *   configuration.
-   * @return {!Promise<Array<Schema$CommentThread>>}
-   */
-  async listCommentThreads(config) {
-    const commentThreadsRequest = Object.assign({}, config);
-    commentThreadsRequest.part = commentThreadsRequest.part.join(',')
-    try {
-      const youtube = await this.getApiClient();
-      const response = await youtube.commentThreads.list(commentThreadsRequest);
-      this.logger.debug('Response: ', response.data);
-      return response.data.items;
-    } catch (error) {
-      const errorMsg =
-        `Fail to list comment threads: ${JSON.stringify(commentThreadsRequest)}`;
-      this.logger.error('YouTube list comment threads failed.', error.message);
-      this.logger.debug('Errors in response:', error);
-      throw new Error(errorMsg);
-    }
-  }
-
-  /**
-   * Returns a collection of playlists that match the API request parameters.
-   * @see https://developers.google.com/youtube/v3/docs/playlists/list
-   * @param {!ListPlaylistConfig} config List playlist configuration.
-   * @param {number} resultLimit The limit of the number of results.
-   * @param {string} pageToken Token to identify a specific page in the result.
-   * @return {!Promise<Array<Schema$Playlist>>}
-   */
-  async listPlaylists(config, resultLimit = 1000, pageToken = null) {
-    if (resultLimit <= 0) return [];
-
-    const playlistsRequest = Object.assign({
-        // auth: this.auth,
-    }, config, {
-        pageToken
-    });
-
-    if (Array.isArray(playlistsRequest.part)) {
-      playlistsRequest.part = playlistsRequest.part.join(',');
-    }
-
-    try {
-      const youtube = await this.getApiClient();
-      const response = await youtube.playlists.list(playlistsRequest);
-      this.logger.debug('Response: ', response.data);
-      if (response.data.nextPageToken) {
-        this.logger.debug(
-          'Call youtube playlist:list API agian with Token: ',
-          response.data.nextPageToken);
-        const nextResponse = await this.listPlaylists(
-          config,
-          resultLimit - response.data.items.length,
-          response.data.nextPageToken);
-        return response.data.items.concat(nextResponse);
-      }
-      return response.data.items;
-    } catch (error) {
-      const errorMsg =
-        `Fail to list playlists: ${JSON.stringify(playlistsRequest)}`;
-      this.logger.error('YouTube list playlists failed.', error.message);
-      this.logger.debug('Errors in response:', error);
-      throw new Error(errorMsg);
-    }
-  }
-
-  /**
-   * Returns a collection of search results that match the query parameters
-   * specified in the API request.
-   * @see https://developers.google.com/youtube/v3/docs/search/list
-   * @param {!ListSearchConfig} config List search result configuration.
-   * @param {number} resultLimit The limit of the number of results.
-   * @param {string} pageToken Token to identify a specific page in the result.
-   * @return {!Promise<Array<Schema$Search>>}
-   */
-  async listSearchResults(config, resultLimit = 1000, pageToken = null) {
-    if (resultLimit <= 0) return [];
-
-    const searchRequest = Object.assign({}, config, { pageToken });
-
-    if (Array.isArray(searchRequest.part)) {
-      searchRequest.part = searchRequest.part.join(',');
-    }
-
-    try {
-      const youtube = await this.getApiClient();
-      const response = await youtube.search.list(searchRequest);
-      this.logger.debug('Response: ', response.data);
-      if (response.data.nextPageToken) {
-        this.logger.debug(
-          'Call youtube search:list API agian with Token: ',
-          response.data.nextPageToken);
-        const nextResponse = await this.listSearchResults(
-          config,
-          resultLimit - response.data.items.length,
-          response.data.nextPageToken);
-        return response.data.items.concat(nextResponse);
-      }
-      return response.data.items;
-    } catch (error) {
-      const errorMsg =
-        `Fail to list search results: ${JSON.stringify(searchRequest)}`;
-      this.logger.error('YouTube list search results failed.', error.message);
-      this.logger.debug('Errors in response:', error);
-      throw new Error(errorMsg);
-    }
-  }
 }
 
 module.exports = {
   YouTube,
-  ListChannelsConfig,
-  ListVideosConfig,
-  ListCommentThreadsConfig,
-  ListPlaylistConfig,
-  ListSearchConfig,
   API_VERSION,
   API_SCOPES,
 };

package/src/components/firestore/data_access_object.js

@@ -54,16 +54,16 @@ class DataAccessObject {
     /** @const {string} */ this.namespace = namespace;
     /** @const {!DataSource} */ this.dataSource =
       typeof database === 'string' ? database : database.source;
-    const databaseId = database.id || DEFAULT_DATABASE;
+    this.databaseId = database.id || DEFAULT_DATABASE;
     /** @type {!FirestoreAccessBase} */ this.accessObject = undefined;
     switch (this.dataSource) {
       case DataSource.FIRESTORE:
         this.accessObject = new NativeModeAccess(
-          `${this.namespace}/database/${kind}`, projectId, databaseId);
+          `${this.namespace}/database/${kind}`, projectId, this.databaseId);
         break;
       case DataSource.DATASTORE:
         this.accessObject = new DatastoreModeAccess(this.namespace, kind,
-          projectId, databaseId);
+          projectId, this.databaseId);
         break;
       default:
         throw new Error(`Unknown DataSource item: ${this.dataSource}.`);