react-relay 2.0.0-rc.2 → 5.0.0

package/lib/RelayRenderer.js

@@ -1,268 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * 
- * @format
- */
-'use strict';
-
-var _objectSpread2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/objectSpread"));
-
-var _inheritsLoose2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/inheritsLoose"));
-
-var _assertThisInitialized2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/assertThisInitialized"));
-
-var _defineProperty2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/defineProperty"));
-
-var INACTIVE_READY_STATE = {
-  aborted: false,
-  done: false,
-  error: null,
-  events: [],
-  ready: false,
-  stale: false
-};
-/**
- * @public
- *
- * RelayRenderer renders a container and query config after fulfilling its data
- * dependencies. Precise rendering behavior is configured via the `render` prop
- * which takes a callback.
- *
- * The container created using `Relay.createContainer` must be supplied via the
- * `Container` prop, and the query configuration that conforms to the shape of a
- * `RelayQueryConfig` must be supplied via the `queryConfig` prop.
- *
- * === Render Callback ===
- *
- * The `render` callback is called with an object with the following properties:
- *
- *   props: ?{[propName: string]: mixed}
- *     If present, sufficient data is ready to render the container. This object
- *     must be spread into the container using the spread attribute operator. If
- *     absent, there is insufficient data to render the container.
- *
- *   done: boolean
- *     Whether all data dependencies have been fulfilled. If `props` is present
- *     but `done` is false, then sufficient data is ready to render, but some
- *     data dependencies have not yet been fulfilled.
- *
- *   error: ?Error
- *     If present, an error occurred while fulfilling data dependencies. If
- *     `props` and `error` are both present, then sufficient data is ready to
- *     render, but an error occurred while fulfilling deferred dependencies.
- *
- *   retry: ?Function
- *     A function that can be called to re-attempt to fulfill data dependencies.
- *     This property is only present if an `error` has occurred.
- *
- *   stale: boolean
- *     When `forceFetch` is enabled, a request is always made to fetch updated
- *     data. However, if all data dependencies can be immediately fulfilled, the
- *     `props` property will be present. In this case, `stale` will be true.
- *
- * The `render` callback can return `undefined` to continue rendering the last
- * view rendered (e.g. when transitioning from one `queryConfig` to another).
- *
- * If a `render` callback is not supplied, the default behavior is to render the
- * container if data is available, the existing view if one exists, or nothing.
- *
- * === Refs ===
- *
- * References to elements rendered by the `render` callback can be obtained by
- * using the React `ref` prop. For example:
- *
- *   <FooComponent {...props} ref={handleFooRef} />
- *
- *   function handleFooRef(component) {
- *     // Invoked when `<FooComponent>` is mounted or unmounted. When mounted,
- *     // `component` will be the component. When unmounted, `component` will
- *     // be null.
- *   }
- *
- */
-
-var RelayRenderer =
-/*#__PURE__*/
-function (_React$Component) {
-  (0, _inheritsLoose2["default"])(RelayRenderer, _React$Component);
-
-  function RelayRenderer(props, context) {
-    var _this;
-
-    _this = _React$Component.call(this, props, context) || this;
-    _this.mounted = true;
-    _this.pendingRequest = null;
-    _this.state = {
-      active: false,
-      readyState: null,
-      retry: _this._retry.bind((0, _assertThisInitialized2["default"])((0, _assertThisInitialized2["default"])(_this)))
-    };
-    return _this;
-  }
-
-  var _proto = RelayRenderer.prototype;
-
-  _proto.componentDidMount = function componentDidMount() {
-    this._validateProps(this.props);
-
-    this._runQueries(this.props);
-  };
-  /**
-   * @private
-   */
-
-
-  _proto._validateProps = function _validateProps(props) {
-    var error = RelayRenderer.propTypes.Container(props, 'Container', 'RelayRenderer');
-
-    if (error) {
-      throw error;
-    }
-  };
-  /**
-   * @private
-   */
-
-
-  _proto._runQueries = function _runQueries(_ref) {
-    var _this2 = this;
-
-    var Container = _ref.Container,
-        forceFetch = _ref.forceFetch,
-        onForceFetch = _ref.onForceFetch,
-        onPrimeCache = _ref.onPrimeCache,
-        queryConfig = _ref.queryConfig,
-        environment = _ref.environment,
-        shouldFetch = _ref.shouldFetch;
-
-    if (!shouldFetch) {
-      return;
-    }
-
-    var onReadyStateChange = function onReadyStateChange(readyState) {
-      if (!_this2.mounted) {
-        _this2._handleReadyStateChange((0, _objectSpread2["default"])({}, readyState, {
-          mounted: false
-        }));
-
-        return;
-      }
-
-      if (request !== _this2.lastRequest) {
-        // Ignore (abort) ready state if we have a new pending request.
-        return;
-      }
-
-      if (readyState.aborted || readyState.done || readyState.error) {
-        _this2.pendingRequest = null;
-      }
-
-      _this2.setState({
-        active: true,
-        readyState: (0, _objectSpread2["default"])({}, readyState, {
-          mounted: true
-        })
-      });
-    };
-
-    if (this.pendingRequest) {
-      this.pendingRequest.abort();
-    }
-
-    var querySet = require("./getRelayQueries")(Container, queryConfig);
-
-    var request = this.pendingRequest = forceFetch ? onForceFetch ? onForceFetch(querySet, onReadyStateChange) : environment.forceFetch(querySet, onReadyStateChange) : onPrimeCache ? onPrimeCache(querySet, onReadyStateChange) : environment.primeCache(querySet, onReadyStateChange);
-    this.lastRequest = request;
-  };
-  /**
-   * @private
-   */
-
-
-  _proto._retry = function _retry() {
-    var readyState = this.state.readyState;
-
-    if (readyState && readyState.error) {
-      this._runQueries(this.props);
-
-      this.setState({
-        readyState: null
-      });
-    }
-  };
-
-  _proto.UNSAFE_componentWillReceiveProps = function UNSAFE_componentWillReceiveProps(nextProps) {
-    if (nextProps.Container !== this.props.Container || nextProps.environment !== this.props.environment || nextProps.queryConfig !== this.props.queryConfig || nextProps.shouldFetch !== this.props.shouldFetch || nextProps.forceFetch && !this.props.forceFetch) {
-      this._validateProps(nextProps);
-
-      this._runQueries(nextProps);
-
-      this.setState({
-        readyState: null
-      });
-    }
-  };
-
-  _proto.componentDidUpdate = function componentDidUpdate(prevProps, prevState) {
-    // `prevState` should exist; the truthy check is for Flow soundness.
-    var readyState = this.state.readyState;
-
-    if (readyState) {
-      if (!prevState || readyState !== prevState.readyState) {
-        this._handleReadyStateChange(readyState);
-      }
-    }
-  };
-  /**
-   * @private
-   */
-
-
-  _proto._handleReadyStateChange = function _handleReadyStateChange(readyState) {
-    var onReadyStateChange = this.props.onReadyStateChange;
-
-    if (onReadyStateChange) {
-      onReadyStateChange(readyState);
-    }
-  };
-
-  _proto.componentWillUnmount = function componentWillUnmount() {
-    if (this.pendingRequest) {
-      this.pendingRequest.abort();
-    }
-
-    this.mounted = false;
-  };
-
-  _proto.render = function render() {
-    var readyState = this.state.active ? this.state.readyState : INACTIVE_READY_STATE;
-    return require("react").createElement(require("./RelayReadyStateRenderer"), {
-      Container: this.props.Container,
-      environment: this.props.environment,
-      queryConfig: this.props.queryConfig,
-      readyState: readyState,
-      render: this.props.render,
-      retry: this.state.retry
-    });
-  };
-
-  return RelayRenderer;
-}(require("react").Component);
-
-(0, _defineProperty2["default"])(RelayRenderer, "propTypes", {
-  Container: require("./RelayPropTypes").Container,
-  forceFetch: require("prop-types").bool,
-  onReadyStateChange: require("prop-types").func,
-  queryConfig: require("./RelayPropTypes").QueryConfig.isRequired,
-  environment: require("./RelayPropTypes").Environment,
-  render: require("prop-types").func,
-  shouldFetch: require("prop-types").bool
-});
-(0, _defineProperty2["default"])(RelayRenderer, "defaultProps", {
-  shouldFetch: true
-});
-module.exports = RelayRenderer;

