@tanstack/svelte-query 4.24.10 → 5.0.0-alpha.1

package/src/createQuery.ts

@@ -1,143 +1,69 @@
-import { QueryObserver, parseQueryArgs } from '@tanstack/query-core'
-import type { QueryFunction, QueryKey } from '@tanstack/query-core'
+import { QueryObserver } from '@tanstack/query-core'
+import type {
+  QueryKey,
+  QueryClient,
+  RegisteredError,
+} from '@tanstack/query-core'
 import { createBaseQuery } from './createBaseQuery'
 import type {
   DefinedCreateQueryResult,
   CreateQueryOptions,
   CreateQueryResult,
+  WritableOrVal,
 } from './types'
 
-export function createQuery<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  options: Omit<
-    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    'initialData'
-  > & {
-    initialData?: () => undefined
-  },
-): CreateQueryResult<TData, TError>
-
-export function createQuery<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  options: Omit<
-    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    'initialData'
-  > & {
-    initialData: TQueryFnData | (() => TQueryFnData)
-  },
-): DefinedCreateQueryResult<TData, TError>
-
-export function createQuery<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  options: CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-): CreateQueryResult<TData, TError>
-
-export function createQuery<
+type UndefinedInitialDataOptions<
   TQueryFnData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
->(
-  queryKey: TQueryKey,
-  options?: Omit<
-    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    'queryKey' | 'initialData'
-  > & { initialData?: () => undefined },
-): CreateQueryResult<TData, TError>
+> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
+  initialData?: undefined
+}
 
-export function createQuery<
+type DefinedInitialDataOptions<
   TQueryFnData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
->(
-  queryKey: TQueryKey,
-  options?: Omit<
-    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    'queryKey' | 'initialData'
-  > & { initialData: TQueryFnData | (() => TQueryFnData) },
-): DefinedCreateQueryResult<TData, TError>
+> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
+  initialData: TQueryFnData | (() => TQueryFnData)
+}
 
 export function createQuery<
   TQueryFnData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 >(
-  queryKey: TQueryKey,
-  options?: Omit<
-    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    'queryKey'
+  options: WritableOrVal<
+    UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
   >,
+  queryClient?: QueryClient,
 ): CreateQueryResult<TData, TError>
 
 export function createQuery<
   TQueryFnData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 >(
-  queryKey: TQueryKey,
-  queryFn: QueryFunction<TQueryFnData, TQueryKey>,
-  options?: Omit<
-    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    'queryKey' | 'queryFn' | 'initialData'
-  > & { initialData?: () => undefined },
-): CreateQueryResult<TData, TError>
-
-export function createQuery<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  queryKey: TQueryKey,
-  queryFn: QueryFunction<TQueryFnData, TQueryKey>,
-  options?: Omit<
-    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    'queryKey' | 'queryFn' | 'initialData'
-  > & { initialData: TQueryFnData | (() => TQueryFnData) },
-): DefinedCreateQueryResult<TData, TError>
-
-export function createQuery<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  queryKey: TQueryKey,
-  queryFn: QueryFunction<TQueryFnData, TQueryKey>,
-  options?: Omit<
-    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    'queryKey' | 'queryFn'
+  options: WritableOrVal<
+    DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
   >,
-): CreateQueryResult<TData, TError>
+  queryClient?: QueryClient,
+): DefinedCreateQueryResult<TData, TError>
 
 export function createQuery<
   TQueryFnData,
-  TError,
+  TError = RegisteredError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 >(
-  arg1: TQueryKey | CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-  arg2?:
-    | QueryFunction<TQueryFnData, TQueryKey>
-    | CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-  arg3?: CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-): CreateQueryResult<TData, TError> {
-  const parsedOptions = parseQueryArgs(arg1, arg2, arg3)
-  const result = createBaseQuery(parsedOptions, QueryObserver)
-  return result
+  options: WritableOrVal<
+    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>
+  >,
+  queryClient?: QueryClient,
+) {
+  return createBaseQuery(options, QueryObserver, queryClient)
 }

package/src/index.ts

