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

package/validation/validate.d.mts

@@ -1,10 +1,17 @@
+/** @category Validation */
 import type { Maybe } from "../jsutils/Maybe.mjs";
 import { GraphQLError } from "../error/GraphQLError.mjs";
 import type { DocumentNode } from "../language/ast.mjs";
 import type { GraphQLSchema } from "../type/schema.mjs";
 import type { SDLValidationRule, ValidationRule } from "./ValidationContext.mjs";
+/**
+ * Options used when validating a GraphQL document.
+ * @category Validation
+ */
 export interface ValidationOptions {
+    /** Maximum number of validation errors before validation stops. */
     maxErrors?: number;
+    /** Whether suggestion text should be omitted from validation errors. */
     hideSuggestions?: Maybe<boolean>;
 }
 /**
@@ -16,21 +23,72 @@ export interface ValidationOptions {
  * A list of specific validation rules may be provided. If not provided, the
  * default list of rules defined by the GraphQL specification will be used.
  *
- * Each validation rules is a function which returns a visitor
+ * Each validation rule is a function that returns a visitor
  * (see the language/visitor API). Visitor methods are expected to return
  * GraphQLErrors, or Arrays of GraphQLErrors when invalid.
  *
  * Validate will stop validation after a `maxErrors` limit has been reached.
  * Attackers can send pathologically invalid queries to induce a DoS attack,
- * so by default `maxErrors` set to 100 errors.
+ * so `maxErrors` defaults to 100 errors.
+ * @param schema - Schema to validate against.
+ * @param documentAST - Document AST to validate.
+ * @param rules - Validation rules to apply.
+ * @param options - Validation options, including error limits and suggestions.
+ * @returns Validation errors, or an empty array when the document is valid.
+ * @example
+ * ```ts
+ * // Validate with the default specified rules.
+ * import { parse } from 'graphql/language';
+ * import { buildSchema } from 'graphql/utilities';
+ * import { validate } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     fullName: String
+ *   }
+ * `);
+ *
+ * validate(schema, parse('{ greeting }')); // => []
+ *
+ * const errors = validate(schema, parse('{ missing }'));
+ * errors[0].message; // => 'Cannot query field "missing" on type "Query".'
+ * ```
+ * @example
+ * ```ts
+ * // This variant uses a custom rule list and validation options.
+ * import { parse } from 'graphql/language';
+ * import { buildSchema } from 'graphql/utilities';
+ * import { FieldsOnCorrectTypeRule, validate } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     greeting: String
+ *   }
+ * `);
+ * const document = parse('{ missingOne missingTwo }');
  *
- * Optionally a custom TypeInfo instance may be provided. If not provided, one
- * will be created from the provided schema.
+ * const errors = validate(
+ *   schema,
+ *   document,
+ *   [FieldsOnCorrectTypeRule],
+ *   { maxErrors: 1 },
+ * );
+ *
+ * errors.length; // => 2
+ * errors[1].message; // => 'Too many validation errors, error limit reached. Validation aborted.'
+ *
+ * const hiddenSuggestionErrors = validate(
+ *   schema,
+ *   parse('{ name }'),
+ *   [FieldsOnCorrectTypeRule],
+ *   { hideSuggestions: true },
+ * );
+ *
+ * hiddenSuggestionErrors[0].message; // => 'Cannot query field "name" on type "Query".'
+ * ```
  */
 export declare function validate(schema: GraphQLSchema, documentAST: DocumentNode, rules?: ReadonlyArray<ValidationRule>, options?: ValidationOptions): ReadonlyArray<GraphQLError>;
-/**
- * @internal
- */
+/** @internal */
 export declare function validateSDL(documentAST: DocumentNode, schemaToExtend?: Maybe<GraphQLSchema>, rules?: ReadonlyArray<SDLValidationRule>): ReadonlyArray<GraphQLError>;
 /**
  * Utility function which asserts a SDL document is valid by throwing an error

package/validation/validate.d.ts

@@ -1,10 +1,17 @@
+/** @category Validation */
 import type { Maybe } from "../jsutils/Maybe.js";
 import { GraphQLError } from "../error/GraphQLError.js";
 import type { DocumentNode } from "../language/ast.js";
 import type { GraphQLSchema } from "../type/schema.js";
 import type { SDLValidationRule, ValidationRule } from "./ValidationContext.js";
+/**
+ * Options used when validating a GraphQL document.
+ * @category Validation
+ */
 export interface ValidationOptions {
+    /** Maximum number of validation errors before validation stops. */
     maxErrors?: number;
+    /** Whether suggestion text should be omitted from validation errors. */
     hideSuggestions?: Maybe<boolean>;
 }
 /**
@@ -16,21 +23,72 @@ export interface ValidationOptions {
  * A list of specific validation rules may be provided. If not provided, the
  * default list of rules defined by the GraphQL specification will be used.
  *
- * Each validation rules is a function which returns a visitor
+ * Each validation rule is a function that returns a visitor
  * (see the language/visitor API). Visitor methods are expected to return
  * GraphQLErrors, or Arrays of GraphQLErrors when invalid.
  *
  * Validate will stop validation after a `maxErrors` limit has been reached.
  * Attackers can send pathologically invalid queries to induce a DoS attack,
- * so by default `maxErrors` set to 100 errors.
+ * so `maxErrors` defaults to 100 errors.
+ * @param schema - Schema to validate against.
+ * @param documentAST - Document AST to validate.
+ * @param rules - Validation rules to apply.
+ * @param options - Validation options, including error limits and suggestions.
+ * @returns Validation errors, or an empty array when the document is valid.
+ * @example
+ * ```ts
+ * // Validate with the default specified rules.
+ * import { parse } from 'graphql/language';
+ * import { buildSchema } from 'graphql/utilities';
+ * import { validate } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     fullName: String
+ *   }
+ * `);
+ *
+ * validate(schema, parse('{ greeting }')); // => []
+ *
+ * const errors = validate(schema, parse('{ missing }'));
+ * errors[0].message; // => 'Cannot query field "missing" on type "Query".'
+ * ```
+ * @example
+ * ```ts
+ * // This variant uses a custom rule list and validation options.
+ * import { parse } from 'graphql/language';
+ * import { buildSchema } from 'graphql/utilities';
+ * import { FieldsOnCorrectTypeRule, validate } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     greeting: String
+ *   }
+ * `);
+ * const document = parse('{ missingOne missingTwo }');
  *
- * Optionally a custom TypeInfo instance may be provided. If not provided, one
- * will be created from the provided schema.
+ * const errors = validate(
+ *   schema,
+ *   document,
+ *   [FieldsOnCorrectTypeRule],
+ *   { maxErrors: 1 },
+ * );
+ *
+ * errors.length; // => 2
+ * errors[1].message; // => 'Too many validation errors, error limit reached. Validation aborted.'
+ *
+ * const hiddenSuggestionErrors = validate(
+ *   schema,
+ *   parse('{ name }'),
+ *   [FieldsOnCorrectTypeRule],
+ *   { hideSuggestions: true },
+ * );
+ *
+ * hiddenSuggestionErrors[0].message; // => 'Cannot query field "name" on type "Query".'
+ * ```
  */
 export declare function validate(schema: GraphQLSchema, documentAST: DocumentNode, rules?: ReadonlyArray<ValidationRule>, options?: ValidationOptions): ReadonlyArray<GraphQLError>;
