graphql 16.14.0 → 16.14.1

package/language/ast.js

@@ -10,29 +10,41 @@ exports.Token =
     void 0;
 exports.isNode = isNode;
 
+/** @category AST */
+
 /**
  * Contains a range of UTF-8 character offsets and token references that
  * identify the region of the source from which the AST derived.
  */
 class Location {
-  /**
-   * The character offset at which this Node begins.
-   */
+  /** The character offset at which this Node begins. */
 
-  /**
-   * The character offset at which this Node ends.
-   */
+  /** The character offset at which this Node ends. */
 
-  /**
-   * The Token at which this Node begins.
-   */
+  /** The Token at which this Node begins. */
 
-  /**
-   * The Token at which this Node ends.
-   */
+  /** The Token at which this Node ends. */
+
+  /** The Source document the AST represents. */
 
   /**
-   * The Source document the AST represents.
+   * Creates a Location instance.
+   * @param startToken - The start token.
+   * @param endToken - The end token.
+   * @param source - Source document used to derive error locations.
+   * @example
+   * ```ts
+   * import { Location, Source, Token, TokenKind } from 'graphql/language';
+   *
+   * const source = new Source('{ hello }');
+   * const startToken = new Token(TokenKind.BRACE_L, 0, 1, 1, 1);
+   * const endToken = new Token(TokenKind.BRACE_R, 8, 9, 1, 9);
+   * const location = new Location(startToken, endToken, source);
+   *
+   * location.start; // => 0
+   * location.end; // => 9
+   * location.source.body; // => '{ hello }'
+   * ```
    */
   constructor(startToken, endToken, source) {
     this.start = startToken.start;
@@ -41,10 +53,27 @@ class Location {
     this.endToken = endToken;
     this.source = source;
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'Location';
   }
+  /**
+   * Returns a JSON representation of this location.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { parse } from 'graphql/language';
+   *
+   * const document = parse('{ hello }');
+   * const location = document.loc?.toJSON();
+   *
+   * location; // => { start: 0, end: 9 }
+   * ```
+   */
 
   toJSON() {
     return {
@@ -61,25 +90,15 @@ class Location {
 exports.Location = Location;
 
 class Token {
-  /**
-   * The kind of Token.
-   */
+  /** The kind of Token. */
 
-  /**
-   * The character offset at which this Node begins.
-   */
+  /** The character offset at which this Node begins. */
 
-  /**
-   * The character offset at which this Node ends.
-   */
+  /** The character offset at which this Node ends. */
 
-  /**
-   * The 1-indexed line number on which this Token appears.
-   */
+  /** The 1-indexed line number on which this Token appears. */
 
-  /**
-   * The 1-indexed column number at which this Token begins.
-   */
+  /** The 1-indexed column number at which this Token begins. */
 
   /**
    * For non-punctuation tokens, represents the interpreted value of the token.
@@ -93,6 +112,28 @@ class Token {
    * including ignored tokens. <SOF> is always the first node and <EOF>
    * the last.
    */
+
+  /** Next token in the token stream, including ignored tokens. */
+
+  /**
+   * Creates a Token instance.
+   * @param kind - Token kind produced by lexical analysis.
+   * @param start - Character offset where this token begins.
+   * @param end - Character offset where this token ends.
+   * @param line - One-indexed line number where this token begins.
+   * @param column - One-indexed column number where this token begins.
+   * @param value - Interpreted value for non-punctuation tokens.
+   * @example
+   * ```ts
+   * import { Token, TokenKind } from 'graphql/language';
+   *
+   * const token = new Token(TokenKind.NAME, 2, 7, 1, 3, 'hello');
+   *
+   * token.kind; // => TokenKind.NAME
+   * token.value; // => 'hello'
+   * token.toJSON(); // => { kind: 'Name', value: 'hello', line: 1, column: 3 }
+   * ```
+   */
   constructor(kind, start, end, line, column, value) {
     this.kind = kind;
     this.start = start;
@@ -104,10 +145,27 @@ class Token {
     this.prev = null;
     this.next = null;
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'Token';
   }
+  /**
+   * Returns a JSON representation of this token.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { Lexer, Source } from 'graphql/language';
+   *
+   * const lexer = new Lexer(new Source('{ hello }'));
+   * const token = lexer.advance().toJSON();
+   *
+   * token; // => { kind: '{', value: undefined, line: 1, column: 1 }
+   * ```
+   */
 
   toJSON() {
     return {
@@ -118,15 +176,11 @@ class Token {
     };
   }
 }
-/**
- * The list of all possible AST node types.
- */
+/** The list of all possible AST node types. */
 
 exports.Token = Token;
 
-/**
- * @internal
- */
+/** @internal */
 const QueryDocumentKeys = {
   Name: [],
   Document: ['definitions'],
@@ -223,17 +277,19 @@ const QueryDocumentKeys = {
 };
 exports.QueryDocumentKeys = QueryDocumentKeys;
 const kindValues = new Set(Object.keys(QueryDocumentKeys));
-/**
- * @internal
- */
+/** @internal */
 
 function isNode(maybeNode) {
   const maybeKind =
     maybeNode === null || maybeNode === void 0 ? void 0 : maybeNode.kind;
   return typeof maybeKind === 'string' && kindValues.has(maybeKind);
 }
-/** Name */
+/** An identifier in a GraphQL document. */
 
+/**
+ * The operation types supported by GraphQL executable definitions.
+ * @category Kinds
+ */
 var OperationTypeNode;
 exports.OperationTypeNode = OperationTypeNode;
 
@@ -242,3 +298,4 @@ exports.OperationTypeNode = OperationTypeNode;
   OperationTypeNode['MUTATION'] = 'mutation';
   OperationTypeNode['SUBSCRIPTION'] = 'subscription';
 })(OperationTypeNode || (exports.OperationTypeNode = OperationTypeNode = {}));
+/** A variable declaration in an operation or legacy fragment definition. */

package/language/ast.mjs

@@ -1,26 +1,38 @@
+/** @category AST */
+
 /**
  * Contains a range of UTF-8 character offsets and token references that
  * identify the region of the source from which the AST derived.
  */
 export class Location {
-  /**
-   * The character offset at which this Node begins.
-   */
+  /** The character offset at which this Node begins. */
 
-  /**
-   * The character offset at which this Node ends.
-   */
+  /** The character offset at which this Node ends. */
 
-  /**
-   * The Token at which this Node begins.
-   */
+  /** The Token at which this Node begins. */
 
-  /**
-   * The Token at which this Node ends.
-   */
+  /** The Token at which this Node ends. */
+
+  /** The Source document the AST represents. */
 
   /**
-   * The Source document the AST represents.
+   * Creates a Location instance.
+   * @param startToken - The start token.
+   * @param endToken - The end token.
+   * @param source - Source document used to derive error locations.
+   * @example
+   * ```ts
+   * import { Location, Source, Token, TokenKind } from 'graphql/language';
+   *
+   * const source = new Source('{ hello }');
+   * const startToken = new Token(TokenKind.BRACE_L, 0, 1, 1, 1);
+   * const endToken = new Token(TokenKind.BRACE_R, 8, 9, 1, 9);
+   * const location = new Location(startToken, endToken, source);
+   *
+   * location.start; // => 0
+   * location.end; // => 9
+   * location.source.body; // => '{ hello }'
+   * ```
    */
   constructor(startToken, endToken, source) {
     this.start = startToken.start;
@@ -29,10 +41,27 @@ export class Location {
     this.endToken = endToken;
     this.source = source;
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'Location';
   }
+  /**
+   * Returns a JSON representation of this location.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { parse } from 'graphql/language';
+   *
+   * const document = parse('{ hello }');
+   * const location = document.loc?.toJSON();
+   *
+   * location; // => { start: 0, end: 9 }
+   * ```
+   */
 
   toJSON() {
     return {
@@ -47,25 +76,15 @@ export class Location {
  */
 
 export class Token {
-  /**
-   * The kind of Token.
-   */
+  /** The kind of Token. */
 
-  /**
-   * The character offset at which this Node begins.
-   */
+  /** The character offset at which this Node begins. */
 
-  /**
-   * The character offset at which this Node ends.
-   */
+  /** The character offset at which this Node ends. */
 
-  /**
-   * The 1-indexed line number on which this Token appears.
-   */
+  /** The 1-indexed line number on which this Token appears. */
 
-  /**
-   * The 1-indexed column number at which this Token begins.
-   */
+  /** The 1-indexed column number at which this Token begins. */
 
   /**
    * For non-punctuation tokens, represents the interpreted value of the token.
@@ -79,6 +98,28 @@ export class Token {
    * including ignored tokens. <SOF> is always the first node and <EOF>
    * the last.
    */
+
+  /** Next token in the token stream, including ignored tokens. */
+
+  /**
+   * Creates a Token instance.
+   * @param kind - Token kind produced by lexical analysis.
+   * @param start - Character offset where this token begins.
+   * @param end - Character offset where this token ends.
+   * @param line - One-indexed line number where this token begins.
+   * @param column - One-indexed column number where this token begins.
+   * @param value - Interpreted value for non-punctuation tokens.
+   * @example
+   * ```ts
+   * import { Token, TokenKind } from 'graphql/language';
+   *
+   * const token = new Token(TokenKind.NAME, 2, 7, 1, 3, 'hello');
+   *
+   * token.kind; // => TokenKind.NAME
+   * token.value; // => 'hello'
+   * token.toJSON(); // => { kind: 'Name', value: 'hello', line: 1, column: 3 }
+   * ```
+   */
   constructor(kind, start, end, line, column, value) {
     this.kind = kind;
     this.start = start;
@@ -90,10 +131,27 @@ export class Token {
     this.prev = null;
     this.next = null;
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'Token';
   }
+  /**
+   * Returns a JSON representation of this token.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { Lexer, Source } from 'graphql/language';
+   *
+   * const lexer = new Lexer(new Source('{ hello }'));
+   * const token = lexer.advance().toJSON();
+   *
+   * token; // => { kind: '{', value: undefined, line: 1, column: 1 }
+   * ```
+   */
 
   toJSON() {
     return {
@@ -104,13 +162,9 @@ export class Token {
     };
   }
 }
-/**
- * The list of all possible AST node types.
- */
+/** The list of all possible AST node types. */
 
-/**
- * @internal
- */
+/** @internal */
 export const QueryDocumentKeys = {
   Name: [],
   Document: ['definitions'],
@@ -206,17 +260,19 @@ export const QueryDocumentKeys = {
   DirectiveArgumentCoordinate: ['name', 'argumentName'],
 };
 const kindValues = new Set(Object.keys(QueryDocumentKeys));
-/**
- * @internal
- */
+/** @internal */
 
 export function isNode(maybeNode) {
   const maybeKind =
     maybeNode === null || maybeNode === void 0 ? void 0 : maybeNode.kind;
   return typeof maybeKind === 'string' && kindValues.has(maybeKind);
 }
-/** Name */
+/** An identifier in a GraphQL document. */
 
+/**
+ * The operation types supported by GraphQL executable definitions.
+ * @category Kinds
+ */
 var OperationTypeNode;
 
 (function (OperationTypeNode) {
@@ -226,3 +282,4 @@ var OperationTypeNode;
 })(OperationTypeNode || (OperationTypeNode = {}));
 
 export { OperationTypeNode };
+/** A variable declaration in an operation or legacy fragment definition. */

package/language/blockString.d.ts

@@ -9,9 +9,7 @@
 export declare function dedentBlockStringLines(
   lines: ReadonlyArray<string>,
 ): Array<string>;
-/**
- * @internal
- */
+/** @internal */
 export declare function isPrintableAsBlockString(value: string): boolean;
 /**
  * Print a block string in the indented block form by adding a leading and

package/language/blockString.js

@@ -69,9 +69,7 @@ function leadingWhitespace(str) {
 
   return i;
 }
-/**
- * @internal
- */
+/** @internal */
 
 function isPrintableAsBlockString(value) {
   if (value === '') {

package/language/blockString.mjs

@@ -57,9 +57,7 @@ function leadingWhitespace(str) {
 
   return i;
 }
-/**
- * @internal
- */
+/** @internal */
 
 export function isPrintableAsBlockString(value) {
   if (value === '') {

package/language/directiveLocation.d.ts

@@ -1,34 +1,54 @@
-/**
- * The set of allowed directive location values.
- */
+/** @category Kinds */
+/** The set of allowed directive location values. */
 declare enum DirectiveLocation {
-  /** Request Definitions */
+  /** Directive location for query operations. */
   QUERY = 'QUERY',
+  /** Directive location for mutation operations. */
   MUTATION = 'MUTATION',
+  /** Directive location for subscription operations. */
   SUBSCRIPTION = 'SUBSCRIPTION',
+  /** Directive location for field selections. */
   FIELD = 'FIELD',
+  /** Directive location for fragment definitions. */
   FRAGMENT_DEFINITION = 'FRAGMENT_DEFINITION',
+  /** Directive location for fragment spreads. */
   FRAGMENT_SPREAD = 'FRAGMENT_SPREAD',
+  /** Directive location for inline fragments. */
   INLINE_FRAGMENT = 'INLINE_FRAGMENT',
+  /** Directive location for variable definitions. */
   VARIABLE_DEFINITION = 'VARIABLE_DEFINITION',
-  /** Type System Definitions */
+  /** Directive location for schema definitions and extensions. */
   SCHEMA = 'SCHEMA',
+  /** Directive location for scalar type definitions and extensions. */
   SCALAR = 'SCALAR',
+  /** Directive location for object type definitions and extensions. */
   OBJECT = 'OBJECT',
+  /** Directive location for field definitions. */
   FIELD_DEFINITION = 'FIELD_DEFINITION',
+  /** Directive location for argument definitions. */
   ARGUMENT_DEFINITION = 'ARGUMENT_DEFINITION',
+  /** Directive location for interface type definitions and extensions. */
   INTERFACE = 'INTERFACE',
+  /** Directive location for union type definitions and extensions. */
   UNION = 'UNION',
+  /** Directive location for enum type definitions and extensions. */
   ENUM = 'ENUM',
+  /** Directive location for enum value definitions. */
   ENUM_VALUE = 'ENUM_VALUE',
+  /** Directive location for input object type definitions and extensions. */
   INPUT_OBJECT = 'INPUT_OBJECT',
+  /** Directive location for input object field definitions. */
   INPUT_FIELD_DEFINITION = 'INPUT_FIELD_DEFINITION',
+  /** Directive location for directive definitions and extensions. */
   DIRECTIVE_DEFINITION = 'DIRECTIVE_DEFINITION',
 }
 export { DirectiveLocation };
 /**
- * The enum type representing the directive location values.
- *
- * @deprecated Please use `DirectiveLocation`. Will be remove in v17.
+ * Deprecated legacy alias for the enum type representing directive location
+ * values. This alias will be removed in v17. In v17, `DirectiveLocation` is
+ * exported as the single public symbol for both the runtime object and the
+ * corresponding TypeScript type.
+ * @deprecated Will be removed in v17. In v17, use `DirectiveLocation` as both
+ * the runtime value and the type.
  */
 export declare type DirectiveLocationEnum = typeof DirectiveLocation;

package/language/directiveLocation.js

@@ -5,9 +5,9 @@ Object.defineProperty(exports, '__esModule', {
 });
 exports.DirectiveLocation = void 0;
 
-/**
- * The set of allowed directive location values.
- */
+/** @category Kinds */
+
+/** The set of allowed directive location values. */
 var DirectiveLocation;
 exports.DirectiveLocation = DirectiveLocation;
 
@@ -34,7 +34,10 @@ exports.DirectiveLocation = DirectiveLocation;
   DirectiveLocation['DIRECTIVE_DEFINITION'] = 'DIRECTIVE_DEFINITION';
 })(DirectiveLocation || (exports.DirectiveLocation = DirectiveLocation = {}));
 /**
- * The enum type representing the directive location values.
- *
- * @deprecated Please use `DirectiveLocation`. Will be remove in v17.
+ * Deprecated legacy alias for the enum type representing directive location
+ * values. This alias will be removed in v17. In v17, `DirectiveLocation` is
+ * exported as the single public symbol for both the runtime object and the
+ * corresponding TypeScript type.
+ * @deprecated Will be removed in v17. In v17, use `DirectiveLocation` as both
+ * the runtime value and the type.
  */

package/language/directiveLocation.mjs

@@ -1,6 +1,6 @@
-/**
- * The set of allowed directive location values.
- */
+/** @category Kinds */
+
+/** The set of allowed directive location values. */
 var DirectiveLocation;
 
 (function (DirectiveLocation) {
@@ -28,7 +28,10 @@ var DirectiveLocation;
 
 export { DirectiveLocation };
 /**
- * The enum type representing the directive location values.
- *
- * @deprecated Please use `DirectiveLocation`. Will be remove in v17.
+ * Deprecated legacy alias for the enum type representing directive location
+ * values. This alias will be removed in v17. In v17, `DirectiveLocation` is
+ * exported as the single public symbol for both the runtime object and the
+ * corresponding TypeScript type.
+ * @deprecated Will be removed in v17. In v17, use `DirectiveLocation` as both
+ * the runtime value and the type.
  */

package/language/index.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Parse, print, and visit GraphQL language source files and AST nodes.
+ *
+ * These exports are also available from the root `graphql` package.
+ * @packageDocumentation
+ */
 export { Source } from './source';
 export { getLocation } from './location';
 export type { SourceLocation } from './location';

package/language/index.mjs

@@ -1,3 +1,9 @@
+/**
+ * Parse, print, and visit GraphQL language source files and AST nodes.
+ *
+ * These exports are also available from the root `graphql` package.
+ * @packageDocumentation
+ */
 export { Source } from './source.mjs';
 export { getLocation } from './location.mjs';
 export { printLocation, printSourceLocation } from './printLocation.mjs';