graphql 17.0.0-beta.1 → 17.0.0-beta.2

package/validation/rules/FieldsOnCorrectTypeRule.js

@@ -6,14 +6,6 @@ const naturalCompare_ts_1 = require("../../jsutils/naturalCompare.js");
 const suggestionList_ts_1 = require("../../jsutils/suggestionList.js");
 const GraphQLError_ts_1 = require("../../error/GraphQLError.js");
 const definition_ts_1 = require("../../type/definition.js");
-/**
- * Fields on correct type
- *
- * A GraphQL document is only valid if all fields selected are defined by the
- * parent type, or are an allowed meta field such as __typename.
- *
- * See https://spec.graphql.org/draft/#sec-Field-Selections
- */
 function FieldsOnCorrectTypeRule(context) {
     return {
         Field(node) {
@@ -21,20 +13,16 @@ function FieldsOnCorrectTypeRule(context) {
             if (type) {
                 const fieldDef = context.getFieldDef();
                 if (!fieldDef) {
-                    // This field doesn't exist, lets look for suggestions.
                     const schema = context.getSchema();
                     const fieldName = node.name.value;
-                    // First determine if there are any suggested types to condition on.
                     let suggestion = (0, didYouMean_ts_1.didYouMean)('to use an inline fragment on', context.hideSuggestions
                         ? []
                         : getSuggestedTypeNames(schema, type, fieldName));
-                    // If there are no suggested types, then perhaps this was a typo?
                     if (suggestion === '') {
                         suggestion = (0, didYouMean_ts_1.didYouMean)(context.hideSuggestions
                             ? []
                             : getSuggestedFieldNames(type, fieldName));
                     }
-                    // Report an error, including helpful suggestions.
                     context.reportError(new GraphQLError_ts_1.GraphQLError(`Cannot query field "${fieldName}" on type "${type}".` +
                         suggestion, { nodes: node }));
                 }
@@ -42,14 +30,8 @@ function FieldsOnCorrectTypeRule(context) {
         },
     };
 }
-/**
- * Go through all of the implementations of type, as well as the interfaces that
- * they implement. If any of those types include the provided field, suggest them,
- * sorted by how often the type is referenced.
- */
 function getSuggestedTypeNames(schema, type, fieldName) {
     if (!(0, definition_ts_1.isAbstractType)(type)) {
-        // Must be an Object type, which does not have possible fields.
         return [];
     }
     const suggestedTypes = new Set();
@@ -58,14 +40,12 @@ function getSuggestedTypeNames(schema, type, fieldName) {
         if (possibleType.getFields()[fieldName] == null) {
             continue;
         }
-        // This object type defines this field.
         suggestedTypes.add(possibleType);
         usageCount[possibleType.name] = 1;
         for (const possibleInterface of possibleType.getInterfaces()) {
             if (possibleInterface.getFields()[fieldName] == null) {
                 continue;
             }
-            // This interface type defines this field.
             suggestedTypes.add(possibleInterface);
             usageCount[possibleInterface.name] =
                 (usageCount[possibleInterface.name] ?? 0) + 1;
@@ -73,12 +53,10 @@ function getSuggestedTypeNames(schema, type, fieldName) {
     }
     return [...suggestedTypes]
         .sort((typeA, typeB) => {
-        // Suggest both interface and object types based on how common they are.
         const usageCountDiff = usageCount[typeB.name] - usageCount[typeA.name];
         if (usageCountDiff !== 0) {
             return usageCountDiff;
         }
-        // Suggest super types first followed by subtypes
         if ((0, definition_ts_1.isInterfaceType)(typeA) && schema.isSubType(typeA, typeB)) {
             return -1;
         }
@@ -89,16 +67,11 @@ function getSuggestedTypeNames(schema, type, fieldName) {
     })
         .map((x) => x.name);
 }
-/**
- * For the field name provided, determine if there are any similar field names
- * that may be the result of a typo.
- */
 function getSuggestedFieldNames(type, fieldName) {
     if ((0, definition_ts_1.isObjectType)(type) || (0, definition_ts_1.isInterfaceType)(type)) {
         const possibleFieldNames = Object.keys(type.getFields());
         return (0, suggestionList_ts_1.suggestionList)(fieldName, possibleFieldNames);
     }
-    // Otherwise, must be a Union type, which does not define fields.
     return [];
 }
 //# sourceMappingURL=FieldsOnCorrectTypeRule.js.map

package/validation/rules/FieldsOnCorrectTypeRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"FieldsOnCorrectTypeRule.js","sourceRoot":"","sources":["../../../src/validation/rules/FieldsOnCorrectTypeRule.ts"],"names":[],"mappings":";;AA+BA,0DA0CC;AAzED,+DAAyD;AACzD,uEAAiE;AACjE,uEAAiE;AAEjE,iEAA2D;AAU3D,4DAIkC;AAKlC;;;;;;;GAOG;AACH,SAAgB,uBAAuB,CACrC,OAA0B;IAE1B,OAAO;QACL,KAAK,CAAC,IAAe;YACnB,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;YACrC,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;gBACvC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,uDAAuD;oBACvD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;oBACnC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;oBAElC,oEAAoE;oBACpE,IAAI,UAAU,GAAG,IAAA,0BAAU,EACzB,8BAA8B,EAC9B,OAAO,CAAC,eAAe;wBACrB,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CACnD,CAAC;oBAEF,iEAAiE;oBACjE,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;wBACtB,UAAU,GAAG,IAAA,0BAAU,EACrB,OAAO,CAAC,eAAe;4BACrB,CAAC,CAAC,EAAE;4BACJ,CAAC,CAAC,sBAAsB,CAAC,IAAI,EAAE,SAAS,CAAC,CAC5C,CAAC;oBACJ,CAAC;oBAED,kDAAkD;oBAClD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,uBAAuB,SAAS,cAAc,IAAI,IAAI;wBACpD,UAAU,EACZ,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,qBAAqB,CAC5B,MAAqB,EACrB,IAAuB,EACvB,SAAiB;IAEjB,IAAI,CAAC,IAAA,8BAAc,EAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,+DAA+D;QAC/D,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAA4C,CAAC;IAC3E,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;QACzD,IAAI,YAAY,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YAChD,SAAS;QACX,CAAC;QAED,uCAAuC;QACvC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACjC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAElC,KAAK,MAAM,iBAAiB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC;YAC7D,IAAI,iBAAiB,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;gBACrD,SAAS;YACX,CAAC;YAED,0CAA0C;YAC1C,cAAc,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACtC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC;gBAChC,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,cAAc,CAAC;SACvB,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACrB,wEAAwE;QACxE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvE,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,cAAc,CAAC;QACxB,CAAC;QAED,iDAAiD;QACjD,IAAI,IAAA,+BAAe,EAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YAC7D,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;QACD,IAAI,IAAA,+BAAe,EAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YAC7D,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,IAAA,kCAAc,EAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAC7B,IAAuB,EACvB,SAAiB;IAEjB,IAAI,IAAA,4BAAY,EAAC,IAAI,CAAC,IAAI,IAAA,+BAAe,EAAC,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACzD,OAAO,IAAA,kCAAc,EAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IACvD,CAAC;IACD,iEAAiE;IACjE,OAAO,EAAE,CAAC;AACZ,CAAC","sourcesContent":["import { didYouMean } from '../../jsutils/didYouMean.ts';\nimport { naturalCompare } from '../../jsutils/naturalCompare.ts';\nimport { suggestionList } from '../../jsutils/suggestionList.ts';\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { FieldNode } from '../../language/ast.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport type {\n  GraphQLInterfaceType,\n  GraphQLObjectType,\n  GraphQLOutputType,\n} from '../../type/definition.ts';\nimport {\n  isAbstractType,\n  isInterfaceType,\n  isObjectType,\n} from '../../type/definition.ts';\nimport type { GraphQLSchema } from '../../type/schema.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Fields on correct type\n *\n * A GraphQL document is only valid if all fields selected are defined by the\n * parent type, or are an allowed meta field such as __typename.\n *\n * See https://spec.graphql.org/draft/#sec-Field-Selections\n */\nexport function FieldsOnCorrectTypeRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    Field(node: FieldNode) {\n      const type = context.getParentType();\n      if (type) {\n        const fieldDef = context.getFieldDef();\n        if (!fieldDef) {\n          // This field doesn't exist, lets look for suggestions.\n          const schema = context.getSchema();\n          const fieldName = node.name.value;\n\n          // First determine if there are any suggested types to condition on.\n          let suggestion = didYouMean(\n            'to use an inline fragment on',\n            context.hideSuggestions\n              ? []\n              : getSuggestedTypeNames(schema, type, fieldName),\n          );\n\n          // If there are no suggested types, then perhaps this was a typo?\n          if (suggestion === '') {\n            suggestion = didYouMean(\n              context.hideSuggestions\n                ? []\n                : getSuggestedFieldNames(type, fieldName),\n            );\n          }\n\n          // Report an error, including helpful suggestions.\n          context.reportError(\n            new GraphQLError(\n              `Cannot query field \"${fieldName}\" on type \"${type}\".` +\n                suggestion,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n    },\n  };\n}\n\n/**\n * Go through all of the implementations of type, as well as the interfaces that\n * they implement. If any of those types include the provided field, suggest them,\n * sorted by how often the type is referenced.\n */\nfunction getSuggestedTypeNames(\n  schema: GraphQLSchema,\n  type: GraphQLOutputType,\n  fieldName: string,\n): Array<string> {\n  if (!isAbstractType(type)) {\n    // Must be an Object type, which does not have possible fields.\n    return [];\n  }\n\n  const suggestedTypes = new Set<GraphQLObjectType | GraphQLInterfaceType>();\n  const usageCount = Object.create(null);\n  for (const possibleType of schema.getPossibleTypes(type)) {\n    if (possibleType.getFields()[fieldName] == null) {\n      continue;\n    }\n\n    // This object type defines this field.\n    suggestedTypes.add(possibleType);\n    usageCount[possibleType.name] = 1;\n\n    for (const possibleInterface of possibleType.getInterfaces()) {\n      if (possibleInterface.getFields()[fieldName] == null) {\n        continue;\n      }\n\n      // This interface type defines this field.\n      suggestedTypes.add(possibleInterface);\n      usageCount[possibleInterface.name] =\n        (usageCount[possibleInterface.name] ?? 0) + 1;\n    }\n  }\n\n  return [...suggestedTypes]\n    .sort((typeA, typeB) => {\n      // Suggest both interface and object types based on how common they are.\n      const usageCountDiff = usageCount[typeB.name] - usageCount[typeA.name];\n      if (usageCountDiff !== 0) {\n        return usageCountDiff;\n      }\n\n      // Suggest super types first followed by subtypes\n      if (isInterfaceType(typeA) && schema.isSubType(typeA, typeB)) {\n        return -1;\n      }\n      if (isInterfaceType(typeB) && schema.isSubType(typeB, typeA)) {\n        return 1;\n      }\n\n      return naturalCompare(typeA.name, typeB.name);\n    })\n    .map((x) => x.name);\n}\n\n/**\n * For the field name provided, determine if there are any similar field names\n * that may be the result of a typo.\n */\nfunction getSuggestedFieldNames(\n  type: GraphQLOutputType,\n  fieldName: string,\n): Array<string> {\n  if (isObjectType(type) || isInterfaceType(type)) {\n    const possibleFieldNames = Object.keys(type.getFields());\n    return suggestionList(fieldName, possibleFieldNames);\n  }\n  // Otherwise, must be a Union type, which does not define fields.\n  return [];\n}\n"]}
+{"version":3,"file":"FieldsOnCorrectTypeRule.js","sourceRoot":"","sources":["../../../src/validation/rules/FieldsOnCorrectTypeRule.ts"],"names":[],"mappings":";;AA4DA,0DA0CC;AApGD,+DAAyD;AACzD,uEAAiE;AACjE,uEAAiE;AAEjE,iEAA2D;AAU3D,4DAIkC;AAwClC,SAAgB,uBAAuB,CACrC,OAA0B;IAE1B,OAAO;QACL,KAAK,CAAC,IAAe;YACnB,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;YACrC,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;gBACvC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAEd,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;oBACnC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;oBAGlC,IAAI,UAAU,GAAG,IAAA,0BAAU,EACzB,8BAA8B,EAC9B,OAAO,CAAC,eAAe;wBACrB,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CACnD,CAAC;oBAGF,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;wBACtB,UAAU,GAAG,IAAA,0BAAU,EACrB,OAAO,CAAC,eAAe;4BACrB,CAAC,CAAC,EAAE;4BACJ,CAAC,CAAC,sBAAsB,CAAC,IAAI,EAAE,SAAS,CAAC,CAC5C,CAAC;oBACJ,CAAC;oBAGD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,uBAAuB,SAAS,cAAc,IAAI,IAAI;wBACpD,UAAU,EACZ,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AASD,SAAS,qBAAqB,CAC5B,MAAqB,EACrB,IAAuB,EACvB,SAAiB;IAEjB,IAAI,CAAC,IAAA,8BAAc,EAAC,IAAI,CAAC,EAAE,CAAC;QAE1B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAA4C,CAAC;IAC3E,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;QACzD,IAAI,YAAY,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YAChD,SAAS;QACX,CAAC;QAGD,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACjC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAElC,KAAK,MAAM,iBAAiB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC;YAC7D,IAAI,iBAAiB,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;gBACrD,SAAS;YACX,CAAC;YAGD,cAAc,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACtC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC;gBAChC,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,cAAc,CAAC;SACvB,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAErB,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvE,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,cAAc,CAAC;QACxB,CAAC;QAGD,IAAI,IAAA,+BAAe,EAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YAC7D,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;QACD,IAAI,IAAA,+BAAe,EAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YAC7D,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,IAAA,kCAAc,EAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC;AAQD,SAAS,sBAAsB,CAC7B,IAAuB,EACvB,SAAiB;IAEjB,IAAI,IAAA,4BAAY,EAAC,IAAI,CAAC,IAAI,IAAA,+BAAe,EAAC,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACzD,OAAO,IAAA,kCAAc,EAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IACvD,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { didYouMean } from '../../jsutils/didYouMean.ts';\nimport { naturalCompare } from '../../jsutils/naturalCompare.ts';\nimport { suggestionList } from '../../jsutils/suggestionList.ts';\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { FieldNode } from '../../language/ast.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport type {\n  GraphQLInterfaceType,\n  GraphQLObjectType,\n  GraphQLOutputType,\n} from '../../type/definition.ts';\nimport {\n  isAbstractType,\n  isInterfaceType,\n  isObjectType,\n} from '../../type/definition.ts';\nimport type { GraphQLSchema } from '../../type/schema.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Fields on correct type\n *\n * A GraphQL document is only valid if all fields selected are defined by the\n * parent type, or are an allowed meta field such as __typename.\n *\n * See https://spec.graphql.org/draft/#sec-Field-Selections\n * @param context - The validation context used while checking the document.\n * @returns A visitor that reports validation errors for this rule.\n * @example\n * ```ts\n * import { buildSchema, parse, validate } from 'graphql';\n * import { FieldsOnCorrectTypeRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String\n *   }\n * `);\n *\n * const invalidDocument = parse(`\n *   { missing }\n * `);\n * const invalidErrors = validate(schema, invalidDocument, [FieldsOnCorrectTypeRule]);\n *\n * invalidErrors.length; // => 1\n *\n * const validDocument = parse(`\n *   { name }\n * `);\n * const validErrors = validate(schema, validDocument, [FieldsOnCorrectTypeRule]);\n *\n * validErrors; // => []\n * ```\n */\nexport function FieldsOnCorrectTypeRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    Field(node: FieldNode) {\n      const type = context.getParentType();\n      if (type) {\n        const fieldDef = context.getFieldDef();\n        if (!fieldDef) {\n          // This field doesn't exist, lets look for suggestions.\n          const schema = context.getSchema();\n          const fieldName = node.name.value;\n\n          // First determine if there are any suggested types to condition on.\n          let suggestion = didYouMean(\n            'to use an inline fragment on',\n            context.hideSuggestions\n              ? []\n              : getSuggestedTypeNames(schema, type, fieldName),\n          );\n\n          // If there are no suggested types, then perhaps this was a typo?\n          if (suggestion === '') {\n            suggestion = didYouMean(\n              context.hideSuggestions\n                ? []\n                : getSuggestedFieldNames(type, fieldName),\n            );\n          }\n\n          // Report an error, including helpful suggestions.\n          context.reportError(\n            new GraphQLError(\n              `Cannot query field \"${fieldName}\" on type \"${type}\".` +\n                suggestion,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n    },\n  };\n}\n\n/**\n * Go through all of the implementations of type, as well as the interfaces that\n * they implement. If any of those types include the provided field, suggest them,\n * sorted by how often the type is referenced.\n *\n * @internal\n */\nfunction getSuggestedTypeNames(\n  schema: GraphQLSchema,\n  type: GraphQLOutputType,\n  fieldName: string,\n): Array<string> {\n  if (!isAbstractType(type)) {\n    // Must be an Object type, which does not have possible fields.\n    return [];\n  }\n\n  const suggestedTypes = new Set<GraphQLObjectType | GraphQLInterfaceType>();\n  const usageCount = Object.create(null);\n  for (const possibleType of schema.getPossibleTypes(type)) {\n    if (possibleType.getFields()[fieldName] == null) {\n      continue;\n    }\n\n    // This object type defines this field.\n    suggestedTypes.add(possibleType);\n    usageCount[possibleType.name] = 1;\n\n    for (const possibleInterface of possibleType.getInterfaces()) {\n      if (possibleInterface.getFields()[fieldName] == null) {\n        continue;\n      }\n\n      // This interface type defines this field.\n      suggestedTypes.add(possibleInterface);\n      usageCount[possibleInterface.name] =\n        (usageCount[possibleInterface.name] ?? 0) + 1;\n    }\n  }\n\n  return [...suggestedTypes]\n    .sort((typeA, typeB) => {\n      // Suggest both interface and object types based on how common they are.\n      const usageCountDiff = usageCount[typeB.name] - usageCount[typeA.name];\n      if (usageCountDiff !== 0) {\n        return usageCountDiff;\n      }\n\n      // Suggest super types first followed by subtypes\n      if (isInterfaceType(typeA) && schema.isSubType(typeA, typeB)) {\n        return -1;\n      }\n      if (isInterfaceType(typeB) && schema.isSubType(typeB, typeA)) {\n        return 1;\n      }\n\n      return naturalCompare(typeA.name, typeB.name);\n    })\n    .map((x) => x.name);\n}\n\n/**\n * For the field name provided, determine if there are any similar field names\n * that may be the result of a typo.\n *\n * @internal\n */\nfunction getSuggestedFieldNames(\n  type: GraphQLOutputType,\n  fieldName: string,\n): Array<string> {\n  if (isObjectType(type) || isInterfaceType(type)) {\n    const possibleFieldNames = Object.keys(type.getFields());\n    return suggestionList(fieldName, possibleFieldNames);\n  }\n  // Otherwise, must be a Union type, which does not define fields.\n  return [];\n}\n"]}

package/validation/rules/FieldsOnCorrectTypeRule.mjs

@@ -3,14 +3,6 @@ import { naturalCompare } from "../../jsutils/naturalCompare.mjs";
 import { suggestionList } from "../../jsutils/suggestionList.mjs";
 import { GraphQLError } from "../../error/GraphQLError.mjs";
 import { isAbstractType, isInterfaceType, isObjectType, } from "../../type/definition.mjs";
-/**
- * Fields on correct type
- *
- * A GraphQL document is only valid if all fields selected are defined by the
- * parent type, or are an allowed meta field such as __typename.
- *
- * See https://spec.graphql.org/draft/#sec-Field-Selections
- */
 export function FieldsOnCorrectTypeRule(context) {
     return {
         Field(node) {
@@ -18,20 +10,16 @@ export function FieldsOnCorrectTypeRule(context) {
             if (type) {
                 const fieldDef = context.getFieldDef();
                 if (!fieldDef) {
-                    // This field doesn't exist, lets look for suggestions.
                     const schema = context.getSchema();
                     const fieldName = node.name.value;
-                    // First determine if there are any suggested types to condition on.
                     let suggestion = didYouMean('to use an inline fragment on', context.hideSuggestions
                         ? []
                         : getSuggestedTypeNames(schema, type, fieldName));
-                    // If there are no suggested types, then perhaps this was a typo?
                     if (suggestion === '') {
                         suggestion = didYouMean(context.hideSuggestions
                             ? []
                             : getSuggestedFieldNames(type, fieldName));
                     }
-                    // Report an error, including helpful suggestions.
                     context.reportError(new GraphQLError(`Cannot query field "${fieldName}" on type "${type}".` +
                         suggestion, { nodes: node }));
                 }
@@ -39,14 +27,8 @@ export function FieldsOnCorrectTypeRule(context) {
         },
     };
 }
-/**
- * Go through all of the implementations of type, as well as the interfaces that
- * they implement. If any of those types include the provided field, suggest them,
- * sorted by how often the type is referenced.
- */
 function getSuggestedTypeNames(schema, type, fieldName) {
     if (!isAbstractType(type)) {
-        // Must be an Object type, which does not have possible fields.
         return [];
     }
     const suggestedTypes = new Set();
@@ -55,14 +37,12 @@ function getSuggestedTypeNames(schema, type, fieldName) {
         if (possibleType.getFields()[fieldName] == null) {
             continue;
         }
-        // This object type defines this field.
         suggestedTypes.add(possibleType);
         usageCount[possibleType.name] = 1;
         for (const possibleInterface of possibleType.getInterfaces()) {
             if (possibleInterface.getFields()[fieldName] == null) {
                 continue;
             }
-            // This interface type defines this field.
             suggestedTypes.add(possibleInterface);
             usageCount[possibleInterface.name] =
                 (usageCount[possibleInterface.name] ?? 0) + 1;
@@ -70,12 +50,10 @@ function getSuggestedTypeNames(schema, type, fieldName) {
     }
     return [...suggestedTypes]
         .sort((typeA, typeB) => {
-        // Suggest both interface and object types based on how common they are.
         const usageCountDiff = usageCount[typeB.name] - usageCount[typeA.name];
         if (usageCountDiff !== 0) {
             return usageCountDiff;
         }
-        // Suggest super types first followed by subtypes
         if (isInterfaceType(typeA) && schema.isSubType(typeA, typeB)) {
             return -1;
         }
@@ -86,16 +64,11 @@ function getSuggestedTypeNames(schema, type, fieldName) {
     })
         .map((x) => x.name);
 }
-/**
- * For the field name provided, determine if there are any similar field names
- * that may be the result of a typo.
- */
 function getSuggestedFieldNames(type, fieldName) {
     if (isObjectType(type) || isInterfaceType(type)) {
         const possibleFieldNames = Object.keys(type.getFields());
         return suggestionList(fieldName, possibleFieldNames);
     }
-    // Otherwise, must be a Union type, which does not define fields.
     return [];
 }
 //# sourceMappingURL=FieldsOnCorrectTypeRule.js.map

package/validation/rules/FieldsOnCorrectTypeRule.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"FieldsOnCorrectTypeRule.js","sourceRoot":"","sources":["../../../src/validation/rules/FieldsOnCorrectTypeRule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,qCAAoC;AACzD,OAAO,EAAE,cAAc,EAAE,yCAAwC;AACjE,OAAO,EAAE,cAAc,EAAE,yCAAwC;AAEjE,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAU3D,OAAO,EACL,cAAc,EACd,eAAe,EACf,YAAY,GACb,kCAAiC;AAKlC;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CACrC,OAA0B;IAE1B,OAAO;QACL,KAAK,CAAC,IAAe;YACnB,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;YACrC,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;gBACvC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,uDAAuD;oBACvD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;oBACnC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;oBAElC,oEAAoE;oBACpE,IAAI,UAAU,GAAG,UAAU,CACzB,8BAA8B,EAC9B,OAAO,CAAC,eAAe;wBACrB,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CACnD,CAAC;oBAEF,iEAAiE;oBACjE,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;wBACtB,UAAU,GAAG,UAAU,CACrB,OAAO,CAAC,eAAe;4BACrB,CAAC,CAAC,EAAE;4BACJ,CAAC,CAAC,sBAAsB,CAAC,IAAI,EAAE,SAAS,CAAC,CAC5C,CAAC;oBACJ,CAAC;oBAED,kDAAkD;oBAClD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,uBAAuB,SAAS,cAAc,IAAI,IAAI;wBACpD,UAAU,EACZ,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,qBAAqB,CAC5B,MAAqB,EACrB,IAAuB,EACvB,SAAiB;IAEjB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,+DAA+D;QAC/D,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAA4C,CAAC;IAC3E,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;QACzD,IAAI,YAAY,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YAChD,SAAS;QACX,CAAC;QAED,uCAAuC;QACvC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACjC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAElC,KAAK,MAAM,iBAAiB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC;YAC7D,IAAI,iBAAiB,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;gBACrD,SAAS;YACX,CAAC;YAED,0CAA0C;YAC1C,cAAc,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACtC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC;gBAChC,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,cAAc,CAAC;SACvB,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACrB,wEAAwE;QACxE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvE,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,cAAc,CAAC;QACxB,CAAC;QAED,iDAAiD;QACjD,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YAC7D,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;QACD,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YAC7D,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAC7B,IAAuB,EACvB,SAAiB;IAEjB,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACzD,OAAO,cAAc,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IACvD,CAAC;IACD,iEAAiE;IACjE,OAAO,EAAE,CAAC;AACZ,CAAC","sourcesContent":["import { didYouMean } from '../../jsutils/didYouMean.ts';\nimport { naturalCompare } from '../../jsutils/naturalCompare.ts';\nimport { suggestionList } from '../../jsutils/suggestionList.ts';\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { FieldNode } from '../../language/ast.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport type {\n  GraphQLInterfaceType,\n  GraphQLObjectType,\n  GraphQLOutputType,\n} from '../../type/definition.ts';\nimport {\n  isAbstractType,\n  isInterfaceType,\n  isObjectType,\n} from '../../type/definition.ts';\nimport type { GraphQLSchema } from '../../type/schema.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Fields on correct type\n *\n * A GraphQL document is only valid if all fields selected are defined by the\n * parent type, or are an allowed meta field such as __typename.\n *\n * See https://spec.graphql.org/draft/#sec-Field-Selections\n */\nexport function FieldsOnCorrectTypeRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    Field(node: FieldNode) {\n      const type = context.getParentType();\n      if (type) {\n        const fieldDef = context.getFieldDef();\n        if (!fieldDef) {\n          // This field doesn't exist, lets look for suggestions.\n          const schema = context.getSchema();\n          const fieldName = node.name.value;\n\n          // First determine if there are any suggested types to condition on.\n          let suggestion = didYouMean(\n            'to use an inline fragment on',\n            context.hideSuggestions\n              ? []\n              : getSuggestedTypeNames(schema, type, fieldName),\n          );\n\n          // If there are no suggested types, then perhaps this was a typo?\n          if (suggestion === '') {\n            suggestion = didYouMean(\n              context.hideSuggestions\n                ? []\n                : getSuggestedFieldNames(type, fieldName),\n            );\n          }\n\n          // Report an error, including helpful suggestions.\n          context.reportError(\n            new GraphQLError(\n              `Cannot query field \"${fieldName}\" on type \"${type}\".` +\n                suggestion,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n    },\n  };\n}\n\n/**\n * Go through all of the implementations of type, as well as the interfaces that\n * they implement. If any of those types include the provided field, suggest them,\n * sorted by how often the type is referenced.\n */\nfunction getSuggestedTypeNames(\n  schema: GraphQLSchema,\n  type: GraphQLOutputType,\n  fieldName: string,\n): Array<string> {\n  if (!isAbstractType(type)) {\n    // Must be an Object type, which does not have possible fields.\n    return [];\n  }\n\n  const suggestedTypes = new Set<GraphQLObjectType | GraphQLInterfaceType>();\n  const usageCount = Object.create(null);\n  for (const possibleType of schema.getPossibleTypes(type)) {\n    if (possibleType.getFields()[fieldName] == null) {\n      continue;\n    }\n\n    // This object type defines this field.\n    suggestedTypes.add(possibleType);\n    usageCount[possibleType.name] = 1;\n\n    for (const possibleInterface of possibleType.getInterfaces()) {\n      if (possibleInterface.getFields()[fieldName] == null) {\n        continue;\n      }\n\n      // This interface type defines this field.\n      suggestedTypes.add(possibleInterface);\n      usageCount[possibleInterface.name] =\n        (usageCount[possibleInterface.name] ?? 0) + 1;\n    }\n  }\n\n  return [...suggestedTypes]\n    .sort((typeA, typeB) => {\n      // Suggest both interface and object types based on how common they are.\n      const usageCountDiff = usageCount[typeB.name] - usageCount[typeA.name];\n      if (usageCountDiff !== 0) {\n        return usageCountDiff;\n      }\n\n      // Suggest super types first followed by subtypes\n      if (isInterfaceType(typeA) && schema.isSubType(typeA, typeB)) {\n        return -1;\n      }\n      if (isInterfaceType(typeB) && schema.isSubType(typeB, typeA)) {\n        return 1;\n      }\n\n      return naturalCompare(typeA.name, typeB.name);\n    })\n    .map((x) => x.name);\n}\n\n/**\n * For the field name provided, determine if there are any similar field names\n * that may be the result of a typo.\n */\nfunction getSuggestedFieldNames(\n  type: GraphQLOutputType,\n  fieldName: string,\n): Array<string> {\n  if (isObjectType(type) || isInterfaceType(type)) {\n    const possibleFieldNames = Object.keys(type.getFields());\n    return suggestionList(fieldName, possibleFieldNames);\n  }\n  // Otherwise, must be a Union type, which does not define fields.\n  return [];\n}\n"]}
+{"version":3,"file":"FieldsOnCorrectTypeRule.js","sourceRoot":"","sources":["../../../src/validation/rules/FieldsOnCorrectTypeRule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,qCAAoC;AACzD,OAAO,EAAE,cAAc,EAAE,yCAAwC;AACjE,OAAO,EAAE,cAAc,EAAE,yCAAwC;AAEjE,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAU3D,OAAO,EACL,cAAc,EACd,eAAe,EACf,YAAY,GACb,kCAAiC;AAwClC,MAAM,UAAU,uBAAuB,CACrC,OAA0B;IAE1B,OAAO;QACL,KAAK,CAAC,IAAe;YACnB,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;YACrC,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;gBACvC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAEd,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;oBACnC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;oBAGlC,IAAI,UAAU,GAAG,UAAU,CACzB,8BAA8B,EAC9B,OAAO,CAAC,eAAe;wBACrB,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CACnD,CAAC;oBAGF,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;wBACtB,UAAU,GAAG,UAAU,CACrB,OAAO,CAAC,eAAe;4BACrB,CAAC,CAAC,EAAE;4BACJ,CAAC,CAAC,sBAAsB,CAAC,IAAI,EAAE,SAAS,CAAC,CAC5C,CAAC;oBACJ,CAAC;oBAGD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,uBAAuB,SAAS,cAAc,IAAI,IAAI;wBACpD,UAAU,EACZ,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AASD,SAAS,qBAAqB,CAC5B,MAAqB,EACrB,IAAuB,EACvB,SAAiB;IAEjB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QAE1B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAA4C,CAAC;IAC3E,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;QACzD,IAAI,YAAY,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YAChD,SAAS;QACX,CAAC;QAGD,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACjC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAElC,KAAK,MAAM,iBAAiB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC;YAC7D,IAAI,iBAAiB,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;gBACrD,SAAS;YACX,CAAC;YAGD,cAAc,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACtC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC;gBAChC,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,cAAc,CAAC;SACvB,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAErB,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvE,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,cAAc,CAAC;QACxB,CAAC;QAGD,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YAC7D,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;QACD,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YAC7D,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC;AAQD,SAAS,sBAAsB,CAC7B,IAAuB,EACvB,SAAiB;IAEjB,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACzD,OAAO,cAAc,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IACvD,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { didYouMean } from '../../jsutils/didYouMean.ts';\nimport { naturalCompare } from '../../jsutils/naturalCompare.ts';\nimport { suggestionList } from '../../jsutils/suggestionList.ts';\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { FieldNode } from '../../language/ast.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport type {\n  GraphQLInterfaceType,\n  GraphQLObjectType,\n  GraphQLOutputType,\n} from '../../type/definition.ts';\nimport {\n  isAbstractType,\n  isInterfaceType,\n  isObjectType,\n} from '../../type/definition.ts';\nimport type { GraphQLSchema } from '../../type/schema.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Fields on correct type\n *\n * A GraphQL document is only valid if all fields selected are defined by the\n * parent type, or are an allowed meta field such as __typename.\n *\n * See https://spec.graphql.org/draft/#sec-Field-Selections\n * @param context - The validation context used while checking the document.\n * @returns A visitor that reports validation errors for this rule.\n * @example\n * ```ts\n * import { buildSchema, parse, validate } from 'graphql';\n * import { FieldsOnCorrectTypeRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String\n *   }\n * `);\n *\n * const invalidDocument = parse(`\n *   { missing }\n * `);\n * const invalidErrors = validate(schema, invalidDocument, [FieldsOnCorrectTypeRule]);\n *\n * invalidErrors.length; // => 1\n *\n * const validDocument = parse(`\n *   { name }\n * `);\n * const validErrors = validate(schema, validDocument, [FieldsOnCorrectTypeRule]);\n *\n * validErrors; // => []\n * ```\n */\nexport function FieldsOnCorrectTypeRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    Field(node: FieldNode) {\n      const type = context.getParentType();\n      if (type) {\n        const fieldDef = context.getFieldDef();\n        if (!fieldDef) {\n          // This field doesn't exist, lets look for suggestions.\n          const schema = context.getSchema();\n          const fieldName = node.name.value;\n\n          // First determine if there are any suggested types to condition on.\n          let suggestion = didYouMean(\n            'to use an inline fragment on',\n            context.hideSuggestions\n              ? []\n              : getSuggestedTypeNames(schema, type, fieldName),\n          );\n\n          // If there are no suggested types, then perhaps this was a typo?\n          if (suggestion === '') {\n            suggestion = didYouMean(\n              context.hideSuggestions\n                ? []\n                : getSuggestedFieldNames(type, fieldName),\n            );\n          }\n\n          // Report an error, including helpful suggestions.\n          context.reportError(\n            new GraphQLError(\n              `Cannot query field \"${fieldName}\" on type \"${type}\".` +\n                suggestion,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n    },\n  };\n}\n\n/**\n * Go through all of the implementations of type, as well as the interfaces that\n * they implement. If any of those types include the provided field, suggest them,\n * sorted by how often the type is referenced.\n *\n * @internal\n */\nfunction getSuggestedTypeNames(\n  schema: GraphQLSchema,\n  type: GraphQLOutputType,\n  fieldName: string,\n): Array<string> {\n  if (!isAbstractType(type)) {\n    // Must be an Object type, which does not have possible fields.\n    return [];\n  }\n\n  const suggestedTypes = new Set<GraphQLObjectType | GraphQLInterfaceType>();\n  const usageCount = Object.create(null);\n  for (const possibleType of schema.getPossibleTypes(type)) {\n    if (possibleType.getFields()[fieldName] == null) {\n      continue;\n    }\n\n    // This object type defines this field.\n    suggestedTypes.add(possibleType);\n    usageCount[possibleType.name] = 1;\n\n    for (const possibleInterface of possibleType.getInterfaces()) {\n      if (possibleInterface.getFields()[fieldName] == null) {\n        continue;\n      }\n\n      // This interface type defines this field.\n      suggestedTypes.add(possibleInterface);\n      usageCount[possibleInterface.name] =\n        (usageCount[possibleInterface.name] ?? 0) + 1;\n    }\n  }\n\n  return [...suggestedTypes]\n    .sort((typeA, typeB) => {\n      // Suggest both interface and object types based on how common they are.\n      const usageCountDiff = usageCount[typeB.name] - usageCount[typeA.name];\n      if (usageCountDiff !== 0) {\n        return usageCountDiff;\n      }\n\n      // Suggest super types first followed by subtypes\n      if (isInterfaceType(typeA) && schema.isSubType(typeA, typeB)) {\n        return -1;\n      }\n      if (isInterfaceType(typeB) && schema.isSubType(typeB, typeA)) {\n        return 1;\n      }\n\n      return naturalCompare(typeA.name, typeB.name);\n    })\n    .map((x) => x.name);\n}\n\n/**\n * For the field name provided, determine if there are any similar field names\n * that may be the result of a typo.\n *\n * @internal\n */\nfunction getSuggestedFieldNames(\n  type: GraphQLOutputType,\n  fieldName: string,\n): Array<string> {\n  if (isObjectType(type) || isInterfaceType(type)) {\n    const possibleFieldNames = Object.keys(type.getFields());\n    return suggestionList(fieldName, possibleFieldNames);\n  }\n  // Otherwise, must be a Union type, which does not define fields.\n  return [];\n}\n"]}

package/validation/rules/FragmentsOnCompositeTypesRule.d.mts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.mjs";
 import type { ValidationContext } from "../ValidationContext.mjs";
 /**
@@ -8,5 +9,32 @@ import type { ValidationContext } from "../ValidationContext.mjs";
  * type condition must also be a composite type.
  *
  * See https://spec.graphql.org/draft/#sec-Fragments-On-Composite-Types
+ * @param context - The validation context used while checking the document.
+ * @returns A visitor that reports validation errors for this rule.
+ * @example
+ * ```ts
+ * import { buildSchema, parse, validate } from 'graphql';
+ * import { FragmentsOnCompositeTypesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   fragment Bad on String { length }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [FragmentsOnCompositeTypesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   fragment Good on Query { name }
+ * `);
+ * const validErrors = validate(schema, validDocument, [FragmentsOnCompositeTypesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export declare function FragmentsOnCompositeTypesRule(context: ValidationContext): ASTVisitor;

package/validation/rules/FragmentsOnCompositeTypesRule.d.ts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.js";
 import type { ValidationContext } from "../ValidationContext.js";
 /**
@@ -8,5 +9,32 @@ import type { ValidationContext } from "../ValidationContext.js";
  * type condition must also be a composite type.
  *
  * See https://spec.graphql.org/draft/#sec-Fragments-On-Composite-Types
+ * @param context - The validation context used while checking the document.
+ * @returns A visitor that reports validation errors for this rule.
+ * @example
+ * ```ts
+ * import { buildSchema, parse, validate } from 'graphql';
+ * import { FragmentsOnCompositeTypesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   fragment Bad on String { length }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [FragmentsOnCompositeTypesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   fragment Good on Query { name }
+ * `);
+ * const validErrors = validate(schema, validDocument, [FragmentsOnCompositeTypesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export declare function FragmentsOnCompositeTypesRule(context: ValidationContext): ASTVisitor;

package/validation/rules/FragmentsOnCompositeTypesRule.js

@@ -5,15 +5,6 @@ const GraphQLError_ts_1 = require("../../error/GraphQLError.js");
 const printer_ts_1 = require("../../language/printer.js");
 const definition_ts_1 = require("../../type/definition.js");
 const typeFromAST_ts_1 = require("../../utilities/typeFromAST.js");
-/**
- * Fragments on composite type
- *
- * Fragments use a type condition to determine if they apply, since fragments
- * can only be spread into a composite type (object, interface, or union), the
- * type condition must also be a composite type.
- *
- * See https://spec.graphql.org/draft/#sec-Fragments-On-Composite-Types
- */
 function FragmentsOnCompositeTypesRule(context) {
     return {
         InlineFragment(node) {

package/validation/rules/FragmentsOnCompositeTypesRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"FragmentsOnCompositeTypesRule.js","sourceRoot":"","sources":["../../../src/validation/rules/FragmentsOnCompositeTypesRule.ts"],"names":[],"mappings":";;AAoBA,sEAgCC;AApDD,iEAA2D;AAE3D,0DAAkD;AAGlD,4DAA2D;AAE3D,mEAA6D;AAI7D;;;;;;;;GAQG;AACH,SAAgB,6BAA6B,CAC3C,OAA0B;IAE1B,OAAO;QACL,cAAc,CAAC,IAAI;YACjB,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;YACzC,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAC,OAAO,CAAC,SAAS,EAAE,EAAE,aAAa,CAAC,CAAC;gBAC7D,IAAI,IAAI,IAAI,CAAC,IAAA,+BAAe,EAAC,IAAI,CAAC,EAAE,CAAC;oBACnC,MAAM,OAAO,GAAG,IAAA,kBAAK,EAAC,aAAa,CAAC,CAAC;oBACrC,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,oDAAoD,OAAO,IAAI,EAC/D,EAAE,KAAK,EAAE,aAAa,EAAE,CACzB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,kBAAkB,CAAC,IAAI;YACrB,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAC,OAAO,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAClE,IAAI,IAAI,IAAI,CAAC,IAAA,+BAAe,EAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,MAAM,OAAO,GAAG,IAAA,kBAAK,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC1C,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,aAAa,IAAI,CAAC,IAAI,CAAC,KAAK,6CAA6C,OAAO,IAAI,EACpF,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,CAC9B,CACF,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport { print } from '../../language/printer.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport { isCompositeType } from '../../type/definition.ts';\n\nimport { typeFromAST } from '../../utilities/typeFromAST.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Fragments on composite type\n *\n * Fragments use a type condition to determine if they apply, since fragments\n * can only be spread into a composite type (object, interface, or union), the\n * type condition must also be a composite type.\n *\n * See https://spec.graphql.org/draft/#sec-Fragments-On-Composite-Types\n */\nexport function FragmentsOnCompositeTypesRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    InlineFragment(node) {\n      const typeCondition = node.typeCondition;\n      if (typeCondition) {\n        const type = typeFromAST(context.getSchema(), typeCondition);\n        if (type && !isCompositeType(type)) {\n          const typeStr = print(typeCondition);\n          context.reportError(\n            new GraphQLError(\n              `Fragment cannot condition on non composite type \"${typeStr}\".`,\n              { nodes: typeCondition },\n            ),\n          );\n        }\n      }\n    },\n    FragmentDefinition(node) {\n      const type = typeFromAST(context.getSchema(), node.typeCondition);\n      if (type && !isCompositeType(type)) {\n        const typeStr = print(node.typeCondition);\n        context.reportError(\n          new GraphQLError(\n            `Fragment \"${node.name.value}\" cannot condition on non composite type \"${typeStr}\".`,\n            { nodes: node.typeCondition },\n          ),\n        );\n      }\n    },\n  };\n}\n"]}
+{"version":3,"file":"FragmentsOnCompositeTypesRule.js","sourceRoot":"","sources":["../../../src/validation/rules/FragmentsOnCompositeTypesRule.ts"],"names":[],"mappings":";;AAiDA,sEAgCC;AA/ED,iEAA2D;AAE3D,0DAAkD;AAGlD,4DAA2D;AAE3D,mEAA6D;AAwC7D,SAAgB,6BAA6B,CAC3C,OAA0B;IAE1B,OAAO;QACL,cAAc,CAAC,IAAI;YACjB,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;YACzC,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAC,OAAO,CAAC,SAAS,EAAE,EAAE,aAAa,CAAC,CAAC;gBAC7D,IAAI,IAAI,IAAI,CAAC,IAAA,+BAAe,EAAC,IAAI,CAAC,EAAE,CAAC;oBACnC,MAAM,OAAO,GAAG,IAAA,kBAAK,EAAC,aAAa,CAAC,CAAC;oBACrC,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,oDAAoD,OAAO,IAAI,EAC/D,EAAE,KAAK,EAAE,aAAa,EAAE,CACzB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,kBAAkB,CAAC,IAAI;YACrB,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAC,OAAO,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAClE,IAAI,IAAI,IAAI,CAAC,IAAA,+BAAe,EAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,MAAM,OAAO,GAAG,IAAA,kBAAK,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC1C,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,aAAa,IAAI,CAAC,IAAI,CAAC,KAAK,6CAA6C,OAAO,IAAI,EACpF,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,CAC9B,CACF,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport { print } from '../../language/printer.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport { isCompositeType } from '../../type/definition.ts';\n\nimport { typeFromAST } from '../../utilities/typeFromAST.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Fragments on composite type\n *\n * Fragments use a type condition to determine if they apply, since fragments\n * can only be spread into a composite type (object, interface, or union), the\n * type condition must also be a composite type.\n *\n * See https://spec.graphql.org/draft/#sec-Fragments-On-Composite-Types\n * @param context - The validation context used while checking the document.\n * @returns A visitor that reports validation errors for this rule.\n * @example\n * ```ts\n * import { buildSchema, parse, validate } from 'graphql';\n * import { FragmentsOnCompositeTypesRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String\n *   }\n * `);\n *\n * const invalidDocument = parse(`\n *   fragment Bad on String { length }\n * `);\n * const invalidErrors = validate(schema, invalidDocument, [FragmentsOnCompositeTypesRule]);\n *\n * invalidErrors.length; // => 1\n *\n * const validDocument = parse(`\n *   fragment Good on Query { name }\n * `);\n * const validErrors = validate(schema, validDocument, [FragmentsOnCompositeTypesRule]);\n *\n * validErrors; // => []\n * ```\n */\nexport function FragmentsOnCompositeTypesRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    InlineFragment(node) {\n      const typeCondition = node.typeCondition;\n      if (typeCondition) {\n        const type = typeFromAST(context.getSchema(), typeCondition);\n        if (type && !isCompositeType(type)) {\n          const typeStr = print(typeCondition);\n          context.reportError(\n            new GraphQLError(\n              `Fragment cannot condition on non composite type \"${typeStr}\".`,\n              { nodes: typeCondition },\n            ),\n          );\n        }\n      }\n    },\n    FragmentDefinition(node) {\n      const type = typeFromAST(context.getSchema(), node.typeCondition);\n      if (type && !isCompositeType(type)) {\n        const typeStr = print(node.typeCondition);\n        context.reportError(\n          new GraphQLError(\n            `Fragment \"${node.name.value}\" cannot condition on non composite type \"${typeStr}\".`,\n            { nodes: node.typeCondition },\n          ),\n        );\n      }\n    },\n  };\n}\n"]}

package/validation/rules/FragmentsOnCompositeTypesRule.mjs

@@ -2,15 +2,6 @@ import { GraphQLError } from "../../error/GraphQLError.mjs";
 import { print } from "../../language/printer.mjs";
 import { isCompositeType } from "../../type/definition.mjs";
 import { typeFromAST } from "../../utilities/typeFromAST.mjs";
-/**
- * Fragments on composite type
- *
- * Fragments use a type condition to determine if they apply, since fragments
- * can only be spread into a composite type (object, interface, or union), the
- * type condition must also be a composite type.
- *
- * See https://spec.graphql.org/draft/#sec-Fragments-On-Composite-Types
- */
 export function FragmentsOnCompositeTypesRule(context) {
     return {
         InlineFragment(node) {

package/validation/rules/FragmentsOnCompositeTypesRule.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"FragmentsOnCompositeTypesRule.js","sourceRoot":"","sources":["../../../src/validation/rules/FragmentsOnCompositeTypesRule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAE3D,OAAO,EAAE,KAAK,EAAE,mCAAkC;AAGlD,OAAO,EAAE,eAAe,EAAE,kCAAiC;AAE3D,OAAO,EAAE,WAAW,EAAE,wCAAuC;AAI7D;;;;;;;;GAQG;AACH,MAAM,UAAU,6BAA6B,CAC3C,OAA0B;IAE1B,OAAO;QACL,cAAc,CAAC,IAAI;YACjB,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;YACzC,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,aAAa,CAAC,CAAC;gBAC7D,IAAI,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBACnC,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;oBACrC,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,oDAAoD,OAAO,IAAI,EAC/D,EAAE,KAAK,EAAE,aAAa,EAAE,CACzB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,kBAAkB,CAAC,IAAI;YACrB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAClE,IAAI,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC1C,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,aAAa,IAAI,CAAC,IAAI,CAAC,KAAK,6CAA6C,OAAO,IAAI,EACpF,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,CAC9B,CACF,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport { print } from '../../language/printer.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport { isCompositeType } from '../../type/definition.ts';\n\nimport { typeFromAST } from '../../utilities/typeFromAST.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Fragments on composite type\n *\n * Fragments use a type condition to determine if they apply, since fragments\n * can only be spread into a composite type (object, interface, or union), the\n * type condition must also be a composite type.\n *\n * See https://spec.graphql.org/draft/#sec-Fragments-On-Composite-Types\n */\nexport function FragmentsOnCompositeTypesRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    InlineFragment(node) {\n      const typeCondition = node.typeCondition;\n      if (typeCondition) {\n        const type = typeFromAST(context.getSchema(), typeCondition);\n        if (type && !isCompositeType(type)) {\n          const typeStr = print(typeCondition);\n          context.reportError(\n            new GraphQLError(\n              `Fragment cannot condition on non composite type \"${typeStr}\".`,\n              { nodes: typeCondition },\n            ),\n          );\n        }\n      }\n    },\n    FragmentDefinition(node) {\n      const type = typeFromAST(context.getSchema(), node.typeCondition);\n      if (type && !isCompositeType(type)) {\n        const typeStr = print(node.typeCondition);\n        context.reportError(\n          new GraphQLError(\n            `Fragment \"${node.name.value}\" cannot condition on non composite type \"${typeStr}\".`,\n            { nodes: node.typeCondition },\n          ),\n        );\n      }\n    },\n  };\n}\n"]}
+{"version":3,"file":"FragmentsOnCompositeTypesRule.js","sourceRoot":"","sources":["../../../src/validation/rules/FragmentsOnCompositeTypesRule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAE3D,OAAO,EAAE,KAAK,EAAE,mCAAkC;AAGlD,OAAO,EAAE,eAAe,EAAE,kCAAiC;AAE3D,OAAO,EAAE,WAAW,EAAE,wCAAuC;AAwC7D,MAAM,UAAU,6BAA6B,CAC3C,OAA0B;IAE1B,OAAO;QACL,cAAc,CAAC,IAAI;YACjB,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;YACzC,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,aAAa,CAAC,CAAC;gBAC7D,IAAI,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBACnC,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;oBACrC,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,oDAAoD,OAAO,IAAI,EAC/D,EAAE,KAAK,EAAE,aAAa,EAAE,CACzB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,kBAAkB,CAAC,IAAI;YACrB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAClE,IAAI,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC1C,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,aAAa,IAAI,CAAC,IAAI,CAAC,KAAK,6CAA6C,OAAO,IAAI,EACpF,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,CAC9B,CACF,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport { print } from '../../language/printer.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport { isCompositeType } from '../../type/definition.ts';\n\nimport { typeFromAST } from '../../utilities/typeFromAST.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Fragments on composite type\n *\n * Fragments use a type condition to determine if they apply, since fragments\n * can only be spread into a composite type (object, interface, or union), the\n * type condition must also be a composite type.\n *\n * See https://spec.graphql.org/draft/#sec-Fragments-On-Composite-Types\n * @param context - The validation context used while checking the document.\n * @returns A visitor that reports validation errors for this rule.\n * @example\n * ```ts\n * import { buildSchema, parse, validate } from 'graphql';\n * import { FragmentsOnCompositeTypesRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String\n *   }\n * `);\n *\n * const invalidDocument = parse(`\n *   fragment Bad on String { length }\n * `);\n * const invalidErrors = validate(schema, invalidDocument, [FragmentsOnCompositeTypesRule]);\n *\n * invalidErrors.length; // => 1\n *\n * const validDocument = parse(`\n *   fragment Good on Query { name }\n * `);\n * const validErrors = validate(schema, validDocument, [FragmentsOnCompositeTypesRule]);\n *\n * validErrors; // => []\n * ```\n */\nexport function FragmentsOnCompositeTypesRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    InlineFragment(node) {\n      const typeCondition = node.typeCondition;\n      if (typeCondition) {\n        const type = typeFromAST(context.getSchema(), typeCondition);\n        if (type && !isCompositeType(type)) {\n          const typeStr = print(typeCondition);\n          context.reportError(\n            new GraphQLError(\n              `Fragment cannot condition on non composite type \"${typeStr}\".`,\n              { nodes: typeCondition },\n            ),\n          );\n        }\n      }\n    },\n    FragmentDefinition(node) {\n      const type = typeFromAST(context.getSchema(), node.typeCondition);\n      if (type && !isCompositeType(type)) {\n        const typeStr = print(node.typeCondition);\n        context.reportError(\n          new GraphQLError(\n            `Fragment \"${node.name.value}\" cannot condition on non composite type \"${typeStr}\".`,\n            { nodes: node.typeCondition },\n          ),\n        );\n      }\n    },\n  };\n}\n"]}

package/validation/rules/KnownArgumentNamesRule.d.mts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.mjs";
 import type { SDLValidationContext, ValidationContext } from "../ValidationContext.mjs";
 /**
@@ -8,9 +9,34 @@ import type { SDLValidationContext, ValidationContext } from "../ValidationConte
  *
  * See https://spec.graphql.org/draft/#sec-Argument-Names
  * See https://spec.graphql.org/draft/#sec-Directives-Are-In-Valid-Locations
+ * @param context - The validation context used while checking the document.
+ * @returns A visitor that reports validation errors for this rule.
+ * @example
+ * ```ts
+ * import { buildSchema, parse, validate } from 'graphql';
+ * import { KnownArgumentNamesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     field(arg: String): String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   { field(unknown: "1") }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [KnownArgumentNamesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   { field(arg: "1") }
+ * `);
+ * const validErrors = validate(schema, validDocument, [KnownArgumentNamesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export declare function KnownArgumentNamesRule(context: ValidationContext): ASTVisitor;
-/**
- * @internal
- */
+/** @internal */
 export declare function KnownArgumentNamesOnDirectivesRule(context: ValidationContext | SDLValidationContext): ASTVisitor;

package/validation/rules/KnownArgumentNamesRule.d.ts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.js";
 import type { SDLValidationContext, ValidationContext } from "../ValidationContext.js";
 /**
@@ -8,9 +9,34 @@ import type { SDLValidationContext, ValidationContext } from "../ValidationConte
  *
  * See https://spec.graphql.org/draft/#sec-Argument-Names
  * See https://spec.graphql.org/draft/#sec-Directives-Are-In-Valid-Locations
+ * @param context - The validation context used while checking the document.
+ * @returns A visitor that reports validation errors for this rule.
+ * @example
+ * ```ts
+ * import { buildSchema, parse, validate } from 'graphql';
+ * import { KnownArgumentNamesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     field(arg: String): String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   { field(unknown: "1") }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [KnownArgumentNamesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   { field(arg: "1") }
+ * `);
+ * const validErrors = validate(schema, validDocument, [KnownArgumentNamesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export declare function KnownArgumentNamesRule(context: ValidationContext): ASTVisitor;
-/**
- * @internal
- */
+/** @internal */
 export declare function KnownArgumentNamesOnDirectivesRule(context: ValidationContext | SDLValidationContext): ASTVisitor;

package/validation/rules/KnownArgumentNamesRule.js

@@ -7,18 +7,8 @@ const suggestionList_ts_1 = require("../../jsutils/suggestionList.js");
 const GraphQLError_ts_1 = require("../../error/GraphQLError.js");
 const kinds_ts_1 = require("../../language/kinds.js");
 const directives_ts_1 = require("../../type/directives.js");
-/**
- * Known argument names
- *
- * A GraphQL field is only valid if all supplied arguments are defined by
- * that field.
- *
- * See https://spec.graphql.org/draft/#sec-Argument-Names
- * See https://spec.graphql.org/draft/#sec-Directives-Are-In-Valid-Locations
- */
 function KnownArgumentNamesRule(context) {
     return {
-        // eslint-disable-next-line new-cap
         ...KnownArgumentNamesOnDirectivesRule(context),
         FragmentArgument(argNode) {
             const fragmentSignature = context.getFragmentSignature();
@@ -48,9 +38,6 @@ function KnownArgumentNamesRule(context) {
         },
     };
 }
-/**
- * @internal
- */
 function KnownArgumentNamesOnDirectivesRule(context) {
     const directiveArgs = new Map();
     const schema = context.getSchema();

package/validation/rules/KnownArgumentNamesRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"KnownArgumentNamesRule.js","sourceRoot":"","sources":["../../../src/validation/rules/KnownArgumentNamesRule.ts"],"names":[],"mappings":";;AAwBA,wDAoDC;AAKD,gFAoDC;AArID,+DAAyD;AACzD,uEAAiE;AAEjE,iEAA2D;AAE3D,sDAA+C;AAG/C,4DAA+D;AAO/D;;;;;;;;GAQG;AACH,SAAgB,sBAAsB,CAAC,OAA0B;IAC/D,OAAO;QACL,mCAAmC;QACnC,GAAG,kCAAkC,CAAC,OAAO,CAAC;QAC9C,gBAAgB,CAAC,OAAO;YACtB,MAAM,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACzD,IAAI,iBAAiB,EAAE,CAAC;gBACtB,MAAM,MAAM,GAAG,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,CACtD,OAAO,CAAC,IAAI,CAAC,KAAK,CACnB,CAAC;gBACF,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;oBACnC,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe;wBACzC,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,IAAA,kCAAc,EACZ,OAAO,EACP,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAC5D,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CACnD,CACF,CAAC;oBACN,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,qBAAqB,OAAO,kBAAkB,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,IAAI;wBACvF,IAAA,0BAAU,EAAC,WAAW,CAAC,EACzB,EAAE,KAAK,EAAE,OAAO,EAAE,CACnB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,QAAQ,CAAC,OAAO;YACd,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;YAEvC,IAAI,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC;gBACxB,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;gBACnC,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe;oBACzC,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,IAAA,kCAAc,EACZ,OAAO,EACP,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CACrC,CAAC;gBACN,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,qBAAqB,OAAO,eAAe,QAAQ,IAAI;oBACrD,IAAA,0BAAU,EAAC,WAAW,CAAC,EACzB,EAAE,KAAK,EAAE,OAAO,EAAE,CACnB,CACF,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,kCAAkC,CAChD,OAAiD;IAEjD,MAAM,aAAa,GAAG,IAAI,GAAG,EAAiC,CAAC;IAE/D,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IACnC,MAAM,iBAAiB,GAAG,MAAM;QAC9B,CAAC,CAAC,MAAM,CAAC,aAAa,EAAE;QACxB,CAAC,CAAC,mCAAmB,CAAC;IACxB,KAAK,MAAM,SAAS,IAAI,iBAAiB,EAAE,CAAC;QAC1C,aAAa,CAAC,GAAG,CACf,SAAS,CAAC,IAAI,EACd,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CACtC,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC;IACzD,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACjC,IAAI,GAAG,CAAC,IAAI,KAAK,eAAI,CAAC,oBAAoB,EAAE,CAAC;YAC3C,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;YAEtC,aAAa,CAAC,GAAG,CACf,GAAG,CAAC,IAAI,CAAC,KAAK,EACd,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CACvC,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO;QACL,SAAS,CAAC,aAAa;YACrB,MAAM,aAAa,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;YAC/C,MAAM,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAEnD,IAAI,aAAa,CAAC,SAAS,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;gBACzD,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;oBAC9C,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;oBACnC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;wBACjC,MAAM,WAAW,GAAG,IAAA,kCAAc,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;wBACvD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,qBAAqB,OAAO,oBAAoB,aAAa,IAAI;4BAC/D,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,0BAAU,EAAC,WAAW,CAAC,CAAC,EAC1D,EAAE,KAAK,EAAE,OAAO,EAAE,CACnB,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;YAED,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { didYouMean } from '../../jsutils/didYouMean.ts';\nimport { suggestionList } from '../../jsutils/suggestionList.ts';\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport { Kind } from '../../language/kinds.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport { specifiedDirectives } from '../../type/directives.ts';\n\nimport type {\n  SDLValidationContext,\n  ValidationContext,\n} from '../ValidationContext.ts';\n\n/**\n * Known argument names\n *\n * A GraphQL field is only valid if all supplied arguments are defined by\n * that field.\n *\n * See https://spec.graphql.org/draft/#sec-Argument-Names\n * See https://spec.graphql.org/draft/#sec-Directives-Are-In-Valid-Locations\n */\nexport function KnownArgumentNamesRule(context: ValidationContext): ASTVisitor {\n  return {\n    // eslint-disable-next-line new-cap\n    ...KnownArgumentNamesOnDirectivesRule(context),\n    FragmentArgument(argNode) {\n      const fragmentSignature = context.getFragmentSignature();\n      if (fragmentSignature) {\n        const varDef = fragmentSignature.variableDefinitions.get(\n          argNode.name.value,\n        );\n        if (!varDef) {\n          const argName = argNode.name.value;\n          const suggestions = context.hideSuggestions\n            ? []\n            : suggestionList(\n                argName,\n                Array.from(fragmentSignature.variableDefinitions.values()).map(\n                  (varSignature) => varSignature.variable.name.value,\n                ),\n              );\n          context.reportError(\n            new GraphQLError(\n              `Unknown argument \"${argName}\" on fragment \"${fragmentSignature.definition.name.value}\".` +\n                didYouMean(suggestions),\n              { nodes: argNode },\n            ),\n          );\n        }\n      }\n    },\n    Argument(argNode) {\n      const argDef = context.getArgument();\n      const fieldDef = context.getFieldDef();\n\n      if (!argDef && fieldDef) {\n        const argName = argNode.name.value;\n        const suggestions = context.hideSuggestions\n          ? []\n          : suggestionList(\n              argName,\n              fieldDef.args.map((arg) => arg.name),\n            );\n        context.reportError(\n          new GraphQLError(\n            `Unknown argument \"${argName}\" on field \"${fieldDef}\".` +\n              didYouMean(suggestions),\n            { nodes: argNode },\n          ),\n        );\n      }\n    },\n  };\n}\n\n/**\n * @internal\n */\nexport function KnownArgumentNamesOnDirectivesRule(\n  context: ValidationContext | SDLValidationContext,\n): ASTVisitor {\n  const directiveArgs = new Map<string, ReadonlyArray<string>>();\n\n  const schema = context.getSchema();\n  const definedDirectives = schema\n    ? schema.getDirectives()\n    : specifiedDirectives;\n  for (const directive of definedDirectives) {\n    directiveArgs.set(\n      directive.name,\n      directive.args.map((arg) => arg.name),\n    );\n  }\n\n  const astDefinitions = context.getDocument().definitions;\n  for (const def of astDefinitions) {\n    if (def.kind === Kind.DIRECTIVE_DEFINITION) {\n      const argsNodes = def.arguments ?? [];\n\n      directiveArgs.set(\n        def.name.value,\n        argsNodes.map((arg) => arg.name.value),\n      );\n    }\n  }\n\n  return {\n    Directive(directiveNode) {\n      const directiveName = directiveNode.name.value;\n      const knownArgs = directiveArgs.get(directiveName);\n\n      if (directiveNode.arguments != null && knownArgs != null) {\n        for (const argNode of directiveNode.arguments) {\n          const argName = argNode.name.value;\n          if (!knownArgs.includes(argName)) {\n            const suggestions = suggestionList(argName, knownArgs);\n            context.reportError(\n              new GraphQLError(\n                `Unknown argument \"${argName}\" on directive \"@${directiveName}\".` +\n                  (context.hideSuggestions ? '' : didYouMean(suggestions)),\n                { nodes: argNode },\n              ),\n            );\n          }\n        }\n      }\n\n      return false;\n    },\n  };\n}\n"]}
+{"version":3,"file":"KnownArgumentNamesRule.js","sourceRoot":"","sources":["../../../src/validation/rules/KnownArgumentNamesRule.ts"],"names":[],"mappings":";;AAqDA,wDAoDC;AAGD,gFAoDC;AA9JD,+DAAyD;AACzD,uEAAiE;AAEjE,iEAA2D;AAE3D,sDAA+C;AAG/C,4DAA+D;AA2C/D,SAAgB,sBAAsB,CAAC,OAA0B;IAC/D,OAAO;QAEL,GAAG,kCAAkC,CAAC,OAAO,CAAC;QAC9C,gBAAgB,CAAC,OAAO;YACtB,MAAM,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACzD,IAAI,iBAAiB,EAAE,CAAC;gBACtB,MAAM,MAAM,GAAG,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,CACtD,OAAO,CAAC,IAAI,CAAC,KAAK,CACnB,CAAC;gBACF,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;oBACnC,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe;wBACzC,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,IAAA,kCAAc,EACZ,OAAO,EACP,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAC5D,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CACnD,CACF,CAAC;oBACN,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,qBAAqB,OAAO,kBAAkB,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,IAAI;wBACvF,IAAA,0BAAU,EAAC,WAAW,CAAC,EACzB,EAAE,KAAK,EAAE,OAAO,EAAE,CACnB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,QAAQ,CAAC,OAAO;YACd,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;YAEvC,IAAI,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC;gBACxB,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;gBACnC,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe;oBACzC,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,IAAA,kCAAc,EACZ,OAAO,EACP,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CACrC,CAAC;gBACN,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,qBAAqB,OAAO,eAAe,QAAQ,IAAI;oBACrD,IAAA,0BAAU,EAAC,WAAW,CAAC,EACzB,EAAE,KAAK,EAAE,OAAO,EAAE,CACnB,CACF,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAGD,SAAgB,kCAAkC,CAChD,OAAiD;IAEjD,MAAM,aAAa,GAAG,IAAI,GAAG,EAAiC,CAAC;IAE/D,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IACnC,MAAM,iBAAiB,GAAG,MAAM;QAC9B,CAAC,CAAC,MAAM,CAAC,aAAa,EAAE;QACxB,CAAC,CAAC,mCAAmB,CAAC;IACxB,KAAK,MAAM,SAAS,IAAI,iBAAiB,EAAE,CAAC;QAC1C,aAAa,CAAC,GAAG,CACf,SAAS,CAAC,IAAI,EACd,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CACtC,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC;IACzD,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACjC,IAAI,GAAG,CAAC,IAAI,KAAK,eAAI,CAAC,oBAAoB,EAAE,CAAC;YAC3C,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;YAEtC,aAAa,CAAC,GAAG,CACf,GAAG,CAAC,IAAI,CAAC,KAAK,EACd,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CACvC,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO;QACL,SAAS,CAAC,aAAa;YACrB,MAAM,aAAa,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;YAC/C,MAAM,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAEnD,IAAI,aAAa,CAAC,SAAS,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;gBACzD,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;oBAC9C,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;oBACnC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;wBACjC,MAAM,WAAW,GAAG,IAAA,kCAAc,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;wBACvD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,qBAAqB,OAAO,oBAAoB,aAAa,IAAI;4BAC/D,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,0BAAU,EAAC,WAAW,CAAC,CAAC,EAC1D,EAAE,KAAK,EAAE,OAAO,EAAE,CACnB,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;YAED,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { didYouMean } from '../../jsutils/didYouMean.ts';\nimport { suggestionList } from '../../jsutils/suggestionList.ts';\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport { Kind } from '../../language/kinds.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport { specifiedDirectives } from '../../type/directives.ts';\n\nimport type {\n  SDLValidationContext,\n  ValidationContext,\n} from '../ValidationContext.ts';\n\n/**\n * Known argument names\n *\n * A GraphQL field is only valid if all supplied arguments are defined by\n * that field.\n *\n * See https://spec.graphql.org/draft/#sec-Argument-Names\n * See https://spec.graphql.org/draft/#sec-Directives-Are-In-Valid-Locations\n * @param context - The validation context used while checking the document.\n * @returns A visitor that reports validation errors for this rule.\n * @example\n * ```ts\n * import { buildSchema, parse, validate } from 'graphql';\n * import { KnownArgumentNamesRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     field(arg: String): String\n *   }\n * `);\n *\n * const invalidDocument = parse(`\n *   { field(unknown: \"1\") }\n * `);\n * const invalidErrors = validate(schema, invalidDocument, [KnownArgumentNamesRule]);\n *\n * invalidErrors.length; // => 1\n *\n * const validDocument = parse(`\n *   { field(arg: \"1\") }\n * `);\n * const validErrors = validate(schema, validDocument, [KnownArgumentNamesRule]);\n *\n * validErrors; // => []\n * ```\n */\nexport function KnownArgumentNamesRule(context: ValidationContext): ASTVisitor {\n  return {\n    // eslint-disable-next-line new-cap\n    ...KnownArgumentNamesOnDirectivesRule(context),\n    FragmentArgument(argNode) {\n      const fragmentSignature = context.getFragmentSignature();\n      if (fragmentSignature) {\n        const varDef = fragmentSignature.variableDefinitions.get(\n          argNode.name.value,\n        );\n        if (!varDef) {\n          const argName = argNode.name.value;\n          const suggestions = context.hideSuggestions\n            ? []\n            : suggestionList(\n                argName,\n                Array.from(fragmentSignature.variableDefinitions.values()).map(\n                  (varSignature) => varSignature.variable.name.value,\n                ),\n              );\n          context.reportError(\n            new GraphQLError(\n              `Unknown argument \"${argName}\" on fragment \"${fragmentSignature.definition.name.value}\".` +\n                didYouMean(suggestions),\n              { nodes: argNode },\n            ),\n          );\n        }\n      }\n    },\n    Argument(argNode) {\n      const argDef = context.getArgument();\n      const fieldDef = context.getFieldDef();\n\n      if (!argDef && fieldDef) {\n        const argName = argNode.name.value;\n        const suggestions = context.hideSuggestions\n          ? []\n          : suggestionList(\n              argName,\n              fieldDef.args.map((arg) => arg.name),\n            );\n        context.reportError(\n          new GraphQLError(\n            `Unknown argument \"${argName}\" on field \"${fieldDef}\".` +\n              didYouMean(suggestions),\n            { nodes: argNode },\n          ),\n        );\n      }\n    },\n  };\n}\n\n/** @internal */\nexport function KnownArgumentNamesOnDirectivesRule(\n  context: ValidationContext | SDLValidationContext,\n): ASTVisitor {\n  const directiveArgs = new Map<string, ReadonlyArray<string>>();\n\n  const schema = context.getSchema();\n  const definedDirectives = schema\n    ? schema.getDirectives()\n    : specifiedDirectives;\n  for (const directive of definedDirectives) {\n    directiveArgs.set(\n      directive.name,\n      directive.args.map((arg) => arg.name),\n    );\n  }\n\n  const astDefinitions = context.getDocument().definitions;\n  for (const def of astDefinitions) {\n    if (def.kind === Kind.DIRECTIVE_DEFINITION) {\n      const argsNodes = def.arguments ?? [];\n\n      directiveArgs.set(\n        def.name.value,\n        argsNodes.map((arg) => arg.name.value),\n      );\n    }\n  }\n\n  return {\n    Directive(directiveNode) {\n      const directiveName = directiveNode.name.value;\n      const knownArgs = directiveArgs.get(directiveName);\n\n      if (directiveNode.arguments != null && knownArgs != null) {\n        for (const argNode of directiveNode.arguments) {\n          const argName = argNode.name.value;\n          if (!knownArgs.includes(argName)) {\n            const suggestions = suggestionList(argName, knownArgs);\n            context.reportError(\n              new GraphQLError(\n                `Unknown argument \"${argName}\" on directive \"@${directiveName}\".` +\n                  (context.hideSuggestions ? '' : didYouMean(suggestions)),\n                { nodes: argNode },\n              ),\n            );\n          }\n        }\n      }\n\n      return false;\n    },\n  };\n}\n"]}

package/validation/rules/KnownArgumentNamesRule.mjs

@@ -3,18 +3,8 @@ import { suggestionList } from "../../jsutils/suggestionList.mjs";
 import { GraphQLError } from "../../error/GraphQLError.mjs";
 import { Kind } from "../../language/kinds.mjs";
 import { specifiedDirectives } from "../../type/directives.mjs";
-/**
- * Known argument names
- *
- * A GraphQL field is only valid if all supplied arguments are defined by
- * that field.
- *
- * See https://spec.graphql.org/draft/#sec-Argument-Names
- * See https://spec.graphql.org/draft/#sec-Directives-Are-In-Valid-Locations
- */
 export function KnownArgumentNamesRule(context) {
     return {
-        // eslint-disable-next-line new-cap
         ...KnownArgumentNamesOnDirectivesRule(context),
         FragmentArgument(argNode) {
             const fragmentSignature = context.getFragmentSignature();
@@ -44,9 +34,6 @@ export function KnownArgumentNamesRule(context) {
         },
     };
 }
-/**
- * @internal
- */
 export function KnownArgumentNamesOnDirectivesRule(context) {
     const directiveArgs = new Map();
     const schema = context.getSchema();