package/lib/RelayRootContainer.js

@@ -1,125 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * 
- * @format
- */
-'use strict';
-
-/**
- * @public
- *
- * RelayRootContainer sends requests for data required to render the supplied
- * `Component` and `route`. The `Component` must be a container created using
- * `Relay.createContainer`.
- *
- * === Render Callbacks ===
- *
- * Whenever the RelayRootContainer renders, one of three render callback props
- * are invoked depending on whether data is being loaded, can be resolved, or if
- * an error is incurred.
- *
- *  ReactDOM.render(
- *    <RelayRootContainer
- *      Component={FooComponent}
- *      route={fooRoute}
- *      renderLoading={function() {
- *        return <View>Loading...</View>;
- *      }}
- *      renderFetched={function(data) {
- *        // Must spread `data` into <FooComponent>.
- *        return <FooComponent {...data} />;
- *      }}
- *      renderFailure={function(error) {
- *        return <View>Error: {error.message}</View>;
- *      }}
- *    />,
- *    ...
- *  );
- *
- * If a callback is not supplied, it has a default behavior:
- *
- *  - Without `renderFetched`, `Component` will be rendered with fetched data.
- *  - Without `renderFailure`, an error will render to null.
- *  - Without `renderLoading`, the existing view will continue to render. If
- *    this is the initial mount (with no existing view), renders to null.
- *
- * In addition, supplying a `renderLoading` that returns undefined has the same
- * effect as not supplying the callback. (Usually, an undefined return value is
- * an error in React).
- *
- * === Refs ===
- *
- * References to elements rendered by any of these callbacks can be obtained by
- * using the React `ref` prop. For example:
- *
- *   <FooComponent {...data} ref={handleFooRef} />
- *
- *   function handleFooRef(component) {
- *     // Invoked when `<FooComponent>` is mounted or unmounted. When mounted,
- *     // `component` will be the component. When unmounted, `component` will
- *     // be null.
- *   }
- *
- */
-function RelayRootContainer(_ref) {
-  var Component = _ref.Component,
-      forceFetch = _ref.forceFetch,
-      onReadyStateChange = _ref.onReadyStateChange,
-      renderFailure = _ref.renderFailure,
-      renderFetched = _ref.renderFetched,
-      renderLoading = _ref.renderLoading,
-      route = _ref.route,
-      shouldFetch = _ref.shouldFetch;
-  return require("react").createElement(require("./RelayRenderer"), {
-    Container: Component,
-    forceFetch: forceFetch,
-    onReadyStateChange: onReadyStateChange,
-    queryConfig: route,
-    environment: require("./RelayStore"),
-    shouldFetch: shouldFetch,
-    render: function render(_ref2) {
-      var done = _ref2.done,
-          error = _ref2.error,
-          props = _ref2.props,
-          retry = _ref2.retry,
-          stale = _ref2.stale;
-
-      if (error) {
-        if (renderFailure) {
-          return renderFailure(error, retry);
-        }
-      } else if (props) {
-        if (renderFetched) {
-          return renderFetched(props, {
-            done: done,
-            stale: stale
-          });
-        } else {
-          return require("react").createElement(Component, props);
-        }
-      } else {
-        if (renderLoading) {
-          return renderLoading();
-        }
-      }
-
-      return undefined;
-    }
-  });
-}
-
-RelayRootContainer.propTypes = {
-  Component: require("./RelayPropTypes").Container,
-  forceFetch: require("prop-types").bool,
-  onReadyStateChange: require("prop-types").func,
-  renderFailure: require("prop-types").func,
-  renderFetched: require("prop-types").func,
-  renderLoading: require("prop-types").func,
-  route: require("./RelayPropTypes").QueryConfig.isRequired,
-  shouldFetch: require("prop-types").bool
-};
-module.exports = RelayRootContainer;

