@openapi-qraft/tanstack-query-react-types 2.0.0-next.16 → 2.0.0-next.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/types/service-operation/ServiceOperationFetchInfiniteQuery.d.ts +4 -3
  3. package/dist/types/service-operation/ServiceOperationFetchInfiniteQuery.d.ts.map +1 -1
  4. package/dist/types/service-operation/ServiceOperationFetchQuery.d.ts +2 -1
  5. package/dist/types/service-operation/ServiceOperationFetchQuery.d.ts.map +1 -1
  6. package/dist/types/shared/ServiceOperationFetchInfiniteQueryOptions.d.ts +66 -0
  7. package/dist/types/shared/ServiceOperationFetchInfiniteQueryOptions.d.ts.map +1 -0
  8. package/dist/types/shared/ServiceOperationFetchQueryOptions.d.ts +8 -0
  9. package/dist/types/shared/ServiceOperationFetchQueryOptions.d.ts.map +1 -1
  10. package/dist/types/shared/index.d.ts +1 -1
  11. package/dist/types/shared/index.d.ts.map +1 -1
  12. package/package.json +2 -2
  13. package/src/service-operation/ServiceOperationFetchInfiniteQuery.ts +26 -57
  14. package/src/service-operation/ServiceOperationFetchQuery.ts +17 -0
  15. package/src/shared/{FetchInfiniteQueryOptions.ts → ServiceOperationFetchInfiniteQueryOptions.ts} +69 -13
  16. package/src/shared/ServiceOperationFetchQueryOptions.ts +15 -0
  17. package/src/shared/index.ts +1 -1
  18. package/dist/types/shared/FetchInfiniteQueryOptions.d.ts +0 -54
  19. package/dist/types/shared/FetchInfiniteQueryOptions.d.ts.map +0 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @openapi-qraft/tanstack-query-react-types
2
2
 
3
+ ## 2.0.0-next.18
4
+
5
+ ## 2.0.0-next.17
6
+
7
+ ### Minor Changes
8
+
9
+ - 8bbe14b: Added two new utility functions: `ensureQueryData` and `ensureInfiniteQueryData`. These methods improve data fetching workflows by allowing seamless retrieval of cached data or fetching it when unavailable. `ensureQueryData` supports standard queries, while `ensureInfiniteQueryData` is tailored for infinite queries, including paginated data handling.
10
+
3
11
  ## 2.0.0-next.16
4
12
 
5
13
  ## 2.0.0-next.15
package/dist/types/service-operation/ServiceOperationFetchInfiniteQuery.d.ts CHANGED
@@ -1,9 +1,10 @@
1
- import type { FetchInfiniteQueryOptionsByParameters, FetchInfiniteQueryOptionsByQueryKey, FetchInfiniteQueryOptionsQueryFn, OperationInfiniteData } from '@openapi-qraft/tanstack-query-react-types';
1
+ import type { OperationInfiniteData, ServiceOperationEnsureInfiniteQueryDataOptions, ServiceOperationFetchInfiniteQueryOptions } from '@openapi-qraft/tanstack-query-react-types';
2
2
  export interface ServiceOperationFetchInfiniteQuery<TSchema extends {
3
3
  url: string;
4
4
  method: string;
5
5
  }, TQueryFnData, TParams, TError> {
6
- fetchInfiniteQuery<TPageParam extends TParams>(options: (FetchInfiniteQueryOptionsByQueryKey<TSchema, TQueryFnData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>) | (FetchInfiniteQueryOptionsByParameters<TSchema, TQueryFnData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>)): Promise<OperationInfiniteData<TQueryFnData, TParams>>;
7
- prefetchInfiniteQuery<TPageParam extends TParams>(options: (FetchInfiniteQueryOptionsByQueryKey<TSchema, TQueryFnData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>) | (FetchInfiniteQueryOptionsByParameters<TSchema, TQueryFnData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>)): Promise<void>;
6
+ fetchInfiniteQuery<TPageParam extends TParams>(options: ServiceOperationFetchInfiniteQueryOptions<TSchema, TQueryFnData, TParams, TPageParam, TError>): Promise<OperationInfiniteData<TQueryFnData, TParams>>;
7
+ prefetchInfiniteQuery<TPageParam extends TParams>(options: ServiceOperationFetchInfiniteQueryOptions<TSchema, TQueryFnData, TParams, TPageParam, TError>): Promise<void>;
8
+ ensureInfiniteQueryData<TPageParam extends TParams>(options: ServiceOperationEnsureInfiniteQueryDataOptions<TSchema, TQueryFnData, TParams, TPageParam, TError>): Promise<OperationInfiniteData<TQueryFnData, TParams>>;
8
9
  }
9
10
  //# sourceMappingURL=ServiceOperationFetchInfiniteQuery.d.ts.map
