@suspensive/react-query-4 3.19.6 → 4.0.0-next.0

package/src/infiniteQueryOptions.ts

@@ -1,77 +0,0 @@
-import {
-  type InfiniteData,
-  type OmitKeyof,
-  type QueryKey,
-  type UseInfiniteQueryOptions,
-  type WithRequired,
-  infiniteQueryOptions as original_infiniteQueryOptions,
-} from '@tanstack/react-query'
-
-/**
- * @deprecated There is no `SelectedInfiniteOptions` in \@tanstack/react-query@^4.40.0.
- */
-export type SelectedInfiniteOptions<
-  TQueryFnData,
-  TError = unknown,
-  TData = InfiniteData<TQueryFnData>,
-  TQueryKey extends QueryKey = QueryKey,
-> = WithRequired<
-  OmitKeyof<
-    UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,
-    | 'queryKeyHashFn'
-    | '_defaulted'
-    | 'behavior'
-    | 'structuralSharing'
-    | 'isDataEqual'
-    | 'onSuccess'
-    | 'onError'
-    | 'onSettled'
-    | 'enabled'
-    | 'refetchInterval'
-    | 'initialData'
-    | 'networkMode'
-  >,
-  'queryKey' | 'queryFn'
-> & {
-  select: (data: InfiniteData<TQueryFnData>) => InfiniteData<TData>
-}
-
-/**
- * @deprecated There is no `UnSelectedInfiniteOptions` in \@tanstack/react-query@^4.40.0.
- */
-export type UnSelectedInfiniteOptions<
-  TQueryFnData,
-  TError = unknown,
-  TData = InfiniteData<TQueryFnData>,
-  TQueryKey extends QueryKey = QueryKey,
-> = WithRequired<
-  OmitKeyof<
-    UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,
-    | 'queryKeyHashFn'
-    | '_defaulted'
-    | 'behavior'
-    | 'structuralSharing'
-    | 'isDataEqual'
-    | 'onSuccess'
-    | 'onError'
-    | 'onSettled'
-    | 'enabled'
-    | 'refetchInterval'
-    | 'initialData'
-    | 'networkMode'
-  >,
-  'queryKey' | 'queryFn'
-> & {
-  select?: undefined
-}
-
-/**
- * This feature is officially supported in \@tanstack/react-query@^4.41.0, You can proceed with the migration.
- * @deprecated Use `infiniteQueryOptions` from \@tanstack/react-query@^4.41.0
- * @example
- * ```diff
- * - import { infiniteQueryOptions } from '@suspensive/react-query'
- * + import { infiniteQueryOptions } from '@tanstack/react-query'
- * ```
- */
-export const infiniteQueryOptions = original_infiniteQueryOptions

package/src/queryOptions.ts

@@ -1,80 +0,0 @@
-import {
-  type OmitKeyof,
-  type QueryKey,
-  type UseQueryOptions,
-  type WithRequired,
-  queryOptions as original_queryOptions,
-} from '@tanstack/react-query'
-
-/**
- * @deprecated There is no `SelectedQueryOptions` in \@tanstack/react-query@^4.40.0.
- */
-export type SelectedQueryOptions<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
-> = WithRequired<
-  OmitKeyof<
-    UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    | 'getNextPageParam'
-    | 'getPreviousPageParam'
-    | 'queryKeyHashFn'
-    | '_defaulted'
-    | 'behavior'
-    | 'structuralSharing'
-    | 'isDataEqual'
-    | 'onSuccess'
-    | 'onError'
-    | 'onSettled'
-    | 'enabled'
-    | 'refetchInterval'
-    | 'initialData'
-    | 'networkMode'
-  >,
-  'queryKey' | 'queryFn'
-> & {
-  select: (data: TQueryFnData) => TData
-}
-
-/**
- * @deprecated There is no `UnSelectedQueryOptions` in \@tanstack/react-query@^4.40.0.
- */
-export type UnSelectedQueryOptions<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
-> = WithRequired<
-  OmitKeyof<
-    UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    | 'getNextPageParam'
-    | 'getPreviousPageParam'
-    | 'queryKeyHashFn'
-    | '_defaulted'
-    | 'behavior'
-    | 'structuralSharing'
-    | 'isDataEqual'
-    | 'onSuccess'
-    | 'onError'
-    | 'onSettled'
-    | 'enabled'
-    | 'refetchInterval'
-    | 'initialData'
-    | 'networkMode'
-  >,
-  'queryKey' | 'queryFn'
-> & {
-  select?: undefined
-}
-
-/**
- * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
- * @deprecated Use `queryOptions` from \@tanstack/react-query@^4.40.0
- * @example
- * ```diff
- * - import { queryOptions } from '@suspensive/react-query'
- * + import { queryOptions } from '@tanstack/react-query'
- * ```
- */
-export const queryOptions = original_queryOptions

