forked from LuanRT/YouTube.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Innertube.js
396 lines (332 loc) · 11.4 KB
/
Innertube.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
'use strict';
const OAuth = require('./core/OAuth');
const Actions = require('./core/Actions');
const SessionBuilder = require('./core/SessionBuilder');
const AccountManager = require('./core/AccountManager');
const PlaylistManager = require('./core/PlaylistManager');
const InteractionManager = require('./core/InteractionManager');
const Search = require('./parser/youtube/Search');
const VideoInfo = require('./parser/youtube/VideoInfo');
const Channel = require('./parser/youtube/Channel');
const Playlist = require('./parser/youtube/Playlist');
const Library = require('./parser/youtube/Library');
const History = require('./parser/youtube/History');
const Comments = require('./parser/youtube/Comments');
const YTMusic = require('./core/Music');
const FilterableFeed = require('./core/FilterableFeed');
const TabbedFeed = require('./core/TabbedFeed');
const EventEmitter = require('events');
const { PassThrough } = require('stream');
const Request = require('./utils/Request');
const {
InnertubeError,
throwIfMissing,
generateRandomString
} = require('./utils/Utils');
const OldParser = require('./parser');
const Proto = require('./proto');
/** @namespace */
class Innertube {
#player;
#request;
/**
* @example
* ```js
* const Innertube = require('youtubei.js');
* const youtube = await new Innertube();
* ```
* @param {object} [config]
* @param {string} [config.gl]
* @param {string} [config.cookie]
* @param {boolean} [config.debug]
* @param {object} [config.proxy]
* @param {object} [config.http_ent]
* @param {object} [config.https_agent]
*/
constructor(config) {
this.config = config || {};
return this.#init();
}
async #init() {
const request = new Request(this.config);
const session = await new SessionBuilder(this.config, request.instance).build();
/** @type {string} */
this.key = session.key;
/** @type {string} */
this.version = session.api_version;
/** @type {object} */
this.context = session.context;
/** @type {boolean} */
this.logged_in = !!this.config.cookie;
/** @type {number} */
this.sts = session.player.sts;
/** @type {string} */
this.player_url = session.player.url;
/** @type {import('./core/Player')} */
this.#player = session.player;
request.setSession(this);
this.#request = request.instance;
/**
* @fires Innertube#auth - fired when signing in to an account.
* @fires Innertube#update-credentials - fired when the access token is no longer valid.
* @type {EventEmitter}
*/
this.ev = new EventEmitter();
this.oauth = new OAuth(this.ev, request.instance);
this.actions = new Actions(this);
this.account = new AccountManager(this.actions);
this.playlist = new PlaylistManager(this.actions);
this.interact = new InteractionManager(this.actions);
this.music = new YTMusic(this);
return this;
}
/**
* Signs in to a google account.
*
* @param {object} credentials
* @param {string} credentials.access_token - Token used to sign in.
* @param {string} credentials.refresh_token - Token used to get a new access token.
* @param {Date} credentials.expires - Access token's expiration date, which is usually 24hrs-ish.
* @returns {Promise.<void>}
*/
signIn(credentials = {}) {
return new Promise(async (resolve) => {
this.oauth.init(credentials);
if (this.oauth.validateCredentials()) {
await this.oauth.checkAccessTokenValidity();
this.logged_in = true;
resolve();
}
this.ev.on('auth', (data) => {
this.logged_in = true;
if (data.status === 'SUCCESS') resolve();
});
});
}
/**
* Signs out of an account.
*
* @returns {Promise.<{ success: boolean, status_code: number }>}
*/
async signOut() {
if (!this.logged_in) throw new InnertubeError('You are not signed in');
const response = await this.oauth.revokeAccessToken();
this.logged_in = false;
return response;
}
/**
* Retrieves video info.
*
* @param {string} video_id
* @returns {Promise.<VideoInfo>}
*/
async getInfo(video_id) {
throwIfMissing({ video_id });
const cpn = generateRandomString(16);
const initial_info = this.actions.getVideoInfo(video_id, cpn);
const continuation = this.actions.next({ video_id });
const response = await Promise.all([ initial_info, continuation ]);
return new VideoInfo(response, this.actions, this.#player, cpn);
}
/**
* Retrieves basic video info.
*
* @param {string} video_id
* @returns {Promise.<VideoInfo>}
*/
async getBasicInfo(video_id) {
throwIfMissing({ video_id });
const cpn = generateRandomString(16);
const response = await this.actions.getVideoInfo(video_id, cpn);
return new VideoInfo([ response, {} ], this.actions, this.#player, cpn);
}
/**
* Searches a given query.
*
* @param {string} query - search query.
* @param {object} [filters] - search filters.
* @param {string} [filters.upload_date] - filter videos by upload date, can be: any | last_hour | today | this_week | this_month | this_year
* @param {string} [filters.type] - filter results by type, can be: any | video | channel | playlist | movie
* @param {string} [filters.duration] - filter videos by duration, can be: any | short | medium | long
* @param {string} [filters.sort_by] - filter video results by order, can be: relevance | rating | upload_date | view_count
* @returns {Promise.<Search>}
*/
async search(query, filters = {}) {
throwIfMissing({ query });
const response = await this.actions.search({ query, filters });
return new Search(this.actions, response.data);
}
/**
* Retrieves search suggestions for a given query.
*
* @param {string} query - the search query.
* @param {object} [options] - search options.
* @param {string} [options.client='YOUTUBE'] - client used to retrieve search suggestions, can be: `YOUTUBE` or `YTMUSIC`.
* @returns {Promise.<{ query: string, results: string[] }>}
*/
async getSearchSuggestions(query, options = { client: 'YOUTUBE' }) {
throwIfMissing({ query });
const response = await this.actions.getSearchSuggestions(options.client, query);
if (options.client === 'YTMUSIC' && !response.data.contents) return [];
const suggestions = new OldParser(this, response.data, {
client: options.client,
data_type: 'SEARCH_SUGGESTIONS'
}).parse();
return suggestions;
}
/**
* Retrieves comments for a video.
*
* @param {string} video_id - the video id.
* @param {string} [sort_by] - can be: `TOP_COMMENTS` or `NEWEST_FIRST`.
* @returns {Promise.<Comments>}
*/
async getComments(video_id, sort_by) {
throwIfMissing({ video_id });
const payload = Proto.encodeCommentsSectionParams(video_id, {
sort_by: sort_by || 'TOP_COMMENTS'
});
const response = await this.actions.next({ ctoken: payload });
return new Comments(this.actions, response.data);
}
/**
* Retrieves YouTube's home feed (aka recommendations).
*
* @returns {Promise<FilterableFeed>}
*/
async getHomeFeed() {
const response = await this.actions.browse('FEwhat_to_watch');
return new FilterableFeed(this.actions, response.data);
}
/**
* Returns the account's library.
*
* @returns {Promise.<Library>}
*/
async getLibrary() {
const response = await this.actions.browse('FElibrary');
return new Library(response.data, this.actions);
}
/**
* Retrieves watch history.
* Which can also be achieved through {@link getLibrary()}.
*
* @returns {Promise.<History>}
*/
async getHistory() {
const response = await this.actions.browse('FEhistory');
return new History(this.actions, response.data);
}
/**
* Retrieves trending content.
*
* @returns {Promise<TabbedFeed>}
*/
async getTrending() {
const response = await this.actions.browse('FEtrending');
return new TabbedFeed(this.actions, response.data);
}
/**
* Retrieves subscriptions feed.
*
* @returns {Promise.<{ items: Array.<{ date: string, videos: object[] }>}>}
*/
async getSubscriptionsFeed() {
const response = await this.actions.browse('FEsubscriptions');
const subsfeed = new OldParser(this, response, {
client: 'YOUTUBE',
data_type: 'SUBSFEED'
}).parse();
return subsfeed;
}
/**
* Retrieves contents for a given channel. (WIP)
*
* @param {string} id - channel id
* @returns {Promise<Channel>}
*/
async getChannel(id) {
throwIfMissing({ id });
const response = await this.actions.browse(id);
return new Channel(this.actions, response.data);
}
/**
* Retrieves notifications.
*
* @returns {Promise.<{ items: Array.<{ title: string, sent_time: string, channel_name: string, channel_thumbnail: object, video_thumbnail: object, video_url: string, read: boolean, notification_id: string }>}>}
*/
async getNotifications() {
const response = await this.actions.notifications('get_notification_menu');
const notifications = new OldParser(this, response.data, {
client: 'YOUTUBE',
data_type: 'NOTIFICATIONS'
}).parse();
return notifications;
}
/**
* Retrieves unseen notifications count.
*
* @returns {Promise.<number>}
*/
async getUnseenNotificationsCount() {
const response = await this.actions.notifications('get_unseen_count');
return response.data.unseenCount;
}
/**
* Retrieves the contents of a given playlist.
*
* @param {string} playlist_id - the id of the playlist.
* @returns {Promise.<Playlist>}
*/
async getPlaylist(playlist_id) {
throwIfMissing({ playlist_id });
const response = await this.actions.browse(`VL${playlist_id.replace(/VL/g, '')}`);
return new Playlist(this.actions, response.data);
}
/**
* An alternative to {@link download}.
* Returns deciphered streaming data.
*
* @param {string} video_id - video id
* @param {object} options - download options.
* @param {string} options.quality - video quality; 360p, 720p, 1080p, etc...
* @param {string} options.type - download type, can be: video, audio or videoandaudio
* @param {string} options.format - file format
* @returns {Promise.<object>}
*/
async getStreamingData(video_id, options = {}) {
const info = await this.getBasicInfo(video_id);
return info.chooseFormat(options);
}
/**
* Downloads a given video. If you only need the direct download link take a look at {@link getStreamingData}.
*
* @param {string} video_id - video id
* @param {object} options - download options.
* @param {string} [options.quality] - video quality; 360p, 720p, 1080p, etc...
* @param {string} [options.type] - download type, can be: video, audio or videoandaudio
* @param {string} [options.format] - file format
* @param {object} [options.range] - download range, indicates which bytes should be downloaded.
* @param {number} options.range.start - the beginning of the range.
* @param {number} options.range.end - the end of the range.
* @returns {PassThrough}
*/
download(video_id, options = {}) {
throwIfMissing({ video_id });
const stream = new PassThrough();
(async () => {
const info = await this.getBasicInfo(video_id);
stream.emit('info', info);
info.download(options, stream);
})();
return stream;
}
getPlayer() {
return this.#player;
}
/** @readonly */
get request() {
return this.#request;
}
}
module.exports = Innertube;