Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (redux-patch-action-middleware) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

redux-patch-action-middleware

A Redux middleware that allows you to patch action payloads based on the current state before they reach reducers. This solves the common problem of accessing data from one reducer in another reducer, without breaking the Redux pattern or creating complex selector chains.

For example, you can modify an action's payload based on the current state of any slice before it reaches its target reducer. This is particularly useful when you need to:

Validate or transform data using state from other reducers
Enforce business rules that depend on multiple parts of your state
Maintain reducer independence while still allowing cross-slice data access

Features

Patch action payloads using the current state
TypeScript support with full type inference
Works with Redux Toolkit
Minimal boilerplate
Flexible API supporting both curried and direct usage
Access any part of the state when handling actions

Installation

npm install redux-patch-action-middleware

Usage

Basic Setup

First, add the middleware to your Redux store:

import { configureStore } from '@reduxjs/toolkit';
import { createPatchActionMiddleware } from 'redux-patch-action-middleware';

const store = configureStore({
    reducer: rootReducer,
    middleware: (getDefaultMiddleware) =>
            getDefaultMiddleware()
                .concat(createPatchActionMiddleware<RootState>())
});

Creating Patched Actions

There are two main ways to create patched actions:

1. Using `createPatchedAction`

This method gives you full control over the action object:

import { createPatchedAction } from 'redux-patch-action-middleware';
import { PayloadAction } from '@reduxjs/toolkit';

const incrementByAmount = createPatchedAction(
  'counter/incrementByAmount',
  (action: PayloadAction<{ amount: number }>, state: RootState) => ({
    ...action,
    payload: {
         amount: Math.min(action.payload.amount, state.counter.maxIncrement)
    }
  })
);

const counterSlice = createSlice({
    name: 'counter',
    initialState: { value: 0 },
    reducers: {
        // Regular reducers here
    },
    extraReducers: (builder) => {
        // Add the patched action using builder
        builder.addCase(incrementByAmount, (state, action) => {
            // action.payload.amount will already be patched here
            state.value += action.payload.patchedAmount;
        });
    }
});

2. Using `createPatchedPayloadAction`

This is a simplified version that only focuses on patching the payload:

import { createPatchedPayloadAction } from 'redux-patch-action-middleware';

// Curried usage
const createPatchedPayloadActionWithState = createPatchedPayloadAction<RootState>();

const incrementByAmount = createPatchedPayloadActionWithState(
    'counter/incrementByAmount',
    (payload: { amount: number }, state: RootState) => ({
        amount: Math.min(payload.amount, state.counter.maxIncrement)
    })
);

Dispatching Actions

Use the created action creators like any other Redux action:

// Dispatch the action
dispatch(incrementByAmount({ amount: 10 }));

API Reference

`createPatchActionMiddleware<S>()`

Creates the middleware instance for your store.

S: The type of your root state

`createPatchedAction<S>()`

Creates an action creator with full action patching capabilities.

S: The type of your root state
Returns a function that accepts:
- type: The action type string
- actionPatcher: A function that receives the original action and state, and returns the patched action

`createPatchedPayloadAction<S>()`

Creates an action creator with simplified payload-only patching.

S: The type of your root state
Returns a function that accepts:
- type: The action type string
- payloadPatcher: A function that receives the original payload and state, and returns the patched payload

TypeScript Support

The library is written in TypeScript and provides full type inference. Generic type parameters allow you to specify:

Your root state type
Input payload type
Output payload type (if different from input)
Action type string

TypeScript Usage Examples

Create reusable patched action creators for your app:

// Create app-wide patched action creators
const createAppPatchedAction = createPatchedAction<RootState>();
const createAppPatchedPayloadAction = createPatchedPayloadAction<RootState>();

// Use them throughout your app with full type inference
const updateUser = createAppPatchedAction(
    'users/update',
    (action: PayloadAction<{ id: string; data: Partial<User> }>, state) => ({
        ...action,
        payload: {
            id: action.payload.id,
            data: {
                ...state.users[action.payload.id],
                ...action.payload.data
            }
        }
    })
);

// Simplified payload-only version
const updateCounter = createAppPatchedPayloadAction(
    'counter/update',
    (payload: { value: number }, state) => ({
        value: Math.min(payload.value, state.counter.maxValue)
    })
);

Creating App-Wide Action Patchers

You can create a strongly-typed AppActionPatcher for your application by providing your RootState type:

// Define your app-specific ActionPatcher type
type AppActionPatcher<P, IP> = ActionPatcher<RootState, P, IP>;

const createAppActionPatcher: <P, IP>(
    actionPatcher: AppActionPatcher<P, IP>,
) => AppActionPatcher<P, IP> = createActionPatcher;

// Or you can use the simpler PayloadPatcher type
const createAppPayloadActionPatcher: <P, IP>(
    payloadPatcher: PayloadPatcher<RootState, P, IP>,
) => AppActionPatcher<P, IP> = createPayloadPatcher;

// Then you can use these patchers in your actions

const amountPatcher = createAppActionPatcher(
    (action: PayloadAction<{ amount: number }>, state) => {
        return {
            ...action,
            payload: {
                patchedAmount:
                    action.payload.amount + state.amount,
            },
        };
    },
);
const amountPayloadPatcher = createAppPayloadActionPatcher(
    (payload: { amount: number }, state) => {
        return {
            patchedAmount: payload.amount + state.amount,
        };
    },
);

// Or just create reusable action patchers with proper typing
const validateAmount = (action: PayloadAction<{ amount: number }>, state: RootState) => ({
    ...action,
    payload: {
        amount: Math.min(action.payload.amount, state.settings.maxAmount)
    }
});

const ensureUserExists = (action: PayloadAction<{ userId: string; data: Partial<User> }>, state: RootState) => ({
    ...action,
    payload: {
        userId: action.payload.userId,
        data: {
            ...action.payload.data,
            user: state.users[action.payload.userId] ?? 
                { id: action.payload.userId }
        }
    }
});

// Use these typed patchers across your application
const incrementCounter = createPatchedAction(
    'counter/increment', 
    validateAmount
);
const addToBalance = createPatchedAction(
    'wallet/add', 
    validateAmount
);
const updateUserProfile = createPatchedAction(
    'users/updateProfile', 
    ensureUserExists
);
const updateUserSettings = createPatchedAction(
    'users/updateSettings', 
    ensureUserExists
);

This approach provides several benefits:

Full type inference for state access
Consistent typing across all action patchers
Reduced type declaration boilerplate
Better IDE support and type checking

Future Plans

Planned Features

Action Creator Integration

Allow passing action creators directly to patchers for tighter integration
Add utilities to patch actions directly in middleware configuration without component awareness

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License - see the LICENSE file for details.