fix(history): pushing/replacing a route sometimes resulted in a back/next action (#56)

Previously, actions dispatched by the user to push/replace the route were intercepted and turned into back/next actions if they matched the next or previous entry in the history stack. This meant that it was not possible to push/replace the next/previous route in the history stack. This change removes that behaviour, so that the direction of dispatched actions are preserved.

BREAKING CHANGE: dispatching a route that matches the previous/next route in the history stack is no longer reinterpreted as a back/next action

BREAKING CHANGE: history functions `set`/`setParams`/`setState`/`setQuery`/`setHash`/`setBasename` no longer accept a function as an argument

BREAKING CHANGE: history functions `set`/`setParams`/`setState`/`setQuery` no longer merge their arguments with the existing params/state/query

BREAKING CHANGE: history functions `back`/`next`/`jump` no longer accept a state argument

Fixes #48

Author: hedgepigdaniel

packages/integration-tests/__helpers__/createTest.js

@@ -194,7 +194,12 @@ const createSnipes = (testName, routesMap, initialPath, opts, callback) => {
         return res
       },
       snapPop: async (direction, prefix = '') => {
-        const res = await pop(direction)
+        let res
+        if (typeof direction === 'string') {
+          res = await pop(direction)
+        } else {
+          res = await direction.call(history)
+        }
 
         if (opts.snipesOnly) return res
 

packages/integration-tests/__tests__/integration/__snapshots__/createAction.js.snap

@@ -194,7 +194,7 @@ Object {
   "hash": "",
   "location": Object {
     "blocked": null,
-    "direction": "backward",
+    "direction": "forward",
     "entries": Array [
       Object {
         "basename": "",
@@ -226,13 +226,28 @@ Object {
         "state": Object {},
         "type": "SECOND",
       },
+      Object {
+        "basename": "",
+        "hash": "",
+        "location": Object {
+          "key": "345678",
+          "pathname": "/first",
+          "scene": "",
+          "search": "",
+          "url": "/first",
+        },
+        "params": Object {},
+        "query": Object {},
+        "state": Object {},
+        "type": "FIRST",
+      },
     ],
     "from": null,
-    "index": 0,
+    "index": 2,
     "key": "345678",
-    "kind": "back",
-    "length": 2,
-    "n": -1,
+    "kind": "push",
+    "length": 3,
+    "n": 1,
     "pathname": "/first",
     "pop": false,
     "prev": Object {
@@ -276,7 +291,7 @@ Object {
   "location": Object {
     "basename": "",
     "blocked": null,
-    "direction": "backward",
+    "direction": "forward",
     "entries": Array [
       Object {
         "basename": "",
@@ -308,14 +323,29 @@ Object {
         "state": Object {},
         "type": "SECOND",
       },
+      Object {
+        "basename": "",
+        "hash": "",
+        "location": Object {
+          "key": "345678",
+          "pathname": "/first",
+          "scene": "",
+          "search": "",
+          "url": "/first",
+        },
+        "params": Object {},
+        "query": Object {},
+        "state": Object {},
+        "type": "FIRST",
+      },
     ],
     "from": null,
     "hash": "",
-    "index": 0,
+    "index": 2,
     "key": "345678",
-    "kind": "back",
-    "length": 2,
-    "n": -1,
+    "kind": "push",
+    "length": 3,
+    "n": 1,
     "params": Object {},
     "pathname": "/first",
     "pop": false,