@google-cloud/nodejs-common 2.2.1 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -34,130 +34,9 @@ const API_SCOPES = Object.freeze([
34
34
  ]);
35
35
  const API_VERSION = 'v3';
36
36
 
37
- /**
38
- * Configuration for listing youtube channels.
39
- * @see https://developers.google.com/youtube/v3/docs/channels/list
40
- * @typedef {{
41
- * part: Array<string>,
42
- * categoryId: (string|undefined),
43
- * forUsername: (string|undefined),
44
- * id: (string|undefined),
45
- * managedByMe: (boolean|undefined),
46
- * mine: (boolean|undefined),
47
- * hl: (string|undefined),
48
- * onBehalfOfContentOwner: (string|undefined),
49
- * pageToken: (string|undefined),
50
- * }}
51
- */
52
- let ListChannelsConfig;
53
-
54
- /**
55
- * Configuration for listing youtube videos.
56
- * @see https://developers.google.com/youtube/v3/docs/videos/list
57
- * @typedef {{
58
- * part: Array<string>,
59
- * id: (string|undefined),
60
- * chart: (string|undefined),
61
- * hl: (string|undefined),
62
- * maxHeight: (unsigned integer|undefined),
63
- * maxResults: (unsigned integer|undefined),
64
- * maxWidth: (unsigned integer|undefined),
65
- * onBehalfOfContentOwner: (string|undefined),
66
- * pageToken: (string|undefined),
67
- * regionCode: (string|undefined),
68
- * }}
69
- */
70
- let ListVideosConfig;
71
-
72
- /**
73
- * Configuration for listing youtube comment threads by the given id.
74
- * @see https://developers.google.com/youtube/v3/docs/commentThreads/list
75
- * @typedef {{
76
- * part: Array<string>,
77
- * id: (string|undefined),
78
- * allThreadsRelatedToChannelId: (string|undefined),
79
- * channelId: (string|undefined),
80
- * videoId: (string|undefined),
81
- * maxResults: (unsigned integer|undefined),
82
- * moderationStatus: (string|undefined),
83
- * order: (string|undefined),
84
- * pageToken: (string|undefined),
85
- * searchTerms: (string|undefined),
86
- * textFormat: (string|undefined),
87
- * limit: (unsigned integer|undefined),
88
- * }}
89
- */
90
- let ListCommentThreadsConfig;
91
-
92
- /**
93
- * Configuration for listing youtube play list.
94
- * @see https://developers.google.com/youtube/v3/docs/Playlists/list
95
- * @typedef {{
96
- * part: Array<string>,
97
- * channelId: (string|undefined),
98
- * id: (string|undefined),
99
- * mine: (boolean|undefined),
100
- * hl: (string|undefined),
101
- * maxResults: (unsigned integer|undefined),
102
- * onBehalfOfContentOwner: (string|undefined),
103
- * onBehalfOfContentOwnerChannel: (string|undefined),
104
- * pageToken: (string|undefined)
105
- * }}
106
- */
107
- let ListPlaylistConfig;
108
-
109
- /**
110
- * Configuration for listing youtube search results.
111
- * @see https://developers.google.com/youtube/v3/docs/search/list
112
- * @typedef {{
113
- * part: Array<string>,
114
- * forContentOwner: (boolean|undefined),
115
- * forDeveloper: (boolean|undefined),
116
- * forMine: (boolean|undefined),
117
- * relatedToVideoId: (string|undefined),
118
- * channelId: (string|undefined),
119
- * channelType: (string|undefined),
120
- * eventType: (string|undefined),
121
- * location: (string|undefined),
122
- * locationRadius: (string|undefined),
123
- * maxResults: (unsigned integer|undefined),
124
- * onBehalfOfContentOwner: (string|undefined),
125
- * order: (string|undefined),
126
- * pageToken: (string|undefined),
127
- * publishedAfter: (datetime|undefined),
128
- * publishedBefore: (datetime|undefined),
129
- * q: (string|undefined),
130
- * regionCode: (string|undefined),
131
- * relevanceLanguage: (string|undefined),
132
- * safeSearch: (string|undefined),
133
- * topicId: (string|undefined),
134
- * type: (string|undefined),
135
- * videoCaption: (string|undefined),
136
- * videoCategoryId: (string|undefined),
137
- * videoDefinition: (string|undefined),
138
- * videoDimension: (string|undefined),
139
- * videoDuration: (string|undefined),
140
- * videoEmbeddable: (string|undefined),
141
- * videoLicense: (string|undefined),
142
- * videoSyndicated: (string|undefined),
143
- * videoType: (string|undefined)
144
- * }}
145
- */
146
- let ListSearchConfig;
147
-
148
37
  /**
149
38
  * Youtube API v3 stub.
150
39
  * See: https://developers.google.com/youtube/v3/docs
151
- * Channel list type definition, see:
152
- * https://developers.google.com/youtube/v3/docs/channels/list
153
- * Video list type definition, see:
154
- * https://developers.google.com/youtube/v3/docs/videos/list
155
- * CommentThread list type definition, see:
156
- * https://developers.google.com/youtube/v3/docs/commentThreads/list
157
- * Playlist list type definition, see:
158
- * https://developers.google.com/youtube/v3/docs/playlists/list
159
- * Search list type definition, see:
160
- * https://developers.google.com/youtube/v3/docs/search/list
161
40
  */