package/dist/types/service-operation/ServiceOperationFetchInfiniteQuery.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ServiceOperationFetchInfiniteQuery.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationFetchInfiniteQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qCAAqC,EACrC,mCAAmC,EACnC,gCAAgC,EAChC,qBAAqB,EACtB,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,kCAAkC,CACjD,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM;IAEN,kBAAkB,CAAC,UAAU,SAAS,OAAO,EAC3C,OAAO,EACH,CAAC,mCAAmC,CAClC,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACC,gCAAgC,CAC9B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,CAAC,GACJ,CAAC,qCAAqC,CACpC,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACC,gCAAgC,CAC9B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,CAAC,GACP,OAAO,CAAC,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC;IAEzD,qBAAqB,CAAC,UAAU,SAAS,OAAO,EAC9C,OAAO,EACH,CAAC,mCAAmC,CAClC,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACC,gCAAgC,CAC9B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,CAAC,GACJ,CAAC,qCAAqC,CACpC,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACC,gCAAgC,CAC9B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,CAAC,GACP,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB"}
1
+ {"version":3,"file":"ServiceOperationFetchInfiniteQuery.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationFetchInfiniteQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,8CAA8C,EAC9C,yCAAyC,EAC1C,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,kCAAkC,CACjD,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM;IAEN,kBAAkB,CAAC,UAAU,SAAS,OAAO,EAC3C,OAAO,EAAE,yCAAyC,CAChD,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACA,OAAO,CAAC,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC;IAEzD,qBAAqB,CAAC,UAAU,SAAS,OAAO,EAC9C,OAAO,EAAE,yCAAyC,CAChD,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACA,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB,uBAAuB,CAAC,UAAU,SAAS,OAAO,EAChD,OAAO,EAAE,8CAA8C,CACrD,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACA,OAAO,CAAC,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC;CAC1D"}
package/dist/types/service-operation/ServiceOperationFetchQuery.d.ts CHANGED
@@ -1,9 +1,10 @@
1
- import type { AreAllOptional, ServiceOperationFetchQueryOptions } from '@openapi-qraft/tanstack-query-react-types';
1
+ import type { AreAllOptional, ServiceOperationEnsureQueryDataOptions, ServiceOperationFetchQueryOptions } from '@openapi-qraft/tanstack-query-react-types';
2
2
  export interface ServiceOperationFetchQuery<TSchema extends {
3
3
  url: string;
4
4
  method: string;
5
5
  }, TQueryFnData, TParams, TError> {
6
6
  fetchQuery(options: AreAllOptional<TParams> extends true ? ServiceOperationFetchQueryOptions<TSchema, TQueryFnData, TParams, TError> | void : ServiceOperationFetchQueryOptions<TSchema, TQueryFnData, TParams, TError>): Promise<TQueryFnData>;
7
7
  prefetchQuery(options: AreAllOptional<TParams> extends true ? ServiceOperationFetchQueryOptions<TSchema, TQueryFnData, TParams, TError> | void : ServiceOperationFetchQueryOptions<TSchema, TQueryFnData, TParams, TError>): Promise<void>;
8
+ ensureQueryData(options: AreAllOptional<TParams> extends true ? ServiceOperationEnsureQueryDataOptions<TSchema, TQueryFnData, TParams, TError> | void : ServiceOperationEnsureQueryDataOptions<TSchema, TQueryFnData, TParams, TError>): Promise<TQueryFnData>;
8
9
  }
9
10
  //# sourceMappingURL=ServiceOperationFetchQuery.d.ts.map
