relay-runtime 0.0.0-main-6e8b52f6 → 0.0.0-main-a2037ae7

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-6e8b52f6
+ * Relay v0.0.0-main-a2037ae7
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/index.js.flow

@@ -203,6 +203,7 @@ export type {
 } from './util/ReaderNode';
 export type {
   ConcreteRequest,
+  ConcreteUpdatableQuery,
   GeneratedNode,
   RequestParameters,
 } from './util/RelayConcreteNode';
@@ -221,6 +222,7 @@ export type {
   Query,
   RefetchableFragment,
   RenderPolicy,
+  UpdatableQuery,
   Variables,
   VariablesOf,
 } from './util/RelayRuntimeTypes';

package/lib/mutations/readUpdatableQuery_EXPERIMENTAL.js

@@ -16,7 +16,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
 
 var _require = require('../query/GraphQLTag'),
-    getRequest = _require.getRequest;
+    getUpdatableQuery = _require.getUpdatableQuery;
 
 var _require2 = require('../store/RelayStoreUtils'),
     getArgumentValues = _require2.getArgumentValues;
@@ -24,10 +24,9 @@ var _require2 = require('../store/RelayStoreUtils'),
 var nonUpdatableKeys = ['id', '__id', '__typename', 'js'];
 
 function readUpdatableQuery_EXPERIMENTAL(query, variables, proxy) {
-  // TODO assert that the concrete request is an updatable query
-  var request = getRequest(query);
+  var updatableQuery = getUpdatableQuery(query);
   var updatableProxy = {};
-  updateProxyFromSelections(updatableProxy, proxy.getRoot(), variables, request.fragment.selections, proxy);
+  updateProxyFromSelections(updatableProxy, proxy.getRoot(), variables, updatableQuery.fragment.selections, proxy);
 
   if (process.env.NODE_ENV !== "production") {
     Object.freeze(updatableProxy);

package/lib/query/GraphQLTag.js

@@ -49,6 +49,11 @@ function isRequest(node) {
   return typeof request === 'object' && request !== null && request.kind === RelayConcreteNode.REQUEST;
 }
 
+function isUpdatableQuery(node) {
+  var updatableQuery = getNode(node);
+  return typeof updatableQuery === 'object' && updatableQuery !== null && updatableQuery.kind === RelayConcreteNode.UPDATABLE_QUERY;
+}
+
 function isInlineDataFragment(node) {
   var fragment = getNode(node);
   return typeof fragment === 'object' && fragment !== null && fragment.kind === RelayConcreteNode.INLINE_DATA_FRAGMENT;
@@ -93,6 +98,12 @@ function getRequest(taggedNode) {
   return request;
 }
 
+function getUpdatableQuery(taggedNode) {
+  var updatableQuery = getNode(taggedNode);
+  !isUpdatableQuery(updatableQuery) ? process.env.NODE_ENV !== "production" ? invariant(false, 'GraphQLTag: Expected a request, got `%s`.', JSON.stringify(updatableQuery)) : invariant(false) : void 0;
+  return updatableQuery;
+}
+
 function getInlineDataFragment(taggedNode) {
   var fragment = getNode(taggedNode);
   !isInlineDataFragment(fragment) ? process.env.NODE_ENV !== "production" ? invariant(false, 'GraphQLTag: Expected an inline data fragment, got `%s`.', JSON.stringify(fragment)) : invariant(false) : void 0;
@@ -105,9 +116,11 @@ module.exports = {
   getPaginationFragment: getPaginationFragment,
   getRefetchableFragment: getRefetchableFragment,
   getRequest: getRequest,
+  getUpdatableQuery: getUpdatableQuery,
   getInlineDataFragment: getInlineDataFragment,
   graphql: graphql,
   isFragment: isFragment,
   isRequest: isRequest,
+  isUpdatableQuery: isUpdatableQuery,
   isInlineDataFragment: isInlineDataFragment
 };

package/lib/util/RelayConcreteNode.js

@@ -54,6 +54,7 @@ var RelayConcreteNode = {
   SPLIT_OPERATION: 'SplitOperation',
   STREAM: 'Stream',
   TYPE_DISCRIMINATOR: 'TypeDiscriminator',
+  UPDATABLE_QUERY: 'UpdatableQuery',
   VARIABLE: 'Variable'
 };
 module.exports = RelayConcreteNode;

package/mutations/RelayRecordSourceProxy.js.flow

@@ -22,7 +22,11 @@ import type {
   RecordSource,
   RecordSourceProxy,
 } from '../store/RelayStoreTypes';
-import type {DataID, OperationType} from '../util/RelayRuntimeTypes';
+import type {
+  DataID,
+  UpdatableQuery,
+  UpdatableQueryType,
+} from '../util/RelayRuntimeTypes';
 import type RelayRecordSourceMutator from './RelayRecordSourceMutator';
 
 const RelayModernRecord = require('../store/RelayModernRecord');
@@ -163,8 +167,8 @@ class RelayRecordSourceProxy implements RecordSourceProxy {
     return this._idsMarkedForInvalidation;
   }
 
-  readUpdatableQuery_EXPERIMENTAL<TQuery: OperationType>(
-    query: GraphQLTaggedNode,
+  readUpdatableQuery_EXPERIMENTAL<TQuery: UpdatableQueryType>(
+    query: UpdatableQuery<TQuery['variables'], TQuery['response']>,
     variables: TQuery['variables'],
   ): TQuery['response'] {
     return readUpdatableQuery_EXPERIMENTAL(query, variables, this);

package/mutations/RelayRecordSourceSelectorProxy.js.flow

@@ -20,7 +20,11 @@ import type {
   SingularReaderSelector,
 } from '../store/RelayStoreTypes';
 import type {ReaderLinkedField} from '../util/ReaderNode';
-import type {DataID, OperationType} from '../util/RelayRuntimeTypes';
+import type {
+  DataID,
+  UpdatableQuery,
+  UpdatableQueryType,
+} from '../util/RelayRuntimeTypes';
 import type RelayRecordSourceMutator from './RelayRecordSourceMutator';
 
 const {ROOT_TYPE, getStorageKey} = require('../store/RelayStoreUtils');
@@ -123,8 +127,8 @@ class RelayRecordSourceSelectorProxy implements RecordSourceSelectorProxy {
     this.__recordSource.invalidateStore();
   }
 
-  readUpdatableQuery_EXPERIMENTAL<TQuery: OperationType>(
-    query: GraphQLTaggedNode,
+  readUpdatableQuery_EXPERIMENTAL<TQuery: UpdatableQueryType>(
+    query: UpdatableQuery<TQuery['variables'], TQuery['response']>,
     variables: TQuery['variables'],
   ): TQuery['response'] {
     return readUpdatableQuery_EXPERIMENTAL(query, variables, this);

package/mutations/readUpdatableQuery_EXPERIMENTAL.js.flow

@@ -16,27 +16,29 @@
 import type {GraphQLTaggedNode} from '../query/GraphQLTag';
 import type {RecordProxy, RecordSourceProxy} from '../store/RelayStoreTypes';
 import type {ReaderLinkedField, ReaderSelection} from '../util/ReaderNode';
-import type {OperationType} from '../util/RelayRuntimeTypes';
+import type {
+  UpdatableQuery,
+  UpdatableQueryType,
+} from '../util/RelayRuntimeTypes';
 
-const {getRequest} = require('../query/GraphQLTag');
+const {getUpdatableQuery} = require('../query/GraphQLTag');
 const {getArgumentValues} = require('../store/RelayStoreUtils');
 
 const nonUpdatableKeys = ['id', '__id', '__typename', 'js'];
 
-function readUpdatableQuery_EXPERIMENTAL<TQuery: OperationType>(
-  query: GraphQLTaggedNode,
+function readUpdatableQuery_EXPERIMENTAL<TQuery: UpdatableQueryType>(
+  query: UpdatableQuery<TQuery['variables'], TQuery['response']>,
   variables: TQuery['variables'],
   proxy: RecordSourceProxy,
 ): TQuery['response'] {
-  // TODO assert that the concrete request is an updatable query
-  const request = getRequest(query);
+  const updatableQuery = getUpdatableQuery(query);
 
   const updatableProxy = {};
   updateProxyFromSelections(
     updatableProxy,
     proxy.getRoot(),
     variables,
-    request.fragment.selections,
+    updatableQuery.fragment.selections,
     proxy,
   );
   if (__DEV__) {
@@ -45,7 +47,7 @@ function readUpdatableQuery_EXPERIMENTAL<TQuery: OperationType>(
   return updatableProxy;
 }
 
-function updateProxyFromSelections<TQuery: OperationType>(
+function updateProxyFromSelections<TQuery: UpdatableQueryType>(
   mutableUpdatableProxy: TQuery['response'],
   recordProxy: RecordProxy,
   queryVariables: TQuery['variables'],
@@ -161,7 +163,7 @@ function updateProxyFromSelections<TQuery: OperationType>(
   }
 }
 
-function createSetterForPluralLinkedField<TQuery: OperationType>(
+function createSetterForPluralLinkedField<TQuery: UpdatableQueryType>(
   selection: ReaderLinkedField,
   queryVariables: TQuery['variables'],
   recordProxy: RecordProxy,
@@ -204,7 +206,7 @@ function createSetterForPluralLinkedField<TQuery: OperationType>(
   };
 }
 
-function createSetterForSingularLinkedField<TQuery: OperationType>(
+function createSetterForSingularLinkedField<TQuery: UpdatableQueryType>(
   selection: ReaderLinkedField,
   queryVariables: TQuery['variables'],
   recordProxy: RecordProxy,
@@ -236,7 +238,7 @@ function createSetterForSingularLinkedField<TQuery: OperationType>(
   };
 }
 
-function createGetterForPluralLinkedField<TQuery: OperationType>(
+function createGetterForPluralLinkedField<TQuery: UpdatableQueryType>(
   selection: ReaderLinkedField,
   queryVariables: TQuery['variables'],
   recordProxy: RecordProxy,
@@ -278,7 +280,7 @@ function createGetterForPluralLinkedField<TQuery: OperationType>(
   };
 }
 
-function createGetterForSingularLinkedField<TQuery: OperationType>(
+function createGetterForSingularLinkedField<TQuery: UpdatableQueryType>(
   selection: ReaderLinkedField,
   queryVariables: TQuery['variables'],
   recordProxy: RecordProxy,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-runtime",
   "description": "A core runtime for building GraphQL-driven applications.",
-  "version": "0.0.0-main-6e8b52f6",
+  "version": "0.0.0-main-a2037ae7",
   "keywords": [
     "graphql",
     "relay"

package/query/GraphQLTag.js.flow

@@ -18,7 +18,10 @@ import type {
   ReaderPaginationFragment,
   ReaderRefetchableFragment,
 } from '../util/ReaderNode';
-import type {ConcreteRequest} from '../util/RelayConcreteNode';
+import type {
+  ConcreteRequest,
+  ConcreteUpdatableQuery,
+} from '../util/RelayConcreteNode';
 
 const RelayConcreteNode = require('../util/RelayConcreteNode');
 const invariant = require('invariant');
@@ -29,9 +32,14 @@ export type GraphQLTaggedNode =
   | ReaderFragment
   | ReaderInlineDataFragment
   | ConcreteRequest
+  | ConcreteUpdatableQuery
   | {
       // This is this case when we `require()` a generated ES6 module
-      default: ReaderFragment | ReaderInlineDataFragment | ConcreteRequest,
+      default:
+        | ReaderFragment
+        | ReaderInlineDataFragment
+        | ConcreteRequest
+        | ConcreteUpdatableQuery,
       ...
     };
 
@@ -51,7 +59,11 @@ function graphql(strings: Array<string>): any {
 
 function getNode(
   taggedNode: GraphQLTaggedNode,
-): ReaderFragment | ReaderInlineDataFragment | ConcreteRequest {
+):
+  | ReaderFragment
+  | ReaderInlineDataFragment
+  | ConcreteRequest
+  | ConcreteUpdatableQuery {
   let node = taggedNode;
   if (typeof node === 'function') {
     node = (node(): ReaderFragment | ConcreteRequest);
@@ -85,6 +97,15 @@ function isRequest(node: GraphQLTaggedNode): boolean {
   );
 }
 
+function isUpdatableQuery(node: GraphQLTaggedNode): boolean {
+  const updatableQuery = getNode(node);
+  return (
+    typeof updatableQuery === 'object' &&
+    updatableQuery !== null &&
+    updatableQuery.kind === RelayConcreteNode.UPDATABLE_QUERY
+  );
+}
+
 function isInlineDataFragment(node: GraphQLTaggedNode): boolean {
   const fragment = getNode(node);
   return (
@@ -142,6 +163,18 @@ function getRequest(taggedNode: GraphQLTaggedNode): ConcreteRequest {
   return (request: any);
 }
 
+function getUpdatableQuery(
+  taggedNode: GraphQLTaggedNode,
+): ConcreteUpdatableQuery {
+  const updatableQuery = getNode(taggedNode);
+  invariant(
+    isUpdatableQuery(updatableQuery),
+    'GraphQLTag: Expected a request, got `%s`.',
+    JSON.stringify(updatableQuery),
+  );
+  return (updatableQuery: any);
+}
+
 function getInlineDataFragment(
   taggedNode: GraphQLTaggedNode,
 ): ReaderInlineDataFragment {
@@ -160,9 +193,11 @@ module.exports = {
   getPaginationFragment,
   getRefetchableFragment,
   getRequest,
+  getUpdatableQuery,
   getInlineDataFragment,
   graphql,
   isFragment,
   isRequest,
+  isUpdatableQuery,
   isInlineDataFragment,
 };