feat(types): type narrowing for isPlaceholderData (#8586)

* feat(types): type narrowing for isPlaceholderData * fix: infiniteQueryObserver types * fix: typing issues 🤷‍♂️ * chore: add missing tsconfig.legacy.json files * fix: run type-tests in serial
TanStack · Jan 27, 2025 · 2399bb0 · 2399bb0
1 parent 97f5544
commit 2399bb0
Show file tree

Hide file tree

Showing 24 changed files with 319 additions and 50 deletions.
diff --git a/packages/angular-query-devtools-experimental/package.json b/packages/angular-query-devtools-experimental/package.json
@@ -18,7 +18,7 @@
     "clean": "premove ./build ./coverage ./dist-ts",
     "compile": "tsc --build",
     "test:eslint": "eslint ./src",
-    "test:types": "pnpm run \"/^test:types:ts[0-9]{2}$/\"",
+    "test:types": "npm-run-all --serial test:types:*",
     "test:types:ts51": "node ../../node_modules/typescript51/lib/tsc.js --build",
     "test:types:ts52": "node ../../node_modules/typescript52/lib/tsc.js --build",
     "test:types:ts53": "node ../../node_modules/typescript53/lib/tsc.js --build",
@@ -57,6 +57,7 @@
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
     "@tanstack/angular-query-experimental": "workspace:*",
     "eslint-plugin-jsdoc": "^50.5.0",
+    "npm-run-all": "^4.1.5",
     "tsup": "8.0.2",
     "typescript": "5.7.2"
   },

diff --git a/packages/angular-query-experimental/package.json b/packages/angular-query-experimental/package.json
@@ -30,7 +30,7 @@
     "clean": "premove ./build ./coverage ./dist-ts",
     "compile": "tsc --build",
     "test:eslint": "eslint ./src",
-    "test:types": "pnpm run \"/^test:types:ts[0-9]{2}$/\"",
+    "test:types": "npm-run-all --serial test:types:*",
     "test:types:ts50": "node ../../node_modules/typescript50/lib/tsc.js --build",
     "test:types:ts51": "node ../../node_modules/typescript51/lib/tsc.js --build",
     "test:types:ts52": "node ../../node_modules/typescript52/lib/tsc.js --build",
@@ -75,6 +75,7 @@
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
     "@microsoft/api-extractor": "^7.48.1",
     "eslint-plugin-jsdoc": "^50.5.0",
+    "npm-run-all": "^4.1.5",
     "tsup": "8.0.2",
     "typescript": "5.7.2"
   },

diff --git a/packages/eslint-plugin-query/package.json b/packages/eslint-plugin-query/package.json
@@ -18,7 +18,7 @@
     "clean": "premove ./dist ./coverage ./dist-ts",
     "compile": "tsc --build",
     "test:eslint": "eslint ./src",
-    "test:types": "pnpm run \"/^test:types:ts[0-9]{2}$/\"",
+    "test:types": "npm-run-all --serial test:types:*",
     "test:types:ts50": "node ../../node_modules/typescript50/lib/tsc.js --build",
     "test:types:ts51": "node ../../node_modules/typescript51/lib/tsc.js --build",
     "test:types:ts52": "node ../../node_modules/typescript52/lib/tsc.js --build",
@@ -61,7 +61,8 @@
   "devDependencies": {
     "@typescript-eslint/rule-tester": "^8.18.1",
     "combinate": "^1.1.11",
-    "eslint": "^9.15.0"
+    "eslint": "^9.15.0",
+    "npm-run-all": "^4.1.5"
   },
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0"

diff --git a/packages/query-async-storage-persister/package.json b/packages/query-async-storage-persister/package.json
@@ -18,7 +18,7 @@
     "clean": "premove ./build ./coverage ./dist-ts",
     "compile": "tsc --build",
     "test:eslint": "eslint ./src",
-    "test:types": "pnpm run \"/^test:types:ts[0-9]{2}$/\"",
+    "test:types": "npm-run-all --serial test:types:*",
     "test:types:ts50": "node ../../node_modules/typescript50/lib/tsc.js --build",
     "test:types:ts51": "node ../../node_modules/typescript51/lib/tsc.js --build",
     "test:types:ts52": "node ../../node_modules/typescript52/lib/tsc.js --build",
@@ -57,5 +57,8 @@
   ],
   "dependencies": {
     "@tanstack/query-persist-client-core": "workspace:*"
+  },
+  "devDependencies": {
+    "npm-run-all": "^4.1.5"
   }
 }
diff --git a/packages/query-broadcast-client-experimental/package.json b/packages/query-broadcast-client-experimental/package.json
@@ -18,7 +18,7 @@
     "clean": "premove ./build ./coverage ./dist-ts",
     "compile": "tsc --build",
     "test:eslint": "eslint ./src",
