navigation-stack 0.5.3 → 0.6.0

package/src/redux/middleware/createUpdateInternalLocationMiddleware.js

@@ -1,72 +0,0 @@
-import ActionTypes from '../ActionTypes';
-import ActionTypesInternal from '../ActionTypesInternal';
-
-// Creates a "middleware" that performs the actual navigation according to the `session` being used.
-// For example, when `WebBrowserSession` is used, it calls methods of the `window.history` object.
-export default function createUpdateInternalLocationMiddleware(
-  session,
-  { shouldIgnoreNavigationLocationSubscriptionEvents },
-) {
-  return function updateInternalLocationMiddleware() {
-    return (next) => {
-      // Whenever browser location changes,
-      // perform the same changes with the internal `location` object.
-      const unsubscribe = session.subscribe((location) => {
-        if (!shouldIgnoreNavigationLocationSubscriptionEvents()) {
-          next({
-            // eslint-disable-next-line no-underscore-dangle
-            type: ActionTypesInternal.INTERNAL_LOCATION_UPDATE,
-            payload: location,
-          });
-        }
-      });
-
-      return (action) => {
-        const { type, payload } = action;
-
-        switch (type) {
-          case ActionTypes.INIT:
-            // `init()` will trigger the `subscribe()` listener,
-            // which will call `updateLocation()`.
-            session.start(payload);
-            // eslint-disable-next-line consistent-return
-            return;
-
-          case ActionTypes.NAVIGATE:
-            // `navigate()` will trigger the `subscribe()` listener,
-            // which will call `updateLocation()`.
-            session.navigate(payload.operation, payload.location);
-            // eslint-disable-next-line consistent-return
-            return;
-
-          case ActionTypes.SHIFT:
-            // `shift()` will trigger the `subscribe()` listener,
-            // which will call `updateLocation()`.
-            session.shift(payload);
-            // eslint-disable-next-line consistent-return
-            return;
-
-          case ActionTypes.STOP:
-            // Remove location change subscription.
-            unsubscribe();
-            // Even if it calls `unsubscribe()` function above, any other subscriptions
-            // would still stay. We're not talking about `navigationStack.subscribe()`
-            // subscriptions because those don't really matter in terms of cleaning them up:
-            // those're just Redux store subscriptions that don't have any side effects.
-            // Subscriptions we're talking here are `Session`'s own subscription
-            // via `session.subscribe()` and any hypothetical manual `session.subscribe()`
-            // calls that could be made by the application code for whatever purpose.
-            // Both of those should be cleared.
-            // To work around that, `.stop()` function removes all subscriptions.
-            session.stop();
-            // eslint-disable-next-line consistent-return
-            return next(action);
-
-          default:
-            // eslint-disable-next-line consistent-return
-            return next(action);
-        }
-      };
-    };
-  };
-}

package/src/redux/middleware/navigationOperationMiddleware.js

@@ -1,34 +0,0 @@
-import Operations from '../../session/navigation/operation/operations';
-import ActionTypes from '../ActionTypes';
-
-// This "middleware" transforms a `PUSH` / `REPLACE` action into a `NAVIGATE` action.
-export default function navigationOperationMiddleware() {
-  return (next) => (action) => {
-    const { type, payload } = action;
-
-    switch (type) {
-      // Converts a `PUSH` action into a `NAVIGATE` action.
-      case ActionTypes.PUSH:
-        return next({
-          type: ActionTypes.NAVIGATE,
-          payload: {
-            operation: Operations.PUSH,
-            location: payload,
-          },
-        });
-
-      // Converts a `REPLACE` action into a `NAVIGATE` action.
-      case ActionTypes.REPLACE:
-        return next({
-          type: ActionTypes.NAVIGATE,
-          payload: {
-            operation: Operations.REPLACE,
-            location: payload,
-          },
-        });
-
-      default:
-        return next(action);
-    }
-  };
-}

package/src/redux/middleware/parseInputLocationMiddleware.js

