react-relay 2.0.0-rc.2 → 5.0.0

package/lib/RelayQueryCaching.js

@@ -1,33 +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 queryCachingEnabled = true;
-/**
- * Methods for configuring caching of Relay queries.
- */
-
-var RelayQueryCaching = {
-  /**
-   * `disable` turns off caching of queries for `getRelayQueries` and
-   * `buildRQL`.
-   */
-  disable: function disable() {
-    queryCachingEnabled = false;
-  },
-
-  /**
-   * @internal
-   */
-  getEnabled: function getEnabled() {
-    return queryCachingEnabled;
-  }
-};
-module.exports = RelayQueryCaching;

package/lib/RelayQueryConfig.js

@@ -1,58 +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"));
-
-/**
- * Configures the root queries and initial variables that define the context in
- * which the top-level component's fragments are requested. This is meant to be
- * subclassed, of which instances are supplied to `RelayRootContainer`.
- */
-var RelayQueryConfig =
-/*#__PURE__*/
-function () {
-  // TODO: Deprecate `routeName`, #8478719.
-  function RelayQueryConfig(initialVariables) {
-    !(this.constructor !== RelayQueryConfig) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayQueryConfig: Abstract class cannot be instantiated.') : require("fbjs/lib/invariant")(false) : void 0;
-    Object.defineProperty(this, 'name', {
-      enumerable: true,
-      value: this.constructor.routeName
-    });
-    Object.defineProperty(this, 'params', {
-      enumerable: true,
-      value: this.prepareVariables((0, _objectSpread2["default"])({}, initialVariables)) || {}
-    });
-    Object.defineProperty(this, 'queries', {
-      enumerable: true,
-      value: (0, _objectSpread2["default"])({}, this.constructor.queries)
-    });
-
-    if (process.env.NODE_ENV !== "production") {
-      Object.freeze(this.params);
-      Object.freeze(this.queries);
-    }
-  }
-  /**
-   * Provides an opportunity to perform additional logic on the variables.
-   * Child class should override this function to perform custom logic.
-   */
-
-
-  var _proto = RelayQueryConfig.prototype;
-
-  _proto.prepareVariables = function prepareVariables(prevVariables) {
-    return prevVariables;
-  };
-
-  return RelayQueryConfig;
-}();
-
-module.exports = RelayQueryConfig;

package/lib/RelayQueryPath.js

