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

package/execution/ExecutionArgs.d.ts

@@ -0,0 +1,101 @@
+/** @category Execution */
+import type { Maybe } from "../jsutils/Maybe.js";
+import type { ObjMap } from "../jsutils/ObjMap.js";
+import type { DocumentNode, FragmentDefinitionNode, OperationDefinitionNode, SubscriptionOperationDefinitionNode } from "../language/ast.js";
+import type { GraphQLFieldResolver, GraphQLTypeResolver } from "../type/definition.js";
+import type { GraphQLSchema } from "../type/schema.js";
+import type { FragmentDetails } from "./collectFields.js";
+import type { VariableValues } from "./values.js";
+/** Arguments accepted by execute and executeSync. */
+export interface ExecutionArgs {
+    /** The schema used for validation or execution. */
+    schema: GraphQLSchema;
+    /** The parsed GraphQL document to execute. */
+    document: DocumentNode;
+    /** Initial root value passed to the operation. */
+    rootValue?: unknown;
+    /** Application context value passed to every resolver. */
+    contextValue?: unknown;
+    /** Runtime variable values keyed by variable name. */
+    variableValues?: Maybe<{
+        readonly [variable: string]: unknown;
+    }>;
+    /** Name of the operation to execute when the document contains multiple operations. */
+    operationName?: Maybe<string>;
+    /** Resolver used when a field does not define its own resolver. */
+    fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
+    /** Resolver used when an abstract type does not define its own resolver. */
+    typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
+    /** Resolver used for the root subscription field. */
+    subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
+    /** Whether suggestion text should be omitted from request errors. */
+    hideSuggestions?: Maybe<boolean>;
+    /** AbortSignal used to cancel execution. */
+    abortSignal?: Maybe<AbortSignal>;
+    /** Whether incremental execution may begin eligible work early. */
+    enableEarlyExecution?: Maybe<boolean>;
+    /** Execution hooks invoked during this operation. */
+    hooks?: Maybe<ExecutionHooks>;
+    /** Additional execution options. */
+    options?: {
+        /**
+         * Set the maximum number of errors allowed for coercing (defaults to 50).
+         *
+         * @internal
+         */
+        maxCoercionErrors?: number;
+    };
+}
+/**
+ * Data that must be available at all points during query execution.
+ *
+ * Namely, schema of the type system that is currently executing,
+ * and the fragments defined in the query document
+ */
+export interface ValidatedExecutionArgs {
+    /** Schema used for execution. */
+    schema: GraphQLSchema;
+    /** Fragment definitions keyed by fragment name. */
+    fragmentDefinitions: ObjMap<FragmentDefinitionNode>;
+    /** Fragment details keyed by fragment name. */
+    fragments: ObjMap<FragmentDetails>;
+    /** Root value passed to the operation. */
+    rootValue: unknown;
+    /** Application context value passed to every resolver. */
+    contextValue: unknown;
+    /** Operation definition selected for execution. */
+    operation: OperationDefinitionNode;
+    /** Operation variable values with source metadata and coerced runtime values. */
+    variableValues: VariableValues;
+    /** Resolver used for fields without an explicit resolver. */
+    fieldResolver: GraphQLFieldResolver<any, any>;
+    /** Resolver used for abstract types without an explicit type resolver. */
+    typeResolver: GraphQLTypeResolver<any, any>;
+    /** Resolver used for subscription fields without an explicit subscribe resolver. */
+    subscribeFieldResolver: GraphQLFieldResolver<any, any>;
+    /** Whether suggestion text should be omitted from execution errors. */
+    hideSuggestions: boolean;
+    /** Whether execution should use error propagation. */
+    errorPropagation: boolean;
+    /** External signal that may abort execution. */
+    externalAbortSignal: AbortSignal | undefined;
+    /** Whether incremental execution may begin eligible work early. */
+    enableEarlyExecution: boolean;
+    /** Execution hooks supplied by the caller. */
+    hooks: ExecutionHooks | undefined;
+}
+/** Validated execution arguments for a subscription operation. */
+export interface ValidatedSubscriptionArgs extends ValidatedExecutionArgs {
+    /** Subscription operation definition selected for execution. */
+    operation: SubscriptionOperationDefinitionNode;
+}
+/** Information passed to hooks after asynchronous execution work has finished. */
+export interface AsyncWorkFinishedInfo {
+    /** Validated execution arguments for the operation that finished async work. */
+    validatedExecutionArgs: ValidatedExecutionArgs;
+}
+/** Optional hooks invoked during GraphQL execution. */
+export interface ExecutionHooks {
+    /** Called after all tracked asynchronous execution work has settled. */
+    asyncWorkFinished?: (info: AsyncWorkFinishedInfo) => void;
+}

package/execution/ExecutionArgs.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ExecutionArgs.js.map