package/lib/RelayRoute.js

@@ -1,92 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * 
- * @format
- */
-'use strict';
-
-var _inheritsLoose2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/inheritsLoose"));
-
-var _assertThisInitialized2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/assertThisInitialized"));
-
-var createURI = function createURI() {
-  return null;
-};
-/**
- * Describes the root queries, param definitions and other metadata for a given
- * path (URI).
- */
-
-
-var RelayRoute =
-/*#__PURE__*/
-function (_RelayQueryConfig) {
-  (0, _inheritsLoose2["default"])(RelayRoute, _RelayQueryConfig);
-
-  function RelayRoute(initialVariables, uri) {
-    var _this;
-
-    _this = _RelayQueryConfig.call(this, initialVariables) || this;
-    var constructor = _this.constructor;
-    var routeName = constructor.routeName,
-        path = constructor.path;
-    !(constructor !== RelayRoute) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRoute: Abstract class cannot be instantiated.') : require("fbjs/lib/invariant")(false) : void 0;
-    !routeName ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, '%s: Subclasses of RelayRoute must define a `routeName`.', constructor.name || '<<anonymous>>') : require("fbjs/lib/invariant")(false) : void 0; // $FlowIssue #9905535 - Object.defineProperty doesn't understand getters
-
-    Object.defineProperty((0, _assertThisInitialized2["default"])((0, _assertThisInitialized2["default"])(_this)), 'uri', {
-      enumerable: true,
-      get: function get() {
-        if (!uri && path) {
-          uri = createURI(constructor, this.params);
-        }
-
-        return uri;
-      }
-    });
-    return _this;
-  }
-
-  var _proto = RelayRoute.prototype;
-
-  _proto.prepareVariables = function prepareVariables(prevVariables) {
-    var _this$constructor = this.constructor,
-        paramDefinitions = _this$constructor.paramDefinitions,
-        prepareParams = _this$constructor.prepareParams,
-        routeName = _this$constructor.routeName;
-    var params = prevVariables;
-
-    if (prepareParams) {
-      /* $FlowFixMe(>=0.17.0) - params is ?Tv but prepareParams expects Tv */
-      params = prepareParams(params);
-    }
-
-    if (paramDefinitions) {
-      require("fbjs/lib/forEachObject")(paramDefinitions, function (paramDefinition, paramName) {
-        if (params) {
-          if (params.hasOwnProperty(paramName)) {
-            return;
-          } else {
-            // Backfill param so that a call variable is created for it.
-            params[paramName] = undefined;
-          }
-        }
-
-        !!paramDefinition.required ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRoute: Missing required parameter `%s` in `%s`. Check the ' + 'supplied params or URI.', paramName, routeName) : require("fbjs/lib/invariant")(false) : void 0;
-      });
-    }
-
-    return params;
-  };
-
-  RelayRoute.injectURICreator = function injectURICreator(creator) {
-    createURI = creator;
-  };
-
-  return RelayRoute;
-}(require("./RelayQueryConfig"));
-
-module.exports = RelayRoute;

package/lib/RelayRouteFragment.js

@@ -1,44 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- *  strict-local
- * @format
- */
-'use strict';
-
-/**
- * Represents a query fragment that is conditional upon the active route as a
- * function that returns either a literal fragment or a fragment reference.
- *
- * Example GraphQL:
- *
- * ```
- * Node {
- *   ${(route) => matchRoute(route, ...)}
- * }
- * ```
- */
-var RelayRouteFragment =
-/*#__PURE__*/
-function () {
-  function RelayRouteFragment(builder) {
-    this._builder = builder;
-  }
-  /**
-   * Returns the query fragment that matches the given route, if any.
-   */
-
-
-  var _proto = RelayRouteFragment.prototype;
-
-  _proto.getFragmentForRoute = function getFragmentForRoute(route) {
-    return this._builder(route);
-  };
-
-  return RelayRouteFragment;
-}();
-
-module.exports = RelayRouteFragment;