react-relay 2.0.0-rc.2 → 5.0.0

package/lib/RelayMutation.js

@@ -1,322 +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
- *
- * RelayMutation is the base class for modeling mutations of data.
- */
-var RelayMutation =
-/*#__PURE__*/
-function () {
-  function RelayMutation(props) {
-    this._didShowFakeDataWarning = false;
-    this._didValidateConfig = false;
-    this._unresolvedProps = props;
-  }
-  /**
-   * @internal
-   */
-
-
-  var _proto = RelayMutation.prototype;
-
-  _proto.bindEnvironment = function bindEnvironment(environment) {
-    if (!this._environment) {
-      this._environment = environment;
-
-      this._resolveProps();
-    } else {
-      !(environment === this._environment) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, '%s: Mutation instance cannot be used in different Relay environments.', this.constructor.name) : require("fbjs/lib/invariant")(false) : void 0;
-    }
-  };
-  /**
-   * Each mutation corresponds to a field on the server which is used by clients
-   * to communicate the type of mutation to be executed.
-   */
-
-
-  _proto.getMutation = function getMutation() {
-    !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, '%s: Expected abstract method `getMutation` to be implemented.', this.constructor.name) : require("fbjs/lib/invariant")(false) : void 0;
-  };
-  /**
-   * "Fat queries" represent a predetermined set of fields that may change as a
-   * result of a mutation, and which should therefore be queried in order to get
-   * a consistent view of the data after performing a mutation. In practice, we
-   * query for a subset of those fields because we intersect the fat query with
-   * the tracked query we have for a given node (ie. the pieces of data we've
-   * previously queried for and have therefore written to the store).
-   *
-   * Fat queries can be written like normal GraphQL queries with one main
-   * exception: fat queries use childless non-scalar fields to indicate that
-   * anything under that field may change. For example, the fat query for
-   * feedback_like contains the field `like_sentence` with no child fields.
-   * This means that any field below `like_sentence` may change as a result of
-   * feedback_like.
-   *
-   * When adding a fat query, consider *all* of the data that might change as a
-   * result of the mutation - not just data that we currently use in Relay. We
-   * don't need to worry about overfetching here (this query is never executed
-   * on its own; the infrastructure always intersects it with what is actually
-   * needed), and if we omit fields here we might get odd consistency behavior
-   * in the future when we add new views or modify existing ones.
-   */
-
-
-  _proto.getFatQuery = function getFatQuery() {
-    !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, '%s: Expected abstract method `getFatQuery` to be implemented.', this.constructor.name) : require("fbjs/lib/invariant")(false) : void 0;
-  };
-  /**
-   * These configurations are used to generate the query for the mutation to be
-   * sent to the server and to correctly write the server's response into the
-   * client store.
-   *
-   * Possible configuration types:
-   *
-   * -  FIELDS_CHANGE provides configuration for mutation fields.
-   *    {
-   *      type: MutationTypes.FIELDS_CHANGE;
-   *      fieldIDs: {[fieldName: string]: DataID | Array<DataID>};
-   *    }
-   *    where fieldIDs map `fieldName`s from the fatQuery to a DataID or
-   *    array of DataIDs to be updated in the store.
-   *
-   * -  RANGE_ADD provides configuration for adding a new edge to a range.
-   *    {
-   *      type: MutationTypes.RANGE_ADD;
-   *      parentName: string;
-   *      parentID: string;
-   *      connectionName: string;
-   *      edgeName: string;
-   *      rangeBehaviors:
-   *        {[call: string]: RelayClassic.RangeOperation};
-   *    }
-   *    where `parentName` is the field in the fatQuery that contains the range,
-   *    `parentID` is the DataID of `parentName` in the store, `connectionName`
-   *    is the name of the range, `edgeName` is the name of the key in server
-   *    response that contains the newly created edge, `rangeBehaviors` maps
-   *    stringified representation of calls on the connection to
-   *    RelayClassic.RangeOperation.
-   *
-   * -  NODE_DELETE provides configuration for deleting a node and the
-   *    corresponding edge from a range.
-   *    {
-   *      type: MutationTypes.NODE_DELETE;
-   *      parentName: string;
-   *      parentID: string;
-   *      connectionName: string;
-   *      deletedIDFieldName: string;
-   *    }
-   *    where `parentName`, `parentID` and `connectionName` refer to the same
-   *    things as in RANGE_ADD, `deletedIDFieldName` is the name of the key in
-   *    the server response that contains the DataID of the deleted node.
-   *
-   * -  RANGE_DELETE provides configuration for deleting an edge from a range
-   *    but doesn't delete the node.
-   *    {
-   *      type: MutationTypes.RANGE_DELETE;
-   *      parentName: string;
-   *      parentID: string;
-   *      connectionName: string;
-   *      deletedIDFieldName: string | Array<string>;
-   *      pathToConnection: Array<string>;
-   *    }
-   *    where `parentName`, `parentID`, `connectionName` and
-   *    `deletedIDFieldName` refer to the same things as in NODE_DELETE.
-   *    `deletedIDFieldName` can also be a path from the response root to the
-   *    deleted node. `pathToConnection` is a path from `parentName` to
-   *    `connectionName`.
-   *
-   * -  REQUIRED_CHILDREN is used to append additional children (fragments or
-   *    fields) to the mutation query. Any data fetched for these children is
-   *    not written to the client store, but you can add code to process it
-   *    in the `onSuccess` callback passed to the `RelayEnvironment` `applyUpdate`
-   *    method. You may need to use this, for example, to fetch fields on a new
-   *    object created by the mutation (and which Relay would normally not
-   *    attempt to fetch because it has not previously fetched anything for that
-   *    object).
-   *    {
-   *      type: MutationTypes.REQUIRED_CHILDREN;
-   *      children: Array<RelayQuery.Node>;
-   *    }
-   */
-
-
-  _proto.getConfigs = function getConfigs() {
-    !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, '%s: Expected abstract method `getConfigs` to be implemented.', this.constructor.name) : require("fbjs/lib/invariant")(false) : void 0;
-  };
-  /**
-   * These variables form the "input" to the mutation query sent to the server.
-   */
-
-
-  _proto.getVariables = function getVariables() {
-    !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, '%s: Expected abstract method `getVariables` to be implemented.', this.constructor.name) : require("fbjs/lib/invariant")(false) : void 0;
-  };
-  /**
-   * These will be sent along with the mutation query to the server.
-   */
-
-
-  _proto.getFiles = function getFiles() {
-    return null;
-  };
-  /**
-   * When a request is sent to the server, mutations can optionally construct an
-   * optimistic response that has the same shape as the server response payload.
-   * This optimistic response is used to pre-emptively update the client cache
-   * to simulate an instantaneous response.
-   *
-   * The optimistic response may be a subset or superset of the actual response
-   * payload. It can be a subset if certain fields are impossible to create on
-   * the client (and if views are expected to handle the data inconsistency). It
-   * can be a superset of the actual response payload if certain fields that are
-   * affected have not been queried by the client, yet.
-   */
-
-
-  _proto.getOptimisticResponse = function getOptimisticResponse() {
-    return null;
-  };
-  /**
-   * Optional. Similar to `getConfig`, this is used to create the query
-   * corresponding to the `optimisticResponse`. If not provided, the query
-   * will be inferred from the optimistic response. Most subclasses shouldn't
-   * need to extend this method.
-   */
-
-
-  _proto.getOptimisticConfigs = function getOptimisticConfigs() {
-    return null;
-  };
-  /**
-   * An optional collision key allows a mutation to identify itself with other
-   * mutations that affect the same fields. Mutations with the same collision
-   * are sent to the server serially and in-order to avoid unpredictable and
-   * potentially incorrect behavior.
-   */
-
-
-  _proto.getCollisionKey = function getCollisionKey() {
-    return null;
-  };
-
-  _proto._resolveProps = function _resolveProps() {
-    var _this = this;
-
-    var fragments = this.constructor.fragments;
-    var initialVariables = this.constructor.initialVariables || {};
-    var props = this._unresolvedProps;
-    var resolvedProps = (0, _objectSpread2["default"])({}, props);
-
-    require("fbjs/lib/forEachObject")(fragments, function (fragmentBuilder, fragmentName) {
-      var propValue = props[fragmentName];
-      process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(propValue !== undefined, 'RelayMutation: Expected data for fragment `%s` to be supplied to ' + '`%s` as a prop. Pass an explicit `null` if this is intentional.', fragmentName, _this.constructor.name) : void 0;
-
-      if (propValue == null) {
-        return;
-      }
-
-      if (typeof propValue !== 'object') {
-        process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(false, 'RelayMutation: Expected data for fragment `%s` supplied to `%s` ' + 'to be an object.', fragmentName, _this.constructor.name) : void 0;
-        return;
-      }
-
-      var fragment = require("./RelayQuery").Fragment.create(buildMutationFragment(_this.constructor.name, fragmentName, fragmentBuilder, initialVariables), require("./RelayMetaRoute").get("$RelayMutation_".concat(_this.constructor.name)), initialVariables);
-
-      if (fragment.isPlural()) {
-        !Array.isArray(propValue) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayMutation: Invalid prop `%s` supplied to `%s`, expected an ' + 'array of records because the corresponding fragment is plural.', fragmentName, _this.constructor.name) : require("fbjs/lib/invariant")(false) : void 0;
-        var dataIDs = propValue.map(function (item, ii) {
-          !(typeof item === 'object' && item != null) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayMutation: Invalid prop `%s` supplied to `%s`, ' + 'expected element at index %s to have query data.', fragmentName, _this.constructor.name, ii) : require("fbjs/lib/invariant")(false) : void 0;
-
-          if (process.env.NODE_ENV !== "production") {
-            var hasFragmentData = require("./RelayFragmentPointer").hasFragment(item, fragment);
-
-            if (!hasFragmentData && !_this._didShowFakeDataWarning) {
-              _this._didShowFakeDataWarning = true;
-              process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(false, 'RelayMutation: Expected prop `%s` element at index %s ' + 'supplied to `%s` to be data fetched by Relay. This is ' + 'likely an error unless you are purposely passing in mock ' + "data that conforms to the shape of this mutation's fragment.", fragmentName, ii, _this.constructor.name) : void 0;
-            }
-          }
-
-          var dataID = require("./RelayRecord").getDataIDForObject(item);
-
-          !dataID ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayMutation: Invalid prop `%s` supplied to `%s`, ' + 'expected element at index %s to have query data.', fragmentName, _this.constructor.name, ii) : require("fbjs/lib/invariant")(false) : void 0;
-          return dataID;
-        });
-        resolvedProps[fragmentName] = dataIDs.map(function (dataID) {
-          return _this._environment.read(fragment, dataID);
-        });
-      } else {
-        !!Array.isArray(propValue) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayMutation: Invalid prop `%s` supplied to `%s`, expected a ' + 'single record because the corresponding fragment is not plural.', fragmentName, _this.constructor.name) : require("fbjs/lib/invariant")(false) : void 0;
-
-        if (process.env.NODE_ENV !== "production") {
-          var hasFragmentData = require("./RelayFragmentPointer").hasFragment(propValue, fragment);
-
-          if (!hasFragmentData && !_this._didShowFakeDataWarning) {
-            _this._didShowFakeDataWarning = true;
-            process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(false, 'RelayMutation: Expected prop `%s` supplied to `%s` to ' + 'be data fetched by Relay. This is likely an error unless ' + 'you are purposely passing in mock data that conforms to ' + "the shape of this mutation's fragment.", fragmentName, _this.constructor.name) : void 0;
-          }
-        }
-
-        var dataID = require("./RelayRecord").getDataIDForObject(propValue);
-
-        if (dataID) {
-          resolvedProps[fragmentName] = _this._environment.read(fragment, dataID);
-        }
-      }
-    });
-
-    this.props = resolvedProps;
-
-    if (!this._didValidateConfig) {
-      this.getConfigs().forEach(function (config) {
-        return require("./validateMutationConfig")(config, _this.constructor.name);
-      });
-      this._didValidateConfig = true;
-    }
-  };
-
-  RelayMutation.getFragment = function getFragment(fragmentName, variableMapping) {
-    var _this2 = this;
-
-    var fragments = this.fragments;
-    var fragmentBuilder = fragments[fragmentName];
-
-    if (!fragmentBuilder) {
-      !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, '%s.getFragment(): `%s` is not a valid fragment name. Available ' + 'fragments names: %s', this.name, fragmentName, Object.keys(fragments).map(function (name) {
-        return '`' + name + '`';
-      }).join(', ')) : require("fbjs/lib/invariant")(false) : void 0;
-    }
-
-    var initialVariables = this.initialVariables || {};
-    var prepareVariables = this.prepareVariables;
-    return require("./RelayFragmentReference").createForContainer(function () {
-      return buildMutationFragment(_this2.name, fragmentName, fragmentBuilder, initialVariables);
-    }, initialVariables, variableMapping, prepareVariables);
-  };
-
-  return RelayMutation;
-}();
-/**
- * Wrapper around `buildRQL.Fragment` with contextual error messages.
- */
-
-
-function buildMutationFragment(mutationName, fragmentName, fragmentBuilder, variables) {
-  var fragment = require("./buildRQL").Fragment(fragmentBuilder, variables);
-
-  !fragment ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'Relay.QL defined on mutation `%s` named `%s` is not a valid fragment. ' + 'A typical fragment is defined using: Relay.QL`fragment on Type {...}`', mutationName, fragmentName) : require("fbjs/lib/invariant")(false) : void 0;
-  return fragment;
-}
-
-module.exports = RelayMutation;

