@thoughtbot/superglue 0.53.3 → 0.54.0

package/index.js

@@ -1,265 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.updateFragments = exports.superglueReducer = exports.pageReducer = exports.mapDispatchToPropsIncludingVisitAndRemote = exports.getIn = exports.fragmentMiddleware = exports.UPDATE_FRAGMENTS = exports.SAVE_RESPONSE = exports.REMOVE_PAGE = exports.GRAFTING_SUCCESS = exports.GRAFTING_ERROR = exports.COPY_PAGE = exports.BEFORE_VISIT = exports.BEFORE_REMOTE = exports.BEFORE_FETCH = exports.ApplicationBase = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _urlParse = _interopRequireDefault(require("url-parse"));
-
-var _reducers = require("./reducers");
-
-exports.rootReducer = _reducers.rootReducer;
-exports.superglueReducer = _reducers.superglueReducer;
-exports.pageReducer = _reducers.pageReducer;
-exports.updateFragments = _reducers.updateFragments;
-
-var _config = require("./config");
-
-var _utils = require("./utils");
-
-exports.urlToPageKey = _utils.urlToPageKey;
-
-var _action_creators = require("./action_creators");
-
-var _actions = require("./actions");
-
-exports.HISTORY_CHANGE = _actions.HISTORY_CHANGE;
-exports.BEFORE_FETCH = _actions.BEFORE_FETCH;
-exports.BEFORE_VISIT = _actions.BEFORE_VISIT;
-exports.BEFORE_REMOTE = _actions.BEFORE_REMOTE;
-exports.SAVE_RESPONSE = _actions.SAVE_RESPONSE;
-exports.UPDATE_FRAGMENTS = _actions.UPDATE_FRAGMENTS;
-exports.COPY_PAGE = _actions.COPY_PAGE;
-exports.REMOVE_PAGE = _actions.REMOVE_PAGE;
-exports.GRAFTING_ERROR = _actions.GRAFTING_ERROR;
-exports.GRAFTING_SUCCESS = _actions.GRAFTING_SUCCESS;
-
-var _redux = require("redux");
-
-var _reduxThunk = _interopRequireDefault(require("redux-thunk"));
-
-var _reactRedux = require("react-redux");
-
-var _history = require("history");
-
-var _Nav = _interopRequireDefault(require("./components/Nav"));
-
-var _react2 = require("./utils/react");
-
-exports.mapStateToProps = _react2.mapStateToProps;
-exports.mapDispatchToProps = _react2.mapDispatchToProps;
-exports.mapDispatchToPropsIncludingVisitAndRemote = _react2.mapDispatchToPropsIncludingVisitAndRemote;
-
-var _middleware = require("./middleware");
-
-exports.fragmentMiddleware = _middleware.fragmentMiddleware;
-
-var _immutability = require("./utils/immutability");
-
-exports.getIn = _immutability.getIn;
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-function _inheritsLoose(subClass, superClass) { subClass.prototype = Object.create(superClass.prototype); subClass.prototype.constructor = subClass; _setPrototypeOf(subClass, superClass); }
-
-function _wrapNativeSuper(Class) { var _cache = typeof Map === "function" ? new Map() : undefined; _wrapNativeSuper = function _wrapNativeSuper(Class) { if (Class === null || !_isNativeFunction(Class)) return Class; if (typeof Class !== "function") { throw new TypeError("Super expression must either be null or a function"); } if (typeof _cache !== "undefined") { if (_cache.has(Class)) return _cache.get(Class); _cache.set(Class, Wrapper); } function Wrapper() { return _construct(Class, arguments, _getPrototypeOf(this).constructor); } Wrapper.prototype = Object.create(Class.prototype, { constructor: { value: Wrapper, enumerable: false, writable: true, configurable: true } }); return _setPrototypeOf(Wrapper, Class); }; return _wrapNativeSuper(Class); }
-
-function _construct(Parent, args, Class) { if (_isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
-
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-
-function _isNativeFunction(fn) { return Function.toString.call(fn).indexOf("[native code]") !== -1; }
-
-function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
-function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
-
-function pageToInitialState(key, page) {
-  var _pages;
-
-  var slices = page.slices || {};
-  return Object.assign({
-    pages: (_pages = {}, _pages[key] = page, _pages)
-  }, slices);
-}
-
-function start(_ref) {
-  var initialPage = _ref.initialPage,
-      _ref$baseUrl = _ref.baseUrl,
-      baseUrl = _ref$baseUrl === void 0 ? _config.config.baseUrl : _ref$baseUrl,
-      _ref$maxPages = _ref.maxPages,
-      maxPages = _ref$maxPages === void 0 ? _config.config.maxPages : _ref$maxPages,
-      path = _ref.path;
-  var initialPageKey = (0, _utils.urlToPageKey)((0, _urlParse["default"])(path).href);
-  var csrfToken = initialPage.csrfToken;
-  var location = (0, _urlParse["default"])(path);
-  _config.config.baseUrl = baseUrl;
-  _config.config.maxPages = maxPages;
-  return {
-    reducer: _reducers.rootReducer,
-    prepareStore: function prepareStore(store) {
-      store.dispatch({
-        type: _actions.HISTORY_CHANGE,
-        payload: {
-          pathname: location.pathname,
-          search: location.query,
-          hash: location.hash
-        }
-      });
-      store.dispatch((0, _action_creators.saveAndProcessPage)(initialPageKey, initialPage));
-      store.dispatch({
-        type: _actions.SET_CSRF_TOKEN,
-        payload: {
-          csrfToken: csrfToken
-        }
-      });
-    },
-    initialState: pageToInitialState(initialPageKey, initialPage),
-    initialPageKey: initialPageKey
-  };
-}
-
-var NotImplementedError = /*#__PURE__*/function (_Error) {
-  _inheritsLoose(NotImplementedError, _Error);
-
-  function NotImplementedError(message) {
-    var _this;
-
-    _this = _Error.call(this, message) || this;
-    _this.name = _this.constructor.name;
-    return _this;
-  }
-
-  return NotImplementedError;
-}( /*#__PURE__*/_wrapNativeSuper(Error));
-
-var ApplicationBase = exports.ApplicationBase = /*#__PURE__*/function (_React$Component) {
-  _inheritsLoose(ApplicationBase, _React$Component);
-
-  function ApplicationBase(props) {
-    var _this2$history;
-
-    var _this2;
-
-    _this2 = _React$Component.call(this, props) || this;
-    _this2.hasWindow = typeof window !== 'undefined'; // Create a navigator Ref for UJS attributes and to enhance the base `visit`
-    // and `visit` thunks
-
-    _this2.navigatorRef = /*#__PURE__*/_react["default"].createRef(); // Retrieve initial values and methods to prepare the store.
-
-    var _start = start({
-      initialPage: _this2.props.initialPage,
-      baseUrl: _this2.props.baseUrl,
-      path: _this2.props.path // The max number of pages to keep in the store. Default is 20
-      // maxPages: 20
-
-    }),
-        prepareStore = _start.prepareStore,
-        initialState = _start.initialState,
-        initialPageKey = _start.initialPageKey,
-        reducer = _start.reducer;
-
-    _this2.initialPageKey = initialPageKey; // Build the store and pass Superglue's provided reducer to be combined with
-    // your reducers located at `application_reducer.js`
-
-    _this2.store = _this2.buildStore(initialState, reducer); // Fire initial events and populate the store
-
-    prepareStore(_this2.store); // Build history
-
-    _this2.history = _this2.createHistory();
-
-    (_this2$history = _this2.history).replace.apply(_this2$history, (0, _utils.argsForHistory)(_this2.props.path));
-
-    var nextMapping = Object.assign({}, _this2.mapping());
-
-    for (var key in nextMapping) {
-      var component = nextMapping[key];
-      nextMapping[key] = (0, _reactRedux.connect)(_react2.mapStateToProps, _react2.mapDispatchToProps)(component);
-    }
-
-    _this2.connectedMapping = nextMapping; // Build visit and remote thunks
-    // Your modified `visit` and `remote` will get passed below to the
-    // Nav component then to your components
-    //
-    // You can access them via `this.props.visit` or `this.props.remote`. In
-    // your page components
-
-    var _this2$visitAndRemote = _this2.visitAndRemote(_this2.navigatorRef, _this2.store),
-        visit = _this2$visitAndRemote.visit,
-        remote = _this2$visitAndRemote.remote;
-
-    _this2.visit = visit;
-    _this2.remote = remote;
-    return _this2;
-  }
-
-  var _proto = ApplicationBase.prototype;
-
-  _proto.visitAndRemote = function visitAndRemote() {
-    throw new NotImplementedError('Implement this');
-  };
-
-  _proto.componentDidMount = function componentDidMount() {
-    var appEl = this.props.appEl; // Create the ujs event handlers. You can change the ujsAttributePrefix
-    // in the event the data attribute conflicts with another.
-
-    this.ujsHandlers = (0, _utils.ujsHandlers)({
-      visit: this.visit,
-      remote: this.remote,
-      store: this.store,
-      ujsAttributePrefix: 'data-sg'
-    });
-    var _this$ujsHandlers = this.ujsHandlers,
-        onClick = _this$ujsHandlers.onClick,
-        onSubmit = _this$ujsHandlers.onSubmit;
-    appEl.addEventListener('click', onClick);
-    appEl.addEventListener('submit', onSubmit);
-  };
-
-  _proto.componentWillUnmount = function componentWillUnmount() {
-    var appEl = this.props.appEl;
-    var _this$ujsHandlers2 = this.ujsHandlers,
-        onClick = _this$ujsHandlers2.onClick,
-        onSubmit = _this$ujsHandlers2.onSubmit;
-    appEl.removeEventListener('click', onClick);
-    appEl.removeEventListener('submit', onSubmit);
-  };
-
-  _proto.buildStore = function buildStore(initialState, reducer) {
-    var store = (0, _redux.createStore)((0, _redux.combineReducers)(reducer), initialState, (0, _redux.compose)((0, _redux.applyMiddleware)(_reduxThunk["default"])));
-    return store;
-  };
-
-  _proto.createHistory = function createHistory() {
-    if (this.hasWindow) {
-      // This is used for client side rendering
-      return (0, _history.createBrowserHistory)({});
-    } else {
-      // This is used for server side rendering
-      return (0, _history.createMemoryHistory)({});
-    }
-  };
-
-  _proto.mapping = function mapping() {
-    throw new NotImplementedError('Implement this');
-  };
-
-  _proto.render = function render() {
-    // The Nav component is pretty bare and can be inherited from for custom
-    // behavior or replaced with your own.
-    return /*#__PURE__*/_react["default"].createElement(_reactRedux.Provider, {
-      store: this.store
-    }, /*#__PURE__*/_react["default"].createElement(_Nav["default"], {
-      store: this.store,
-      ref: this.navigatorRef,
-      visit: this.visit,
-      remote: this.remote,
-      mapping: this.connectedMapping,
-      history: this.history,
-      initialPageKey: this.initialPageKey
-    }));
-  };
-
-  return ApplicationBase;
-}(_react["default"].Component);

package/middleware.js

@@ -1,78 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.fragmentMiddleware = void 0;
-
-var actions = _interopRequireWildcard(require("./actions"));
-
-var _immutability = require("./utils/immutability");
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-var actionValues = Object.values(actions);
-
-var fragmentMiddleware = exports.fragmentMiddleware = function fragmentMiddleware(store) {
-  return function (next) {
-    return function (action) {
-      var prevState = store.getState();
-      var nextAction = next(action);
-      var nextState = store.getState();
-
-      if (actionValues.includes(action.type)) {
-        return nextAction;
-      }
-
-      if (prevState.pages === nextState.pages) {
-        return nextAction;
-      }
-
-      var changedFragments = {};
-      var changedKeys = Object.keys(nextState.pages).filter(function (key) {
-        return prevState.pages[key] !== nextState.pages[key];
-      });
-
-      if (changedKeys.length === 0) {
-        return nextAction;
-      }
-
-      changedKeys.forEach(function (key) {
-        nextState.pages[key].fragments.forEach(function (fragment) {
-          var type = fragment.type,
-              path = fragment.path;
-          var nextPage = nextState.pages[key];
-          var prevPage = prevState.pages[key];
-          var nextFragment, prevFragment;
-
-          try {
-            prevFragment = (0, _immutability.getIn)(prevPage, path);
-            nextFragment = (0, _immutability.getIn)(nextPage, path);
-          } catch (err) {
-            if (err.name == 'KeyPathError') {
-              console.warn(err.message);
-            } else {
-              throw err;
-            }
-          }
-
-          if (nextFragment !== undefined && prevFragment !== undefined && nextFragment !== prevFragment && nextFragment) {
-            changedFragments[type] = nextFragment;
-          }
-        });
-      });
-
-      if (Object.keys(changedFragments).length === 0) {
-        return nextAction;
-      }
-
-      store.dispatch({
-        type: actions.UPDATE_FRAGMENTS,
-        payload: {
-          changedFragments: changedFragments
-        }
-      });
-      return nextAction;
-    };
-  };
-};

package/reducers/index.js

@@ -1,263 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.appendReceivedFragmentsOntoPage = appendReceivedFragmentsOntoPage;
-exports.graftNodeOntoPage = graftNodeOntoPage;
-exports.handleGraft = handleGraft;
-exports.metaReducer = metaReducer;
-exports.pageReducer = pageReducer;
-exports.rootReducer = void 0;
-exports.superglueReducer = superglueReducer;
-
-var _utils = require("../utils");
-
-var _actions = require("../actions");
-
-var _config = require("../config");
-
-function addPlaceholdersToDeferredNodes(existingPage, page) {
-  var _existingPage$defers = existingPage.defers,
-      defers = _existingPage$defers === void 0 ? [] : _existingPage$defers;
-  var prevDefers = defers.map(function (_ref) {
-    var path = _ref.path;
-    var node = (0, _utils.getIn)(existingPage, path);
-    var copy = JSON.stringify(node);
-    return [path, JSON.parse(copy)];
-  });
-  return prevDefers.reduce(function (memo, _ref2) {
-    var path = _ref2[0],
-        node = _ref2[1];
-    return (0, _utils.setIn)(page, path, node);
-  }, page);
-}
-
-function constrainPagesSize(state) {
-  var maxPages = _config.config.maxPages;
-  var allPageKeys = Object.keys(state);
-  var cacheTimesRecentFirst = allPageKeys.map(function (key) {
-    return state[key].savedAt;
-  }).sort(function (a, b) {
-    return b - a;
-  });
-
-  for (var _i = 0, _Array$from = Array.from(allPageKeys); _i < _Array$from.length; _i++) {
-    var key = _Array$from[_i];
-
-    if (state[key].savedAt <= cacheTimesRecentFirst[maxPages - 1]) {
-      delete state[key];
-    }
-  }
-}
-
-function saveResponse(state, pageKey, page) {
-  state = Object.assign({}, state);
-  page = Object.assign({
-    pageKey: pageKey,
-    fragments: []
-  }, page, {
-    savedAt: Date.now()
-  });
-  var existingPage = state[pageKey];
-
-  if (existingPage) {
-    page = addPlaceholdersToDeferredNodes(existingPage, page);
-  }
-
-  constrainPagesSize(state);
-  state[pageKey] = page;
-  return state;
-}
-
-function appendReceivedFragmentsOntoPage(state, pageKey, receivedFragments) {
-  if (!pageKey) {
-    return state;
-  }
-
-  if (receivedFragments.length === 0) {
-    return state;
-  }
-
-  var currentPage = state[pageKey];
-  var _currentPage$fragment = currentPage.fragments,
-      prevFragments = _currentPage$fragment === void 0 ? [] : _currentPage$fragment;
-  var nextFragments = [].concat(prevFragments);
-  var existingKeys = {};
-  prevFragments.forEach(function (frag) {
-    return existingKeys[frag.path] = true;
-  });
-  receivedFragments.forEach(function (frag) {
-    if (!existingKeys[frag.path]) {
-      nextFragments.push(frag);
-    }
-  });
-  var nextPage = Object.assign({}, currentPage, {
-    fragments: nextFragments
-  });
-  var nextState = Object.assign({}, state);
-  nextState[pageKey] = nextPage;
-  return nextState;
-}
-
-function graftNodeOntoPage(state, pageKey, node, pathToNode) {
-  if (!node) {
-    console.warn('There was no node returned in the response. Do you have the correct key path in your props_at?');
-    return state;
-  }
-
-  if (!pathToNode || !pageKey) {
-    return state;
-  }
-
-  var fullPathToNode = [pageKey, pathToNode].join('.');
-  return (0, _utils.setIn)(state, fullPathToNode, node);
-}
-
-function handleGraft(state, pageKey, page) {
-  var currentPage = state[pageKey];
-
-  if (!currentPage) {
-    var error = new Error("Superglue was looking for " + pageKey + " in your state, but could not find it in your mapping. Did you forget to pass in a valid pageKey to this.props.remote or this.props.visit?");
-    throw error;
-  }
-
-  var receivedNode = page.data,
-      pathToNode = page.path,
-      _page$fragments = page.fragments,
-      receivedFragments = _page$fragments === void 0 ? [] : _page$fragments;
-  return [function (nextState) {
-    return graftNodeOntoPage(nextState, pageKey, receivedNode, pathToNode);
-  }, function (nextState) {
-    return appendReceivedFragmentsOntoPage(nextState, pageKey, receivedFragments);
-  }].reduce(function (memo, fn) {
-    return fn(memo);
-  }, state);
-}
-
-function pageReducer(state, action) {
-  if (state === void 0) {
-    state = {};
-  }
-
-  switch (action.type) {
-    case _actions.SAVE_RESPONSE:
-      {
-        var _action$payload = action.payload,
-            pageKey = _action$payload.pageKey,
-            page = _action$payload.page;
-        return saveResponse(state, pageKey, page);
-      }
-
-    case _actions.HANDLE_GRAFT:
-      {
-        var _action$payload2 = action.payload,
-            _pageKey = _action$payload2.pageKey,
-            _page = _action$payload2.page;
-        return handleGraft(state, _pageKey, _page);
-      }
-
-    case _actions.UPDATE_FRAGMENTS:
-      {
-        var changedFragments = action.payload.changedFragments;
-        var nextState = state;
-        Object.entries(state).forEach(function (_ref3) {
-          var pageKey = _ref3[0],
-              page = _ref3[1];
-          page.fragments.forEach(function (fragment) {
-            var type = fragment.type,
-                path = fragment.path;
-            var changedNode = changedFragments[type];
-            var currentNode = (0, _utils.getIn)(nextState, pageKey + "." + path);
-
-            if (type in changedFragments && changedNode !== currentNode) {
-              var nextNode = JSON.parse(JSON.stringify(changedNode));
-              nextState = (0, _utils.setIn)(nextState, pageKey + "." + path, nextNode);
-            }
-          });
-        });
-        return nextState;
-      }
-
-    case _actions.COPY_PAGE:
-      {
-        var _nextState = Object.assign({}, state);
-
-        var _action$payload3 = action.payload,
-            from = _action$payload3.from,
-            to = _action$payload3.to;
-        _nextState[(0, _utils.urlToPageKey)(to)] = JSON.parse(JSON.stringify(_nextState[from]));
-        return _nextState;
-      }
-
-    case _actions.REMOVE_PAGE:
-      {
-        var _pageKey2 = action.payload.pageKey;
-
-        var _nextState2 = Object.assign({}, state);
-
-        delete _nextState2[_pageKey2];
-        return _nextState2;
-      }
-
-    default:
-      return state;
-  }
-}
-
-function metaReducer(state, action) {
-  if (state === void 0) {
-    state = {};
-  }
-
-  switch (action.type) {
-    case _actions.HISTORY_CHANGE:
-      {
-        var _action$payload4 = action.payload,
-            pathname = _action$payload4.pathname,
-            search = _action$payload4.search,
-            hash = _action$payload4.hash;
-        var currentPageKey = (0, _utils.urlToPageKey)(pathname + search);
-        return Object.assign({}, state, {
-          currentPageKey: currentPageKey,
-          pathname: pathname,
-          search: search,
-          hash: hash
-        });
-      }
-
-    case _actions.SAVE_RESPONSE:
-      {
-        var _action$payload$page = action.payload.page,
-            csrfToken = _action$payload$page.csrfToken,
-            assets = _action$payload$page.assets;
-        return Object.assign({}, state, {
-          csrfToken: csrfToken,
-          assets: assets
-        });
-      }
-
-    case _actions.SET_CSRF_TOKEN:
-      {
-        var _csrfToken = action.payload.csrfToken;
-        return Object.assign({}, state, {
-          csrfToken: _csrfToken
-        });
-      }
-
-    default:
-      return state;
-  }
-}
-
-function superglueReducer(state, action) {
-  if (state === void 0) {
-    state = {};
-  }
-
-  var meta = metaReducer(state, action);
-  return Object.assign({}, meta);
-}
-
-var rootReducer = exports.rootReducer = {
-  superglue: superglueReducer,
-  pages: pageReducer
-};

package/utils/helpers.js

@@ -1,38 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.argsForHistory = argsForHistory;
-exports.extractNodeAndPath = extractNodeAndPath;
-exports.isGraft = isGraft;
-
-var _url = require("./url");
-
-function isGraft(page) {
-  return page.action === 'graft';
-}
-
-function extractNodeAndPath(page) {
-  var node = page.data,
-      action = page.action,
-      pathToNode = page.path;
-
-  if (action === 'graft') {
-    return {
-      node: node,
-      pathToNode: pathToNode
-    };
-  } else {
-    var errMsg = 'Expected page to be a graft response rendered from node filtering.';
-    throw new Error(errMsg);
-  }
-}
-
-function argsForHistory(path) {
-  var pageKey = (0, _url.urlToPageKey)(path);
-  return [path, {
-    superglue: true,
-    pageKey: pageKey,
-    posX: 0,
-    posY: 0
-  }];
-}