graphql 14.4.2 → 14.5.3

package/utilities/findDeprecatedUsages.d.ts

@@ -0,0 +1,13 @@
+import { GraphQLError } from '../error/GraphQLError';
+import { DocumentNode } from '../language/ast';
+import { GraphQLSchema } from '../type/schema';
+
+/**
+ * A validation rule which reports deprecated usages.
+ *
+ * Returns a list of GraphQLError instances describing each deprecated use.
+ */
+export function findDeprecatedUsages(
+  schema: GraphQLSchema,
+  ast: DocumentNode,
+): GraphQLError[];

package/utilities/findDeprecatedUsages.js.flow

@@ -1,10 +1,13 @@
 // @flow strict
 
 import { GraphQLError } from '../error/GraphQLError';
-import { visit, visitWithTypeInfo } from '../language/visitor';
+
 import { type DocumentNode } from '../language/ast';
+import { visit, visitWithTypeInfo } from '../language/visitor';
+
 import { getNamedType } from '../type/definition';
 import { type GraphQLSchema } from '../type/schema';
+
 import { TypeInfo } from './TypeInfo';
 
 /**

package/utilities/getOperationAST.d.ts

@@ -0,0 +1,12 @@
+import Maybe from '../tsutils/Maybe';
+import { DocumentNode, OperationDefinitionNode } from '../language/ast';
+
+/**
+ * Returns an operation AST given a document AST and optionally an operation
+ * name. If a name is not provided, an operation is only returned if only one is
+ * provided in the document.
+ */
+export function getOperationAST(
+  documentAST: DocumentNode,
+  operationName: Maybe<string>,
+): Maybe<OperationDefinitionNode>;

package/utilities/getOperationAST.js

