graphql 17.0.0-beta.1 → 17.0.0-beta.2

package/language/visitor.d.mts

@@ -1,9 +1,7 @@
+/** @category Visiting */
 import type { ASTNode } from "./ast.mjs";
 import { Kind } from "./kinds.mjs";
-/**
- * A visitor is provided to visit, it contains the collection of
- * relevant functions to be called during the visitor's traversal.
- */
+/** A visitor defines the callbacks called during AST traversal. */
 export type ASTVisitor = EnterLeaveVisitor<ASTNode> | KindVisitor;
 type KindVisitor = {
     readonly [NodeT in ASTNode as NodeT['kind']]?: ASTVisitFn<NodeT> | EnterLeaveVisitor<NodeT>;
@@ -13,27 +11,28 @@ interface EnterLeaveVisitor<TVisitedNode extends ASTNode> {
     readonly leave?: ASTVisitFn<TVisitedNode> | undefined;
 }
 /**
- * A visitor is comprised of visit functions, which are called on each node
- * during the visitor's traversal.
+ * A visitor is composed of visit functions called for each node during traversal.
+ * @typeParam TVisitedNode - AST node type handled by this visitor function.
  */
 export type ASTVisitFn<TVisitedNode extends ASTNode> = (
-/** The current node being visiting. */
+/** Current node being visited. */
 node: TVisitedNode, 
-/** The index or key to this node from the parent node or Array. */
+/** Index or key for this node within the parent node or array. */
 key: string | number | undefined, 
-/** The parent immediately above this node, which may be an Array. */
+/** Parent immediately above this node, which may be an array. */
 parent: ASTNode | ReadonlyArray<ASTNode> | undefined, 
-/** The key path to get to this node from the root node. */
+/** Key path from the root node to this node. */
 path: ReadonlyArray<string | number>, 
 /**
- * All nodes and Arrays visited before reaching parent of this node.
+ * All nodes and arrays visited before reaching this node's parent.
  * These correspond to array indices in `path`.
- * Note: ancestors includes arrays which contain the parent of visited node.
+ * Note: ancestors includes arrays that contain the visited node's parent.
  */
 ancestors: ReadonlyArray<ASTNode | ReadonlyArray<ASTNode>>) => any;
 /**
- * A reducer is comprised of reducer functions which convert AST nodes into
- * another form.
+ * A reducer is composed of reducer functions that convert AST nodes into another form.
+ *
+ * @internal
  */
 export type ASTReducer<R> = {
     readonly [NodeT in ASTNode as NodeT['kind']]?: {
@@ -42,29 +41,41 @@ export type ASTReducer<R> = {
     };
 };
 type ASTReducerFn<TReducedNode extends ASTNode, R> = (
-/** The current node being visiting. */
+/**
+ * Current node being visited.
+ * @internal
+ */
 node: {
     [K in keyof TReducedNode]: ReducedField<TReducedNode[K], R>;
 }, 
-/** The index or key to this node from the parent node or Array. */
+/**
+ * Index or key for this node within the parent node or array.
+ * @internal
+ */
 key: string | number | undefined, 
-/** The parent immediately above this node, which may be an Array. */
+/**
+ * Parent immediately above this node, which may be an array.
+ * @internal
+ */
 parent: ASTNode | ReadonlyArray<ASTNode> | undefined, 
-/** The key path to get to this node from the root node. */
+/**
+ * Key path from the root node to this node.
+ * @internal
+ */
 path: ReadonlyArray<string | number>, 
 /**
- * All nodes and Arrays visited before reaching parent of this node.
+ * All nodes and arrays visited before reaching this node's parent.
  * These correspond to array indices in `path`.
- * Note: ancestors includes arrays which contain the parent of visited node.
+ * Note: ancestors includes arrays that contain the visited node's parent.
+ * @internal
  */
 ancestors: ReadonlyArray<ASTNode | ReadonlyArray<ASTNode>>) => R;
 type ReducedField<T, R> = T extends ASTNode ? R : T extends ReadonlyArray<ASTNode> ? ReadonlyArray<R> : T;
-/**
- * A KeyMap describes each the traversable properties of each kind of node.
- */
+/** A visitor key map describes the traversable child properties for each node kind. */
 export type ASTVisitorKeyMap = {
     [NodeT in ASTNode as NodeT['kind']]?: ReadonlyArray<keyof NodeT>;
 };
+/** A value that can be returned from a visitor function to stop traversal. */
 export declare const BREAK: unknown;
 /**
  * visit() will walk through an AST using a depth-first traversal, calling
@@ -79,82 +90,181 @@ export declare const BREAK: unknown;
  * When using visit() to edit an AST, the original AST will not be modified, and
  * a new version of the AST with the changes applied will be returned from the
  * visit function.
- *
+ * @param root - The AST node at which to start traversal.
+ * @param visitor - The visitor or reducer functions to call while traversing.
+ * @param visitorKeys - Optional map of child keys to visit for each AST node kind.
+ * @returns The original AST, an edited AST, or a reduced value depending on the visitor.
+ * @typeParam N - The root AST node type returned when visiting without reducing.
+ * @example
  * ```ts
- * const editedAST = visit(ast, {
- *   enter(node, key, parent, path, ancestors) {
- *     // @return
- *     //   undefined: no action
- *     //   false: skip visiting this node
- *     //   visitor.BREAK: stop visiting altogether
- *     //   null: delete this node
- *     //   any value: replace this node with the returned value
+ * // Return values control traversal: undefined makes no change, false skips
+ * // a subtree, BREAK stops traversal, null removes a node, and any other
+ * // value replaces the current node.
+ * import { Kind, parse, print, visit } from 'graphql/language';
+ *
+ * const document = parse('{ hero { name } }');
+ * const editedAST = visit(document, {
+ *   Field: (node) => {
+ *     if (node.name.value === 'hero') {
+ *       return {
+ *         ...node,
+ *         name: { kind: Kind.NAME, value: 'human' },
+ *       };
+ *     }
  *   },
- *   leave(node, key, parent, path, ancestors) {
- *     // @return
- *     //   undefined: no action
- *     //   false: no action
- *     //   visitor.BREAK: stop visiting altogether
- *     //   null: delete this node
- *     //   any value: replace this node with the returned value
- *   }
  * });
+ *
+ * print(editedAST); // => '{\n  human {\n    name\n  }\n}'
  * ```
+ * @example
+ * ```ts
+ * // A named visitor function runs when entering nodes of that kind.
+ * import { parse, visit } from 'graphql/language';
  *
- * 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 three permutations of the
- * visitor API:
+ * const document = parse('{ hero { name } }');
+ * const fieldNames = [];
  *
- * 1) Named visitors triggered when entering a node of a specific kind.
+ * visit(document, {
+ *   Field: (node) => {
+ *     fieldNames.push(node.name.value);
+ *   },
+ * });
  *
- * ```ts
- * visit(ast, {
- *   Kind(node) {
- *     // enter the "Kind" node
- *   }
- * })
+ * fieldNames; // => ['hero', 'name']
  * ```
+ * @example
+ * ```ts
+ * // A named visitor object can provide separate enter and leave handlers for
+ * // nodes of that kind.
+ * import { parse, visit } from 'graphql/language';
  *
- * 2) Named visitors that trigger upon entering and leaving a node of a specific kind.
+ * const document = parse('{ hero { name } }');
+ * const events = [];
  *
- * ```ts
- * visit(ast, {
- *   Kind: {
- *     enter(node) {
- *       // enter the "Kind" node
- *     }
- *     leave(node) {
- *       // leave the "Kind" node
- *     }
- *   }
- * })
+ * visit(document, {
+ *   Field: {
+ *     enter: (node) => {
+ *       events.push(`enter:${node.name.value}`);
+ *     },
+ *     leave: (node) => {
+ *       events.push(`leave:${node.name.value}`);
+ *     },
+ *   },
+ * });
+ *
+ * events; // => ['enter:hero', 'enter:name', 'leave:name', 'leave:hero']
  * ```
+ * @example
+ * ```ts
+ * // Generic enter and leave handlers run for every node.
+ * import { parse, visit } from 'graphql/language';
  *
- * 3) Generic visitors that trigger upon entering and leaving any node.
+ * const document = parse('{ hero { name } }');
+ * let enterCount = 0;
+ * let leaveCount = 0;
  *
- * ```ts
- * visit(ast, {
- *   enter(node) {
- *     // enter any node
+ * visit(document, {
+ *   enter: (node) => {
+ *     enterCount += 1;
+ *   },
+ *   leave: (node) => {
+ *     leaveCount += 1;
  *   },
- *   leave(node) {
- *     // leave any node
- *   }
- * })
+ * });
+ *
+ * enterCount; // => leaveCount
+ * enterCount > 0; // => true
  * ```
  */
 export declare function visit<N extends ASTNode>(root: N, visitor: ASTVisitor, visitorKeys?: ASTVisitorKeyMap): N;
+/**
+ * Traverses an AST with reducer callbacks and returns the reduced value.
+ * @param root - The AST node where traversal starts.
+ * @param visitor - Reducer callbacks to invoke during traversal.
+ * @param visitorKeys - Optional mapping of child keys for each AST node kind.
+ * @returns The value produced by the reducer visitor.
+ * @typeParam R - The value produced by reducer visitor callbacks.
+ * @example
+ * ```ts
+ * // A reducer visitor returns values from leave handlers to build a reduced
+ * // result instead of returning an edited AST.
+ * import { parse, visit } from 'graphql/language';
+ *
+ * const document = parse('{ hero { name } }');
+ * const printed = visit(document, {
+ *   Name: {
+ *     leave: (node) => {
+ *       return node.value;
+ *     },
+ *   },
+ *   Field: {
+ *     leave: (node) => {
+ *       return node.selectionSet == null
+ *         ? node.name
+ *         : `${node.name} { ${node.selectionSet} }`;
+ *     },
+ *   },
+ *   SelectionSet: {
+ *     leave: (node) => {
+ *       return node.selections.join(' ');
+ *     },
+ *   },
+ *   OperationDefinition: {
+ *     leave: (node) => {
+ *       return node.selectionSet;
+ *     },
+ *   },
+ *   Document: {
+ *     leave: (node) => {
+ *       return node.definitions.join('\n');
+ *     },
+ *   },
+ * });
+ *
+ * printed; // => 'hero { name }'
+ * ```
+ */
 export declare function visit<R>(root: ASTNode, visitor: ASTReducer<R>, visitorKeys?: ASTVisitorKeyMap): R;
 /**
  * Creates a new visitor instance which delegates to many visitors to run in
  * parallel. Each visitor will be visited for each node before moving on.
  *
  * If a prior visitor edits a node, no following visitors will see that node.
+ * @param visitors - The visitors to merge into one parallel visitor.
+ * @returns A visitor that delegates traversal to each provided visitor.
+ * @example
+ * ```ts
+ * import { parse, visit, visitInParallel } from 'graphql/language';
+ *
+ * const document = parse('{ hero { name } }');
+ * const events = [];
+ *
+ * visit(
+ *   document,
+ *   visitInParallel([
+ *     { Field: (node) => { events.push(`field:${node.name.value}`); } },
+ *     { Name: (node) => { events.push(`name:${node.value}`); } },
+ *   ]),
+ * );
+ *
+ * events; // => ['field:hero', 'name:hero', 'field:name', 'name:name']
+ * ```
  */
 export declare function visitInParallel(visitors: ReadonlyArray<ASTVisitor>): ASTVisitor;
 /**
  * Given a visitor instance and a node kind, return EnterLeaveVisitor for that kind.
+ * @param visitor - The visitor object to inspect.
+ * @param kind - The AST node kind to resolve handlers for.
+ * @returns The enter and leave handlers that apply for the given node kind.
+ * @example
+ * ```ts
+ * import { Kind, getEnterLeaveForKind } from 'graphql/language';
+ *
+ * const handlers = getEnterLeaveForKind({ Field: () => {} }, Kind.FIELD);
+ *
+ * typeof handlers.enter; // => 'function'
+ * handlers.leave; // => undefined
+ * ```
  */
 export declare function getEnterLeaveForKind(visitor: ASTVisitor, kind: Kind): EnterLeaveVisitor<ASTNode>;
 export {};

package/language/visitor.d.ts

@@ -1,9 +1,7 @@
+/** @category Visiting */
 import type { ASTNode } from "./ast.js";
 import { Kind } from "./kinds.js";
-/**
- * A visitor is provided to visit, it contains the collection of
- * relevant functions to be called during the visitor's traversal.
- */
+/** A visitor defines the callbacks called during AST traversal. */
 export type ASTVisitor = EnterLeaveVisitor<ASTNode> | KindVisitor;
 type KindVisitor = {
     readonly [NodeT in ASTNode as NodeT['kind']]?: ASTVisitFn<NodeT> | EnterLeaveVisitor<NodeT>;
@@ -13,27 +11,28 @@ interface EnterLeaveVisitor<TVisitedNode extends ASTNode> {
     readonly leave?: ASTVisitFn<TVisitedNode> | undefined;
 }
 /**
- * A visitor is comprised of visit functions, which are called on each node
- * during the visitor's traversal.
+ * A visitor is composed of visit functions called for each node during traversal.
+ * @typeParam TVisitedNode - AST node type handled by this visitor function.
  */
 export type ASTVisitFn<TVisitedNode extends ASTNode> = (
-/** The current node being visiting. */
+/** Current node being visited. */
 node: TVisitedNode, 
-/** The index or key to this node from the parent node or Array. */
+/** Index or key for this node within the parent node or array. */
 key: string | number | undefined, 
-/** The parent immediately above this node, which may be an Array. */
+/** Parent immediately above this node, which may be an array. */
 parent: ASTNode | ReadonlyArray<ASTNode> | undefined, 
-/** The key path to get to this node from the root node. */
+/** Key path from the root node to this node. */
 path: ReadonlyArray<string | number>, 
 /**
- * All nodes and Arrays visited before reaching parent of this node.
+ * All nodes and arrays visited before reaching this node's parent.
  * These correspond to array indices in `path`.
- * Note: ancestors includes arrays which contain the parent of visited node.
+ * Note: ancestors includes arrays that contain the visited node's parent.
  */
 ancestors: ReadonlyArray<ASTNode | ReadonlyArray<ASTNode>>) => any;
 /**
- * A reducer is comprised of reducer functions which convert AST nodes into
- * another form.
+ * A reducer is composed of reducer functions that convert AST nodes into another form.
+ *
+ * @internal
  */
 export type ASTReducer<R> = {
     readonly [NodeT in ASTNode as NodeT['kind']]?: {
@@ -42,29 +41,41 @@ export type ASTReducer<R> = {
     };
 };
 type ASTReducerFn<TReducedNode extends ASTNode, R> = (
-/** The current node being visiting. */
+/**
+ * Current node being visited.
+ * @internal
+ */
 node: {
     [K in keyof TReducedNode]: ReducedField<TReducedNode[K], R>;
 }, 
-/** The index or key to this node from the parent node or Array. */
+/**
+ * Index or key for this node within the parent node or array.
+ * @internal
+ */
 key: string | number | undefined, 
-/** The parent immediately above this node, which may be an Array. */
+/**
+ * Parent immediately above this node, which may be an array.
+ * @internal
+ */
 parent: ASTNode | ReadonlyArray<ASTNode> | undefined, 
-/** The key path to get to this node from the root node. */
+/**
+ * Key path from the root node to this node.
+ * @internal
+ */
 path: ReadonlyArray<string | number>, 
 /**
- * All nodes and Arrays visited before reaching parent of this node.
+ * All nodes and arrays visited before reaching this node's parent.
  * These correspond to array indices in `path`.
- * Note: ancestors includes arrays which contain the parent of visited node.
+ * Note: ancestors includes arrays that contain the visited node's parent.
+ * @internal
  */
 ancestors: ReadonlyArray<ASTNode | ReadonlyArray<ASTNode>>) => R;
 type ReducedField<T, R> = T extends ASTNode ? R : T extends ReadonlyArray<ASTNode> ? ReadonlyArray<R> : T;
-/**
- * A KeyMap describes each the traversable properties of each kind of node.
- */
+/** A visitor key map describes the traversable child properties for each node kind. */
 export type ASTVisitorKeyMap = {
     [NodeT in ASTNode as NodeT['kind']]?: ReadonlyArray<keyof NodeT>;
 };
+/** A value that can be returned from a visitor function to stop traversal. */
 export declare const BREAK: unknown;
 /**
  * visit() will walk through an AST using a depth-first traversal, calling
@@ -79,82 +90,181 @@ export declare const BREAK: unknown;
  * When using visit() to edit an AST, the original AST will not be modified, and
  * a new version of the AST with the changes applied will be returned from the
  * visit function.
- *
+ * @param root - The AST node at which to start traversal.
+ * @param visitor - The visitor or reducer functions to call while traversing.
+ * @param visitorKeys - Optional map of child keys to visit for each AST node kind.
+ * @returns The original AST, an edited AST, or a reduced value depending on the visitor.
+ * @typeParam N - The root AST node type returned when visiting without reducing.
+ * @example
  * ```ts
- * const editedAST = visit(ast, {
- *   enter(node, key, parent, path, ancestors) {
- *     // @return
- *     //   undefined: no action
- *     //   false: skip visiting this node
- *     //   visitor.BREAK: stop visiting altogether
- *     //   null: delete this node
- *     //   any value: replace this node with the returned value
+ * // Return values control traversal: undefined makes no change, false skips
+ * // a subtree, BREAK stops traversal, null removes a node, and any other
+ * // value replaces the current node.
+ * import { Kind, parse, print, visit } from 'graphql/language';
+ *
+ * const document = parse('{ hero { name } }');
+ * const editedAST = visit(document, {
+ *   Field: (node) => {
+ *     if (node.name.value === 'hero') {
+ *       return {
+ *         ...node,
+ *         name: { kind: Kind.NAME, value: 'human' },
+ *       };
+ *     }
  *   },
- *   leave(node, key, parent, path, ancestors) {
- *     // @return
- *     //   undefined: no action
- *     //   false: no action
- *     //   visitor.BREAK: stop visiting altogether
- *     //   null: delete this node
- *     //   any value: replace this node with the returned value
- *   }
  * });
+ *
+ * print(editedAST); // => '{\n  human {\n    name\n  }\n}'
  * ```
+ * @example
+ * ```ts
+ * // A named visitor function runs when entering nodes of that kind.
+ * import { parse, visit } from 'graphql/language';
  *
- * 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 three permutations of the
- * visitor API:
+ * const document = parse('{ hero { name } }');
+ * const fieldNames = [];
  *
- * 1) Named visitors triggered when entering a node of a specific kind.
+ * visit(document, {
+ *   Field: (node) => {
+ *     fieldNames.push(node.name.value);
+ *   },
+ * });
  *
- * ```ts
- * visit(ast, {
- *   Kind(node) {
- *     // enter the "Kind" node
- *   }
- * })
+ * fieldNames; // => ['hero', 'name']
  * ```
+ * @example
+ * ```ts
+ * // A named visitor object can provide separate enter and leave handlers for
+ * // nodes of that kind.
+ * import { parse, visit } from 'graphql/language';
  *
- * 2) Named visitors that trigger upon entering and leaving a node of a specific kind.
+ * const document = parse('{ hero { name } }');
+ * const events = [];
  *
- * ```ts
- * visit(ast, {
- *   Kind: {
- *     enter(node) {
- *       // enter the "Kind" node
- *     }
- *     leave(node) {
- *       // leave the "Kind" node
- *     }
- *   }
- * })
+ * visit(document, {
+ *   Field: {
+ *     enter: (node) => {
+ *       events.push(`enter:${node.name.value}`);
+ *     },
+ *     leave: (node) => {
+ *       events.push(`leave:${node.name.value}`);
+ *     },
+ *   },
+ * });
+ *
+ * events; // => ['enter:hero', 'enter:name', 'leave:name', 'leave:hero']
  * ```
+ * @example
+ * ```ts
+ * // Generic enter and leave handlers run for every node.
+ * import { parse, visit } from 'graphql/language';
  *
- * 3) Generic visitors that trigger upon entering and leaving any node.
+ * const document = parse('{ hero { name } }');
+ * let enterCount = 0;
+ * let leaveCount = 0;
  *
- * ```ts
- * visit(ast, {
- *   enter(node) {
- *     // enter any node
+ * visit(document, {
+ *   enter: (node) => {
+ *     enterCount += 1;
+ *   },
+ *   leave: (node) => {
+ *     leaveCount += 1;
  *   },
- *   leave(node) {
- *     // leave any node
- *   }
- * })
+ * });
+ *
+ * enterCount; // => leaveCount
+ * enterCount > 0; // => true
  * ```
  */
 export declare function visit<N extends ASTNode>(root: N, visitor: ASTVisitor, visitorKeys?: ASTVisitorKeyMap): N;
+/**
+ * Traverses an AST with reducer callbacks and returns the reduced value.
+ * @param root - The AST node where traversal starts.
+ * @param visitor - Reducer callbacks to invoke during traversal.
+ * @param visitorKeys - Optional mapping of child keys for each AST node kind.
+ * @returns The value produced by the reducer visitor.
+ * @typeParam R - The value produced by reducer visitor callbacks.
+ * @example
+ * ```ts
+ * // A reducer visitor returns values from leave handlers to build a reduced
+ * // result instead of returning an edited AST.
+ * import { parse, visit } from 'graphql/language';
+ *
+ * const document = parse('{ hero { name } }');
+ * const printed = visit(document, {
+ *   Name: {
+ *     leave: (node) => {
+ *       return node.value;
+ *     },
+ *   },
+ *   Field: {
+ *     leave: (node) => {
+ *       return node.selectionSet == null
+ *         ? node.name
+ *         : `${node.name} { ${node.selectionSet} }`;
+ *     },
+ *   },
+ *   SelectionSet: {
+ *     leave: (node) => {
+ *       return node.selections.join(' ');
+ *     },
+ *   },
+ *   OperationDefinition: {
+ *     leave: (node) => {
+ *       return node.selectionSet;
+ *     },
+ *   },
+ *   Document: {
+ *     leave: (node) => {
+ *       return node.definitions.join('\n');
+ *     },
+ *   },
+ * });
+ *
+ * printed; // => 'hero { name }'
+ * ```
+ */
 export declare function visit<R>(root: ASTNode, visitor: ASTReducer<R>, visitorKeys?: ASTVisitorKeyMap): R;
 /**
  * Creates a new visitor instance which delegates to many visitors to run in
  * parallel. Each visitor will be visited for each node before moving on.
  *
  * If a prior visitor edits a node, no following visitors will see that node.
+ * @param visitors - The visitors to merge into one parallel visitor.
+ * @returns A visitor that delegates traversal to each provided visitor.
+ * @example
+ * ```ts
+ * import { parse, visit, visitInParallel } from 'graphql/language';
+ *
+ * const document = parse('{ hero { name } }');
+ * const events = [];
+ *
+ * visit(
+ *   document,
+ *   visitInParallel([
+ *     { Field: (node) => { events.push(`field:${node.name.value}`); } },
+ *     { Name: (node) => { events.push(`name:${node.value}`); } },
+ *   ]),
+ * );
+ *
+ * events; // => ['field:hero', 'name:hero', 'field:name', 'name:name']
+ * ```
  */
 export declare function visitInParallel(visitors: ReadonlyArray<ASTVisitor>): ASTVisitor;
 /**
  * Given a visitor instance and a node kind, return EnterLeaveVisitor for that kind.
+ * @param visitor - The visitor object to inspect.
+ * @param kind - The AST node kind to resolve handlers for.
+ * @returns The enter and leave handlers that apply for the given node kind.
+ * @example
+ * ```ts
+ * import { Kind, getEnterLeaveForKind } from 'graphql/language';
+ *
+ * const handlers = getEnterLeaveForKind({ Field: () => {} }, Kind.FIELD);
+ *
+ * typeof handlers.enter; // => 'function'
+ * handlers.leave; // => undefined
+ * ```
  */
 export declare function getEnterLeaveForKind(visitor: ASTVisitor, kind: Kind): EnterLeaveVisitor<ASTNode>;
 export {};