relay-runtime 1.3.0 → 1.5.0

package/PATENTS

@@ -1,33 +0,0 @@
-Additional Grant of Patent Rights Version 2
-
-"Software" means the Relay software distributed by Facebook, Inc.
-
-Facebook, Inc. ("Facebook") hereby grants to each recipient of the Software
-("you") a perpetual, worldwide, royalty-free, non-exclusive, irrevocable
-(subject to the termination provision below) license under any Necessary
-Claims, to make, have made, use, sell, offer to sell, import, and otherwise
-transfer the Software. For avoidance of doubt, no license is granted under
-Facebook's rights in any patent claims that are infringed by (i) modifications
-to the Software made by you or any third party or (ii) the Software in
-combination with any software or other technology.
-
-The license granted hereunder will terminate, automatically and without notice,
-if you (or any of your subsidiaries, corporate affiliates or agents) initiate
-directly or indirectly, or take a direct financial interest in, any Patent
-Assertion: (i) against Facebook or any of its subsidiaries or corporate
-affiliates, (ii) against any party if such Patent Assertion arises in whole or
-in part from any software, technology, product or service of Facebook or any of
-its subsidiaries or corporate affiliates, or (iii) against any party relating
-to the Software. Notwithstanding the foregoing, if Facebook or any of its
-subsidiaries or corporate affiliates files a lawsuit alleging patent
-infringement against you in the first instance, and you respond by filing a
-patent infringement counterclaim in that lawsuit against that party that is
-unrelated to the Software, the license granted hereunder will not terminate
-under section (i) of this paragraph due to such counterclaim.
-
-A "Necessary Claim" is a claim of a patent owned by Facebook that is
-necessarily infringed by the Software standing alone.
-
-A "Patent Assertion" is any lawsuit or other action alleging direct, indirect,
-or contributory infringement or inducement to infringe any patent, including a
-cross-claim or counterclaim.

package/lib/ConvertToObserveFunction.js

@@ -1,39 +0,0 @@
-/**
- * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
- *
- * @providesModule ConvertToObserveFunction
- * 
- * @format
- */
-
-'use strict';
-
-/**
- * Converts a FetchFunction into an ObserveFunction for use by RelayNetwork.
- */
-function convertFetch(fn) {
-  return function fetch(operation, variables, cacheConfig, uploadables) {
-    return require('./RelayObservable').from(fn(operation, variables, cacheConfig, uploadables));
-  };
-}
-
-/**
- * Converts a SubscribeFunction into an ObserveFunction for use by RelayNetwork.
- */
-function convertSubscribe(fn) {
-  return function subscribe(operation, variables, cacheConfig) {
-    return require('./RelayObservable').fromLegacy(function (observer) {
-      return fn(operation, variables, cacheConfig, observer);
-    });
-  };
-}
-
-module.exports = {
-  convertFetch: convertFetch,
-  convertSubscribe: convertSubscribe
-};

package/lib/RelayDebugger.js

