README.md

Reduce boilerplate in Redux

• Create actions similar to Flummox.
• Generate action ids.
• Supports actions with decorators, promises, and therefore ES7 async.

actions.js

//
// 4 different ways to write actions: ES7 Async/Await, Promises, Async Function, Synchronous.
//

import {createActions, asyncAction} from './helpers.js'

export const CounterActions = createActions({

  async incrementAsync() {

    const promise = new Promise((resolve, reject) => {
      setTimeout(() => {
        resolve()
      }, 1000)
    })

    let result = await promise
    return result

  },

  // Use decorator to mark action that returns promise
  @asyncAction()
  incrementPromise() {
  
    // Debug
    const promise = new Promise( (resolve, reject) => {
      setTimeout(() => {
        resolve()
      }, 1000)
    })
  
    return promise;
  },

  incrementFunctionWithState() {
    return (dispatch, getState) => {
      const {counter} = getState()
      console.log(dispatch)
      if (counter % 2 === 0) return
      dispatch(CounterActions.increment())
    }
  },

  incrementFunction()) {
    return dispatch => {
      setTimeout(() => {
        dispatch(CounterActions.increment())
      }, 1000)
    }
  },

  increment() {
    return {}
  },

})

app.js

import React from 'react';
import {Provider} from 'redux/react';
import {RouteHandler} from 'react-router'

import {createRedux, createDispatcher, composeStores} from 'redux';
import thunkMiddleware from 'redux/lib/middleware/thunk';
import {compose} from 'redux';
import {promiseMiddleware} from './helpers.js';
import * as stores from './store.js';

const store = composeStores(stores);

const dispatcher = createDispatcher(
  store,
  getState => [promiseMiddleware(), thunkMiddleware(getState)]
);

const redux = createRedux(dispatcher);

////////////////////////////////////////////////////////////////////////////////

// We use the above code - which this is shorthand for this, but adds our promise middleware.
//const redux = createRedux(stores)

////////////////////////////////////////////////////////////////////////////////

export default class App extends React.Component {

  render() {
    return (
      <Provider redux={redux}>
        {() =>
          <RouteHandler/>
        }
      </Provider>
    );
  }

}

helpers.js

// redux-helpers.js

import _ from 'lodash';
import uniqueId from 'uniqueid';

// Create actions that don't need constants :)
export const createActions = (actionObj) => {
  const baseId = uniqueId();
  return _.zipObject(_.map(actionObj, (actionCreator, key) => {
    const actionId = `${baseId}-${key}`;
    const asyncTypes = ['BEGIN', 'SUCCESS', 'FAILURE'].map( (state) => `${actionId}-${state}`);
    const method = (...args) => {
      const result = actionCreator(...args);

      if (result instanceof Promise) {
        // Promise (async)
        return {
          types: asyncTypes,
          promise: result,
        };
      } else if (typeof result === 'function') {
        // Function (async)
        return (...args) => { // eslint-disable-line no-shadow
          return {
            type: actionId,
            ...(result(...args) || {})
          };
        };
      } else { // eslint-disable-line no-else-return
        // Object (sync)
        return {
          type: actionId,
          ...(result || {})
        };
      }
    };
    if (actionCreator._async === true) {
      const [ begin, success, failure ] = asyncTypes;
      method._id = {
        begin,
        success,
        failure
      };
    } else {
      method._id = actionId;
    }
    return [key, method];
  }));
};

// Get action ids from actions created with `createActions`
export const getActionIds = (actionCreators) => {
  return _.mapValues(actionCreators, (value, key) => { // eslint-disable-line no-unused-vars
    return value._id;
  });
};

// Replace switch statements in stores (taken from the Redux README)
export const createStore = (initialState, handlers) => {
  return (state = initialState, action = {}) =>
    handlers[action.type] ?
      handlers[action.type](state, action) :
      state;
};

export function promiseMiddleware() {
  return (next) => (action) => {
    const { promise, types, ...rest } = action;
    if (!promise) {
      return next(action);
    }

    const [REQUEST, SUCCESS, FAILURE] = types;
    next({ ...rest, type: REQUEST });
    return promise.then(
      (result) => next({ ...rest, result, type: SUCCESS }),
      (error) => next({ ...rest, error, type: FAILURE })
    );
  };
}

export function asyncAction() {
  return (target, name, descriptor) => {
    descriptor.value._async = true;
    return descriptor;
  };
}

index.js

import React from 'react'
import App from './app.js'

React.render(<App/>, document.getElementById('body'))

store.js

import {createStore, getActionIds} from './helpers.js'
import {default as Immutable, Map, List} from 'immutable'
import {CounterActions} from './actions.js'

const actions = getActionIds(CounterActions)

const initialState = 0

export const counter = createStore(initialState, {

  // actions.incrementPromise.begin
  // actions.incrementPromise.success
  // actions.incrementPromise.failure
  [actions.incrementPromise.success]: (state, actions) => {
    return state + 5
  },

})

@iNikNik thanks for the great example. I'm having an issue using async/await (as provided in your first example). It seems that the async begin/success/failure types don't get added unless @asyncAction() is used. Is this by design? It seems without it there's no way to know the function is async without knowing the result of the function and testing for Promise, but by that point the actionCreator has already been setup.

Any suggestions?

Hello @babsonmatt ! Thanks for the feedback, but I just forked @vjpr's gist)
async incrementAsync() returns a promise object. So, promise middleware will dispatch 3 types of action (begin, success, failure). But you can't handle these actions without asyncAction decorator.
Yep, it's by design:
https://gist.github.com/iNikNik/3c1b870f63dc0de67c38#file-helpers-js-L37-L46
https://gist.github.com/iNikNik/3c1b870f63dc0de67c38#file-helpers-js-L52-L56