react-relay 2.0.0-rc.2 → 5.0.0

package/lib/RelayFragmentReference.js

@@ -1,249 +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"));
-
-/**
- * @internal
- *
- * RelayFragmentReference is the return type of fragment composition:
- *
- *   fragment on Foo {
- *     ${Child.getFragment('bar', {baz: variables.qux})}
- *   }
- *
- * Whereas a fragment defines a sub-query's structure, a fragment reference is
- * a particular instantiation of the fragment as it is composed within a query
- * or another fragment. It encodes the source fragment, initial variables, and
- * a mapping from variables in the composing query's (or fragment's) scope to
- * variables in the fragment's scope.
- *
- * The variable mapping is represented by `variableMapping`, a dictionary that
- * maps from names of variables in the parent scope to variables that exist in
- * the fragment. Example:
- *
- * ```
- * // Fragment:
- * var Container = Relay.createContainer(..., {
- *   initialVariables: {
- *     private: 'foo',
- *     public: 'bar',
- *     variable: null,
- *   },
- *   fragments: {
- *     foo: ...
- *   }
- * });
- *
- * // Reference:
- * ${Container.getQuery(
- *   'foo',
- *   // Variable Mapping:
- *   {
- *     public: 'BAR',
- *     variable: variables.source,
- *   }
- * )}
- * ```
- *
- * When evaluating the referenced fragment, `$public` will be overridden with
- * `'Bar'`. The value of `$variable` will become the value of `$source` in the
- * outer scope. This is analagous to:
- *
- * ```
- * function inner(private = 'foo', public = 'bar', variable) {}
- * function outer(source) {
- *   inner(public = 'BAR', variable = source);
- * }
- * ```
- *
- * Where the value of the inner `variable` depends on how `outer` is called.
- *
- * The `prepareVariables` function allows for variables to be modified based on
- * the runtime environment or route name.
- */
-var RelayFragmentReference =
-/*#__PURE__*/
-function () {
-  RelayFragmentReference.createForContainer = function createForContainer(fragmentGetter, initialVariables, variableMapping, prepareVariables) {
-    var reference = new RelayFragmentReference(fragmentGetter, initialVariables, variableMapping, prepareVariables);
-    reference._isContainerFragment = true;
-    return reference;
-  };
-
-  function RelayFragmentReference(fragmentGetter, initialVariables, variableMapping, prepareVariables) {
-    this._conditions = null;
-    this._initialVariables = initialVariables || {};
-    this._fragment = undefined;
-    this._fragmentGetter = fragmentGetter;
-    this._isContainerFragment = false;
-    this._isDeferred = false;
-    this._isTypeConditional = false;
-    this._variableMapping = variableMapping;
-    this._prepareVariables = prepareVariables;
-  }
-
-  var _proto = RelayFragmentReference.prototype;
-
-  _proto.conditionOnType = function conditionOnType() {
-    this._isTypeConditional = true;
-    return this;
-  };
-
-  _proto.getConditions = function getConditions() {
-    return this._conditions;
-  };
-
-  _proto.getFragmentUnconditional = function getFragmentUnconditional() {
-    var fragment = this._fragment;
-
-    if (fragment == null) {
-      fragment = this._fragmentGetter();
-      this._fragment = fragment;
-    }
-
-    return fragment;
-  };
-
-  _proto.getInitialVariables = function getInitialVariables() {
-    return this._initialVariables;
-  };
-
-  _proto.getVariableMapping = function getVariableMapping() {
-    return this._variableMapping;
-  };
-  /**
-   * Mark this usage of the fragment as deferred.
-   */
-
-
-  _proto.defer = function defer() {
-    this._isDeferred = true;
-    return this;
-  };
-  /**
-   * Mark this fragment for inclusion only if the given variable is truthy.
-   */
-
-
-  _proto["if"] = function _if(value) {
-    var callVariable = require("./QueryBuilder").getCallVariable(value);
-
-    !callVariable ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayFragmentReference: Invalid value `%s` supplied to `if()`. ' + 'Expected a variable.', callVariable) : require("fbjs/lib/invariant")(false) : void 0;
-
-    this._addCondition({
-      passingValue: true,
-      variable: callVariable.callVariableName
-    });
-
-    return this;
-  };
-  /**
-   * Mark this fragment for inclusion only if the given variable is falsy.
-   */
-
-
-  _proto.unless = function unless(value) {
-    var callVariable = require("./QueryBuilder").getCallVariable(value);
-
-    !callVariable ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayFragmentReference: Invalid value `%s` supplied to `unless()`. ' + 'Expected a variable.', callVariable) : require("fbjs/lib/invariant")(false) : void 0;
-
-    this._addCondition({
-      passingValue: false,
-      variable: callVariable.callVariableName
-    });
-
-    return this;
-  };
-  /**
-   * Get the referenced fragment if all conditions are met.
-   */
-
-
-  _proto.getFragment = function getFragment(variables) {
-    // determine if the variables match the supplied if/unless conditions
-    var conditions = this._conditions;
-
-    if (conditions && !conditions.every(function (_ref) {
-      var variable = _ref.variable,
-          passingValue = _ref.passingValue;
-      return !!variables[variable] === passingValue;
-    })) {
-      return null;
-    }
-
-    return this.getFragmentUnconditional();
-  };
-  /**
-   * Get the variables to pass to the referenced fragment, accounting for
-   * initial values, overrides, and route-specific variables.
-   */
-
-
-  _proto.getVariables = function getVariables(route, variables) {
-    var _this = this;
-
-    var innerVariables = (0, _objectSpread2["default"])({}, this._initialVariables); // map variables from outer -> inner scope
-
-    var variableMapping = this._variableMapping;
-
-    if (variableMapping) {
-      require("fbjs/lib/forEachObject")(variableMapping, function (value, name) {
-        var callVariable = require("./QueryBuilder").getCallVariable(value);
-
-        if (callVariable) {
-          value = variables[callVariable.callVariableName];
-        }
-
-        if (value === undefined) {
-          process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(false, 'RelayFragmentReference: Variable `%s` is undefined in fragment ' + '`%s`.', name, _this.getFragmentUnconditional().name) : void 0;
-        } else {
-          innerVariables[name] = value;
-        }
-      });
-    }
-
-    var prepareVariables = this._prepareVariables;
-
-    if (prepareVariables) {
-      innerVariables = prepareVariables(innerVariables, route);
-    }
-
-    return innerVariables;
-  };
-
-  _proto.isContainerFragment = function isContainerFragment() {
-    return this._isContainerFragment;
-  };
-
-  _proto.isDeferred = function isDeferred() {
-    return this._isDeferred;
-  };
-
-  _proto.isTypeConditional = function isTypeConditional() {
-    return this._isTypeConditional;
-  };
-
-  _proto._addCondition = function _addCondition(condition) {
-    var conditions = this._conditions;
-
-    if (!conditions) {
-      conditions = [];
-      this._conditions = conditions;
-    }
-
-    conditions.push(condition);
-  };
-
-  return RelayFragmentReference;
-}();
-
-module.exports = RelayFragmentReference;

package/lib/RelayFragmentSpecResolver.js

@@ -1,305 +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 _defineProperty2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/defineProperty"));
-
-/**
- * An implementation of the `FragmentSpecResolver` interface defined in
- * `RelayEnvironmentTypes`.
- *
- * This utility is implemented as an imperative, stateful API for performance
- * reasons: reusing previous resolvers, callback functions, and subscriptions
- * all helps to reduce object allocation and thereby decrease GC time.
- *
- * The `resolve()` function is also lazy and memoized: changes in the store mark
- * the resolver as stale and notify the caller, and the actual results are
- * recomputed the first time `resolve()` is called.
- */
-var RelayFragmentSpecResolver =
-/*#__PURE__*/
-function () {
-  function RelayFragmentSpecResolver(context, fragments, props, callback) {
-    var _this = this;
-
-    (0, _defineProperty2["default"])(this, "_onChange", function () {
-      _this._stale = true;
-
-      if (typeof _this._callback === 'function') {
-        _this._callback();
-      }
-    });
-    this._callback = callback;
-    this._context = context;
-    this._data = {};
-    this._fragments = fragments;
-    this._props = props;
-    this._resolvers = {};
-    this._stale = false;
-    this.setProps(props);
-  }
-
-  var _proto = RelayFragmentSpecResolver.prototype;
-
-  _proto.dispose = function dispose() {
-    require("fbjs/lib/forEachObject")(this._resolvers, disposeCallback);
-  };
-
-  _proto.resolve = function resolve() {
-    var _this2 = this;
-
-    if (this._stale) {
-      // Avoid mapping the object multiple times, which could occur if data for
-      // multiple keys changes in the same event loop.
-      var prevData = this._data;
-      var nextData;
-
-      require("fbjs/lib/forEachObject")(this._resolvers, function (resolver, key) {
-        var prevItem = prevData[key];
-
-        if (resolver) {
-          var nextItem = resolver.resolve();
-
-          if (nextData || nextItem !== prevItem) {
-            nextData = nextData || (0, _objectSpread2["default"])({}, prevData);
-            nextData[key] = nextItem;
-          }
-        } else {
-          var prop = _this2._props[key];
-
-          var _nextItem = prop !== undefined ? prop : null;
-
-          if (nextData || !require("relay-runtime").isScalarAndEqual(_nextItem, prevItem)) {
-            nextData = nextData || (0, _objectSpread2["default"])({}, prevData);
-            nextData[key] = _nextItem;
-          }
-        }
-      });
-
-      this._data = nextData || prevData;
-      this._stale = false;
-    }
-
-    return this._data;
-  };
-
-  _proto.setCallback = function setCallback(callback) {
-    this._callback = callback;
-  };
-
-  _proto.setProps = function setProps(props) {
-    var _this3 = this;
-
-    var selectors = require("./RelaySelector").getSelectorsFromObject(this._context.variables, this._fragments, props);
-
-    require("fbjs/lib/forEachObject")(selectors, function (selector, key) {
-      var resolver = _this3._resolvers[key];
-
-      if (selector == null) {
-        if (resolver != null) {
-          resolver.dispose();
-        }
-
-        resolver = null;
-      } else if (Array.isArray(selector)) {
-        if (resolver == null) {
-          resolver = new SelectorListResolver(_this3._context.environment, selector, _this3._onChange);
-        } else {
-          !(resolver instanceof SelectorListResolver) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayFragmentSpecResolver: Expected prop `%s` to always be an array.', key) : require("fbjs/lib/invariant")(false) : void 0;
-          resolver.setSelectors(selector);
-        }
-      } else {
-        if (resolver == null) {
-          resolver = new SelectorResolver(_this3._context.environment, selector, _this3._onChange);
-        } else {
-          !(resolver instanceof SelectorResolver) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayFragmentSpecResolver: Expected prop `%s` to always be an object.', key) : require("fbjs/lib/invariant")(false) : void 0;
-          resolver.setSelector(selector);
-        }
-      }
-
-      _this3._resolvers[key] = resolver;
-    });
-
-    this._props = props;
-    this._stale = true;
-  };
-
-  _proto.setVariables = function setVariables(variables) {
-    require("fbjs/lib/forEachObject")(this._resolvers, function (resolver) {
-      if (resolver) {
-        resolver.setVariables(variables);
-      }
-    });
-
-    this._stale = true;
-  };
-
-  _proto.isLoading = function isLoading() {
-    return false;
-  };
-
-  return RelayFragmentSpecResolver;
-}();
-/**
- * A resolver for a single Selector.
- */
-
-
-var SelectorResolver =
-/*#__PURE__*/
-function () {
-  function SelectorResolver(environment, selector, callback) {
-    var _this4 = this;
-
-    (0, _defineProperty2["default"])(this, "_onChange", function (snapshot) {
-      _this4._data = snapshot.data;
-
-      _this4._callback();
-    });
-
-    var _snapshot = environment.lookup(selector);
-
-    this._callback = callback;
-    this._data = _snapshot.data;
-    this._environment = environment;
-    this._selector = selector;
-    this._subscription = environment.subscribe(_snapshot, this._onChange);
-  }
-
-  var _proto2 = SelectorResolver.prototype;
-
-  _proto2.dispose = function dispose() {
-    if (this._subscription) {
-      this._subscription.dispose();
-
-      this._subscription = null;
-    }
-  };
-
-  _proto2.resolve = function resolve() {
-    return this._data;
-  };
-
-  _proto2.setSelector = function setSelector(selector) {
-    if (this._subscription != null && require("./RelaySelector").areEqualSelectors(selector, this._selector)) {
-      return;
-    }
-
-    this.dispose();
-
-    var snapshot = this._environment.lookup(selector);
-
-    this._data = snapshot.data;
-    this._selector = selector;
-    this._subscription = this._environment.subscribe(snapshot, this._onChange);
-  };
-
-  _proto2.setVariables = function setVariables(variables) {
-    // Note: in the classic implementation variables have to be merged because
-    // they also contain root variables.
-    var selector = (0, _objectSpread2["default"])({}, this._selector, {
-      variables: (0, _objectSpread2["default"])({}, this._selector.variables, variables)
-    });
-    this.setSelector(selector);
-  };
-
-  return SelectorResolver;
-}();
-/**
- * A resolver for an array of Selectors.
- */
-
-
-var SelectorListResolver =
-/*#__PURE__*/
-function () {
-  function SelectorListResolver(environment, selectors, callback) {
-    var _this5 = this;
-
-    (0, _defineProperty2["default"])(this, "_onChange", function (data) {
-      _this5._stale = true;
-
-      _this5._callback();
-    });
-    this._callback = callback;
-    this._data = [];
-    this._environment = environment;
-    this._resolvers = [];
-    this._stale = true;
-    this.setSelectors(selectors);
-  }
-
-  var _proto3 = SelectorListResolver.prototype;
-
-  _proto3.dispose = function dispose() {
-    this._resolvers.forEach(disposeCallback);
-  };
-
-  _proto3.resolve = function resolve() {
-    if (this._stale) {
-      // Avoid mapping the array multiple times, which could occur if data for
-      // multiple indices changes in the same event loop.
-      var prevData = this._data;
-      var nextData;
-
-      for (var ii = 0; ii < this._resolvers.length; ii++) {
-        var prevItem = prevData[ii];
-
-        var nextItem = this._resolvers[ii].resolve();
-
-        if (nextData || nextItem !== prevItem) {
-          nextData = nextData || prevData.slice(0, ii);
-          nextData.push(nextItem);
-        }
-      }
-
-      this._data = nextData || prevData;
-      this._stale = false;
-    }
-
-    return this._data;
-  };
-
-  _proto3.setSelectors = function setSelectors(selectors) {
-    while (this._resolvers.length > selectors.length) {
-      var resolver = this._resolvers.pop();
-
-      resolver.dispose();
-    }
-
-    for (var ii = 0; ii < selectors.length; ii++) {
-      if (ii < this._resolvers.length) {
-        this._resolvers[ii].setSelector(selectors[ii]);
-      } else {
-        this._resolvers[ii] = new SelectorResolver(this._environment, selectors[ii], this._onChange);
-      }
-    }
-
-    this._stale = true;
-  };
-
-  _proto3.setVariables = function setVariables(variables) {
-    this._resolvers.forEach(function (resolver) {
-      return resolver.setVariables(variables);
-    });
-
-    this._stale = true;
-  };
-
-  return SelectorListResolver;
-}();
-
-function disposeCallback(disposable) {
-  disposable && disposable.dispose();
-}
-
-module.exports = RelayFragmentSpecResolver;