@tanstack/svelte-query 4.21.0

package/src/lib/createQuery.ts

@@ -0,0 +1,143 @@
+import { QueryObserver, parseQueryArgs } from '@tanstack/query-core'
+import type { QueryFunction, QueryKey } from '@tanstack/query-core'
+import { createBaseQuery } from './createBaseQuery'
+import type {
+  DefinedCreateQueryResult,
+  CreateQueryOptions,
+  CreateQueryStoreResult,
+} 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
+  },
+): CreateQueryStoreResult<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>,
+): CreateQueryStoreResult<TData, TError>
+
+export function createQuery<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+>(
+  queryKey: TQueryKey,
+  options?: Omit<
+    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+    'queryKey' | 'initialData'
+  > & { initialData?: () => undefined },
+): CreateQueryStoreResult<TData, TError>
+
+export function createQuery<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+>(
+  queryKey: TQueryKey,
+  options?: Omit<
+    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+    'queryKey' | 'initialData'
+  > & { initialData: TQueryFnData | (() => TQueryFnData) },
+): DefinedCreateQueryResult<TData, TError>
+
+export function createQuery<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+>(
+  queryKey: TQueryKey,
+  options?: Omit<
+    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+    'queryKey'
+  >,
+): CreateQueryStoreResult<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?: () => undefined },
+): CreateQueryStoreResult<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'
+  >,
+): CreateQueryStoreResult<TData, TError>
+
+export function createQuery<
+  TQueryFnData,
+  TError,
+  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>,
+): CreateQueryStoreResult<TData, TError> {
+  const parsedOptions = parseQueryArgs(arg1, arg2, arg3)
+  const result = createBaseQuery(parsedOptions, QueryObserver)
+  return result
+}

package/src/lib/index.ts

@@ -0,0 +1,17 @@
+/* istanbul ignore file */
+
+// Re-export core
+export * from '@tanstack/query-core'
+
+// Svelte Query
+export * from './types'
+export { createQuery } from './createQuery'
+export { createQueries } from './createQueries'
+export { createInfiniteQuery } from './createInfiniteQuery'
+export { createMutation } from './createMutation'
+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 QueryClientProvider } from './QueryClientProvider.svelte'

package/src/lib/types.ts

@@ -0,0 +1,146 @@
+import type {
+  InfiniteQueryObserverOptions,
+  InfiniteQueryObserverResult,
+  MutationObserverResult,
+  QueryObserverOptions,
+  QueryObserverResult,
+  QueryKey,
+  MutationObserverOptions,
+  MutateFunction,
+  DefinedQueryObserverResult,
+} from '@tanstack/query-core'
+import type { QueryClient } from '@tanstack/query-core'
+import type { Readable } from 'svelte/store'
+
+export interface ContextOptions {
+  /**
+   * Use this to pass your Svelte Query context. Otherwise, `defaultContext` will be used.
+   */
+  context?: QueryClient | undefined
+}
+
+export interface CreateBaseQueryOptions<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+  TQueryData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+> extends ContextOptions,
+    QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {}
+
+export interface CreateQueryOptions<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+> extends CreateBaseQueryOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    TQueryFnData,
+    TQueryKey
+  > {}
+
+export interface CreateInfiniteQueryOptions<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+  TQueryData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+> extends InfiniteQueryObserverOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    TQueryData,
+    TQueryKey
+  > {}
+
+export type CreateInfiniteQueryResult<
+  TData = unknown,
+  TError = unknown,
+> = Readable<InfiniteQueryObserverResult<TData, TError>>
+
+export interface CreateInfiniteQueryStoreResult<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+> extends Readable<CreateInfiniteQueryResult<TData, TError>> {}
+
+export type CreateBaseQueryResult<
+  TData = unknown,
+  TError = unknown,
+> = QueryObserverResult<TData, TError>
+
+export type CreateQueryResult<
+  TData = unknown,
+  TError = unknown,
+> = CreateBaseQueryResult<TData, TError>
+
+export interface CreateQueryStoreResult<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+> extends Readable<CreateQueryResult<TData, TError>> {}
+
+export type DefinedCreateBaseQueryResult<
+  TData = unknown,
+  TError = unknown,
+> = Readable<DefinedQueryObserverResult<TData, TError>>
+
+export type DefinedCreateQueryResult<
+  TData = unknown,
+  TError = unknown,
+> = DefinedCreateBaseQueryResult<TData, TError>
+
+export interface CreateMutationOptions<
+  TData = unknown,
+  TError = unknown,
+  TVariables = void,
+  TContext = unknown,
+> extends ContextOptions,
+    Omit<
+      MutationObserverOptions<TData, TError, TVariables, TContext>,
+      '_defaulted' | 'variables'
+    > {}
+
+export type UseMutateFunction<
+  TData = unknown,
+  TError = unknown,
+  TVariables = void,
+  TContext = unknown,
+> = (
+  ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
+) => void
+
+export type UseMutateAsyncFunction<
+  TData = unknown,
+  TError = unknown,
+  TVariables = void,
+  TContext = unknown,
+> = MutateFunction<TData, TError, TVariables, TContext>
+
+export type UseBaseMutationResult<
+  TData = unknown,
+  TError = unknown,
+  TVariables = unknown,
+  TContext = unknown,
+> = Override<
+  MutationObserverResult<TData, TError, TVariables, TContext>,
+  { mutate: UseMutateFunction<TData, TError, TVariables, TContext> }
+> & { mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext> }
+
+export type CreateMutationResult<
+  TData = unknown,
+  TError = unknown,
+  TVariables = unknown,
+  TContext = unknown,
+> = UseBaseMutationResult<TData, TError, TVariables, TContext>
+
+export interface MutationStoreResult<
+  TData = unknown,
+  TError = unknown,
+  TVariables = unknown,
+  TContext = unknown,
+> extends Readable<CreateMutationResult<TData, TError, TVariables, TContext>> {}
+
+type Override<A, B> = { [K in keyof A]: K extends keyof B ? B[K] : A[K] }

package/src/lib/useHydrate.ts

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

package/src/lib/useIsFetching.ts

@@ -0,0 +1,41 @@
+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,
+): Readable<number> {
+  const [filters] = parseFilterArgs(arg1, arg2)
+  const client: QueryClient = useQueryClient()
+  const cache = client.getQueryCache()
+  // isFetching is the prev value initialized on mount *
+  let isFetching = client.isFetching(filters)
+
+  const { subscribe } = readable(isFetching, (set) => {
+    return cache.subscribe(
+      notifyManager.batchCalls(() => {
+        const newIsFetching = client.isFetching(filters)
+        if (isFetching !== newIsFetching) {
+          // * and update with each change
+          isFetching = newIsFetching
+          set(isFetching)
+        }
+      }),
+    )
+  })
+
+  return { subscribe }
+}

package/src/lib/useIsMutating.ts

@@ -0,0 +1,41 @@
+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'>,
+): Readable<number> {
+  const [filters] = parseMutationFilterArgs(arg1, arg2)
+  const client: QueryClient = useQueryClient()
+  const cache = client.getMutationCache()
+  // isMutating is the prev value initialized on mount *
+  let isMutating = client.isMutating(filters)
+
+  const { subscribe } = readable(isMutating, (set) => {
+    return cache.subscribe(
+      notifyManager.batchCalls(() => {
+        const newIisMutating = client.isMutating(filters)
+        if (isMutating !== newIisMutating) {
+          // * and update with each change
+          isMutating = newIisMutating
+          set(isMutating)
+        }
+      }),
+    )
+  })
+
+  return { subscribe }
+}

package/src/lib/useQueryClient.ts

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