Added new 'FormattedExecutionResult' type (#2688)

Author: IvanGoncharov

src/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;

src/execution/execute.js

@@ -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,

src/execution/index.d.ts

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

src/execution/index.js

@@ -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';

src/index.d.ts

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

src/index.js

@@ -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';