@@ -1,204 +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 idField = require("./RelayQuery").Field.build({
-  fieldName: require("./RelayNodeInterface").ID,
-  type: 'String'
-});
-
-var typeField = require("./RelayQuery").Field.build({
-  fieldName: require("./RelayNodeInterface").TYPENAME,
-  type: 'String'
-});
-
-// Placeholder path used to write data to root record (ROOT_ID).
-var ROOT_RECORD_PATH = {
-  type: 'rootRecord'
-};
-
-/**
- * @internal
- *
- * Represents the path (root plus fields) within a query that fetched a
- * particular node. Each step of the path may represent a root query (for
- * refetchable nodes) or the field path from the nearest refetchable node.
- */
-var RelayQueryPath = {
-  getRootRecordPath: function getRootRecordPath() {
-    return ROOT_RECORD_PATH;
-  },
-  createForID: function createForID(dataID, name, routeName) {
-    !!require("./RelayRecord").isClientID(dataID) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayQueryPath.createForID: Expected dataID to be a server id, got ' + '`%s`.', dataID) : require("fbjs/lib/invariant")(false) : void 0;
-    return {
-      dataID: dataID,
-      name: name,
-      routeName: routeName || '$RelayQuery',
-      type: 'node'
-    };
-  },
-  create: function create(root) {
-    if (root.getFieldName() === require("./RelayNodeInterface").NODE) {
-      var identifyingArg = root.getIdentifyingArg();
-
-      if (identifyingArg && typeof identifyingArg.value === 'string') {
-        return {
-          dataID: identifyingArg.value,
-          name: root.getName(),
-          routeName: root.getRoute().name,
-          type: 'node'
-        };
-      }
-    }
-
-    return {
-      root: root,
-      type: 'root'
-    };
-  },
-  getPath: function getPath(parent, node, dataID) {
-    if (dataID == null || require("./RelayRecord").isClientID(dataID)) {
-      return {
-        node: node,
-        parent: parent,
-        type: 'client'
-      };
-    } else if (parent.type === 'node' && parent.dataID === dataID) {
-      return parent;
-    } else {
-      return {
-        dataID: dataID,
-        name: RelayQueryPath.getName(parent),
-        routeName: RelayQueryPath.getRouteName(parent),
-        type: 'node'
-      };
-    }
-  },
-  isRootPath: function isRootPath(path) {
-    return path.type === 'node' || path.type === 'root';
-  },
-  getParent: function getParent(path) {
-    !(path.type === 'client') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayQueryPath: Cannot get the parent of a root path.') : require("fbjs/lib/invariant")(false) : void 0;
-    return path.parent;
-  },
-  getName: function getName(path) {
-    while (path.type === 'client') {
-      path = path.parent;
-    }
-
-    if (path === ROOT_RECORD_PATH) {
-      return 'RootRecordPath';
-    } else if (path.type === 'root') {
-      return path.root.getName();
-    } else if (path.type === 'node') {
-      return path.name;
-    } else {
-      !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayQueryPath.getName(): Invalid path `%s`.', path) : require("fbjs/lib/invariant")(false) : void 0;
-    }
-  },
-  getRouteName: function getRouteName(path) {
-    while (path.type === 'client') {
-      path = path.parent;
-    }
-
-    if (path === ROOT_RECORD_PATH) {
-      return '$RelayQueryPath';
-    } else if (path.type === 'root') {
-      return path.root.getRoute().name;
-    } else if (path.type === 'node') {
-      return path.routeName;
-    } else {
-      !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayQueryPath.getRouteName(): Invalid path `%s`.', path) : require("fbjs/lib/invariant")(false) : void 0;
-    }
-  },
-  getQuery: function getQuery(store, path, appendNode) {
-    var child = appendNode;
-    var prevField;
-
-    var _ConnectionInterface$ = require("relay-runtime").ConnectionInterface.get(),
-        EDGES = _ConnectionInterface$.EDGES;
-
-    while (path.type === 'client') {
-      var node = path.node;
-
-      if (node instanceof require("./RelayQuery").Field) {
-        var schemaName = node.getSchemaName();
-        process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(!prevField || prevField !== EDGES || !node.isConnection(), 'RelayQueryPath.getQuery(): Cannot generate accurate query for ' + 'path with connection `%s`. Consider adding an `id` field to each ' + '`node` to make them refetchable.', schemaName) : void 0;
-        prevField = schemaName;
-      }
-
-      var idFieldName = node instanceof require("./RelayQuery").Field ? node.getInferredPrimaryKey() : require("./RelayNodeInterface").ID;
-
-      if (idFieldName) {
-        child = node.clone([child, node.getFieldByStorageKey(idFieldName), node.getFieldByStorageKey(require("./RelayNodeInterface").TYPENAME)]);
-      } else {
-        child = node.clone([child]);
-      }
-
-      path = path.parent;
-    }
-
-    !(path.type !== 'rootRecord') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayQueryPath: Attempted to construct a classic query, but the ' + 'record was initially fetched with new Relay APIs. Ensure that ' + 'deprecated components such as RelayContainer are not nested in ' + 'new APIs such as QueryRenderer or FragmentContainer.') : require("fbjs/lib/invariant")(false) : void 0;
-    var root = path.type === 'root' ? path.root : createRootQueryFromNodePath(path);
-    var children = [child, root.getFieldByStorageKey(require("./RelayNodeInterface").ID), root.getFieldByStorageKey(require("./RelayNodeInterface").TYPENAME)];
-    var rootChildren = getRootFragmentForQuery(store, root, children);
-    var pathQuery = root.cloneWithRoute(rootChildren, appendNode.getRoute()); // for flow
-
-    !(pathQuery instanceof require("./RelayQuery").Root) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayQueryPath: Expected the root of path `%s` to be a query.', RelayQueryPath.getName(path)) : require("fbjs/lib/invariant")(false) : void 0;
-    return pathQuery;
-  }
-};
-
-function createRootQueryFromNodePath(nodePath) {
-  return require("./RelayQuery").Root.build(nodePath.name, require("./RelayNodeInterface").NODE, nodePath.dataID, [idField, typeField], {
-    identifyingArgName: require("./RelayNodeInterface").ID,
-    identifyingArgType: require("./RelayNodeInterface").ID_TYPE,
-    isAbstract: true,
-    isDeferred: false,
-    isPlural: false
-  }, require("./RelayNodeInterface").NODE_TYPE, nodePath.routeName);
-}
-
-function getRootFragmentForQuery(store, root, children) {
-  var nextChildren = []; // $FlowIssue: Flow isn't recognizing that `filter(x => !!x)` returns a list
-  // of non-null values.
-
-  children.forEach(function (child) {
-    if (child) {
-      nextChildren.push(child);
-    }
-  });
-
-  if (!root.isAbstract()) {
-    // No need to wrap child nodes of a known concrete type.
-    return nextChildren;
-  }
-
-  var identifyingArgKeys = [];
-
-  require("./forEachRootCallArg")(root, function (_ref) {
-    var identifyingArgKey = _ref.identifyingArgKey;
-    identifyingArgKeys.push(identifyingArgKey);
-  });
-
-  var identifyingArgKey = identifyingArgKeys[0];
-  var rootID = store.getDataID(root.getStorageKey(), identifyingArgKey);
-  var rootType = rootID && store.getType(rootID);
-
-  if (rootType != null) {
-    return [require("./RelayQuery").Fragment.build(root.getName(), rootType, nextChildren)];
-  } else {
-    var rootState = rootID != null ? store.getRecordState(rootID) : require("./RelayClassicRecordState").UNKNOWN;
-    process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(false, 'RelayQueryPath: No typename found for %s record `%s`. Generating a ' + 'possibly invalid query.', rootState.toLowerCase(), rootID) : void 0;
-    return nextChildren;
-  }
-}
-
-module.exports = RelayQueryPath;