@@ -1,199 +0,0 @@
-/**
- * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
- *
- * @providesModule RelayDebugger
- * 
- * @format
- */
-
-'use strict';
-
-var _classCallCheck3 = _interopRequireDefault(require('babel-runtime/helpers/classCallCheck'));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
-
-var RelayDebugger = function () {
-  function RelayDebugger() {
-    (0, _classCallCheck3['default'])(this, RelayDebugger);
-
-    this._idCounter = 1;
-    this._envDebuggers = new Map();
-  }
-
-  RelayDebugger.prototype.registerEnvironment = function registerEnvironment(env) {
-    var idString = 'RelayModernEnvironment' + this._idCounter++;
-    this._envDebuggers.set(idString, new EnvironmentDebugger(env, idString));
-    return idString;
-  };
-
-  RelayDebugger.prototype.getEnvironmentDebugger = function getEnvironmentDebugger(id) {
-    var envDebugger = this._envDebuggers.get(id);
-    if (!envDebugger) {
-      throw new Error('No registered environment: ' + id);
-    }
-
-    return envDebugger;
-  };
-
-  RelayDebugger.prototype.getRegisteredEnvironmentIds = function getRegisteredEnvironmentIds() {
-    return Array.from(this._envDebuggers.keys());
-  };
-
-  return RelayDebugger;
-}();
-
-var EnvironmentDebugger = function () {
-  function EnvironmentDebugger(environment, id) {
-    (0, _classCallCheck3['default'])(this, EnvironmentDebugger);
-
-    this._environment = environment;
-    this._id = id;
-    this._envIsDirty = false;
-    this._monkeyPatchSource();
-
-    this._recordedMutationEvents = [];
-    this._isRecordingMutationEvents = false;
-  }
-
-  EnvironmentDebugger.prototype.getEnvironment = function getEnvironment() {
-    return this._environment;
-  };
-
-  EnvironmentDebugger.prototype.getId = function getId() {
-    return this._id;
-  };
-
-  EnvironmentDebugger.prototype.getMatchingRecords = function getMatchingRecords(matchStr, matchType) {
-    var inspector = require('./RelayRecordSourceInspector').getForEnvironment(this._environment);
-
-    function isMatching(record) {
-      if (matchType === 'idtype') {
-        return record.id.includes(matchStr) || !!record.type && record.type.includes(matchStr);
-      }
-      if (matchType === 'id') {
-        return record.id.includes(matchStr);
-      }
-      if (matchType === 'type') {
-        return !!record.type && record.type.includes(matchStr);
-      }
-      if (matchType === 'predicate') {
-        var recordInspector = inspector.get(record.id);
-        var fields = recordInspector && recordInspector.inspect();
-        if (typeof fields === 'object' && fields !== null) {
-          throw new Error('Not implemented');
-        }
-        return false;
-      }
-      throw new Error('Unknown match type: ' + matchType);
-    }
-
-    return inspector.getRecords().filter(isMatching);
-  };
-
-  EnvironmentDebugger.prototype.getRecord = function getRecord(id) {
-    var inspector = require('./RelayRecordSourceInspector').getForEnvironment(this._environment);
-    var recordInspector = inspector.get(id);
-    return recordInspector && recordInspector.inspect();
-  };
-
-  EnvironmentDebugger.prototype._monkeyPatchSource = function _monkeyPatchSource() {
-    var _this = this;
-
-    var source = this._environment.getStore().getSource();
-    var originalSet = source.set;
-    var originalRemove = source.remove;
-
-    source.set = function () {
-      for (var _len = arguments.length, args = Array(_len), _key = 0; _key < _len; _key++) {
-        args[_key] = arguments[_key];
-      }
-
-      originalSet.apply(source, args);
-      _this.triggerDirty();
-    };
-    source.remove = function () {
-      for (var _len2 = arguments.length, args = Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-        args[_key2] = arguments[_key2];
-      }
-
-      originalRemove.apply(source, args);
-      _this.triggerDirty();
-    };
-  };
-
-  EnvironmentDebugger.prototype.triggerDirty = function triggerDirty() {
-    this._envIsDirty = true;
-  };
-
-  EnvironmentDebugger.prototype.isDirty = function isDirty() {
-    return this._envIsDirty;
-  };
-
-  EnvironmentDebugger.prototype.resetDirty = function resetDirty() {
-    this._envIsDirty = false;
-  };
-
-  EnvironmentDebugger.prototype.startRecordingMutationEvents = function startRecordingMutationEvents() {
-    this._isRecordingMutationEvents = true;
-    this._recordedMutationEvents = [];
-  };
-
-  EnvironmentDebugger.prototype.stopRecordingMutationEvents = function stopRecordingMutationEvents() {
-    this._isRecordingMutationEvents = false;
-  };
-
-  EnvironmentDebugger.prototype.getRecordedMutationEvents = function getRecordedMutationEvents() {
-    return this._recordedMutationEvents;
-  };
-
-  EnvironmentDebugger.prototype.recordMutationEvent = function recordMutationEvent(_ref) {
-    var eventName = _ref.eventName,
-        seriesId = _ref.seriesId,
-        payload = _ref.payload,
-        mutation = _ref.mutation,
-        fn = _ref.fn;
-
-    if (this._isRecordingMutationEvents) {
-      var getSnapshot = function getSnapshot() {
-        var snapshot = {};
-        var ids = source.getRecordIDs();
-        ids.forEach(function (id) {
-          snapshot[id] = source.get(id);
-        });
-        return snapshot;
-      };
-
-      var source = this._environment.getStore().getSource();
-
-
-      var _snapshotBefore = getSnapshot();
-      fn();
-      var _snapshotAfter = getSnapshot();
-
-      var event = {
-        eventName: eventName,
-        seriesId: seriesId,
-        payload: payload,
-        snapshotBefore: _snapshotBefore,
-        snapshotAfter: _snapshotAfter,
-        mutation: mutation
-      };
-
-      this._recordedMutationEvents.push(event);
-    } else {
-      fn();
-    }
-  };
-
-  return EnvironmentDebugger;
-}();
-
-module.exports = {
-  RelayDebugger: RelayDebugger,
-  EnvironmentDebugger: EnvironmentDebugger
-};