@@ -1,23 +0,0 @@
-import parseInputLocation from '../../parseInputLocation';
-import ActionTypes from '../ActionTypes';
-
-// This "middleware" transforms input location argument into a proper `NormalizedInputLocation`.
-export default function parseInputLocationMiddleware() {
-  return (next) => (action) => {
-    const { type, payload } = action;
-
-    switch (type) {
-      case ActionTypes.INIT:
-      case ActionTypes.PUSH:
-      case ActionTypes.REPLACE:
-        return next({
-          type,
-          // `payload` is optional in `INIT` action.
-          payload: payload && parseInputLocation(payload),
-        });
-
-      default:
-        return next(action);
-    }
-  };
-}

package/src/redux/middleware/updateLocationMiddleware.js

@@ -1,28 +0,0 @@
-import getLocationFromInternalLocation from '../../getLocationFromInternalLocation';
-import ActionTypes from '../ActionTypes';
-import ActionTypesInternal from '../ActionTypesInternal';
-
-export default function updateLocationMiddleware() {
-  return (next) => (action) => {
-    const { type, payload } = action;
-
-    switch (type) {
-      // Convert `LocationInternal` object to a publicly-visible `Location` object.
-      // It hides non-essential properties of location such as `operation`, `index`, `delta`.
-      // eslint-disable-next-line no-underscore-dangle
-      case ActionTypesInternal.INTERNAL_LOCATION_UPDATE:
-        // Dispatch a "public" `UPDATE` Redux action.
-        // This is what users of this package should use
-        // rather than `INTERNAL_LOCATION_UPDATE` which is for internal purposes.
-        next({
-          type: ActionTypes.UPDATE,
-          payload: getLocationFromInternalLocation(payload),
-        });
-        return;
-
-      default:
-        // eslint-disable-next-line consistent-return
-        return next(action);
-    }
-  };
-}

package/src/session/InMemorySession.js

@@ -1,13 +0,0 @@
-import Session from './Session';
-import InMemoryEnvironment from '../environment/InMemoryEnvironment';
-import InMemorySessionLifecycle from './lifecycle/InMemorySessionLifecycle';
-import InMemoryNavigation from './navigation/InMemoryNavigation';
-
-export default class InMemorySession extends Session {
-  constructor({ navigation = new InMemoryNavigation() } = {}) {
-    super({ navigation });
-
-    this.environment = new InMemoryEnvironment();
-    this.lifecycle = new InMemorySessionLifecycle();
-  }
-}

package/src/session/ServerSideRenderSession.js

@@ -1,9 +0,0 @@
-import InMemorySession from './InMemorySession';
-import ServerSideNavigation from './navigation/ServerSideNavigation';
-
-// `ServerSideRenderSession` is just a `InMemorySession` that specifically prohibits any navigation.
-export default class ServerSideRenderSession extends InMemorySession {
-  constructor() {
-    super({ navigation: new ServerSideNavigation() });
-  }
-}

package/src/session/WebBrowserSession.js

@@ -1,13 +0,0 @@
-import Session from './Session';
-import WebBrowserEnvironment from '../environment/WebBrowserEnvironment';
-import WebBrowserSessionLifecycle from './lifecycle/WebBrowserSessionLifecycle';
-import WebBrowserNavigation from './navigation/WebBrowserNavigation';
-
-export default class WebBrowserSession extends Session {
-  constructor() {
-    super({ navigation: new WebBrowserNavigation() });
-
-    this.environment = new WebBrowserEnvironment();
-    this.lifecycle = new WebBrowserSessionLifecycle();
-  }
-}

package/test/middlewareTestUtil.js

@@ -1,31 +0,0 @@
-import ActionTypes from '../src/redux/ActionTypes';
-import ActionTypesInternal from '../src/redux/ActionTypesInternal';
-
-export function invokeLocationMiddleware(middleware, action) {
-  let result;
-
-  function next(nextAction) {
-    result = nextAction;
-  }
-
-  middleware()(next)(action);
-
-  return result;
-}
-
-export function transformInputLocationUsingMiddleware(middleware, location) {
-  return invokeLocationMiddleware(middleware, {
-    type: ActionTypes.NAVIGATE,
-    payload: {
-      operation: 'push',
-      location,
-    },
-  }).payload.location;
-}
-
-export function transformOutputLocationUsingMiddleware(middleware, location) {
-  return invokeLocationMiddleware(middleware, {
-    type: ActionTypesInternal.INTERNAL_LOCATION_UPDATE,
-    payload: location,
-  }).payload;
-}

