graphql/validation/rules/StreamDirectiveOnListFieldRule.mjs.map

A Query Language and Runtime which can target any service.

{"version":3,"file":"StreamDirectiveOnListFieldRule.js","sourceRoot":"","sources":["../../../src/validation/rules/StreamDirectiveOnListFieldRule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAK3D,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,kCAAiC;AACtE,OAAO,EAAE,sBAAsB,EAAE,kCAAiC;AA6BlE,MAAM,UAAU,8BAA8B,CAC5C,OAA0B;IAE1B,OAAO;QACL,SAAS,CAAC,IAAmB;YAC3B,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3C,IACE,QAAQ;gBACR,UAAU;gBACV,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,sBAAsB,CAAC,IAAI;gBAC/C,CAAC,CACC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;oBACzB,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CACpE,EACD,CAAC;gBACD,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,yDAAyD,UAAU,IAAI,QAAQ,CAAC,IAAI,IAAI,EACxF,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CACF,CAAC;YACJ,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 type { ASTVisitor } from '../../language/visitor.ts';\n\nimport { isListType, isWrappingType } from '../../type/definition.ts';\nimport { GraphQLStreamDirective } from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Stream directives are used on list fields\n *\n * A GraphQL document is only valid if stream directives are used on list fields.\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, StreamDirectiveOnListFieldRule } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String\n *     friends: [String]\n *   }\n * `);\n * const invalidDocument = parse('{ name @stream(initialCount: 0) }');\n * const validDocument = parse('{ friends @stream(initialCount: 0) }');\n *\n * validate(schema, invalidDocument, [StreamDirectiveOnListFieldRule]).length; // => 1\n * validate(schema, validDocument, [StreamDirectiveOnListFieldRule]); // => []\n * ```\n */\nexport function StreamDirectiveOnListFieldRule(\n  context: ValidationContext,\n): ASTVisitor {\n  return {\n    Directive(node: DirectiveNode) {\n      const fieldDef = context.getFieldDef();\n      const parentType = context.getParentType();\n      if (\n        fieldDef &&\n        parentType &&\n        node.name.value === GraphQLStreamDirective.name &&\n        !(\n          isListType(fieldDef.type) ||\n          (isWrappingType(fieldDef.type) && isListType(fieldDef.type.ofType))\n        )\n      ) {\n        context.reportError(\n          new GraphQLError(\n            `Directive \"@stream\" cannot be used on non-list field \"${parentType}.${fieldDef.name}\".`,\n            { nodes: node },\n          ),\n        );\n      }\n    },\n  };\n}\n"]}