Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: use queryOptions for library home page #948

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 9 additions & 30 deletions src/hooks/itemPublish.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,16 @@ import { splitRequestByIdsAndReturn } from '../api/axios.js';
import * as Api from '../api/itemPublish.js';
import { UndefinedArgument } from '../config/errors.js';
import { itemKeys } from '../keys.js';
import configureQueryOptions from '../queryOptions/index.js';
import { QueryClientConfig } from '../types.js';

export default (queryConfig: QueryClientConfig) => {
const { defaultQueryOptions } = queryConfig;
const {
mostLikedPublishedItemsOptions,
mostRecentPublishedItemsOptions,
publishedItemsForMemberOptions,
} = configureQueryOptions(queryConfig);

return {
useAllPublishedItems: (
Expand All @@ -31,44 +37,17 @@ export default (queryConfig: QueryClientConfig) => {
limit?: number;
},
options?: { enabled?: boolean },
) => {
const enabledValue = options?.enabled ?? true;
return useQuery({
queryKey: itemKeys.published().mostLiked(args?.limit),
queryFn: () => Api.getMostLikedPublishedItems(args ?? {}, queryConfig),
...defaultQueryOptions,
enabled: enabledValue,
});
},
) => useQuery(mostLikedPublishedItemsOptions(args, options)),
useMostRecentPublishedItems: (
args?: {
limit?: number;
},
options?: { enabled?: boolean },
) => {
const enabledValue = options?.enabled ?? true;
return useQuery({
queryKey: itemKeys.published().mostRecent(args?.limit),
queryFn: () => Api.getMostRecentPublishedItems(args ?? {}, queryConfig),
...defaultQueryOptions,
enabled: enabledValue,
});
},
) => useQuery(mostRecentPublishedItemsOptions(args, options)),
usePublishedItemsForMember: (
memberId?: UUID,
options?: { enabled?: boolean },
) =>
useQuery({
queryKey: itemKeys.published().byMember(memberId),
queryFn: () => {
if (!memberId) {
throw new UndefinedArgument();
}
return Api.getPublishedItemsForMember(memberId, queryConfig);
},
...defaultQueryOptions,
enabled: Boolean(memberId) && (options?.enabled ?? true),
}),
) => useQuery(publishedItemsForMemberOptions(memberId, options)),
useItemPublishedInformation: (
args: {
itemId?: UUID;
Expand Down
6 changes: 6 additions & 0 deletions src/queryClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import {
} from './config/constants.js';
import configureHooks from './hooks/index.js';
import configureMutations from './mutations/index.js';
import configureQueryOptions from './queryOptions/index.js';
import type { QueryClientConfig } from './types.js';
import { getHostname } from './utils/util.js';

Expand Down Expand Up @@ -76,6 +77,7 @@ export default (
QueryClientProvider: typeof QueryClientProvider;
hooks: typeof hooks;
useMutation: typeof useMutation;
queryOptions: typeof queryOptions;
ReactQueryDevtools: typeof ReactQueryDevtools;
dehydrate: typeof dehydrate;
Hydrate: typeof HydrationBoundary;
Expand Down Expand Up @@ -144,6 +146,9 @@ export default (
: undefined;
const hooks = configureHooks(queryConfig, websocketClient);

// set up options
const queryOptions = configureQueryOptions(queryConfig);

// returns the queryClient and relative instances
return {
queryConfig,
Expand All @@ -153,6 +158,7 @@ export default (
QueryClientProvider,
hooks,
useMutation,
queryOptions,
ReactQueryDevtools,
dehydrate,
Hydrate: HydrationBoundary,
Expand Down
6 changes: 6 additions & 0 deletions src/queryOptions/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { QueryClientConfig } from '../types.js';
import configureItemPublish from './itemPublish.js';

export default (queryConfig: QueryClientConfig) => ({
...configureItemPublish(queryConfig),
});
59 changes: 59 additions & 0 deletions src/queryOptions/itemPublish.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
import { UUID } from '@graasp/sdk';

import { queryOptions } from '@tanstack/react-query';

import { UndefinedArgument } from '../config/errors.js';
import { Api, QueryClientConfig } from '../index.js';
import { itemKeys } from '../keys.js';

export default (queryConfig: QueryClientConfig) => {
const { defaultQueryOptions } = queryConfig;

return {
publishedItemsForMemberOptions: (
memberId?: UUID,
options?: { enabled?: boolean },
) =>
queryOptions({
queryKey: itemKeys.published().byMember(memberId),
queryFn: () => {
if (!memberId) {
throw new UndefinedArgument();
}
return Api.getPublishedItemsForMember(memberId, queryConfig);
},
...defaultQueryOptions,
enabled: Boolean(memberId) && (options?.enabled ?? true),
}),

mostLikedPublishedItemsOptions: (
args?: {
limit?: number;
},
options?: { enabled?: boolean },
) => {
const enabledValue = options?.enabled ?? true;
return queryOptions({
queryKey: itemKeys.published().mostLiked(args?.limit),
queryFn: () => Api.getMostLikedPublishedItems(args ?? {}, queryConfig),
...defaultQueryOptions,
enabled: enabledValue,
});
},

mostRecentPublishedItemsOptions: (
args?: {
limit?: number;
},
options?: { enabled?: boolean },
) => {
const enabledValue = options?.enabled ?? true;
return queryOptions({
queryKey: itemKeys.published().mostRecent(args?.limit),
queryFn: () => Api.getMostRecentPublishedItems(args ?? {}, queryConfig),
...defaultQueryOptions,
enabled: enabledValue,
});
},
};
};