react-relay 20.0.0 → 20.1.0

package/ReactRelayContext.js

@@ -1,5 +1,5 @@
 /**
- * Relay v20.0.0
+ * Relay v20.1.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/ReactRelayPaginationContainer.js.flow

@@ -805,7 +805,7 @@ function createContainerWithFragments<
         ...fragmentVariables,
       }: Variables);
 
-      const cacheConfig: ?CacheConfig = options
+      const cacheConfig: ?{...CacheConfig} = options
         ? {force: !!options.force}
         : undefined;
       if (cacheConfig != null && options?.metadata != null) {

package/ReactRelayRefetchContainer.js.flow

@@ -339,7 +339,7 @@ function createContainerWithFragments<
         ? {...fetchVariables, ...renderVariables}
         : fetchVariables;
 
-      const cacheConfig: ?CacheConfig = options
+      const cacheConfig: ?{...CacheConfig} = options
         ? {force: !!options.force}
         : undefined;
       if (cacheConfig != null && options?.metadata != null) {

package/getRootVariablesForFragments.js.flow

@@ -32,6 +32,8 @@ function getRootVariablesForFragments<TProps: {...}>(
       selector != null && selector.kind === 'PluralReaderSelector'
         ? selector.selectors[0]?.owner.variables ?? {}
         : selector?.owner.variables ?? {};
+    /* $FlowFixMe[incompatible-indexer] Natural Inference rollout. See
+     * https://fburl.com/gdoc/y8dn025u */
     rootVariables = {
       ...rootVariables,
       ...fragmentOwnerVariables,

package/hooks.js

@@ -1,5 +1,5 @@
 /**
- * Relay v20.0.0
+ * Relay v20.1.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v20.0.0
+ * Relay v20.1.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/legacy.js

@@ -1,5 +1,5 @@
 /**
- * Relay v20.0.0
+ * Relay v20.1.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/lib/relay-hooks/legacy/FragmentResource.js

@@ -193,7 +193,7 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
       }
     }
     var fragmentSelector = getSelector(fragmentNode, fragmentRef);
-    !(fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to receive an object where `...%s` was spread, ' + 'but the fragment reference was not found`. This is most ' + 'likely the result of:\n' + "- Forgetting to spread `%s` in `%s`'s parent's fragment.\n" + '- Conditionally fetching `%s` but unconditionally passing %s prop ' + 'to `%s`. If the parent fragment only fetches the fragment conditionally ' + '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' + 'spread  - then the fragment reference will not exist. ' + 'In this case, pass `null` if the conditions for evaluating the ' + 'fragment are not met (e.g. if the `@include(if)` value is false.)', fragmentNode.name, fragmentNode.name, componentDisplayName, fragmentNode.name, fragmentKey == null ? 'a fragment reference' : "the `".concat(fragmentKey, "`"), componentDisplayName) : invariant(false) : void 0;
+    !(fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to receive an object where `...%s` was spread, ' + 'but the fragment reference was not found`. This is most ' + 'likely the result of:\n' + "- Forgetting to spread `%s` in `%s`'s parent's fragment.\n" + '- Conditionally fetching `%s` but unconditionally passing %s prop ' + 'to `%s`. If the parent fragment only fetches the fragment conditionally ' + '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' + 'spread  - then the fragment reference will not exist. ' + 'This issue can generally be fixed by adding `@alias` after `...%s`.\n' + 'See https://relay.dev/docs/next/guides/alias-directive/', fragmentNode.name, fragmentNode.name, componentDisplayName, fragmentNode.name, fragmentKey == null ? 'a fragment reference' : "the `".concat(fragmentKey, "`"), componentDisplayName, fragmentNode.name) : invariant(false) : void 0;
     var fragmentResult = null;
     var snapshot = null;
     if (RelayFeatureFlags.ENABLE_RELAY_OPERATION_TRACKER_SUSPENSE && cachedValue != null && cachedValue.kind === 'missing') {

package/lib/relay-hooks/readFragmentInternal.js

@@ -127,7 +127,7 @@ function readFragmentInternal(environment, fragmentNode, fragmentRef, hookDispla
   } else {
     !!Array.isArray(fragmentRef) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected fragment pointer%s for fragment `%s` not to be ' + 'an array, instead got `%s`. Add `@relay(plural: true)` ' + 'to fragment `%s` to allow the prop to be an array.', fragmentKey != null ? " for key `".concat(fragmentKey, "`") : '', fragmentNode.name, typeof fragmentRef, fragmentNode.name) : invariant(false) : void 0;
   }
-  !(fragmentRef == null || isPlural && Array.isArray(fragmentRef) && fragmentRef.length === 0 || fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to receive an object where `...%s` was spread, ' + 'but the fragment reference was not found`. This is most ' + 'likely the result of:\n' + "- Forgetting to spread `%s` in `%s`'s parent's fragment.\n" + '- Conditionally fetching `%s` but unconditionally passing %s prop ' + 'to `%s`. If the parent fragment only fetches the fragment conditionally ' + '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' + 'spread  - then the fragment reference will not exist. ' + 'In this case, pass `null` if the conditions for evaluating the ' + 'fragment are not met (e.g. if the `@include(if)` value is false.)', fragmentNode.name, fragmentNode.name, hookDisplayName, fragmentNode.name, fragmentKey == null ? 'a fragment reference' : "the `".concat(fragmentKey, "`"), hookDisplayName) : invariant(false) : void 0;
+  !(fragmentRef == null || isPlural && Array.isArray(fragmentRef) && fragmentRef.length === 0 || fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to receive an object where `...%s` was spread, ' + 'but the fragment reference was not found`. This is most ' + 'likely the result of:\n' + "- Forgetting to spread `%s` in `%s`'s parent's fragment.\n" + '- Conditionally fetching `%s` but unconditionally passing %s prop ' + 'to `%s`. If the parent fragment only fetches the fragment conditionally ' + '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' + 'spread  - then the fragment reference will not exist. ' + 'This issue can generally be fixed by adding `@alias` after `...%s`.\n' + 'See https://relay.dev/docs/next/guides/alias-directive/', fragmentNode.name, fragmentNode.name, hookDisplayName, fragmentNode.name, fragmentKey == null ? 'a fragment reference' : "the `".concat(fragmentKey, "`"), hookDisplayName, fragmentNode.name) : invariant(false) : void 0;
   var state = getFragmentState(environment, fragmentSelector);
   var clientEdgeQueries = null;
   if (((_fragmentNode$metadat2 = fragmentNode.metadata) === null || _fragmentNode$metadat2 === void 0 ? void 0 : _fragmentNode$metadat2.hasClientEdges) === true || RelayFeatureFlags.CHECK_ALL_FRAGMENTS_FOR_MISSING_CLIENT_EDGES) {

package/lib/relay-hooks/useFragmentInternal_CURRENT.js

@@ -308,7 +308,7 @@ function useFragmentInternal(fragmentNode, fragmentRef, hookDisplayName, queryOp
   } else {
     !!Array.isArray(fragmentRef) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected fragment pointer%s for fragment `%s` not to be ' + 'an array, instead got `%s`. Add `@relay(plural: true)` ' + 'to fragment `%s` to allow the prop to be an array.', fragmentNode.name, typeof fragmentRef, fragmentNode.name) : invariant(false) : void 0;
   }
-  !(fragmentRef == null || isPlural && Array.isArray(fragmentRef) && fragmentRef.length === 0 || fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to receive an object where `...%s` was spread, ' + 'but the fragment reference was not found`. This is most ' + 'likely the result of:\n' + "- Forgetting to spread `%s` in `%s`'s parent's fragment.\n" + '- Conditionally fetching `%s` but unconditionally passing %s prop ' + 'to `%s`. If the parent fragment only fetches the fragment conditionally ' + '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' + 'spread  - then the fragment reference will not exist. ' + 'In this case, pass `null` if the conditions for evaluating the ' + 'fragment are not met (e.g. if the `@include(if)` value is false.)', fragmentNode.name, fragmentNode.name, hookDisplayName, fragmentNode.name, hookDisplayName) : invariant(false) : void 0;
+  !(fragmentRef == null || isPlural && Array.isArray(fragmentRef) && fragmentRef.length === 0 || fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to receive an object where `...%s` was spread, ' + 'but the fragment reference was not found`. This is most ' + 'likely the result of:\n' + "- Forgetting to spread `%s` in `%s`'s parent's fragment.\n" + '- Conditionally fetching `%s` but unconditionally passing %s prop ' + 'to `%s`. If the parent fragment only fetches the fragment conditionally ' + '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' + 'spread  - then the fragment reference will not exist. ' + 'This issue can generally be fixed by adding `@alias` after `...%s`.\n' + 'See https://relay.dev/docs/next/guides/alias-directive/', fragmentNode.name, fragmentNode.name, hookDisplayName, fragmentNode.name, hookDisplayName, fragmentNode.name) : invariant(false) : void 0;
   var environment = useRelayEnvironment();
   var loggerContext;
   if (RelayFeatureFlags.ENABLE_UI_CONTEXT_ON_RELAY_LOGGER) {

package/lib/relay-hooks/useFragmentInternal_EXPERIMENTAL.js

@@ -327,7 +327,7 @@ function useFragmentInternal_EXPERIMENTAL(fragmentNode, fragmentRef, hookDisplay
   } else {
     !!Array.isArray(fragmentRef) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected fragment pointer%s for fragment `%s` not to be ' + 'an array, instead got `%s`. Add `@relay(plural: true)` ' + 'to fragment `%s` to allow the prop to be an array.', fragmentNode.name, typeof fragmentRef, fragmentNode.name) : invariant(false) : void 0;
   }
-  !(fragmentRef == null || isPlural && Array.isArray(fragmentRef) && fragmentRef.length === 0 || fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to receive an object where `...%s` was spread, ' + 'but the fragment reference was not found`. This is most ' + 'likely the result of:\n' + "- Forgetting to spread `%s` in `%s`'s parent's fragment.\n" + '- Conditionally fetching `%s` but unconditionally passing %s prop ' + 'to `%s`. If the parent fragment only fetches the fragment conditionally ' + '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' + 'spread  - then the fragment reference will not exist. ' + 'In this case, pass `null` if the conditions for evaluating the ' + 'fragment are not met (e.g. if the `@include(if)` value is false.)', fragmentNode.name, fragmentNode.name, hookDisplayName, fragmentNode.name, hookDisplayName) : invariant(false) : void 0;
+  !(fragmentRef == null || isPlural && Array.isArray(fragmentRef) && fragmentRef.length === 0 || fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to receive an object where `...%s` was spread, ' + 'but the fragment reference was not found`. This is most ' + 'likely the result of:\n' + "- Forgetting to spread `%s` in `%s`'s parent's fragment.\n" + '- Conditionally fetching `%s` but unconditionally passing %s prop ' + 'to `%s`. If the parent fragment only fetches the fragment conditionally ' + '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' + 'spread - then the fragment reference will not exist. ' + 'This issue can generally be fixed by adding `@alias` after `...%s`.\n' + 'See https://relay.dev/docs/next/guides/alias-directive/', fragmentNode.name, fragmentNode.name, hookDisplayName, fragmentNode.name, hookDisplayName) : invariant(false) : void 0;
   var environment = useRelayEnvironment();
   var loggerContext;
   if (RelayFeatureFlags.ENABLE_UI_CONTEXT_ON_RELAY_LOGGER) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-relay",
   "description": "A framework for building GraphQL-driven React applications.",
-  "version": "20.0.0",
+  "version": "20.1.0",
   "keywords": [
     "graphql",
     "relay",
@@ -20,7 +20,7 @@
     "fbjs": "^3.0.2",
     "invariant": "^2.2.4",
     "nullthrows": "^1.1.1",
-    "relay-runtime": "20.0.0"
+    "relay-runtime": "20.1.0"
   },
   "peerDependencies": {
     "react": "^16.9.0 || ^17 || ^18 || ^19"

package/relay-hooks/EntryPointTypes.flow.js.flow

@@ -293,6 +293,6 @@ export type EntryPoint<TEntryPointParams, +TEntryPointComponent> =
 
 export type PreloadParamsOf<T> = Parameters<T['getPreloadProps']>[0];
 
-export type IEnvironmentProvider<TOptions> = {
+export type IEnvironmentProvider<TOptions> = $ReadOnly<{
   getEnvironment: (options: ?TOptions) => IEnvironment,
-};
+}>;

package/relay-hooks/RelayEnvironmentProvider.js.flow

@@ -22,15 +22,17 @@ const React = require('react');
 
 const {useMemo} = React;
 
-type Props = $ReadOnly<{
-  children: React.Node,
+type Props<TChildren> = $ReadOnly<{
+  children: TChildren,
   environment: IEnvironment,
   getEnvironmentForActor?: ?(
     actorIdentifier: ActorIdentifier,
   ) => IActorEnvironment,
 }>;
 
-function RelayEnvironmentProvider(props: Props): React.Node {
+component RelayEnvironmentProvider<TChildren: React.Node>(
+  ...props: Props<TChildren>
+) renders TChildren {
   const {children, environment, getEnvironmentForActor} = props;
   const context = useMemo(
     () => ({environment, getEnvironmentForActor}),

package/relay-hooks/legacy/FragmentResource.js.flow

@@ -340,14 +340,15 @@ class FragmentResourceImpl {
         'to `%s`. If the parent fragment only fetches the fragment conditionally ' +
         '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' +
         'spread  - then the fragment reference will not exist. ' +
-        'In this case, pass `null` if the conditions for evaluating the ' +
-        'fragment are not met (e.g. if the `@include(if)` value is false.)',
+        'This issue can generally be fixed by adding `@alias` after `...%s`.\n' +
+        'See https://relay.dev/docs/next/guides/alias-directive/',
       fragmentNode.name,
       fragmentNode.name,
       componentDisplayName,
       fragmentNode.name,
       fragmentKey == null ? 'a fragment reference' : `the \`${fragmentKey}\``,
       componentDisplayName,
+      fragmentNode.name,
     );
 
     let fragmentResult = null;

package/relay-hooks/loadQuery.js.flow

@@ -351,10 +351,16 @@ function loadQuery<
       return;
     }
     if (didExecuteNetworkSource) {
+      /* $FlowFixMe[constant-condition] Error discovered during Constant
+       * Condition roll out. See https://fburl.com/workplace/1v97vimq. */
       unsubscribeFromExecution && unsubscribeFromExecution();
     } else {
+      /* $FlowFixMe[constant-condition] Error discovered during Constant
+       * Condition roll out. See https://fburl.com/workplace/1v97vimq. */
       unsubscribeFromNetworkRequest && unsubscribeFromNetworkRequest();
     }
