[visitor-plugin-common] fix: satisfy strict mode in base-types-visitor (#4683) (#11037)

Author: eddeee888

.changeset/strict-visitor-plugin-common-types.md

@@ -0,0 +1,10 @@
+---
+'@graphql-codegen/visitor-plugin-common': patch
+---
+
+Fix type errors in `visitor-plugin-common` (`base-types-visitor`) under `strict: true`:
+
+- `BaseTypesVisitor`'s constructor takes `additionalConfig` as `Partial<TPluginConfig>`, since the visitor fills in the defaults for every key it leaves out.
+- `BaseTypesVisitor` handles input objects, objects, interfaces, unions and enums without `fields`, `types`, `values` or `description` by treating them as empty, instead of throwing.
+
+Generated output is unchanged.

packages/plugins/other/visitor-plugin-common/src/base-types-visitor.ts

@@ -503,7 +503,7 @@ export class BaseTypesVisitor<
   constructor(
     protected _schema: GraphQLSchema,
     rawConfig: TRawConfig,
-    additionalConfig: TPluginConfig,
+    additionalConfig: Partial<TPluginConfig>,
     defaultScalars: NormalizedScalarsMap = DEFAULT_SCALARS,
   ) {
     super(rawConfig, {
@@ -568,7 +568,7 @@ export class BaseTypesVisitor<
   }
 
   public getScalarsImports(): string[] {
-    return Object.keys(this.config.scalars).reduce((res, enumName) => {
+    return Object.keys(this.config.scalars).reduce<string[]>((res, enumName) => {
       const mappedValue = this.config.scalars[enumName];
 
       if (mappedValue.input.isExternal) {
@@ -613,7 +613,7 @@ export class BaseTypesVisitor<
 
         return null;
       })
-      .filter(a => a);
+      .filter((a): a is string => !!a);
   }
 
   public get scalarsDefinition(): string {
@@ -694,21 +694,22 @@ export class BaseTypesVisitor<
       .asKind(this._parsedConfig.declarationKind.input)
       .withName(this.convertName(node))
       .withComment(node.description?.value)
-      .withBlock(node.fields.join('\n'));
+      .withBlock((node.fields || []).join('\n'));
   }
 
   getInputObjectOneOfDeclarationBlock(node: InputObjectTypeDefinitionNode): DeclarationBlock {
+    const fields = node.fields || [];
     return new DeclarationBlock(this._declarationBlockConfig)
       .export()
       .asKind(
         getOneOfInputDeclarationKind({
-          fieldCount: node.fields.length,
+          fieldCount: fields.length,
           inputDeclarationKind: this._parsedConfig.declarationKind.input,
         }),
       )
       .withName(this.convertName(node))
       .withComment(node.description?.value)
-      .withContent(`\n` + node.fields.join('\n  |'));
+      .withContent(`\n` + fields.join('\n  |'));
   }
 
   InputObjectTypeDefinition(node: InputObjectTypeDefinitionNode): string {
@@ -730,9 +731,10 @@ export class BaseTypesVisitor<
   ): string {
     if (this.config.onlyEnums) return '';
 
-    const comment = transformComment(node.description.value, 1);
+    const comment = transformComment(node.description?.value || '', 1);
     const { input } = this._parsedConfig.declarationKind;
 
+    // `node.type` is already printed to a string by the visitor; removing the cast needs a visited-AST type for `node`
     let type: string = node.type as any as string;
     if (node.directives && this.config.directiveArgumentAndInputFieldMappings) {
       type = this._getDirectiveOverrideType(node.directives) || type;
@@ -753,8 +755,9 @@ export class BaseTypesVisitor<
 
   UnionTypeDefinition(node: UnionTypeDefinitionNode, key: string | number, parent: any): string {
     if (this.config.onlyOperationTypes || this.config.onlyEnums) return '';
+    // `node.types` are already printed strings, so the original AST node is read from `parent[key]`, and `parent` is `any` because oldVisit's parent is untyped
     const originalNode = parent[key] as UnionTypeDefinitionNode;
-    const possibleTypes = originalNode.types
+    const possibleTypes = (originalNode.types || [])
       .map(t =>
         this.scalars[t.name.value] ? this._getScalar(t.name.value, 'output') : this.convertName(t),
       )
@@ -764,7 +767,7 @@ export class BaseTypesVisitor<
       .export()
       .asKind('type')
       .withName(this.convertName(node))
-      .withComment(node.description.value)
+      .withComment(node.description?.value)
       .withContent(possibleTypes).string;
   }
 
@@ -787,6 +790,7 @@ export class BaseTypesVisitor<
   ): DeclarationBlock {
     const optionalTypename = this.config.nonOptionalTypename ? '__typename' : '__typename?';
     const { type, interface: interfacesType } = this._parsedConfig.declarationKind;
+    // `node.fields` are already printed to strings by the visitor; dropping `as string[]` needs a visited-AST type for `node`
     const allFields = [
       ...(this.config.addTypename
         ? [
@@ -797,7 +801,7 @@ export class BaseTypesVisitor<
             ),
           ]
         : []),
-      ...node.fields,
+      ...(node.fields || []),
     ] as string[];
     const interfacesNames = originalNode.interfaces
       ? originalNode.interfaces.map(i => this.convertName(i))
@@ -857,7 +861,7 @@ export class BaseTypesVisitor<
       .withName(this.convertName(node))
       .withComment(node.description?.value);
 
-    return declarationBlock.withBlock(node.fields.join('\n'));
+    return declarationBlock.withBlock((node.fields || []).join('\n'));
   }
 
   InterfaceTypeDefinition(
@@ -905,11 +909,11 @@ export class BaseTypesVisitor<
           useTypesSuffix: this.config.enumSuffix,
         }),
       )
-      .withComment(node.description.value)
+      .withComment(node.description?.value)
       .withBlock(
         buildEnumValuesBlock({
           typeName: enumName,
-          values: node.values,
+          values: node.values || [],
           schema: this._schema,
           naming: {
             convert: this.config.convert,
@@ -960,9 +964,11 @@ export class BaseTypesVisitor<
     return this.getArgumentsObjectDeclarationBlock(node, name, field).string;
   }
 
-  protected buildArgumentsBlock(node: InterfaceTypeDefinitionNode | ObjectTypeDefinitionNode) {
+  protected buildArgumentsBlock(
+    node: InterfaceTypeDefinitionNode | ObjectTypeDefinitionNode,
+  ): string {
     const fieldsWithArguments =
-      node.fields.filter(field => field.arguments && field.arguments.length > 0) || [];
+      node.fields?.filter(field => field.arguments && field.arguments.length > 0) || [];
     return fieldsWithArguments
       .map(field => {
         const name =