@tanstack/vue-query 5.96.2 → 5.98.0

package/src/queryOptions.ts

@@ -1,8 +1,60 @@
-import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'
+import type { DeepUnwrapRef, ShallowOption } from './types'
 import type {
-  DefinedInitialQueryOptions,
-  UndefinedInitialQueryOptions,
-} from './useQuery'
+  DataTag,
+  DefaultError,
+  Enabled,
+  InitialDataFunction,
+  NonUndefinedGuard,
+  QueryKey,
+  QueryObserverOptions,
+} from '@tanstack/query-core'
+
+export type QueryOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+> = {
+  [Property in keyof QueryObserverOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    TQueryData,
+    TQueryKey
+  >]: Property extends 'enabled'
+    ? () => Enabled<TQueryFnData, TError, TQueryData, DeepUnwrapRef<TQueryKey>>
+    : QueryObserverOptions<
+        TQueryFnData,
+        TError,
+        TData,
+        TQueryData,
+        DeepUnwrapRef<TQueryKey>
+      >[Property]
+} & ShallowOption
+
+export type UndefinedInitialQueryOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+> = QueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
+  initialData?:
+    | undefined
+    | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
+    | NonUndefinedGuard<TQueryFnData>
+}
+
+export type DefinedInitialQueryOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+> = QueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
+  initialData:
+    | NonUndefinedGuard<TQueryFnData>
+    | (() => NonUndefinedGuard<TQueryFnData>)
+}
 
 export function queryOptions<
   TQueryFnData = unknown,
@@ -15,6 +67,22 @@ export function queryOptions<
   queryKey: DataTag<TQueryKey, TQueryFnData, TError>
 }
 
+export function queryOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+>(
+  options: () => DefinedInitialQueryOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    TQueryKey
+  >,
+): () => DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
+  queryKey: DataTag<TQueryKey, TQueryFnData, TError>
+}
+
 export function queryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
@@ -26,6 +94,27 @@ export function queryOptions<
   queryKey: DataTag<TQueryKey, TQueryFnData, TError>
 }
 
+export function queryOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+>(
+  options: () => UndefinedInitialQueryOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    TQueryKey
+  >,
+): () => UndefinedInitialQueryOptions<
+  TQueryFnData,
+  TError,
+  TData,
+  TQueryKey
+> & {
+  queryKey: DataTag<TQueryKey, TQueryFnData, TError>
+}
+
 export function queryOptions(options: unknown) {
   return options
 }

package/src/types.ts

@@ -22,6 +22,8 @@ type UnwrapLeaf =
   | Set<any>
   | WeakSet<any>
 
+export type MaybeGetter<T> = T | (() => T)
+
 export type MaybeRef<T> = Ref<T> | ComputedRef<T> | T
 
 export type MaybeRefOrGetter<T> = MaybeRef<T> | (() => T)

package/src/usePrefetchInfiniteQuery.ts

