@graphql-codegen/visitor-plugin-common 6.1.2 → 6.2.0-alpha-20251119131248-4aa0bce27decc294509fae591f5c2236858abdbb

package/cjs/base-visitor.js

@@ -4,11 +4,16 @@ exports.BaseVisitor = void 0;
 const tslib_1 = require("tslib");
 const auto_bind_1 = tslib_1.__importDefault(require("auto-bind"));
 const naming_js_1 = require("./naming.js");
+const plugin_helpers_1 = require("@graphql-codegen/plugin-helpers");
 class BaseVisitor {
     _parsedConfig;
     _declarationBlockConfig = {};
     scalars;
     constructor(rawConfig, additionalConfig) {
+        const importExtension = (0, plugin_helpers_1.normalizeImportExtension)({
+            emitLegacyCommonJSImports: rawConfig.emitLegacyCommonJSImports,
+            importExtension: rawConfig.importExtension,
+        });
         this._parsedConfig = {
             convert: (0, naming_js_1.convertFactory)(rawConfig),
             typesPrefix: rawConfig.typesPrefix || '',
@@ -20,7 +25,8 @@ class BaseVisitor {
             useTypeImports: !!rawConfig.useTypeImports,
             allowEnumStringTypes: !!rawConfig.allowEnumStringTypes,
             inlineFragmentTypes: rawConfig.inlineFragmentTypes ?? 'inline',
-            emitLegacyCommonJSImports: rawConfig.emitLegacyCommonJSImports === undefined ? true : !!rawConfig.emitLegacyCommonJSImports,
+            emitLegacyCommonJSImports: rawConfig.emitLegacyCommonJSImports ?? true,
+            importExtension,
             extractAllFieldsToTypes: rawConfig.extractAllFieldsToTypes ?? false,
             printFieldsOnNewLines: rawConfig.printFieldsOnNewLines ?? false,
             includeExternalFragments: rawConfig.includeExternalFragments ?? false,

package/cjs/client-side-base-visitor.js

@@ -296,7 +296,11 @@ class ClientSideBaseVisitor extends base_visitor_js_1.BaseVisitor {
     }
     clearExtension(path) {
         const extension = (0, path_1.extname)(path);
-        if (!this.config.emitLegacyCommonJSImports && extension === '.js') {
+        const importExtension = (0, plugin_helpers_1.normalizeImportExtension)({
+            emitLegacyCommonJSImports: this.config.emitLegacyCommonJSImports,
+            importExtension: this.config.importExtension,
+        });
+        if (extension === importExtension) {
             return path;
         }
         if (EXTENSIONS_TO_REMOVE.includes(extension)) {
@@ -330,9 +334,10 @@ class ClientSideBaseVisitor extends base_visitor_js_1.BaseVisitor {
                 if (this._collectedOperations.length > 0) {
                     if (this.config.importDocumentNodeExternallyFrom === 'near-operation-file' && this._documents.length === 1) {
                         let documentPath = `./${this.clearExtension((0, path_1.basename)(this._documents[0].location))}`;
-                        if (!this.config.emitLegacyCommonJSImports) {
-                            documentPath += '.js';
-                        }
+                        documentPath += (0, plugin_helpers_1.normalizeImportExtension)({
+                            emitLegacyCommonJSImports: this.config.emitLegacyCommonJSImports,
+                            importExtension: this.config.importExtension,
+                        });
                         this._imports.add(`import * as Operations from '${documentPath}';`);
                     }
                     else {
@@ -350,6 +355,10 @@ class ClientSideBaseVisitor extends base_visitor_js_1.BaseVisitor {
         }
         const excludeFragments = options.excludeFragments || this.config.globalNamespace || this.config.documentMode !== DocumentMode.graphQLTag;
         if (!excludeFragments) {
+            const importExtension = (0, plugin_helpers_1.normalizeImportExtension)({
+                emitLegacyCommonJSImports: this.config.emitLegacyCommonJSImports,
+                importExtension: this.config.importExtension,
+            });
             const deduplicatedImports = Object.values((0, utils_js_1.groupBy)(this.config.fragmentImports, fi => fi.importSource.path))
                 .map((fragmentImports) => ({
                 ...fragmentImports[0],
@@ -358,6 +367,7 @@ class ClientSideBaseVisitor extends base_visitor_js_1.BaseVisitor {
                     identifiers: (0, utils_js_1.unique)((0, utils_js_1.flatten)(fragmentImports.map(fi => fi.importSource.identifiers)), identifier => identifier.name),
                 },
                 emitLegacyCommonJSImports: this.config.emitLegacyCommonJSImports,
+                importExtension,
             }))
                 .filter(fragmentImport => fragmentImport.outputPath !== fragmentImport.importSource.path);
             for (const fragmentImport of deduplicatedImports) {

package/cjs/imports.js

@@ -9,6 +9,7 @@ exports.fixLocalFilePath = fixLocalFilePath;
 const tslib_1 = require("tslib");
 const path_1 = require("path");
 const parse_filepath_1 = tslib_1.__importDefault(require("parse-filepath"));
+const plugin_helpers_1 = require("@graphql-codegen/plugin-helpers");
 function generateFragmentImportStatement(statement, kind) {
     const { importSource: fragmentImportSource, ...rest } = statement;
     const { identifiers, path, namespace } = fragmentImportSource;
@@ -31,7 +32,12 @@ function generateImportStatement(statement) {
     const importNames = importSource.identifiers?.length
         ? `{ ${Array.from(new Set(importSource.identifiers)).join(', ')} }`
         : '*';
-    const importExtension = importPath.startsWith('/') || importPath.startsWith('.') ? (statement.emitLegacyCommonJSImports ? '' : '.js') : '';
+    const importExtension = importPath.startsWith('/') || importPath.startsWith('.')
+        ? (0, plugin_helpers_1.normalizeImportExtension)({
+            emitLegacyCommonJSImports: statement.emitLegacyCommonJSImports,
+            importExtension: statement.importExtension,
+        })
+        : '';
     const importAlias = importSource.namespace ? ` as ${importSource.namespace}` : '';
     const importStatement = typesImport ? 'import type' : 'import';
     return `${importStatement} ${importNames}${importAlias} from '${importPath}${importExtension}';${importAlias ? '\n' : ''}`;

package/esm/base-visitor.js

@@ -1,10 +1,15 @@
 import autoBind from 'auto-bind';
 import { convertFactory } from './naming.js';
+import { normalizeImportExtension } from '@graphql-codegen/plugin-helpers';
 export class BaseVisitor {
     _parsedConfig;
     _declarationBlockConfig = {};
     scalars;
     constructor(rawConfig, additionalConfig) {
+        const importExtension = normalizeImportExtension({
+            emitLegacyCommonJSImports: rawConfig.emitLegacyCommonJSImports,
+            importExtension: rawConfig.importExtension,
+        });
         this._parsedConfig = {
             convert: convertFactory(rawConfig),
             typesPrefix: rawConfig.typesPrefix || '',
@@ -16,7 +21,8 @@ export class BaseVisitor {
             useTypeImports: !!rawConfig.useTypeImports,
             allowEnumStringTypes: !!rawConfig.allowEnumStringTypes,
             inlineFragmentTypes: rawConfig.inlineFragmentTypes ?? 'inline',
-            emitLegacyCommonJSImports: rawConfig.emitLegacyCommonJSImports === undefined ? true : !!rawConfig.emitLegacyCommonJSImports,
+            emitLegacyCommonJSImports: rawConfig.emitLegacyCommonJSImports ?? true,
+            importExtension,
             extractAllFieldsToTypes: rawConfig.extractAllFieldsToTypes ?? false,
             printFieldsOnNewLines: rawConfig.printFieldsOnNewLines ?? false,
             includeExternalFragments: rawConfig.includeExternalFragments ?? false,

package/esm/client-side-base-visitor.js

@@ -1,5 +1,5 @@
 import { basename, extname } from 'path';
-import { oldVisit } from '@graphql-codegen/plugin-helpers';
+import { normalizeImportExtension, oldVisit } from '@graphql-codegen/plugin-helpers';
 import { optimizeDocumentNode } from '@graphql-tools/optimize';
 import autoBind from 'auto-bind';
 import { pascalCase } from 'change-case-all';
@@ -292,7 +292,11 @@ export class ClientSideBaseVisitor extends BaseVisitor {
     }
     clearExtension(path) {
         const extension = extname(path);
-        if (!this.config.emitLegacyCommonJSImports && extension === '.js') {
+        const importExtension = normalizeImportExtension({
+            emitLegacyCommonJSImports: this.config.emitLegacyCommonJSImports,
+            importExtension: this.config.importExtension,
+        });
+        if (extension === importExtension) {
             return path;
         }
         if (EXTENSIONS_TO_REMOVE.includes(extension)) {
@@ -326,9 +330,10 @@ export class ClientSideBaseVisitor extends BaseVisitor {
                 if (this._collectedOperations.length > 0) {
                     if (this.config.importDocumentNodeExternallyFrom === 'near-operation-file' && this._documents.length === 1) {
                         let documentPath = `./${this.clearExtension(basename(this._documents[0].location))}`;
-                        if (!this.config.emitLegacyCommonJSImports) {
-                            documentPath += '.js';
-                        }
+                        documentPath += normalizeImportExtension({
+                            emitLegacyCommonJSImports: this.config.emitLegacyCommonJSImports,
+                            importExtension: this.config.importExtension,
+                        });
                         this._imports.add(`import * as Operations from '${documentPath}';`);
                     }
                     else {
@@ -346,6 +351,10 @@ export class ClientSideBaseVisitor extends BaseVisitor {
         }
         const excludeFragments = options.excludeFragments || this.config.globalNamespace || this.config.documentMode !== DocumentMode.graphQLTag;
         if (!excludeFragments) {
+            const importExtension = normalizeImportExtension({
+                emitLegacyCommonJSImports: this.config.emitLegacyCommonJSImports,
+                importExtension: this.config.importExtension,
+            });
             const deduplicatedImports = Object.values(groupBy(this.config.fragmentImports, fi => fi.importSource.path))
                 .map((fragmentImports) => ({
                 ...fragmentImports[0],
@@ -354,6 +363,7 @@ export class ClientSideBaseVisitor extends BaseVisitor {
                     identifiers: unique(flatten(fragmentImports.map(fi => fi.importSource.identifiers)), identifier => identifier.name),
                 },
                 emitLegacyCommonJSImports: this.config.emitLegacyCommonJSImports,
+                importExtension,
             }))
                 .filter(fragmentImport => fragmentImport.outputPath !== fragmentImport.importSource.path);
             for (const fragmentImport of deduplicatedImports) {

package/esm/imports.js

@@ -1,5 +1,6 @@
 import { dirname, isAbsolute, join, relative, resolve } from 'path';
 import parse from 'parse-filepath';
+import { normalizeImportExtension } from '@graphql-codegen/plugin-helpers';
 export function generateFragmentImportStatement(statement, kind) {
     const { importSource: fragmentImportSource, ...rest } = statement;
     const { identifiers, path, namespace } = fragmentImportSource;
@@ -22,7 +23,12 @@ export function generateImportStatement(statement) {
     const importNames = importSource.identifiers?.length
         ? `{ ${Array.from(new Set(importSource.identifiers)).join(', ')} }`
         : '*';
-    const importExtension = importPath.startsWith('/') || importPath.startsWith('.') ? (statement.emitLegacyCommonJSImports ? '' : '.js') : '';
+    const importExtension = importPath.startsWith('/') || importPath.startsWith('.')
+        ? normalizeImportExtension({
+            emitLegacyCommonJSImports: statement.emitLegacyCommonJSImports,
+            importExtension: statement.importExtension,
+        })
+        : '';
     const importAlias = importSource.namespace ? ` as ${importSource.namespace}` : '';
     const importStatement = typesImport ? 'import type' : 'import';
     return `${importStatement} ${importNames}${importAlias} from '${importPath}${importExtension}';${importAlias ? '\n' : ''}`;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@graphql-codegen/visitor-plugin-common",
-  "version": "6.1.2",
+  "version": "6.2.0-alpha-20251119131248-4aa0bce27decc294509fae591f5c2236858abdbb",
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
     "@graphql-tools/optimize": "^2.0.0",
-    "@graphql-codegen/plugin-helpers": "^6.0.0",
+    "@graphql-codegen/plugin-helpers": "6.1.0-alpha-20251119131248-4aa0bce27decc294509fae591f5c2236858abdbb",
     "@graphql-tools/relay-operation-optimizer": "^7.0.0",
     "@graphql-tools/utils": "^10.0.0",
     "auto-bind": "~4.0.0",

package/typings/base-visitor.d.cts

@@ -21,7 +21,8 @@ export interface ParsedConfig {
     useTypeImports: boolean;
     allowEnumStringTypes: boolean;
     inlineFragmentTypes: InlineFragmentTypeOptions;
-    emitLegacyCommonJSImports: boolean;
+    emitLegacyCommonJSImports?: boolean;
+    importExtension: '' | `.${string}`;
     printFieldsOnNewLines: boolean;
     includeExternalFragments: boolean;
 }
@@ -343,11 +344,17 @@ export interface RawConfig {
      */
     inlineFragmentTypes?: InlineFragmentTypeOptions;
     /**
+     * @deprecated Please use `importExtension` instead.
      * @default true
      * @description Emit legacy common js imports.
      * Default it will be `true` this way it ensure that generated code works with [non-compliant bundlers](https://github.com/dotansimha/graphql-code-generator/issues/8065).
      */
     emitLegacyCommonJSImports?: boolean;
+    /**
+     * @description Append this extension to all imports.
+     * Useful for ESM environments that require file extensions in import statements.
+     */
+    importExtension?: '' | `.${string}`;
     /**
      * @default false
      * @description Extract all field types to their own types, instead of inlining them.

package/typings/base-visitor.d.ts

@@ -21,7 +21,8 @@ export interface ParsedConfig {
     useTypeImports: boolean;
     allowEnumStringTypes: boolean;
     inlineFragmentTypes: InlineFragmentTypeOptions;
-    emitLegacyCommonJSImports: boolean;
+    emitLegacyCommonJSImports?: boolean;
+    importExtension: '' | `.${string}`;
     printFieldsOnNewLines: boolean;
     includeExternalFragments: boolean;
 }
@@ -343,11 +344,17 @@ export interface RawConfig {
      */
     inlineFragmentTypes?: InlineFragmentTypeOptions;
     /**
+     * @deprecated Please use `importExtension` instead.
      * @default true
      * @description Emit legacy common js imports.
      * Default it will be `true` this way it ensure that generated code works with [non-compliant bundlers](https://github.com/dotansimha/graphql-code-generator/issues/8065).
      */
     emitLegacyCommonJSImports?: boolean;
+    /**
+     * @description Append this extension to all imports.
+     * Useful for ESM environments that require file extensions in import statements.
+     */
+    importExtension?: '' | `.${string}`;
     /**
      * @default false
      * @description Extract all field types to their own types, instead of inlining them.

package/typings/imports.d.cts

@@ -4,7 +4,8 @@ export type ImportDeclaration<T = string> = {
     baseOutputDir: string;
     baseDir: string;
     typesImport: boolean;
-    emitLegacyCommonJSImports: boolean;
+    emitLegacyCommonJSImports?: boolean;
+    importExtension: '' | `.${string}`;
 };
 export type ImportSource<T = string> = {
     /**

package/typings/imports.d.ts

@@ -4,7 +4,8 @@ export type ImportDeclaration<T = string> = {
     baseOutputDir: string;
     baseDir: string;
     typesImport: boolean;
-    emitLegacyCommonJSImports: boolean;
+    emitLegacyCommonJSImports?: boolean;
+    importExtension: '' | `.${string}`;
 };
 export type ImportSource<T = string> = {
     /**