graphql 15.1.0 → 15.4.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 GraphQL Contributors
+Copyright (c) GraphQL Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -13,7 +13,7 @@ Looking for help? Find resources [from the community](https://graphql.org/commun
 
 ## Getting Started
 
-An overview of GraphQL in general is available in the
+A general overview of GraphQL is available in the
 [README](https://github.com/graphql/graphql-spec/blob/master/README.md) for the
 [Specification for GraphQL](https://github.com/graphql/graphql-spec). That overview
 describes a simple set of GraphQL examples that exist as [tests](src/__tests__)
@@ -30,16 +30,16 @@ With npm:
 npm install --save graphql
 ```
 
-or alternatively using yarn:
+or using yarn:
 
 ```sh
 yarn add graphql
 ```
 
-GraphQL.js provides two important capabilities: building a type schema, and
+GraphQL.js provides two important capabilities: building a type schema and
 serving queries against that type schema.
 
-First, build a GraphQL type schema which maps to your code base.
+First, build a GraphQL type schema which maps to your codebase.
 
 ```js
 import {
@@ -64,10 +64,9 @@ var schema = new GraphQLSchema({
 });
 ```
 
-This defines a simple schema with one type and one field, that resolves
+This defines a simple schema, with one type and one field, that resolves
 to a fixed value. The `resolve` function can return a value, a promise,
-or an array of promises. A more complex example is included in the top
-level [tests](src/__tests__) directory.
+or an array of promises. A more complex example is included in the top-level [tests](src/__tests__) directory.
 
 Then, serve the result of a query against that type schema.
 
@@ -102,7 +101,7 @@ graphql(schema, query).then((result) => {
 });
 ```
 
-**Note**: Please don't forget to set `NODE_ENV=production` if you are running a production server it will disable some checks that can be useful during development but will significantly improve performance.
+**Note**: Please don't forget to set `NODE_ENV=production` if you are running a production server. It will disable some checks that can be useful during development but will significantly improve performance.
 
 ### Want to ride the bleeding edge?
 
@@ -118,7 +117,7 @@ npm install graphql@git://github.com/graphql/graphql-js.git#npm
 
 ### Using in a Browser
 
-GraphQL.js is a general purpose library and can be used both in a Node server
+GraphQL.js is a general-purpose library and can be used both in a Node server
 and in the browser. As an example, the [GraphiQL](https://github.com/graphql/graphiql/)
 tool is built with GraphQL.js!
 
@@ -130,8 +129,7 @@ custom build configurations look for `.mjs` files!
 
 ### Contributing
 
-We actively welcome pull requests, learn how to
-[contribute](https://github.com/graphql/graphql-js/blob/master/.github/CONTRIBUTING.md).
+We actively welcome pull requests. Learn how to [contribute](./.github/CONTRIBUTING.md).
 
 ### Changelog
 
@@ -139,7 +137,7 @@ Changes are tracked as [GitHub releases](https://github.com/graphql/graphql-js/r
 
 ### License
 
-GraphQL.js is [MIT-licensed](https://github.com/graphql/graphql-js/blob/master/LICENSE).
+GraphQL.js is [MIT-licensed](./LICENSE).
 
 ### Credits
 

package/error/GraphQLError.js

@@ -6,13 +6,13 @@ Object.defineProperty(exports, "__esModule", {
 exports.printError = printError;
 exports.GraphQLError = void 0;
 
-var _isObjectLike = _interopRequireDefault(require("../jsutils/isObjectLike"));
+var _isObjectLike = _interopRequireDefault(require("../jsutils/isObjectLike.js"));
 
-var _symbols = require("../polyfills/symbols");
+var _symbols = require("../polyfills/symbols.js");
 
-var _location = require("../language/location");
+var _location = require("../language/location.js");
 
-var _printLocation = require("../language/printLocation");
+var _printLocation = require("../language/printLocation.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -247,7 +247,7 @@ var GraphQLError = /*#__PURE__*/function (_Error) {
     value: function toString() {
       return printError(this);
     } // FIXME: workaround to not break chai comparisons, should be remove in v16
-    // $FlowFixMe Flow doesn't support computed properties yet
+    // $FlowFixMe[unsupported-syntax] Flow doesn't support computed properties yet
 
   }, {
     key: _symbols.SYMBOL_TO_STRING_TAG,

package/error/GraphQLError.js.flow

@@ -1,14 +1,14 @@
 // @flow strict
-
 // FIXME:
 // flowlint uninitialized-instance-property:off
 
 import isObjectLike from '../jsutils/isObjectLike';
 import { SYMBOL_TO_STRING_TAG } from '../polyfills/symbols';
 
-import { type ASTNode } from '../language/ast';
-import { type Source } from '../language/source';
-import { type SourceLocation, getLocation } from '../language/location';
+import type { ASTNode } from '../language/ast';
+import type { Source } from '../language/source';
+import type { SourceLocation } from '../language/location';
+import { getLocation } from '../language/location';
 import { printLocation, printSourceLocation } from '../language/printLocation';
 
 /**
@@ -213,7 +213,7 @@ export class GraphQLError extends Error {
   }
 
   // FIXME: workaround to not break chai comparisons, should be remove in v16
-  // $FlowFixMe Flow doesn't support computed properties yet
+  // $FlowFixMe[unsupported-syntax] Flow doesn't support computed properties yet
   get [SYMBOL_TO_STRING_TAG](): string {
     return 'Object';
   }

package/error/GraphQLError.mjs

@@ -236,7 +236,7 @@ export var GraphQLError = /*#__PURE__*/function (_Error) {
     value: function toString() {
       return printError(this);
     } // FIXME: workaround to not break chai comparisons, should be remove in v16
-    // $FlowFixMe Flow doesn't support computed properties yet
+    // $FlowFixMe[unsupported-syntax] Flow doesn't support computed properties yet
 
   }, {
     key: SYMBOL_TO_STRING_TAG,

package/error/formatError.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.formatError = formatError;
 
-var _devAssert = _interopRequireDefault(require("../jsutils/devAssert"));
+var _devAssert = _interopRequireDefault(require("../jsutils/devAssert.js"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 

package/error/formatError.js.flow

@@ -1,10 +1,9 @@
 // @flow strict
-
 import devAssert from '../jsutils/devAssert';
 
-import { type SourceLocation } from '../language/location';
+import type { SourceLocation } from '../language/location';
 
-import { type GraphQLError } from './GraphQLError';
+import type { GraphQLError } from './GraphQLError';
 
 /**
  * Given a GraphQLError, format it according to the rules described by the

package/error/index.js

@@ -34,10 +34,10 @@ Object.defineProperty(exports, "formatError", {
   }
 });
 
-var _GraphQLError = require("./GraphQLError");
+var _GraphQLError = require("./GraphQLError.js");
 
-var _syntaxError = require("./syntaxError");
+var _syntaxError = require("./syntaxError.js");
 
-var _locatedError = require("./locatedError");
+var _locatedError = require("./locatedError.js");
 
-var _formatError = require("./formatError");
+var _formatError = require("./formatError.js");

package/error/index.js.flow

@@ -1,5 +1,4 @@
 // @flow strict
-
 export { GraphQLError, printError } from './GraphQLError';
 
 export { syntaxError } from './syntaxError';

package/error/locatedError.d.ts

@@ -5,12 +5,12 @@ import { ASTNode } from '../language/ast';
 import { GraphQLError } from './GraphQLError';
 
 /**
- * Given an arbitrary Error, presumably thrown while attempting to execute a
+ * Given an arbitrary value, presumably thrown while attempting to execute a
  * GraphQL operation, produce a new GraphQLError aware of the location in the
  * document responsible for the original Error.
  */
 export function locatedError(
-  originalError: Error | GraphQLError,
+  rawOriginalError: any,
   nodes: ASTNode | ReadonlyArray<ASTNode> | undefined,
   path?: Maybe<ReadonlyArray<string | number>>,
 ): GraphQLError;

package/error/locatedError.js

@@ -5,18 +5,23 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.locatedError = locatedError;
 
-var _GraphQLError = require("./GraphQLError");
+var _inspect = _interopRequireDefault(require("../jsutils/inspect.js"));
+
+var _GraphQLError = require("./GraphQLError.js");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
- * Given an arbitrary Error, presumably thrown while attempting to execute a
+ * Given an arbitrary value, presumably thrown while attempting to execute a
  * GraphQL operation, produce a new GraphQLError aware of the location in the
  * document responsible for the original Error.
  */
-function locatedError(originalError, nodes, path) {
+function locatedError(rawOriginalError, nodes, path) {
   var _nodes;
 
-  // Note: this uses a brand-check to support GraphQL errors originating from
-  // other contexts.
+  // Sometimes a non-error is thrown, wrap it as an Error instance to ensure a consistent Error interface.
+  var originalError = rawOriginalError instanceof Error ? rawOriginalError : new Error('Unexpected error value: ' + (0, _inspect.default)(rawOriginalError)); // Note: this uses a brand-check to support GraphQL errors originating from other contexts.
+
   if (Array.isArray(originalError.path)) {
     return originalError;
   }

package/error/locatedError.js.flow

@@ -1,21 +1,27 @@
 // @flow strict
+import inspect from '../jsutils/inspect';
 
-import { type ASTNode } from '../language/ast';
+import type { ASTNode } from '../language/ast';
 
 import { GraphQLError } from './GraphQLError';
 
 /**
- * Given an arbitrary Error, presumably thrown while attempting to execute a
+ * Given an arbitrary value, presumably thrown while attempting to execute a
  * GraphQL operation, produce a new GraphQLError aware of the location in the
  * document responsible for the original Error.
  */
 export function locatedError(
-  originalError: Error | GraphQLError,
+  rawOriginalError: mixed,
   nodes: ASTNode | $ReadOnlyArray<ASTNode> | void | null,
   path?: ?$ReadOnlyArray<string | number>,
 ): GraphQLError {
-  // Note: this uses a brand-check to support GraphQL errors originating from
-  // other contexts.
+  // Sometimes a non-error is thrown, wrap it as an Error instance to ensure a consistent Error interface.
+  const originalError: Error | GraphQLError =
+    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.
   if (Array.isArray(originalError.path)) {
     return (originalError: any);
   }

package/error/locatedError.mjs

@@ -1,15 +1,17 @@
+import inspect from "../jsutils/inspect.mjs";
 import { GraphQLError } from "./GraphQLError.mjs";
 /**
- * Given an arbitrary Error, presumably thrown while attempting to execute a
+ * Given an arbitrary value, presumably thrown while attempting to execute a
  * GraphQL operation, produce a new GraphQLError aware of the location in the
  * document responsible for the original Error.
  */
 
-export function locatedError(originalError, nodes, path) {
+export function locatedError(rawOriginalError, nodes, path) {
   var _nodes;
 
-  // Note: this uses a brand-check to support GraphQL errors originating from
-  // other contexts.
+  // Sometimes a non-error is thrown, wrap it as an Error instance to ensure a consistent Error interface.
+  var 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.
+
   if (Array.isArray(originalError.path)) {
     return originalError;
   }

package/error/syntaxError.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.syntaxError = syntaxError;
 
-var _GraphQLError = require("./GraphQLError");
+var _GraphQLError = require("./GraphQLError.js");
 
 /**
  * Produces a GraphQLError representing a syntax error, containing useful

package/error/syntaxError.js.flow

@@ -1,6 +1,5 @@
 // @flow strict
-
-import { type Source } from '../language/source';
+import type { Source } from '../language/source';
 
 import { GraphQLError } from './GraphQLError';
 

package/execution/execute.d.ts

@@ -4,6 +4,7 @@ import { PromiseOrValue } from '../jsutils/PromiseOrValue';
 import { Path } from '../jsutils/Path';
 
 import { GraphQLError } from '../error/GraphQLError';
+import { GraphQLFormattedError } from '../error/formatError';
 
 import {
   DocumentNode,
@@ -43,11 +44,26 @@ export interface ExecutionContext {
  *
  *   - `errors` is included when any errors occurred as a non-empty array.
  *   - `data` is the result of a successful execution of the query.
+ *   - `extensions` is reserved for adding non-standard properties.
  */
-export interface ExecutionResult<TData = { [key: string]: any }> {
+export interface ExecutionResult<
+  TData = { [key: string]: any },
+  TExtensions = { [key: string]: any }
+> {
   errors?: ReadonlyArray<GraphQLError>;
   // TS_SPECIFIC: TData. Motivation: https://github.com/graphql/graphql-js/pull/2490#issuecomment-639154229
   data?: TData | null;
+  extensions?: TExtensions;
+}
+
+export interface FormattedExecutionResult<
+  TData = { [key: string]: any },
+  TExtensions = { [key: string]: any }
+> {
+  errors?: ReadonlyArray<GraphQLFormattedError>;
+  // TS_SPECIFIC: TData. Motivation: https://github.com/graphql/graphql-js/pull/2490#issuecomment-639154229
+  data?: TData | null;
+  extensions?: TExtensions;
 }
 
 export interface ExecutionArgs {
@@ -85,6 +101,13 @@ export function execute(
   typeResolver?: Maybe<GraphQLTypeResolver<any, any>>,
 ): PromiseOrValue<ExecutionResult>;
 
+/**
+ * Also implements the "Evaluating requests" section of the GraphQL specification.
+ * However, it guarantees to complete synchronously (or throw an error) assuming
+ * that all field resolvers are also synchronous.
+ */
+export function executeSync(args: ExecutionArgs): ExecutionResult;
+
 /**
  * Essential assertions before executing to provide developer feedback for
  * improper use of the GraphQL library.
@@ -136,21 +159,6 @@ export function buildResolveInfo(
   path: Path,
 ): GraphQLResolveInfo;
 
-/**
- * Isolates the "ReturnOrAbrupt" behavior to not de-opt the `resolveField`
- * function. Returns the result of resolveFn or the abrupt-return Error object.
- *
- * @internal
- */
-export function resolveFieldValueOrError(
-  exeContext: ExecutionContext,
-  fieldDef: GraphQLField<any, any>,
-  fieldNodes: ReadonlyArray<FieldNode>,
-  resolveFn: GraphQLFieldResolver<any, any>,
-  source: any,
-  info: GraphQLResolveInfo,
-): any;
-
 /**
  * If a resolveType function is not given, then a default resolve behavior is
  * used which attempts two strategies: