@openapi-qraft/react 1.3.2 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/CHANGELOG.md +25 -1
  2. package/README.md +17 -17
  3. package/dist/ServiceOperation.d.ts +146 -40
  4. package/dist/ServiceOperation.d.ts.map +1 -1
  5. package/dist/callbacks/getInfiniteQueryState.d.ts +5 -0
  6. package/dist/callbacks/getInfiniteQueryState.d.ts.map +1 -0
  7. package/dist/callbacks/getInfiniteQueryState.js +5 -0
  8. package/dist/callbacks/getInfiniteQueryState.js.map +1 -0
  9. package/dist/callbacks/getQueriesData.d.ts +5 -0
  10. package/dist/callbacks/getQueriesData.d.ts.map +1 -0
  11. package/dist/callbacks/getQueriesData.js +5 -0
  12. package/dist/callbacks/getQueriesData.js.map +1 -0
  13. package/dist/callbacks/getQueryState.d.ts +5 -0
  14. package/dist/callbacks/getQueryState.d.ts.map +1 -0
  15. package/dist/callbacks/getQueryState.js +5 -0
  16. package/dist/callbacks/getQueryState.js.map +1 -0
  17. package/dist/callbacks/isMutating.d.ts +5 -0
  18. package/dist/callbacks/isMutating.d.ts.map +1 -0
  19. package/dist/callbacks/isMutating.js +5 -0
  20. package/dist/callbacks/isMutating.js.map +1 -0
  21. package/dist/callbacks/removeQueries.d.ts +5 -0
  22. package/dist/callbacks/removeQueries.d.ts.map +1 -0
  23. package/dist/callbacks/removeQueries.js +5 -0
  24. package/dist/callbacks/removeQueries.js.map +1 -0
  25. package/dist/callbacks/setQueriesData.d.ts +5 -0
  26. package/dist/callbacks/setQueriesData.d.ts.map +1 -0
  27. package/dist/callbacks/setQueriesData.js +5 -0
  28. package/dist/callbacks/setQueriesData.js.map +1 -0
  29. package/dist/callbacks/useIsFetching.js.map +1 -1
  30. package/dist/callbacks/useIsMutating.d.ts +7 -0
  31. package/dist/callbacks/useIsMutating.d.ts.map +1 -0
  32. package/dist/callbacks/useIsMutating.js +9 -0
  33. package/dist/callbacks/useIsMutating.js.map +1 -0
  34. package/dist/callbacks/useMutationState.d.ts.map +1 -1
  35. package/dist/callbacks/useMutationState.js +2 -15
  36. package/dist/callbacks/useMutationState.js.map +1 -1
  37. package/dist/lib/callQueryClientMethodWithMutationFilters.d.ts +11 -0
  38. package/dist/lib/callQueryClientMethodWithMutationFilters.d.ts.map +1 -0
  39. package/dist/lib/callQueryClientMethodWithMutationFilters.js +18 -0
  40. package/dist/lib/callQueryClientMethodWithMutationFilters.js.map +1 -0
  41. package/dist/lib/callQueryClientMethodWithQueryFilters.js +1 -1
  42. package/dist/lib/callQueryClientMethodWithQueryFilters.js.map +1 -1
  43. package/dist/lib/callQueryClientMethodWithQueryKey.js +1 -1
  44. package/dist/lib/callQueryClientMethodWithQueryKey.js.map +1 -1
  45. package/dist/lib/composeBaseQueryKey.d.ts +6 -0
  46. package/dist/lib/composeBaseQueryKey.d.ts.map +1 -0
  47. package/dist/lib/composeBaseQueryKey.js +7 -0
  48. package/dist/lib/composeBaseQueryKey.js.map +1 -0
  49. package/dist/lib/composeInfiniteQueryKey.d.ts.map +1 -1
  50. package/dist/lib/composeInfiniteQueryKey.js +2 -1
  51. package/dist/lib/composeInfiniteQueryKey.js.map +1 -1
  52. package/dist/lib/composeMutationFilters.d.ts +11 -0
  53. package/dist/lib/composeMutationFilters.d.ts.map +1 -0
  54. package/dist/lib/composeMutationFilters.js +32 -0
  55. package/dist/lib/composeMutationFilters.js.map +1 -0
  56. package/dist/lib/composeMutationKey.js +1 -1
  57. package/dist/lib/composeMutationKey.js.map +1 -1
  58. package/dist/lib/composeQueryFilters.d.ts +5 -2
  59. package/dist/lib/composeQueryFilters.d.ts.map +1 -1
  60. package/dist/lib/composeQueryFilters.js +17 -11
  61. package/dist/lib/composeQueryFilters.js.map +1 -1
  62. package/dist/lib/composeQueryKey.d.ts.map +1 -1
  63. package/dist/lib/composeQueryKey.js +2 -1
  64. package/dist/lib/composeQueryKey.js.map +1 -1
  65. package/package.json +4 -3
  66. package/src/ServiceOperation.ts +344 -84
  67. package/src/callbacks/getInfiniteQueryState.ts +23 -0
  68. package/src/callbacks/getQueriesData.ts +18 -0
  69. package/src/callbacks/getQueryState.ts +19 -0
  70. package/src/callbacks/isMutating.ts +22 -0
  71. package/src/callbacks/removeQueries.ts +22 -0
  72. package/src/callbacks/setQueriesData.ts +22 -0
  73. package/src/callbacks/useIsFetching.ts +1 -1
  74. package/src/callbacks/useIsMutating.ts +42 -0
  75. package/src/callbacks/useMutationState.ts +2 -27
  76. package/src/lib/callQueryClientMethodWithMutationFilters.ts +37 -0
  77. package/src/lib/callQueryClientMethodWithQueryFilters.ts +1 -1
  78. package/src/lib/callQueryClientMethodWithQueryKey.ts +1 -1
  79. package/src/lib/composeBaseQueryKey.ts +34 -0
  80. package/src/lib/composeInfiniteQueryKey.ts +2 -1
  81. package/src/lib/composeMutationFilters.ts +44 -0
  82. package/src/lib/composeMutationKey.ts +1 -1
  83. package/src/lib/composeQueryFilters.ts +24 -16
  84. package/src/lib/composeQueryKey.ts +2 -1
