react-relay 2.0.0-rc.2 → 5.0.0

package/lib/RelayReadyStateRenderer.js

@@ -1,145 +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"));
-
-/**
- * @public
- *
- * RelayReadyStateRenderer synchronously renders a container and query config
- * given `readyState`. The `readyState` must be an accurate representation of
- * the data that currently resides in the supplied `environment`. If you need
- * data to be fetched in addition to rendering, please use `RelayRenderer`.
- *
- * If `readyState` is not supplied, the previously rendered `readyState` will
- * continue to be rendered (or null if there is no previous `readyState`).
- */
-var RelayReadyStateRenderer =
-/*#__PURE__*/
-function (_React$Component) {
-  (0, _inheritsLoose2["default"])(RelayReadyStateRenderer, _React$Component);
-
-  // TODO t16225453
-  function RelayReadyStateRenderer(props, context) {
-    var _this;
-
-    _this = _React$Component.call(this, props, context) || this;
-    _this._relay = {
-      environment: props.environment,
-      variables: props.queryConfig.params,
-      route: props.queryConfig
-    };
-    _this.state = {
-      getContainerProps: createContainerPropsFactory()
-    };
-    return _this;
-  }
-
-  var _proto = RelayReadyStateRenderer.prototype;
-
-  _proto.UNSAFE_componentWillReceiveProps = function UNSAFE_componentWillReceiveProps(nextProps) {
-    if (this.props.environment !== nextProps.environment || this.props.queryConfig !== nextProps.queryConfig) {
-      this._relay = {
-        environment: nextProps.environment,
-        variables: nextProps.queryConfig.params,
-        route: nextProps.queryConfig
-      };
-    }
-  };
-  /**
-   * Avoid updating when we have fetched data but are still not ready.
-   */
-
-
-  _proto.shouldComponentUpdate = function shouldComponentUpdate(nextProps) {
-    var prevProps = this.props;
-
-    if (prevProps.Container !== nextProps.Container || prevProps.environment !== nextProps.environment || prevProps.queryConfig !== nextProps.queryConfig || prevProps.render !== nextProps.render || prevProps.retry !== nextProps.retry) {
-      return true;
-    }
-
-    var prevReadyState = prevProps.readyState;
-    var nextReadyState = nextProps.readyState;
-
-    if (prevReadyState == null || nextReadyState == null) {
-      return true;
-    }
-
-    if (prevReadyState.aborted !== nextReadyState.aborted || prevReadyState.done !== nextReadyState.done || prevReadyState.error !== nextReadyState.error || prevReadyState.ready !== nextReadyState.ready || prevReadyState.stale !== nextReadyState.stale) {
-      return true;
-    }
-
-    return nextReadyState.ready;
-  };
-
-  _proto.render = function render() {
-    var children;
-    var shouldUpdate = false;
-    var _this$props = this.props,
-        readyState = _this$props.readyState,
-        render = _this$props.render;
-
-    if (readyState) {
-      if (render) {
-        children = render({
-          done: readyState.done,
-          error: readyState.error,
-          events: readyState.events,
-          props: readyState.ready ? this.state.getContainerProps(this.props) : null,
-          retry: this.props.retry,
-          stale: readyState.stale
-        });
-      } else if (readyState.ready) {
-        var Container = this.props.Container;
-        children = require("react").createElement(Container, this.state.getContainerProps(this.props));
-      }
-
-      shouldUpdate = true;
-    }
-
-    if (children === undefined) {
-      children = null;
-      shouldUpdate = false;
-    }
-
-    return require("react").createElement(require("./ReactRelayContext").Provider, {
-      value: this._relay
-    }, require("react").createElement(require("./RelayStaticContainer"), {
-      shouldUpdate: shouldUpdate
-    }, children));
-  };
-
-  return RelayReadyStateRenderer;
-}(require("react").Component);
-
-function createContainerPropsFactory() {
-  var prevProps;
-  var querySet;
-  return function (nextProps) {
-    if (!querySet || !prevProps || prevProps.Container !== nextProps.Container || prevProps.queryConfig !== nextProps.queryConfig) {
-      querySet = require("./getRelayQueries")(nextProps.Container, nextProps.queryConfig);
-    }
-
-    var containerProps = (0, _objectSpread2["default"])({}, nextProps.queryConfig.params, require("fbjs/lib/mapObject")(querySet, function (query) {
-      return createFragmentPointerForRoot(nextProps.environment, query);
-    }));
-    prevProps = nextProps;
-    return containerProps;
-  };
-}
-
-function createFragmentPointerForRoot(environment, query) {
-  return query ? require("./RelayFragmentPointer").createForRoot(environment.getStoreData().getQueuedStore(), query) : null;
-}
-
-module.exports = RelayReadyStateRenderer;

