typings

Author: phryneas

src/query/baseQueryTypes.ts

@@ -59,7 +59,7 @@ export type BaseQueryMeta<BaseQuery extends BaseQueryFn> = UnwrapPromise<
 
 export type BaseQueryError<BaseQuery extends BaseQueryFn> = Exclude<
   UnwrapPromise<ReturnType<BaseQuery>>,
-  { error: undefined }
+  { error?: undefined }
 >['error']
 
 export type BaseQueryArg<

src/query/core/buildMiddleware/cacheLifecycle.ts

@@ -1,7 +1,7 @@
 import { isAsyncThunkAction, isFulfilled } from '@reduxjs/toolkit'
 import type { AnyAction } from 'redux'
 import type { ThunkDispatch } from 'redux-thunk'
-import type { BaseQueryFn } from '../../baseQueryTypes'
+import type { BaseQueryFn, BaseQueryMeta } from '../../baseQueryTypes'
 import { DefinitionType } from '../../endpointDefinitions'
 import type { RootState } from '../apiState'
 import type {
@@ -78,7 +78,10 @@ declare module '../../endpointDefinitions' {
     requestId: string
   }
 
-  export interface CacheLifecyclePromises<ResultType = unknown> {
+  export interface CacheLifecyclePromises<
+    ResultType = unknown,
+    MetaType = unknown
+  > {
     /**
      * Promise that will resolve with the first value for this cache key.
      * This allows you to `await` until an actual value is in cache.
@@ -98,6 +101,10 @@ declare module '../../endpointDefinitions' {
          * The (transformed) query result.
          */
         data: ResultType
+        /**
+         * The `meta` returned by the `baseQuery`
+         */
+        meta: MetaType
       },
       typeof neverResolvedError
     >
@@ -115,7 +122,7 @@ declare module '../../endpointDefinitions' {
     ResultType,
     ReducerPath extends string = string
   > extends QueryBaseLifecycleApi<QueryArg, BaseQuery, ResultType, ReducerPath>,
-      CacheLifecyclePromises<ResultType> {}
+      CacheLifecyclePromises<ResultType, BaseQueryMeta<BaseQuery>> {}
 
   export interface MutationCacheLifecycleApi<
     QueryArg,
@@ -128,7 +135,7 @@ declare module '../../endpointDefinitions' {
         ResultType,
         ReducerPath
       >,
-      CacheLifecyclePromises<ResultType> {}
+      CacheLifecyclePromises<ResultType, BaseQueryMeta<BaseQuery>> {}
 
   interface QueryExtraOptions<
     TagTypes extends string,
@@ -181,7 +188,7 @@ export const build: SubMiddlewareBuilder = ({
 
   return (mwApi) => {
     type CacheLifecycle = {
-      valueResolved?(value: { data: unknown }): unknown
+      valueResolved?(value: { data: unknown; meta: unknown }): unknown
       cacheEntryRemoved(): void
     }
     const lifecycleMap: Record<string, CacheLifecycle> = {}
@@ -219,12 +226,10 @@ export const build: SubMiddlewareBuilder = ({
       } else if (isFullfilledThunk(action)) {
         const lifecycle = lifecycleMap[cacheKey]
         if (lifecycle?.valueResolved) {
-          lifecycle.valueResolved(
-            {
-              data: action.payload,
-              meta: action.meta.baseQueryMeta,
-            } as any /* TODO typings */
-          )
+          lifecycle.valueResolved({
+            data: action.payload,
+            meta: action.meta.baseQueryMeta,
+          })
           delete lifecycle.valueResolved
         }
       } else if (
@@ -273,10 +278,10 @@ export const build: SubMiddlewareBuilder = ({
         lifecycle.cacheEntryRemoved = resolve
       })
       const cacheDataLoaded: PromiseWithKnownReason<
-        { data: unknown },
+        { data: unknown; meta: unknown },
         typeof neverResolvedError
       > = Promise.race([
-        new Promise<{ data: unknown }>((resolve) => {
+        new Promise<{ data: unknown; meta: unknown }>((resolve) => {
           lifecycle.valueResolved = resolve
         }),
         cacheEntryRemoved.then(() => {

src/query/core/buildMiddleware/queryLifecycle.ts

@@ -1,5 +1,9 @@
 import { isPending, isRejected, isFulfilled } from '@reduxjs/toolkit'
-import type { BaseQueryError, BaseQueryFn } from '../../baseQueryTypes'
+import type {
+  BaseQueryError,
+  BaseQueryFn,
+  BaseQueryMeta,
+} from '../../baseQueryTypes'
 import { DefinitionType } from '../../endpointDefinitions'
 import type { QueryFulfilledRejectionReason } from '../../endpointDefinitions'
 import type { Recipe } from '../buildThunks'
@@ -31,6 +35,10 @@ declare module '../../endpointDefinitions' {
          * The (transformed) query result.
          */
         data: ResultType
+        /**
+         * The `meta` returned by the `baseQuery`
+         */
+        meta: BaseQueryMeta<BaseQuery>
       },
       QueryFulfilledRejectionReason<BaseQuery>
     >
@@ -43,9 +51,14 @@ declare module '../../endpointDefinitions' {
          * If this is `false`, that means this error was returned from the `baseQuery` or `queryFn` in a controlled manner.
          */
         isUnhandledError: false
+        /**
+         * The `meta` returned by the `baseQuery`
+         */
+        meta: BaseQueryMeta<BaseQuery>
       }
     | {
         error: unknown
+        meta?: undefined
         /**
          * If this is `true`, that means that this error is the result of `baseQueryFn`, `queryFn` or `transformResponse` throwing an error instead of handling it properly.
          * There can not be made any assumption about the shape of `error`.
@@ -113,8 +126,8 @@ export const build: SubMiddlewareBuilder = ({
 
   return (mwApi) => {
     type CacheLifecycle = {
-      resolve(value: { data: unknown }): unknown
-      reject(value: { error: unknown; isUnhandledError: boolean }): unknown
+      resolve(value: { data: unknown; meta: unknown }): unknown
+      reject(value: QueryFulfilledRejectionReason<any>): unknown
     }
     const lifecycleMap: Record<string, CacheLifecycle> = {}
 
@@ -131,7 +144,7 @@ export const build: SubMiddlewareBuilder = ({
         if (onQueryStarted) {
           const lifecycle = {} as CacheLifecycle
           const queryFulfilled = new (Promise as PromiseConstructorWithKnownReason)<
-            { data: unknown },
+            { data: unknown; meta: unknown },
             QueryFulfilledRejectionReason<any>
           >((resolve, reject) => {
             lifecycle.resolve = resolve
@@ -169,22 +182,18 @@ export const build: SubMiddlewareBuilder = ({
         }
       } else if (isFullfilledThunk(action)) {
         const { requestId, baseQueryMeta } = action.meta
-        lifecycleMap[requestId]?.resolve(
-          {
-            data: action.payload,
-            meta: baseQueryMeta,
-          } as any /* TODO typings for this */
-        )
+        lifecycleMap[requestId]?.resolve({
+          data: action.payload,
+          meta: baseQueryMeta,
+        })
         delete lifecycleMap[requestId]
       } else if (isRejectedThunk(action)) {
         const { requestId, rejectedWithValue, baseQueryMeta } = action.meta
-        lifecycleMap[requestId]?.reject(
-          {
-            error: action.payload ?? action.error,
-            isUnhandledError: !rejectedWithValue,
-            meta: baseQueryMeta,
-          } as any /* TODO typings for this */
-        )
+        lifecycleMap[requestId]?.reject({
+          error: action.payload ?? action.error,
+          isUnhandledError: !rejectedWithValue,
+          meta: baseQueryMeta as any,
+        })
         delete lifecycleMap[requestId]
       }
 

src/query/endpointDefinitions.ts

@@ -33,7 +33,7 @@ interface EndpointDefinitionWithQuery<
    *
    * ```ts
    * // codeblock-meta title="query example"
-   * 
+   *
    * import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react'
    * interface Post {
    *   id: number
@@ -75,7 +75,7 @@ interface EndpointDefinitionWithQueryFn<
    * @example
    * ```ts
    * // codeblock-meta title="Basic queryFn example"
-   * 
+   *
    * import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react'
    * interface Post {
    *   id: number
@@ -203,7 +203,7 @@ export interface QueryExtraOptions<
    *
    * ```ts
    * // codeblock-meta title="providesTags example"
-   * 
+   *
    * import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react'
    * interface Post {
    *   id: number
@@ -362,14 +362,14 @@ export interface MutationExtraOptions<
     arg: QueryArg,
     mutationApi: MutationApi<ReducerPath, any>,
     error: unknown,
-    meta: undefined
+    meta: BaseQueryMeta<BaseQuery>
   ): void
   /** @deprecated please use `onQueryStarted` instead */
   onSuccess?(
     arg: QueryArg,
     mutationApi: MutationApi<ReducerPath, any>,
     result: ResultType,
-    meta: undefined
+    meta: BaseQueryMeta<BaseQuery>
   ): void
 }
 

src/query/index.ts

@@ -1,9 +1,5 @@
 export { QueryStatus } from './core/apiState'
-export type {
-  Api,
-  Module,
-  ApiModules,
-} from './apiTypes'
+export type { Api, Module, ApiModules } from './apiTypes'
 export type { BaseQueryEnhancer, BaseQueryFn } from './baseQueryTypes'
 export type {
   EndpointDefinitions,
@@ -12,7 +8,11 @@ export type {
   MutationDefinition,
 } from './endpointDefinitions'
 export { fetchBaseQuery } from './fetchBaseQuery'
-export type { FetchBaseQueryError, FetchArgs } from './fetchBaseQuery'
+export type {
+  FetchBaseQueryError,
+  FetchBaseQueryMeta,
+  FetchArgs,
+} from './fetchBaseQuery'
 export { retry } from './retry'
 export { setupListeners } from './core/setupListeners'
 export { skipSelector, skipToken, SkipToken } from './core/buildSelectors'

src/query/tests/cacheCollection.test.ts

@@ -1,6 +1,5 @@
-import { createApi } from '@reduxjs/toolkit/query'
+import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query'
 import { configureStore } from '@reduxjs/toolkit'
-import { fetchBaseQuery } from '../fetchBaseQuery'
 import { waitMs } from './helpers'
 import type { Middleware, Reducer } from 'redux'
 

src/query/tests/cacheLifecycle.test.ts

@@ -1,6 +1,7 @@
 import { createApi } from '@reduxjs/toolkit/query'
-import { fetchBaseQuery } from '../fetchBaseQuery'
-import { fakeTimerWaitFor, setupApiStore, waitMs } from './helpers'
+import type { FetchBaseQueryMeta } from '@reduxjs/toolkit/query'
+import { fetchBaseQuery } from '@reduxjs/toolkit/query'
+import { expectType, fakeTimerWaitFor, setupApiStore, waitMs } from './helpers'
 
 beforeAll(() => {
   jest.useFakeTimers()
@@ -81,14 +82,17 @@ describe.each([['query'], ['mutation']] as const)(
       const extended = api.injectEndpoints({
         overrideExisting: true,
         endpoints: (build) => ({
-          injected: build[type as 'mutation']<unknown, string>({
+          injected: build[type as 'mutation']<number, string>({
             query: () => '/success',
             async onCacheEntryAdded(
               arg,
               { dispatch, getState, cacheEntryRemoved, cacheDataLoaded }
             ) {
               onNewCacheEntry(arg)
               const firstValue = await cacheDataLoaded
+              expectType<{ data: number; meta?: FetchBaseQueryMeta }>(
+                firstValue
+              )
               gotFirstValue(firstValue)
               await cacheEntryRemoved
               onCleanup()