package/test/redux/Action.test.js

@@ -1,73 +0,0 @@
-import ActionTypes from '../../src/redux/ActionTypes';
-import Actions from '../../src/redux/Actions';
-
-describe('Actions', () => {
-  it('#init should create an INIT action', () => {
-    expect(Actions.init('/foo?bar=baz#qux')).to.eql({
-      type: ActionTypes.INIT,
-      payload: '/foo?bar=baz#qux',
-    });
-  });
-
-  it('#push should create a PUSH action with location', () => {
-    expect(Actions.push('/foo?bar=baz#qux')).to.eql({
-      type: ActionTypes.PUSH,
-      payload: '/foo?bar=baz#qux',
-    });
-
-    expect(
-      Actions.push({
-        pathname: '/foo',
-        search: '?bar=baz',
-        hash: '#qux',
-      }),
-    ).to.eql({
-      type: ActionTypes.PUSH,
-      payload: {
-        pathname: '/foo',
-        search: '?bar=baz',
-        hash: '#qux',
-      },
-    });
-  });
-
-  it('#replace should create a REPLACE action with location', () => {
-    expect(Actions.replace('/foo?bar=baz#qux')).to.eql({
-      type: ActionTypes.REPLACE,
-      payload: '/foo?bar=baz#qux',
-    });
-
-    expect(
-      Actions.replace({
-        pathname: '/foo',
-        search: '?bar=baz',
-        hash: '#qux',
-      }),
-    ).to.eql({
-      type: ActionTypes.REPLACE,
-      payload: {
-        pathname: '/foo',
-        search: '?bar=baz',
-        hash: '#qux',
-      },
-    });
-  });
-
-  it('#go should create a SHIFT action with delta', () => {
-    expect(Actions.shift(1)).to.eql({
-      type: ActionTypes.SHIFT,
-      payload: 1,
-    });
-
-    expect(Actions.shift(-1)).to.eql({
-      type: ActionTypes.SHIFT,
-      payload: -1,
-    });
-  });
-
-  it('#stop should create a STOP action', () => {
-    expect(Actions.stop()).to.eql({
-      type: ActionTypes.STOP,
-    });
-  });
-});

package/test/redux/ActionTypes.test.js

@@ -1,13 +0,0 @@
-import ActionTypes from '../../src/redux/ActionTypes';
-
-describe('ActionTypes', () => {
-  it('should have the correct exports', () => {
-    expect(ActionTypes.INIT).to.exist();
-    expect(ActionTypes.PUSH).to.exist();
-    expect(ActionTypes.REPLACE).to.exist();
-    expect(ActionTypes.NAVIGATE).to.exist();
-    expect(ActionTypes.SHIFT).to.exist();
-    expect(ActionTypes.UPDATE).to.exist();
-    expect(ActionTypes.STOP).to.exist();
-  });
-});

package/test/redux/createMiddlewares.test.js

