[typescript-operations] Add importSchemaTypesFrom to import user-defined+used input/enum types externally (#10534)

eddeee888 · eddeee888 · commit a6806c4a3f57 · 2026-04-18T23:14:07.000+10:00
* Draft importSchemaTypesFrom

* Minor test fixes

* Fix test name

* Update dev-tests

* Baseline dev-test for importSchemaTypesFrom

* Implement relative import paths correctly

* Update tests to handle outputDir correctly

* Add test for absolute importSchemaTypesFrom

* Remove unncessary files

* Add test about unused things

* Remove comment

* Add comments

* Add changeset
diff --git a/.changeset/clever-loops-crash.md b/.changeset/clever-loops-crash.md
@@ -0,0 +1,6 @@
+---
+'@graphql-codegen/visitor-plugin-common': minor
+'@graphql-codegen/typescript-operations': minor
+---
+
+Add importSchemaTypesFrom support
diff --git a/dev-test/codegen.ts b/dev-test/codegen.ts
@@ -273,6 +273,26 @@ const config: CodegenConfig = {
       plugins: ['typescript-operations'],
     },
     // #endregion
+
+    // standalone-operations
+    './dev-test/standalone-operations/import-schema-types/_base.generated.ts': {
+      schema: './dev-test/standalone-operations/schema.graphql',
+      documents: ['./dev-test/standalone-operations/import-schema-types/*.graphql'],
+      plugins: ['typescript-operations'],
+      config: {
+        generatesOperationTypes: false,
+      },
+    },
+    './dev-test/standalone-operations/import-schema-types/_types.generated.ts': {
+      schema: './dev-test/standalone-operations/schema.graphql',
+      documents: ['./dev-test/standalone-operations/import-schema-types/*.graphql'],
+      plugins: ['typescript-operations'],
+      config: {
+        importSchemaTypesFrom:
+          './dev-test/standalone-operations/import-schema-types/_base.generated.ts',
+        namespacedImportName: 'Types',
+      },
+    },
   },
 };
 
diff --git a/dev-test/githunt/typed-document-nodes.ts b/dev-test/githunt/typed-document-nodes.ts
@@ -174,18 +174,6 @@ 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
@@ -172,18 +172,6 @@ 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
@@ -167,18 +167,6 @@ 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
@@ -167,18 +167,6 @@ 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
@@ -172,18 +172,6 @@ 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
@@ -172,18 +172,6 @@ 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
@@ -35,18 +35,6 @@ 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
@@ -172,18 +172,6 @@ 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
@@ -172,18 +172,6 @@ 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/standalone-operations/import-schema-types/_base.generated.ts b/dev-test/standalone-operations/import-schema-types/_base.generated.ts
@@ -0,0 +1,6 @@
+/** UserRole Description */
+export type UserRole =
+  /** UserRole ADMIN */
+  | 'ADMIN'
+  /** UserRole CUSTOMER */
+  | 'CUSTOMER';
diff --git a/dev-test/standalone-operations/import-schema-types/_types.generated.ts b/dev-test/standalone-operations/import-schema-types/_types.generated.ts
@@ -0,0 +1,11 @@
+import type * as Types from './_base.generated';
+
+type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+export type WithVariablesQueryVariables = Exact<{
+  role?: Types.UserRole | null;
+}>;
+
+export type WithVariablesQuery = {
+  __typename?: 'Query';
+  user?: { __typename?: 'User'; id: string; name: string } | null;
+};
diff --git a/dev-test/standalone-operations/import-schema-types/query.graphql b/dev-test/standalone-operations/import-schema-types/query.graphql
@@ -0,0 +1,6 @@
+query WithVariables($role: UserRole) {
+  user(id: "100") {
+    id
+    name
+  }
+}
diff --git a/dev-test/standalone-operations/schema.graphql b/dev-test/standalone-operations/schema.graphql
@@ -0,0 +1,17 @@
+type Query {
+  user(id: ID!, role: UserRole): User
+}
+
+type User {
+  id: ID!
+  name: String!
+  role: UserRole!
+}
+
+"UserRole Description"
+enum UserRole {
+  "UserRole ADMIN"
+  ADMIN
+  "UserRole CUSTOMER"
+  CUSTOMER
+}
diff --git a/dev-test/star-wars/types.avoidOptionals.ts b/dev-test/star-wars/types.avoidOptionals.ts
@@ -244,15 +244,6 @@ 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
@@ -244,15 +244,6 @@ 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
@@ -244,15 +244,6 @@ 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
@@ -240,15 +240,6 @@ 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
@@ -244,15 +244,6 @@ 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
@@ -53,15 +53,6 @@ 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
@@ -244,15 +244,6 @@ 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
@@ -244,15 +244,6 @@ 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
@@ -244,15 +244,6 @@ 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/base-documents-visitor.ts b/packages/plugins/other/visitor-plugin-common/src/base-documents-visitor.ts
diff --git a/packages/plugins/other/visitor-plugin-common/src/graphql-type-utils.ts b/packages/plugins/other/visitor-plugin-common/src/graphql-type-utils.ts
diff --git a/packages/plugins/other/visitor-plugin-common/src/index.ts b/packages/plugins/other/visitor-plugin-common/src/index.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/__snapshots__/ts-documents.spec.ts.snap b/packages/plugins/typescript/operations/tests/__snapshots__/ts-documents.spec.ts.snap
diff --git a/packages/plugins/typescript/operations/tests/ts-documents.nullability.spec.ts b/packages/plugins/typescript/operations/tests/ts-documents.nullability.spec.ts
diff --git a/packages/plugins/typescript/operations/tests/ts-documents.standalone.enum.spec.ts b/packages/plugins/typescript/operations/tests/ts-documents.standalone.enum.spec.ts
diff --git a/packages/plugins/typescript/operations/tests/ts-documents.standalone.import-types.spec.ts b/packages/plugins/typescript/operations/tests/ts-documents.standalone.import-types.spec.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
