Merge pull request #8171 from thornbill/refactor-recommendations-hook

Refactor useMovieRecommendations hook
This commit is contained in:
Bill Thornton
2026-07-09 13:29:55 -04:00
committed by GitHub
3 changed files with 56 additions and 41 deletions
@@ -1,13 +1,11 @@
import { ItemFields } from '@jellyfin/sdk/lib/generated-client/models/item-fields';
import type { RecommendationDto } from '@jellyfin/sdk/lib/generated-client/models/recommendation-dto';
import { RecommendationType } from '@jellyfin/sdk/lib/generated-client/models/recommendation-type';
import React, { type FC } from 'react';
import { CardShape } from 'components/cardbuilder/utils/shape';
import { useApi } from 'hooks/useApi';
import {
useGetMovieRecommendations,
useGetSuggestionSectionsWithItems
} from 'hooks/useFetchItems';
import { useGetSuggestionSectionsWithItems } from 'hooks/useFetchItems';
import { appRouter } from 'components/router/appRouter';
import globalize from 'lib/globalize';
import Loading from 'components/loading/LoadingComponent';
@@ -17,6 +15,8 @@ import type { ParentId } from 'types/library';
import type { Section, SectionType } from 'types/sections';
import type { ItemDto } from 'types/base/models/item-dto';
import { useMovieRecommendations } from '../hooks/api/useMovieRecommendations';
interface SuggestionsSectionViewProps {
parentId: ParentId;
sectionType: SectionType[];
@@ -35,7 +35,15 @@ const SuggestionsSectionView: FC<SuggestionsSectionViewProps> = ({
const {
isLoading: isRecommendationsLoading,
data: movieRecommendationsItems
} = useGetMovieRecommendations(isMovieRecommendationEnabled, parentId);
} = useMovieRecommendations({
parentId: parentId || undefined,
fields: [
ItemFields.PrimaryImageAspectRatio,
ItemFields.MediaSourceCount
],
categoryLimit: 6,
itemLimit: 20
}, isMovieRecommendationEnabled);
if (isLoading || isRecommendationsLoading) {
return <Loading />;
@@ -0,0 +1,43 @@
import type { Api } from '@jellyfin/sdk/lib/api';
import type { MovieApiGetMovieRecommendationsRequest } from '@jellyfin/sdk/lib/generated-client/api/movie-api';
import { getMovieApi } from '@jellyfin/sdk/lib/utils/api/movie-api';
import { queryOptions, useQuery } from '@tanstack/react-query';
import type { AxiosRequestConfig } from 'axios';
import { useApi } from 'hooks/useApi';
const fetchGetMovieRecommendations = async (
api: Api,
params: MovieApiGetMovieRecommendationsRequest,
options?: AxiosRequestConfig
) => {
const response = await getMovieApi(api).getMovieRecommendations(params, options);
return response.data;
};
/** Query options for fetching movie recommendations. */
export const getMovieRecommendationsQuery = (
api?: Api,
params: MovieApiGetMovieRecommendationsRequest = {},
enabled = true
) => queryOptions({
queryKey: ['MovieRecommendations', params?.parentId],
queryFn: ({ signal }) => fetchGetMovieRecommendations(api!, params, { signal }),
enabled: !!api && enabled
});
/** Hook for fetching movie recommendations. */
export const useMovieRecommendations = (
params?: MovieApiGetMovieRecommendationsRequest,
enabled?: boolean
) => {
const { api, user } = useApi();
return useQuery(getMovieRecommendationsQuery(
api,
{
...params,
userId: params?.userId || user?.Id
},
enabled
));
};
-36
View File
@@ -11,7 +11,6 @@ import { SortOrder } from '@jellyfin/sdk/lib/generated-client/models/sort-order'
import { getArtistApi } from '@jellyfin/sdk/lib/utils/api/artist-api';
import { getFilterApi } from '@jellyfin/sdk/lib/utils/api/filter-api';
import { getGenreApi } from '@jellyfin/sdk/lib/utils/api/genre-api';
import { getMovieApi } from '@jellyfin/sdk/lib/utils/api/movie-api';
import { getPersonApi } from '@jellyfin/sdk/lib/utils/api/person-api';
import { getStudioApi } from '@jellyfin/sdk/lib/utils/api/studio-api';
import { getShowApi } from '@jellyfin/sdk/lib/utils/api/show-api';
@@ -74,41 +73,6 @@ export const useGetItems = (parametersOptions: LibraryApiGetItemsRequest) => {
});
};
const fetchGetMovieRecommendations = async (
currentApi: JellyfinApiContext,
parentId: ParentId,
options?: AxiosRequestConfig
) => {
const { api, user } = currentApi;
if (api && user?.Id) {
const response = await getMovieApi(api).getMovieRecommendations(
{
userId: user.Id,
fields: [
ItemFields.PrimaryImageAspectRatio,
ItemFields.MediaSourceCount
],
parentId: parentId ?? undefined,
categoryLimit: 6,
itemLimit: 20
},
{
signal: options?.signal
}
);
return response.data;
}
};
export const useGetMovieRecommendations = (isMovieRecommendationEnabled: boolean, parentId: ParentId) => {
const currentApi = useApi();
return useQuery({
queryKey: ['MovieRecommendations', isMovieRecommendationEnabled, parentId],
queryFn: ({ signal }) => fetchGetMovieRecommendations(currentApi, parentId, { signal }),
enabled: !!currentApi.api && !!currentApi.user?.Id && isMovieRecommendationEnabled
});
};
const fetchGetGenres = async (
currentApi: JellyfinApiContext,
itemType: BaseItemKind[],