graphql 17.0.0-beta.0 → 17.0.0-beta.2

package/utilities/typeFromAST.d.ts

@@ -1,15 +1,101 @@
-import type { ListTypeNode, NamedTypeNode, NonNullTypeNode, TypeNode } from '../language/ast.js';
-import type { GraphQLNamedType, GraphQLType } from '../type/definition.js';
-import { GraphQLList, GraphQLNonNull } from '../type/definition.js';
-import type { GraphQLSchema } from '../type/schema.js';
+/** @category Values */
+import type { ListTypeNode, NamedTypeNode, NonNullTypeNode, TypeNode } from "../language/ast.js";
+import type { GraphQLNamedType, GraphQLType } from "../type/definition.js";
+import { GraphQLList, GraphQLNonNull } from "../type/definition.js";
+import type { GraphQLSchema } from "../type/schema.js";
 /**
  * Given a Schema and an AST node describing a type, return a GraphQLType
  * definition which applies to that type. For example, if provided the parsed
  * AST node for `[User]`, a GraphQLList instance will be returned, containing
  * the type called "User" found in the schema. If a type called "User" is not
  * found in the schema, then undefined will be returned.
+ * @param schema - GraphQL schema to use.
+ * @param typeNode - The GraphQL type AST node to resolve.
+ * @returns The GraphQL type referenced by the AST node, or undefined if it cannot be resolved.
+ * @example
+ * ```ts
+ * import { parseType } from 'graphql/language';
+ * import { buildSchema, typeFromAST } from 'graphql/utilities';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * typeFromAST(schema, parseType('String'))?.toString(); // => 'String'
+ * typeFromAST(schema, parseType('Missing')); // => undefined
+ * ```
  */
 export declare function typeFromAST(schema: GraphQLSchema, typeNode: NamedTypeNode): GraphQLNamedType | undefined;
+/**
+ * Resolves a list type AST node against a schema.
+ * @param schema - GraphQL schema to use.
+ * @param typeNode - The list type AST node to resolve.
+ * @returns The GraphQL list type referenced by the AST node, or undefined if
+ * it cannot be resolved.
+ * @example
+ * ```ts
+ * import { parseType } from 'graphql/language';
+ * import { buildSchema, typeFromAST } from 'graphql/utilities';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     tags: [String]
+ *   }
+ * `);
+ *
+ * typeFromAST(schema, parseType('[String]'))?.toString(); // => '[String]'
+ * typeFromAST(schema, parseType('[Missing]')); // => undefined
+ * ```
+ */
 export declare function typeFromAST(schema: GraphQLSchema, typeNode: ListTypeNode): GraphQLList<any> | undefined;
+/**
+ * Resolves a non-null type AST node against a schema.
+ * @param schema - GraphQL schema to use.
+ * @param typeNode - The non-null type AST node to resolve.
+ * @returns The GraphQL non-null type referenced by the AST node, or undefined
+ * if it cannot be resolved.
+ * @example
+ * ```ts
+ * import { parseType } from 'graphql/language';
+ * import { buildSchema, typeFromAST } from 'graphql/utilities';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String!
+ *   }
+ * `);
+ *
+ * typeFromAST(schema, parseType('String!'))?.toString(); // => 'String!'
+ * typeFromAST(schema, parseType('[String!]!'))?.toString(); // => '[String!]!'
+ * ```
+ */
 export declare function typeFromAST(schema: GraphQLSchema, typeNode: NonNullTypeNode): GraphQLNonNull<any> | undefined;
+/**
+ * Resolves a type AST node against a schema.
+ * @param schema - GraphQL schema to use.
+ * @param typeNode - The GraphQL type AST node to resolve.
+ * @returns The GraphQL type referenced by the AST node, or undefined if it
+ * cannot be resolved.
+ * @example
+ * ```ts
+ * import { parseType } from 'graphql/language';
+ * import { buildSchema, typeFromAST } from 'graphql/utilities';
+ *
+ * const schema = buildSchema(`
+ *   type User {
+ *     name: String
+ *   }
+ *
+ *   type Query {
+ *     users: [User!]!
+ *   }
+ * `);
+ *
+ * typeFromAST(schema, parseType('User'))?.toString(); // => 'User'
+ * typeFromAST(schema, parseType('[User!]!'))?.toString(); // => '[User!]!'
+ * typeFromAST(schema, parseType('Missing')); // => undefined
+ * ```
+ */
 export declare function typeFromAST(schema: GraphQLSchema, typeNode: TypeNode): GraphQLType | undefined;

package/utilities/typeFromAST.js

