@tanstack/react-query 5.0.0-alpha.50 → 5.0.0-alpha.52

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-query",
-  "version": "5.0.0-alpha.50",
+  "version": "5.0.0-alpha.52",
   "description": "Hooks for managing, caching and syncing asynchronous and remote data in React",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -10,15 +10,16 @@
     "type": "github",
     "url": "https://github.com/sponsors/tannerlinsley"
   },
-  "type": "commonjs",
+  "type": "module",
   "types": "build/lib/index.d.ts",
-  "main": "build/lib/index.js",
-  "module": "build/lib/index.mjs",
+  "main": "build/lib/index.cjs",
+  "module": "build/lib/index.js",
   "exports": {
     ".": {
       "types": "./build/lib/index.d.ts",
-      "import": "./build/lib/index.mjs",
-      "default": "./build/lib/index.js"
+      "import": "./build/lib/index.js",
+      "require": "./build/lib/index.cjs",
+      "default": "./build/lib/index.cjs"
     },
     "./package.json": "./package.json"
   },
@@ -61,7 +62,7 @@
     "test:lib": "vitest run --coverage",
     "test:lib:dev": "pnpm run test:lib --watch",
     "build": "pnpm build:rollup && pnpm build:codemods && pnpm build:types",
-    "build:rollup": "rollup --config rollup.config.mjs",
+    "build:rollup": "rollup --config rollup.config.js",
     "build:codemods": "cpy ../codemods/src/**/* ./build/codemods",
     "build:types": "tsc --emitDeclarationOnly"
   }

package/build/lib/HydrationBoundary.mjs

@@ -1,29 +0,0 @@
-'use client';
-import * as React from 'react';
-import { hydrate } from '@tanstack/query-core';
-import { useQueryClient } from './QueryClientProvider.mjs';
-
-const HydrationBoundary = ({
-  children,
-  options = {},
-  state,
-  queryClient
-}) => {
-  const client = useQueryClient(queryClient);
-  const optionsRef = React.useRef(options);
-  optionsRef.current = options;
-
-  // Running hydrate again with the same queries is safe,
-  // it wont overwrite or initialize existing queries,
-  // relying on useMemo here is only a performance optimization.
-  // hydrate can and should be run *during* render here for SSR to work properly
-  React.useMemo(() => {
-    if (state) {
-      hydrate(client, state, optionsRef.current);
-    }
-  }, [client, state]);
-  return children;
-};
-
-export { HydrationBoundary };
-//# sourceMappingURL=HydrationBoundary.mjs.map

package/build/lib/QueryClientProvider.mjs

@@ -1,31 +0,0 @@
-'use client';
-import * as React from 'react';
-
-const QueryClientContext = /*#__PURE__*/React.createContext(undefined);
-const useQueryClient = queryClient => {
-  const client = React.useContext(QueryClientContext);
-  if (queryClient) {
-    return queryClient;
-  }
-  if (!client) {
-    throw new Error('No QueryClient set, use QueryClientProvider to set one');
-  }
-  return client;
-};
-const QueryClientProvider = ({
-  client,
-  children
-}) => {
-  React.useEffect(() => {
-    client.mount();
-    return () => {
-      client.unmount();
-    };
-  }, [client]);
-  return /*#__PURE__*/React.createElement(QueryClientContext.Provider, {
-    value: client
-  }, children);
-};
-
-export { QueryClientContext, QueryClientProvider, useQueryClient };
-//# sourceMappingURL=QueryClientProvider.mjs.map

package/build/lib/QueryErrorResetBoundary.mjs

@@ -1,38 +0,0 @@
-'use client';
-import * as React from 'react';
-
-// CONTEXT
-
-function createValue() {
-  let isReset = false;
-  return {
-    clearReset: () => {
-      isReset = false;
-    },
-    reset: () => {
-      isReset = true;
-    },
-    isReset: () => {
-      return isReset;
-    }
-  };
-}
-const QueryErrorResetBoundaryContext = /*#__PURE__*/React.createContext(createValue());
-
-// HOOK
-
-const useQueryErrorResetBoundary = () => React.useContext(QueryErrorResetBoundaryContext);
-
-// COMPONENT
-
-const QueryErrorResetBoundary = ({
-  children
-}) => {
-  const [value] = React.useState(() => createValue());
-  return /*#__PURE__*/React.createElement(QueryErrorResetBoundaryContext.Provider, {
-    value: value
-  }, typeof children === 'function' ? children(value) : children);
-};
-
-export { QueryErrorResetBoundary, useQueryErrorResetBoundary };
-//# sourceMappingURL=QueryErrorResetBoundary.mjs.map

