app-redux-utils

Installation

npm install app-redux-utils

How to use

// Users.actions.ts
import { createAction, createActionWithCallback } from "app-redux-utils";
import { UsersStore } from "./Users.store";

export interface ILoadUserData {
    userId: number;
}

export class UsersActions {
    public static readonly PREFIX = "USERS_";
    public static readonly UPDATE_STORE = UsersActions.PREFIX + "UPDATE_STORE";

    public static readonly LOAD_USERS = UsersActions.PREFIX + "LOAD_USERS";
    public static readonly LOAD_USER = UsersActions.PREFIX + "LOAD_USER";
    public static readonly LOAD_CURRENT_USER = UsersActions.PREFIX + "LOAD_CURRENT_USER";
    public static readonly LOAD_SOMETHING_ELSE = UsersActions.PREFIX + "LOAD_SOMETHING_ELSE";

    public static updateStore = (partialStore: Partial<UsersStore>) =>
        createAction(UsersActions.UPDATE_STORE, partialStore);

    public static loadUsers = () =>
        createAction(UsersActions.LOAD_USERS);

    public static loadUser = (data: ILoadUserData) =>
        createAction(UsersActions.LOAD_USER, data);

    public static loadCurrentUser = () =>
        createActionWithCallback(UsersActions.LOAD_CURRENT_USER);

    public static loadSomethingElse = () =>
        createAction(UsersActions.LOAD_SOMETHING_ELSE);
}

// UsersPageContainer.ts
import { ComponentType } from "react";
import { connect } from "react-redux";
import { Dispatch } from "redux";

import { UsersActions } from "./Users.actions";
import { IUsersPageCallProps, UsersPage } from "./UsersPage";

const mapDispatchToProps = (dispatch: Dispatch): IUsersPageCallProps => {
    return {
        loadUsers: () => dispatch(UsersActions.loadUsers()),
        loadUser: (userId: number) => dispatch(UsersActions.loadUser({ userId })),
        loadCurrentUser: () => dispatch(
            UsersActions.loadCurrentUser()(
                () => UsersActions.loadSomethingElse()
            )
        ),
    };
};

const UsersPageContainer: ComponentType = connect(
    null,
    mapDispatchToProps
)(UsersPage);

export { UsersPageContainer };

// Users.reducer.ts
import { Reducer } from "app-redux-utils";

import { UsersActions } from "./Users.actions";
import { UsersStore } from "./Users.store";

export const UsersReducer = Reducer(new UsersStore(), UsersActions.UPDATE_STORE);

// State.ts
import { UsersStore } from "./Users.store";
import { SomeStore } from "./Some.store";

export class State {
    public usersStore: UsersStore;
    public someStore: SomeStore;
}

// getReducers.ts
import { ReducersMapObject } from "redux";
import { State } from "./State";
import { UsersReducer } from "./Users.reducer";
import { SomeReducer } from "./Some.reducer";

export function getReducers(): ReducersMapObject<State, any> {
    return {
        usersStore: UsersReducer,
        someStore: SomeReducer,
    };
}

// configureApp.ts
import { createReducers } from "app-redux-utils";
import { applyMiddleware, compose, createStore, Store } from "redux";

import { State } from "./State";
import { getReducers } from "./getReducers";

export function configureApp(): Store<State> {
    const composeEnhancer = window["__REDUX_DEVTOOLS_EXTENSION_COMPOSE__"] || compose;
    const store: Store<State> = createStore(
        createReducers(getReducers),
        composeEnhancer(applyMiddleware())
    );

    return store;
}

Using with redux-saga

// Users.saga.ts
import { put } from "@redux-saga/core/effects";
import { AppAction } from "app-redux-utils";

import { UsersApi } from "@api/UsersApi";
import { UsersActions, ILoadUserData } from "../redux/Users.actions";
import { UsersStore } from "../redux/Users.store";

export class UsersSaga {
    private static* updateStore(partialStore: Partial<UsersStore>) {
        yield put(UsersActions.updateStore(partialStore));
    }

    public static* loadUsers(action: AppAction) {
        // some logic ...

        yield UsersSaga.updateStore({
            users: [],
        });
    }

    public static* loadUser(action: AppAction<ILoadUserData>) {
        // some logic ...

        const response = yield UsersApi.getUserById(action.payload.userId);

        yield UsersSaga.updateStore({
            openedUser: response.data,
        });
    }

    // other sagas...
}

// Users.watcher.ts

import { SagaMiddleware } from "redux-saga";
import { ForkEffect, put, PutEffect, TakeEffect, takeLatest } from "@redux-saga/core/effects";
import { AppAction } from "app-redux-utils";

import { UsersActions } from "../redux/Users.actions";
import { UsersSaga } from "./Users.saga";

type WatchFunction = () => IterableIterator<ForkEffect | TakeEffect | PutEffect>;

export class UsersWatcher {
    public watchFunctions: WatchFunction[];

    constructor() {
        this.watchFunctions = [];

        this.watchLatest(
            UsersActions.LOAD_USERS,
            UsersSaga.loadUsers
        );
        this.watchLatest(
            UsersActions.LOAD_USER,
            UsersSaga.loadUser
        );
        this.watchLatest(
            UsersActions.LOAD_CURRENT_USER,
            UsersSaga.loadCurrentUser
        );
    }

    private getSagaWithCallbackAction(saga: (action: AppAction) => void): (action: AppAction) => void {
        return function* (action: AppAction) {
            yield saga(action);

            if (typeof action.callbackAction === "function") {
                yield put(action.callbackAction());
            }
        };
    }

    private watchLatest(actionType: string, saga: (action: AppAction) => void) {
        const sagaWithCallbackAction = this.getSagaWithCallbackAction(saga);
        this.watchFunctions.push(
            function* () {
                yield takeLatest(actionType, sagaWithCallbackAction);
            }
        );
    }

    public run(sagaMiddleware: SagaMiddleware) {
        this.watchFunctions.forEach(saga => sagaMiddleware.run(saga));
    }
}

// configureApp.ts
import { createReducers } from "app-redux-utils";
import { applyMiddleware, compose, createStore, Store } from "redux";
import createSagaMiddleware, { SagaMiddleware } from "redux-saga";

import { State } from "./State";
import { getReducers } from "./getReducers";
import { UsersWatcher } from "./Users.watcher";

export function configureApp(): Store<State> {
    const sagaMiddleware: SagaMiddleware = createSagaMiddleware();
    const middleware = applyMiddleware(
        sagaMiddleware
    );

    const composeEnhancer = window["__REDUX_DEVTOOLS_EXTENSION_COMPOSE__"] || compose;
    const store: Store<State> = createStore(
        createReducers(getReducers),
        composeEnhancer(middleware)
    );

    const watcher = new UsersWatcher();
    watcher.run(sagaMiddleware);

    return store;
}