@tanstack/react-query 4.3.4 → 4.3.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-query",
-  "version": "4.3.4",
+  "version": "4.3.7",
   "description": "Hooks for managing, caching and syncing asynchronous and remote data in React",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -12,6 +12,7 @@
   },
   "types": "build/lib/index.d.ts",
   "main": "build/lib/index.js",
+  "module": "build/lib/index.esm.js",
   "exports": {
     ".": {
       "types": "./build/lib/index.d.ts",
@@ -46,7 +47,7 @@
     "react-error-boundary": "^3.1.4"
   },
   "dependencies": {
-    "@tanstack/query-core": "4.3.4",
+    "@tanstack/query-core": "4.3.7",
     "use-sync-external-store": "^1.2.0"
   },
   "peerDependencies": {

package/src/__tests__/Hydrate.test.tsx

@@ -10,7 +10,7 @@ import {
   useHydrate,
   Hydrate,
 } from '@tanstack/react-query'
-import { createQueryClient, sleep } from '../../../../tests/utils'
+import { createQueryClient, sleep } from './utils'
 import * as coreModule from '@tanstack/query-core'
 
 describe('React hydration', () => {

package/src/__tests__/QueryClientProvider.test.tsx

@@ -2,7 +2,7 @@ import * as React from 'react'
 import { render, waitFor } from '@testing-library/react'
 import { renderToString } from 'react-dom/server'
 
-import { sleep, queryKey, createQueryClient } from '../../../../tests/utils'
+import { sleep, queryKey, createQueryClient } from './utils'
 import {
   QueryClient,
   QueryClientProvider,

package/src/__tests__/QueryResetErrorBoundary.test.tsx

@@ -1,10 +1,9 @@
-import { waitFor, fireEvent } from '@testing-library/react'
+import { fireEvent, waitFor } from '@testing-library/react'
 import { ErrorBoundary } from 'react-error-boundary'
 import * as React from 'react'
 
-import { sleep, queryKey, createQueryClient } from '../../../../tests/utils'
-import { renderWithClient } from './utils'
-import { useQuery, QueryCache, QueryErrorResetBoundary } from '..'
+import { createQueryClient, queryKey, renderWithClient, sleep } from './utils'
+import { QueryCache, QueryErrorResetBoundary, useQuery } from '..'
 
 // TODO: This should be removed with the types for react-error-boundary get updated.
 declare module 'react-error-boundary' {

package/src/__tests__/ssr-hydration.test.tsx

@@ -12,12 +12,7 @@ import {
   dehydrate,
   hydrate,
 } from '..'
-import {
-  createQueryClient,
-  mockLogger,
-  setIsServer,
-  sleep,
-} from '../../../../tests/utils'
+import { createQueryClient, mockLogger, setIsServer, sleep } from './utils'
 
 const isReact18 = () => (process.env.REACTJS_VERSION || '18') === '18'
 

package/src/__tests__/ssr.test.tsx

@@ -6,7 +6,7 @@ import * as React from 'react'
 // @ts-ignore
 import { renderToString } from 'react-dom/server'
 
-import { sleep, queryKey, createQueryClient } from '../../../../tests/utils'
+import { sleep, queryKey, createQueryClient } from './utils'
 import { useQuery, QueryClientProvider, QueryCache, useInfiniteQuery } from '..'
 
 describe('Server Side Rendering', () => {

package/src/__tests__/suspense.test.tsx

@@ -1,17 +1,16 @@
-import { waitFor, fireEvent } from '@testing-library/react'
+import { fireEvent, waitFor } from '@testing-library/react'
 import { ErrorBoundary } from 'react-error-boundary'
 import * as React from 'react'
 
-import { sleep, queryKey, createQueryClient } from '../../../../tests/utils'
-import { renderWithClient } from './utils'
+import { createQueryClient, queryKey, renderWithClient, sleep } from './utils'
 import {
-  useQuery,
   QueryCache,
   QueryErrorResetBoundary,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
   useQueryErrorResetBoundary,
   UseQueryResult,
-  UseInfiniteQueryResult,
-  useInfiniteQuery,
 } from '..'
 
 describe("useQuery's in Suspense mode", () => {

package/src/__tests__/useInfiniteQuery.test.tsx

@@ -1,20 +1,20 @@
-import { waitFor, fireEvent } from '@testing-library/react'
+import { fireEvent, waitFor } from '@testing-library/react'
 import * as React from 'react'
 
 import {
+  Blink,
+  createQueryClient,
   queryKey,
-  sleep,
+  renderWithClient,
   setActTimeout,
-  createQueryClient,
-} from '../../../../tests/utils'
-
-import { renderWithClient, Blink } from './utils'
+  sleep,
+} from './utils'
 import {
-  useInfiniteQuery,
-  UseInfiniteQueryResult,
+  InfiniteData,
   QueryCache,
   QueryFunctionContext,
-  InfiniteData,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
 } from '..'
 
 interface Result {

package/src/__tests__/useIsFetching.test.tsx

@@ -5,11 +5,11 @@ import { ErrorBoundary } from 'react-error-boundary'
 import {
   createQueryClient,
   queryKey,
+  renderWithClient,
   setActTimeout,
   sleep,
-} from '../../../../tests/utils'
-import { renderWithClient } from './utils'
-import { QueryClient, useQuery, useIsFetching, QueryCache } from '..'
+} from './utils'
+import { QueryCache, QueryClient, useIsFetching, useQuery } from '..'
 
 describe('useIsFetching', () => {
   // See https://github.com/tannerlinsley/react-query/issues/105

package/src/__tests__/useIsMutating.test.tsx

@@ -1,14 +1,13 @@
-import { waitFor, fireEvent } from '@testing-library/react'
+import { fireEvent, waitFor } from '@testing-library/react'
 import * as React from 'react'
 import { useIsMutating } from '../useIsMutating'
 import { useMutation } from '../useMutation'
 import {
   createQueryClient,
+  renderWithClient,
   setActTimeout,
   sleep,
-} from '../../../../tests/utils'
-
-import { renderWithClient } from './utils'
+} from './utils'
 import { ErrorBoundary } from 'react-error-boundary'
 import { QueryClient } from '@tanstack/query-core'
 import * as MutationCacheModule from '../../../query-core/src/mutationCache'

package/src/__tests__/useMutation.test.tsx

@@ -3,16 +3,16 @@ import '@testing-library/jest-dom'
 import * as React from 'react'
 import { ErrorBoundary } from 'react-error-boundary'
 
-import { QueryClient, useMutation, QueryCache, MutationCache } from '..'
+import { MutationCache, QueryCache, QueryClient, useMutation } from '..'
 import { UseMutationResult } from '../types'
 import {
   createQueryClient,
   mockNavigatorOnLine,
   queryKey,
+  renderWithClient,
   setActTimeout,
   sleep,
-} from '../../../../tests/utils'
-import { renderWithClient } from './utils'
+} from './utils'
 
 describe('useMutation', () => {
   const queryCache = new QueryCache()

package/src/__tests__/useQueries.test.tsx

@@ -9,19 +9,19 @@ import {
   expectType,
   expectTypeNotAny,
   queryKey,
+  renderWithClient,
   sleep,
-} from '../../../../tests/utils'
-import { renderWithClient } from './utils'
+} from './utils'
 import {
-  QueryClient,
-  useQueries,
-  UseQueryResult,
-  QueryCache,
-  QueryObserverResult,
   QueriesObserver,
+  QueryCache,
+  QueryClient,
   QueryFunction,
-  UseQueryOptions,
   QueryKey,
+  QueryObserverResult,
+  useQueries,
+  UseQueryOptions,
+  UseQueryResult,
 } from '..'
 import { QueryFunctionContext } from '@tanstack/query-core'
 

package/src/__tests__/useQuery.test.tsx

@@ -1,25 +1,26 @@
-import { act, waitFor, fireEvent } from '@testing-library/react'
+import { act, fireEvent, waitFor } from '@testing-library/react'
 import '@testing-library/jest-dom'
 import * as React from 'react'
 import {
+  Blink,
+  createQueryClient,
   expectType,
-  queryKey,
+  mockLogger,
+  mockNavigatorOnLine,
   mockVisibilityState,
-  sleep,
+  queryKey,
+  renderWithClient,
   setActTimeout,
-  mockNavigatorOnLine,
-  mockLogger,
-  createQueryClient,
-} from '../../../../tests/utils'
-import { renderWithClient, Blink } from './utils'
+  sleep,
+} from './utils'
 import {
-  useQuery,
-  UseQueryResult,
+  DefinedUseQueryResult,
   QueryCache,
   QueryFunction,
   QueryFunctionContext,
+  useQuery,
   UseQueryOptions,
-  DefinedUseQueryResult,
+  UseQueryResult,
 } from '..'
 import { ErrorBoundary } from 'react-error-boundary'
 

package/src/__tests__/utils.tsx

@@ -1,7 +1,13 @@
 import * as React from 'react'
-import { render } from '@testing-library/react'
-import { setActTimeout } from '../../../../tests/utils'
-import { QueryClient, ContextOptions, QueryClientProvider } from '..'
+import { act, render } from '@testing-library/react'
+import {
+  QueryClient,
+  ContextOptions,
+  QueryClientProvider,
+  QueryClientConfig,
+  MutationOptions,
+} from '..'
+import * as utils from '@tanstack/query-core'
 
 export function renderWithClient(
   client: QueryClient,
@@ -43,3 +49,76 @@ export const Blink = ({
 
   return shouldShow ? <>{children}</> : <>off</>
 }
+
+export function createQueryClient(config?: QueryClientConfig): QueryClient {
+  jest.spyOn(console, 'error').mockImplementation(() => undefined)
+  return new QueryClient({ logger: mockLogger, ...config })
+}
+
+export function mockVisibilityState(value: DocumentVisibilityState) {
+  return jest.spyOn(document, 'visibilityState', 'get').mockReturnValue(value)
+}
+
+export function mockNavigatorOnLine(value: boolean) {
+  return jest.spyOn(navigator, 'onLine', 'get').mockReturnValue(value)
+}
+
+export const mockLogger = {
+  log: jest.fn(),
+  warn: jest.fn(),
+  error: jest.fn(),
+}
+
+let queryKeyCount = 0
+export function queryKey(): Array<string> {
+  queryKeyCount++
+  return [`query_${queryKeyCount}`]
+}
+
+export function sleep(timeout: number): Promise<void> {
+  return new Promise((resolve, _reject) => {
+    setTimeout(resolve, timeout)
+  })
+}
+
+export function setActTimeout(fn: () => void, ms?: number) {
+  return setTimeout(() => {
+    act(() => {
+      fn()
+    })
+  }, ms)
+}
+
+/**
+ * Assert the parameter is of a specific type.
+ */
+export function expectType<T>(_: T): void {
+  return undefined
+}
+
+/**
+ * Assert the parameter is not typed as `any`
+ */
+export function expectTypeNotAny<T>(_: 0 extends 1 & T ? never : T): void {
+  return undefined
+}
+
+export function executeMutation(
+  queryClient: QueryClient,
+  options: MutationOptions<any, any, any, any>,
+): Promise<unknown> {
+  return queryClient.getMutationCache().build(queryClient, options).execute()
+}
+
+// This monkey-patches the isServer-value from utils,
+// so that we can pretend to be in a server environment
+export function setIsServer(isServer: boolean) {
+  const original = utils.isServer
+  // @ts-ignore
+  utils.isServer = isServer
+
+  return () => {
+    // @ts-ignore
+    utils.isServer = original
+  }
+}