package/build/lib/errorBoundaryUtils.mjs

@@ -1,28 +0,0 @@
-'use client';
-import * as React from 'react';
-import { shouldThrowError } from './utils.mjs';
-
-const ensurePreventErrorBoundaryRetry = (options, errorResetBoundary) => {
-  if (options.suspense || options.throwOnError) {
-    // Prevent retrying failed query if the error boundary has not been reset yet
-    if (!errorResetBoundary.isReset()) {
-      options.retryOnMount = false;
-    }
-  }
-};
-const useClearResetErrorBoundary = errorResetBoundary => {
-  React.useEffect(() => {
-    errorResetBoundary.clearReset();
-  }, [errorResetBoundary]);
-};
-const getHasError = ({
-  result,
-  errorResetBoundary,
-  throwOnError,
-  query
-}) => {
-  return result.isError && !errorResetBoundary.isReset() && !result.isFetching && shouldThrowError(throwOnError, [result.error, query]);
-};
-
-export { ensurePreventErrorBoundaryRetry, getHasError, useClearResetErrorBoundary };
-//# sourceMappingURL=errorBoundaryUtils.mjs.map

package/build/lib/index.mjs

@@ -1,12 +0,0 @@
-export * from '@tanstack/query-core';
-export { useQueries } from './useQueries.mjs';
-export { queryOptions, useQuery } from './useQuery.mjs';
-export { QueryClientContext, QueryClientProvider, useQueryClient } from './QueryClientProvider.mjs';
-export { HydrationBoundary } from './HydrationBoundary.mjs';
-export { QueryErrorResetBoundary, useQueryErrorResetBoundary } from './QueryErrorResetBoundary.mjs';
-export { useIsFetching } from './useIsFetching.mjs';
-export { useIsMutating, useMutationState } from './useMutationState.mjs';
-export { useMutation } from './useMutation.mjs';
-export { useInfiniteQuery } from './useInfiniteQuery.mjs';
-export { IsRestoringProvider, useIsRestoring } from './isRestoring.mjs';
-//# sourceMappingURL=index.mjs.map

package/build/lib/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/build/lib/isRestoring.mjs

@@ -1,9 +0,0 @@
-'use client';
-import * as React from 'react';
-
-const IsRestoringContext = /*#__PURE__*/React.createContext(false);
-const useIsRestoring = () => React.useContext(IsRestoringContext);
-const IsRestoringProvider = IsRestoringContext.Provider;
-
-export { IsRestoringProvider, useIsRestoring };
-//# sourceMappingURL=isRestoring.mjs.map

package/build/lib/useBaseQuery.mjs

@@ -1,52 +0,0 @@
-'use client';
-import * as React from 'react';
-import { notifyManager } from '@tanstack/query-core';
-import { useQueryErrorResetBoundary } from './QueryErrorResetBoundary.mjs';
-import { useQueryClient } from './QueryClientProvider.mjs';
-import { useIsRestoring } from './isRestoring.mjs';
-import { ensurePreventErrorBoundaryRetry, useClearResetErrorBoundary, getHasError } from './errorBoundaryUtils.mjs';
-import { ensureStaleTime, shouldSuspend, fetchOptimistic } from './suspense.mjs';
-
-function useBaseQuery(options, Observer, queryClient) {
-  const client = useQueryClient(queryClient);
-  const isRestoring = useIsRestoring();
-  const errorResetBoundary = useQueryErrorResetBoundary();
-  const defaultedOptions = client.defaultQueryOptions(options);
-
-  // Make sure results are optimistically set in fetching state before subscribing or updating options
-  defaultedOptions._optimisticResults = isRestoring ? 'isRestoring' : 'optimistic';
-  ensureStaleTime(defaultedOptions);
-  ensurePreventErrorBoundaryRetry(defaultedOptions, errorResetBoundary);
-  useClearResetErrorBoundary(errorResetBoundary);
-  const [observer] = React.useState(() => new Observer(client, defaultedOptions));
-  const result = observer.getOptimisticResult(defaultedOptions);
-  React.useSyncExternalStore(React.useCallback(onStoreChange => isRestoring ? () => undefined : observer.subscribe(notifyManager.batchCalls(onStoreChange)), [observer, isRestoring]), () => observer.getCurrentResult(), () => observer.getCurrentResult());
-  React.useEffect(() => {
-    // Do not notify on updates because of changes in the options because
-    // these changes should already be reflected in the optimistic result.
-    observer.setOptions(defaultedOptions, {
-      listeners: false
-    });
-  }, [defaultedOptions, observer]);
-
-  // Handle suspense
-  if (shouldSuspend(defaultedOptions, result, isRestoring)) {
-    throw fetchOptimistic(defaultedOptions, observer, errorResetBoundary);
-  }
-
-  // Handle error boundary
-  if (getHasError({
-    result,
-    errorResetBoundary,
-    throwOnError: defaultedOptions.throwOnError,
-    query: observer.getCurrentQuery()
-  })) {
-    throw result.error;
-  }
-
-  // Handle result property usage tracking
-  return !defaultedOptions.notifyOnChangeProps ? observer.trackResult(result) : result;
-}
-
-export { useBaseQuery };
-//# sourceMappingURL=useBaseQuery.mjs.map