package/lib/RelayRecord.js

@@ -1,75 +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 MetadataKey = {
-  DATA_ID: '__dataID__',
-  FILTER_CALLS: '__filterCalls__',
-  FORCE_INDEX: '__forceIndex__',
-  MUTATION_IDS: '__mutationIDs__',
-  MUTATION_STATUS: '__mutationStatus__',
-  PATH: '__path__',
-  RANGE: '__range__',
-  RESOLVED_DEFERRED_FRAGMENTS: '__resolvedDeferredFragments__',
-  RESOLVED_FRAGMENT_MAP: '__resolvedFragmentMap__',
-  RESOLVED_FRAGMENT_MAP_GENERATION: '__resolvedFragmentMapGeneration__',
-  STATUS: '__status__'
-};
-var metadataKeyLookup = {};
-Object.keys(MetadataKey).forEach(function (name) {
-  metadataKeyLookup[MetadataKey[name]] = true;
-});
-/**
- * Records are plain objects with special metadata properties.
- */
-
-var RelayRecord = {
-  MetadataKey: MetadataKey,
-  create: function create(dataID) {
-    return {
-      __dataID__: dataID
-    };
-  },
-  createWithFields: function createWithFields(dataID, fields) {
-    return (0, _objectSpread2["default"])({
-      __dataID__: dataID
-    }, fields);
-  },
-  isRecord: function isRecord(maybeRecord) {
-    return typeof maybeRecord === 'object' && maybeRecord != null && !Array.isArray(maybeRecord) && typeof maybeRecord.__dataID__ === 'string';
-  },
-  getRecord: function getRecord(maybeRecord) {
-    if (RelayRecord.isRecord(maybeRecord)) {
-      return maybeRecord;
-    } else {
-      return null;
-    }
-  },
-  getDataID: function getDataID(record) {
-    return record.__dataID__;
-  },
-  getDataIDForObject: function getDataIDForObject(maybeRecord) {
-    return maybeRecord.__dataID__;
-  },
-
-  /**
-   * Checks whether the given ID was created on the client, as opposed to an ID
-   * that's understood by the server as well.
-   */
-  isClientID: function isClientID(dataID) {
-    return dataID.indexOf('client:') === 0;
-  },
-  isMetadataKey: function isMetadataKey(key) {
-    return metadataKeyLookup.hasOwnProperty(key);
-  }
-};
-module.exports = RelayRecord;

package/lib/RelayRecordStatusMap.js