package/lib/RelayQueryRequest.js

@@ -1,103 +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';
-
-var _inheritsLoose2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/inheritsLoose"));
-
-/**
- * @internal
- *
- * Instances of these are made available via `RelayNetworkLayer.sendQueries`.
- */
-var RelayQueryRequest =
-/*#__PURE__*/
-function (_Deferred) {
-  (0, _inheritsLoose2["default"])(RelayQueryRequest, _Deferred);
-
-  function RelayQueryRequest(query) {
-    var _this;
-
-    _this = _Deferred.call(this) || this;
-    _this._printedQuery = null;
-    _this._query = query;
-    return _this;
-  }
-  /**
-   * @public
-   *
-   * Gets a string name used to refer to this request for printing debug output.
-   */
-
-
-  var _proto = RelayQueryRequest.prototype;
-
-  _proto.getDebugName = function getDebugName() {
-    var name = this._query.getName();
-
-    return this._query.isDeferred() ? name + ' (DEFERRED)' : name;
-  };
-  /**
-   * @public
-   *
-   * Gets a unique identifier for this query. These identifiers are useful for
-   * assigning response payloads to their corresponding queries when sent in a
-   * single GraphQL request.
-   */
-
-
-  _proto.getID = function getID() {
-    return this._query.getID();
-  };
-
-  _proto._getPrintedQuery = function _getPrintedQuery() {
-    var printedQuery = this._printedQuery;
-
-    if (printedQuery == null) {
-      printedQuery = this._query instanceof require("./RelayQuery").OSSQuery ? require("./printRelayOSSQuery")(this._query) : require("./printRelayQuery")(this._query);
-      this._printedQuery = printedQuery;
-    }
-
-    return printedQuery;
-  };
-  /**
-   * @public
-   *
-   * Gets the variables used by the query. These variables should be serialized
-   * and sent in the GraphQL request.
-   */
-
-
-  _proto.getVariables = function getVariables() {
-    return this._getPrintedQuery().variables;
-  };
-  /**
-   * @public
-   *
-   * Gets a string representation of the GraphQL query.
-   */
-
-
-  _proto.getQueryString = function getQueryString() {
-    return this._getPrintedQuery().text;
-  };
-  /**
-   * @public
-   * @unstable
-   */
-
-
-  _proto.getQuery = function getQuery() {
-    return this._query;
-  };
-
-  return RelayQueryRequest;
-}(require("fbjs/lib/Deferred"));
-
-module.exports = RelayQueryRequest;

