typesafe-actions

Breaking changes

1. In v5 all the deprecated v4 creator functions are available under deprecated named import to help with incremental migration.

// before
import { createAction, createStandardAction, createCustomAction } from "typesafe-actions"

// after
import { deprecated } from "typesafe-actions"
const { createAction, createStandardAction, createCustomAction } = deprecated;

2. createStandardAction was renamed to createAction and .map method was removed in favor of simpler redux-actions style API.

// before
const withMappedPayloadAndMeta = createStandardAction(
  'CREATE_STANDARD_ACTION'
).map(({ username, message }: Notification) => ({
  payload: `${username}: ${message}`,
  meta: { username, message },
}));

// after
const withMappedPayloadAndMeta = createAction(
  'CREATE_STANDARD_ACTION',
  ({ username, message }: Notification) => `${username}: ${message}`, // payload creator
  ({ username, message }: Notification) => ({ username, message }) // meta creator
)();

3. v4 version of createAction was removed. I suggest to refactor to use a new createAction as in point 2, which was simplified and extended to support redux-actions style API.

// before
const withPayloadAndMeta = createAction('CREATE_ACTION', resolve => {
  return (id: number, token: string) => resolve(id, token);
});

// after
const withPayloadAndMeta = createAction(
  'CREATE_ACTION',
  (id: number, token: string) => id, // payload creator
  (id: number, token: string) => token // meta creator
})();

4. createCustomAction - API was greatly simplified, now it's used like this:

// before
const add = createCustomAction('CUSTOM', type => {
  return (first: number, second: number) => ({ type, customProp1: first, customProp2: second });
});

// after
const add = createCustomAction(
  'CUSTOM',
  (first: number, second: number) => ({ customProp1: first, customProp2: second })
);

5. AsyncActionCreator should be just renamed to AsyncActionCreatorBuilder.

// before
import { AsyncActionCreator } from "typesafe-actions"

//after
import { AsyncActionCreatorBuilder } from "typesafe-actions"

New

• Rewrite and simplify createAction & createAsyncAction API (#192)

Improvements

• Fixed .npmignore. Fixed #205
• Rollup build improvements (#203)
• Updated AsyncActionCreatorBuilder and AsyncAction types to fix cancel handler type being never (#194)
• Fixed high memory consumption (#171)

Improvements

• Downgrade rollup ver to fix react-native prod runtime error #170

Improvements

• Resolved #164
• Added performance tests: npm run performance:[2,10,50]

Improvements

• Updated build pipeline to use babel for code transformation and bundle optimizations #155

New API

• Added new type AsyncActionCreator (#148)

Improvements

• Removed implicit dependency on tslib (Resolved #147)

New API

• Added optional cancel action to the createAsyncAction API (#146)

Improvements

• Updated createReducer handlers property type to show the correct type of only already added handlers

Improvements

• Fixed error - createReducer cannot be called when handling more than 2 actions #145

Improvements

• Fixed error - no exported member RootAction #141

Improvements

• Added typing support for reducer as object map #140

New API

• Added createReducer a typesafe reducer factory using object map and chain API #106
• Exported various helper-types returned from public API #123

Breaking change

From v4.x.x all action creators will use undefined instead of void as a generic type parameter to make the action-creator function require NO parameters.

Background discussion: https://github.com/piotrwitek/typesafe-actions/issues/124#issuecomment-479446603

const increment = createStandardAction('INCREMENT')<undefined>();
increment(); // <= no parameters required

const fetchUsers = createAsyncAction(
  'FETCH_USERS_REQUEST',
  'FETCH_USERS_SUCCESS',
  'FETCH_USERS_FAILURE'
)<undefined, User[], Error>();
fetchUsers.request(); // <= no parameters required

Improvements

• Improved ActionType to bring back v3.3 behaviour #132
• Fixed backward compatibility for void type parameters from v3.1 (after internal type refactoring for v3.2 they were not treated as EmptyAC anymore) #124

Improvements

Updated types to be compatible with the recent TypeScript release v3.4.1 🎉

New API

action and createAction have new 3rd parameter which is error property on action object making it fully FSA compliant.

import { action, createAction } from 'typesafe-actions';

export const todosError = (message: string) => action('todos/ERROR', message, undefined, true);
// todosError: (message: string) => { type: "todos/ADD"; payload: string; error: boolean; }

export const todosError = createAction('todos/ERROR', action => {
  // Note: "action" callback does not need "type" parameter
  return (message: string) => action(message, undefined, true);
});
// todosError: (message: string) => { type: "todos/ADD"; payload: string; error: boolean; }

Improvements

Fixed #117
Fixed #118

Improvements

Fixed #122

New API

createCustomAction

Create an enhanced action-creator with unlimited number of arguments and custom properties on action object.

• Arguments of resulting action-creator will preserve their original semantic names (id, firstName, lastName).
• Returned action objects have custom properties ({ type, customProp1, customProp2, ...customPropN })

createCustomAction(type, type => {
  return (namedArg1, namedArg2, ...namedArgN) => ({ type, customProp1, customProp2, ...customPropN })
})

Examples:
> Advanced Usage Examples

import { createCustomAction } from 'typesafe-actions';

const add = createCustomAction('CUSTOM', type => {
  return (first: number, second: number) => ({ type, customProp1: first, customProp2: second });
});

add(1) // { type: "CUSTOM"; customProp1: number; customProp2: number; }

Breaking change

From v3.x.x the minimum required TS version is v3.2.

This allow us to benefit from new type-checker features like tuple types and to simplify some existing complexity in function overloads.
This should help us in the long run to implement new features faster.

FIXED:

Resolved #68
Resolved #53
Resolved #91
Resolved #44
Resolved #74
Resolved #77
Resolved #100
Resolved #42