162
41
  class YouTube extends GoogleApiClient {
163
42
  /**
@@ -180,173 +59,10 @@ class YouTube extends GoogleApiClient {
180
59
  getVersion() {
181
60
  return API_VERSION;
182
61
  }
183
-
184
- /**
185
- * Returns a collection of zero or more channel resources that match the
186
- * request criteria.
187
- * @see https://developers.google.com/youtube/v3/docs/channels/list
188
- * @param {!ListChannelsConfig} config List channels configuration.
189
- * @return {!Promise<Array<Schema$Channel>>}
190
- */
191
- async listChannels(config) {
192
- const channelListRequest = Object.assign({}, config);
193
- channelListRequest.part = channelListRequest.part.join(',')
194
- try {
195
- const youtube = await this.getApiClient();
196
- const response = await youtube.channels.list(channelListRequest);
197
- this.logger.debug('Response: ', response);
198
- return response.data.items;
199
- } catch (error) {
200
- const errorMsg =
201
- `Fail to list channels: ${JSON.stringify(channelListRequest)}`;
202
- this.logger.error('YouTube list channels failed.', error.message);
203
- this.logger.debug('Errors in response:', error);
204
- throw new Error(errorMsg);
205
- }
206
- }
207
-
208
- /**
209
- * Returns a list of videos that match the API request parameters.
210
- * @see https://developers.google.com/youtube/v3/docs/videos/list
211
- * @param {!ListVideosConfig} config List videos configuration.
212
- * @return {!Promise<Array<Schema$Video>>}
213
- */
214
- async listVideos(config) {
215
- const videoListRequest = Object.assign({}, config);
216
- videoListRequest.part = videoListRequest.part.join(',')
217
- try {
218
- const youtube = await this.getApiClient();
219
- const response = await youtube.videos.list(videoListRequest);
220
- this.logger.debug('Response: ', response);
221
- return response.data.items;
222
- } catch (error) {
223
- const errorMsg =
224
- `Fail to list videos: ${JSON.stringify(videoListRequest)}`;
225
- this.logger.error('YouTube list videos failed.', error.message);
226
- this.logger.debug('Errors in response:', error);
227
- throw new Error(errorMsg);
228
- }
229
- }
230
-
231
- /**
232
- * Returns a list of comment threads that match the API request parameters.
233
- * @see https://developers.google.com/youtube/v3/docs/videos/list
234
- * @param {!ListCommentThreadsConfig} config List comment threads
235
- * configuration.
236
- * @return {!Promise<Array<Schema$CommentThread>>}
237
- */
238
- async listCommentThreads(config) {
239
- const commentThreadsRequest = Object.assign({}, config);
240
- commentThreadsRequest.part = commentThreadsRequest.part.join(',')
241
- try {
242
- const youtube = await this.getApiClient();
243
- const response = await youtube.commentThreads.list(commentThreadsRequest);
244
- this.logger.debug('Response: ', response.data);
245
- return response.data.items;
246
- } catch (error) {
247
- const errorMsg =
248
- `Fail to list comment threads: ${JSON.stringify(commentThreadsRequest)}`;
249
- this.logger.error('YouTube list comment threads failed.', error.message);
250
- this.logger.debug('Errors in response:', error);
251
- throw new Error(errorMsg);
252
- }
253
- }
254
-
255
- /**
256
- * Returns a collection of playlists that match the API request parameters.
257
- * @see https://developers.google.com/youtube/v3/docs/playlists/list
258
- * @param {!ListPlaylistConfig} config List playlist configuration.
259
- * @param {number} resultLimit The limit of the number of results.
260
- * @param {string} pageToken Token to identify a specific page in the result.
261
- * @return {!Promise<Array<Schema$Playlist>>}
262
- */
263
- async listPlaylists(config, resultLimit = 1000, pageToken = null) {
264
- if (resultLimit <= 0) return [];
265
-
266
- const playlistsRequest = Object.assign({
267
- // auth: this.auth,
268
- }, config, {
269
- pageToken
270
- });
271
-
272
- if (Array.isArray(playlistsRequest.part)) {
273
- playlistsRequest.part = playlistsRequest.part.join(',');
274
- }
275
-
276
- try {
277
- const youtube = await this.getApiClient();
278
- const response = await youtube.playlists.list(playlistsRequest);
279
- this.logger.debug('Response: ', response.data);
280
- if (response.data.nextPageToken) {
281
- this.logger.debug(
282
- 'Call youtube playlist:list API agian with Token: ',
283
- response.data.nextPageToken);
284
- const nextResponse = await this.listPlaylists(
285
- config,
286
- resultLimit - response.data.items.length,
287
- response.data.nextPageToken);
288
- return response.data.items.concat(nextResponse);
289
- }
290
- return response.data.items;
291
- } catch (error) {
292
- const errorMsg =
293
- `Fail to list playlists: ${JSON.stringify(playlistsRequest)}`;
294
- this.logger.error('YouTube list playlists failed.', error.message);
295
- this.logger.debug('Errors in response:', error);
296
- throw new Error(errorMsg);
297
- }
298
- }
299
-
300
- /**
301
- * Returns a collection of search results that match the query parameters
302
- * specified in the API request.
303
- * @see https://developers.google.com/youtube/v3/docs/search/list
304
- * @param {!ListSearchConfig} config List search result configuration.
305
- * @param {number} resultLimit The limit of the number of results.
306
- * @param {string} pageToken Token to identify a specific page in the result.
307
- * @return {!Promise<Array<Schema$Search>>}
308
- */
309
- async listSearchResults(config, resultLimit = 1000, pageToken = null) {
310
- if (resultLimit <= 0) return [];
311
-
312
- const searchRequest = Object.assign({}, config, { pageToken });
313
-
314
- if (Array.isArray(searchRequest.part)) {
315
- searchRequest.part = searchRequest.part.join(',');
316
- }
317
-
318
- try {
319
- const youtube = await this.getApiClient();
320
- const response = await youtube.search.list(searchRequest);
321
- this.logger.debug('Response: ', response.data);
322
- if (response.data.nextPageToken) {
323
- this.logger.debug(
324
- 'Call youtube search:list API agian with Token: ',
325
- response.data.nextPageToken);
326
- const nextResponse = await this.listSearchResults(
327
- config,
328
- resultLimit - response.data.items.length,
329
- response.data.nextPageToken);
330
- return response.data.items.concat(nextResponse);
331
- }
332
- return response.data.items;
333
- } catch (error) {
334
- const errorMsg =
335
- `Fail to list search results: ${JSON.stringify(searchRequest)}`;
336
- this.logger.error('YouTube list search results failed.', error.message);
337
- this.logger.debug('Errors in response:', error);
338
- throw new Error(errorMsg);
339
- }
340
- }
341
62
  }