package/lib/RelayQueryTracker.js

@@ -1,86 +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';
-
-var _toConsumableArray2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/toConsumableArray"));
-
-var RelayQueryTracker =
-/*#__PURE__*/
-function () {
-  function RelayQueryTracker() {
-    this._trackedNodesByID = {};
-  }
-
-  var _proto = RelayQueryTracker.prototype;
-
-  _proto.trackNodeForID = function trackNodeForID(node, dataID) {
-    this._trackedNodesByID[dataID] = this._trackedNodesByID[dataID] || {
-      trackedNodes: [],
-      isMerged: false
-    };
-
-    this._trackedNodesByID[dataID].trackedNodes.push(node);
-
-    this._trackedNodesByID[dataID].isMerged = false;
-  };
-  /**
-   * Get the children that are tracked for the given `dataID`, if any.
-   */
-
-
-  _proto.getTrackedChildrenForID = function getTrackedChildrenForID(dataID) {
-    var trackedNodesByID = this._trackedNodesByID[dataID];
-
-    if (!trackedNodesByID) {
-      return [];
-    }
-
-    var isMerged = trackedNodesByID.isMerged,
-        trackedNodes = trackedNodesByID.trackedNodes;
-
-    if (!isMerged) {
-      var trackedChildren = [];
-      trackedNodes.forEach(function (trackedQuery) {
-        trackedChildren.push.apply(trackedChildren, (0, _toConsumableArray2["default"])(trackedQuery.getChildren()));
-      });
-      trackedNodes.length = 0;
-      trackedNodesByID.isMerged = true;
-
-      var containerNode = require("./RelayQuery").Fragment.build('RelayQueryTracker', require("./RelayNodeInterface").NODE_TYPE, trackedChildren);
-
-      containerNode = require("./flattenRelayQuery")(containerNode);
-
-      if (containerNode) {
-        trackedNodes.push(containerNode);
-      }
-    }
-
-    var trackedNode = trackedNodes[0];
-
-    if (trackedNode) {
-      return trackedNode.getChildren();
-    }
-
-    return [];
-  };
-  /**
-   * Removes all nodes that are tracking the given DataID from the
-   * query-tracker.
-   */
-
-
-  _proto.untrackNodesForID = function untrackNodesForID(dataID) {
-    delete this._trackedNodesByID[dataID];
-  };
-
-  return RelayQueryTracker;
-}();
-
-module.exports = RelayQueryTracker;

package/lib/RelayQueryTransform.js

@@ -1,91 +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';
-
-var _inheritsLoose2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/inheritsLoose"));
-
-/**
- * @internal
- *
- * `RelayQueryTransform` is a `RelayQueryVisitor` subclass that simplifies the
- * process of traversing, filtering, or transforming a Relay Query.
- *
- * The traversal is a map operation from `RelayQuery` nodes to nodes. The
- * default implementation traverses all nodes and maps each one to its
- * original value (ie. a no-op).
- *
- * Just like `RelayQueryVisitor`, subclasses of `RelayQueryTransform` can
- * optionally implement methods to customize the traversal and mapping of
- * different RelayQuery node types:
- *
- * - `visitField(field, state)`: Returns the new value for the visited field, or
- *   `null` to remove it from the output.
- * - `visitFragment(fragment, state)`: Returns the new value for the visited
- *   fragment, or `null` to remove it from the output.
- * - `visitQuery(fragment, state)`: Returns the new value for the top-level
- *   query, or `null` to transform the entire query out of existence.
- *
- * There are two additional methods for controlling the traversal:
- *
- * - `traverse(parent, state)`: Returns a cloned copy of the parent node after
- *   processing all of its children. Does not clone if nothing changed.
- * - `visit(child, state)`: Processes the child node, calling the appropriate
- *   `visit{Field,Fragment,Root` method based on the node type.
- *
- * All of these methods may return the original node in order to leave it
- * intact.
- *
- * @see RelayQueryVisitor
- */
-var RelayQueryTransform =
-/*#__PURE__*/
-function (_RelayQueryVisitor) {
-  (0, _inheritsLoose2["default"])(RelayQueryTransform, _RelayQueryVisitor);
-
-  function RelayQueryTransform() {
-    return _RelayQueryVisitor.apply(this, arguments) || this;
-  }
-
-  var _proto = RelayQueryTransform.prototype;
-
-  _proto.traverse = function traverse(node, nextState) {
-    if (!node.canHaveSubselections()) {
-      return node;
-    }
-
-    var nextChildren;
-    this.traverseChildren(node, nextState, function (child, index, children) {
-      var prevChild = children[index];
-      var nextChild = this.visit(prevChild, nextState);
-
-      if (nextChild !== prevChild) {
-        nextChildren = nextChildren || children.slice(0, index);
-      }
-
-      if (nextChildren && nextChild) {
-        nextChildren.push(nextChild);
-      }
-    }, this);
-
-    if (nextChildren) {
-      if (!nextChildren.length) {
-        return null;
-      }
-
-      return node.clone(nextChildren);
-    }
-
-    return node;
-  };
-
-  return RelayQueryTransform;
-}(require("./RelayQueryVisitor"));
-
-module.exports = RelayQueryTransform;

