Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Urql 4 now have more strict generics for passing variables #328

Closed
mlesin opened this issue Apr 12, 2023 · 5 comments
Closed

Urql 4 now have more strict generics for passing variables #328

mlesin opened this issue Apr 12, 2023 · 5 comments

Comments

@mlesin
Copy link
Contributor

mlesin commented Apr 12, 2023

Which packages are impacted by your issue?

@graphql-codegen/typescript-vue-urql

Describe the bug

Recent Urql major version update now have more strict type requirements for passing variable into useQuery generic.
Now it forces variables property to be required in passing object if any variable is not optional, and that breaks code generated by typescript-vue-urql:

export function useUsersQuery(
  options: Omit<Urql.UseQueryArgs<never, UsersQueryVariables>, "query"> = {} // ERROR: Property 'variables' is missing in type '{}' but required in type 'Omit<UseQueryArgs<never, Exact<{ id: string; }>>, "query">'.
) {
  return Urql.useQuery<UsersQuery>({ query: UsersDocument, ...options }); // ERROR: Property 'variables' is optional in type ...skipped... but required in type 'MaybeRefObj$1<{ query: DocumentInput<UsersQuery, AnyVariables>; variables: AnyVariables; }>'
}

Your Example Website or App

https://the-guild.dev/graphql/codegen

Steps to Reproduce the Bug or Issue

  1. Go to https://the-guild.dev/graphql/codegen
  2. Provide the following schema:
schema {
  query: Query
}

type Query {
  user(id: String!): User
}

type User {
  id: String!
  username: String!
  email: String!
}
  1. Provide the following operations:
query users($id: String!) {
  user(id: $id) {
    id
    username
  }
}
  1. Provide the following config:
generates:
  components.ts:
    plugins:
      - typescript-vue-urql

Expected behavior

That is pretty easy to fix, however:

export function useUsersQuery(  
  options: Omit<Urql.UseQueryArgs<never, UsersQueryVariables>, "query">
//---------------------------------------------------------------------^^ Removing default object here
) {
  return Urql.useQuery<UsersQuery, UsersQueryVariables>({ query: UsersDocument, ...options });
//---------------------------------^^^^^^^^^^^^^^^^^^^ Passing variables type explicitly
}

Screenshots or Videos

No response

Platform

  • OS: Linux
  • NodeJS: [e.g. 18.14.0]
  • graphql version: [e.g. 16.3.0]
  • @graphql-codegen/typescript-vue-urq version: 2.3.6
  • @urql/core version 4.0.4

Codegen Config File

No response

Additional context

No response

@TimoStolz
Copy link

For further reference, this issue has been also reported as issue #9421 in repo dotansimha/graphql-code-generator

@TimoStolz
Copy link

The relevant change in urql is reported here: urql-graphql/urql#2607

@productdevbook
Copy link

I have the same problem and I hope this problem will be solved as soon as possible.

@lucastraba
Copy link

This was fixed, but it stopped working again!

@saihaj
Copy link
Collaborator

saihaj commented Sep 5, 2024

@saihaj saihaj closed this as completed Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants