@behindthemusictree/app-kit-ui 33.3.0 → 34.1.0

package/dist/genre-tree/index.d.ts

@@ -1,9 +1,9 @@
 import * as react from 'react';
-import { ReactNode, ComponentProps } from 'react';
+import { ReactNode, ComponentType, ComponentProps } from 'react';
 import { z } from 'zod';
 import { GenreTreeProps, FocusChangeReason, GenreTreeNode, GenreTreeAction, GenreTreeViewMode, GenreTreeViewport, WheelZoomMode } from '@behindthemusictree/genre-tree-view';
 export { FocusChangeReason, GenreTreeAction, GenreTreeOutlineSkeleton, GenreTreeSkeleton, GenreTreeViewMode, GenreTreeViewSkeleton, GenreTreeViewSkeletonProps, GenreTreeViewport, GenreTreeWheelSkeleton } from '@behindthemusictree/genre-tree-view';
-import { TrackBase, CriteriaOverview, GenreUuid, CriteriaPlaylistMinimum, RenderArtistLink, RenderSongLink, CriteriaPlaylistSimple, ArtistSearchResult, SongSearchResult, UseGenreRemoteSearchOptions, GenreSearchResult, GenrePlaylistUuid, CriteriaMinimum } from '@behindthemusictree/app-kit/genre-tree';
+import { TrackBase, CriteriaOverview, GenreUuid, CriteriaPlaylistMinimum, GenreMusicSelection, RenderArtistLink, RenderSongLink, CriteriaPlaylistSimple, ArtistSearchResult, SongSearchResult, UseGenreRemoteSearchOptions, GenreSearchResult, GenrePlaylistUuid, CriteriaMinimum, GenreCatalogueCounts, GenrePlaylistSummary } from '@behindthemusictree/app-kit/genre-tree';
 import { Scope } from '@behindthemusictree/app-kit/transport';
 import { DetailPanel } from '@behindthemusictree/ui';
 
