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

package/validation/rules/DeferStreamDirectiveLabelRule.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"DeferStreamDirectiveLabelRule.js","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveLabelRule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAG3D,OAAO,EAAE,IAAI,EAAE,iCAAgC;AAG/C,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,kCAAiC;AAIlC;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAC3C,OAA0B;IAE1B,MAAM,WAAW,GAAG,IAAI,GAAG,EAAyB,CAAC;IACrD,OAAO;QACL,SAAS,CAAC,IAAI;YACZ,IACE,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,qBAAqB,CAAC,IAAI;gBAC9C,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sBAAsB,CAAC,IAAI,EAC/C,CAAC;gBACD,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CACxC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,OAAO,CACpC,CAAC;gBACF,MAAM,UAAU,GAAG,aAAa,EAAE,KAAK,CAAC;gBACxC,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;oBACjD,OAAO;gBACT,CAAC;gBACD,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;oBACpC,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,cAAc,IAAI,CAAC,IAAI,CAAC,KAAK,oCAAoC,EACjE,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;oBACF,OAAO;gBACT,CAAC;gBAED,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACrD,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;oBACvB,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,mHAAmH,EACnH,EAAE,KAAK,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAC9B,CACF,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { DirectiveNode } from '../../language/ast.ts';\nimport { Kind } from '../../language/kinds.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport {\n  GraphQLDeferDirective,\n  GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Defer and stream directive labels are unique\n *\n * A GraphQL document is only valid if defer and stream directives' label argument is static and unique.\n */\nexport function DeferStreamDirectiveLabelRule(\n  context: ValidationContext,\n): ASTVisitor {\n  const knownLabels = new Map<string, DirectiveNode>();\n  return {\n    Directive(node) {\n      if (\n        node.name.value === GraphQLDeferDirective.name ||\n        node.name.value === GraphQLStreamDirective.name\n      ) {\n        const labelArgument = node.arguments?.find(\n          (arg) => arg.name.value === 'label',\n        );\n        const labelValue = labelArgument?.value;\n        if (!labelValue || labelValue.kind === Kind.NULL) {\n          return;\n        }\n        if (labelValue.kind !== Kind.STRING) {\n          context.reportError(\n            new GraphQLError(\n              `Argument \"@${node.name.value}(label:)\" must be a static string.`,\n              { nodes: node },\n            ),\n          );\n          return;\n        }\n\n        const knownLabel = knownLabels.get(labelValue.value);\n        if (knownLabel != null) {\n          context.reportError(\n            new GraphQLError(\n              'Value for arguments \"defer(label:)\" and \"stream(label:)\" must be unique across all Defer/Stream directive usages.',\n              { nodes: [knownLabel, node] },\n            ),\n          );\n        } else {\n          knownLabels.set(labelValue.value, node);\n        }\n      }\n    },\n  };\n}\n"]}
+{"version":3,"file":"DeferStreamDirectiveLabelRule.js","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveLabelRule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAG3D,OAAO,EAAE,IAAI,EAAE,iCAAgC;AAG/C,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,kCAAiC;AAsClC,MAAM,UAAU,6BAA6B,CAC3C,OAA0B;IAE1B,MAAM,WAAW,GAAG,IAAI,GAAG,EAAyB,CAAC;IACrD,OAAO;QACL,SAAS,CAAC,IAAI;YACZ,IACE,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,qBAAqB,CAAC,IAAI;gBAC9C,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sBAAsB,CAAC,IAAI,EAC/C,CAAC;gBACD,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CACxC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,OAAO,CACpC,CAAC;gBACF,MAAM,UAAU,GAAG,aAAa,EAAE,KAAK,CAAC;gBACxC,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;oBACjD,OAAO;gBACT,CAAC;gBACD,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;oBACpC,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,cAAc,IAAI,CAAC,IAAI,CAAC,KAAK,oCAAoC,EACjE,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;oBACF,OAAO;gBACT,CAAC;gBAED,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACrD,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;oBACvB,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,mHAAmH,EACnH,EAAE,KAAK,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAC9B,CACF,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { DirectiveNode } from '../../language/ast.ts';\nimport { Kind } from '../../language/kinds.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport {\n  GraphQLDeferDirective,\n  GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Defer and stream directive labels are unique\n *\n * A GraphQL document is only valid if defer and stream directives' label argument is static and unique.\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 { parse } from 'graphql/language';\n * import { buildSchema } from 'graphql/utilities';\n * import { validate, DeferStreamDirectiveLabelRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     friends: [String]\n *   }\n * `);\n * const invalidDocument = parse(`\n *   {\n *     friends @stream(label: \"friends\")\n *     other: friends @stream(label: \"friends\")\n *   }\n * `);\n * const validDocument = parse(`\n *   {\n *     friends @stream(label: \"friends\")\n *     other: friends @stream(label: \"otherFriends\")\n *   }\n * `);\n *\n * validate(schema, invalidDocument, [DeferStreamDirectiveLabelRule]).length; // => 1\n * validate(schema, validDocument, [DeferStreamDirectiveLabelRule]); // => []\n * ```\n */\nexport function DeferStreamDirectiveLabelRule(\n  context: ValidationContext,\n): ASTVisitor {\n  const knownLabels = new Map<string, DirectiveNode>();\n  return {\n    Directive(node) {\n      if (\n        node.name.value === GraphQLDeferDirective.name ||\n        node.name.value === GraphQLStreamDirective.name\n      ) {\n        const labelArgument = node.arguments?.find(\n          (arg) => arg.name.value === 'label',\n        );\n        const labelValue = labelArgument?.value;\n        if (!labelValue || labelValue.kind === Kind.NULL) {\n          return;\n        }\n        if (labelValue.kind !== Kind.STRING) {\n          context.reportError(\n            new GraphQLError(\n              `Argument \"@${node.name.value}(label:)\" must be a static string.`,\n              { nodes: node },\n            ),\n          );\n          return;\n        }\n\n        const knownLabel = knownLabels.get(labelValue.value);\n        if (knownLabel != null) {\n          context.reportError(\n            new GraphQLError(\n              'Value for arguments \"defer(label:)\" and \"stream(label:)\" must be unique across all Defer/Stream directive usages.',\n              { nodes: [knownLabel, node] },\n            ),\n          );\n        } else {\n          knownLabels.set(labelValue.value, node);\n        }\n      }\n    },\n  };\n}\n"]}

package/validation/rules/DeferStreamDirectiveOnRootFieldRule.d.mts

@@ -1,8 +1,36 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.mjs";
 import type { ValidationContext } from "../ValidationContext.mjs";
 /**
  * Defer and stream directives are used on valid root field
  *
  * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.
+ * @param context - The validation context used while checking the document.
+ * @returns A visitor that reports validation errors for this rule.
+ * @example
+ * ```ts
+ * import { parse } from 'graphql/language';
+ * import { buildSchema } from 'graphql/utilities';
+ * import { validate, DeferStreamDirectiveOnRootFieldRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     message: String
+ *   }
+ *
+ *   type Mutation {
+ *     updateMessage: String
+ *   }
+ * `);
+ * const invalidDocument = parse(`
+ *   mutation { ... @defer { updateMessage } }
+ * `);
+ * const validDocument = parse(`
+ *   { ... @defer { message } }
+ * `);
+ *
+ * validate(schema, invalidDocument, [DeferStreamDirectiveOnRootFieldRule]).length; // => 1
+ * validate(schema, validDocument, [DeferStreamDirectiveOnRootFieldRule]); // => []
+ * ```
  */
 export declare function DeferStreamDirectiveOnRootFieldRule(context: ValidationContext): ASTVisitor;

