@suspensive/react-query-4 2.18.5 → 2.18.6

package/src/queryOptions.ts

@@ -55,6 +55,12 @@ export type UnSelectedQueryOptions<
   select?: undefined
 }
 
+/**
+ * Creates a reusable query options object that can be used across different query hooks.
+ * Provides better type inference and easier query key management.
+ *
+ * @see {@link https://suspensive.org/docs/react-query/queryOptions Suspensive Docs}
+ */
 export function queryOptions<
   TQueryFnData = unknown,
   TError = unknown,

package/src/usePrefetchInfiniteQuery.ts

@@ -1,8 +1,8 @@
 import { type FetchInfiniteQueryOptions, type QueryKey, useQueryClient } from '@tanstack/react-query'
 
 /**
- * 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.
- * @see {@link https://suspensive.org/en/docs/react-query/usePrefetchInfiniteQuery Suspensive Docs}
+ * 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`.
+ * @see {@link https://suspensive.org/docs/react-query/usePrefetchInfiniteQuery Suspensive Docs}
  */
 export function usePrefetchInfiniteQuery<
   TQueryFnData = unknown,

package/src/usePrefetchQuery.ts

@@ -1,8 +1,8 @@
 import { type FetchQueryOptions, type QueryKey, useQueryClient } from '@tanstack/react-query'
 
 /**
- * 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.
- * @see {@link https://suspensive.org/en/docs/react-query/usePrefetchQuery Suspensive Docs}
+ * 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`.
+ * @see {@link https://suspensive.org/docs/react-query/usePrefetchQuery Suspensive Docs}
  */
 export function usePrefetchQuery<
   TQueryFnData = unknown,

package/src/useSuspenseInfiniteQuery.ts

@@ -27,8 +27,8 @@ export type UseSuspenseInfiniteQueryOptions<
 >
 
 /**
- * This hook is wrapping useInfiniteQuery of `@tanstack/react-query` v4 with default suspense option.
- * @see {@link https://suspensive.org/en/docs/react-query/useSuspenseInfiniteQuery Suspensive Docs}
+ * This hook is wrapping `useInfiniteQuery` of `@tanstack/react-query` v4 with default suspense option.
+ * @see {@link https://suspensive.org/docs/react-query/useSuspenseInfiniteQuery Suspensive Docs}
  */
 export function useSuspenseInfiniteQuery<
   TQueryFnData = unknown,

package/src/useSuspenseQueries.ts

@@ -110,8 +110,8 @@ export type SuspenseQueriesResults<
             Array<UseSuspenseQueryResult>
 
 /**
- * This hook is wrapping useQueries of `@tanstack/react-query` v4 with default suspense option.
- * @see {@link https://suspensive.org/en/docs/react-query/useSuspenseQueries Suspensive Docs}
+ * This hook is wrapping `useQueries` of `@tanstack/react-query` v4 with default suspense option.
+ * @see {@link https://suspensive.org/docs/react-query/useSuspenseQueries Suspensive Docs}
  */
 export function useSuspenseQueries<T extends any[]>({
   queries,

package/src/useSuspenseQuery.ts

@@ -18,8 +18,8 @@ export type UseSuspenseQueryOptions<
 >
 
 /**
- * This hook is wrapping useQuery of `@tanstack/react-query` v4 with default suspense option.
- * @see {@link https://suspensive.org/en/docs/react-query/useSuspenseQuery Suspensive Docs}
+ * This hook is wrapping `useQuery` of `@tanstack/react-query` v4 with default suspense option.
+ * @see {@link https://suspensive.org/docs/react-query/useSuspenseQuery Suspensive Docs}
  */
 export function useSuspenseQuery<
   TQueryFnData = unknown,

package/dist/chunk-23KTCH3O.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/PrefetchInfiniteQuery.tsx"],"sourcesContent":["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/en/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"],"mappings":";;;;;;AAkBS;AAPF,SAAS,sBAKd,SAA4E;AAC5E,2BAAyB,OAAO;AAChC,SAAO,gCAAE;AACX;","names":[]}

package/dist/chunk-BATIZYKY.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/SuspenseInfiniteQuery.tsx"],"sourcesContent":["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/en/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"],"mappings":";;;;;;;;;AAkCM;AAVC,IAAM,wBAAwB,CAKnC,OAKC;AALD,eACA;AAAA;AAAA,EA9BF,IA6BE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,yCAAG,mBAAS,yBAAyB,OAAO,CAAC,GAAE;AAAA;","names":[]}

package/dist/chunk-DG465QGB.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/useSuspenseQuery.ts"],"sourcesContent":["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'\n>\n\n/**\n * This hook is wrapping useQuery of `@tanstack/react-query` v4 with default suspense option.\n * @see {@link https://suspensive.org/en/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  }) as UseSuspenseQueryResult<TData, TError>\n}\n"],"mappings":";;;;;;;AAAA,SAAmE,gBAAgB;AAuB5E,SAAS,iBAKd,SAA0E;AAC1E,SAAO,SAAiD,iCACnD,UADmD;AAAA,IAEtD,SAAS;AAAA,IACT,kBAAkB;AAAA,IAClB,UAAU;AAAA,EACZ,EAAC;AACH;","names":[]}

package/dist/chunk-M3WE7YQL.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/SuspenseQuery.tsx"],"sourcesContent":["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/en/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"],"mappings":";;;;;;;;;AA8BM;AAVC,IAAM,gBAAgB,CAK3B,OAKC;AALD,eACA;AAAA;AAAA,EA1BF,IAyBE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,yCAAG,mBAAS,iBAAiB,OAAO,CAAC,GAAE;AAAA;","names":[]}

package/dist/chunk-RH37KNQI.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/SuspenseQueries.tsx"],"sourcesContent":["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/en/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"],"mappings":";;;;;;AAyBS;AAPF,SAAS,gBAAiC;AAAA,EAC/C;AAAA,EACA;AACF,GAGG;AACD,SAAO,gCAAG,mBAAS,mBAAmB,EAAE,QAAQ,CAAC,CAAC,GAAE;AACtD;","names":[]}

package/dist/chunk-SKFNGOLA.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/usePrefetchQuery.ts"],"sourcesContent":["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/en/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"],"mappings":";;;AAAA,SAAgD,sBAAsB;AAM/D,SAAS,iBAKd,SAAoE;AACpE,QAAM,cAAc,eAAe;AAEnC,MAAI,OAAO,QAAQ,aAAa,eAAe,CAAC,YAAY,cAAc,QAAQ,QAAQ,GAAG;AAC3F,gBAAY,cAAc,OAAO;AAAA,EACnC;AACF;","names":[]}

package/dist/chunk-SVNRMWGF.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/PrefetchQuery.tsx"],"sourcesContent":["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/en/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"],"mappings":";;;;;;AAkBS;AAPF,SAAS,cAKd,SAAoE;AACpE,mBAAiB,OAAO;AACxB,SAAO,gCAAE;AACX;","names":[]}

package/dist/chunk-YVDW7PFY.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/usePrefetchInfiniteQuery.ts"],"sourcesContent":["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/en/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"],"mappings":";;;AAAA,SAAwD,sBAAsB;AAMvE,SAAS,yBAKd,SAA4E;AAC5E,QAAM,cAAc,eAAe;AAEnC,MAAI,OAAO,QAAQ,aAAa,eAAe,CAAC,YAAY,cAAc,QAAQ,QAAQ,GAAG;AAC3F,gBAAY,sBAAsB,OAAO;AAAA,EAC3C;AACF;","names":[]}