package/lib/RelayRecordSourceInspector.js

@@ -1,289 +0,0 @@
-/**
- * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
- *
- * @providesModule RelayRecordSourceInspector
- * 
- * @format
- */
-
-'use strict';
-
-var _classCallCheck3 = _interopRequireDefault(require('babel-runtime/helpers/classCallCheck'));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
-
-var _require = require('./RelayStoreUtils'),
-    ROOT_ID = _require.ROOT_ID,
-    ROOT_TYPE = _require.ROOT_TYPE;
-
-var _require2 = require('./RelayStoreUtils'),
-    REF_KEY = _require2.REF_KEY,
-    REFS_KEY = _require2.REFS_KEY;
-
-/**
- * A class intended for introspecting a RecordSource and its Records during
- * development.
- */
-var RelayRecordSourceInspector = function () {
-  RelayRecordSourceInspector.getForEnvironment = function getForEnvironment(environment) {
-    return new RelayRecordSourceInspector(environment.getStore().getSource());
-  };
-
-  function RelayRecordSourceInspector(source) {
-    (0, _classCallCheck3['default'])(this, RelayRecordSourceInspector);
-
-    this._proxies = {};
-    this._source = source;
-  }
-
-  /**
-   * Returns an inspector for the record with the given id, or null/undefined if
-   * that record is deleted/unfetched.
-   */
-
-
-  RelayRecordSourceInspector.prototype.get = function get(dataID) {
-    if (!this._proxies.hasOwnProperty(dataID)) {
-      var record = this._source.get(dataID);
-      if (record != null) {
-        this._proxies[dataID] = new RecordInspector(this, record);
-      } else {
-        this._proxies[dataID] = record;
-      }
-    }
-    return this._proxies[dataID];
-  };
-
-  /**
-   * Returns a list of "<id>: <type>" for each record in the store that has an
-   * `id`.
-   */
-
-
-  RelayRecordSourceInspector.prototype.getNodes = function getNodes() {
-    var _this = this;
-
-    var nodes = [];
-    this._source.getRecordIDs().forEach(function (dataID) {
-      if (dataID.indexOf('client:') === 0) {
-        return;
-      }
-      var record = _this._source.get(dataID);
-      nodes.push(RecordSummary.createFromRecord(dataID, record));
-    });
-    return nodes;
-  };
-
-  /**
-   * Returns a list of "<id>: <type>" for all records in the store including
-   * those that do not have an `id`.
-   */
-
-
-  RelayRecordSourceInspector.prototype.getRecords = function getRecords() {
-    var _this2 = this;
-
-    return this._source.getRecordIDs().map(function (dataID) {
-      var record = _this2._source.get(dataID);
-      return RecordSummary.createFromRecord(dataID, record);
-    });
-  };
-
-  /**
-   * Returns an inspector for the synthesized "root" object, allowing access to
-   * e.g. the `viewer` object or the results of other fields on the "Query"
-   * type.
-   */
-
-
-  RelayRecordSourceInspector.prototype.getRoot = function getRoot() {
-    var root = this.get(ROOT_ID);
-    require('fbjs/lib/invariant')(root && root.getType() === ROOT_TYPE, 'RelayRecordSourceProxy#getRoot(): Expected the source to contain a ' + 'root record.');
-    // Make viewer more accessible: if a record is not present on the original
-    // field name but is present on the viewer handle field, rewrite the getter
-    // to make `root.viewer` work.
-    if (root.viewer == null) {
-      var viewerHandle = require('./getRelayHandleKey')('viewer', null, 'viewer');
-      var unsafeRoot = root; // to access getter properties
-      if (unsafeRoot[viewerHandle] != null) {
-        Object.defineProperty(unsafeRoot, 'viewer', {
-          configurable: true,
-          enumerable: true,
-          get: function get() {
-            return unsafeRoot[viewerHandle];
-          }
-        });
-      }
-    }
-    return root;
-  };
-
-  return RelayRecordSourceInspector;
-}();
-
-/**
- * Internal class for inspecting a single Record.
- */
-
-
-var RecordInspector = function () {
-  function RecordInspector(sourceInspector, record) {
-    var _this3 = this;
-
-    (0, _classCallCheck3['default'])(this, RecordInspector);
-
-    this._record = record;
-    this._sourceInspector = sourceInspector;
-
-    // Make it easier to inspect the record in a debugger console:
-    // defined properties appear in autocomplete when typing "obj."
-    require('fbjs/lib/forEachObject')(record, function (value, key) {
-      var identifier = key.replace(/[^_a-zA-Z0-9]/g, '_');
-      if (typeof value === 'object' && value !== null) {
-        if (value.hasOwnProperty(REF_KEY)) {
-          Object.defineProperty(_this3, identifier, {
-            configurable: true,
-            enumerable: true,
-            get: function get() {
-              return this.getLinkedRecord(key);
-            }
-          });
-        } else if (value.hasOwnProperty(REFS_KEY)) {
-          Object.defineProperty(_this3, identifier, {
-            configurable: true,
-            enumerable: true,
-            get: function get() {
-              return this.getLinkedRecords(key);
-            }
-          });
-        }
-      } else {
-        Object.defineProperty(_this3, identifier, {
-          configurable: true,
-          enumerable: true,
-          get: function get() {
-            return this.getValue(key);
-          }
-        });
-      }
-    });
-  }
-
-  /**
-   * Get the cache id of the given record. For types that implement the `Node`
-   * interface (or that have an `id`) this will be `id`, for other types it will be
-   * a synthesized identifier based on the field path from the nearest ancestor
-   * record that does have an `id`.
-   */
-
-
-  RecordInspector.prototype.getDataID = function getDataID() {
-    return require('./RelayModernRecord').getDataID(this._record);
-  };
-
-  /**
-   * Returns a list of the fields that have been fetched on the current record.
-   */
-
-
-  RecordInspector.prototype.getFields = function getFields() {
-    return Object.keys(this._record).sort();
-  };
-
-  /**
-   * Returns the type of the record.
-   */
-
-
-  RecordInspector.prototype.getType = function getType() {
-    return require('./RelayModernRecord').getType(this._record);
-  };
-
-  /**
-   * Returns a copy of the internal representation of the record.
-   */
-
-
-  RecordInspector.prototype.inspect = function inspect() {
-    return require('./simpleClone')(this._record);
-  };
-
-  /**
-   * Returns the value of a scalar field. May throw if the given field is
-   * present but not actually scalar.
-   */
-
-
-  RecordInspector.prototype.getValue = function getValue(name, args) {
-    var storageKey = args ? require('./formatStorageKey')(name, args) : name;
-    return require('./RelayModernRecord').getValue(this._record, storageKey);
-  };
-
-  /**
-   * Returns an inspector for the given scalar "linked" field (a field whose
-   * value is another Record instead of a scalar). May throw if the field is
-   * present but not a scalar linked record.
-   */
-
-
-  RecordInspector.prototype.getLinkedRecord = function getLinkedRecord(name, args) {
-    var storageKey = args ? require('./formatStorageKey')(name, args) : name;
-    var linkedID = require('./RelayModernRecord').getLinkedRecordID(this._record, storageKey);
-    return linkedID != null ? this._sourceInspector.get(linkedID) : linkedID;
-  };
-
-  /**
-   * Returns an array of inspectors for the given plural "linked" field (a field
-   * whose value is an array of Records instead of a scalar). May throw if the
-   * field is  present but not a plural linked record.
-   */
-
-
-  RecordInspector.prototype.getLinkedRecords = function getLinkedRecords(name, args) {
-    var _this4 = this;
-
-    var storageKey = args ? require('./formatStorageKey')(name, args) : name;
-    var linkedIDs = require('./RelayModernRecord').getLinkedRecordIDs(this._record, storageKey);
-    if (linkedIDs == null) {
-      return linkedIDs;
-    }
-    return linkedIDs.map(function (linkedID) {
-      return linkedID != null ? _this4._sourceInspector.get(linkedID) : linkedID;
-    });
-  };
-
-  return RecordInspector;
-}();
-
-/**
- * An internal class to provide a console-friendly string representation of a
- * Record.
- */
-
-
-var RecordSummary = function () {
-  RecordSummary.createFromRecord = function createFromRecord(id, record) {
-    var type = record ? require('./RelayModernRecord').getType(record) : null;
-    return new RecordSummary(id, type);
-  };
-
-  function RecordSummary(id, type) {
-    (0, _classCallCheck3['default'])(this, RecordSummary);
-
-    this.id = id;
-    this.type = type;
-  }
-
-  RecordSummary.prototype.toString = function toString() {
-    return this.type ? this.id + ': ' + this.type : this.id;
-  };
-
-  return RecordSummary;
-}();
-
-module.exports = RelayRecordSourceInspector;

