@tanstack/solid-query 5.103.1 → 5.103.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-query",
-  "version": "5.103.1",
+  "version": "5.103.3",
   "description": "Primitives for managing, caching and syncing asynchronous and remote data in Solid",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -46,15 +46,15 @@
     "!src/__tests__"
   ],
   "dependencies": {
-    "@tanstack/query-core": "5.103.1"
+    "@tanstack/query-core": "5.103.3"
   },
   "devDependencies": {
     "@solidjs/testing-library": "^0.8.10",
-    "npm-run-all2": "^5.0.0",
-    "solid-js": "^1.9.7",
+    "@tanstack/query-test-utils": "0.0.0",
+    "npm-run-all2": "^9.0.3",
+    "solid-js": "^1.9.15",
     "unplugin-solid": "^2.0.0",
-    "vite-plugin-solid": "^2.11.6",
-    "@tanstack/query-test-utils": "0.0.0"
+    "vite-plugin-solid": "^2.11.14"
   },
   "peerDependencies": {
     "solid-js": "^1.6.0"

package/src/QueryClient.ts

@@ -45,9 +45,7 @@ export interface QueryObserverOptions<
    * Defaults reconciliation to false.
    */
   reconcile?:
-    | string
-    | false
-    | ((oldData: TData | undefined, newData: TData) => TData)
+    string | false | ((oldData: TData | undefined, newData: TData) => TData)
 }
 
 /**
@@ -82,9 +80,7 @@ export interface InfiniteQueryObserverOptions<
    * Defaults reconciliation to false.
    */
   reconcile?:
-    | string
-    | false
-    | ((oldData: TData | undefined, newData: TData) => TData)
+    string | false | ((oldData: TData | undefined, newData: TData) => TData)
 }
 
 /**

package/src/QueryClientProvider.tsx

@@ -18,7 +18,7 @@ const queryClientContextError =
   'No QueryClient set, use QueryClientProvider to set one'
 
 /**
- * The `useQueryClient` hook returns the current `QueryClient` instance.
+ * The `useQueryClient` primitive returns the current `QueryClient` instance.
  *
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.

package/src/infiniteQueryOptions.ts

@@ -36,7 +36,7 @@ export type UndefinedInitialDataInfiniteOptions<
 
 /**
  * The options accepted by the `infiniteQueryOptions` overload selected when `initialData` is set — `data` is
- * never `undefined`.
+ * never `undefined` (unless a `select` changes `TData` to include `undefined`).
  *
  * @template TQueryFnData - The type of a single page, as your `queryFn` resolves it.
  * @template TError - The type of errors your `queryFn` may throw.

package/src/isRestoring.ts

@@ -4,7 +4,7 @@ import type { Accessor } from 'solid-js'
 const IsRestoringContext = createContext<Accessor<boolean>>(() => false)
 
 /**
- * If you are using `PersistQueryClientProvider`, you can also use the `useIsRestoring` hook alongside it to
+ * If you are using `PersistQueryClientProvider`, you can also use the `useIsRestoring` primitive alongside it to
  * check if a restore is currently in progress. `useQuery` and friends also check this internally to avoid
  * race conditions between the restore and mounting queries.
  *

package/src/queryOptions.ts

@@ -30,7 +30,7 @@ export type UndefinedInitialDataOptions<
 
 /**
  * The options accepted by the `queryOptions` overload selected when `initialData` is set — `data` is never
- * `undefined`.
+ * `undefined` (unless a `select` changes `TData` to include `undefined`).
  *
  * @template TQueryFnData - The type your `queryFn` resolves to.
  * @template TError - The type of errors your `queryFn` may throw.
@@ -53,7 +53,8 @@ export type DefinedInitialDataOptions<
  * be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and
  * is the query key to generate options for.
  *
- * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined`.
+ * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless
+ * a `select` changes `TData` to include `undefined`).
  *
  * @see {@link useQuery} to run a query with these options.
  * @param options - The {@link DefinedInitialDataOptions} to use — everything you can pass to `useQuery`, with `initialData` set.

package/src/types.ts

@@ -45,7 +45,8 @@ export interface UseBaseQueryOptions<
    * Only applicable while rendering queries on the server with streaming.
    * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
    * This can be useful to avoid sending a loading state to the client before the query has resolved.
-   * Defaults to `false`.
+   *
+   * @defaultValue false
    */
   deferStream?: boolean
   /**
@@ -123,7 +124,8 @@ export type UseQueryResult<
 > = UseBaseQueryResult<TData, TError>
 
 /**
- * The object `useQuery` returns when `initialData` guarantees `data` is never `undefined`.
+ * The object `useQuery` returns when `initialData` guarantees `data` is never `undefined` (unless a
+ * `select` changes `TData` to include `undefined`).
  *
  * @template TData - The type `data` ends up as, after `select` runs (if set).
  * @template TError - The type of errors this query may hold.
@@ -134,7 +136,8 @@ export type DefinedUseBaseQueryResult<
 > = DefinedQueryObserverResult<TData, TError>
 
 /**
- * The object `useQuery` returns when `initialData` guarantees `data` is never `undefined`.
+ * The object `useQuery` returns when `initialData` guarantees `data` is never `undefined` (unless a
+ * `select` changes `TData` to include `undefined`).
  *
  * @template TData - The type `data` ends up as, after `select` runs (if set).
  * @template TError - The type of errors this query may hold.
@@ -170,12 +173,21 @@ export interface InfiniteQueryOptions<
   >,
   'queryKey' | 'suspense'
 > {
+  /**
+   * The query key to use for this query. Required here, unlike on the options this type extends.
+   *
+   * The query key will be hashed into a stable hash. See [Query Keys](https://tanstack.com/query/latest/docs/framework/solid/guides/query-keys)
+   * for more information.
+   *
+   * The query will automatically update when this key changes (as long as `enabled` is not set to `false`).
+   */
   queryKey: TQueryKey
   /**
    * Only applicable while rendering queries on the server with streaming.
    * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
    * This can be useful to avoid sending a loading state to the client before the query has resolved.
-   * Defaults to `false`.
+   *
+   * @defaultValue false
    */
   deferStream?: boolean
   /**
@@ -219,7 +231,8 @@ export type UseInfiniteQueryResult<
 > = InfiniteQueryObserverResult<TData, TError>
 
 /**
- * The object `useInfiniteQuery` returns when `initialData` guarantees `data` is never `undefined`.
+ * The object `useInfiniteQuery` returns when `initialData` guarantees `data` is never `undefined` (unless a
+ * `select` changes `TData` to include `undefined`).
  *
  * @template TData - The type `data` ends up as, after `select` runs (if set).
  * @template TError - The type of errors this query may hold.

package/src/useBaseQuery.ts

@@ -28,9 +28,7 @@ function reconcileFn<TData, TError>(
   store: QueryObserverResult<TData, TError>,
   result: QueryObserverResult<TData, TError>,
   reconcileOption:
-    | string
-    | false
-    | ((oldData: TData | undefined, newData: TData) => TData),
+    string | false | ((oldData: TData | undefined, newData: TData) => TData),
   queryHash?: string,
 ): QueryObserverResult<TData, TError> {
   if (reconcileOption === false) return result
@@ -342,7 +340,7 @@ export function useBaseQuery<
   )
 
   onCleanup(() => {
-    if (isServer && queryResource.loading) {
+    if (isServer && queryResource.state === 'pending') {
       unsubscribeQueued = true
       return
     }

package/src/useIsFetching.ts

@@ -5,7 +5,7 @@ import type { QueryClient } from './QueryClient'
 import type { Accessor } from 'solid-js'
 
 /**
- * The `useIsFetching` hook returns the `number` of the queries that your application is loading or fetching
+ * The `useIsFetching` primitive returns the `number` of the queries that your application is loading or fetching
  * in the background (useful for app-wide loading indicators).
  *
  * @param filters - An accessor returning the {@link QueryFilters} to narrow down the matched queries.

package/src/useIsMutating.ts

@@ -5,7 +5,7 @@ import type { QueryClient } from './QueryClient'
 import type { Accessor } from 'solid-js'
 
 /**
- * The `useIsMutating` hook returns the `number` of mutations that your application currently has `pending`
+ * The `useIsMutating` primitive returns the `number` of mutations that your application currently has `pending`
  * (useful for app-wide loading indicators).
  *
  * @param filters - An accessor returning the {@link MutationFilters} to narrow down the matched mutations.

package/src/useMutation.ts

@@ -12,6 +12,9 @@ import type {
 import type { Accessor } from 'solid-js'
 
 /**
+ * Unlike queries, mutations are typically used to create/update/delete data or perform server side-effects.
+ * `useMutation` is the primitive for that.
+ *
  * @param options - An accessor returning the {@link UseMutationOptions} to use.
  * @param queryClient - An accessor for a custom `QueryClient`. Otherwise, the one from the nearest context
  * will be used.

package/src/useMutationState.ts

@@ -49,7 +49,7 @@ function getResult<
 }
 
 /**
- * `useMutationState` is a hook that gives you access to all mutations in the `MutationCache`. You can pass
+ * `useMutationState` is a primitive that gives you access to all mutations in the `MutationCache`. You can pass
  * `filters` ({@link MutationFilters}) to narrow down your mutations, and `select` to transform the mutation
  * state.
  *

package/src/useQueries.ts

@@ -185,7 +185,7 @@ type QueriesResults<
         : { [K in keyof T]: GetResults<T[K]> }
 
 /**
- * The `useQueries` hook can be used to fetch a variable number of queries.
+ * The `useQueries` primitive can be used to fetch a variable number of queries.
  *
  * The `queries` key accepts an array with query option objects mostly identical to `useQuery` — see
  * `placeholderData` below for the one difference. A custom `QueryClient` is supplied once, as `useQueries`'

package/src/useQuery.ts

@@ -15,6 +15,9 @@ import type {
 } from './queryOptions'
 
 /**
+ * Subscribes to a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
+ * The query runs when the options call for it — `enabled: false` skips the initial fetch.
+ *
  * @see {@link queryOptions} to share these options between `useQuery` and imperative APIs like `queryClient.query`.
  * @param options - An accessor returning the {@link UndefinedInitialDataOptions} to use — everything you can
  * pass to `useQuery`.
@@ -124,7 +127,9 @@ import type {
  * ```
  *
  * @example
- * Seeding a detail query from an already-cached list, to skip the loading state:
+ * Seeding a detail query from an already-cached list, to skip the loading state. `initialDataUpdatedAt` carries
+ * over the list's own fetch time, so that if you set a `staleTime`, it's measured from when the list was
+ * fetched rather than from now:
  * ```tsx
  * import { useQuery, useQueryClient } from '@tanstack/solid-query'
  *
@@ -138,6 +143,8 @@ import type {
  *       queryClient
  *         .getQueryData<Array<Post>>(['posts'])
  *         ?.find((post) => post.id === props.postId),
+ *     initialDataUpdatedAt: () =>
+ *       queryClient.getQueryState(['posts'])?.dataUpdatedAt,
  *   }))
  *
  *   return postQuery.isError ? <span>Error: {postQuery.error.message}</span> : <h1>{postQuery.data?.title}</h1>
@@ -186,7 +193,11 @@ export function useQuery<
 ): UseQueryResult<TData, TError>
 
 /**
- * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined`.
+ * Subscribes to a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
+ * The query runs when the options call for it — `enabled: false` skips the initial fetch.
+ *
+ * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless
+ * a `select` changes `TData` to include `undefined`).
  *
  * @see {@link queryOptions} to share these options between `useQuery` and imperative APIs like `queryClient.query`.
  * @param options - An accessor returning the {@link DefinedInitialDataOptions} to use — everything you can