@@ -13,5 +13,5 @@ export { useQueryClient } from './useQueryClient'
 export { useIsFetching } from './useIsFetching'
 export { useIsMutating } from './useIsMutating'
 export { useHydrate } from './useHydrate'
-export { default as Hydrate } from './Hydrate.svelte'
+export { default as HydrationBoundary } from './HydrationBoundary.svelte'
 export { default as QueryClientProvider } from './QueryClientProvider.svelte'

package/src/types.ts

@@ -8,9 +8,12 @@ import type {
   MutationObserverOptions,
   MutateFunction,
   DefinedQueryObserverResult,
+  RegisteredError,
 } from '@tanstack/query-core'
 import type { QueryClient } from '@tanstack/query-core'
-import type { Readable } from 'svelte/store'
+import type { Readable, Writable } from 'svelte/store'
+
+export type WritableOrVal<T> = T | Writable<T>
 
 export interface ContextOptions {
   /**
@@ -21,19 +24,21 @@ export interface ContextOptions {
 
 export interface CreateBaseQueryOptions<
   TQueryFnData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TData = TQueryFnData,
   TQueryData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 > extends ContextOptions,
     QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {}
 
-export interface CreateBaseQueryResult<TData = unknown, TError = unknown>
-  extends Readable<QueryObserverResult<TData, TError>> {}
+export interface CreateBaseQueryResult<
+  TData = unknown,
+  TError = RegisteredError,
+> extends Readable<QueryObserverResult<TData, TError>> {}
 
 export interface CreateQueryOptions<
   TQueryFnData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 > extends CreateBaseQueryOptions<
@@ -44,41 +49,43 @@ export interface CreateQueryOptions<
     TQueryKey
   > {}
 
-export interface CreateQueryResult<TData = unknown, TError = unknown>
+export interface CreateQueryResult<TData = unknown, TError = RegisteredError>
   extends CreateBaseQueryResult<TData, TError> {}
 
 export interface CreateInfiniteQueryOptions<
   TQueryFnData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TData = TQueryFnData,
   TQueryData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
 > extends InfiniteQueryObserverOptions<
     TQueryFnData,
     TError,
     TData,
     TQueryData,
-    TQueryKey
+    TQueryKey,
+    TPageParam
   > {}
 
 export type CreateInfiniteQueryResult<
   TData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
 > = Readable<InfiniteQueryObserverResult<TData, TError>>
 
 export type DefinedCreateBaseQueryResult<
   TData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
 > = Readable<DefinedQueryObserverResult<TData, TError>>
 
 export type DefinedCreateQueryResult<
   TData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
 > = DefinedCreateBaseQueryResult<TData, TError>
 
 export interface CreateMutationOptions<
   TData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TVariables = void,
   TContext = unknown,
 > extends ContextOptions,
@@ -89,7 +96,7 @@ export interface CreateMutationOptions<
 
 export type CreateMutateFunction<
   TData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TVariables = void,
   TContext = unknown,
 > = (
@@ -98,14 +105,14 @@ export type CreateMutateFunction<
 
 export type CreateMutateAsyncFunction<
   TData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TVariables = void,
   TContext = unknown,
 > = MutateFunction<TData, TError, TVariables, TContext>
 
 export type CreateBaseMutationResult<
   TData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TVariables = unknown,
   TContext = unknown,
 > = Override<
@@ -117,7 +124,7 @@ export type CreateBaseMutationResult<
 
 export interface CreateMutationResult<
   TData = unknown,
-  TError = unknown,
+  TError = RegisteredError,
   TVariables = unknown,
   TContext = unknown,
 > extends Readable<

package/src/useHydrate.ts

@@ -5,8 +5,12 @@ import {
 } from '@tanstack/query-core'
 import { useQueryClient } from './useQueryClient'
 
-export function useHydrate(state?: unknown, options?: HydrateOptions) {
-  const client: QueryClient = useQueryClient()
+export function useHydrate(
+  state?: unknown,
+  options?: HydrateOptions,
+  queryClient?: QueryClient,
+) {
+  const client = useQueryClient(queryClient)
 
   if (state) {
     hydrate(client, state, options)

package/src/useIsFetching.ts

@@ -1,25 +1,16 @@
 import {
   type QueryFilters,
-  type QueryKey,
   type QueryClient,
-  parseFilterArgs,
   notifyManager,
 } from '@tanstack/query-core'
 import { type Readable, readable } from 'svelte/store'
 import { useQueryClient } from './useQueryClient'
 
-export function useIsFetching(filters?: QueryFilters): Readable<number>
 export function useIsFetching(
-  queryKey?: QueryKey,
   filters?: QueryFilters,
-): Readable<number>
-
-export function useIsFetching(
-  arg1?: QueryKey | QueryFilters,
-  arg2?: QueryFilters,
+  queryClient?: QueryClient,
 ): Readable<number> {
-  const [filters] = parseFilterArgs(arg1, arg2)
-  const client: QueryClient = useQueryClient()
+  const client = useQueryClient(queryClient)
   const cache = client.getQueryCache()
   // isFetching is the prev value initialized on mount *
   let isFetching = client.isFetching(filters)

package/src/useIsMutating.ts

@@ -1,25 +1,16 @@
 import {
   type MutationFilters,
-  type MutationKey,
   type QueryClient,
   notifyManager,
-  parseMutationFilterArgs,
 } from '@tanstack/query-core'
 import { type Readable, readable } from 'svelte/store'
 import { useQueryClient } from './useQueryClient'
 
-export function useIsMutating(filters?: MutationFilters): Readable<number>
 export function useIsMutating(
-  mutationKey?: MutationKey,
-  filters?: Omit<MutationFilters, 'mutationKey'>,
-): Readable<number>
-
-export function useIsMutating(
-  arg1?: MutationKey | MutationFilters,
-  arg2?: Omit<MutationFilters, 'mutationKey'>,
+  filters?: MutationFilters,
+  queryClient?: QueryClient,
 ): Readable<number> {
-  const [filters] = parseMutationFilterArgs(arg1, arg2)
-  const client: QueryClient = useQueryClient()
+  const client = useQueryClient(queryClient)
   const cache = client.getMutationCache()
   // isMutating is the prev value initialized on mount *
   let isMutating = client.isMutating(filters)

package/src/useQueryClient.ts

@@ -1,7 +1,12 @@
 import type { QueryClient } from '@tanstack/query-core'
 import { getQueryClientContext } from './context'
 
-export function useQueryClient(): QueryClient {
-  const queryClient = getQueryClientContext()
-  return queryClient
+export function useQueryClient(queryClient?: QueryClient): QueryClient {
+  const client = getQueryClientContext()
+
+  if (queryClient) {
+    return queryClient
+  }
+
+  return client
 }

package/src/utils.ts

@@ -0,0 +1,8 @@
+import type { Writable } from 'svelte/store'
+import type { WritableOrVal } from './types'
+
+export function isWritable<T extends object>(
+  obj: WritableOrVal<T>,
+): obj is Writable<T> {
+  return 'subscribe' in obj && 'set' in obj && 'update' in obj
+}

package/build/lib/Hydrate.svelte.d.ts

@@ -1,20 +0,0 @@
-import { SvelteComponentTyped } from "svelte";
-import type { DehydratedState, HydrateOptions } from '@tanstack/query-core';
-declare const __propDef: {
-    props: {
-        state: DehydratedState;
-        options?: HydrateOptions | undefined;
-    };
-    events: {
-        [evt: string]: CustomEvent<any>;
-    };
-    slots: {
-        default: {};
-    };
-};
-export declare type HydrateProps = typeof __propDef.props;
-export declare type HydrateEvents = typeof __propDef.events;
-export declare type HydrateSlots = typeof __propDef.slots;
-export default class Hydrate extends SvelteComponentTyped<HydrateProps, HydrateEvents, HydrateSlots> {
-}
-export {};

package/src/Hydrate.svelte

@@ -1,11 +0,0 @@
-<script lang="ts">
-  import type { DehydratedState, HydrateOptions } from '@tanstack/query-core'
-  import { useHydrate } from './useHydrate'
-
-  export let state: DehydratedState
-  export let options: HydrateOptions | undefined = undefined
-
-  useHydrate(state, options)
-</script>
-
-<slot />