GraphQL useMutation options (redwoodjs#3041)

sahilsaini1107 · Jul 27, 2021 · d9d3852 · d9d3852
1 parent 03140b2
commit d9d3852
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 16 deletions.
diff --git a/packages/web/src/apollo/typeOverride.ts b/packages/web/src/apollo/typeOverride.ts
@@ -1,10 +1,19 @@
 // Override useQuery and useMutation types
-import type { QueryResult, MutationTuple } from '@apollo/client'
+import type {
+  QueryHookOptions,
+  QueryResult,
+  MutationHookOptions,
+  MutationTuple,
+} from '@apollo/client'
 
+// @MARK: Override relevant types from Apollo here
 declare global {
   interface QueryOperationResult extends QueryResult {}
   interface MutationOperationResult<TData, TVariables>
     extends MutationTuple<TData, TVariables> {}
+
+  interface GraphQLQueryHookOptions extends QueryHookOptions {}
+  interface GraphQLMutationHookOptions extends MutationHookOptions {}
 }
 
 export {}
diff --git a/packages/web/src/components/GraphQLHooksProvider.tsx b/packages/web/src/components/GraphQLHooksProvider.tsx
@@ -1,20 +1,13 @@
 import type { DocumentNode } from 'graphql'
 
-export interface GraphQLHookOptions {
-  variables?: Record<string, any>
-  refetchQueries?: { query: DocumentNode; variables?: Record<string, any> }[]
-  onCompleted?: (data: any) => void
-  [key: string]: any
-}
-
 type DefaultUseQueryType = (
   query: DocumentNode,
-  options?: GraphQLHookOptions
+  options?: GraphQLQueryHookOptions
 ) => QueryOperationResult
 
 type DefaultUseMutationType = (
   mutation: DocumentNode,
-  options?: GraphQLHookOptions
+  options?: GraphQLMutationHookOptions
 ) => MutationOperationResult
 export interface GraphQLHooks<
   TuseQuery = DefaultUseQueryType,
@@ -73,14 +66,14 @@ export const GraphQLHooksProvider = <
 
 export function useQuery<TData = any>(
   query: DocumentNode,
-  options?: GraphQLHookOptions
+  options?: GraphQLQueryHookOptions
 ): QueryOperationResult<TData> {
   return React.useContext(GraphQLHooksContext).useQuery(query, options)
 }
 
 export function useMutation<TData = any>(
   mutation: DocumentNode,
-  options?: GraphQLHookOptions
+  options?: GraphQLMutationHookOptions
 ): MutationOperationResult<TData> {
   return React.useContext(GraphQLHooksContext).useMutation(mutation, options)
 }
diff --git a/packages/web/src/global.web-auto-imports.ts b/packages/web/src/global.web-auto-imports.ts
@@ -23,4 +23,16 @@ declare global {
   // not defining it here, because it gets overriden by Apollo provider anyway
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   interface MutationOperationResult<TData = any, TVariables = any> {}
+
+  // Overridable useQuery and useMutation hooks
+  interface GraphQLQueryHookOptions {
+    variables?: Record<string, any>
+    [key: string]: any
+  }
+
+  export interface GraphQLMutationHookOptions {
+    variables?: Record<string, any>
+    onCompleted?: (data: any) => void
+    [key: string]: any
+  }
 }
diff --git a/tasks/framework-tools/yarn.lock b/tasks/framework-tools/yarn.lock
@@ -2429,10 +2429,10 @@
   resolved "https://registry.yarnpkg.com/@open-draft/until/-/until-1.0.3.tgz#db9cc719191a62e7d9200f6e7bab21c5b848adca"
   integrity sha512-Aq58f5HiWdyDlFffbbSjAlv596h/cOnt2DO1w3DOC7OJ5EHs0hd/nycJfiu9RJbT6Yk6F1knnRRXNSpxoIVZ9Q==
 
-"@redwoodjs/[email protected].1":
-  version "0.35.1"
-  resolved "https://registry.yarnpkg.com/@redwoodjs/eslint-config/-/eslint-config-0.35.1.tgz#db6155303775b09734045f4c8dbc1a22bd9fa0ac"
-  integrity sha512-WIHQESsyAsNb9syugVCJU1kO5meXA8wSuDHEIoZFvbZ1ylegusdksAdeX3hwhgx6DlNbdJZRlkqLy8ilMd74Mw==
+"@redwoodjs/[email protected].2":
+  version "0.35.2"
+  resolved "https://registry.yarnpkg.com/@redwoodjs/eslint-config/-/eslint-config-0.35.2.tgz#3e6a6fb7aa3444a8ce723403f260c82efc4fcbec"
+  integrity sha512-Q3IxuGCFl1wnEV5zbeqBh3pSCrbPBd2rK3iQmqPtBD9ni4OnfaYwyYOo+eLIYufUmULSn/y8QNT5Flwylapt8g==
   dependencies:
     "@typescript-eslint/eslint-plugin" "4.28.2"
     "@typescript-eslint/parser" "4.28.2"