package/lib/RelayStoreProxyDebugger.js

@@ -1,44 +0,0 @@
-/**
- * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
- *
- * @providesModule RelayStoreProxyDebugger
- * 
- * @format
- */
-
-'use strict';
-
-/* eslint-disable no-console-disallow */
-
-function dump(proxy) {
-  if (proxy instanceof require('./RelayRecordSourceSelectorProxy')) {
-    var recordSource = proxy.__recordSource;
-    if (recordSource instanceof require('./RelayRecordSourceProxy')) {
-      dumpRelayRecordSourceProxy(recordSource);
-    }
-  } else if (proxy instanceof require('./RelayRecordSourceProxy')) {
-    dumpRelayRecordSourceProxy(proxy);
-  } else {
-    require('fbjs/lib/warning')(false, 'RelayStoreProxyDebugger: not supported yet.');
-  }
-}
-
-function dumpRelayRecordSourceProxy(proxy) {
-  var mutatorSources = proxy.__mutator.__sources;
-  if (mutatorSources.length !== 2) {
-    require('fbjs/lib/warning')(false, 'RelayStoreProxyDebugger: expected the mutator sources to have sink and base. ' + 'This is a Relay side bug; please report it to the Relay team.');
-    return;
-  }
-  console.groupCollapsed('RelayStoreProxyDebugger', '');
-  // Create a 'deep copy' of the records through an extra json encode/decode step.
-  console.log('Modified Records: ', JSON.parse(JSON.stringify(mutatorSources[0])));
-  console.log('Original Records: ', JSON.parse(JSON.stringify(mutatorSources[1])));
-  console.groupEnd();
-}
-
-module.exports = { dump: dump };