@@ -1,96 +0,0 @@
-import { applyMiddleware, createStore } from 'redux';
-
-import Actions from '../../src/redux/Actions';
-import createMiddlewares from '../../src/redux/createMiddlewares';
-import internalLocationReducer from '../../src/redux/internalLocationReducer';
-import InMemorySession from '../../src/session/InMemorySession';
-
-describe('createMiddlewares', () => {
-  let store;
-
-  beforeEach(() => {
-    store = createStore(
-      internalLocationReducer,
-      applyMiddleware(
-        ...createMiddlewares(new InMemorySession(), {
-          _internalLocationReducer: true,
-        }),
-      ),
-    );
-    store.dispatch(Actions.init('/initial'));
-  });
-
-  afterEach(() => {
-    store.dispatch(Actions.stop());
-  });
-
-  it('should support `push` and `shift` navigation actions', () => {
-    store.dispatch(Actions.push('/new'));
-    expect(store.getState()).to.include({
-      pathname: '/new',
-      index: 1,
-    });
-
-    store.dispatch(Actions.shift(-1));
-    expect(store.getState()).to.include({
-      pathname: '/initial',
-      index: 0,
-    });
-
-    store.dispatch(Actions.shift(+1));
-    expect(store.getState()).to.include({
-      pathname: '/new',
-      index: 1,
-    });
-  });
-
-  it('should support `replace` navigation action', () => {
-    store.dispatch(Actions.replace('/new'));
-    expect(store.getState()).to.include({
-      pathname: '/new',
-      index: 0,
-    });
-  });
-
-  it('should ignore other actions', () => {
-    expect(
-      store.dispatch({
-        type: 'UNKNOWN',
-        payload: { unknown: {} },
-      }),
-    ).to.eql({
-      type: 'UNKNOWN',
-      payload: { unknown: {} },
-    });
-  });
-});
-
-describe('createMiddlewares.basePath', () => {
-  it('should support `basePath`', () => {
-    const session = new InMemorySession();
-
-    const store = createStore(
-      internalLocationReducer,
-      applyMiddleware(
-        ...createMiddlewares(session, {
-          basePath: '/base',
-          _internalLocationReducer: true,
-        }),
-      ),
-    );
-
-    store.dispatch(Actions.init('/initial'));
-
-    store.dispatch(Actions.push('/new'));
-
-    // eslint-disable-next-line no-underscore-dangle
-    expect(session._subscription._latest.pathname).to.equal('/base/new');
-
-    expect(store.getState()).to.include({
-      pathname: '/new',
-      index: 1,
-    });
-
-    store.dispatch(Actions.stop());
-  });
-});

package/test/redux/index.test.js

@@ -1,10 +0,0 @@
-import * as exports from '../../src/redux';
-
-describe('redux', () => {
-  it('should export top level correctly', () => {
-    expect(exports.Actions).to.exist();
-    expect(exports.ActionTypes).to.exist();
-    expect(exports.createMiddlewares).to.exist();
-    expect(exports.locationReducer).to.exist();
-  });
-});

package/test/redux/locationReducer.test.js

@@ -1,39 +0,0 @@
-import ActionTypes from '../../src/redux/ActionTypes';
-import locationReducer from '../../src/redux/locationReducer';
-
-describe('locationReducer', () => {
-  const prevState = {
-    operation: 'push',
-    delta: 1,
-    hash: '',
-    index: 5,
-    key: 'h0j8qq:4',
-    pathname: '/new/path',
-    query: {},
-    search: '',
-  };
-
-  it('should handle UPDATE', () => {
-    const newLocation = {
-      key: 'h0j8qq:5',
-      pathname: '/foo',
-      query: {
-        bar: 'baz',
-      },
-      search: '?bar=baz',
-      hash: '#qux',
-    };
-    const action = {
-      type: ActionTypes.UPDATE,
-      payload: newLocation,
-    };
-    expect(locationReducer(prevState, action)).to.eql(newLocation);
-  });
-
-  it('should not handle unknown action', () => {
-    const unknownAction = {
-      type: 'UNKNOWN',
-    };
-    expect(locationReducer(prevState, unknownAction)).to.equal(prevState);
-  });
-});

package/test/redux/middleware/createAddInputLocationBasePathMiddleware.test.js

@@ -1,40 +0,0 @@
-import createAddInputLocationBasePathMiddleware from '../../../src/redux/middleware/createAddInputLocationBasePathMiddleware';
-import { transformInputLocationUsingMiddleware } from '../../middlewareTestUtil';
-
-describe('createAddInputLocationBasePathMiddleware', () => {
-  [
-    ['/base', 'generic `basePath`'],
-    ['/base/', '`basePath` with a trailing slash'],
-  ].forEach(([basePath, title]) => {
-    describe(title, () => {
-      const addInputLocationBasePathMiddleware =
-        createAddInputLocationBasePathMiddleware(basePath);
-
-      it('should prepend `basePath` to `location.pathname` on input locations', () => {
-        expect(
-          transformInputLocationUsingMiddleware(
-            addInputLocationBasePathMiddleware,
-            { pathname: '/path' },
-          ),
-        ).to.eql({
-          pathname: '/base/path',
-        });
-      });
-    });
-  });
-
-  describe('No `basePath` specified', () => {
-    const addInputLocationBasePathMiddleware =
-      createAddInputLocationBasePathMiddleware('/');
-
-    it('should not modify `location.pathname` of input locations', () => {
-      const location = { pathname: '/path' };
-      expect(
-        transformInputLocationUsingMiddleware(
-          addInputLocationBasePathMiddleware,
-          location,
-        ),
-      ).to.equal(location);
-    });
-  });
-});

