@suspensive/react-query-4 3.2.2 → 3.3.0

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.
Files changed (67) hide show
  1. package/dist/SuspenseQueries.cjs +1 -33
  2. package/dist/SuspenseQueries.cjs.map +1 -1
  3. package/dist/SuspenseQueries.d.cts +1 -4
  4. package/dist/SuspenseQueries.d.ts +1 -4
  5. package/dist/SuspenseQueries.js +1 -2
  6. package/dist/SuspenseQuery.cjs +1 -28
  7. package/dist/SuspenseQuery.cjs.map +1 -1
  8. package/dist/SuspenseQuery.d.cts +1 -3
  9. package/dist/SuspenseQuery.d.ts +1 -3
  10. package/dist/SuspenseQuery.js +1 -2
  11. package/dist/{chunk-MMV3JWIQ.js → chunk-7AETAPCD.js} +2 -4
  12. package/dist/chunk-7AETAPCD.js.map +1 -0
  13. package/dist/{chunk-3OKEPIW3.js → chunk-CCIJG25S.js} +1 -1
  14. package/dist/chunk-CCIJG25S.js.map +1 -0
  15. package/dist/{chunk-D5FKB2PY.js → chunk-QYGYB5UC.js} +4 -4
  16. package/dist/chunk-QYGYB5UC.js.map +1 -0
  17. package/dist/chunk-WCKC4M3O.js +12 -0
  18. package/dist/chunk-WCKC4M3O.js.map +1 -0
  19. package/dist/chunk-YFVQ7O2B.js +12 -0
  20. package/dist/chunk-YFVQ7O2B.js.map +1 -0
  21. package/dist/chunk-Z4ML33QN.js +10 -0
  22. package/dist/chunk-Z4ML33QN.js.map +1 -0
  23. package/dist/index.cjs +20 -36
  24. package/dist/index.cjs.map +1 -1
  25. package/dist/index.js +10 -10
  26. package/dist/infiniteQueryOptions.cjs.map +1 -1
  27. package/dist/infiniteQueryOptions.d.cts +6 -0
  28. package/dist/infiniteQueryOptions.d.ts +6 -0
  29. package/dist/infiniteQueryOptions.js +1 -1
  30. package/dist/queryOptions.cjs +2 -3
  31. package/dist/queryOptions.cjs.map +1 -1
  32. package/dist/queryOptions.d.cts +15 -7
  33. package/dist/queryOptions.d.ts +15 -7
  34. package/dist/queryOptions.js +1 -1
  35. package/dist/useSuspenseQueries.cjs +1 -28
  36. package/dist/useSuspenseQueries.cjs.map +1 -1
  37. package/dist/useSuspenseQueries.d.cts +25 -46
  38. package/dist/useSuspenseQueries.d.ts +25 -46
  39. package/dist/useSuspenseQueries.js +1 -1
  40. package/dist/useSuspenseQuery.cjs +1 -25
  41. package/dist/useSuspenseQuery.cjs.map +1 -1
  42. package/dist/useSuspenseQuery.d.cts +29 -10
  43. package/dist/useSuspenseQuery.d.ts +29 -10
  44. package/dist/useSuspenseQuery.js +1 -1
  45. package/package.json +5 -5
  46. package/src/PrefetchQuery.test-d.tsx +1 -1
  47. package/src/SuspenseQueries.test-d.tsx +1 -3
  48. package/src/SuspenseQueries.tsx +1 -1
  49. package/src/SuspenseQuery.test-d.tsx +5 -6
  50. package/src/SuspenseQuery.tsx +6 -2
  51. package/src/infiniteQueryOptions.ts +6 -0
  52. package/src/queryOptions.test-d.tsx +25 -15
  53. package/src/queryOptions.ts +15 -26
  54. package/src/usePrefetchQuery.test-d.tsx +1 -1
  55. package/src/useSuspenseQueries.test-d.ts +4 -6
  56. package/src/useSuspenseQueries.ts +29 -114
  57. package/src/useSuspenseQuery.test-d.ts +5 -6
  58. package/src/useSuspenseQuery.ts +33 -32
  59. package/dist/chunk-3E4WCXHQ.js +0 -21
  60. package/dist/chunk-3E4WCXHQ.js.map +0 -1
  61. package/dist/chunk-3OKEPIW3.js.map +0 -1
  62. package/dist/chunk-D5FKB2PY.js.map +0 -1
  63. package/dist/chunk-MMV3JWIQ.js.map +0 -1
  64. package/dist/chunk-NIWB6JKL.js +0 -24
  65. package/dist/chunk-NIWB6JKL.js.map +0 -1
  66. package/dist/chunk-UVSCLLGR.js +0 -11
  67. package/dist/chunk-UVSCLLGR.js.map +0 -1
@@ -1,21 +0,0 @@
1
- "use client"
2
- import {
3
- __spreadProps,
4
- __spreadValues
5
- } from "./chunk-QETBZSG5.js";
6
-
7
- // src/useSuspenseQuery.ts
8
- import { useQuery } from "@tanstack/react-query";
9
- function useSuspenseQuery(options) {
10
- return useQuery(__spreadProps(__spreadValues({}, options), {
11
- enabled: true,
12
- useErrorBoundary: true,
13
- suspense: true,
14
- networkMode: "always"
15
- }));
16
- }
17
-
18
- export {
19
- useSuspenseQuery
20
- };
21
- //# sourceMappingURL=chunk-3E4WCXHQ.js.map
@@ -1 +0,0 @@
1
- {"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' | '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"],"mappings":";;;;;;;AAAA,SAAmE,gBAAgB;AAuB5E,SAAS,iBAKd,SAA0E;AAC1E,SAAO,SAAiD,iCACnD,UADmD;AAAA,IAEtD,SAAS;AAAA,IACT,kBAAkB;AAAA,IAClB,UAAU;AAAA,IACV,aAAa;AAAA,EACf,EAAC;AACH;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/infiniteQueryOptions.ts"],"sourcesContent":["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"],"mappings":";;;AAyEO,SAAS,qBAAqB,SAAkB;AACrD,SAAO;AACT;","names":[]}
@@ -1 +0,0 @@
1
- {"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/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":[]}
@@ -1 +0,0 @@
1
- {"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/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":[]}
@@ -1,24 +0,0 @@
1
- "use client"
2
- import {
3
- __spreadProps,
4
- __spreadValues
5
- } from "./chunk-QETBZSG5.js";
6
-
7
- // src/useSuspenseQueries.ts
8
- import { useQueries } from "@tanstack/react-query";
9
- function useSuspenseQueries({
10
- queries,
11
- context
12
- }) {
13
- return useQueries({
14
- queries: queries.map((query) => __spreadProps(__spreadValues({}, query), {
15
- suspense: true
16
- })),
17
- context
18
- });
19
- }
20
-
21
- export {
22
- useSuspenseQueries
23
- };
24
- //# sourceMappingURL=chunk-NIWB6JKL.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/useSuspenseQueries.ts"],"sourcesContent":["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"],"mappings":";;;;;;;AAAA,SAAmD,kBAAkB;AAmH9D,SAAS,mBAAoC;AAAA,EAClD;AAAA,EACA;AACF,GAG8B;AAC5B,SAAO,WAAW;AAAA,IAChB,SAAS,QAAQ,IAAI,CAAC,UAA2B,iCAE5C,QAF4C;AAAA,MAG/C,UAAU;AAAA,IACZ,EAAE;AAAA,IACF;AAAA,EACF,CAAC;AACH;","names":[]}
@@ -1,11 +0,0 @@
1
- "use client"
2
-
3
- // src/queryOptions.ts
4
- function queryOptions(options) {
5
- return options;
6
- }
7
-
8
- export {
9
- queryOptions
10
- };
11
- //# sourceMappingURL=chunk-UVSCLLGR.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/queryOptions.ts"],"sourcesContent":["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"],"mappings":";;;AAmFO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;","names":[]}