graphql 16.0.1 → 16.3.0

package/README.md

@@ -71,9 +71,9 @@ or an array of promises. A more complex example is included in the top-level [te
 Then, serve the result of a query against that type schema.
 
 ```js
-var query = '{ hello }';
+var source = '{ hello }';
 
-graphql(schema, query).then((result) => {
+graphql({ schema, source }).then((result) => {
   // Prints
   // {
   //   data: { hello: "world" }
@@ -87,9 +87,9 @@ first ensure the query is syntactically and semantically valid before executing
 it, reporting errors otherwise.
 
 ```js
-var query = '{ BoyHowdy }';
+var source = '{ BoyHowdy }';
 
-graphql(schema, query).then((result) => {
+graphql({ schema, source }).then((result) => {
   // Prints
   // {
   //   errors: [

package/error/GraphQLError.d.ts

@@ -1,7 +1,7 @@
 import type { Maybe } from '../jsutils/Maybe';
 import type { ASTNode } from '../language/ast';
-import type { Source } from '../language/source';
 import type { SourceLocation } from '../language/location';
+import type { Source } from '../language/source';
 /**
  * Custom extensions
  *
@@ -14,6 +14,18 @@ import type { SourceLocation } from '../language/location';
 export interface GraphQLErrorExtensions {
   [attributeName: string]: unknown;
 }
+export interface GraphQLErrorArgs {
+  nodes?: ReadonlyArray<ASTNode> | ASTNode | null;
+  source?: Maybe<Source>;
+  positions?: Maybe<ReadonlyArray<number>>;
+  path?: Maybe<ReadonlyArray<string | number>>;
+  originalError?: Maybe<
+    Error & {
+      readonly extensions?: unknown;
+    }
+  >;
+  extensions?: Maybe<GraphQLErrorExtensions>;
+}
 /**
  * A GraphQLError describes an Error found during the parse, validate, or
  * execute phases of performing a GraphQL operation. In addition to a message
@@ -63,6 +75,9 @@ export declare class GraphQLError extends Error {
    * Extension fields to add to the formatted error.
    */
   readonly extensions: GraphQLErrorExtensions;
+  /**
+   * @deprecated Please use the `GraphQLErrorArgs` constructor overload instead.
+   */
   constructor(
     message: string,
     nodes?: ReadonlyArray<ASTNode> | ASTNode | null,
@@ -76,6 +91,7 @@ export declare class GraphQLError extends Error {
     >,
     extensions?: Maybe<GraphQLErrorExtensions>,
   );
+  constructor(message: string, args?: GraphQLErrorArgs);
   get [Symbol.toStringTag](): string;
   toString(): string;
   toJSON(): GraphQLFormattedError;

package/error/GraphQLError.js

@@ -13,12 +13,29 @@ var _location = require('../language/location.js');
 
 var _printLocation = require('../language/printLocation.js');
 
+function toNormalizedArgs(args) {
+  const firstArg = args[0];
+
+  if (firstArg == null || 'kind' in firstArg || 'length' in firstArg) {
+    return {
+      nodes: firstArg,
+      source: args[1],
+      positions: args[2],
+      path: args[3],
+      originalError: args[4],
+      extensions: args[5],
+    };
+  }
+
+  return firstArg;
+}
 /**
  * A GraphQLError describes an Error found during the parse, validate, or
  * execute phases of performing a GraphQL operation. In addition to a message
  * and stack trace, it also includes information about the locations in a
  * GraphQL document and/or execution result that correspond to the Error.
  */
+
 class GraphQLError extends Error {
   /**
    * An array of `{ line, column }` locations within the source GraphQL document
@@ -61,17 +78,15 @@ class GraphQLError extends Error {
   /**
    * Extension fields to add to the formatted error.
    */
-  constructor(
-    message,
-    nodes,
-    source,
-    positions,
-    path,
-    originalError,
-    extensions,
-  ) {
+
+  /**
+   * @deprecated Please use the `GraphQLErrorArgs` constructor overload instead.
+   */
+  constructor(message, ...rawArgs) {
     var _this$nodes, _nodeLocations$, _ref;
 
+    const { nodes, source, positions, path, originalError, extensions } =
+      toNormalizedArgs(rawArgs);
     super(message);
     this.name = 'GraphQLError';
     this.path = path !== null && path !== void 0 ? path : undefined;
@@ -151,7 +166,9 @@ class GraphQLError extends Error {
         enumerable: false,
       },
     }); // Include (non-enumerable) stack trace.
-    // istanbul ignore next (See: 'https://github.com/graphql/graphql-js/issues/2317')
+
+    /* c8 ignore start */
+    // FIXME: https://github.com/graphql/graphql-js/issues/2317
 
     if (
       originalError !== null &&
@@ -172,6 +189,7 @@ class GraphQLError extends Error {
         configurable: true,
       });
     }
+    /* c8 ignore stop */
   }
 
   get [Symbol.toStringTag]() {

package/error/GraphQLError.mjs

@@ -4,22 +4,30 @@ import {
   printLocation,
   printSourceLocation,
 } from '../language/printLocation.mjs';
-/**
- * Custom extensions
- *
- * @remarks
- * Use a unique identifier name for your extension, for example the name of
- * your library or project. Do not use a shortened identifier as this increases
- * the risk of conflicts. We recommend you add at most one extension field,
- * an object which can contain all the values you need.
- */
 
+function toNormalizedArgs(args) {
+  const firstArg = args[0];
+
+  if (firstArg == null || 'kind' in firstArg || 'length' in firstArg) {
+    return {
+      nodes: firstArg,
+      source: args[1],
+      positions: args[2],
+      path: args[3],
+      originalError: args[4],
+      extensions: args[5],
+    };
+  }
+
+  return firstArg;
+}
 /**
  * A GraphQLError describes an Error found during the parse, validate, or
  * execute phases of performing a GraphQL operation. In addition to a message
  * and stack trace, it also includes information about the locations in a
  * GraphQL document and/or execution result that correspond to the Error.
  */
+
 export class GraphQLError extends Error {
   /**
    * An array of `{ line, column }` locations within the source GraphQL document
@@ -62,17 +70,15 @@ export class GraphQLError extends Error {
   /**
    * Extension fields to add to the formatted error.
    */
-  constructor(
-    message,
-    nodes,
-    source,
-    positions,
-    path,
-    originalError,
-    extensions,
-  ) {
+
+  /**
+   * @deprecated Please use the `GraphQLErrorArgs` constructor overload instead.
+   */
+  constructor(message, ...rawArgs) {
     var _this$nodes, _nodeLocations$, _ref;
 
+    const { nodes, source, positions, path, originalError, extensions } =
+      toNormalizedArgs(rawArgs);
     super(message);
     this.name = 'GraphQLError';
     this.path = path !== null && path !== void 0 ? path : undefined;
@@ -150,7 +156,9 @@ export class GraphQLError extends Error {
         enumerable: false,
       },
     }); // Include (non-enumerable) stack trace.
-    // istanbul ignore next (See: 'https://github.com/graphql/graphql-js/issues/2317')
+
+    /* c8 ignore start */
+    // FIXME: https://github.com/graphql/graphql-js/issues/2317
 
     if (
       originalError !== null &&
@@ -171,6 +179,7 @@ export class GraphQLError extends Error {
         configurable: true,
       });
     }
+    /* c8 ignore stop */
   }
 
   get [Symbol.toStringTag]() {

package/error/locatedError.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, '__esModule', {
 });
 exports.locatedError = locatedError;
 
-var _inspect = require('../jsutils/inspect.js');
+var _toError = require('../jsutils/toError.js');
 
 var _GraphQLError = require('./GraphQLError.js');
 
@@ -17,13 +17,7 @@ var _GraphQLError = require('./GraphQLError.js');
 function locatedError(rawOriginalError, nodes, path) {
   var _nodes;
 
-  // Sometimes a non-error is thrown, wrap it as an Error instance to ensure a consistent Error interface.
-  const originalError =
-    rawOriginalError instanceof Error
-      ? rawOriginalError
-      : new Error(
-          'Unexpected error value: ' + (0, _inspect.inspect)(rawOriginalError),
-        ); // Note: this uses a brand-check to support GraphQL errors originating from other contexts.
+  const originalError = (0, _toError.toError)(rawOriginalError); // Note: this uses a brand-check to support GraphQL errors originating from other contexts.
 
   if (isLocatedGraphQLError(originalError)) {
     return originalError;

package/error/locatedError.mjs

@@ -1,4 +1,4 @@
-import { inspect } from '../jsutils/inspect.mjs';
+import { toError } from '../jsutils/toError.mjs';
 import { GraphQLError } from './GraphQLError.mjs';
 /**
  * Given an arbitrary value, presumably thrown while attempting to execute a
@@ -9,11 +9,7 @@ import { GraphQLError } from './GraphQLError.mjs';
 export function locatedError(rawOriginalError, nodes, path) {
   var _nodes;
 
-  // Sometimes a non-error is thrown, wrap it as an Error instance to ensure a consistent Error interface.
-  const originalError =
-    rawOriginalError instanceof Error
-      ? rawOriginalError
-      : new Error('Unexpected error value: ' + inspect(rawOriginalError)); // Note: this uses a brand-check to support GraphQL errors originating from other contexts.
+  const originalError = toError(rawOriginalError); // Note: this uses a brand-check to support GraphQL errors originating from other contexts.
 
   if (isLocatedGraphQLError(originalError)) {
     return originalError;

package/execution/collectFields.d.ts

@@ -1,17 +1,17 @@
 import type { ObjMap } from '../jsutils/ObjMap';
 import type {
-  SelectionSetNode,
   FieldNode,
   FragmentDefinitionNode,
+  SelectionSetNode,
 } from '../language/ast';
-import type { GraphQLSchema } from '../type/schema';
 import type { GraphQLObjectType } from '../type/definition';
+import type { GraphQLSchema } from '../type/schema';
 /**
- * Given a selectionSet, collect all of the fields and returns it at the end.
+ * Given a selectionSet, collects all of the fields and returns them.
  *
- * CollectFields requires the "runtime type" of an object. For a field which
+ * CollectFields requires the "runtime type" of an object. For a field that
  * returns an Interface or Union type, the "runtime type" will be the actual
- * Object type returned by that field.
+ * object type returned by that field.
  *
  * @internal
  */
@@ -26,11 +26,11 @@ export declare function collectFields(
 ): Map<string, ReadonlyArray<FieldNode>>;
 /**
  * Given an array of field nodes, collects all of the subfields of the passed
- * in fields, and returns it at the end.
+ * in fields, and returns them at the end.
  *
- * CollectFields requires the "return type" of an object. For a field which
+ * CollectSubFields requires the "return type" of an object. For a field that
  * returns an Interface or Union type, the "return type" will be the actual
- * Object type returned by that field.
+ * object type returned by that field.
  *
  * @internal
  */

package/execution/collectFields.js

@@ -8,20 +8,20 @@ exports.collectSubfields = collectSubfields;
 
 var _kinds = require('../language/kinds.js');
 
-var _directives = require('../type/directives.js');
-
 var _definition = require('../type/definition.js');
 
+var _directives = require('../type/directives.js');
+
 var _typeFromAST = require('../utilities/typeFromAST.js');
 
 var _values = require('./values.js');
 
 /**
- * Given a selectionSet, collect all of the fields and returns it at the end.
+ * Given a selectionSet, collects all of the fields and returns them.
  *
- * CollectFields requires the "runtime type" of an object. For a field which
+ * CollectFields requires the "runtime type" of an object. For a field that
  * returns an Interface or Union type, the "runtime type" will be the actual
- * Object type returned by that field.
+ * object type returned by that field.
  *
  * @internal
  */
@@ -46,11 +46,11 @@ function collectFields(
 }
 /**
  * Given an array of field nodes, collects all of the subfields of the passed
- * in fields, and returns it at the end.
+ * in fields, and returns them at the end.
  *
- * CollectFields requires the "return type" of an object. For a field which
+ * CollectSubFields requires the "return type" of an object. For a field that
  * returns an Interface or Union type, the "return type" will be the actual
- * Object type returned by that field.
+ * object type returned by that field.
  *
  * @internal
  */

package/execution/collectFields.mjs

@@ -1,17 +1,17 @@
 import { Kind } from '../language/kinds.mjs';
+import { isAbstractType } from '../type/definition.mjs';
 import {
   GraphQLIncludeDirective,
   GraphQLSkipDirective,
 } from '../type/directives.mjs';
-import { isAbstractType } from '../type/definition.mjs';
 import { typeFromAST } from '../utilities/typeFromAST.mjs';
 import { getDirectiveValues } from './values.mjs';
 /**
- * Given a selectionSet, collect all of the fields and returns it at the end.
+ * Given a selectionSet, collects all of the fields and returns them.
  *
- * CollectFields requires the "runtime type" of an object. For a field which
+ * CollectFields requires the "runtime type" of an object. For a field that
  * returns an Interface or Union type, the "runtime type" will be the actual
- * Object type returned by that field.
+ * object type returned by that field.
  *
  * @internal
  */
@@ -37,11 +37,11 @@ export function collectFields(
 }
 /**
  * Given an array of field nodes, collects all of the subfields of the passed
- * in fields, and returns it at the end.
+ * in fields, and returns them at the end.
  *
- * CollectFields requires the "return type" of an object. For a field which
+ * CollectSubFields requires the "return type" of an object. For a field that
  * returns an Interface or Union type, the "return type" will be the actual
- * Object type returned by that field.
+ * object type returned by that field.
  *
  * @internal
  */

package/execution/execute.d.ts

@@ -1,23 +1,23 @@
-import type { Path } from '../jsutils/Path';
+import type { Maybe } from '../jsutils/Maybe';
 import type { ObjMap } from '../jsutils/ObjMap';
+import type { Path } from '../jsutils/Path';
 import type { PromiseOrValue } from '../jsutils/PromiseOrValue';
-import type { Maybe } from '../jsutils/Maybe';
 import type { GraphQLFormattedError } from '../error/GraphQLError';
 import { GraphQLError } from '../error/GraphQLError';
 import type {
   DocumentNode,
-  OperationDefinitionNode,
   FieldNode,
   FragmentDefinitionNode,
+  OperationDefinitionNode,
 } from '../language/ast';
-import type { GraphQLSchema } from '../type/schema';
 import type {
-  GraphQLObjectType,
   GraphQLField,
   GraphQLFieldResolver,
+  GraphQLObjectType,
   GraphQLResolveInfo,
   GraphQLTypeResolver,
 } from '../type/definition';
+import type { GraphQLSchema } from '../type/schema';
 /**
  * Terminology
  *

package/execution/execute.js

@@ -11,25 +11,25 @@ exports.execute = execute;
 exports.executeSync = executeSync;
 exports.getFieldDef = getFieldDef;
 
-var _inspect = require('../jsutils/inspect.js');
+var _devAssert = require('../jsutils/devAssert.js');
 
-var _memoize = require('../jsutils/memoize3.js');
+var _inspect = require('../jsutils/inspect.js');
 
 var _invariant = require('../jsutils/invariant.js');
 
-var _devAssert = require('../jsutils/devAssert.js');
-
-var _isPromise = require('../jsutils/isPromise.js');
+var _isIterableObject = require('../jsutils/isIterableObject.js');
 
 var _isObjectLike = require('../jsutils/isObjectLike.js');
 
-var _promiseReduce = require('../jsutils/promiseReduce.js');
+var _isPromise = require('../jsutils/isPromise.js');
 
-var _promiseForObject = require('../jsutils/promiseForObject.js');
+var _memoize = require('../jsutils/memoize3.js');
 
 var _Path = require('../jsutils/Path.js');
 
-var _isIterableObject = require('../jsutils/isIterableObject.js');
+var _promiseForObject = require('../jsutils/promiseForObject.js');
+
+var _promiseReduce = require('../jsutils/promiseReduce.js');
 
 var _GraphQLError = require('../error/GraphQLError.js');
 
@@ -39,16 +39,16 @@ var _ast = require('../language/ast.js');
 
 var _kinds = require('../language/kinds.js');
 
-var _validate = require('../type/validate.js');
+var _definition = require('../type/definition.js');
 
 var _introspection = require('../type/introspection.js');
 
-var _definition = require('../type/definition.js');
-
-var _values = require('./values.js');
+var _validate = require('../type/validate.js');
 
 var _collectFields = require('./collectFields.js');
 
+var _values = require('./values.js');
+
 /**
  * A memoized collection of relevant subfields with regard to the return
  * type. Memoizing ensures the subfields are not repeatedly calculated, which
@@ -102,6 +102,12 @@ const collectSubfields = (0, _memoize.memoize3)(
  * a GraphQLError will be thrown immediately explaining the invalid input.
  */
 function execute(args) {
+  // Temporary for v15 to v16 migration. Remove in v17
+  arguments.length < 2 ||
+    (0, _devAssert.devAssert)(
+      false,
+      'graphql@16 dropped long-deprecated support for positional arguments, please pass an object instead.',
+    );
   const { schema, document, variableValues, rootValue } = args; // If arguments are missing or incorrect, throw an error.
 
   assertValidExecutionArguments(schema, document, variableValues); // If a valid execution context cannot be created due to incorrect arguments,
@@ -247,6 +253,8 @@ function buildExecutionContext(args) {
       case _kinds.Kind.FRAGMENT_DEFINITION:
         fragments[definition.name.value] = definition;
         break;
+
+      default: // ignore non-executable definitions
     }
   }
 
@@ -260,7 +268,9 @@ function buildExecutionContext(args) {
     }
 
     return [new _GraphQLError.GraphQLError('Must provide an operation.')];
-  } // istanbul ignore next (See: 'https://github.com/graphql/graphql-js/issues/2203')
+  } // FIXME: https://github.com/graphql/graphql-js/issues/2203
+
+  /* c8 ignore next */
 
   const variableDefinitions =
     (_operation$variableDe = operation.variableDefinitions) !== null &&
@@ -424,7 +434,7 @@ function executeFields(exeContext, parentType, sourceValue, path, fields) {
   return (0, _promiseForObject.promiseForObject)(results);
 }
 /**
- * Implements the "Executing field" section of the spec
+ * Implements the "Executing fields" section of the spec
  * In particular, this function figures out the value that the field returns by
  * calling its resolve function, then calls completeValue to complete promises,
  * serialize scalars, or execute the sub-selection-set for objects.
@@ -541,7 +551,7 @@ function handleFieldError(error, returnType, exeContext) {
 }
 /**
  * Implements the instructions for completeValue as defined in the
- * "Field entries" section of the spec.
+ * "Value Completion" section of the spec.
  *
  * If the field type is Non-Null, then this recursively completes the value
  * for the inner type. It throws a field error if that completion returns null,
@@ -618,7 +628,6 @@ function completeValue(exeContext, returnType, fieldNodes, info, path, result) {
       result,
     );
   } // If field type is Object, execute and complete all sub-selections.
-  // istanbul ignore else (See: 'https://github.com/graphql/graphql-js/issues/2618')
 
   if ((0, _definition.isObjectType)(returnType)) {
     return completeObjectValue(
@@ -629,7 +638,9 @@ function completeValue(exeContext, returnType, fieldNodes, info, path, result) {
       path,
       result,
     );
-  } // istanbul ignore next (Not reachable. All possible output types have been considered)
+  }
+  /* c8 ignore next 6 */
+  // Not reachable, all possible output types have been considered.
 
   false ||
     (0, _invariant.invariant)(

package/execution/execute.mjs

@@ -1,35 +1,35 @@
+import { devAssert } from '../jsutils/devAssert.mjs';
 import { inspect } from '../jsutils/inspect.mjs';
-import { memoize3 } from '../jsutils/memoize3.mjs';
 import { invariant } from '../jsutils/invariant.mjs';
-import { devAssert } from '../jsutils/devAssert.mjs';
-import { isPromise } from '../jsutils/isPromise.mjs';
+import { isIterableObject } from '../jsutils/isIterableObject.mjs';
 import { isObjectLike } from '../jsutils/isObjectLike.mjs';
-import { promiseReduce } from '../jsutils/promiseReduce.mjs';
-import { promiseForObject } from '../jsutils/promiseForObject.mjs';
+import { isPromise } from '../jsutils/isPromise.mjs';
+import { memoize3 } from '../jsutils/memoize3.mjs';
 import { addPath, pathToArray } from '../jsutils/Path.mjs';
-import { isIterableObject } from '../jsutils/isIterableObject.mjs';
+import { promiseForObject } from '../jsutils/promiseForObject.mjs';
+import { promiseReduce } from '../jsutils/promiseReduce.mjs';
 import { GraphQLError } from '../error/GraphQLError.mjs';
 import { locatedError } from '../error/locatedError.mjs';
 import { OperationTypeNode } from '../language/ast.mjs';
 import { Kind } from '../language/kinds.mjs';
-import { assertValidSchema } from '../type/validate.mjs';
-import {
-  SchemaMetaFieldDef,
-  TypeMetaFieldDef,
-  TypeNameMetaFieldDef,
-} from '../type/introspection.mjs';
 import {
-  isObjectType,
   isAbstractType,
   isLeafType,
   isListType,
   isNonNullType,
+  isObjectType,
 } from '../type/definition.mjs';
-import { getVariableValues, getArgumentValues } from './values.mjs';
+import {
+  SchemaMetaFieldDef,
+  TypeMetaFieldDef,
+  TypeNameMetaFieldDef,
+} from '../type/introspection.mjs';
+import { assertValidSchema } from '../type/validate.mjs';
 import {
   collectFields,
   collectSubfields as _collectSubfields,
 } from './collectFields.mjs';
+import { getArgumentValues, getVariableValues } from './values.mjs';
 /**
  * A memoized collection of relevant subfields with regard to the return
  * type. Memoizing ensures the subfields are not repeatedly calculated, which
@@ -83,6 +83,12 @@ const collectSubfields = memoize3((exeContext, returnType, fieldNodes) =>
  * a GraphQLError will be thrown immediately explaining the invalid input.
  */
 export function execute(args) {
+  // Temporary for v15 to v16 migration. Remove in v17
+  arguments.length < 2 ||
+    devAssert(
+      false,
+      'graphql@16 dropped long-deprecated support for positional arguments, please pass an object instead.',
+    );
   const { schema, document, variableValues, rootValue } = args; // If arguments are missing or incorrect, throw an error.
 
   assertValidExecutionArguments(schema, document, variableValues); // If a valid execution context cannot be created due to incorrect arguments,
@@ -232,6 +238,8 @@ export function buildExecutionContext(args) {
       case Kind.FRAGMENT_DEFINITION:
         fragments[definition.name.value] = definition;
         break;
+
+      default: // ignore non-executable definitions
     }
   }
 
@@ -241,7 +249,9 @@ export function buildExecutionContext(args) {
     }
 
     return [new GraphQLError('Must provide an operation.')];
-  } // istanbul ignore next (See: 'https://github.com/graphql/graphql-js/issues/2203')
+  } // FIXME: https://github.com/graphql/graphql-js/issues/2203
+
+  /* c8 ignore next */
 
   const variableDefinitions =
     (_operation$variableDe = operation.variableDefinitions) !== null &&
@@ -405,7 +415,7 @@ function executeFields(exeContext, parentType, sourceValue, path, fields) {
   return promiseForObject(results);
 }
 /**
- * Implements the "Executing field" section of the spec
+ * Implements the "Executing fields" section of the spec
  * In particular, this function figures out the value that the field returns by
  * calling its resolve function, then calls completeValue to complete promises,
  * serialize scalars, or execute the sub-selection-set for objects.
@@ -520,7 +530,7 @@ function handleFieldError(error, returnType, exeContext) {
 }
 /**
  * Implements the instructions for completeValue as defined in the
- * "Field entries" section of the spec.
+ * "Value Completion" section of the spec.
  *
  * If the field type is Non-Null, then this recursively completes the value
  * for the inner type. It throws a field error if that completion returns null,
@@ -597,7 +607,6 @@ function completeValue(exeContext, returnType, fieldNodes, info, path, result) {
       result,
     );
   } // If field type is Object, execute and complete all sub-selections.
-  // istanbul ignore else (See: 'https://github.com/graphql/graphql-js/issues/2618')
 
   if (isObjectType(returnType)) {
     return completeObjectValue(
@@ -608,7 +617,9 @@ function completeValue(exeContext, returnType, fieldNodes, info, path, result) {
       path,
       result,
     );
-  } // istanbul ignore next (Not reachable. All possible output types have been considered)
+  }
+  /* c8 ignore next 6 */
+  // Not reachable, all possible output types have been considered.
 
   false ||
     invariant(

package/execution/index.d.ts

@@ -11,4 +11,4 @@ export type {
   FormattedExecutionResult,
 } from './execute';
 export { subscribe, createSourceEventStream } from './subscribe';
-export { getDirectiveValues } from './values';
+export { getVariableValues, getDirectiveValues } from './values';