navigation-stack 0.3.0 → 0.4.0

package/types/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "forceConsistentCasingInFileNames": true,
-    "lib": ["es2016"],
+    "lib": ["es2020", "dom"],
     "module": "commonjs",
     "strict": true,
     "types": [],

package/lib/cjs/LocationDataStorage.js

@@ -1,60 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _getLocationUrl = _interopRequireDefault(require("./getLocationUrl"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class LocationDataStorage {
-  constructor(environment, {
-    namespace
-  } = {}) {
-    this._environment = environment;
-    this._getFallbackLocationKey = _getLocationUrl.default;
-    this._stateKeyPrefix = namespace ? `${namespace}|` : '';
-  }
-  get(location, key) {
-    const stateKey = this._getStateKey(location, key);
-    try {
-      const value = this._environment.dataStorage.get(stateKey);
-      // === null is probably sufficient.
-      if (value === null) {
-        return undefined;
-      }
-
-      // We want to catch JSON parse errors in case someone separately threw
-      // junk into sessionStorage under our namespace.
-      return JSON.parse(value);
-    } catch (error) {
-      // Pretend that the entry doesn't exist.
-      return undefined;
-    }
-  }
-  set(location, key, value) {
-    const stateKey = this._getStateKey(location, key);
-    if (value === undefined) {
-      try {
-        this._environment.dataStorage.remove(stateKey);
-      } catch (error) {
-        // No need to handle errors here.
-      }
-      return;
-    }
-
-    // Unlike with read, we want to fail on invalid values here, since the
-    // value here is provided by the caller of this method.
-    const valueString = JSON.stringify(value);
-    try {
-      this._environment.dataStorage.set(stateKey, valueString);
-    } catch (error) {
-      // No need to handle errors here either. If it didn't work, it didn't
-      // work. We make no guarantees about actually saving the value.
-    }
-  }
-  _getStateKey(location, key) {
-    const locationKey = location.key || this._getFallbackLocationKey(location);
-    const keyPrefix = `${this._stateKeyPrefix}${locationKey}`;
-    return `${keyPrefix}|${key}`;
-  }
-}
-exports.default = LocationDataStorage;
-module.exports = exports.default;

package/lib/cjs/addBeforeLocationChangeListener.js

@@ -1,7 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _beforeLocationChangeListeners = require("./beforeLocationChangeListeners");
-exports.default = _beforeLocationChangeListeners.addBeforeLocationChangeListener;
-module.exports = exports.default;

package/lib/cjs/beforeLocationChangeListeners.js

@@ -1,51 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.addBeforeLocationChangeListener = addBeforeLocationChangeListener;
-exports.getBeforeLocationChangeListeners = getBeforeLocationChangeListeners;
-exports.removeAllBeforeLocationChangeListeners = removeAllBeforeLocationChangeListeners;
-exports.runBeforeLocationChangeListeners = runBeforeLocationChangeListeners;
-/* eslint-disable no-underscore-dangle */
-
-function getBeforeLocationChangeListeners(session) {
-  return session._beforeLocationChangeListenersList || [];
-}
-function addBeforeLocationChangeListenerToTheList(listener, session) {
-  if (!session._beforeLocationChangeListenersList) {
-    session._beforeLocationChangeListenersList = [];
-  }
-  session._beforeLocationChangeListenersList.push(listener);
-}
-function removeBeforeLocationChangeListenerFromTheList(listener, session) {
-  if (session._beforeLocationChangeListenersList) {
-    session._beforeLocationChangeListenersList = session._beforeLocationChangeListenersList.filter(_ => _ !== listener);
-  }
-}
-function removeAllBeforeLocationChangeListeners(session) {
-  session._beforeLocationChangeListenersList = [];
-}
-
-// Runs the `listener` while ignoring any errors that might be thrown by it.
-function runBeforeLocationChangeListener(listener, location) {
-  try {
-    listener(location);
-  } catch (error) {
-    // eslint-disable-next-line no-console
-    console.warn(`Ignoring before location change listener \`${listener.name}\` that failed with \`${error}\`.`);
-    // eslint-disable-next-line no-console
-    console.error(error);
-  }
-}
-
-// Runs all listeners in order.
-function runBeforeLocationChangeListeners(navigationListeners, toLocation) {
-  for (const listener of navigationListeners) {
-    runBeforeLocationChangeListener(listener, toLocation);
-  }
-}
-function addBeforeLocationChangeListener(session, listener) {
-  addBeforeLocationChangeListenerToTheList(listener, session);
-  return () => {
-    removeBeforeLocationChangeListenerFromTheList(listener, session);
-  };
-}

package/lib/cjs/createMiddlewares.js

@@ -1,47 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = createMiddlewares;
-var _createBasePathMiddleware = _interopRequireDefault(require("./middleware/createBasePathMiddleware"));
-var _createBeforeLocationChangeListenerMiddleware = _interopRequireDefault(require("./middleware/createBeforeLocationChangeListenerMiddleware"));
-var _createLocationMiddleware = _interopRequireDefault(require("./middleware/createLocationMiddleware"));
-var _createNavigationBlockerMiddleware = _interopRequireDefault(require("./middleware/createNavigationBlockerMiddleware"));
-var _navigationActionMiddleware = _interopRequireDefault(require("./middleware/navigationActionMiddleware"));
-var _normalizeInputLocationMiddleware = _interopRequireDefault(require("./middleware/normalizeInputLocationMiddleware"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function createMiddlewares(session, options) {
-  // Allows temporarily ignoring location update events.
-  let shouldIgnoreLocationSubscriptionEvents = false;
-  const ignoreLocationSubscriptionEvents = func => {
-    shouldIgnoreLocationSubscriptionEvents = true;
-    func();
-    shouldIgnoreLocationSubscriptionEvents = false;
-  };
-  return [
-  // Validates that the action "payload" (input location) is a proper `NormalizedInputLocation`.
-  _normalizeInputLocationMiddleware.default,
-  // Transforms a "PUSH" / "REPLACE" action into a "NAVIGATE" action.
-  _navigationActionMiddleware.default,
-  // If a website is hosted under a certain path (`basePath`)
-  // then this middleware will automatically strip that starting segment from the `pathname` of `location`s.
-  (0, _createBasePathMiddleware.default)(options && options.basePath),
-  // Allows blocking navigation.
-  // Handles `NAVIGATE` actions dispatched by the application itself.
-  (0, _createNavigationBlockerMiddleware.default)(session, {
-    ignoreLocationSubscriptionEvents
-  }),
-  // This "middleware" performs the actual navigation according to the `session` being used.
-  // For example, when `BrowserSession` is used, it calls methods of the `history` object.
-  (0, _createLocationMiddleware.default)(session, {
-    shouldIgnoreLocationSubscriptionEvents: () => shouldIgnoreLocationSubscriptionEvents
-  }),
-  // Allows blocking navigation.
-  // Handles location `UPDATE` actions dispatched in response to location update events.
-  (0, _createNavigationBlockerMiddleware.default)(session, {
-    ignoreLocationSubscriptionEvents
-  }),
-  // Allows subscribing to upcoming location changes
-  // before those changes are applied in the `location` object in the state.
-  (0, _createBeforeLocationChangeListenerMiddleware.default)(session)];
-}
-module.exports = exports.default;

package/lib/cjs/middleware/createBasePathMiddleware.js

@@ -1,24 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = createBasePathMiddleware;
-var _basePath = require("../basePath");
-var _createTransformLocationMiddleware = _interopRequireDefault(require("./createTransformLocationMiddleware"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// Creates a "middleware" that, when a website is hosted under a certain path (`basePath`),
-// automatically strips that starting segment from the `pathname` of `location`s.
-function createBasePathMiddleware(basePath) {
-  return (0, _createTransformLocationMiddleware.default)({
-    // Transforms input `Location`:
-    // prepends `basePath` to the URL.
-    transformInputLocation: location => {
-      return (0, _basePath.addBasePath)(location, basePath);
-    },
-    // Transforms subscription `Location` object:
-    // removes `basePath` from the URL.
-    transformSubscriptionLocation: location => {
-      return (0, _basePath.removeBasePath)(location, basePath);
-    }
-  });
-}
-module.exports = exports.default;

package/lib/cjs/middleware/createBeforeLocationChangeListenerMiddleware.js

@@ -1,39 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = createBeforeLocationChangeListenerMiddleware;
-var _ActionTypes = _interopRequireDefault(require("../ActionTypes"));
-var _beforeLocationChangeListeners = require("../beforeLocationChangeListeners");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// Creates a "middleware" that calls upcoming navigation listeners.
-function createBeforeLocationChangeListenerMiddleware(session) {
-  return function navigationListenerMiddleware() {
-    return next => action => {
-      const {
-        type,
-        payload
-      } = action;
-      switch (type) {
-        // Trigger navigation listeners before the `location` has been updated in Redux state.
-        // It doesn't matter that the new location URL has already been updated in the web browser's
-        // address bar, or that the web browser's history has already switched to the new locaiton.
-        // From the application's point of view, all of that doesn't matter and even doesn't exist.
-        // All that exists from the application's point of view is the `location` object in the Redux state.
-        // Until the `location` object in the Redux state is updated, the old page is still rendered.
-        // The appliation is only concerned with the updates of the `location` object in the Redux state
-        // and completely ignores any updates to the URL in the web browser's address bar.
-        case _ActionTypes.default.UPDATE:
-          (0, _beforeLocationChangeListeners.runBeforeLocationChangeListeners)((0, _beforeLocationChangeListeners.getBeforeLocationChangeListeners)(session), payload);
-          return next(action);
-
-        // Remove any navigation listeners on `DISPOSE` event.
-        case _ActionTypes.default.DISPOSE:
-          (0, _beforeLocationChangeListeners.removeAllBeforeLocationChangeListeners)(session);
-          return next(action);
-        default:
-          return next(action);
-      }
-    };
-  };
-}
-module.exports = exports.default;

package/lib/cjs/middleware/createLocationMiddleware.js

@@ -1,56 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = createLocationMiddleware;
-var _ActionTypes = _interopRequireDefault(require("../ActionTypes"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function updateLocation(location) {
-  return {
-    type: _ActionTypes.default.UPDATE,
-    payload: location
-  };
-}
-
-// Creates a "middleware" that performs the actual navigation according to the `session` being used.
-// For example, when `BrowserSession` is used, it calls methods of the `window.history` object.
-function createLocationMiddleware(session, {
-  shouldIgnoreLocationSubscriptionEvents
-}) {
-  return function locationMiddleware() {
-    return next => {
-      // Whenever browser location changes,
-      // perform the same changes with the internal `location` object.
-      const unsubscribe = session.navigation.subscribe(location => {
-        if (!shouldIgnoreLocationSubscriptionEvents()) {
-          next(updateLocation(location));
-        }
-      });
-      return action => {
-        const {
-          type,
-          payload
-        } = action;
-        switch (type) {
-          case _ActionTypes.default.INIT:
-            return next(updateLocation(session.navigation.init()));
-          case _ActionTypes.default.NAVIGATE:
-            // `session.navigate()` doesn't trigger the `subscribe()` listener.
-            return next(updateLocation(session.navigation.navigate(payload)));
-          case _ActionTypes.default.SHIFT:
-            // `shift()` will trigger the `subscribe()` listener,
-            // which will call `updateLocation()`.
-            session.navigation.shift(payload);
-            // eslint-disable-next-line consistent-return
-            return;
-          case _ActionTypes.default.DISPOSE:
-            unsubscribe();
-            // eslint-disable-next-line consistent-return
-            return;
-          default:
-            return next(action);
-        }
-      };
-    };
-  };
-}
-module.exports = exports.default;

package/lib/cjs/middleware/createNavigationBlockerMiddleware.js

@@ -1,161 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = createNavigationBlockerMiddleware;
-var _ActionTypes = _interopRequireDefault(require("../ActionTypes"));
-var _isPromise = _interopRequireDefault(require("../isPromise"));
-var _navigationBlockers = require("../navigationBlockers");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// Creates a "middleware" that applies navigation blockers.
-function createNavigationBlockerMiddleware(session, {
-  ignoreLocationSubscriptionEvents
-}) {
-  function createNavigationBlockersEvaluationStatus() {
-    /* eslint-disable no-underscore-dangle */
-    if (session._navigationBlockersEvaluationStatus) {
-      session._navigationBlockersEvaluationStatus.cancelled = true;
-    }
-    session._navigationBlockersEvaluationStatus = {
-      cancelled: false
-    };
-    return session._navigationBlockersEvaluationStatus;
-  }
-  return function navigationBlockerMiddleware() {
-    return next => action => {
-      const {
-        type,
-        payload
-      } = action;
-
-      // Declaring `result` variable here fixes ESLint error:
-      // "Unexpected lexical declaration in case block".
-      let result;
-      switch (type) {
-        // Prevent or allow navigation that was initiated by the application
-        // by dispatching a `.push()` or `.replace()` action.
-        //
-        // It doesn't handle `.shift()` navigation actions because it doesn't yet know
-        // the `location` that it's gonna `shift` to. Instead, it waits for the web browser
-        // to "shift" to that `location` and then reads it and rewinds the "shift"
-        // if it should've been blocked. That is handled in the `case ActionTypes.UPDATE` block.
-        //
-        // This type of "shifting" and then rewinding the "shift" doesn't really matter to the application at all.
-        // From the application's point of view, all of that doesn't matter and even doesn't exist.
-        // All that exists from the application's point of view is the `location` object in the Redux state.
-        // Until the `location` object in the Redux state is updated, the old page is still rendered.
-        // The appliation is only concerned with the updates of the `location` object in the Redux state
-        // and completely ignores any updates to the URL in the web browser's address bar.
-        //
-        case _ActionTypes.default.NAVIGATE:
-          // `resultValue` variable name works around a stupid javascript error:
-          // "Cannot redeclare block-scoped variable 'result'".
-          result = (0, _navigationBlockers.runNavigationBlockers)((0, _navigationBlockers.getNavigationBlockers)(session), payload);
-          if ((0, _isPromise.default)(result)) {
-            const status = createNavigationBlockersEvaluationStatus();
-            // eslint-disable-next-line consistent-return
-            result.then(resultValue => {
-              if (!status.cancelled) {
-                if (!resultValue) {
-                  return next(action);
-                }
-              }
-            });
-          } else if (!result) {
-            return next(action);
-          }
-          // eslint-disable-next-line consistent-return
-          return;
-
-        // One can notice that this "middleware" handles both `NAVIGATE` and `UPDATE` Redux actions,
-        // even though a `NAVIGATE` action normally always causes a follow-up `UPDATE` Redux action.
-        // There's no contradiction here: if a navigation blocker should block a certain navigation,
-        // it will do that at the `NAVIGATION` stage and it won't get to the `UPDATE` stage, so it
-        // won't be called "second time" or something like that.
-        //
-        // One could ask then: Why handle `UPDATE` Redux action at all?
-        // The reason why it handles `UPDATE` Redux actions here is because
-        // `NAVIGATE` Redux actions are only emitted for programmatic "push" or "replace" navigation
-        // initiated by the application code, and there're other cases of navigation such as
-        // programmatic "shift" navigation or when the user manually clicks "Back" or "Forward" button
-        // in a web browser. Such "other" cases could only be handled by reacting to an `UPDATE` Redux action
-        // which is only emitted after the URL in the browser's address bar has changed.
-        //
-        // But there's no real drawback in reacting to an `UPDATE` Redux action "post factum" because
-        // from the application's point of view the address bar doesn't matter and even doesn't exist.
-        // All that exists from the application's point of view is the `location` object in the Redux state.
-        // Until the `location` object in the Redux state is updated, the old page is still rendered.
-        // The appliation is only concerned with the updates of the `location` object in the Redux state
-        // and completely ignores any updates to the URL in the web browser's address bar.
-        //
-        // So here, the "middleware" attempts to prevent or allow navigation that has already happened
-        // in the web browser's address bar but hasn't yet happened in Redux state.
-        // For example, it could be a user clicking a "Back"/"Forward" button in their web browser.
-        // If such navigation should've been blocked, it will simply not update the `locaiton` object in Redux state,
-        // and it will also "rewind" the change of the URL in the web browser's address bar so that it's consistent
-        // with the `location` in Redux state.
-        //
-        case _ActionTypes.default.UPDATE:
-          // If no navigation blockers to run, don't do anything.
-          if ((0, _navigationBlockers.getNavigationBlockers)(session).length === 0) {
-            return next(action);
-          }
-
-          // If it was the initial page load or a redirect,
-          // it's not really a navigation that could be rolled back.
-          if (payload.delta === 0) {
-            return next(action);
-          }
-
-          // It's not really possible for a location to not have a `delta` property in a web browser session.
-          // So this case is not something that's supposed to happen in real life.
-          // Rather, it's a guard against an unsupported or incorrect session implementation or something like that.
-          // If there's no `delta` property on the location, it means that the previous location can't be rewound to,
-          // so it can't really "prevent" the navigation that has just happened.
-          if (payload.delta === null) {
-            return next(action);
-          }
-          result = (0, _navigationBlockers.runNavigationBlockers)((0, _navigationBlockers.getNavigationBlockers)(session), payload);
-          if ((0, _isPromise.default)(result)) {
-            const status = createNavigationBlockersEvaluationStatus();
-
-            // While location blockers are running, rewind to the previous location.
-            ignoreLocationSubscriptionEvents(() => {
-              session.navigation.shift(-payload.delta);
-            });
-            result.then(promiseResult => {
-              if (promiseResult) {
-                // Navigation blocked.
-                // Already rewound to a previous location.
-              } else if (!status.cancelled) {
-                // Navigation not blocked.
-                // Rewind back to the new location.
-                ignoreLocationSubscriptionEvents(() => {
-                  session.navigation.shift(payload.delta);
-                });
-                // Update the location.
-                next(action);
-              }
-            });
-          } else if (result) {
-            // Prevent the navigation: rewind to the previous location.
-            ignoreLocationSubscriptionEvents(() => {
-              session.navigation.shift(-payload.delta);
-            });
-          } else {
-            // Update the location.
-            return next(action);
-          }
-          // eslint-disable-next-line consistent-return
-          return;
-
-        // Remove any navigation blockers on `DISPOSE` event.
-        case _ActionTypes.default.DISPOSE:
-          (0, _navigationBlockers.removeAllNavigationBlockers)(session);
-          return next(action);
-        default:
-          return next(action);
-      }
-    };
-  };
-}
-module.exports = exports.default;

package/lib/cjs/middleware/createTransformLocationMiddleware.js

@@ -1,38 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = createTransformLocationMiddleware;
-var _ActionTypes = _interopRequireDefault(require("../ActionTypes"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// Creates a "middleware" that transforms action payload (location).
-function createTransformLocationMiddleware({
-  transformInputLocation,
-  transformSubscriptionLocation
-}) {
-  return function transformLocationMiddleware() {
-    return next => action => {
-      const {
-        type,
-        payload
-      } = action;
-      switch (type) {
-        // Transforms `NAVIGATE` action payload (`location`).
-        case _ActionTypes.default.NAVIGATE:
-          return next({
-            type,
-            payload: transformInputLocation(payload)
-          });
-
-        // Transforms `UPDATE` action payload (input `location`).
-        case _ActionTypes.default.UPDATE:
-          return next({
-            type,
-            payload: transformSubscriptionLocation(payload)
-          });
-        default:
-          return next(action);
-      }
-    };
-  };
-}
-module.exports = exports.default;

package/lib/cjs/onlyAllowedOnClientSide.js

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = onlyAllowedOnClientSide;
-function onlyAllowedOnClientSide() {
-  if (typeof window === 'undefined') {
-    throw new Error('This function can only be called on client side');
-  }
-}
-module.exports = exports.default;