@tramvai/react-query 2.29.0 → 2.32.0

package/README.md

@@ -5,7 +5,7 @@ sidebar_position: 5
 
 # React Query
 
-A library for handling requests in React components. Based on [react-query](https://react-query.tanstack.com/).
+A library for handling requests in React components. Based on [@tanstack/react-query](https://tanstack.com/query/v4/).
 
 ## Explanation
 
@@ -86,7 +86,7 @@ const query = createQuery({
 
 #### Unique query parameters
 
-To create a generic `query` that takes parameters for a query, you must return a unique `key`, you can read more about this in the official documentation section [Query Keys](https://react-query.tanstack.com/guides/query-keys)
+To create a generic `query` that takes parameters for a query, you must return a unique `key`, you can read more about this in the official documentation section [Query Keys](https://tanstack.com/query/v4/docs/guides/query-keys)
 
 As a parameter `key` you can use:
 
@@ -121,7 +121,7 @@ export function Component({ id }) {
 
 React hook for working with `Query` object
 
-[react-query docs](https://react-query.tanstack.com/reference/useQuery)
+[react-query docs](https://tanstack.com/query/v4/docs/reference/useQuery)
 
 ```ts
 import { useQuery } from '@tramvai/react-query';
@@ -137,7 +137,7 @@ export function Component() {
 
 React Hook for working with the list of `Query` objects
 
-[react-query docs](https://react-query.tanstack.com/reference/useQueries)
+[react-query docs](https://tanstack.com/query/v4/docs/reference/useQueries)
 
 ```ts
 import { useQueries } from '@tramvai/react-query';
@@ -189,7 +189,7 @@ const query = createInfiniteQuery({
 
 React hook for working with the `InfiniteQuery` object
 
-[react-query docs](https://react-query.tanstack.com/reference/useInfiniteQuery)
+[react-query docs](https://tanstack.com/query/v4/docs/reference/useInfiniteQuery)
 
 ```ts
 import { useInfiniteQuery } from '@tramvai/react-query';
@@ -248,7 +248,7 @@ const mutation = createMutation({
 
 React hook for working with the `Mutation` object
 
-[react-query docs](https://react-query.tanstack.com/reference/useMutation)
+[react-query docs](https://tanstack.com/query/v4/docs/reference/useMutation)
 
 ```ts
 import { useMutation } from '@tramvai/react-query';
@@ -276,6 +276,6 @@ export function Component() {
 
 :::warning Prefer to use methods from the `@tramvai/react-query` as it is can work both with the `Query` wrapper and the query options to `react-query` itself :::
 
-You can get [`QueryClient`](https://react-query.tanstack.com/reference/QueryClient) from di by token `QUERY_CLIENT_TOKEN` or using method `useQueryClient` in React-components.
+You can get [`QueryClient`](https://tanstack.com/query/v4/docs/reference/QueryClient) from di by token `QUERY_CLIENT_TOKEN` or using method `useQueryClient` in React-components.
 
 To convert wrapped `Query` object to object acceptable by `react-query` use method [raw](#raw) of the `Query` instance.

package/lib/baseQuery/types.d.ts

@@ -1,7 +1,8 @@
 import type { ActionConditionsParameters, ActionContext, TramvaiAction } from '@tramvai/core';
-import type { QueryKey as ReactQueryKey, QueryOptions } from 'react-query';
+import type { QueryKey as ReactQueryKey, QueryOptions } from '@tanstack/react-query';
 export declare const QUERY_PARAMETERS = "__query_parameters__";
-export declare type QueryKey<Options> = ((options: Options) => ReactQueryKey) | ReactQueryKey;
+export declare type ReactQueryKeyOrString = ReactQueryKey | string;
+export declare type QueryKey<Options> = ((options: Options) => ReactQueryKeyOrString) | ReactQueryKeyOrString;
 export interface BaseCreateQueryOptions<Options, Deps> {
     key: QueryKey<Options>;
     fn: Function;

package/lib/index.d.ts

@@ -4,4 +4,4 @@ export { createInfiniteQuery } from './infiniteQuery/create';
 export { useInfiniteQuery } from './infiniteQuery/use';
 export { createMutation } from './mutation/create';
 export { useMutation } from './mutation/use';
-export { useQueryClient } from 'react-query';
+export { useQueryClient } from '@tanstack/react-query';

package/lib/index.es.js

@@ -1,12 +1,12 @@
+import identity from '@tinkoff/utils/function/identity';
 import applyOrReturn from '@tinkoff/utils/function/applyOrReturn';
 import { declareAction } from '@tramvai/core';
 import { QUERY_CLIENT_TOKEN } from '@tramvai/module-react-query';
 import { CONTEXT_TOKEN } from '@tramvai/tokens-common';
-import isString from '@tinkoff/utils/is/string';
 import isArray from '@tinkoff/utils/is/array';
 import { useMemo } from 'react';
-import { useQuery as useQuery$1, useQueries as useQueries$1, useInfiniteQuery as useInfiniteQuery$1, useMutation as useMutation$1 } from 'react-query';
-export { useQueryClient } from 'react-query';
+import { useQuery as useQuery$1, useQueries as useQueries$1, useInfiniteQuery as useInfiniteQuery$1, useMutation as useMutation$1 } from '@tanstack/react-query';
+export { useQueryClient } from '@tanstack/react-query';
 import { useConsumerContext } from '@tramvai/state';
 import { useShallowEqual } from '@tinkoff/react-hooks';
 
@@ -15,16 +15,16 @@ const isQuery = (arg) => {
     return QUERY_PARAMETERS in arg;
 };
 
-const defaultKey = (options) => {
-    if (isString(options) || isArray(options)) {
-        return options;
+const normalizeKey = (key) => {
+    if (isArray(key)) {
+        return key;
     }
-    return [options];
+    return [key];
 };
 
 const convertToRawQuery$1 = (query, context, options) => {
-    const { key = defaultKey, fn, deps, conditions, queryOptions } = query[QUERY_PARAMETERS];
-    const queryKey = applyOrReturn([options], key);
+    const { key = identity, fn, deps, conditions, queryOptions } = query[QUERY_PARAMETERS];
+    const queryKey = normalizeKey(applyOrReturn([options], key));
     const actionWrapper = declareAction({
         name: 'queryExecution',
         async fn() {
@@ -112,12 +112,12 @@ function useQueries(queries) {
             return query;
         });
     }, [memoQueries, context]);
-    return useQueries$1(resultQueries);
+    return useQueries$1({ queries: resultQueries });
 }
 
 const convertToRawQuery = (query, context, options) => {
-    const { key = defaultKey, fn, getNextPageParam, getPreviousPageParam, deps, conditions, infiniteQueryOptions, } = query[QUERY_PARAMETERS];
-    const queryKey = applyOrReturn([options], key);
+    const { key = identity, fn, getNextPageParam, getPreviousPageParam, deps, conditions, infiniteQueryOptions, } = query[QUERY_PARAMETERS];
+    const queryKey = normalizeKey(applyOrReturn([options], key));
     const actionWrapper = declareAction({
         name: 'infiniteQueryExecution',
         async fn(pageParam) {
@@ -203,8 +203,8 @@ const isMutation = (arg) => {
 };
 
 const convertToRawMutation = (mutation, context, options) => {
-    const { key = defaultKey, fn, deps, conditions, mutationOptions } = mutation[MUTATION_PARAMETERS];
-    const mutationKey = applyOrReturn([options], key);
+    const { key = identity, fn, deps, conditions, mutationOptions } = mutation[MUTATION_PARAMETERS];
+    const mutationKey = normalizeKey(applyOrReturn([options], key));
     const actionWrapper = declareAction({
         name: 'mutationExecution',
         async fn(variables) {

package/lib/index.js

@@ -2,21 +2,21 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var identity = require('@tinkoff/utils/function/identity');
 var applyOrReturn = require('@tinkoff/utils/function/applyOrReturn');
 var core = require('@tramvai/core');
 var moduleReactQuery = require('@tramvai/module-react-query');
 var tokensCommon = require('@tramvai/tokens-common');
-var isString = require('@tinkoff/utils/is/string');
 var isArray = require('@tinkoff/utils/is/array');
 var react = require('react');
-var reactQuery = require('react-query');
+var reactQuery = require('@tanstack/react-query');
 var state = require('@tramvai/state');
 var reactHooks = require('@tinkoff/react-hooks');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
+var identity__default = /*#__PURE__*/_interopDefaultLegacy(identity);
 var applyOrReturn__default = /*#__PURE__*/_interopDefaultLegacy(applyOrReturn);
-var isString__default = /*#__PURE__*/_interopDefaultLegacy(isString);
 var isArray__default = /*#__PURE__*/_interopDefaultLegacy(isArray);
 
 const QUERY_PARAMETERS = '__query_parameters__';
@@ -24,16 +24,16 @@ const isQuery = (arg) => {
     return QUERY_PARAMETERS in arg;
 };
 
-const defaultKey = (options) => {
-    if (isString__default["default"](options) || isArray__default["default"](options)) {
-        return options;
+const normalizeKey = (key) => {
+    if (isArray__default["default"](key)) {
+        return key;
     }
-    return [options];
+    return [key];
 };
 
 const convertToRawQuery$1 = (query, context, options) => {
-    const { key = defaultKey, fn, deps, conditions, queryOptions } = query[QUERY_PARAMETERS];
-    const queryKey = applyOrReturn__default["default"]([options], key);
+    const { key = identity__default["default"], fn, deps, conditions, queryOptions } = query[QUERY_PARAMETERS];
+    const queryKey = normalizeKey(applyOrReturn__default["default"]([options], key));
     const actionWrapper = core.declareAction({
         name: 'queryExecution',
         async fn() {
@@ -121,12 +121,12 @@ function useQueries(queries) {
             return query;
         });
     }, [memoQueries, context]);
-    return reactQuery.useQueries(resultQueries);
+    return reactQuery.useQueries({ queries: resultQueries });
 }
 
 const convertToRawQuery = (query, context, options) => {
-    const { key = defaultKey, fn, getNextPageParam, getPreviousPageParam, deps, conditions, infiniteQueryOptions, } = query[QUERY_PARAMETERS];
-    const queryKey = applyOrReturn__default["default"]([options], key);
+    const { key = identity__default["default"], fn, getNextPageParam, getPreviousPageParam, deps, conditions, infiniteQueryOptions, } = query[QUERY_PARAMETERS];
+    const queryKey = normalizeKey(applyOrReturn__default["default"]([options], key));
     const actionWrapper = core.declareAction({
         name: 'infiniteQueryExecution',
         async fn(pageParam) {
@@ -212,8 +212,8 @@ const isMutation = (arg) => {
 };
 
 const convertToRawMutation = (mutation, context, options) => {
-    const { key = defaultKey, fn, deps, conditions, mutationOptions } = mutation[MUTATION_PARAMETERS];
-    const mutationKey = applyOrReturn__default["default"]([options], key);
+    const { key = identity__default["default"], fn, deps, conditions, mutationOptions } = mutation[MUTATION_PARAMETERS];
+    const mutationKey = normalizeKey(applyOrReturn__default["default"]([options], key));
     const actionWrapper = core.declareAction({
         name: 'mutationExecution',
         async fn(variables) {

package/lib/infiniteQuery/types.d.ts

@@ -1,5 +1,5 @@
 import type { ProvideDepsIterator } from '@tinkoff/dippy';
-import type { UseInfiniteQueryOptions, InfiniteData } from 'react-query';
+import type { UseInfiniteQueryOptions, InfiniteData } from '@tanstack/react-query';
 import type { TramvaiAction } from '@tramvai/core';
 import type { BaseCreateQueryOptions, BaseQuery } from '../baseQuery/types';
 export interface CreateInfiniteQueryOptions<Options, PageParam, Result, Deps> extends BaseCreateQueryOptions<Options, Deps> {

package/lib/infiniteQuery/use.d.ts

@@ -1,4 +1,4 @@
-import type { InfiniteQueryObserverResult, UseInfiniteQueryOptions } from 'react-query';
+import type { InfiniteQueryObserverResult, UseInfiniteQueryOptions } from '@tanstack/react-query';
 import type { InfiniteQuery } from './types';
 declare function useInfiniteQuery<Options extends void, PageParam, Result, Deps>(query: UseInfiniteQueryOptions<Result, Error> | InfiniteQuery<Options, PageParam, Result, Deps>): InfiniteQueryObserverResult<Result, Error>;
 declare function useInfiniteQuery<Options, PageParam, Result, Deps>(query: UseInfiniteQueryOptions<Result, Error> | InfiniteQuery<Options, PageParam, Result, Deps>, options: Options): InfiniteQueryObserverResult<Result, Error>;

package/lib/mutation/types.d.ts

@@ -1,6 +1,6 @@
 import type { ActionConditionsParameters, ActionContext } from '@tramvai/core';
 import type { ProvideDepsIterator } from '@tinkoff/dippy';
-import type { MutationKey as ReactMutationKey, MutationOptions, UseMutationOptions } from 'react-query';
+import type { MutationKey as ReactMutationKey, MutationOptions, UseMutationOptions } from '@tanstack/react-query';
 export declare const MUTATION_PARAMETERS = "__mutations_parameters__";
 export declare type MutationKey<Options> = ((options?: Options) => ReactMutationKey) | ReactMutationKey;
 export interface CreateMutationOptions<Options, Variables, Result, Deps, Key extends MutationKey<Options> = (options?: Options) => ReactMutationKey> {

package/lib/mutation/use.d.ts

@@ -1,4 +1,4 @@
-import type { UseMutationOptions, UseMutationResult, MutationKey as ReactMutationKey } from 'react-query';
+import type { UseMutationOptions, UseMutationResult, MutationKey as ReactMutationKey } from '@tanstack/react-query';
 import type { Mutation } from './types';
 interface UseMutation {
     <Options, Variables, Result, Deps, Key extends (options?: Options) => ReactMutationKey>(Mutation: UseMutationOptions<Result, any, Variables> | Mutation<Options, Variables, Result, Deps, Key>, options: Options): UseMutationResult<Result, any, Variables>;

package/lib/query/types.d.ts

@@ -1,5 +1,5 @@
 import type { ProvideDepsIterator } from '@tinkoff/dippy';
-import type { UseQueryOptions } from 'react-query';
+import type { UseQueryOptions } from '@tanstack/react-query';
 import type { TramvaiAction } from '@tramvai/core';
 import type { BaseCreateQueryOptions, BaseQuery } from '../baseQuery/types';
 export interface CreateQueryOptions<Options, Result, Deps> extends BaseCreateQueryOptions<Options, Deps> {

package/lib/query/use.d.ts

@@ -1,6 +1,6 @@
-import type { UseQueryOptions, QueryObserverResult } from 'react-query';
+import type { UseQueryOptions, QueryObserverResult } from '@tanstack/react-query';
 import type { Query } from './types';
 declare function useQuery<Options extends void, Result, Deps>(query: UseQueryOptions<Result, Error> | Query<Options, Result, Deps>): QueryObserverResult<Result, Error>;
 declare function useQuery<Options, Result, Deps>(query: UseQueryOptions<Result, Error> | Query<Options, Result, Deps>, options: Options): QueryObserverResult<Result, Error>;
-declare function useQueries<Result, Deps>(queries: Array<UseQueryOptions<Result, Error> | Query<any, Result, Deps>>): import("react-query").UseQueryResult<unknown extends Result ? Result : Result, Error>[];
+declare function useQueries<Result, Deps>(queries: Array<UseQueryOptions<Result, Error> | Query<any, Result, Deps>>): import("@tanstack/react-query").UseQueryResult<unknown extends Result ? Result : Result, Error>[];
 export { useQuery, useQueries };

package/lib/shared/normalizeKey.d.ts

@@ -0,0 +1,3 @@
+import type { QueryKey } from '@tanstack/react-query';
+import type { ReactQueryKeyOrString } from '../baseQuery/types';
+export declare const normalizeKey: (key: ReactQueryKeyOrString) => QueryKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/react-query",
-  "version": "2.29.0",
+  "version": "2.32.0",
   "description": "",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -19,16 +19,16 @@
   },
   "dependencies": {
     "@tinkoff/react-hooks": "0.1.3",
-    "@tramvai/core": "2.29.0",
-    "@tramvai/module-react-query": "2.29.0",
-    "@tramvai/state": "2.29.0",
-    "@tramvai/tokens-common": "2.29.0"
+    "@tramvai/core": "2.32.0",
+    "@tramvai/module-react-query": "2.32.0",
+    "@tramvai/state": "2.32.0",
+    "@tramvai/tokens-common": "2.32.0"
   },
   "peerDependencies": {
     "@tinkoff/dippy": "0.8.6",
     "@tinkoff/utils": "^2.1.2",
     "react": ">=16.14.0",
-    "react-query": "^3.35.0",
+    "@tanstack/react-query": "^4.7.1",
     "tslib": "^2.4.0"
   },
   "module": "lib/index.es.js",

package/lib/defaultKey.d.ts

@@ -1,2 +0,0 @@
-import type { QueryKey as ReactQueryKey } from 'react-query';
-export declare const defaultKey: (options: any) => ReactQueryKey;