allow replacing RTKQ's usage of immer

packages/toolkit/src/query/core/buildMiddleware/batchActions.ts

@@ -5,8 +5,7 @@ import type {
  QuerySubstateIdentifier,
  Subscribers,
 } from '../apiState'
-import { produceWithPatches } from 'immer'
-import type { AnyAction } from '@reduxjs/toolkit';
+import type { AnyAction } from '@reduxjs/toolkit'
 import { createSlice, PayloadAction } from '@reduxjs/toolkit'
 
 // Copied from https://github.com/feross/queue-microtask
@@ -30,7 +29,12 @@ const queueMicrotaskShim =
 
 export const buildBatchedActionsHandler: InternalHandlerBuilder<
  [actionShouldContinue: boolean, subscriptionExists: boolean]
-> = ({ api, queryThunk, internalState }) => {
+> = ({
+ api,
+ queryThunk,
+ internalState,
+ immutableHelpers: { createWithPatches },
+}) => {
  const subscriptionsPrefix = `${api.reducerPath}/subscriptions`
 
  let previousSubscriptions: SubscriptionState =
@@ -125,7 +129,7 @@ export const buildBatchedActionsHandler: InternalHandlerBuilder<
  JSON.stringify(internalState.currentSubscriptions)
  )
  // Figure out a smaller diff between original and current
- const [, patches] = produceWithPatches(
+ const [, patches] = createWithPatches(
  previousSubscriptions,
  () => newSubscriptions
  )

packages/toolkit/src/query/core/buildMiddleware/index.ts

@@ -12,6 +12,7 @@ import { buildInvalidationByTagsHandler } from './invalidationByTags'
 import { buildPollingHandler } from './polling'
 import type {
  BuildMiddlewareInput,
+ BuildSubMiddlewareInput,
  InternalHandlerBuilder,
  InternalMiddlewareState,
 } from './types'
@@ -63,7 +64,7 @@ export function buildMiddleware<
  currentSubscriptions: {},
  }
 
- const builderArgs = {
+ const builderArgs: BuildSubMiddlewareInput = {
  ...(input as any as BuildMiddlewareInput<
  EndpointDefinitions,
  string,

packages/toolkit/src/query/core/buildMiddleware/types.ts

@@ -24,6 +24,7 @@ import type {
  QueryThunkArg,
  ThunkResult,
 } from '../buildThunks'
+import type { ImmutableHelpers } from '../../tsHelpers'
 
 export type QueryStateMeta<T> = Record<string, undefined | T>
 export type TimeoutId = ReturnType<typeof setTimeout>
@@ -43,6 +44,7 @@ export interface BuildMiddlewareInput<
  mutationThunk: MutationThunk
  api: Api<any, Definitions, ReducerPath, TagTypes>
  assertTagType: AssertTagTypes
+ immutableHelpers: Pick<ImmutableHelpers, 'createWithPatches'>
 }
 
 export type SubMiddlewareApi = MiddlewareAPI<

packages/toolkit/src/query/core/buildSlice.ts

@@ -32,7 +32,6 @@ import type {
  QueryDefinition,
 } from '../endpointDefinitions'
 import type { Patch } from 'immer'
-import { applyPatches } from 'immer'
 import { onFocus, onFocusLost, onOffline, onOnline } from './setupListeners'
 import {
  isDocumentVisible,
@@ -41,6 +40,7 @@ import {
 } from '../utils'
 import type { ApiContext } from '../apiTypes'
 import { isUpsertQuery } from './buildInitiate'
+import type { ImmutableHelpers } from '../tsHelpers'
 
 function updateQuerySubstateIfExists(
  state: QueryState<any>,
@@ -99,6 +99,7 @@ export function buildSlice({
  },
  assertTagType,
  config,
+ immutableHelpers: { applyPatches },
 }: {
  reducerPath: string
  queryThunk: QueryThunk
@@ -109,6 +110,7 @@ export function buildSlice({
  ConfigState<string>,
  'online' | 'focused' | 'middlewareRegistered'
  >
+ immutableHelpers: Pick<ImmutableHelpers, 'applyPatches'>
 }) {
  const resetApiState = createAction(`${reducerPath}/resetApiState`)
  const querySlice = createSlice({

packages/toolkit/src/query/core/buildThunks.ts

@@ -32,7 +32,6 @@ import {
  isRejectedWithValue,
 } from '@reduxjs/toolkit'
 import type { Patch } from 'immer'
-import { isDraftable, produceWithPatches } from 'immer'
 import type {
  AnyAction,
  ThunkAction,
@@ -44,7 +43,7 @@ import { createAsyncThunk, SHOULD_AUTOBATCH } from '@reduxjs/toolkit'
 import { HandledError } from '../HandledError'
 
 import type { ApiEndpointQuery, PrefetchOptions } from './module'
-import type { UnwrapPromise } from '../tsHelpers'
+import type { ImmutableHelpers, UnwrapPromise } from '../tsHelpers'
 
 declare module './module' {
  export interface ApiEndpointQuery<
@@ -222,12 +221,14 @@ export function buildThunks<
  context: { endpointDefinitions },
  serializeQueryArgs,
  api,
+ immutableHelpers: { isDraftable, createWithPatches },
 }: {
  baseQuery: BaseQuery
  reducerPath: ReducerPath
  context: ApiContext<Definitions>
  serializeQueryArgs: InternalSerializeQueryArgs
  api: Api<BaseQuery, Definitions, ReducerPath, any>
+ immutableHelpers: Pick<ImmutableHelpers, 'isDraftable' | 'createWithPatches'>
 }) {
  type State = RootState<any, string, ReducerPath>
 
@@ -264,7 +265,7 @@ export function buildThunks<
  }
  if ('data' in currentState) {
  if (isDraftable(currentState.data)) {
- const [, patches, inversePatches] = produceWithPatches(
+ const [, patches, inversePatches] = createWithPatches(
  currentState.data,
  updateRecipe
  )

packages/toolkit/src/query/core/module.ts

@@ -40,6 +40,7 @@ import type {
  QueryActionCreatorResult,
 } from './buildInitiate'
 import { buildInitiate } from './buildInitiate'
+import type { ImmutableHelpers } from '../tsHelpers'
 import { assertCast, safeAssign } from '../tsHelpers'
 import type { InternalSerializeQueryArgs } from '../defaultSerializeQueryArgs'
 import type { SliceActions } from './buildSlice'
@@ -48,7 +49,12 @@ import type { BaseQueryFn } from '../baseQueryTypes'
 import type { ReferenceCacheLifecycle } from './buildMiddleware/cacheLifecycle'
 import type { ReferenceQueryLifecycle } from './buildMiddleware/queryLifecycle'
 import type { ReferenceCacheCollection } from './buildMiddleware/cacheCollection'
-import { enablePatches } from 'immer'
+import {
+ applyPatches,
+ enablePatches,
+ isDraftable,
+ produceWithPatches,
+} from 'immer'
 
 /**
  * `ifOlderThan` - (default: `false` | `number`) - _number is value in seconds_
@@ -71,7 +77,8 @@ export type CoreModule =
  | ReferenceQueryLifecycle
  | ReferenceCacheCollection
 
-export interface ThunkWithReturnValue<T> extends ThunkAction<T, any, any, AnyAction> {}
+export interface ThunkWithReturnValue<T>
+ extends ThunkAction<T, any, any, AnyAction> {}
 
 declare module '../apiTypes' {
  export interface ApiModules<
@@ -450,6 +457,13 @@ export type ListenerActions = {
 
 export type InternalActions = SliceActions & ListenerActions
 
+interface CoreModuleOptions {
+ immutableHelpers?: Pick<
+ ImmutableHelpers,
+ 'createWithPatches' | 'applyPatches' | 'isDraftable'
+ >
+}
+
 /**
  * Creates a module containing the basic redux logic for use with `buildCreateApi`.
  *
@@ -458,7 +472,13 @@ export type InternalActions = SliceActions & ListenerActions
  * const createBaseApi = buildCreateApi(coreModule());
  * ```
  */
-export const coreModule = (): Module<CoreModule> => ({
+export const coreModule = ({
+ immutableHelpers = {
+ createWithPatches: produceWithPatches,
+ applyPatches,
+ isDraftable,
+ },
+}: CoreModuleOptions = {}): Module<CoreModule> => ({
  name: coreModuleName,
  init(
  api,
@@ -518,6 +538,7 @@ export const coreModule = (): Module<CoreModule> => ({
  context,
  api,
  serializeQueryArgs,
+ immutableHelpers,
  })
 
  const { reducer, actions: sliceActions } = buildSlice({
@@ -533,6 +554,7 @@ export const coreModule = (): Module<CoreModule> => ({
  keepUnusedDataFor,
  reducerPath,
  },
+ immutableHelpers,
  })
 
  safeAssign(api.util, {
@@ -551,6 +573,7 @@ export const coreModule = (): Module<CoreModule> => ({
  mutationThunk,
  api,
  assertTagType,
+ immutableHelpers,
  })
  safeAssign(api.util, middlewareActions)
 

packages/toolkit/src/query/tsHelpers.ts

@@ -1,3 +1,22 @@
+import type { Draft, Patch, applyPatches } from 'immer'
+
+export interface ImmutableHelpers {
+ createNextState: <Base>(
+ base: Base,
+ recipe: (draft: Draft<Base>) => void | Base | Draft<Base>
+ ) => Base
+ createWithPatches: <Base>(
+ base: Base,
+ recipe: (draft: Draft<Base>) => void | Base | Draft<Base>
+ ) => readonly [Base, Patch[], Patch[]]
+ // depends on an Objectish type that immer doesn't export
+ applyPatches: typeof applyPatches
+ isDraft(value: any): boolean
+ isDraftable(value: any): boolean
+ original<T>(value: T): T | undefined
+ current<T>(value: T): T
+}
+
 export type Id<T> = { [K in keyof T]: T[K] } & {}
 export type WithRequiredProp<T, K extends keyof T> = Omit<T, K> &
  Required<Pick<T, K>>

packages/toolkit/src/tsHelpers.ts

@@ -1,12 +1,18 @@
 import type { Middleware, StoreEnhancer } from 'redux'
+import type { Draft, Patch, applyPatches } from 'immer'
 import type { MiddlewareArray } from './utils'
-import type { Draft } from 'immer'
 
 export interface ImmutableHelpers {
  createNextState: <Base>(
  base: Base,
  recipe: (draft: Draft<Base>) => void | Base | Draft<Base>
  ) => Base
+ createWithPatches: <Base>(
+ base: Base,
+ recipe: (draft: Draft<Base>) => void | Base | Draft<Base>
+ ) => readonly [Base, Patch[], Patch[]]
+ // depends on an Objectish type that immer doesn't export
+ applyPatches: typeof applyPatches
  isDraft(value: any): boolean
  isDraftable(value: any): boolean
  original<T>(value: T): T | undefined