navigation-stack 0.3.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (257) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +611 -163
  3. package/data-storage/package.json +6 -0
  4. package/karma.conf.cjs +21 -4
  5. package/lib/cjs/NavigationStack.js +88 -0
  6. package/lib/cjs/data-storage/DataStorage.js +71 -0
  7. package/lib/cjs/data-storage/LocationDataStorage.js +29 -0
  8. package/lib/cjs/data-storage/index.js +9 -0
  9. package/lib/cjs/debug.js +12 -0
  10. package/lib/cjs/environment/InMemoryEnvironment.js +15 -0
  11. package/lib/cjs/environment/WebBrowserEnvironment.js +15 -0
  12. package/lib/cjs/environment/data-storage/InMemoryDataStorage.js +27 -0
  13. package/lib/cjs/environment/data-storage/WebBrowserDataStorage.js +21 -0
  14. package/lib/cjs/environment/scroll-position/InMemoryScrollPosition.js +44 -0
  15. package/lib/cjs/environment/scroll-position/WebBrowserScrollPosition.js +60 -0
  16. package/lib/cjs/getLocationFromInternalLocation.js +14 -0
  17. package/lib/cjs/index.js +20 -16
  18. package/lib/cjs/navigationBlockers.js +28 -23
  19. package/lib/cjs/{normalizeInputLocation.js → parseInputLocation.js} +25 -9
  20. package/lib/cjs/{ActionTypes.js → redux/ActionTypes.js} +1 -1
  21. package/lib/cjs/redux/ActionTypesInternal.js +8 -0
  22. package/lib/cjs/{Actions.js → redux/Actions.js} +5 -4
  23. package/lib/cjs/redux/createMiddlewares.js +60 -0
  24. package/lib/cjs/redux/index.js +13 -0
  25. package/lib/cjs/redux/internalLocationReducer.js +14 -0
  26. package/lib/cjs/redux/middleware/createAddInputLocationBasePathMiddleware.js +32 -0
  27. package/lib/cjs/redux/middleware/createNonProgrammaticNavigationBlockerMiddleware.js +113 -0
  28. package/lib/cjs/redux/middleware/createProgrammaticNavigationBlockerMiddleware.js +94 -0
  29. package/lib/cjs/redux/middleware/createRemoveOutputLocationBasePathMiddleware.js +30 -0
  30. package/lib/cjs/redux/middleware/createUpdateInternalLocationMiddleware.js +73 -0
  31. package/lib/cjs/{middleware/navigationActionMiddleware.js → redux/middleware/navigationOperationMiddleware.js} +11 -8
  32. package/lib/cjs/{middleware/normalizeInputLocationMiddleware.js → redux/middleware/parseInputLocationMiddleware.js} +6 -4
  33. package/lib/cjs/redux/middleware/updateLocationMiddleware.js +34 -0
  34. package/lib/cjs/scroll-position/PageScrollPositionSetter.js +97 -0
  35. package/lib/cjs/scroll-position/ScrollPositionAutoSaver.js +141 -0
  36. package/lib/cjs/scroll-position/ScrollPositionRestoration.js +407 -0
  37. package/lib/cjs/scroll-position/ScrollPositionSaver.js +87 -0
  38. package/lib/cjs/scroll-position/ScrollPositionSetter.js +16 -0
  39. package/lib/cjs/scroll-position/constants.js +5 -0
  40. package/lib/cjs/scroll-position/index.js +7 -0
  41. package/lib/cjs/scroll-position/scheduleNextTick.js +11 -0
  42. package/lib/cjs/session/InMemorySession.js +22 -0
  43. package/lib/cjs/session/ServerSideRenderSession.js +17 -0
  44. package/lib/cjs/session/Session.js +202 -0
  45. package/lib/cjs/session/WebBrowserSession.js +20 -0
  46. package/lib/cjs/session/key/createSessionKey.js +23 -0
  47. package/lib/cjs/session/lifecycle/InMemorySessionLifecycle.js +19 -0
  48. package/lib/cjs/session/lifecycle/WebBrowserSessionLifecycle.js +128 -0
  49. package/lib/cjs/session/lifecycle/page-lifecycle/PageLifecycle.js +269 -0
  50. package/lib/cjs/session/lifecycle/page-lifecycle/PageLifecycleInstance.js +8 -0
  51. package/lib/cjs/session/lifecycle/page-lifecycle/supportsConstructableEventTarget.js +33 -0
  52. package/lib/cjs/session/navigation/InMemoryNavigation.js +104 -0
  53. package/lib/cjs/session/navigation/ServerSideNavigation.js +61 -0
  54. package/lib/cjs/session/navigation/WebBrowserNavigation.js +221 -0
  55. package/lib/cjs/session/navigation/error/NavigationOutOfBoundsError.js +12 -0
  56. package/lib/cjs/session/navigation/error/ServerSideNavigationError.js +21 -0
  57. package/lib/cjs/session/navigation/operation/operations.js +11 -0
  58. package/lib/cjs/session/subscription/Subscription.js +81 -0
  59. package/lib/data-storage/index.d.ts +35 -0
  60. package/lib/esm/NavigationStack.js +81 -0
  61. package/lib/esm/data-storage/DataStorage.js +65 -0
  62. package/lib/esm/data-storage/LocationDataStorage.js +22 -0
  63. package/lib/esm/data-storage/index.js +2 -0
  64. package/lib/esm/debug.js +7 -0
  65. package/lib/esm/environment/InMemoryEnvironment.js +8 -0
  66. package/lib/esm/environment/WebBrowserEnvironment.js +8 -0
  67. package/lib/esm/environment/data-storage/InMemoryDataStorage.js +21 -0
  68. package/lib/esm/environment/data-storage/WebBrowserDataStorage.js +15 -0
  69. package/lib/esm/environment/scroll-position/InMemoryScrollPosition.js +38 -0
  70. package/lib/esm/environment/scroll-position/WebBrowserScrollPosition.js +54 -0
  71. package/lib/esm/getLocationFromInternalLocation.js +9 -0
  72. package/lib/esm/index.js +10 -8
  73. package/lib/esm/navigationBlockers.js +28 -23
  74. package/lib/esm/{normalizeInputLocation.js → parseInputLocation.js} +24 -8
  75. package/lib/esm/{ActionTypes.js → redux/ActionTypes.js} +1 -1
  76. package/lib/esm/redux/ActionTypesInternal.js +3 -0
  77. package/lib/esm/{Actions.js → redux/Actions.js} +5 -4
  78. package/lib/esm/redux/createMiddlewares.js +54 -0
  79. package/lib/esm/redux/index.js +4 -0
  80. package/lib/esm/redux/internalLocationReducer.js +8 -0
  81. package/lib/esm/redux/middleware/createAddInputLocationBasePathMiddleware.js +27 -0
  82. package/lib/esm/redux/middleware/createNonProgrammaticNavigationBlockerMiddleware.js +108 -0
  83. package/lib/esm/redux/middleware/createProgrammaticNavigationBlockerMiddleware.js +88 -0
  84. package/lib/esm/redux/middleware/createRemoveOutputLocationBasePathMiddleware.js +25 -0
  85. package/lib/esm/redux/middleware/createUpdateInternalLocationMiddleware.js +68 -0
  86. package/lib/esm/{middleware/navigationActionMiddleware.js → redux/middleware/navigationOperationMiddleware.js} +10 -7
  87. package/lib/esm/{middleware/normalizeInputLocationMiddleware.js → redux/middleware/parseInputLocationMiddleware.js} +5 -3
  88. package/lib/esm/redux/middleware/updateLocationMiddleware.js +28 -0
  89. package/lib/esm/scroll-position/PageScrollPositionSetter.js +91 -0
  90. package/lib/esm/scroll-position/ScrollPositionAutoSaver.js +134 -0
  91. package/lib/esm/scroll-position/ScrollPositionRestoration.js +400 -0
  92. package/lib/esm/scroll-position/ScrollPositionSaver.js +80 -0
  93. package/lib/esm/scroll-position/ScrollPositionSetter.js +10 -0
  94. package/lib/esm/scroll-position/constants.js +1 -0
  95. package/lib/esm/scroll-position/index.js +1 -0
  96. package/lib/esm/scroll-position/scheduleNextTick.js +6 -0
  97. package/lib/esm/session/InMemorySession.js +15 -0
  98. package/lib/esm/session/ServerSideRenderSession.js +11 -0
  99. package/lib/esm/session/Session.js +195 -0
  100. package/lib/esm/session/WebBrowserSession.js +13 -0
  101. package/lib/esm/session/key/createSessionKey.js +18 -0
  102. package/lib/esm/session/lifecycle/InMemorySessionLifecycle.js +13 -0
  103. package/lib/esm/session/lifecycle/WebBrowserSessionLifecycle.js +120 -0
  104. package/lib/esm/session/lifecycle/page-lifecycle/PageLifecycle.js +263 -0
  105. package/lib/esm/session/lifecycle/page-lifecycle/PageLifecycleInstance.js +2 -0
  106. package/lib/esm/session/lifecycle/page-lifecycle/supportsConstructableEventTarget.js +30 -0
  107. package/lib/esm/session/navigation/InMemoryNavigation.js +97 -0
  108. package/lib/esm/session/navigation/ServerSideNavigation.js +54 -0
  109. package/lib/esm/session/navigation/WebBrowserNavigation.js +213 -0
  110. package/lib/esm/session/navigation/error/NavigationOutOfBoundsError.js +6 -0
  111. package/lib/esm/session/navigation/error/ServerSideNavigationError.js +14 -0
  112. package/lib/esm/session/navigation/operation/operations.js +6 -0
  113. package/lib/esm/session/subscription/Subscription.js +75 -0
  114. package/lib/index.d.ts +179 -157
  115. package/lib/redux/index.d.ts +90 -0
  116. package/lib/scroll-position/index.d.ts +107 -0
  117. package/package.json +9 -5
  118. package/redux/package.json +6 -0
  119. package/scroll-position/package.json +6 -0
  120. package/src/NavigationStack.js +100 -0
  121. package/src/data-storage/DataStorage.js +69 -0
  122. package/src/data-storage/LocationDataStorage.js +23 -0
  123. package/src/data-storage/index.js +2 -0
  124. package/src/debug.js +8 -0
  125. package/src/environment/InMemoryEnvironment.js +9 -0
  126. package/src/environment/WebBrowserEnvironment.js +9 -0
  127. package/src/environment/data-storage/InMemoryDataStorage.js +23 -0
  128. package/src/environment/data-storage/WebBrowserDataStorage.js +17 -0
  129. package/src/environment/scroll-position/InMemoryScrollPosition.js +45 -0
  130. package/src/environment/scroll-position/WebBrowserScrollPosition.js +72 -0
  131. package/src/getLocationFromInternalLocation.js +7 -0
  132. package/src/index.js +10 -8
  133. package/src/navigationBlockers.js +31 -27
  134. package/src/{normalizeInputLocation.js → parseInputLocation.js} +23 -8
  135. package/src/{ActionTypes.js → redux/ActionTypes.js} +1 -1
  136. package/src/redux/ActionTypesInternal.js +3 -0
  137. package/src/{Actions.js → redux/Actions.js} +4 -3
  138. package/src/redux/createMiddlewares.js +65 -0
  139. package/src/redux/index.js +4 -0
  140. package/src/redux/internalLocationReducer.js +9 -0
  141. package/src/redux/middleware/createAddInputLocationBasePathMiddleware.js +27 -0
  142. package/src/redux/middleware/createNonProgrammaticNavigationBlockerMiddleware.js +119 -0
  143. package/src/redux/middleware/createProgrammaticNavigationBlockerMiddleware.js +94 -0
  144. package/src/redux/middleware/createRemoveOutputLocationBasePathMiddleware.js +26 -0
  145. package/src/redux/middleware/createUpdateInternalLocationMiddleware.js +72 -0
  146. package/src/{middleware/navigationActionMiddleware.js → redux/middleware/navigationOperationMiddleware.js} +10 -3
  147. package/src/{middleware/normalizeInputLocationMiddleware.js → redux/middleware/parseInputLocationMiddleware.js} +5 -3
  148. package/src/redux/middleware/updateLocationMiddleware.js +28 -0
  149. package/src/scroll-position/PageScrollPositionSetter.js +110 -0
  150. package/src/scroll-position/ScrollPositionAutoSaver.js +168 -0
  151. package/src/scroll-position/ScrollPositionRestoration.js +551 -0
  152. package/src/scroll-position/ScrollPositionSaver.js +120 -0
  153. package/src/scroll-position/ScrollPositionSetter.js +16 -0
  154. package/src/scroll-position/constants.js +1 -0
  155. package/src/scroll-position/index.js +1 -0
  156. package/src/scroll-position/scheduleNextTick.js +6 -0
  157. package/src/session/InMemorySession.js +13 -0
  158. package/src/session/ServerSideRenderSession.js +9 -0
  159. package/src/session/Session.js +238 -0
  160. package/src/session/WebBrowserSession.js +13 -0
  161. package/src/session/key/createSessionKey.js +18 -0
  162. package/src/session/lifecycle/InMemorySessionLifecycle.js +13 -0
  163. package/src/session/lifecycle/WebBrowserSessionLifecycle.js +126 -0
  164. package/src/session/lifecycle/page-lifecycle/PageLifecycle.js +291 -0
  165. package/src/session/lifecycle/page-lifecycle/PageLifecycleInstance.js +3 -0
  166. package/src/session/lifecycle/page-lifecycle/supportsConstructableEventTarget.js +32 -0
  167. package/src/session/navigation/InMemoryNavigation.js +78 -0
  168. package/src/session/navigation/ServerSideNavigation.js +43 -0
  169. package/src/session/navigation/WebBrowserNavigation.js +224 -0
  170. package/src/session/navigation/error/NavigationOutOfBoundsError.js +7 -0
  171. package/src/session/navigation/error/ServerSideNavigationError.js +18 -0
  172. package/src/session/navigation/operation/operations.js +6 -0
  173. package/src/session/subscription/Subscription.js +76 -0
  174. package/test/NavigationStack.test.js +296 -0
  175. package/test/{LocationDataStorage.test.js → data-storage/LocationDataStorage.test.js} +3 -3
  176. package/test/data-storage/index.test.js +8 -0
  177. package/test/index.js +12 -0
  178. package/test/index.test.js +8 -7
  179. package/test/{helpers.js → middlewareTestUtil.js} +9 -12
  180. package/test/{normalizeInputLocation.test.js → parseInputLocationMiddleware.test.js} +9 -9
  181. package/test/{Action.test.js → redux/Action.test.js} +7 -6
  182. package/test/{ActionTypes.test.js → redux/ActionTypes.test.js} +2 -2
  183. package/test/redux/createMiddlewares.test.js +96 -0
  184. package/test/redux/index.test.js +10 -0
  185. package/test/{locationReducer.test.js → redux/locationReducer.test.js} +4 -7
  186. package/test/redux/middleware/createAddInputLocationBasePathMiddleware.test.js +40 -0
  187. package/test/redux/middleware/createNonProgrammaticNavigationBlockerMiddleware.test.js +264 -0
  188. package/test/redux/middleware/createProgrammaticNavigationBlockerMiddleware.test.js +312 -0
  189. package/test/redux/middleware/createRemoveOutputLocationBasePathMiddleware.test.js +51 -0
  190. package/test/{middleware/navigationActionMiddleware.test.js → redux/middleware/navigationOperationMiddleware.test.js} +16 -12
  191. package/test/{middleware/normalizeInputLocationMiddleware.test.js → redux/middleware/parseInputLocationMiddleware.test.js} +4 -4
  192. package/test/scroll-position/ScrollPositionRestoration.test.js +435 -0
  193. package/test/scroll-position/addScrollableContainer.js +39 -0
  194. package/test/scroll-position/addScrollableContainerWithAnchors.js +56 -0
  195. package/test/scroll-position/createApp.js +132 -0
  196. package/test/scroll-position/delay.js +9 -0
  197. package/test/scroll-position/mockPageLifecycle.js +17 -0
  198. package/test/scroll-position/runApp.js +24 -0
  199. package/test/scroll-position/withScrollableContainerAtIndexPageWithDisabledAutomaticScrollPositionRestoration.js +72 -0
  200. package/test/session/InMemorySession.test.js +348 -0
  201. package/test/session/ServerSession.test.js +17 -9
  202. package/test/session/WebBrowserSession.test.js +265 -0
  203. package/test/testUtil.js +3 -0
  204. package/types/data-storage/index.d.ts +35 -0
  205. package/types/index.d.ts +179 -157
  206. package/types/redux/index.d.ts +90 -0
  207. package/types/scroll-position/index.d.ts +107 -0
  208. package/types/tsconfig.json +1 -1
  209. package/lib/cjs/LocationDataStorage.js +0 -61
  210. package/lib/cjs/addBeforeLocationChangeListener.js +0 -7
  211. package/lib/cjs/beforeLocationChangeListeners.js +0 -51
  212. package/lib/cjs/createMiddlewares.js +0 -47
  213. package/lib/cjs/middleware/createBasePathMiddleware.js +0 -24
  214. package/lib/cjs/middleware/createBeforeLocationChangeListenerMiddleware.js +0 -39
  215. package/lib/cjs/middleware/createLocationMiddleware.js +0 -56
  216. package/lib/cjs/middleware/createNavigationBlockerMiddleware.js +0 -161
  217. package/lib/cjs/middleware/createTransformLocationMiddleware.js +0 -38
  218. package/lib/cjs/onlyAllowedOnClientSide.js +0 -10
  219. package/lib/cjs/session/BrowserSession.js +0 -235
  220. package/lib/cjs/session/MemorySession.js +0 -223
  221. package/lib/cjs/session/ServerSession.js +0 -65
  222. package/lib/esm/LocationDataStorage.js +0 -54
  223. package/lib/esm/addBeforeLocationChangeListener.js +0 -2
  224. package/lib/esm/beforeLocationChangeListeners.js +0 -44
  225. package/lib/esm/createMiddlewares.js +0 -41
  226. package/lib/esm/middleware/createBasePathMiddleware.js +0 -19
  227. package/lib/esm/middleware/createBeforeLocationChangeListenerMiddleware.js +0 -34
  228. package/lib/esm/middleware/createLocationMiddleware.js +0 -50
  229. package/lib/esm/middleware/createNavigationBlockerMiddleware.js +0 -156
  230. package/lib/esm/middleware/createTransformLocationMiddleware.js +0 -33
  231. package/lib/esm/onlyAllowedOnClientSide.js +0 -5
  232. package/lib/esm/session/BrowserSession.js +0 -229
  233. package/lib/esm/session/MemorySession.js +0 -217
  234. package/lib/esm/session/ServerSession.js +0 -58
  235. package/src/LocationDataStorage.js +0 -60
  236. package/src/addBeforeLocationChangeListener.js +0 -2
  237. package/src/beforeLocationChangeListeners.js +0 -54
  238. package/src/createMiddlewares.js +0 -45
  239. package/src/middleware/createBasePathMiddleware.js +0 -20
  240. package/src/middleware/createBeforeLocationChangeListenerMiddleware.js +0 -40
  241. package/src/middleware/createLocationMiddleware.js +0 -55
  242. package/src/middleware/createNavigationBlockerMiddleware.js +0 -168
  243. package/src/middleware/createTransformLocationMiddleware.js +0 -29
  244. package/src/onlyAllowedOnClientSide.js +0 -5
  245. package/src/session/BrowserSession.js +0 -235
  246. package/src/session/MemorySession.js +0 -219
  247. package/src/session/ServerSession.js +0 -67
  248. package/test/createMiddlewares.test.js +0 -62
  249. package/test/middleware/createBasePathMiddleware.test.js +0 -67
  250. package/test/middleware/createBeforeLocationChangeListenerMiddleware.test.js +0 -141
  251. package/test/middleware/createNavigationBlockerMiddleware.test.js +0 -471
  252. package/test/middleware/createTransformLocationMiddleware.test.js +0 -44
  253. package/test/session/BrowserSession.test.js +0 -182
  254. package/test/session/MemorySession.test.js +0 -244
  255. /package/lib/cjs/{locationReducer.js → redux/locationReducer.js} +0 -0
  256. /package/lib/esm/{locationReducer.js → redux/locationReducer.js} +0 -0
  257. /package/src/{locationReducer.js → redux/locationReducer.js} +0 -0
