[typescript-operations] Generate enums referenced in operation Variables (#10508)

eddeee888 · web-flow · commit 046102142aca · 2025-11-26T00:47:46.000+11:00
* Collect used enums

* Use enum converter for Enum

* Add changeset

* Add doc

* Update dev tests

* Fix return type issue
diff --git a/.changeset/curly-trees-lead.md b/.changeset/curly-trees-lead.md
@@ -0,0 +1,5 @@
+---
+'@graphql-codegen/typescript-operations': major
+---
+
+BREAKING CHANGE: typescript-operations plugin now generates enum if it is used in operation.
diff --git a/dev-test/githunt/typed-document-nodes.ts b/dev-test/githunt/typed-document-nodes.ts
@@ -169,6 +169,18 @@ export enum VoteType {
   Up = 'UP',
 }
 
+/** A list of options for the sort order of the feed */
+export type FeedType =
+  /** Sort by a combination of freshness and score, using Reddit's algorithm */
+  | 'HOT'
+  /** Newest entries first */
+  | 'NEW'
+  /** Highest score entries first */
+  | 'TOP';
+
+/** The type of vote to record, when submitting a vote */
+export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
+
 export type OnCommentAddedSubscriptionVariables = Exact<{
   repoFullName: string;
 }>;
diff --git a/dev-test/githunt/types.avoidOptionals.ts b/dev-test/githunt/types.avoidOptionals.ts
@@ -168,6 +168,18 @@ export enum VoteType {
   Up = 'UP',
 }
 
+/** A list of options for the sort order of the feed */
+export type FeedType =
+  /** Sort by a combination of freshness and score, using Reddit's algorithm */
+  | 'HOT'
+  /** Newest entries first */
+  | 'NEW'
+  /** Highest score entries first */
+  | 'TOP';
+
+/** The type of vote to record, when submitting a vote */
+export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
+
 export type OnCommentAddedSubscriptionVariables = Exact<{
   repoFullName: string;
 }>;
diff --git a/dev-test/githunt/types.d.ts b/dev-test/githunt/types.d.ts
@@ -163,6 +163,18 @@ export type Vote = {
 /** The type of vote to record, when submitting a vote */
 export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
 
+/** A list of options for the sort order of the feed */
+export type FeedType =
+  /** Sort by a combination of freshness and score, using Reddit's algorithm */
+  | 'HOT'
+  /** Newest entries first */
+  | 'NEW'
+  /** Highest score entries first */
+  | 'TOP';
+
+/** The type of vote to record, when submitting a vote */
+export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
+
 export type OnCommentAddedSubscriptionVariables = Exact<{
   repoFullName: string;
 }>;
diff --git a/dev-test/githunt/types.enumsAsTypes.ts b/dev-test/githunt/types.enumsAsTypes.ts
@@ -163,6 +163,18 @@ export type Vote = {
 /** The type of vote to record, when submitting a vote */
 export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
 
+/** A list of options for the sort order of the feed */
+export type FeedType =
+  /** Sort by a combination of freshness and score, using Reddit's algorithm */
+  | 'HOT'
+  /** Newest entries first */
+  | 'NEW'
+  /** Highest score entries first */
+  | 'TOP';
+
+/** The type of vote to record, when submitting a vote */
+export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
+
 export type OnCommentAddedSubscriptionVariables = Exact<{
   repoFullName: string;
 }>;
diff --git a/dev-test/githunt/types.flatten.preResolveTypes.ts b/dev-test/githunt/types.flatten.preResolveTypes.ts
@@ -168,6 +168,18 @@ export enum VoteType {
   Up = 'UP',
 }
 
+/** A list of options for the sort order of the feed */
+export type FeedType =
+  /** Sort by a combination of freshness and score, using Reddit's algorithm */
+  | 'HOT'
+  /** Newest entries first */
+  | 'NEW'
+  /** Highest score entries first */
+  | 'TOP';
+
+/** The type of vote to record, when submitting a vote */
+export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
+
 export type OnCommentAddedSubscriptionVariables = Exact<{
   repoFullName: string;
 }>;
diff --git a/dev-test/githunt/types.immutableTypes.ts b/dev-test/githunt/types.immutableTypes.ts
@@ -168,6 +168,18 @@ export enum VoteType {
   Up = 'UP',
 }
 
+/** A list of options for the sort order of the feed */
+export type FeedType =
+  /** Sort by a combination of freshness and score, using Reddit's algorithm */
+  | 'HOT'
+  /** Newest entries first */
+  | 'NEW'
+  /** Highest score entries first */
+  | 'TOP';
+
+/** The type of vote to record, when submitting a vote */
+export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
+
 export type OnCommentAddedSubscriptionVariables = Exact<{
   repoFullName: string;
 }>;
diff --git a/dev-test/githunt/types.preResolveTypes.onlyOperationTypes.ts b/dev-test/githunt/types.preResolveTypes.onlyOperationTypes.ts
@@ -31,6 +31,18 @@ export enum VoteType {
   Up = 'UP',
 }
 
+/** A list of options for the sort order of the feed */
+export type FeedType =
+  /** Sort by a combination of freshness and score, using Reddit's algorithm */
+  | 'HOT'
+  /** Newest entries first */
+  | 'NEW'
+  /** Highest score entries first */
+  | 'TOP';
+
+/** The type of vote to record, when submitting a vote */
+export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
+
 export type OnCommentAddedSubscriptionVariables = Exact<{
   repoFullName: string;
 }>;
diff --git a/dev-test/githunt/types.preResolveTypes.ts b/dev-test/githunt/types.preResolveTypes.ts
@@ -168,6 +168,18 @@ export enum VoteType {
   Up = 'UP',
 }
 
+/** A list of options for the sort order of the feed */
+export type FeedType =
+  /** Sort by a combination of freshness and score, using Reddit's algorithm */
+  | 'HOT'
+  /** Newest entries first */
+  | 'NEW'
+  /** Highest score entries first */
+  | 'TOP';
+
+/** The type of vote to record, when submitting a vote */
+export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
+
 export type OnCommentAddedSubscriptionVariables = Exact<{
   repoFullName: string;
 }>;
diff --git a/dev-test/githunt/types.ts b/dev-test/githunt/types.ts
@@ -168,6 +168,18 @@ export enum VoteType {
   Up = 'UP',
 }
 
+/** A list of options for the sort order of the feed */
+export type FeedType =
+  /** Sort by a combination of freshness and score, using Reddit's algorithm */
+  | 'HOT'
+  /** Newest entries first */
+  | 'NEW'
+  /** Highest score entries first */
+  | 'TOP';
+
+/** The type of vote to record, when submitting a vote */
+export type VoteType = 'CANCEL' | 'DOWN' | 'UP';
+
 export type OnCommentAddedSubscriptionVariables = Exact<{
   repoFullName: string;
 }>;
diff --git a/dev-test/star-wars/types.avoidOptionals.ts b/dev-test/star-wars/types.avoidOptionals.ts
@@ -240,6 +240,15 @@ export type StarshipLengthArgs = {
   unit?: InputMaybe<LengthUnit>;
 };
 
+/** The episodes in the Star Wars trilogy */
+export type Episode =
+  /** Star Wars Episode V: The Empire Strikes Back, released in 1980. */
+  | 'EMPIRE'
+  /** Star Wars Episode VI: Return of the Jedi, released in 1983. */
+  | 'JEDI'
+  /** Star Wars Episode IV: A New Hope, released in 1977. */
+  | 'NEWHOPE';
+
 export type CreateReviewForEpisodeMutationVariables = Exact<{
   episode: Episode;
   review: ReviewInput;
diff --git a/dev-test/star-wars/types.excludeQueryAlpha.ts b/dev-test/star-wars/types.excludeQueryAlpha.ts
@@ -240,6 +240,15 @@ export type StarshipLengthArgs = {
   unit?: InputMaybe<LengthUnit>;
 };
 
+/** The episodes in the Star Wars trilogy */
+export type Episode =
+  /** Star Wars Episode V: The Empire Strikes Back, released in 1980. */
+  | 'EMPIRE'
+  /** Star Wars Episode VI: Return of the Jedi, released in 1983. */
+  | 'JEDI'
+  /** Star Wars Episode IV: A New Hope, released in 1977. */
+  | 'NEWHOPE';
+
 export type CreateReviewForEpisodeMutationVariables = Exact<{
   episode: Episode;
   review: ReviewInput;
diff --git a/dev-test/star-wars/types.excludeQueryBeta.ts b/dev-test/star-wars/types.excludeQueryBeta.ts
@@ -240,6 +240,15 @@ export type StarshipLengthArgs = {
   unit?: InputMaybe<LengthUnit>;
 };
 
+/** The episodes in the Star Wars trilogy */
+export type Episode =
+  /** Star Wars Episode V: The Empire Strikes Back, released in 1980. */
+  | 'EMPIRE'
+  /** Star Wars Episode VI: Return of the Jedi, released in 1983. */
+  | 'JEDI'
+  /** Star Wars Episode IV: A New Hope, released in 1977. */
+  | 'NEWHOPE';
+
 export type CreateReviewForEpisodeMutationVariables = Exact<{
   episode: Episode;
   review: ReviewInput;
diff --git a/dev-test/star-wars/types.globallyAvailable.d.ts b/dev-test/star-wars/types.globallyAvailable.d.ts
@@ -238,6 +238,15 @@ type StarshipLengthArgs = {
   unit?: InputMaybe<LengthUnit>;
 };
 
+/** The episodes in the Star Wars trilogy */
+type Episode =
+  /** Star Wars Episode V: The Empire Strikes Back, released in 1980. */
+  | 'EMPIRE'
+  /** Star Wars Episode VI: Return of the Jedi, released in 1983. */
+  | 'JEDI'
+  /** Star Wars Episode IV: A New Hope, released in 1977. */
+  | 'NEWHOPE';
+
 type CreateReviewForEpisodeMutationVariables = Exact<{
   episode: Episode;
   review: ReviewInput;
diff --git a/dev-test/star-wars/types.immutableTypes.ts b/dev-test/star-wars/types.immutableTypes.ts
@@ -240,6 +240,15 @@ export type StarshipLengthArgs = {
   unit?: InputMaybe<LengthUnit>;
 };
 
+/** The episodes in the Star Wars trilogy */
+export type Episode =
+  /** Star Wars Episode V: The Empire Strikes Back, released in 1980. */
+  | 'EMPIRE'
+  /** Star Wars Episode VI: Return of the Jedi, released in 1983. */
+  | 'JEDI'
+  /** Star Wars Episode IV: A New Hope, released in 1977. */
+  | 'NEWHOPE';
+
 export type CreateReviewForEpisodeMutationVariables = Exact<{
   episode: Episode;
   review: ReviewInput;
diff --git a/dev-test/star-wars/types.preResolveTypes.onlyOperationTypes.ts b/dev-test/star-wars/types.preResolveTypes.onlyOperationTypes.ts
@@ -49,6 +49,15 @@ export type ReviewInput = {
   stars: Scalars['Int']['input'];
 };
 
+/** The episodes in the Star Wars trilogy */
+export type Episode =
+  /** Star Wars Episode V: The Empire Strikes Back, released in 1980. */
+  | 'EMPIRE'
+  /** Star Wars Episode VI: Return of the Jedi, released in 1983. */
+  | 'JEDI'
+  /** Star Wars Episode IV: A New Hope, released in 1977. */
+  | 'NEWHOPE';
+
 export type CreateReviewForEpisodeMutationVariables = Exact<{
   episode: Episode;
   review: ReviewInput;
diff --git a/dev-test/star-wars/types.preResolveTypes.ts b/dev-test/star-wars/types.preResolveTypes.ts
@@ -240,6 +240,15 @@ export type StarshipLengthArgs = {
   unit?: InputMaybe<LengthUnit>;
 };
 
+/** The episodes in the Star Wars trilogy */
+export type Episode =
+  /** Star Wars Episode V: The Empire Strikes Back, released in 1980. */
+  | 'EMPIRE'
+  /** Star Wars Episode VI: Return of the Jedi, released in 1983. */
+  | 'JEDI'
+  /** Star Wars Episode IV: A New Hope, released in 1977. */
+  | 'NEWHOPE';
+
 export type CreateReviewForEpisodeMutationVariables = Exact<{
   episode: Episode;
   review: ReviewInput;
diff --git a/dev-test/star-wars/types.skipSchema.ts b/dev-test/star-wars/types.skipSchema.ts
@@ -240,6 +240,15 @@ export type StarshipLengthArgs = {
   unit?: InputMaybe<LengthUnit>;
 };
 
+/** The episodes in the Star Wars trilogy */
+export type Episode =
+  /** Star Wars Episode V: The Empire Strikes Back, released in 1980. */
+  | 'EMPIRE'
+  /** Star Wars Episode VI: Return of the Jedi, released in 1983. */
+  | 'JEDI'
+  /** Star Wars Episode IV: A New Hope, released in 1977. */
+  | 'NEWHOPE';
+
 export type CreateReviewForEpisodeMutationVariables = Exact<{
   episode: Episode;
   review: ReviewInput;
diff --git a/dev-test/star-wars/types.ts b/dev-test/star-wars/types.ts
@@ -240,6 +240,15 @@ export type StarshipLengthArgs = {
   unit?: InputMaybe<LengthUnit>;
 };
 
+/** The episodes in the Star Wars trilogy */
+export type Episode =
+  /** Star Wars Episode V: The Empire Strikes Back, released in 1980. */
+  | 'EMPIRE'
+  /** Star Wars Episode VI: Return of the Jedi, released in 1983. */
+  | 'JEDI'
+  /** Star Wars Episode IV: A New Hope, released in 1977. */
+  | 'NEWHOPE';
+
 export type CreateReviewForEpisodeMutationVariables = Exact<{
   episode: Episode;
   review: ReviewInput;
diff --git a/packages/plugins/other/visitor-plugin-common/src/convert-schema-enum-to-declaration-block-string.ts b/packages/plugins/other/visitor-plugin-common/src/convert-schema-enum-to-declaration-block-string.ts
@@ -9,7 +9,7 @@ import {
   wrapWithSingleQuotes,
 } from './utils.js';
 
-interface ConvertSchemaEnumToDeclarationBlockString {
+export interface ConvertSchemaEnumToDeclarationBlockString {
   schema: GraphQLSchema;
   node: EnumTypeDefinitionNode;
   enumName: string;
diff --git a/packages/plugins/typescript/operations/package.json b/packages/plugins/typescript/operations/package.json
@@ -15,6 +15,7 @@
   "dependencies": {
     "@graphql-codegen/plugin-helpers": "^6.0.0",
     "@graphql-codegen/typescript": "^5.0.4",
+    "@graphql-codegen/schema-ast": "^5.0.0",
     "@graphql-codegen/visitor-plugin-common": "6.1.2",
     "auto-bind": "~4.0.0",
     "tslib": "~2.6.0"
diff --git a/packages/plugins/typescript/operations/src/config.ts b/packages/plugins/typescript/operations/src/config.ts
diff --git a/packages/plugins/typescript/operations/src/index.ts b/packages/plugins/typescript/operations/src/index.ts
diff --git a/packages/plugins/typescript/operations/src/visitor.ts b/packages/plugins/typescript/operations/src/visitor.ts
diff --git a/packages/plugins/typescript/operations/tests/ts-documents.standalone.spec.ts b/packages/plugins/typescript/operations/tests/ts-documents.standalone.spec.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@graphql-codegen/typescript-operations': major
 +---
++
 +BREAKING CHANGE: typescript-operations plugin now generates enum if it is used in operation.