Forward directive arguments params to context type

[robertherber]

Description

This adds any arguments passed to directives to the directiveContextTypes, allowing more for specific context types.

Here is an example:

directive @auth (
  match: JSONObject
  skip: Boolean
  includes: JSONObject
) on FIELD_DEFINITION

type Mutation {
  createEntity(name: String!): Entity! @auth(match: { cmsCanModifyEntities: true })

  getEntity(name: String!): Entity! @auth(skip: true)
}

With this PR we can customize the ContextType of each resolver to adapt to whatever arguments where passed to the @auth directive.

In our example we can respect both the skip: true (i.e. no token in context) as well as cmsCanModifyEntities: true (our auth middleware has verified that the token contains this):

type AuthContextWithToken<TContext, DirectiveArgs extends {
      readonly match?: Record<string, unknown>
      readonly includes?: Record<string, unknown>
      readonly skip?: boolean
    }> = DirectiveArgs['skip'] extends true
      ? Omit<TContext, 'decodedToken' | 'token'>
      : Omit<TContext, 'decodedToken'> & {
        readonly decodedToken: DirectiveArgs['match']
        & Record<keyof DirectiveArgs['includes'], ReadonlyArray<DirectiveArgs['includes']>>
      }

Related # (issue)
#9668

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Not 100% sure if we should consider this a breaking change, it expects the directiveContextTypes to accept 2 type parameters instead of 1.

Screenshots/Sandbox (if appropriate/relevant):

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Used through patch in readapt
• Added a resolver (bar) demonstrating the functionality in the current test suite.

Test Environment:

• OS: MacOS
• @graphql-codegen/...:
• NodeJS: 18

Checklist:

• I have followed the CONTRIBUTING doc and the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[changeset-bot]

🦋 Changeset detected

Latest commit: fac1505

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 10 packages

Name	Type
@graphql-codegen/testing	Minor
@graphql-codegen/typescript-resolvers	Minor
@graphql-codegen/visitor-plugin-common	Minor
@graphql-codegen/typescript-document-nodes	Patch
@graphql-codegen/gql-tag-operations	Patch
@graphql-codegen/typescript-operations	Patch
@graphql-codegen/typed-document-node	Patch
@graphql-codegen/typescript	Patch
@graphql-codegen/graphql-modules-preset	Patch
@graphql-codegen/client-preset	Patch

Not sure what this means? Click here to learn what changesets are.

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

[robertherber]

@dotansimha Any chance of getting a test run (and review) on this? Thx :)

[saihaj]

nice tests

[robertherber]

@saihaj @dotansimha What are we missing to get this merged? Is there anything more I can do?

I see some checks are failing - but not sure it has to do with this PR (I see other PRs seems to fail similarly).

[robertherber]

@saihaj @dotansimha Any chance of getting this merged? Thanks :)