-/**
- * @internal
- */
+/** @internal */
 export declare function validateSDL(documentAST: DocumentNode, schemaToExtend?: Maybe<GraphQLSchema>, rules?: ReadonlyArray<SDLValidationRule>): ReadonlyArray<GraphQLError>;
 /**
  * Utility function which asserts a SDL document is valid by throwing an error

package/validation/validate.js

@@ -12,34 +12,11 @@ const validate_ts_1 = require("../type/validate.js");
 const TypeInfo_ts_1 = require("../utilities/TypeInfo.js");
 const specifiedRules_ts_1 = require("./specifiedRules.js");
 const ValidationContext_ts_1 = require("./ValidationContext.js");
-// Per the specification, descriptions must not affect validation.
-// See https://spec.graphql.org/draft/#sec-Descriptions
 const QueryDocumentKeysToValidate = (0, mapValue_ts_1.mapValue)(ast_ts_1.QueryDocumentKeys, (keys) => keys.filter((key) => key !== 'description'));
 const tooManyValidationErrorsError = new GraphQLError_ts_1.GraphQLError('Too many validation errors, error limit reached. Validation aborted.');
-/**
- * Implements the "Validation" section of the spec.
- *
- * Validation runs synchronously, returning an array of encountered errors, or
- * an empty array if no errors were encountered and the document is valid.
- *
- * A list of specific validation rules may be provided. If not provided, the
- * default list of rules defined by the GraphQL specification will be used.
- *
- * Each validation rules is a function which returns a visitor
- * (see the language/visitor API). Visitor methods are expected to return
- * GraphQLErrors, or Arrays of GraphQLErrors when invalid.
- *
- * Validate will stop validation after a `maxErrors` limit has been reached.
- * Attackers can send pathologically invalid queries to induce a DoS attack,
- * so by default `maxErrors` set to 100 errors.
- *
- * Optionally a custom TypeInfo instance may be provided. If not provided, one
- * will be created from the provided schema.
- */
 function validate(schema, documentAST, rules = specifiedRules_ts_1.specifiedRules, options) {
     const maxErrors = options?.maxErrors ?? 100;
     const hideSuggestions = options?.hideSuggestions ?? false;
-    // If the schema used for validation is invalid, throw an error.
     (0, validate_ts_1.assertValidSchema)(schema);
     const errors = [];
     const typeInfo = new TypeInfo_ts_1.TypeInfo(schema);
@@ -49,10 +26,7 @@ function validate(schema, documentAST, rules = specifiedRules_ts_1.specifiedRule
         }
         errors.push(error);
     }, hideSuggestions);
-    // This uses a specialized visitor which runs multiple visitors in parallel,
-    // while maintaining the visitor skip and break API.
     const visitor = (0, visitor_ts_1.visitInParallel)(rules.map((rule) => rule(context)));
-    // Visit the whole document with each instance of all provided rules.
     try {
         (0, visitor_ts_1.visit)(documentAST, (0, TypeInfo_ts_1.visitWithTypeInfo)(typeInfo, visitor), QueryDocumentKeysToValidate);
     }
@@ -66,9 +40,6 @@ function validate(schema, documentAST, rules = specifiedRules_ts_1.specifiedRule
     }
     return errors;
 }
