Update api of withRPCRedux and withRPCReactor (#4)

Author: ganemone

README.md

@@ -70,7 +70,7 @@ function Example({count, loading, error, increment}) {
 }
 
 const hoc = compose(
-  withRPCRedux({rpcId: 'increment'}),
+  withRPCRedux('increment'),
   connect(({count, loading, error}) => ({count, loading, error})),
 );
 export default hoc(Example);
@@ -79,22 +79,21 @@ export default hoc(Example);
 ### Usage with Reactors
 
 ```js
-// add the reactor enhancer in main.js
+// add the reactor enhancer in src/main.js
 import {reactorEnhancer} from 'redux-reactors'
 // ...
 app.plugin(ReduxPlugin, {reducer, enhancer: reactorEnhancer});
 
-// define a reactor
-import {createRPCReactor} from 'fusion-plugin-rpc-redux-react';
-export const incrementReactor = createRPCReactor('increment', {
+// define a reactor (src/reactors/increment.js)
+import {withRPCReactor} from 'fusion-plugin-rpc-redux-react';
+export const incrementReactor = withRPCReactor('increment', {
   start: (state, action) => ({count: state.count, loading: true, error: ''});
   success: (state, action) => ({count: action.payload.count, loading: false, error: ''});
   failure: (state, action) => ({count: state.count, loading: false, error: action.payload.error});
 });
 
-// use the higher order component
+// use the higher order component (src/components/example.js)
 import React from 'react';
-import {withRPCReactor} from 'fusion-plugin-rpc-redux-react';
 import {connect} from 'react-redux';
 import {compose} from 'redux';
 import {incrementReactor} from './reactors/increment.js'
@@ -113,7 +112,7 @@ function Example({count, loading, error, increment}) {
 }
 
 const hoc = compose(
-  withRPCRedux(incrementReactor),
+  incrementReactor,
   connect(({count, loading, error}) => ({count, loading, error})),
 );
 export default hoc(Example);
@@ -126,12 +125,24 @@ export default hoc(Example);
 
 ```js
 import {withRPCRedux} from 'fusion-plugin-rpc-redux-react';
-const NewComponent = withRPCRedux({
-  rpcId: '', // required
+const NewComponent = withRPCRedux('rpcId', {
   propName: '', // optional, defaults to rpcId
   mapStateToParams: (state) => ({}), // optional
   transformParams(params) => ({}), // optional
-})Component)
+})(Component)
 ```
 
 #### `withRPCReactor`
+```js
+import {withRPCReactor} from 'fusion-plugin-rpc-redux-react';
+const NewComponent = withRPCReactor('rpcId', {
+  start: (state, action) => newState, // optional
+  success: (state, action) => newState, // optional
+  failure: (state, action) => newState, // optional
+},
+{
+  propName: '', // optional, defaults to rpcId
+  mapStateToParams: (state) => ({}), // optional
+  transformParams(params) => ({}), // optional
+})(Component);
+```

docs/migrations/00004.md

@@ -0,0 +1,45 @@
+#### Remove createRPCReactor export
+
+```diff
+-import {createRPCReactor} from 'fusion-plugin-rpc-redux-react';
+```
+
+#### Update withRPCReactor api
+
+```diff
+-import {createRPCReactor} from 'fusion-plugin-rpc-redux-react';
+-const withIncrement = withRPCReactor({
+-  ...createRPCReactor('rpcId', {
+-    start: (state, action) => newState,
+-    success: (state, action) => newState,
+-    failure: (state, action) => newState,
+-  }),
+-  propName: '',
+-  mapStateToParams: (state) => {},
+-  transformParams: (params) => {},
+-});
++const withIncrement = withRPCReactor('rpcId', {
++  start: (state, action) => newState,
++  success: (state, action) => newState,
++  failure: (state, action) => newState,
++}, {
++  propName: '',
++  mapStateToParams: (state) => {},
++  transformParams: (params) => {},
++})
+```
+
+#### Update withRPCRedux api
+```diff
+-const withIncrement = withRPCRedux({
+-  rpcId: 'increment',
+-  propName: '',
+-  mapStateToParams: (state) => {},
+-  transformParams: (params) => {},
+-});
++const withIncrement = withRPCRedux('increment', {
++  propName: '',
++  mapStateToParams: (state) => {},
++  transformParams: (params) => {},
++});
+```

package.json

@@ -18,8 +18,8 @@
     "./dist/browser.es.js": "./dist/browser.es.es2015.js"
   },
   "dependencies": {
-    "fusion-plugin-rpc": "^0.1.8",
-    "web-rpc-redux": "^0.1.7"
+    "fusion-plugin-rpc": "^0.2.0",
+    "fusion-rpc-redux": "^0.2.0"
   },
   "peerDependencies": {
     "fusion-react": "^0.1.8",

src/__tests__/__node__/index.js

@@ -11,15 +11,15 @@ test('plugin', t => {
     of() {},
   };
   const RPCRedux = Plugin({handlers, EventEmitter});
-  t.equal(typeof RPCRedux.of().test, 'function');
+  const mockCtx = {headers: {}};
+  t.equal(typeof RPCRedux.of(mockCtx).test, 'function');
   t.end();
 });
 
 test('withRPCRedux hoc', t => {
   function Test() {}
   t.equals(typeof withRPCRedux, 'function');
-  const Connected = withRPCRedux({
-    rpcId: 'test',
+  const Connected = withRPCRedux('test', {
     actions: {
       start() {},
       success() {},
@@ -51,24 +51,27 @@ test('withRPCRedux hoc', t => {
 test('withRPCReactor hoc', t => {
   function Test() {}
   t.equals(typeof withRPCReactor, 'function');
-  const Connected = withRPCReactor({
-    rpcId: 'test',
-    reactors: {
-      start() {},
-      success() {},
-      failure() {},
-    },
-    mapStateToParams: () => {},
-    transformParams: () => {},
+  const Connected = withRPCReactor('test', {
+    start() {},
+    success() {},
+    failure() {},
   })(Test);
   t.equals(Connected.displayName, 'WithRPCRedux(Test)');
   const renderer = new ShallowRenderer();
+  const expectedActions = ['TEST_START', 'TEST_SUCCESS'];
+  const expectedPayloads = ['test-args', 'test-resolve'];
   renderer.render(React.createElement(Connected), {
     rpc: {
-      test() {},
+      test(args) {
+        t.equal(args, 'test-args');
+        return Promise.resolve('test-resolve');
+      },
     },
     store: {
-      dispatch() {},
+      dispatch(action) {
+        t.equal(action.type, expectedActions.shift());
+        t.equal(action.payload, expectedPayloads.shift());
+      },
       getState() {},
     },
   });
@@ -78,5 +81,6 @@ test('withRPCReactor hoc', t => {
     'function',
     'passes the handler through to props'
   );
+  rendered.props.test('test-args');
   t.end();
 });

src/hoc.js

@@ -1,31 +1,25 @@
 import PropTypes from 'prop-types';
 import React from 'react';
-import {createRPCHandler, createRPCReactor} from 'web-rpc-redux';
+import {createRPCHandler, createRPCReactors} from 'fusion-rpc-redux';
 
-export const withRPCReactor = ({
-  propName,
+export const withRPCReactor = (
   rpcId,
   reactors,
-  transformParams,
-  mapStateToParams,
-}) => {
-  const actions = createRPCReactor(rpcId, reactors);
-  return withRPCRedux({
-    actions,
+  {propName, transformParams, mapStateToParams} = {}
+) => {
+  return withRPCRedux(rpcId, {
+    actions: createRPCReactors(rpcId, reactors),
     propName,
     rpcId,
     transformParams,
     mapStateToParams,
   });
 };
 
-export function withRPCRedux({
-  propName,
+export function withRPCRedux(
   rpcId,
-  actions,
-  transformParams,
-  mapStateToParams,
-}) {
+  {propName, actions, transformParams, mapStateToParams} = {}
+) {
   if (!propName) {
     propName = rpcId;
   }

src/index.js

@@ -1,5 +1,5 @@
 import plugin from './plugin';
-export {createRPCReducer, createRPCReactor} from 'web-rpc-redux';
+export {createRPCReducer} from 'fusion-rpc-redux';
 export {withRPCRedux, withRPCReactor} from './hoc';
 
 export default plugin;

yarn.lock

@@ -1570,9 +1570,9 @@ fusion-core@^0.1.8:
     koa-compose "^4.0.0"
     node-mocks-http "^1.6.6"
 
-fusion-plugin-rpc@^0.1.8:
-  version "0.1.8"
-  resolved "https://registry.yarnpkg.com/fusion-plugin-rpc/-/fusion-plugin-rpc-0.1.8.tgz#be96ccdcf3e7120af528171c157ee98f1a079bd7"
+fusion-plugin-rpc@^0.2.0:
+  version "0.2.0"
+  resolved "https://registry.yarnpkg.com/fusion-plugin-rpc/-/fusion-plugin-rpc-0.2.0.tgz#a1fc7facec7de605b95c6ff74d9d517e3c2ecb7a"
   dependencies:
     body-parser "^1.17.1"
     koa-bodyparser "4.2.0"
@@ -1587,6 +1587,12 @@ fusion-react@^0.1.8:
   version "0.1.8"
   resolved "https://registry.yarnpkg.com/fusion-react/-/fusion-react-0.1.8.tgz#fed6129ffe7745f2692a94ac513d80af30821e0b"
 
+fusion-rpc-redux@^0.2.0:
+  version "0.2.0"
+  resolved "https://registry.yarnpkg.com/fusion-rpc-redux/-/fusion-rpc-redux-0.2.0.tgz#ad88778466af6f34d07945077325e9180379cc38"
+  dependencies:
+    redux-reactors "^1.0.3"
+
 get-stdin@^4.0.1:
   version "4.0.1"
   resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-4.0.1.tgz#b968c6b0a04384324902e8bf1a5df32579a450fe"
@@ -3350,12 +3356,6 @@ vlq@^0.2.1:
   version "0.2.3"
   resolved "https://registry.yarnpkg.com/vlq/-/vlq-0.2.3.tgz#8f3e4328cf63b1540c0d67e1b2778386f8975b26"
 
-web-rpc-redux@^0.1.7:
-  version "0.1.7"
-  resolved "https://registry.yarnpkg.com/web-rpc-redux/-/web-rpc-redux-0.1.7.tgz#e9d5bee6a50b1a5813ea85c4b150aa97459b9358"
-  dependencies:
-    redux-reactors "^1.0.3"
-
 whatwg-fetch@>=0.10.0:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/whatwg-fetch/-/whatwg-fetch-2.0.3.tgz#9c84ec2dcf68187ff00bc64e1274b442176e1c84"