+    /* $FlowFixMe[constant-condition] Error discovered during Constant
+     * Condition roll out. See https://fburl.com/workplace/1v97vimq. */
     cancelOnLoadCallback && cancelOnLoadCallback();
     isNetworkRequestCancelled = true;
   };

package/relay-hooks/readFragmentInternal.js.flow

@@ -198,14 +198,15 @@ function readFragmentInternal(
       'to `%s`. If the parent fragment only fetches the fragment conditionally ' +
       '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' +
       'spread  - then the fragment reference will not exist. ' +
-      'In this case, pass `null` if the conditions for evaluating the ' +
-      'fragment are not met (e.g. if the `@include(if)` value is false.)',
+      'This issue can generally be fixed by adding `@alias` after `...%s`.\n' +
+      'See https://relay.dev/docs/next/guides/alias-directive/',
     fragmentNode.name,
     fragmentNode.name,
     hookDisplayName,
     fragmentNode.name,
     fragmentKey == null ? 'a fragment reference' : `the \`${fragmentKey}\``,
     hookDisplayName,
+    fragmentNode.name,
   );
 
   const state = getFragmentState(environment, fragmentSelector);

package/relay-hooks/useFragmentInternal_CURRENT.js.flow

@@ -400,13 +400,14 @@ hook useFragmentInternal(
       'to `%s`. If the parent fragment only fetches the fragment conditionally ' +
       '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' +
       'spread  - then the fragment reference will not exist. ' +
-      'In this case, pass `null` if the conditions for evaluating the ' +
-      'fragment are not met (e.g. if the `@include(if)` value is false.)',
+      'This issue can generally be fixed by adding `@alias` after `...%s`.\n' +
+      'See https://relay.dev/docs/next/guides/alias-directive/',
     fragmentNode.name,
     fragmentNode.name,
     hookDisplayName,
     fragmentNode.name,
     hookDisplayName,
+    fragmentNode.name,
   );
 
   const environment = useRelayEnvironment();