-    "test:types": "pnpm run \"/^test:types:ts[0-9]{2}$/\"",
+    "test:types": "npm-run-all --serial test:types:*",
     "test:types:ts50": "node ../../node_modules/typescript50/lib/tsc.js --build",
     "test:types:ts51": "node ../../node_modules/typescript51/lib/tsc.js --build",
     "test:types:ts52": "node ../../node_modules/typescript52/lib/tsc.js --build",
@@ -56,5 +56,8 @@
   "dependencies": {
     "@tanstack/query-core": "workspace:*",
     "broadcast-channel": "^7.0.0"
+  },
+  "devDependencies": {
+    "npm-run-all": "^4.1.5"
   }
 }
diff --git a/packages/query-core/package.json b/packages/query-core/package.json
@@ -18,7 +18,7 @@
     "clean": "premove ./build ./coverage ./dist-ts",
     "compile": "tsc --build",
     "test:eslint": "eslint ./src",
-    "test:types": "pnpm run \"/^test:types:ts[0-9]{2}$/\"",
+    "test:types": "npm-run-all --serial test:types:*",
     "test:types:ts50": "node ../../node_modules/typescript50/lib/tsc.js --build tsconfig.legacy.json",
     "test:types:ts51": "node ../../node_modules/typescript51/lib/tsc.js --build tsconfig.legacy.json",
     "test:types:ts52": "node ../../node_modules/typescript52/lib/tsc.js --build tsconfig.legacy.json",
@@ -56,6 +56,7 @@
     "!src/__tests__"
   ],
   "devDependencies": {
-    "@testing-library/dom": "^10.4.0"
+    "@testing-library/dom": "^10.4.0",
+    "npm-run-all": "^4.1.5"
   }
 }
diff --git a/packages/query-core/src/__tests__/infiniteQueryObserver.test-d.tsx b/packages/query-core/src/__tests__/infiniteQueryObserver.test-d.tsx
@@ -32,19 +32,22 @@ describe('InfiniteQueryObserver', () => {
       expectTypeOf(result.error).toEqualTypeOf<null>()
       expectTypeOf(result.isLoading).toEqualTypeOf<boolean>()
       expectTypeOf(result.status).toEqualTypeOf<'pending'>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<false>()
     }
 
     if (result.isLoading) {
       expectTypeOf(result.data).toEqualTypeOf<undefined>()
       expectTypeOf(result.error).toEqualTypeOf<null>()
       expectTypeOf(result.isPending).toEqualTypeOf<true>()
       expectTypeOf(result.status).toEqualTypeOf<'pending'>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<false>()
     }
 
     if (result.isLoadingError) {
       expectTypeOf(result.data).toEqualTypeOf<undefined>()
       expectTypeOf(result.error).toEqualTypeOf<Error>()
       expectTypeOf(result.status).toEqualTypeOf<'error'>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<false>()
     }
 
     if (result.isRefetchError) {
@@ -53,12 +56,20 @@ describe('InfiniteQueryObserver', () => {
       expectTypeOf(result.status).toEqualTypeOf<'error'>()
       expectTypeOf(result.isFetchNextPageError).toEqualTypeOf<boolean>()
       expectTypeOf(result.isFetchPreviousPageError).toEqualTypeOf<boolean>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<false>()
     }
 
     if (result.isSuccess) {
       expectTypeOf(result.data).toEqualTypeOf<InfiniteData<string, unknown>>()
       expectTypeOf(result.error).toEqualTypeOf<null>()
       expectTypeOf(result.status).toEqualTypeOf<'success'>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<boolean>()
+    }
+
+    if (result.isPlaceholderData) {
+      expectTypeOf(result.data).toEqualTypeOf<InfiniteData<string, unknown>>()
+      expectTypeOf(result.error).toEqualTypeOf<null>()
+      expectTypeOf(result.status).toEqualTypeOf<'success'>()
     }
   })
 })
