Urql 4 now have more strict types for variables (#329)

dotansimha · Sep 7, 2023 · e330c6e · e330c6e
1 parent b2ab7cb
commit e330c6e
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 6 deletions.
diff --git a/.changeset/kind-pens-argue.md b/.changeset/kind-pens-argue.md
@@ -0,0 +1,5 @@
+---
+'@graphql-codegen/typescript-vue-urql': minor
+---
+
+Generate explicit type for variables used in a query to work with urql v4
diff --git a/packages/plugins/typescript/vue-urql/src/visitor.ts b/packages/plugins/typescript/vue-urql/src/visitor.ts
@@ -98,8 +98,8 @@ export function use${operationName}<R = ${operationResultType}>(options: Omit<Ur
     }
 
     return `
-export function use${operationName}(options: Omit<Urql.Use${operationType}Args<never, ${operationVariablesTypes}>, 'query'> = {}) {
-  return Urql.use${operationType}<${operationResultType}>({ query: ${documentVariableName}, ...options });
+export function use${operationName}(options: Omit<Urql.Use${operationType}Args<never, ${operationVariablesTypes}>, 'query'>) {
+  return Urql.use${operationType}<${operationResultType}, ${operationVariablesTypes}>({ query: ${documentVariableName}, ...options });
 };`;
   }
 

diff --git a/packages/plugins/typescript/vue-urql/tests/__snapshots__/urql.spec.ts.snap b/packages/plugins/typescript/vue-urql/tests/__snapshots__/urql.spec.ts.snap
@@ -24,7 +24,7 @@ import * as Urql from '@urql/vue';
 export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
 
 
-export function useTestQuery(options: Omit<Urql.UseQueryArgs<never, Operations.TestQueryVariables>, 'query'> = {}) {
-  return Urql.useQuery<Operations.TestQuery>({ query: Operations.TestDocument, ...options });
+export function useTestQuery(options: Omit<Urql.UseQueryArgs<never, Operations.TestQueryVariables>, 'query'>) {
+  return Urql.useQuery<Operations.TestQuery, Operations.TestQueryVariables>({ query: Operations.TestDocument, ...options });
 };"
 `;
diff --git a/packages/plugins/typescript/vue-urql/tests/urql.spec.ts b/packages/plugins/typescript/vue-urql/tests/urql.spec.ts
@@ -477,8 +477,8 @@ query MyFeed {
       )) as Types.ComplexPluginOutput;
 
       expect(content.content).toBeSimilarStringTo(`
-export function useFeedQuery(options: Omit<Urql.UseQueryArgs<never, FeedQueryVariables>, 'query'> = {}) {
-  return Urql.useQuery<FeedQuery>({ query: FeedDocument, ...options });
+export function useFeedQuery(options: Omit<Urql.UseQueryArgs<never, FeedQueryVariables>, 'query'>) {
+  return Urql.useQuery<FeedQuery, FeedQueryVariables>({ query: FeedDocument, ...options });
 };`);
 
       expect(content.content).toBeSimilarStringTo(`