@suspensive/react-query-4 2.5.1 → 2.6.1
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.
- package/dist/RequiredKeyof-CHKtWddC.d.cts +5 -0
- package/dist/RequiredKeyof-CHKtWddC.d.ts +5 -0
- package/dist/chunk-BFNN3IPQ.js +11 -0
- package/dist/chunk-BFNN3IPQ.js.map +1 -0
- package/dist/index.cjs +7 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +7 -3
- package/dist/infiniteQueryOptions.cjs +34 -0
- package/dist/infiniteQueryOptions.cjs.map +1 -0
- package/dist/infiniteQueryOptions.d.cts +20 -0
- package/dist/infiniteQueryOptions.d.ts +20 -0
- package/dist/infiniteQueryOptions.js +9 -0
- package/dist/infiniteQueryOptions.js.map +1 -0
- package/dist/queryOptions.d.cts +1 -4
- package/dist/queryOptions.d.ts +1 -4
- package/package.json +4 -7
- package/src/SuspenseInfiniteQuery.test-d.tsx +34 -0
- package/src/SuspenseQueries.test-d.tsx +2 -6
- package/src/SuspenseQuery.test-d.tsx +29 -0
- package/src/index.ts +1 -0
- package/src/infiniteQueryOptions.test-d.tsx +94 -0
- package/src/infiniteQueryOptions.ts +83 -0
- package/src/useSuspenseInfiniteQuery.test-d.ts +22 -0
- package/src/useSuspenseQuery.test-d.ts +19 -0
|
@@ -0,0 +1 @@
|
|
|
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\ntype 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 >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: InfiniteData<TQueryFnData>) => InfiniteData<TData>\n}\n\ntype 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 >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\n\n/**\n * @experimental This is experimental feature.\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\n/**\n * @experimental This is experimental feature.\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\n/**\n * @experimental This is experimental feature.\n */\nexport function infiniteQueryOptions(options: unknown) {\n return options\n}\n"],"mappings":";;;AAgFO,SAAS,qBAAqB,SAAkB;AACrD,SAAO;AACT;","names":[]}
|
package/dist/index.cjs
CHANGED
|
@@ -54,6 +54,7 @@ __export(src_exports, {
|
|
|
54
54
|
SuspenseInfiniteQuery: () => SuspenseInfiniteQuery,
|
|
55
55
|
SuspenseQueries: () => SuspenseQueries,
|
|
56
56
|
SuspenseQuery: () => SuspenseQuery,
|
|
57
|
+
infiniteQueryOptions: () => infiniteQueryOptions,
|
|
57
58
|
queryOptions: () => queryOptions,
|
|
58
59
|
useSuspenseInfiniteQuery: () => useSuspenseInfiniteQuery,
|
|
59
60
|
useSuspenseQueries: () => useSuspenseQueries,
|
|
@@ -66,6 +67,11 @@ function queryOptions(options) {
|
|
|
66
67
|
return options;
|
|
67
68
|
}
|
|
68
69
|
|
|
70
|
+
// src/infiniteQueryOptions.ts
|
|
71
|
+
function infiniteQueryOptions(options) {
|
|
72
|
+
return options;
|
|
73
|
+
}
|
|
74
|
+
|
|
69
75
|
// src/useSuspenseQuery.ts
|
|
70
76
|
var import_react_query = require("@tanstack/react-query");
|
|
71
77
|
function useSuspenseQuery(options) {
|
|
@@ -157,6 +163,7 @@ if (process.env.NODE_ENV === "development") {
|
|
|
157
163
|
SuspenseInfiniteQuery,
|
|
158
164
|
SuspenseQueries,
|
|
159
165
|
SuspenseQuery,
|
|
166
|
+
infiniteQueryOptions,
|
|
160
167
|
queryOptions,
|
|
161
168
|
useSuspenseInfiniteQuery,
|
|
162
169
|
useSuspenseQueries,
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/queryOptions.ts","../src/useSuspenseQuery.ts","../src/SuspenseQuery.tsx","../src/useSuspenseQueries.ts","../src/SuspenseQueries.tsx","../src/useSuspenseInfiniteQuery.ts","../src/SuspenseInfiniteQuery.tsx","../src/QueryErrorBoundary.tsx"],"sourcesContent":["export { queryOptions } from './queryOptions'\nexport { SuspenseQuery } from './SuspenseQuery'\nexport { SuspenseQueries } from './SuspenseQueries'\nexport { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery'\n\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'\n\nexport { QueryErrorBoundary } from './QueryErrorBoundary'\n","import type { QueryKey, UseQueryOptions } from '@tanstack/react-query'\nimport type { OmitKeyof, RequiredKeyof } from './utility-types'\n\ntype 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 >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: TQueryFnData) => TData\n}\n\ntype 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 >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\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>\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>\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options:\n | SelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n | UnSelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n) {\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 interface UseSuspenseQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> extends 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/docs/react-query/useSuspenseQuery}\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","import type { QueryKey } from '@tanstack/react-query'\nimport type { ReactNode } from 'react'\nimport { type UseSuspenseQueryOptions, type UseSuspenseQueryResult, useSuspenseQuery } from './useSuspenseQuery'\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 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}\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) => ({ ...query, suspense: true })),\n context,\n }) as SuspenseQueriesResults<T>\n}\n","import type { ReactNode } from 'react'\nimport { type SuspenseQueriesOptions, type SuspenseQueriesResults, useSuspenseQueries } from './useSuspenseQueries'\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 {\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 interface UseSuspenseInfiniteQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> extends OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData'\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}\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 }) as UseSuspenseInfiniteQueryResult<TData, TError>\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\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 { ErrorBoundary } from '@suspensive/react'\nimport { useQueryErrorResetBoundary } from '@tanstack/react-query'\nimport { type ComponentPropsWithoutRef, type ComponentRef, forwardRef } from 'react'\n\n/**\n * This component wrapping QueryErrorResetBoundary of `@tanstack/react-query` with `@suspensive/react`'s ErrorBoundary. So you must install `@suspensive/react` first, then use it. with this component, You don't have to make unnecessary repetitive implementation to combine ErrorBoundary with QueryErrorResetBoundary\n * @see {@link https://suspensive.org/docs/react-query/QueryErrorBoundary}\n */\nexport const QueryErrorBoundary = forwardRef<\n ComponentRef<typeof ErrorBoundary>,\n ComponentPropsWithoutRef<typeof ErrorBoundary>\n>(({ onReset, ...props }, resetRef) => {\n const { reset } = useQueryErrorResetBoundary()\n return (\n <ErrorBoundary\n {...props}\n onReset={() => {\n onReset?.()\n reset()\n }}\n ref={resetRef}\n />\n )\n})\nif (process.env.NODE_ENV === 'development') {\n QueryErrorBoundary.displayName = 'QueryErrorBoundary'\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACyEO,SAAS,aAMd,SAGA;AACA,SAAO;AACT;;;ACpFA,yBAAmF;AAuB5E,SAAS,iBAKd,SAA0E;AAC1E,aAAO,6BAAiD,iCACnD,UADmD;AAAA,IAEtD,SAAS;AAAA,IACT,kBAAkB;AAAA,IAClB,UAAU;AAAA,EACZ,EAAC;AACH;;;ACrBM;AAVC,IAAM,gBAAgB,CAK3B,OAKC;AALD,eACA;AAAA;AAAA,EAVF,IASE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,oFAAG,mBAAS,iBAAiB,OAAO,CAAC,GAAE;AAAA;;;ACd7C,IAAAA,sBAAqE;AAmH9D,SAAS,mBAAoC;AAAA,EAClD;AAAA,EACA;AACF,GAG8B;AAC5B,aAAO,gCAAW;AAAA,IAChB,SAAS,QAAQ,IAAI,CAAC,UAA2B,iCAAK,QAAL,EAAY,UAAU,KAAK,EAAE;AAAA,IAC9E;AAAA,EACF,CAAC;AACH;;;ACpHS,IAAAC,sBAAA;AAPF,SAAS,gBAAiC;AAAA,EAC/C;AAAA,EACA;AACF,GAGG;AACD,SAAO,6EAAG,mBAAS,mBAAmB,EAAE,QAAQ,CAAC,CAAC,GAAE;AACtD;;;ACXA,IAAAC,sBAMO;AA0BA,SAAS,yBAMd,SAC+C;AAC/C,aAAO,sCAAiB,iCACnB,UADmB;AAAA,IAEtB,SAAS;AAAA,IACT,UAAU;AAAA,IACV,kBAAkB;AAAA,EACpB,EAAC;AACH;;;AC5BM,IAAAC,sBAAA;AAVC,IAAM,wBAAwB,CAKnC,OAKC;AALD,eACA;AAAA;AAAA,EAdF,IAaE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,sFAAG,mBAAS,yBAAyB,OAAO,CAAC,GAAE;AAAA;;;AClBrD,mBAA8B;AAC9B,IAAAC,sBAA2C;AAC3C,IAAAC,gBAA6E;AAYzE,IAAAC,sBAAA;AANG,IAAM,yBAAqB,0BAGhC,CAAC,IAAuB,aAAa;AAApC,eAAE,UAXL,IAWG,IAAc,kBAAd,IAAc,CAAZ;AACH,QAAM,EAAE,MAAM,QAAI,gDAA2B;AAC7C,SACE;AAAA,IAAC;AAAA,qCACK,QADL;AAAA,MAEC,SAAS,MAAM;AACb;AACA,cAAM;AAAA,MACR;AAAA,MACA,KAAK;AAAA;AAAA,EACP;AAEJ,CAAC;AACD,IAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,qBAAmB,cAAc;AACnC;","names":["import_react_query","import_jsx_runtime","import_react_query","import_jsx_runtime","import_react_query","import_react","import_jsx_runtime"]}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/queryOptions.ts","../src/infiniteQueryOptions.ts","../src/useSuspenseQuery.ts","../src/SuspenseQuery.tsx","../src/useSuspenseQueries.ts","../src/SuspenseQueries.tsx","../src/useSuspenseInfiniteQuery.ts","../src/SuspenseInfiniteQuery.tsx","../src/QueryErrorBoundary.tsx"],"sourcesContent":["export { queryOptions } from './queryOptions'\nexport { infiniteQueryOptions } from './infiniteQueryOptions'\nexport { SuspenseQuery } from './SuspenseQuery'\nexport { SuspenseQueries } from './SuspenseQueries'\nexport { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery'\n\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'\n\nexport { QueryErrorBoundary } from './QueryErrorBoundary'\n","import type { QueryKey, UseQueryOptions } from '@tanstack/react-query'\nimport type { OmitKeyof, RequiredKeyof } from './utility-types'\n\ntype 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 >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: TQueryFnData) => TData\n}\n\ntype 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 >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\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>\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>\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options:\n | SelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n | UnSelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n) {\n return options\n}\n","import type { InfiniteData, QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query'\nimport type { OmitKeyof, RequiredKeyof } from './utility-types'\n\ntype 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 >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: InfiniteData<TQueryFnData>) => InfiniteData<TData>\n}\n\ntype 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 >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\n\n/**\n * @experimental This is experimental feature.\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\n/**\n * @experimental This is experimental feature.\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\n/**\n * @experimental This is experimental feature.\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 interface UseSuspenseQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> extends 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/docs/react-query/useSuspenseQuery}\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","import type { QueryKey } from '@tanstack/react-query'\nimport type { ReactNode } from 'react'\nimport { type UseSuspenseQueryOptions, type UseSuspenseQueryResult, useSuspenseQuery } from './useSuspenseQuery'\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 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}\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) => ({ ...query, suspense: true })),\n context,\n }) as SuspenseQueriesResults<T>\n}\n","import type { ReactNode } from 'react'\nimport { type SuspenseQueriesOptions, type SuspenseQueriesResults, useSuspenseQueries } from './useSuspenseQueries'\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 {\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 interface UseSuspenseInfiniteQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> extends OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData'\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}\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 }) as UseSuspenseInfiniteQueryResult<TData, TError>\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\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 { ErrorBoundary } from '@suspensive/react'\nimport { useQueryErrorResetBoundary } from '@tanstack/react-query'\nimport { type ComponentPropsWithoutRef, type ComponentRef, forwardRef } from 'react'\n\n/**\n * This component wrapping QueryErrorResetBoundary of `@tanstack/react-query` with `@suspensive/react`'s ErrorBoundary. So you must install `@suspensive/react` first, then use it. with this component, You don't have to make unnecessary repetitive implementation to combine ErrorBoundary with QueryErrorResetBoundary\n * @see {@link https://suspensive.org/docs/react-query/QueryErrorBoundary}\n */\nexport const QueryErrorBoundary = forwardRef<\n ComponentRef<typeof ErrorBoundary>,\n ComponentPropsWithoutRef<typeof ErrorBoundary>\n>(({ onReset, ...props }, resetRef) => {\n const { reset } = useQueryErrorResetBoundary()\n return (\n <ErrorBoundary\n {...props}\n onReset={() => {\n onReset?.()\n reset()\n }}\n ref={resetRef}\n />\n )\n})\nif (process.env.NODE_ENV === 'development') {\n QueryErrorBoundary.displayName = 'QueryErrorBoundary'\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACyEO,SAAS,aAMd,SAGA;AACA,SAAO;AACT;;;ACJO,SAAS,qBAAqB,SAAkB;AACrD,SAAO;AACT;;;AClFA,yBAAmF;AAuB5E,SAAS,iBAKd,SAA0E;AAC1E,aAAO,6BAAiD,iCACnD,UADmD;AAAA,IAEtD,SAAS;AAAA,IACT,kBAAkB;AAAA,IAClB,UAAU;AAAA,EACZ,EAAC;AACH;;;ACrBM;AAVC,IAAM,gBAAgB,CAK3B,OAKC;AALD,eACA;AAAA;AAAA,EAVF,IASE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,oFAAG,mBAAS,iBAAiB,OAAO,CAAC,GAAE;AAAA;;;ACd7C,IAAAA,sBAAqE;AAmH9D,SAAS,mBAAoC;AAAA,EAClD;AAAA,EACA;AACF,GAG8B;AAC5B,aAAO,gCAAW;AAAA,IAChB,SAAS,QAAQ,IAAI,CAAC,UAA2B,iCAAK,QAAL,EAAY,UAAU,KAAK,EAAE;AAAA,IAC9E;AAAA,EACF,CAAC;AACH;;;ACpHS,IAAAC,sBAAA;AAPF,SAAS,gBAAiC;AAAA,EAC/C;AAAA,EACA;AACF,GAGG;AACD,SAAO,6EAAG,mBAAS,mBAAmB,EAAE,QAAQ,CAAC,CAAC,GAAE;AACtD;;;ACXA,IAAAC,sBAMO;AA0BA,SAAS,yBAMd,SAC+C;AAC/C,aAAO,sCAAiB,iCACnB,UADmB;AAAA,IAEtB,SAAS;AAAA,IACT,UAAU;AAAA,IACV,kBAAkB;AAAA,EACpB,EAAC;AACH;;;AC5BM,IAAAC,sBAAA;AAVC,IAAM,wBAAwB,CAKnC,OAKC;AALD,eACA;AAAA;AAAA,EAdF,IAaE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,sFAAG,mBAAS,yBAAyB,OAAO,CAAC,GAAE;AAAA;;;AClBrD,mBAA8B;AAC9B,IAAAC,sBAA2C;AAC3C,IAAAC,gBAA6E;AAYzE,IAAAC,sBAAA;AANG,IAAM,yBAAqB,0BAGhC,CAAC,IAAuB,aAAa;AAApC,eAAE,UAXL,IAWG,IAAc,kBAAd,IAAc,CAAZ;AACH,QAAM,EAAE,MAAM,QAAI,gDAA2B;AAC7C,SACE;AAAA,IAAC;AAAA,qCACK,QADL;AAAA,MAEC,SAAS,MAAM;AACb;AACA,cAAM;AAAA,MACR;AAAA,MACA,KAAK;AAAA;AAAA,EACP;AAEJ,CAAC;AACD,IAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,qBAAmB,cAAc;AACnC;","names":["import_react_query","import_jsx_runtime","import_react_query","import_jsx_runtime","import_react_query","import_react","import_jsx_runtime"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { queryOptions } from './queryOptions.cjs';
|
|
2
|
+
export { infiniteQueryOptions } from './infiniteQueryOptions.cjs';
|
|
2
3
|
export { SuspenseQuery } from './SuspenseQuery.cjs';
|
|
3
4
|
export { SuspenseQueries } from './SuspenseQueries.cjs';
|
|
4
5
|
export { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery.cjs';
|
|
@@ -8,6 +9,7 @@ export { UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult, useSus
|
|
|
8
9
|
export { QueryErrorBoundary } from './QueryErrorBoundary.cjs';
|
|
9
10
|
import '@tanstack/react-query';
|
|
10
11
|
import './OmitKeyof-CFsZLI4k.cjs';
|
|
12
|
+
import './RequiredKeyof-CHKtWddC.cjs';
|
|
11
13
|
import 'react/jsx-runtime';
|
|
12
14
|
import 'react';
|
|
13
15
|
import '@suspensive/react';
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { queryOptions } from './queryOptions.js';
|
|
2
|
+
export { infiniteQueryOptions } from './infiniteQueryOptions.js';
|
|
2
3
|
export { SuspenseQuery } from './SuspenseQuery.js';
|
|
3
4
|
export { SuspenseQueries } from './SuspenseQueries.js';
|
|
4
5
|
export { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery.js';
|
|
@@ -8,6 +9,7 @@ export { UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult, useSus
|
|
|
8
9
|
export { QueryErrorBoundary } from './QueryErrorBoundary.js';
|
|
9
10
|
import '@tanstack/react-query';
|
|
10
11
|
import './OmitKeyof-CFsZLI4k.js';
|
|
12
|
+
import './RequiredKeyof-CHKtWddC.js';
|
|
11
13
|
import 'react/jsx-runtime';
|
|
12
14
|
import 'react';
|
|
13
15
|
import '@suspensive/react';
|
package/dist/index.js
CHANGED
|
@@ -8,27 +8,31 @@ import {
|
|
|
8
8
|
import {
|
|
9
9
|
SuspenseQueries
|
|
10
10
|
} from "./chunk-HJAGY6R3.js";
|
|
11
|
+
import {
|
|
12
|
+
useSuspenseQueries
|
|
13
|
+
} from "./chunk-S7L2LUVS.js";
|
|
11
14
|
import {
|
|
12
15
|
SuspenseQuery
|
|
13
16
|
} from "./chunk-VZUIX5KZ.js";
|
|
14
17
|
import {
|
|
15
18
|
useSuspenseQuery
|
|
16
19
|
} from "./chunk-J3EHCRU6.js";
|
|
20
|
+
import {
|
|
21
|
+
infiniteQueryOptions
|
|
22
|
+
} from "./chunk-BFNN3IPQ.js";
|
|
17
23
|
import {
|
|
18
24
|
queryOptions
|
|
19
25
|
} from "./chunk-6NEAC47I.js";
|
|
20
26
|
import {
|
|
21
27
|
useSuspenseInfiniteQuery
|
|
22
28
|
} from "./chunk-3B63MBHY.js";
|
|
23
|
-
import {
|
|
24
|
-
useSuspenseQueries
|
|
25
|
-
} from "./chunk-S7L2LUVS.js";
|
|
26
29
|
import "./chunk-QETBZSG5.js";
|
|
27
30
|
export {
|
|
28
31
|
QueryErrorBoundary,
|
|
29
32
|
SuspenseInfiniteQuery,
|
|
30
33
|
SuspenseQueries,
|
|
31
34
|
SuspenseQuery,
|
|
35
|
+
infiniteQueryOptions,
|
|
32
36
|
queryOptions,
|
|
33
37
|
useSuspenseInfiniteQuery,
|
|
34
38
|
useSuspenseQueries,
|
|
@@ -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/infiniteQueryOptions.ts
|
|
22
|
+
var infiniteQueryOptions_exports = {};
|
|
23
|
+
__export(infiniteQueryOptions_exports, {
|
|
24
|
+
infiniteQueryOptions: () => infiniteQueryOptions
|
|
25
|
+
});
|
|
26
|
+
module.exports = __toCommonJS(infiniteQueryOptions_exports);
|
|
27
|
+
function infiniteQueryOptions(options) {
|
|
28
|
+
return options;
|
|
29
|
+
}
|
|
30
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
31
|
+
0 && (module.exports = {
|
|
32
|
+
infiniteQueryOptions
|
|
33
|
+
});
|
|
34
|
+
//# sourceMappingURL=infiniteQueryOptions.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
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\ntype 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 >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: InfiniteData<TQueryFnData>) => InfiniteData<TData>\n}\n\ntype 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 >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\n\n/**\n * @experimental This is experimental feature.\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\n/**\n * @experimental This is experimental feature.\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\n/**\n * @experimental This is experimental feature.\n */\nexport function infiniteQueryOptions(options: unknown) {\n return options\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAgFO,SAAS,qBAAqB,SAAkB;AACrD,SAAO;AACT;","names":[]}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { InfiniteData, QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query';
|
|
2
|
+
import { O as OmitKeyof } from './OmitKeyof-CFsZLI4k.cjs';
|
|
3
|
+
import { R as RequiredKeyof } from './RequiredKeyof-CHKtWddC.cjs';
|
|
4
|
+
|
|
5
|
+
type SelectedInfiniteOptions<TQueryFnData, TError = unknown, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey> = RequiredKeyof<OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'queryKeyHashFn' | '_defaulted' | 'behavior' | 'structuralSharing' | 'isDataEqual' | 'onSuccess' | 'onError' | 'onSettled' | 'enabled' | 'refetchInterval' | 'initialData'>, 'queryKey' | 'queryFn'> & {
|
|
6
|
+
select: (data: InfiniteData<TQueryFnData>) => InfiniteData<TData>;
|
|
7
|
+
};
|
|
8
|
+
type UnSelectedInfiniteOptions<TQueryFnData, TError = unknown, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey> = RequiredKeyof<OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'queryKeyHashFn' | '_defaulted' | 'behavior' | 'structuralSharing' | 'isDataEqual' | 'onSuccess' | 'onError' | 'onSettled' | 'enabled' | 'refetchInterval' | 'initialData'>, 'queryKey' | 'queryFn'> & {
|
|
9
|
+
select?: undefined;
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* @experimental This is experimental feature.
|
|
13
|
+
*/
|
|
14
|
+
declare function infiniteQueryOptions<TQueryFnData, TError = unknown, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey>(options: SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>): SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
15
|
+
/**
|
|
16
|
+
* @experimental This is experimental feature.
|
|
17
|
+
*/
|
|
18
|
+
declare function infiniteQueryOptions<TQueryFnData, TError = unknown, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey>(options: UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>): UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
19
|
+
|
|
20
|
+
export { infiniteQueryOptions };
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { InfiniteData, QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query';
|
|
2
|
+
import { O as OmitKeyof } from './OmitKeyof-CFsZLI4k.js';
|
|
3
|
+
import { R as RequiredKeyof } from './RequiredKeyof-CHKtWddC.js';
|
|
4
|
+
|
|
5
|
+
type SelectedInfiniteOptions<TQueryFnData, TError = unknown, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey> = RequiredKeyof<OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'queryKeyHashFn' | '_defaulted' | 'behavior' | 'structuralSharing' | 'isDataEqual' | 'onSuccess' | 'onError' | 'onSettled' | 'enabled' | 'refetchInterval' | 'initialData'>, 'queryKey' | 'queryFn'> & {
|
|
6
|
+
select: (data: InfiniteData<TQueryFnData>) => InfiniteData<TData>;
|
|
7
|
+
};
|
|
8
|
+
type UnSelectedInfiniteOptions<TQueryFnData, TError = unknown, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey> = RequiredKeyof<OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'queryKeyHashFn' | '_defaulted' | 'behavior' | 'structuralSharing' | 'isDataEqual' | 'onSuccess' | 'onError' | 'onSettled' | 'enabled' | 'refetchInterval' | 'initialData'>, 'queryKey' | 'queryFn'> & {
|
|
9
|
+
select?: undefined;
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* @experimental This is experimental feature.
|
|
13
|
+
*/
|
|
14
|
+
declare function infiniteQueryOptions<TQueryFnData, TError = unknown, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey>(options: SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>): SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
15
|
+
/**
|
|
16
|
+
* @experimental This is experimental feature.
|
|
17
|
+
*/
|
|
18
|
+
declare function infiniteQueryOptions<TQueryFnData, TError = unknown, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey>(options: UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>): UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
19
|
+
|
|
20
|
+
export { infiniteQueryOptions };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|
package/dist/queryOptions.d.cts
CHANGED
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
import { QueryKey, UseQueryOptions } from '@tanstack/react-query';
|
|
2
2
|
import { O as OmitKeyof } from './OmitKeyof-CFsZLI4k.cjs';
|
|
3
|
-
|
|
4
|
-
type RequiredKeyof<T, TKey extends keyof T> = T & {
|
|
5
|
-
[_ in TKey]: Record<never, never>;
|
|
6
|
-
};
|
|
3
|
+
import { R as RequiredKeyof } from './RequiredKeyof-CHKtWddC.cjs';
|
|
7
4
|
|
|
8
5
|
type SelectedQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = RequiredKeyof<OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'getNextPageParam' | 'getPreviousPageParam' | 'queryKeyHashFn' | '_defaulted' | 'behavior' | 'structuralSharing' | 'isDataEqual' | 'onSuccess' | 'onError' | 'onSettled' | 'enabled' | 'refetchInterval' | 'initialData'>, 'queryKey' | 'queryFn'> & {
|
|
9
6
|
select: (data: TQueryFnData) => TData;
|
package/dist/queryOptions.d.ts
CHANGED
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
import { QueryKey, UseQueryOptions } from '@tanstack/react-query';
|
|
2
2
|
import { O as OmitKeyof } from './OmitKeyof-CFsZLI4k.js';
|
|
3
|
-
|
|
4
|
-
type RequiredKeyof<T, TKey extends keyof T> = T & {
|
|
5
|
-
[_ in TKey]: Record<never, never>;
|
|
6
|
-
};
|
|
3
|
+
import { R as RequiredKeyof } from './RequiredKeyof-CHKtWddC.js';
|
|
7
4
|
|
|
8
5
|
type SelectedQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = RequiredKeyof<OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'getNextPageParam' | 'getPreviousPageParam' | 'queryKeyHashFn' | '_defaulted' | 'behavior' | 'structuralSharing' | 'isDataEqual' | 'onSuccess' | 'onError' | 'onSettled' | 'enabled' | 'refetchInterval' | 'initialData'>, 'queryKey' | 'queryFn'> & {
|
|
9
6
|
select: (data: TQueryFnData) => TData;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@suspensive/react-query-4",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.6.1",
|
|
4
4
|
"description": "Useful helpers for @tanstack/react-query@4 with suspense",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"suspensive",
|
|
@@ -15,10 +15,7 @@
|
|
|
15
15
|
"directory": "packages/react-query-4"
|
|
16
16
|
},
|
|
17
17
|
"license": "MIT",
|
|
18
|
-
"author":
|
|
19
|
-
"name": "Jonghyeon Ko",
|
|
20
|
-
"email": "jonghyeon@toss.im"
|
|
21
|
-
},
|
|
18
|
+
"author": "Jonghyeon Ko <jonghyeon@toss.im>",
|
|
22
19
|
"sideEffects": false,
|
|
23
20
|
"type": "module",
|
|
24
21
|
"exports": {
|
|
@@ -48,7 +45,7 @@
|
|
|
48
45
|
"react": "^18.3.1",
|
|
49
46
|
"react-dom": "^18.3.1",
|
|
50
47
|
"@suspensive/eslint-config": "0.0.0",
|
|
51
|
-
"@suspensive/react": "2.
|
|
48
|
+
"@suspensive/react": "2.6.1",
|
|
52
49
|
"@suspensive/test-utils": "0.0.0",
|
|
53
50
|
"@suspensive/tsconfig": "0.0.0-development",
|
|
54
51
|
"@suspensive/tsup": "0.0.0"
|
|
@@ -56,7 +53,7 @@
|
|
|
56
53
|
"peerDependencies": {
|
|
57
54
|
"@tanstack/react-query": "^4",
|
|
58
55
|
"react": "^18",
|
|
59
|
-
"@suspensive/react": "^2.
|
|
56
|
+
"@suspensive/react": "^2.6.12.6.1"
|
|
60
57
|
},
|
|
61
58
|
"peerDependenciesMeta": {
|
|
62
59
|
"@suspensive/react": {
|
|
@@ -2,6 +2,7 @@ import { queryFn, queryKey } from '@suspensive/test-utils'
|
|
|
2
2
|
import type { InfiniteData } from '@tanstack/react-query'
|
|
3
3
|
import type { ReactNode } from 'react'
|
|
4
4
|
import { describe, expectTypeOf, it } from 'vitest'
|
|
5
|
+
import { infiniteQueryOptions } from './infiniteQueryOptions'
|
|
5
6
|
import { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery'
|
|
6
7
|
import type { UseSuspenseInfiniteQueryResult } from './useSuspenseInfiniteQuery'
|
|
7
8
|
|
|
@@ -88,6 +89,35 @@ describe('<SuspenseInfiniteQuery/>', () => {
|
|
|
88
89
|
</SuspenseInfiniteQuery>
|
|
89
90
|
)
|
|
90
91
|
|
|
92
|
+
const options = infiniteQueryOptions({ queryKey, queryFn })
|
|
93
|
+
|
|
94
|
+
;() => (
|
|
95
|
+
<SuspenseInfiniteQuery {...options}>
|
|
96
|
+
{(query) => {
|
|
97
|
+
expectTypeOf(query).toEqualTypeOf<UseSuspenseInfiniteQueryResult<{ text: string }>>()
|
|
98
|
+
expectTypeOf(query.data).toEqualTypeOf<InfiniteData<{ text: string }>>()
|
|
99
|
+
expectTypeOf(query.status).toEqualTypeOf<'success'>()
|
|
100
|
+
return <></>
|
|
101
|
+
}}
|
|
102
|
+
</SuspenseInfiniteQuery>
|
|
103
|
+
)
|
|
104
|
+
;() => (
|
|
105
|
+
<SuspenseInfiniteQuery
|
|
106
|
+
{...options}
|
|
107
|
+
select={(data) => ({
|
|
108
|
+
pages: data.pages.map(({ text }) => text),
|
|
109
|
+
pageParams: data.pageParams,
|
|
110
|
+
})}
|
|
111
|
+
>
|
|
112
|
+
{(selectedQuery) => {
|
|
113
|
+
expectTypeOf(selectedQuery).toEqualTypeOf<UseSuspenseInfiniteQueryResult<string>>()
|
|
114
|
+
expectTypeOf(selectedQuery.data).toEqualTypeOf<InfiniteData<string>>()
|
|
115
|
+
expectTypeOf(selectedQuery.status).toEqualTypeOf<'success'>()
|
|
116
|
+
return <></>
|
|
117
|
+
}}
|
|
118
|
+
</SuspenseInfiniteQuery>
|
|
119
|
+
)
|
|
120
|
+
|
|
91
121
|
expectTypeOf(
|
|
92
122
|
<SuspenseInfiniteQuery queryKey={queryKey} queryFn={queryFn}>
|
|
93
123
|
{() => <></>}
|
|
@@ -98,5 +128,9 @@ describe('<SuspenseInfiniteQuery/>', () => {
|
|
|
98
128
|
{() => <></>}
|
|
99
129
|
</SuspenseInfiniteQuery>
|
|
100
130
|
).not.toEqualTypeOf<ReactNode>()
|
|
131
|
+
expectTypeOf(<SuspenseInfiniteQuery {...options}>{() => <></>}</SuspenseInfiniteQuery>).toEqualTypeOf<JSX.Element>()
|
|
132
|
+
expectTypeOf(
|
|
133
|
+
<SuspenseInfiniteQuery {...options}>{() => <></>}</SuspenseInfiniteQuery>
|
|
134
|
+
).not.toEqualTypeOf<ReactNode>()
|
|
101
135
|
})
|
|
102
136
|
})
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { queryFn, queryKey } from '@suspensive/test-utils'
|
|
2
2
|
import type { ReactNode } from 'react'
|
|
3
3
|
import { describe, expectTypeOf, it } from 'vitest'
|
|
4
|
+
import { queryOptions } from './queryOptions'
|
|
4
5
|
import { SuspenseQueries } from './SuspenseQueries'
|
|
5
6
|
import type { UseSuspenseQueryResult } from './useSuspenseQuery'
|
|
6
7
|
|
|
@@ -23,12 +24,7 @@ describe('<SuspenseQueries/>', () => {
|
|
|
23
24
|
</SuspenseQueries>
|
|
24
25
|
)
|
|
25
26
|
;() => (
|
|
26
|
-
<SuspenseQueries
|
|
27
|
-
queries={[
|
|
28
|
-
{ queryKey, queryFn },
|
|
29
|
-
{ queryKey, queryFn },
|
|
30
|
-
]}
|
|
31
|
-
>
|
|
27
|
+
<SuspenseQueries queries={[{ queryKey, queryFn }, queryOptions({ queryKey, queryFn })]}>
|
|
32
28
|
{([
|
|
33
29
|
query1,
|
|
34
30
|
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { queryFn, queryKey } from '@suspensive/test-utils'
|
|
2
2
|
import type { ReactNode } from 'react'
|
|
3
3
|
import { describe, expectTypeOf, it } from 'vitest'
|
|
4
|
+
import { queryOptions } from './queryOptions'
|
|
4
5
|
import { SuspenseQuery } from './SuspenseQuery'
|
|
5
6
|
import type { UseSuspenseQueryResult } from './useSuspenseQuery'
|
|
6
7
|
|
|
@@ -80,6 +81,32 @@ describe('<SuspenseQuery/>', () => {
|
|
|
80
81
|
</SuspenseQuery>
|
|
81
82
|
)
|
|
82
83
|
|
|
84
|
+
const options = queryOptions({
|
|
85
|
+
queryKey,
|
|
86
|
+
queryFn,
|
|
87
|
+
})
|
|
88
|
+
|
|
89
|
+
;() => (
|
|
90
|
+
<SuspenseQuery {...options}>
|
|
91
|
+
{(query) => {
|
|
92
|
+
expectTypeOf(query).toEqualTypeOf<UseSuspenseQueryResult<{ text: string }>>()
|
|
93
|
+
expectTypeOf(query.data).toEqualTypeOf<{ text: string }>()
|
|
94
|
+
expectTypeOf(query.status).toEqualTypeOf<'success'>()
|
|
95
|
+
return <></>
|
|
96
|
+
}}
|
|
97
|
+
</SuspenseQuery>
|
|
98
|
+
)
|
|
99
|
+
;() => (
|
|
100
|
+
<SuspenseQuery {...options} select={(data) => data.text}>
|
|
101
|
+
{(selectedQuery) => {
|
|
102
|
+
expectTypeOf(selectedQuery).toEqualTypeOf<UseSuspenseQueryResult<string>>()
|
|
103
|
+
expectTypeOf(selectedQuery.data).toEqualTypeOf<string>()
|
|
104
|
+
expectTypeOf(selectedQuery.status).toEqualTypeOf<'success'>()
|
|
105
|
+
return <></>
|
|
106
|
+
}}
|
|
107
|
+
</SuspenseQuery>
|
|
108
|
+
)
|
|
109
|
+
|
|
83
110
|
expectTypeOf(
|
|
84
111
|
<SuspenseQuery queryKey={queryKey} queryFn={queryFn}>
|
|
85
112
|
{() => <></>}
|
|
@@ -90,5 +117,7 @@ describe('<SuspenseQuery/>', () => {
|
|
|
90
117
|
{() => <></>}
|
|
91
118
|
</SuspenseQuery>
|
|
92
119
|
).not.toEqualTypeOf<ReactNode>()
|
|
120
|
+
expectTypeOf(<SuspenseQuery {...options}>{() => <></>}</SuspenseQuery>).toEqualTypeOf<JSX.Element>()
|
|
121
|
+
expectTypeOf(<SuspenseQuery {...options}>{() => <></>}</SuspenseQuery>).not.toEqualTypeOf<ReactNode>()
|
|
93
122
|
})
|
|
94
123
|
})
|
package/src/index.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { queryOptions } from './queryOptions'
|
|
2
|
+
export { infiniteQueryOptions } from './infiniteQueryOptions'
|
|
2
3
|
export { SuspenseQuery } from './SuspenseQuery'
|
|
3
4
|
export { SuspenseQueries } from './SuspenseQueries'
|
|
4
5
|
export { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery'
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { queryKey } from '@suspensive/test-utils'
|
|
2
|
+
import { type InfiniteData, type UseInfiniteQueryResult, useInfiniteQuery, useQueryClient } from '@tanstack/react-query'
|
|
3
|
+
import { describe, expectTypeOf, it } from 'vitest'
|
|
4
|
+
import { infiniteQueryOptions } from './infiniteQueryOptions'
|
|
5
|
+
import { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery'
|
|
6
|
+
import { type UseSuspenseInfiniteQueryResult, useSuspenseInfiniteQuery } from './useSuspenseInfiniteQuery'
|
|
7
|
+
|
|
8
|
+
const infiniteQuery = {
|
|
9
|
+
options1: () =>
|
|
10
|
+
infiniteQueryOptions({
|
|
11
|
+
queryKey: [...queryKey, 1] as const,
|
|
12
|
+
queryFn: () => Promise.resolve({ field: 'success' }),
|
|
13
|
+
}),
|
|
14
|
+
options2: () =>
|
|
15
|
+
infiniteQueryOptions({
|
|
16
|
+
queryKey: [...queryKey, 2] as const,
|
|
17
|
+
queryFn: () => Promise.resolve({ field: 'success' }),
|
|
18
|
+
}),
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
describe('infiniteQueryOptions', () => {
|
|
22
|
+
it('should be used with useInfiniteQuery', () => {
|
|
23
|
+
const keyFn1Query = useInfiniteQuery(infiniteQuery.options1())
|
|
24
|
+
expectTypeOf(keyFn1Query).toEqualTypeOf<UseInfiniteQueryResult<{ field: string }>>()
|
|
25
|
+
expectTypeOf(keyFn1Query.data).toEqualTypeOf<InfiniteData<{ field: string }> | undefined>()
|
|
26
|
+
const keyFn1Query_Select = useInfiniteQuery({
|
|
27
|
+
...infiniteQuery.options1(),
|
|
28
|
+
select: (data) => ({
|
|
29
|
+
pages: data.pages.map(({ field }) => field),
|
|
30
|
+
pageParams: data.pageParams,
|
|
31
|
+
}),
|
|
32
|
+
})
|
|
33
|
+
expectTypeOf(keyFn1Query_Select).toEqualTypeOf<UseInfiniteQueryResult<string>>()
|
|
34
|
+
expectTypeOf(keyFn1Query_Select.data).toEqualTypeOf<InfiniteData<string> | undefined>()
|
|
35
|
+
})
|
|
36
|
+
it('should be used with useSuspenseInfiniteQuery', () => {
|
|
37
|
+
const keyFn1SuspenseQuery = useSuspenseInfiniteQuery(infiniteQuery.options1())
|
|
38
|
+
expectTypeOf(keyFn1SuspenseQuery).toEqualTypeOf<UseSuspenseInfiniteQueryResult<{ field: string }>>()
|
|
39
|
+
expectTypeOf(keyFn1SuspenseQuery.data).toEqualTypeOf<InfiniteData<{ field: string }>>()
|
|
40
|
+
const keyFn1SuspenseQuery_Select = useSuspenseInfiniteQuery({
|
|
41
|
+
...infiniteQuery.options1(),
|
|
42
|
+
select: (data) => ({
|
|
43
|
+
pages: data.pages.map(({ field }) => field),
|
|
44
|
+
pageParams: data.pageParams,
|
|
45
|
+
}),
|
|
46
|
+
})
|
|
47
|
+
expectTypeOf(keyFn1SuspenseQuery_Select).toEqualTypeOf<UseSuspenseInfiniteQueryResult<string>>()
|
|
48
|
+
expectTypeOf(keyFn1SuspenseQuery_Select.data).toEqualTypeOf<InfiniteData<string>>()
|
|
49
|
+
})
|
|
50
|
+
it('should be used with <SuspenseInfiniteQuery/>', () => {
|
|
51
|
+
;(() => (
|
|
52
|
+
<SuspenseInfiniteQuery {...infiniteQuery.options1()}>
|
|
53
|
+
{(keyFn1SuspenseQuery) => {
|
|
54
|
+
expectTypeOf(keyFn1SuspenseQuery).toEqualTypeOf<UseSuspenseInfiniteQueryResult<{ field: string }>>()
|
|
55
|
+
expectTypeOf(keyFn1SuspenseQuery.data).toEqualTypeOf<
|
|
56
|
+
InfiniteData<{
|
|
57
|
+
field: string
|
|
58
|
+
}>
|
|
59
|
+
>()
|
|
60
|
+
return <></>
|
|
61
|
+
}}
|
|
62
|
+
</SuspenseInfiniteQuery>
|
|
63
|
+
))()
|
|
64
|
+
;(() => (
|
|
65
|
+
<SuspenseInfiniteQuery
|
|
66
|
+
{...infiniteQuery.options1()}
|
|
67
|
+
select={(data) => ({
|
|
68
|
+
pages: data.pages.map(({ field }) => field),
|
|
69
|
+
pageParams: data.pageParams,
|
|
70
|
+
})}
|
|
71
|
+
>
|
|
72
|
+
{(keyFn1SuspenseQuery_Select) => {
|
|
73
|
+
expectTypeOf(keyFn1SuspenseQuery_Select).toEqualTypeOf<UseSuspenseInfiniteQueryResult<string>>()
|
|
74
|
+
expectTypeOf(keyFn1SuspenseQuery_Select.data).toEqualTypeOf<InfiniteData<string>>()
|
|
75
|
+
return <></>
|
|
76
|
+
}}
|
|
77
|
+
</SuspenseInfiniteQuery>
|
|
78
|
+
))()
|
|
79
|
+
})
|
|
80
|
+
|
|
81
|
+
it('should be used with useQueryClient', async () => {
|
|
82
|
+
const queryClient = useQueryClient()
|
|
83
|
+
|
|
84
|
+
queryClient.invalidateQueries(infiniteQuery.options1())
|
|
85
|
+
queryClient.resetQueries(infiniteQuery.options1())
|
|
86
|
+
queryClient.removeQueries(infiniteQuery.options1())
|
|
87
|
+
queryClient.cancelQueries(infiniteQuery.options1())
|
|
88
|
+
queryClient.prefetchQuery(infiniteQuery.options1())
|
|
89
|
+
queryClient.refetchQueries(infiniteQuery.options1())
|
|
90
|
+
|
|
91
|
+
const query1 = await queryClient.fetchQuery(infiniteQuery.options1())
|
|
92
|
+
expectTypeOf(query1).toEqualTypeOf<{ field: string }>()
|
|
93
|
+
})
|
|
94
|
+
})
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import type { InfiniteData, QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query'
|
|
2
|
+
import type { OmitKeyof, RequiredKeyof } from './utility-types'
|
|
3
|
+
|
|
4
|
+
type SelectedInfiniteOptions<
|
|
5
|
+
TQueryFnData,
|
|
6
|
+
TError = unknown,
|
|
7
|
+
TData = InfiniteData<TQueryFnData>,
|
|
8
|
+
TQueryKey extends QueryKey = QueryKey,
|
|
9
|
+
> = RequiredKeyof<
|
|
10
|
+
OmitKeyof<
|
|
11
|
+
UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,
|
|
12
|
+
| 'queryKeyHashFn'
|
|
13
|
+
| '_defaulted'
|
|
14
|
+
| 'behavior'
|
|
15
|
+
| 'structuralSharing'
|
|
16
|
+
| 'isDataEqual'
|
|
17
|
+
| 'onSuccess'
|
|
18
|
+
| 'onError'
|
|
19
|
+
| 'onSettled'
|
|
20
|
+
| 'enabled'
|
|
21
|
+
| 'refetchInterval'
|
|
22
|
+
| 'initialData'
|
|
23
|
+
>,
|
|
24
|
+
'queryKey' | 'queryFn'
|
|
25
|
+
> & {
|
|
26
|
+
select: (data: InfiniteData<TQueryFnData>) => InfiniteData<TData>
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
type UnSelectedInfiniteOptions<
|
|
30
|
+
TQueryFnData,
|
|
31
|
+
TError = unknown,
|
|
32
|
+
TData = InfiniteData<TQueryFnData>,
|
|
33
|
+
TQueryKey extends QueryKey = QueryKey,
|
|
34
|
+
> = RequiredKeyof<
|
|
35
|
+
OmitKeyof<
|
|
36
|
+
UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,
|
|
37
|
+
| 'queryKeyHashFn'
|
|
38
|
+
| '_defaulted'
|
|
39
|
+
| 'behavior'
|
|
40
|
+
| 'structuralSharing'
|
|
41
|
+
| 'isDataEqual'
|
|
42
|
+
| 'onSuccess'
|
|
43
|
+
| 'onError'
|
|
44
|
+
| 'onSettled'
|
|
45
|
+
| 'enabled'
|
|
46
|
+
| 'refetchInterval'
|
|
47
|
+
| 'initialData'
|
|
48
|
+
>,
|
|
49
|
+
'queryKey' | 'queryFn'
|
|
50
|
+
> & {
|
|
51
|
+
select?: undefined
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* @experimental This is experimental feature.
|
|
56
|
+
*/
|
|
57
|
+
export function infiniteQueryOptions<
|
|
58
|
+
TQueryFnData,
|
|
59
|
+
TError = unknown,
|
|
60
|
+
TData = InfiniteData<TQueryFnData>,
|
|
61
|
+
TQueryKey extends QueryKey = QueryKey,
|
|
62
|
+
>(
|
|
63
|
+
options: SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>
|
|
64
|
+
): SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* @experimental This is experimental feature.
|
|
68
|
+
*/
|
|
69
|
+
export function infiniteQueryOptions<
|
|
70
|
+
TQueryFnData,
|
|
71
|
+
TError = unknown,
|
|
72
|
+
TData = InfiniteData<TQueryFnData>,
|
|
73
|
+
TQueryKey extends QueryKey = QueryKey,
|
|
74
|
+
>(
|
|
75
|
+
options: UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>
|
|
76
|
+
): UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* @experimental This is experimental feature.
|
|
80
|
+
*/
|
|
81
|
+
export function infiniteQueryOptions(options: unknown) {
|
|
82
|
+
return options
|
|
83
|
+
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { queryFn, queryKey } from '@suspensive/test-utils'
|
|
2
2
|
import type { InfiniteData } from '@tanstack/react-query'
|
|
3
|
+
import { infiniteQueryOptions } from './infiniteQueryOptions'
|
|
3
4
|
import { type UseSuspenseInfiniteQueryResult, useSuspenseInfiniteQuery } from './useSuspenseInfiniteQuery'
|
|
4
5
|
|
|
5
6
|
describe('useSuspenseInfiniteQuery', () => {
|
|
@@ -55,5 +56,26 @@ describe('useSuspenseInfiniteQuery', () => {
|
|
|
55
56
|
expectTypeOf(selectedInfiniteQuery).toEqualTypeOf<UseSuspenseInfiniteQueryResult<string>>()
|
|
56
57
|
expectTypeOf(selectedInfiniteQuery.data).toEqualTypeOf<InfiniteData<string>>()
|
|
57
58
|
expectTypeOf(selectedInfiniteQuery.status).toEqualTypeOf<'success'>()
|
|
59
|
+
|
|
60
|
+
const options = infiniteQueryOptions({
|
|
61
|
+
queryKey,
|
|
62
|
+
queryFn,
|
|
63
|
+
})
|
|
64
|
+
|
|
65
|
+
const infiniteQueryWithOptions = useSuspenseInfiniteQuery(options)
|
|
66
|
+
expectTypeOf(infiniteQueryWithOptions).toEqualTypeOf<UseSuspenseInfiniteQueryResult<{ text: string }>>()
|
|
67
|
+
expectTypeOf(infiniteQueryWithOptions.data).toEqualTypeOf<InfiniteData<{ text: string }>>()
|
|
68
|
+
expectTypeOf(infiniteQueryWithOptions.status).toEqualTypeOf<'success'>()
|
|
69
|
+
|
|
70
|
+
const selectedInfiniteQueryWithOptions = useSuspenseInfiniteQuery({
|
|
71
|
+
...options,
|
|
72
|
+
select: (data) => ({
|
|
73
|
+
pages: data.pages.map(({ text }) => text),
|
|
74
|
+
pageParams: data.pageParams,
|
|
75
|
+
}),
|
|
76
|
+
})
|
|
77
|
+
expectTypeOf(selectedInfiniteQueryWithOptions).toEqualTypeOf<UseSuspenseInfiniteQueryResult<string>>()
|
|
78
|
+
expectTypeOf(selectedInfiniteQueryWithOptions.data).toEqualTypeOf<InfiniteData<string>>()
|
|
79
|
+
expectTypeOf(selectedInfiniteQueryWithOptions.status).toEqualTypeOf<'success'>()
|
|
58
80
|
})
|
|
59
81
|
})
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { queryFn, queryKey } from '@suspensive/test-utils'
|
|
2
2
|
import { describe, expectTypeOf, it } from 'vitest'
|
|
3
|
+
import { queryOptions } from './queryOptions'
|
|
3
4
|
import { type UseSuspenseQueryResult, useSuspenseQuery } from './useSuspenseQuery'
|
|
4
5
|
|
|
5
6
|
describe('useSuspenseQuery', () => {
|
|
@@ -47,5 +48,23 @@ describe('useSuspenseQuery', () => {
|
|
|
47
48
|
expectTypeOf(selectedResult).toEqualTypeOf<UseSuspenseQueryResult<string>>()
|
|
48
49
|
expectTypeOf(selectedResult.data).toEqualTypeOf<string>()
|
|
49
50
|
expectTypeOf(selectedResult.status).toEqualTypeOf<'success'>()
|
|
51
|
+
|
|
52
|
+
const options = queryOptions({
|
|
53
|
+
queryKey,
|
|
54
|
+
queryFn,
|
|
55
|
+
})
|
|
56
|
+
|
|
57
|
+
const resultWithOptions = useSuspenseQuery(options)
|
|
58
|
+
expectTypeOf(resultWithOptions).toEqualTypeOf<UseSuspenseQueryResult<{ text: string }>>()
|
|
59
|
+
expectTypeOf(resultWithOptions.data).toEqualTypeOf<{ text: string }>()
|
|
60
|
+
expectTypeOf(resultWithOptions.status).toEqualTypeOf<'success'>()
|
|
61
|
+
|
|
62
|
+
const selectedResultWithOptions = useSuspenseQuery({
|
|
63
|
+
...options,
|
|
64
|
+
select: (data) => data.text,
|
|
65
|
+
})
|
|
66
|
+
expectTypeOf(selectedResultWithOptions).toEqualTypeOf<UseSuspenseQueryResult<string>>()
|
|
67
|
+
expectTypeOf(selectedResultWithOptions.data).toEqualTypeOf<string>()
|
|
68
|
+
expectTypeOf(selectedResultWithOptions.status).toEqualTypeOf<'success'>()
|
|
50
69
|
})
|
|
51
70
|
})
|