@@ -1,57 +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';
-/**
- * Record might contain data from optimistic update.
- */
-
-var OPTIMISTIC_MASK = 0x01;
-/**
- * The subtree of data from this record contains partial data.
- */
-
-var PARTIAL_MASK = 0x04;
-
-function set(status, value, mask) {
-  status = status || 0;
-
-  if (value) {
-    return status | mask; // eslint-disable-line no-bitwise
-  } else {
-    return status & ~mask; // eslint-disable-line no-bitwise
-  }
-}
-
-function check(status, mask) {
-  return ((status || 0) & mask) !== 0; // eslint-disable-line no-bitwise
-}
-/**
- * A set of functions for modifying `__status__` on records inside of
- * RelayStore.
- */
-
-
-var RelayRecordStatusMap = {
-  setOptimisticStatus: function setOptimisticStatus(status, value) {
-    return set(status, value, OPTIMISTIC_MASK);
-  },
-  isOptimisticStatus: function isOptimisticStatus(status) {
-    return check(status, OPTIMISTIC_MASK);
-  },
-  // Should only be used on records read out from RelayRecordStore
-  // by `readRelayQueryData`.
-  setPartialStatus: function setPartialStatus(status, value) {
-    return set(status, value, PARTIAL_MASK);
-  },
-  isPartialStatus: function isPartialStatus(status) {
-    return check(status, PARTIAL_MASK);
-  }
-};
-module.exports = RelayRecordStatusMap;

package/lib/RelayRecordStore.js

