Reverts the change that removed bound action creators on the stores d…

…ispatch
ctrlplusb · Jul 23, 2019 · e8aa7bd · e8aa7bd
1 parent 75ce14c
commit e8aa7bd
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 12 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -240,15 +240,16 @@ export type Store<
   StoreModel extends object,
   StoreConfig extends EasyPeasyConfig<any, any> = any
 > = O.Merge<
-  ReduxStore<State<StoreModel>>,
+  O.Omit<ReduxStore<State<StoreModel>>, 'dispatch'>,
   {
+    dispatch: Dispatch<StoreModel>;
     getActions: () => Actions<StoreModel>;
     getMockedActions: () => MockedAction[];
     clearMockedActions: () => void;
     useStoreActions: <Result = any>(
       mapActions: (actions: Actions<StoreModel>) => Result,
     ) => Result;
-    useStoreDispatch: () => Dispatch;
+    useStoreDispatch: () => Dispatch<StoreModel>;
     useStoreState: <Result = any>(
       mapState: (state: State<StoreModel>) => Result,
       dependencies?: Array<any>,
@@ -261,9 +262,16 @@ export type Store<
 // #region Dispatch
 
 /**
- * The Redux store Dispatch
+ * Enhanced version of the Redux Dispatch with action creators bound to it
+ *
+ * @example
+ *
+ * type DispatchWithActions = Dispatch<StoreModel>;
  */
-export type Dispatch = ReduxDispatch;
+export type Dispatch<
+  StoreModel,
+  Action extends ReduxAction = ReduxAction<any>
+> = Actions<StoreModel> & ReduxDispatch<Action>;
 
 // #endregion
 
@@ -348,7 +356,7 @@ export function thunk<
     actions: Actions<Model>,
     payload: Payload,
     helpers: {
-      dispatch: Dispatch;
+      dispatch: Dispatch<StoreModel>;
       getState: () => State<Model>;
       getStoreActions: () => Actions<StoreModel>;
       getStoreState: () => State<StoreModel>;
@@ -633,7 +641,9 @@ export function useStoreActions<
  *   return <AddTodoForm save={(todo) => dispatch({ type: 'ADD_TODO', payload: todo })} />;
  * }
  */
-export function useStoreDispatch(): Dispatch;
+export function useStoreDispatch<StoreModel extends object = {}>(): Dispatch<
+  StoreModel
+>;
 
 // #endregion
 
@@ -686,7 +696,7 @@ export function createContextStore<
   useStoreActions: <Result = any>(
     mapActions: (actions: Actions<StoreModel>) => Result,
   ) => Result;
-  useStoreDispatch: () => Dispatch;
+  useStoreDispatch: () => Dispatch<StoreModel>;
 };
 
 export interface UseLocalStore<

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "easy-peasy",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.6",
   "description": "Vegetarian friendly state for React",
   "license": "MIT",
   "main": "dist/easy-peasy.cjs.js",

diff --git a/src/__tests__/typescript/action.ts b/src/__tests__/typescript/action.ts
@@ -28,6 +28,14 @@ const model: Model = {
 
 const store = createStore(model);
 
+store.dispatch.todos.add('foo');
+// typings:expect-error
+store.dispatch.todos.add(1);
+// typings:expect-error
+store.dispatch.todos.add();
+
+store.dispatch.todos.clear();
+
 interface ListeningModel {
   logs: string[];
   doAction: Action<ListeningModel, string>;

diff --git a/src/__tests__/typescript/store.ts b/src/__tests__/typescript/store.ts
@@ -24,20 +24,20 @@ const count = store.useStoreState(state => state.count);
 count + 10;
 
 store.getActions().doAction(true);
-store.getActions().doAction(true);
+store.dispatch.doAction(true);
 
 // typings:expect-error
 store.getActions().doAction(1);
 // typings:expect-error
-store.getActions().doAction(1);
+store.dispatch.doAction(1);
 
 store.getActions().doThunk(1);
-store.getActions().doThunk(1);
+store.dispatch.doThunk(1);
 
 // typings:expect-error
 store.getActions().doThunk(true);
 // typings:expect-error
-store.getActions().doThunk(true);
+store.dispatch.doThunk(true);
 
 store.getMockedActions()[0].type;
 

diff --git a/src/create-store.js b/src/create-store.js
@@ -116,6 +116,18 @@ export default function createStore(model, options = {}) {
   references.dispatch = store.dispatch;
   references.getState = store.getState;
 
+  // attachs the action creators to the stores dispatch
+  const bindActionCreators = () => {
+    Object.keys(store.dispatch).forEach(actionsKey => {
+      delete store.dispatch[actionsKey];
+    });
+    Object.keys(references.internals.actionCreators).forEach(key => {
+      store.dispatch[key] = references.internals.actionCreators[key];
+    });
+  };
+
+  bindActionCreators();
+
   const rebindStore = removeKey => {
     const currentState = store.getState();
     if (removeKey) {
@@ -124,6 +136,7 @@ export default function createStore(model, options = {}) {
     bindStoreInternals(store.getState());
     store.replaceReducer(references.internals.reducer);
     store.getActions().replaceState(references.internals.defaultState);
+    bindActionCreators();
   };
 
   store.addModel = (key, modelForKey) => {