package/lib/RelayQueryVisitor.js

@@ -1,93 +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';
-
-/**
- * @internal
- *
- * Base class for traversing a Relay Query.
- *
- * Subclasses can optionally implement methods to customize the traversal:
- *
- * - `visitField(field, state)`: Called for each field.
- * - `visitFragment(fragment, state)`: Called for each fragment.
- * - `visitQuery(fragment, state)`: Called for the top level query.
- *
- * A `state` variable is passed along to all callbacks and can be used to
- * accumulate data while traversing (effectively passing data back up the tree),
- * or modify the behavior of later callbacks (effectively passing data down the
- * tree).
- *
- * There are two additional methods for controlling the traversal:
- *
- * - `traverse(parent, state)`: Visits all children of `parent`. Subclasses
- *   may override in order to short-circuit traversal. Note that
- *   `visit{Field,Fragment,Query}` are //not// called on `parent`, as it will
- *   already have been visited by the time this method is called.
- * - `visit(child, state)`: Processes the `child` node, calling the appropriate
- *   `visit{Field,Fragment,Query}` method based on the node type.
- *
- * By convention, each of the callback methods returns the visited node. This is
- * used by the `RelayQueryTransform` subclass to implement mapping and filtering
- * behavior, but purely-visitor subclases do not need to follow this convention.
- *
- * @see RelayQueryTransform
- */
-var RelayQueryVisitor =
-/*#__PURE__*/
-function () {
-  function RelayQueryVisitor() {}
-
-  var _proto = RelayQueryVisitor.prototype;
-
-  _proto.visit = function visit(node, nextState) {
-    if (node instanceof require("./RelayQuery").Field) {
-      return this.visitField(node, nextState);
-    } else if (node instanceof require("./RelayQuery").Fragment) {
-      return this.visitFragment(node, nextState);
-    } else if (node instanceof require("./RelayQuery").Root) {
-      return this.visitRoot(node, nextState);
-    }
-  };
-
-  _proto.traverse = function traverse(node, nextState) {
-    if (node.canHaveSubselections()) {
-      this.traverseChildren(node, nextState, function (child) {
-        this.visit(child, nextState);
-      }, this);
-    }
-
-    return node;
-  };
-
-  _proto.traverseChildren = function traverseChildren(node, nextState, callback, context) {
-    var children = node.getChildren();
-
-    for (var _index = 0; _index < children.length; _index++) {
-      callback.call(context, children[_index], _index, children);
-    }
-  };
-
-  _proto.visitField = function visitField(node, nextState) {
-    return this.traverse(node, nextState);
-  };
-
-  _proto.visitFragment = function visitFragment(node, nextState) {
-    return this.traverse(node, nextState);
-  };
-
-  _proto.visitRoot = function visitRoot(node, nextState) {
-    return this.traverse(node, nextState);
-  };
-
-  return RelayQueryVisitor;
-}();
-
-module.exports = RelayQueryVisitor;