Empty variables, consider using never type?

[christoomey]

First, thank you so much for this wonderful project! It's extremely impressive and I've been very happy with it overall.

I did run into one small issue for a query with no variables, e.g.

const QUERY = gql`
  query Users {
    users {
      id
      name
    }
  }
`

For this query, the generated type of the UsersVariables would be:

export type UsersVariables = {};

Unfortunately, TypeScript is a bit overly permissive with the {} literal value and will allow any object to be assigned:

type UsersVariables = {}

// The following is incorrect as the query takes no variables,
// but the typing allows it
const variables: UsersVariables = { name: 'hello' }

// Using a more restrictive type, we can prevent this:
type UsersVariablesNever = { [index: string]: never };
// This line will now properly highlight the `name` value
// as an error since the query doesn't accept any variables
const neverVariables: UsersVariablesNever = { name: 'hello' }

TypeScript playground with this example

---

My suggestion would be to use the more restrictive { [index: string]: never } instead of {} for empty variable type definitions.

[Quramy]

@christoomey

Thanks your feedback.

For this query, the generated type of the UsersVariables would be:

export type UsersVariables = {};

I think it' better to not generate variable type for no-variadic query. How about it ?

[christoomey]

That is certainly an option and would fix the correctness issue. In my case I was hoping to rely on the graphql query as the source of truth and then be able to use the generated types to constrain my system. My hope was to be able to always wire up the variables and have them correctly give me feedback.