package/dist/types/service-operation/ServiceOperationFetchQuery.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ServiceOperationFetchQuery.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationFetchQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,iCAAiC,EAClC,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,0BAA0B,CACzC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM;IAEN,UAAU,CACR,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GACzC,iCAAiC,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,GAAG,IAAI,GACR,iCAAiC,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,GACJ,OAAO,CAAC,YAAY,CAAC,CAAC;IAEzB,aAAa,CACX,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GACzC,iCAAiC,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,GAAG,IAAI,GACR,iCAAiC,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,GACJ,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB"}
1
+ {"version":3,"file":"ServiceOperationFetchQuery.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationFetchQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,sCAAsC,EACtC,iCAAiC,EAClC,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,0BAA0B,CACzC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM;IAEN,UAAU,CACR,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GACzC,iCAAiC,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,GAAG,IAAI,GACR,iCAAiC,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,GACJ,OAAO,CAAC,YAAY,CAAC,CAAC;IAEzB,aAAa,CACX,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GACzC,iCAAiC,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,GAAG,IAAI,GACR,iCAAiC,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,GACJ,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB,eAAe,CACb,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GACzC,sCAAsC,CACpC,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,GAAG,IAAI,GACR,sCAAsC,CACpC,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,GACJ,OAAO,CAAC,YAAY,CAAC,CAAC;CAC1B"}
package/dist/types/shared/ServiceOperationFetchInfiniteQueryOptions.d.ts ADDED
@@ -0,0 +1,66 @@
1
+ import type { DefaultError, FetchQueryOptions, GetNextPageParamFunction, InitialPageParam, QueryFunction } from '@tanstack/query-core';
2
+ import type { OperationInfiniteData } from './OperationInfiniteData.js';
3
+ import type { PartialParameters } from './PartialParameters.js';
4
+ import type { ServiceOperationInfiniteQueryKey } from './ServiceOperationKey.js';
5
+ import { RequestFn } from './RequestFn.js';
6
+ export type ServiceOperationFetchInfiniteQueryOptions<TSchema extends {
7
+ url: string;
8
+ method: string;
9
+ }, TQueryFnData, TParams, TPageParam, TError = DefaultError> = (FetchInfiniteQueryOptionsByQueryKey<TSchema, TQueryFnData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>) | (FetchInfiniteQueryOptionsByParameters<TSchema, TQueryFnData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>);
10
+ export type ServiceOperationEnsureInfiniteQueryDataOptions<TSchema extends {
11
+ url: string;
12
+ method: string;
13
+ }, TQueryFnData, TParams, TPageParam, TError = DefaultError> = ((FetchInfiniteQueryOptionsByQueryKey<TSchema, TQueryFnData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>) & {
14
+ revalidateIfStale?: boolean;
15
+ }) | ((FetchInfiniteQueryOptionsByParameters<TSchema, TQueryFnData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>) & {
16
+ revalidateIfStale?: boolean;
17
+ });
18
+ type FetchInfiniteQueryPages<TQueryFnData = unknown, TPageParam = unknown> = {
19
+ pages?: never;
20
+ } | {
21
+ pages: number;
22
+ getNextPageParam: GetNextPageParamFunction<PartialParameters<TPageParam>, TQueryFnData>;
23
+ };
24
+ type FetchInfiniteQueryOptionsBase<TSchema extends {
25
+ url: string;
26
+ method: string;
27
+ }, TQueryFnData, TParams, TPageParam = unknown, TError = DefaultError> = Omit<FetchQueryOptions<TQueryFnData, TError, OperationInfiniteData<TQueryFnData, TParams>, ServiceOperationInfiniteQueryKey<TSchema, TParams>, TPageParam>, 'queryKey' | 'initialPageParam'> & InitialPageParam<PartialParameters<TPageParam>> & FetchInfiniteQueryPages<TQueryFnData, TPageParam>;
28
+ type FetchInfiniteQueryOptionsByQueryKey<TSchema extends {
29
+ url: string;
30
+ method: string;
31
+ }, TQueryFnData, TParams, TPageParam, TError = DefaultError> = FetchInfiniteQueryOptionsBase<TSchema, TQueryFnData, TParams, TPageParam, TError> & {
32
+ /**
33
+ * Fetch Queries by query key
34
+ */
35
+ queryKey?: ServiceOperationInfiniteQueryKey<TSchema, TParams>;
36
+ parameters?: never;
37
+ };
38
+ type FetchInfiniteQueryOptionsByParameters<TSchema extends {
39
+ url: string;
40
+ method: string;
41
+ }, TQueryFnData, TParams, TPageParam, TError = DefaultError> = FetchInfiniteQueryOptionsBase<TSchema, TQueryFnData, TParams, TPageParam, TError> & {
42
+ /**
43
+ * Fetch Queries by parameters
44
+ */
45
+ parameters?: TParams;
46
+ queryKey?: never;
47
+ };
48
+ type FetchInfiniteQueryOptionsQueryFn<TSchema extends {
49
+ url: string;
50
+ method: string;
51
+ }, TQueryFnData, TParams, TError> = {
52
+ queryFn: QueryFunction<TQueryFnData, ServiceOperationInfiniteQueryKey<TSchema, TParams>>;
53
+ } | {
54
+ /**
55
+ * Custom request function to use for the query
56
+ */
57
+ requestFn?: RequestFn<TQueryFnData, TError>;
58
+ /**
59
+ * Base URL to use for the request (used in the `queryFn`)
60
+ * @example 'https://api.example.com'
61
+ */
62
+ baseUrl?: string | undefined;
63
+ queryFn?: never;
64
+ };
65
+ export {};
66
+ //# sourceMappingURL=ServiceOperationFetchInfiniteQueryOptions.d.ts.map
package/dist/types/shared/ServiceOperationFetchInfiniteQueryOptions.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ServiceOperationFetchInfiniteQueryOptions.d.ts","sourceRoot":"","sources":["../../../src/shared/ServiceOperationFetchInfiniteQueryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,wBAAwB,EACxB,gBAAgB,EAChB,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,0BAA0B,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,MAAM,yCAAyC,CACnD,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,GAAG,YAAY,IAEnB,CAAC,mCAAmC,CAClC,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACC,gCAAgC,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,GAC3E,CAAC,qCAAqC,CACpC,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACC,gCAAgC,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAEhF,MAAM,MAAM,8CAA8C,CACxD,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,GAAG,YAAY,IAEnB,CAAC,CAAC,mCAAmC,CACnC,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACC,gCAAgC,CAC9B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,CAAC,GAAG;IAAE,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,GACvC,CAAC,CAAC,qCAAqC,CACrC,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GACC,gCAAgC,CAC9B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,CACP,CAAC,GAAG;IAAE,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAE5C,KAAK,uBAAuB,CAAC,YAAY,GAAG,OAAO,EAAE,UAAU,GAAG,OAAO,IACrE;IACE,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,GACD;IACE,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,wBAAwB,CACxC,iBAAiB,CAAC,UAAU,CAAC,EAC7B,YAAY,CACb,CAAC;CACH,CAAC;AAEN,KAAK,6BAA6B,CAChC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,UAAU,GAAG,OAAO,EACpB,MAAM,GAAG,YAAY,IACnB,IAAI,CACN,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,EAC5C,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,EAClD,UAAU,CACX,EACD,UAAU,GAAG,kBAAkB,CAChC,GACC,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,GAC/C,uBAAuB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AAEpD,KAAK,mCAAmC,CACtC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,GAAG,YAAY,IACnB,6BAA6B,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GAAG;IACF;;OAEG;IACH,QAAQ,CAAC,EAAE,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9D,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB,CAAC;AAEF,KAAK,qCAAqC,CACxC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,GAAG,YAAY,IACnB,6BAA6B,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GAAG;IACF;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB,CAAC;AAEF,KAAK,gCAAgC,CACnC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM,IAEJ;IACE,OAAO,EAAE,aAAa,CACpB,YAAY,EACZ,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,CACnD,CAAC;CACH,GACD;IACE;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC5C;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,CAAC"}
package/dist/types/shared/ServiceOperationFetchQueryOptions.d.ts CHANGED
@@ -5,6 +5,14 @@ export type ServiceOperationFetchQueryOptions<TSchema extends {
5
5
  url: string;
6
6
  method: string;
7
7
  }, TQueryFnData, TParams, TError> = (FetchQueryOptionsByQueryKey<TSchema, TQueryFnData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>) | (FetchQueryOptionsByParameters<TSchema, TQueryFnData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>);
