react-relay 2.0.0-rc.2 → 5.0.0

package/lib/RelayEnvironment.js

@@ -1,449 +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"));
-
-/**
- * @public
- *
- * `RelayEnvironment` is the public API for Relay core. Each instance provides
- * an isolated environment with:
- * - Methods for fetching and updating data.
- * - An in-memory cache of fetched data.
- * - A configurable network layer for resolving queries/mutations.
- * - A configurable task scheduler to control when internal tasks are executed.
- *
- * No data or configuration is shared between instances. We recommend creating
- * one `RelayEnvironment` instance per user: client apps may share a single
- * instance, server apps may create one instance per HTTP request.
- */
-var RelayEnvironment =
-/*#__PURE__*/
-function () {
-  var _proto = RelayEnvironment.prototype;
-
-  _proto.applyMutation = function applyMutation(_ref) {
-    var configs = _ref.configs,
-        operation = _ref.operation,
-        optimisticResponse = _ref.optimisticResponse,
-        variables = _ref.variables;
-    var mutationTransaction = new (require("./RelayGraphQLMutation"))(operation.node, require("./RelayVariables").getOperationVariables(operation, variables), null, this);
-    mutationTransaction.applyOptimistic(operation.node, optimisticResponse, configs);
-    var disposed = false;
-    return {
-      dispose: function dispose() {
-        if (!disposed) {
-          disposed = true;
-          mutationTransaction.rollback();
-        }
-      }
-    };
-  };
-
-  _proto.check = function check(selector) {
-    return false;
-  };
-
-  _proto.commitPayload = function commitPayload(operationDescriptor, payload) {
-    var selector = operationDescriptor.root;
-
-    var fragment = require("./RelayQuery").Fragment.create(selector.node, require("./RelayMetaRoute").get('$RelayEnvironment'), selector.variables);
-
-    var path = require("./RelayQueryPath").getRootRecordPath();
-
-    this._storeData.handleFragmentPayload(selector.dataID, fragment, path, payload, null);
-  };
-  /**
-   * An internal implementation of the "lookup" API that is shared by `lookup()`
-   * and `subscribe()`. Note that `subscribe()` cannot use `lookup()` directly,
-   * since the former may modify the result data before freezing it.
-   */
-
-
-  _proto._lookup = function _lookup(selector) {
-    var fragment = require("./RelayQuery").Fragment.create(selector.node, require("./RelayMetaRoute").get('$RelayEnvironment'), selector.variables);
-
-    var _readRelayQueryData = require("./readRelayQueryData")(this._storeData, fragment, selector.dataID),
-        data = _readRelayQueryData.data,
-        dataIDs = _readRelayQueryData.dataIDs; // Ensure that the root ID is considered "seen" and will be watched for
-    // changes if the returned selector is passed to `subscribe()`.
-
-
-    dataIDs[selector.dataID] = true;
-    return (0, _objectSpread2["default"])({}, selector, {
-      data: data,
-      seenRecords: dataIDs,
-      isMissingData: false
-    });
-  };
-
-  _proto.lookup = function lookup(selector) {
-    var snapshot = this._lookup(selector);
-
-    if (process.env.NODE_ENV !== "production") {
-      deepFreezeSnapshot(snapshot);
-    }
-
-    return snapshot;
-  };
-
-  _proto.sendMutation = function sendMutation(_ref2) {
-    var configs = _ref2.configs,
-        onCompleted = _ref2.onCompleted,
-        onError = _ref2.onError,
-        operation = _ref2.operation,
-        optimisticOperation = _ref2.optimisticOperation,
-        optimisticResponse = _ref2.optimisticResponse,
-        variables = _ref2.variables,
-        uploadables = _ref2.uploadables;
-    var disposed = false;
-    var mutationTransaction = new (require("./RelayGraphQLMutation"))(operation.node, require("./RelayVariables").getOperationVariables(operation, variables), uploadables, this, {
-      onSuccess: function onSuccess(response) {
-        if (disposed) {
-          return;
-        }
-
-        onCompleted && onCompleted(response);
-      },
-      onFailure: function onFailure(transaction) {
-        if (disposed) {
-          return;
-        }
-
-        if (onError) {
-          var _error = transaction.getError();
-
-          if (!_error) {
-            _error = new Error("RelayEnvironment: Unknown error executing mutation ".concat(operation.node.name));
-          }
-
-          onError(_error);
-        }
-      }
-    });
-
-    if (optimisticResponse) {
-      mutationTransaction.applyOptimistic(optimisticOperation ? optimisticOperation.node : operation.node, optimisticResponse, configs);
-    }
-
-    mutationTransaction.commit(configs);
-    return {
-      dispose: function dispose() {
-        if (!disposed) {
-          disposed = true;
-        }
-      }
-    };
-  };
-
-  _proto.subscribe = function subscribe(snapshot, callback) {
-    var _this = this;
-
-    var subscription;
-
-    var changeEmitter = this._storeData.getChangeEmitter();
-
-    var update = function update() {
-      // Re-read data and see if anything changed
-      var nextSnapshot = _this._lookup(snapshot); // Note that `recycleNodesInto` may modify the "next" value
-
-
-      nextSnapshot.data = require("relay-runtime").recycleNodesInto(snapshot.data, nextSnapshot.data);
-
-      if (nextSnapshot.data === snapshot.data) {
-        // The record changes don't affect the results of the selector
-        return;
-      }
-
-      if (process.env.NODE_ENV !== "production") {
-        deepFreezeSnapshot(nextSnapshot);
-      }
-
-      if (subscription) {
-        subscription.remove();
-      }
-
-      subscription = changeEmitter.addListenerForIDs(Object.keys(nextSnapshot.seenRecords), update);
-      snapshot = nextSnapshot;
-      callback(snapshot);
-    };
-
-    subscription = changeEmitter.addListenerForIDs(Object.keys(snapshot.seenRecords), update);
-    return {
-      dispose: function dispose() {
-        if (subscription) {
-          subscription.remove();
-          subscription = null;
-        }
-      }
-    };
-  };
-
-  _proto.retain = function retain(selector) {
-    return {
-      dispose: function dispose() {}
-    };
-  };
-
-  _proto.sendQuery = function sendQuery(_ref3) {
-    var _this2 = this;
-
-    var cacheConfig = _ref3.cacheConfig,
-        onCompleted = _ref3.onCompleted,
-        onError = _ref3.onError,
-        onNext = _ref3.onNext,
-        operation = _ref3.operation;
-    var isDisposed = false;
-
-    var dispose = function dispose() {
-      isDisposed = true;
-    };
-
-    var query = require("./RelayQuery").OSSQuery.create(operation.node, require("./RelayMetaRoute").get('$RelayEnvironment'), operation.variables);
-
-    var request = new (require("./RelayQueryRequest"))(query);
-    request.getPromise().then(function (payload) {
-      if (isDisposed) {
-        return;
-      }
-
-      var forceIndex = cacheConfig && cacheConfig.force ? require("./generateForceIndex")() : null;
-
-      _this2._storeData.handleOSSQueryPayload(query, payload.response, forceIndex);
-
-      onNext && onNext(operation.root);
-      onCompleted && onCompleted();
-    }, function (error) {
-      if (isDisposed) {
-        return;
-      }
-
-      onError && onError(error);
-    });
-
-    this._storeData.getTaskQueue().enqueue(function () {
-      _this2._storeData.getNetworkLayer().sendQueries([request]);
-    });
-
-    return {
-      dispose: dispose
-    };
-  };
-
-  _proto.execute = function execute(_ref4) {
-    var _this3 = this;
-
-    var operation = _ref4.operation,
-        cacheConfig = _ref4.cacheConfig,
-        updater = _ref4.updater;
-    return require("relay-runtime").Observable.fromLegacy(function (observer) {
-      return _this3.sendQuery((0, _objectSpread2["default"])({
-        operation: operation,
-        cacheConfig: cacheConfig
-      }, observer));
-    });
-  };
-
-  function RelayEnvironment(storeData) {
-    this._storeData = storeData ? storeData : new (require("./RelayStoreData"))();
-
-    this._storeData.getChangeEmitter().injectBatchingStrategy(require("./relayUnstableBatchedUpdates"));
-
-    this.applyUpdate = this.applyUpdate.bind(this);
-    this.commitUpdate = this.commitUpdate.bind(this);
-    this.unstable_internal = require("./RelayClassicCore");
-  }
-  /**
-   * @internal
-   */
-
-
-  _proto.getStoreData = function getStoreData() {
-    return this._storeData;
-  };
-  /**
-   * @internal
-   */
-
-
-  _proto.injectDefaultNetworkLayer = function injectDefaultNetworkLayer(networkLayer) {
-    this._storeData.getNetworkLayer().injectDefaultImplementation(networkLayer);
-  };
-
-  _proto.injectNetworkLayer = function injectNetworkLayer(networkLayer) {
-    this._storeData.getNetworkLayer().injectImplementation(networkLayer);
-  };
-  /**
-   * @internal
-   */
-
-
-  _proto.injectQueryTracker = function injectQueryTracker(queryTracker) {
-    this._storeData.injectQueryTracker(queryTracker);
-  };
-
-  _proto.addNetworkSubscriber = function addNetworkSubscriber(queryCallback, mutationCallback) {
-    return this._storeData.getNetworkLayer().addNetworkSubscriber(queryCallback, mutationCallback);
-  };
-
-  _proto.injectTaskScheduler = function injectTaskScheduler(scheduler) {
-    this._storeData.injectTaskScheduler(scheduler);
-  };
-
-  _proto.injectCacheManager = function injectCacheManager(cacheManager) {
-    this._storeData.injectCacheManager(cacheManager);
-  };
-  /**
-   * Primes the store by sending requests for any missing data that would be
-   * required to satisfy the supplied set of queries.
-   */
-
-
-  _proto.primeCache = function primeCache(querySet, callback) {
-    return this._storeData.getQueryRunner().run(querySet, callback);
-  };
-  /**
-   * Forces the supplied set of queries to be fetched and written to the store.
-   * Any data that previously satisfied the queries will be overwritten.
-   */
-
-
-  _proto.forceFetch = function forceFetch(querySet, callback) {
-    return this._storeData.getQueryRunner().forceFetch(querySet, callback);
-  };
-  /**
-   * Reads query data anchored at the supplied data ID.
-   */
-
-
-  _proto.read = function read(node, dataID, options) {
-    return require("./readRelayQueryData")(this._storeData, node, dataID, options).data;
-  };
-  /**
-   * Reads query data anchored at the supplied data IDs.
-   */
-
-
-  _proto.readAll = function readAll(node, dataIDs, options) {
-    var _this4 = this;
-
-    return dataIDs.map(function (dataID) {
-      return require("./readRelayQueryData")(_this4._storeData, node, dataID, options).data;
-    });
-  };
-  /**
-   * Reads query data, where each element in the result array corresponds to a
-   * root call argument. If the root call has no arguments, the result array
-   * will contain exactly one element.
-   */
-
-
-  _proto.readQuery = function readQuery(root, options) {
-    var _this5 = this;
-
-    var queuedStore = this._storeData.getQueuedStore();
-
-    var storageKey = root.getStorageKey();
-    var results = [];
-
-    require("./forEachRootCallArg")(root, function (_ref5) {
-      var identifyingArgKey = _ref5.identifyingArgKey;
-      var data;
-      var dataID = queuedStore.getDataID(storageKey, identifyingArgKey);
-
-      if (dataID != null) {
-        data = _this5.read(root, dataID, options);
-      }
-
-      results.push(data);
-    });
-
-    return results;
-  };
-  /**
-   * @internal
-   *
-   * Returns a fragment "resolver" - a subscription to the results of a fragment
-   * and a means to access the latest results. This is a transitional API and
-   * not recommended for general use.
-   */
-
-
-  _proto.getFragmentResolver = function getFragmentResolver(fragment, onNext) {
-    return new (require("./GraphQLStoreQueryResolver"))(this._storeData, fragment, onNext);
-  };
-  /**
-   * Adds an update to the store without committing it. The returned
-   * RelayMutationTransaction can be committed or rolled back at a later time.
-   */
-
-
-  _proto.applyUpdate = function applyUpdate(mutation, callbacks) {
-    mutation.bindEnvironment(this);
-    return this._storeData.getMutationQueue().createTransaction(mutation, callbacks).applyOptimistic();
-  };
-  /**
-   * Adds an update to the store and commits it immediately. Returns
-   * the RelayMutationTransaction.
-   */
-
-
-  _proto.commitUpdate = function commitUpdate(mutation, callbacks) {
-    var transaction = this.applyUpdate(mutation, callbacks); // The idea here is to defer the call to `commit()` to give the optimistic
-    // mutation time to flush out to the UI before starting the commit work.
-
-    var preCommitStatus = transaction.getStatus();
-    setTimeout(function () {
-      if (transaction.getStatus() !== preCommitStatus) {
-        return;
-      }
-
-      transaction.commit();
-    });
-    return transaction;
-  };
-  /**
-   * @deprecated
-   *
-   * Method renamed to commitUpdate
-   */
-
-
-  _proto.update = function update(mutation, callbacks) {
-    process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(false, '`Relay.Store.update` is deprecated. Please use' + ' `Relay.Store.commitUpdate` or `Relay.Store.applyUpdate` instead.') : void 0;
-    this.commitUpdate(mutation, callbacks);
-  };
-
-  return RelayEnvironment;
-}();
-/**
- * RelayQuery mutates the `__cachedFragment__` property of concrete nodes for
- * memoization purposes, so a snapshot cannot be completely frozen. Instead this
- * function shallow-freezes the snapshot itself and deeply freezes all
- * properties except the `node`.
- */
-
-
-function deepFreezeSnapshot(snapshot) {
-  Object.freeze(snapshot);
-
-  if (snapshot.data != null) {
-    require("relay-runtime").deepFreeze(snapshot.data);
-  }
-
-  require("relay-runtime").deepFreeze(snapshot.seenRecords);
-
-  require("relay-runtime").deepFreeze(snapshot.variables);
-
-  return snapshot;
-}
-
-module.exports = RelayEnvironment;