package/execution/ExecutionArgs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExecutionArgs.js","sourceRoot":"","sources":["../../src/execution/ExecutionArgs.ts"],"names":[],"mappings":"","sourcesContent":["/** @category Execution */\n\nimport type { Maybe } from '../jsutils/Maybe.ts';\nimport type { ObjMap } from '../jsutils/ObjMap.ts';\n\nimport type {\n  DocumentNode,\n  FragmentDefinitionNode,\n  OperationDefinitionNode,\n  SubscriptionOperationDefinitionNode,\n} from '../language/ast.ts';\n\nimport type {\n  GraphQLFieldResolver,\n  GraphQLTypeResolver,\n} from '../type/definition.ts';\nimport type { GraphQLSchema } from '../type/schema.ts';\n\nimport type { FragmentDetails } from './collectFields.ts';\nimport type { VariableValues } from './values.ts';\n\n/** Arguments accepted by execute and executeSync. */\nexport interface ExecutionArgs {\n  /** The schema used for validation or execution. */\n  schema: GraphQLSchema;\n  /** The parsed GraphQL document to execute. */\n  document: DocumentNode;\n  /** Initial root value passed to the operation. */\n  rootValue?: unknown;\n  /** Application context value passed to every resolver. */\n  contextValue?: unknown;\n  /** Runtime variable values keyed by variable name. */\n  variableValues?: Maybe<{ readonly [variable: string]: unknown }>;\n  /** Name of the operation to execute when the document contains multiple operations. */\n  operationName?: Maybe<string>;\n  /** Resolver used when a field does not define its own resolver. */\n  fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;\n  /** Resolver used when an abstract type does not define its own resolver. */\n  typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;\n  /** Resolver used for the root subscription field. */\n  subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;\n  /** Whether suggestion text should be omitted from request errors. */\n  hideSuggestions?: Maybe<boolean>;\n  /** AbortSignal used to cancel execution. */\n  abortSignal?: Maybe<AbortSignal>;\n  /** Whether incremental execution may begin eligible work early. */\n  enableEarlyExecution?: Maybe<boolean>;\n  /** Execution hooks invoked during this operation. */\n  hooks?: Maybe<ExecutionHooks>;\n  /** Additional execution options. */\n  options?: {\n    /**\n     * Set the maximum number of errors allowed for coercing (defaults to 50).\n     *\n     * @internal\n     */\n    maxCoercionErrors?: number;\n  };\n}\n\n/**\n * Data that must be available at all points during query execution.\n *\n * Namely, schema of the type system that is currently executing,\n * and the fragments defined in the query document\n */\nexport interface ValidatedExecutionArgs {\n  /** Schema used for execution. */\n  schema: GraphQLSchema;\n  // TODO: consider deprecating/removing fragmentDefinitions if/when fragment\n  // arguments are officially supported and/or the full fragment details are\n  // exposed within GraphQLResolveInfo.\n  /** Fragment definitions keyed by fragment name. */\n  fragmentDefinitions: ObjMap<FragmentDefinitionNode>;\n  /** Fragment details keyed by fragment name. */\n  fragments: ObjMap<FragmentDetails>;\n  /** Root value passed to the operation. */\n  rootValue: unknown;\n  /** Application context value passed to every resolver. */\n  contextValue: unknown;\n  /** Operation definition selected for execution. */\n  operation: OperationDefinitionNode;\n  /** Operation variable values with source metadata and coerced runtime values. */\n  variableValues: VariableValues;\n  /** Resolver used for fields without an explicit resolver. */\n  fieldResolver: GraphQLFieldResolver<any, any>;\n  /** Resolver used for abstract types without an explicit type resolver. */\n  typeResolver: GraphQLTypeResolver<any, any>;\n  /** Resolver used for subscription fields without an explicit subscribe resolver. */\n  subscribeFieldResolver: GraphQLFieldResolver<any, any>;\n  /** Whether suggestion text should be omitted from execution errors. */\n  hideSuggestions: boolean;\n  /** Whether execution should use error propagation. */\n  errorPropagation: boolean;\n  /** External signal that may abort execution. */\n  externalAbortSignal: AbortSignal | undefined;\n  /** Whether incremental execution may begin eligible work early. */\n  enableEarlyExecution: boolean;\n  /** Execution hooks supplied by the caller. */\n  hooks: ExecutionHooks | undefined;\n}\n\n/** Validated execution arguments for a subscription operation. */\nexport interface ValidatedSubscriptionArgs extends ValidatedExecutionArgs {\n  /** Subscription operation definition selected for execution. */\n  operation: SubscriptionOperationDefinitionNode;\n}\n\n/** Information passed to hooks after asynchronous execution work has finished. */\nexport interface AsyncWorkFinishedInfo {\n  /** Validated execution arguments for the operation that finished async work. */\n  validatedExecutionArgs: ValidatedExecutionArgs;\n}\n\n/** Optional hooks invoked during GraphQL execution. */\nexport interface ExecutionHooks {\n  /** Called after all tracked asynchronous execution work has settled. */\n  asyncWorkFinished?: (info: AsyncWorkFinishedInfo) => void;\n}\n"]}

package/execution/ExecutionArgs.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ExecutionArgs.js.map

package/execution/ExecutionArgs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExecutionArgs.js","sourceRoot":"","sources":["../../src/execution/ExecutionArgs.ts"],"names":[],"mappings":"","sourcesContent":["/** @category Execution */\n\nimport type { Maybe } from '../jsutils/Maybe.ts';\nimport type { ObjMap } from '../jsutils/ObjMap.ts';\n\nimport type {\n  DocumentNode,\n  FragmentDefinitionNode,\n  OperationDefinitionNode,\n  SubscriptionOperationDefinitionNode,\n} from '../language/ast.ts';\n\nimport type {\n  GraphQLFieldResolver,\n  GraphQLTypeResolver,\n} from '../type/definition.ts';\nimport type { GraphQLSchema } from '../type/schema.ts';\n\nimport type { FragmentDetails } from './collectFields.ts';\nimport type { VariableValues } from './values.ts';\n\n/** Arguments accepted by execute and executeSync. */\nexport interface ExecutionArgs {\n  /** The schema used for validation or execution. */\n  schema: GraphQLSchema;\n  /** The parsed GraphQL document to execute. */\n  document: DocumentNode;\n  /** Initial root value passed to the operation. */\n  rootValue?: unknown;\n  /** Application context value passed to every resolver. */\n  contextValue?: unknown;\n  /** Runtime variable values keyed by variable name. */\n  variableValues?: Maybe<{ readonly [variable: string]: unknown }>;\n  /** Name of the operation to execute when the document contains multiple operations. */\n  operationName?: Maybe<string>;\n  /** Resolver used when a field does not define its own resolver. */\n  fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;\n  /** Resolver used when an abstract type does not define its own resolver. */\n  typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;\n  /** Resolver used for the root subscription field. */\n  subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;\n  /** Whether suggestion text should be omitted from request errors. */\n  hideSuggestions?: Maybe<boolean>;\n  /** AbortSignal used to cancel execution. */\n  abortSignal?: Maybe<AbortSignal>;\n  /** Whether incremental execution may begin eligible work early. */\n  enableEarlyExecution?: Maybe<boolean>;\n  /** Execution hooks invoked during this operation. */\n  hooks?: Maybe<ExecutionHooks>;\n  /** Additional execution options. */\n  options?: {\n    /**\n     * Set the maximum number of errors allowed for coercing (defaults to 50).\n     *\n     * @internal\n     */\n    maxCoercionErrors?: number;\n  };\n}\n\n/**\n * Data that must be available at all points during query execution.\n *\n * Namely, schema of the type system that is currently executing,\n * and the fragments defined in the query document\n */\nexport interface ValidatedExecutionArgs {\n  /** Schema used for execution. */\n  schema: GraphQLSchema;\n  // TODO: consider deprecating/removing fragmentDefinitions if/when fragment\n  // arguments are officially supported and/or the full fragment details are\n  // exposed within GraphQLResolveInfo.\n  /** Fragment definitions keyed by fragment name. */\n  fragmentDefinitions: ObjMap<FragmentDefinitionNode>;\n  /** Fragment details keyed by fragment name. */\n  fragments: ObjMap<FragmentDetails>;\n  /** Root value passed to the operation. */\n  rootValue: unknown;\n  /** Application context value passed to every resolver. */\n  contextValue: unknown;\n  /** Operation definition selected for execution. */\n  operation: OperationDefinitionNode;\n  /** Operation variable values with source metadata and coerced runtime values. */\n  variableValues: VariableValues;\n  /** Resolver used for fields without an explicit resolver. */\n  fieldResolver: GraphQLFieldResolver<any, any>;\n  /** Resolver used for abstract types without an explicit type resolver. */\n  typeResolver: GraphQLTypeResolver<any, any>;\n  /** Resolver used for subscription fields without an explicit subscribe resolver. */\n  subscribeFieldResolver: GraphQLFieldResolver<any, any>;\n  /** Whether suggestion text should be omitted from execution errors. */\n  hideSuggestions: boolean;\n  /** Whether execution should use error propagation. */\n  errorPropagation: boolean;\n  /** External signal that may abort execution. */\n  externalAbortSignal: AbortSignal | undefined;\n  /** Whether incremental execution may begin eligible work early. */\n  enableEarlyExecution: boolean;\n  /** Execution hooks supplied by the caller. */\n  hooks: ExecutionHooks | undefined;\n}\n\n/** Validated execution arguments for a subscription operation. */\nexport interface ValidatedSubscriptionArgs extends ValidatedExecutionArgs {\n  /** Subscription operation definition selected for execution. */\n  operation: SubscriptionOperationDefinitionNode;\n}\n\n/** Information passed to hooks after asynchronous execution work has finished. */\nexport interface AsyncWorkFinishedInfo {\n  /** Validated execution arguments for the operation that finished async work. */\n  validatedExecutionArgs: ValidatedExecutionArgs;\n}\n\n/** Optional hooks invoked during GraphQL execution. */\nexport interface ExecutionHooks {\n  /** Called after all tracked asynchronous execution work has settled. */\n  asyncWorkFinished?: (info: AsyncWorkFinishedInfo) => void;\n}\n"]}

package/execution/Executor.d.mts

@@ -1,19 +1,18 @@
-import type { ObjMap } from '../jsutils/ObjMap.js';
-import type { Path } from '../jsutils/Path.js';
-import type { PromiseOrValue } from '../jsutils/PromiseOrValue.js';
-import type { GraphQLFormattedError } from '../error/GraphQLError.js';
-import { GraphQLError } from '../error/GraphQLError.js';
-import type { FragmentDefinitionNode, OperationDefinitionNode, SubscriptionOperationDefinitionNode } from '../language/ast.js';
-import type { GraphQLAbstractType, GraphQLFieldResolver, GraphQLLeafType, GraphQLList, GraphQLObjectType, GraphQLOutputType, GraphQLResolveInfo, GraphQLResolveInfoHelpers, GraphQLTypeResolver } from '../type/definition.js';
-import type { GraphQLSchema } from '../type/schema.js';
-import { AbortedGraphQLExecutionError } from './AbortedGraphQLExecutionError.js';
-import type { DeferUsage, FieldDetailsList, FragmentDetails, GroupedFieldSet } from './collectFields.js';
-import { collectSubfields as _collectSubfields } from './collectFields.js';
-import type { SharedExecutionContext } from './createSharedExecutionContext.js';
-import type { StreamUsage } from './getStreamUsage.js';
-import { getStreamUsage as _getStreamUsage } from './getStreamUsage.js';
-import type { ExecutionHooks } from './hooks.js';
-import type { VariableValues } from './values.js';
+/** @category Execution */
+import type { ObjMap } from "../jsutils/ObjMap.mjs";
+import type { Path } from "../jsutils/Path.mjs";
+import type { PromiseOrValue } from "../jsutils/PromiseOrValue.mjs";
+import type { GraphQLFormattedError } from "../error/GraphQLError.mjs";
+import { GraphQLError } from "../error/GraphQLError.mjs";
+import type { GraphQLAbstractType, GraphQLLeafType, GraphQLList, GraphQLObjectType, GraphQLOutputType, GraphQLResolveInfo, GraphQLResolveInfoHelpers } from "../type/definition.mjs";
+import type { GraphQLSchema } from "../type/schema.mjs";
+import { AbortedGraphQLExecutionError } from "./AbortedGraphQLExecutionError.mjs";
+import type { DeferUsage, FieldDetailsList, GroupedFieldSet } from "./collectFields.mjs";
+import { collectSubfields as _collectSubfields } from "./collectFields.mjs";
+import type { SharedExecutionContext } from "./createSharedExecutionContext.mjs";
+import type { ValidatedExecutionArgs } from "./ExecutionArgs.mjs";
+import type { StreamUsage } from "./getStreamUsage.mjs";
+import { getStreamUsage as _getStreamUsage } from "./getStreamUsage.mjs";
 /**
  * Terminology
  *
@@ -32,44 +31,19 @@ import type { VariableValues } from './values.js';
  * 1) field references e.g `a`
  * 2) fragment "spreads" e.g. `...c`
  * 3) inline fragment "spreads" e.g. `...on Type { a }`
- */
-/**
- * Data that must be available at all points during query execution.
  *
- * Namely, schema of the type system that is currently executing,
- * and the fragments defined in the query document
+ * @internal
  */
-export interface ValidatedExecutionArgs {
-    schema: GraphQLSchema;
-    fragmentDefinitions: ObjMap<FragmentDefinitionNode>;
-    fragments: ObjMap<FragmentDetails>;
-    rootValue: unknown;
-    contextValue: unknown;
-    operation: OperationDefinitionNode;
-    variableValues: VariableValues;
-    fieldResolver: GraphQLFieldResolver<any, any>;
-    typeResolver: GraphQLTypeResolver<any, any>;
-    subscribeFieldResolver: GraphQLFieldResolver<any, any>;
-    perEventExecutor: (validatedExecutionArgs: ValidatedSubscriptionArgs) => PromiseOrValue<ExecutionResult>;
-    hideSuggestions: boolean;
-    errorPropagation: boolean;
-    externalAbortSignal: AbortSignal | undefined;
-    enableEarlyExecution: boolean;
-    hooks: ExecutionHooks | undefined;
-}
-export interface ValidatedSubscriptionArgs extends ValidatedExecutionArgs {
-    operation: SubscriptionOperationDefinitionNode;
-}
 /**
  * A memoized collection of relevant subfields with regard to the return
  * type. Memoizing ensures the subfields are not repeatedly calculated, which
  * saves overhead when resolving lists of values.
+ *
+ * @internal
  */
 export declare const collectSubfields: (validatedExecutionArgs: ValidatedExecutionArgs, returnType: GraphQLObjectType, fieldDetailsList: FieldDetailsList) => ReturnType<typeof _collectSubfields>;
+/** @internal */
 export declare const getStreamUsage: typeof _getStreamUsage;
-/**
- * @internal
- */
 declare class CollectedErrors {
     private _errorPositions;
     private _errors;
@@ -79,22 +53,29 @@ declare class CollectedErrors {
     hasNulledPosition(startPath: Path | undefined): boolean;
 }
 /**
- * The result of GraphQL execution.
- *
- *   - `errors` is included when any errors occurred as a non-empty array.
- *   - `data` is the result of a successful execution of the query.
- *   - `hasNext` is true if a future payload is expected.
- *   - `extensions` is reserved for adding non-standard properties.
- *   - `incremental` is a list of the results from defer/stream directives.
+ * Represents the response produced by executing a GraphQL operation.
+ * @typeParam TData - Shape of the execution data payload.
+ * @typeParam TExtensions - Shape of the extensions payload.
  */
 export interface ExecutionResult<TData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> {
+    /** Errors raised while parsing, validating, or executing the operation. */
     errors?: ReadonlyArray<GraphQLError>;
+    /** Data returned by execution, or null when execution could not produce data. */
     data?: TData | null;
+    /** Additional non-standard metadata included in the execution result. */
     extensions?: TExtensions;
 }
+/**
+ * A JSON-serializable GraphQL execution result.
+ * @typeParam TData - Shape of the formatted data payload.
+ * @typeParam TExtensions - Shape of the formatted extensions payload.
+ */
 export interface FormattedExecutionResult<TData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> {
+    /** Errors raised while parsing, validating, or executing the operation. */
     errors?: ReadonlyArray<GraphQLFormattedError>;
+    /** Data returned by execution, or null when execution could not produce data. */
     data?: TData | null;
+    /** Additional non-standard metadata included in the formatted result. */
     extensions?: TExtensions;
 }
 /** @internal */
@@ -119,6 +100,8 @@ TAlternativeInitialResponse = ExecutionResult> {
     /**
      * Given a completed execution context and data, build the `{ errors, data }`
      * response defined by the "Response" section of the GraphQL specification.
+     *
+     * @internal
      */
     buildResponse(data: ObjMap<unknown> | null): ExecutionResult | TAlternativeInitialResponse;
     executeCollectedRootFields(rootType: GraphQLObjectType, rootValue: unknown, originalGroupedFieldSet: GroupedFieldSet, serially: boolean, _newDeferUsages: ReadonlyArray<DeferUsage>): PromiseOrValue<ObjMap<unknown>>;
@@ -126,11 +109,15 @@ TAlternativeInitialResponse = ExecutionResult> {
     /**
      * Implements the "Executing selection sets" section of the spec
      * for fields that must be executed serially.
+     *
+     * @internal
      */
     executeFieldsSerially(parentType: GraphQLObjectType, sourceValue: unknown, path: Path | undefined, groupedFieldSet: GroupedFieldSet, positionContext: TPositionContext | undefined): PromiseOrValue<ObjMap<unknown>>;
     /**
      * Implements the "Executing selection sets" section of the spec
      * for fields that may be executed in parallel.
+     *
+     * @internal
      */
     executeFields(parentType: GraphQLObjectType, sourceValue: unknown, path: Path | undefined, groupedFieldSet: GroupedFieldSet, positionContext: TPositionContext | undefined): PromiseOrValue<ObjMap<unknown>>;
     /**
@@ -138,6 +125,8 @@ TAlternativeInitialResponse = ExecutionResult> {
      * In particular, this function figures out the value that the field returns by
      * calling its resolve function, then calls completeValue to complete promises,
      * coercing scalars, or execute the sub-selection-set for objects.
+     *
+     * @internal
      */
     executeField(parentType: GraphQLObjectType, source: unknown, fieldDetailsList: FieldDetailsList, path: Path, positionContext: TPositionContext | undefined): PromiseOrValue<unknown>;
     handleFieldError(rawError: unknown, returnType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, path: Path): void;
@@ -161,12 +150,16 @@ TAlternativeInitialResponse = ExecutionResult> {
      *
      * Otherwise, the field type expects a sub-selection set, and will complete the
      * value by executing all sub-selections.
+     *
+     * @internal
      */
     completeValue(returnType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, result: unknown, positionContext: TPositionContext | undefined): PromiseOrValue<unknown>;
     completePromisedValue(returnType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, result: PromiseLike<unknown>, positionContext: TPositionContext | undefined): Promise<unknown>;
     /**
      * Complete a async iterator value by completing the result and calling
      * recursively until all the results are completed.
+     *
+     * @internal
      */
     completeAsyncIterableValue(itemType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, items: AsyncIterable<unknown>, positionContext: TPositionContext | undefined): Promise<ReadonlyArray<unknown>>;
     handleStream(_index: number, _path: Path, _iterator: {
@@ -179,6 +172,8 @@ TAlternativeInitialResponse = ExecutionResult> {
     /**
      * Complete a list value by completing each item in the list with the
      * inner type
+     *
+     * @internal
      */
     completeListValue(returnType: GraphQLList<GraphQLOutputType>, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, result: unknown, positionContext: TPositionContext | undefined): PromiseOrValue<ReadonlyArray<unknown>>;
     completeIterableValue(itemType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, items: Iterable<unknown>, positionContext: TPositionContext | undefined): PromiseOrValue<ReadonlyArray<unknown>>;
@@ -187,22 +182,30 @@ TAlternativeInitialResponse = ExecutionResult> {
      * Complete a list item value by adding it to the completed results.
      *
      * Returns true if the value is a Promise.
+     *
+     * @internal
      */
     completeListItemValue(item: unknown, completedResults: Array<unknown>, itemType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, itemPath: Path, positionContext: TPositionContext | undefined): boolean;
     completePromisedListItemValue(item: PromiseLike<unknown>, itemType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, itemPath: Path, positionContext: TPositionContext | undefined): Promise<unknown>;
     /**
      * Complete a Scalar or Enum by serializing to a valid value, returning
      * null if serialization is not possible.
+     *
+     * @internal
      */
     completeLeafValue(returnType: GraphQLLeafType, result: unknown): unknown;
     /**
      * Complete a value of an abstract type by determining the runtime object type
      * of that value, then complete the value for that type.
+     *
+     * @internal
      */
     completeAbstractValue(returnType: GraphQLAbstractType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, result: unknown, positionContext: TPositionContext | undefined): PromiseOrValue<ObjMap<unknown>>;
     ensureValidRuntimeType(runtimeTypeName: unknown, schema: GraphQLSchema, returnType: GraphQLAbstractType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, result: unknown): GraphQLObjectType;
     /**
      * Complete an Object value by executing all sub-selections.
+     *
+     * @internal
      */
     completeObjectValue(returnType: GraphQLObjectType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, result: unknown, positionContext: TPositionContext | undefined): PromiseOrValue<ObjMap<unknown>>;
     invalidReturnTypeError(returnType: GraphQLObjectType, result: unknown, fieldDetailsList: FieldDetailsList): GraphQLError;

package/execution/Executor.d.ts

@@ -1,19 +1,18 @@
-import type { ObjMap } from '../jsutils/ObjMap.js';
-import type { Path } from '../jsutils/Path.js';
-import type { PromiseOrValue } from '../jsutils/PromiseOrValue.js';
-import type { GraphQLFormattedError } from '../error/GraphQLError.js';
-import { GraphQLError } from '../error/GraphQLError.js';
-import type { FragmentDefinitionNode, OperationDefinitionNode, SubscriptionOperationDefinitionNode } from '../language/ast.js';
-import type { GraphQLAbstractType, GraphQLFieldResolver, GraphQLLeafType, GraphQLList, GraphQLObjectType, GraphQLOutputType, GraphQLResolveInfo, GraphQLResolveInfoHelpers, GraphQLTypeResolver } from '../type/definition.js';
-import type { GraphQLSchema } from '../type/schema.js';
-import { AbortedGraphQLExecutionError } from './AbortedGraphQLExecutionError.js';
-import type { DeferUsage, FieldDetailsList, FragmentDetails, GroupedFieldSet } from './collectFields.js';
-import { collectSubfields as _collectSubfields } from './collectFields.js';
-import type { SharedExecutionContext } from './createSharedExecutionContext.js';
-import type { StreamUsage } from './getStreamUsage.js';
-import { getStreamUsage as _getStreamUsage } from './getStreamUsage.js';
-import type { ExecutionHooks } from './hooks.js';
-import type { VariableValues } from './values.js';
+/** @category Execution */
+import type { ObjMap } from "../jsutils/ObjMap.js";
+import type { Path } from "../jsutils/Path.js";
+import type { PromiseOrValue } from "../jsutils/PromiseOrValue.js";
+import type { GraphQLFormattedError } from "../error/GraphQLError.js";
+import { GraphQLError } from "../error/GraphQLError.js";
+import type { GraphQLAbstractType, GraphQLLeafType, GraphQLList, GraphQLObjectType, GraphQLOutputType, GraphQLResolveInfo, GraphQLResolveInfoHelpers } from "../type/definition.js";
+import type { GraphQLSchema } from "../type/schema.js";
+import { AbortedGraphQLExecutionError } from "./AbortedGraphQLExecutionError.js";
+import type { DeferUsage, FieldDetailsList, GroupedFieldSet } from "./collectFields.js";
+import { collectSubfields as _collectSubfields } from "./collectFields.js";
+import type { SharedExecutionContext } from "./createSharedExecutionContext.js";
+import type { ValidatedExecutionArgs } from "./ExecutionArgs.js";
+import type { StreamUsage } from "./getStreamUsage.js";
+import { getStreamUsage as _getStreamUsage } from "./getStreamUsage.js";
 /**
  * Terminology
  *
@@ -32,44 +31,19 @@ import type { VariableValues } from './values.js';
  * 1) field references e.g `a`
  * 2) fragment "spreads" e.g. `...c`
  * 3) inline fragment "spreads" e.g. `...on Type { a }`
- */
-/**
- * Data that must be available at all points during query execution.
  *
- * Namely, schema of the type system that is currently executing,
- * and the fragments defined in the query document
+ * @internal
  */
-export interface ValidatedExecutionArgs {
-    schema: GraphQLSchema;
-    fragmentDefinitions: ObjMap<FragmentDefinitionNode>;
-    fragments: ObjMap<FragmentDetails>;
-    rootValue: unknown;
-    contextValue: unknown;
-    operation: OperationDefinitionNode;
-    variableValues: VariableValues;
-    fieldResolver: GraphQLFieldResolver<any, any>;
-    typeResolver: GraphQLTypeResolver<any, any>;
-    subscribeFieldResolver: GraphQLFieldResolver<any, any>;
-    perEventExecutor: (validatedExecutionArgs: ValidatedSubscriptionArgs) => PromiseOrValue<ExecutionResult>;
-    hideSuggestions: boolean;
-    errorPropagation: boolean;
-    externalAbortSignal: AbortSignal | undefined;
-    enableEarlyExecution: boolean;
-    hooks: ExecutionHooks | undefined;
-}
-export interface ValidatedSubscriptionArgs extends ValidatedExecutionArgs {
-    operation: SubscriptionOperationDefinitionNode;
-}
 /**
  * A memoized collection of relevant subfields with regard to the return
  * type. Memoizing ensures the subfields are not repeatedly calculated, which
  * saves overhead when resolving lists of values.
+ *
+ * @internal
  */
 export declare const collectSubfields: (validatedExecutionArgs: ValidatedExecutionArgs, returnType: GraphQLObjectType, fieldDetailsList: FieldDetailsList) => ReturnType<typeof _collectSubfields>;
+/** @internal */
 export declare const getStreamUsage: typeof _getStreamUsage;
-/**
- * @internal
- */
 declare class CollectedErrors {
     private _errorPositions;
     private _errors;
@@ -79,22 +53,29 @@ declare class CollectedErrors {
     hasNulledPosition(startPath: Path | undefined): boolean;
 }
 /**
- * The result of GraphQL execution.
- *
- *   - `errors` is included when any errors occurred as a non-empty array.
- *   - `data` is the result of a successful execution of the query.
- *   - `hasNext` is true if a future payload is expected.
- *   - `extensions` is reserved for adding non-standard properties.
- *   - `incremental` is a list of the results from defer/stream directives.
+ * Represents the response produced by executing a GraphQL operation.
+ * @typeParam TData - Shape of the execution data payload.
+ * @typeParam TExtensions - Shape of the extensions payload.
  */
 export interface ExecutionResult<TData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> {
+    /** Errors raised while parsing, validating, or executing the operation. */
     errors?: ReadonlyArray<GraphQLError>;
+    /** Data returned by execution, or null when execution could not produce data. */
     data?: TData | null;
+    /** Additional non-standard metadata included in the execution result. */
     extensions?: TExtensions;
 }
+/**
+ * A JSON-serializable GraphQL execution result.
+ * @typeParam TData - Shape of the formatted data payload.
+ * @typeParam TExtensions - Shape of the formatted extensions payload.
+ */
 export interface FormattedExecutionResult<TData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> {
+    /** Errors raised while parsing, validating, or executing the operation. */
     errors?: ReadonlyArray<GraphQLFormattedError>;
+    /** Data returned by execution, or null when execution could not produce data. */
     data?: TData | null;
+    /** Additional non-standard metadata included in the formatted result. */
     extensions?: TExtensions;
 }
 /** @internal */
@@ -119,6 +100,8 @@ TAlternativeInitialResponse = ExecutionResult> {
     /**
      * Given a completed execution context and data, build the `{ errors, data }`
      * response defined by the "Response" section of the GraphQL specification.
+     *
+     * @internal
      */
     buildResponse(data: ObjMap<unknown> | null): ExecutionResult | TAlternativeInitialResponse;
     executeCollectedRootFields(rootType: GraphQLObjectType, rootValue: unknown, originalGroupedFieldSet: GroupedFieldSet, serially: boolean, _newDeferUsages: ReadonlyArray<DeferUsage>): PromiseOrValue<ObjMap<unknown>>;
@@ -126,11 +109,15 @@ TAlternativeInitialResponse = ExecutionResult> {
     /**
      * Implements the "Executing selection sets" section of the spec
      * for fields that must be executed serially.
+     *
+     * @internal
      */
     executeFieldsSerially(parentType: GraphQLObjectType, sourceValue: unknown, path: Path | undefined, groupedFieldSet: GroupedFieldSet, positionContext: TPositionContext | undefined): PromiseOrValue<ObjMap<unknown>>;
     /**
      * Implements the "Executing selection sets" section of the spec
      * for fields that may be executed in parallel.
+     *
+     * @internal
      */
     executeFields(parentType: GraphQLObjectType, sourceValue: unknown, path: Path | undefined, groupedFieldSet: GroupedFieldSet, positionContext: TPositionContext | undefined): PromiseOrValue<ObjMap<unknown>>;
     /**
@@ -138,6 +125,8 @@ TAlternativeInitialResponse = ExecutionResult> {
      * In particular, this function figures out the value that the field returns by
      * calling its resolve function, then calls completeValue to complete promises,
      * coercing scalars, or execute the sub-selection-set for objects.
+     *
+     * @internal
      */
     executeField(parentType: GraphQLObjectType, source: unknown, fieldDetailsList: FieldDetailsList, path: Path, positionContext: TPositionContext | undefined): PromiseOrValue<unknown>;
     handleFieldError(rawError: unknown, returnType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, path: Path): void;
@@ -161,12 +150,16 @@ TAlternativeInitialResponse = ExecutionResult> {
      *
      * Otherwise, the field type expects a sub-selection set, and will complete the
      * value by executing all sub-selections.
+     *
+     * @internal
      */
     completeValue(returnType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, result: unknown, positionContext: TPositionContext | undefined): PromiseOrValue<unknown>;
     completePromisedValue(returnType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, result: PromiseLike<unknown>, positionContext: TPositionContext | undefined): Promise<unknown>;
     /**
      * Complete a async iterator value by completing the result and calling
      * recursively until all the results are completed.
+     *
+     * @internal
      */
     completeAsyncIterableValue(itemType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, items: AsyncIterable<unknown>, positionContext: TPositionContext | undefined): Promise<ReadonlyArray<unknown>>;
     handleStream(_index: number, _path: Path, _iterator: {
@@ -179,6 +172,8 @@ TAlternativeInitialResponse = ExecutionResult> {
     /**
      * Complete a list value by completing each item in the list with the
      * inner type
+     *
+     * @internal
      */
     completeListValue(returnType: GraphQLList<GraphQLOutputType>, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, result: unknown, positionContext: TPositionContext | undefined): PromiseOrValue<ReadonlyArray<unknown>>;
     completeIterableValue(itemType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, items: Iterable<unknown>, positionContext: TPositionContext | undefined): PromiseOrValue<ReadonlyArray<unknown>>;
@@ -187,22 +182,30 @@ TAlternativeInitialResponse = ExecutionResult> {
      * Complete a list item value by adding it to the completed results.
      *
      * Returns true if the value is a Promise.
+     *
+     * @internal
      */
     completeListItemValue(item: unknown, completedResults: Array<unknown>, itemType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, itemPath: Path, positionContext: TPositionContext | undefined): boolean;
     completePromisedListItemValue(item: PromiseLike<unknown>, itemType: GraphQLOutputType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, itemPath: Path, positionContext: TPositionContext | undefined): Promise<unknown>;
     /**
      * Complete a Scalar or Enum by serializing to a valid value, returning
      * null if serialization is not possible.
+     *
+     * @internal
      */
     completeLeafValue(returnType: GraphQLLeafType, result: unknown): unknown;
     /**
      * Complete a value of an abstract type by determining the runtime object type
      * of that value, then complete the value for that type.
+     *
+     * @internal
      */
     completeAbstractValue(returnType: GraphQLAbstractType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, result: unknown, positionContext: TPositionContext | undefined): PromiseOrValue<ObjMap<unknown>>;
     ensureValidRuntimeType(runtimeTypeName: unknown, schema: GraphQLSchema, returnType: GraphQLAbstractType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, result: unknown): GraphQLObjectType;
     /**
      * Complete an Object value by executing all sub-selections.
+     *
+     * @internal
      */
     completeObjectValue(returnType: GraphQLObjectType, fieldDetailsList: FieldDetailsList, info: GraphQLResolveInfo, path: Path, result: unknown, positionContext: TPositionContext | undefined): PromiseOrValue<ObjMap<unknown>>;
     invalidReturnTypeError(returnType: GraphQLObjectType, result: unknown, fieldDetailsList: FieldDetailsList): GraphQLError;