@@ -20,6 +20,7 @@ import {
20
20
  QueryFunction,
21
21
  InitialPageParam,
22
22
  GetNextPageParamFunction,
23
+ QueryState,
23
24
  } from '@tanstack/query-core';
24
25
  import type {
25
26
  DefinedInitialDataInfiniteOptions,
@@ -41,15 +42,21 @@ import type {
41
42
 
42
43
  import type { RequestFn } from './lib/requestFn.js';
43
44
 
45
+ type ServiceOperationBaseQueryKey<
46
+ S extends { url: string; method: string },
47
+ Infinite extends boolean,
48
+ T,
49
+ > = [S & { infinite: Infinite }, T];
50
+
44
51
  export type ServiceOperationQueryKey<
45
52
  S extends { url: string; method: string },
46
53
  T,
47
- > = [S, T];
54
+ > = ServiceOperationBaseQueryKey<S, false, T>;
48
55
 
49
56
  export type ServiceOperationInfiniteQueryKey<
50
57
  S extends { url: string; method: string },
51
58
  T,
52
- > = [S & { infinite: true }, T];
59
+ > = ServiceOperationBaseQueryKey<S, true, T>;
53
60
 
54
61
  export type ServiceOperationMutationKey<
55
62
  S extends Record<'url' | 'method', string>,
@@ -72,11 +79,15 @@ export interface ServiceOperationQuery<
72
79
  ServiceOperationFetchQuery<TSchema, TData, TParams, TError>,
73
80
  ServiceOperationFetchInfiniteQuery<TSchema, TData, TParams, TError>,
74
81
  ServiceOperationGetQueryData<TSchema, TData, TParams>,
82
+ ServiceOperationGetQueryState<TSchema, TData, TParams, TError>,
83
+ ServiceOperationGetQueriesData<TSchema, TData, TParams, TError>,
75
84
  ServiceOperationGetInfiniteQueryData<TSchema, TData, TParams>,
76
85
  ServiceOperationSetQueryData<TSchema, TData, TParams>,
86
+ ServiceOperationSetQueriesData<TSchema, TData, TParams, TError>,
77
87
  ServiceOperationSetInfiniteQueryData<TSchema, TData, TParams>,
78
88
  ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError>,
79
89
  ServiceOperationCancelQueries<TSchema, TData, TParams, TError>,
90
+ ServiceOperationRemoveQueries<TSchema, TData, TParams, TError>,
80
91
  ServiceOperationResetQueries<TSchema, TData, TParams, TError>,
81
92
  ServiceOperationRefetchQueries<TSchema, TData, TParams, TError>,
82
93
  ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
@@ -389,9 +400,18 @@ type QueryTypeFilter = 'all' | 'active' | 'inactive';
389
400
  interface QueryFiltersBase<
390
401
  TSchema extends { url: string; method: string },
391
402
  TData,
403
+ TInfinite extends boolean,
392
404
  TParams = {},
393
405
  TError = DefaultError,
394
406
  > {
407
+ /**
408
+ * Include queries matching this predicate function
409
+ */
410
+ predicate?: TInfinite extends true
411
+ ? QueryFilterInfinitePredicate<TSchema, TData, TParams, TError>
412
+ : TInfinite extends false
413
+ ? QueryFilterRegularPredicate<TSchema, TData, TParams, TError>
414
+ : (query: string) => boolean;
395
415
  /**
396
416
  * Filter to active queries, inactive queries or all queries
397
417
  */
@@ -400,18 +420,6 @@ interface QueryFiltersBase<
400
420
  * Match query key exactly
401
421
  */
402
422
  exact?: boolean;
403
- /**
404
- * Include queries matching this predicate function
405
- */
406
- predicate?: (
407
- query: Query<
408
- TData,
409
- TError,
410
- TData,
411
- | ServiceOperationQueryKey<TSchema, TParams>
412
- | ServiceOperationInfiniteQueryKey<TSchema, TParams>
413
- >
414
- ) => boolean;
415
423
  /**
416
424
  * Include or exclude stale queries
417
425
  */
@@ -425,35 +433,86 @@ interface QueryFiltersBase<
425
433
  interface QueryFiltersByQueryKey<
426
434
  TSchema extends { url: string; method: string },
427
435
  TData,
436
+ TInfinite extends boolean,
428
437
  TParams = {},
429
438
  TError = DefaultError,
430
- > extends QueryFiltersBase<TSchema, TData, TParams, TError> {
439
+ > extends QueryFiltersBase<TSchema, TData, TInfinite, TParams, TError> {
431
440
  /**
432
441
  * Include queries matching this query key
433
442
  */
434
- queryKey?: ServiceOperationQueryKey<TSchema, TParams>;
443
+ queryKey?: ServiceOperationBaseQueryKey<TSchema, TInfinite, TParams>;
444
+
445
+ infinite?: never;
446
+ parameters?: never;
435
447
  }
436
448
 
437
449
  interface QueryFiltersByParameters<
438
450
  TSchema extends { url: string; method: string },
439
451
  TData,
452
+ TInfinite extends boolean,
440
453
  TParams = {},
441
454
  TError = DefaultError,
442
- > extends QueryFiltersBase<TSchema, TData, TParams, TError> {
455
+ > extends QueryFiltersBase<TSchema, TData, TInfinite, TParams, TError> {
456
+ /**
457
+ * Is the query infinite
458
+ */
459
+ infinite?: TInfinite;
460
+
443
461
  /**
444
462
  * Include queries matching parameters
445
463
  */
446
464
  parameters?: TParams;
465
+
466
+ queryKey?: never;
467
+ }
468
+
469
+ interface QueryFilterInfinitePredicate<
470
+ TSchema extends { url: string; method: string },
471
+ TData,
472
+ TParams = {},
473
+ TError = DefaultError,
474
+ > {
475
+ /**
476
+ * Include queries matching this predicate function
477
+ */
478
+ (
479
+ query: Query<
480
+ InfiniteData<TData, TParams>,
481
+ TError,
482
+ InfiniteData<TData, TParams>,
483
+ ServiceOperationInfiniteQueryKey<TSchema, TParams>
484
+ >
485
+ ): boolean;
486
+ }
487
+
488
+ interface QueryFilterRegularPredicate<
489
+ TSchema extends { url: string; method: string },
490
+ TData,
491
+ TParams = {},
492
+ TError = DefaultError,
493
+ > {
494
+ /**
495
+ * Include queries matching this predicate function
496
+ */
497
+ (
498
+ query: Query<
499
+ TData,
500
+ TError,
501
+ TData,
502
+ ServiceOperationQueryKey<TSchema, TParams>
503
+ >
504
+ ): boolean;
447
505
  }
448
506
 
449
507
  type InvalidateQueryFilters<
450
508
  TSchema extends { url: string; method: string },
451
509
  TData,
510
+ TInfinite extends boolean,
452
511
  TParams = {},
453
512
  TError = DefaultError,
454
513
  > = (
455
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
456
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>
514
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
515
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
457
516
  ) & {
458
517
  refetchType?: QueryTypeFilter | 'none';
459
518
  };
@@ -464,13 +523,13 @@ interface ServiceOperationInvalidateQueries<
464
523
  TParams = {},
465
524
  TError = DefaultError,
466
525
  > {
467
- invalidateQueries(
468
- filters: InvalidateQueryFilters<TSchema, TData, TParams, TError>,
526
+ invalidateQueries<TInfinite extends boolean>(
527
+ filters: InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError>,
469
528
  options: InvalidateOptions,
470
529
  queryClient: QueryClient
471
530
  ): Promise<void>;
472
- invalidateQueries(
473
- filters: InvalidateQueryFilters<TSchema, TData, TParams, TError>,
531
+ invalidateQueries<TInfinite extends boolean>(
532
+ filters: InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError>,
474
533
  queryClient: QueryClient
475
534
  ): Promise<void>;
476
535
  invalidateQueries(queryClient: QueryClient): Promise<void>;
@@ -485,10 +544,9 @@ export interface ServiceOperationInvalidateQueriesCallback<
485
544
  TParams = {},
486
545
  TError = DefaultError,
487
546
  > extends ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError> {
488
- invalidateQueries(
547
+ invalidateQueries<TInfinite extends boolean>(
489
548
  filters:
490
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
491
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>
549
+ | InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError>
492
550
  | QueryClient,
493
551
  options?: InvalidateOptions | QueryClient,
494
552
  queryClient?: QueryClient
@@ -501,17 +559,17 @@ interface ServiceOperationCancelQueries<
501
559
  TParams = {},
502
560
  TError = DefaultError,
503
561
  > {
504
- cancelQueries(
562
+ cancelQueries<TInfinite extends boolean>(
505
563
  filters:
506
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
507
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>,
564
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
565
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
508
566
  options: CancelOptions,
509
567
  queryClient: QueryClient
510
568
  ): Promise<void>;
511
- cancelQueries(
569
+ cancelQueries<TInfinite extends boolean>(
512
570
  filters:
513
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
514
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>,
571
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
572
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
515
573
  queryClient: QueryClient
516
574
  ): Promise<void>;
517
575
  cancelQueries(queryClient: QueryClient): Promise<void>;
@@ -526,33 +584,66 @@ export interface ServiceOperationCancelQueriesCallback<
526
584
  TParams = {},
527
585
  TError = DefaultError,
528
586
  > extends ServiceOperationCancelQueries<TSchema, TData, TParams, TError> {
529
- cancelQueries(
587
+ cancelQueries<TInfinite extends boolean>(
530
588
  filters:
531
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
532
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>
589
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
590
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
533
591
  | QueryClient,
534
592
  options?: CancelOptions | QueryClient,
535
593
  queryClient?: QueryClient
536
594
  ): Promise<void>;
537
595
  }
538
596
 
597
+ interface ServiceOperationRemoveQueries<
598
+ TSchema extends { url: string; method: string },
599
+ TData,
600
+ TParams = {},
601
+ TError = DefaultError,
602
+ > {
603
+ removeQueries<TInfinite extends boolean>(
604
+ filters:
605
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
606
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
607
+ queryClient: QueryClient
608
+ ): void;
609
+ removeQueries(queryClient: QueryClient): void;
610
+ }
611
+
612
+ /**
613
+ * @internal
614
+ */
615
+ export interface ServiceOperationRemoveQueriesCallback<
616
+ TSchema extends { url: string; method: string },
617
+ TData,
618
+ TParams = {},
619
+ TError = DefaultError,
620
+ > extends ServiceOperationRemoveQueries<TSchema, TData, TParams, TError> {
621
+ removeQueries<TInfinite extends boolean>(
622
+ filters:
623
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
624
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
625
+ | QueryClient,
626
+ queryClient?: QueryClient
627
+ ): void;
628
+ }
629
+
539
630
  interface ServiceOperationResetQueries<
540
631
  TSchema extends { url: string; method: string },
541
632
  TData,
542
633
  TParams = {},
543
634
  TError = DefaultError,
544
635
  > {
545
- resetQueries(
636
+ resetQueries<TInfinite extends boolean>(
546
637
  filters:
547
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
548
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>,
638
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
639
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
549
640
  options: ResetOptions,
550
641
  queryClient: QueryClient
551
642
  ): Promise<void>;
552
- resetQueries(
643
+ resetQueries<TInfinite extends boolean>(
553
644
  filters:
554
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
555
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>,
645
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
646
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
556
647
  queryClient: QueryClient
557
648
  ): Promise<void>;
558
649
  resetQueries(queryClient: QueryClient): Promise<void>;
@@ -567,10 +658,10 @@ export interface ServiceOperationResetQueriesCallback<
567
658
  TParams = {},
568
659
  TError = DefaultError,
569
660
  > extends ServiceOperationResetQueries<TSchema, TData, TParams, TError> {
570
- resetQueries(
661
+ resetQueries<TInfinite extends boolean>(
571
662
  filters:
572
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
573
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>
663
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
664
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
574
665
  | QueryClient,
575
666
  options?: ResetOptions | QueryClient,
576
667
  queryClient?: QueryClient
@@ -583,17 +674,17 @@ interface ServiceOperationRefetchQueries<
583
674
  TParams = {},
584
675
  TError = DefaultError,
585
676
  > {
586
- refetchQueries(
677
+ refetchQueries<TInfinite extends boolean>(
587
678
  filters:
588
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
589
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>,
679
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
680
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
590
681
  options: RefetchOptions,
591
682
  queryClient: QueryClient
592
683
  ): Promise<void>;
593
- refetchQueries(
684
+ refetchQueries<TInfinite extends boolean>(
594
685
  filters:
595
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
596
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>,
686
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
687
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
597
688
  queryClient: QueryClient
598
689
  ): Promise<void>;
599
690
  refetchQueries(queryClient: QueryClient): Promise<void>;
@@ -608,10 +699,10 @@ export interface ServiceOperationResetQueriesCallback<
608
699
  TParams = {},
609
700
  TError = DefaultError,
610
701
  > extends ServiceOperationRefetchQueries<TSchema, TData, TParams, TError> {
611
- refetchQueries(
702
+ refetchQueries<TInfinite extends boolean>(
612
703
  filters:
613
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
614
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>
704
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
705
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
615
706
  | QueryClient,
616
707
  options?: RefetchOptions | QueryClient,
617
708
  queryClient?: QueryClient
@@ -624,10 +715,10 @@ interface ServiceOperationIsFetchingQueries<
624
715
  TParams = {},
625
716
  TError = DefaultError,
626
717
  > {
627
- isFetching(
718
+ isFetching<TInfinite extends boolean>(
628
719
  filters:
629
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
630
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>,
720
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
721
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
631
722
  queryClient: QueryClient
632
723
  ): number;
633
724
  isFetching(queryClient: QueryClient): number;
@@ -642,10 +733,10 @@ export interface ServiceOperationIsFetchingQueriesCallback<
642
733
  TParams = {},
643
734
  TError = DefaultError,
644
735
  > extends ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
645
- refetchQueries(
736
+ refetchQueries<TInfinite extends boolean>(
646
737
  filters:
647
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
648
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>
738
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
739
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
649
740
  | QueryClient,
650
741
  queryClient?: QueryClient
651
742
  ): number;
@@ -657,10 +748,10 @@ interface ServiceOperationUseIsFetchingQueries<
657
748
  TParams = {},
658
749
  TError = DefaultError,
659
750
  > {
660
- useIsFetching(
751
+ useIsFetching<TInfinite extends boolean>(
661
752
  filters?:
662
- | QueryFiltersByParameters<TSchema, TData, TParams, TError>
663
- | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>,
753
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
754
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
664
755
  queryClient?: QueryClient
665
756
  ): number;
666
757
  }
@@ -714,7 +805,7 @@ interface ServiceOperationUseInfiniteQuery<
714
805
  UndefinedInitialDataInfiniteOptions<
715
806
  TData,
716
807
  TError,
717
- InfiniteData<TData>,
808
+ InfiniteData<TData, TParams>,
718
809
  ServiceOperationInfiniteQueryKey<TSchema, TParams>,
719
810
  PartialParameters<TPageParam>
720
811
  >,
@@ -725,14 +816,14 @@ interface ServiceOperationUseInfiniteQuery<
725
816
  > &
726
817
  InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>,
727
818
  queryClient?: QueryClient
728
- ): UseInfiniteQueryResult<InfiniteData<TData>, TError | Error>;
819
+ ): UseInfiniteQueryResult<InfiniteData<TData, TParams>, TError | Error>;
729
820
  useInfiniteQuery<TPageParam extends TParams>(
730
821
  parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
731
822
  options: Omit<
732
823
  DefinedInitialDataInfiniteOptions<
733
824
  TData,
734
825
  TError,
735
- InfiniteData<TData>,
826
+ InfiniteData<TData, TParams>,
736
827
  ServiceOperationInfiniteQueryKey<TSchema, TParams>,
737
828
  PartialParameters<TPageParam>
738
829
  >,
@@ -743,7 +834,10 @@ interface ServiceOperationUseInfiniteQuery<
743
834
  > &
744
835
  InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>,
745
836
  queryClient?: QueryClient
746
- ): DefinedUseInfiniteQueryResult<InfiniteData<TData>, TError | Error>;
837
+ ): DefinedUseInfiniteQueryResult<
838
+ InfiniteData<TData, TParams>,
839
+ TError | Error
840
+ >;
747
841
  }
748
842
 
749
843
  interface ServiceOperationUseSuspenseInfiniteQuery<
@@ -758,7 +852,7 @@ interface ServiceOperationUseSuspenseInfiniteQuery<
758
852
  UseSuspenseInfiniteQueryOptions<
759
853
  TData,
760
854
  TError,
761
- InfiniteData<TData>,
855
+ InfiniteData<TData, TParams>,
762
856
  TData,
763
857
  ServiceOperationInfiniteQueryKey<TSchema, TParams>,
764
858
  PartialParameters<TPageParam>
@@ -770,7 +864,10 @@ interface ServiceOperationUseSuspenseInfiniteQuery<
770
864
  > &
771
865
  InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>,
772
866
  queryClient?: QueryClient
773
- ): UseSuspenseInfiniteQueryResult<InfiniteData<TData>, TError | Error>;
867
+ ): UseSuspenseInfiniteQueryResult<
868
+ InfiniteData<TData, TParams>,
869
+ TError | Error
870
+ >;
774
871
  }
775
872
 
776
873
  interface ServiceOperationUseSuspenseQueryQuery<
@@ -801,7 +898,9 @@ export interface ServiceOperationMutation<
801
898
  TParams,
802
899
  TError = DefaultError,
803
900
  > extends ServiceOperationUseMutation<TSchema, TBody, TData, TParams, TError>,
901
+ ServiceOperationUseIsMutating<TSchema, TBody, TData, TParams, TError>,
804
902
  ServiceOperationUseMutationState<TSchema, TBody, TData, TParams, TError>,
903
+ ServiceOperationIsMutatingQueries<TSchema, TBody, TData, TParams, TError>,
805
904
  ServiceOperationMutationFn<TSchema, TBody, TData, TParams> {
806
905
  schema: TSchema;
807
906
  types: {
@@ -819,8 +918,8 @@ interface ServiceOperationUseMutation<
819
918
  TParams,
820
919
  TError = DefaultError,
821
920
  > {
822
- getMutationKey<TMutationKeyParams extends TParams>(
823
- parameters: TMutationKeyParams | undefined
921
+ getMutationKey<TMutationKeyParams extends TParams | undefined = undefined>(
922
+ parameters?: TMutationKeyParams
824
923
  ): ServiceOperationMutationKey<TSchema, TMutationKeyParams>;
825
924
 
826
925
  useMutation<
@@ -876,7 +975,7 @@ interface UseMutationStateFiltersBase<
876
975
  status?: MutationStatus;
877
976
  }
878
977
 
879
- interface UseMutationStateFiltersByParameters<
978
+ interface MutationFiltersByParameters<
880
979
  TBody,
881
980
  TData,
882
981
  TParams,
@@ -887,9 +986,10 @@ interface UseMutationStateFiltersByParameters<
887
986
  * Include mutations matching these parameters
888
987
  */
889
988
  parameters?: PartialParameters<TParams>;
989
+ mutationKey?: never;
890
990
  }
891
991
 
892
- interface UseMutationStateFiltersByMutationKey<
992
+ interface MutationFiltersByMutationKey<
893
993
  TSchema extends { url: string; method: string },
894
994
  TBody,
895
995
  TData,
@@ -904,6 +1004,7 @@ interface UseMutationStateFiltersByMutationKey<
904
1004
  TSchema,
905
1005
  PartialParameters<TParams>
906
1006
  >;
1007
+ parameters?: never;
907
1008
  }
908
1009
 
909
1010
  type MutationVariables<TBody, TParams> = {
@@ -928,14 +1029,8 @@ interface ServiceOperationUseMutationState<
928
1029
  >(
929
1030
  options?: {
930
1031
  filters?:
931
- | UseMutationStateFiltersByParameters<
932
- TBody,
933
- TData,
934
- TParams,
935
- TError,
936
- TContext
937
- >
938
- | UseMutationStateFiltersByMutationKey<
1032
+ | MutationFiltersByParameters<TBody, TData, TParams, TError, TContext>
1033
+ | MutationFiltersByMutationKey<
939
1034
  TSchema,
940
1035
  TBody,
941
1036
  TData,
@@ -956,6 +1051,28 @@ interface ServiceOperationUseMutationState<
956
1051
  ): Array<TResult>;
957
1052
  }
958
1053
 
1054
+ interface ServiceOperationUseIsMutating<
1055
+ TSchema extends { url: string; method: string },
1056
+ TBody,
1057
+ TData,
1058
+ TParams,
1059
+ TError = DefaultError,
1060
+ > {
1061
+ useIsMutating<TContext = unknown>(
1062
+ filters?:
1063
+ | MutationFiltersByParameters<TBody, TData, TParams, TError, TContext>
1064
+ | MutationFiltersByMutationKey<
1065
+ TSchema,
1066
+ TBody,
1067
+ TData,
1068
+ TParams,
1069
+ TError,
1070
+ TContext
1071
+ >,
1072
+ queryClient?: QueryClient
1073
+ ): number;
1074
+ }
1075
+
959
1076
  interface QueryFnOptionsBase<
960
1077
  TMeta extends Record<string, any>,
961
1078
  TSignal extends AbortSignal = AbortSignal,
@@ -1057,6 +1174,75 @@ export interface ServiceOperationSetQueryDataCallback<
1057
1174
  ): TData | undefined;
1058
1175
  }
1059
1176
 
1177
+ interface ServiceOperationSetQueriesData<
1178
+ TSchema extends { url: string; method: string },
1179
+ TData,
1180
+ TParams = {}, // todo::try to replace `TParams = {}` with `TParams = undefined`
1181
+ TError = DefaultError,
1182
+ > {
1183
+ setQueriesData<TInfinite extends boolean>(
1184
+ filters:
1185
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
1186
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
1187
+ updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
1188
+ options: SetDataOptions,
1189
+ queryClient: QueryClient
1190
+ ): Array<TData | undefined>;
1191
+
1192
+ setQueriesData<TInfinite extends boolean>(
1193
+ filters:
1194
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
1195
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
1196
+ updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
1197
+ queryClient: QueryClient
1198
+ ): Array<TData | undefined>;
1199
+ }
1200
+
1201
+ /**
1202
+ * @internal
1203
+ */
1204
+ export interface ServiceOperationSetQueriesDataCallback<
1205
+ TSchema extends { url: string; method: string },
1206
+ TData,
1207
+ TParams = {},
1208
+ TError = DefaultError,
1209
+ > extends ServiceOperationSetQueriesData<TSchema, TData, TParams, TError> {
1210
+ setQueriesData<TInfinite extends boolean>(
1211
+ filters:
1212
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
1213
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
1214
+ updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
1215
+ options: SetDataOptions | QueryClient,
1216
+ queryClient?: QueryClient
1217
+ ): Array<TData | undefined>;
1218
+ }
1219
+
1220
+ interface ServiceOperationGetQueriesData<
1221
+ TSchema extends { url: string; method: string },
1222
+ TData,
1223
+ TParams = {}, // todo::try to replace `TParams = {}` with `TParams = undefined`
1224
+ TError = DefaultError,
1225
+ > {
1226
+ getQueriesData<TInfinite extends boolean>(
1227
+ filters:
1228
+ | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
1229
+ | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
1230
+ queryClient: QueryClient
1231
+ ): TInfinite extends true
1232
+ ? Array<
1233
+ [
1234
+ queryKey: ServiceOperationInfiniteQueryKey<TSchema, TParams>,
1235
+ data: NoInfer<InfiniteData<TData, TParams>> | undefined,
1236
+ ]
1237
+ >
1238
+ : Array<
1239
+ [
1240
+ queryKey: ServiceOperationQueryKey<TSchema, TParams>,
1241
+ data: TData | undefined,
1242
+ ]
1243
+ >;
1244
+ }
1245
+
1060
1246
  interface ServiceOperationSetInfiniteQueryData<
1061
1247
  TSchema extends { url: string; method: string },
1062
1248
  TData,
@@ -1065,12 +1251,12 @@ interface ServiceOperationSetInfiniteQueryData<
1065
1251
  setInfiniteQueryData(
1066
1252
  parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
1067
1253
  updater: Updater<
1068
- NoInfer<InfiniteData<TData>> | undefined,
1069
- NoInfer<InfiniteData<TData>> | undefined
1254
+ NoInfer<InfiniteData<TData, TParams>> | undefined,
1255
+ NoInfer<InfiniteData<TData, TParams>> | undefined
1070
1256
  >,
1071
1257
  queryClient: QueryClient,
1072
1258
  options?: SetDataOptions
1073
- ): InfiniteData<TData> | undefined;
1259
+ ): InfiniteData<TData, TParams> | undefined;
1074
1260
  }
1075
1261
 
1076
1262
  interface ServiceOperationGetQueryData<
@@ -1092,7 +1278,26 @@ interface ServiceOperationGetInfiniteQueryData<
1092
1278
  getInfiniteQueryData(
1093
1279
  parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
1094
1280
  queryClient: QueryClient
1095
- ): InfiniteData<TData> | undefined;
1281
+ ): InfiniteData<TData, TParams> | undefined;
1282
+ }
1283
+
1284
+ interface ServiceOperationGetQueryState<
1285
+ TSchema extends { url: string; method: string },
1286
+ TData,
1287
+ TParams = {},
1288
+ TError = DefaultError,
1289
+ > {
1290
+ getQueryState(
1291
+ parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
1292
+ queryClient: QueryClient
1293
+ ): QueryState<TData, TError> | undefined;
1294
+
1295
+ getInfiniteQueryState(
1296
+ parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
1297
+ queryClient: QueryClient
1298
+ ):
1299
+ | QueryState<InfiniteData<TData, PartialParameters<TParams>>, TError>
1300
+ | undefined;
1096
1301
  }
1097
1302
 
1098
1303
  export interface ServiceOperationMutationFn<
@@ -1130,6 +1335,61 @@ export interface ServiceOperationMutationFn<
1130
1335
  ): Promise<TData>;
1131
1336
  }
1132
1337
 
1338
+ interface ServiceOperationIsMutatingQueries<
1339
+ TSchema extends { url: string; method: string },
1340
+ TBody,
1341
+ TData,
1342
+ TParams = {},
1343
+ TError = DefaultError,
1344
+ > {
1345
+ isMutating<TContext>(
1346
+ filters:
1347
+ | MutationFiltersByParameters<TBody, TData, TParams, TError, TContext>
1348
+ | MutationFiltersByMutationKey<
1349
+ TSchema,
1350
+ TBody,
1351
+ TData,
1352
+ TParams,
1353
+ TError,
1354
+ TContext
1355
+ >,
1356
+ queryClient: QueryClient
1357
+ ): number;
1358
+ isMutating(queryClient: QueryClient): number;
1359
+ }
1360
+
1361
+ /**
1362
+ * @internal
1363
+ */
1364
+ export interface ServiceOperationIsMutatingQueriesCallback<
1365
+ TSchema extends { url: string; method: string },
1366
+ TBody,
1367
+ TData,
1368
+ TParams = {},
1369
+ TError = DefaultError,
1370
+ > extends ServiceOperationIsMutatingQueries<
1371
+ TSchema,
1372
+ TBody,
1373
+ TData,
1374
+ TParams,
1375
+ TError
1376
+ > {
1377
+ isMutating<TContext>(
1378
+ filters:
1379
+ | MutationFiltersByParameters<TBody, TData, TParams, TError, TContext>
1380
+ | MutationFiltersByMutationKey<
1381
+ TSchema,
1382
+ TBody,
1383
+ TData,
1384
+ TParams,
1385
+ TError,
1386
+ TContext
1387
+ >
1388
+ | QueryClient,
1389
+ queryClient?: QueryClient
1390
+ ): number;
1391
+ }
1392
+
1133
1393
  /**
1134
1394
  * Shallow partial 'parameters'.
1135
1395
  * @example