[typescript-urql] improve query hooks argument types

Is your feature request related to a problem? Please describe.

Even if you generate code with a query with required arguments, you can still make a no-argument call because the function arguments are set to default values. Therefore, it is not type-safe.

example

query Foo($bar: String!) {
  foo(bar: $bar) {
    id
  }
}

generated code

export function useFooQuery(options: Omit<Urql.UseQueryArgs<FooQueryVariables>, 'query'> = {}) {
//                                                                                       ^^^^ set default value
  return Urql.useQuery<FooQuery>({ query: FooDocument, ...options });                                         
};

// The following code will not result in a compilation error
useFooQuery();

Describe the solution you’d like

For documents with required arguments, generate code with required arguments.

export function useFooQuery(options: Omit<Urql.UseQueryArgs<FooQueryVariables>, 'query'>) {
  return Urql.useQuery<FooQuery>({ query: FooDocument, ...options });                                         
};

Also, if the arguments are optional, the arguments should also be optional of generated code.

query Foo2($bar: String) {
  foo2(bar: $bar) {
    id
  }
}

export function useFoo2Query(options?: Omit<Urql.UseQueryArgs<Foo2QueryVariables>, 'query'>) {
//                                  ^ optional
  return Urql.useQuery<Foo2Query>({ query: Foo2Document, ...options });                                         
};

Additional context I have fixed this issue. I can submit a PR if you need it.

[edkimmel]

Hello, I don’t believe 3.5.0 has fixed this problem. It appears to have made the outer options required now, but not the variables object, which is the actual important piece for the required query variables.

query MySubscription($userId: String!) {
  ...
}

useMySubscriptionQuery() <-- Now fails in 3.5.0 useMySubscriptionQuery({}) <-- Compiles, but is still incorrect useMySubscriptionQuery({variables: {userId: "123"}}) <-- The correct requirement

[charlypoly]

Released in @graphql-codegen/typescript-urql@3.5.0 📦