feat: add artist views

This commit is contained in:
Lei Nelissen
2023-04-28 23:35:06 +02:00
parent 130b18bc2e
commit c9036b56ed
9 changed files with 401 additions and 4 deletions

View File

@@ -68,5 +68,6 @@
"color-scheme-description": "By default, Fintunes will follow your operating system's color scheme. You can however choose to override this to make sure Fintunes is always in dark mode or light mode.",
"color-scheme-system": "System",
"color-scheme-light": "Light Mode",
"color-scheme-dark": "Dark Mode"
"color-scheme-dark": "Dark Mode",
"artists": "Artists"
}

View File

@@ -66,4 +66,5 @@ export type LocaleKeys = 'play-next'
| 'color-scheme-description'
| 'color-scheme-system'
| 'color-scheme-light'
| 'color-scheme-dark'
| 'color-scheme-dark'
| 'artists'

View File

@@ -1,4 +1,5 @@
import React from 'react';
import { StyleSheet } from 'react-native';
import { createStackNavigator } from '@react-navigation/stack';
import { GestureHandlerRootView } from 'react-native-gesture-handler';
import { THEME_COLOR } from 'CONSTANTS';
@@ -12,7 +13,8 @@ import Albums from './stacks/Albums';
import Album from './stacks/Album';
import Playlists from './stacks/Playlists';
import Playlist from './stacks/Playlist';
import { StyleSheet } from 'react-native';
import Artists from './stacks/Artists';
import Artist from './stacks/Artist';
const Stack = createStackNavigator<StackParams>();
@@ -31,6 +33,8 @@ function MusicStack() {
<Stack.Screen name="RecentAlbums" component={RecentAlbums} options={{ headerTitle: t('recent-albums'), headerShown: false }} />
<Stack.Screen name="Albums" component={Albums} options={{ headerTitle: t('albums') }} />
<Stack.Screen name="Album" component={Album} options={{ headerTitle: t('album') }} />
<Stack.Screen name="Artists" component={Artists} options={{ headerTitle: t('artists') }} />
<Stack.Screen name="Artist" component={Artist} options={({ route }) => ({ headerTitle: route.params.Name })} />
<Stack.Screen name="Playlists" component={Playlists} options={{ headerTitle: t('playlists') }} />
<Stack.Screen name="Playlist" component={Playlist} options={{ headerTitle: t('playlist') }} />
</Stack.Navigator>

View File

@@ -0,0 +1,101 @@
import React, { useCallback, useEffect, ReactText } from 'react';
import { useGetImage } from 'utility/JellyfinApi';
import { View } from 'react-native';
import { RouteProp, useNavigation, useRoute } from '@react-navigation/native';
import { differenceInDays } from 'date-fns';
import { useAppDispatch, useTypedSelector } from 'store';
import { fetchAllAlbums } from 'store/music/actions';
import { ALBUM_CACHE_AMOUNT_OF_DAYS } from 'CONSTANTS';
import TouchableHandler from 'components/TouchableHandler';
import AlbumImage, { AlbumItem } from './components/AlbumImage';
import { EntityId } from '@reduxjs/toolkit';
import styled from 'styled-components/native';
import useDefaultStyles from 'components/Colors';
import { Album } from 'store/music/types';
import { Text } from 'components/Typography';
import { ShadowWrapper } from 'components/Shadow';
import { NavigationProp, StackParams } from 'screens/types';
import { SafeFlatList } from 'components/SafeNavigatorView';
import { chunk } from 'lodash';
interface GeneratedAlbumItemProps {
id: ReactText;
imageUrl: string;
name: string;
artist: string;
onPress: (id: string) => void;
}
const HalfOpacity = styled.Text`
opacity: 0.5;
`;
const GeneratedAlbumItem = React.memo(function GeneratedAlbumItem(props: GeneratedAlbumItemProps) {
const defaultStyles = useDefaultStyles();
const { id, imageUrl, name, artist, onPress } = props;
return (
<TouchableHandler id={id as string} onPress={onPress}>
<AlbumItem>
<ShadowWrapper size="medium">
<AlbumImage source={{ uri: imageUrl }} style={[defaultStyles.imageBackground]} />
</ShadowWrapper>
<Text numberOfLines={1} style={defaultStyles.text}>{name}</Text>
<HalfOpacity style={defaultStyles.text} numberOfLines={1}>{artist}</HalfOpacity>
</AlbumItem>
</TouchableHandler>
);
});
const Artist: React.FC = () => {
// Retrieve data from store
const { entities: albums } = useTypedSelector((state) => state.music.albums);
const isLoading = useTypedSelector((state) => state.music.albums.isLoading);
const lastRefreshed = useTypedSelector((state) => state.music.albums.lastRefreshed);
// Initialise helpers
const dispatch = useAppDispatch();
const navigation = useNavigation<NavigationProp>();
const { params } = useRoute<RouteProp<StackParams, 'Artist'>>();
const getImage = useGetImage();
// Set callbacks
const retrieveData = useCallback(() => dispatch(fetchAllAlbums()), [dispatch]);
const selectAlbum = useCallback((id: string) => navigation.navigate('Album', { id, album: albums[id] as Album }), [navigation, albums]);
const generateItem = useCallback(({ item }: { item: EntityId[] }) => {
return (
<View style={{ flexDirection: 'row', marginLeft: 10, marginRight: 10 }} key={item.join('-')}>
{item.map((id) => (
<GeneratedAlbumItem
key={id}
id={id}
imageUrl={getImage(id as string)}
name={albums[id]?.Name || ''}
artist={albums[id]?.AlbumArtist || ''}
onPress={selectAlbum}
/>
))}
</View>
);
}, [albums, getImage, selectAlbum]);
// Retrieve data on mount
useEffect(() => {
// GUARD: Only refresh this API call every set amounts of days
if (!lastRefreshed || differenceInDays(lastRefreshed, new Date()) > ALBUM_CACHE_AMOUNT_OF_DAYS) {
retrieveData();
}
});
return (
<SafeFlatList
data={chunk(params.albumIds, 2)}
refreshing={isLoading}
onRefresh={retrieveData}
renderItem={generateItem}
/>
);
};
export default Artist;

View File

@@ -0,0 +1,218 @@
import React, { useCallback, useEffect, useRef, useMemo } from 'react';
import { useGetImage } from 'utility/JellyfinApi';
import { SectionList, View } from 'react-native';
import { useNavigation } from '@react-navigation/native';
import { differenceInDays } from 'date-fns';
import { useAppDispatch, useTypedSelector } from 'store';
import { fetchAllAlbums } from 'store/music/actions';
import { ALBUM_CACHE_AMOUNT_OF_DAYS, THEME_COLOR } from 'CONSTANTS';
import AlbumImage from './components/AlbumImage';
import { SectionArtistItem, SectionedArtist, selectArtists } from 'store/music/selectors';
import AlphabetScroller from 'components/AlphabetScroller';
import styled from 'styled-components/native';
import useDefaultStyles, { ColoredBlurView } from 'components/Colors';
import { Text } from 'components/Typography';
import { NavigationProp } from 'screens/types';
import { SafeSectionList } from 'components/SafeNavigatorView';
import { Gap } from 'components/Utility';
const HeadingHeight = 50;
function generateSection({ section }: { section: SectionedArtist }) {
return (
<SectionHeading label={section.label} key={section.label} />
);
}
const SectionContainer = styled.View`
height: ${HeadingHeight}px;
justify-content: center;
padding: 0 24px;
`;
const SectionText = styled(Text)`
font-size: 24px;
font-weight: 400;
`;
const ArtistHeight = 32 + 8 * 2;
const ArtistContainer = styled.Pressable`
padding: 8px 16px;
border-radius: 8px;
height: ${ArtistHeight}px;
display: flex;
flex-grow: 1;
flex-shrink: 1;
display: flex;
align-items: center;
flex-direction: row;
overflow: hidden;
`;
const SectionHeading = React.memo(function SectionHeading(props: { label: string }) {
const { label } = props;
return (
<ColoredBlurView>
<SectionContainer>
<SectionText>{label}</SectionText>
</SectionContainer>
</ColoredBlurView>
);
});
interface GeneratedArtistItemProps {
item: SectionArtistItem;
imageURL: string;
onPress: (payload: SectionArtistItem) => void;
}
const GeneratedArtistItem = React.memo(function GeneratedArtistItem(props: GeneratedArtistItemProps) {
const defaultStyles = useDefaultStyles();
const { item, imageURL, onPress } = props;
const handlePress = useCallback(() => {
onPress(item);
}, [item, onPress]);
return (
<ArtistContainer
onPress={handlePress}
style={({ pressed }) => [
{ borderColor: defaultStyles.divider.backgroundColor },
pressed && defaultStyles.activeBackground,
]}
>
{({ pressed }) => (
<>
<AlbumImage source={{ uri: imageURL }} style={{ height: 32, width: 32, borderRadius: 4, marginBottom: 0 }} />
<Gap size={16} />
<Text
numberOfLines={1}
style={[
defaultStyles.text,
pressed && { color: THEME_COLOR },
{ flexShrink: 1 }
]}
>
{item.Name}
</Text>
</>
)}
</ArtistContainer>
);
});
const Artists: React.FC = () => {
// Retrieve data from store
// const { entities: albums } = useTypedSelector((state) => state.music.albums);
const isLoading = useTypedSelector((state) => state.music.albums.isLoading);
const lastRefreshed = useTypedSelector((state) => state.music.albums.lastRefreshed);
const sections = useTypedSelector(selectArtists);
// Initialise helpers
const dispatch = useAppDispatch();
const navigation = useNavigation<NavigationProp>();
const getImage = useGetImage();
const listRef = useRef<SectionList<SectionArtistItem>>(null);
// Create an array that computes all the height data for the entire list in
// advance. We can then use this pre-computed data to respond to
// `getItemLayout` calls, without having to compute things in place (and
// fail horribly).
// This approach was inspired by https://gist.github.com/RaphBlanchet/472ed013e05398c083caae6216b598b5
const itemLayouts = useMemo(() => {
// Create an array in which we will store all possible outputs for
// `getItemLayout`. We will loop through each potential album and add
// items that will be in the list
const layouts: Array<{ length: number; offset: number; index: number }> = [];
// Keep track of both the index of items and the offset (in pixels) from
// the top
let index = 0;
let offset = 0;
// Loop through each individual section (i.e. alphabet letter) and add
// all items in that particular section.
sections.forEach((section) => {
// Each section starts with a header, so we'll need to add the item,
// as well as the offset.
layouts[index] = ({ length: HeadingHeight, offset, index });
index++;
offset += HeadingHeight;
// Then, loop through all the rows and add items for those as well.
section.data.forEach(() => {
offset += ArtistHeight;
layouts[index] = ({ length: ArtistHeight, offset, index });
index++;
});
// The way SectionList works is that you get an item for a
// SectionHeader and a SectionFooter, no matter if you've specified
// whether you want them or not. Thus, we will need to add an empty
// footer as an item, so that we don't mismatch our indexes
layouts[index] = { length: 0, offset, index };
index++;
});
// Then, store and memoize the output
return layouts;
}, [sections]);
// Set callbacks
const retrieveData = useCallback(() => dispatch(fetchAllAlbums()), [dispatch]);
const selectArtist = useCallback((payload: SectionArtistItem) => (
navigation.navigate('Artist', payload)
), [navigation]);
const selectLetter = useCallback((sectionIndex: number) => {
listRef.current?.scrollToLocation({ sectionIndex, itemIndex: 0, animated: false, });
}, [listRef]);
const generateItem = useCallback(({ item }: { item: SectionArtistItem }) => {
return (
<View style={{ flexDirection: 'row', marginLeft: 10, marginRight: 10 }} key={item.Id}>
<GeneratedArtistItem
key={item.Id}
item={item}
onPress={selectArtist}
imageURL={getImage(item.Id)}
/>
</View>
);
}, [getImage, selectArtist]);
// Retrieve data on mount
useEffect(() => {
// GUARD: Only refresh this API call every set amounts of days
if (!lastRefreshed || differenceInDays(lastRefreshed, new Date()) > ALBUM_CACHE_AMOUNT_OF_DAYS) {
retrieveData();
}
});
return (
<>
<AlphabetScroller onSelect={selectLetter} />
<SafeSectionList
sections={sections}
refreshing={isLoading}
onRefresh={retrieveData}
getItemLayout={(_, i) => {
if (!(i in itemLayouts)) {
console.log('COuLD NOT FIND LAYOUT ITEM', i, _);
}
return itemLayouts[i] ?? { length: 0, offset: 0, index: i };
}}
ref={listRef}
keyExtractor={(item) => item.Id}
renderSectionHeader={generateSection}
renderItem={generateItem}
/>
</>
);
};
export default Artists;

View File

@@ -35,10 +35,12 @@ const NavigationHeader: React.FC = () => {
const navigation = useNavigation<NavigationProp>();
const handleAllAlbumsClick = useCallback(() => { navigation.navigate('Albums'); }, [navigation]);
const handlePlaylistsClick = useCallback(() => { navigation.navigate('Playlists'); }, [navigation]);
const handleArtistsClick = useCallback(() => { navigation.navigate('Artists'); }, [navigation]);
return (
<>
<ListButton onPress={handleAllAlbumsClick} testID="all-albums">{t('all-albums')}</ListButton>
<ListButton onPress={handleArtistsClick} testID="artists">{t('artists')}</ListButton>
<ListButton onPress={handlePlaylistsClick} testID="playlists">{t('playlists')}</ListButton>
<ListContainer>
<HeaderContainer>

View File

@@ -1,10 +1,13 @@
import { StackNavigationProp } from '@react-navigation/stack';
import { SectionArtistItem } from 'store/music/selectors';
import { Album } from 'store/music/types';
export type StackParams = {
[key: string]: Record<string, unknown> | undefined;
[key: string]: Record<string, unknown> | object | undefined;
Albums: undefined;
Album: { id: string, album: Album };
Artists: undefined;
Artist: SectionArtistItem;
Playlists: undefined;
Playlist: { id: string };
RecentAlbums: undefined;

View File

@@ -3,6 +3,7 @@ import { parseISO } from 'date-fns';
import { ALPHABET_LETTERS } from 'CONSTANTS';
import { createSelector, EntityId } from '@reduxjs/toolkit';
import { SectionListData } from 'react-native';
import { ArtistItem } from './types';
/**
* Retrieves a list of the n most recent albums
@@ -90,3 +91,64 @@ export const selectAlbumsByAlphabet = createSelector(
(state: AppState) => state.music.albums,
splitAlbumsByAlphabet,
);
export type SectionArtistItem = ArtistItem & { albumIds: EntityId[] };
/**
* Retrieve all artists based on the available albums
*/
export function artistsFromAlbums(state: AppState['music']['albums']) {
// Loop through all albums to retrieve the AlbumArtists
const artists = state.ids.reduce((sum, id) => {
// Retrieve the album from the state
const album = state.entities[id];
// Then, loop through all artists
album?.ArtistItems.forEach((artist) => {
// GUARD: Check that an array already exists for this artist
if (!(artist.Name in sum)) {
sum[artist.Name] = { albumIds: [] as EntityId[], ...artist };
}
// Add the album id to the artist in the object
sum[artist.Name].albumIds.push(id);
}, []);
return sum;
}, {} as Record<string, SectionArtistItem>);
// Now, alphabetically order the object by artist names
const sortedArtists = Object.entries(artists)
.sort(([a], [b]) => a.localeCompare(b));
return sortedArtists;
}
export type SectionedArtist = SectionListData<SectionArtistItem>;
function splitArtistsByAlphabet(state: AppState['music']['albums']) {
const artists = artistsFromAlbums(state);
const sections: SectionedArtist[] = ALPHABET_LETTERS.split('').map((l) => ({ label: l, data: [] }));
artists.forEach((artist) => {
const letter = artist[0].toUpperCase().charAt(0);
const index = letter ? ALPHABET_LETTERS.indexOf(letter) : 26;
// Then find the current row in this section (note that albums are
// grouped in pairs so we can render them more easily).
const section = sections[index >= 0 ? index : 26];
// Add the album to the row
(section.data as unknown as SectionArtistItem[]).push(artist[1]);
});
return sections;
}
/**
* Wrap splitByAlphabet into a memoized selector
*/
export const selectArtists = createSelector(
(state: AppState) => state.music.albums,
splitArtistsByAlphabet,
);

View File

@@ -4,6 +4,11 @@ import { Album, AlbumTrack, SimilarAlbum } from 'store/music/types';
type Credentials = AppState['settings']['jellyfin'];
/**
* This is a convenience function that converts a set of Jellyfin credentials
* from the Redux store to a HTTP Header that authenticates the user against the
* Jellyfin server.
*/
function generateConfig(credentials: Credentials): RequestInit {
return {
headers: {