react-relay 13.1.1 → 14.1.0

package/ReactRelayContainerUtils.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 function getComponentName(component: React$ComponentType<any>): string {

package/ReactRelayContext.js

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

package/ReactRelayContext.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 import type {RelayContext} from 'relay-runtime/store/RelayStoreTypes';
 

package/ReactRelayFragmentContainer.js.flow

@@ -8,14 +8,12 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
-
 import type {GeneratedNodeMap, RelayProp, $RelayProps} from './ReactRelayTypes';
 import type {
   FragmentMap,
   FragmentSpecResolver,
+  IEnvironment,
   RelayContext,
 } from 'relay-runtime';
 
@@ -58,7 +56,7 @@ function createContainerWithFragments<
 
   return class extends React.Component<ContainerProps, ContainerState> {
     static displayName = containerName;
-    constructor(props) {
+    constructor(props: $FlowFixMe) {
       super(props);
       const relayContext = assertRelayContext(props.__relayContext);
       const rootIsQueryRenderer = props.__rootIsQueryRenderer ?? false;
@@ -163,7 +161,10 @@ function createContainerWithFragments<
       this.state.resolver.dispose();
     }
 
-    shouldComponentUpdate(nextProps, nextState): boolean {
+    shouldComponentUpdate(
+      nextProps: ContainerProps,
+      nextState: ContainerState,
+    ): boolean {
       // Short-circuit if any Relay-related data has changed
       if (nextState.data !== this.state.data) {
         return true;
@@ -247,7 +248,7 @@ function createContainerWithFragments<
   };
 }
 
-function getRelayProp(environment) {
+function getRelayProp(environment: IEnvironment) {
   return {
     environment,
   };

package/ReactRelayFragmentMockRenderer.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 const ReactRelayContext = require('./ReactRelayContext');

package/ReactRelayLocalQueryRenderer.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {ReactRelayQueryRendererContext as ReactRelayQueryRendererContextType} from './ReactRelayQueryRendererContext';
@@ -40,7 +38,7 @@ const queryRendererContext: ReactRelayQueryRendererContextType = {
   rootIsQueryRenderer: true,
 };
 
-function useDeepCompare<T: interface {}>(value: T): T {
+function useDeepCompare<T: {...}>(value: T): T {
   const latestValue = React.useRef(value);
   if (!areEqual(latestValue.current, value)) {
     if (__DEV__) {

package/ReactRelayPaginationContainer.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {
@@ -235,7 +233,7 @@ function createGetConnectionFromProps(metadata: ReactConnectionMetadata) {
     'ReactRelayPaginationContainer: Unable to synthesize a ' +
       'getConnectionFromProps function.',
   );
-  return props => {
+  return (props: any) => {
     let data = props[metadata.fragmentName];
     for (let i = 0; i < path.length; i++) {
       if (!data || typeof data !== 'object') {
@@ -264,7 +262,9 @@ function createGetFragmentVariables(
 
 type ReactConnectionMetadata = ConnectionMetadata & {fragmentName: string, ...};
 
-function findConnectionMetadata(fragments): ReactConnectionMetadata {
+function findConnectionMetadata(
+  fragments: FragmentMap,
+): ReactConnectionMetadata {
   let foundConnectionMetadata = null;
   let isRelayModern = false;
   for (const fragmentName in fragments) {
@@ -308,7 +308,7 @@ function toObserver(observerOrCallback: ?ObserverOrCallback): Observer<void> {
     ? {
         error: observerOrCallback,
         complete: observerOrCallback,
-        unsubscribe: subscription => {
+        unsubscribe: (subscription: Subscription) => {
           typeof observerOrCallback === 'function' && observerOrCallback();
         },
       }
@@ -356,7 +356,7 @@ function createContainerWithFragments<
     _isUnmounted: boolean;
     _hasFetched: boolean;
 
-    constructor(props) {
+    constructor(props: any) {
       super(props);
       const relayContext = assertRelayContext(props.__relayContext);
       const rootIsQueryRenderer = props.__rootIsQueryRenderer ?? false;
@@ -415,7 +415,7 @@ function createContainerWithFragments<
      * for updates. Props may be the same in which case previous data and
      * subscriptions can be reused.
      */
-    UNSAFE_componentWillReceiveProps(nextProps) {
+    UNSAFE_componentWillReceiveProps(nextProps: any) {
       const relayContext = assertRelayContext(nextProps.__relayContext);
       const rootIsQueryRenderer = nextProps.__rootIsQueryRenderer ?? false;
       const prevIDs = getDataIDsFromObject(fragments, this.props);
@@ -479,7 +479,10 @@ function createContainerWithFragments<
       this._cleanup();
     }
 
-    shouldComponentUpdate(nextProps, nextState): boolean {
+    shouldComponentUpdate(
+      nextProps: Props,
+      nextState: ContainerState,
+    ): boolean {
       // Short-circuit if any Relay-related data has changed
       if (
         nextState.data !== this.state.data ||
@@ -722,7 +725,7 @@ function createContainerWithFragments<
       return this._queryFetcher;
     }
 
-    _canFetchPage(method): boolean {
+    _canFetchPage(method: 'loadMore' | 'refetchConnection'): boolean {
       if (this._isUnmounted) {
         warning(
           false,
@@ -813,7 +816,7 @@ function createContainerWithFragments<
       }
       this._hasFetched = true;
 
-      const onNext = (payload, complete) => {
+      const onNext = (payload: mixed, complete: () => void) => {
         const prevData = this._resolver.resolve();
         this._resolver.setVariables(
           getFragmentVariables(

package/ReactRelayQueryFetcher.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {
@@ -35,26 +33,26 @@ type OnDataChange = ({
 }) => void;
 
 /** The external API of 'fetch' **/
-export type FetchOptions = {|
+export type FetchOptions = {
   environment: IEnvironment,
   onDataChange?: null | OnDataChange,
   operation: OperationDescriptor,
-|};
+};
 
 // Internally we keep an array of onDataChange callbacks, to support reusing
 // the queryRenderer for multiple components.
-type FetchOptionsInternal = {|
+type FetchOptionsInternal = {
   environment: IEnvironment,
   onDataChangeCallbacks: Array<OnDataChange>,
   operation: OperationDescriptor,
-|};
+};
 
-export type ExecuteConfig = {|
+export type ExecuteConfig = {
   environment: IEnvironment,
   operation: OperationDescriptor,
   // Allows pagination container to retain results from previous queries
   preservePreviousReferences?: boolean,
-|};
+};
 
 class ReactRelayQueryFetcher {
   _fetchOptions: ?FetchOptionsInternal;
@@ -77,10 +75,10 @@ class ReactRelayQueryFetcher {
     }
   }
 
-  getSelectionReferences(): {|
+  getSelectionReferences(): {
     cacheSelectionReference: ?Disposable,
     selectionReferences: Array<Disposable>,
-  |} {
+  } {
     return {
       cacheSelectionReference: this._cacheSelectionReference,
       selectionReferences: this._selectionReferences,
@@ -194,6 +192,7 @@ class ReactRelayQueryFetcher {
       onDataChange &&
       this._fetchOptions.onDataChangeCallbacks.indexOf(onDataChange) === -1
     ) {
+      // $FlowFixMe[incompatible-use]
       this._fetchOptions.onDataChangeCallbacks.push(onDataChange);
     }
 
@@ -320,7 +319,7 @@ class ReactRelayQueryFetcher {
   }: {
     notifyFirstResult: boolean,
     ...
-  }) {
+  }): void {
     invariant(
       this._fetchOptions,
       'ReactRelayQueryFetcher: `_onQueryDataAvailable` should have been called after having called `fetch`',

package/ReactRelayQueryRenderer.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {ReactRelayQueryRendererContext as ReactRelayQueryRendererContextType} from './ReactRelayQueryRendererContext';
@@ -29,13 +27,12 @@ const ReactRelayQueryRendererContext = require('./ReactRelayQueryRendererContext
 const areEqual = require('areEqual');
 const React = require('react');
 const {
-  RelayFeatureFlags,
   createOperationDescriptor,
   deepFreeze,
   getRequest,
 } = require('relay-runtime');
 
-type RetryCallbacks = {|
+type RetryCallbacks = {
   handleDataChange:
     | null
     | (({
@@ -44,34 +41,39 @@ type RetryCallbacks = {|
         ...
       }) => void),
   handleRetryAfterError: null | ((error: Error) => void),
-|};
+};
 
-export type RenderProps<T> = {|
+export type RenderProps<T> = {
   error: ?Error,
   props: ?T,
   retry: ?(cacheConfigOverride?: CacheConfig) => void,
-|};
+};
 /**
  * React may double-fire the constructor, and we call 'fetch' in the
  * constructor. If a request is already in flight from a previous call to the
  * constructor, just reuse the query fetcher and wait for the response.
  */
-const requestCache = {};
+const requestCache: {
+  [string]: void | {
+    queryFetcher: ReactRelayQueryFetcher,
+    snapshot: ?Snapshot,
+  },
+} = {};
 
 const queryRendererContext: ReactRelayQueryRendererContextType = {
   rootIsQueryRenderer: true,
 };
 
-export type Props = {|
+export type Props = {
   cacheConfig?: ?CacheConfig,
   fetchPolicy?: 'store-and-network' | 'network-only',
   environment: IEnvironment,
   query: ?GraphQLTaggedNode,
   render: (renderProps: RenderProps<Object>) => React.Node,
   variables: Variables,
-|};
+};
 
-type State = {|
+type State = {
   error: Error | null,
   prevPropsEnvironment: IEnvironment,
   prevPropsVariables: Variables,
@@ -82,7 +84,7 @@ type State = {|
   retryCallbacks: RetryCallbacks,
   requestCacheKey: ?string,
   snapshot: Snapshot | null,
-|};
+};
 
 /**
  * @public
@@ -157,10 +159,7 @@ class ReactRelayQueryRenderer extends React.Component<Props, State> {
   }
 
   componentDidMount() {
-    if (
-      RelayFeatureFlags.ENABLE_QUERY_RENDERER_OFFSCREEN_SUPPORT === true &&
-      this._maybeHiddenOrFastRefresh === true
-    ) {
+    if (this._maybeHiddenOrFastRefresh === true) {
       // This block only runs if the component has previously "unmounted"
       // due to it being hidden by the Offscreen API, or during fast refresh.
       // At this point, the current cached resource will have been disposed

package/ReactRelayQueryRendererContext.js.flow

@@ -8,12 +8,10 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 const React = require('react');
 
-export type ReactRelayQueryRendererContext = {|rootIsQueryRenderer: boolean|};
+export type ReactRelayQueryRendererContext = {rootIsQueryRenderer: boolean};
 
 module.exports = (React.createContext({
   rootIsQueryRenderer: false,

package/ReactRelayRefetchContainer.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {
@@ -24,6 +22,7 @@ import type {
   Disposable,
   FragmentMap,
   GraphQLTaggedNode,
+  IEnvironment,
   RelayContext,
   Subscription,
   Variables,
@@ -86,7 +85,7 @@ function createContainerWithFragments<
     _queryFetcher: ?ReactRelayQueryFetcher;
     _isUnmounted: boolean;
 
-    constructor(props) {
+    constructor(props: any) {
       super(props);
       const relayContext = assertRelayContext(props.__relayContext);
       const rootIsQueryRenderer = props.__rootIsQueryRenderer ?? false;
@@ -217,7 +216,10 @@ function createContainerWithFragments<
       this._refetchSubscription && this._refetchSubscription.unsubscribe();
     }
 
-    shouldComponentUpdate(nextProps, nextState): boolean {
+    shouldComponentUpdate(
+      nextProps: ContainerProps,
+      nextState: ContainerState,
+    ): boolean {
       // Short-circuit if any Relay-related data has changed
       if (
         nextState.data !== this.state.data ||
@@ -360,9 +362,7 @@ function createContainerWithFragments<
       );
 
       // TODO: T26288752 find a better way
-      /* eslint-disable lint/react-state-props-mutation */
       this.state.localVariables = fetchVariables;
-      /* eslint-enable lint/react-state-props-mutation */
 
       // Cancel any previously running refetch.
       this._refetchSubscription && this._refetchSubscription.unsubscribe();
@@ -465,7 +465,10 @@ function createContainerWithFragments<
   };
 }
 
-function getRelayProp(environment, refetch): RelayRefetchProp {
+function getRelayProp(
+  environment: IEnvironment,
+  refetch: RelayRefetchProp['refetch'],
+): RelayRefetchProp {
   return {
     environment,
     refetch,

package/ReactRelayTestMocker.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {

package/ReactRelayTypes.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {
@@ -29,7 +27,7 @@ export type ObserverOrCallback = Observer<void> | ((error: ?Error) => mixed);
 // RelayRefetchProp to flow into a RelayProp.
 export type RelayProp = {+environment: IEnvironment, ...};
 
-export type RelayPaginationProp = {|
+export type RelayPaginationProp = {
   +environment: IEnvironment,
   +hasMore: () => boolean,
   +isLoading: () => boolean,
@@ -43,9 +41,9 @@ export type RelayPaginationProp = {|
     observerOrCallback: ?ObserverOrCallback,
     refetchVariables: ?Variables,
   ) => ?Disposable,
-|};
+};
 
-export type RelayRefetchProp = {|
+export type RelayRefetchProp = {
   +environment: IEnvironment,
   +refetch: (
     refetchVariables: Variables | ((fragmentVariables: Variables) => Variables),
@@ -53,13 +51,13 @@ export type RelayRefetchProp = {|
     observerOrCallback: ?ObserverOrCallback,
     options?: RefetchOptions,
   ) => Disposable,
-|};
+};
 
-export type RefetchOptions = {|
+export type RefetchOptions = {
   +force?: boolean,
   +fetchPolicy?: 'store-or-network' | 'network-only',
   +metadata?: {[key: string]: mixed, ...},
-|};
+};
 
 /**
  * A utility type which takes the type of a fragment's data (typically found in

package/RelayContext.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {RelayContext} from 'relay-runtime';

package/__flowtests__/ReactRelayFragmentContainer-flowtest.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 const {
@@ -45,7 +43,7 @@ class BarComponent extends React.Component<{
   requiredProp: string,
   ...
 }> {
-  static defaultProps = {
+  static defaultProps: {defaultProp: string} = {
     defaultProp: 'default',
   };
   getNum(): number {
@@ -127,7 +125,7 @@ module.exports = {
     return <Bar {...props} />;
   },
   checkStaticsAndMethodsProxying(): React.Node {
-    class ProxyChecker extends React.PureComponent<{||}> {
+    class ProxyChecker extends React.PureComponent<{}> {
       _barRef: ?BarComponent;
       getString(): string {
         const ok = this._barRef ? this._barRef.getNum() : 'default'; // legit

package/__flowtests__/ReactRelayPaginationContainer-flowtest.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 const {
@@ -33,13 +31,13 @@ class FooComponent extends React.Component {
     requiredProp: string,
     ...
   };
-  static defaultProps = {
+  static defaultProps: {defaultProp: string} = {
     defaultProp: 'default',
   };
   getNum(): number {
     return 42;
   }
-  render() {
+  render(): React.Node {
     const reqLen = this.props.requiredProp.length;
     const optionalProp = this.props.optionalProp;
 
@@ -159,7 +157,7 @@ module.exports = {
         /** $FlowExpectedError: Foo `getNum` gives number, but `getString` assumes string  **/
         return bad ? 'not good' : ok;
       }
-      render() {
+      render(): React.Node {
         return (
           <Foo
             componentRef={ref => {

package/__flowtests__/ReactRelayRefetchContainer-flowtest.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 const {
@@ -32,13 +30,13 @@ class FooComponent extends React.Component {
     requiredProp: string,
     ...
   };
-  static defaultProps = {
+  static defaultProps: {defaultProp: string} = {
     defaultProp: 'default',
   };
   getNum(): number {
     return 42;
   }
-  render() {
+  render(): React.Node {
     const reqLen = this.props.requiredProp.length;
     const optionalProp = this.props.optionalProp;
 
@@ -142,7 +140,7 @@ module.exports = {
         /** $FlowExpectedError: Foo `getNum` gives number, but `getString` assumes string  **/
         return bad ? 'not good' : ok;
       }
-      render() {
+      render(): React.Node {
         return (
           <Foo
             componentRef={ref => {

package/__flowtests__/RelayModern-flowtest.js.flow

@@ -8,8 +8,6 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {$FragmentRef} from '../ReactRelayTypes';
@@ -252,9 +250,9 @@ declare var aComplexUserRef: {
   optionalUsers={null}
 />;
 
-class AnyTest extends React.Component<{|
+class AnyTest extends React.Component<{
   anything: any,
-|}> {}
+}> {}
 const AnyTestContainer = createFragmentContainer(AnyTest, {});
 
 <AnyTestContainer anything={42} />;

package/__flowtests__/RelayModernFlowtest_badref.graphql.js.flow

@@ -8,16 +8,14 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {RelayModernFlowtest_user$ref} from './RelayModernFlowtest_user.graphql';
 import type {FragmentType} from 'relay-runtime';
 
 declare export opaque type RelayModernFlowtest_badref$ref: FragmentType;
-export type RelayModernFlowtest_badref = {|
+export type RelayModernFlowtest_badref = {
   +id: string,
   +$fragmentSpreads: RelayModernFlowtest_user$ref,
   +$fragmentType: RelayModernFlowtest_badref$ref,
-|};
+};

package/__flowtests__/RelayModernFlowtest_notref.graphql.js.flow

@@ -8,16 +8,14 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {RelayModernFlowtest_user$ref} from './RelayModernFlowtest_user.graphql';
 import type {FragmentType} from 'relay-runtime';
 
 declare export opaque type RelayModernFlowtest_notref$ref: FragmentType;
-export type RelayModernFlowtest_notref = {|
+export type RelayModernFlowtest_notref = {
   +id: string,
   +$fragmentSpreads: RelayModernFlowtest_user$ref,
   +$fragmentType: RelayModernFlowtest_notref$ref,
-|};
+};

package/__flowtests__/RelayModernFlowtest_user.graphql.js.flow

@@ -8,14 +8,12 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {FragmentType} from 'relay-runtime';
 
 declare export opaque type RelayModernFlowtest_user$ref: FragmentType;
-export type RelayModernFlowtest_user = {|
+export type RelayModernFlowtest_user = {
   +name: ?string,
   +$fragmentType: RelayModernFlowtest_user$ref,
-|};
+};

package/__flowtests__/RelayModernFlowtest_users.graphql.js.flow

@@ -8,14 +8,12 @@
  * @format
  */
 
-// flowlint ambiguous-object-type:error
-
 'use strict';
 
 import type {FragmentType} from 'relay-runtime';
 
 declare export opaque type RelayModernFlowtest_users$ref: FragmentType;
-export type RelayModernFlowtest_users = $ReadOnlyArray<{|
+export type RelayModernFlowtest_users = $ReadOnlyArray<{
   +name: ?string,
   +$fragmentType: RelayModernFlowtest_users$ref,
-|}>;
+}>;