docs: add type inference with TypedDocument for variableValues

[Sleepful]

Description

Better type inference, I am not a fan of as any but that's what it takes for now, and allows variableValues to be typed-checked at executeDocument callsite

[changeset-bot]

⚠️ No Changeset found

Latest commit: 94768ab

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[Sleepful]

Added another commit, now it properly check for nested properties in the variableValues and reports an error if there are any additional properties that should not be there!

Example:

The query, just for completeness:

  const q = graphql(`
    mutation Patch($rowId: Int!, $sliderPatch: sliderPatch!) {
      updateSliderByRowId(
        input: {sliderPatch: $sliderPatch, rowId: $rowId}
      ) {
        clientMutationId
        slider {
          enDescription
          esDescription
          id
          image
          rowId
          url
        }
      }
    }
`)

Here is where it gets better reporting, ignoring the first argument of requestContext for this example:

  const res = await executeDocument({}, q, {
    sliderPatch:
      { enDescription, esDescription, image, url, a: "" },
                                    // highlights ^ `a` and reports error!
      rowId
    })

Error reported:

Object literal may only specify known properties, and 'a' does not exist in type '{ url?: string | null | undefined; esDescription?: string | null | undefined; enDescription?: string | null | undefined; image?: string | null | undefined; }'

[benjie]

I don't think we need generics for TData/TVariables, maybe something like this would work:

export async function executeDocument<TDoc extends TypedDocumentNode | DocumentNode, TExtensions = ObjMap<unknown>>(
  requestContext: Partial<Grafast.RequestContext>,
  document: TDoc,
  variableValues?: VariablesOf<TDoc>,
  operationName?: string,
): Promise<ExecutionResult<ResultOf<TDoc>, TExtensions>> {

(Also the second parameter to ExecutionResult is TExtensions not TVariables - I recognize this was already incorrect.)

[benjie]

Hi @Sleepful, gentle nudge to see if you're interested in the above change?

[Sleepful]

Thanks for taking care of the diff and merging it 💙