@@ -14,40 +14,22 @@ var _kinds = require("../language/kinds");
  */
 function getOperationAST(documentAST, operationName) {
   var operation = null;
-  var _iteratorNormalCompletion = true;
-  var _didIteratorError = false;
-  var _iteratorError = undefined;
 
-  try {
-    for (var _iterator = documentAST.definitions[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
-      var definition = _step.value;
+  for (var _i2 = 0, _documentAST$definiti2 = documentAST.definitions; _i2 < _documentAST$definiti2.length; _i2++) {
+    var definition = _documentAST$definiti2[_i2];
 
-      if (definition.kind === _kinds.Kind.OPERATION_DEFINITION) {
-        if (!operationName) {
-          // If no operation name was provided, only return an Operation if there
-          // is one defined in the document. Upon encountering the second, return
-          // null.
-          if (operation) {
-            return null;
-          }
-
-          operation = definition;
-        } else if (definition.name && definition.name.value === operationName) {
-          return definition;
+    if (definition.kind === _kinds.Kind.OPERATION_DEFINITION) {
+      if (!operationName) {
+        // If no operation name was provided, only return an Operation if there
+        // is one defined in the document. Upon encountering the second, return
+        // null.
+        if (operation) {
+          return null;
         }
-      }
-    }
-  } catch (err) {
-    _didIteratorError = true;
-    _iteratorError = err;
-  } finally {
-    try {
-      if (!_iteratorNormalCompletion && _iterator.return != null) {
-        _iterator.return();
-      }
-    } finally {
-      if (_didIteratorError) {
-        throw _iteratorError;
+
+        operation = definition;
+      } else if (definition.name && definition.name.value === operationName) {
+        return definition;
       }
     }
   }

package/utilities/getOperationAST.mjs

@@ -7,40 +7,22 @@ import { Kind } from '../language/kinds';
  */
 export function getOperationAST(documentAST, operationName) {
   var operation = null;
-  var _iteratorNormalCompletion = true;
-  var _didIteratorError = false;
-  var _iteratorError = undefined;
 
-  try {
-    for (var _iterator = documentAST.definitions[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
-      var definition = _step.value;
+  for (var _i2 = 0, _documentAST$definiti2 = documentAST.definitions; _i2 < _documentAST$definiti2.length; _i2++) {
+    var definition = _documentAST$definiti2[_i2];
 
-      if (definition.kind === Kind.OPERATION_DEFINITION) {
-        if (!operationName) {
-          // If no operation name was provided, only return an Operation if there
-          // is one defined in the document. Upon encountering the second, return
-          // null.
-          if (operation) {
-            return null;
-          }
-
-          operation = definition;
-        } else if (definition.name && definition.name.value === operationName) {
-          return definition;
+    if (definition.kind === Kind.OPERATION_DEFINITION) {
+      if (!operationName) {
+        // If no operation name was provided, only return an Operation if there
+        // is one defined in the document. Upon encountering the second, return
+        // null.
+        if (operation) {
+          return null;
         }
-      }
-    }
-  } catch (err) {
-    _didIteratorError = true;
-    _iteratorError = err;
-  } finally {
-    try {
-      if (!_iteratorNormalCompletion && _iterator.return != null) {
-        _iterator.return();
-      }
-    } finally {
-      if (_didIteratorError) {
-        throw _iteratorError;
+
+        operation = definition;
+      } else if (definition.name && definition.name.value === operationName) {
+        return definition;
       }
     }
   }

package/utilities/getOperationRootType.d.ts

@@ -0,0 +1,14 @@
+import {
+  OperationDefinitionNode,
+  OperationTypeDefinitionNode,
+} from '../language/ast';
+import { GraphQLSchema } from '../type/schema';
+import { GraphQLObjectType } from '../type/definition';
+
+/**
+ * Extracts the root type of the operation from the schema.
+ */
+export function getOperationRootType(
+  schema: GraphQLSchema,
+  operation: OperationDefinitionNode | OperationTypeDefinitionNode,
+): GraphQLObjectType;

package/utilities/getOperationRootType.js.flow

@@ -1,10 +1,12 @@
 // @flow strict
 
 import { GraphQLError } from '../error/GraphQLError';
+
 import {
   type OperationDefinitionNode,
   type OperationTypeDefinitionNode,
 } from '../language/ast';
+
 import { type GraphQLSchema } from '../type/schema';
 import { type GraphQLObjectType } from '../type/definition';
 

package/utilities/index.d.ts

@@ -0,0 +1,127 @@
+// The GraphQL query recommended for a full schema introspection.
+export {
+  getIntrospectionQuery,
+  // @deprecated, use getIntrospectionQuery() - will be removed in v15
+  introspectionQuery,
+} from './introspectionQuery';
+
+export {
+  IntrospectionOptions,
+  IntrospectionQuery,
+  IntrospectionSchema,
+  IntrospectionType,
+  IntrospectionInputType,
+  IntrospectionOutputType,
+  IntrospectionScalarType,
+  IntrospectionObjectType,
+  IntrospectionInterfaceType,
+  IntrospectionUnionType,
+  IntrospectionEnumType,
+  IntrospectionInputObjectType,
+  IntrospectionTypeRef,
+  IntrospectionInputTypeRef,
+  IntrospectionOutputTypeRef,
+  IntrospectionNamedTypeRef,
+  IntrospectionListTypeRef,
+  IntrospectionNonNullTypeRef,
+  IntrospectionField,
+  IntrospectionInputValue,
+  IntrospectionEnumValue,
+  IntrospectionDirective,
+} from './introspectionQuery';
+
+// Gets the target Operation from a Document
+export { getOperationAST } from './getOperationAST';
+
+// Gets the Type for the target Operation AST.
+export { getOperationRootType } from './getOperationRootType';
+
+// Convert a GraphQLSchema to an IntrospectionQuery
+export { introspectionFromSchema } from './introspectionFromSchema';
+
+// Build a GraphQLSchema from an introspection result.
+export { buildClientSchema } from './buildClientSchema';
+
+// Build a GraphQLSchema from GraphQL Schema language.
+export {
+  buildASTSchema,
+  buildSchema,
+  // @deprecated: Get the description from a schema AST node and supports legacy
+  // syntax for specifying descriptions - will be removed in v16
+  getDescription,
+  BuildSchemaOptions,
+} from './buildASTSchema';
+
+// Extends an existing GraphQLSchema from a parsed GraphQL Schema language AST.
+export { extendSchema } from './extendSchema';
+
+// Sort a GraphQLSchema.
+export { lexicographicSortSchema } from './lexicographicSortSchema';
+
+// Print a GraphQLSchema to GraphQL Schema language.
+export {
+  printSchema,
+  printType,
+  printIntrospectionSchema,
+} from './schemaPrinter';
+
+// Create a GraphQLType from a GraphQL language AST.
+export { typeFromAST } from './typeFromAST';
+
+// Create a JavaScript value from a GraphQL language AST with a type.
+export { valueFromAST } from './valueFromAST';
+
+// Create a JavaScript value from a GraphQL language AST without a type.
+export { valueFromASTUntyped } from './valueFromASTUntyped';
+
+// Create a GraphQL language AST from a JavaScript value.
+export { astFromValue } from './astFromValue';
+
+// A helper to use within recursive-descent visitors which need to be aware of
+// the GraphQL type system.
+export { TypeInfo } from './TypeInfo';
+
+// Coerces a JavaScript value to a GraphQL type, or produces errors.
+export { coerceInputValue } from './coerceInputValue';
+
+// Coerces a JavaScript value to a GraphQL type, or produces errors.
+export { coerceValue } from './coerceValue';
+
+// @deprecated use coerceValue - will be removed in v15
+export { isValidJSValue } from './isValidJSValue';
+
+// @deprecated use validation - will be removed in v15
+export { isValidLiteralValue } from './isValidLiteralValue';
+
+// Concatenates multiple AST together.
+export { concatAST } from './concatAST';
+
+// Separates an AST into an AST per Operation.
+export { separateOperations } from './separateOperations';
+
+// Strips characters that are not significant to the validity or execution
+// of a GraphQL document.
+export { stripIgnoredCharacters } from './stripIgnoredCharacters';
+
+// Comparators for types
+export {
+  isEqualType,
+  isTypeSubTypeOf,
+  doTypesOverlap,
+} from './typeComparators';
+
+// Asserts that a string is a valid GraphQL name
+export { assertValidName, isValidNameError } from './assertValidName';
+
+// Compares two GraphQLSchemas and detects breaking changes.
+export {
+  BreakingChangeType,
+  DangerousChangeType,
+  findBreakingChanges,
+  findDangerousChanges,
+  BreakingChange,
+  DangerousChange,
+} from './findBreakingChanges';
+
+// Report all deprecated usage within a GraphQL document.
+export { findDeprecatedUsages } from './findDeprecatedUsages';

package/utilities/index.js

@@ -117,6 +117,12 @@ Object.defineProperty(exports, "TypeInfo", {
     return _TypeInfo.TypeInfo;
   }
 });
+Object.defineProperty(exports, "coerceInputValue", {
+  enumerable: true,
+  get: function get() {
+    return _coerceInputValue.coerceInputValue;
+  }
+});
 Object.defineProperty(exports, "coerceValue", {
   enumerable: true,
   get: function get() {
@@ -242,6 +248,8 @@ var _astFromValue = require("./astFromValue");
 
 var _TypeInfo = require("./TypeInfo");
 
+var _coerceInputValue = require("./coerceInputValue");
+
 var _coerceValue = require("./coerceValue");
 
 var _isValidJSValue = require("./isValidJSValue");

package/utilities/index.js.flow

@@ -86,9 +86,12 @@ export { astFromValue } from './astFromValue';
 export { TypeInfo } from './TypeInfo';
 
 // Coerces a JavaScript value to a GraphQL type, or produces errors.
+export { coerceInputValue } from './coerceInputValue';
+
+// @deprecated use coerceInputValue - will be removed in v15.
 export { coerceValue } from './coerceValue';
 
-// @deprecated use coerceValue - will be removed in v15.
+// @deprecated use coerceInputValue - will be removed in v15.
 export { isValidJSValue } from './isValidJSValue';
 
 // @deprecated use validation - will be removed in v15

package/utilities/index.mjs

@@ -33,7 +33,9 @@ export { astFromValue } from './astFromValue'; // A helper to use within recursi
 
 export { TypeInfo } from './TypeInfo'; // Coerces a JavaScript value to a GraphQL type, or produces errors.
 
-export { coerceValue } from './coerceValue'; // @deprecated use coerceValue - will be removed in v15.
+export { coerceInputValue } from './coerceInputValue'; // @deprecated use coerceInputValue - will be removed in v15.
+
+export { coerceValue } from './coerceValue'; // @deprecated use coerceInputValue - will be removed in v15.
 
 export { isValidJSValue } from './isValidJSValue'; // @deprecated use validation - will be removed in v15
 

package/utilities/introspectionFromSchema.d.ts

@@ -0,0 +1,16 @@
+import { GraphQLSchema } from '../type/schema';
+import { IntrospectionQuery, IntrospectionOptions } from './introspectionQuery';
+
+/**
+ * Build an IntrospectionQuery from a GraphQLSchema
+ *
+ * IntrospectionQuery is useful for utilities that care about type and field
+ * relationships, but do not need to traverse through those relationships.
+ *
+ * This is the inverse of buildClientSchema. The primary use case is outside
+ * of the server context, for instance when doing schema comparisons.
+ */
+export function introspectionFromSchema(
+  schema: GraphQLSchema,
+  options?: IntrospectionOptions,
+): IntrospectionQuery;

package/utilities/introspectionFromSchema.js

@@ -9,10 +9,10 @@ var _invariant = _interopRequireDefault(require("../jsutils/invariant"));
 
 var _isPromise = _interopRequireDefault(require("../jsutils/isPromise"));
 
-var _execute = require("../execution/execute");
-
 var _parser = require("../language/parser");
 
+var _execute = require("../execution/execute");
+
 var _introspectionQuery = require("./introspectionQuery");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -29,6 +29,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 function introspectionFromSchema(schema, options) {
   var queryAST = (0, _parser.parse)((0, _introspectionQuery.getIntrospectionQuery)(options));
   var result = (0, _execute.execute)(schema, queryAST);
-  !(!(0, _isPromise.default)(result) && !result.errors && result.data) ? (0, _invariant.default)(0) : void 0;
+
+  /* istanbul ignore next */
+  !(0, _isPromise.default)(result) && !result.errors && result.data || (0, _invariant.default)(0);
   return result.data;
 }

package/utilities/introspectionFromSchema.js.flow

@@ -2,9 +2,11 @@
 
 import invariant from '../jsutils/invariant';
 import isPromise from '../jsutils/isPromise';
-import { type GraphQLSchema } from '../type/schema';
-import { execute } from '../execution/execute';
+
 import { parse } from '../language/parser';
+import { execute } from '../execution/execute';
+import { type GraphQLSchema } from '../type/schema';
+
 import {
   type IntrospectionQuery,
   type IntrospectionOptions,

package/utilities/introspectionFromSchema.mjs

@@ -1,7 +1,7 @@
 import invariant from '../jsutils/invariant';
 import isPromise from '../jsutils/isPromise';
-import { execute } from '../execution/execute';
 import { parse } from '../language/parser';
+import { execute } from '../execution/execute';
 import { getIntrospectionQuery } from './introspectionQuery';
 /**
  * Build an IntrospectionQuery from a GraphQLSchema
@@ -16,6 +16,8 @@ import { getIntrospectionQuery } from './introspectionQuery';
 export function introspectionFromSchema(schema, options) {
   var queryAST = parse(getIntrospectionQuery(options));
   var result = execute(schema, queryAST);
-  !(!isPromise(result) && !result.errors && result.data) ? invariant(0) : void 0;
+
+  /* istanbul ignore next */
+  !isPromise(result) && !result.errors && result.data || invariant(0);
   return result.data;
 }

package/utilities/introspectionQuery.d.ts

@@ -0,0 +1,177 @@
+import Maybe from '../tsutils/Maybe';
+import { DirectiveLocationEnum } from '../language/directiveLocation';
+
+export interface IntrospectionOptions {
+  // Whether to include descriptions in the introspection result.
+  // Default: true
+  descriptions: boolean;
+}
+
+export function getIntrospectionQuery(options?: IntrospectionOptions): string;
+
+/**
+ * Deprecated, call getIntrospectionQuery directly.
+ *
+ * This function will be removed in v15
+ */
+export const introspectionQuery: string;
+
+export interface IntrospectionQuery {
+  readonly __schema: IntrospectionSchema;
+}
+
+export interface IntrospectionSchema {
+  readonly queryType: IntrospectionNamedTypeRef<IntrospectionObjectType>;
+  readonly mutationType: Maybe<
+    IntrospectionNamedTypeRef<IntrospectionObjectType>
+  >;
+  readonly subscriptionType: Maybe<
+    IntrospectionNamedTypeRef<IntrospectionObjectType>
+  >;
+  readonly types: ReadonlyArray<IntrospectionType>;
+  readonly directives: ReadonlyArray<IntrospectionDirective>;
+}
+
+export type IntrospectionType =
+  | IntrospectionScalarType
+  | IntrospectionObjectType
+  | IntrospectionInterfaceType
+  | IntrospectionUnionType
+  | IntrospectionEnumType
+  | IntrospectionInputObjectType;
+
+export type IntrospectionOutputType =
+  | IntrospectionScalarType
+  | IntrospectionObjectType
+  | IntrospectionInterfaceType
+  | IntrospectionUnionType
+  | IntrospectionEnumType;
+
+export type IntrospectionInputType =
+  | IntrospectionScalarType
+  | IntrospectionEnumType
+  | IntrospectionInputObjectType;
+
+export interface IntrospectionScalarType {
+  readonly kind: 'SCALAR';
+  readonly name: string;
+  readonly description?: Maybe<string>;
+}
+
+export interface IntrospectionObjectType {
+  readonly kind: 'OBJECT';
+  readonly name: string;
+  readonly description?: Maybe<string>;
+  readonly fields: ReadonlyArray<IntrospectionField>;
+  readonly interfaces: ReadonlyArray<
+    IntrospectionNamedTypeRef<IntrospectionInterfaceType>
+  >;
+}
+
+export interface IntrospectionInterfaceType {
+  readonly kind: 'INTERFACE';
+  readonly name: string;
+  readonly description?: Maybe<string>;
+  readonly fields: ReadonlyArray<IntrospectionField>;
+  readonly possibleTypes: ReadonlyArray<
+    IntrospectionNamedTypeRef<IntrospectionObjectType>
+  >;
+}
+
+export interface IntrospectionUnionType {
+  readonly kind: 'UNION';
+  readonly name: string;
+  readonly description?: Maybe<string>;
+  readonly possibleTypes: ReadonlyArray<
+    IntrospectionNamedTypeRef<IntrospectionObjectType>
+  >;
+}
+
+export interface IntrospectionEnumType {
+  readonly kind: 'ENUM';
+  readonly name: string;
+  readonly description?: Maybe<string>;
+  readonly enumValues: ReadonlyArray<IntrospectionEnumValue>;
+}
+
+export interface IntrospectionInputObjectType {
+  readonly kind: 'INPUT_OBJECT';
+  readonly name: string;
+  readonly description?: Maybe<string>;
+  readonly inputFields: ReadonlyArray<IntrospectionInputValue>;
+}
+
+export interface IntrospectionListTypeRef<
+  T extends IntrospectionTypeRef = IntrospectionTypeRef
+> {
+  readonly kind: 'LIST';
+  readonly ofType: T;
+}
+
+export interface IntrospectionNonNullTypeRef<
+  T extends IntrospectionTypeRef = IntrospectionTypeRef
+> {
+  readonly kind: 'NON_NULL';
+  readonly ofType: T;
+}
+
+export type IntrospectionTypeRef =
+  | IntrospectionNamedTypeRef<IntrospectionType>
+  | IntrospectionListTypeRef<any>
+  | IntrospectionNonNullTypeRef<
+      | IntrospectionNamedTypeRef<IntrospectionType>
+      | IntrospectionListTypeRef<any>
+    >;
+
+export type IntrospectionOutputTypeRef =
+  | IntrospectionNamedTypeRef<IntrospectionOutputType>
+  | IntrospectionListTypeRef<any>
+  | IntrospectionNonNullTypeRef<
+      | IntrospectionNamedTypeRef<IntrospectionOutputType>
+      | IntrospectionListTypeRef<any>
+    >;
+
+export type IntrospectionInputTypeRef =
+  | IntrospectionNamedTypeRef<IntrospectionInputType>
+  | IntrospectionListTypeRef<any>
+  | IntrospectionNonNullTypeRef<
+      | IntrospectionNamedTypeRef<IntrospectionInputType>
+      | IntrospectionListTypeRef<any>
+    >;
+
+export interface IntrospectionNamedTypeRef<
+  T extends IntrospectionType = IntrospectionType
+> {
+  readonly kind: T['kind'];
+  readonly name: string;
+}
+
+export interface IntrospectionField {
+  readonly name: string;
+  readonly description?: Maybe<string>;
+  readonly args: ReadonlyArray<IntrospectionInputValue>;
+  readonly type: IntrospectionOutputTypeRef;
+  readonly isDeprecated: boolean;
+  readonly deprecationReason?: Maybe<string>;
+}
+
+export interface IntrospectionInputValue {
+  readonly name: string;
+  readonly description?: Maybe<string>;
+  readonly type: IntrospectionInputTypeRef;
+  readonly defaultValue?: Maybe<string>;
+}
+
+export interface IntrospectionEnumValue {
+  readonly name: string;
+  readonly description?: Maybe<string>;
+  readonly isDeprecated: boolean;
+  readonly deprecationReason?: Maybe<string>;
+}
+
+export interface IntrospectionDirective {
+  readonly name: string;
+  readonly description?: Maybe<string>;
+  readonly locations: ReadonlyArray<DirectiveLocationEnum>;
+  readonly args: ReadonlyArray<IntrospectionInputValue>;
+}

package/utilities/isValidJSValue.d.ts

@@ -0,0 +1,8 @@
+import { GraphQLInputType } from '../type/definition';
+
+/**
+ * Deprecated. Use coerceValue() directly for richer information.
+ *
+ * This function will be removed in v15
+ */
+export function isValidJSValue(value: any, type: GraphQLInputType): string[];

package/utilities/isValidJSValue.js

@@ -10,7 +10,7 @@ var _coerceValue = require("./coerceValue");
 /* istanbul ignore file */
 
 /**
- * Deprecated. Use coerceValue() directly for richer information.
+ * Deprecated. Use coerceInputValue() directly for richer information.
  *
  * This function will be removed in v15
  */

package/utilities/isValidJSValue.js.flow

@@ -1,11 +1,12 @@
 // @flow strict
 
 /* istanbul ignore file */
-import { coerceValue } from './coerceValue';
 import { type GraphQLInputType } from '../type/definition';
 
+import { coerceValue } from './coerceValue';
+
 /**
- * Deprecated. Use coerceValue() directly for richer information.
+ * Deprecated. Use coerceInputValue() directly for richer information.
  *
  * This function will be removed in v15
  */

package/utilities/isValidJSValue.mjs

@@ -1,11 +1,11 @@
 /* istanbul ignore file */
 import { coerceValue } from './coerceValue';
-
 /**
- * Deprecated. Use coerceValue() directly for richer information.
+ * Deprecated. Use coerceInputValue() directly for richer information.
  *
  * This function will be removed in v15
  */
+
 export function isValidJSValue(value, type) {
   var errors = coerceValue(value, type).errors;
   return errors ? errors.map(function (error) {