feat: add externalUnionsAsInterfaces config (#13)

ExpediaGroup · Mar 14, 2024 · cb48d1d · cb48d1d
1 parent b50dafb
commit cb48d1d
Show file tree

Hide file tree

Showing 18 changed files with 25 additions and 6 deletions.
diff --git a/src/config.ts b/src/config.ts
@@ -34,6 +34,11 @@ export const configSchema = object({
    * @description If `MyType` depends on `MyDependentType1` and `MyDependentType2`, we can allow `MyDependentType2` to be imported externally by including its import in `extraImports` and omitting it in the `dependentTypesInScope` list: `["MyType", "MyDependentType1"]`
    */
   dependentTypesInScope: optional(array(string())),
+  /**
+   * Denotes Kotlin classes representing union types to be treated as interfaces rather than annotation classes.
+   * This should be used for types outside `dependentTypesInScope` that are not generated by the plugin.
+   */
+  externalUnionsAsInterfaces: optional(array(string())),
   /**
    * Additional imports to add to the generated file.
    * @example ["com.example.additional.import.*"]

diff --git a/src/helpers/build-annotations.ts b/src/helpers/build-annotations.ts
@@ -55,8 +55,8 @@ export function buildAnnotations({
   const directiveAnnotations = definitionNode
     ? buildDirectiveAnnotations(definitionNode, config, description)
     : "";
-  const unionAnnotation = resolvedType?.annotation
-    ? `@${resolvedType.annotation}\n`
+  const unionAnnotation = resolvedType?.unionAnnotation
+    ? `@${resolvedType.unionAnnotation}\n`
     : "";
 
   const annotations = [

diff --git a/src/helpers/build-type-metadata.ts b/src/helpers/build-type-metadata.ts
@@ -25,7 +25,7 @@ import { CodegenConfig } from "../plugin";
 
 export interface TypeMetadata {
   typeName: string;
-  annotation?: string;
+  unionAnnotation?: string;
   defaultValue: string;
   isNullable: boolean;
 }
@@ -59,10 +59,17 @@ export function buildTypeMetadata(
       typeName: buildListType(typeNode, scalarTypeName),
     };
   } else if (isUnionType(schemaType)) {
+    const shouldTreatUnionAsInterface =
+      config.externalUnionsAsInterfaces?.includes(schemaType.name);
     return {
       ...commonMetadata,
-      annotation: schemaType.name,
-      typeName: buildListType(typeNode, "Any"),
+      unionAnnotation: shouldTreatUnionAsInterface
+        ? undefined
+        : schemaType.name,
+      typeName: buildListType(
+        typeNode,
+        shouldTreatUnionAsInterface ? schemaType.name : "Any",
+      ),
     };
   } else {
     return {

diff --git a/...hould_annotate_enums_properly/expected.kt → ...hould_generate_enums_properly/expected.kt b/...hould_annotate_enums_properly/expected.kt → ...hould_generate_enums_properly/expected.kt
diff --git a/...ld_annotate_enums_properly/schema.graphql → ...ld_generate_enums_properly/schema.graphql b/...ld_annotate_enums_properly/schema.graphql → ...ld_generate_enums_properly/schema.graphql
diff --git a/...annotate_input_types_properly/expected.kt → ...generate_input_types_properly/expected.kt b/...annotate_input_types_properly/expected.kt → ...generate_input_types_properly/expected.kt
diff --git a/...otate_input_types_properly/schema.graphql → ...erate_input_types_properly/schema.graphql b/...otate_input_types_properly/schema.graphql → ...erate_input_types_properly/schema.graphql
diff --git a/...te_multi-union_types_properly/expected.kt → ...te_multi-union_types_properly/expected.kt b/...te_multi-union_types_properly/expected.kt → ...te_multi-union_types_properly/expected.kt
diff --git a/...multi-union_types_properly/schema.graphql → ...multi-union_types_properly/schema.graphql b/...multi-union_types_properly/schema.graphql → ...multi-union_types_properly/schema.graphql
diff --git a/...ble_union_list_types_properly/expected.kt → ...ble_union_list_types_properly/expected.kt b/...ble_union_list_types_properly/expected.kt → ...ble_union_list_types_properly/expected.kt
diff --git a/..._union_list_types_properly/schema.graphql → ..._union_list_types_properly/schema.graphql b/..._union_list_types_properly/schema.graphql → ..._union_list_types_properly/schema.graphql
diff --git a/...ate_union_list_types_properly/expected.kt → ...ate_union_list_types_properly/expected.kt b/...ate_union_list_types_properly/expected.kt → ...ate_union_list_types_properly/expected.kt
diff --git a/..._union_list_types_properly/schema.graphql → ..._union_list_types_properly/schema.graphql b/..._union_list_types_properly/schema.graphql → ..._union_list_types_properly/schema.graphql
diff --git a/...annotate_union_types_properly/expected.kt → ...generate_union_types_properly/expected.kt b/...annotate_union_types_properly/expected.kt → ...generate_union_types_properly/expected.kt
diff --git a/...otate_union_types_properly/schema.graphql → ...erate_union_types_properly/schema.graphql b/...otate_union_types_properly/schema.graphql → ...erate_union_types_properly/schema.graphql
diff --git a/test/unit/should_honor_dependentTypesInScope_config/codegen.config.ts b/test/unit/should_honor_dependentTypesInScope_config/codegen.config.ts
@@ -4,7 +4,9 @@ export default {
   extraImports: [
     "com.some.import.TypeOutOfScope",
     "com.some.import.UnionOutOfScope",
+    "com.some.import.ExternalUnionAsInterface",
   ],
   onlyTypes: ["MyTypeInOnlyTypes"],
   dependentTypesInScope: ["TypeInScope", "UnionInScope", "Type1"],
+  externalUnionsAsInterfaces: ["ExternalUnionAsInterface"],
 } satisfies GraphQLKotlinCodegenConfig;
diff --git a/test/unit/should_honor_dependentTypesInScope_config/expected.kt b/test/unit/should_honor_dependentTypesInScope_config/expected.kt
@@ -3,6 +3,7 @@ package com.kotlin.generated
 import com.expediagroup.graphql.generator.annotations.*
 import com.some.import.TypeOutOfScope
 import com.some.import.UnionOutOfScope
+import com.some.import.ExternalUnionAsInterface
 
 data class MyTypeInOnlyTypes(
     val field: TypeInScope,
@@ -14,7 +15,8 @@ data class TypeInScope(
     @UnionInScope
     val unionInScopeField: Any? = null,
     @UnionOutOfScope
-    val unionOutOfScopeField: Any? = null
+    val unionOutOfScopeField: Any? = null,
+    val externalUnionAsInterfaceField: ExternalUnionAsInterface? = null
 )
 
 @GraphQLUnion(

diff --git a/test/unit/should_honor_dependentTypesInScope_config/schema.graphql b/test/unit/should_honor_dependentTypesInScope_config/schema.graphql
@@ -7,6 +7,7 @@ type TypeInScope {
   field: String
   unionInScopeField: UnionInScope
   unionOutOfScopeField: UnionOutOfScope
+  externalUnionAsInterfaceField: ExternalUnionAsInterface
 }
 
 type TypeOutOfScope {
@@ -17,6 +18,8 @@ union UnionInScope = Type1
 
 union UnionOutOfScope = Type2
 
+union ExternalUnionAsInterface = Type1 | Type2
+
 type Type1 {
   field: String
 }