Merge branch 'entity-methods-creator' into per-slice-creator

Author: EskiMojo14

docs/usage/custom-slice-creators.mdx

@@ -691,11 +691,7 @@ Creators are registered by using module augmentation to add a new key (their uni
 const reducerCreatorType = Symbol('reducerCreatorType')
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     [reducerCreatorType]: () => ReducerDefinition<typeof reducerCreatorType>
   }
   export interface SliceReducerCreatorsExposes<
@@ -724,8 +720,6 @@ declare module '@reduxjs/toolkit' {
 The type parameters for `SliceReducerCreators` are:
 
 - `State` - The state type used by the slice.
-- `SliceName` - The [`name`](../api/createSlice#name) used by the slice.
-- `ReducerPath` - The [`reducerPath`](../api/createSlice#reducerpath) used by the slice.
 
 This is where you register the type of the `create` value of the creator definition (typically a function signature).
 
@@ -739,11 +733,7 @@ However, this should be specifically included in the function signature, so Type
 const batchedCreatorType = Symbol('batchedCreatorType')
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     [batchedCreatorType]: <Payload>(
       // highlight-next-line
       this: ReducerCreators<State, {}>,
@@ -778,11 +768,7 @@ import {
 const batchedCreatorType = Symbol('batchedCreatorType')
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     [batchedCreatorType]: <Payload>(
       reducer: CaseReducer<State, PayloadAction<Payload>>,
     ) => PreparedCaseReducerDefinition<
@@ -813,11 +799,7 @@ Sometimes it's useful to have a reducer creator that only works with a specific
 const loaderCreatorType = Symbol('loaderCreatorType')
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     // highlight-next-line
     [loaderCreatorType]: State extends { loading: boolean }
       ? () => {
@@ -837,11 +819,7 @@ An alternative would be just using that required type _as_ the `State` type for
 const loaderCreatorType = Symbol('loaderCreatorType')
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     [loaderCreatorType]: () => {
       start: CaseReducerDefinition<{ loading: boolean }, PayloadAction>
       end: CaseReducerDefinition<{ loading: boolean }, PayloadAction>
@@ -884,11 +862,7 @@ For example, with (a simplified version of) the `asyncThunk` creator:
 const asyncThunkCreatorType = Symbol('asyncThunkCreatorType')
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     [asyncThunkCreatorType]: <ThunkArg, Returned>(
       payloadCreator: AsyncThunkPayloadCreator<ThunkArg, Returned>,
     ) => AsyncThunkReducerDefinition<State, ThunkArg, Returned>
@@ -927,11 +901,7 @@ For example, with the `preparedReducer` creator:
 const preparedReducerType = Symbol('preparedReducerType')
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     [preparedReducerType]: <Prepare extends PrepareAction<any>>(
       prepare: Prepare,
       caseReducer: CaseReducer<State, ActionForPrepare<Prepare>>,
@@ -1029,11 +999,7 @@ interface ToastThunkCreator<
 
 // register the creator types
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     [toastCreatorType]: (
       config: ToastReducerConfig<State>,
     ) => ToastReducerDefinition<State>
@@ -1157,11 +1123,7 @@ interface PaginationState {
 }
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     // make sure the creator is only called when state is compatible
     [paginationCreatorType]: State extends PaginationState
       ? (this: ReducerCreators<State>) => {
@@ -1227,11 +1189,7 @@ interface HistoryState<T> {
 }
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     // make sure the creator is only called when state is compatible
     [historyCreatorType]: State extends HistoryState<any>
       ? (this: ReducerCreators<State>) => {

packages/toolkit/src/createSlice.ts

@@ -39,7 +39,7 @@ export enum ReducerType {
   entityMethods = 'entityMethods',
 }
 
-export type RegisteredReducerType = keyof SliceReducerCreators<any, any, any>
+export type RegisteredReducerType = keyof SliceReducerCreators<any>
 
 export type ReducerDefinition<
   T extends RegisteredReducerType = RegisteredReducerType,
@@ -51,11 +51,7 @@ export type CreatorCaseReducers<State> =
   | Record<string, ReducerDefinition>
   | SliceCaseReducers<State>
 
-export interface SliceReducerCreators<
-  State,
-  SliceName extends string,
-  ReducerPath extends string,
-> {
+export interface SliceReducerCreators<State> {
   [ReducerType.reducer]: {
     (
       caseReducer: CaseReducer<State, PayloadAction>,
@@ -113,28 +109,14 @@ export interface SliceReducerCreatorsExposes<
 
 export type ReducerCreators<
   State,
-  Name extends string = string,
-  ReducerPath extends string = Name,
   CreatorMap extends Record<string, RegisteredReducerType> = {},
 > = {
-  reducer: SliceReducerCreators<State, Name, ReducerPath>[ReducerType.reducer]
-  preparedReducer: SliceReducerCreators<
-    State,
-    Name,
-    ReducerPath
-  >[ReducerType.reducerWithPrepare]
+  reducer: SliceReducerCreators<State>[ReducerType.reducer]
+  preparedReducer: SliceReducerCreators<State>[ReducerType.reducerWithPrepare]
 } & {
-  [CreatorName in keyof CreatorMap as SliceReducerCreators<
-    State,
-    Name,
-    ReducerPath
-  >[CreatorMap[CreatorName]] extends never
+  [CreatorName in keyof CreatorMap as SliceReducerCreators<State>[CreatorMap[CreatorName]] extends never
     ? never
-    : CreatorName]: SliceReducerCreators<
-    State,
-    Name,
-    ReducerPath
-  >[CreatorMap[CreatorName]]
+    : CreatorName]: SliceReducerCreators<State>[CreatorMap[CreatorName]]
 }
 
 interface InternalReducerHandlingContext<State> {
@@ -269,14 +251,14 @@ type DefinitionFromValue<
 
 type ReducerDefinitionsForType<Type extends RegisteredReducerType> = {
   [CreatorType in RegisteredReducerType]: DefinitionFromValue<
-    SliceReducerCreators<any, any, any>[CreatorType],
+    SliceReducerCreators<any>[CreatorType],
     Type
   >
 }[RegisteredReducerType]
 
 export type ReducerCreator<Type extends RegisteredReducerType> = {
   type: Type
-  create: SliceReducerCreators<any, any, any>[Type]
+  create: SliceReducerCreators<any>[Type]
 } & (ReducerDefinitionsForType<Type> extends never
   ? {
       handle?<State>(
@@ -435,23 +417,16 @@ type InjectedSlice<
 
 type CreatorCallback<
   State,
-  Name extends string,
-  ReducerPath extends string,
   CreatorMap extends Record<string, RegisteredReducerType>,
 > = (
-  create: ReducerCreators<State, Name, ReducerPath, CreatorMap>,
+  create: ReducerCreators<State, CreatorMap>,
 ) => Record<string, ReducerDefinition>
 
 type GetCaseReducers<
   State,
-  Name extends string,
-  ReducerPath extends string,
   CreatorMap extends Record<string, RegisteredReducerType>,
-  CR extends SliceCaseReducers<State> | CreatorCallback<State, any, any, any>,
-> =
-  CR extends CreatorCallback<State, Name, ReducerPath, CreatorMap>
-    ? ReturnType<CR>
-    : CR
+  CR extends SliceCaseReducers<State> | CreatorCallback<State, any>,
+> = CR extends CreatorCallback<State, CreatorMap> ? ReturnType<CR> : CR
 
 /**
  * Options for `createSlice()`.
@@ -464,8 +439,6 @@ export interface CreateSliceOptions<
     | SliceCaseReducers<State>
     | CreatorCallback<
         State,
-        Name,
-        ReducerPath,
         CreatorMap & SliceCreatorMap
       > = SliceCaseReducers<State>,
   Name extends string = string,
@@ -727,7 +700,7 @@ type SliceDefinedSelectors<
  */
 export type ValidateSliceCaseReducers<
   S,
-  ACR extends SliceCaseReducers<S> | CreatorCallback<S, any, any, any>,
+  ACR extends SliceCaseReducers<S> | CreatorCallback<S, any>,
 > = ACR & {
   [T in keyof ACR]: ACR[T] extends {
     reducer(s: S, action?: infer A): any
@@ -786,8 +759,7 @@ export const preparedReducerCreator: ReducerCreator<ReducerType.reducerWithPrepa
 
 const isCreatorCallback = (
   reducers: unknown,
-): reducers is CreatorCallback<any, any, any, any> =>
-  typeof reducers === 'function'
+): reducers is CreatorCallback<any, any> => typeof reducers === 'function'
 
 type CreatorOption<CreatorMap extends Record<string, RegisteredReducerType>> = {
   [Name in keyof CreatorMap]: Name extends 'reducer' | 'preparedReducer'
@@ -857,7 +829,7 @@ export function buildCreateSlice<
     State,
     CaseReducers extends
       | SliceCaseReducers<State>
-      | CreatorCallback<State, Name, ReducerPath, CreatorMap & SliceCreatorMap>,
+      | CreatorCallback<State, CreatorMap & SliceCreatorMap>,
     Name extends string,
     Selectors extends SliceSelectors<State>,
     ReducerPath extends string = Name,
@@ -874,13 +846,7 @@ export function buildCreateSlice<
     >,
   ): Slice<
     State,
-    GetCaseReducers<
-      State,
-      Name,
-      ReducerPath,
-      CreatorMap & SliceCreatorMap,
-      CaseReducers
-    >,
+    GetCaseReducers<State, CreatorMap & SliceCreatorMap, CaseReducers>,
     Name,
     ReducerPath,
     Selectors
@@ -1104,13 +1070,7 @@ export function buildCreateSlice<
     ): Pick<
       Slice<
         State,
-        GetCaseReducers<
-          State,
-          Name,
-          ReducerPath,
-          CreatorMap & SliceCreatorMap,
-          CaseReducers
-        >,
+        GetCaseReducers<State, CreatorMap & SliceCreatorMap, CaseReducers>,
         Name,
         CurrentReducerPath,
         Selectors
@@ -1176,13 +1136,7 @@ export function buildCreateSlice<
 
     const slice: Slice<
       State,
-      GetCaseReducers<
-        State,
-        Name,
-        ReducerPath,
-        CreatorMap & SliceCreatorMap,
-        CaseReducers
-      >,
+      GetCaseReducers<State, CreatorMap & SliceCreatorMap, CaseReducers>,
       Name,
       ReducerPath,
       Selectors

packages/toolkit/src/tests/createSlice.test-d.ts

@@ -915,11 +915,7 @@ interface AddToastThunk<Name extends string, ReducerName extends PropertyKey> {
 }
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     [toasterCreatorType]: State extends ToastState
       ? () => ReducerDefinition<typeof toasterCreatorType>
       : never

packages/toolkit/src/tests/createSlice.test.ts

@@ -1233,11 +1233,7 @@ type PatchThunk<
 }
 
 declare module '@reduxjs/toolkit' {
-  export interface SliceReducerCreators<
-    State,
-    SliceName extends string,
-    ReducerPath extends string,
-  > {
+  export interface SliceReducerCreators<State> {
     [loaderCreatorType]: (
       reducers: Pick<LoaderReducerDefinition<State>, 'ended' | 'started'>,
     ) => LoaderReducerDefinition<State>