package/build/lib/useInfiniteQuery.mjs

@@ -1,13 +0,0 @@
-'use client';
-import { InfiniteQueryObserver } from '@tanstack/query-core';
-import { useBaseQuery } from './useBaseQuery.mjs';
-
-// HOOK
-function useInfiniteQuery(options, queryClient) {
-  return useBaseQuery(options,
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-  InfiniteQueryObserver, queryClient);
-}
-
-export { useInfiniteQuery };
-//# sourceMappingURL=useInfiniteQuery.mjs.map

package/build/lib/useIsFetching.mjs

@@ -1,13 +0,0 @@
-'use client';
-import * as React from 'react';
-import { notifyManager } from '@tanstack/query-core';
-import { useQueryClient } from './QueryClientProvider.mjs';
-
-function useIsFetching(filters, queryClient) {
-  const client = useQueryClient(queryClient);
-  const queryCache = client.getQueryCache();
-  return React.useSyncExternalStore(React.useCallback(onStoreChange => queryCache.subscribe(notifyManager.batchCalls(onStoreChange)), [queryCache]), () => client.isFetching(filters), () => client.isFetching(filters));
-}
-
-export { useIsFetching };
-//# sourceMappingURL=useIsFetching.mjs.map

package/build/lib/useMutation.mjs

