@tanstack/preact-query 5.103.2 → 5.104.0

package/src/infiniteQueryOptions.ts

@@ -92,7 +92,7 @@ export type UnusedSkipTokenInfiniteOptions<
 
 /**
  * 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/queryOptions.ts

@@ -71,7 +71,7 @@ export type UnusedSkipTokenOptions<
 
 /**
  * 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.
@@ -92,8 +92,7 @@ export type DefinedInitialDataOptions<
    * cache.
    */
   initialData:
-    | NonUndefinedGuard<TQueryFnData>
-    | (() => NonUndefinedGuard<TQueryFnData>)
+    NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>)
   /**
    * Optional here, but omitting it is only safe when no fetch will be attempted — for example with
    * `enabled: false`, or when a default query function has been defined. Otherwise, an enabled query with no
@@ -107,7 +106,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.
  * @see [The Query Options API](https://tkdodo.eu/blog/the-query-options-api) for more on this pattern.

package/src/suspense.ts

@@ -49,8 +49,7 @@ export const ensureSuspenseTimers = (
 
 export const shouldSuspend = (
   defaultedOptions:
-    | DefaultedQueryObserverOptions<any, any, any, any, any>
-    | undefined,
+    DefaultedQueryObserverOptions<any, any, any, any, any> | undefined,
   result: QueryObserverResult<any, any>,
 ) => defaultedOptions?.suspense && result.isPending
 

package/src/types.ts

@@ -343,8 +343,8 @@ export type UseSuspenseQueryResult<
 
 /**
  * The result of `useQuery` when `initialData` is set, or of `useSuspenseQuery` before the `isPlaceholderData`
- * omission — `data` is never `undefined`. Re-exports {@link DefinedQueryObserverResult} from
- * `@tanstack/query-core`.
+ * omission — `data` is never `undefined` (unless a `select` changes `TData` to include `undefined`).
+ * Re-exports {@link DefinedQueryObserverResult} from `@tanstack/query-core`.
  *
  * @template TData - The type `data` ends up as after `select` runs.
  * @template TError - The type of errors your `queryFn` may throw.
@@ -367,8 +367,9 @@ export type UseInfiniteQueryResult<
 > = InfiniteQueryObserverResult<TData, TError>
 
 /**
- * The result of `useInfiniteQuery` when `initialData` is set — `data` is never `undefined`. Re-exports
- * {@link DefinedInfiniteQueryObserverResult} from `@tanstack/query-core`.
+ * The result of `useInfiniteQuery` when `initialData` is set — `data` is never `undefined` (unless a
+ * `select` changes `TData` to include `undefined`). Re-exports {@link DefinedInfiniteQueryObserverResult}
+ * from `@tanstack/query-core`.
  *
  * @template TData - The type `data` ends up as after `select` runs.
  * @template TError - The type of errors your `queryFn` may throw.

package/src/useBaseQuery.ts

@@ -55,12 +55,9 @@ export function useBaseQuery<
 
   const query = client
     .getQueryCache()
-    .get<
-      TQueryFnData,
-      TError,
-      TQueryData,
-      TQueryKey
-    >(defaultedOptions.queryHash)
+    .get<TQueryFnData, TError, TQueryData, TQueryKey>(
+      defaultedOptions.queryHash,
+    )
 
   if (process.env.NODE_ENV !== 'production') {
     if (!defaultedOptions.queryFn) {

package/src/useQueries.ts

@@ -143,10 +143,14 @@ type GetUseQueryResult<T> =
 
 /**
  * The `queries` array accepted by `useQueries`. Recursively unwraps each tuple element so every entry's
- * `queryFn`/`select`/`throwOnError` are inferred individually, up to 20 elements. An opaque array (e.g.
- * `unknown[]`) is returned as-is; a non-tuple array of a known element type, or a tuple past 20 elements, falls
+ * `queryFn`/`select`/`throwOnError` are inferred individually, up to 20 elements — past that, a tuple falls
  * back to a single homogeneous options type.
  *
+ * An opaque array (e.g. `unknown[]`) is returned as-is; a non-tuple array whose element type structurally
+ * matches a query options object is mapped per-element instead, still inferring each entry individually; any
+ * other non-tuple array — one whose element type doesn't match the expected options shape — falls back to
+ * that same homogeneous options type too.
+ *
  * @template T - The type of the `queries` array as written at the call site.
  * @template TResults - The internal accumulator that this type builds during recursion. It is not meant
  * to be set explicitly.

package/src/useQuery.ts

@@ -13,7 +13,8 @@ import type {
 import { useBaseQuery } from './useBaseQuery'
 
 /**
- * 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 queryOptions} to share these options between `useQuery` and imperative APIs like `queryClient.query`.
  * @param options - The {@link DefinedInitialDataOptions} to use — everything you can pass to `useQuery`, with `initialData` set.
@@ -223,7 +224,9 @@ export function useQuery<
  * ```
  *
  * @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/preact-query'
  *
@@ -237,6 +240,8 @@ export function useQuery<
  *       queryClient
  *         .getQueryData<Array<Post>>(['posts'])
  *         ?.find((post) => post.id === postId),
+ *     initialDataUpdatedAt: () =>
+ *       queryClient.getQueryState(['posts'])?.dataUpdatedAt,
  *   })
  *
  *   if (isError) return <span>Error: {error.message}</span>

package/src/useSuspenseQueries.ts

@@ -106,9 +106,13 @@ type GetUseSuspenseQueryResult<T> =
 
 /**
  * The `queries` array accepted by `useSuspenseQueries`. Recursively unwraps each tuple element so every
- * entry's `queryFn`/`select` are inferred individually, up to 20 elements. An opaque array (e.g. `unknown[]`)
- * is returned as-is; a non-tuple array of a known element type, or a tuple past 20 elements, falls back to a
- * single homogeneous {@link UseSuspenseQueryOptions} type.
+ * entry's `queryFn`/`select` are inferred individually, up to 20 elements — past that, a tuple falls back to
+ * a single homogeneous {@link UseSuspenseQueryOptions} type.
+ *
+ * An opaque array (e.g. `unknown[]`) is returned as-is; a non-tuple array whose element type structurally
+ * matches a query options object is mapped per-element instead, still inferring each entry individually; any
+ * other non-tuple array — one whose element type doesn't match the expected options shape — falls back to
+ * that same homogeneous options type too.
  *
  * @template T - The type of the `queries` array as written at the call site.
  * @template TResults - The internal accumulator that this type builds during recursion. It is not meant

package/build/query-codemods/eslint.config.js

@@ -1,25 +0,0 @@
-// @ts-check
-
-import rootConfig from './root.eslint.config.js'
-
-export default [
-  ...rootConfig,
-  {
-    rules: {
-      'cspell/spellchecker': 'off',
-      '@typescript-eslint/no-unnecessary-condition': 'off',
-      'import/no-duplicates': 'off',
-      'import/no-unresolved': 'off',
-      'import/order': 'off',
-      'no-shadow': 'off',
-      'sort-imports': 'off',
-    },
-  },
-  {
-    files: ['src/**/__testfixtures__/**'],
-    rules: {
-      // Codemod fixtures intentionally preserve historical QueryClient syntax.
-      'no-restricted-syntax': 'off',
-    },
-  },
-]

package/build/query-codemods/package.json

@@ -1,38 +0,0 @@
-{
-  "name": "@tanstack/query-codemods",
-  "private": true,
-  "description": "Collection of codemods to make the migration easier.",
-  "author": "Balázs Máté Petró",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/TanStack/query.git",
-    "directory": "packages/query-codemods"
-  },
-  "homepage": "https://tanstack.com/query",
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/tannerlinsley"
-  },
-  "scripts": {
-    "clean": "premove ./coverage ./dist-ts",
-    "test:eslint": "eslint --concurrency=auto ./src",
-    "test:lib": "vitest",
-    "test:lib:dev": "pnpm run test:lib --watch"
-  },
-  "type": "module",
-  "exports": {
-    "./package.json": "./package.json"
-  },
-  "sideEffects": false,
-  "files": [
-    "src",
-    "!src/jest.config.js",
-    "!src/**/__testfixtures__",
-    "!src/**/__tests__"
-  ],
-  "devDependencies": {
-    "@types/jscodeshift": "17.3.0",
-    "jscodeshift": "17.3.0"
-  }
-}

