graphql 16.14.0 → 16.14.1

package/validation/rules/FieldsOnCorrectTypeRule.js

@@ -15,6 +15,8 @@ var _GraphQLError = require('../../error/GraphQLError.js');
 
 var _definition = require('../../type/definition.js');
 
+/** @category Validation Rules */
+
 /**
  * Fields on correct type
  *
@@ -22,6 +24,33 @@ var _definition = require('../../type/definition.js');
  * parent type, or are an allowed meta field such as __typename.
  *
  * See https://spec.graphql.org/draft/#sec-Field-Selections
+ * @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 { FieldsOnCorrectTypeRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   { missing }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [FieldsOnCorrectTypeRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   { name }
+ * `);
+ * const validErrors = validate(schema, validDocument, [FieldsOnCorrectTypeRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 function FieldsOnCorrectTypeRule(context) {
   return {
@@ -65,6 +94,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.
+ *
+ * @internal
  */
 
 function getSuggestedTypeNames(schema, type, fieldName) {
@@ -130,6 +161,8 @@ function getSuggestedTypeNames(schema, type, fieldName) {
 /**
  * For the field name provided, determine if there are any similar field names
  * that may be the result of a typo.
+ *
+ * @internal
  */
 
 function getSuggestedFieldNames(type, fieldName) {

package/validation/rules/FieldsOnCorrectTypeRule.mjs

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import { didYouMean } from '../../jsutils/didYouMean.mjs';
 import { naturalCompare } from '../../jsutils/naturalCompare.mjs';
 import { suggestionList } from '../../jsutils/suggestionList.mjs';
@@ -15,6 +16,33 @@ import {
  * parent type, or are an allowed meta field such as __typename.
  *
  * See https://spec.graphql.org/draft/#sec-Field-Selections
+ * @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 { FieldsOnCorrectTypeRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   { missing }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [FieldsOnCorrectTypeRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   { name }
+ * `);
+ * const validErrors = validate(schema, validDocument, [FieldsOnCorrectTypeRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export function FieldsOnCorrectTypeRule(context) {
   return {
@@ -56,6 +84,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.
+ *
+ * @internal
  */
 
 function getSuggestedTypeNames(schema, type, fieldName) {
@@ -115,6 +145,8 @@ function getSuggestedTypeNames(schema, type, fieldName) {
 /**
  * For the field name provided, determine if there are any similar field names
  * that may be the result of a typo.
+ *
+ * @internal
  */
 
 function getSuggestedFieldNames(type, fieldName) {

package/validation/rules/FragmentsOnCompositeTypesRule.d.ts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from '../../language/visitor';
 import type { ValidationContext } from '../ValidationContext';
 /**
@@ -8,6 +9,33 @@ import type { ValidationContext } from '../ValidationContext';
  * 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,

package/validation/rules/FragmentsOnCompositeTypesRule.js

@@ -13,6 +13,8 @@ var _definition = require('../../type/definition.js');
 
 var _typeFromAST = require('../../utilities/typeFromAST.js');
 
+/** @category Validation Rules */
+
 /**
  * Fragments on composite type
  *
@@ -21,6 +23,33 @@ var _typeFromAST = require('../../utilities/typeFromAST.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; // => []
+ * ```
  */
 function FragmentsOnCompositeTypesRule(context) {
   return {

package/validation/rules/FragmentsOnCompositeTypesRule.mjs

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import { GraphQLError } from '../../error/GraphQLError.mjs';
 import { print } from '../../language/printer.mjs';
 import { isCompositeType } from '../../type/definition.mjs';
@@ -11,6 +12,33 @@ import { typeFromAST } from '../../utilities/typeFromAST.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 function FragmentsOnCompositeTypesRule(context) {
   return {

package/validation/rules/KnownArgumentNamesRule.d.ts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from '../../language/visitor';
 import type {
   SDLValidationContext,
@@ -11,13 +12,38 @@ import type {
  *
  * 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

@@ -16,6 +16,8 @@ var _kinds = require('../../language/kinds.js');
 
 var _directives = require('../../type/directives.js');
 
+/** @category Validation Rules */
+
 /**
  * Known argument names
  *
@@ -24,6 +26,33 @@ var _directives = require('../../type/directives.js');
  *
  * 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; // => []
+ * ```
  */
 function KnownArgumentNamesRule(context) {
   return {
@@ -55,9 +84,7 @@ function KnownArgumentNamesRule(context) {
     },
   };
 }
-/**
- * @internal
- */
+/** @internal */
 
 function KnownArgumentNamesOnDirectivesRule(context) {
   const directiveArgs = Object.create(null);

package/validation/rules/KnownArgumentNamesRule.mjs

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import { didYouMean } from '../../jsutils/didYouMean.mjs';
 import { suggestionList } from '../../jsutils/suggestionList.mjs';
 import { GraphQLError } from '../../error/GraphQLError.mjs';
@@ -12,6 +13,33 @@ import { specifiedDirectives } from '../../type/directives.mjs';
  *
  * 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 function KnownArgumentNamesRule(context) {
   return {
@@ -40,9 +68,7 @@ export function KnownArgumentNamesRule(context) {
     },
   };
 }
-/**
- * @internal
- */
+/** @internal */
 
 export function KnownArgumentNamesOnDirectivesRule(context) {
   const directiveArgs = Object.create(null);

package/validation/rules/KnownDirectivesRule.d.ts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from '../../language/visitor';
 import type {
   SDLValidationContext,
@@ -10,6 +11,33 @@ import type {
  * schema and legally positioned.
  *
  * See https://spec.graphql.org/draft/#sec-Directives-Are-Defined
+ * @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 { KnownDirectivesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   { name @unknown }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [KnownDirectivesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   { name @include(if: true) }
+ * `);
+ * const validErrors = validate(schema, validDocument, [KnownDirectivesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export declare function KnownDirectivesRule(
   context: ValidationContext | SDLValidationContext,

package/validation/rules/KnownDirectivesRule.js

@@ -19,6 +19,8 @@ var _kinds = require('../../language/kinds.js');
 
 var _directives = require('../../type/directives.js');
 
+/** @category Validation Rules */
+
 /**
  * Known directives
  *
@@ -26,6 +28,33 @@ var _directives = require('../../type/directives.js');
  * schema and legally positioned.
  *
  * See https://spec.graphql.org/draft/#sec-Directives-Are-Defined
+ * @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 { KnownDirectivesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   { name @unknown }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [KnownDirectivesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   { name @include(if: true) }
+ * `);
+ * const validErrors = validate(schema, validDocument, [KnownDirectivesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 function KnownDirectivesRule(context) {
   const locationsMap = Object.create(null);

package/validation/rules/KnownDirectivesRule.mjs

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import { inspect } from '../../jsutils/inspect.mjs';
 import { invariant } from '../../jsutils/invariant.mjs';
 import { GraphQLError } from '../../error/GraphQLError.mjs';
@@ -13,6 +14,33 @@ import { specifiedDirectives } from '../../type/directives.mjs';
  * schema and legally positioned.
  *
  * See https://spec.graphql.org/draft/#sec-Directives-Are-Defined
+ * @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 { KnownDirectivesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   { name @unknown }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [KnownDirectivesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   { name @include(if: true) }
+ * `);
+ * const validErrors = validate(schema, validDocument, [KnownDirectivesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export function KnownDirectivesRule(context) {
   const locationsMap = Object.create(null);

package/validation/rules/KnownFragmentNamesRule.d.ts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from '../../language/visitor';
 import type { ValidationContext } from '../ValidationContext';
 /**
@@ -7,6 +8,33 @@ import type { ValidationContext } from '../ValidationContext';
  * to fragments defined in the same document.
  *
  * See https://spec.graphql.org/draft/#sec-Fragment-spread-target-defined
+ * @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 { KnownFragmentNamesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   { ...Missing }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [KnownFragmentNamesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   fragment NameFields on Query { name } query { ...NameFields }
+ * `);
+ * const validErrors = validate(schema, validDocument, [KnownFragmentNamesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export declare function KnownFragmentNamesRule(
   context: ValidationContext,

package/validation/rules/KnownFragmentNamesRule.js

@@ -7,6 +7,8 @@ exports.KnownFragmentNamesRule = KnownFragmentNamesRule;
 
 var _GraphQLError = require('../../error/GraphQLError.js');
 
+/** @category Validation Rules */
+
 /**
  * Known fragment names
  *
@@ -14,6 +16,33 @@ var _GraphQLError = require('../../error/GraphQLError.js');
  * to fragments defined in the same document.
  *
  * See https://spec.graphql.org/draft/#sec-Fragment-spread-target-defined
+ * @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 { KnownFragmentNamesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   { ...Missing }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [KnownFragmentNamesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   fragment NameFields on Query { name } query { ...NameFields }
+ * `);
+ * const validErrors = validate(schema, validDocument, [KnownFragmentNamesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 function KnownFragmentNamesRule(context) {
   return {

package/validation/rules/KnownFragmentNamesRule.mjs

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import { GraphQLError } from '../../error/GraphQLError.mjs';
 
 /**
@@ -7,6 +8,33 @@ import { GraphQLError } from '../../error/GraphQLError.mjs';
  * to fragments defined in the same document.
  *
  * See https://spec.graphql.org/draft/#sec-Fragment-spread-target-defined
+ * @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 { KnownFragmentNamesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   { ...Missing }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [KnownFragmentNamesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   fragment NameFields on Query { name } query { ...NameFields }
+ * `);
+ * const validErrors = validate(schema, validDocument, [KnownFragmentNamesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export function KnownFragmentNamesRule(context) {
   return {

package/validation/rules/KnownTypeNamesRule.d.ts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from '../../language/visitor';
 import type {
   SDLValidationContext,
@@ -10,6 +11,33 @@ import type {
  * variable definitions and fragment conditions) are defined by the type schema.
  *
  * See https://spec.graphql.org/draft/#sec-Fragment-Spread-Type-Existence
+ * @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 { KnownTypeNamesRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   fragment Bad on Missing { name }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [KnownTypeNamesRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   fragment Good on Query { name }
+ * `);
+ * const validErrors = validate(schema, validDocument, [KnownTypeNamesRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export declare function KnownTypeNamesRule(
   context: ValidationContext | SDLValidationContext,