8
+ export type ServiceOperationEnsureQueryDataOptions<TSchema extends {
9
+ url: string;
10
+ method: string;
11
+ }, TQueryFnData, TParams, TError> = (FetchQueryOptionsByQueryKey<TSchema, TQueryFnData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError> & {
12
+ revalidateIfStale?: boolean;
13
+ }) | (FetchQueryOptionsByParameters<TSchema, TQueryFnData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError> & {
14
+ revalidateIfStale?: boolean;
15
+ });
8
16
  type FetchQueryOptionsBase<TSchema extends {
9
17
  url: string;
10
18
  method: string;
package/dist/types/shared/ServiceOperationFetchQueryOptions.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ServiceOperationFetchQueryOptions.d.ts","sourceRoot":"","sources":["../../../src/shared/ServiceOperationFetchQueryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2CAA2C,CAAC;AAC3E,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAEzE,MAAM,MAAM,iCAAiC,CAC3C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM,IAEJ,CAAC,2BAA2B,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,GAClE,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,GACnE,CAAC,6BAA6B,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,GACpE,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAExE,KAAK,qBAAqB,CACxB,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,YAAY,IACnB,IAAI,CACN,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,YAAY,EACZ,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAC3C,EACD,UAAU,GAAG,SAAS,CACvB,CAAC;AAEF,UAAU,2BAA2B,CACnC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,YAAY,CACrB,SAAQ,qBAAqB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC;IACrE;;OAEG;IACH,QAAQ,EAAE,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB;AAED,UAAU,6BAA6B,CACrC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,YAAY,CACrB,SAAQ,qBAAqB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC;IACrE;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED,KAAK,wBAAwB,CAC3B,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM,IAEJ;IACE,OAAO,EAAE,aAAa,CACpB,YAAY,EACZ,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAC3C,CAAC;CACH,GACD;IACE;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC5C;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,CAAC"}
1
+ {"version":3,"file":"ServiceOperationFetchQueryOptions.d.ts","sourceRoot":"","sources":["../../../src/shared/ServiceOperationFetchQueryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2CAA2C,CAAC;AAC3E,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAEzE,MAAM,MAAM,iCAAiC,CAC3C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM,IAEJ,CAAC,2BAA2B,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,GAClE,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,GACnE,CAAC,6BAA6B,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,GACpE,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAExE,MAAM,MAAM,sCAAsC,CAChD,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM,IAEJ,CAAC,2BAA2B,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,GAClE,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG;IACjE,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC,GACJ,CAAC,6BAA6B,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,GACpE,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG;IACjE,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC,CAAC;AAET,KAAK,qBAAqB,CACxB,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,YAAY,IACnB,IAAI,CACN,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,YAAY,EACZ,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAC3C,EACD,UAAU,GAAG,SAAS,CACvB,CAAC;AAEF,UAAU,2BAA2B,CACnC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,YAAY,CACrB,SAAQ,qBAAqB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC;IACrE;;OAEG;IACH,QAAQ,EAAE,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB;AAED,UAAU,6BAA6B,CACrC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,YAAY,CACrB,SAAQ,qBAAqB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC;IACrE;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED,KAAK,wBAAwB,CAC3B,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM,IAEJ;IACE,OAAO,EAAE,aAAa,CACpB,YAAY,EACZ,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAC3C,CAAC;CACH,GACD;IACE;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC5C;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,CAAC"}
package/dist/types/shared/index.d.ts CHANGED
@@ -1,11 +1,11 @@
1
1
  export type * from './AreAllOptional.js';
2
- export type * from './FetchInfiniteQueryOptions.js';
3
2
  export type * from './InvalidateQueryFilters.js';
4
3
  export type * from './MutationFilters.js';
5
4
  export type * from './OperationInfiniteData.js';
6
5
  export type * from './PartialParameters.js';
7
6
  export type * from './QueryFilters.js';
8
7
  export type * from './RequestFn.js';
8
+ export type * from './ServiceOperationFetchInfiniteQueryOptions.js';
9
9
  export type * from './ServiceOperationFetchQueryOptions.js';
10
10
  export type * from './ServiceOperationKey.js';
11
11
  export type * from './ServiceOperationMutation.js';
package/dist/types/shared/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/shared/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,qBAAqB,CAAC;AACzC,mBAAmB,gCAAgC,CAAC;AACpD,mBAAmB,6BAA6B,CAAC;AACjD,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,gBAAgB,CAAC;AACpC,mBAAmB,wCAAwC,CAAC;AAC5D,mBAAmB,0BAA0B,CAAC;AAC9C,mBAAmB,+BAA+B,CAAC;AACnD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,yCAAyC,CAAC;AAC7D,mBAAmB,mBAAmB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/shared/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,qBAAqB,CAAC;AACzC,mBAAmB,6BAA6B,CAAC;AACjD,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,gBAAgB,CAAC;AACpC,mBAAmB,gDAAgD,CAAC;AACpE,mBAAmB,wCAAwC,CAAC;AAC5D,mBAAmB,0BAA0B,CAAC;AAC9C,mBAAmB,+BAA+B,CAAC;AACnD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,yCAAyC,CAAC;AAC7D,mBAAmB,mBAAmB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openapi-qraft/tanstack-query-react-types",
3
- "version": "2.0.0-next.16",
3
+ "version": "2.0.0-next.18",
4
4
  "scripts": {
5
5
  "build": "yarn clean && NODE_ENV=production rollup --config rollup.config.mjs && tsc --project tsconfig.build.json --emitDeclarationOnly",
6
6
  "dev": "yarn clean && tsc --project tsconfig.build.json --watch --outDir ./dist/esm --noEmitOnError false",
@@ -27,7 +27,7 @@
27
27
  "devDependencies": {
28
28
  "@openapi-qraft/eslint-config": "1.0.0",
29
29
  "@openapi-qraft/rollup-config": "1.1.0-next.0",
30
- "eslint": "^9.10.0",
30
+ "eslint": "^9.16.0",
31
31
  "rimraf": "^5.0.10",
32
32
  "rollup": "~4.22.4",
33
33
  "typescript": "^5.6.2"
package/src/service-operation/ServiceOperationFetchInfiniteQuery.ts CHANGED
@@ -1,8 +1,7 @@
1
1
  import type {
2
- FetchInfiniteQueryOptionsByParameters,
3
- FetchInfiniteQueryOptionsByQueryKey,
4
- FetchInfiniteQueryOptionsQueryFn,
5
2
  OperationInfiniteData,
3
+ ServiceOperationEnsureInfiniteQueryDataOptions,
4
+ ServiceOperationFetchInfiniteQueryOptions,
6
5
  } from '@openapi-qraft/tanstack-query-react-types';
7
6
 
8
7
  export interface ServiceOperationFetchInfiniteQuery<
@@ -12,62 +11,32 @@ export interface ServiceOperationFetchInfiniteQuery<
12
11
  TError,
13
12
  > {
14
13
  fetchInfiniteQuery<TPageParam extends TParams>(
15
- options:
16
- | (FetchInfiniteQueryOptionsByQueryKey<
17
- TSchema,
18
- TQueryFnData,
19
- TParams,
20
- TPageParam,
21
- TError
22
- > &
23
- FetchInfiniteQueryOptionsQueryFn<
24
- TSchema,
25
- TQueryFnData,
26
- TParams,
27
- TError
28
- >)
29
- | (FetchInfiniteQueryOptionsByParameters<
30
- TSchema,
31
- TQueryFnData,
32
- TParams,
33
- TPageParam,
34
- TError
35
- > &
36
- FetchInfiniteQueryOptionsQueryFn<
37
- TSchema,
38
- TQueryFnData,
39
- TParams,
40
- TError
41
- >)
14
+ options: ServiceOperationFetchInfiniteQueryOptions<
15
+ TSchema,
16
+ TQueryFnData,
17
+ TParams,
18
+ TPageParam,
19
+ TError
20
+ >
42
21
  ): Promise<OperationInfiniteData<TQueryFnData, TParams>>;
43
22
 
44
23
  prefetchInfiniteQuery<TPageParam extends TParams>(
45
- options:
46
- | (FetchInfiniteQueryOptionsByQueryKey<
47
- TSchema,
48
- TQueryFnData,
49
- TParams,
50
- TPageParam,
51
- TError
52
- > &
53
- FetchInfiniteQueryOptionsQueryFn<
54
- TSchema,
55
- TQueryFnData,
56
- TParams,
57
- TError
58
- >)
59
- | (FetchInfiniteQueryOptionsByParameters<
60
- TSchema,
61
- TQueryFnData,
62
- TParams,
63
- TPageParam,
64
- TError
65
- > &
66
- FetchInfiniteQueryOptionsQueryFn<
67
- TSchema,
68
- TQueryFnData,
69
- TParams,
70
- TError
71
- >)
24
+ options: ServiceOperationFetchInfiniteQueryOptions<
25
+ TSchema,
26
+ TQueryFnData,
27
+ TParams,
28
+ TPageParam,
29
+ TError
30
+ >
72
31
  ): Promise<void>;
32
+
33
+ ensureInfiniteQueryData<TPageParam extends TParams>(
34
+ options: ServiceOperationEnsureInfiniteQueryDataOptions<
35
+ TSchema,
36
+ TQueryFnData,
37
+ TParams,
38
+ TPageParam,
39
+ TError
40
+ >
41
+ ): Promise<OperationInfiniteData<TQueryFnData, TParams>>;
73
42
  }
package/src/service-operation/ServiceOperationFetchQuery.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import type {
2
2
  AreAllOptional,
3
+ ServiceOperationEnsureQueryDataOptions,
3
4
  ServiceOperationFetchQueryOptions,
4
5
  } from '@openapi-qraft/tanstack-query-react-types';
5
6
 
@@ -40,4 +41,20 @@ export interface ServiceOperationFetchQuery<
40
41
  TError
41
42
  >
42
43
  ): Promise<void>;
44
+
45
+ ensureQueryData(
46
+ options: AreAllOptional<TParams> extends true
47
+ ? ServiceOperationEnsureQueryDataOptions<
48
+ TSchema,
49
+ TQueryFnData,
50
+ TParams,
51
+ TError
52
+ > | void
53
+ : ServiceOperationEnsureQueryDataOptions<
54
+ TSchema,
55
+ TQueryFnData,
56
+ TParams,
57
+ TError
58
+ >
59
+ ): Promise<TQueryFnData>;
43
60
  }
package/src/shared/{FetchInfiniteQueryOptions.ts → ServiceOperationFetchInfiniteQueryOptions.ts} RENAMED
@@ -7,12 +7,67 @@ import type {
7
7
  } from '@tanstack/query-core';
8
8
  import type { OperationInfiniteData } from './OperationInfiniteData.js';
9
9
  import type { PartialParameters } from './PartialParameters.js';
10
- import type {
11
- ServiceOperationInfiniteQueryKey,
12
- ServiceOperationQueryKey,
13
- } from './ServiceOperationKey.js';
10
+ import type { ServiceOperationInfiniteQueryKey } from './ServiceOperationKey.js';
14
11
  import { RequestFn } from './RequestFn.js';
15
12
 
13
+ export type ServiceOperationFetchInfiniteQueryOptions<
14
+ TSchema extends { url: string; method: string },
15
+ TQueryFnData,
16
+ TParams,
17
+ TPageParam,
18
+ TError = DefaultError,
19
+ > =
20
+ | (FetchInfiniteQueryOptionsByQueryKey<
21
+ TSchema,
22
+ TQueryFnData,
23
+ TParams,
24
+ TPageParam,
25
+ TError
26
+ > &
27
+ FetchInfiniteQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>)
28
+ | (FetchInfiniteQueryOptionsByParameters<
29
+ TSchema,
30
+ TQueryFnData,
31
+ TParams,
32
+ TPageParam,
33
+ TError
34
+ > &
35
+ FetchInfiniteQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>);
36
+
37
+ export type ServiceOperationEnsureInfiniteQueryDataOptions<
38
+ TSchema extends { url: string; method: string },
39
+ TQueryFnData,
40
+ TParams,
41
+ TPageParam,
42
+ TError = DefaultError,
43
+ > =
44
+ | ((FetchInfiniteQueryOptionsByQueryKey<
45
+ TSchema,
46
+ TQueryFnData,
47
+ TParams,
48
+ TPageParam,
49
+ TError
50
+ > &
51
+ FetchInfiniteQueryOptionsQueryFn<
52
+ TSchema,
53
+ TQueryFnData,
54
+ TParams,
55
+ TError
56
+ >) & { revalidateIfStale?: boolean })
57
+ | ((FetchInfiniteQueryOptionsByParameters<
58
+ TSchema,
59
+ TQueryFnData,
60
+ TParams,
61
+ TPageParam,
62
+ TError
63
+ > &
64
+ FetchInfiniteQueryOptionsQueryFn<
65
+ TSchema,
66
+ TQueryFnData,
67
+ TParams,
68
+ TError
69
+ >) & { revalidateIfStale?: boolean });
70
+
16
71
  type FetchInfiniteQueryPages<TQueryFnData = unknown, TPageParam = unknown> =
17
72
  | {
18
73
  pages?: never;
@@ -28,7 +83,7 @@ type FetchInfiniteQueryPages<TQueryFnData = unknown, TPageParam = unknown> =
28
83
  type FetchInfiniteQueryOptionsBase<
29
84
  TSchema extends { url: string; method: string },
30
85
  TQueryFnData,
31
- TParams = {},
86
+ TParams,
32
87
  TPageParam = unknown,
33
88
  TError = DefaultError,
34
89
  > = Omit<
@@ -36,7 +91,7 @@ type FetchInfiniteQueryOptionsBase<
36
91
  TQueryFnData,
37
92
  TError,
38
93
  OperationInfiniteData<TQueryFnData, TParams>,
39
- ServiceOperationQueryKey<TSchema, TParams>,
94
+ ServiceOperationInfiniteQueryKey<TSchema, TParams>,
40
95
  TPageParam
41
96
  >,
42
97
  'queryKey' | 'initialPageParam'
@@ -44,11 +99,11 @@ type FetchInfiniteQueryOptionsBase<
44
99
  InitialPageParam<PartialParameters<TPageParam>> &
45
100
  FetchInfiniteQueryPages<TQueryFnData, TPageParam>;
46
101
 
47
- export type FetchInfiniteQueryOptionsByQueryKey<
102
+ type FetchInfiniteQueryOptionsByQueryKey<
48
103
  TSchema extends { url: string; method: string },
49
104
  TQueryFnData,
50
- TParams = {},
51
- TPageParam = {},
105
+ TParams,
106
+ TPageParam,
52
107
  TError = DefaultError,
53
108
  > = FetchInfiniteQueryOptionsBase<
54
109
  TSchema,
@@ -63,11 +118,12 @@ export type FetchInfiniteQueryOptionsByQueryKey<
63
118
  queryKey?: ServiceOperationInfiniteQueryKey<TSchema, TParams>;
64
119
  parameters?: never;
65
120
  };
66
- export type FetchInfiniteQueryOptionsByParameters<
121
+
122
+ type FetchInfiniteQueryOptionsByParameters<
67
123
  TSchema extends { url: string; method: string },
68
124
  TQueryFnData,
69
- TParams = {},
70
- TPageParam = {},
125
+ TParams,
126
+ TPageParam,
71
127
  TError = DefaultError,
72
128
  > = FetchInfiniteQueryOptionsBase<
73
129
  TSchema,
@@ -83,7 +139,7 @@ export type FetchInfiniteQueryOptionsByParameters<
83
139
  queryKey?: never;
84
140
  };
85
141
 
86
- export type FetchInfiniteQueryOptionsQueryFn<
142
+ type FetchInfiniteQueryOptionsQueryFn<
87
143
  TSchema extends { url: string; method: string },
88
144
  TQueryFnData,
89
145
  TParams,
package/src/shared/ServiceOperationFetchQueryOptions.ts CHANGED
@@ -17,6 +17,21 @@ export type ServiceOperationFetchQueryOptions<
17
17
  | (FetchQueryOptionsByParameters<TSchema, TQueryFnData, TParams, TError> &
18
18
  FetchQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError>);
19
19
 
20
+ export type ServiceOperationEnsureQueryDataOptions<
21
+ TSchema extends { url: string; method: string },
22
+ TQueryFnData,
23
+ TParams,
24
+ TError,
25
+ > =
26
+ | (FetchQueryOptionsByQueryKey<TSchema, TQueryFnData, TParams, TError> &
27
+ FetchQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError> & {
28
+ revalidateIfStale?: boolean;
29
+ })
30
+ | (FetchQueryOptionsByParameters<TSchema, TQueryFnData, TParams, TError> &
31
+ FetchQueryOptionsQueryFn<TSchema, TQueryFnData, TParams, TError> & {
32
+ revalidateIfStale?: boolean;
33
+ });
34
+
20
35
  type FetchQueryOptionsBase<
21
36
  TSchema extends { url: string; method: string },
22
37
  TQueryFnData,
package/src/shared/index.ts CHANGED
@@ -1,11 +1,11 @@
1
1
  export type * from './AreAllOptional.js';
2
- export type * from './FetchInfiniteQueryOptions.js';
3
2
  export type * from './InvalidateQueryFilters.js';
4
3
  export type * from './MutationFilters.js';
5
4
  export type * from './OperationInfiniteData.js';
6
5
  export type * from './PartialParameters.js';
7
6
  export type * from './QueryFilters.js';
8
7
  export type * from './RequestFn.js';
8
+ export type * from './ServiceOperationFetchInfiniteQueryOptions.js';
9
9
  export type * from './ServiceOperationFetchQueryOptions.js';
10
10
  export type * from './ServiceOperationKey.js';
11
11
  export type * from './ServiceOperationMutation.js';
package/dist/types/shared/FetchInfiniteQueryOptions.d.ts DELETED
@@ -1,54 +0,0 @@
1
- import type { DefaultError, FetchQueryOptions, GetNextPageParamFunction, InitialPageParam, QueryFunction } from '@tanstack/query-core';
2
- import type { OperationInfiniteData } from './OperationInfiniteData.js';
3
- import type { PartialParameters } from './PartialParameters.js';
4
- import type { ServiceOperationInfiniteQueryKey, ServiceOperationQueryKey } from './ServiceOperationKey.js';
5
- import { RequestFn } from './RequestFn.js';
6
- type FetchInfiniteQueryPages<TQueryFnData = unknown, TPageParam = unknown> = {
7
- pages?: never;
8
- } | {
9
- pages: number;
10
- getNextPageParam: GetNextPageParamFunction<PartialParameters<TPageParam>, TQueryFnData>;
11
- };
12
- type FetchInfiniteQueryOptionsBase<TSchema extends {
13
- url: string;
14
- method: string;
15
- }, TQueryFnData, TParams = {}, TPageParam = unknown, TError = DefaultError> = Omit<FetchQueryOptions<TQueryFnData, TError, OperationInfiniteData<TQueryFnData, TParams>, ServiceOperationQueryKey<TSchema, TParams>, TPageParam>, 'queryKey' | 'initialPageParam'> & InitialPageParam<PartialParameters<TPageParam>> & FetchInfiniteQueryPages<TQueryFnData, TPageParam>;
16
- export type FetchInfiniteQueryOptionsByQueryKey<TSchema extends {
17
- url: string;
18
- method: string;
19
- }, TQueryFnData, TParams = {}, TPageParam = {}, TError = DefaultError> = FetchInfiniteQueryOptionsBase<TSchema, TQueryFnData, TParams, TPageParam, TError> & {
20
- /**
21
- * Fetch Queries by query key
22
- */
23
- queryKey?: ServiceOperationInfiniteQueryKey<TSchema, TParams>;
24
- parameters?: never;
25
- };
26
- export type FetchInfiniteQueryOptionsByParameters<TSchema extends {
27
- url: string;
28
- method: string;
29
- }, TQueryFnData, TParams = {}, TPageParam = {}, TError = DefaultError> = FetchInfiniteQueryOptionsBase<TSchema, TQueryFnData, TParams, TPageParam, TError> & {
30
- /**
31
- * Fetch Queries by parameters
32
- */
33
- parameters?: TParams;
34
- queryKey?: never;
35
- };
36
- export type FetchInfiniteQueryOptionsQueryFn<TSchema extends {
37
- url: string;
38
- method: string;
39
- }, TQueryFnData, TParams, TError> = {
40
- queryFn: QueryFunction<TQueryFnData, ServiceOperationInfiniteQueryKey<TSchema, TParams>>;
41
- } | {
42
- /**
43
- * Custom request function to use for the query
44
- */
45
- requestFn?: RequestFn<TQueryFnData, TError>;
46
- /**
47
- * Base URL to use for the request (used in the `queryFn`)
48
- * @example 'https://api.example.com'
49
- */
50
- baseUrl?: string | undefined;
51
- queryFn?: never;
52
- };
53
- export {};
54
- //# sourceMappingURL=FetchInfiniteQueryOptions.d.ts.map
package/dist/types/shared/FetchInfiniteQueryOptions.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"FetchInfiniteQueryOptions.d.ts","sourceRoot":"","sources":["../../../src/shared/FetchInfiniteQueryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,wBAAwB,EACxB,gBAAgB,EAChB,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EACV,gCAAgC,EAChC,wBAAwB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,KAAK,uBAAuB,CAAC,YAAY,GAAG,OAAO,EAAE,UAAU,GAAG,OAAO,IACrE;IACE,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,GACD;IACE,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,wBAAwB,CACxC,iBAAiB,CAAC,UAAU,CAAC,EAC7B,YAAY,CACb,CAAC;CACH,CAAC;AAEN,KAAK,6BAA6B,CAChC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,UAAU,GAAG,OAAO,EACpB,MAAM,GAAG,YAAY,IACnB,IAAI,CACN,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,EAC5C,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,EAC1C,UAAU,CACX,EACD,UAAU,GAAG,kBAAkB,CAChC,GACC,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,GAC/C,uBAAuB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AAEpD,MAAM,MAAM,mCAAmC,CAC7C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,UAAU,GAAG,EAAE,EACf,MAAM,GAAG,YAAY,IACnB,6BAA6B,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GAAG;IACF;;OAEG;IACH,QAAQ,CAAC,EAAE,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9D,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,qCAAqC,CAC/C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,UAAU,GAAG,EAAE,EACf,MAAM,GAAG,YAAY,IACnB,6BAA6B,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GAAG;IACF;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,gCAAgC,CAC1C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM,IAEJ;IACE,OAAO,EAAE,aAAa,CACpB,YAAY,EACZ,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,CACnD,CAAC;CACH,GACD;IACE;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC5C;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,CAAC"}