feat: add watch history and playlist support

lib/Actions.js

@@ -8,15 +8,16 @@ const Constants = require('./Constants');
 /**
  * Performs direct interactions on YouTube.
  *
- * @param {object} session A valid Innertube session.
+ * @param {Innertube} session A valid Innertube session.
  * @param {string} engagement_type Type of engagement.
  * @param {object} args Engagement arguments.
- * @returns {object} { success: boolean, status_code: number } | { success: boolean, status_code: number, message: string }
+ * @returns {Promise.<object>} { success: boolean, status_code: number } | { success: boolean, status_code: number, message: string }
  */
 async function engage(session, engagement_type, args = {}) {
   if (!session.logged_in) throw new Error('You are not signed-in');
 
   let data;
+
   switch (engagement_type) {
     case 'like/like':
     case 'like/dislike':
@@ -32,7 +33,8 @@ async function engage(session, engagement_type, args = {}) {
     case 'subscription/unsubscribe':
       data = {
         context: session.context,
-        channelIds: [args.channel_id]
+        channelIds: [args.channel_id],
+        params: engagement_type == 'subscription/subscribe' ? 'EgIIAhgA' : 'CgIIAhgA'
       };
       break;
     case 'comment/create_comment':
@@ -59,15 +61,36 @@ async function engage(session, engagement_type, args = {}) {
 /**
  * Accesses YouTube's various sections.
  *
- * @param {object} session A valid Innertube session.
- * @param {string} action_type Type of action.
- * @returns {object} { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
+ * @param {Innertube} session - A valid Innertube session.
+ * @param {string} action_type - Type of action.
+ * @param {object} args - Action argumenets.
+ * @returns {Promise.<object>} { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
  */
 async function browse(session, action_type, args = {}) {
-  if (!session.logged_in && action_type != 'lyrics') throw new Error('You are not signed-in');
+  if (!session.logged_in && (action_type != 'lyrics' || action_type != 'music_playlist'))
+    throw new Error('You are not signed-in');
 
   let data;
-  switch (action_type) { // TODO: Handle more actions
+
+  switch (action_type) {
+    case 'account_notifications':
+      data = {
+        context: session.context,
+        browseId: 'SPaccount_notifications'
+      };
+      break;
+    case 'account_privacy':
+      data = {
+        context: session.context,
+        browseId: 'SPaccount_privacy'
+      };
+      break;
+    case 'history':
+      data = {
+        context: session.context,
+        browseId: 'FEhistory'
+      }
+      break;
     case 'home_feed':
       data = {
         context: session.context,
@@ -81,14 +104,21 @@ async function browse(session, action_type, args = {}) {
       };
       break;
     case 'lyrics':
-      const yt_music_context = JSON.parse(JSON.stringify(session.context)); // deep copy the context obj so we don't accidentally change it
+    case 'music_playlist':
+      const context = JSON.parse(JSON.stringify(session.context)); // deep copy the context obj so we don't accidentally change it
 
-      yt_music_context.client.originalUrl = Constants.URLS.YT_MUSIC_URL;
-      yt_music_context.client.clientVersion = '1.20211213.00.00';
-      yt_music_context.client.clientName = 'WEB_REMIX';
+      context.client.originalUrl = Constants.URLS.YT_MUSIC_URL;
+      context.client.clientVersion = Constants.YTMUSIC_VERSION;
+      context.client.clientName = 'WEB_REMIX';
 
       data = {
-        context: yt_music_context,
+        context,
+        browseId: args.browse_id
+      }
+      break;
+    case 'playlist':
+      data = {
+        context: session.context,
         browseId: args.browse_id
       }
       break;
@@ -108,18 +138,103 @@ async function browse(session, action_type, args = {}) {
   };
 }
 
+
+/**
+ * Account settings endpoints.
+ *
+ * @param {Innertube} session - A valid Innertube session.
+ * @param {string} action_type - Type of action.
+ * @param {object} args - Action argumenets.
+ * @returns {Promise.<object>} { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
+ */
+async function account(session, action_type, args = {}) {
+  if (!session.logged_in) throw new Error('You are not signed-in');
+
+  let data;
+
+  switch (action_type) {
+    case 'account/account_menu':
+      data = { context: session.context };
+      break;
+    case 'account/set_setting':
+      data = {
+        context: session.context,
+        newValue: {
+          boolValue: args.new_value
+        },
+        settingItemId: args.setting_item_id
+      }
+      break;
+    default:
+      break;
+  }
+
+  const response = await Axios.post(`${Constants.URLS.YT_BASE_URL}/youtubei/v1/${action_type}${session.logged_in && session.cookie.length < 1 ? '' : `?key=${session.key}`}`,
+    JSON.stringify(data), Constants.INNERTUBE_REQOPTS({ session })).catch((error) => error);
+
+  if (response instanceof Error) return { success: false, status_code: response.response.status, message: response.message };
+
+  return {
+    success: true,
+    status_code: response.status,
+    data: response.data
+  };
+}
+
+/**
+ * Accesses YouTube Music endpoints under /youtubei/v1/music/.
+ * 
+ * @param {Innertube} session - A valid Innertube session.
+ * @param {string} action_type - Type of action.
+ * @param {object} args - Action arguments.
+ * @todo Implement more actions.
+ * @returns 
+ */
+async function music(session, action_type, args) {
+  const context = JSON.parse(JSON.stringify(session.context)); // deep copy the context obj so we don't accidentally change it
+
+  context.client.originalUrl = Constants.URLS.YT_MUSIC_URL;
+  context.client.clientVersion = Constants.YTMUSIC_VERSION;
+  context.client.clientName = 'WEB_REMIX';
+
+  let data;
+
+  switch (action_type) {
+    case 'get_search_suggestions':
+      data = {
+        context,
+        input: args.input || ''
+      };
+      break;
+    default:
+      break;
+  }
+
+  const response = await Axios.post(`${Constants.URLS.YT_MUSIC_URL}/youtubei/v1/music/${action_type}${session.logged_in && session.cookie.length < 1 ? '' : `?key=${session.key}`}`,
+    JSON.stringify(data), Constants.INNERTUBE_REQOPTS({ session, ytmusic: true })).catch((error) => error);
+
+  if (response instanceof Error) return { success: false, status_code: response.response.status, message: response.message };
+
+  return {
+    success: true,
+    status_code: response.status,
+    data: response.data
+  };
+}
+
 /**
  * Performs searches on YouTube.
  *
- * @param {object} session A valid Innertube session.
- * @param {string} client YouTube client: YOUTUBE | YTMUSIC
- * @param {object} args Search arguments.
- * @returns {object} { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
+ * @param {Innertube} session - A valid Innertube session.
+ * @param {string} client - YouTube client: YOUTUBE | YTMUSIC
+ * @param {object} args - Search arguments.
+ * @returns {Promise.<object>} - { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
  */
 async function search(session, client, args = {}) {
   if (!args.query) throw new Error('No query was provided');
 
   let data;
+
   switch (client) {
     case 'YOUTUBE':
       data = {
@@ -129,14 +244,14 @@ async function search(session, client, args = {}) {
       };
       break;
     case 'YTMUSIC':
-      const yt_music_context = JSON.parse(JSON.stringify(session.context)); // deep copy the context obj so we don't accidentally change it
+      const context = JSON.parse(JSON.stringify(session.context)); // deep copy the context obj so we don't accidentally change it
 
-      yt_music_context.client.originalUrl = Constants.URLS.YT_MUSIC_URL;
-      yt_music_context.client.clientVersion = '1.20211213.00.00';
-      yt_music_context.client.clientName = 'WEB_REMIX';
+      context.client.originalUrl = Constants.URLS.YT_MUSIC_URL;
+      context.client.clientVersion = Constants.YTMUSIC_VERSION;
+      context.client.clientName = 'WEB_REMIX';
 
       data = {
-        context: yt_music_context,
+        context: context,
         query: args.query
       };
       break;
@@ -159,10 +274,10 @@ async function search(session, client, args = {}) {
 /**
  * Interacts with YouTube's notification system.
  *
- * @param {object} session A valid Innertube session.
- * @param {string} action_type Type of action.
- * @param {object} args Action arguments.
- * @returns {object} { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
+ * @param {Innertube} session - A valid Innertube session.
+ * @param {string} action_type - Type of action.
+ * @param {object} args - Action arguments.
+ * @returns {Promise.<object>} - { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
  */
 async function notifications(session, action_type, args = {}) {
   if (!session.logged_in) throw new Error('You are not signed-in');
@@ -207,13 +322,14 @@ async function notifications(session, action_type, args = {}) {
 /**
  * Interacts with YouTube's livechat system.
  *
- * @param {object} session A valid Innertube session.
- * @param {string} action_type Type of action.
- * @param {object} args Action arguments.
- * @returns {object} { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
+ * @param {Innertube} session - A valid Innertube session.
+ * @param {string} action_type - Type of action.
+ * @param {object} args - Action arguments.
+ * @returns {Promise.<object>} - { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
  */
 async function livechat(session, action_type, args = {}) {
   let data;
+
   switch (action_type) {
     case 'live_chat/get_live_chat':
       data = {
@@ -263,9 +379,9 @@ async function livechat(session, action_type, args = {}) {
 /**
  * Gets detailed data for a video.
  *
- * @param {object} session A valid Innertube session.
- * @param {object} args Request arguments.
- * @returns {object} Video data.
+ * @param {Innertube} session - A valid Innertube session.
+ * @param {object} args - Request arguments.
+ * @returns {Promise.<object>} - Video data.
  */
 async function getVideoInfo(session, args = {}) {
   let response;
@@ -283,9 +399,9 @@ async function getVideoInfo(session, args = {}) {
 /**
  * Requests continuation for previously performed actions.
  *
- * @param {object} session A valid Innertube session.
- * @param {object} args Continuation arguments.
- * @returns {object} { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
+ * @param {Innertube} session - A valid Innertube session.
+ * @param {object} args - Continuation arguments.
+ * @returns {Promise.<object>} - { success: boolean, status_code: number, data: object } | { success: boolean, status_code: number, message: string } 
  */
 async function getContinuation(session, args = {}) {
   let data = { context: session.context };
@@ -294,13 +410,13 @@ async function getContinuation(session, args = {}) {
   if (args.video_id) {
     data.videoId = args.video_id;
     if (args.ytmusic) {
-      const yt_music_context = JSON.parse(JSON.stringify(session.context)); // deep copy the context obj so we don't accidentally change it
+      const context = JSON.parse(JSON.stringify(session.context)); // deep copy the context obj so we don't accidentally change it
 
-      yt_music_context.client.originalUrl = Constants.URLS.YT_MUSIC_URL;
-      yt_music_context.client.clientVersion = '1.20211213.00.00';
-      yt_music_context.client.clientName = 'WEB_REMIX';
+      context.client.originalUrl = Constants.URLS.YT_MUSIC_URL;
+      context.client.clientVersion = Constants.YTMUSIC_VERSION;
+      context.client.clientName = 'WEB_REMIX';
 
-      data.context = yt_music_context;
+      data.context = context;
       data.isAudioOnly = true;
       data.tunerSettingValue = 'AUTOMIX_SETTING_NORMAL';
     } else {
@@ -328,4 +444,24 @@ async function getContinuation(session, args = {}) {
   };
 }
 
-module.exports = { engage, browse, search, notifications, livechat, getVideoInfo, getContinuation };
+/**
+ * Gets search suggestions.
+ * 
+ * @param {Innertube} session 
+ * @param {string} query 
+ * @returns 
+ */
+async function getYTSearchSuggestions(session, query) {
+  const response = await Axios.get(`${Constants.URLS.YT_SUGGESTIONS}search?client=firefox&ds=yt&q=${query}`,
+   Constants.DEFAULT_HEADERS(session)).catch((error) => error);
+
+  if (response instanceof Error) return { success: false, status_code: response.response.status, message: response.message };
+
+  return {
+    success: true,
+    status_code: response.status,
+    data: response.data
+  };
+}
+
+module.exports = { engage, browse, account, music, search, notifications, livechat, getVideoInfo, getContinuation, getYTSearchSuggestions };