@graphql-codegen/visitor-plugin-common 5.7.1 → 5.8.0-alpha-20250316110831-3f757aba5365f95cb2ea64e6f2e73cd4ddd534a2

package/cjs/base-resolvers-visitor.js

@@ -47,6 +47,9 @@ class BaseResolversVisitor extends base_visitor_js_1.BaseVisitor {
             },
             resolversNonOptionalTypename: normalizeResolversNonOptionalTypename((0, utils_js_1.getConfigValue)(rawConfig.resolversNonOptionalTypename, false)),
             avoidCheckingAbstractTypesRecursively: (0, utils_js_1.getConfigValue)(rawConfig.avoidCheckingAbstractTypesRecursively, false),
+            customDirectives: {
+                semanticNonNull: rawConfig.customDirectives?.semanticNonNull ?? false,
+            },
             ...additionalConfig,
         });
         this._schema = _schema;
@@ -610,17 +613,11 @@ class BaseResolversVisitor extends base_visitor_js_1.BaseVisitor {
         const declarationKind = 'type';
         return (parentName, avoidResolverOptionals) => {
             const original = parent[key];
-            const baseType = (0, utils_js_1.getBaseTypeNode)(original.type);
-            const realType = baseType.name.value;
             const parentType = this.schema.getType(parentName);
             if (this._federation.skipField({ fieldNode: original, parentType })) {
                 return null;
             }
             const contextType = this.getContextType(parentName, node);
-            const typeToUse = this.getTypeToUse(realType);
-            const mappedType = this._variablesTransformer.wrapAstTypeWithModifiers(typeToUse, original.type);
-            const subscriptionType = this._schema.getSubscriptionType();
-            const isSubscriptionType = subscriptionType && subscriptionType.name === parentName;
             let argsType = hasArguments
                 ? this.convertName(parentName +
                     (this.config.addUnderscoreToArgsType ? '_' : '') +
@@ -647,12 +644,35 @@ class BaseResolversVisitor extends base_visitor_js_1.BaseVisitor {
                 parentType,
                 parentTypeSignature: this.getParentTypeForSignature(node),
             });
-            const mappedTypeKey = isSubscriptionType ? `${mappedType}, "${node.name}"` : mappedType;
-            const directiveMappings = node.directives
-                ?.map(directive => this._directiveResolverMappings[directive.name])
-                .filter(Boolean)
-                .reverse() ?? [];
-            const resolverType = isSubscriptionType ? 'SubscriptionResolver' : directiveMappings[0] ?? 'Resolver';
+            const { mappedTypeKey, resolverType } = (() => {
+                const baseType = (0, utils_js_1.getBaseTypeNode)(original.type);
+                const realType = baseType.name.value;
+                const typeToUse = this.getTypeToUse(realType);
+                /**
+                 * Turns GraphQL type to TypeScript types (`mappedType`) e.g.
+                 * - String!  -> ResolversTypes['String']>
+                 * - String   -> Maybe<ResolversTypes['String']>
+                 * - [String] -> Maybe<Array<Maybe<ResolversTypes['String']>>>
+                 * - [String!]! -> Array<ResolversTypes['String']>
+                 */
+                const mappedType = this._variablesTransformer.wrapAstTypeWithModifiers(typeToUse, original.type);
+                const subscriptionType = this._schema.getSubscriptionType();
+                const isSubscriptionType = subscriptionType && subscriptionType.name === parentName;
+                if (isSubscriptionType) {
+                    return {
+                        mappedTypeKey: `${mappedType}, "${node.name}"`,
+                        resolverType: 'SubscriptionResolver',
+                    };
+                }
+                const directiveMappings = node.directives
+                    ?.map(directive => this._directiveResolverMappings[directive.name])
+                    .filter(Boolean)
+                    .reverse() ?? [];
+                return {
+                    mappedTypeKey: this.modifyFieldDefinitionNodeTransformedType({ node: original, originalType: mappedType }),
+                    resolverType: directiveMappings[0] ?? 'Resolver',
+                };
+            })();
             const signature = {
                 name: node.name,
                 modifier: avoidResolverOptionals ? '' : '?',
@@ -699,6 +719,26 @@ class BaseResolversVisitor extends base_visitor_js_1.BaseVisitor {
     applyOptionalFields(argsType, _fields) {
         return `Partial<${argsType}>`;
     }
+    /**
+     * Function to apply extra transformation to a FieldDefinitionNode's TypeScript type based on config options
+     * e.g. takes `Maybe<ResolversTypes['String']>`, and returns the type without the `Maybe<>` wrapper.
+     */
+    modifyFieldDefinitionNodeTransformedType({ node, originalType, }) {
+        let result = originalType;
+        if (this.config.customDirectives.semanticNonNull) {
+            const fieldHasSemanticNonNull = node.directives.some(d => d.name.value === 'semanticNonNull');
+            if (fieldHasSemanticNonNull) {
+                result = this.clearOptional(result);
+            }
+        }
+        return result;
+    }
+    clearOptional(str) {
+        if (str.startsWith('Maybe')) {
+            return str.replace(/Maybe<(.*?)>$/, '$1');
+        }
+        return str;
+    }
     ObjectTypeDefinition(node) {
         const declarationKind = 'type';
         const name = this.convertName(node, {

package/esm/base-resolvers-visitor.js

@@ -43,6 +43,9 @@ export class BaseResolversVisitor extends BaseVisitor {
             },
             resolversNonOptionalTypename: normalizeResolversNonOptionalTypename(getConfigValue(rawConfig.resolversNonOptionalTypename, false)),
             avoidCheckingAbstractTypesRecursively: getConfigValue(rawConfig.avoidCheckingAbstractTypesRecursively, false),
+            customDirectives: {
+                semanticNonNull: rawConfig.customDirectives?.semanticNonNull ?? false,
+            },
             ...additionalConfig,
         });
         this._schema = _schema;
@@ -606,17 +609,11 @@ export class BaseResolversVisitor extends BaseVisitor {
         const declarationKind = 'type';
         return (parentName, avoidResolverOptionals) => {
             const original = parent[key];
-            const baseType = getBaseTypeNode(original.type);
-            const realType = baseType.name.value;
             const parentType = this.schema.getType(parentName);
             if (this._federation.skipField({ fieldNode: original, parentType })) {
                 return null;
             }
             const contextType = this.getContextType(parentName, node);
-            const typeToUse = this.getTypeToUse(realType);
-            const mappedType = this._variablesTransformer.wrapAstTypeWithModifiers(typeToUse, original.type);
-            const subscriptionType = this._schema.getSubscriptionType();
-            const isSubscriptionType = subscriptionType && subscriptionType.name === parentName;
             let argsType = hasArguments
                 ? this.convertName(parentName +
                     (this.config.addUnderscoreToArgsType ? '_' : '') +
@@ -643,12 +640,35 @@ export class BaseResolversVisitor extends BaseVisitor {
                 parentType,
                 parentTypeSignature: this.getParentTypeForSignature(node),
             });
-            const mappedTypeKey = isSubscriptionType ? `${mappedType}, "${node.name}"` : mappedType;
-            const directiveMappings = node.directives
-                ?.map(directive => this._directiveResolverMappings[directive.name])
-                .filter(Boolean)
-                .reverse() ?? [];
-            const resolverType = isSubscriptionType ? 'SubscriptionResolver' : directiveMappings[0] ?? 'Resolver';
+            const { mappedTypeKey, resolverType } = (() => {
+                const baseType = getBaseTypeNode(original.type);
+                const realType = baseType.name.value;
+                const typeToUse = this.getTypeToUse(realType);
+                /**
+                 * Turns GraphQL type to TypeScript types (`mappedType`) e.g.
+                 * - String!  -> ResolversTypes['String']>
+                 * - String   -> Maybe<ResolversTypes['String']>
+                 * - [String] -> Maybe<Array<Maybe<ResolversTypes['String']>>>
+                 * - [String!]! -> Array<ResolversTypes['String']>
+                 */
+                const mappedType = this._variablesTransformer.wrapAstTypeWithModifiers(typeToUse, original.type);
+                const subscriptionType = this._schema.getSubscriptionType();
+                const isSubscriptionType = subscriptionType && subscriptionType.name === parentName;
+                if (isSubscriptionType) {
+                    return {
+                        mappedTypeKey: `${mappedType}, "${node.name}"`,
+                        resolverType: 'SubscriptionResolver',
+                    };
+                }
+                const directiveMappings = node.directives
+                    ?.map(directive => this._directiveResolverMappings[directive.name])
+                    .filter(Boolean)
+                    .reverse() ?? [];
+                return {
+                    mappedTypeKey: this.modifyFieldDefinitionNodeTransformedType({ node: original, originalType: mappedType }),
+                    resolverType: directiveMappings[0] ?? 'Resolver',
+                };
+            })();
             const signature = {
                 name: node.name,
                 modifier: avoidResolverOptionals ? '' : '?',
@@ -695,6 +715,26 @@ export class BaseResolversVisitor extends BaseVisitor {
     applyOptionalFields(argsType, _fields) {
         return `Partial<${argsType}>`;
     }
+    /**
+     * Function to apply extra transformation to a FieldDefinitionNode's TypeScript type based on config options
+     * e.g. takes `Maybe<ResolversTypes['String']>`, and returns the type without the `Maybe<>` wrapper.
+     */
+    modifyFieldDefinitionNodeTransformedType({ node, originalType, }) {
+        let result = originalType;
+        if (this.config.customDirectives.semanticNonNull) {
+            const fieldHasSemanticNonNull = node.directives.some(d => d.name.value === 'semanticNonNull');
+            if (fieldHasSemanticNonNull) {
+                result = this.clearOptional(result);
+            }
+        }
+        return result;
+    }
+    clearOptional(str) {
+        if (str.startsWith('Maybe')) {
+            return str.replace(/Maybe<(.*?)>$/, '$1');
+        }
+        return str;
+    }
     ObjectTypeDefinition(node) {
         const declarationKind = 'type';
         const name = this.convertName(node, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/visitor-plugin-common",
-  "version": "5.7.1",
+  "version": "5.8.0-alpha-20250316110831-3f757aba5365f95cb2ea64e6f2e73cd4ddd534a2",
   "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"
   },

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

@@ -32,6 +32,9 @@ export interface ParsedResolversConfig extends ParsedConfig {
     directiveResolverMappings: Record<string, string>;
     resolversNonOptionalTypename: ResolversNonOptionalTypenameConfig;
     avoidCheckingAbstractTypesRecursively: boolean;
+    customDirectives: {
+        semanticNonNull: boolean;
+    };
 }
 type FieldDefinitionPrintFn = (parentName: string, avoidResolverOptionals: boolean) => string | null;
 export interface RootResolver {
@@ -505,6 +508,31 @@ export interface RawResolversConfig extends RawConfig {
      * ```
      */
     enumSuffix?: boolean;
+    /**
+     * @description Configures behavior for custom directives from various GraphQL libraries.
+     * @exampleMarkdown
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file.ts': {
+     *        plugins: ['typescript-resolvers'],
+     *        config: {
+     *          customDirectives: {
+     *            semanticNonNull: true
+     *          }
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     */
+    customDirectives?: {
+        semanticNonNull?: boolean;
+    };
     /**
      * @default false
      * @description Sets the `__resolveType` field as optional field.
@@ -721,6 +749,15 @@ export declare class BaseResolversVisitor<TRawConfig extends RawResolversConfig
     private getContextType;
     protected applyRequireFields(argsType: string, fields: InputValueDefinitionNode[]): string;
     protected applyOptionalFields(argsType: string, _fields: readonly InputValueDefinitionNode[]): string;
+    /**
+     * Function to apply extra transformation to a FieldDefinitionNode's TypeScript type based on config options
+     * e.g. takes `Maybe<ResolversTypes['String']>`, and returns the type without the `Maybe<>` wrapper.
+     */
+    protected modifyFieldDefinitionNodeTransformedType({ node, originalType, }: {
+        node: FieldDefinitionNode;
+        originalType: string;
+    }): string;
+    protected clearOptional(str: string): string;
     ObjectTypeDefinition(node: ObjectTypeDefinitionNode): string;
     UnionTypeDefinition(node: UnionTypeDefinitionNode, key: string | number, parent: any): string;
     ScalarTypeDefinition(node: ScalarTypeDefinitionNode): string;

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

@@ -32,6 +32,9 @@ export interface ParsedResolversConfig extends ParsedConfig {
     directiveResolverMappings: Record<string, string>;
     resolversNonOptionalTypename: ResolversNonOptionalTypenameConfig;
     avoidCheckingAbstractTypesRecursively: boolean;
+    customDirectives: {
+        semanticNonNull: boolean;
+    };
 }
 type FieldDefinitionPrintFn = (parentName: string, avoidResolverOptionals: boolean) => string | null;
 export interface RootResolver {
@@ -505,6 +508,31 @@ export interface RawResolversConfig extends RawConfig {
      * ```
      */
     enumSuffix?: boolean;
+    /**
+     * @description Configures behavior for custom directives from various GraphQL libraries.
+     * @exampleMarkdown
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file.ts': {
+     *        plugins: ['typescript-resolvers'],
+     *        config: {
+     *          customDirectives: {
+     *            semanticNonNull: true
+     *          }
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     */
+    customDirectives?: {
+        semanticNonNull?: boolean;
+    };
     /**
      * @default false
      * @description Sets the `__resolveType` field as optional field.
@@ -721,6 +749,15 @@ export declare class BaseResolversVisitor<TRawConfig extends RawResolversConfig
     private getContextType;
     protected applyRequireFields(argsType: string, fields: InputValueDefinitionNode[]): string;
     protected applyOptionalFields(argsType: string, _fields: readonly InputValueDefinitionNode[]): string;
+    /**
+     * Function to apply extra transformation to a FieldDefinitionNode's TypeScript type based on config options
+     * e.g. takes `Maybe<ResolversTypes['String']>`, and returns the type without the `Maybe<>` wrapper.
+     */
+    protected modifyFieldDefinitionNodeTransformedType({ node, originalType, }: {
+        node: FieldDefinitionNode;
+        originalType: string;
+    }): string;
+    protected clearOptional(str: string): string;
     ObjectTypeDefinition(node: ObjectTypeDefinitionNode): string;
     UnionTypeDefinition(node: UnionTypeDefinitionNode, key: string | number, parent: any): string;
     ScalarTypeDefinition(node: ScalarTypeDefinitionNode): string;