react-relay 14.1.0 → 16.0.0

package/lib/ReactRelayTestMocker.js

@@ -1,86 +1,38 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and 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 _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
-
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var areEqual = require("fbjs/lib/areEqual");
-
 var invariant = require('invariant');
-
 var _require = require('relay-runtime'),
-    Network = _require.Network,
-    createOperationDescriptor = _require.createOperationDescriptor,
-    isRelayModernEnvironment = _require.isRelayModernEnvironment;
-
+  Network = _require.Network,
+  createOperationDescriptor = _require.createOperationDescriptor,
+  isRelayModernEnvironment = _require.isRelayModernEnvironment;
 var warning = require("fbjs/lib/warning");
-
-/**
- * The next id to return from `generateId()`.
- */
 var nextId = 0;
-
 var ReactRelayTestMocker = /*#__PURE__*/function () {
   function ReactRelayTestMocker(env) {
     (0, _defineProperty2["default"])(this, "_defaults", {});
     (0, _defineProperty2["default"])(this, "_pendingFetches", []);
-
     if (isRelayModernEnvironment(env)) {
       this._mockNetworkLayer(env);
     } else {
       process.env.NODE_ENV !== "production" ? warning(false, 'Network mocking is currently only supported in Relay Modern. ' + 'You will not be able to resolve requests made with Relay ' + 'Classic environments.') : void 0;
     }
-
     this._environment = env;
   }
-
   ReactRelayTestMocker.mockOutEnvironment = function mockOutEnvironment(env) {
     return new ReactRelayTestMocker(env);
-  }
-  /**
-   * Get a unique id number (as a string). Note: will wrap around after 2^32
-   * calls, if your test needs that many IDs.
-   *
-   * @returns a unique id string
-   */
-  ;
-
+  };
   ReactRelayTestMocker.generateId = function generateId() {
     var toRet = nextId.toString();
     nextId++;
     return toRet;
-  }
-  /**
-   * Create a unique identifier for a (query, variables) pair.
-   * @param request: the request associated with the query
-   * @param variables: the variables associated with this invocation of the
-   * query
-   *
-   * @returns a string which can later be used to uniquely identify this query
-   * in the list of pending queries
-   */
-  ;
-
+  };
   ReactRelayTestMocker.getIdentifier = function getIdentifier(request) {
     return request.name;
-  }
-  /**
-   * Remove variables that we don't need from the query that will make it more
-   * annoying to test (e.g. client_mutation_id, actor_id)
-   */
-  ;
-
+  };
   ReactRelayTestMocker.stripUnused = function stripUnused(variables) {
     if (variables.input) {
       var toRemove = ['client_mutation_id', 'actor_id', 'clientMutationId', 'actorId'];
@@ -92,23 +44,11 @@ var ReactRelayTestMocker = /*#__PURE__*/function () {
       });
       return strippedVariables;
     }
-
     return variables;
-  }
-  /**
-   * Replace the environment's network layer with a mocked out one to allow for
-   * better testing. Mocking the network allows testing without using a mocked
-   * out QueryRenderer, and will allow for easier testing of components wrapped
-   * in refetch containers, for example. It also allows test writers to see how
-   * their components behave under error conditions.
-   */
-  ;
-
+  };
   var _proto = ReactRelayTestMocker.prototype;