@@ -25,6 +25,7 @@ type GenreDetailSlots<O extends CriteriaOverview> = {
 type GenreDetailExtrasProps<O extends CriteriaOverview> = GenreDetailSlots<O> & GenrePlaylistTracksSlots & {
     genreUuid: GenreUuid;
     genrePlaylist: CriteriaPlaylistMinimum;
+    selection?: GenreMusicSelection;
     wikidataId?: string | null;
     scope: Scope;
     getBackendBaseUrl: () => string;
@@ -60,11 +61,9 @@ type HostOverlayPanel = Omit<OverlayPanel, "expanded" | "onExpandedChange"> & {
 /** The host-owned detail panel's contract with the tree: the area the panel covers, and the node-style resolver the tree publishes back. */
 type HostPanelProps = Partial<Pick<GenreTreeProps, "obscuredInset" | "onNodeStyleResolverChange">>;
 
-/** What a play button needs of a playlist; `criteria` is only read when playing one artist's songs in the genre. */
 type PlayableGenrePlaylistInput = CriteriaPlaylistMinimum & {
     criteria?: CriteriaPlaylistSimple["criteria"];
 };
-/** What a tree node's play button plays, and which node is the one currently playing. */
 type GenrePlaylistPlayback = {
     playingNodeId: string | null;
     play: (genrePlaylist: PlayableGenrePlaylistInput) => Promise<void>;
@@ -72,7 +71,6 @@ type GenrePlaylistPlayback = {
 type UseGenrePlaylistPlaybackOptions = {
     scope: Scope;
     genrePlaylists: CriteriaPlaylistSimple[];
-    /** When set, nodes play only this artist's songs in the genre's subtree instead of the whole genre playlist. */
     artist?: {
         uuid: string;
         name: string;
@@ -155,6 +153,33 @@ type UseGenreRemoteSearchGroupOptions = UseGenreRemoteSearchOptions & {
 /** Genres from the API's ranked `genres/search/`, rendered with the umbrella tag and the tree they live in. */
 declare function useGenreRemoteSearchGroup(getBaseUrl: () => string, text: string, onSelect: (genre: GenreSearchResult) => void, { key, label, filter, describe, ...options }?: UseGenreRemoteSearchGroupOptions): SearchGroup;
 
+/** @deprecated Use `SearchGroup`. */
+type GenreSearchExtraGroup = SearchGroup;
+type GenreSearchProps<T extends CriteriaPlaylistSimple = CriteriaPlaylistSimple> = {
+    genrePlaylists: T[];
+    onSelect: (genrePlaylist: T) => void;
+    /** Name of the currently selected genre; fills the input whenever it changes. */
+    selectedName?: string | null;
+    /** When set, renders a "Previous" button left of the text and makes room for it. */
+    onPrevious?: () => void;
+    /** Called by the clear button, after it empties the input. */
+    onClear?: () => void;
+    placeholder?: string;
+    /** Called with what the user types, and with "" on clear or pick; never when `selectedName` refills the input. */
+    onQueryChange?: (query: string) => void;
+    /** Further result groups (places, artists, songs) the host resolves from `onQueryChange`. */
+    extraGroups?: SearchGroup[];
+    /** Called when the input gains focus. */
+    onFocus?: () => void;
+};
+declare function GenreSearch<T extends CriteriaPlaylistSimple = CriteriaPlaylistSimple>({ genrePlaylists, onSelect, selectedName, onClear, onPrevious, placeholder, onQueryChange, extraGroups, onFocus, }: GenreSearchProps<T>): react.JSX.Element;
+
+interface GenreSearchGroupsProps {
+    query: string;
+    focused: boolean;
+    children: (groups: SearchGroup[]) => ReactNode;
+}
+
 type ParentChange = {
     genre: GenreUuid;
     from: GenreUuid | null;
@@ -227,6 +252,8 @@ type GenreTreeViewProps<O extends CriteriaOverview = CriteriaOverview> = {
     readOnly?: boolean;
     /** Further result groups (e.g. places) shown in the search box next to genres, artists and songs. */
     extraSearchGroups?: SearchGroup[];
+    /** Host search hooks run inside this subtree, so typing does not rerender the tree page. */
+    SearchGroups?: ComponentType<GenreSearchGroupsProps>;
     /** Fires with the typed search text (empty when cleared), so a host can drive its own `extraSearchGroups`. */
     onSearchQueryChange?: (text: string) => void;
     /** Fires when the search box gains focus, e.g. to load data for `extraSearchGroups` lazily. */
@@ -290,7 +317,7 @@ type GenreTreeViewProps<O extends CriteriaOverview = CriteriaOverview> = {
     collapsed?: boolean;
     onCollapsedChange?: (collapsed: boolean) => void;
 };
-declare function GenreTreeView<O extends CriteriaOverview = CriteriaOverview>({ scope, handleGenreCreationAction, handleGenreRenameAction, onParentChanged, getBackendBaseUrl, additionalActions, viewMode: controlledViewMode, selectedNodeId: controlledSelectedNodeId, onSelectedNodeIdChange, defaultViewport, viewportRestore, onViewportChange, readOnly, className, showDisplayOptions, showAddRoot, allowWheelRotation: controlledAllowWheelRotation, criteriaOverviewSchema, renderGenreDetailExtras, floatingControlsLeading, sizeMetric: controlledSizeMetric, onSizeMetricChange, renderArtistLink, artistUuid: controlledArtistUuid, onArtistUuidChange, artistExpanded: controlledArtistExpanded, onArtistExpandedChange, getShareUrl, extraSearchGroups, onSearchQueryChange, onSearchFocus, artistSearch, onArtistSelect, artistSearchBaseUrl, songUuid: controlledSongUuid, onSongUuidChange, songExpanded: controlledSongExpanded, onSongExpandedChange, songSearch, onSongSelect, renderSongLink, renderSummary, renderEssentialTracks, renderSongLeading, renderSongActions, renderTracksToolbar, renderDangerZone, expanded, onExpandedChange, collapsed, onCollapsedChange, overlayPanel, placement, ...focus }: GenreTreeViewProps<O>): react.JSX.Element;
+declare function GenreTreeView<O extends CriteriaOverview = CriteriaOverview>({ scope, handleGenreCreationAction, handleGenreRenameAction, onParentChanged, getBackendBaseUrl, additionalActions, viewMode: controlledViewMode, selectedNodeId: controlledSelectedNodeId, onSelectedNodeIdChange, defaultViewport, viewportRestore, onViewportChange, readOnly, className, showDisplayOptions, showAddRoot, allowWheelRotation: controlledAllowWheelRotation, criteriaOverviewSchema, renderGenreDetailExtras, floatingControlsLeading, sizeMetric: controlledSizeMetric, onSizeMetricChange, renderArtistLink, artistUuid: controlledArtistUuid, onArtistUuidChange, artistExpanded: controlledArtistExpanded, onArtistExpandedChange, getShareUrl, extraSearchGroups, SearchGroups, onSearchQueryChange, onSearchFocus, artistSearch, onArtistSelect, artistSearchBaseUrl, songUuid: controlledSongUuid, onSongUuidChange, songExpanded: controlledSongExpanded, onSongExpandedChange, songSearch, onSongSelect, renderSongLink, renderSummary, renderEssentialTracks, renderSongLeading, renderSongActions, renderTracksToolbar, renderDangerZone, expanded, onExpandedChange, collapsed, onCollapsedChange, overlayPanel, placement, ...focus }: GenreTreeViewProps<O>): react.JSX.Element;
 
 type GenreActionBandProps = {
     node: GenreTreeNode;
@@ -317,9 +344,9 @@ type GenreActionBandProps = {
 declare function GenreActionBand({ node, onPlayPause, isPlaying, onZoomIn, onAddChild, onRename, onChangeParent, side, onToggleSide, toggleSideDisabledReason, additionalActions, shareTarget, shareUrl, }: GenreActionBandProps): react.JSX.Element | null;
 
 /** What the action band reads of a genre's playlist: enough to play it and to know whether it can be. */
-type PlayableGenrePlaylist = CriteriaPlaylistMinimum & {
+type PlayableGenrePlaylist = (CriteriaPlaylistMinimum & {
     tracksCount: number;
-};
+}) | GenrePlaylistSummary;
 type GenreNodeActionBandProps = Omit<ComponentProps<typeof GenreActionBand>, "onPlayPause" | "isPlaying"> & {
     genrePlaylist: PlayableGenrePlaylist;
     playback: GenrePlaylistPlayback;
@@ -330,6 +357,7 @@ type GenreInfoPanelBodyProps<O extends CriteriaOverview> = {
     toolbar?: ReactNode;
     family: ReactNode;
     genreUuid: GenreUuid;
+    catalogue?: GenreCatalogueCounts;
     genrePlaylist: PlayableGenrePlaylist;
     wikidataId?: string | null;
     scope: Scope;
@@ -341,7 +369,7 @@ type GenreInfoPanelBodyProps<O extends CriteriaOverview> = {
 };
 /** The body of a genre's info panel: action band, then the genre's overview, family and tracks.
  * Shared by the tree's panel and the standalone GenreDetailPanel. */
-declare function GenreInfoPanelBody<O extends CriteriaOverview>({ toolbar, family, genreUuid, genrePlaylist, wikidataId, scope, getBackendBaseUrl, playback, band, extras, }: GenreInfoPanelBodyProps<O>): react.JSX.Element;
+declare function GenreInfoPanelBody<O extends CriteriaOverview>({ toolbar, family, genreUuid, genrePlaylist, catalogue, wikidataId, scope, getBackendBaseUrl, playback, band, extras, }: GenreInfoPanelBodyProps<O>): react.JSX.Element;
 
 type GenreDetailPanelProps<O extends CriteriaOverview> = {
     genreUuid: GenreUuid;
@@ -393,27 +421,6 @@ type GenrePlaylistTreePerRootProps<T extends TrackBase> = {
 } & HostPanelProps;
 declare function GenrePlaylistTreePerRoot<T extends TrackBase>({ scope, className, rootUuid, genrePlaylistTreePerRoot, handleGenreCreationAction, handleGenreRenameAction, additionalActions, onNodeClick, onNodeHover, selectedNodeId, onSelectedNodeChange, readOnly, wheelZoom, defaultViewport, viewportRestore, onViewportChange, playback, ...hostPanel }: GenrePlaylistTreePerRootProps<T>): react.JSX.Element;
 
-/** @deprecated Use `SearchGroup`. */
-type GenreSearchExtraGroup = SearchGroup;
-type GenreSearchProps<T extends CriteriaPlaylistSimple = CriteriaPlaylistSimple> = {
-    genrePlaylists: T[];
-    onSelect: (genrePlaylist: T) => void;
-    /** Name of the currently selected genre; fills the input whenever it changes. */
-    selectedName?: string | null;
-    /** When set, renders a "Previous" button left of the text and makes room for it. */
-    onPrevious?: () => void;
-    /** Called by the clear button, after it empties the input. */
-    onClear?: () => void;
-    placeholder?: string;
-    /** Called with what the user types, and with "" on clear or pick; never when `selectedName` refills the input. */
-    onQueryChange?: (query: string) => void;
-    /** Further result groups (places, artists, songs) the host resolves from `onQueryChange`. */
-    extraGroups?: SearchGroup[];
-    /** Called when the input gains focus. */
-    onFocus?: () => void;
-};
-declare function GenreSearch<T extends CriteriaPlaylistSimple = CriteriaPlaylistSimple>({ genrePlaylists, onSelect, selectedName, onClear, onPrevious, placeholder, onQueryChange, extraGroups, onFocus, }: GenreSearchProps<T>): react.JSX.Element;
-
 interface TrackListSidebarProps<T extends TrackBase> {
     className?: string;
     renderDuration?: (track: T) => ReactNode;
@@ -472,4 +479,4 @@ interface RatingProps {
 }
 declare function Rating({ rating, handleChange }: RatingProps): react.JSX.Element;
 
-export { type ArtistSearchProps, GenreDetailPanel, type GenreDetailPanelProps, type GenreDetailSlots, type GenreFocusProps, GenreInfoPanelBody, type GenreInfoPanelBodyProps, GenreNodeActionBand, type GenrePlaylistPlayback, type GenrePlaylistTracksSlots, GenrePlaylistTreePerRoot, type GenrePlaylistTreePerRootProps, GenreSearch, type GenreSearchExtraGroup, type GenreSearchProps, type GenreTreeShareTarget, GenreTreeView, type GenreTreeViewProps, type GetGenreTreeShareUrl, type ParentChange, type PlayableGenrePlaylist, PlayerPanel, type PlayerPanelProps, Rating, type RatingProps, SEARCH_FAILED_STATUS, SearchBox, type SearchBoxProps, type SearchGroup, type SearchGroupItem, TrackItem, type TrackItemProps, TrackListSidebar, type TrackListSidebarProps, TrackPositionPlayPause, type TrackPositionPlayPauseProps, type UseGenrePlaylistPlaybackOptions, type UseGenreRemoteSearchGroupOptions, searchStatus, useArtistSearchGroup, useGenrePlaylistPlayback, useGenreRemoteSearchGroup, useSongSearchGroup };
+export { type ArtistSearchProps, GenreDetailPanel, type GenreDetailPanelProps, type GenreDetailSlots, type GenreFocusProps, GenreInfoPanelBody, type GenreInfoPanelBodyProps, GenreNodeActionBand, type GenrePlaylistPlayback, type GenrePlaylistTracksSlots, GenrePlaylistTreePerRoot, type GenrePlaylistTreePerRootProps, GenreSearch, type GenreSearchExtraGroup, type GenreSearchGroupsProps, type GenreSearchProps, type GenreTreeShareTarget, GenreTreeView, type GenreTreeViewProps, type GetGenreTreeShareUrl, type ParentChange, type PlayableGenrePlaylist, PlayerPanel, type PlayerPanelProps, Rating, type RatingProps, SEARCH_FAILED_STATUS, SearchBox, type SearchBoxProps, type SearchGroup, type SearchGroupItem, TrackItem, type TrackItemProps, TrackListSidebar, type TrackListSidebarProps, TrackPositionPlayPause, type TrackPositionPlayPauseProps, type UseGenrePlaylistPlaybackOptions, type UseGenreRemoteSearchGroupOptions, searchStatus, useArtistSearchGroup, useGenrePlaylistPlayback, useGenreRemoteSearchGroup, useSongSearchGroup };

package/dist/genre-tree/index.js

@@ -21,7 +21,7 @@ import {
   useGenrePlaylistPlayback,
   useGenreRemoteSearchGroup,
   useSongSearchGroup
-} from "../chunk-QMELESFB.js";
+} from "../chunk-JP7PID7L.js";
 import "../chunk-DKQQLLMY.js";
 export {
   GenreDetailPanel,