diff --git a/packages/query-core/src/__tests__/queryObserver.test-d.tsx b/packages/query-core/src/__tests__/queryObserver.test-d.tsx
@@ -32,6 +32,7 @@ describe('queryObserver', () => {
       expectTypeOf(result.isLoadingError).toEqualTypeOf<false>()
       expectTypeOf(result.isRefetchError).toEqualTypeOf<false>()
       expectTypeOf(result.status).toEqualTypeOf<'pending'>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<false>()
     }
     if (result.isLoading) {
       expectTypeOf(result.data).toEqualTypeOf<undefined>()
@@ -43,6 +44,7 @@ describe('queryObserver', () => {
       expectTypeOf(result.isRefetchError).toEqualTypeOf<false>()
       expectTypeOf(result.isSuccess).toEqualTypeOf<false>()
       expectTypeOf(result.status).toEqualTypeOf<'pending'>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<false>()
     }
 
     if (result.isLoadingError) {
@@ -55,6 +57,7 @@ describe('queryObserver', () => {
       expectTypeOf(result.isRefetchError).toEqualTypeOf<false>()
       expectTypeOf(result.isSuccess).toEqualTypeOf<false>()
       expectTypeOf(result.status).toEqualTypeOf<'error'>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<false>()
     }
 
     if (result.isRefetchError) {
@@ -67,6 +70,7 @@ describe('queryObserver', () => {
       expectTypeOf(result.isRefetchError).toEqualTypeOf<true>()
       expectTypeOf(result.isSuccess).toEqualTypeOf<false>()
       expectTypeOf(result.status).toEqualTypeOf<'error'>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<false>()
     }
 
     if (result.isSuccess) {
@@ -79,6 +83,20 @@ describe('queryObserver', () => {
       expectTypeOf(result.isRefetchError).toEqualTypeOf<false>()
       expectTypeOf(result.isSuccess).toEqualTypeOf<true>()
       expectTypeOf(result.status).toEqualTypeOf<'success'>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<boolean>()
+    }
+
+    if (result.isPlaceholderData) {
+      expectTypeOf(result.data).toEqualTypeOf<{ value: string }>()
+      expectTypeOf(result.error).toEqualTypeOf<null>()
+      expectTypeOf(result.isError).toEqualTypeOf<false>()
+      expectTypeOf(result.isPending).toEqualTypeOf<false>()
+      expectTypeOf(result.isLoading).toEqualTypeOf<false>()
+      expectTypeOf(result.isLoadingError).toEqualTypeOf<false>()
+      expectTypeOf(result.isRefetchError).toEqualTypeOf<false>()
+      expectTypeOf(result.isSuccess).toEqualTypeOf<true>()
+      expectTypeOf(result.status).toEqualTypeOf<'success'>()
+      expectTypeOf(result.isPlaceholderData).toEqualTypeOf<true>()
     }
   })
 

diff --git a/packages/query-core/src/types.ts b/packages/query-core/src/types.ts
@@ -791,6 +791,7 @@ export interface QueryObserverPendingResult<
   isLoadingError: false
   isRefetchError: false
   isSuccess: false
+  isPlaceholderData: false
   status: 'pending'
 }
 
@@ -806,6 +807,7 @@ export interface QueryObserverLoadingResult<
   isLoadingError: false
   isRefetchError: false
   isSuccess: false
+  isPlaceholderData: false
   status: 'pending'
 }
 
@@ -821,6 +823,7 @@ export interface QueryObserverLoadingErrorResult<
   isLoadingError: true
   isRefetchError: false
   isSuccess: false
+  isPlaceholderData: false
   status: 'error'
 }
 
@@ -836,6 +839,7 @@ export interface QueryObserverRefetchErrorResult<
   isLoadingError: false
   isRefetchError: true
   isSuccess: false
+  isPlaceholderData: false
   status: 'error'
 }
 
@@ -851,6 +855,23 @@ export interface QueryObserverSuccessResult<
   isLoadingError: false
   isRefetchError: false
   isSuccess: true
+  isPlaceholderData: false
+  status: 'success'
+}
+
+export interface QueryObserverPlaceholderResult<
+  TData = unknown,
+  TError = DefaultError,
+> extends QueryObserverBaseResult<TData, TError> {
+  data: TData
+  isError: false
+  error: null
+  isPending: false
+  isLoading: false
+  isLoadingError: false
+  isRefetchError: false
+  isSuccess: true
+  isPlaceholderData: true
   status: 'success'
 }
 
@@ -866,6 +887,7 @@ export type QueryObserverResult<TData = unknown, TError = DefaultError> =
   | QueryObserverLoadingErrorResult<TData, TError>
   | QueryObserverLoadingResult<TData, TError>
   | QueryObserverPendingResult<TData, TError>
+  | QueryObserverPlaceholderResult<TData, TError>
 
 export interface InfiniteQueryObserverBaseResult<
   TData = unknown,
@@ -922,6 +944,7 @@ export interface InfiniteQueryObserverPendingResult<
   isFetchNextPageError: false
   isFetchPreviousPageError: false
   isSuccess: false
+  isPlaceholderData: false
   status: 'pending'
 }
 
@@ -939,6 +962,7 @@ export interface InfiniteQueryObserverLoadingResult<
   isFetchNextPageError: false
   isFetchPreviousPageError: false
   isSuccess: false
+  isPlaceholderData: false
   status: 'pending'
 }
 