@@ -537,6 +538,7 @@ hook useFragmentInternal(
     if (
       RelayFeatureFlags.ENABLE_RELAY_OPERATION_TRACKER_SUSPENSE ||
       environment !== previousEnvironment ||
+      // $FlowFixMe[sketchy-null-bool]
       !committedFragmentSelectorRef.current ||
       // $FlowFixMe[react-rule-unsafe-ref]
       !areEqualSelectors(committedFragmentSelectorRef.current, fragmentSelector)

package/relay-hooks/useFragmentInternal_EXPERIMENTAL.js.flow

@@ -436,9 +436,9 @@ hook useFragmentInternal_EXPERIMENTAL(
       '- Conditionally fetching `%s` but unconditionally passing %s prop ' +
       'to `%s`. If the parent fragment only fetches the fragment conditionally ' +
       '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' +
-      'spread  - then the fragment reference will not exist. ' +
-      'In this case, pass `null` if the conditions for evaluating the ' +
-      'fragment are not met (e.g. if the `@include(if)` value is false.)',
+      'spread - then the fragment reference will not exist. ' +
+      'This issue can generally be fixed by adding `@alias` after `...%s`.\n' +
+      'See https://relay.dev/docs/next/guides/alias-directive/',
     fragmentNode.name,
     fragmentNode.name,
     hookDisplayName,
@@ -569,6 +569,7 @@ hook useFragmentInternal_EXPERIMENTAL(
     if (
       RelayFeatureFlags.ENABLE_RELAY_OPERATION_TRACKER_SUSPENSE ||
       environment !== previousEnvironment ||
+      // $FlowFixMe[sketchy-null-bool]
       !committedFragmentSelectorRef.current ||
       // $FlowFixMe[react-rule-unsafe-ref]
       !areEqualSelectors(committedFragmentSelectorRef.current, fragmentSelector)

package/relay-hooks/useLazyLoadQuery.js.flow

@@ -93,7 +93,7 @@ hook useLazyLoadQuery<TVariables: Variables, TData>(
   /**
    * Object containing the variable values to fetch the query. These variables need to match GraphQL variables declared inside the query.
    */
-  variables: TVariables,
+  variables: NoInfer<TVariables>,
   /**
    * options object
    */

package/relay-hooks/usePreloadedQuery.js.flow

@@ -16,7 +16,7 @@ import type {
   PreloadedQueryInner,
   PreloadedQueryInner_DEPRECATED,
 } from './EntryPointTypes.flow';
-import type {Query, RenderPolicy, Variables} from 'relay-runtime';
+import type {ClientQuery, Query, RenderPolicy, Variables} from 'relay-runtime';
 
 const useLazyLoadQueryNode = require('./useLazyLoadQueryNode');
 const useMemoOperationDescriptor = require('./useMemoOperationDescriptor');
@@ -56,7 +56,9 @@ hook usePreloadedQuery<
   TData,
   TRawResponse: ?{...} = void,
 >(
-  gqlQuery: Query<TVariables, TData, TRawResponse>,
+  gqlQuery:
+    | Query<TVariables, TData, TRawResponse>
+    | ClientQuery<TVariables, TData, TRawResponse>,
   preloadedQuery: PreloadedQuery<
     TVariables,
     TData,
@@ -155,6 +157,8 @@ hook usePreloadedQuery<
     variables: TVariables,
     response: TData,
     rawResponse?: $NonMaybeType<TRawResponse>,
+    /* $FlowFixMe[incompatible-call] Natural Inference rollout. See
+     * https://fburl.com/gdoc/y8dn025u */
   }>(useLazyLoadQueryNodeParams);
 
   if (__DEV__) {