-/**
- * @internal
- */
 function validateSDL(documentAST, schemaToExtend, rules = specifiedRules_ts_1.specifiedSDLRules) {
     const errors = [];
     const context = new ValidationContext_ts_1.SDLValidationContext(documentAST, schemaToExtend, (error) => {
@@ -78,24 +49,12 @@ function validateSDL(documentAST, schemaToExtend, rules = specifiedRules_ts_1.sp
     (0, visitor_ts_1.visit)(documentAST, (0, visitor_ts_1.visitInParallel)(visitors));
     return errors;
 }
-/**
- * Utility function which asserts a SDL document is valid by throwing an error
- * if it is invalid.
- *
- * @internal
- */
 function assertValidSDL(documentAST) {
     const errors = validateSDL(documentAST);
     if (errors.length !== 0) {
         throw new Error(errors.map((error) => error.message).join('\n\n'));
     }
 }
-/**
- * Utility function which asserts a SDL document is valid by throwing an error
- * if it is invalid.
- *
- * @internal
- */
 function assertValidSDLExtension(documentAST, schema) {
     const errors = validateSDL(documentAST, schema);
     if (errors.length !== 0) {

package/validation/validate.js.map

@@ -1 +1 @@
-{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/validation/validate.ts"],"names":[],"mappings":";;AAyDA,4BA8CC;AAKD,kCAiBC;AAQD,wCAKC;AAQD,0DAQC;AA1JD,wDAAkD;AAGlD,8DAAwD;AAGxD,+CAAuD;AACvD,uDAAgE;AAGhE,qDAAwD;AAExD,0DAAuE;AAEvE,2DAAwE;AAExE,iEAGgC;AAOhC,kEAAkE;AAClE,uDAAuD;AACvD,MAAM,2BAA2B,GAAG,IAAA,sBAAQ,EAC1C,0BAAiB,EACjB,CAAC,IAA2B,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,aAAa,CAAC,CAC7E,CAAC;AAEF,MAAM,4BAA4B,GAAG,IAAI,8BAAY,CACnD,sEAAsE,CACvE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,QAAQ,CACtB,MAAqB,EACrB,WAAyB,EACzB,QAAuC,kCAAc,EACrD,OAA2B;IAE3B,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC;IAC5C,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,KAAK,CAAC;IAE1D,gEAAgE;IAChE,IAAA,+BAAiB,EAAC,MAAM,CAAC,CAAC;IAE1B,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,MAAM,QAAQ,GAAG,IAAI,sBAAQ,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,wCAAiB,CACnC,MAAM,EACN,WAAW,EACX,QAAQ,EACR,CAAC,KAAK,EAAE,EAAE;QACR,IAAI,MAAM,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC/B,MAAM,4BAA4B,CAAC;QACrC,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC,EACD,eAAe,CAChB,CAAC;IAEF,4EAA4E;IAC5E,oDAAoD;IACpD,MAAM,OAAO,GAAG,IAAA,4BAAe,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAEpE,qEAAqE;IACrE,IAAI,CAAC;QACH,IAAA,kBAAK,EACH,WAAW,EACX,IAAA,+BAAiB,EAAC,QAAQ,EAAE,OAAO,CAAC,EACpC,2BAA2B,CAC5B,CAAC;IACJ,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,4BAA4B,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW,CACzB,WAAyB,EACzB,cAAqC,EACrC,QAA0C,qCAAiB;IAE3D,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,MAAM,OAAO,GAAG,IAAI,2CAAoB,CACtC,WAAW,EACX,cAAc,EACd,CAAC,KAAK,EAAE,EAAE;QACR,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC,CACF,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,IAAA,kBAAK,EAAC,WAAW,EAAE,IAAA,4BAAe,EAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,WAAyB;IACtD,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,WAAyB,EACzB,MAAqB;IAErB,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAChD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;AACH,CAAC","sourcesContent":["import { mapValue } from '../jsutils/mapValue.ts';\nimport type { Maybe } from '../jsutils/Maybe.ts';\n\nimport { GraphQLError } from '../error/GraphQLError.ts';\n\nimport type { DocumentNode } from '../language/ast.ts';\nimport { QueryDocumentKeys } from '../language/ast.ts';\nimport { visit, visitInParallel } from '../language/visitor.ts';\n\nimport type { GraphQLSchema } from '../type/schema.ts';\nimport { assertValidSchema } from '../type/validate.ts';\n\nimport { TypeInfo, visitWithTypeInfo } from '../utilities/TypeInfo.ts';\n\nimport { specifiedRules, specifiedSDLRules } from './specifiedRules.ts';\nimport type { SDLValidationRule, ValidationRule } from './ValidationContext.ts';\nimport {\n  SDLValidationContext,\n  ValidationContext,\n} from './ValidationContext.ts';\n\nexport interface ValidationOptions {\n  maxErrors?: number;\n  hideSuggestions?: Maybe<boolean>;\n}\n\n// Per the specification, descriptions must not affect validation.\n// See https://spec.graphql.org/draft/#sec-Descriptions\nconst QueryDocumentKeysToValidate = mapValue(\n  QueryDocumentKeys,\n  (keys: ReadonlyArray<string>) => keys.filter((key) => key !== 'description'),\n);\n\nconst tooManyValidationErrorsError = new GraphQLError(\n  'Too many validation errors, error limit reached. Validation aborted.',\n);\n\n/**\n * Implements the \"Validation\" section of the spec.\n *\n * Validation runs synchronously, returning an array of encountered errors, or\n * an empty array if no errors were encountered and the document is valid.\n *\n * A list of specific validation rules may be provided. If not provided, the\n * default list of rules defined by the GraphQL specification will be used.\n *\n * Each validation rules is a function which returns a visitor\n * (see the language/visitor API). Visitor methods are expected to return\n * GraphQLErrors, or Arrays of GraphQLErrors when invalid.\n *\n * Validate will stop validation after a `maxErrors` limit has been reached.\n * Attackers can send pathologically invalid queries to induce a DoS attack,\n * so by default `maxErrors` set to 100 errors.\n *\n * Optionally a custom TypeInfo instance may be provided. If not provided, one\n * will be created from the provided schema.\n */\nexport function validate(\n  schema: GraphQLSchema,\n  documentAST: DocumentNode,\n  rules: ReadonlyArray<ValidationRule> = specifiedRules,\n  options?: ValidationOptions,\n): ReadonlyArray<GraphQLError> {\n  const maxErrors = options?.maxErrors ?? 100;\n  const hideSuggestions = options?.hideSuggestions ?? false;\n\n  // If the schema used for validation is invalid, throw an error.\n  assertValidSchema(schema);\n\n  const errors: Array<GraphQLError> = [];\n  const typeInfo = new TypeInfo(schema);\n  const context = new ValidationContext(\n    schema,\n    documentAST,\n    typeInfo,\n    (error) => {\n      if (errors.length >= maxErrors) {\n        throw tooManyValidationErrorsError;\n      }\n      errors.push(error);\n    },\n    hideSuggestions,\n  );\n\n  // This uses a specialized visitor which runs multiple visitors in parallel,\n  // while maintaining the visitor skip and break API.\n  const visitor = visitInParallel(rules.map((rule) => rule(context)));\n\n  // Visit the whole document with each instance of all provided rules.\n  try {\n    visit(\n      documentAST,\n      visitWithTypeInfo(typeInfo, visitor),\n      QueryDocumentKeysToValidate,\n    );\n  } catch (e: unknown) {\n    if (e === tooManyValidationErrorsError) {\n      errors.push(tooManyValidationErrorsError);\n    } else {\n      throw e;\n    }\n  }\n  return errors;\n}\n\n/**\n * @internal\n */\nexport function validateSDL(\n  documentAST: DocumentNode,\n  schemaToExtend?: Maybe<GraphQLSchema>,\n  rules: ReadonlyArray<SDLValidationRule> = specifiedSDLRules,\n): ReadonlyArray<GraphQLError> {\n  const errors: Array<GraphQLError> = [];\n  const context = new SDLValidationContext(\n    documentAST,\n    schemaToExtend,\n    (error) => {\n      errors.push(error);\n    },\n  );\n\n  const visitors = rules.map((rule) => rule(context));\n  visit(documentAST, visitInParallel(visitors));\n  return errors;\n}\n\n/**\n * Utility function which asserts a SDL document is valid by throwing an error\n * if it is invalid.\n *\n * @internal\n */\nexport function assertValidSDL(documentAST: DocumentNode): void {\n  const errors = validateSDL(documentAST);\n  if (errors.length !== 0) {\n    throw new Error(errors.map((error) => error.message).join('\\n\\n'));\n  }\n}\n\n/**\n * Utility function which asserts a SDL document is valid by throwing an error\n * if it is invalid.\n *\n * @internal\n */\nexport function assertValidSDLExtension(\n  documentAST: DocumentNode,\n  schema: GraphQLSchema,\n): void {\n  const errors = validateSDL(documentAST, schema);\n  if (errors.length !== 0) {\n    throw new Error(errors.map((error) => error.message).join('\\n\\n'));\n  }\n}\n"]}
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/validation/validate.ts"],"names":[],"mappings":";;AAsHA,4BA8CC;AAGD,kCAiBC;AAQD,wCAKC;AAQD,0DAQC;AAnND,wDAAkD;AAGlD,8DAAwD;AAGxD,+CAAuD;AACvD,uDAAgE;AAGhE,qDAAwD;AAExD,0DAAuE;AAEvE,2DAAwE;AAExE,iEAGgC;AAehC,MAAM,2BAA2B,GAAG,IAAA,sBAAQ,EAC1C,0BAAiB,EACjB,CAAC,IAA2B,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,aAAa,CAAC,CAC7E,CAAC;AAEF,MAAM,4BAA4B,GAAG,IAAI,8BAAY,CACnD,sEAAsE,CACvE,CAAC;AA2EF,SAAgB,QAAQ,CACtB,MAAqB,EACrB,WAAyB,EACzB,QAAuC,kCAAc,EACrD,OAA2B;IAE3B,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC;IAC5C,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,KAAK,CAAC;IAG1D,IAAA,+BAAiB,EAAC,MAAM,CAAC,CAAC;IAE1B,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,MAAM,QAAQ,GAAG,IAAI,sBAAQ,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,wCAAiB,CACnC,MAAM,EACN,WAAW,EACX,QAAQ,EACR,CAAC,KAAK,EAAE,EAAE;QACR,IAAI,MAAM,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC/B,MAAM,4BAA4B,CAAC;QACrC,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC,EACD,eAAe,CAChB,CAAC;IAIF,MAAM,OAAO,GAAG,IAAA,4BAAe,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAGpE,IAAI,CAAC;QACH,IAAA,kBAAK,EACH,WAAW,EACX,IAAA,+BAAiB,EAAC,QAAQ,EAAE,OAAO,CAAC,EACpC,2BAA2B,CAC5B,CAAC;IACJ,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,4BAA4B,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAGD,SAAgB,WAAW,CACzB,WAAyB,EACzB,cAAqC,EACrC,QAA0C,qCAAiB;IAE3D,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,MAAM,OAAO,GAAG,IAAI,2CAAoB,CACtC,WAAW,EACX,cAAc,EACd,CAAC,KAAK,EAAE,EAAE;QACR,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC,CACF,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,IAAA,kBAAK,EAAC,WAAW,EAAE,IAAA,4BAAe,EAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AAChB,CAAC;AAQD,SAAgB,cAAc,CAAC,WAAyB;IACtD,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAQD,SAAgB,uBAAuB,CACrC,WAAyB,EACzB,MAAqB;IAErB,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAChD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;AACH,CAAC","sourcesContent":["/** @category Validation */\n\nimport { mapValue } from '../jsutils/mapValue.ts';\nimport type { Maybe } from '../jsutils/Maybe.ts';\n\nimport { GraphQLError } from '../error/GraphQLError.ts';\n\nimport type { DocumentNode } from '../language/ast.ts';\nimport { QueryDocumentKeys } from '../language/ast.ts';\nimport { visit, visitInParallel } from '../language/visitor.ts';\n\nimport type { GraphQLSchema } from '../type/schema.ts';\nimport { assertValidSchema } from '../type/validate.ts';\n\nimport { TypeInfo, visitWithTypeInfo } from '../utilities/TypeInfo.ts';\n\nimport { specifiedRules, specifiedSDLRules } from './specifiedRules.ts';\nimport type { SDLValidationRule, ValidationRule } from './ValidationContext.ts';\nimport {\n  SDLValidationContext,\n  ValidationContext,\n} from './ValidationContext.ts';\n\n/**\n * Options used when validating a GraphQL document.\n * @category Validation\n */\nexport interface ValidationOptions {\n  /** Maximum number of validation errors before validation stops. */\n  maxErrors?: number;\n  /** Whether suggestion text should be omitted from validation errors. */\n  hideSuggestions?: Maybe<boolean>;\n}\n\n// Per the specification, descriptions must not affect validation.\n// See https://spec.graphql.org/draft/#sec-Descriptions\nconst QueryDocumentKeysToValidate = mapValue(\n  QueryDocumentKeys,\n  (keys: ReadonlyArray<string>) => keys.filter((key) => key !== 'description'),\n);\n\nconst tooManyValidationErrorsError = new GraphQLError(\n  'Too many validation errors, error limit reached. Validation aborted.',\n);\n\n/**\n * Implements the \"Validation\" section of the spec.\n *\n * Validation runs synchronously, returning an array of encountered errors, or\n * an empty array if no errors were encountered and the document is valid.\n *\n * A list of specific validation rules may be provided. If not provided, the\n * default list of rules defined by the GraphQL specification will be used.\n *\n * Each validation rule is a function that returns a visitor\n * (see the language/visitor API). Visitor methods are expected to return\n * GraphQLErrors, or Arrays of GraphQLErrors when invalid.\n *\n * Validate will stop validation after a `maxErrors` limit has been reached.\n * Attackers can send pathologically invalid queries to induce a DoS attack,\n * so `maxErrors` defaults to 100 errors.\n * @param schema - Schema to validate against.\n * @param documentAST - Document AST to validate.\n * @param rules - Validation rules to apply.\n * @param options - Validation options, including error limits and suggestions.\n * @returns Validation errors, or an empty array when the document is valid.\n * @example\n * ```ts\n * // Validate with the default specified rules.\n * import { parse } from 'graphql/language';\n * import { buildSchema } from 'graphql/utilities';\n * import { validate } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     fullName: String\n *   }\n * `);\n *\n * validate(schema, parse('{ greeting }')); // => []\n *\n * const errors = validate(schema, parse('{ missing }'));\n * errors[0].message; // => 'Cannot query field \"missing\" on type \"Query\".'\n * ```\n * @example\n * ```ts\n * // This variant uses a custom rule list and validation options.\n * import { parse } from 'graphql/language';\n * import { buildSchema } from 'graphql/utilities';\n * import { FieldsOnCorrectTypeRule, validate } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     greeting: String\n *   }\n * `);\n * const document = parse('{ missingOne missingTwo }');\n *\n * const errors = validate(\n *   schema,\n *   document,\n *   [FieldsOnCorrectTypeRule],\n *   { maxErrors: 1 },\n * );\n *\n * errors.length; // => 2\n * errors[1].message; // => 'Too many validation errors, error limit reached. Validation aborted.'\n *\n * const hiddenSuggestionErrors = validate(\n *   schema,\n *   parse('{ name }'),\n *   [FieldsOnCorrectTypeRule],\n *   { hideSuggestions: true },\n * );\n *\n * hiddenSuggestionErrors[0].message; // => 'Cannot query field \"name\" on type \"Query\".'\n * ```\n */\nexport function validate(\n  schema: GraphQLSchema,\n  documentAST: DocumentNode,\n  rules: ReadonlyArray<ValidationRule> = specifiedRules,\n  options?: ValidationOptions,\n): ReadonlyArray<GraphQLError> {\n  const maxErrors = options?.maxErrors ?? 100;\n  const hideSuggestions = options?.hideSuggestions ?? false;\n\n  // If the schema used for validation is invalid, throw an error.\n  assertValidSchema(schema);\n\n  const errors: Array<GraphQLError> = [];\n  const typeInfo = new TypeInfo(schema);\n  const context = new ValidationContext(\n    schema,\n    documentAST,\n    typeInfo,\n    (error) => {\n      if (errors.length >= maxErrors) {\n        throw tooManyValidationErrorsError;\n      }\n      errors.push(error);\n    },\n    hideSuggestions,\n  );\n\n  // This uses a specialized visitor which runs multiple visitors in parallel,\n  // while maintaining the visitor skip and break API.\n  const visitor = visitInParallel(rules.map((rule) => rule(context)));\n\n  // Visit the whole document with each instance of all provided rules.\n  try {\n    visit(\n      documentAST,\n      visitWithTypeInfo(typeInfo, visitor),\n      QueryDocumentKeysToValidate,\n    );\n  } catch (e: unknown) {\n    if (e === tooManyValidationErrorsError) {\n      errors.push(tooManyValidationErrorsError);\n    } else {\n      throw e;\n    }\n  }\n  return errors;\n}\n\n/** @internal */\nexport function validateSDL(\n  documentAST: DocumentNode,\n  schemaToExtend?: Maybe<GraphQLSchema>,\n  rules: ReadonlyArray<SDLValidationRule> = specifiedSDLRules,\n): ReadonlyArray<GraphQLError> {\n  const errors: Array<GraphQLError> = [];\n  const context = new SDLValidationContext(\n    documentAST,\n    schemaToExtend,\n    (error) => {\n      errors.push(error);\n    },\n  );\n\n  const visitors = rules.map((rule) => rule(context));\n  visit(documentAST, visitInParallel(visitors));\n  return errors;\n}\n\n/**\n * Utility function which asserts a SDL document is valid by throwing an error\n * if it is invalid.\n *\n * @internal\n */\nexport function assertValidSDL(documentAST: DocumentNode): void {\n  const errors = validateSDL(documentAST);\n  if (errors.length !== 0) {\n    throw new Error(errors.map((error) => error.message).join('\\n\\n'));\n  }\n}\n\n/**\n * Utility function which asserts a SDL document is valid by throwing an error\n * if it is invalid.\n *\n * @internal\n */\nexport function assertValidSDLExtension(\n  documentAST: DocumentNode,\n  schema: GraphQLSchema,\n): void {\n  const errors = validateSDL(documentAST, schema);\n  if (errors.length !== 0) {\n    throw new Error(errors.map((error) => error.message).join('\\n\\n'));\n  }\n}\n"]}

package/validation/validate.mjs

@@ -6,34 +6,11 @@ import { assertValidSchema } from "../type/validate.mjs";
 import { TypeInfo, visitWithTypeInfo } from "../utilities/TypeInfo.mjs";
 import { specifiedRules, specifiedSDLRules } from "./specifiedRules.mjs";
 import { SDLValidationContext, ValidationContext, } from "./ValidationContext.mjs";
-// Per the specification, descriptions must not affect validation.
-// See https://spec.graphql.org/draft/#sec-Descriptions
 const QueryDocumentKeysToValidate = mapValue(QueryDocumentKeys, (keys) => keys.filter((key) => key !== 'description'));
 const tooManyValidationErrorsError = new GraphQLError('Too many validation errors, error limit reached. Validation aborted.');
-/**
- * Implements the "Validation" section of the spec.
- *
- * Validation runs synchronously, returning an array of encountered errors, or
- * an empty array if no errors were encountered and the document is valid.
- *
- * A list of specific validation rules may be provided. If not provided, the
- * default list of rules defined by the GraphQL specification will be used.
- *
- * Each validation rules is a function which returns a visitor
- * (see the language/visitor API). Visitor methods are expected to return
- * GraphQLErrors, or Arrays of GraphQLErrors when invalid.
- *
- * Validate will stop validation after a `maxErrors` limit has been reached.
- * Attackers can send pathologically invalid queries to induce a DoS attack,
- * so by default `maxErrors` set to 100 errors.
- *
- * Optionally a custom TypeInfo instance may be provided. If not provided, one
- * will be created from the provided schema.
- */
 export function validate(schema, documentAST, rules = specifiedRules, options) {
     const maxErrors = options?.maxErrors ?? 100;
     const hideSuggestions = options?.hideSuggestions ?? false;
-    // If the schema used for validation is invalid, throw an error.
     assertValidSchema(schema);
     const errors = [];
     const typeInfo = new TypeInfo(schema);
@@ -43,10 +20,7 @@ export function validate(schema, documentAST, rules = specifiedRules, options) {
         }
         errors.push(error);
     }, hideSuggestions);
-    // This uses a specialized visitor which runs multiple visitors in parallel,
-    // while maintaining the visitor skip and break API.
     const visitor = visitInParallel(rules.map((rule) => rule(context)));
-    // Visit the whole document with each instance of all provided rules.
     try {
         visit(documentAST, visitWithTypeInfo(typeInfo, visitor), QueryDocumentKeysToValidate);
     }
@@ -60,9 +34,6 @@ export function validate(schema, documentAST, rules = specifiedRules, options) {
     }
     return errors;
 }
-/**
- * @internal
- */
 export function validateSDL(documentAST, schemaToExtend, rules = specifiedSDLRules) {
     const errors = [];
     const context = new SDLValidationContext(documentAST, schemaToExtend, (error) => {
@@ -72,24 +43,12 @@ export function validateSDL(documentAST, schemaToExtend, rules = specifiedSDLRul
     visit(documentAST, visitInParallel(visitors));
     return errors;
 }
-/**
- * Utility function which asserts a SDL document is valid by throwing an error
- * if it is invalid.
- *
- * @internal
- */
 export function assertValidSDL(documentAST) {
     const errors = validateSDL(documentAST);
     if (errors.length !== 0) {
         throw new Error(errors.map((error) => error.message).join('\n\n'));
     }
 }
-/**
- * Utility function which asserts a SDL document is valid by throwing an error
- * if it is invalid.
- *
- * @internal
- */
 export function assertValidSDLExtension(documentAST, schema) {
     const errors = validateSDL(documentAST, schema);
     if (errors.length !== 0) {

package/validation/validate.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/validation/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,gCAA+B;AAGlD,OAAO,EAAE,YAAY,EAAE,kCAAiC;AAGxD,OAAO,EAAE,iBAAiB,EAAE,4BAA2B;AACvD,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,gCAA+B;AAGhE,OAAO,EAAE,iBAAiB,EAAE,6BAA4B;AAExD,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,kCAAiC;AAEvE,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,6BAA4B;AAExE,OAAO,EACL,oBAAoB,EACpB,iBAAiB,GAClB,gCAA+B;AAOhC,kEAAkE;AAClE,uDAAuD;AACvD,MAAM,2BAA2B,GAAG,QAAQ,CAC1C,iBAAiB,EACjB,CAAC,IAA2B,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,aAAa,CAAC,CAC7E,CAAC;AAEF,MAAM,4BAA4B,GAAG,IAAI,YAAY,CACnD,sEAAsE,CACvE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAqB,EACrB,WAAyB,EACzB,QAAuC,cAAc,EACrD,OAA2B;IAE3B,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC;IAC5C,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,KAAK,CAAC;IAE1D,gEAAgE;IAChE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE1B,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CACnC,MAAM,EACN,WAAW,EACX,QAAQ,EACR,CAAC,KAAK,EAAE,EAAE;QACR,IAAI,MAAM,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC/B,MAAM,4BAA4B,CAAC;QACrC,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC,EACD,eAAe,CAChB,CAAC;IAEF,4EAA4E;IAC5E,oDAAoD;IACpD,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAEpE,qEAAqE;IACrE,IAAI,CAAC;QACH,KAAK,CACH,WAAW,EACX,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,EACpC,2BAA2B,CAC5B,CAAC;IACJ,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,4BAA4B,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,WAAyB,EACzB,cAAqC,EACrC,QAA0C,iBAAiB;IAE3D,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,MAAM,OAAO,GAAG,IAAI,oBAAoB,CACtC,WAAW,EACX,cAAc,EACd,CAAC,KAAK,EAAE,EAAE;QACR,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC,CACF,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,KAAK,CAAC,WAAW,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,WAAyB;IACtD,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,WAAyB,EACzB,MAAqB;IAErB,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAChD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;AACH,CAAC","sourcesContent":["import { mapValue } from '../jsutils/mapValue.ts';\nimport type { Maybe } from '../jsutils/Maybe.ts';\n\nimport { GraphQLError } from '../error/GraphQLError.ts';\n\nimport type { DocumentNode } from '../language/ast.ts';\nimport { QueryDocumentKeys } from '../language/ast.ts';\nimport { visit, visitInParallel } from '../language/visitor.ts';\n\nimport type { GraphQLSchema } from '../type/schema.ts';\nimport { assertValidSchema } from '../type/validate.ts';\n\nimport { TypeInfo, visitWithTypeInfo } from '../utilities/TypeInfo.ts';\n\nimport { specifiedRules, specifiedSDLRules } from './specifiedRules.ts';\nimport type { SDLValidationRule, ValidationRule } from './ValidationContext.ts';\nimport {\n  SDLValidationContext,\n  ValidationContext,\n} from './ValidationContext.ts';\n\nexport interface ValidationOptions {\n  maxErrors?: number;\n  hideSuggestions?: Maybe<boolean>;\n}\n\n// Per the specification, descriptions must not affect validation.\n// See https://spec.graphql.org/draft/#sec-Descriptions\nconst QueryDocumentKeysToValidate = mapValue(\n  QueryDocumentKeys,\n  (keys: ReadonlyArray<string>) => keys.filter((key) => key !== 'description'),\n);\n\nconst tooManyValidationErrorsError = new GraphQLError(\n  'Too many validation errors, error limit reached. Validation aborted.',\n);\n\n/**\n * Implements the \"Validation\" section of the spec.\n *\n * Validation runs synchronously, returning an array of encountered errors, or\n * an empty array if no errors were encountered and the document is valid.\n *\n * A list of specific validation rules may be provided. If not provided, the\n * default list of rules defined by the GraphQL specification will be used.\n *\n * Each validation rules is a function which returns a visitor\n * (see the language/visitor API). Visitor methods are expected to return\n * GraphQLErrors, or Arrays of GraphQLErrors when invalid.\n *\n * Validate will stop validation after a `maxErrors` limit has been reached.\n * Attackers can send pathologically invalid queries to induce a DoS attack,\n * so by default `maxErrors` set to 100 errors.\n *\n * Optionally a custom TypeInfo instance may be provided. If not provided, one\n * will be created from the provided schema.\n */\nexport function validate(\n  schema: GraphQLSchema,\n  documentAST: DocumentNode,\n  rules: ReadonlyArray<ValidationRule> = specifiedRules,\n  options?: ValidationOptions,\n): ReadonlyArray<GraphQLError> {\n  const maxErrors = options?.maxErrors ?? 100;\n  const hideSuggestions = options?.hideSuggestions ?? false;\n\n  // If the schema used for validation is invalid, throw an error.\n  assertValidSchema(schema);\n\n  const errors: Array<GraphQLError> = [];\n  const typeInfo = new TypeInfo(schema);\n  const context = new ValidationContext(\n    schema,\n    documentAST,\n    typeInfo,\n    (error) => {\n      if (errors.length >= maxErrors) {\n        throw tooManyValidationErrorsError;\n      }\n      errors.push(error);\n    },\n    hideSuggestions,\n  );\n\n  // This uses a specialized visitor which runs multiple visitors in parallel,\n  // while maintaining the visitor skip and break API.\n  const visitor = visitInParallel(rules.map((rule) => rule(context)));\n\n  // Visit the whole document with each instance of all provided rules.\n  try {\n    visit(\n      documentAST,\n      visitWithTypeInfo(typeInfo, visitor),\n      QueryDocumentKeysToValidate,\n    );\n  } catch (e: unknown) {\n    if (e === tooManyValidationErrorsError) {\n      errors.push(tooManyValidationErrorsError);\n    } else {\n      throw e;\n    }\n  }\n  return errors;\n}\n\n/**\n * @internal\n */\nexport function validateSDL(\n  documentAST: DocumentNode,\n  schemaToExtend?: Maybe<GraphQLSchema>,\n  rules: ReadonlyArray<SDLValidationRule> = specifiedSDLRules,\n): ReadonlyArray<GraphQLError> {\n  const errors: Array<GraphQLError> = [];\n  const context = new SDLValidationContext(\n    documentAST,\n    schemaToExtend,\n    (error) => {\n      errors.push(error);\n    },\n  );\n\n  const visitors = rules.map((rule) => rule(context));\n  visit(documentAST, visitInParallel(visitors));\n  return errors;\n}\n\n/**\n * Utility function which asserts a SDL document is valid by throwing an error\n * if it is invalid.\n *\n * @internal\n */\nexport function assertValidSDL(documentAST: DocumentNode): void {\n  const errors = validateSDL(documentAST);\n  if (errors.length !== 0) {\n    throw new Error(errors.map((error) => error.message).join('\\n\\n'));\n  }\n}\n\n/**\n * Utility function which asserts a SDL document is valid by throwing an error\n * if it is invalid.\n *\n * @internal\n */\nexport function assertValidSDLExtension(\n  documentAST: DocumentNode,\n  schema: GraphQLSchema,\n): void {\n  const errors = validateSDL(documentAST, schema);\n  if (errors.length !== 0) {\n    throw new Error(errors.map((error) => error.message).join('\\n\\n'));\n  }\n}\n"]}
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/validation/validate.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,gCAA+B;AAGlD,OAAO,EAAE,YAAY,EAAE,kCAAiC;AAGxD,OAAO,EAAE,iBAAiB,EAAE,4BAA2B;AACvD,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,gCAA+B;AAGhE,OAAO,EAAE,iBAAiB,EAAE,6BAA4B;AAExD,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,kCAAiC;AAEvE,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,6BAA4B;AAExE,OAAO,EACL,oBAAoB,EACpB,iBAAiB,GAClB,gCAA+B;AAehC,MAAM,2BAA2B,GAAG,QAAQ,CAC1C,iBAAiB,EACjB,CAAC,IAA2B,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,aAAa,CAAC,CAC7E,CAAC;AAEF,MAAM,4BAA4B,GAAG,IAAI,YAAY,CACnD,sEAAsE,CACvE,CAAC;AA2EF,MAAM,UAAU,QAAQ,CACtB,MAAqB,EACrB,WAAyB,EACzB,QAAuC,cAAc,EACrD,OAA2B;IAE3B,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC;IAC5C,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,KAAK,CAAC;IAG1D,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE1B,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CACnC,MAAM,EACN,WAAW,EACX,QAAQ,EACR,CAAC,KAAK,EAAE,EAAE;QACR,IAAI,MAAM,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC/B,MAAM,4BAA4B,CAAC;QACrC,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC,EACD,eAAe,CAChB,CAAC;IAIF,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAGpE,IAAI,CAAC;QACH,KAAK,CACH,WAAW,EACX,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,EACpC,2BAA2B,CAC5B,CAAC;IACJ,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,4BAA4B,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAGD,MAAM,UAAU,WAAW,CACzB,WAAyB,EACzB,cAAqC,EACrC,QAA0C,iBAAiB;IAE3D,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,MAAM,OAAO,GAAG,IAAI,oBAAoB,CACtC,WAAW,EACX,cAAc,EACd,CAAC,KAAK,EAAE,EAAE;QACR,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC,CACF,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,KAAK,CAAC,WAAW,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AAChB,CAAC;AAQD,MAAM,UAAU,cAAc,CAAC,WAAyB;IACtD,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAQD,MAAM,UAAU,uBAAuB,CACrC,WAAyB,EACzB,MAAqB;IAErB,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAChD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;AACH,CAAC","sourcesContent":["/** @category Validation */\n\nimport { mapValue } from '../jsutils/mapValue.ts';\nimport type { Maybe } from '../jsutils/Maybe.ts';\n\nimport { GraphQLError } from '../error/GraphQLError.ts';\n\nimport type { DocumentNode } from '../language/ast.ts';\nimport { QueryDocumentKeys } from '../language/ast.ts';\nimport { visit, visitInParallel } from '../language/visitor.ts';\n\nimport type { GraphQLSchema } from '../type/schema.ts';\nimport { assertValidSchema } from '../type/validate.ts';\n\nimport { TypeInfo, visitWithTypeInfo } from '../utilities/TypeInfo.ts';\n\nimport { specifiedRules, specifiedSDLRules } from './specifiedRules.ts';\nimport type { SDLValidationRule, ValidationRule } from './ValidationContext.ts';\nimport {\n  SDLValidationContext,\n  ValidationContext,\n} from './ValidationContext.ts';\n\n/**\n * Options used when validating a GraphQL document.\n * @category Validation\n */\nexport interface ValidationOptions {\n  /** Maximum number of validation errors before validation stops. */\n  maxErrors?: number;\n  /** Whether suggestion text should be omitted from validation errors. */\n  hideSuggestions?: Maybe<boolean>;\n}\n\n// Per the specification, descriptions must not affect validation.\n// See https://spec.graphql.org/draft/#sec-Descriptions\nconst QueryDocumentKeysToValidate = mapValue(\n  QueryDocumentKeys,\n  (keys: ReadonlyArray<string>) => keys.filter((key) => key !== 'description'),\n);\n\nconst tooManyValidationErrorsError = new GraphQLError(\n  'Too many validation errors, error limit reached. Validation aborted.',\n);\n\n/**\n * Implements the \"Validation\" section of the spec.\n *\n * Validation runs synchronously, returning an array of encountered errors, or\n * an empty array if no errors were encountered and the document is valid.\n *\n * A list of specific validation rules may be provided. If not provided, the\n * default list of rules defined by the GraphQL specification will be used.\n *\n * Each validation rule is a function that returns a visitor\n * (see the language/visitor API). Visitor methods are expected to return\n * GraphQLErrors, or Arrays of GraphQLErrors when invalid.\n *\n * Validate will stop validation after a `maxErrors` limit has been reached.\n * Attackers can send pathologically invalid queries to induce a DoS attack,\n * so `maxErrors` defaults to 100 errors.\n * @param schema - Schema to validate against.\n * @param documentAST - Document AST to validate.\n * @param rules - Validation rules to apply.\n * @param options - Validation options, including error limits and suggestions.\n * @returns Validation errors, or an empty array when the document is valid.\n * @example\n * ```ts\n * // Validate with the default specified rules.\n * import { parse } from 'graphql/language';\n * import { buildSchema } from 'graphql/utilities';\n * import { validate } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     fullName: String\n *   }\n * `);\n *\n * validate(schema, parse('{ greeting }')); // => []\n *\n * const errors = validate(schema, parse('{ missing }'));\n * errors[0].message; // => 'Cannot query field \"missing\" on type \"Query\".'\n * ```\n * @example\n * ```ts\n * // This variant uses a custom rule list and validation options.\n * import { parse } from 'graphql/language';\n * import { buildSchema } from 'graphql/utilities';\n * import { FieldsOnCorrectTypeRule, validate } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     greeting: String\n *   }\n * `);\n * const document = parse('{ missingOne missingTwo }');\n *\n * const errors = validate(\n *   schema,\n *   document,\n *   [FieldsOnCorrectTypeRule],\n *   { maxErrors: 1 },\n * );\n *\n * errors.length; // => 2\n * errors[1].message; // => 'Too many validation errors, error limit reached. Validation aborted.'\n *\n * const hiddenSuggestionErrors = validate(\n *   schema,\n *   parse('{ name }'),\n *   [FieldsOnCorrectTypeRule],\n *   { hideSuggestions: true },\n * );\n *\n * hiddenSuggestionErrors[0].message; // => 'Cannot query field \"name\" on type \"Query\".'\n * ```\n */\nexport function validate(\n  schema: GraphQLSchema,\n  documentAST: DocumentNode,\n  rules: ReadonlyArray<ValidationRule> = specifiedRules,\n  options?: ValidationOptions,\n): ReadonlyArray<GraphQLError> {\n  const maxErrors = options?.maxErrors ?? 100;\n  const hideSuggestions = options?.hideSuggestions ?? false;\n\n  // If the schema used for validation is invalid, throw an error.\n  assertValidSchema(schema);\n\n  const errors: Array<GraphQLError> = [];\n  const typeInfo = new TypeInfo(schema);\n  const context = new ValidationContext(\n    schema,\n    documentAST,\n    typeInfo,\n    (error) => {\n      if (errors.length >= maxErrors) {\n        throw tooManyValidationErrorsError;\n      }\n      errors.push(error);\n    },\n    hideSuggestions,\n  );\n\n  // This uses a specialized visitor which runs multiple visitors in parallel,\n  // while maintaining the visitor skip and break API.\n  const visitor = visitInParallel(rules.map((rule) => rule(context)));\n\n  // Visit the whole document with each instance of all provided rules.\n  try {\n    visit(\n      documentAST,\n      visitWithTypeInfo(typeInfo, visitor),\n      QueryDocumentKeysToValidate,\n    );\n  } catch (e: unknown) {\n    if (e === tooManyValidationErrorsError) {\n      errors.push(tooManyValidationErrorsError);\n    } else {\n      throw e;\n    }\n  }\n  return errors;\n}\n\n/** @internal */\nexport function validateSDL(\n  documentAST: DocumentNode,\n  schemaToExtend?: Maybe<GraphQLSchema>,\n  rules: ReadonlyArray<SDLValidationRule> = specifiedSDLRules,\n): ReadonlyArray<GraphQLError> {\n  const errors: Array<GraphQLError> = [];\n  const context = new SDLValidationContext(\n    documentAST,\n    schemaToExtend,\n    (error) => {\n      errors.push(error);\n    },\n  );\n\n  const visitors = rules.map((rule) => rule(context));\n  visit(documentAST, visitInParallel(visitors));\n  return errors;\n}\n\n/**\n * Utility function which asserts a SDL document is valid by throwing an error\n * if it is invalid.\n *\n * @internal\n */\nexport function assertValidSDL(documentAST: DocumentNode): void {\n  const errors = validateSDL(documentAST);\n  if (errors.length !== 0) {\n    throw new Error(errors.map((error) => error.message).join('\\n\\n'));\n  }\n}\n\n/**\n * Utility function which asserts a SDL document is valid by throwing an error\n * if it is invalid.\n *\n * @internal\n */\nexport function assertValidSDLExtension(\n  documentAST: DocumentNode,\n  schema: GraphQLSchema,\n): void {\n  const errors = validateSDL(documentAST, schema);\n  if (errors.length !== 0) {\n    throw new Error(errors.map((error) => error.message).join('\\n\\n'));\n  }\n}\n"]}

package/version.d.mts

@@ -1,10 +1,7 @@
-/**
- * A string containing the version of the GraphQL.js library
- */
+/** @category Version */
+/** A string containing the version of the GraphQL.js library */
 export declare const version: string;
-/**
- * An object containing the components of the GraphQL.js version string
- */
+/** An object containing the components of the GraphQL.js version string */
 export declare const versionInfo: Readonly<{
     major: number;
     minor: number;

package/version.d.ts

@@ -1,10 +1,7 @@
-/**
- * A string containing the version of the GraphQL.js library
- */
+/** @category Version */
+/** A string containing the version of the GraphQL.js library */
 export declare const version: string;
-/**
- * An object containing the components of the GraphQL.js version string
- */
+/** An object containing the components of the GraphQL.js version string */
 export declare const versionInfo: Readonly<{
     major: number;
     minor: number;

package/version.js

@@ -1,19 +1,11 @@
 "use strict";
-// Note: This file is autogenerated using "resources/gen-version.js" script and
-// automatically updated by "npm version" command.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.versionInfo = exports.version = void 0;
-/**
- * A string containing the version of the GraphQL.js library
- */
-exports.version = '17.0.0-beta.1';
-/**
- * An object containing the components of the GraphQL.js version string
- */
+exports.version = '17.0.0-beta.2';
 exports.versionInfo = Object.freeze({
     major: 17,
     minor: 0,
     patch: 0,
-    preReleaseTag: 'beta.1',
+    preReleaseTag: 'beta.2',
 });
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";AAAA,+EAA+E;AAC/E,kDAAkD;;;AAElD;;GAEG;AACU,QAAA,OAAO,GAAG,eAAyB,CAAC;AAEjD;;GAEG;AACU,QAAA,WAAW,GAKnB,MAAM,CAAC,MAAM,CAAC;IACjB,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;IACR,aAAa,EAAE,QAAQ;CACxB,CAAC,CAAC","sourcesContent":["// Note: This file is autogenerated using \"resources/gen-version.js\" script and\n// automatically updated by \"npm version\" command.\n\n/**\n * A string containing the version of the GraphQL.js library\n */\nexport const version = '17.0.0-beta.1' as string;\n\n/**\n * An object containing the components of the GraphQL.js version string\n */\nexport const versionInfo: Readonly<{\n  major: number;\n  minor: number;\n  patch: number;\n  preReleaseTag: string | null;\n}> = Object.freeze({\n  major: 17,\n  minor: 0,\n  patch: 0,\n  preReleaseTag: 'beta.1',\n});\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;AAMa,QAAA,OAAO,GAAG,eAAyB,CAAC;AAGpC,QAAA,WAAW,GAKnB,MAAM,CAAC,MAAM,CAAC;IACjB,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;IACR,aAAa,EAAE,QAAQ;CACxB,CAAC,CAAC","sourcesContent":["/** @category Version */\n\n// Note: This file is autogenerated using \"resources/gen-version.js\" script and\n// automatically updated by \"npm version\" command.\n\n/** A string containing the version of the GraphQL.js library */\nexport const version = '17.0.0-beta.2' as string;\n\n/** An object containing the components of the GraphQL.js version string */\nexport const versionInfo: Readonly<{\n  major: number;\n  minor: number;\n  patch: number;\n  preReleaseTag: string | null;\n}> = Object.freeze({\n  major: 17,\n  minor: 0,\n  patch: 0,\n  preReleaseTag: 'beta.2',\n});\n"]}

package/version.mjs

@@ -1,16 +1,8 @@
-// Note: This file is autogenerated using "resources/gen-version.js" script and
-// automatically updated by "npm version" command.
-/**
- * A string containing the version of the GraphQL.js library
- */
-export const version = '17.0.0-beta.1';
-/**
- * An object containing the components of the GraphQL.js version string
- */
+export const version = '17.0.0-beta.2';
 export const versionInfo = Object.freeze({
     major: 17,
     minor: 0,
     patch: 0,
-    preReleaseTag: 'beta.1',
+    preReleaseTag: 'beta.2',
 });
 //# sourceMappingURL=version.js.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAElD;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,eAAyB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAKnB,MAAM,CAAC,MAAM,CAAC;IACjB,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;IACR,aAAa,EAAE,QAAQ;CACxB,CAAC,CAAC","sourcesContent":["// Note: This file is autogenerated using \"resources/gen-version.js\" script and\n// automatically updated by \"npm version\" command.\n\n/**\n * A string containing the version of the GraphQL.js library\n */\nexport const version = '17.0.0-beta.1' as string;\n\n/**\n * An object containing the components of the GraphQL.js version string\n */\nexport const versionInfo: Readonly<{\n  major: number;\n  minor: number;\n  patch: number;\n  preReleaseTag: string | null;\n}> = Object.freeze({\n  major: 17,\n  minor: 0,\n  patch: 0,\n  preReleaseTag: 'beta.1',\n});\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,OAAO,GAAG,eAAyB,CAAC;AAGjD,MAAM,CAAC,MAAM,WAAW,GAKnB,MAAM,CAAC,MAAM,CAAC;IACjB,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;IACR,aAAa,EAAE,QAAQ;CACxB,CAAC,CAAC","sourcesContent":["/** @category Version */\n\n// Note: This file is autogenerated using \"resources/gen-version.js\" script and\n// automatically updated by \"npm version\" command.\n\n/** A string containing the version of the GraphQL.js library */\nexport const version = '17.0.0-beta.2' as string;\n\n/** An object containing the components of the GraphQL.js version string */\nexport const versionInfo: Readonly<{\n  major: number;\n  minor: number;\n  patch: number;\n  preReleaseTag: string | null;\n}> = Object.freeze({\n  major: 17,\n  minor: 0,\n  patch: 0,\n  preReleaseTag: 'beta.2',\n});\n"]}