package/validation/rules/DeferStreamDirectiveOnRootFieldRule.d.ts

@@ -1,8 +1,36 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.js";
 import type { ValidationContext } from "../ValidationContext.js";
 /**
  * Defer and stream directives are used on valid root field
  *
  * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.
+ * @param context - The validation context used while checking the document.
+ * @returns A visitor that reports validation errors for this rule.
+ * @example
+ * ```ts
+ * import { parse } from 'graphql/language';
+ * import { buildSchema } from 'graphql/utilities';
+ * import { validate, DeferStreamDirectiveOnRootFieldRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     message: String
+ *   }
+ *
+ *   type Mutation {
+ *     updateMessage: String
+ *   }
+ * `);
+ * const invalidDocument = parse(`
+ *   mutation { ... @defer { updateMessage } }
+ * `);
+ * const validDocument = parse(`
+ *   { ... @defer { message } }
+ * `);
+ *
+ * validate(schema, invalidDocument, [DeferStreamDirectiveOnRootFieldRule]).length; // => 1
+ * validate(schema, validDocument, [DeferStreamDirectiveOnRootFieldRule]); // => []
+ * ```
  */
 export declare function DeferStreamDirectiveOnRootFieldRule(context: ValidationContext): ASTVisitor;

package/validation/rules/DeferStreamDirectiveOnRootFieldRule.js

@@ -3,11 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeferStreamDirectiveOnRootFieldRule = DeferStreamDirectiveOnRootFieldRule;
 const GraphQLError_ts_1 = require("../../error/GraphQLError.js");
 const directives_ts_1 = require("../../type/directives.js");
