@suspensive/react-query-4 0.0.1-beta.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.
- package/LICENSE +21 -0
- package/dist/OmitKeyof-CFsZLI4k.d.cts +3 -0
- package/dist/OmitKeyof-CFsZLI4k.d.ts +3 -0
- package/dist/QueryErrorBoundary.cjs +81 -0
- package/dist/QueryErrorBoundary.cjs.map +1 -0
- package/dist/QueryErrorBoundary.d.cts +29 -0
- package/dist/QueryErrorBoundary.d.ts +29 -0
- package/dist/QueryErrorBoundary.js +9 -0
- package/dist/QueryErrorBoundary.js.map +1 -0
- package/dist/SuspenseInfiniteQuery.cjs +81 -0
- package/dist/SuspenseInfiniteQuery.cjs.map +1 -0
- package/dist/SuspenseInfiniteQuery.d.cts +14 -0
- package/dist/SuspenseInfiniteQuery.d.ts +14 -0
- package/dist/SuspenseInfiniteQuery.js +10 -0
- package/dist/SuspenseInfiniteQuery.js.map +1 -0
- package/dist/SuspenseQueries.cjs +69 -0
- package/dist/SuspenseQueries.cjs.map +1 -0
- package/dist/SuspenseQueries.d.cts +16 -0
- package/dist/SuspenseQueries.d.ts +16 -0
- package/dist/SuspenseQueries.js +10 -0
- package/dist/SuspenseQueries.js.map +1 -0
- package/dist/SuspenseQuery.cjs +81 -0
- package/dist/SuspenseQuery.cjs.map +1 -0
- package/dist/SuspenseQuery.d.cts +14 -0
- package/dist/SuspenseQuery.d.ts +14 -0
- package/dist/SuspenseQuery.js +10 -0
- package/dist/SuspenseQuery.js.map +1 -0
- package/dist/chunk-3B63MBHY.js +22 -0
- package/dist/chunk-3B63MBHY.js.map +1 -0
- package/dist/chunk-BN22WZP6.js +18 -0
- package/dist/chunk-BN22WZP6.js.map +1 -0
- package/dist/chunk-J3EHCRU6.js +20 -0
- package/dist/chunk-J3EHCRU6.js.map +1 -0
- package/dist/chunk-MEYWTEWA.js +11 -0
- package/dist/chunk-MEYWTEWA.js.map +1 -0
- package/dist/chunk-P5MROV72.js +34 -0
- package/dist/chunk-P5MROV72.js.map +1 -0
- package/dist/chunk-QETBZSG5.js +39 -0
- package/dist/chunk-QETBZSG5.js.map +1 -0
- package/dist/chunk-S7L2LUVS.js +22 -0
- package/dist/chunk-S7L2LUVS.js.map +1 -0
- package/dist/chunk-VPKMZV3T.js +23 -0
- package/dist/chunk-VPKMZV3T.js.map +1 -0
- package/dist/chunk-ZAOCTI7U.js +23 -0
- package/dist/chunk-ZAOCTI7U.js.map +1 -0
- package/dist/index.cjs +165 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +13 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +37 -0
- package/dist/index.js.map +1 -0
- package/dist/queryOptions.cjs +34 -0
- package/dist/queryOptions.cjs.map +1 -0
- package/dist/queryOptions.d.cts +17 -0
- package/dist/queryOptions.d.ts +17 -0
- package/dist/queryOptions.js +9 -0
- package/dist/queryOptions.js.map +1 -0
- package/dist/useSuspenseInfiniteQuery.cjs +56 -0
- package/dist/useSuspenseInfiniteQuery.cjs.map +1 -0
- package/dist/useSuspenseInfiniteQuery.d.cts +16 -0
- package/dist/useSuspenseInfiniteQuery.d.ts +16 -0
- package/dist/useSuspenseInfiniteQuery.js +9 -0
- package/dist/useSuspenseInfiniteQuery.js.map +1 -0
- package/dist/useSuspenseQueries.cjs +58 -0
- package/dist/useSuspenseQueries.cjs.map +1 -0
- package/dist/useSuspenseQueries.d.cts +55 -0
- package/dist/useSuspenseQueries.d.ts +55 -0
- package/dist/useSuspenseQueries.js +9 -0
- package/dist/useSuspenseQueries.js.map +1 -0
- package/dist/useSuspenseQuery.cjs +56 -0
- package/dist/useSuspenseQuery.cjs.map +1 -0
- package/dist/useSuspenseQuery.d.cts +16 -0
- package/dist/useSuspenseQuery.d.ts +16 -0
- package/dist/useSuspenseQuery.js +9 -0
- package/dist/useSuspenseQuery.js.map +1 -0
- package/package.json +80 -0
- package/src/QueryErrorBoundary.tsx +27 -0
- package/src/SuspenseInfiniteQuery.test-d.tsx +102 -0
- package/src/SuspenseInfiniteQuery.tsx +22 -0
- package/src/SuspenseQueries.test-d.tsx +54 -0
- package/src/SuspenseQueries.tsx +15 -0
- package/src/SuspenseQuery.test-d.tsx +94 -0
- package/src/SuspenseQuery.tsx +18 -0
- package/src/index.ts +13 -0
- package/src/queryOptions.test-d.tsx +119 -0
- package/src/queryOptions.ts +88 -0
- package/src/useSuspenseInfiniteQuery.test-d.ts +59 -0
- package/src/useSuspenseInfiniteQuery.ts +47 -0
- package/src/useSuspenseQueries.test-d.ts +75 -0
- package/src/useSuspenseQueries.ts +127 -0
- package/src/useSuspenseQuery.test-d.ts +51 -0
- package/src/useSuspenseQuery.ts +36 -0
- package/src/utility-types/OmitKeyof.test-d.ts +175 -0
- package/src/utility-types/OmitKeyof.ts +11 -0
- package/src/utility-types/RequiredKeyof.ts +3 -0
- package/src/utility-types/index.ts +2 -0
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use client"
|
|
2
|
+
"use strict";
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __defProps = Object.defineProperties;
|
|
5
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
6
|
+
var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
|
|
7
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
8
|
+
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
|
|
9
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
10
|
+
var __propIsEnum = Object.prototype.propertyIsEnumerable;
|
|
11
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
12
|
+
var __spreadValues = (a, b) => {
|
|
13
|
+
for (var prop in b || (b = {}))
|
|
14
|
+
if (__hasOwnProp.call(b, prop))
|
|
15
|
+
__defNormalProp(a, prop, b[prop]);
|
|
16
|
+
if (__getOwnPropSymbols)
|
|
17
|
+
for (var prop of __getOwnPropSymbols(b)) {
|
|
18
|
+
if (__propIsEnum.call(b, prop))
|
|
19
|
+
__defNormalProp(a, prop, b[prop]);
|
|
20
|
+
}
|
|
21
|
+
return a;
|
|
22
|
+
};
|
|
23
|
+
var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
|
|
24
|
+
var __export = (target, all) => {
|
|
25
|
+
for (var name in all)
|
|
26
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
27
|
+
};
|
|
28
|
+
var __copyProps = (to, from, except, desc) => {
|
|
29
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
30
|
+
for (let key of __getOwnPropNames(from))
|
|
31
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
32
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
33
|
+
}
|
|
34
|
+
return to;
|
|
35
|
+
};
|
|
36
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
37
|
+
|
|
38
|
+
// src/useSuspenseInfiniteQuery.ts
|
|
39
|
+
var useSuspenseInfiniteQuery_exports = {};
|
|
40
|
+
__export(useSuspenseInfiniteQuery_exports, {
|
|
41
|
+
useSuspenseInfiniteQuery: () => useSuspenseInfiniteQuery
|
|
42
|
+
});
|
|
43
|
+
module.exports = __toCommonJS(useSuspenseInfiniteQuery_exports);
|
|
44
|
+
var import_react_query = require("@tanstack/react-query");
|
|
45
|
+
function useSuspenseInfiniteQuery(options) {
|
|
46
|
+
return (0, import_react_query.useInfiniteQuery)(__spreadProps(__spreadValues({}, options), {
|
|
47
|
+
enabled: true,
|
|
48
|
+
suspense: true,
|
|
49
|
+
useErrorBoundary: true
|
|
50
|
+
}));
|
|
51
|
+
}
|
|
52
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
53
|
+
0 && (module.exports = {
|
|
54
|
+
useSuspenseInfiniteQuery
|
|
55
|
+
});
|
|
56
|
+
//# sourceMappingURL=useSuspenseInfiniteQuery.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/useSuspenseInfiniteQuery.ts"],"sourcesContent":["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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAMO;AA0BA,SAAS,yBAMd,SAC+C;AAC/C,aAAO,qCAAiB,iCACnB,UADmB;AAAA,IAEtB,SAAS;AAAA,IACT,UAAU;AAAA,IACV,kBAAkB;AAAA,EACpB,EAAC;AACH;","names":[]}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { UseInfiniteQueryResult, InfiniteData, QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query';
|
|
2
|
+
import { O as OmitKeyof } from './OmitKeyof-CFsZLI4k.cjs';
|
|
3
|
+
|
|
4
|
+
interface UseSuspenseInfiniteQueryResult<TData = unknown, TError = unknown> extends OmitKeyof<UseInfiniteQueryResult<TData, TError>, keyof Pick<UseInfiniteQueryResult<TData, TError>, 'isPlaceholderData'>> {
|
|
5
|
+
data: InfiniteData<TData>;
|
|
6
|
+
status: 'success';
|
|
7
|
+
}
|
|
8
|
+
interface UseSuspenseInfiniteQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData'> {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* This hook is wrapping useInfiniteQuery of `@tanstack/react-query` v4 with default suspense option.
|
|
12
|
+
* @see {@link https://suspensive.org/docs/react-query/useSuspenseInfiniteQuery}
|
|
13
|
+
*/
|
|
14
|
+
declare function useSuspenseInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseSuspenseInfiniteQueryResult<TData, TError>;
|
|
15
|
+
|
|
16
|
+
export { type UseSuspenseInfiniteQueryOptions, type UseSuspenseInfiniteQueryResult, useSuspenseInfiniteQuery };
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { UseInfiniteQueryResult, InfiniteData, QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query';
|
|
2
|
+
import { O as OmitKeyof } from './OmitKeyof-CFsZLI4k.js';
|
|
3
|
+
|
|
4
|
+
interface UseSuspenseInfiniteQueryResult<TData = unknown, TError = unknown> extends OmitKeyof<UseInfiniteQueryResult<TData, TError>, keyof Pick<UseInfiniteQueryResult<TData, TError>, 'isPlaceholderData'>> {
|
|
5
|
+
data: InfiniteData<TData>;
|
|
6
|
+
status: 'success';
|
|
7
|
+
}
|
|
8
|
+
interface UseSuspenseInfiniteQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData'> {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* This hook is wrapping useInfiniteQuery of `@tanstack/react-query` v4 with default suspense option.
|
|
12
|
+
* @see {@link https://suspensive.org/docs/react-query/useSuspenseInfiniteQuery}
|
|
13
|
+
*/
|
|
14
|
+
declare function useSuspenseInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseSuspenseInfiniteQueryResult<TData, TError>;
|
|
15
|
+
|
|
16
|
+
export { type UseSuspenseInfiniteQueryOptions, type UseSuspenseInfiniteQueryResult, useSuspenseInfiniteQuery };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use client"
|
|
2
|
+
"use strict";
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __defProps = Object.defineProperties;
|
|
5
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
6
|
+
var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
|
|
7
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
8
|
+
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
|
|
9
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
10
|
+
var __propIsEnum = Object.prototype.propertyIsEnumerable;
|
|
11
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
12
|
+
var __spreadValues = (a, b) => {
|
|
13
|
+
for (var prop in b || (b = {}))
|
|
14
|
+
if (__hasOwnProp.call(b, prop))
|
|
15
|
+
__defNormalProp(a, prop, b[prop]);
|
|
16
|
+
if (__getOwnPropSymbols)
|
|
17
|
+
for (var prop of __getOwnPropSymbols(b)) {
|
|
18
|
+
if (__propIsEnum.call(b, prop))
|
|
19
|
+
__defNormalProp(a, prop, b[prop]);
|
|
20
|
+
}
|
|
21
|
+
return a;
|
|
22
|
+
};
|
|
23
|
+
var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
|
|
24
|
+
var __export = (target, all) => {
|
|
25
|
+
for (var name in all)
|
|
26
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
27
|
+
};
|
|
28
|
+
var __copyProps = (to, from, except, desc) => {
|
|
29
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
30
|
+
for (let key of __getOwnPropNames(from))
|
|
31
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
32
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
33
|
+
}
|
|
34
|
+
return to;
|
|
35
|
+
};
|
|
36
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
37
|
+
|
|
38
|
+
// src/useSuspenseQueries.ts
|
|
39
|
+
var useSuspenseQueries_exports = {};
|
|
40
|
+
__export(useSuspenseQueries_exports, {
|
|
41
|
+
useSuspenseQueries: () => useSuspenseQueries
|
|
42
|
+
});
|
|
43
|
+
module.exports = __toCommonJS(useSuspenseQueries_exports);
|
|
44
|
+
var import_react_query = require("@tanstack/react-query");
|
|
45
|
+
function useSuspenseQueries({
|
|
46
|
+
queries,
|
|
47
|
+
context
|
|
48
|
+
}) {
|
|
49
|
+
return (0, import_react_query.useQueries)({
|
|
50
|
+
queries: queries.map((query) => __spreadProps(__spreadValues({}, query), { suspense: true })),
|
|
51
|
+
context
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
55
|
+
0 && (module.exports = {
|
|
56
|
+
useSuspenseQueries
|
|
57
|
+
});
|
|
58
|
+
//# sourceMappingURL=useSuspenseQueries.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
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}\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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAqE;AAmH9D,SAAS,mBAAoC;AAAA,EAClD;AAAA,EACA;AACF,GAG8B;AAC5B,aAAO,+BAAW;AAAA,IAChB,SAAS,QAAQ,IAAI,CAAC,UAA2B,iCAAK,QAAL,EAAY,UAAU,KAAK,EAAE;AAAA,IAC9E;AAAA,EACF,CAAC;AACH;","names":[]}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { UseQueryOptions, QueryFunction } from '@tanstack/react-query';
|
|
2
|
+
import { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery.cjs';
|
|
3
|
+
import './OmitKeyof-CFsZLI4k.cjs';
|
|
4
|
+
|
|
5
|
+
type MAXIMUM_DEPTH = 20;
|
|
6
|
+
type GetSuspenseOptions<T> = T extends {
|
|
7
|
+
queryFnData: infer TQueryFnData;
|
|
8
|
+
error?: infer TError;
|
|
9
|
+
data: infer TData;
|
|
10
|
+
} ? UseSuspenseQueryOptions<TQueryFnData, TError, TData> : T extends {
|
|
11
|
+
queryFnData: infer TQueryFnData;
|
|
12
|
+
error?: infer TError;
|
|
13
|
+
} ? UseSuspenseQueryOptions<TQueryFnData, TError> : T extends {
|
|
14
|
+
data: infer TData;
|
|
15
|
+
error?: infer TError;
|
|
16
|
+
} ? UseSuspenseQueryOptions<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? UseSuspenseQueryOptions<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? UseSuspenseQueryOptions<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseSuspenseQueryOptions<TQueryFnData> : T extends {
|
|
17
|
+
queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
|
|
18
|
+
select?: (data: any) => infer TData;
|
|
19
|
+
} ? UseSuspenseQueryOptions<TQueryFnData, unknown, TData, TQueryKey> : T extends {
|
|
20
|
+
queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
|
|
21
|
+
} ? UseSuspenseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey> : UseSuspenseQueryOptions;
|
|
22
|
+
type GetSuspenseResults<T> = T extends {
|
|
23
|
+
queryFnData: any;
|
|
24
|
+
error?: infer TError;
|
|
25
|
+
data: infer TData;
|
|
26
|
+
} ? UseSuspenseQueryResult<TData, TError> : T extends {
|
|
27
|
+
queryFnData: infer TQueryFnData;
|
|
28
|
+
error?: infer TError;
|
|
29
|
+
} ? UseSuspenseQueryResult<TQueryFnData, TError> : T extends {
|
|
30
|
+
data: infer TData;
|
|
31
|
+
error?: infer TError;
|
|
32
|
+
} ? UseSuspenseQueryResult<TData, TError> : T extends [any, infer TError, infer TData] ? UseSuspenseQueryResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? UseSuspenseQueryResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseSuspenseQueryResult<TQueryFnData> : T extends {
|
|
33
|
+
queryFn?: QueryFunction<infer TQueryFnData, any>;
|
|
34
|
+
select?: (data: any) => infer TData;
|
|
35
|
+
} ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData> : T extends {
|
|
36
|
+
queryFn?: QueryFunction<infer TQueryFnData, any>;
|
|
37
|
+
} ? UseSuspenseQueryResult<TQueryFnData> : UseSuspenseQueryResult;
|
|
38
|
+
/**
|
|
39
|
+
* SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
|
|
40
|
+
*/
|
|
41
|
+
type SuspenseQueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseSuspenseQueryOptions> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetSuspenseOptions<Head>] : T extends [infer Head, ...infer Tail] ? SuspenseQueriesOptions<[...Tail], [...TResult, GetSuspenseOptions<Head>], [...TDepth, 1]> : Array<unknown> extends T ? T : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>> : Array<UseSuspenseQueryOptions>;
|
|
42
|
+
/**
|
|
43
|
+
* SuspenseQueriesResults reducer recursively maps type param to results
|
|
44
|
+
*/
|
|
45
|
+
type SuspenseQueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseSuspenseQueryResult> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetSuspenseResults<Head>] : T extends [infer Head, ...infer Tail] ? SuspenseQueriesResults<[...Tail], [...TResult, GetSuspenseResults<Head>], [...TDepth, 1]> : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, any>> ? Array<UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>> : Array<UseSuspenseQueryResult>;
|
|
46
|
+
/**
|
|
47
|
+
* This hook is wrapping useQueries of `@tanstack/react-query` v4 with default suspense option.
|
|
48
|
+
* @see {@link https://suspensive.org/docs/react-query/useSuspenseQueries}
|
|
49
|
+
*/
|
|
50
|
+
declare function useSuspenseQueries<T extends any[]>({ queries, context, }: {
|
|
51
|
+
queries: readonly [...SuspenseQueriesOptions<T>];
|
|
52
|
+
context?: UseQueryOptions['context'];
|
|
53
|
+
}): SuspenseQueriesResults<T>;
|
|
54
|
+
|
|
55
|
+
export { type SuspenseQueriesOptions, type SuspenseQueriesResults, useSuspenseQueries };
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { UseQueryOptions, QueryFunction } from '@tanstack/react-query';
|
|
2
|
+
import { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery.js';
|
|
3
|
+
import './OmitKeyof-CFsZLI4k.js';
|
|
4
|
+
|
|
5
|
+
type MAXIMUM_DEPTH = 20;
|
|
6
|
+
type GetSuspenseOptions<T> = T extends {
|
|
7
|
+
queryFnData: infer TQueryFnData;
|
|
8
|
+
error?: infer TError;
|
|
9
|
+
data: infer TData;
|
|
10
|
+
} ? UseSuspenseQueryOptions<TQueryFnData, TError, TData> : T extends {
|
|
11
|
+
queryFnData: infer TQueryFnData;
|
|
12
|
+
error?: infer TError;
|
|
13
|
+
} ? UseSuspenseQueryOptions<TQueryFnData, TError> : T extends {
|
|
14
|
+
data: infer TData;
|
|
15
|
+
error?: infer TError;
|
|
16
|
+
} ? UseSuspenseQueryOptions<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? UseSuspenseQueryOptions<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? UseSuspenseQueryOptions<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseSuspenseQueryOptions<TQueryFnData> : T extends {
|
|
17
|
+
queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
|
|
18
|
+
select?: (data: any) => infer TData;
|
|
19
|
+
} ? UseSuspenseQueryOptions<TQueryFnData, unknown, TData, TQueryKey> : T extends {
|
|
20
|
+
queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
|
|
21
|
+
} ? UseSuspenseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey> : UseSuspenseQueryOptions;
|
|
22
|
+
type GetSuspenseResults<T> = T extends {
|
|
23
|
+
queryFnData: any;
|
|
24
|
+
error?: infer TError;
|
|
25
|
+
data: infer TData;
|
|
26
|
+
} ? UseSuspenseQueryResult<TData, TError> : T extends {
|
|
27
|
+
queryFnData: infer TQueryFnData;
|
|
28
|
+
error?: infer TError;
|
|
29
|
+
} ? UseSuspenseQueryResult<TQueryFnData, TError> : T extends {
|
|
30
|
+
data: infer TData;
|
|
31
|
+
error?: infer TError;
|
|
32
|
+
} ? UseSuspenseQueryResult<TData, TError> : T extends [any, infer TError, infer TData] ? UseSuspenseQueryResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? UseSuspenseQueryResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseSuspenseQueryResult<TQueryFnData> : T extends {
|
|
33
|
+
queryFn?: QueryFunction<infer TQueryFnData, any>;
|
|
34
|
+
select?: (data: any) => infer TData;
|
|
35
|
+
} ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData> : T extends {
|
|
36
|
+
queryFn?: QueryFunction<infer TQueryFnData, any>;
|
|
37
|
+
} ? UseSuspenseQueryResult<TQueryFnData> : UseSuspenseQueryResult;
|
|
38
|
+
/**
|
|
39
|
+
* SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
|
|
40
|
+
*/
|
|
41
|
+
type SuspenseQueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseSuspenseQueryOptions> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetSuspenseOptions<Head>] : T extends [infer Head, ...infer Tail] ? SuspenseQueriesOptions<[...Tail], [...TResult, GetSuspenseOptions<Head>], [...TDepth, 1]> : Array<unknown> extends T ? T : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>> : Array<UseSuspenseQueryOptions>;
|
|
42
|
+
/**
|
|
43
|
+
* SuspenseQueriesResults reducer recursively maps type param to results
|
|
44
|
+
*/
|
|
45
|
+
type SuspenseQueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseSuspenseQueryResult> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetSuspenseResults<Head>] : T extends [infer Head, ...infer Tail] ? SuspenseQueriesResults<[...Tail], [...TResult, GetSuspenseResults<Head>], [...TDepth, 1]> : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, any>> ? Array<UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>> : Array<UseSuspenseQueryResult>;
|
|
46
|
+
/**
|
|
47
|
+
* This hook is wrapping useQueries of `@tanstack/react-query` v4 with default suspense option.
|
|
48
|
+
* @see {@link https://suspensive.org/docs/react-query/useSuspenseQueries}
|
|
49
|
+
*/
|
|
50
|
+
declare function useSuspenseQueries<T extends any[]>({ queries, context, }: {
|
|
51
|
+
queries: readonly [...SuspenseQueriesOptions<T>];
|
|
52
|
+
context?: UseQueryOptions['context'];
|
|
53
|
+
}): SuspenseQueriesResults<T>;
|
|
54
|
+
|
|
55
|
+
export { type SuspenseQueriesOptions, type SuspenseQueriesResults, useSuspenseQueries };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use client"
|
|
2
|
+
"use strict";
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __defProps = Object.defineProperties;
|
|
5
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
6
|
+
var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
|
|
7
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
8
|
+
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
|
|
9
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
10
|
+
var __propIsEnum = Object.prototype.propertyIsEnumerable;
|
|
11
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
12
|
+
var __spreadValues = (a, b) => {
|
|
13
|
+
for (var prop in b || (b = {}))
|
|
14
|
+
if (__hasOwnProp.call(b, prop))
|
|
15
|
+
__defNormalProp(a, prop, b[prop]);
|
|
16
|
+
if (__getOwnPropSymbols)
|
|
17
|
+
for (var prop of __getOwnPropSymbols(b)) {
|
|
18
|
+
if (__propIsEnum.call(b, prop))
|
|
19
|
+
__defNormalProp(a, prop, b[prop]);
|
|
20
|
+
}
|
|
21
|
+
return a;
|
|
22
|
+
};
|
|
23
|
+
var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
|
|
24
|
+
var __export = (target, all) => {
|
|
25
|
+
for (var name in all)
|
|
26
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
27
|
+
};
|
|
28
|
+
var __copyProps = (to, from, except, desc) => {
|
|
29
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
30
|
+
for (let key of __getOwnPropNames(from))
|
|
31
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
32
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
33
|
+
}
|
|
34
|
+
return to;
|
|
35
|
+
};
|
|
36
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
37
|
+
|
|
38
|
+
// src/useSuspenseQuery.ts
|
|
39
|
+
var useSuspenseQuery_exports = {};
|
|
40
|
+
__export(useSuspenseQuery_exports, {
|
|
41
|
+
useSuspenseQuery: () => useSuspenseQuery
|
|
42
|
+
});
|
|
43
|
+
module.exports = __toCommonJS(useSuspenseQuery_exports);
|
|
44
|
+
var import_react_query = require("@tanstack/react-query");
|
|
45
|
+
function useSuspenseQuery(options) {
|
|
46
|
+
return (0, import_react_query.useQuery)(__spreadProps(__spreadValues({}, options), {
|
|
47
|
+
enabled: true,
|
|
48
|
+
useErrorBoundary: true,
|
|
49
|
+
suspense: true
|
|
50
|
+
}));
|
|
51
|
+
}
|
|
52
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
53
|
+
0 && (module.exports = {
|
|
54
|
+
useSuspenseQuery
|
|
55
|
+
});
|
|
56
|
+
//# sourceMappingURL=useSuspenseQuery.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
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 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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAmF;AAuB5E,SAAS,iBAKd,SAA0E;AAC1E,aAAO,6BAAiD,iCACnD,UADmD;AAAA,IAEtD,SAAS;AAAA,IACT,kBAAkB;AAAA,IAClB,UAAU;AAAA,EACZ,EAAC;AACH;","names":[]}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { UseQueryResult, QueryKey, UseQueryOptions } from '@tanstack/react-query';
|
|
2
|
+
import { O as OmitKeyof } from './OmitKeyof-CFsZLI4k.cjs';
|
|
3
|
+
|
|
4
|
+
interface UseSuspenseQueryResult<TData = unknown, TError = unknown> extends OmitKeyof<UseQueryResult<TData, TError>, keyof Pick<UseQueryResult, 'isPlaceholderData'>> {
|
|
5
|
+
data: TData;
|
|
6
|
+
status: 'success';
|
|
7
|
+
}
|
|
8
|
+
interface UseSuspenseQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData'> {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* This hook is wrapping useQuery of `@tanstack/react-query` v4 with default suspense option.
|
|
12
|
+
* @see {@link https://suspensive.org/docs/react-query/useSuspenseQuery}
|
|
13
|
+
*/
|
|
14
|
+
declare function useSuspenseQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseSuspenseQueryResult<TData, TError>;
|
|
15
|
+
|
|
16
|
+
export { type UseSuspenseQueryOptions, type UseSuspenseQueryResult, useSuspenseQuery };
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { UseQueryResult, QueryKey, UseQueryOptions } from '@tanstack/react-query';
|
|
2
|
+
import { O as OmitKeyof } from './OmitKeyof-CFsZLI4k.js';
|
|
3
|
+
|
|
4
|
+
interface UseSuspenseQueryResult<TData = unknown, TError = unknown> extends OmitKeyof<UseQueryResult<TData, TError>, keyof Pick<UseQueryResult, 'isPlaceholderData'>> {
|
|
5
|
+
data: TData;
|
|
6
|
+
status: 'success';
|
|
7
|
+
}
|
|
8
|
+
interface UseSuspenseQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData'> {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* This hook is wrapping useQuery of `@tanstack/react-query` v4 with default suspense option.
|
|
12
|
+
* @see {@link https://suspensive.org/docs/react-query/useSuspenseQuery}
|
|
13
|
+
*/
|
|
14
|
+
declare function useSuspenseQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseSuspenseQueryResult<TData, TError>;
|
|
15
|
+
|
|
16
|
+
export { type UseSuspenseQueryOptions, type UseSuspenseQueryResult, useSuspenseQuery };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|
package/package.json
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@suspensive/react-query-4",
|
|
3
|
+
"version": "0.0.1-beta.0",
|
|
4
|
+
"description": "Useful helpers for @tanstack/react-query@4 with suspense",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"suspensive",
|
|
7
|
+
"react",
|
|
8
|
+
"react-query"
|
|
9
|
+
],
|
|
10
|
+
"homepage": "https://suspensive.org",
|
|
11
|
+
"bugs": "https://github.com/toss/suspensive/issues",
|
|
12
|
+
"repository": {
|
|
13
|
+
"type": "git",
|
|
14
|
+
"url": "https://github.com/toss/suspensive.git",
|
|
15
|
+
"directory": "packages/react-query"
|
|
16
|
+
},
|
|
17
|
+
"license": "MIT",
|
|
18
|
+
"author": {
|
|
19
|
+
"name": "Jonghyeon Ko",
|
|
20
|
+
"email": "jonghyeon@toss.im"
|
|
21
|
+
},
|
|
22
|
+
"sideEffects": false,
|
|
23
|
+
"type": "module",
|
|
24
|
+
"exports": {
|
|
25
|
+
".": {
|
|
26
|
+
"import": {
|
|
27
|
+
"types": "./dist/index.d.ts",
|
|
28
|
+
"default": "./dist/index.js"
|
|
29
|
+
},
|
|
30
|
+
"require": {
|
|
31
|
+
"types": "./dist/index.d.cts",
|
|
32
|
+
"default": "./dist/index.cjs"
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"./package.json": "./package.json"
|
|
36
|
+
},
|
|
37
|
+
"main": "dist/index.cjs",
|
|
38
|
+
"module": "dist/index.js",
|
|
39
|
+
"types": "dist/index.d.ts",
|
|
40
|
+
"files": [
|
|
41
|
+
"dist",
|
|
42
|
+
"src"
|
|
43
|
+
],
|
|
44
|
+
"devDependencies": {
|
|
45
|
+
"@tanstack/react-query": "^4.36.1",
|
|
46
|
+
"@types/react": "^18.3.3",
|
|
47
|
+
"@types/react-dom": "^18.3.0",
|
|
48
|
+
"react": "^18.3.1",
|
|
49
|
+
"react-dom": "^18.3.1",
|
|
50
|
+
"@suspensive/eslint-config": "0.0.0",
|
|
51
|
+
"@suspensive/react": "2.1.2-beta.0",
|
|
52
|
+
"@suspensive/test-utils": "0.0.0",
|
|
53
|
+
"@suspensive/tsconfig": "0.0.0-development",
|
|
54
|
+
"@suspensive/tsup": "0.0.0"
|
|
55
|
+
},
|
|
56
|
+
"peerDependencies": {
|
|
57
|
+
"@suspensive/react": "^2.1.2-beta.0",
|
|
58
|
+
"@tanstack/react-query": "^4",
|
|
59
|
+
"react": "^18"
|
|
60
|
+
},
|
|
61
|
+
"peerDependenciesMeta": {
|
|
62
|
+
"@suspensive/react": {
|
|
63
|
+
"optional": true
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
"publishConfig": {
|
|
67
|
+
"access": "public"
|
|
68
|
+
},
|
|
69
|
+
"scripts": {
|
|
70
|
+
"build": "tsup",
|
|
71
|
+
"ci:attw": "attw --pack",
|
|
72
|
+
"ci:eslint": "eslint \"**/*.{js,jsx,cjs,mjs,ts,tsx,cts,mts}\"",
|
|
73
|
+
"ci:publint": "publint --strict",
|
|
74
|
+
"ci:test": "vitest run --coverage --typecheck",
|
|
75
|
+
"ci:test:watch": "vitest --ui --coverage --typecheck",
|
|
76
|
+
"ci:type": "tsc --noEmit",
|
|
77
|
+
"clean": "rimraf ./dist && rimraf ./coverage",
|
|
78
|
+
"dev": "tsup --watch"
|
|
79
|
+
}
|
|
80
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { ErrorBoundary } from '@suspensive/react'
|
|
2
|
+
import { useQueryErrorResetBoundary } from '@tanstack/react-query'
|
|
3
|
+
import { type ComponentPropsWithoutRef, type ComponentRef, forwardRef } from 'react'
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* 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
|
|
7
|
+
* @see {@link https://suspensive.org/docs/react-query/QueryErrorBoundary}
|
|
8
|
+
*/
|
|
9
|
+
export const QueryErrorBoundary = forwardRef<
|
|
10
|
+
ComponentRef<typeof ErrorBoundary>,
|
|
11
|
+
ComponentPropsWithoutRef<typeof ErrorBoundary>
|
|
12
|
+
>(({ onReset, ...props }, resetRef) => {
|
|
13
|
+
const { reset } = useQueryErrorResetBoundary()
|
|
14
|
+
return (
|
|
15
|
+
<ErrorBoundary
|
|
16
|
+
{...props}
|
|
17
|
+
onReset={() => {
|
|
18
|
+
onReset?.()
|
|
19
|
+
reset()
|
|
20
|
+
}}
|
|
21
|
+
ref={resetRef}
|
|
22
|
+
/>
|
|
23
|
+
)
|
|
24
|
+
})
|
|
25
|
+
if (process.env.NODE_ENV === 'development') {
|
|
26
|
+
QueryErrorBoundary.displayName = 'QueryErrorBoundary'
|
|
27
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { queryFn, queryKey } from '@suspensive/test-utils'
|
|
2
|
+
import type { InfiniteData } from '@tanstack/react-query'
|
|
3
|
+
import type { ReactNode } from 'react'
|
|
4
|
+
import { describe, expectTypeOf, it } from 'vitest'
|
|
5
|
+
import { SuspenseInfiniteQuery } from './SuspenseInfiniteQuery'
|
|
6
|
+
import type { UseSuspenseInfiniteQueryResult } from './useSuspenseInfiniteQuery'
|
|
7
|
+
|
|
8
|
+
describe('<SuspenseInfiniteQuery/>', () => {
|
|
9
|
+
it('type error', () => {
|
|
10
|
+
;() => (
|
|
11
|
+
<SuspenseInfiniteQuery
|
|
12
|
+
queryKey={queryKey}
|
|
13
|
+
queryFn={queryFn}
|
|
14
|
+
//@ts-expect-error no suspense
|
|
15
|
+
suspense={boolean}
|
|
16
|
+
>
|
|
17
|
+
{(query) => <>{query.data.pages.filter(({ text }) => text)}</>}
|
|
18
|
+
</SuspenseInfiniteQuery>
|
|
19
|
+
)
|
|
20
|
+
;() => (
|
|
21
|
+
<SuspenseInfiniteQuery
|
|
22
|
+
queryKey={queryKey}
|
|
23
|
+
queryFn={queryFn}
|
|
24
|
+
//@ts-expect-error no useErrorBoundary
|
|
25
|
+
useErrorBoundary={boolean}
|
|
26
|
+
>
|
|
27
|
+
{(query) => <>{query.data.pages.filter(({ text }) => text)}</>}
|
|
28
|
+
</SuspenseInfiniteQuery>
|
|
29
|
+
)
|
|
30
|
+
;() => (
|
|
31
|
+
<SuspenseInfiniteQuery
|
|
32
|
+
queryKey={queryKey}
|
|
33
|
+
queryFn={queryFn}
|
|
34
|
+
//@ts-expect-error no enabled
|
|
35
|
+
enabled={boolean}
|
|
36
|
+
>
|
|
37
|
+
{(query) => <>{query.data.pages.filter(({ text }) => text)}</>}
|
|
38
|
+
</SuspenseInfiniteQuery>
|
|
39
|
+
)
|
|
40
|
+
;() => (
|
|
41
|
+
<SuspenseInfiniteQuery
|
|
42
|
+
queryKey={queryKey}
|
|
43
|
+
queryFn={queryFn}
|
|
44
|
+
//@ts-expect-error no placeholderData
|
|
45
|
+
placeholderData="placeholder"
|
|
46
|
+
>
|
|
47
|
+
{(query) => <>{query.data.pages.filter(({ text }) => text)}</>}
|
|
48
|
+
</SuspenseInfiniteQuery>
|
|
49
|
+
)
|
|
50
|
+
;() => (
|
|
51
|
+
<SuspenseInfiniteQuery
|
|
52
|
+
queryKey={queryKey}
|
|
53
|
+
queryFn={queryFn}
|
|
54
|
+
//@ts-expect-error no placeholderData
|
|
55
|
+
placeholderData="placeholder"
|
|
56
|
+
>
|
|
57
|
+
{(query) => <>{query.data.pages.filter(({ text }) => text)}</>}
|
|
58
|
+
</SuspenseInfiniteQuery>
|
|
59
|
+
)
|
|
60
|
+
})
|
|
61
|
+
|
|
62
|
+
it('type check', () => {
|
|
63
|
+
;() => (
|
|
64
|
+
<SuspenseInfiniteQuery queryKey={queryKey} queryFn={queryFn}>
|
|
65
|
+
{(query) => {
|
|
66
|
+
expectTypeOf(query).toEqualTypeOf<UseSuspenseInfiniteQueryResult<{ text: string }>>()
|
|
67
|
+
expectTypeOf(query.data).toEqualTypeOf<InfiniteData<{ text: string }>>()
|
|
68
|
+
expectTypeOf(query.status).toEqualTypeOf<'success'>()
|
|
69
|
+
return <></>
|
|
70
|
+
}}
|
|
71
|
+
</SuspenseInfiniteQuery>
|
|
72
|
+
)
|
|
73
|
+
;() => (
|
|
74
|
+
<SuspenseInfiniteQuery
|
|
75
|
+
queryKey={queryKey}
|
|
76
|
+
queryFn={queryFn}
|
|
77
|
+
select={(data) => ({
|
|
78
|
+
pages: data.pages.map(({ text }) => text),
|
|
79
|
+
pageParams: data.pageParams,
|
|
80
|
+
})}
|
|
81
|
+
>
|
|
82
|
+
{(selectedQuery) => {
|
|
83
|
+
expectTypeOf(selectedQuery).toEqualTypeOf<UseSuspenseInfiniteQueryResult<string>>()
|
|
84
|
+
expectTypeOf(selectedQuery.data).toEqualTypeOf<InfiniteData<string>>()
|
|
85
|
+
expectTypeOf(selectedQuery.status).toEqualTypeOf<'success'>()
|
|
86
|
+
return <></>
|
|
87
|
+
}}
|
|
88
|
+
</SuspenseInfiniteQuery>
|
|
89
|
+
)
|
|
90
|
+
|
|
91
|
+
expectTypeOf(
|
|
92
|
+
<SuspenseInfiniteQuery queryKey={queryKey} queryFn={queryFn}>
|
|
93
|
+
{() => <></>}
|
|
94
|
+
</SuspenseInfiniteQuery>
|
|
95
|
+
).toEqualTypeOf<JSX.Element>()
|
|
96
|
+
expectTypeOf(
|
|
97
|
+
<SuspenseInfiniteQuery queryKey={queryKey} queryFn={queryFn}>
|
|
98
|
+
{() => <></>}
|
|
99
|
+
</SuspenseInfiniteQuery>
|
|
100
|
+
).not.toEqualTypeOf<ReactNode>()
|
|
101
|
+
})
|
|
102
|
+
})
|