package/lib/formatStorageKey.js

@@ -1,37 +0,0 @@
-/**
- * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
- *
- * @providesModule formatStorageKey
- * 
- * @format
- */
-
-'use strict';
-
-/**
- * Given a `fieldName` (eg. "foo") and an object representing arguments and
- * values (eg. `{first: 10, orberBy: "name"}`) returns a unique storage key
- * (ie. `foo{"first":10,"orderBy":"name"}`).
- */
-function formatStorageKey(fieldName, argsWithValues) {
-  if (!argsWithValues) {
-    return fieldName;
-  }
-  var filtered = null;
-  require('fbjs/lib/forEachObject')(argsWithValues, function (value, argName) {
-    if (value != null) {
-      if (!filtered) {
-        filtered = {};
-      }
-      filtered[argName] = value;
-    }
-  });
-  return fieldName + (filtered ? require('./stableJSONStringify')(filtered) : '');
-}
-
-module.exports = formatStorageKey;

package/lib/prettyStringify.js

@@ -1,35 +0,0 @@
-/**
- * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
- *
- * 
- * @providesModule prettyStringify
- * @format
- */
-
-'use strict';
-
-/**
- * Simple wrapper for `JSON.stringify` that adds whitespace to aid readability:
- *
- * ```
- * const object = {a: 1, b 2};
- *
- * JSON.stringify(object);  // {"a":1,"b":2}
- *
- * prettyStringify(object); // {
- *                          //   "a": 1,
- *                          //   "b": 2
- *                          // }
- * ```
- */
-
-function prettyStringify(stringifiable) {
-  return JSON.stringify(stringifiable, null, 2);
-}
-
-module.exports = prettyStringify;