98 lines
7.4 KiB
JavaScript
98 lines
7.4 KiB
JavaScript
/**
|
|
* GraphQL.js provides a reference implementation for the GraphQL specification
|
|
* but is also a useful utility for operating on GraphQL files and building
|
|
* sophisticated tools.
|
|
*
|
|
* This primary module exports a general purpose function for fulfilling all
|
|
* steps of the GraphQL specification in a single operation, but also includes
|
|
* utilities for every part of the GraphQL specification:
|
|
*
|
|
* - Parsing the GraphQL language.
|
|
* - Building a GraphQL type schema.
|
|
* - Validating a GraphQL request against a type schema.
|
|
* - Executing a GraphQL request against a type schema.
|
|
*
|
|
* This also includes utility functions for operating on GraphQL types and
|
|
* GraphQL documents to facilitate building tools.
|
|
*
|
|
* You may also import from each sub-directory directly. For example, the
|
|
* following two import statements are equivalent:
|
|
*
|
|
* import { parse } from 'graphql';
|
|
* import { parse } from 'graphql/language';
|
|
*/
|
|
// The GraphQL.js version info.
|
|
export { version, versionInfo } from './version'; // The primary entry point into fulfilling a GraphQL request.
|
|
|
|
export { graphql, graphqlSync } from './graphql'; // Create and operate on GraphQL type definitions and schema.
|
|
|
|
export { // Definitions
|
|
GraphQLSchema, GraphQLDirective, GraphQLScalarType, GraphQLObjectType, GraphQLInterfaceType, GraphQLUnionType, GraphQLEnumType, GraphQLInputObjectType, GraphQLList, GraphQLNonNull, // Standard GraphQL Scalars
|
|
specifiedScalarTypes, GraphQLInt, GraphQLFloat, GraphQLString, GraphQLBoolean, GraphQLID, // Built-in Directives defined by the Spec
|
|
specifiedDirectives, GraphQLIncludeDirective, GraphQLSkipDirective, GraphQLDeprecatedDirective, // "Enum" of Type Kinds
|
|
TypeKind, // Constant Deprecation Reason
|
|
DEFAULT_DEPRECATION_REASON, // GraphQL Types for introspection.
|
|
introspectionTypes, __Schema, __Directive, __DirectiveLocation, __Type, __Field, __InputValue, __EnumValue, __TypeKind, // Meta-field definitions.
|
|
SchemaMetaFieldDef, TypeMetaFieldDef, TypeNameMetaFieldDef, // Predicates
|
|
isSchema, isDirective, isType, isScalarType, isObjectType, isInterfaceType, isUnionType, isEnumType, isInputObjectType, isListType, isNonNullType, isInputType, isOutputType, isLeafType, isCompositeType, isAbstractType, isWrappingType, isNullableType, isNamedType, isRequiredArgument, isRequiredInputField, isSpecifiedScalarType, isIntrospectionType, isSpecifiedDirective, // Assertions
|
|
assertSchema, assertDirective, assertType, assertScalarType, assertObjectType, assertInterfaceType, assertUnionType, assertEnumType, assertInputObjectType, assertListType, assertNonNullType, assertInputType, assertOutputType, assertLeafType, assertCompositeType, assertAbstractType, assertWrappingType, assertNullableType, assertNamedType, // Un-modifiers
|
|
getNullableType, getNamedType, // Validate GraphQL schema.
|
|
validateSchema, assertValidSchema } from './type';
|
|
// Parse and operate on GraphQL language source files.
|
|
export { Source, getLocation, // Print source location
|
|
printLocation, printSourceLocation, // Lex
|
|
createLexer, TokenKind, // Parse
|
|
parse, parseValue, parseType, // Print
|
|
print, // Visit
|
|
visit, visitInParallel, visitWithTypeInfo, getVisitFn, BREAK, Kind, DirectiveLocation, // Predicates
|
|
isDefinitionNode, isExecutableDefinitionNode, isSelectionNode, isValueNode, isTypeNode, isTypeSystemDefinitionNode, isTypeDefinitionNode, isTypeSystemExtensionNode, isTypeExtensionNode } from './language';
|
|
// Execute GraphQL queries.
|
|
export { execute, defaultFieldResolver, defaultTypeResolver, responsePathAsArray, getDirectiveValues } from './execution';
|
|
export { subscribe, createSourceEventStream } from './subscription';
|
|
// Validate GraphQL documents.
|
|
export { validate, ValidationContext, // All validation rules in the GraphQL Specification.
|
|
specifiedRules, // Individual validation rules.
|
|
ExecutableDefinitionsRule, FieldsOnCorrectTypeRule, FragmentsOnCompositeTypesRule, KnownArgumentNamesRule, KnownDirectivesRule, KnownFragmentNamesRule, KnownTypeNamesRule, LoneAnonymousOperationRule, NoFragmentCyclesRule, NoUndefinedVariablesRule, NoUnusedFragmentsRule, NoUnusedVariablesRule, OverlappingFieldsCanBeMergedRule, PossibleFragmentSpreadsRule, ProvidedRequiredArgumentsRule, ScalarLeafsRule, SingleFieldSubscriptionsRule, UniqueArgumentNamesRule, UniqueDirectivesPerLocationRule, UniqueFragmentNamesRule, UniqueInputFieldNamesRule, UniqueOperationNamesRule, UniqueVariableNamesRule, ValuesOfCorrectTypeRule, VariablesAreInputTypesRule, VariablesInAllowedPositionRule, // SDL-specific validation rules
|
|
LoneSchemaDefinitionRule, UniqueOperationTypesRule, UniqueTypeNamesRule, UniqueEnumValueNamesRule, UniqueFieldDefinitionNamesRule, UniqueDirectiveNamesRule, PossibleTypeExtensionsRule } from './validation';
|
|
// Create, format, and print GraphQL errors.
|
|
export { GraphQLError, syntaxError, locatedError, printError, formatError } from './error';
|
|
// Utilities for operating on GraphQL type schema and parsed sources.
|
|
export { // Produce the GraphQL query recommended for a full schema introspection.
|
|
// Accepts optional IntrospectionOptions.
|
|
getIntrospectionQuery, // @deprecated: use getIntrospectionQuery - will be removed in v15.
|
|
introspectionQuery, // Gets the target Operation from a Document.
|
|
getOperationAST, // Gets the Type for the target Operation AST.
|
|
getOperationRootType, // Convert a GraphQLSchema to an IntrospectionQuery.
|
|
introspectionFromSchema, // Build a GraphQLSchema from an introspection result.
|
|
buildClientSchema, // Build a GraphQLSchema from a parsed GraphQL Schema language AST.
|
|
buildASTSchema, // Build a GraphQLSchema from a GraphQL schema language document.
|
|
buildSchema, // @deprecated: Get the description from a schema AST node and supports legacy
|
|
// syntax for specifying descriptions - will be removed in v16.
|
|
getDescription, // Extends an existing GraphQLSchema from a parsed GraphQL Schema
|
|
// language AST.
|
|
extendSchema, // Sort a GraphQLSchema.
|
|
lexicographicSortSchema, // Print a GraphQLSchema to GraphQL Schema language.
|
|
printSchema, // Print a GraphQLType to GraphQL Schema language.
|
|
printType, // Prints the built-in introspection schema in the Schema Language
|
|
// format.
|
|
printIntrospectionSchema, // Create a GraphQLType from a GraphQL language AST.
|
|
typeFromAST, // Create a JavaScript value from a GraphQL language AST with a Type.
|
|
valueFromAST, // Create a JavaScript value from a GraphQL language AST without a Type.
|
|
valueFromASTUntyped, // Create a GraphQL language AST from a JavaScript value.
|
|
astFromValue, // A helper to use within recursive-descent visitors which need to be aware of
|
|
// the GraphQL type system.
|
|
TypeInfo, // Coerces a JavaScript value to a GraphQL type, or produces errors.
|
|
coerceInputValue, // @deprecated use coerceInputValue - will be removed in v15
|
|
coerceValue, // @deprecated use coerceInputValue - will be removed in v15
|
|
isValidJSValue, // @deprecated use validation - will be removed in v15
|
|
isValidLiteralValue, // Concatenates multiple AST together.
|
|
concatAST, // Separates an AST into an AST per Operation.
|
|
separateOperations, // Strips characters that are not significant to the validity or execution
|
|
// of a GraphQL document.
|
|
stripIgnoredCharacters, // Comparators for types
|
|
isEqualType, isTypeSubTypeOf, doTypesOverlap, // Asserts a string is a valid GraphQL name.
|
|
assertValidName, // Determine if a string is a valid GraphQL name.
|
|
isValidNameError, // Compares two GraphQLSchemas and detects breaking changes.
|
|
BreakingChangeType, DangerousChangeType, findBreakingChanges, findDangerousChanges, // Report all deprecated usage within a GraphQL document.
|
|
findDeprecatedUsages } from './utilities';
|