package/src/usePrefetchInfiniteQuery.test-d.tsx

@@ -1,14 +0,0 @@
-import { infiniteQueryOptions } from '@tanstack/react-query'
-import { queryFn, queryKey } from './test-utils'
-import { usePrefetchInfiniteQuery } from './usePrefetchInfiniteQuery'
-
-describe('usePrefetchInfiniteQuery', () => {
-  it('type check', () => {
-    expectTypeOf(usePrefetchInfiniteQuery({ queryFn, queryKey }))
-      // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-      .toEqualTypeOf<void>()
-    expectTypeOf(usePrefetchInfiniteQuery(infiniteQueryOptions({ queryFn, queryKey })))
-      // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-      .toEqualTypeOf<void>()
-  })
-})

package/src/usePrefetchInfiniteQuery.ts

@@ -1,19 +0,0 @@
-'use client'
-import { type FetchInfiniteQueryOptions, type QueryKey, useQueryClient } from '@tanstack/react-query'
-
-/**
- * The `usePrefetchInfiniteQuery` does not return anything, it should be used just to fire a prefetch during render, before a suspense boundary that wraps a component that uses `useSuspenseInfiniteQuery`.
- * @see {@link https://suspensive.org/docs/react-query/usePrefetchInfiniteQuery Suspensive Docs}
- */
-export function usePrefetchInfiniteQuery<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {
-  const queryClient = useQueryClient()
-
-  if (typeof options.queryKey !== 'undefined' && !queryClient.getQueryState(options.queryKey)) {
-    queryClient.prefetchInfiniteQuery(options)
-  }
-}

package/src/usePrefetchQuery.test-d.tsx

@@ -1,14 +0,0 @@
-import { queryOptions } from '@tanstack/react-query'
-import { queryFn, queryKey } from './test-utils'
-import { usePrefetchQuery } from './usePrefetchQuery'
-
-describe('usePrefetchQuery', () => {
-  it('type check', () => {
-    expectTypeOf(usePrefetchQuery({ queryFn, queryKey }))
-      // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-      .toEqualTypeOf<void>()
-    expectTypeOf(usePrefetchQuery(queryOptions({ queryFn, queryKey })))
-      // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-      .toEqualTypeOf<void>()
-  })
-})

package/src/usePrefetchQuery.ts

@@ -1,19 +0,0 @@
-'use client'
-import { type FetchQueryOptions, type QueryKey, useQueryClient } from '@tanstack/react-query'
-
-/**
- * The `usePrefetchQuery` does not return anything, it should be used just to fire a prefetch during render, before a suspense boundary that wraps a component that uses `useSuspenseQuery`.
- * @see {@link https://suspensive.org/docs/react-query/usePrefetchQuery Suspensive Docs}
- */
-export function usePrefetchQuery<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {
-  const queryClient = useQueryClient()
-
-  if (typeof options.queryKey !== 'undefined' && !queryClient.getQueryState(options.queryKey)) {
-    queryClient.prefetchQuery(options)
-  }
-}

package/src/useSuspenseInfiniteQuery.ts