@@ -1,19 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.typeFromAST = typeFromAST;
-const kinds_js_1 = require("../language/kinds.js");
-const definition_js_1 = require("../type/definition.js");
+const kinds_ts_1 = require("../language/kinds.js");
+const definition_ts_1 = require("../type/definition.js");
 function typeFromAST(schema, typeNode) {
     switch (typeNode.kind) {
-        case kinds_js_1.Kind.LIST_TYPE: {
+        case kinds_ts_1.Kind.LIST_TYPE: {
             const innerType = typeFromAST(schema, typeNode.type);
-            return innerType && new definition_js_1.GraphQLList(innerType);
+            return innerType && new definition_ts_1.GraphQLList(innerType);
         }
-        case kinds_js_1.Kind.NON_NULL_TYPE: {
+        case kinds_ts_1.Kind.NON_NULL_TYPE: {
             const innerType = typeFromAST(schema, typeNode.type);
-            return innerType && new definition_js_1.GraphQLNonNull(innerType);
+            return innerType && new definition_ts_1.GraphQLNonNull(innerType);
         }
-        case kinds_js_1.Kind.NAMED_TYPE:
+        case kinds_ts_1.Kind.NAMED_TYPE:
             return schema.getType(typeNode.name.value);
     }
 }

package/utilities/typeFromAST.js.map

@@ -1 +1 @@
-{"version":3,"file":"typeFromAST.js","sourceRoot":"","sources":["../../src/utilities/typeFromAST.ts"],"names":[],"mappings":";;AAmCA,kCAgBC;AA7CD,mDAA4C;AAG5C,yDAAoE;AA0BpE,SAAgB,WAAW,CACzB,MAAqB,EACrB,QAAkB;IAElB,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,eAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YACpB,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,OAAO,SAAS,IAAI,IAAI,2BAAW,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QACD,KAAK,eAAI,CAAC,aAAa,CAAC,CAAC,CAAC;YACxB,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,OAAO,SAAS,IAAI,IAAI,8BAAc,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;QACD,KAAK,eAAI,CAAC,UAAU;YAClB,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC","sourcesContent":["import type {\n  ListTypeNode,\n  NamedTypeNode,\n  NonNullTypeNode,\n  TypeNode,\n} from '../language/ast.js';\nimport { Kind } from '../language/kinds.js';\n\nimport type { GraphQLNamedType, GraphQLType } from '../type/definition.js';\nimport { GraphQLList, GraphQLNonNull } from '../type/definition.js';\nimport type { GraphQLSchema } from '../type/schema.js';\n\n/**\n * Given a Schema and an AST node describing a type, return a GraphQLType\n * definition which applies to that type. For example, if provided the parsed\n * AST node for `[User]`, a GraphQLList instance will be returned, containing\n * the type called \"User\" found in the schema. If a type called \"User\" is not\n * found in the schema, then undefined will be returned.\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: NamedTypeNode,\n): GraphQLNamedType | undefined;\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: ListTypeNode,\n): GraphQLList<any> | undefined;\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: NonNullTypeNode,\n): GraphQLNonNull<any> | undefined;\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: TypeNode,\n): GraphQLType | undefined;\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: TypeNode,\n): GraphQLType | undefined {\n  switch (typeNode.kind) {\n    case Kind.LIST_TYPE: {\n      const innerType = typeFromAST(schema, typeNode.type);\n      return innerType && new GraphQLList(innerType);\n    }\n    case Kind.NON_NULL_TYPE: {\n      const innerType = typeFromAST(schema, typeNode.type);\n      return innerType && new GraphQLNonNull(innerType);\n    }\n    case Kind.NAMED_TYPE:\n      return schema.getType(typeNode.name.value);\n  }\n}\n"]}
+{"version":3,"file":"typeFromAST.js","sourceRoot":"","sources":["../../src/utilities/typeFromAST.ts"],"names":[],"mappings":";;AAkIA,kCAkBC;AA5ID,mDAA4C;AAO5C,yDAAoE;AAmHpE,SAAgB,WAAW,CACzB,MAAqB,EACrB,QAAkB;IAElB,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,eAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YACpB,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,OAAO,SAAS,IAAI,IAAI,2BAAW,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QACD,KAAK,eAAI,CAAC,aAAa,CAAC,CAAC,CAAC;YACxB,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAEtC,CAAC;YACd,OAAO,SAAS,IAAI,IAAI,8BAAc,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;QACD,KAAK,eAAI,CAAC,UAAU;YAClB,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC","sourcesContent":["/** @category Values */\n\nimport type {\n  ListTypeNode,\n  NamedTypeNode,\n  NonNullTypeNode,\n  TypeNode,\n} from '../language/ast.ts';\nimport { Kind } from '../language/kinds.ts';\n\nimport type {\n  GraphQLNamedType,\n  GraphQLNullableType,\n  GraphQLType,\n} from '../type/definition.ts';\nimport { GraphQLList, GraphQLNonNull } from '../type/definition.ts';\nimport type { GraphQLSchema } from '../type/schema.ts';\n\n/**\n * Given a Schema and an AST node describing a type, return a GraphQLType\n * definition which applies to that type. For example, if provided the parsed\n * AST node for `[User]`, a GraphQLList instance will be returned, containing\n * the type called \"User\" found in the schema. If a type called \"User\" is not\n * found in the schema, then undefined will be returned.\n * @param schema - GraphQL schema to use.\n * @param typeNode - The GraphQL type AST node to resolve.\n * @returns The GraphQL type referenced by the AST node, or undefined if it cannot be resolved.\n * @example\n * ```ts\n * import { parseType } from 'graphql/language';\n * import { buildSchema, typeFromAST } from 'graphql/utilities';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String\n *   }\n * `);\n *\n * typeFromAST(schema, parseType('String'))?.toString(); // => 'String'\n * typeFromAST(schema, parseType('Missing')); // => undefined\n * ```\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: NamedTypeNode,\n): GraphQLNamedType | undefined;\n/**\n * Resolves a list type AST node against a schema.\n * @param schema - GraphQL schema to use.\n * @param typeNode - The list type AST node to resolve.\n * @returns The GraphQL list type referenced by the AST node, or undefined if\n * it cannot be resolved.\n * @example\n * ```ts\n * import { parseType } from 'graphql/language';\n * import { buildSchema, typeFromAST } from 'graphql/utilities';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     tags: [String]\n *   }\n * `);\n *\n * typeFromAST(schema, parseType('[String]'))?.toString(); // => '[String]'\n * typeFromAST(schema, parseType('[Missing]')); // => undefined\n * ```\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: ListTypeNode,\n): GraphQLList<any> | undefined;\n/**\n * Resolves a non-null type AST node against a schema.\n * @param schema - GraphQL schema to use.\n * @param typeNode - The non-null type AST node to resolve.\n * @returns The GraphQL non-null type referenced by the AST node, or undefined\n * if it cannot be resolved.\n * @example\n * ```ts\n * import { parseType } from 'graphql/language';\n * import { buildSchema, typeFromAST } from 'graphql/utilities';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String!\n *   }\n * `);\n *\n * typeFromAST(schema, parseType('String!'))?.toString(); // => 'String!'\n * typeFromAST(schema, parseType('[String!]!'))?.toString(); // => '[String!]!'\n * ```\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: NonNullTypeNode,\n): GraphQLNonNull<any> | undefined;\n/**\n * Resolves a type AST node against a schema.\n * @param schema - GraphQL schema to use.\n * @param typeNode - The GraphQL type AST node to resolve.\n * @returns The GraphQL type referenced by the AST node, or undefined if it\n * cannot be resolved.\n * @example\n * ```ts\n * import { parseType } from 'graphql/language';\n * import { buildSchema, typeFromAST } from 'graphql/utilities';\n *\n * const schema = buildSchema(`\n *   type User {\n *     name: String\n *   }\n *\n *   type Query {\n *     users: [User!]!\n *   }\n * `);\n *\n * typeFromAST(schema, parseType('User'))?.toString(); // => 'User'\n * typeFromAST(schema, parseType('[User!]!'))?.toString(); // => '[User!]!'\n * typeFromAST(schema, parseType('Missing')); // => undefined\n * ```\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: TypeNode,\n): GraphQLType | undefined;\n/**\n * Resolves a type AST node against a schema.\n * @internal\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: TypeNode,\n): GraphQLType | undefined {\n  switch (typeNode.kind) {\n    case Kind.LIST_TYPE: {\n      const innerType = typeFromAST(schema, typeNode.type);\n      return innerType && new GraphQLList(innerType);\n    }\n    case Kind.NON_NULL_TYPE: {\n      const innerType = typeFromAST(schema, typeNode.type) as\n        | GraphQLNullableType\n        | undefined;\n      return innerType && new GraphQLNonNull(innerType);\n    }\n    case Kind.NAMED_TYPE:\n      return schema.getType(typeNode.name.value);\n  }\n}\n"]}

package/utilities/typeFromAST.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"typeFromAST.js","sourceRoot":"","sources":["../../src/utilities/typeFromAST.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,IAAI,EAAE,8BAA6B;AAG5C,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,+BAA8B;AA0BpE,MAAM,UAAU,WAAW,CACzB,MAAqB,EACrB,QAAkB;IAElB,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YACpB,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,OAAO,SAAS,IAAI,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QACD,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;YACxB,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,OAAO,SAAS,IAAI,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;QACD,KAAK,IAAI,CAAC,UAAU;YAClB,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC","sourcesContent":["import type {\n  ListTypeNode,\n  NamedTypeNode,\n  NonNullTypeNode,\n  TypeNode,\n} from '../language/ast.js';\nimport { Kind } from '../language/kinds.js';\n\nimport type { GraphQLNamedType, GraphQLType } from '../type/definition.js';\nimport { GraphQLList, GraphQLNonNull } from '../type/definition.js';\nimport type { GraphQLSchema } from '../type/schema.js';\n\n/**\n * Given a Schema and an AST node describing a type, return a GraphQLType\n * definition which applies to that type. For example, if provided the parsed\n * AST node for `[User]`, a GraphQLList instance will be returned, containing\n * the type called \"User\" found in the schema. If a type called \"User\" is not\n * found in the schema, then undefined will be returned.\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: NamedTypeNode,\n): GraphQLNamedType | undefined;\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: ListTypeNode,\n): GraphQLList<any> | undefined;\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: NonNullTypeNode,\n): GraphQLNonNull<any> | undefined;\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: TypeNode,\n): GraphQLType | undefined;\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: TypeNode,\n): GraphQLType | undefined {\n  switch (typeNode.kind) {\n    case Kind.LIST_TYPE: {\n      const innerType = typeFromAST(schema, typeNode.type);\n      return innerType && new GraphQLList(innerType);\n    }\n    case Kind.NON_NULL_TYPE: {\n      const innerType = typeFromAST(schema, typeNode.type);\n      return innerType && new GraphQLNonNull(innerType);\n    }\n    case Kind.NAMED_TYPE:\n      return schema.getType(typeNode.name.value);\n  }\n}\n"]}
+{"version":3,"file":"typeFromAST.js","sourceRoot":"","sources":["../../src/utilities/typeFromAST.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,IAAI,EAAE,8BAA6B;AAO5C,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,+BAA8B;AAmHpE,MAAM,UAAU,WAAW,CACzB,MAAqB,EACrB,QAAkB;IAElB,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YACpB,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,OAAO,SAAS,IAAI,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QACD,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;YACxB,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAEtC,CAAC;YACd,OAAO,SAAS,IAAI,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;QACD,KAAK,IAAI,CAAC,UAAU;YAClB,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC","sourcesContent":["/** @category Values */\n\nimport type {\n  ListTypeNode,\n  NamedTypeNode,\n  NonNullTypeNode,\n  TypeNode,\n} from '../language/ast.ts';\nimport { Kind } from '../language/kinds.ts';\n\nimport type {\n  GraphQLNamedType,\n  GraphQLNullableType,\n  GraphQLType,\n} from '../type/definition.ts';\nimport { GraphQLList, GraphQLNonNull } from '../type/definition.ts';\nimport type { GraphQLSchema } from '../type/schema.ts';\n\n/**\n * Given a Schema and an AST node describing a type, return a GraphQLType\n * definition which applies to that type. For example, if provided the parsed\n * AST node for `[User]`, a GraphQLList instance will be returned, containing\n * the type called \"User\" found in the schema. If a type called \"User\" is not\n * found in the schema, then undefined will be returned.\n * @param schema - GraphQL schema to use.\n * @param typeNode - The GraphQL type AST node to resolve.\n * @returns The GraphQL type referenced by the AST node, or undefined if it cannot be resolved.\n * @example\n * ```ts\n * import { parseType } from 'graphql/language';\n * import { buildSchema, typeFromAST } from 'graphql/utilities';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String\n *   }\n * `);\n *\n * typeFromAST(schema, parseType('String'))?.toString(); // => 'String'\n * typeFromAST(schema, parseType('Missing')); // => undefined\n * ```\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: NamedTypeNode,\n): GraphQLNamedType | undefined;\n/**\n * Resolves a list type AST node against a schema.\n * @param schema - GraphQL schema to use.\n * @param typeNode - The list type AST node to resolve.\n * @returns The GraphQL list type referenced by the AST node, or undefined if\n * it cannot be resolved.\n * @example\n * ```ts\n * import { parseType } from 'graphql/language';\n * import { buildSchema, typeFromAST } from 'graphql/utilities';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     tags: [String]\n *   }\n * `);\n *\n * typeFromAST(schema, parseType('[String]'))?.toString(); // => '[String]'\n * typeFromAST(schema, parseType('[Missing]')); // => undefined\n * ```\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: ListTypeNode,\n): GraphQLList<any> | undefined;\n/**\n * Resolves a non-null type AST node against a schema.\n * @param schema - GraphQL schema to use.\n * @param typeNode - The non-null type AST node to resolve.\n * @returns The GraphQL non-null type referenced by the AST node, or undefined\n * if it cannot be resolved.\n * @example\n * ```ts\n * import { parseType } from 'graphql/language';\n * import { buildSchema, typeFromAST } from 'graphql/utilities';\n *\n * const schema = buildSchema(`\n *   type Query {\n *     name: String!\n *   }\n * `);\n *\n * typeFromAST(schema, parseType('String!'))?.toString(); // => 'String!'\n * typeFromAST(schema, parseType('[String!]!'))?.toString(); // => '[String!]!'\n * ```\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: NonNullTypeNode,\n): GraphQLNonNull<any> | undefined;\n/**\n * Resolves a type AST node against a schema.\n * @param schema - GraphQL schema to use.\n * @param typeNode - The GraphQL type AST node to resolve.\n * @returns The GraphQL type referenced by the AST node, or undefined if it\n * cannot be resolved.\n * @example\n * ```ts\n * import { parseType } from 'graphql/language';\n * import { buildSchema, typeFromAST } from 'graphql/utilities';\n *\n * const schema = buildSchema(`\n *   type User {\n *     name: String\n *   }\n *\n *   type Query {\n *     users: [User!]!\n *   }\n * `);\n *\n * typeFromAST(schema, parseType('User'))?.toString(); // => 'User'\n * typeFromAST(schema, parseType('[User!]!'))?.toString(); // => '[User!]!'\n * typeFromAST(schema, parseType('Missing')); // => undefined\n * ```\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: TypeNode,\n): GraphQLType | undefined;\n/**\n * Resolves a type AST node against a schema.\n * @internal\n */\nexport function typeFromAST(\n  schema: GraphQLSchema,\n  typeNode: TypeNode,\n): GraphQLType | undefined {\n  switch (typeNode.kind) {\n    case Kind.LIST_TYPE: {\n      const innerType = typeFromAST(schema, typeNode.type);\n      return innerType && new GraphQLList(innerType);\n    }\n    case Kind.NON_NULL_TYPE: {\n      const innerType = typeFromAST(schema, typeNode.type) as\n        | GraphQLNullableType\n        | undefined;\n      return innerType && new GraphQLNonNull(innerType);\n    }\n    case Kind.NAMED_TYPE:\n      return schema.getType(typeNode.name.value);\n  }\n}\n"]}

package/utilities/typedQueryDocumentNode.d.mts

@@ -1,12 +1,16 @@
-import type { DocumentNode, ExecutableDefinitionNode } from '../language/ast.js';
+/** @category Typed Documents */
+import type { DocumentNode, ExecutableDefinitionNode } from "../language/ast.mjs";
 /**
  * Wrapper type that contains DocumentNode and types that can be deduced from it.
+ * @typeParam TResponseData - Typed GraphQL response data shape.
+ * @typeParam TRequestVariables - Typed GraphQL request variables shape.
  */
 export interface TypedQueryDocumentNode<TResponseData = {
     [key: string]: any;
 }, TRequestVariables = {
     [key: string]: any;
 }> extends DocumentNode {
+    /** Top-level executable and type-system definitions in this document. */
     readonly definitions: ReadonlyArray<ExecutableDefinitionNode>;
     /**
      * This type is used to ensure that the variables you pass in to the query are assignable to Variables

package/utilities/typedQueryDocumentNode.d.ts

@@ -1,12 +1,16 @@
-import type { DocumentNode, ExecutableDefinitionNode } from '../language/ast.js';
+/** @category Typed Documents */
+import type { DocumentNode, ExecutableDefinitionNode } from "../language/ast.js";
 /**
  * Wrapper type that contains DocumentNode and types that can be deduced from it.
+ * @typeParam TResponseData - Typed GraphQL response data shape.
+ * @typeParam TRequestVariables - Typed GraphQL request variables shape.
  */
 export interface TypedQueryDocumentNode<TResponseData = {
     [key: string]: any;
 }, TRequestVariables = {
     [key: string]: any;
 }> extends DocumentNode {
+    /** Top-level executable and type-system definitions in this document. */
     readonly definitions: ReadonlyArray<ExecutableDefinitionNode>;
     /**
      * This type is used to ensure that the variables you pass in to the query are assignable to Variables

package/utilities/typedQueryDocumentNode.js.map

@@ -1 +1 @@
-{"version":3,"file":"typedQueryDocumentNode.js","sourceRoot":"","sources":["../../src/utilities/typedQueryDocumentNode.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  DocumentNode,\n  ExecutableDefinitionNode,\n} from '../language/ast.js';\n/**\n * Wrapper type that contains DocumentNode and types that can be deduced from it.\n */\nexport interface TypedQueryDocumentNode<\n  TResponseData = { [key: string]: any },\n  TRequestVariables = { [key: string]: any },\n> extends DocumentNode {\n  readonly definitions: ReadonlyArray<ExecutableDefinitionNode>;\n  // FIXME: remove once TS implements proper way to enforce nominal typing\n  /**\n   * This type is used to ensure that the variables you pass in to the query are assignable to Variables\n   * and that the Result is assignable to whatever you pass your result to. The method is never actually\n   * implemented, but the type is valid because we list it as optional\n   */\n  __ensureTypesOfVariablesAndResultMatching?: (\n    variables: TRequestVariables,\n  ) => TResponseData;\n}\n"]}
+{"version":3,"file":"typedQueryDocumentNode.js","sourceRoot":"","sources":["../../src/utilities/typedQueryDocumentNode.ts"],"names":[],"mappings":"","sourcesContent":["/** @category Typed Documents */\n\nimport type {\n  DocumentNode,\n  ExecutableDefinitionNode,\n} from '../language/ast.ts';\n/**\n * Wrapper type that contains DocumentNode and types that can be deduced from it.\n * @typeParam TResponseData - Typed GraphQL response data shape.\n * @typeParam TRequestVariables - Typed GraphQL request variables shape.\n */\nexport interface TypedQueryDocumentNode<\n  TResponseData = { [key: string]: any },\n  TRequestVariables = { [key: string]: any },\n> extends DocumentNode {\n  /** Top-level executable and type-system definitions in this document. */\n  readonly definitions: ReadonlyArray<ExecutableDefinitionNode>;\n  // FIXME: remove once TS implements proper way to enforce nominal typing\n  /**\n   * This type is used to ensure that the variables you pass in to the query are assignable to Variables\n   * and that the Result is assignable to whatever you pass your result to. The method is never actually\n   * implemented, but the type is valid because we list it as optional\n   */\n  __ensureTypesOfVariablesAndResultMatching?: (\n    variables: TRequestVariables,\n  ) => TResponseData;\n}\n"]}

package/utilities/typedQueryDocumentNode.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"typedQueryDocumentNode.js","sourceRoot":"","sources":["../../src/utilities/typedQueryDocumentNode.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  DocumentNode,\n  ExecutableDefinitionNode,\n} from '../language/ast.js';\n/**\n * Wrapper type that contains DocumentNode and types that can be deduced from it.\n */\nexport interface TypedQueryDocumentNode<\n  TResponseData = { [key: string]: any },\n  TRequestVariables = { [key: string]: any },\n> extends DocumentNode {\n  readonly definitions: ReadonlyArray<ExecutableDefinitionNode>;\n  // FIXME: remove once TS implements proper way to enforce nominal typing\n  /**\n   * This type is used to ensure that the variables you pass in to the query are assignable to Variables\n   * and that the Result is assignable to whatever you pass your result to. The method is never actually\n   * implemented, but the type is valid because we list it as optional\n   */\n  __ensureTypesOfVariablesAndResultMatching?: (\n    variables: TRequestVariables,\n  ) => TResponseData;\n}\n"]}
+{"version":3,"file":"typedQueryDocumentNode.js","sourceRoot":"","sources":["../../src/utilities/typedQueryDocumentNode.ts"],"names":[],"mappings":"","sourcesContent":["/** @category Typed Documents */\n\nimport type {\n  DocumentNode,\n  ExecutableDefinitionNode,\n} from '../language/ast.ts';\n/**\n * Wrapper type that contains DocumentNode and types that can be deduced from it.\n * @typeParam TResponseData - Typed GraphQL response data shape.\n * @typeParam TRequestVariables - Typed GraphQL request variables shape.\n */\nexport interface TypedQueryDocumentNode<\n  TResponseData = { [key: string]: any },\n  TRequestVariables = { [key: string]: any },\n> extends DocumentNode {\n  /** Top-level executable and type-system definitions in this document. */\n  readonly definitions: ReadonlyArray<ExecutableDefinitionNode>;\n  // FIXME: remove once TS implements proper way to enforce nominal typing\n  /**\n   * This type is used to ensure that the variables you pass in to the query are assignable to Variables\n   * and that the Result is assignable to whatever you pass your result to. The method is never actually\n   * implemented, but the type is valid because we list it as optional\n   */\n  __ensureTypesOfVariablesAndResultMatching?: (\n    variables: TRequestVariables,\n  ) => TResponseData;\n}\n"]}

package/utilities/validateInputValue.d.mts

@@ -1,12 +1,67 @@
-import type { Maybe } from '../jsutils/Maybe.js';
-import { GraphQLError } from '../error/GraphQLError.js';
-import type { ValueNode } from '../language/ast.js';
-import type { GraphQLInputType } from '../type/definition.js';
-import type { FragmentVariableValues } from '../execution/collectFields.js';
-import type { VariableValues } from '../execution/values.js';
+/** @category Values */
+import type { Maybe } from "../jsutils/Maybe.mjs";
+import { GraphQLError } from "../error/GraphQLError.mjs";
+import type { ValueNode } from "../language/ast.mjs";
+import type { GraphQLInputType } from "../type/definition.mjs";
+import type { FragmentVariableValues } from "../execution/collectFields.mjs";
+import type { VariableValues } from "../execution/values.mjs";
 /**
  * Validate that the provided input value is allowed for this type, collecting
  * all errors via a callback function.
+ * @param inputValue - JavaScript value to validate.
+ * @param type - GraphQL input type to validate the value against.
+ * @param onError - Callback invoked for each validation error and path.
+ * @param hideSuggestions - Whether suggestion text should be omitted from errors.
+ * @returns Nothing.
+ * @example
+ * ```ts
+ * // Collect validation errors with their input paths.
+ * import {
+ *   GraphQLInputObjectType,
+ *   GraphQLInt,
+ *   GraphQLNonNull,
+ * } from 'graphql/type';
+ * import { validateInputValue } from 'graphql/utilities';
+ *
+ * const ReviewInput = new GraphQLInputObjectType({
+ *   name: 'ReviewInput',
+ *   fields: {
+ *     stars: { type: new GraphQLNonNull(GraphQLInt) },
+ *   },
+ * });
+ * const errors = [];
+ *
+ * validateInputValue({ stars: 'bad' }, ReviewInput, (error, path) => {
+ *   errors.push({ message: error.message, path });
+ * });
+ *
+ * errors; // => [ { message: 'Expected value of type "Int", found: "bad".', path: ['stars'] } ]
+ * ```
+ * @example
+ * ```ts
+ * // This variant hides suggestion text for unknown input fields.
+ * import { GraphQLInputObjectType, GraphQLString } from 'graphql/type';
+ * import { validateInputValue } from 'graphql/utilities';
+ *
+ * const ReviewInput = new GraphQLInputObjectType({
+ *   name: 'ReviewInput',
+ *   fields: {
+ *     comment: { type: GraphQLString },
+ *   },
+ * });
+ * const errors = [];
+ *
+ * validateInputValue(
+ *   { rating: 'extra field' },
+ *   ReviewInput,
+ *   (error) => {
+ *     errors.push(error.message);
+ *   },
+ *   true,
+ * );
+ *
+ * errors; // => ['Expected value of type "ReviewInput" not to include unknown field "rating", found: { rating: "extra field" }.']
+ * ```
  */
 export declare function validateInputValue(inputValue: unknown, type: GraphQLInputType, onError: (error: GraphQLError, path: ReadonlyArray<string | number>) => void, hideSuggestions?: Maybe<boolean>): void;
 /**
@@ -15,5 +70,73 @@ export declare function validateInputValue(inputValue: unknown, type: GraphQLInp
  *
  * If variable values are not provided, the literal is validated statically
  * (not assuming that those variables are missing runtime values).
+ * @param valueNode - GraphQL value AST node to validate.
+ * @param type - GraphQL input type to validate the literal against.
+ * @param onError - Callback invoked for each validation error and path.
+ * @param variables - Operation variable values returned by getVariableValues.
+ * @param fragmentVariableValues - Fragment variable values for the current fragment scope.
+ * @param hideSuggestions - Whether suggestion text should be omitted from errors.
+ * @returns Nothing.
+ * @example
+ * ```ts
+ * // Validate literal input values and collect literal paths.
+ * import { parseValue } from 'graphql/language';
+ * import {
+ *   GraphQLInputObjectType,
+ *   GraphQLInt,
+ *   GraphQLNonNull,
+ * } from 'graphql/type';
+ * import { validateInputLiteral } from 'graphql/utilities';
+ *
+ * const ReviewInput = new GraphQLInputObjectType({
+ *   name: 'ReviewInput',
+ *   fields: {
+ *     stars: { type: new GraphQLNonNull(GraphQLInt) },
+ *   },
+ * });
+ * const errors = [];
+ *
+ * validateInputLiteral(parseValue('{ stars: "bad" }'), ReviewInput, (error, path) => {
+ *   errors.push({ message: error.message, path });
+ * });
+ *
+ * errors; // => [ { message: 'Expected value of type "Int", found: "bad".', path: ['stars'] } ]
+ * ```
+ * @example
+ * ```ts
+ * // This variant resolves variable references using VariableValues from getVariableValues().
+ * import assert from 'node:assert';
+ * import { parse, parseValue } from 'graphql/language';
+ * import { GraphQLInt } from 'graphql/type';
+ * import { getVariableValues } from 'graphql/execution';
+ * import { buildSchema, validateInputLiteral } from 'graphql/utilities';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     review(stars: Int): String
+ *   }
+ * `);
+ * const document = parse('query ($stars: Int = 5) { review(stars: $stars) }');
+ * const operation = document.definitions[0];
+ * const result = getVariableValues(
+ *   schema,
+ *   operation.variableDefinitions,
+ *   { stars: '4' },
+ * );
+ *
+ * assert('variableValues' in result);
+ *
+ * const errors = [];
+ * validateInputLiteral(
+ *   parseValue('$stars'),
+ *   GraphQLInt,
+ *   (error) => errors.push(error.message),
+ *   result.variableValues,
+ *   undefined,
+ *   true,
+ * );
+ *
+ * errors; // => []
+ * ```
  */
 export declare function validateInputLiteral(valueNode: ValueNode, type: GraphQLInputType, onError: (error: GraphQLError, path: ReadonlyArray<string | number>) => void, variables?: Maybe<VariableValues>, fragmentVariableValues?: Maybe<FragmentVariableValues>, hideSuggestions?: Maybe<boolean>): void;

package/utilities/validateInputValue.d.ts

@@ -1,12 +1,67 @@
-import type { Maybe } from '../jsutils/Maybe.js';
-import { GraphQLError } from '../error/GraphQLError.js';
-import type { ValueNode } from '../language/ast.js';
-import type { GraphQLInputType } from '../type/definition.js';
-import type { FragmentVariableValues } from '../execution/collectFields.js';
-import type { VariableValues } from '../execution/values.js';
+/** @category Values */
+import type { Maybe } from "../jsutils/Maybe.js";
+import { GraphQLError } from "../error/GraphQLError.js";
+import type { ValueNode } from "../language/ast.js";
+import type { GraphQLInputType } from "../type/definition.js";
+import type { FragmentVariableValues } from "../execution/collectFields.js";
+import type { VariableValues } from "../execution/values.js";
 /**
  * Validate that the provided input value is allowed for this type, collecting
  * all errors via a callback function.
+ * @param inputValue - JavaScript value to validate.
+ * @param type - GraphQL input type to validate the value against.
+ * @param onError - Callback invoked for each validation error and path.
+ * @param hideSuggestions - Whether suggestion text should be omitted from errors.
+ * @returns Nothing.
+ * @example
+ * ```ts
+ * // Collect validation errors with their input paths.
+ * import {
+ *   GraphQLInputObjectType,
+ *   GraphQLInt,
+ *   GraphQLNonNull,
+ * } from 'graphql/type';
+ * import { validateInputValue } from 'graphql/utilities';
+ *
+ * const ReviewInput = new GraphQLInputObjectType({
+ *   name: 'ReviewInput',
+ *   fields: {
+ *     stars: { type: new GraphQLNonNull(GraphQLInt) },
+ *   },
+ * });
+ * const errors = [];
+ *
+ * validateInputValue({ stars: 'bad' }, ReviewInput, (error, path) => {
+ *   errors.push({ message: error.message, path });
+ * });
+ *
+ * errors; // => [ { message: 'Expected value of type "Int", found: "bad".', path: ['stars'] } ]
+ * ```
+ * @example
+ * ```ts
+ * // This variant hides suggestion text for unknown input fields.
+ * import { GraphQLInputObjectType, GraphQLString } from 'graphql/type';
+ * import { validateInputValue } from 'graphql/utilities';
+ *
+ * const ReviewInput = new GraphQLInputObjectType({
+ *   name: 'ReviewInput',
+ *   fields: {
+ *     comment: { type: GraphQLString },
+ *   },
+ * });
+ * const errors = [];
+ *
+ * validateInputValue(
+ *   { rating: 'extra field' },
+ *   ReviewInput,
+ *   (error) => {
+ *     errors.push(error.message);
+ *   },
+ *   true,
+ * );
+ *
+ * errors; // => ['Expected value of type "ReviewInput" not to include unknown field "rating", found: { rating: "extra field" }.']
+ * ```
  */
 export declare function validateInputValue(inputValue: unknown, type: GraphQLInputType, onError: (error: GraphQLError, path: ReadonlyArray<string | number>) => void, hideSuggestions?: Maybe<boolean>): void;
 /**
@@ -15,5 +70,73 @@ export declare function validateInputValue(inputValue: unknown, type: GraphQLInp
  *
  * If variable values are not provided, the literal is validated statically
  * (not assuming that those variables are missing runtime values).
+ * @param valueNode - GraphQL value AST node to validate.
+ * @param type - GraphQL input type to validate the literal against.
+ * @param onError - Callback invoked for each validation error and path.
+ * @param variables - Operation variable values returned by getVariableValues.
+ * @param fragmentVariableValues - Fragment variable values for the current fragment scope.
+ * @param hideSuggestions - Whether suggestion text should be omitted from errors.
+ * @returns Nothing.
+ * @example
+ * ```ts
+ * // Validate literal input values and collect literal paths.
+ * import { parseValue } from 'graphql/language';
+ * import {
+ *   GraphQLInputObjectType,
+ *   GraphQLInt,
+ *   GraphQLNonNull,
+ * } from 'graphql/type';
+ * import { validateInputLiteral } from 'graphql/utilities';
+ *
+ * const ReviewInput = new GraphQLInputObjectType({
+ *   name: 'ReviewInput',
+ *   fields: {
+ *     stars: { type: new GraphQLNonNull(GraphQLInt) },
+ *   },
+ * });
+ * const errors = [];
+ *
+ * validateInputLiteral(parseValue('{ stars: "bad" }'), ReviewInput, (error, path) => {
+ *   errors.push({ message: error.message, path });
+ * });
+ *
+ * errors; // => [ { message: 'Expected value of type "Int", found: "bad".', path: ['stars'] } ]
+ * ```
+ * @example
+ * ```ts
+ * // This variant resolves variable references using VariableValues from getVariableValues().
+ * import assert from 'node:assert';
+ * import { parse, parseValue } from 'graphql/language';
+ * import { GraphQLInt } from 'graphql/type';
+ * import { getVariableValues } from 'graphql/execution';
+ * import { buildSchema, validateInputLiteral } from 'graphql/utilities';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     review(stars: Int): String
+ *   }
+ * `);
+ * const document = parse('query ($stars: Int = 5) { review(stars: $stars) }');
+ * const operation = document.definitions[0];
+ * const result = getVariableValues(
+ *   schema,
+ *   operation.variableDefinitions,
+ *   { stars: '4' },
+ * );
+ *
+ * assert('variableValues' in result);
+ *
+ * const errors = [];
+ * validateInputLiteral(
+ *   parseValue('$stars'),
+ *   GraphQLInt,
+ *   (error) => errors.push(error.message),
+ *   result.variableValues,
+ *   undefined,
+ *   true,
+ * );
+ *
+ * errors; // => []
+ * ```
  */
 export declare function validateInputLiteral(valueNode: ValueNode, type: GraphQLInputType, onError: (error: GraphQLError, path: ReadonlyArray<string | number>) => void, variables?: Maybe<VariableValues>, fragmentVariableValues?: Maybe<FragmentVariableValues>, hideSuggestions?: Maybe<boolean>): void;