chore(main): release 5.7.0 (#451)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [5.7.0](https://github.com/LuanRT/YouTube.js/compare/v5.6.0...v5.7.0) (2023-07-24)
+
+
+### Features
+
+* **parser:** Add `PageHeader` ([#450](https://github.com/LuanRT/YouTube.js/issues/450)) ([18cbc8c](https://github.com/LuanRT/YouTube.js/commit/18cbc8c038ddddffa1ba1519e56a8054b2996e42))
+* **parser:** Add `SearchHeader` ([6997982](https://github.com/LuanRT/YouTube.js/commit/6997982cf2db87edf4929e9a77e2690e7b630d3d)), closes [#452](https://github.com/LuanRT/YouTube.js/issues/452)
+
 ## [5.6.0](https://github.com/LuanRT/YouTube.js/compare/v5.5.0...v5.6.0) (2023-07-18)
 
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "youtubei.js",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "youtubei.js",
-      "version": "5.6.0",
+      "version": "5.7.0",
       "funding": [
         "https://github.com/sponsors/LuanRT"
       ],

package.json

@@ -1,6 +1,6 @@
 {
   "name": "youtubei.js",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "description": "A wrapper around YouTube's private API. Supports YouTube, YouTube Music, YouTube Kids and YouTube Studio (WIP).",
   "type": "module",
   "types": "./dist/src/platform/lib.d.ts",

src/parser/classes/Button.ts

@@ -15,26 +15,20 @@ export default class Button extends YTNode {
 
   constructor(data: RawNode) {
     super();
-
-    if (Reflect.has(data, 'text')) {
+    if (Reflect.has(data, 'text'))
       this.text = new Text(data.text).toString();
-    }
 
-    if (Reflect.has(data, 'accessibility') && Reflect.has(data.accessibility, 'label')) {
+    if (Reflect.has(data, 'accessibility') && Reflect.has(data.accessibility, 'label'))
       this.label = data.accessibility.label;
-    }
 
-    if (Reflect.has(data, 'tooltip')) {
+    if (Reflect.has(data, 'tooltip'))
       this.tooltip = data.tooltip;
-    }
 
-    if (Reflect.has(data, 'icon') && Reflect.has(data.icon, 'iconType')) {
+    if (Reflect.has(data, 'icon') && Reflect.has(data.icon, 'iconType'))
       this.icon_type = data.icon.iconType;
-    }
 
-    if (Reflect.has(data, 'isDisabled')) {
+    if (Reflect.has(data, 'isDisabled'))
       this.is_disabled = data.isDisabled;
-    }
 
     this.endpoint = new NavigationEndpoint(data.navigationEndpoint || data.serviceEndpoint || data.command);
   }

src/parser/classes/ContentPreviewImageView.ts

@@ -0,0 +1,16 @@
+import { YTNode } from '../helpers.js';
+import type { RawNode } from '../index.js';
+import Thumbnail from './misc/Thumbnail.js';
+
+export default class ContentPreviewImageView extends YTNode {
+  static type = 'ContentPreviewImageView';
+
+  image: Thumbnail[];
+  style: string;
+
+  constructor(data: RawNode) {
+    super();
+    this.image = data.image.sources.map((x: any) => new Thumbnail(x)).sort((a: Thumbnail, b: Thumbnail) => b.width - a.width);
+    this.style = data.style;
+  }
+}

src/parser/classes/DynamicTextView.ts

@@ -0,0 +1,13 @@
+import { YTNode } from '../helpers.js';
+import type { RawNode } from '../index.js';
+
+export default class DynamicTextView extends YTNode {
+  static type = 'DynamicTextView';
+
+  text: string;
+
+  constructor(data: RawNode) {
+    super();
+    this.text = data.text.content;
+  }
+}

src/parser/classes/NavigationEndpoint.ts

@@ -4,12 +4,14 @@ import { YTNode } from '../helpers.js';
 import Parser, { type RawNode } from '../index.js';
 import type { IParsedResponse } from '../types/ParsedResponse.js';
 import CreatePlaylistDialog from './CreatePlaylistDialog.js';
+import OpenPopupAction from './actions/OpenPopupAction.js';
 
 export default class NavigationEndpoint extends YTNode {
   static type = 'NavigationEndpoint';
 
   payload;
   dialog?: CreatePlaylistDialog | YTNode | null;
+  open_popup?: OpenPopupAction | null;
 
   metadata: {
     url?: string;
@@ -24,6 +26,9 @@ export default class NavigationEndpoint extends YTNode {
     if (Reflect.has(data || {}, 'innertubeCommand'))
       data = data.innertubeCommand;
 
+    if (Reflect.has(data || {}, 'openPopupAction'))
+      this.open_popup = new OpenPopupAction(data.openPopupAction);
+
     const name = Object.keys(data || {})
       .find((item) =>
         item.endsWith('Endpoint') ||
@@ -36,6 +41,7 @@ export default class NavigationEndpoint extends YTNode {
       this.dialog = Parser.parseItem(this.payload.dialog || this.payload.content);
     }
 
+
     if (data?.serviceEndpoint) {
       data = data.serviceEndpoint;
     }
@@ -85,9 +91,9 @@ export default class NavigationEndpoint extends YTNode {
     }
   }
 
-  call<T extends IParsedResponse>(actions: Actions, args: { [ key: string ]: any; parse: true }): Promise<T>;
-  call(actions: Actions, args?: { [ key: string ]: any; parse?: false }): Promise<ApiResponse>;
-  call(actions: Actions, args?: { [ key: string ]: any; parse?: boolean }): Promise<IParsedResponse | ApiResponse> {
+  call<T extends IParsedResponse>(actions: Actions, args: { [key: string]: any; parse: true }): Promise<T>;
+  call(actions: Actions, args?: { [key: string]: any; parse?: false }): Promise<ApiResponse>;
+  call(actions: Actions, args?: { [key: string]: any; parse?: boolean }): Promise<IParsedResponse | ApiResponse> {
     if (!actions)
       throw new Error('An active caller must be provided');
     if (!this.metadata.api_url)

src/parser/classes/PageHeader.ts

@@ -0,0 +1,16 @@
+import { YTNode } from '../helpers.js';
+import Parser, { type RawNode } from '../index.js';
+import PageHeaderView from './PageHeaderView.js';
+
+export default class PageHeader extends YTNode {
+  static type = 'PageHeader';
+
+  page_title: string;
+  content: PageHeaderView | null;
+
+  constructor(data: RawNode) {
+    super();
+    this.page_title = data.pageTitle;
+    this.content = Parser.parseItem(data.content, PageHeaderView);
+  }
+}

src/parser/classes/PageHeaderView.ts

@@ -0,0 +1,17 @@
+import { YTNode } from '../helpers.js';
+import Parser, { type RawNode } from '../index.js';
+import ContentPreviewImageView from './ContentPreviewImageView.js';
+import DynamicTextView from './DynamicTextView.js';
+
+export default class PageHeaderView extends YTNode {
+  static type = 'PageHeaderView';
+
+  image: ContentPreviewImageView | null;
+  title: DynamicTextView | null;
+
+  constructor(data: RawNode) {
+    super();
+    this.image = Parser.parseItem(data.image, ContentPreviewImageView);
+    this.title = Parser.parseItem(data.title, DynamicTextView);
+  }
+}

src/parser/classes/SearchFilterOptionsDialog.ts

@@ -0,0 +1,18 @@
+import type { ObservedArray } from '../helpers.js';
+import { YTNode } from '../helpers.js';
+import { Parser, type RawNode } from '../index.js';
+import SearchFilterGroup from './SearchFilterGroup.js';
+import Text from './misc/Text.js';
+
+export default class SearchFilterOptionsDialog extends YTNode {
+  static type = 'SearchFilterOptionsDialog';
+
+  title: Text;
+  groups: ObservedArray<SearchFilterGroup>;
+
+  constructor(data: RawNode) {
+    super();
+    this.title = new Text(data.title);
+    this.groups = Parser.parseArray(data.groups, SearchFilterGroup);
+  }
+}

src/parser/classes/SearchHeader.ts

@@ -0,0 +1,18 @@
+import { YTNode } from '../helpers.js';
+import { Parser, type RawNode } from '../index.js';
+import Button from './Button.js';
+import ChipCloud from './ChipCloud.js';
+
+export default class SearchHeader extends YTNode {
+  static type = 'SearchHeader';
+
+  chip_bar: ChipCloud | null;
+  search_filter_button: Button | null;
+
+  constructor(data: RawNode) {
+    super();
+    this.chip_bar = Parser.parseItem(data.chipBar, ChipCloud);
+    this.search_filter_button = Parser.parseItem(data.searchFilterButton, Button);
+    console.log(this.search_filter_button?.endpoint.open_popup);
+  }
+}

src/parser/classes/SearchSubMenu.ts

@@ -8,14 +8,19 @@ import ToggleButton from './ToggleButton.js';
 export default class SearchSubMenu extends YTNode {
   static type = 'SearchSubMenu';
 
-  title: Text;
-  groups: ObservedArray<SearchFilterGroup>;
-  button: ToggleButton | null;
+  title?: Text;
+  groups?: ObservedArray<SearchFilterGroup>;
+  button?: ToggleButton | null;
 
   constructor(data: RawNode) {
     super();
-    this.title = new Text(data.title);
-    this.groups = Parser.parseArray(data.groups, SearchFilterGroup);
-    this.button = Parser.parseItem(data.button, ToggleButton);
+    if (Reflect.has(data, 'title'))
+      this.title = new Text(data.title);
+
+    if (!Reflect.has(data, 'groups'))
+      this.groups = Parser.parseArray(data.groups, SearchFilterGroup);
+
+    if (Reflect.has(data, 'button'))
+      this.button = Parser.parseItem(data.button, ToggleButton);
   }
 }

src/parser/nodes.ts

@@ -71,6 +71,7 @@ export { default as CompactPlaylist } from './classes/CompactPlaylist.js';
 export { default as CompactStation } from './classes/CompactStation.js';
 export { default as CompactVideo } from './classes/CompactVideo.js';
 export { default as ConfirmDialog } from './classes/ConfirmDialog.js';
+export { default as ContentPreviewImageView } from './classes/ContentPreviewImageView.js';
 export { default as ContinuationItem } from './classes/ContinuationItem.js';
 export { default as ConversationBar } from './classes/ConversationBar.js';
 export { default as CopyLink } from './classes/CopyLink.js';
@@ -81,6 +82,7 @@ export { default as DidYouMean } from './classes/DidYouMean.js';
 export { default as DownloadButton } from './classes/DownloadButton.js';
 export { default as Dropdown } from './classes/Dropdown.js';
 export { default as DropdownItem } from './classes/DropdownItem.js';
+export { default as DynamicTextView } from './classes/DynamicTextView.js';
 export { default as Element } from './classes/Element.js';
 export { default as EmergencyOnebox } from './classes/EmergencyOnebox.js';
 export { default as EmojiPickerCategory } from './classes/EmojiPickerCategory.js';
@@ -238,6 +240,8 @@ export { default as MusicTwoRowItem } from './classes/MusicTwoRowItem.js';
 export { default as MusicVisualHeader } from './classes/MusicVisualHeader.js';
 export { default as NavigationEndpoint } from './classes/NavigationEndpoint.js';
 export { default as Notification } from './classes/Notification.js';
+export { default as PageHeader } from './classes/PageHeader.js';
+export { default as PageHeaderView } from './classes/PageHeaderView.js';
 export { default as PageIntroduction } from './classes/PageIntroduction.js';
 export { default as PlayerAnnotationsExpanded } from './classes/PlayerAnnotationsExpanded.js';
 export { default as PlayerCaptionsTracklist } from './classes/PlayerCaptionsTracklist.js';
@@ -285,6 +289,8 @@ export { default as RichShelf } from './classes/RichShelf.js';
 export { default as SearchBox } from './classes/SearchBox.js';
 export { default as SearchFilter } from './classes/SearchFilter.js';
 export { default as SearchFilterGroup } from './classes/SearchFilterGroup.js';
+export { default as SearchFilterOptionsDialog } from './classes/SearchFilterOptionsDialog.js';
+export { default as SearchHeader } from './classes/SearchHeader.js';
 export { default as SearchRefinementCard } from './classes/SearchRefinementCard.js';
 export { default as SearchSubMenu } from './classes/SearchSubMenu.js';
 export { default as SearchSuggestion } from './classes/SearchSuggestion.js';

src/parser/youtube/Channel.ts

@@ -9,6 +9,7 @@ import SubscribeButton from '../classes/SubscribeButton.js';
 import ExpandableTab from '../classes/ExpandableTab.js';
 import SectionList from '../classes/SectionList.js';
 import Tab from '../classes/Tab.js';
+import PageHeader from '../classes/PageHeader.js';
 
 import Feed from '../../core/mixins/Feed.js';
 import FilterableFeed from '../../core/mixins/FilterableFeed.js';
@@ -25,7 +26,7 @@ import type { ApiResponse } from '../../core/Actions.js';
 import type { IBrowseResponse } from '../types/index.js';
 
 export default class Channel extends TabbedFeed<IBrowseResponse> {
-  header?: C4TabbedHeader | CarouselHeader | InteractiveTabbedHeader;
+  header?: C4TabbedHeader | CarouselHeader | InteractiveTabbedHeader | PageHeader;
   metadata;
   subscribe_button?: SubscribeButton;
   current_tab?: Tab | ExpandableTab;
@@ -33,7 +34,7 @@ export default class Channel extends TabbedFeed<IBrowseResponse> {
   constructor(actions: Actions, data: ApiResponse | IBrowseResponse, already_parsed = false) {
     super(actions, data, already_parsed);
 
-    this.header = this.page.header?.item()?.as(C4TabbedHeader, CarouselHeader, InteractiveTabbedHeader);
+    this.header = this.page.header?.item()?.as(C4TabbedHeader, CarouselHeader, InteractiveTabbedHeader, PageHeader);
 
     const metadata = this.page.metadata?.item().as(ChannelMetadata);
     const microformat = this.page.microformat?.as(MicroformatData);

src/parser/youtube/Search.ts

@@ -2,6 +2,7 @@ import Feed from '../../core/mixins/Feed.js';
 import { InnertubeError } from '../../utils/Utils.js';
 import HorizontalCardList from '../classes/HorizontalCardList.js';
 import ItemSection from '../classes/ItemSection.js';
+import SearchHeader from '../classes/SearchHeader.js';
 import SearchRefinementCard from '../classes/SearchRefinementCard.js';
 import SearchSubMenu from '../classes/SearchSubMenu.js';
 import SectionList from '../classes/SectionList.js';
@@ -11,8 +12,8 @@ import type Actions from '../../core/Actions.js';
 import type { ApiResponse } from '../../core/Actions.js';
 import type { ObservedArray, YTNode } from '../helpers.js';
 import type { ISearchResponse } from '../types/ParsedResponse.js';
-
 class Search extends Feed<ISearchResponse> {
+  header?: SearchHeader;
   results?: ObservedArray<YTNode> | null;
   refinements: string[];
   estimated_results: number;
@@ -30,6 +31,9 @@ class Search extends Feed<ISearchResponse> {
     if (!contents)
       throw new InnertubeError('No contents found in search response');
 
+    if (this.page.header)
+      this.header = this.page.header.item().as(SearchHeader);
+
     this.results = contents.find((content) => content.is(ItemSection) && content.contents && content.contents.length > 0)?.as(ItemSection).contents;
 
     this.refinements = this.page.refinements || [];