@@ -1,34 +0,0 @@
-'use client'
-import {
-  type OmitKeyof,
-  type QueryKey,
-  type UseInfiniteQueryOptions,
-  type WithRequired,
-  useSuspenseInfiniteQuery as original_useSuspenseInfiniteQuery,
-} from '@tanstack/react-query'
-
-export type { UseSuspenseInfiniteQueryResult } from '@tanstack/react-query'
-
-export type UseSuspenseInfiniteQueryOptions<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
-> = WithRequired<
-  OmitKeyof<
-    UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,
-    'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData' | 'networkMode' | 'initialData'
-  >,
-  'queryKey'
->
-
-/**
- * This feature is officially supported in \@tanstack/react-query@^4.41.0, You can proceed with the migration.
- * @deprecated Use `useSuspenseInfiniteQuery` from \@tanstack/react-query@^4.41.0
- * @example
- * ```diff
- * - import { useSuspenseInfiniteQuery } from '@suspensive/react-query'
- * + import { useSuspenseInfiniteQuery } from '@tanstack/react-query'
- * ```
- */
-export const useSuspenseInfiniteQuery = original_useSuspenseInfiniteQuery

package/src/useSuspenseQueries.ts

@@ -1,47 +0,0 @@
-'use client'
-import {
-  type SuspenseQueriesOptions as original_SuspenseQueriesOptions,
-  type SuspenseQueriesResults as original_SuspenseQueriesResults,
-  useSuspenseQueries as original_useSuspenseQueries,
-} from '@tanstack/react-query'
-
-/**
- * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
- * @deprecated Use `SuspenseQueriesOptions` from \@tanstack/react-query@^4.40.0
- * @example
- * ```diff
- * - import type { SuspenseQueriesOptions } from '@suspensive/react-query'
- * + import type { SuspenseQueriesOptions } from '@tanstack/react-query'
- * ```
- */
-export type SuspenseQueriesOptions<
-  T extends Array<any>,
-  TResult extends Array<any> = [],
-  TDepth extends ReadonlyArray<number> = [],
-> = original_SuspenseQueriesOptions<T, TResult, TDepth>
-
-/**
- * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
- * @deprecated Use `SuspenseQueriesResults` from \@tanstack/react-query@^4.40.0
- * @example
- * ```diff
- * - import type { SuspenseQueriesResults } from '@suspensive/react-query'
- * + import type { SuspenseQueriesResults } from '@tanstack/react-query'
- * ```
- */
-export type SuspenseQueriesResults<
-  T extends Array<any>,
-  TResult extends Array<any> = [],
-  TDepth extends ReadonlyArray<number> = [],
-> = original_SuspenseQueriesResults<T, TResult, TDepth>
-
-/**
- * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
- * @deprecated Use `useSuspenseQueries` from \@tanstack/react-query@^4.40.0
- * @example
- * ```diff
- * - import { useSuspenseQueries } from '@suspensive/react-query'
- * + import { useSuspenseQueries } from '@tanstack/react-query'
- * ```
- */
-export const useSuspenseQueries = original_useSuspenseQueries

package/src/useSuspenseQuery.ts

@@ -1,39 +0,0 @@
-'use client'
-import {
-  type UseSuspenseQueryOptions as original_UseSuspenseQueryOptions,
-  type UseSuspenseQueryResult as original_UseSuspenseQueryResult,
-  useSuspenseQuery as original_useSuspenseQuery,
-} from '@tanstack/react-query'
-
-/**
- * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
- * @deprecated Use `UseSuspenseQueryOptions` from \@tanstack/react-query@^4.40.0
- * @example
- * ```diff
- * - import type { UseSuspenseQueryOptions } from '@suspensive/react-query'
- * + import type { UseSuspenseQueryOptions } from '@tanstack/react-query'
- * ```
- */
-export type UseSuspenseQueryOptions = original_UseSuspenseQueryOptions
-
-/**
- * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
- * @deprecated Use `UseSuspenseQueryResult` from \@tanstack/react-query@^4.40.0
- * @example
- * ```diff
- * - import type { UseSuspenseQueryResult } from '@suspensive/react-query'
- * + import type { UseSuspenseQueryResult } from '@tanstack/react-query'
- * ```
- */
-export type UseSuspenseQueryResult = original_UseSuspenseQueryResult
-
-/**
- * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
- * @deprecated Use `useSuspenseQuery` from \@tanstack/react-query@^4.40.0
- * @example
- * ```diff
- * - import { useSuspenseQuery } from '@suspensive/react-query'
- * + import { useSuspenseQuery } from '@tanstack/react-query'
- * ```
- */
-export const useSuspenseQuery = original_useSuspenseQuery