@graphql-codegen/visitor-plugin-common 5.4.0 → 5.5.0-alpha-20241008120609-5103ffdfd3b1dde3243e745e73922d58be0c104f

package/cjs/base-resolvers-visitor.js

@@ -42,6 +42,9 @@ class BaseResolversVisitor extends base_visitor_js_1.BaseVisitor {
             mappers: (0, mappers_js_1.transformMappers)(rawConfig.mappers || {}, rawConfig.mapperTypeSuffix),
             scalars: (0, utils_js_1.buildScalarsFromConfig)(_schema, rawConfig, defaultScalars),
             internalResolversPrefix: (0, utils_js_1.getConfigValue)(rawConfig.internalResolversPrefix, '__'),
+            generateInternalResolversIfNeeded: {
+                __resolveReference: rawConfig.generateInternalResolversIfNeeded?.__resolveReference ?? false,
+            },
             resolversNonOptionalTypename: normalizeResolversNonOptionalTypename((0, utils_js_1.getConfigValue)(rawConfig.resolversNonOptionalTypename, false)),
             ...additionalConfig,
         });
@@ -60,7 +63,6 @@ class BaseResolversVisitor extends base_visitor_js_1.BaseVisitor {
         this._rootTypeNames = new Set();
         this._globalDeclarations = new Set();
         this._hasScalars = false;
-        this._hasFederation = false;
         this._checkedTypesWithNestedAbstractTypes = {};
         this._shouldMapType = {};
         (0, auto_bind_1.default)(this);
@@ -501,7 +503,7 @@ class BaseResolversVisitor extends base_visitor_js_1.BaseVisitor {
         return this._hasScalars;
     }
     hasFederation() {
-        return this._hasFederation;
+        return Object.keys(this._federation.getMeta()).length > 0;
     }
     getRootResolver() {
         const name = this.convertName(this.config.allResolversTypeName);
@@ -517,7 +519,13 @@ class BaseResolversVisitor extends base_visitor_js_1.BaseVisitor {
                 .map(schemaTypeName => {
                 const resolverType = this._collectedResolvers[schemaTypeName];
                 if (resolverType.baseGeneratedTypename) {
-                    userDefinedTypes[schemaTypeName] = { name: resolverType.baseGeneratedTypename };
+                    userDefinedTypes[schemaTypeName] = {
+                        name: resolverType.baseGeneratedTypename,
+                    };
+                    const federationMeta = this._federation.getMeta()[schemaTypeName];
+                    if (federationMeta) {
+                        userDefinedTypes[schemaTypeName].federation = federationMeta;
+                    }
                 }
                 return (0, utils_js_1.indent)(this.formatRootResolver(schemaTypeName, resolverType.typename, declarationKind));
             })
@@ -647,7 +655,14 @@ class BaseResolversVisitor extends base_visitor_js_1.BaseVisitor {
                 genericTypes: [mappedTypeKey, parentTypeSignature, contextType, argsType].filter(f => f),
             };
             if (this._federation.isResolveReferenceField(node)) {
-                this._hasFederation = true;
+                if (this.config.generateInternalResolversIfNeeded.__resolveReference) {
+                    const federationDetails = (0, plugin_helpers_1.checkObjectTypeFederationDetails)(parentType.astNode, this._schema);
+                    if (!federationDetails || federationDetails.resolvableKeyDirectives.length === 0) {
+                        return '';
+                    }
+                    signature.modifier = ''; // if a federation type has resolvable @key, then it should be required
+                }
+                this._federation.setMeta(parentType.name, { hasResolveReference: true });
                 signature.type = 'ReferenceResolver';
                 if (signature.genericTypes.length >= 3) {
                     signature.genericTypes = signature.genericTypes.slice(0, 3);

package/esm/base-resolvers-visitor.js

@@ -1,4 +1,4 @@
-import { ApolloFederation, getBaseType } from '@graphql-codegen/plugin-helpers';
+import { ApolloFederation, checkObjectTypeFederationDetails, getBaseType } from '@graphql-codegen/plugin-helpers';
 import { getRootTypeNames } from '@graphql-tools/utils';
 import autoBind from 'auto-bind';
 import { GraphQLObjectType, isEnumType, isInterfaceType, isNonNullType, isObjectType, isUnionType, } from 'graphql';
@@ -38,6 +38,9 @@ export class BaseResolversVisitor extends BaseVisitor {
             mappers: transformMappers(rawConfig.mappers || {}, rawConfig.mapperTypeSuffix),
             scalars: buildScalarsFromConfig(_schema, rawConfig, defaultScalars),
             internalResolversPrefix: getConfigValue(rawConfig.internalResolversPrefix, '__'),
+            generateInternalResolversIfNeeded: {
+                __resolveReference: rawConfig.generateInternalResolversIfNeeded?.__resolveReference ?? false,
+            },
             resolversNonOptionalTypename: normalizeResolversNonOptionalTypename(getConfigValue(rawConfig.resolversNonOptionalTypename, false)),
             ...additionalConfig,
         });
@@ -56,7 +59,6 @@ export class BaseResolversVisitor extends BaseVisitor {
         this._rootTypeNames = new Set();
         this._globalDeclarations = new Set();
         this._hasScalars = false;
-        this._hasFederation = false;
         this._checkedTypesWithNestedAbstractTypes = {};
         this._shouldMapType = {};
         autoBind(this);
@@ -497,7 +499,7 @@ export class BaseResolversVisitor extends BaseVisitor {
         return this._hasScalars;
     }
     hasFederation() {
-        return this._hasFederation;
+        return Object.keys(this._federation.getMeta()).length > 0;
     }
     getRootResolver() {
         const name = this.convertName(this.config.allResolversTypeName);
@@ -513,7 +515,13 @@ export class BaseResolversVisitor extends BaseVisitor {
                 .map(schemaTypeName => {
                 const resolverType = this._collectedResolvers[schemaTypeName];
                 if (resolverType.baseGeneratedTypename) {
-                    userDefinedTypes[schemaTypeName] = { name: resolverType.baseGeneratedTypename };
+                    userDefinedTypes[schemaTypeName] = {
+                        name: resolverType.baseGeneratedTypename,
+                    };
+                    const federationMeta = this._federation.getMeta()[schemaTypeName];
+                    if (federationMeta) {
+                        userDefinedTypes[schemaTypeName].federation = federationMeta;
+                    }
                 }
                 return indent(this.formatRootResolver(schemaTypeName, resolverType.typename, declarationKind));
             })
@@ -643,7 +651,14 @@ export class BaseResolversVisitor extends BaseVisitor {
                 genericTypes: [mappedTypeKey, parentTypeSignature, contextType, argsType].filter(f => f),
             };
             if (this._federation.isResolveReferenceField(node)) {
-                this._hasFederation = true;
+                if (this.config.generateInternalResolversIfNeeded.__resolveReference) {
+                    const federationDetails = checkObjectTypeFederationDetails(parentType.astNode, this._schema);
+                    if (!federationDetails || federationDetails.resolvableKeyDirectives.length === 0) {
+                        return '';
+                    }
+                    signature.modifier = ''; // if a federation type has resolvable @key, then it should be required
+                }
+                this._federation.setMeta(parentType.name, { hasResolveReference: true });
                 signature.type = 'ReferenceResolver';
                 if (signature.genericTypes.length >= 3) {
                     signature.genericTypes = signature.genericTypes.slice(0, 3);

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@graphql-codegen/visitor-plugin-common",
-  "version": "5.4.0",
+  "version": "5.5.0-alpha-20241008120609-5103ffdfd3b1dde3243e745e73922d58be0c104f",
   "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": "^5.0.4",
+    "@graphql-codegen/plugin-helpers": "5.1.0-alpha-20241008120609-5103ffdfd3b1dde3243e745e73922d58be0c104f",
     "@graphql-tools/relay-operation-optimizer": "^7.0.0",
     "@graphql-tools/utils": "^10.0.0",
     "auto-bind": "~4.0.0",

package/typings/base-resolvers-visitor.d.cts

@@ -2,7 +2,7 @@ import { ApolloFederation } from '@graphql-codegen/plugin-helpers';
 import { ASTNode, DirectiveDefinitionNode, EnumTypeDefinitionNode, FieldDefinitionNode, GraphQLNamedType, GraphQLObjectType, GraphQLSchema, InputValueDefinitionNode, InterfaceTypeDefinitionNode, ListTypeNode, NamedTypeNode, NameNode, NonNullTypeNode, ObjectTypeDefinitionNode, ScalarTypeDefinitionNode, UnionTypeDefinitionNode } from 'graphql';
 import { BaseVisitor, BaseVisitorConvertOptions, ParsedConfig, RawConfig } from './base-visitor.cjs';
 import { ParsedMapper } from './mappers.cjs';
-import { AvoidOptionalsConfig, ConvertOptions, DeclarationKind, EnumValuesMap, NormalizedAvoidOptionalsConfig, NormalizedScalarsMap, ParsedEnumValuesMap, ResolversNonOptionalTypenameConfig } from './types.cjs';
+import { AvoidOptionalsConfig, ConvertOptions, DeclarationKind, EnumValuesMap, type NormalizedGenerateInternalResolversIfNeededConfig, type GenerateInternalResolversIfNeededConfig, NormalizedAvoidOptionalsConfig, NormalizedScalarsMap, ParsedEnumValuesMap, ResolversNonOptionalTypenameConfig } from './types.cjs';
 import { DeclarationBlockConfig } from './utils.cjs';
 import { OperationVariablesToObject } from './variables-to-object.cjs';
 export interface ParsedResolversConfig extends ParsedConfig {
@@ -27,11 +27,26 @@ export interface ParsedResolversConfig extends ParsedConfig {
     resolverTypeSuffix: string;
     allResolversTypeName: string;
     internalResolversPrefix: string;
+    generateInternalResolversIfNeeded: NormalizedGenerateInternalResolversIfNeededConfig;
     onlyResolveTypeForInterfaces: boolean;
     directiveResolverMappings: Record<string, string>;
     resolversNonOptionalTypename: ResolversNonOptionalTypenameConfig;
 }
 type FieldDefinitionPrintFn = (parentName: string, avoidResolverOptionals: boolean) => string | null;
+export interface RootResolver {
+    content: string;
+    generatedResolverTypes: {
+        resolversMap: {
+            name: string;
+        };
+        userDefined: Record<string, {
+            name: string;
+            federation?: {
+                hasResolveReference: boolean;
+            };
+        }>;
+    };
+}
 export interface RawResolversConfig extends RawConfig {
     /**
      * @description Adds `_` to generated `Args` types in order to avoid duplicate identifiers.
@@ -521,6 +536,16 @@ export interface RawResolversConfig extends RawConfig {
      * If you are using `mercurius-js`, please set this field to empty string for better compatibility.
      */
     internalResolversPrefix?: string;
+    /**
+     * @type object
+     * @default { __resolveReference: false }
+     * @description If relevant internal resolvers are set to `true`, the resolver type will only be generated if the right conditions are met.
+     * Enabling this allows a more correct type generation for the resolvers.
+     * For example:
+     * - `__isTypeOf` is generated for implementing types and union members
+     * - `__resolveReference` is generated for federation types that have at least one resolvable `@key` directive
+     */
+    generateInternalResolversIfNeeded?: GenerateInternalResolversIfNeededConfig;
     /**
      * @type boolean
      * @default false
@@ -619,7 +644,6 @@ export declare class BaseResolversVisitor<TRawConfig extends RawResolversConfig
     protected _globalDeclarations: Set<string>;
     protected _federation: ApolloFederation;
     protected _hasScalars: boolean;
-    protected _hasFederation: boolean;
     protected _fieldContextTypeMap: FieldContextTypeMap;
     protected _directiveContextTypesMap: FieldContextTypeMap;
     protected _checkedTypesWithNestedAbstractTypes: Record<string, {
@@ -670,17 +694,7 @@ export declare class BaseResolversVisitor<TRawConfig extends RawResolversConfig
     setVariablesTransformer(variablesTransfomer: OperationVariablesToObject): void;
     hasScalars(): boolean;
     hasFederation(): boolean;
-    getRootResolver(): {
-        content: string;
-        generatedResolverTypes: {
-            resolversMap: {
-                name: string;
-            };
-            userDefined: Record<string, {
-                name: string;
-            }>;
-        };
-    };
+    getRootResolver(): RootResolver;
     protected formatRootResolver(schemaTypeName: string, resolverType: string, declarationKind: DeclarationKind): string;
     getAllDirectiveResolvers(): string;
     Name(node: NameNode): string;

package/typings/base-resolvers-visitor.d.ts

@@ -2,7 +2,7 @@ import { ApolloFederation } from '@graphql-codegen/plugin-helpers';
 import { ASTNode, DirectiveDefinitionNode, EnumTypeDefinitionNode, FieldDefinitionNode, GraphQLNamedType, GraphQLObjectType, GraphQLSchema, InputValueDefinitionNode, InterfaceTypeDefinitionNode, ListTypeNode, NamedTypeNode, NameNode, NonNullTypeNode, ObjectTypeDefinitionNode, ScalarTypeDefinitionNode, UnionTypeDefinitionNode } from 'graphql';
 import { BaseVisitor, BaseVisitorConvertOptions, ParsedConfig, RawConfig } from './base-visitor.js';
 import { ParsedMapper } from './mappers.js';
-import { AvoidOptionalsConfig, ConvertOptions, DeclarationKind, EnumValuesMap, NormalizedAvoidOptionalsConfig, NormalizedScalarsMap, ParsedEnumValuesMap, ResolversNonOptionalTypenameConfig } from './types.js';
+import { AvoidOptionalsConfig, ConvertOptions, DeclarationKind, EnumValuesMap, type NormalizedGenerateInternalResolversIfNeededConfig, type GenerateInternalResolversIfNeededConfig, NormalizedAvoidOptionalsConfig, NormalizedScalarsMap, ParsedEnumValuesMap, ResolversNonOptionalTypenameConfig } from './types.js';
 import { DeclarationBlockConfig } from './utils.js';
 import { OperationVariablesToObject } from './variables-to-object.js';
 export interface ParsedResolversConfig extends ParsedConfig {
@@ -27,11 +27,26 @@ export interface ParsedResolversConfig extends ParsedConfig {
     resolverTypeSuffix: string;
     allResolversTypeName: string;
     internalResolversPrefix: string;
+    generateInternalResolversIfNeeded: NormalizedGenerateInternalResolversIfNeededConfig;
     onlyResolveTypeForInterfaces: boolean;
     directiveResolverMappings: Record<string, string>;
     resolversNonOptionalTypename: ResolversNonOptionalTypenameConfig;
 }
 type FieldDefinitionPrintFn = (parentName: string, avoidResolverOptionals: boolean) => string | null;
+export interface RootResolver {
+    content: string;
+    generatedResolverTypes: {
+        resolversMap: {
+            name: string;
+        };
+        userDefined: Record<string, {
+            name: string;
+            federation?: {
+                hasResolveReference: boolean;
+            };
+        }>;
+    };
+}
 export interface RawResolversConfig extends RawConfig {
     /**
      * @description Adds `_` to generated `Args` types in order to avoid duplicate identifiers.
@@ -521,6 +536,16 @@ export interface RawResolversConfig extends RawConfig {
      * If you are using `mercurius-js`, please set this field to empty string for better compatibility.
      */
     internalResolversPrefix?: string;
+    /**
+     * @type object
+     * @default { __resolveReference: false }
+     * @description If relevant internal resolvers are set to `true`, the resolver type will only be generated if the right conditions are met.
+     * Enabling this allows a more correct type generation for the resolvers.
+     * For example:
+     * - `__isTypeOf` is generated for implementing types and union members
+     * - `__resolveReference` is generated for federation types that have at least one resolvable `@key` directive
+     */
+    generateInternalResolversIfNeeded?: GenerateInternalResolversIfNeededConfig;
     /**
      * @type boolean
      * @default false
@@ -619,7 +644,6 @@ export declare class BaseResolversVisitor<TRawConfig extends RawResolversConfig
     protected _globalDeclarations: Set<string>;
     protected _federation: ApolloFederation;
     protected _hasScalars: boolean;
-    protected _hasFederation: boolean;
     protected _fieldContextTypeMap: FieldContextTypeMap;
     protected _directiveContextTypesMap: FieldContextTypeMap;
     protected _checkedTypesWithNestedAbstractTypes: Record<string, {
@@ -670,17 +694,7 @@ export declare class BaseResolversVisitor<TRawConfig extends RawResolversConfig
     setVariablesTransformer(variablesTransfomer: OperationVariablesToObject): void;
     hasScalars(): boolean;
     hasFederation(): boolean;
-    getRootResolver(): {
-        content: string;
-        generatedResolverTypes: {
-            resolversMap: {
-                name: string;
-            };
-            userDefined: Record<string, {
-                name: string;
-            }>;
-        };
-    };
+    getRootResolver(): RootResolver;
     protected formatRootResolver(schemaTypeName: string, resolverType: string, declarationKind: DeclarationKind): string;
     getAllDirectiveResolvers(): string;
     Name(node: NameNode): string;

package/typings/types.d.cts

@@ -120,3 +120,7 @@ export interface ResolversNonOptionalTypenameConfig {
     interfaceImplementingType?: boolean;
     excludeTypes?: string[];
 }
+export interface GenerateInternalResolversIfNeededConfig {
+    __resolveReference?: boolean;
+}
+export type NormalizedGenerateInternalResolversIfNeededConfig = Required<GenerateInternalResolversIfNeededConfig>;

package/typings/types.d.ts

@@ -120,3 +120,7 @@ export interface ResolversNonOptionalTypenameConfig {
     interfaceImplementingType?: boolean;
     excludeTypes?: string[];
 }
+export interface GenerateInternalResolversIfNeededConfig {
+    __resolveReference?: boolean;
+}
+export type NormalizedGenerateInternalResolversIfNeededConfig = Required<GenerateInternalResolversIfNeededConfig>;