feat: Aligns introspection to javascript

Matches with the reference implementation

Author: NeedleInAJayStack

Sources/GraphQL/Type/Directives.swift

@@ -8,6 +8,7 @@ public enum DirectiveLocation: String, Encodable {
     case field = "FIELD"
     case fragmentDefinition = "FRAGMENT_DEFINITION"
     case fragmentSpread = "FRAGMENT_SPREAD"
+    case fragmentVariableDefinition = "FRAGMENT_VARIABLE_DEFINITION"
     case inlineFragment = "INLINE_FRAGMENT"
     case variableDefinition = "VARIABLE_DEFINITION"
     // Schema Definitions
@@ -69,7 +70,7 @@ public let GraphQLIncludeDirective = try! GraphQLDirective(
     name: "include",
     description:
     "Directs the executor to include this field or fragment only when " +
-        "the `if` argument is true.",
+        "the \\`if\\` argument is true.",
     locations: [
         .field,
         .fragmentSpread,
@@ -89,7 +90,7 @@ public let GraphQLIncludeDirective = try! GraphQLDirective(
 public let GraphQLSkipDirective = try! GraphQLDirective(
     name: "skip",
     description:
-    "Directs the executor to skip this field or fragment when the `if` " +
+    "Directs the executor to skip this field or fragment when the \\`if\\` " +
         "argument is true.",
     locations: [
         .field,
@@ -128,7 +129,8 @@ public let GraphQLDeprecatedDirective = try! GraphQLDirective(
             description:
             "Explains why this element was deprecated, usually also including a " +
                 "suggestion for how to access supported similar data. Formatted " +
-                "in [Markdown](https://daringfireball.net/projects/markdown/).",
+                "using the Markdown syntax, as specified by [CommonMark]" +
+                "(https://commonmark.org/).",
             defaultValue: defaulDeprecationReason
         ),
     ]
@@ -154,7 +156,7 @@ public let GraphQLSpecifiedByDirective = try! GraphQLDirective(
  */
 public let GraphQLOneOfDirective = try! GraphQLDirective(
     name: "oneOf",
-    description: "Indicates exactly one field must be supplied and this field must not be `null`.",
+    description: "Indicates exactly one field must be supplied and this field must not be \\`null\\`.",
     locations: [.inputObject],
     args: [:]
 )

Sources/GraphQL/Type/Introspection.swift

@@ -7,6 +7,7 @@ let __Schema = try! GraphQLObjectType(
         "exposes all available types and directives on the server, as well as " +
         "the entry points for query, mutation, and subscription operations.",
     fields: [
+        "description": GraphQLField(type: GraphQLString),
         "types": GraphQLField(
             type: GraphQLNonNull(GraphQLList(GraphQLNonNull(__Type))),
             description: "A list of all types supported by this server.",
@@ -75,7 +76,7 @@ let __Directive = try! GraphQLObjectType(
     description:
     "A Directive provides a way to describe alternate runtime execution and " +
         "type validation behavior in a GraphQL document." +
-        "\n\nIn some cases, you need to provide options to alter GraphQL\"s " +
+        "\n\nIn some cases, you need to provide options to alter GraphQL's " +
         "execution behavior in ways field arguments will not suffice, such as " +
         "conditionally including or skipping a field. Directives provide this by " +
         "describing additional information to the executor.",
@@ -86,6 +87,9 @@ let __Directive = try! GraphQLObjectType(
         "locations": GraphQLField(type: GraphQLNonNull(GraphQLList(GraphQLNonNull(__DirectiveLocation)))),
         "args": GraphQLField(
             type: GraphQLNonNull(GraphQLList(GraphQLNonNull(__InputValue))),
+            args: [
+                "includeDeprecated": GraphQLArgument(type: GraphQLBoolean, defaultValue: false),
+            ],
             resolve: { directive, _, _, _ -> [GraphQLArgumentDefinition]? in
                 guard let directive = directive as? GraphQLDirective else {
                     return nil
@@ -131,6 +135,14 @@ let __DirectiveLocation = try! GraphQLEnumType(
             value: Map(DirectiveLocation.inlineFragment.rawValue),
             description: "Location adjacent to an inline fragment."
         ),
+        "VARIABLE_DEFINITION": GraphQLEnumValue(
+            value: Map(DirectiveLocation.variableDefinition.rawValue),
+            description: "Location adjacent to an operation variable definition."
+        ),
+        "FRAGMENT_VARIABLE_DEFINITION": GraphQLEnumValue(
+            value: Map(DirectiveLocation.fragmentVariableDefinition.rawValue),
+            description: "Location adjacent to a fragment variable definition."
+        ),
         "SCHEMA": GraphQLEnumValue(
             value: Map(DirectiveLocation.schema.rawValue),
             description: "Location adjacent to a schema definition."
@@ -183,10 +195,10 @@ let __Type: GraphQLObjectType = {
         name: "__Type",
         description:
         "The fundamental unit of any GraphQL Schema is the type. There are " +
-            "many kinds of types in GraphQL as represented by the `__TypeKind` enum." +
+            "many kinds of types in GraphQL as represented by the \\`__TypeKind\\` enum." +
             "\n\nDepending on the kind of a type, certain fields describe " +
             "information about that type. Scalar types provide no information " +
-            "beyond a name and description and optional `specifiedByURL`, while Enum types provide their values. " +
+            "beyond a name, description and optional \\`specifiedByURL\\`, while Enum types provide their values. " +
             "Object and Interface types provide the fields they describe. Abstract " +
             "types, Union and Interface, provide the Object types possible " +
             "at runtime. List and NonNull types compose other types.",
@@ -303,6 +315,12 @@ let __Type: GraphQLObjectType = {
         ),
         "inputFields": GraphQLField(
             type: GraphQLList(GraphQLNonNull(__InputValue)),
+            args: [
+                "includeDeprecated": GraphQLArgument(
+                    type: GraphQLBoolean,
+                    defaultValue: false
+                ),
+            ],
             resolve: { type, _, _, _ -> [InputObjectFieldDefinition]? in
                 guard let type = type as? GraphQLInputObjectType else {
                     return nil
@@ -337,6 +355,9 @@ let __Field = try! GraphQLObjectType(
         "description": GraphQLField(type: GraphQLString),
         "args": GraphQLField(
             type: GraphQLNonNull(GraphQLList(GraphQLNonNull(__InputValue))),
+            args: [
+                "includeDeprecated": GraphQLArgument(type: GraphQLBoolean, defaultValue: false),
+            ],
             resolve: { field, _, _, _ -> [GraphQLArgumentDefinition]? in
                 guard let field = field as? GraphQLFieldDefinition else {
                     return nil
@@ -386,6 +407,8 @@ let __InputValue = try! GraphQLObjectType(
                 return .string(print(ast: literal))
             }
         ),
+        "isDeprecated": GraphQLField(type: GraphQLNonNull(GraphQLBoolean)),
+        "deprecationReason": GraphQLField(type: GraphQLString),
     ]
 )
 
@@ -417,7 +440,7 @@ public enum TypeKind: String, Encodable {
 
 let __TypeKind = try! GraphQLEnumType(
     name: "__TypeKind",
-    description: "An enum describing what kind of type a given `__Type` is.",
+    description: "An enum describing what kind of type a given \\`__Type\\` is.",
     values: [
         "SCALAR": GraphQLEnumValue(
             value: Map(TypeKind.scalar.rawValue),
@@ -426,37 +449,37 @@ let __TypeKind = try! GraphQLEnumType(
         "OBJECT": GraphQLEnumValue(
             value: Map(TypeKind.object.rawValue),
             description: "Indicates this type is an object. " +
-                "`fields` and `interfaces` are valid fields."
+                "\\`fields\\` and \\`interfaces\\` are valid fields."
         ),
         "INTERFACE": GraphQLEnumValue(
             value: Map(TypeKind.interface.rawValue),
             description: "Indicates this type is an interface. " +
-                "`fields`, `interfaces`, and `possibleTypes` are valid fields."
+                "\\`fields\\`, \\`interfaces\\`, and \\`possibleTypes\\` are valid fields."
         ),
         "UNION": GraphQLEnumValue(
             value: Map(TypeKind.union.rawValue),
             description: "Indicates this type is a union. " +
-                "`possibleTypes` is a valid field."
+                "\\`possibleTypes\\` is a valid field."
         ),
         "ENUM": GraphQLEnumValue(
             value: Map(TypeKind.enum.rawValue),
             description: "Indicates this type is an enum. " +
-                "`enumValues` is a valid field."
+                "\\`enumValues\\` is a valid field."
         ),
         "INPUT_OBJECT": GraphQLEnumValue(
             value: Map(TypeKind.inputObject.rawValue),
             description: "Indicates this type is an input object. " +
-                "`inputFields` is a valid field."
+                "\\`inputFields\\` is a valid field."
         ),
         "LIST": GraphQLEnumValue(
             value: Map(TypeKind.list.rawValue),
             description: "Indicates this type is a list. " +
-                "`ofType` is a valid field."
+                "\\`ofType\\` is a valid field."
         ),
         "NON_NULL": GraphQLEnumValue(
             value: Map(TypeKind.nonNull.rawValue),
             description: "Indicates this type is a non-null. " +
-                "`ofType` is a valid field."
+                "\\`ofType\\` is a valid field."
         ),
     ]
 )