@@ -1,433 +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 EMPTY = '';
-
-var FILTER_CALLS = require("./RelayRecord").MetadataKey.FILTER_CALLS,
-    FORCE_INDEX = require("./RelayRecord").MetadataKey.FORCE_INDEX,
-    MUTATION_IDS = require("./RelayRecord").MetadataKey.MUTATION_IDS,
-    PATH = require("./RelayRecord").MetadataKey.PATH,
-    RANGE = require("./RelayRecord").MetadataKey.RANGE,
-    RESOLVED_FRAGMENT_MAP = require("./RelayRecord").MetadataKey.RESOLVED_FRAGMENT_MAP;
-/**
- * @internal
- *
- * `RelayRecordStore` is the central repository for all data fetched by the
- * client. Data is stored as a map from IDs to Records. Records are shapes of
- * data with globally unique "data IDs".
- */
-
-
-var RelayRecordStore =
-/*#__PURE__*/
-function () {
-  function RelayRecordStore(records, rootCallMaps, nodeConnectionMap) {
-    this._cachedRecords = records.cachedRecords;
-    this._cachedRootCallMap = rootCallMaps && rootCallMaps.cachedRootCallMap || {};
-    this._queuedRecords = records.queuedRecords;
-    this._nodeConnectionMap = nodeConnectionMap || {};
-    this._records = records.records;
-    this._rootCallMap = rootCallMaps && rootCallMaps.rootCallMap || {};
-    this._storage = [];
-
-    if (this._queuedRecords) {
-      this._storage.push(this._queuedRecords);
-    }
-
-    if (this._records) {
-      this._storage.push(this._records);
-    }
-
-    if (this._cachedRecords) {
-      this._storage.push(this._cachedRecords);
-    }
-  }
-  /**
-   * Get the data ID associated with a storage key (and optionally an
-   * identifying argument value) for a root query.
-   */
-
-
-  var _proto = RelayRecordStore.prototype;
-
-  _proto.getDataID = function getDataID(storageKey, identifyingArgValue) {
-    if (require("./RelayNodeInterface").isNodeRootCall(storageKey)) {
-      !(identifyingArgValue != null) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRecordStore.getDataID(): Argument to `%s()` ' + 'cannot be null or undefined.', storageKey) : require("fbjs/lib/invariant")(false) : void 0;
-      return identifyingArgValue;
-    }
-
-    if (identifyingArgValue == null) {
-      identifyingArgValue = EMPTY;
-    }
-
-    if (this._rootCallMap.hasOwnProperty(storageKey) && this._rootCallMap[storageKey].hasOwnProperty(identifyingArgValue)) {
-      return this._rootCallMap[storageKey][identifyingArgValue];
-    } else if (this._cachedRootCallMap.hasOwnProperty(storageKey)) {
-      return this._cachedRootCallMap[storageKey][identifyingArgValue];
-    }
-  };
-  /**
-   * Returns the status of the record stored at `dataID`.
-   */
-
-
-  _proto.getRecordState = function getRecordState(dataID) {
-    var record = this._getRecord(dataID);
-
-    if (record === null) {
-      return require("./RelayClassicRecordState").NONEXISTENT;
-    } else if (record === undefined) {
-      return require("./RelayClassicRecordState").UNKNOWN;
-    }
-
-    return require("./RelayClassicRecordState").EXISTENT;
-  };
-  /**
-   * Returns the path to a non-refetchable record.
-   */
-
-
-  _proto.getPathToRecord = function getPathToRecord(dataID) {
-    var path = this._getField(dataID, PATH);
-
-    return path;
-  };
-  /**
-   * Returns whether a given record is affected by an optimistic update.
-   */
-
-
-  _proto.hasOptimisticUpdate = function hasOptimisticUpdate(dataID) {
-    var queuedRecords = this._queuedRecords;
-    return queuedRecords ? queuedRecords.hasOwnProperty(dataID) : false;
-  };
-  /**
-   * Returns a list of client mutation IDs for queued mutations whose optimistic
-   * updates are affecting the record corresponding the given dataID. Returns
-   * null if the record isn't affected by any optimistic updates.
-   */
-
-
-  _proto.getClientMutationIDs = function getClientMutationIDs(dataID) {
-    var queuedRecords = this._queuedRecords;
-
-    if (queuedRecords) {
-      var record = queuedRecords[dataID];
-
-      if (record) {
-        return record[MUTATION_IDS];
-      }
-    }
-
-    return null;
-  };
-  /**
-   * Check whether a given record has received data for a deferred fragment.
-   */
-
-
-  _proto.hasFragmentData = function hasFragmentData(dataID, fragmentID) {
-    var resolvedFragmentMap = this._getField(dataID, RESOLVED_FRAGMENT_MAP);
-
-    !(typeof resolvedFragmentMap === 'object' || resolvedFragmentMap == null) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRecordStore.hasFragmentData(): Expected the map of ' + 'resolved deferred fragments associated with record `%s` to be null or ' + 'an object. Found a(n) `%s`.', dataID, typeof resolvedFragmentMap) : require("fbjs/lib/invariant")(false) : void 0;
-    return !!(resolvedFragmentMap && resolvedFragmentMap[fragmentID]);
-  };
-
-  _proto.getType = function getType(dataID) {
-    // `__typename` property is typed as `string`
-    return this._getField(dataID, '__typename');
-  };
-  /**
-   * Returns the value of the field for the given dataID.
-   */
-
-
-  _proto.getField = function getField(dataID, storageKey) {
-    return this._getField(dataID, storageKey);
-  };
-  /**
-   * Returns the Data ID of a linked record (eg the ID of the `address` record
-   * in `actor{address}`).
-   */
-
-
-  _proto.getLinkedRecordID = function getLinkedRecordID(dataID, storageKey) {
-    var field = this._getField(dataID, storageKey);
-
-    if (field == null) {
-      return field;
-    }
-
-    var record = require("./RelayRecord").getRecord(field);
-
-    !record ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRecordStore.getLinkedRecordID(): Expected field `%s` for record ' + '`%s` to have a linked record.', storageKey, dataID) : require("fbjs/lib/invariant")(false) : void 0;
-    return require("./RelayRecord").getDataID(record);
-  };
-  /**
-   * Returns an array of Data ID for a plural linked field (eg the actor IDs of
-   * the `likers` in `story{likers}`).
-   */
-
-
-  _proto.getLinkedRecordIDs = function getLinkedRecordIDs(dataID, storageKey) {
-    var field = this._getField(dataID, storageKey);
-
-    if (field == null) {
-      return field;
-    }
-
-    !Array.isArray(field) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRecordStore.getLinkedRecordIDs(): Expected field `%s` for ' + 'record `%s` to have an array of linked records.', storageKey, dataID) : require("fbjs/lib/invariant")(false) : void 0;
-    return field.map(function (element, ii) {
-      var record = require("./RelayRecord").getRecord(element);
-
-      !record ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRecordStore.getLinkedRecordIDs(): Expected element at index %s ' + 'in field `%s` for record `%s` to be a linked record.', ii, storageKey, dataID) : require("fbjs/lib/invariant")(false) : void 0;
-      return require("./RelayRecord").getDataID(record);
-    });
-  };
-  /**
-   * Gets the connectionIDs for all the connections that contain the given
-   * record as a `node`, or null if the record does not appear as a `node` in
-   * any connection.
-   */
-
-
-  _proto.getConnectionIDsForRecord = function getConnectionIDsForRecord(dataID) {
-    var connectionIDs = this._nodeConnectionMap[dataID];
-
-    if (connectionIDs) {
-      return Object.keys(connectionIDs);
-    }
-
-    return null;
-  };
-  /**
-   * Gets the connectionIDs for all variations of calls for the given base
-   * schema name (Ex: `posts.orderby(recent)` and `posts.orderby(likes)`).
-   */
-
-
-  _proto.getConnectionIDsForField = function getConnectionIDsForField(dataID, schemaName) {
-    // ignore queued records because not all range fields may be present there
-    var record = this._records[dataID];
-
-    if (record == null) {
-      return record;
-    }
-
-    var connectionIDs;
-
-    require("fbjs/lib/forEachObject")(record, function (datum, key) {
-      if (datum && getFieldNameFromKey(key) === schemaName) {
-        // $FlowFixMe(site=www,mobile) forEachObject is only typed in www
-        var connectionID = require("./RelayRecord").getDataIDForObject(datum);
-
-        if (connectionID) {
-          connectionIDs = connectionIDs || [];
-          connectionIDs.push(connectionID);
-        }
-      }
-    });
-
-    return connectionIDs;
-  };
-  /**
-   * Get the force index associated with the range at `connectionID`.
-   */
-
-
-  _proto.getRangeForceIndex = function getRangeForceIndex(connectionID) {
-    var forceIndex = this._getField(connectionID, FORCE_INDEX);
-
-    if (forceIndex === null) {
-      return -1;
-    }
-
-    return forceIndex || 0;
-  };
-  /**
-   * Get the condition calls that were used to fetch the given connection.
-   * Ex: for a field `photos.orderby(recent)`, this would be
-   * [{name: 'orderby', value: 'recent'}]
-   */
-
-
-  _proto.getRangeFilterCalls = function getRangeFilterCalls(connectionID) {
-    return this._getField(connectionID, FILTER_CALLS);
-  };
-  /**
-   * Returns range information for the given connection field:
-   * - `filteredEdges`: any edges already fetched for the given `calls`.
-   * - `diffCalls`: an array of calls describing the difference
-   *   between the given `calls` and already fetched data. Includes conditional
-   *   calls (`orderby`) and range/offset calls (`first`, `after`).
-   * - `filterCalls`: the subset of `calls` that are condition calls
-   *   (`orderby`).
-   */
-
-
-  _proto.getRangeMetadata = function getRangeMetadata(connectionID, calls) {
-    var _this = this;
-
-    if (connectionID == null) {
-      return connectionID;
-    }
-
-    var range = this._getField(connectionID, RANGE);
-
-    if (range == null) {
-      if (range === null) {
-        process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(false, 'RelayRecordStore.getRangeMetadata(): Expected range to exist if ' + '`edges` has been fetched.') : void 0;
-      }
-
-      return undefined;
-    }
-
-    var filterCalls = getFilterCalls(calls); // Edges can only be fetched if a range call (first/last/find) is given.
-    // Otherwise return diffCalls/filterCalls with empty edges.
-
-    if (calls.length === filterCalls.length) {
-      return {
-        diffCalls: calls,
-        filterCalls: filterCalls,
-        pageInfo: undefined,
-        requestedEdgeIDs: [],
-        filteredEdges: []
-      };
-    }
-
-    var queuedRecord = this._queuedRecords ? this._queuedRecords[connectionID] : null;
-    var rangeInfo = range.retrieveRangeInfoForQuery(calls, queuedRecord);
-    var diffCalls = rangeInfo.diffCalls;
-    var pageInfo = rangeInfo.pageInfo,
-        requestedEdgeIDs = rangeInfo.requestedEdgeIDs;
-
-    if (diffCalls && diffCalls.length) {
-      diffCalls = filterCalls.concat(diffCalls);
-    } else {
-      diffCalls = [];
-    }
-
-    var filteredEdges;
-
-    if (requestedEdgeIDs) {
-      var _ConnectionInterface$ = require("relay-runtime").ConnectionInterface.get(),
-          NODE = _ConnectionInterface$.NODE;
-
-      filteredEdges = requestedEdgeIDs.map(function (edgeID) {
-        return {
-          edgeID: edgeID,
-          nodeID: _this.getLinkedRecordID(edgeID, NODE)
-        };
-      }).filter(function (edge) {
-        return _this._getRecord(edge.nodeID);
-      });
-    } else {
-      filteredEdges = [];
-    }
-
-    return {
-      diffCalls: diffCalls,
-      filterCalls: filterCalls,
-      pageInfo: pageInfo,
-      requestedEdgeIDs: requestedEdgeIDs,
-      filteredEdges: filteredEdges
-    };
-  };
-  /**
-   * Returns whether there is a range at `connectionID`.
-   */
-
-
-  _proto.hasRange = function hasRange(connectionID) {
-    return !!this._getField(connectionID, RANGE);
-  };
-  /**
-   * Completely removes the record identified by `dataID` from the store.
-   * This is only used by garbage collection.
-   */
-
-
-  _proto.removeRecord = function removeRecord(dataID) {
-    delete this._records[dataID];
-
-    if (this._queuedRecords) {
-      delete this._queuedRecords[dataID];
-    }
-
-    if (this._cachedRecords) {
-      delete this._cachedRecords[dataID];
-    }
-
-    delete this._nodeConnectionMap[dataID];
-  };
-  /**
-   * Gets the first version of the record from the available caches.
-   */
-
-
-  _proto._getRecord = function _getRecord(dataID) {
-    if (this._queuedRecords && this._queuedRecords.hasOwnProperty(dataID)) {
-      return this._queuedRecords[dataID];
-    } else if (this._records.hasOwnProperty(dataID)) {
-      return this._records[dataID];
-    } else if (this._cachedRecords) {
-      return this._cachedRecords[dataID];
-    }
-  };
-  /**
-   * Get the value of the field from the first version of the record for which
-   * the field is defined, returning `null` if the record has been deleted or
-   * `undefined` if the record has not been fetched.
-   */
-
-
-  _proto._getField = function _getField(dataID, storageKey) {
-    var storage = this._storage;
-
-    for (var ii = 0; ii < storage.length; ii++) {
-      var record = storage[ii][dataID];
-
-      if (record === null) {
-        return null;
-      } else if (record && record.hasOwnProperty(storageKey)) {
-        return record[storageKey];
-      }
-    }
-
-    return undefined;
-  };
-
-  return RelayRecordStore;
-}();
-/**
- * Filter calls to only those that specify conditions on the returned results
- * (ex: `orderby(TOP_STORIES)`), removing generic calls (ex: `first`, `find`).
- */
-
-
-function getFilterCalls(calls) {
-  return calls.filter(function (call) {
-    return !require("relay-runtime").ConnectionInterface.isConnectionCall(call);
-  });
-}
-/**
- * Returns the field name based on the object key used to store the data in
- * nodeData. It returns the field name without any calls. For example, the
- * field name for 'profile_picture{size:"50"}' will be 'profile_picture'
- */
-
-
-function getFieldNameFromKey(key) {
-  // This is based on the GraphQL spec for what constitutes a valid field name.
-  return key.split(/(?![_A-Za-z][_0-9A-Za-z]*)/, 1)[0];
-}
-
-module.exports = RelayRecordStore;