@graphql-codegen/visitor-plugin-common 3.0.2 → 3.1.0-alpha-20230310110943-3acf07a7b

package/cjs/base-resolvers-visitor.js

@@ -41,6 +41,7 @@ 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, '__'),
+            resolversNonOptionalTypename: normalizeResolversNonOptionalTypename((0, utils_js_1.getConfigValue)(rawConfig.resolversNonOptionalTypename, false)),
             ...additionalConfig,
         });
         this._schema = _schema;
@@ -281,7 +282,10 @@ class BaseResolversVisitor extends base_visitor_js_1.BaseVisitor {
                         const finalTypename = isScalar ? this._getScalar(typeName) : unionMemberValue;
                         return replacePlaceholder(this.config.defaultMapper.type, finalTypename);
                     }
-                    return unionMemberValue;
+                    const nonOptionalTypenameModifier = this.config.resolversNonOptionalTypename.union
+                        ? ` & { __typename: "${unionMemberType}" }`
+                        : '';
+                    return `${unionMemberValue}${nonOptionalTypenameModifier}`;
                 });
                 res[typeName] = referencedTypes.map(type => `( ${type} )`).join(' | '); // Must wrap every union member in explicit "( )" to separate the members
             }
@@ -785,3 +789,17 @@ function replacePlaceholder(pattern, typename) {
 function hasPlaceholder(pattern) {
     return pattern.includes('{T}');
 }
+function normalizeResolversNonOptionalTypename(input) {
+    const defaultConfig = {
+        union: false,
+    };
+    if (typeof input === 'boolean') {
+        return {
+            union: input,
+        };
+    }
+    return {
+        ...defaultConfig,
+        ...input,
+    };
+}

package/esm/base-resolvers-visitor.js

@@ -37,6 +37,7 @@ export class BaseResolversVisitor extends BaseVisitor {
             mappers: transformMappers(rawConfig.mappers || {}, rawConfig.mapperTypeSuffix),
             scalars: buildScalarsFromConfig(_schema, rawConfig, defaultScalars),
             internalResolversPrefix: getConfigValue(rawConfig.internalResolversPrefix, '__'),
+            resolversNonOptionalTypename: normalizeResolversNonOptionalTypename(getConfigValue(rawConfig.resolversNonOptionalTypename, false)),
             ...additionalConfig,
         });
         this._schema = _schema;
@@ -277,7 +278,10 @@ export class BaseResolversVisitor extends BaseVisitor {
                         const finalTypename = isScalar ? this._getScalar(typeName) : unionMemberValue;
                         return replacePlaceholder(this.config.defaultMapper.type, finalTypename);
                     }
-                    return unionMemberValue;
+                    const nonOptionalTypenameModifier = this.config.resolversNonOptionalTypename.union
+                        ? ` & { __typename: "${unionMemberType}" }`
+                        : '';
+                    return `${unionMemberValue}${nonOptionalTypenameModifier}`;
                 });
                 res[typeName] = referencedTypes.map(type => `( ${type} )`).join(' | '); // Must wrap every union member in explicit "( )" to separate the members
             }
@@ -780,3 +784,17 @@ function replacePlaceholder(pattern, typename) {
 function hasPlaceholder(pattern) {
     return pattern.includes('{T}');
 }
+function normalizeResolversNonOptionalTypename(input) {
+    const defaultConfig = {
+        union: false,
+    };
+    if (typeof input === 'boolean') {
+        return {
+            union: input,
+        };
+    }
+    return {
+        ...defaultConfig,
+        ...input,
+    };
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@graphql-codegen/visitor-plugin-common",
-  "version": "3.0.2",
+  "version": "3.1.0-alpha-20230310110943-3acf07a7b",
   "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": "^1.3.0",
-    "@graphql-codegen/plugin-helpers": "^4.1.0",
+    "@graphql-codegen/plugin-helpers": "4.1.1-alpha-20230310110943-3acf07a7b",
     "@graphql-tools/relay-operation-optimizer": "^6.5.0",
     "@graphql-tools/utils": "^9.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, 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, NormalizedScalarsMap, ParsedEnumValuesMap } from './types.cjs';
+import { AvoidOptionalsConfig, ConvertOptions, DeclarationKind, EnumValuesMap, NormalizedScalarsMap, ParsedEnumValuesMap, ResolversNonOptionalTypenameConfig } from './types.cjs';
 import { DeclarationBlockConfig } from './utils.cjs';
 import { OperationVariablesToObject } from './variables-to-object.cjs';
 export interface ParsedResolversConfig extends ParsedConfig {
@@ -28,6 +28,7 @@ export interface ParsedResolversConfig extends ParsedConfig {
     internalResolversPrefix: string;
     onlyResolveTypeForInterfaces: boolean;
     directiveResolverMappings: Record<string, string>;
+    resolversNonOptionalTypename: ResolversNonOptionalTypenameConfig;
 }
 export interface RawResolversConfig extends RawConfig {
     /**
@@ -493,6 +494,11 @@ export interface RawResolversConfig extends RawConfig {
      * @description Turning this flag to `true` will generate resolver signature that has only `resolveType` for interfaces, forcing developers to write inherited type resolvers in the type itself.
      */
     onlyResolveTypeForInterfaces?: boolean;
+    /**
+     * @description Make __typename of resolver mappings non-optional
+     * @default false
+     */
+    resolversNonOptionalTypename?: boolean | ResolversNonOptionalTypenameConfig;
     /**
      * @ignore
      */

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

@@ -2,7 +2,7 @@ import { ApolloFederation } from '@graphql-codegen/plugin-helpers';
 import { ASTNode, DirectiveDefinitionNode, EnumTypeDefinitionNode, FieldDefinitionNode, GraphQLNamedType, 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, NormalizedScalarsMap, ParsedEnumValuesMap } from './types.js';
+import { AvoidOptionalsConfig, ConvertOptions, DeclarationKind, EnumValuesMap, NormalizedScalarsMap, ParsedEnumValuesMap, ResolversNonOptionalTypenameConfig } from './types.js';
 import { DeclarationBlockConfig } from './utils.js';
 import { OperationVariablesToObject } from './variables-to-object.js';
 export interface ParsedResolversConfig extends ParsedConfig {
@@ -28,6 +28,7 @@ export interface ParsedResolversConfig extends ParsedConfig {
     internalResolversPrefix: string;
     onlyResolveTypeForInterfaces: boolean;
     directiveResolverMappings: Record<string, string>;
+    resolversNonOptionalTypename: ResolversNonOptionalTypenameConfig;
 }
 export interface RawResolversConfig extends RawConfig {
     /**
@@ -493,6 +494,11 @@ export interface RawResolversConfig extends RawConfig {
      * @description Turning this flag to `true` will generate resolver signature that has only `resolveType` for interfaces, forcing developers to write inherited type resolvers in the type itself.
      */
     onlyResolveTypeForInterfaces?: boolean;
+    /**
+     * @description Make __typename of resolver mappings non-optional
+     * @default false
+     */
+    resolversNonOptionalTypename?: boolean | ResolversNonOptionalTypenameConfig;
     /**
      * @ignore
      */

package/typings/types.d.cts

@@ -99,3 +99,6 @@ export interface ParsedImport {
     moduleName: string | null;
     propName: string;
 }
+export interface ResolversNonOptionalTypenameConfig {
+    union?: boolean;
+}

package/typings/types.d.ts

@@ -99,3 +99,6 @@ export interface ParsedImport {
     moduleName: string | null;
     propName: string;
 }
+export interface ResolversNonOptionalTypenameConfig {
+    union?: boolean;
+}