relay-runtime 12.0.0 → 13.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Facebook, Inc. and its affiliates.
+Copyright (c) Meta Platforms, Inc. and affiliates.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -0,0 +1,67 @@
+Relay Runtime
+---
+
+A set of Relay APIs responsible for data fetching, reading and normalization of
+the GraphQL data.
+
+Example:
+
+```js
+
+// @flow strict-local
+
+import type {FetchFunction} from 'relay-runtime';
+
+const {
+  Environment,
+  Network,
+  Observable,
+  RecordSource,
+  Store,
+  fetchQuery,
+  graphql,
+} = require('relay-runtime');
+
+const fetchFn: FetchFunction = function (request, variables) {
+  return new Observable.create(source => {
+    fetch('/my-graphql-api', {
+      method: 'POST',
+      body: JSON.stringify({
+        text: request.text,
+        variables,
+      }),
+    })
+      .then(response => response.json())
+      .then(data => source.next(data));
+  });
+};
+
+const network = Network.create(fetchFn);
+const store = new Store(new RecordSource());
+const environment = new Environment({
+  network,
+  store,
+});
+
+fetchQuery(
+  environment,
+  graphql`
+    query AppQuery($id: ID!) {
+      user(id: $id) {
+        name
+      }
+    }
+  `,
+  {id: 'my-node-id'},
+).subscribe({
+  error: error => {
+    console.error(error);
+  },
+  next: data => {
+    console.log(data);
+  },
+});
+
+```
+
+For complete API reference, visit https://relay.dev/.

package/handlers/RelayDefaultHandlerProvider.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -12,12 +12,12 @@
 
 'use strict';
 
+import type {Handler} from '../store/RelayStoreTypes';
+
 const ConnectionHandler = require('./connection/ConnectionHandler');
 const MutationHandlers = require('./connection/MutationHandlers');
-
 const invariant = require('invariant');
 
-import type {Handler} from '../store/RelayStoreTypes';
 export type HandlerProvider = (name: string) => ?Handler;
 
 function RelayDefaultHandlerProvider(handle: string): Handler {

package/handlers/connection/ConnectionHandler.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -12,23 +12,21 @@
 
 'use strict';
 
-const ConnectionInterface = require('./ConnectionInterface');
-
-const getRelayHandleKey = require('../../util/getRelayHandleKey');
-const invariant = require('invariant');
-const warning = require('warning');
-
-const {generateClientID} = require('../../store/ClientID');
-const {getStableStorageKey} = require('../../store/RelayStoreUtils');
-
 import type {
   HandleFieldPayload,
-  RecordProxy,
   ReadOnlyRecordProxy,
+  RecordProxy,
   RecordSourceProxy,
 } from '../../store/RelayStoreTypes';
 import type {DataID, Variables} from '../../util/RelayRuntimeTypes';
 
+const {generateClientID} = require('../../store/ClientID');
+const {getStableStorageKey} = require('../../store/RelayStoreUtils');
+const getRelayHandleKey = require('../../util/getRelayHandleKey');
+const ConnectionInterface = require('./ConnectionInterface');
+const invariant = require('invariant');
+const warning = require('warning');
+
 export type ConnectionMetadata = {
   path: ?Array<string>,
   direction: ?('forward' | 'backward' | 'bidirectional'),
@@ -146,12 +144,10 @@ function update(store: RecordSourceProxy, payload: HandleFieldPayload): void {
     let nextEdges = [];
     const args = payload.args;
     if (prevEdges && serverEdges) {
-      // $FlowFixMe[prop-missing]
       if (args.after != null) {
         // Forward pagination from the end of the connection: append edges
         if (
           clientPageInfo &&
-          // $FlowFixMe[prop-missing]
           args.after === clientPageInfo.getValue(END_CURSOR)
         ) {
           const nodeIDs = new Set();
@@ -167,12 +163,10 @@ function update(store: RecordSourceProxy, payload: HandleFieldPayload): void {
           );
           return;
         }
-        // $FlowFixMe[prop-missing]
       } else if (args.before != null) {
         // Backward pagination from the start of the connection: prepend edges
         if (
           clientPageInfo &&
-          // $FlowFixMe[prop-missing]
           args.before === clientPageInfo.getValue(START_CURSOR)
         ) {
           const nodeIDs = new Set();
@@ -204,12 +198,10 @@ function update(store: RecordSourceProxy, payload: HandleFieldPayload): void {
     }
     // Page info should be updated even if no new edge were returned.
     if (clientPageInfo && serverPageInfo) {
-      // $FlowFixMe[prop-missing]
       if (args.after == null && args.before == null) {
         // The connection was refetched from the beginning/end: replace
         // page_info
         clientPageInfo.copyFieldsFrom(serverPageInfo);
-        // $FlowFixMe[prop-missing]
       } else if (args.before != null || (args.after == null && args.last)) {
         clientPageInfo.setValue(
           !!serverPageInfo.getValue(HAS_PREV_PAGE),
@@ -219,7 +211,6 @@ function update(store: RecordSourceProxy, payload: HandleFieldPayload): void {
         if (typeof startCursor === 'string') {
           clientPageInfo.setValue(startCursor, START_CURSOR);
         }
-        // $FlowFixMe[prop-missing]
       } else if (args.after != null || (args.before == null && args.first)) {
         clientPageInfo.setValue(
           !!serverPageInfo.getValue(HAS_NEXT_PAGE),

package/handlers/connection/ConnectionInterface.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.

package/handlers/connection/MutationHandlers.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -12,19 +12,18 @@
 
 'use strict';
 
-const ConnectionHandler = require('./ConnectionHandler');
-const ConnectionInterface = require('./ConnectionInterface');
-
-const invariant = require('invariant');
-const warning = require('warning');
-
 import type {
-  RecordProxy,
   HandleFieldPayload,
-  RecordSourceProxy,
   Handler,
+  RecordProxy,
+  RecordSourceProxy,
 } from '../../store/RelayStoreTypes';
 
+const ConnectionHandler = require('./ConnectionHandler');
+const ConnectionInterface = require('./ConnectionInterface');
+const invariant = require('invariant');
+const warning = require('warning');
+
 const DeleteRecordHandler = {
   update: (store: RecordSourceProxy, payload: HandleFieldPayload) => {
     const record = store.get(payload.dataID);
@@ -51,7 +50,6 @@ const DeleteEdgeHandler = {
     if (record == null) {
       return;
     }
-    // $FlowFixMe[prop-missing]
     const {connections} = payload.handleArgs;
     invariant(
       connections != null,
@@ -101,7 +99,6 @@ function edgeUpdater(
     if (record == null) {
       return;
     }
-    // $FlowFixMe[prop-missing]
     const {connections} = payload.handleArgs;
     invariant(
       connections != null,
@@ -174,7 +171,6 @@ function nodeUpdater(
     if (record == null) {
       return;
     }
-    // $FlowFixMe[prop-missing]
     const {connections, edgeTypeName} = payload.handleArgs;
     invariant(
       connections != null,

package/index.js

@@ -1,7 +1,7 @@
 /**
- * Relay v12.0.0
+ * Relay v13.0.0
  *
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.

package/index.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -14,41 +14,43 @@
 
 const ConnectionHandler = require('./handlers/connection/ConnectionHandler');
 const ConnectionInterface = require('./handlers/connection/ConnectionInterface');
-const GraphQLTag = require('./query/GraphQLTag');
 const MutationHandlers = require('./handlers/connection/MutationHandlers');
+const RelayDefaultHandlerProvider = require('./handlers/RelayDefaultHandlerProvider');
+const applyOptimisticMutation = require('./mutations/applyOptimisticMutation');
+const commitLocalUpdate = require('./mutations/commitLocalUpdate');
+const commitMutation = require('./mutations/commitMutation');
+const RelayDeclarativeMutationConfig = require('./mutations/RelayDeclarativeMutationConfig');
+const RelayNetwork = require('./network/RelayNetwork');
+const RelayObservable = require('./network/RelayObservable');
+const RelayQueryResponseCache = require('./network/RelayQueryResponseCache');
+const fetchQuery = require('./query/fetchQuery');
+const fetchQuery_DEPRECATED = require('./query/fetchQuery_DEPRECATED');
+const fetchQueryInternal = require('./query/fetchQueryInternal');
+const GraphQLTag = require('./query/GraphQLTag');
 const PreloadableQueryRegistry = require('./query/PreloadableQueryRegistry');
-const RelayConcreteNode = require('./util/RelayConcreteNode');
+const {
+  generateClientID,
+  generateUniqueClientID,
+  isClientID,
+} = require('./store/ClientID');
+const createFragmentSpecResolver = require('./store/createFragmentSpecResolver');
+const createRelayContext = require('./store/createRelayContext');
+const isRelayModernEnvironment = require('./store/isRelayModernEnvironment');
+const readInlineData = require('./store/readInlineData');
 const RelayConcreteVariables = require('./store/RelayConcreteVariables');
-const RelayDeclarativeMutationConfig = require('./mutations/RelayDeclarativeMutationConfig');
-const RelayDefaultHandleKey = require('./util/RelayDefaultHandleKey');
-const RelayDefaultHandlerProvider = require('./handlers/RelayDefaultHandlerProvider');
-const RelayError = require('./util/RelayError');
-const RelayFeatureFlags = require('./util/RelayFeatureFlags');
 const RelayModernEnvironment = require('./store/RelayModernEnvironment');
 const RelayModernOperationDescriptor = require('./store/RelayModernOperationDescriptor');
 const RelayModernRecord = require('./store/RelayModernRecord');
 const RelayModernSelector = require('./store/RelayModernSelector');
 const RelayModernStore = require('./store/RelayModernStore');
-const RelayNetwork = require('./network/RelayNetwork');
-const RelayObservable = require('./network/RelayObservable');
 const RelayOperationTracker = require('./store/RelayOperationTracker');
-const RelayProfiler = require('./util/RelayProfiler');
-const RelayQueryResponseCache = require('./network/RelayQueryResponseCache');
 const RelayRecordSource = require('./store/RelayRecordSource');
-const RelayReplaySubject = require('./util/RelayReplaySubject');
 const RelayStoreUtils = require('./store/RelayStoreUtils');
+const ResolverFragments = require('./store/ResolverFragments');
 const ViewerPattern = require('./store/ViewerPattern');
-
-const applyOptimisticMutation = require('./mutations/applyOptimisticMutation');
-const commitLocalUpdate = require('./mutations/commitLocalUpdate');
-const commitMutation = require('./mutations/commitMutation');
-const createFragmentSpecResolver = require('./store/createFragmentSpecResolver');
+const requestSubscription = require('./subscription/requestSubscription');
 const createPayloadFor3DField = require('./util/createPayloadFor3DField');
-const createRelayContext = require('./store/createRelayContext');
 const deepFreeze = require('./util/deepFreeze');
-const fetchQuery = require('./query/fetchQuery');
-const fetchQueryInternal = require('./query/fetchQueryInternal');
-const fetchQuery_DEPRECATED = require('./query/fetchQuery_DEPRECATED');
 const getFragmentIdentifier = require('./util/getFragmentIdentifier');
 const getPaginationMetadata = require('./util/getPaginationMetadata');
 const getPaginationVariables = require('./util/getPaginationVariables');
@@ -58,20 +60,17 @@ const getRelayHandleKey = require('./util/getRelayHandleKey');
 const getRequestIdentifier = require('./util/getRequestIdentifier');
 const getValueAtPath = require('./util/getValueAtPath');
 const isPromise = require('./util/isPromise');
-const isRelayModernEnvironment = require('./store/isRelayModernEnvironment');
 const isScalarAndEqual = require('./util/isScalarAndEqual');
-const readInlineData = require('./store/readInlineData');
 const recycleNodesInto = require('./util/recycleNodesInto');
+const RelayConcreteNode = require('./util/RelayConcreteNode');
+const RelayDefaultHandleKey = require('./util/RelayDefaultHandleKey');
+const RelayError = require('./util/RelayError');
+const RelayFeatureFlags = require('./util/RelayFeatureFlags');
+const RelayProfiler = require('./util/RelayProfiler');
+const RelayReplaySubject = require('./util/RelayReplaySubject');
 const reportMissingRequiredFields = require('./util/reportMissingRequiredFields');
-const requestSubscription = require('./subscription/requestSubscription');
 const stableCopy = require('./util/stableCopy');
 
-const {
-  generateClientID,
-  generateUniqueClientID,
-  isClientID,
-} = require('./store/ClientID');
-
 export type {ConnectionMetadata} from './handlers/connection/ConnectionHandler';
 export type {
   EdgeRecord,
@@ -87,7 +86,6 @@ export type {OptimisticMutationConfig} from './mutations/applyOptimisticMutation
 export type {
   DEPRECATED_MutationConfig,
   MutationConfig,
-  MutationParameters,
 } from './mutations/commitMutation';
 export type {
   ExecuteFunction,
@@ -121,7 +119,9 @@ export type {RecordState} from './store/RelayRecordState';
 export type {
   ExecuteMutationConfig,
   FragmentMap,
-  FragmentReference,
+  // DEPRECATED: use FragmentType instead of FragmentReference
+  FragmentType as FragmentReference,
+  FragmentType,
   FragmentSpecResolver,
   HandleFieldPayload,
   IEnvironment,
@@ -131,6 +131,7 @@ export type {
   MissingFieldHandler,
   MissingRequiredFields,
   ModuleImportPointer,
+  MutationParameters,
   NormalizationSelector,
   OperationAvailability,
   OperationDescriptor,
@@ -179,8 +180,8 @@ export type {
   NormalizationSplitOperation,
   NormalizationStream,
   NormalizationTypeDiscriminator,
+  NormalizationOperation,
 } from './util/NormalizationNode';
-export type {NormalizationOperation} from './util/NormalizationNode';
 export type {
   ReaderArgument,
   ReaderArgumentDefinition,
@@ -210,7 +211,14 @@ export type {
   Disposable,
   FetchPolicy,
   FetchQueryFetchPolicy,
+  Fragment,
+  GraphQLSubscription,
+  InlineFragment,
+  Mutation,
+  Operation,
   OperationType,
+  Query,
+  RefetchableFragment,
   RenderPolicy,
   Variables,
   VariablesOf,
@@ -345,6 +353,7 @@ module.exports = {
   getPendingOperationsForFragment: getPendingOperationsForFragment,
   getValueAtPath: getValueAtPath,
   __internal: {
+    ResolverFragments,
     OperationTracker: RelayOperationTracker,
     createRelayContext: createRelayContext,
     getOperationVariables: RelayConcreteVariables.getOperationVariables,

package/lib/handlers/RelayDefaultHandlerProvider.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.

package/lib/handlers/connection/ConnectionHandler.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -10,20 +10,20 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var ConnectionInterface = require('./ConnectionInterface');
+var _require = require('../../store/ClientID'),
+    generateClientID = _require.generateClientID;
+
+var _require2 = require('../../store/RelayStoreUtils'),
+    getStableStorageKey = _require2.getStableStorageKey;
 
 var getRelayHandleKey = require('../../util/getRelayHandleKey');
 
+var ConnectionInterface = require('./ConnectionInterface');
+
 var invariant = require('invariant');
 
 var warning = require("fbjs/lib/warning");
 
-var _require = require('../../store/ClientID'),
-    generateClientID = _require.generateClientID;
-
-var _require2 = require('../../store/RelayStoreUtils'),
-    getStableStorageKey = _require2.getStableStorageKey;
-
 var CONNECTION = 'connection'; // Per-instance incrementing index used to generate unique edge IDs
 
 var NEXT_EDGE_INDEX = '__connection_next_edge_index';
@@ -133,23 +133,19 @@ function update(store, payload) {
     var args = payload.args;
 
     if (prevEdges && _serverEdges) {
-      // $FlowFixMe[prop-missing]
       if (args.after != null) {
         // Forward pagination from the end of the connection: append edges
-        if (clientPageInfo && // $FlowFixMe[prop-missing]
-        args.after === clientPageInfo.getValue(END_CURSOR)) {
+        if (clientPageInfo && args.after === clientPageInfo.getValue(END_CURSOR)) {
           var nodeIDs = new Set();
           mergeEdges(prevEdges, nextEdges, nodeIDs);
           mergeEdges(_serverEdges, nextEdges, nodeIDs);
         } else {
           process.env.NODE_ENV !== "production" ? warning(false, 'Relay: Unexpected after cursor `%s`, edges must ' + 'be fetched from the end of the list (`%s`).', args.after, clientPageInfo && clientPageInfo.getValue(END_CURSOR)) : void 0;
           return;
-        } // $FlowFixMe[prop-missing]
-
+        }
       } else if (args.before != null) {
         // Backward pagination from the start of the connection: prepend edges
-        if (clientPageInfo && // $FlowFixMe[prop-missing]
-        args.before === clientPageInfo.getValue(START_CURSOR)) {
+        if (clientPageInfo && args.before === clientPageInfo.getValue(START_CURSOR)) {
           var _nodeIDs = new Set();
 
           mergeEdges(_serverEdges, nextEdges, _nodeIDs);
@@ -176,19 +172,17 @@ function update(store, payload) {
 
 
     if (clientPageInfo && serverPageInfo) {
-      // $FlowFixMe[prop-missing]
       if (args.after == null && args.before == null) {
         // The connection was refetched from the beginning/end: replace
         // page_info
-        clientPageInfo.copyFieldsFrom(serverPageInfo); // $FlowFixMe[prop-missing]
+        clientPageInfo.copyFieldsFrom(serverPageInfo);
       } else if (args.before != null || args.after == null && args.last) {
         clientPageInfo.setValue(!!serverPageInfo.getValue(HAS_PREV_PAGE), HAS_PREV_PAGE);
         var startCursor = serverPageInfo.getValue(START_CURSOR);
 
         if (typeof startCursor === 'string') {
           clientPageInfo.setValue(startCursor, START_CURSOR);
-        } // $FlowFixMe[prop-missing]
-
+        }
       } else if (args.after != null || args.before == null && args.first) {
         clientPageInfo.setValue(!!serverPageInfo.getValue(HAS_NEXT_PAGE), HAS_NEXT_PAGE);
         var endCursor = serverPageInfo.getValue(END_CURSOR);

package/lib/handlers/connection/ConnectionInterface.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.

package/lib/handlers/connection/MutationHandlers.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -47,8 +47,7 @@ var DeleteEdgeHandler = {
 
     if (record == null) {
       return;
-    } // $FlowFixMe[prop-missing]
-
+    }
 
     var connections = payload.handleArgs.connections;
     !(connections != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'MutationHandlers: Expected connection IDs to be specified.') : invariant(false) : void 0;
@@ -101,8 +100,7 @@ function edgeUpdater(insertFn) {
 
     if (record == null) {
       return;
-    } // $FlowFixMe[prop-missing]
-
+    }
 
     var connections = payload.handleArgs.connections;
     !(connections != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'MutationHandlers: Expected connection IDs to be specified.') : invariant(false) : void 0;
@@ -205,8 +203,7 @@ function nodeUpdater(insertFn) {
 
     if (record == null) {
       return;
-    } // $FlowFixMe[prop-missing]
-
+    }
 
     var _payload$handleArgs = payload.handleArgs,
         connections = _payload$handleArgs.connections,