undox/src/undox.action.ts

Redux implementation of Undo/Redo based on storing actions instead of states.

import { Action } from './interfaces/public'


export enum UndoxTypes {
  UNDO  = 'undox/UNDO',
  REDO  = 'undox/REDO',
  GROUP = 'undox/GROUP'
}


/**
 * Undo a number of actions
 * @interface
 * @member {number} payload - The number of steps to undo (must be positive and less than the length of the past)
 */
export interface UndoAction extends Action {
  readonly type: UndoxTypes.UNDO
  payload?: number
}


/**
 * Redo a number of actions
 * @interface
 * @member {number} payload - The number of steps to redo (must be positive and less than the length of the future)
 */
export interface RedoAction extends Action {
  readonly type: UndoxTypes.REDO
  payload?: number
}


/**
 * Group actions
 * @interface
 * @member {Action[]} payload - An array of actions which will be grouped into one
 */
export interface GroupAction<A extends Action> extends Action {
  readonly type: UndoxTypes.GROUP
  payload: A[]
}

/*
 * Action Creators
 */

export const redo = (nStates = 1): RedoAction => {
  return {
    type    : UndoxTypes.REDO,
    payload : nStates
  }
}


export const undo = (nStates = 1): UndoAction => {
  return {
    type    : UndoxTypes.UNDO,
    payload : nStates
  }
}


export const group = <A extends Action>(actions: A[]): GroupAction<A> => {
  return {
    type    : UndoxTypes.GROUP,
    payload : actions
  }
}


export type UndoxAction<A extends Action>
  = UndoAction
  | RedoAction
  | GroupAction<A>
  | A