@suspensive/react-query-4 3.0.0-next.11 → 3.0.0-next.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,11 @@
1
+ "use client"
2
+
3
+ // src/mutationOptions.tsx
4
+ function mutationOptions(options) {
5
+ return options;
6
+ }
7
+
8
+ export {
9
+ mutationOptions
10
+ };
11
+ //# sourceMappingURL=chunk-34N4X5NK.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/mutationOptions.tsx"],"sourcesContent":["import type { UseMutationOptions } from '@tanstack/react-query'\n\n/**\n * @experimental This is experimental feature.\n */\nexport function mutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(\n options: UseMutationOptions<TData, TError, TVariables, TContext>\n): UseMutationOptions<TData, TError, TVariables, TContext> {\n return options\n}\n"],"mappings":";;;AAKO,SAAS,gBACd,SACyD;AACzD,SAAO;AACT;","names":[]}
package/dist/index.cjs CHANGED
@@ -58,6 +58,7 @@ __export(index_exports, {
58
58
  SuspenseQueries: () => SuspenseQueries,
59
59
  SuspenseQuery: () => SuspenseQuery,
60
60
  infiniteQueryOptions: () => infiniteQueryOptions,
61
+ mutationOptions: () => mutationOptions,
61
62
  queryOptions: () => queryOptions,
62
63
  usePrefetchInfiniteQuery: () => usePrefetchInfiniteQuery,
63
64
  usePrefetchQuery: () => usePrefetchQuery,
@@ -188,6 +189,11 @@ function Mutation(_a) {
188
189
  return /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(import_jsx_runtime6.Fragment, { children: children((0, import_react_query6.useMutation)(options)) });
189
190
  }
190
191
 
192
+ // src/mutationOptions.tsx
193
+ function mutationOptions(options) {
194
+ return options;
195
+ }
196
+
191
197
  // src/QueryClientConsumer.tsx
192
198
  var import_react_query7 = require("@tanstack/react-query");
193
199
  var import_jsx_runtime7 = require("react/jsx-runtime");
@@ -207,6 +213,7 @@ function QueryClientConsumer({
207
213
  SuspenseQueries,
208
214
  SuspenseQuery,
209
215
  infiniteQueryOptions,
216
+ mutationOptions,
210
217
  queryOptions,
211
218
  usePrefetchInfiniteQuery,
212
219
  usePrefetchQuery,
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts","../src/queryOptions.ts","../src/infiniteQueryOptions.ts","../src/useSuspenseQuery.ts","../src/useSuspenseQueries.ts","../src/useSuspenseInfiniteQuery.ts","../src/usePrefetchQuery.ts","../src/usePrefetchInfiniteQuery.ts","../src/SuspenseQuery.tsx","../src/SuspenseQueries.tsx","../src/SuspenseInfiniteQuery.tsx","../src/PrefetchQuery.tsx","../src/PrefetchInfiniteQuery.tsx","../src/Mutation.tsx","../src/QueryClientConsumer.tsx"],"sourcesContent":["export { queryOptions } from './queryOptions'\nexport type { SelectedQueryOptions, UnSelectedQueryOptions } from './queryOptions'\nexport { infiniteQueryOptions } from './infiniteQueryOptions'\nexport type { SelectedInfiniteOptions, UnSelectedInfiniteOptions } from './infiniteQueryOptions'\nexport { useSuspenseQuery } from './useSuspenseQuery'\nexport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery'\nexport { useSuspenseQueries } from './useSuspenseQueries'\nexport type { SuspenseQueriesOptions, SuspenseQueriesResults } from './useSuspenseQueries'\nexport { useSuspenseInfiniteQuery } from './useSuspenseInfiniteQuery'\nexport type { UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult } from './useSuspenseInfiniteQuery'\nexport { usePrefetchQuery } from './usePrefetchQuery'\nexport { usePrefetchInfiniteQuery } from './usePrefetchInfiniteQuery'\n\nexport { SuspenseQuery } from './SuspenseQuery'\nexport { SuspenseQueries } from './SuspenseQueries'\nexport { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery'\nexport { PrefetchQuery } from './PrefetchQuery'\nexport { PrefetchInfiniteQuery } from './PrefetchInfiniteQuery'\nexport { Mutation } from './Mutation'\nexport { QueryClientConsumer } from './QueryClientConsumer'\n","import type { QueryKey, UseQueryOptions } from '@tanstack/react-query'\nimport type { OmitKeyof, RequiredKeyof } from './utility-types'\n\nexport type SelectedQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n | 'getNextPageParam'\n | 'getPreviousPageParam'\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: TQueryFnData) => TData\n}\n\nexport type UnSelectedQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n | 'getNextPageParam'\n | 'getPreviousPageParam'\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\n\n/**\n * Creates a reusable query options object that can be used across different query hooks.\n * Provides better type inference and easier query key management.\n *\n * @see {@link https://suspensive.org/docs/react-query/queryOptions Suspensive Docs}\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: SelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n): SelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UnSelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n): UnSelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function queryOptions(options: unknown) {\n return options\n}\n","import type { InfiniteData, QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query'\nimport type { OmitKeyof, RequiredKeyof } from './utility-types'\n\nexport type SelectedInfiniteOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: InfiniteData<TQueryFnData>) => InfiniteData<TData>\n}\n\nexport type UnSelectedInfiniteOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\n\nexport function infiniteQueryOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n): SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function infiniteQueryOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n): UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function infiniteQueryOptions(options: unknown) {\n return options\n}\n","import { type QueryKey, type UseQueryOptions, type UseQueryResult, useQuery } from '@tanstack/react-query'\nimport type { OmitKeyof } from './utility-types'\n\nexport interface UseSuspenseQueryResult<TData = unknown, TError = unknown>\n extends OmitKeyof<UseQueryResult<TData, TError>, keyof Pick<UseQueryResult, 'isPlaceholderData'>> {\n data: TData\n status: 'success'\n}\n\nexport type UseSuspenseQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData' | 'networkMode'\n>\n\n/**\n * This hook is wrapping `useQuery` of `@tanstack/react-query` v4 with default suspense option.\n * @see {@link https://suspensive.org/docs/react-query/useSuspenseQuery Suspensive Docs}\n */\nexport function useSuspenseQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n return useQuery<TQueryFnData, TError, TData, TQueryKey>({\n ...options,\n enabled: true,\n useErrorBoundary: true,\n suspense: true,\n networkMode: 'always',\n }) as UseSuspenseQueryResult<TData, TError>\n}\n","import { type QueryFunction, type UseQueryOptions, useQueries } from '@tanstack/react-query'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery'\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\ntype GetSuspenseOptions<T> =\n // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryOptions<unknown, TError, TData>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryOptions<TQueryFnData>\n : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TData, TQueryKey>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey>\n : // Fallback\n UseSuspenseQueryOptions\n\ntype GetSuspenseResults<T> =\n // Part 1: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? UseSuspenseQueryResult<TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryResult<TData, TError>\n : // Part 2: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? UseSuspenseQueryResult<TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n }\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Fallback\n UseSuspenseQueryResult\n\n/**\n * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type SuspenseQueriesOptions<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryOptions>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseOptions<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesOptions<[...Tail], [...TResult, GetSuspenseOptions<Head>], [...TDepth, 1]>\n : Array<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>>\n ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>\n : // Fallback\n Array<UseSuspenseQueryOptions>\n\n/**\n * SuspenseQueriesResults reducer recursively maps type param to results\n */\nexport type SuspenseQueriesResults<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseResults<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesResults<[...Tail], [...TResult, GetSuspenseResults<Head>], [...TDepth, 1]>\n : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, any>>\n ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results\n Array<UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>>\n : // Fallback\n Array<UseSuspenseQueryResult>\n\n/**\n * This hook is wrapping `useQueries` of `@tanstack/react-query` v4 with default suspense option.\n * @see {@link https://suspensive.org/docs/react-query/useSuspenseQueries Suspensive Docs}\n */\nexport function useSuspenseQueries<T extends any[]>({\n queries,\n context,\n}: {\n queries: readonly [...SuspenseQueriesOptions<T>]\n context?: UseQueryOptions['context']\n}): SuspenseQueriesResults<T> {\n return useQueries({\n queries: queries.map((query: typeof queries) => ({\n // eslint-disable-next-line @typescript-eslint/no-misused-spread\n ...query,\n suspense: true,\n })),\n context,\n }) as SuspenseQueriesResults<T>\n}\n","import {\n type InfiniteData,\n type QueryKey,\n type UseInfiniteQueryOptions,\n type UseInfiniteQueryResult,\n useInfiniteQuery,\n} from '@tanstack/react-query'\nimport type { OmitKeyof } from './utility-types'\n\nexport interface UseSuspenseInfiniteQueryResult<TData = unknown, TError = unknown>\n extends OmitKeyof<\n UseInfiniteQueryResult<TData, TError>,\n keyof Pick<UseInfiniteQueryResult<TData, TError>, 'isPlaceholderData'>\n > {\n data: InfiniteData<TData>\n status: 'success'\n}\n\nexport type UseSuspenseInfiniteQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData' | 'networkMode'\n>\n\n/**\n * This hook is wrapping `useInfiniteQuery` of `@tanstack/react-query` v4 with default suspense option.\n * @see {@link https://suspensive.org/docs/react-query/useSuspenseInfiniteQuery Suspensive Docs}\n */\nexport function useSuspenseInfiniteQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n): UseSuspenseInfiniteQueryResult<TData, TError> {\n return useInfiniteQuery({\n ...options,\n enabled: true,\n suspense: true,\n useErrorBoundary: true,\n networkMode: 'always',\n }) as UseSuspenseInfiniteQueryResult<TData, TError>\n}\n","import { type FetchQueryOptions, type QueryKey, useQueryClient } from '@tanstack/react-query'\n\n/**\n * The `usePrefetchQuery` does not return anything, it should be used just to fire a prefetch during render, before a suspense boundary that wraps a component that uses `useSuspenseQuery`.\n * @see {@link https://suspensive.org/docs/react-query/usePrefetchQuery Suspensive Docs}\n */\nexport function usePrefetchQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n const queryClient = useQueryClient()\n\n if (typeof options.queryKey !== 'undefined' && !queryClient.getQueryState(options.queryKey)) {\n queryClient.prefetchQuery(options)\n }\n}\n","import { type FetchInfiniteQueryOptions, type QueryKey, useQueryClient } from '@tanstack/react-query'\n\n/**\n * The `usePrefetchInfiniteQuery` does not return anything, it should be used just to fire a prefetch during render, before a suspense boundary that wraps a component that uses `useSuspenseInfiniteQuery`.\n * @see {@link https://suspensive.org/docs/react-query/usePrefetchInfiniteQuery Suspensive Docs}\n */\nexport function usePrefetchInfiniteQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n const queryClient = useQueryClient()\n\n if (typeof options.queryKey !== 'undefined' && !queryClient.getQueryState(options.queryKey)) {\n queryClient.prefetchInfiniteQuery(options)\n }\n}\n","import type { QueryKey } from '@tanstack/react-query'\nimport type { ReactNode } from 'react'\nimport { type UseSuspenseQueryOptions, type UseSuspenseQueryResult, useSuspenseQuery } from './useSuspenseQuery'\n\n/**\n * We provide these components to clearly express what causes suspense at the same depth.\n * `<SuspenseQuery/>` serves to make `useSuspenseQuery` easier to use in jsx.\n * @see {@link https://suspensive.org/docs/react-query/SuspenseQuery Suspensive Docs}\n * @example\n * ```tsx\n * import { SuspenseQuery } from '@suspensive/react-query'\n *\n * // You can use QueryOptions as props.\n * <SuspenseQuery {...queryOptions()}>\n * {({ data, isLoading }) => {\n * return <></>\n * }\n * </SuspenseQuery>\n * ```\n */\nexport const SuspenseQuery = <\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>({\n children,\n ...options\n}: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n children: (queryResult: UseSuspenseQueryResult<TData, TError>) => ReactNode\n}) => <>{children(useSuspenseQuery(options))}</>\n","import type { ReactNode } from 'react'\nimport { type SuspenseQueriesOptions, type SuspenseQueriesResults, useSuspenseQueries } from './useSuspenseQueries'\n\n/**\n * We provide these components to clearly express what causes suspense at the same depth.\n * `<SuspenseQueries/>` serves to make `useSuspenseQueries` easier to use in jsx.\n * @see {@link https://suspensive.org/docs/react-query/SuspenseQueries Suspensive Docs}\n * @example\n * ```tsx\n * import { SuspenseQueries } from '@suspensive/react-query'\n *\n * <SuspenseQueries queries={[firstQueryOptions(), secondQueryOptions()]}>\n * {([{ data: firstQueryData }, { data: secondQueryData }]) => {\n * return <></>\n * }}\n * </SuspenseQueries>\n * ```\n */\nexport function SuspenseQueries<T extends any[]>({\n children,\n queries,\n}: {\n queries: readonly [...SuspenseQueriesOptions<T>]\n children: (queries: SuspenseQueriesResults<T>) => ReactNode\n}) {\n return <>{children(useSuspenseQueries({ queries }))}</>\n}\n","import type { QueryKey } from '@tanstack/react-query'\nimport type { ReactNode } from 'react'\nimport {\n type UseSuspenseInfiniteQueryOptions,\n type UseSuspenseInfiniteQueryResult,\n useSuspenseInfiniteQuery,\n} from './useSuspenseInfiniteQuery'\n\n/**\n * We provide these components to clearly express what causes suspense at the same depth.\n * `<SuspenseInfiniteQuery/>` serves to make `useSuspenseInfiniteQuery` easier to use in jsx.\n * @see {@link https://suspensive.org/docs/react-query/SuspenseInfiniteQuery Suspensive Docs}\n * @example\n * ```tsx\n * import { SuspenseInfiniteQuery } from '@suspensive/react-query'\n *\n * // You can use infiniteQueryOptions as props.\n * <SuspenseInfiniteQuery {...infiniteQueryOptions()}>\n * {({ data, fetchNextPage }) => {\n * return <></>\n * }}\n * </SuspenseInfiniteQuery>\n * ```\n */\nexport const SuspenseInfiniteQuery = <\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>({\n children,\n ...options\n}: UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n children: (query: UseSuspenseInfiniteQueryResult<TData, TError>) => ReactNode\n}) => <>{children(useSuspenseInfiniteQuery(options))}</>\n","import { type FetchQueryOptions, type QueryKey } from '@tanstack/react-query'\nimport { usePrefetchQuery } from './usePrefetchQuery'\n\n/**\n * A component that allows you to use usePrefetchQuery in JSX, avoiding the limitations of React hooks.\n * @see {@link https://suspensive.org/docs/react-query/PrefetchQuery Suspensive Docs}\n * @example\n * ```tsx\n * <PrefetchQuery queryKey={['queryKey']} queryFn={queryFn} />\n * ```\n */\nexport function PrefetchQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n usePrefetchQuery(options)\n return <></>\n}\n","import { type FetchInfiniteQueryOptions, type QueryKey } from '@tanstack/react-query'\nimport { usePrefetchInfiniteQuery } from './usePrefetchInfiniteQuery'\n\n/**\n * A component that allows you to use `usePrefetchInfiniteQuery` in JSX, avoiding the limitations of React hooks.\n * @see {@link https://suspensive.org/docs/react-query/PrefetchInfiniteQuery Suspensive Docs}\n * @example\n * ```tsx\n * <PrefetchInfiniteQuery queryKey={['queryKey']} queryFn={queryFn} />\n * ```\n */\nexport function PrefetchInfiniteQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n usePrefetchInfiniteQuery(options)\n return <></>\n}\n","import { type UseMutationOptions, type UseMutationResult, useMutation } from '@tanstack/react-query'\nimport type { ReactNode } from 'react'\n\nexport function Mutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>({\n children,\n ...options\n}: UseMutationOptions<TData, TError, TVariables, TContext> & {\n children: (mutationResult: UseMutationResult<TData, TError, TVariables, TContext>) => ReactNode\n}) {\n return <>{children(useMutation(options))}</>\n}\n","import { type QueryClient, useQueryClient } from '@tanstack/react-query'\nimport type { Context, ReactNode } from 'react'\n\n/**\n * @experimental This is experimental feature.\n */\nexport function QueryClientConsumer({\n children,\n context,\n}: {\n children: (queryClient: QueryClient) => ReactNode\n context?: Context<QueryClient | undefined>\n}) {\n return <>{children(useQueryClient({ context: context as any }))}</>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACmFO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;;;ACZO,SAAS,qBAAqB,SAAkB;AACrD,SAAO;AACT;;;AC3EA,yBAAmF;AAuB5E,SAAS,iBAKd,SAA0E;AAC1E,aAAO,6BAAiD,iCACnD,UADmD;AAAA,IAEtD,SAAS;AAAA,IACT,kBAAkB;AAAA,IAClB,UAAU;AAAA,IACV,aAAa;AAAA,EACf,EAAC;AACH;;;ACpCA,IAAAA,sBAAqE;AAmH9D,SAAS,mBAAoC;AAAA,EAClD;AAAA,EACA;AACF,GAG8B;AAC5B,aAAO,gCAAW;AAAA,IAChB,SAAS,QAAQ,IAAI,CAAC,UAA2B,iCAE5C,QAF4C;AAAA,MAG/C,UAAU;AAAA,IACZ,EAAE;AAAA,IACF;AAAA,EACF,CAAC;AACH;;;AClIA,IAAAC,sBAMO;AA0BA,SAAS,yBAMd,SAC+C;AAC/C,aAAO,sCAAiB,iCACnB,UADmB;AAAA,IAEtB,SAAS;AAAA,IACT,UAAU;AAAA,IACV,kBAAkB;AAAA,IAClB,aAAa;AAAA,EACf,EAAC;AACH;;;AC/CA,IAAAC,sBAAsE;AAM/D,SAAS,iBAKd,SAAoE;AACpE,QAAM,kBAAc,oCAAe;AAEnC,MAAI,OAAO,QAAQ,aAAa,eAAe,CAAC,YAAY,cAAc,QAAQ,QAAQ,GAAG;AAC3F,gBAAY,cAAc,OAAO;AAAA,EACnC;AACF;;;ACjBA,IAAAC,sBAA8E;AAMvE,SAAS,yBAKd,SAA4E;AAC5E,QAAM,kBAAc,oCAAe;AAEnC,MAAI,OAAO,QAAQ,aAAa,eAAe,CAAC,YAAY,cAAc,QAAQ,QAAQ,GAAG;AAC3F,gBAAY,sBAAsB,OAAO;AAAA,EAC3C;AACF;;;ACaM;AAVC,IAAM,gBAAgB,CAK3B,OAKC;AALD,eACA;AAAA;AAAA,EA1BF,IAyBE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,oFAAG,mBAAS,iBAAiB,OAAO,CAAC,GAAE;AAAA;;;ACLpC,IAAAC,sBAAA;AAPF,SAAS,gBAAiC;AAAA,EAC/C;AAAA,EACA;AACF,GAGG;AACD,SAAO,6EAAG,mBAAS,mBAAmB,EAAE,QAAQ,CAAC,CAAC,GAAE;AACtD;;;ACQM,IAAAC,sBAAA;AAVC,IAAM,wBAAwB,CAKnC,OAKC;AALD,eACA;AAAA;AAAA,EA9BF,IA6BE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,sFAAG,mBAAS,yBAAyB,OAAO,CAAC,GAAE;AAAA;;;AChB5C,IAAAC,sBAAA;AAPF,SAAS,cAKd,SAAoE;AACpE,mBAAiB,OAAO;AACxB,SAAO,6EAAE;AACX;;;ACDS,IAAAC,sBAAA;AAPF,SAAS,sBAKd,SAA4E;AAC5E,2BAAyB,OAAO;AAChC,SAAO,6EAAE;AACX;;;ACnBA,IAAAC,sBAA6E;AASpE,IAAAC,sBAAA;AANF,SAAS,SAAmF,IAKhG;AALgG,eACjG;AAAA;AAAA,EAJF,IAGmG,IAE9F,oBAF8F,IAE9F;AAAA,IADH;AAAA;AAKA,SAAO,6EAAG,uBAAS,iCAAY,OAAO,CAAC,GAAE;AAC3C;;;ACVA,IAAAC,sBAAiD;AAaxC,IAAAC,sBAAA;AAPF,SAAS,oBAAoB;AAAA,EAClC;AAAA,EACA;AACF,GAGG;AACD,SAAO,6EAAG,uBAAS,oCAAe,EAAE,QAAwB,CAAC,CAAC,GAAE;AAClE;","names":["import_react_query","import_react_query","import_react_query","import_react_query","import_jsx_runtime","import_jsx_runtime","import_jsx_runtime","import_jsx_runtime","import_react_query","import_jsx_runtime","import_react_query","import_jsx_runtime"]}
1
+ {"version":3,"sources":["../src/index.ts","../src/queryOptions.ts","../src/infiniteQueryOptions.ts","../src/useSuspenseQuery.ts","../src/useSuspenseQueries.ts","../src/useSuspenseInfiniteQuery.ts","../src/usePrefetchQuery.ts","../src/usePrefetchInfiniteQuery.ts","../src/SuspenseQuery.tsx","../src/SuspenseQueries.tsx","../src/SuspenseInfiniteQuery.tsx","../src/PrefetchQuery.tsx","../src/PrefetchInfiniteQuery.tsx","../src/Mutation.tsx","../src/mutationOptions.tsx","../src/QueryClientConsumer.tsx"],"sourcesContent":["export { queryOptions } from './queryOptions'\nexport type { SelectedQueryOptions, UnSelectedQueryOptions } from './queryOptions'\nexport { infiniteQueryOptions } from './infiniteQueryOptions'\nexport type { SelectedInfiniteOptions, UnSelectedInfiniteOptions } from './infiniteQueryOptions'\nexport { useSuspenseQuery } from './useSuspenseQuery'\nexport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery'\nexport { useSuspenseQueries } from './useSuspenseQueries'\nexport type { SuspenseQueriesOptions, SuspenseQueriesResults } from './useSuspenseQueries'\nexport { useSuspenseInfiniteQuery } from './useSuspenseInfiniteQuery'\nexport type { UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult } from './useSuspenseInfiniteQuery'\nexport { usePrefetchQuery } from './usePrefetchQuery'\nexport { usePrefetchInfiniteQuery } from './usePrefetchInfiniteQuery'\n\nexport { SuspenseQuery } from './SuspenseQuery'\nexport { SuspenseQueries } from './SuspenseQueries'\nexport { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery'\nexport { PrefetchQuery } from './PrefetchQuery'\nexport { PrefetchInfiniteQuery } from './PrefetchInfiniteQuery'\nexport { Mutation } from './Mutation'\nexport { mutationOptions } from './mutationOptions'\nexport { QueryClientConsumer } from './QueryClientConsumer'\n","import type { QueryKey, UseQueryOptions } from '@tanstack/react-query'\nimport type { OmitKeyof, RequiredKeyof } from './utility-types'\n\nexport type SelectedQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n | 'getNextPageParam'\n | 'getPreviousPageParam'\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: TQueryFnData) => TData\n}\n\nexport type UnSelectedQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n | 'getNextPageParam'\n | 'getPreviousPageParam'\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\n\n/**\n * Creates a reusable query options object that can be used across different query hooks.\n * Provides better type inference and easier query key management.\n *\n * @see {@link https://suspensive.org/docs/react-query/queryOptions Suspensive Docs}\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: SelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n): SelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UnSelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n): UnSelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function queryOptions(options: unknown) {\n return options\n}\n","import type { InfiniteData, QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query'\nimport type { OmitKeyof, RequiredKeyof } from './utility-types'\n\nexport type SelectedInfiniteOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: InfiniteData<TQueryFnData>) => InfiniteData<TData>\n}\n\nexport type UnSelectedInfiniteOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\n\nexport function infiniteQueryOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n): SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function infiniteQueryOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n): UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function infiniteQueryOptions(options: unknown) {\n return options\n}\n","import { type QueryKey, type UseQueryOptions, type UseQueryResult, useQuery } from '@tanstack/react-query'\nimport type { OmitKeyof } from './utility-types'\n\nexport interface UseSuspenseQueryResult<TData = unknown, TError = unknown>\n extends OmitKeyof<UseQueryResult<TData, TError>, keyof Pick<UseQueryResult, 'isPlaceholderData'>> {\n data: TData\n status: 'success'\n}\n\nexport type UseSuspenseQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData' | 'networkMode'\n>\n\n/**\n * This hook is wrapping `useQuery` of `@tanstack/react-query` v4 with default suspense option.\n * @see {@link https://suspensive.org/docs/react-query/useSuspenseQuery Suspensive Docs}\n */\nexport function useSuspenseQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n return useQuery<TQueryFnData, TError, TData, TQueryKey>({\n ...options,\n enabled: true,\n useErrorBoundary: true,\n suspense: true,\n networkMode: 'always',\n }) as UseSuspenseQueryResult<TData, TError>\n}\n","import { type QueryFunction, type UseQueryOptions, useQueries } from '@tanstack/react-query'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery'\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\ntype GetSuspenseOptions<T> =\n // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryOptions<unknown, TError, TData>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryOptions<TQueryFnData>\n : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TData, TQueryKey>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey>\n : // Fallback\n UseSuspenseQueryOptions\n\ntype GetSuspenseResults<T> =\n // Part 1: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? UseSuspenseQueryResult<TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryResult<TData, TError>\n : // Part 2: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? UseSuspenseQueryResult<TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n }\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Fallback\n UseSuspenseQueryResult\n\n/**\n * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type SuspenseQueriesOptions<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryOptions>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseOptions<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesOptions<[...Tail], [...TResult, GetSuspenseOptions<Head>], [...TDepth, 1]>\n : Array<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>>\n ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>\n : // Fallback\n Array<UseSuspenseQueryOptions>\n\n/**\n * SuspenseQueriesResults reducer recursively maps type param to results\n */\nexport type SuspenseQueriesResults<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseResults<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesResults<[...Tail], [...TResult, GetSuspenseResults<Head>], [...TDepth, 1]>\n : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, any>>\n ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results\n Array<UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>>\n : // Fallback\n Array<UseSuspenseQueryResult>\n\n/**\n * This hook is wrapping `useQueries` of `@tanstack/react-query` v4 with default suspense option.\n * @see {@link https://suspensive.org/docs/react-query/useSuspenseQueries Suspensive Docs}\n */\nexport function useSuspenseQueries<T extends any[]>({\n queries,\n context,\n}: {\n queries: readonly [...SuspenseQueriesOptions<T>]\n context?: UseQueryOptions['context']\n}): SuspenseQueriesResults<T> {\n return useQueries({\n queries: queries.map((query: typeof queries) => ({\n // eslint-disable-next-line @typescript-eslint/no-misused-spread\n ...query,\n suspense: true,\n })),\n context,\n }) as SuspenseQueriesResults<T>\n}\n","import {\n type InfiniteData,\n type QueryKey,\n type UseInfiniteQueryOptions,\n type UseInfiniteQueryResult,\n useInfiniteQuery,\n} from '@tanstack/react-query'\nimport type { OmitKeyof } from './utility-types'\n\nexport interface UseSuspenseInfiniteQueryResult<TData = unknown, TError = unknown>\n extends OmitKeyof<\n UseInfiniteQueryResult<TData, TError>,\n keyof Pick<UseInfiniteQueryResult<TData, TError>, 'isPlaceholderData'>\n > {\n data: InfiniteData<TData>\n status: 'success'\n}\n\nexport type UseSuspenseInfiniteQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData' | 'networkMode'\n>\n\n/**\n * This hook is wrapping `useInfiniteQuery` of `@tanstack/react-query` v4 with default suspense option.\n * @see {@link https://suspensive.org/docs/react-query/useSuspenseInfiniteQuery Suspensive Docs}\n */\nexport function useSuspenseInfiniteQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n): UseSuspenseInfiniteQueryResult<TData, TError> {\n return useInfiniteQuery({\n ...options,\n enabled: true,\n suspense: true,\n useErrorBoundary: true,\n networkMode: 'always',\n }) as UseSuspenseInfiniteQueryResult<TData, TError>\n}\n","import { type FetchQueryOptions, type QueryKey, useQueryClient } from '@tanstack/react-query'\n\n/**\n * The `usePrefetchQuery` does not return anything, it should be used just to fire a prefetch during render, before a suspense boundary that wraps a component that uses `useSuspenseQuery`.\n * @see {@link https://suspensive.org/docs/react-query/usePrefetchQuery Suspensive Docs}\n */\nexport function usePrefetchQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n const queryClient = useQueryClient()\n\n if (typeof options.queryKey !== 'undefined' && !queryClient.getQueryState(options.queryKey)) {\n queryClient.prefetchQuery(options)\n }\n}\n","import { type FetchInfiniteQueryOptions, type QueryKey, useQueryClient } from '@tanstack/react-query'\n\n/**\n * The `usePrefetchInfiniteQuery` does not return anything, it should be used just to fire a prefetch during render, before a suspense boundary that wraps a component that uses `useSuspenseInfiniteQuery`.\n * @see {@link https://suspensive.org/docs/react-query/usePrefetchInfiniteQuery Suspensive Docs}\n */\nexport function usePrefetchInfiniteQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n const queryClient = useQueryClient()\n\n if (typeof options.queryKey !== 'undefined' && !queryClient.getQueryState(options.queryKey)) {\n queryClient.prefetchInfiniteQuery(options)\n }\n}\n","import type { QueryKey } from '@tanstack/react-query'\nimport type { ReactNode } from 'react'\nimport { type UseSuspenseQueryOptions, type UseSuspenseQueryResult, useSuspenseQuery } from './useSuspenseQuery'\n\n/**\n * We provide these components to clearly express what causes suspense at the same depth.\n * `<SuspenseQuery/>` serves to make `useSuspenseQuery` easier to use in jsx.\n * @see {@link https://suspensive.org/docs/react-query/SuspenseQuery Suspensive Docs}\n * @example\n * ```tsx\n * import { SuspenseQuery } from '@suspensive/react-query'\n *\n * // You can use QueryOptions as props.\n * <SuspenseQuery {...queryOptions()}>\n * {({ data, isLoading }) => {\n * return <></>\n * }\n * </SuspenseQuery>\n * ```\n */\nexport const SuspenseQuery = <\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>({\n children,\n ...options\n}: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n children: (queryResult: UseSuspenseQueryResult<TData, TError>) => ReactNode\n}) => <>{children(useSuspenseQuery(options))}</>\n","import type { ReactNode } from 'react'\nimport { type SuspenseQueriesOptions, type SuspenseQueriesResults, useSuspenseQueries } from './useSuspenseQueries'\n\n/**\n * We provide these components to clearly express what causes suspense at the same depth.\n * `<SuspenseQueries/>` serves to make `useSuspenseQueries` easier to use in jsx.\n * @see {@link https://suspensive.org/docs/react-query/SuspenseQueries Suspensive Docs}\n * @example\n * ```tsx\n * import { SuspenseQueries } from '@suspensive/react-query'\n *\n * <SuspenseQueries queries={[firstQueryOptions(), secondQueryOptions()]}>\n * {([{ data: firstQueryData }, { data: secondQueryData }]) => {\n * return <></>\n * }}\n * </SuspenseQueries>\n * ```\n */\nexport function SuspenseQueries<T extends any[]>({\n children,\n queries,\n}: {\n queries: readonly [...SuspenseQueriesOptions<T>]\n children: (queries: SuspenseQueriesResults<T>) => ReactNode\n}) {\n return <>{children(useSuspenseQueries({ queries }))}</>\n}\n","import type { QueryKey } from '@tanstack/react-query'\nimport type { ReactNode } from 'react'\nimport {\n type UseSuspenseInfiniteQueryOptions,\n type UseSuspenseInfiniteQueryResult,\n useSuspenseInfiniteQuery,\n} from './useSuspenseInfiniteQuery'\n\n/**\n * We provide these components to clearly express what causes suspense at the same depth.\n * `<SuspenseInfiniteQuery/>` serves to make `useSuspenseInfiniteQuery` easier to use in jsx.\n * @see {@link https://suspensive.org/docs/react-query/SuspenseInfiniteQuery Suspensive Docs}\n * @example\n * ```tsx\n * import { SuspenseInfiniteQuery } from '@suspensive/react-query'\n *\n * // You can use infiniteQueryOptions as props.\n * <SuspenseInfiniteQuery {...infiniteQueryOptions()}>\n * {({ data, fetchNextPage }) => {\n * return <></>\n * }}\n * </SuspenseInfiniteQuery>\n * ```\n */\nexport const SuspenseInfiniteQuery = <\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>({\n children,\n ...options\n}: UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n children: (query: UseSuspenseInfiniteQueryResult<TData, TError>) => ReactNode\n}) => <>{children(useSuspenseInfiniteQuery(options))}</>\n","import { type FetchQueryOptions, type QueryKey } from '@tanstack/react-query'\nimport { usePrefetchQuery } from './usePrefetchQuery'\n\n/**\n * A component that allows you to use usePrefetchQuery in JSX, avoiding the limitations of React hooks.\n * @see {@link https://suspensive.org/docs/react-query/PrefetchQuery Suspensive Docs}\n * @example\n * ```tsx\n * <PrefetchQuery queryKey={['queryKey']} queryFn={queryFn} />\n * ```\n */\nexport function PrefetchQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n usePrefetchQuery(options)\n return <></>\n}\n","import { type FetchInfiniteQueryOptions, type QueryKey } from '@tanstack/react-query'\nimport { usePrefetchInfiniteQuery } from './usePrefetchInfiniteQuery'\n\n/**\n * A component that allows you to use `usePrefetchInfiniteQuery` in JSX, avoiding the limitations of React hooks.\n * @see {@link https://suspensive.org/docs/react-query/PrefetchInfiniteQuery Suspensive Docs}\n * @example\n * ```tsx\n * <PrefetchInfiniteQuery queryKey={['queryKey']} queryFn={queryFn} />\n * ```\n */\nexport function PrefetchInfiniteQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n usePrefetchInfiniteQuery(options)\n return <></>\n}\n","import { type UseMutationOptions, type UseMutationResult, useMutation } from '@tanstack/react-query'\nimport type { ReactNode } from 'react'\n\nexport function Mutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>({\n children,\n ...options\n}: UseMutationOptions<TData, TError, TVariables, TContext> & {\n children: (mutationResult: UseMutationResult<TData, TError, TVariables, TContext>) => ReactNode\n}) {\n return <>{children(useMutation(options))}</>\n}\n","import type { UseMutationOptions } from '@tanstack/react-query'\n\n/**\n * @experimental This is experimental feature.\n */\nexport function mutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(\n options: UseMutationOptions<TData, TError, TVariables, TContext>\n): UseMutationOptions<TData, TError, TVariables, TContext> {\n return options\n}\n","import { type QueryClient, useQueryClient } from '@tanstack/react-query'\nimport type { Context, ReactNode } from 'react'\n\n/**\n * @experimental This is experimental feature.\n */\nexport function QueryClientConsumer({\n children,\n context,\n}: {\n children: (queryClient: QueryClient) => ReactNode\n context?: Context<QueryClient | undefined>\n}) {\n return <>{children(useQueryClient({ context: context as any }))}</>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACmFO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;;;ACZO,SAAS,qBAAqB,SAAkB;AACrD,SAAO;AACT;;;AC3EA,yBAAmF;AAuB5E,SAAS,iBAKd,SAA0E;AAC1E,aAAO,6BAAiD,iCACnD,UADmD;AAAA,IAEtD,SAAS;AAAA,IACT,kBAAkB;AAAA,IAClB,UAAU;AAAA,IACV,aAAa;AAAA,EACf,EAAC;AACH;;;ACpCA,IAAAA,sBAAqE;AAmH9D,SAAS,mBAAoC;AAAA,EAClD;AAAA,EACA;AACF,GAG8B;AAC5B,aAAO,gCAAW;AAAA,IAChB,SAAS,QAAQ,IAAI,CAAC,UAA2B,iCAE5C,QAF4C;AAAA,MAG/C,UAAU;AAAA,IACZ,EAAE;AAAA,IACF;AAAA,EACF,CAAC;AACH;;;AClIA,IAAAC,sBAMO;AA0BA,SAAS,yBAMd,SAC+C;AAC/C,aAAO,sCAAiB,iCACnB,UADmB;AAAA,IAEtB,SAAS;AAAA,IACT,UAAU;AAAA,IACV,kBAAkB;AAAA,IAClB,aAAa;AAAA,EACf,EAAC;AACH;;;AC/CA,IAAAC,sBAAsE;AAM/D,SAAS,iBAKd,SAAoE;AACpE,QAAM,kBAAc,oCAAe;AAEnC,MAAI,OAAO,QAAQ,aAAa,eAAe,CAAC,YAAY,cAAc,QAAQ,QAAQ,GAAG;AAC3F,gBAAY,cAAc,OAAO;AAAA,EACnC;AACF;;;ACjBA,IAAAC,sBAA8E;AAMvE,SAAS,yBAKd,SAA4E;AAC5E,QAAM,kBAAc,oCAAe;AAEnC,MAAI,OAAO,QAAQ,aAAa,eAAe,CAAC,YAAY,cAAc,QAAQ,QAAQ,GAAG;AAC3F,gBAAY,sBAAsB,OAAO;AAAA,EAC3C;AACF;;;ACaM;AAVC,IAAM,gBAAgB,CAK3B,OAKC;AALD,eACA;AAAA;AAAA,EA1BF,IAyBE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,oFAAG,mBAAS,iBAAiB,OAAO,CAAC,GAAE;AAAA;;;ACLpC,IAAAC,sBAAA;AAPF,SAAS,gBAAiC;AAAA,EAC/C;AAAA,EACA;AACF,GAGG;AACD,SAAO,6EAAG,mBAAS,mBAAmB,EAAE,QAAQ,CAAC,CAAC,GAAE;AACtD;;;ACQM,IAAAC,sBAAA;AAVC,IAAM,wBAAwB,CAKnC,OAKC;AALD,eACA;AAAA;AAAA,EA9BF,IA6BE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,sFAAG,mBAAS,yBAAyB,OAAO,CAAC,GAAE;AAAA;;;AChB5C,IAAAC,sBAAA;AAPF,SAAS,cAKd,SAAoE;AACpE,mBAAiB,OAAO;AACxB,SAAO,6EAAE;AACX;;;ACDS,IAAAC,sBAAA;AAPF,SAAS,sBAKd,SAA4E;AAC5E,2BAAyB,OAAO;AAChC,SAAO,6EAAE;AACX;;;ACnBA,IAAAC,sBAA6E;AASpE,IAAAC,sBAAA;AANF,SAAS,SAAmF,IAKhG;AALgG,eACjG;AAAA;AAAA,EAJF,IAGmG,IAE9F,oBAF8F,IAE9F;AAAA,IADH;AAAA;AAKA,SAAO,6EAAG,uBAAS,iCAAY,OAAO,CAAC,GAAE;AAC3C;;;ACLO,SAAS,gBACd,SACyD;AACzD,SAAO;AACT;;;ACTA,IAAAC,sBAAiD;AAaxC,IAAAC,sBAAA;AAPF,SAAS,oBAAoB;AAAA,EAClC;AAAA,EACA;AACF,GAGG;AACD,SAAO,6EAAG,uBAAS,oCAAe,EAAE,QAAwB,CAAC,CAAC,GAAE;AAClE;","names":["import_react_query","import_react_query","import_react_query","import_react_query","import_jsx_runtime","import_jsx_runtime","import_jsx_runtime","import_jsx_runtime","import_react_query","import_jsx_runtime","import_react_query","import_jsx_runtime"]}
package/dist/index.d.cts CHANGED
@@ -11,6 +11,7 @@ export { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery.cjs';
11
11
  export { PrefetchQuery } from './PrefetchQuery.cjs';
12
12
  export { PrefetchInfiniteQuery } from './PrefetchInfiniteQuery.cjs';
13
13
  export { Mutation } from './Mutation.cjs';
14
+ export { mutationOptions } from './mutationOptions.cjs';
14
15
  export { QueryClientConsumer } from './QueryClientConsumer.cjs';
15
16
  import '@tanstack/react-query';
16
17
  import './OmitKeyof-CFsZLI4k.cjs';
package/dist/index.d.ts CHANGED
@@ -11,6 +11,7 @@ export { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery.js';
11
11
  export { PrefetchQuery } from './PrefetchQuery.js';
12
12
  export { PrefetchInfiniteQuery } from './PrefetchInfiniteQuery.js';
13
13
  export { Mutation } from './Mutation.js';
14
+ export { mutationOptions } from './mutationOptions.js';
14
15
  export { QueryClientConsumer } from './QueryClientConsumer.js';
15
16
  import '@tanstack/react-query';
16
17
  import './OmitKeyof-CFsZLI4k.js';
package/dist/index.js CHANGED
@@ -2,6 +2,9 @@
2
2
  import {
3
3
  infiniteQueryOptions
4
4
  } from "./chunk-3OKEPIW3.js";
5
+ import {
6
+ mutationOptions
7
+ } from "./chunk-34N4X5NK.js";
5
8
  import {
6
9
  queryOptions
7
10
  } from "./chunk-UVSCLLGR.js";
@@ -51,6 +54,7 @@ export {
51
54
  SuspenseQueries,
52
55
  SuspenseQuery,
53
56
  infiniteQueryOptions,
57
+ mutationOptions,
54
58
  queryOptions,
55
59
  usePrefetchInfiniteQuery,
56
60
  usePrefetchQuery,
@@ -0,0 +1,34 @@
1
+ "use client"
2
+ "use strict";
3
+ var __defProp = Object.defineProperty;
4
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
+ var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
7
+ var __export = (target, all) => {
8
+ for (var name in all)
9
+ __defProp(target, name, { get: all[name], enumerable: true });
10
+ };
11
+ var __copyProps = (to, from, except, desc) => {
12
+ if (from && typeof from === "object" || typeof from === "function") {
13
+ for (let key of __getOwnPropNames(from))
14
+ if (!__hasOwnProp.call(to, key) && key !== except)
15
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
16
+ }
17
+ return to;
18
+ };
19
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
20
+
21
+ // src/mutationOptions.tsx
22
+ var mutationOptions_exports = {};
23
+ __export(mutationOptions_exports, {
24
+ mutationOptions: () => mutationOptions
25
+ });
26
+ module.exports = __toCommonJS(mutationOptions_exports);
27
+ function mutationOptions(options) {
28
+ return options;
29
+ }
30
+ // Annotate the CommonJS export names for ESM import in node:
31
+ 0 && (module.exports = {
32
+ mutationOptions
33
+ });
34
+ //# sourceMappingURL=mutationOptions.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/mutationOptions.tsx"],"sourcesContent":["import type { UseMutationOptions } from '@tanstack/react-query'\n\n/**\n * @experimental This is experimental feature.\n */\nexport function mutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(\n options: UseMutationOptions<TData, TError, TVariables, TContext>\n): UseMutationOptions<TData, TError, TVariables, TContext> {\n return options\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKO,SAAS,gBACd,SACyD;AACzD,SAAO;AACT;","names":[]}
@@ -0,0 +1,8 @@
1
+ import { UseMutationOptions } from '@tanstack/react-query';
2
+
3
+ /**
4
+ * @experimental This is experimental feature.
5
+ */
6
+ declare function mutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(options: UseMutationOptions<TData, TError, TVariables, TContext>): UseMutationOptions<TData, TError, TVariables, TContext>;
7
+
8
+ export { mutationOptions };
@@ -0,0 +1,8 @@
1
+ import { UseMutationOptions } from '@tanstack/react-query';
2
+
3
+ /**
4
+ * @experimental This is experimental feature.
5
+ */
6
+ declare function mutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(options: UseMutationOptions<TData, TError, TVariables, TContext>): UseMutationOptions<TData, TError, TVariables, TContext>;
7
+
8
+ export { mutationOptions };
@@ -0,0 +1,9 @@
1
+ "use client"
2
+ import {
3
+ mutationOptions
4
+ } from "./chunk-34N4X5NK.js";
5
+ import "./chunk-QETBZSG5.js";
6
+ export {
7
+ mutationOptions
8
+ };
9
+ //# sourceMappingURL=mutationOptions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@suspensive/react-query-4",
3
- "version": "3.0.0-next.11",
3
+ "version": "3.0.0-next.13",
4
4
  "description": "Suspensive interfaces for @tanstack/react-query@4",
5
5
  "keywords": [
6
6
  "suspensive",
package/src/index.ts CHANGED
@@ -17,4 +17,5 @@ export { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery'
17
17
  export { PrefetchQuery } from './PrefetchQuery'
18
18
  export { PrefetchInfiniteQuery } from './PrefetchInfiniteQuery'
19
19
  export { Mutation } from './Mutation'
20
+ export { mutationOptions } from './mutationOptions'
20
21
  export { QueryClientConsumer } from './QueryClientConsumer'
@@ -0,0 +1,35 @@
1
+ import {
2
+ type UseMutateAsyncFunction,
3
+ type UseMutateFunction,
4
+ type UseMutationResult,
5
+ useMutation,
6
+ } from '@tanstack/react-query'
7
+ import { describe, expectTypeOf, it } from 'vitest'
8
+ import { Mutation } from './Mutation'
9
+ import { mutationOptions } from './mutationOptions'
10
+
11
+ const mutationOption = mutationOptions({
12
+ mutationFn: () => Promise.resolve(1),
13
+ onMutate: () => 'onMutation',
14
+ })
15
+
16
+ describe('mutationOptions', () => {
17
+ it('should be used with useMutation', () => {
18
+ const mutation = useMutation(mutationOption)
19
+ expectTypeOf(mutation).toEqualTypeOf<UseMutationResult<number, unknown, void, string>>()
20
+ expectTypeOf(mutation.data).toEqualTypeOf<number | undefined>()
21
+ expectTypeOf(mutation.mutate).toEqualTypeOf<UseMutateFunction<number, unknown, void, string>>()
22
+ expectTypeOf(mutation.mutateAsync).toEqualTypeOf<UseMutateAsyncFunction<number, unknown, void, string>>()
23
+ })
24
+ it('should be used with <Mutation/>', () => {
25
+ ;(() => (
26
+ <Mutation {...mutationOption}>
27
+ {(mutation) => {
28
+ expectTypeOf(mutation).toEqualTypeOf<UseMutationResult<number, unknown, void, string>>()
29
+ expectTypeOf(mutation.data).toEqualTypeOf<number | undefined>()
30
+ return <></>
31
+ }}
32
+ </Mutation>
33
+ ))()
34
+ })
35
+ })
@@ -0,0 +1,10 @@
1
+ import type { UseMutationOptions } from '@tanstack/react-query'
2
+
3
+ /**
4
+ * @experimental This is experimental feature.
5
+ */
6
+ export function mutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(
7
+ options: UseMutationOptions<TData, TError, TVariables, TContext>
8
+ ): UseMutationOptions<TData, TError, TVariables, TContext> {
9
+ return options
10
+ }