@@ -956,6 +980,7 @@ export interface InfiniteQueryObserverLoadingErrorResult<
   isFetchNextPageError: false
   isFetchPreviousPageError: false
   isSuccess: false
+  isPlaceholderData: false
   status: 'error'
 }
 
@@ -971,6 +996,7 @@ export interface InfiniteQueryObserverRefetchErrorResult<
   isLoadingError: false
   isRefetchError: true
   isSuccess: false
+  isPlaceholderData: false
   status: 'error'
 }
 
@@ -988,6 +1014,25 @@ export interface InfiniteQueryObserverSuccessResult<
   isFetchNextPageError: false
   isFetchPreviousPageError: false
   isSuccess: true
+  isPlaceholderData: false
+  status: 'success'
+}
+
+export interface InfiniteQueryObserverPlaceholderResult<
+  TData = unknown,
+  TError = DefaultError,
+> extends InfiniteQueryObserverBaseResult<TData, TError> {
+  data: TData
+  isError: false
+  error: null
+  isPending: false
+  isLoading: false
+  isLoadingError: false
+  isRefetchError: false
+  isSuccess: true
+  isPlaceholderData: true
+  isFetchNextPageError: false
+  isFetchPreviousPageError: false
   status: 'success'
 }
 
@@ -1006,6 +1051,7 @@ export type InfiniteQueryObserverResult<
   | InfiniteQueryObserverLoadingErrorResult<TData, TError>
   | InfiniteQueryObserverLoadingResult<TData, TError>
   | InfiniteQueryObserverPendingResult<TData, TError>
+  | InfiniteQueryObserverPlaceholderResult<TData, TError>
 
 export type MutationKey = Register extends {
   mutationKey: infer TMutationKey

diff --git a/packages/query-devtools/package.json b/packages/query-devtools/package.json
@@ -18,7 +18,7 @@
     "clean": "premove ./build ./coverage ./dist-ts",
     "compile": "tsc --build",
     "test:eslint": "eslint ./src",
-    "test:types": "pnpm run \"/^test:types:ts[0-9]{2}$/\"",
+    "test:types": "npm-run-all --serial test:types:*",
     "test:types:ts50": "node ../../node_modules/typescript50/lib/tsc.js --build",
     "test:types:ts51": "node ../../node_modules/typescript51/lib/tsc.js --build",
     "test:types:ts52": "node ../../node_modules/typescript52/lib/tsc.js --build",
@@ -70,6 +70,7 @@
     "@tanstack/query-core": "workspace:*",
     "clsx": "^2.1.1",
     "goober": "^2.1.16",
+    "npm-run-all": "^4.1.5",
     "solid-js": "^1.9.3",
     "solid-transition-group": "^0.2.3",
     "superjson": "^2.2.1",

diff --git a/packages/query-persist-client-core/package.json b/packages/query-persist-client-core/package.json
@@ -18,7 +18,7 @@
     "clean": "premove ./build ./coverage ./dist-ts",
     "compile": "tsc --build",
     "test:eslint": "eslint ./src",
-    "test:types": "pnpm run \"/^test:types:ts[0-9]{2}$/\"",
+    "test:types": "npm-run-all --serial test:types:*",
     "test:types:ts50": "node ../../node_modules/typescript50/lib/tsc.js --build",
     "test:types:ts51": "node ../../node_modules/typescript51/lib/tsc.js --build",
     "test:types:ts52": "node ../../node_modules/typescript52/lib/tsc.js --build",
@@ -57,5 +57,8 @@
   ],
   "dependencies": {
     "@tanstack/query-core": "workspace:*"
+  },
+  "devDependencies": {
+    "npm-run-all": "^4.1.5"
   }
 }
diff --git a/packages/query-sync-storage-persister/package.json b/packages/query-sync-storage-persister/package.json
@@ -18,7 +18,7 @@
     "clean": "premove ./build ./coverage ./dist-ts",
     "compile": "tsc --build",
     "test:eslint": "eslint ./src",
-    "test:types": "pnpm run \"/^test:types:ts[0-9]{2}$/\"",
+    "test:types": "npm-run-all --serial test:types:*",
     "test:types:ts50": "node ../../node_modules/typescript50/lib/tsc.js --build",
     "test:types:ts51": "node ../../node_modules/typescript51/lib/tsc.js --build",
     "test:types:ts52": "node ../../node_modules/typescript52/lib/tsc.js --build",
@@ -58,5 +58,8 @@
   "dependencies": {
     "@tanstack/query-core": "workspace:*",
     "@tanstack/query-persist-client-core": "workspace:*"
+  },
+  "devDependencies": {
+    "npm-run-all": "^4.1.5"
   }
 }