-
   _proto._mockNetworkLayer = function _mockNetworkLayer(env) {
     var _this = this;
-
     var fetch = function fetch(request, variables, cacheConfig) {
       var resolve;
       var reject;
@@ -117,13 +57,11 @@ var ReactRelayTestMocker = /*#__PURE__*/function () {
         reject = rej;
       });
       var strippedVars = ReactRelayTestMocker.stripUnused(variables);
-      var ident = ReactRelayTestMocker.getIdentifier(request); // there's a default value for this query, use it
-
+      var ident = ReactRelayTestMocker.getIdentifier(request);
       if (_this._defaults[ident]) {
         var payload = _this._defaults[ident];
         return typeof payload === 'function' ? payload(strippedVars) : payload;
       }
-
       _this._pendingFetches.push({
         ident: ident,
         cacheConfig: cacheConfig,
@@ -134,16 +72,13 @@ var ReactRelayTestMocker = /*#__PURE__*/function () {
         request: request,
         variables: strippedVars
       });
-
       return promise;
     };
-
     var isLoading = function isLoading(ident) {
       return _this._pendingFetches.some(function (pending) {
         return pending.ident === ident;
       });
     };
-
     var resolveRawQuery = function resolveRawQuery(toResolve, payload) {
       _this._pendingFetches = _this._pendingFetches.filter(function (pending) {
         return pending !== toResolve;
@@ -151,7 +86,6 @@ var ReactRelayTestMocker = /*#__PURE__*/function () {
       var deferred = toResolve.deferred;
       deferred.resolve(payload);
     };
-
     var rejectQuery = function rejectQuery(toResolve, payload) {
       _this._pendingFetches = _this._pendingFetches.filter(function (pending) {
         return pending !== toResolve;
@@ -159,7 +93,6 @@ var ReactRelayTestMocker = /*#__PURE__*/function () {
       var deferred = toResolve.deferred;
       deferred.reject(payload.error);
     };
-
     env.mock = {
       isLoading: isLoading,
       rejectQuery: rejectQuery,
@@ -167,82 +100,44 @@ var ReactRelayTestMocker = /*#__PURE__*/function () {
       fetch: fetch
     };
     env.hasMockedNetwork = true;
-
     env.__setNet(Network.create(fetch));
-
     return env;
-  }
-  /**
-   * set a default payload for a given query
-   */
-  ;
-
+  };
   _proto.setDefault = function setDefault(toSet) {
     var query = toSet.query,
-        payload = toSet.payload;
+      payload = toSet.payload;
     var ident = ReactRelayTestMocker.getIdentifier(query.params);
     this._defaults[ident] = payload;
-  }
-  /**
-   * remove a default payload for a given query
-   */
-  ;
-
+  };
   _proto.unsetDefault = function unsetDefault(toUnset) {
     var query = toUnset.query;
     var ident = ReactRelayTestMocker.getIdentifier(query.params);
     delete this._defaults[ident];
-  }
-  /**
-   * Write directly to the Relay store instead of trying to resolve a query that
-   * was sent via the network.
-   *
-   * Use this method when testing a component wrapped in a fragment container
-   * (via `createFragmentContainer`). The component under test should also be
-   * wrapped in a `RelayTestRenderer`.
-   */
-  ;
-
+  };
   _proto.dataWrite = function dataWrite(config) {
     var query = config.query,
-        variables = config.variables,
-        payload = config.payload;
+      variables = config.variables,
+      payload = config.payload;
     var operationDescriptor = createOperationDescriptor(query, variables);
     !(payload.data != null && payload.errors === undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Only `data` can be written when using `writeDirect`. You may need to ' + 'wrap your payload in an object like `{data: payload}`.') : invariant(false) : void 0;
-
     this._environment.commitPayload(operationDescriptor, payload.data);
-  }
-  /**
-   * Write the data specified in config's payload to the instance's environment.
-   * NOTE: callers may need to invoke `jest.runOnlyPendingTimers()` after
-   * calling this function.
-   *
-   * @param config: an object containing the data to write and the query and
-   * variables that the payload is simulating a response to
-   */
-  ;
-
+  };
   _proto.networkWrite = function networkWrite(config) {
     !this._environment.hasMockedNetwork ? process.env.NODE_ENV !== "production" ? invariant(false, 'You cannot resolve queries without a mocked environment. Did you mean ' + 'to use `writeDirect` instead?') : invariant(false) : void 0;
     var query = config.query,
-        variables = config.variables,
-        payload = config.payload;
+      variables = config.variables,
+      payload = config.payload;
     var ident = ReactRelayTestMocker.getIdentifier(query.params);
     var usedVars;
-
     if (variables) {
       var operationDescriptor = createOperationDescriptor(query, variables);
       usedVars = ReactRelayTestMocker.stripUnused(operationDescriptor.request.variables);
     }
-
     var toResolve;
-
     this._pendingFetches.forEach(function (pending) {
       var pendingVars = pending.variables;
-
       if (pending.ident === ident) {
         !(!toResolve || variables) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Multiple queries with the same name are currently pending. You ' + 'should pass variables to `write` so that it can determine which ' + 'to resolve') : invariant(false) : void 0;
-
         if (variables) {
           if (areEqual(pendingVars, usedVars)) {
             toResolve = pending;
@@ -252,12 +147,9 @@ var ReactRelayTestMocker = /*#__PURE__*/function () {
         }
       }
     });
-
     var varMessage = usedVars ? ' - variables: ' + JSON.stringify(usedVars) : '';
     !toResolve ? process.env.NODE_ENV !== "production" ? invariant(false, 'You are attempting to resolve a query that has not been fetched ' + '(%s%s).\n\tPlease ensure you passed the correct variables, or use ' + '`writeDirect` instead.', ident, varMessage) : invariant(false) : void 0;
-    var realPayload = // $FlowFixMe[incompatible-call]
-    typeof payload === 'function' ? payload(toResolve.variables) : payload; // if there are errors, reject the query
-
+    var realPayload = typeof payload === 'function' ? payload(toResolve.variables) : payload;
     if (realPayload.errors != null && realPayload.errors.length > 0) {
       this._environment.mock.rejectQuery(toResolve, {
         error: realPayload.errors[0]
@@ -266,8 +158,6 @@ var ReactRelayTestMocker = /*#__PURE__*/function () {
       this._environment.mock.resolveRawQuery(toResolve, realPayload);
     }
   };
-
   return ReactRelayTestMocker;
 }();
-
 module.exports = ReactRelayTestMocker;

package/lib/ReactRelayTypes.js

@@ -1,10 +1 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and 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/RelayContext.js

@@ -1,37 +1,14 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and 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 isRelayEnvironment = require('./isRelayEnvironment');
-
 var invariant = require('invariant');
-/**
- * Asserts that the input is a matches the `RelayContext` type defined in
- * `RelayEnvironmentTypes` and returns it as that type.
- */
-
-
 function assertRelayContext(relay) {
   !isRelayContext(relay) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayContext: Expected `context.relay` to be an object conforming to ' + 'the `RelayContext` interface, got `%s`.', relay) : invariant(false) : void 0;
   return relay;
 }
-/**
- * Determine if the input is a plain object that matches the `RelayContext`
- * type defined in `RelayEnvironmentTypes`.
- */
-
-
 function isRelayContext(context) {
   return typeof context === 'object' && context !== null && !Array.isArray(context) && isRelayEnvironment(context.environment);
 }
-
 module.exports = {
   assertRelayContext: assertRelayContext,
   isRelayContext: isRelayContext

package/lib/assertFragmentMap.js

@@ -1,23 +1,8 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and 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 invariant = require('invariant');
-/**
- * Fail fast if the user supplies invalid fragments as input.
- */
-
-
 function assertFragmentMap(componentName, fragmentSpec) {
   !(fragmentSpec && typeof fragmentSpec === 'object') ? process.env.NODE_ENV !== "production" ? invariant(false, 'Could not create Relay Container for `%s`. ' + 'Expected a set of GraphQL fragments, got `%s` instead.', componentName, fragmentSpec) : invariant(false) : void 0;
-
   for (var key in fragmentSpec) {
     if (fragmentSpec.hasOwnProperty(key)) {
       var fragment = fragmentSpec[key];
@@ -25,5 +10,4 @@ function assertFragmentMap(componentName, fragmentSpec) {
     }
   }
 }
-
 module.exports = assertFragmentMap;

package/lib/buildReactRelayContainer.js

@@ -1,78 +1,44 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and 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 _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
-
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-
 var assertFragmentMap = require('./assertFragmentMap');
-
 var _require = require('./ReactRelayContainerUtils'),
-    getComponentName = _require.getComponentName,
-    getContainerName = _require.getContainerName;
-
+  getComponentName = _require.getComponentName,
+  getContainerName = _require.getContainerName;
 var ReactRelayContext = require('./ReactRelayContext');
-
 var ReactRelayQueryRendererContext = require('./ReactRelayQueryRendererContext');
-
-var readContext = require('./readContext');
-
 var invariant = require('invariant');
-
 var React = require('react');
-
 var _require2 = require('relay-runtime'),
-    getFragment = _require2.getFragment;
-
-/**
- * Helper to create the Relay HOCs with ref forwarding, setting the displayName
- * and reading the React context.
- */
+  getFragment = _require2.getFragment;
+var useContext = React.useContext;
 function buildReactRelayContainer(ComponentClass, fragmentSpec, createContainerWithFragments) {
-  // Sanity-check user-defined fragment input
   var containerName = getContainerName(ComponentClass);
   assertFragmentMap(getComponentName(ComponentClass), fragmentSpec);
   var fragments = {};
-
   for (var key in fragmentSpec) {
     fragments[key] = getFragment(fragmentSpec[key]);
   }
-
   var Container = createContainerWithFragments(ComponentClass, fragments);
   Container.displayName = containerName;
-
   function forwardRef(props, ref) {
     var _queryRendererContext;
-
-    var context = readContext(ReactRelayContext);
+    var context = useContext(ReactRelayContext);
     !(context != null) ? process.env.NODE_ENV !== "production" ? invariant(false, '`%s` tried to render a context that was not valid this means that ' + '`%s` was rendered outside of a query renderer.', containerName, containerName) : invariant(false) : void 0;
-    var queryRendererContext = readContext(ReactRelayQueryRendererContext);
+    var queryRendererContext = useContext(ReactRelayQueryRendererContext);
     return /*#__PURE__*/React.createElement(Container, (0, _extends2["default"])({}, props, {
       __relayContext: context,
       __rootIsQueryRenderer: (_queryRendererContext = queryRendererContext === null || queryRendererContext === void 0 ? void 0 : queryRendererContext.rootIsQueryRenderer) !== null && _queryRendererContext !== void 0 ? _queryRendererContext : false,
       componentRef: props.componentRef || ref
     }));
   }
-
   forwardRef.displayName = containerName;
   var ForwardContainer = React.forwardRef(forwardRef);
-
   if (process.env.NODE_ENV !== "production") {
-    // Used by RelayModernTestUtils
     ForwardContainer.__ComponentClass = ComponentClass;
     ForwardContainer.displayName = containerName;
-  } // $FlowFixMe[incompatible-return]
-
-
+  }
   return ForwardContainer;
 }
-
 module.exports = buildReactRelayContainer;

package/lib/getRootVariablesForFragments.js

@@ -1,29 +1,13 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and 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 _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
-
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
 var _require = require('relay-runtime'),
-    getSelector = _require.getSelector;
-
+  getSelector = _require.getSelector;
 function getRootVariablesForFragments(fragments, props) {
-  var rootVariables = {}; // NOTE: For extra safety, we make sure the rootVariables include the
-  // variables from all owners in this fragmentSpec, even though they
-  // should all point to the same owner
-
+  var rootVariables = {};
   Object.keys(fragments).forEach(function (key) {
     var _selector$selectors$, _selector$selectors$2, _selector$owner$varia;
-
     var fragmentNode = fragments[key];
     var fragmentRef = props[key];
     var selector = getSelector(fragmentNode, fragmentRef);
@@ -32,5 +16,4 @@ function getRootVariablesForFragments(fragments, props) {
   });
   return rootVariables;
 }
-
 module.exports = getRootVariablesForFragments;

package/lib/hooks.js

@@ -1,51 +1,23 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and 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 EntryPointContainer = require('./relay-hooks/EntryPointContainer.react');
-
 var loadEntryPoint = require('./relay-hooks/loadEntryPoint');
-
 var _require = require('./relay-hooks/loadQuery'),
-    loadQuery = _require.loadQuery;
-
+  loadQuery = _require.loadQuery;
+var ProfilerContext = require('./relay-hooks/ProfilerContext');
 var RelayEnvironmentProvider = require('./relay-hooks/RelayEnvironmentProvider');
-
 var useEntryPointLoader = require('./relay-hooks/useEntryPointLoader');
-
 var useFragment = require('./relay-hooks/useFragment');
-
 var useLazyLoadQuery = require('./relay-hooks/useLazyLoadQuery');
-
 var useMutation = require('./relay-hooks/useMutation');
-
 var usePaginationFragment = require('./relay-hooks/usePaginationFragment');
-
 var usePreloadedQuery = require('./relay-hooks/usePreloadedQuery');
-
 var useQueryLoader = require('./relay-hooks/useQueryLoader');
-
 var useRefetchableFragment = require('./relay-hooks/useRefetchableFragment');
-
 var useRelayEnvironment = require('./relay-hooks/useRelayEnvironment');
-
 var useSubscribeToInvalidationState = require('./relay-hooks/useSubscribeToInvalidationState');
-
 var useSubscription = require('./relay-hooks/useSubscription');
-
 var RelayRuntime = require('relay-runtime');
-
-/**
- * The public interface for Relay Hooks.
- * This will eventually become the main public interface for react-relay.
- */
 module.exports = {
   ConnectionHandler: RelayRuntime.ConnectionHandler,
   applyOptimisticMutation: RelayRuntime.applyOptimisticMutation,
@@ -56,6 +28,7 @@ module.exports = {
   requestSubscription: RelayRuntime.requestSubscription,
   EntryPointContainer: EntryPointContainer,
   RelayEnvironmentProvider: RelayEnvironmentProvider,
+  ProfilerContext: ProfilerContext,
   fetchQuery: RelayRuntime.fetchQuery,
   loadQuery: loadQuery,
   loadEntryPoint: loadEntryPoint,

package/lib/index.js

@@ -1,66 +1,30 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and 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 ReactRelayContext = require('./ReactRelayContext');
-
 var ReactRelayFragmentContainer = require('./ReactRelayFragmentContainer');
-
 var ReactRelayLocalQueryRenderer = require('./ReactRelayLocalQueryRenderer');
-
 var ReactRelayPaginationContainer = require('./ReactRelayPaginationContainer');
-
 var ReactRelayQueryRenderer = require('./ReactRelayQueryRenderer');
-
 var ReactRelayRefetchContainer = require('./ReactRelayRefetchContainer');
-
 var EntryPointContainer = require('./relay-hooks/EntryPointContainer.react');
-
 var loadEntryPoint = require('./relay-hooks/loadEntryPoint');
-
 var _require = require('./relay-hooks/loadQuery'),
-    loadQuery = _require.loadQuery;
-
+  loadQuery = _require.loadQuery;
+var ProfilerContext = require('./relay-hooks/ProfilerContext');
 var RelayEnvironmentProvider = require('./relay-hooks/RelayEnvironmentProvider');
-
 var useClientQuery = require('./relay-hooks/useClientQuery');
-
 var useEntryPointLoader = require('./relay-hooks/useEntryPointLoader');
-
 var useFragment = require('./relay-hooks/useFragment');
-
 var useLazyLoadQuery = require('./relay-hooks/useLazyLoadQuery');
-
 var useMutation = require('./relay-hooks/useMutation');
-
 var usePaginationFragment = require('./relay-hooks/usePaginationFragment');
-
 var usePreloadedQuery = require('./relay-hooks/usePreloadedQuery');
-
 var useQueryLoader = require('./relay-hooks/useQueryLoader');
-
 var useRefetchableFragment = require('./relay-hooks/useRefetchableFragment');
-
 var useRelayEnvironment = require('./relay-hooks/useRelayEnvironment');
-
 var useSubscribeToInvalidationState = require('./relay-hooks/useSubscribeToInvalidationState');
-
 var useSubscription = require('./relay-hooks/useSubscription');
-
 var RelayRuntime = require('relay-runtime');
-
-/**
- * The public interface to react-relay.
- * Currently contains both Relay Hooks and legacy Container APIs.
- * Will eventually only export the interface from ./hooks.js.
- */
 module.exports = {
   ConnectionHandler: RelayRuntime.ConnectionHandler,
   QueryRenderer: ReactRelayQueryRenderer,
@@ -78,9 +42,9 @@ module.exports = {
   graphql: RelayRuntime.graphql,
   readInlineData: RelayRuntime.readInlineData,
   requestSubscription: RelayRuntime.requestSubscription,
-  // Relay Hooks
   EntryPointContainer: EntryPointContainer,
   RelayEnvironmentProvider: RelayEnvironmentProvider,
+  ProfilerContext: ProfilerContext,
   fetchQuery: RelayRuntime.fetchQuery,
   loadQuery: loadQuery,
   loadEntryPoint: loadEntryPoint,

package/lib/isRelayEnvironment.js

@@ -1,21 +1,6 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and 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';
-/**
- * Determine if a given value is an object that implements the `Environment`
- * interface defined in `RelayEnvironmentTypes`.
- */
 
 function isRelayEnvironment(environment) {
-  return typeof environment === 'object' && environment !== null && // TODO: add applyMutation/sendMutation once ready in both cores
-  typeof environment.check === 'function' && typeof environment.lookup === 'function' && typeof environment.retain === 'function' && typeof environment.execute === 'function' && typeof environment.subscribe === 'function';
+  return typeof environment === 'object' && environment !== null && typeof environment.check === 'function' && typeof environment.lookup === 'function' && typeof environment.retain === 'function' && typeof environment.execute === 'function' && typeof environment.subscribe === 'function';
 }
-
 module.exports = isRelayEnvironment;