package/lib/RelayEnvironmentTypes.js

@@ -1,10 +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';

package/lib/RelayFetchMode.js

@@ -1,17 +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
- * @format
- */
-'use strict';
-
-var RelayFetchMode = Object.freeze({
-  CLIENT: 'CLIENT',
-  PRELOAD: 'PRELOAD',
-  REFETCH: 'REFETCH'
-});
-module.exports = RelayFetchMode;

package/lib/RelayFragmentPointer.js

@@ -1,161 +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';
-
-/**
- * Fragment pointers encapsulate the fetched data for a fragment reference. They
- * are opaque tokens that are used by Relay containers to read data that is then
- * passed to the underlying React component.
- *
- * @internal
- */
-var RelayFragmentPointer = {
-  addFragment: function addFragment(record, fragment) {
-    var fragmentMap = record.__fragments__;
-
-    if (fragmentMap == null) {
-      fragmentMap = record.__fragments__ = {};
-    }
-
-    !(typeof fragmentMap === 'object' && fragmentMap != null) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayFragmentPointer: Expected record to contain a fragment map, got ' + '`%s` for record `%s`.', fragmentMap, record.__dataID__) : require("fbjs/lib/invariant")(false) : void 0;
-    var fragmentID = fragment.getConcreteFragmentID();
-    var variableList = fragmentMap[fragmentID];
-
-    if (variableList == null) {
-      variableList = fragmentMap[fragmentID] = [];
-    }
-
-    !Array.isArray(variableList) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayFragmentPointer: Expected record to contain a fragment/variable ' + 'map, got `%s` for record `%s`.', variableList, record.__dataID__) : require("fbjs/lib/invariant")(false) : void 0;
-    variableList.push(fragment.getVariables());
-  },
-
-  /**
-   * Returns true if the concrete fragment is included in the fragment pointer
-   * results, regardless of the variables.
-   */
-  hasConcreteFragment: function hasConcreteFragment(record, fragment) {
-    var fragmentMap = record.__fragments__;
-
-    if (typeof fragmentMap === 'object' && fragmentMap != null) {
-      var _fragmentID = fragment.getConcreteFragmentID();
-
-      return fragmentMap.hasOwnProperty(_fragmentID);
-    }
-
-    return false;
-  },
-
-  /**
-   * Returns true if the combination of concrete fragment + variables is
-   * included in the fragment pointer results.
-   */
-  hasFragment: function hasFragment(record, fragment) {
-    var variableList = RelayFragmentPointer.getFragmentVariables(record, fragment);
-
-    if (variableList != null) {
-      return variableList.some(function (vars) {
-        return require("fbjs/lib/areEqual")(vars, fragment.getVariables());
-      });
-    }
-
-    return false;
-  },
-  getVariablesForID: function getVariablesForID(record, fragmentID) {
-    var fragmentMap = record.__fragments__;
-
-    if (typeof fragmentMap === 'object' && fragmentMap != null) {
-      var variables = fragmentMap[fragmentID];
-
-      if (variables) {
-        !(Array.isArray(variables) && variables.length === 1) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayFragmentPointer: Expected an array with at most one set of ' + 'variables per concrete fragment, got %s.', variables) : require("fbjs/lib/invariant")(false) : void 0;
-        return variables[0];
-      }
-    }
-
-    return null;
-  },
-
-  /**
-   * Returns the list of variables whose results are available for the given
-   * concrete fragment.
-   */
-  getFragmentVariables: function getFragmentVariables(record, fragment) {
-    var fragmentMap = record.__fragments__;
-
-    if (typeof fragmentMap === 'object' && fragmentMap != null) {
-      var _fragmentID2 = fragment.getConcreteFragmentID();
-
-      return fragmentMap[_fragmentID2];
-    }
-
-    return null;
-  },
-  create: function create(dataID, fragment) {
-    var record = require("./RelayRecord").create(dataID);
-
-    RelayFragmentPointer.addFragment(record, fragment);
-    /* $FlowFixMe - Flow error detected during the deployment of v0.38.0. To see
-     * the error, remove this comment and run flow */
-
-    return record;
-  },
-  createForRoot: function createForRoot(store, query) {
-    var fragment = getRootFragment(query);
-
-    if (!fragment) {
-      return null;
-    }
-
-    var storageKey = query.getStorageKey();
-    var pointers = [];
-
-    require("./forEachRootCallArg")(query, function (_ref) {
-      var identifyingArgKey = _ref.identifyingArgKey;
-      var dataID = store.getDataID(storageKey, identifyingArgKey);
-
-      if (dataID == null) {
-        pointers.push(null);
-      } else {
-        pointers.push(RelayFragmentPointer.create(dataID, fragment));
-      }
-    }); // Distinguish between singular/plural queries.
-
-
-    var identifyingArg = query.getIdentifyingArg();
-    var identifyingArgValue = identifyingArg && identifyingArg.value || null;
-
-    if (Array.isArray(identifyingArgValue)) {
-      return pointers;
-    }
-
-    return pointers[0];
-  }
-};
-
-function getRootFragment(query) {
-  var batchCall = query.getBatchCall();
-
-  if (batchCall) {
-    !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'Queries supplied at the root cannot have batch call variables. Query ' + '`%s` has a batch call variable, `%s`.', query.getName(), batchCall.refParamName) : require("fbjs/lib/invariant")(false) : void 0;
-  }
-
-  var fragment;
-  query.getChildren().forEach(function (child) {
-    if (child instanceof require("./RelayQuery").Fragment) {
-      !!fragment ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'Queries supplied at the root should contain exactly one fragment ' + "(e.g. `${Component.getFragment('...')}`). Query `%s` contains " + 'more than one fragment.', query.getName()) : require("fbjs/lib/invariant")(false) : void 0;
-      fragment = child;
-    } else if (child instanceof require("./RelayQuery").Field) {
-      !child.isGenerated() ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'Queries supplied at the root should contain exactly one fragment ' + 'and no fields. Query `%s` contains a field, `%s`. If you need to ' + 'fetch fields, declare them in a Relay container.', query.getName(), child.getSchemaName()) : require("fbjs/lib/invariant")(false) : void 0;
-    }
-  });
-  return fragment;
-}
-
-module.exports = RelayFragmentPointer;