graphql 15.2.0 → 15.3.0

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,7 +129,7 @@ custom build configurations look for `.mjs` files!
 
 ### Contributing
 
-We actively welcome pull requests, learn how to [contribute](./.github/CONTRIBUTING.md).
+We actively welcome pull requests. Learn how to [contribute](./.github/CONTRIBUTING.md).
 
 ### Changelog
 

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,
@@ -55,6 +56,16 @@ export interface ExecutionResult<
   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 {
   schema: GraphQLSchema;
   document: DocumentNode;

package/execution/execute.js

@@ -840,12 +840,12 @@ var defaultFieldResolver = function defaultFieldResolver(source, args, contextVa
 };
 /**
  * This method looks up the field on the given type definition.
- * It has special casing for the two introspection fields, __schema
- * and __typename. __typename is special because it can always be
- * queried as a field, even in situations where no other fields
- * are allowed, like on a Union. __schema could get automatically
- * added to the query type, but that would require mutating type
- * definitions, which would cause issues.
+ * It has special casing for the three introspection fields,
+ * __schema, __type and __typename. __typename is special because
+ * it can always be queried as a field, even in situations where no
+ * other fields are allowed, like on a Union. __schema and __type
+ * could get automatically added to the query type, but that would
+ * require mutating type definitions, which would cause issues.
  *
  * @internal
  */

package/execution/execute.js.flow

@@ -16,6 +16,7 @@ import promiseReduce from '../jsutils/promiseReduce';
 import promiseForObject from '../jsutils/promiseForObject';
 import { addPath, pathToArray } from '../jsutils/Path';
 
+import type { GraphQLFormattedError } from '../error/formatError';
 import { GraphQLError } from '../error/GraphQLError';
 import { locatedError } from '../error/locatedError';
 
@@ -120,6 +121,12 @@ export type ExecutionResult = {|
   extensions?: ObjMap<mixed>,
 |};
 
+export type FormattedExecutionResult = {|
+  errors?: $ReadOnlyArray<GraphQLFormattedError>,
+  data?: ObjMap<mixed> | null,
+  extensions?: ObjMap<mixed>,
+|};
+
 export type ExecutionArgs = {|
   schema: GraphQLSchema,
   document: DocumentNode,
@@ -1222,12 +1229,12 @@ export const defaultFieldResolver: GraphQLFieldResolver<
 
 /**
  * This method looks up the field on the given type definition.
- * It has special casing for the two introspection fields, __schema
- * and __typename. __typename is special because it can always be
- * queried as a field, even in situations where no other fields
- * are allowed, like on a Union. __schema could get automatically
- * added to the query type, but that would require mutating type
- * definitions, which would cause issues.
+ * It has special casing for the three introspection fields,
+ * __schema, __type and __typename. __typename is special because
+ * it can always be queried as a field, even in situations where no
+ * other fields are allowed, like on a Union. __schema and __type
+ * could get automatically added to the query type, but that would
+ * require mutating type definitions, which would cause issues.
  *
  * @internal
  */

package/execution/execute.mjs

@@ -820,12 +820,12 @@ export var defaultFieldResolver = function defaultFieldResolver(source, args, co
 };
 /**
  * This method looks up the field on the given type definition.
- * It has special casing for the two introspection fields, __schema
- * and __typename. __typename is special because it can always be
- * queried as a field, even in situations where no other fields
- * are allowed, like on a Union. __schema could get automatically
- * added to the query type, but that would require mutating type
- * definitions, which would cause issues.
+ * It has special casing for the three introspection fields,
+ * __schema, __type and __typename. __typename is special because
+ * it can always be queried as a field, even in situations where no
+ * other fields are allowed, like on a Union. __schema and __type
+ * could get automatically added to the query type, but that would
+ * require mutating type definitions, which would cause issues.
  *
  * @internal
  */

package/execution/index.d.ts

@@ -7,6 +7,7 @@ export {
   defaultTypeResolver,
   ExecutionArgs,
   ExecutionResult,
+  FormattedExecutionResult,
 } from './execute';
 
 export { getDirectiveValues } from './values';

package/execution/index.js.flow

@@ -8,6 +8,11 @@ export {
   defaultFieldResolver,
   defaultTypeResolver,
 } from './execute';
-export type { ExecutionArgs, ExecutionResult } from './execute';
+
+export type {
+  ExecutionArgs,
+  ExecutionResult,
+  FormattedExecutionResult,
+} from './execute';
 
 export { getDirectiveValues } from './values';

package/index.d.ts

@@ -299,6 +299,7 @@ export {
   getDirectiveValues,
   ExecutionArgs,
   ExecutionResult,
+  FormattedExecutionResult,
 } from './execution/index';
 
 export {

package/index.js.flow

@@ -288,7 +288,11 @@ export {
   getDirectiveValues,
 } from './execution/index';
 
-export type { ExecutionArgs, ExecutionResult } from './execution/index';
+export type {
+  ExecutionArgs,
+  ExecutionResult,
+  FormattedExecutionResult,
+} from './execution/index';
 
 export { subscribe, createSourceEventStream } from './subscription/index';
 export type { SubscriptionArgs } from './subscription/index';

package/language/source.d.ts

@@ -4,12 +4,11 @@ interface Location {
 }
 
 /**
- * A representation of source input to GraphQL.
- * `name` and `locationOffset` are optional. They are useful for clients who
- * store GraphQL documents in source files; for example, if the GraphQL input
- * starts at line 40 in a file named Foo.graphql, it might be useful for name to
- * be "Foo.graphql" and location to be `{ line: 40, column: 0 }`.
- * line and column in locationOffset are 1-indexed
+ * A representation of source input to GraphQL. The `name` and `locationOffset` parameters are
+ * optional, but they are useful for clients who store GraphQL documents in source files.
+ * For example, if the GraphQL input starts at line 40 in a file named `Foo.graphql`, it might
+ * be useful for `name` to be `"Foo.graphql"` and location to be `{ line: 40, column: 1 }`.
+ * The `line` and `column` properties in `locationOffset` are 1-indexed.
  */
 export class Source {
   body: string;

package/language/source.js

@@ -16,12 +16,11 @@ function _defineProperties(target, props) { for (var i = 0; i < props.length; i+
 function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
 
 /**
- * A representation of source input to GraphQL.
- * `name` and `locationOffset` are optional. They are useful for clients who
- * store GraphQL documents in source files; for example, if the GraphQL input
- * starts at line 40 in a file named Foo.graphql, it might be useful for name to
- * be "Foo.graphql" and location to be `{ line: 40, column: 0 }`.
- * line and column in locationOffset are 1-indexed
+ * A representation of source input to GraphQL. The `name` and `locationOffset` parameters are
+ * optional, but they are useful for clients who store GraphQL documents in source files.
+ * For example, if the GraphQL input starts at line 40 in a file named `Foo.graphql`, it might
+ * be useful for `name` to be `"Foo.graphql"` and location to be `{ line: 40, column: 1 }`.
+ * The `line` and `column` properties in `locationOffset` are 1-indexed.
  */
 var Source = /*#__PURE__*/function () {
   function Source(body) {

package/language/source.js.flow

@@ -10,12 +10,11 @@ type Location = {|
 |};
 
 /**
- * A representation of source input to GraphQL.
- * `name` and `locationOffset` are optional. They are useful for clients who
- * store GraphQL documents in source files; for example, if the GraphQL input
- * starts at line 40 in a file named Foo.graphql, it might be useful for name to
- * be "Foo.graphql" and location to be `{ line: 40, column: 0 }`.
- * line and column in locationOffset are 1-indexed
+ * A representation of source input to GraphQL. The `name` and `locationOffset` parameters are
+ * optional, but they are useful for clients who store GraphQL documents in source files.
+ * For example, if the GraphQL input starts at line 40 in a file named `Foo.graphql`, it might
+ * be useful for `name` to be `"Foo.graphql"` and location to be `{ line: 40, column: 1 }`.
+ * The `line` and `column` properties in `locationOffset` are 1-indexed.
  */
 export class Source {
   body: string;

package/language/source.mjs

@@ -6,12 +6,11 @@ import { SYMBOL_TO_STRING_TAG } from "../polyfills/symbols.mjs";
 import devAssert from "../jsutils/devAssert.mjs";
 
 /**
- * A representation of source input to GraphQL.
- * `name` and `locationOffset` are optional. They are useful for clients who
- * store GraphQL documents in source files; for example, if the GraphQL input
- * starts at line 40 in a file named Foo.graphql, it might be useful for name to
- * be "Foo.graphql" and location to be `{ line: 40, column: 0 }`.
- * line and column in locationOffset are 1-indexed
+ * A representation of source input to GraphQL. The `name` and `locationOffset` parameters are
+ * optional, but they are useful for clients who store GraphQL documents in source files.
+ * For example, if the GraphQL input starts at line 40 in a file named `Foo.graphql`, it might
+ * be useful for `name` to be `"Foo.graphql"` and location to be `{ line: 40, column: 1 }`.
+ * The `line` and `column` properties in `locationOffset` are 1-indexed.
  */
 export var Source = /*#__PURE__*/function () {
   function Source(body) {

package/language/visitor.d.ts

@@ -151,7 +151,7 @@ export const QueryDocumentKeys: {
 export const BREAK: any;
 
 /**
- * visit() will walk through an AST using a depth first traversal, calling
+ * visit() will walk through an AST using a depth-first traversal, calling
  * the visitor's enter function at each node in the traversal, and calling the
  * leave function after visiting that node and all of its child nodes.
  *
@@ -185,10 +185,10 @@ export const BREAK: any;
  *
  * Alternatively to providing enter() and leave() functions, a visitor can
  * instead provide functions named the same as the kinds of AST nodes, or
- * enter/leave visitors at a named key, leading to four permutations of
+ * enter/leave visitors at a named key, leading to four permutations of the
  * visitor API:
  *
- * 1) Named visitors triggered when entering a node a specific kind.
+ * 1) Named visitors triggered when entering a node of a specific kind.
  *
  *     visit(ast, {
  *       Kind(node) {

package/language/visitor.js

@@ -64,7 +64,7 @@ var QueryDocumentKeys = {
 exports.QueryDocumentKeys = QueryDocumentKeys;
 var BREAK = Object.freeze({});
 /**
- * visit() will walk through an AST using a depth first traversal, calling
+ * visit() will walk through an AST using a depth-first traversal, calling
  * the visitor's enter function at each node in the traversal, and calling the
  * leave function after visiting that node and all of its child nodes.
  *
@@ -98,10 +98,10 @@ var BREAK = Object.freeze({});
  *
  * Alternatively to providing enter() and leave() functions, a visitor can
  * instead provide functions named the same as the kinds of AST nodes, or
- * enter/leave visitors at a named key, leading to four permutations of
+ * enter/leave visitors at a named key, leading to four permutations of the
  * visitor API:
  *
- * 1) Named visitors triggered when entering a node a specific kind.
+ * 1) Named visitors triggered when entering a node of a specific kind.
  *
  *     visit(ast, {
  *       Kind(node) {

package/language/visitor.js.flow

@@ -139,7 +139,7 @@ export const QueryDocumentKeys: VisitorKeyMap<ASTKindToNode> = {
 export const BREAK: { ... } = Object.freeze({});
 
 /**
- * visit() will walk through an AST using a depth first traversal, calling
+ * visit() will walk through an AST using a depth-first traversal, calling
  * the visitor's enter function at each node in the traversal, and calling the
  * leave function after visiting that node and all of its child nodes.
  *
@@ -173,10 +173,10 @@ export const BREAK: { ... } = Object.freeze({});
  *
  * Alternatively to providing enter() and leave() functions, a visitor can
  * instead provide functions named the same as the kinds of AST nodes, or
- * enter/leave visitors at a named key, leading to four permutations of
+ * enter/leave visitors at a named key, leading to four permutations of the
  * visitor API:
  *
- * 1) Named visitors triggered when entering a node a specific kind.
+ * 1) Named visitors triggered when entering a node of a specific kind.
  *
  *     visit(ast, {
  *       Kind(node) {

package/language/visitor.mjs

@@ -54,7 +54,7 @@ export var QueryDocumentKeys = {
 };
 export var BREAK = Object.freeze({});
 /**
- * visit() will walk through an AST using a depth first traversal, calling
+ * visit() will walk through an AST using a depth-first traversal, calling
  * the visitor's enter function at each node in the traversal, and calling the
  * leave function after visiting that node and all of its child nodes.
  *
@@ -88,10 +88,10 @@ export var BREAK = Object.freeze({});
  *
  * Alternatively to providing enter() and leave() functions, a visitor can
  * instead provide functions named the same as the kinds of AST nodes, or
- * enter/leave visitors at a named key, leading to four permutations of
+ * enter/leave visitors at a named key, leading to four permutations of the
  * visitor API:
  *
- * 1) Named visitors triggered when entering a node a specific kind.
+ * 1) Named visitors triggered when entering a node of a specific kind.
  *
  *     visit(ast, {
  *       Kind(node) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql",
-  "version": "15.2.0",
+  "version": "15.3.0",
   "description": "A Query Language and Runtime which can target any service.",
   "license": "MIT",
   "main": "index",
@@ -23,4 +23,4 @@
     "node": ">= 10.x"
   },
   "dependencies": {}
-}
+}

package/type/definition.d.ts

@@ -241,15 +241,13 @@ export function isNullableType(type: any): type is GraphQLNullableType;
 
 export function assertNullableType(type: any): GraphQLNullableType;
 
-// FIXME Disabled because of https://github.com/yaacovCR/graphql-tools-fork/issues/40#issuecomment-586671219
-// tslint:disable:unified-signatures
 export function getNullableType(type: undefined): undefined;
 export function getNullableType<T extends GraphQLNullableType>(type: T): T;
 export function getNullableType<T extends GraphQLNullableType>(
+  // FIXME Disabled because of https://github.com/yaacovCR/graphql-tools-fork/issues/40#issuecomment-586671219
   // eslint-disable-next-line @typescript-eslint/unified-signatures
   type: GraphQLNonNull<T>,
 ): T;
-// tslint:enable:unified-signatures
 
 /**
  * These named types do not include modifiers like List or NonNull.

package/version.js

@@ -13,7 +13,7 @@ exports.versionInfo = exports.version = void 0;
 /**
  * A string containing the version of the GraphQL.js library
  */
-var version = '15.2.0';
+var version = '15.3.0';
 /**
  * An object containing the components of the GraphQL.js version string
  */
@@ -21,7 +21,7 @@ var version = '15.2.0';
 exports.version = version;
 var versionInfo = Object.freeze({
   major: 15,
-  minor: 2,
+  minor: 3,
   patch: 0,
   preReleaseTag: null
 });

package/version.js.flow

@@ -8,14 +8,14 @@
 /**
  * A string containing the version of the GraphQL.js library
  */
-export const version = '15.2.0';
+export const version = '15.3.0';
 
 /**
  * An object containing the components of the GraphQL.js version string
  */
 export const versionInfo = Object.freeze({
   major: 15,
-  minor: 2,
+  minor: 3,
   patch: 0,
   preReleaseTag: null,
 });

package/version.mjs

@@ -6,14 +6,14 @@
 /**
  * A string containing the version of the GraphQL.js library
  */
-export var version = '15.2.0';
+export var version = '15.3.0';
 /**
  * An object containing the components of the GraphQL.js version string
  */
 
 export var versionInfo = Object.freeze({
   major: 15,
-  minor: 2,
+  minor: 3,
   patch: 0,
   preReleaseTag: null
 });