package/lib/RelayMutationDebugPrinter.js

@@ -1,47 +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
- *
- * Helper functions to print mutation queries for debugging purposes.
- */
-var RelayMutationDebugPrinter = {
-  printOptimisticMutation: function printOptimisticMutation(query, response) {
-    /* eslint-disable no-console */
-    if (!console.groupCollapsed || !console.groupEnd) {
-      return;
-    }
-
-    RelayMutationDebugPrinter.printMutation(query, 'Optimistic');
-    console.groupCollapsed('Optimistic Response');
-    console.log(response);
-    console.groupEnd();
-    /* eslint-enable no-console */
-  },
-  printMutation: function printMutation(query, name) {
-    /* eslint-disable no-console */
-    if (!console.groupCollapsed || !console.groupEnd) {
-      return;
-    }
-
-    var printedQuery = query ? require("./printRelayQuery")(query) : null;
-    name = name || 'Mutation';
-    console.groupCollapsed(name + ' Variables');
-    console.log(printedQuery ? printedQuery.variables : {});
-    console.groupEnd();
-    console.groupCollapsed(name + ' Query');
-    console.log(printedQuery ? printedQuery.text : '');
-    console.groupEnd();
-    /* eslint-enable no-console */
-  }
-};
-module.exports = RelayMutationDebugPrinter;