342
63
 
343
64
  module.exports = {
344
65
  YouTube,
345
- ListChannelsConfig,
346
- ListVideosConfig,
347
- ListCommentThreadsConfig,
348
- ListPlaylistConfig,
349
- ListSearchConfig,
350
66
  API_VERSION,
351
67
  API_SCOPES,
352
68
  };
@@ -54,16 +54,16 @@ class DataAccessObject {
54
54
  /** @const {string} */ this.namespace = namespace;
55
55
  /** @const {!DataSource} */ this.dataSource =
56
56
  typeof database === 'string' ? database : database.source;
57
- const databaseId = database.id || DEFAULT_DATABASE;
57
+ this.databaseId = database.id || DEFAULT_DATABASE;
58
58
  /** @type {!FirestoreAccessBase} */ this.accessObject = undefined;
59
59
  switch (this.dataSource) {
60
60
  case DataSource.FIRESTORE:
61
61
  this.accessObject = new NativeModeAccess(
62
- `${this.namespace}/database/${kind}`, projectId, databaseId);
62
+ `${this.namespace}/database/${kind}`, projectId, this.databaseId);
63
63
  break;
64
64
  case DataSource.DATASTORE:
65
65
  this.accessObject = new DatastoreModeAccess(this.namespace, kind,
66
- projectId, databaseId);
66
+ projectId, this.databaseId);
67
67
  break;
68
68
  default:
69
69
  throw new Error(`Unknown DataSource item: ${this.dataSource}.`);