package/build/query-codemods/root.eslint.config.js

@@ -1,113 +0,0 @@
-// @ts-check
-
-// @ts-ignore Needed due to moduleResolution Node vs Bundler
-import { tanstackConfig } from '@tanstack/eslint-config'
-import pluginCspell from '@cspell/eslint-plugin'
-import vitest from '@vitest/eslint-plugin'
-
-export default [
-  ...tanstackConfig,
-  {
-    name: 'tanstack/temp',
-    plugins: {
-      cspell: pluginCspell,
-    },
-    rules: {
-      'cspell/spellchecker': [
-        'warn',
-        {
-          cspell: {
-            words: [
-              'Promisable', // Our public interface
-              'TSES', // @typescript-eslint package's interface
-              'codemod', // We support our codemod
-              'combinate', // Library name
-              'datatag', // Query options tagging
-              'extralight', // Our public interface
-              'jscodeshift',
-              'refetches', // Query refetch operations
-              'retryer', // Our public interface
-              'solidjs', // Our target framework
-              'tabular-nums', // https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric
-              'tanstack', // Our package scope
-              'todos', // Too general word to be caught as error
-              'tsqd', // Our public interface (TanStack Query Devtools shorthand)
-              'tsdown', // We use tsdown as builder
-              'typecheck', // Field of vite.config.ts
-              'vue-demi', // dependency of @tanstack/vue-query
-              'ɵkind', // Angular specific
-              'ɵproviders', // Angular specific
-            ],
-          },
-        },
-      ],
-      '@typescript-eslint/no-empty-function': 'off',
-      '@typescript-eslint/no-unsafe-function-type': 'off',
-      'no-case-declarations': 'off',
-      /**
-       * Disallows direct calls to deprecated imperative query methods of `QueryClient`
-       * for new tests and code
-       *
-       * Existing tests that directly test the methods from before the refactoring
-       * will be grandfathered in and allowed to continue using the deprecated methods.
-       * They should not be removed, but new tests should use the new methods instead.
-       */
-      'no-restricted-syntax': [
-        'error',
-        {
-          selector:
-            'CallExpression[callee.type="MemberExpression"]:matches([callee.property.name="fetchQuery"], [callee.computed=true][callee.property.value="fetchQuery"])',
-          message: 'Use queryClient.query(options) instead.',
-        },
-        {
-          selector:
-            'CallExpression[callee.type="MemberExpression"]:matches([callee.property.name="prefetchQuery"], [callee.computed=true][callee.property.value="prefetchQuery"])',
-          message:
-            'Use queryClient.query(options).catch(noop) instead if errors should be swallowed.',
-        },
-        {
-          selector:
-            'CallExpression[callee.type="MemberExpression"]:matches([callee.property.name="ensureQueryData"], [callee.computed=true][callee.property.value="ensureQueryData"])',
-          message:
-            "Use queryClient.query({ ...options, staleTime: 'static' }) instead.",
-        },
-        {
-          selector:
-            'CallExpression[callee.type="MemberExpression"]:matches([callee.property.name="fetchInfiniteQuery"], [callee.computed=true][callee.property.value="fetchInfiniteQuery"])',
-          message: 'Use queryClient.infiniteQuery(options) instead.',
-        },
-        {
-          selector:
-            'CallExpression[callee.type="MemberExpression"]:matches([callee.property.name="prefetchInfiniteQuery"], [callee.computed=true][callee.property.value="prefetchInfiniteQuery"])',
-          message:
-            'Use queryClient.infiniteQuery(options).catch(noop) instead if errors should be swallowed.',
-        },
-        {
-          selector:
-            'CallExpression[callee.type="MemberExpression"]:matches([callee.property.name="ensureInfiniteQueryData"], [callee.computed=true][callee.property.value="ensureInfiniteQueryData"])',
-          message:
-            "Use queryClient.infiniteQuery({ ...options, staleTime: 'static' }) instead.",
-        },
-      ],
-      'prefer-const': 'off',
-    },
-  },
-  {
-    files: ['**/*.spec.ts*', '**/*.test.ts*', '**/*.test-d.ts*'],
-    plugins: { vitest },
-    rules: {
-      ...vitest.configs.recommended.rules,
-      'vitest/consistent-test-it': [
-        'error',
-        { fn: 'it', withinDescribe: 'it' },
-      ],
-      'vitest/no-standalone-expect': [
-        'error',
-        {
-          additionalTestBlockFunctions: ['itIf'],
-        },
-      ],
-    },
-    settings: { vitest: { typecheck: true } },
-  },
-]

package/build/query-codemods/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist-ts",
-    "rootDir": "."
-  },
-  "include": ["src", "*.config.ts", "*.config.js", "package.json"]
-}

package/build/query-codemods/vite.config.ts

@@ -1,30 +0,0 @@
-import { defineConfig } from 'vitest/config'
-
-import packageJson from './package.json'
-
-export default defineConfig({
-  // fix from https://github.com/vitest-dev/vitest/issues/6992#issuecomment-2509408660
-  resolve: {
-    conditions: ['@tanstack/custom-condition'],
-  },
-  environments: {
-    ssr: {
-      resolve: {
-        conditions: ['@tanstack/custom-condition'],
-      },
-    },
-  },
-  test: {
-    name: packageJson.name,
-    dir: './src',
-    watch: false,
-    globals: true,
-    coverage: {
-      enabled: !!process.env.CI,
-      provider: 'istanbul',
-      include: ['src/**/*.{js,ts,cjs,mjs,jsx,tsx}'],
-    },
-    typecheck: { enabled: true },
-    restoreMocks: true,
-  },
-})