Introduce VariablesOf utility type

Reviewed By: kassens Differential Revision: D22165729 fbshipit-source-id: 740750ea7cffe7afd51feefa56a3a0e74bbb0294
kassens · Jul 6, 2020 · f1f784f · f1f784f
1 parent 61c8627
commit f1f784f
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 7 deletions.
diff --git a/packages/relay-experimental/EntryPointTypes.flow.js b/packages/relay-experimental/EntryPointTypes.flow.js
@@ -23,8 +23,11 @@ import type {
   Observable,
   OperationType,
   RequestParameters,
+  VariablesOf as _VariablesOf,
 } from 'relay-runtime';
 
+export type VariablesOf<T> = _VariablesOf<T>;
+
 export type PreloadFetchPolicy =
   | 'store-or-network'
   | 'store-and-network'

diff --git a/packages/relay-experimental/fetchQuery.js b/packages/relay-experimental/fetchQuery.js
@@ -29,6 +29,7 @@ import type {
   IEnvironment,
   OperationDescriptor,
   OperationType,
+  VariablesOf,
 } from 'relay-runtime';
 
 /**
@@ -111,7 +112,7 @@ import type {
 function fetchQuery<TQuery: OperationType>(
   environment: IEnvironment,
   query: GraphQLTaggedNode,
-  variables: $ElementType<TQuery, 'variables'>,
+  variables: VariablesOf<TQuery>,
   options?: $ReadOnly<{|
     fetchPolicy?: FetchQueryFetchPolicy,
     networkCacheConfig?: CacheConfig,

diff --git a/packages/relay-experimental/preloadQuery_DEPRECATED.js b/packages/relay-experimental/preloadQuery_DEPRECATED.js
@@ -31,6 +31,7 @@ import type {
   PreloadFetchPolicy,
   PreloadOptions,
   PreloadQueryStatus,
+  VariablesOf,
 } from './EntryPointTypes.flow';
 import type {
   ConcreteRequest,
@@ -76,7 +77,7 @@ type PendingQueryEntry =
 function preloadQuery<TQuery: OperationType, TEnvironmentProviderOptions>(
   environment: IEnvironment,
   preloadableRequest: GraphQLTaggedNode | PreloadableConcreteRequest<TQuery>,
-  variables: $ElementType<TQuery, 'variables'>,
+  variables: VariablesOf<TQuery>,
   options?: ?PreloadOptions,
   environmentProviderOptions?: ?TEnvironmentProviderOptions,
 ): PreloadedQueryInner_DEPRECATED<TQuery, TEnvironmentProviderOptions> {
@@ -126,7 +127,7 @@ function preloadQueryDeduped<TQuery: OperationType>(
   environment: Environment,
   pendingQueries: Map<string, PendingQueryEntry>,
   preloadableRequest: GraphQLTaggedNode | PreloadableConcreteRequest<TQuery>,
-  variables: $ElementType<TQuery, 'variables'>,
+  variables: VariablesOf<TQuery>,
   options: ?PreloadOptions,
 ): PendingQueryEntry {
   let params;

diff --git a/packages/relay-experimental/useLazyLoadQuery.js b/packages/relay-experimental/useLazyLoadQuery.js
@@ -24,11 +24,12 @@ import type {
   GraphQLTaggedNode,
   OperationType,
   RenderPolicy,
+  VariablesOf,
 } from 'relay-runtime';
 
 function useLazyLoadQuery<TQuery: OperationType>(
   gqlQuery: GraphQLTaggedNode,
-  variables: $ElementType<TQuery, 'variables'>,
+  variables: VariablesOf<TQuery>,
   options?: {|
     fetchKey?: string | number,
     fetchPolicy?: FetchPolicy,

diff --git a/packages/relay-experimental/useLoadMoreFunction.js b/packages/relay-experimental/useLoadMoreFunction.js
@@ -41,6 +41,7 @@ import type {
   OperationType,
   ReaderFragment,
   ReaderPaginationMetadata,
+  VariablesOf,
 } from 'relay-runtime';
 
 export type Direction = 'forward' | 'backward';
@@ -49,7 +50,7 @@ export type LoadMoreFn<TQuery: OperationType> = (
   count: number,
   options?: {|
     onComplete?: (Error | null) => void,
-    UNSTABLE_extraVariables?: $Shape<$ElementType<TQuery, 'variables'>>,
+    UNSTABLE_extraVariables?: $Shape<VariablesOf<TQuery>>,
   |},
 ) => Disposable;
 

diff --git a/packages/relay-experimental/useRefetchableFragmentNode.js b/packages/relay-experimental/useRefetchableFragmentNode.js
@@ -51,6 +51,7 @@ import type {
   ReaderFragment,
   RenderPolicy,
   Variables,
+  VariablesOf,
 } from 'relay-runtime';
 
 export type RefetchFn<
@@ -103,13 +104,13 @@ type RefetchFnBase<TVars, TOptions> = (
 ) => Disposable;
 
 type RefetchFnExact<TQuery: OperationType, TOptions = Options> = RefetchFnBase<
-  $ElementType<TQuery, 'variables'>,
+  VariablesOf<TQuery>,
   TOptions,
 >;
 type RefetchFnInexact<
   TQuery: OperationType,
   TOptions = Options,
-> = RefetchFnBase<$Shape<$ElementType<TQuery, 'variables'>>, TOptions>;
+> = RefetchFnBase<$Shape<VariablesOf<TQuery>>, TOptions>;
 
 type Action =
   | {|

diff --git a/packages/relay-runtime/index.js b/packages/relay-runtime/index.js
@@ -189,6 +189,7 @@ export type {
   OperationType,
   RenderPolicy,
   Variables,
+  VariablesOf,
 } from './util/RelayRuntimeTypes';
 export type {Local3DPayload} from './util/createPayloadFor3DField';
 

diff --git a/packages/relay-runtime/util/RelayRuntimeTypes.js b/packages/relay-runtime/util/RelayRuntimeTypes.js
@@ -38,6 +38,8 @@ export type OperationType = {|
   +rawResponse?: {...},
 |};
 
+export type VariablesOf<T: OperationType> = $ElementType<T, 'variables'>;
+
 /**
  * Settings for how a query response may be cached.
  *