relay-runtime 0.0.0-main-9c7301dd → 0.0.0-main-10c2a88a

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-9c7301dd
+ * Relay v0.0.0-main-10c2a88a
  *
  * Copyright (c) Facebook, Inc. and its affiliates.
  *

package/lib/mutations/RelayDeclarativeMutationConfig.js

@@ -201,7 +201,10 @@ function rangeDelete(config, request) {
       return;
     }
 
-    var deleteIDs = [];
+    var deleteIDs = []; // the type of data should come from a type parameter associated with ConcreteRequest,
+    // but ConcreteRequest does not contain a type parameter. Hence, we use a FlowFixMe.
+    // $FlowFixMe[incompatible-use] see above
+
     var deletedIDField = data[rootField];
 
     if (deletedIDField && Array.isArray(deletedIDFieldName)) {

package/lib/store/RelayPublishQueue.js

@@ -45,9 +45,15 @@ var RelayPublishQueue = /*#__PURE__*/function () {
   // True if the next `run()` should apply the backup and rerun all optimistic
   // updates performing a rebase.
   // Payloads to apply or Sources to publish to the store with the next `run()`.
+  // $FlowFixMe[unclear-type] See explanation below.
   // Optimistic updaters to add with the next `run()`.
+  // $FlowFixMe[unclear-type] See explanation below.
   // Optimistic updaters that are already added and might be rerun in order to
   // rebase them.
+  // $FlowFixMe[unclear-type] See explanation below.
+  // For _pendingOptimisticUpdates, _appliedOptimisticUpdates, and _pendingData,
+  // we want to parametrize by "any" since the type is effectively
+  // "the union of all T's that PublishQueue's methods were called with".
   // Garbage collection hold, should rerun gc on dispose
   function RelayPublishQueue(store, handlerProvider, getDataID) {
     this._hasStoreSnapshot = false;
@@ -301,7 +307,7 @@ var RelayPublishQueue = /*#__PURE__*/function () {
 
     var sink = RelayRecordSource.create();
     var mutator = new RelayRecordSourceMutator(this._store.getSource(), sink);
-    var recordSourceProxy = new RelayRecordSourceProxy(mutator, this._getDataID, this._handlerProvider);
+    var recordSourceProxy = new RelayRecordSourceProxy(mutator, this._getDataID, this._handlerProvider); // $FlowFixMe[unclear-type] see explanation above.
 
     var processUpdate = function processUpdate(optimisticUpdate) {
       if (optimisticUpdate.storeUpdater) {

package/multi-actor-environment/ActorSpecificEnvironment.js.flow

@@ -18,6 +18,7 @@ import type RelayObservable from '../network/RelayObservable';
 import type {
   ExecuteMutationConfig,
   LogFunction,
+  MutationParameters,
   OperationAvailability,
   OperationDescriptor,
   OperationTracker,
@@ -112,7 +113,9 @@ class ActorSpecificEnvironment implements IActorEnvironment {
     return this._defaultRenderPolicy;
   }
 
-  applyMutation(optimisticConfig: OptimisticResponseConfig): Disposable {
+  applyMutation<TMutation: MutationParameters>(
+    optimisticConfig: OptimisticResponseConfig<TMutation>,
+  ): Disposable {
     return this.multiActorEnvironment.applyMutation(this, optimisticConfig);
   }
 
@@ -190,15 +193,15 @@ class ActorSpecificEnvironment implements IActorEnvironment {
     return this.multiActorEnvironment.execute(this, config);
   }
 
-  executeSubscription(config: {
+  executeSubscription<TMutation: MutationParameters>(config: {
     operation: OperationDescriptor,
-    updater: ?SelectorStoreUpdater,
+    updater?: ?SelectorStoreUpdater<$ElementType<TMutation, 'response'>>,
   }): RelayObservable<GraphQLResponse> {
     return this.multiActorEnvironment.executeSubscription(this, config);
   }
 
-  executeMutation(
-    options: ExecuteMutationConfig,
+  executeMutation<TMutation: MutationParameters>(
+    options: ExecuteMutationConfig<TMutation>,
   ): RelayObservable<GraphQLResponse> {
     return this.multiActorEnvironment.executeMutation(this, options);
   }

package/multi-actor-environment/MultiActorEnvironment.js.flow

@@ -21,6 +21,7 @@ import type {
   LogFunction,
   MissingFieldHandler,
   MutableRecordSource,
+  MutationParameters,
   OperationAvailability,
   OperationDescriptor,
   OperationLoader,
@@ -273,9 +274,9 @@ class MultiActorEnvironment implements IMultiActorEnvironment {
     });
   }
 
-  applyMutation(
+  applyMutation<TMutation: MutationParameters>(
     actorEnvironment: IActorEnvironment,
-    optimisticConfig: OptimisticResponseConfig,
+    optimisticConfig: OptimisticResponseConfig<TMutation>,
   ): Disposable {
     const subscription = this._execute(actorEnvironment, {
       createSource: () => RelayObservable.create(_sink => {}),
@@ -347,14 +348,14 @@ class MultiActorEnvironment implements IMultiActorEnvironment {
     });
   }
 
-  executeSubscription(
+  executeSubscription<TMutation: MutationParameters>(
     actorEnvironment: IActorEnvironment,
     {
       operation,
       updater,
     }: {
       operation: OperationDescriptor,
-      updater?: ?SelectorStoreUpdater,
+      updater?: ?SelectorStoreUpdater<$ElementType<TMutation, 'response'>>,
     },
   ): RelayObservable<GraphQLResponse> {
     return this._execute(actorEnvironment, {
@@ -374,7 +375,7 @@ class MultiActorEnvironment implements IMultiActorEnvironment {
     });
   }
 
-  executeMutation(
+  executeMutation<TMutation: MutationParameters>(
     actorEnvironment: IActorEnvironment,
     {
       operation,
@@ -382,7 +383,7 @@ class MultiActorEnvironment implements IMultiActorEnvironment {
       optimisticUpdater,
       updater,
       uploadables,
-    }: ExecuteMutationConfig,
+    }: ExecuteMutationConfig<TMutation>,
   ): RelayObservable<GraphQLResponse> {
     let optimisticConfig;
     if (optimisticResponse || optimisticUpdater) {
@@ -438,7 +439,7 @@ class MultiActorEnvironment implements IMultiActorEnvironment {
     return this._isServer;
   }
 
-  _execute(
+  _execute<TMutation: MutationParameters>(
     actorEnvironment: IActorEnvironment,
     {
       createSource,
@@ -450,8 +451,8 @@ class MultiActorEnvironment implements IMultiActorEnvironment {
       createSource: () => RelayObservable<GraphQLResponse>,
       isClientPayload: boolean,
       operation: OperationDescriptor,
-      optimisticConfig: ?OptimisticResponseConfig,
-      updater: ?SelectorStoreUpdater,
+      optimisticConfig: ?OptimisticResponseConfig<TMutation>,
+      updater: ?SelectorStoreUpdater<$ElementType<TMutation, 'response'>>,
     |},
   ): RelayObservable<GraphQLResponse> {
     return RelayObservable.create(sink => {

package/multi-actor-environment/MultiActorEnvironmentTypes.js.flow

@@ -17,6 +17,7 @@ import type RelayPublishQueue from '../store/RelayPublishQueue';
 import type {
   ExecuteMutationConfig,
   IEnvironment,
+  MutationParameters,
   OperationAvailability,
   OperationDescriptor,
   OptimisticResponseConfig,
@@ -138,9 +139,9 @@ export interface IMultiActorEnvironment {
    * Apply an optimistic mutation response and/or updater. The mutation can be
    * reverted by calling `dispose()` on the returned value.
    */
-  applyMutation(
+  applyMutation<TMutation: MutationParameters>(
     actorEnvironment: IActorEnvironment,
-    optimisticConfig: OptimisticResponseConfig,
+    optimisticConfig: OptimisticResponseConfig<TMutation>,
   ): Disposable;
 
   /**
@@ -201,11 +202,11 @@ export interface IMultiActorEnvironment {
    * Note: Observables are lazy, so calling this method will do nothing until
    * the result is subscribed to: environment.executeSubscription({...}).subscribe({...}).
    */
-  executeSubscription(
+  executeSubscription<TMutation: MutationParameters>(
     actorEnvironment: IActorEnvironment,
     config: {
       operation: OperationDescriptor,
-      updater?: ?SelectorStoreUpdater,
+      updater?: ?SelectorStoreUpdater<$ElementType<TMutation, 'response'>>,
     },
   ): RelayObservable<GraphQLResponse>;
 
@@ -219,9 +220,9 @@ export interface IMultiActorEnvironment {
    * the result is subscribed to:
    * environment.executeMutation({...}).subscribe({...}).
    */
-  executeMutation(
+  executeMutation<TMutation: MutationParameters>(
     actorEnvironment: IActorEnvironment,
-    config: ExecuteMutationConfig,
+    config: ExecuteMutationConfig<TMutation>,
   ): RelayObservable<GraphQLResponse>;
 
   /**

package/mutations/RelayDeclarativeMutationConfig.js.flow

@@ -13,6 +13,7 @@
 'use strict';
 
 import type {
+  MutationParameters,
   RecordSourceSelectorProxy,
   SelectorData,
   SelectorStoreUpdater,
@@ -83,18 +84,24 @@ export type DeclarativeMutationConfig =
   | RangeDeleteConfig
   | NodeDeleteConfig;
 
-function convert(
+function convert<TMutation: MutationParameters>(
   configs: Array<DeclarativeMutationConfig>,
   request: ConcreteRequest,
-  optimisticUpdater?: ?SelectorStoreUpdater,
-  updater?: ?SelectorStoreUpdater,
+  optimisticUpdater?: ?SelectorStoreUpdater<
+    $ElementType<TMutation, 'response'>,
+  >,
+  updater?: ?SelectorStoreUpdater<$ElementType<TMutation, 'response'>>,
 ): {
-  optimisticUpdater: SelectorStoreUpdater,
-  updater: SelectorStoreUpdater,
+  optimisticUpdater: SelectorStoreUpdater<$ElementType<TMutation, 'response'>>,
+  updater: SelectorStoreUpdater<$ElementType<TMutation, 'response'>>,
   ...
 } {
-  const configOptimisticUpdates = optimisticUpdater ? [optimisticUpdater] : [];
-  const configUpdates = updater ? [updater] : [];
+  const configOptimisticUpdates: Array<
+    SelectorStoreUpdater<$ElementType<TMutation, 'response'>>,
+  > = optimisticUpdater ? [optimisticUpdater] : [];
+  const configUpdates: Array<
+    SelectorStoreUpdater<$ElementType<TMutation, 'response'>>,
+  > = updater ? [updater] : [];
   configs.forEach(config => {
     switch (config.type) {
       case 'NODE_DELETE':
@@ -123,13 +130,16 @@ function convert(
   return {
     optimisticUpdater: (
       store: RecordSourceSelectorProxy,
-      data: ?SelectorData,
+      data: ?$ElementType<TMutation, 'response'>,
     ) => {
       configOptimisticUpdates.forEach(eachOptimisticUpdater => {
         eachOptimisticUpdater(store, data);
       });
     },
-    updater: (store: RecordSourceSelectorProxy, data: ?SelectorData) => {
+    updater: (
+      store: RecordSourceSelectorProxy,
+      data: ?$ElementType<TMutation, 'response'>,
+    ) => {
       configUpdates.forEach(eachUpdater => {
         eachUpdater(store, data);
       });
@@ -140,13 +150,13 @@ function convert(
 function nodeDelete(
   config: NodeDeleteConfig,
   request: ConcreteRequest,
-): ?SelectorStoreUpdater {
+): ?SelectorStoreUpdater<mixed> {
   const {deletedIDFieldName} = config;
   const rootField = getRootField(request);
   if (!rootField) {
     return null;
   }
-  return (store: RecordSourceSelectorProxy, data: ?SelectorData) => {
+  return (store: RecordSourceSelectorProxy, data: ?mixed) => {
     const payload = store.getRootField(rootField);
     if (!payload) {
       return;
@@ -164,7 +174,7 @@ function nodeDelete(
 function rangeAdd(
   config: RangeAddConfig,
   request: ConcreteRequest,
-): ?SelectorStoreUpdater {
+): ?SelectorStoreUpdater<mixed> {
   const {parentID, connectionInfo, edgeName} = config;
   if (!parentID) {
     warning(
@@ -178,7 +188,7 @@ function rangeAdd(
   if (!connectionInfo || !rootField) {
     return null;
   }
-  return (store: RecordSourceSelectorProxy, data: ?SelectorData) => {
+  return (store: RecordSourceSelectorProxy, data: ?mixed) => {
     const parent = store.get(parentID);
     if (!parent) {
       return;
@@ -232,7 +242,7 @@ function rangeAdd(
 function rangeDelete(
   config: RangeDeleteConfig,
   request: ConcreteRequest,
-): ?SelectorStoreUpdater {
+): ?SelectorStoreUpdater<mixed> {
   const {
     parentID,
     connectionKeys,
@@ -251,12 +261,16 @@ function rangeDelete(
   if (!rootField) {
     return null;
   }
-  return (store: RecordSourceSelectorProxy, data: ?SelectorData) => {
+  return (store: RecordSourceSelectorProxy, data: ?mixed) => {
     if (!data) {
       return;
     }
     const deleteIDs = [];
+    // the type of data should come from a type parameter associated with ConcreteRequest,
+    // but ConcreteRequest does not contain a type parameter. Hence, we use a FlowFixMe.
+    // $FlowFixMe[incompatible-use] see above
     let deletedIDField = data[rootField];
+
     if (deletedIDField && Array.isArray(deletedIDFieldName)) {
       for (const eachField of deletedIDFieldName) {
         if (deletedIDField && typeof deletedIDField === 'object') {

package/mutations/applyOptimisticMutation.js.flow

@@ -15,6 +15,7 @@
 import type {GraphQLTaggedNode} from '../query/GraphQLTag';
 import type {
   IEnvironment,
+  MutationParameters,
   SelectorStoreUpdater,
 } from '../store/RelayStoreTypes';
 import type {Disposable, Variables} from '../util/RelayRuntimeTypes';
@@ -28,11 +29,13 @@ const {
 const RelayDeclarativeMutationConfig = require('./RelayDeclarativeMutationConfig');
 const invariant = require('invariant');
 
-export type OptimisticMutationConfig = {|
+export type OptimisticMutationConfig<TMutation: MutationParameters> = {|
   configs?: ?Array<DeclarativeMutationConfig>,
   mutation: GraphQLTaggedNode,
   variables: Variables,
-  optimisticUpdater?: ?SelectorStoreUpdater,
+  optimisticUpdater?: ?SelectorStoreUpdater<
+    $ElementType<TMutation, 'response'>,
+  >,
   optimisticResponse?: Object,
 |};
 
@@ -40,9 +43,9 @@ export type OptimisticMutationConfig = {|
  * Higher-level helper function to execute a mutation against a specific
  * environment.
  */
-function applyOptimisticMutation(
+function applyOptimisticMutation<TMutation: MutationParameters>(
   environment: IEnvironment,
-  config: OptimisticMutationConfig,
+  config: OptimisticMutationConfig<TMutation>,
 ): Disposable {
   invariant(
     isRelayModernEnvironment(environment),

package/mutations/commitMutation.js.flow

@@ -37,27 +37,30 @@ const validateMutation = require('./validateMutation');
 const invariant = require('invariant');
 const warning = require('warning');
 
-export type DEPRECATED_MutationConfig<T> = {|
+export type DEPRECATED_MutationConfig<TMutationResponse> = {|
   configs?: Array<DeclarativeMutationConfig>,
   cacheConfig?: CacheConfig,
   mutation: GraphQLTaggedNode,
   variables: Variables,
   uploadables?: UploadableMap,
-  onCompleted?: ?(response: T, errors: ?Array<PayloadError>) => void,
+  onCompleted?: ?(
+    response: TMutationResponse,
+    errors: ?Array<PayloadError>,
+  ) => void,
   onError?: ?(error: Error) => void,
   onUnsubscribe?: ?() => void,
-  optimisticUpdater?: ?SelectorStoreUpdater,
+  optimisticUpdater?: ?SelectorStoreUpdater<TMutationResponse>,
   optimisticResponse?: Object,
-  updater?: ?SelectorStoreUpdater,
+  updater?: ?SelectorStoreUpdater<TMutationResponse>,
 |};
 
-export type MutationConfig<T: MutationParameters> = {|
+export type MutationConfig<TMutation: MutationParameters> = {|
   configs?: Array<DeclarativeMutationConfig>,
   cacheConfig?: CacheConfig,
   mutation: GraphQLTaggedNode,
   onError?: ?(error: Error) => void,
   onCompleted?: ?(
-    response: $ElementType<T, 'response'>,
+    response: $ElementType<TMutation, 'response'>,
     errors: ?Array<PayloadError>,
   ) => void,
   onNext?: ?() => void,
@@ -65,24 +68,26 @@ export type MutationConfig<T: MutationParameters> = {|
   optimisticResponse?: $ElementType<
     {
       +rawResponse?: {...},
-      ...T,
+      ...TMutation,
       ...
     },
     'rawResponse',
   >,
-  optimisticUpdater?: ?SelectorStoreUpdater,
-  updater?: ?SelectorStoreUpdater,
+  optimisticUpdater?: ?SelectorStoreUpdater<
+    $ElementType<TMutation, 'response'>,
+  >,
+  updater?: ?SelectorStoreUpdater<$ElementType<TMutation, 'response'>>,
   uploadables?: UploadableMap,
-  variables: $ElementType<T, 'variables'>,
+  variables: $ElementType<TMutation, 'variables'>,
 |};
 
 /**
  * Higher-level helper function to execute a mutation against a specific
  * environment.
  */
-function commitMutation<T: MutationParameters>(
+function commitMutation<TMutation: MutationParameters>(
   environment: IEnvironment,
-  config: MutationConfig<T>,
+  config: MutationConfig<TMutation>,
 ): Disposable {
   invariant(
     isRelayModernEnvironment(environment),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-runtime",
   "description": "A core runtime for building GraphQL-driven applications.",
-  "version": "0.0.0-main-9c7301dd",
+  "version": "0.0.0-main-10c2a88a",
   "keywords": [
     "graphql",
     "relay"