-/**
- * Defer and stream directives are used on valid root field
- *
- * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.
- */
 function DeferStreamDirectiveOnRootFieldRule(context) {
     return {
         Directive(node) {

package/validation/rules/DeferStreamDirectiveOnRootFieldRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeferStreamDirectiveOnRootFieldRule.js","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveOnRootFieldRule.ts"],"names":[],"mappings":";;AAgBA,kFA8CC;AA9DD,iEAA2D;AAI3D,4DAGkC;AAIlC;;;;GAIG;AACH,SAAgB,mCAAmC,CACjD,OAA0B;IAE1B,OAAO;QACL,SAAS,CAAC,IAAI;YACZ,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,eAAe,EAAE,CAAC;YAC3D,MAAM,gBAAgB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,mBAAmB,EAAE,CAAC;YACnE,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3C,IAAI,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,qCAAqB,CAAC,IAAI,EAAE,CAAC;gBACjE,IAAI,YAAY,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;oBAChD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,yDAAyD,UAAU,IAAI,EACvE,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,gBAAgB,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;oBACxD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,6DAA6D,UAAU,IAAI,EAC3E,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,IAAI,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sCAAsB,CAAC,IAAI,EAAE,CAAC;gBAClE,IAAI,YAAY,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;oBAChD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,0DAA0D,UAAU,IAAI,EACxE,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,gBAAgB,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;oBACxD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,8DAA8D,UAAU,IAAI,EAC5E,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport {\n  GraphQLDeferDirective,\n  GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Defer and stream directives are used on valid root field\n *\n * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.\n */\nexport function DeferStreamDirectiveOnRootFieldRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    Directive(node) {\n      const mutationType = context.getSchema().getMutationType();\n      const subscriptionType = context.getSchema().getSubscriptionType();\n      const parentType = context.getParentType();\n      if (parentType && node.name.value === GraphQLDeferDirective.name) {\n        if (mutationType && parentType === mutationType) {\n          context.reportError(\n            new GraphQLError(\n              `Defer directive cannot be used on root mutation type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n        if (subscriptionType && parentType === subscriptionType) {\n          context.reportError(\n            new GraphQLError(\n              `Defer directive cannot be used on root subscription type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n      if (parentType && node.name.value === GraphQLStreamDirective.name) {\n        if (mutationType && parentType === mutationType) {\n          context.reportError(\n            new GraphQLError(\n              `Stream directive cannot be used on root mutation type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n        if (subscriptionType && parentType === subscriptionType) {\n          context.reportError(\n            new GraphQLError(\n              `Stream directive cannot be used on root subscription type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n    },\n  };\n}\n"]}
+{"version":3,"file":"DeferStreamDirectiveOnRootFieldRule.js","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveOnRootFieldRule.ts"],"names":[],"mappings":";;AA6CA,kFA8CC;AAzFD,iEAA2D;AAI3D,4DAGkC;AAoClC,SAAgB,mCAAmC,CACjD,OAA0B;IAE1B,OAAO;QACL,SAAS,CAAC,IAAI;YACZ,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,eAAe,EAAE,CAAC;YAC3D,MAAM,gBAAgB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,mBAAmB,EAAE,CAAC;YACnE,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3C,IAAI,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,qCAAqB,CAAC,IAAI,EAAE,CAAC;gBACjE,IAAI,YAAY,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;oBAChD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,yDAAyD,UAAU,IAAI,EACvE,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,gBAAgB,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;oBACxD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,6DAA6D,UAAU,IAAI,EAC3E,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,IAAI,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sCAAsB,CAAC,IAAI,EAAE,CAAC;gBAClE,IAAI,YAAY,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;oBAChD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,0DAA0D,UAAU,IAAI,EACxE,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,gBAAgB,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;oBACxD,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,8DAA8D,UAAU,IAAI,EAC5E,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport {\n  GraphQLDeferDirective,\n  GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Defer and stream directives are used on valid root field\n *\n * A GraphQL document is only valid if defer directives are not used on root mutation or subscription 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 { parse } from 'graphql/language';\n * import { buildSchema } from 'graphql/utilities';\n * import { validate, DeferStreamDirectiveOnRootFieldRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     message: String\n *   }\n *\n *   type Mutation {\n *     updateMessage: String\n *   }\n * `);\n * const invalidDocument = parse(`\n *   mutation { ... @defer { updateMessage } }\n * `);\n * const validDocument = parse(`\n *   { ... @defer { message } }\n * `);\n *\n * validate(schema, invalidDocument, [DeferStreamDirectiveOnRootFieldRule]).length; // => 1\n * validate(schema, validDocument, [DeferStreamDirectiveOnRootFieldRule]); // => []\n * ```\n */\nexport function DeferStreamDirectiveOnRootFieldRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    Directive(node) {\n      const mutationType = context.getSchema().getMutationType();\n      const subscriptionType = context.getSchema().getSubscriptionType();\n      const parentType = context.getParentType();\n      if (parentType && node.name.value === GraphQLDeferDirective.name) {\n        if (mutationType && parentType === mutationType) {\n          context.reportError(\n            new GraphQLError(\n              `Defer directive cannot be used on root mutation type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n        if (subscriptionType && parentType === subscriptionType) {\n          context.reportError(\n            new GraphQLError(\n              `Defer directive cannot be used on root subscription type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n      if (parentType && node.name.value === GraphQLStreamDirective.name) {\n        if (mutationType && parentType === mutationType) {\n          context.reportError(\n            new GraphQLError(\n              `Stream directive cannot be used on root mutation type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n        if (subscriptionType && parentType === subscriptionType) {\n          context.reportError(\n            new GraphQLError(\n              `Stream directive cannot be used on root subscription type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n    },\n  };\n}\n"]}

package/validation/rules/DeferStreamDirectiveOnRootFieldRule.mjs

@@ -1,10 +1,5 @@
 import { GraphQLError } from "../../error/GraphQLError.mjs";
 import { GraphQLDeferDirective, GraphQLStreamDirective, } from "../../type/directives.mjs";
-/**
- * Defer and stream directives are used on valid root field
- *
- * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.
- */
 export function DeferStreamDirectiveOnRootFieldRule(context) {
     return {
         Directive(node) {

package/validation/rules/DeferStreamDirectiveOnRootFieldRule.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"DeferStreamDirectiveOnRootFieldRule.js","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveOnRootFieldRule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAI3D,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,kCAAiC;AAIlC;;;;GAIG;AACH,MAAM,UAAU,mCAAmC,CACjD,OAA0B;IAE1B,OAAO;QACL,SAAS,CAAC,IAAI;YACZ,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,eAAe,EAAE,CAAC;YAC3D,MAAM,gBAAgB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,mBAAmB,EAAE,CAAC;YACnE,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3C,IAAI,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,qBAAqB,CAAC,IAAI,EAAE,CAAC;gBACjE,IAAI,YAAY,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;oBAChD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,yDAAyD,UAAU,IAAI,EACvE,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,gBAAgB,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;oBACxD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,6DAA6D,UAAU,IAAI,EAC3E,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,IAAI,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sBAAsB,CAAC,IAAI,EAAE,CAAC;gBAClE,IAAI,YAAY,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;oBAChD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,0DAA0D,UAAU,IAAI,EACxE,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,gBAAgB,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;oBACxD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,8DAA8D,UAAU,IAAI,EAC5E,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport {\n  GraphQLDeferDirective,\n  GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Defer and stream directives are used on valid root field\n *\n * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.\n */\nexport function DeferStreamDirectiveOnRootFieldRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    Directive(node) {\n      const mutationType = context.getSchema().getMutationType();\n      const subscriptionType = context.getSchema().getSubscriptionType();\n      const parentType = context.getParentType();\n      if (parentType && node.name.value === GraphQLDeferDirective.name) {\n        if (mutationType && parentType === mutationType) {\n          context.reportError(\n            new GraphQLError(\n              `Defer directive cannot be used on root mutation type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n        if (subscriptionType && parentType === subscriptionType) {\n          context.reportError(\n            new GraphQLError(\n              `Defer directive cannot be used on root subscription type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n      if (parentType && node.name.value === GraphQLStreamDirective.name) {\n        if (mutationType && parentType === mutationType) {\n          context.reportError(\n            new GraphQLError(\n              `Stream directive cannot be used on root mutation type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n        if (subscriptionType && parentType === subscriptionType) {\n          context.reportError(\n            new GraphQLError(\n              `Stream directive cannot be used on root subscription type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n    },\n  };\n}\n"]}
+{"version":3,"file":"DeferStreamDirectiveOnRootFieldRule.js","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveOnRootFieldRule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAI3D,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,kCAAiC;AAoClC,MAAM,UAAU,mCAAmC,CACjD,OAA0B;IAE1B,OAAO;QACL,SAAS,CAAC,IAAI;YACZ,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,eAAe,EAAE,CAAC;YAC3D,MAAM,gBAAgB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,mBAAmB,EAAE,CAAC;YACnE,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3C,IAAI,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,qBAAqB,CAAC,IAAI,EAAE,CAAC;gBACjE,IAAI,YAAY,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;oBAChD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,yDAAyD,UAAU,IAAI,EACvE,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,gBAAgB,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;oBACxD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,6DAA6D,UAAU,IAAI,EAC3E,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,IAAI,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sBAAsB,CAAC,IAAI,EAAE,CAAC;gBAClE,IAAI,YAAY,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;oBAChD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,0DAA0D,UAAU,IAAI,EACxE,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,gBAAgB,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;oBACxD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,8DAA8D,UAAU,IAAI,EAC5E,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport {\n  GraphQLDeferDirective,\n  GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Defer and stream directives are used on valid root field\n *\n * A GraphQL document is only valid if defer directives are not used on root mutation or subscription 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 { parse } from 'graphql/language';\n * import { buildSchema } from 'graphql/utilities';\n * import { validate, DeferStreamDirectiveOnRootFieldRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     message: String\n *   }\n *\n *   type Mutation {\n *     updateMessage: String\n *   }\n * `);\n * const invalidDocument = parse(`\n *   mutation { ... @defer { updateMessage } }\n * `);\n * const validDocument = parse(`\n *   { ... @defer { message } }\n * `);\n *\n * validate(schema, invalidDocument, [DeferStreamDirectiveOnRootFieldRule]).length; // => 1\n * validate(schema, validDocument, [DeferStreamDirectiveOnRootFieldRule]); // => []\n * ```\n */\nexport function DeferStreamDirectiveOnRootFieldRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    Directive(node) {\n      const mutationType = context.getSchema().getMutationType();\n      const subscriptionType = context.getSchema().getSubscriptionType();\n      const parentType = context.getParentType();\n      if (parentType && node.name.value === GraphQLDeferDirective.name) {\n        if (mutationType && parentType === mutationType) {\n          context.reportError(\n            new GraphQLError(\n              `Defer directive cannot be used on root mutation type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n        if (subscriptionType && parentType === subscriptionType) {\n          context.reportError(\n            new GraphQLError(\n              `Defer directive cannot be used on root subscription type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n      if (parentType && node.name.value === GraphQLStreamDirective.name) {\n        if (mutationType && parentType === mutationType) {\n          context.reportError(\n            new GraphQLError(\n              `Stream directive cannot be used on root mutation type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n        if (subscriptionType && parentType === subscriptionType) {\n          context.reportError(\n            new GraphQLError(\n              `Stream directive cannot be used on root subscription type \"${parentType}\".`,\n              { nodes: node },\n            ),\n          );\n        }\n      }\n    },\n  };\n}\n"]}

package/validation/rules/DeferStreamDirectiveOnValidOperationsRule.d.mts

@@ -1,8 +1,60 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.mjs";
 import type { ValidationContext } from "../ValidationContext.mjs";
 /**
  * Defer And Stream Directives Are Used On Valid Operations
  *
  * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.
+ * @param context - The validation context used while checking the document.
+ * @returns A visitor that reports validation errors for this rule.
+ * @example
+ * ```ts
+ * import { parse } from 'graphql/language';
+ * import { buildSchema } from 'graphql/utilities';
+ * import {
+ *   validate,
+ *   DeferStreamDirectiveOnValidOperationsRule,
+ * } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     message: Message
+ *   }
+ *
+ *   type Subscription {
+ *     message: Message
+ *   }
+ *
+ *   type Message {
+ *     body: String
+ *   }
+ * `);
+ * const invalidDocument = parse(`
+ *   subscription {
+ *     message {
+ *       ...MessageBody @defer
+ *     }
+ *   }
+ *
+ *   fragment MessageBody on Message {
+ *     body
+ *   }
+ * `);
+ * const validDocument = parse(`
+ *   subscription {
+ *     message {
+ *       ...MessageBody @defer(if: false)
+ *     }
+ *   }
+ *
+ *   fragment MessageBody on Message {
+ *     body
+ *   }
+ * `);
+ *
+ * validate(schema, invalidDocument, [DeferStreamDirectiveOnValidOperationsRule])
+ *   .length; // => 1
+ * validate(schema, validDocument, [DeferStreamDirectiveOnValidOperationsRule]); // => []
+ * ```
  */
 export declare function DeferStreamDirectiveOnValidOperationsRule(context: ValidationContext): ASTVisitor;

package/validation/rules/DeferStreamDirectiveOnValidOperationsRule.d.ts

@@ -1,8 +1,60 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.js";
 import type { ValidationContext } from "../ValidationContext.js";
 /**
  * Defer And Stream Directives Are Used On Valid Operations
  *
  * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.
+ * @param context - The validation context used while checking the document.
+ * @returns A visitor that reports validation errors for this rule.
+ * @example
+ * ```ts
+ * import { parse } from 'graphql/language';
+ * import { buildSchema } from 'graphql/utilities';
+ * import {
+ *   validate,
+ *   DeferStreamDirectiveOnValidOperationsRule,
+ * } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     message: Message
+ *   }
+ *
+ *   type Subscription {
+ *     message: Message
+ *   }
+ *
+ *   type Message {
+ *     body: String
+ *   }
+ * `);
+ * const invalidDocument = parse(`
+ *   subscription {
+ *     message {
+ *       ...MessageBody @defer
+ *     }
+ *   }
+ *
+ *   fragment MessageBody on Message {
+ *     body
+ *   }
+ * `);
+ * const validDocument = parse(`
+ *   subscription {
+ *     message {
+ *       ...MessageBody @defer(if: false)
+ *     }
+ *   }
+ *
+ *   fragment MessageBody on Message {
+ *     body
+ *   }
+ * `);
+ *
+ * validate(schema, invalidDocument, [DeferStreamDirectiveOnValidOperationsRule])
+ *   .length; // => 1
+ * validate(schema, validDocument, [DeferStreamDirectiveOnValidOperationsRule]); // => []
+ * ```
  */
 export declare function DeferStreamDirectiveOnValidOperationsRule(context: ValidationContext): ASTVisitor;

package/validation/rules/DeferStreamDirectiveOnValidOperationsRule.js

@@ -20,11 +20,6 @@ function ifArgumentCanBeFalse(node) {
     }
     return true;
 }
-/**
- * Defer And Stream Directives Are Used On Valid Operations
- *
- * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.
- */
 function DeferStreamDirectiveOnValidOperationsRule(context) {
     const fragmentsUsedOnSubscriptions = new Set();
     return {

package/validation/rules/DeferStreamDirectiveOnValidOperationsRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeferStreamDirectiveOnValidOperationsRule.js","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveOnValidOperationsRule.ts"],"names":[],"mappings":";;AAkCA,8FA+CC;AAjFD,iEAA2D;AAG3D,kDAA0D;AAC1D,sDAA+C;AAG/C,4DAGkC;AAIlC,SAAS,oBAAoB,CAAC,IAAmB;IAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;IAC1E,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,eAAI,CAAC,OAAO,EAAE,CAAC;QAC3C,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;SAAM,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,eAAI,CAAC,QAAQ,EAAE,CAAC;QACnD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,SAAgB,yCAAyC,CACvD,OAA0B;IAE1B,MAAM,4BAA4B,GAAG,IAAI,GAAG,EAAU,CAAC;IAEvD,OAAO;QACL,mBAAmB,CAAC,SAAS;YAC3B,IAAI,SAAS,CAAC,SAAS,KAAK,0BAAiB,CAAC,YAAY,EAAE,CAAC;gBAC3D,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,iCAAiC,CAC9D,SAAS,CACV,EAAE,CAAC;oBACF,4BAA4B,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxD,CAAC;YACH,CAAC;QACH,CAAC;QACD,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS;YAC7C,MAAM,cAAc,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAEpC,IACE,MAAM,IAAI,cAAc;gBACxB,CAAC,CAAC,cAAc,CAAC,IAAI,KAAK,eAAI,CAAC,mBAAmB;oBAChD,4BAA4B,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC5D,CAAC,cAAc,CAAC,IAAI,KAAK,eAAI,CAAC,oBAAoB;wBAChD,cAAc,CAAC,SAAS,KAAK,0BAAiB,CAAC,YAAY,CAAC,CAAC,EACjE,CAAC;gBACD,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,qCAAqB,CAAC,IAAI,EAAE,CAAC;oBACnD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChC,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,qHAAqH,EACrH,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;qBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sCAAsB,CAAC,IAAI,EAAE,CAAC;oBAC3D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChC,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,uHAAuH,EACvH,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { DirectiveNode } from '../../language/ast.ts';\nimport { OperationTypeNode } from '../../language/ast.ts';\nimport { Kind } from '../../language/kinds.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport {\n  GraphQLDeferDirective,\n  GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\nfunction ifArgumentCanBeFalse(node: DirectiveNode): boolean {\n  const ifArgument = node.arguments?.find((arg) => arg.name.value === 'if');\n  if (!ifArgument) {\n    return false;\n  }\n  if (ifArgument.value.kind === Kind.BOOLEAN) {\n    if (ifArgument.value.value) {\n      return false;\n    }\n  } else if (ifArgument.value.kind !== Kind.VARIABLE) {\n    return false;\n  }\n  return true;\n}\n\n/**\n * Defer And Stream Directives Are Used On Valid Operations\n *\n * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.\n */\nexport function DeferStreamDirectiveOnValidOperationsRule(\n  context: ValidationContext,\n): ASTVisitor {\n  const fragmentsUsedOnSubscriptions = new Set<string>();\n\n  return {\n    OperationDefinition(operation) {\n      if (operation.operation === OperationTypeNode.SUBSCRIPTION) {\n        for (const fragment of context.getRecursivelyReferencedFragments(\n          operation,\n        )) {\n          fragmentsUsedOnSubscriptions.add(fragment.name.value);\n        }\n      }\n    },\n    Directive(node, _key, _parent, _path, ancestors) {\n      const definitionNode = ancestors[2];\n\n      if (\n        'kind' in definitionNode &&\n        ((definitionNode.kind === Kind.FRAGMENT_DEFINITION &&\n          fragmentsUsedOnSubscriptions.has(definitionNode.name.value)) ||\n          (definitionNode.kind === Kind.OPERATION_DEFINITION &&\n            definitionNode.operation === OperationTypeNode.SUBSCRIPTION))\n      ) {\n        if (node.name.value === GraphQLDeferDirective.name) {\n          if (!ifArgumentCanBeFalse(node)) {\n            context.reportError(\n              new GraphQLError(\n                'Defer directive not supported on subscription operations. Disable `@defer` by setting the `if` argument to `false`.',\n                { nodes: node },\n              ),\n            );\n          }\n        } else if (node.name.value === GraphQLStreamDirective.name) {\n          if (!ifArgumentCanBeFalse(node)) {\n            context.reportError(\n              new GraphQLError(\n                'Stream directive not supported on subscription operations. Disable `@stream` by setting the `if` argument to `false`.',\n                { nodes: node },\n              ),\n            );\n          }\n        }\n      }\n    },\n  };\n}\n"]}
+{"version":3,"file":"DeferStreamDirectiveOnValidOperationsRule.js","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveOnValidOperationsRule.ts"],"names":[],"mappings":";;AAuFA,8FA+CC;AApID,iEAA2D;AAG3D,kDAA0D;AAC1D,sDAA+C;AAG/C,4DAGkC;AAIlC,SAAS,oBAAoB,CAAC,IAAmB;IAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;IAC1E,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,eAAI,CAAC,OAAO,EAAE,CAAC;QAC3C,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;SAAM,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,eAAI,CAAC,QAAQ,EAAE,CAAC;QACnD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AA0DD,SAAgB,yCAAyC,CACvD,OAA0B;IAE1B,MAAM,4BAA4B,GAAG,IAAI,GAAG,EAAU,CAAC;IAEvD,OAAO;QACL,mBAAmB,CAAC,SAAS;YAC3B,IAAI,SAAS,CAAC,SAAS,KAAK,0BAAiB,CAAC,YAAY,EAAE,CAAC;gBAC3D,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,iCAAiC,CAC9D,SAAS,CACV,EAAE,CAAC;oBACF,4BAA4B,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxD,CAAC;YACH,CAAC;QACH,CAAC;QACD,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS;YAC7C,MAAM,cAAc,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAEpC,IACE,MAAM,IAAI,cAAc;gBACxB,CAAC,CAAC,cAAc,CAAC,IAAI,KAAK,eAAI,CAAC,mBAAmB;oBAChD,4BAA4B,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC5D,CAAC,cAAc,CAAC,IAAI,KAAK,eAAI,CAAC,oBAAoB;wBAChD,cAAc,CAAC,SAAS,KAAK,0BAAiB,CAAC,YAAY,CAAC,CAAC,EACjE,CAAC;gBACD,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,qCAAqB,CAAC,IAAI,EAAE,CAAC;oBACnD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChC,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,qHAAqH,EACrH,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;qBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sCAAsB,CAAC,IAAI,EAAE,CAAC;oBAC3D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChC,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CACd,uHAAuH,EACvH,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { DirectiveNode } from '../../language/ast.ts';\nimport { OperationTypeNode } from '../../language/ast.ts';\nimport { Kind } from '../../language/kinds.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport {\n  GraphQLDeferDirective,\n  GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\nfunction ifArgumentCanBeFalse(node: DirectiveNode): boolean {\n  const ifArgument = node.arguments?.find((arg) => arg.name.value === 'if');\n  if (!ifArgument) {\n    return false;\n  }\n  if (ifArgument.value.kind === Kind.BOOLEAN) {\n    if (ifArgument.value.value) {\n      return false;\n    }\n  } else if (ifArgument.value.kind !== Kind.VARIABLE) {\n    return false;\n  }\n  return true;\n}\n\n/**\n * Defer And Stream Directives Are Used On Valid Operations\n *\n * A GraphQL document is only valid if defer directives are not used on root mutation or subscription 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 { parse } from 'graphql/language';\n * import { buildSchema } from 'graphql/utilities';\n * import {\n *   validate,\n *   DeferStreamDirectiveOnValidOperationsRule,\n * } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     message: Message\n *   }\n *\n *   type Subscription {\n *     message: Message\n *   }\n *\n *   type Message {\n *     body: String\n *   }\n * `);\n * const invalidDocument = parse(`\n *   subscription {\n *     message {\n *       ...MessageBody @defer\n *     }\n *   }\n *\n *   fragment MessageBody on Message {\n *     body\n *   }\n * `);\n * const validDocument = parse(`\n *   subscription {\n *     message {\n *       ...MessageBody @defer(if: false)\n *     }\n *   }\n *\n *   fragment MessageBody on Message {\n *     body\n *   }\n * `);\n *\n * validate(schema, invalidDocument, [DeferStreamDirectiveOnValidOperationsRule])\n *   .length; // => 1\n * validate(schema, validDocument, [DeferStreamDirectiveOnValidOperationsRule]); // => []\n * ```\n */\nexport function DeferStreamDirectiveOnValidOperationsRule(\n  context: ValidationContext,\n): ASTVisitor {\n  const fragmentsUsedOnSubscriptions = new Set<string>();\n\n  return {\n    OperationDefinition(operation) {\n      if (operation.operation === OperationTypeNode.SUBSCRIPTION) {\n        for (const fragment of context.getRecursivelyReferencedFragments(\n          operation,\n        )) {\n          fragmentsUsedOnSubscriptions.add(fragment.name.value);\n        }\n      }\n    },\n    Directive(node, _key, _parent, _path, ancestors) {\n      const definitionNode = ancestors[2];\n\n      if (\n        'kind' in definitionNode &&\n        ((definitionNode.kind === Kind.FRAGMENT_DEFINITION &&\n          fragmentsUsedOnSubscriptions.has(definitionNode.name.value)) ||\n          (definitionNode.kind === Kind.OPERATION_DEFINITION &&\n            definitionNode.operation === OperationTypeNode.SUBSCRIPTION))\n      ) {\n        if (node.name.value === GraphQLDeferDirective.name) {\n          if (!ifArgumentCanBeFalse(node)) {\n            context.reportError(\n              new GraphQLError(\n                'Defer directive not supported on subscription operations. Disable `@defer` by setting the `if` argument to `false`.',\n                { nodes: node },\n              ),\n            );\n          }\n        } else if (node.name.value === GraphQLStreamDirective.name) {\n          if (!ifArgumentCanBeFalse(node)) {\n            context.reportError(\n              new GraphQLError(\n                'Stream directive not supported on subscription operations. Disable `@stream` by setting the `if` argument to `false`.',\n                { nodes: node },\n              ),\n            );\n          }\n        }\n      }\n    },\n  };\n}\n"]}

package/validation/rules/DeferStreamDirectiveOnValidOperationsRule.mjs

@@ -17,11 +17,6 @@ function ifArgumentCanBeFalse(node) {
     }
     return true;
 }
-/**
- * Defer And Stream Directives Are Used On Valid Operations
- *
- * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.
- */
 export function DeferStreamDirectiveOnValidOperationsRule(context) {
     const fragmentsUsedOnSubscriptions = new Set();
     return {

package/validation/rules/DeferStreamDirectiveOnValidOperationsRule.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"DeferStreamDirectiveOnValidOperationsRule.js","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveOnValidOperationsRule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAG3D,OAAO,EAAE,iBAAiB,EAAE,+BAA8B;AAC1D,OAAO,EAAE,IAAI,EAAE,iCAAgC;AAG/C,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,kCAAiC;AAIlC,SAAS,oBAAoB,CAAC,IAAmB;IAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;IAC1E,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3C,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;SAAM,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;QACnD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yCAAyC,CACvD,OAA0B;IAE1B,MAAM,4BAA4B,GAAG,IAAI,GAAG,EAAU,CAAC;IAEvD,OAAO;QACL,mBAAmB,CAAC,SAAS;YAC3B,IAAI,SAAS,CAAC,SAAS,KAAK,iBAAiB,CAAC,YAAY,EAAE,CAAC;gBAC3D,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,iCAAiC,CAC9D,SAAS,CACV,EAAE,CAAC;oBACF,4BAA4B,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxD,CAAC;YACH,CAAC;QACH,CAAC;QACD,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS;YAC7C,MAAM,cAAc,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAEpC,IACE,MAAM,IAAI,cAAc;gBACxB,CAAC,CAAC,cAAc,CAAC,IAAI,KAAK,IAAI,CAAC,mBAAmB;oBAChD,4BAA4B,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC5D,CAAC,cAAc,CAAC,IAAI,KAAK,IAAI,CAAC,oBAAoB;wBAChD,cAAc,CAAC,SAAS,KAAK,iBAAiB,CAAC,YAAY,CAAC,CAAC,EACjE,CAAC;gBACD,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,qBAAqB,CAAC,IAAI,EAAE,CAAC;oBACnD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChC,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,qHAAqH,EACrH,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;qBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sBAAsB,CAAC,IAAI,EAAE,CAAC;oBAC3D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChC,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,uHAAuH,EACvH,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { DirectiveNode } from '../../language/ast.ts';\nimport { OperationTypeNode } from '../../language/ast.ts';\nimport { Kind } from '../../language/kinds.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport {\n  GraphQLDeferDirective,\n  GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\nfunction ifArgumentCanBeFalse(node: DirectiveNode): boolean {\n  const ifArgument = node.arguments?.find((arg) => arg.name.value === 'if');\n  if (!ifArgument) {\n    return false;\n  }\n  if (ifArgument.value.kind === Kind.BOOLEAN) {\n    if (ifArgument.value.value) {\n      return false;\n    }\n  } else if (ifArgument.value.kind !== Kind.VARIABLE) {\n    return false;\n  }\n  return true;\n}\n\n/**\n * Defer And Stream Directives Are Used On Valid Operations\n *\n * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.\n */\nexport function DeferStreamDirectiveOnValidOperationsRule(\n  context: ValidationContext,\n): ASTVisitor {\n  const fragmentsUsedOnSubscriptions = new Set<string>();\n\n  return {\n    OperationDefinition(operation) {\n      if (operation.operation === OperationTypeNode.SUBSCRIPTION) {\n        for (const fragment of context.getRecursivelyReferencedFragments(\n          operation,\n        )) {\n          fragmentsUsedOnSubscriptions.add(fragment.name.value);\n        }\n      }\n    },\n    Directive(node, _key, _parent, _path, ancestors) {\n      const definitionNode = ancestors[2];\n\n      if (\n        'kind' in definitionNode &&\n        ((definitionNode.kind === Kind.FRAGMENT_DEFINITION &&\n          fragmentsUsedOnSubscriptions.has(definitionNode.name.value)) ||\n          (definitionNode.kind === Kind.OPERATION_DEFINITION &&\n            definitionNode.operation === OperationTypeNode.SUBSCRIPTION))\n      ) {\n        if (node.name.value === GraphQLDeferDirective.name) {\n          if (!ifArgumentCanBeFalse(node)) {\n            context.reportError(\n              new GraphQLError(\n                'Defer directive not supported on subscription operations. Disable `@defer` by setting the `if` argument to `false`.',\n                { nodes: node },\n              ),\n            );\n          }\n        } else if (node.name.value === GraphQLStreamDirective.name) {\n          if (!ifArgumentCanBeFalse(node)) {\n            context.reportError(\n              new GraphQLError(\n                'Stream directive not supported on subscription operations. Disable `@stream` by setting the `if` argument to `false`.',\n                { nodes: node },\n              ),\n            );\n          }\n        }\n      }\n    },\n  };\n}\n"]}
+{"version":3,"file":"DeferStreamDirectiveOnValidOperationsRule.js","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveOnValidOperationsRule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAG3D,OAAO,EAAE,iBAAiB,EAAE,+BAA8B;AAC1D,OAAO,EAAE,IAAI,EAAE,iCAAgC;AAG/C,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,kCAAiC;AAIlC,SAAS,oBAAoB,CAAC,IAAmB;IAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;IAC1E,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3C,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;SAAM,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;QACnD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AA0DD,MAAM,UAAU,yCAAyC,CACvD,OAA0B;IAE1B,MAAM,4BAA4B,GAAG,IAAI,GAAG,EAAU,CAAC;IAEvD,OAAO;QACL,mBAAmB,CAAC,SAAS;YAC3B,IAAI,SAAS,CAAC,SAAS,KAAK,iBAAiB,CAAC,YAAY,EAAE,CAAC;gBAC3D,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,iCAAiC,CAC9D,SAAS,CACV,EAAE,CAAC;oBACF,4BAA4B,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxD,CAAC;YACH,CAAC;QACH,CAAC;QACD,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS;YAC7C,MAAM,cAAc,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAEpC,IACE,MAAM,IAAI,cAAc;gBACxB,CAAC,CAAC,cAAc,CAAC,IAAI,KAAK,IAAI,CAAC,mBAAmB;oBAChD,4BAA4B,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC5D,CAAC,cAAc,CAAC,IAAI,KAAK,IAAI,CAAC,oBAAoB;wBAChD,cAAc,CAAC,SAAS,KAAK,iBAAiB,CAAC,YAAY,CAAC,CAAC,EACjE,CAAC;gBACD,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,qBAAqB,CAAC,IAAI,EAAE,CAAC;oBACnD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChC,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,qHAAqH,EACrH,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;qBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sBAAsB,CAAC,IAAI,EAAE,CAAC;oBAC3D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChC,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,uHAAuH,EACvH,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type { DirectiveNode } from '../../language/ast.ts';\nimport { OperationTypeNode } from '../../language/ast.ts';\nimport { Kind } from '../../language/kinds.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport {\n  GraphQLDeferDirective,\n  GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\nfunction ifArgumentCanBeFalse(node: DirectiveNode): boolean {\n  const ifArgument = node.arguments?.find((arg) => arg.name.value === 'if');\n  if (!ifArgument) {\n    return false;\n  }\n  if (ifArgument.value.kind === Kind.BOOLEAN) {\n    if (ifArgument.value.value) {\n      return false;\n    }\n  } else if (ifArgument.value.kind !== Kind.VARIABLE) {\n    return false;\n  }\n  return true;\n}\n\n/**\n * Defer And Stream Directives Are Used On Valid Operations\n *\n * A GraphQL document is only valid if defer directives are not used on root mutation or subscription 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 { parse } from 'graphql/language';\n * import { buildSchema } from 'graphql/utilities';\n * import {\n *   validate,\n *   DeferStreamDirectiveOnValidOperationsRule,\n * } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     message: Message\n *   }\n *\n *   type Subscription {\n *     message: Message\n *   }\n *\n *   type Message {\n *     body: String\n *   }\n * `);\n * const invalidDocument = parse(`\n *   subscription {\n *     message {\n *       ...MessageBody @defer\n *     }\n *   }\n *\n *   fragment MessageBody on Message {\n *     body\n *   }\n * `);\n * const validDocument = parse(`\n *   subscription {\n *     message {\n *       ...MessageBody @defer(if: false)\n *     }\n *   }\n *\n *   fragment MessageBody on Message {\n *     body\n *   }\n * `);\n *\n * validate(schema, invalidDocument, [DeferStreamDirectiveOnValidOperationsRule])\n *   .length; // => 1\n * validate(schema, validDocument, [DeferStreamDirectiveOnValidOperationsRule]); // => []\n * ```\n */\nexport function DeferStreamDirectiveOnValidOperationsRule(\n  context: ValidationContext,\n): ASTVisitor {\n  const fragmentsUsedOnSubscriptions = new Set<string>();\n\n  return {\n    OperationDefinition(operation) {\n      if (operation.operation === OperationTypeNode.SUBSCRIPTION) {\n        for (const fragment of context.getRecursivelyReferencedFragments(\n          operation,\n        )) {\n          fragmentsUsedOnSubscriptions.add(fragment.name.value);\n        }\n      }\n    },\n    Directive(node, _key, _parent, _path, ancestors) {\n      const definitionNode = ancestors[2];\n\n      if (\n        'kind' in definitionNode &&\n        ((definitionNode.kind === Kind.FRAGMENT_DEFINITION &&\n          fragmentsUsedOnSubscriptions.has(definitionNode.name.value)) ||\n          (definitionNode.kind === Kind.OPERATION_DEFINITION &&\n            definitionNode.operation === OperationTypeNode.SUBSCRIPTION))\n      ) {\n        if (node.name.value === GraphQLDeferDirective.name) {\n          if (!ifArgumentCanBeFalse(node)) {\n            context.reportError(\n              new GraphQLError(\n                'Defer directive not supported on subscription operations. Disable `@defer` by setting the `if` argument to `false`.',\n                { nodes: node },\n              ),\n            );\n          }\n        } else if (node.name.value === GraphQLStreamDirective.name) {\n          if (!ifArgumentCanBeFalse(node)) {\n            context.reportError(\n              new GraphQLError(\n                'Stream directive not supported on subscription operations. Disable `@stream` by setting the `if` argument to `false`.',\n                { nodes: node },\n              ),\n            );\n          }\n        }\n      }\n    },\n  };\n}\n"]}

package/validation/rules/ExecutableDefinitionsRule.d.mts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.mjs";
 import type { ASTValidationContext } from "../ValidationContext.mjs";
 /**
@@ -7,5 +8,32 @@ import type { ASTValidationContext } from "../ValidationContext.mjs";
  * operation or fragment definitions.
  *
  * See https://spec.graphql.org/draft/#sec-Executable-Definitions
+ * @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 { ExecutableDefinitionsRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   type Extra { field: String }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [ExecutableDefinitionsRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   { name }
+ * `);
+ * const validErrors = validate(schema, validDocument, [ExecutableDefinitionsRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export declare function ExecutableDefinitionsRule(context: ASTValidationContext): ASTVisitor;

package/validation/rules/ExecutableDefinitionsRule.d.ts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.js";
 import type { ASTValidationContext } from "../ValidationContext.js";
 /**
@@ -7,5 +8,32 @@ import type { ASTValidationContext } from "../ValidationContext.js";
  * operation or fragment definitions.
  *
  * See https://spec.graphql.org/draft/#sec-Executable-Definitions
+ * @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 { ExecutableDefinitionsRule } from 'graphql/validation';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const invalidDocument = parse(`
+ *   type Extra { field: String }
+ * `);
+ * const invalidErrors = validate(schema, invalidDocument, [ExecutableDefinitionsRule]);
+ *
+ * invalidErrors.length; // => 1
+ *
+ * const validDocument = parse(`
+ *   { name }
+ * `);
+ * const validErrors = validate(schema, validDocument, [ExecutableDefinitionsRule]);
+ *
+ * validErrors; // => []
+ * ```
  */
 export declare function ExecutableDefinitionsRule(context: ASTValidationContext): ASTVisitor;

package/validation/rules/ExecutableDefinitionsRule.js

@@ -4,14 +4,6 @@ exports.ExecutableDefinitionsRule = ExecutableDefinitionsRule;
 const GraphQLError_ts_1 = require("../../error/GraphQLError.js");
 const kinds_ts_1 = require("../../language/kinds.js");
 const predicates_ts_1 = require("../../language/predicates.js");
-/**
- * Executable definitions
- *
- * A GraphQL document is only valid for execution if all definitions are either
- * operation or fragment definitions.
- *
- * See https://spec.graphql.org/draft/#sec-Executable-Definitions
- */
 function ExecutableDefinitionsRule(context) {
     return {
         Document(node) {

package/validation/rules/ExecutableDefinitionsRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExecutableDefinitionsRule.js","sourceRoot":"","sources":["../../../src/validation/rules/ExecutableDefinitionsRule.ts"],"names":[],"mappings":";;AAgBA,8DAsBC;AAtCD,iEAA2D;AAE3D,sDAA+C;AAC/C,gEAA0E;AAK1E;;;;;;;GAOG;AACH,SAAgB,yBAAyB,CACvC,OAA6B;IAE7B,OAAO;QACL,QAAQ,CAAC,IAAI;YACX,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC1C,IAAI,CAAC,IAAA,0CAA0B,EAAC,UAAU,CAAC,EAAE,CAAC;oBAC5C,MAAM,OAAO,GACX,UAAU,CAAC,IAAI,KAAK,eAAI,CAAC,iBAAiB;wBAC1C,UAAU,CAAC,IAAI,KAAK,eAAI,CAAC,gBAAgB;wBACvC,CAAC,CAAC,QAAQ;wBACV,CAAC,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;oBACxC,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CAAC,OAAO,OAAO,gCAAgC,EAAE;wBAC/D,KAAK,EAAE,UAAU;qBAClB,CAAC,CACH,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport { Kind } from '../../language/kinds.ts';\nimport { isExecutableDefinitionNode } from '../../language/predicates.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport type { ASTValidationContext } from '../ValidationContext.ts';\n\n/**\n * Executable definitions\n *\n * A GraphQL document is only valid for execution if all definitions are either\n * operation or fragment definitions.\n *\n * See https://spec.graphql.org/draft/#sec-Executable-Definitions\n */\nexport function ExecutableDefinitionsRule(\n  context: ASTValidationContext,\n): ASTVisitor {\n  return {\n    Document(node) {\n      for (const definition of node.definitions) {\n        if (!isExecutableDefinitionNode(definition)) {\n          const defName =\n            definition.kind === Kind.SCHEMA_DEFINITION ||\n            definition.kind === Kind.SCHEMA_EXTENSION\n              ? 'schema'\n              : '\"' + definition.name.value + '\"';\n          context.reportError(\n            new GraphQLError(`The ${defName} definition is not executable.`, {\n              nodes: definition,\n            }),\n          );\n        }\n      }\n      return false;\n    },\n  };\n}\n"]}
+{"version":3,"file":"ExecutableDefinitionsRule.js","sourceRoot":"","sources":["../../../src/validation/rules/ExecutableDefinitionsRule.ts"],"names":[],"mappings":";;AA6CA,8DAsBC;AAjED,iEAA2D;AAE3D,sDAA+C;AAC/C,gEAA0E;AAwC1E,SAAgB,yBAAyB,CACvC,OAA6B;IAE7B,OAAO;QACL,QAAQ,CAAC,IAAI;YACX,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC1C,IAAI,CAAC,IAAA,0CAA0B,EAAC,UAAU,CAAC,EAAE,CAAC;oBAC5C,MAAM,OAAO,GACX,UAAU,CAAC,IAAI,KAAK,eAAI,CAAC,iBAAiB;wBAC1C,UAAU,CAAC,IAAI,KAAK,eAAI,CAAC,gBAAgB;wBACvC,CAAC,CAAC,QAAQ;wBACV,CAAC,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;oBACxC,OAAO,CAAC,WAAW,CACjB,IAAI,8BAAY,CAAC,OAAO,OAAO,gCAAgC,EAAE;wBAC/D,KAAK,EAAE,UAAU;qBAClB,CAAC,CACH,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport { Kind } from '../../language/kinds.ts';\nimport { isExecutableDefinitionNode } from '../../language/predicates.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport type { ASTValidationContext } from '../ValidationContext.ts';\n\n/**\n * Executable definitions\n *\n * A GraphQL document is only valid for execution if all definitions are either\n * operation or fragment definitions.\n *\n * See https://spec.graphql.org/draft/#sec-Executable-Definitions\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 { ExecutableDefinitionsRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String\n *   }\n * `);\n *\n * const invalidDocument = parse(`\n *   type Extra { field: String }\n * `);\n * const invalidErrors = validate(schema, invalidDocument, [ExecutableDefinitionsRule]);\n *\n * invalidErrors.length; // => 1\n *\n * const validDocument = parse(`\n *   { name }\n * `);\n * const validErrors = validate(schema, validDocument, [ExecutableDefinitionsRule]);\n *\n * validErrors; // => []\n * ```\n */\nexport function ExecutableDefinitionsRule(\n  context: ASTValidationContext,\n): ASTVisitor {\n  return {\n    Document(node) {\n      for (const definition of node.definitions) {\n        if (!isExecutableDefinitionNode(definition)) {\n          const defName =\n            definition.kind === Kind.SCHEMA_DEFINITION ||\n            definition.kind === Kind.SCHEMA_EXTENSION\n              ? 'schema'\n              : '\"' + definition.name.value + '\"';\n          context.reportError(\n            new GraphQLError(`The ${defName} definition is not executable.`, {\n              nodes: definition,\n            }),\n          );\n        }\n      }\n      return false;\n    },\n  };\n}\n"]}

package/validation/rules/ExecutableDefinitionsRule.mjs

@@ -1,14 +1,6 @@
 import { GraphQLError } from "../../error/GraphQLError.mjs";
 import { Kind } from "../../language/kinds.mjs";
 import { isExecutableDefinitionNode } from "../../language/predicates.mjs";
-/**
- * Executable definitions
- *
- * A GraphQL document is only valid for execution if all definitions are either
- * operation or fragment definitions.
- *
- * See https://spec.graphql.org/draft/#sec-Executable-Definitions
- */
 export function ExecutableDefinitionsRule(context) {
     return {
         Document(node) {

package/validation/rules/ExecutableDefinitionsRule.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ExecutableDefinitionsRule.js","sourceRoot":"","sources":["../../../src/validation/rules/ExecutableDefinitionsRule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAE3D,OAAO,EAAE,IAAI,EAAE,iCAAgC;AAC/C,OAAO,EAAE,0BAA0B,EAAE,sCAAqC;AAK1E;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAA6B;IAE7B,OAAO;QACL,QAAQ,CAAC,IAAI;YACX,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC1C,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC5C,MAAM,OAAO,GACX,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,iBAAiB;wBAC1C,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,gBAAgB;wBACvC,CAAC,CAAC,QAAQ;wBACV,CAAC,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;oBACxC,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CAAC,OAAO,OAAO,gCAAgC,EAAE;wBAC/D,KAAK,EAAE,UAAU;qBAClB,CAAC,CACH,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport { Kind } from '../../language/kinds.ts';\nimport { isExecutableDefinitionNode } from '../../language/predicates.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport type { ASTValidationContext } from '../ValidationContext.ts';\n\n/**\n * Executable definitions\n *\n * A GraphQL document is only valid for execution if all definitions are either\n * operation or fragment definitions.\n *\n * See https://spec.graphql.org/draft/#sec-Executable-Definitions\n */\nexport function ExecutableDefinitionsRule(\n  context: ASTValidationContext,\n): ASTVisitor {\n  return {\n    Document(node) {\n      for (const definition of node.definitions) {\n        if (!isExecutableDefinitionNode(definition)) {\n          const defName =\n            definition.kind === Kind.SCHEMA_DEFINITION ||\n            definition.kind === Kind.SCHEMA_EXTENSION\n              ? 'schema'\n              : '\"' + definition.name.value + '\"';\n          context.reportError(\n            new GraphQLError(`The ${defName} definition is not executable.`, {\n              nodes: definition,\n            }),\n          );\n        }\n      }\n      return false;\n    },\n  };\n}\n"]}
+{"version":3,"file":"ExecutableDefinitionsRule.js","sourceRoot":"","sources":["../../../src/validation/rules/ExecutableDefinitionsRule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAE3D,OAAO,EAAE,IAAI,EAAE,iCAAgC;AAC/C,OAAO,EAAE,0BAA0B,EAAE,sCAAqC;AAwC1E,MAAM,UAAU,yBAAyB,CACvC,OAA6B;IAE7B,OAAO;QACL,QAAQ,CAAC,IAAI;YACX,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC1C,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC5C,MAAM,OAAO,GACX,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,iBAAiB;wBAC1C,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,gBAAgB;wBACvC,CAAC,CAAC,QAAQ;wBACV,CAAC,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;oBACxC,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CAAC,OAAO,OAAO,gCAAgC,EAAE;wBAC/D,KAAK,EAAE,UAAU;qBAClB,CAAC,CACH,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport { Kind } from '../../language/kinds.ts';\nimport { isExecutableDefinitionNode } from '../../language/predicates.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport type { ASTValidationContext } from '../ValidationContext.ts';\n\n/**\n * Executable definitions\n *\n * A GraphQL document is only valid for execution if all definitions are either\n * operation or fragment definitions.\n *\n * See https://spec.graphql.org/draft/#sec-Executable-Definitions\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 { ExecutableDefinitionsRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String\n *   }\n * `);\n *\n * const invalidDocument = parse(`\n *   type Extra { field: String }\n * `);\n * const invalidErrors = validate(schema, invalidDocument, [ExecutableDefinitionsRule]);\n *\n * invalidErrors.length; // => 1\n *\n * const validDocument = parse(`\n *   { name }\n * `);\n * const validErrors = validate(schema, validDocument, [ExecutableDefinitionsRule]);\n *\n * validErrors; // => []\n * ```\n */\nexport function ExecutableDefinitionsRule(\n  context: ASTValidationContext,\n): ASTVisitor {\n  return {\n    Document(node) {\n      for (const definition of node.definitions) {\n        if (!isExecutableDefinitionNode(definition)) {\n          const defName =\n            definition.kind === Kind.SCHEMA_DEFINITION ||\n            definition.kind === Kind.SCHEMA_EXTENSION\n              ? 'schema'\n              : '\"' + definition.name.value + '\"';\n          context.reportError(\n            new GraphQLError(`The ${defName} definition is not executable.`, {\n              nodes: definition,\n            }),\n          );\n        }\n      }\n      return false;\n    },\n  };\n}\n"]}

package/validation/rules/FieldsOnCorrectTypeRule.d.mts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.mjs";
 import type { ValidationContext } from "../ValidationContext.mjs";
 /**
@@ -7,5 +8,32 @@ import type { ValidationContext } from "../ValidationContext.mjs";
  * 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 declare function FieldsOnCorrectTypeRule(context: ValidationContext): ASTVisitor;

package/validation/rules/FieldsOnCorrectTypeRule.d.ts

@@ -1,3 +1,4 @@
+/** @category Validation Rules */
 import type { ASTVisitor } from "../../language/visitor.js";
 import type { ValidationContext } from "../ValidationContext.js";
 /**
@@ -7,5 +8,32 @@ import type { ValidationContext } from "../ValidationContext.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; // => []
+ * ```
  */
 export declare function FieldsOnCorrectTypeRule(context: ValidationContext): ASTVisitor;