@@ -0,0 +1,113 @@
+import { getCurrentScope, unref, watchEffect } from 'vue-demi'
+import { useQueryClient } from './useQueryClient'
+import { cloneDeepUnref } from './utils'
+import type {
+  DefaultError,
+  FetchInfiniteQueryOptions,
+  FetchQueryOptions,
+  GetNextPageParamFunction,
+  InfiniteData,
+  InitialPageParam,
+  OmitKeyof,
+  QueryKey,
+  SkipToken,
+} from '@tanstack/query-core'
+import type { QueryClient } from './queryClient'
+import type { MaybeRefDeep, MaybeRefOrGetter } from './types'
+
+type PrefetchInfinitePages<TQueryFnData, TPageParam> =
+  | {
+      pages?: never
+      getNextPageParam?: GetNextPageParamFunction<TPageParam, TQueryFnData>
+    }
+  | {
+      pages: number
+      getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
+    }
+
+export type UsePrefetchInfiniteQueryOptions<
+  TQueryFnData,
+  TError,
+  TData,
+  TQueryKey extends QueryKey,
+  TPageParam,
+> = OmitKeyof<
+  FetchQueryOptions<
+    TQueryFnData,
+    TError,
+    InfiniteData<TData, TPageParam>,
+    TQueryKey,
+    TPageParam
+  >,
+  'queryFn' | 'initialPageParam'
+> &
+  InitialPageParam<TPageParam> & {
+    queryFn?: Exclude<
+      FetchQueryOptions<
+        TQueryFnData,
+        TError,
+        InfiniteData<TData, TPageParam>,
+        TQueryKey,
+        TPageParam
+      >['queryFn'],
+      SkipToken
+    >
+  } & PrefetchInfinitePages<TQueryFnData, TPageParam>
+
+function isGetter<T>(value: MaybeRefOrGetter<T>): value is () => T {
+  return typeof value === 'function'
+}
+
+export function usePrefetchInfiniteQuery<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
+>(
+  options: MaybeRefOrGetter<
+    MaybeRefDeep<
+      UsePrefetchInfiniteQueryOptions<
+        TQueryFnData,
+        TError,
+        TData,
+        TQueryKey,
+        TPageParam
+      >
+    >
+  >,
+  queryClient?: QueryClient,
+): void {
+  if (process.env.NODE_ENV === 'development') {
+    if (!getCurrentScope()) {
+      console.warn(
+        'vue-query composable like "useQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
+      )
+    }
+  }
+
+  const client = queryClient || useQueryClient()
+
+  watchEffect(() => {
+    const resolvedOptions = isGetter(options) ? options() : unref(options)
+    const clonedOptions: UsePrefetchInfiniteQueryOptions<
+      TQueryFnData,
+      TError,
+      TData,
+      TQueryKey,
+      TPageParam
+    > = cloneDeepUnref(resolvedOptions)
+
+    if (!client.getQueryState(clonedOptions.queryKey)) {
+      void client.prefetchInfiniteQuery(
+        clonedOptions as FetchInfiniteQueryOptions<
+          TQueryFnData,
+          TError,
+          TData,
+          TQueryKey,
+          TPageParam
+        >,
+      )
+    }
+  })
+}

package/src/usePrefetchQuery.ts

@@ -0,0 +1,69 @@
+import { getCurrentScope, unref, watchEffect } from 'vue-demi'
+import { useQueryClient } from './useQueryClient'
+import { cloneDeepUnref } from './utils'
+import type {
+  DefaultError,
+  FetchQueryOptions,
+  OmitKeyof,
+  QueryKey,
+  SkipToken,
+} from '@tanstack/query-core'
+import type { QueryClient } from './queryClient'
+import type { MaybeRefDeep, MaybeRefOrGetter } from './types'
+
+export type UsePrefetchQueryOptions<
+  TQueryFnData,
+  TError,
+  TData,
+  TQueryKey extends QueryKey,
+> = OmitKeyof<
+  FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+  'queryFn'
+> & {
+  queryFn?: Exclude<
+    FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>['queryFn'],
+    SkipToken
+  >
+}
+
+function isGetter<T>(value: MaybeRefOrGetter<T>): value is () => T {
+  return typeof value === 'function'
+}
+
+export function usePrefetchQuery<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+>(
+  options: MaybeRefOrGetter<
+    MaybeRefDeep<
+      UsePrefetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
+    >
+  >,
+  queryClient?: QueryClient,
+): void {
+  if (process.env.NODE_ENV === 'development') {
+    if (!getCurrentScope()) {
+      console.warn(
+        'vue-query composable like "useQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
+      )
+    }
+  }
+
+  const client = queryClient || useQueryClient()
+
+  watchEffect(() => {
+    const resolvedOptions = isGetter(options) ? options() : unref(options)
+    const clonedOptions: UsePrefetchQueryOptions<
+      TQueryFnData,
+      TError,
+      TData,
+      TQueryKey
+    > = cloneDeepUnref(resolvedOptions)
+
+    if (!client.getQueryState(clonedOptions.queryKey)) {
+      void client.prefetchQuery(clonedOptions)
+    }
+  })
+}

package/src/utils.ts

@@ -109,3 +109,7 @@ function isPlainObject(value: unknown): value is Object {
 function isFunction(value: unknown): value is Function {
   return typeof value === 'function'
 }
+
+export function toValueDeep<T>(source: (() => T) | MaybeRefDeep<T>): T {
+  return isFunction(source) ? source() : cloneDeepUnref(source)
+}