package/test/redux/middleware/createRemoveOutputLocationBasePathMiddleware.test.js

@@ -1,51 +0,0 @@
-import createRemoveOutputLocationBasePathMiddleware from '../../../src/redux/middleware/createRemoveOutputLocationBasePathMiddleware';
-import { transformOutputLocationUsingMiddleware } from '../../middlewareTestUtil';
-
-describe('createRemoveOutputLocationBasePathMiddleware', () => {
-  [
-    ['/base', 'generic `basePath`'],
-    ['/base/', '`basePath` with a trailing slash'],
-  ].forEach(([basePath, title]) => {
-    describe(title, () => {
-      const removeOutputLocationBasePathMiddleware =
-        createRemoveOutputLocationBasePathMiddleware(basePath);
-
-      it('should strip `basePath` from `location.pathname` on subscription locations', () => {
-        expect(
-          transformOutputLocationUsingMiddleware(
-            removeOutputLocationBasePathMiddleware,
-            { pathname: '/base/path' },
-          ),
-        ).to.eql({
-          pathname: '/path',
-        });
-      });
-
-      it('should handle unrecognized paths on subscription locations', () => {
-        expect(
-          transformOutputLocationUsingMiddleware(
-            removeOutputLocationBasePathMiddleware,
-            { pathname: '/path' },
-          ),
-        ).to.eql({
-          pathname: '/path',
-        });
-      });
-    });
-  });
-
-  describe('No `basePath` specified', () => {
-    const removeOutputLocationBasePathMiddleware =
-      createRemoveOutputLocationBasePathMiddleware('/');
-
-    it('should not modify `location.pathname` of subscription locations', () => {
-      const location = { pathname: '/path' };
-      expect(
-        transformOutputLocationUsingMiddleware(
-          removeOutputLocationBasePathMiddleware,
-          location,
-        ),
-      ).to.equal(location);
-    });
-  });
-});

package/test/redux/middleware/navigationOperationMiddleware.test.js

@@ -1,78 +0,0 @@
-import ActionTypes from '../../../src/redux/ActionTypes';
-import navigationOperationMiddleware from '../../../src/redux/middleware/navigationOperationMiddleware';
-
-describe('navigationOperationMiddleware', () => {
-  let next;
-  let dispatch;
-  beforeEach(() => {
-    next = sinon.spy();
-    dispatch = navigationOperationMiddleware()(next);
-  });
-
-  it('should change `type` of PUSH action', () => {
-    dispatch({
-      type: ActionTypes.PUSH,
-      payload: {
-        pathname: '/foo',
-        search: '?bar=baz',
-        hash: '#qux',
-      },
-    });
-
-    expect(next).to.be.calledWith({
-      type: ActionTypes.NAVIGATE,
-      payload: {
-        operation: 'push',
-        location: {
-          pathname: '/foo',
-          search: '?bar=baz',
-          hash: '#qux',
-        },
-      },
-    });
-  });
-
-  it('should change `type` of REPLACE action', () => {
-    dispatch({
-      type: ActionTypes.REPLACE,
-      payload: {
-        pathname: '/foo',
-        search: '?bar=baz',
-        hash: '#qux',
-      },
-    });
-
-    expect(next).to.be.calledWith({
-      type: ActionTypes.NAVIGATE,
-      payload: {
-        operation: 'replace',
-        location: {
-          pathname: '/foo',
-          search: '?bar=baz',
-          hash: '#qux',
-        },
-      },
-    });
-  });
-
-  it('should not affect other action', () => {
-    const UNKNOWN = 'UNKNOWN';
-    dispatch({
-      type: UNKNOWN,
-      payload: {
-        pathname: '/foo',
-        search: '?bar=baz',
-        hash: '#qux',
-      },
-    });
-
-    expect(next).to.be.calledWith({
-      type: UNKNOWN,
-      payload: {
-        pathname: '/foo',
-        search: '?bar=baz',
-        hash: '#qux',
-      },
-    });
-  });
-});