@google-cloud/nodejs-common 2.2.2 → 2.3.1

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/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,
@@ -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}.`);

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 {{