feat(ytmusic): Add support for YouTube Music mood filters (#404)

* add filters property to ytmusic HomeFeed

* remove implied type

* add applyFilter to HomeFeed

* add test

* remove section_list var

Author: Buroni

src/parser/ytmusic/HomeFeed.ts

@@ -9,13 +9,16 @@ import type { ApiResponse } from '../../core/Actions.js';
 import type { ObservedArray } from '../helpers.js';
 import type { IBrowseResponse } from '../types/ParsedResponse.js';
 import { InnertubeError } from '../../utils/Utils.js';
+import ChipCloud from '../classes/ChipCloud.js';
+import ChipCloudChip from '../classes/ChipCloudChip.js';
 
 class HomeFeed {
   #page: IBrowseResponse;
   #actions: Actions;
   #continuation?: string;
 
   sections?: ObservedArray<MusicCarouselShelf | MusicTastebuilderShelf>;
+  header?: ChipCloud;
 
   constructor(response: ApiResponse, actions: Actions) {
     this.#actions = actions;
@@ -36,6 +39,7 @@ class HomeFeed {
       return;
     }
 
+    this.header = tab.content?.as(SectionList).header?.as(ChipCloud);
     this.#continuation = tab.content?.as(SectionList).continuation;
     this.sections = tab.content?.as(SectionList).contents.as(MusicCarouselShelf, MusicTastebuilderShelf);
   }
@@ -55,6 +59,33 @@ class HomeFeed {
     return new HomeFeed(response, this.#actions);
   }
 
+  async applyFilter(target_filter: string | ChipCloudChip): Promise<HomeFeed> {
+    let cloud_chip: ChipCloudChip | undefined;
+
+    if (typeof target_filter === 'string') {
+      cloud_chip = this.header?.chips?.as(ChipCloudChip).get({ text: target_filter });
+      if (!cloud_chip)
+        throw new InnertubeError('Could not find filter with given name.', { available_filters: this.filters });
+    } else if (target_filter?.is(ChipCloudChip)) {
+      cloud_chip = target_filter;
+    }
+
+    if (!cloud_chip)
+      throw new InnertubeError('Invalid filter', { available_filters: this.filters });
+
+    if (cloud_chip?.is_selected) return this;
+
+    if (!cloud_chip.endpoint)
+      throw new InnertubeError('Selected filter does not have an endpoint.');
+
+    const response = await cloud_chip.endpoint.call(this.#actions, { client: 'YTMUSIC' });
+    return new HomeFeed(response, this.#actions);
+  }
+
+  get filters(): string[] {
+    return this.header?.chips?.as(ChipCloudChip).map((chip) => chip.text) || [];
+  }
+
   get has_continuation(): boolean {
     return !!this.#continuation;
   }

test/main.test.ts

@@ -296,6 +296,13 @@ describe('YouTube.js Tests', () => {
         expect(incremental_continuation.sections).toBeDefined();
         expect(incremental_continuation.sections?.length).toBeGreaterThan(0);
       });
+      
+      test('HomeFeed#applyFilter', async () => {
+        home = await home.applyFilter(home.filters[1]);
+        expect(home).toBeDefined();
+        expect(home.sections).toBeDefined();
+        expect(home.sections?.length).toBeGreaterThan(0);
+      });
     });
 
     test('Innertube#music.getExplore', async () => {