@@ -1,33 +0,0 @@
-'use client';
-import * as React from 'react';
-import { MutationObserver, notifyManager } from '@tanstack/query-core';
-import { useQueryClient } from './QueryClientProvider.mjs';
-import { shouldThrowError } from './utils.mjs';
-
-// HOOK
-
-function useMutation(options, queryClient) {
-  const client = useQueryClient(queryClient);
-  const [observer] = React.useState(() => new MutationObserver(client, options));
-  React.useEffect(() => {
-    observer.setOptions(options);
-  }, [observer, options]);
-  const result = React.useSyncExternalStore(React.useCallback(onStoreChange => observer.subscribe(notifyManager.batchCalls(onStoreChange)), [observer]), () => observer.getCurrentResult(), () => observer.getCurrentResult());
-  const mutate = React.useCallback((variables, mutateOptions) => {
-    observer.mutate(variables, mutateOptions).catch(noop);
-  }, [observer]);
-  if (result.error && shouldThrowError(observer.options.throwOnError, [result.error])) {
-    throw result.error;
-  }
-  return {
-    ...result,
-    mutate,
-    mutateAsync: result.mutate
-  };
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-function noop() {}
-
-export { useMutation };
-//# sourceMappingURL=useMutation.mjs.map

package/build/lib/useMutationState.mjs

@@ -1,38 +0,0 @@
-'use client';
-import * as React from 'react';
-import { replaceEqualDeep, notifyManager } from '@tanstack/query-core';
-import { useQueryClient } from './QueryClientProvider.mjs';
-
-function useIsMutating(filters, queryClient) {
-  const client = useQueryClient(queryClient);
-  return useMutationState({
-    filters: {
-      ...filters,
-      status: 'pending'
-    }
-  }, client).length;
-}
-function getResult(mutationCache, options) {
-  return mutationCache.findAll(options.filters).map(mutation => options.select ? options.select(mutation) : mutation.state);
-}
-function useMutationState(options = {}, queryClient) {
-  const mutationCache = useQueryClient(queryClient).getMutationCache();
-  const optionsRef = React.useRef(options);
-  const result = React.useRef();
-  if (!result.current) {
-    result.current = getResult(mutationCache, options);
-  }
-  React.useEffect(() => {
-    optionsRef.current = options;
-  });
-  return React.useSyncExternalStore(React.useCallback(onStoreChange => mutationCache.subscribe(() => {
-    const nextResult = replaceEqualDeep(result.current, getResult(mutationCache, optionsRef.current));
-    if (result.current !== nextResult) {
-      result.current = nextResult;
-      notifyManager.schedule(onStoreChange);
-    }
-  }), [mutationCache]), () => result.current, () => result.current);
-}
-
-export { useIsMutating, useMutationState };
-//# sourceMappingURL=useMutationState.mjs.map

package/build/lib/useQueries.mjs

@@ -1,78 +0,0 @@
-'use client';
-import * as React from 'react';
-import { QueriesObserver, notifyManager } from '@tanstack/query-core';
-import { useQueryClient } from './QueryClientProvider.mjs';
-import { useIsRestoring } from './isRestoring.mjs';
-import { useQueryErrorResetBoundary } from './QueryErrorResetBoundary.mjs';
-import { ensurePreventErrorBoundaryRetry, useClearResetErrorBoundary, getHasError } from './errorBoundaryUtils.mjs';
-import { ensureStaleTime, shouldSuspend, fetchOptimistic, willFetch } from './suspense.mjs';
-
-// This defines the `UseQueryOptions` that are accepted in `QueriesOptions` & `GetOptions`.
-// `placeholderData` function does not have a parameter
-// Avoid TS depth-limit error in case of large array literal
-/**
- * QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
- */
-/**
- * QueriesResults reducer recursively maps type param to results
- */
-function useQueries({
-  queries,
-  ...options
-}, queryClient) {
-  const client = useQueryClient(queryClient);
-  const isRestoring = useIsRestoring();
-  const errorResetBoundary = useQueryErrorResetBoundary();
-  const defaultedQueries = React.useMemo(() => queries.map(opts => {
-    const defaultedOptions = client.defaultQueryOptions(opts);
-
-    // Make sure the results are already in fetching state before subscribing or updating options
-    defaultedOptions._optimisticResults = isRestoring ? 'isRestoring' : 'optimistic';
-    return defaultedOptions;
-  }), [queries, client, isRestoring]);
-  defaultedQueries.forEach(query => {
-    ensureStaleTime(query);
-    ensurePreventErrorBoundaryRetry(query, errorResetBoundary);
-  });
-  useClearResetErrorBoundary(errorResetBoundary);
-  const [observer] = React.useState(() => new QueriesObserver(client, defaultedQueries, options));
-  const [optimisticResult, getCombinedResult, trackResult] = observer.getOptimisticResult(defaultedQueries);
-  React.useSyncExternalStore(React.useCallback(onStoreChange => isRestoring ? () => undefined : observer.subscribe(notifyManager.batchCalls(onStoreChange)), [observer, isRestoring]), () => observer.getCurrentResult(), () => observer.getCurrentResult());
-  React.useEffect(() => {
-    // Do not notify on updates because of changes in the options because
-    // these changes should already be reflected in the optimistic result.
-    observer.setQueries(defaultedQueries, options, {
-      listeners: false
-    });
-  }, [defaultedQueries, options, observer]);
-  const shouldAtLeastOneSuspend = optimisticResult.some((result, index) => shouldSuspend(defaultedQueries[index], result, isRestoring));
-  const suspensePromises = shouldAtLeastOneSuspend ? optimisticResult.flatMap((result, index) => {
-    const opts = defaultedQueries[index];
-    const queryObserver = observer.getObservers()[index];
-    if (opts && queryObserver) {
-      if (shouldSuspend(opts, result, isRestoring)) {
-        return fetchOptimistic(opts, queryObserver, errorResetBoundary);
-      } else if (willFetch(result, isRestoring)) {
-        void fetchOptimistic(opts, queryObserver, errorResetBoundary);
-      }
-    }
-    return [];
-  }) : [];
-  if (suspensePromises.length > 0) {
-    throw Promise.all(suspensePromises);
-  }
-  const observerQueries = observer.getQueries();
-  const firstSingleResultWhichShouldThrow = optimisticResult.find((result, index) => getHasError({
-    result,
-    errorResetBoundary,
-    throwOnError: defaultedQueries[index]?.throwOnError ?? false,
-    query: observerQueries[index]
-  }));
-  if (firstSingleResultWhichShouldThrow?.error) {
-    throw firstSingleResultWhichShouldThrow.error;
-  }
-  return getCombinedResult(trackResult());
-}
-
-export { useQueries };
-//# sourceMappingURL=useQueries.mjs.map

package/build/lib/useQuery.mjs

@@ -1,16 +0,0 @@
-'use client';
-import { QueryObserver } from '@tanstack/query-core';
-import { useBaseQuery } from './useBaseQuery.mjs';
-
-function queryOptions(options) {
-  return options;
-}
-
-// HOOK
-
-function useQuery(options, queryClient) {
-  return useBaseQuery(options, QueryObserver, queryClient);
-}
-
-export { queryOptions, useQuery };
-//# sourceMappingURL=useQuery.mjs.map