[FEAT]: Support TypedDocumentNode

[jyasskin]

Describe the need

It would be nice if calling graphql(SomeAppropriateConstant) would apply the appropriate Typescript types to the input variables and return value. The graphql-codegen ecosystem has tooling to compile queries to that appropriate constant, but it needs a small amount of integration with request libraries to propagate the types.

https://github.com/dotansimha/graphql-typed-document-node?tab=readme-ov-file#how-can-i-support-this-in-my-library has instructions. The main cost is in adding a dependency on that type-only library.

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[jyasskin]

Oops, you probably actually need to use the TypedDocumentString type that's not actually exported from graphql-typed-document-node: dotansimha/graphql-typed-document-node#163.

[fpapado]

I would love to work on this! I just noticed that @graphql-typed-document-node/core exports a DocumentTypeDecoration type as its lowest-common-denominator kind of type, so I believe it is possible to add an overload in octokit, without needing to name TypedDocumentString directly 👀