@@ -1,67 +0,0 @@
1
- /* eslint-disable max-classes-per-file */
2
-
3
- import normalizeInputLocation from '../normalizeInputLocation';
4
-
5
- function noop() {}
6
-
7
- function serverSideNavigationNotPossible() {
8
- throw new Error('Server-side navigation is not possible');
9
- }
10
-
11
- class ServerNavigation {
12
- constructor(initialLocation) {
13
- this._location = normalizeInputLocation(initialLocation);
14
- }
15
-
16
- init() {
17
- return {
18
- action: 'INIT',
19
- ...this._location,
20
- index: 0,
21
- key: '0',
22
- };
23
- }
24
-
25
- subscribe() {
26
- // Server-side environment emits no location subscription events.
27
- return noop;
28
- }
29
-
30
- // Navigation methods are not implemented, because `ServerSession` instances
31
- // cannot navigate.
32
- navigate() {
33
- serverSideNavigationNotPossible();
34
- }
35
-
36
- // Navigation methods are not implemented, because `ServerSession` instances
37
- // cannot navigate.
38
- shift() {
39
- serverSideNavigationNotPossible();
40
- }
41
- }
42
-
43
- class ServerDataStorage {
44
- // It doesn't seem to make any sense to store anything on server side.
45
- // Hence, state management methods are "no op" stubs.
46
- get() {
47
- return null;
48
- }
49
-
50
- remove() {}
51
-
52
- set() {}
53
- }
54
-
55
- export default class ServerSession {
56
- constructor(initialLocation) {
57
- this.navigation = new ServerNavigation(initialLocation);
58
- this.dataStorage = new ServerDataStorage();
59
- }
60
-
61
- // "Before destroy" listeners are currently ignored.
62
- // If required, one could implement a `_destroy()` method
63
- // and there check that the listeners actually do get called.
64
- addBeforeDestroyListener() {
65
- return noop;
66
- }
67
- }
@@ -1,62 +0,0 @@
1
- import { applyMiddleware, createStore } from 'redux';
2
-
3
- import Actions from '../src/Actions';
4
- import createMiddlewares from '../src/createMiddlewares';
5
- import locationReducer from '../src/locationReducer';
6
- import MemorySession from '../src/session/MemorySession';
7
-
8
- describe('createMiddlewares', () => {
9
- let store;
10
-
11
- beforeEach(() => {
12
- store = createStore(
13
- locationReducer,
14
- applyMiddleware(...createMiddlewares(new MemorySession('/foo'))),
15
- );
16
- store.dispatch(Actions.init());
17
- });
18
-
19
- afterEach(() => {
20
- store.dispatch(Actions.dispose());
21
- });
22
-
23
- it('should support push and go', () => {
24
- store.dispatch(Actions.push('/bar'));
25
- expect(store.getState()).to.include({
26
- pathname: '/bar',
27
- index: 1,
28
- });
29
-
30
- store.dispatch(Actions.shift(-1));
31
- expect(store.getState()).to.include({
32
- pathname: '/foo',
33
- index: 0,
34
- });
35
-
36
- store.dispatch(Actions.shift(+1));
37
- expect(store.getState()).to.include({
38
- pathname: '/bar',
39
- index: 1,
40
- });
41
- });
42
-
43
- it('should support replace', () => {
44
- store.dispatch(Actions.replace('/bar'));
45
- expect(store.getState()).to.include({
46
- pathname: '/bar',
47
- index: 0,
48
- });
49
- });
50
-
51
- it('should ignore other actions', () => {
52
- expect(
53
- store.dispatch({
54
- type: 'UNKNOWN',
55
- payload: { unknown: {} },
56
- }),
57
- ).to.eql({
58
- type: 'UNKNOWN',
59
- payload: { unknown: {} },
60
- });
61
- });
62
- });
@@ -1,67 +0,0 @@
1
- import createBasePathMiddleware from '../../src/middleware/createBasePathMiddleware';
2
- import {
3
- transformInputLocationUsingMiddleware,
4
- transformSubscriptionLocationUsingMiddleware,
5
- } from '../helpers';
6
-
7
- describe('createBasePathMiddleware', () => {
8
- [
9
- ['/foo', 'generic `basePath`'],
10
- ['/foo/', '`basePath` with a trailing slash'],
11
- ].forEach(([basePath, title]) => {
12
- describe(title, () => {
13
- const basePathMiddleware = createBasePathMiddleware(basePath);
14
-
15
- it('should prepend `basePath` to `location.pathname` on input locations', () => {
16
- expect(
17
- transformInputLocationUsingMiddleware(basePathMiddleware, {
18
- pathname: '/path',
19
- }),
20
- ).to.eql({
21
- pathname: '/foo/path',
22
- });
23
- });
24
-
25
- it('should strip `basePath` from `location.pathname` on subscription locations', () => {
26
- expect(
27
- transformSubscriptionLocationUsingMiddleware(basePathMiddleware, {
28
- pathname: '/foo/path',
29
- }),
30
- ).to.eql({
31
- pathname: '/path',
32
- });
33
- });
34
-
35
- it('should handle unrecognized paths on subscription locations', () => {
36
- expect(
37
- transformSubscriptionLocationUsingMiddleware(basePathMiddleware, {
38
- pathname: '/bar/path',
39
- }),
40
- ).to.eql({
41
- pathname: '/bar/path',
42
- });
43
- });
44
- });
45
- });
46
-
47
- describe('No `basePath` specified', () => {
48
- const basePathMiddleware = createBasePathMiddleware('/');
49
-
50
- it('should not modify `location.pathname` of input locations', () => {
51
- const location = { pathname: '/path' };
52
- expect(
53
- transformInputLocationUsingMiddleware(basePathMiddleware, location),
54
- ).to.equal(location);
55
- });
56
-
57
- it('should not modify `location.pathname` of subscription locations', () => {
58
- const location = { pathname: '/path' };
59
- expect(
60
- transformSubscriptionLocationUsingMiddleware(
61
- basePathMiddleware,
62
- location,
63
- ),
64
- ).to.equal(location);
65
- });
66
- });
67
- });
@@ -1,141 +0,0 @@
1
- import { applyMiddleware, createStore } from 'redux';
2
-
3
- import Actions from '../../src/Actions';
4
- import addBeforeLocationChangeListenerOriginal from '../../src/addBeforeLocationChangeListener';
5
- import createMiddlewares from '../../src/createMiddlewares';
6
- import locationReducer from '../../src/locationReducer';
7
- import MemorySession from '../../src/session/MemorySession';
8
- import { shouldWarn } from '../helpers';
9
-
10
- describe('createBeforeLocationChangeListenerMiddleware', () => {
11
- const sandbox = sinon.createSandbox();
12
-
13
- let session;
14
- let store;
15
-
16
- function addBeforeLocationChangeListener(listener) {
17
- return addBeforeLocationChangeListenerOriginal(session, listener);
18
- }
19
-
20
- beforeEach(() => {
21
- session = new MemorySession('/foo');
22
-
23
- store = createStore(
24
- locationReducer,
25
- applyMiddleware(...createMiddlewares(session)),
26
- );
27
- store.dispatch(Actions.init());
28
- });
29
-
30
- afterEach(() => {
31
- store.dispatch(Actions.dispose());
32
-
33
- sandbox.restore();
34
- });
35
-
36
- describe('PUSH navigations', () => {
37
- it('should listen to upcoming navigation', () => {
38
- const listener1 = sinon.stub();
39
- const listener2 = sinon.stub();
40
-
41
- addBeforeLocationChangeListener(listener1);
42
- addBeforeLocationChangeListener(listener2);
43
-
44
- store.dispatch(Actions.push('/bar'));
45
- expect(store.getState().pathname).to.equal('/bar');
46
-
47
- expect(listener1).to.have.been.calledOnce();
48
-
49
- expect(listener1.firstCall.args[0]).to.include({
50
- action: 'PUSH',
51
- pathname: '/bar',
52
- });
53
-
54
- expect(listener2).to.have.been.calledOnce();
55
-
56
- expect(listener2.firstCall.args[0]).to.include({
57
- action: 'PUSH',
58
- pathname: '/bar',
59
- });
60
- });
61
-
62
- it('should warn on and ignore listeners that throw', () => {
63
- shouldWarn(
64
- 'Ignoring before location change listener `syncListener` that failed with `Error: foo`.',
65
- );
66
-
67
- const syncListener = () => {
68
- throw new Error('foo');
69
- };
70
-
71
- addBeforeLocationChangeListener(syncListener);
72
-
73
- store.dispatch(Actions.push('/bar'));
74
- expect(store.getState().pathname).to.equal('/bar');
75
- });
76
-
77
- it('should allow removing listeners', () => {
78
- const listener = sinon.stub();
79
-
80
- const removeNavigationListener =
81
- addBeforeLocationChangeListener(listener);
82
-
83
- store.dispatch(Actions.push('/bar-1'));
84
- expect(store.getState().pathname).to.equal('/bar-1');
85
-
86
- expect(listener).to.have.been.calledOnce();
87
-
88
- removeNavigationListener();
89
-
90
- store.dispatch(Actions.push('/bar-2'));
91
- expect(store.getState().pathname).to.equal('/bar-2');
92
-
93
- expect(listener).to.have.been.calledOnce();
94
- });
95
- });
96
-
97
- describe('SHIFT navigations', () => {
98
- beforeEach(() => {
99
- store.dispatch(Actions.push('/bar'));
100
- });
101
-
102
- it('should listen to upcoming navigation', () => {
103
- const listener = sinon.stub();
104
- addBeforeLocationChangeListener(listener);
105
-
106
- store.dispatch(Actions.shift(-1));
107
- expect(store.getState().pathname).to.equal('/foo');
108
-
109
- expect(listener).to.have.been.calledOnce();
110
-
111
- expect(listener.firstCall.args[0]).to.include({
112
- action: 'SHIFT',
113
- pathname: '/foo',
114
- delta: -1,
115
- });
116
- });
117
- });
118
-
119
- describe('INIT', () => {
120
- it('should ignore to the initial load', () => {
121
- // Get rid of the old store. We'll replace it with a new one.
122
- store.dispatch(Actions.dispose());
123
-
124
- store = createStore(
125
- locationReducer,
126
- applyMiddleware(...createMiddlewares(new MemorySession('/foo'))),
127
- );
128
-
129
- const listener = sinon.stub();
130
- addBeforeLocationChangeListener(listener);
131
-
132
- expect(listener).to.not.have.been.called();
133
-
134
- expect(store.getState()).to.be.undefined();
135
- store.dispatch(Actions.init());
136
- expect(store.getState().pathname).to.equal('/foo');
137
-
138
- expect(listener).to.not.have.been.called();
139
- });
140
- });
141
- });