Add GraphQL definitions for the Apollo Kotlin library (#609)

Author: lukel97

resources/definitions/ApolloKotlin.graphql

@@ -0,0 +1,27 @@
+# Marks a field or variable definition as optional or required
+# By default Apollo Kotlin generates all variables of nullable types as optional, in compliance with the GraphQL specification,
+# but this can be configured with this directive, because if the variable was added in the first place, it's usually to pass a value
+directive @optional(if: Boolean = true) on FIELD | VARIABLE_DEFINITION
+
+# Marks a field as non-null. The corresponding Kotlin property will be made non-nullable even if the GraphQL type is nullable.
+# When used on an object definition in a schema document, `fields` must be non-empty and contain a selection set of fields that should be non-null
+# When used on a field from an executable document, `fields` must always be empty
+#
+# Setting the directive at the schema level is usually easier as there is little reason that a field would be non-null in one place
+# and null in the other
+directive @nonnull(fields: String! = "") on OBJECT | FIELD
+
+# Marks fields as key fields. Key fields are used to compute the cache key of an object
+# `keyFields` should contain a selection set. Composite fields are not supported yet.
+directive @typePolicy(keyFields: String!) on OBJECT | INTERFACE | UNION
+
+# Indicates how to compute a key from a field arguments.
+# `keyArgs` should contain a selection set. Composite args are not supported yet.
+directive @fieldPolicy(forField: String!, keyArgs: String!) repeatable on OBJECT
+
+# Indicates that the given field or enum value is still experimental and might be changed
+# in a backward incompatible manner
+directive @experimental(
+  reason: String! = "Experimental"
+) on FIELD_DEFINITION | ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION | ENUM_VALUE
+

resources/messages/GraphQLMessages.properties

@@ -92,3 +92,4 @@ graphql.library.prefix=GraphQL:
 graphql.library.built.in=Specification
 graphql.library.relay=Relay
 graphql.library.federation=Federation
+graphql.library.apollokotlin=Apollo Kotlin

src/main/com/intellij/lang/jsgraphql/GraphQLSettings.java

@@ -114,6 +114,15 @@ public void setFederationSupportEnabled(boolean enableFederationSupport) {
         settingsChanged();
     }
 
+    public boolean isApolloKotlinSupportEnabled() {
+        return myState.enableApolloKotlinSupport;
+    }
+
+    public void setApolloKotlinSupportEnabled(boolean enableApolloKotlinSupport) {
+        myState.enableApolloKotlinSupport = enableApolloKotlinSupport;
+        settingsChanged();
+    }
+
     /**
      * The state class that is persisted as XML
      * NOTE!!!: 1. Class must be static, and 2. Fields must be public for settings serialization to work
@@ -126,6 +135,7 @@ public static class GraphQLSettingsState {
 
         public boolean enableRelayModernFrameworkSupport;
         public boolean enableFederationSupport = false;
+        public boolean enableApolloKotlinSupport = false;
     }
 }
 

src/main/com/intellij/lang/jsgraphql/schema/library/GraphQLLibraryManager.java

@@ -40,7 +40,8 @@ public final class GraphQLLibraryManager {
     private static final Map<GraphQLLibraryDescriptor, String> ourDefinitionResourcePaths = Map.of(
         GraphQLLibraryTypes.SPECIFICATION, "Specification.graphql",
         GraphQLLibraryTypes.RELAY, "Relay.graphql",
-        GraphQLLibraryTypes.FEDERATION, "Federation.graphql"
+        GraphQLLibraryTypes.FEDERATION, "Federation.graphql",
+        GraphQLLibraryTypes.APOLLO_KOTLIN, "ApolloKotlin.graphql"
     );
 
     private final Project myProject;

src/main/com/intellij/lang/jsgraphql/schema/library/GraphQLLibraryTypes.java

@@ -37,6 +37,18 @@ public boolean isEnabled(@NotNull Project project) {
         }
     };
 
+    public static GraphQLLibraryDescriptor APOLLO_KOTLIN = new GraphQLLibraryDescriptor("APOLLO_KOTLIN") {
+        @Override
+        public boolean isEnabled(@NotNull Project project) {
+            return GraphQLSettings.getSettings(project).isApolloKotlinSupportEnabled();
+        }
+
+        @Override
+        public @NotNull String getPresentableText() {
+            return GraphQLBundle.message("graphql.library.apollokotlin");
+        }
+    };
+
     private GraphQLLibraryTypes() {
     }
 }

src/main/com/intellij/lang/jsgraphql/ui/GraphQLSettingsConfigurable.kt

@@ -89,6 +89,13 @@ class GraphQLSettingsConfigurable(private val project: Project) :
                         settings::setFederationSupportEnabled
                     ).updateLibraries()
                 }
+                row {
+                    checkBox(
+                        message("graphql.library.apollokotlin"),
+                        settings::isApolloKotlinSupportEnabled,
+                        settings::setApolloKotlinSupportEnabled
+                    ).updateLibraries()
+                }
             }
         }
     }

src/test/com/intellij/lang/jsgraphql/GraphQLTestUtils.java

@@ -56,6 +56,8 @@ public static void withLibrary(@NotNull Project project,
                 settings.setRelaySupportEnabled(true);
             } else if (libraryDescriptor == GraphQLLibraryTypes.FEDERATION) {
                 settings.setFederationSupportEnabled(true);
+            } else if (libraryDescriptor == GraphQLLibraryTypes.APOLLO_KOTLIN) {
+                settings.setApolloKotlinSupportEnabled(true);
             } else {
                 throw new IllegalArgumentException("Unexpected library: " + libraryDescriptor);
             }