graphql

Breaking

• Remove ambiguity in isLeafType check: it no longer performs named type unwrapping and is consistent with the other isCompositeType/isAbstractType checks (#697).

New

• Make wording in error messages more consistent (#767).
• Allow deprecated fields/values to be extended (#755).
• Validation messages about names starting with double underscores are now use console.warn rather than console.error (#717).
• Improved the error message for undefined field config (#702).
• The findBreakingChanges validation now reports breaking changes made to arguments (#701).

Internal

• Performance improvements to the separateOperations module (#710).
• Improvements to Flow checking (#699) and type safety (#698).

Fixes

• Downgrade error to warning for non-spec-compliant use of non-meta fields starting with __ (#692).
• Workaround for problem in some environments with reserved literals (such as default) being used as properties (#693).

New:

• Added isNamedType() and assertNamedType() #589
• Default field resolvers now get full execution info as a third argument #615
• ObjectType.isTypeOf() and InterfaceType.resolveType() may now return Promises #631
• Support and fixes for flow type v0.38 #671
• Added TypeInfo.getEnumValue() and EnumType.getValue(name) #674
• Added findDeprecatedUsages() #676

Fixes:

• Enforce spec that no non-meta field may start with "__" #600 (Potentially breaking for existing non-compliant uses).
• isValidJSValue() reports if coercion results in error #602
• Executor throws friendlier error if no document is provided #614
• Fixed import circular dependency, improving compressed builds #644

New:

• assertXXXType() functions help ensure type-correct code using graphql (#570)
• Added toJSON() and inspect() methods on all GraphQL types for easier debugging (#578)
• ValidationContext types are exported (a17256bb148389727db64d2832339d6dce32827a)

Fixes:

• Differentiate between input values with no default and with null default (#569)
• Improvements to Flow types in field resolvers (#573, #575, #577)

Fixes:

• Supports Flow v0.35
• GraphQL parser now returns clearer error messages (07cc624677f4c7120e588e530c6fdb2d87e6210a)

GraphQL.js v0.8.0 is now compliant with the most recent version of the GraphQL specification! This release is also the first to include flow types in the NPM package, which should make it easier to use GraphQL in a well typed way. It also includes many new utilities and small improvements. Thanks to everyone who helped with this release!

Breaking & Spec Changes:

• A resolve function's info.path value is now a Linked List instead of an Array (#562)
• A resolve function's info.fieldASTs value has been renamed to info.fieldNodes (#554)
• formatError now includes the path of field errors (#561)
• The most recent version of the GraphQL specification is more strict about field argument validation. (#553)
• The most recent version of the GraphQL specification does not allow multiple directives of the same name in the same location (#552)

New:

• GraphQL now supports a literal null value as a field argument. (#544)
• Flow type definitions are now included in the NPM package! The names of many types were changed to be more descriptive. (#554, #526, #412)
• printType lets you print a single GraphQL type using the experimental schema language (#558)
• defaultResolver, the field resolver used when one is not provided, is now available (#527)

New:

• An Interface or Union's resolveType function may return a string type name instance of an instance (#509)
• Adds utility for comparing schema for breaking changes (#508)

Fixes:

• No longer includes holes in the locations of a GraphQL Error (#507)

New:

• Adds parseType method, which allows for parsing type references independently of whole GraphQL documents (#506)
• Adds isDeprecated field to type definition API, making it easier to use within tools (#496 @asiandrummer)

Fixes:

• Allows GraphQL Errors to be configurable, fixing compatibility issues with Bluebird Promises (#505 @darthtrevino)
• Fix bug where locations go missing when the error comes from something at the beginning of the file (#487 @martijnwalraven)
• Supports Promises-A (in addition to Promises-A+) which improves support with older libraries (#481)
• No longer accept empty string as a valid Int/Float value. (#477 @robzhu)
• Provide clearer error message when variables are provided as an unparsed string. (f2f3db565ba6418c8d2351b468bf653d2300829a)

Thanks to many contributors, GraphQL v0.7.0 contains many improvements and a few new utilities for those building tools using graphql-js.

Most exciting is that the schema language is now more fully featured than ever and you can create new usable schemas directly from that language, making GraphQL easier to use than ever. Huge thanks to @lacker for his vision and effort in making this happen.

Breaking:

• Default resolver behavior now provides args and context, allowing for more powerful resolvers on your existing data objects (#468 @lacker)
• GraphQLError has been refactored to provide more information and behave more like the built-in Error object (8df7894c8974bd19c600ad05df9d42ed3def3e65)

New:

• GraphQL schema documents can now specify descriptions via doc-block style comments (#463 #464)
• Schema language documents no longer have to specify a schema declaration if their root types are named Query and Mutation (#470)
• GraphQLSchema generated by referencing introspection, read from a schema language document, or extending an existing schema can now be used for execution (#469)

New Utilities:

• buildSchema() is a utility for creating a usable GraphQLSchema directly from the GraphQL schema language (#471 @lacker)
• separateOperations() is a utility for splitting up a GraphQL document with many operations into multiple smaller documents with one operation each (#456)

Fixed:

• Extending a schema allows for defining new directives (#455 @robzhu)
• The stack of a GraphQLError is now more predictable, improving compatibility with other libraries (#452 @RylanH)

Thanks to the excellent contributions from community members both in the form of code, careful review, and thoughtful discussion. This version of GraphQL fixes a handful of issues

New:

• Union type definitions may now accept list of possible Types as a "thunk". (#436 @ekosz)
• List fields can now return any iterable collection, not limited to Array, including Backbone.Collection, or Immutable.js Lists. (#449, #300 @mwschall)

Fixed:

• Ensure source code is only ASCII. (#429 @kassens)
• astFromValue() now requires a Type as a second parameter and properly serializes Enums with different internal values. (#435 @nodkz)
• GraphQLError.stack is now a writable property, fixing issues in Bluebird and other libraries which use a brand-check for Error. (#439 @alexturek)
• GraphQLError.message, GraphQLError.locations, and GraphQLError.path are now enumerable properties, which means JSON.stringify() will now produce a value which is compliant with the GraphQL spec. (#426 @bnewtonius)
• Field errors are now thrown when values are resolved for fields typed Int or Float which are not representable by those types, improving debugability and spec compliance. (#391 @stubailo)
• Errors during field value completion (e.g. a value returned of an incorrect type) now include location information. (#445)

Builds on npm are now smaller and dependency-free! This should make graphql easier to use in clients like Apollo and Relay.

New:

• Execution errors now include a path property indicating the position in the response which produced the error. (#396)

Fixes:

• No longer causes issues when included in a React Native project. (#414)
• Better error reporting in edge cases thanks to improved Flow error checking. (c7700f206579eef0046649f26e42c8cd336e6e74)

This version introduces directives to the (still experimental) schema language and introduces a @deprecated directive for marking deprecated fields. It also improves validation error messages, thanks to @yuzhi and @robzhu.

New:

• Schema Language Directives (#376, #382)
• New @deprecated directive (#384)
• Directive constructor and built-ins are now exported from the main module (#381)
• Introspection types are now exported from the main module (71b6a4aaecf064c7095bca81cc4285fa74ba175e)
• Validation: improving overlapping fields quality, may detect new issues (#386)
• Improve validation error message when field names conflict (#363)
• Include possible names when validation fails (#355)
• Error logging for new interface type semantics (#350)

Fixes:

• Deepen introspection query from 3 levels to 7 (#364)
• Printer now correct prints empty block lists (ea5b241487c884edb561b12e0a92e947107bbfc1)
• Ensure buildASTSchema does not exclude @skip and @include (#380)

This version is the first reference implementation fully compatible with GraphQL — April 2016. In addition to any relevant breaking changes from the spec, it also has made some breaking changes to its API.

Thanks so much to those who contributed issues and pull requests for your help in improving GraphQL!

Breaking:

• The graphql and execute functions now accept a context parameter which is distinct from rootValue and available as the third argument to all resolve functions. The additional information is now the fourth argument to resolve functions. Any resolve function which currently uses the third argument will need to be updated in order to use this version of graphql-js. (#326)
• Types can now be explicitly provided to new GraphQLSchema({ types: [...] }). Types which implement an interface but are otherwise not referenced as a field return type are no longer automatically added to the Schema! Provide types like this directly to new GraphQLSchema to ensure they are included in order to use this version of graphql-js. This fixes a long-standing bug which made it difficult to build multiple related Schema with the same type instances. (#327)
• Spec compliance: Directives are now defined and introspected with an array of locations they can be legally placed, rather than a set of booleans. (#317)

New:

• Spec compliance: Overlapping fields must have compatible response shapes (https://github.com/graphql/graphql-js/commit/c034de91acce10d5c06d03bd332c6ebd45e2213c)
• More support for the experimental schema IDL: (#325) (#323) (https://github.com/graphql/graphql-js/commit/fdafe32724f2d6dac1ba360f1a440c0e633e75d9)

Fixes:

• Spec compliance: @skip and @include are now commutative. (#335) (https://github.com/graphql/graphql-js/commit/47f87fa701cb33fc1fb0ca65b4668c7a14a5ad11)
• Experimental schema IDL no longer allows duplicate query types. (https://github.com/graphql/graphql-js/commit/ffe76c51c44922e2a24494ef0def9e3b999caacb)
• No longer sends incorrect error messages when a response name is not provided (#319)
• Visitor now correctly encounters both enter and leave when editing the root node in an AST (#298)
• Visitor helpers are now directly exported (https://github.com/graphql/graphql-js/commit/5ea2ff1e17ff76ad0734c5ebd3041d0bd2b201e5)

Many breaking changes which have been planned for some time were introduced in the last few weeks. This beta release should help you test support. A full description of changes will be outlined in the final release, please refer to the commit history for detailed information.

New:

• Adds validator to ensure variable names are unique (#296)

Fixes:

• Fix a case where the AST printer could erroneously exclude information from anonymous operations (#289)

New:

• Utilities for comparing GraphQL types are now exported directly. (aff18e63c8befe9a380d75d82c80411921fe77cb)

Fixes:

• No longer parses documents which contain u2028 or u2029 characters, to comply with the spec. This is technically breaking, but these are so rare that I doubt anyone will encounter this.

New:

• The full GraphQL API is now exported from the top module. If you're building a tool that uses GraphQL.js, hopefully this makes it easier to import and use utilities in this library. (4547904dda4e430f1eda52dd3e2b7e150049a93b)
• Clearer error messages:
  • When a requested field cannot be found on an interface or union, we'll suggest an inline fragment. (#282)
  • When a variable isn't used, we'll include the name of the query that defined it.
  • When a field typed as List returns something that is not a list, the error will include the name of the type and field. (#276)
  • When an input type includes unknown information, ensure it's name is printed. (#261)

New:

• Original errors can now be retrieved from any GraphQLError with error.originalError #251.
• visitWithTypeInfo now supports visitors which edit or break-early.
• visitInParallel now experimentally supports visitors which edit or break-early.

Fixes:

• No longer allows 52-bit integers, instead requiring 32-bit values as per the spec.
• No more false-positive validation errors when validating a query which contains experimental type definitions #255.
• visitInParallel now correctly skips subtrees when a visitor returns false #254.
• Release now uses babel-runtime again, broken in 0.4.13, #246.

New:

• import { extendSchema } from 'graphql/utilities allows extending an existing schema with the GraphQL type definition language (#227)
• When an Object type implements an Interface type, a field on the Object type can return a more specific type than the same field defined on the Interface type. This "covariant return types" is now also defined in the GraphQL Spec (#239)
• Loosens the rule which requires overlapping fields to be unambiguously merged in the case that two same-named fields are statically known to not overlap due to being conditional to different types. This rule change has also been reflected in the GraphQL Spec (#229)
• Removes the rule which requires overlapping fields to have equivalent directives. This rule change has also been reflected in the GraphQL Spec (#230)
• Validation now ~25-30x faster due to a number of improvements including simplifications, algorithm improvements, memoization, and running validation rules in parallel.
  • Parallelizing rules will change the order in which validation errors are reported within a file.

Fixes:

• Fixes issues when used in a Babel 6 environment (#228)
• Validation error of incorrect variable placement now includes a reference to the variable definition for easier debugging.
• Validation errors of ambiguous overlapping fields now includes clearer non-interleaved references to the overlapping fields.
• Input object validation errors now include more accurate error messages documenting which input object field contains the error (#204)

New:

• Experimental customizable validation

Fixes:

• Validator could false positive and be overly verbose when spreading an unknown fragment (8c62789fd156761ca83992fb8d2192d41d768d13)

New:

• buildClientSchema() now supports deprecated fields #216
• Custom directives now supported by GraphQLSchema #215
• concatAST() utility added, which helps support validation of graphql fragments spread across multiple sources (3a6b4d130f225c275cba3027245ffaff0f4b7799)

Fixes:

• Nested input objects with similarly named keys could falsely fail validation #206

New

• Broadened legal use of interfaces to allow for additional arguments on implementing fields (see https://github.com/facebook/graphql/pull/110)

New:

• Supports subscription in the IDL grammar and Schema representation. There is minimal support for subscriptions in the executor - at this point should still be considered experimental.

Fixes:

• Validators are aware of inline fragments without type conditions (a0bf6f9bb1155a502649c8de743b4e35841b08b0)

Follows GraphQL October

New:

• Operations without names are accepted
• Inline fragments without type conditions are accepted

Fixes:

• Properly export getOperationAST utility from graphql/utilities

New:

• Resolvers can now return a JavaScript Error object to indicate resolution failure. They can also return Arrays where only certain indices contain Error objects. (#178)
• Unicode support clarified and restricted (#186)
• getOperationAST() utility added (f66ddf55f93010f7e2ca4ca717d522d4d0d4b12b)
• Early error if deprecation API is misused. (#185)
• Clearer lex errors when encountering a non-printable character (#183)

Fixes:

• Built-in Scalars and Introspection types now have descriptions
• Input object duplicate values now parse correctly and are reported as validation errors (#184)

Fixes

• Syntax errors related to parsing of 'extend type' declaration #166

New:

• [Experimental] GraphQL parser/visitor now supports experimental type definition language.
• [Experimental] GraphQL parser now accepts subscription as an operation kind keyword.

Fixes:

• Type definition will no longer allow the use of invalid Name for type, field, and argument names. #145
• Improved error messages for syntax errors relating to numbers.
• No longer modify field definition objects provided to type definitions. #132
• Sundry minor documentation, typo and test improvements.

Fixes:

• Improves error messaging for Syntax errors.

New/Breaking:

• Asserts that the GraphQLSchema and GraphQLType types are properly constructed, following the "validation" rules defined in the GraphQL Spec
  • Asserts that Objects which claim to implement an Interface actually do.
  • Schema asserts that all included types have unique names.
  • Clearer error messages when incorrect type used in GraphQLType constructors, including List and NonNull type constructors.
  • Asserts that Scalar definitions include serialization functions.
  • Removal of the graphql/type/validation submodule.
• Asserts that the runtime Object type result of an Interface or Union typed field is a type is a possible type of that Interface or Union.
• EnumType.getValues() now returns an Array.

Fixes:

• Correctly parse Enum values from variables. #123

Breaking/New:

• isTypeOf is now called (if defined) to assert that GraphQL object types are executing against the correct values #38
• Field resolve functions now have a new API: resolve(value, args, info), where info is an object which contains the same information which used to be separate arguments, and includes more useful stuff! https://github.com/graphql/graphql-js/blob/master/src/type/definition.js#L359
• graphql() no longer formats its errors. result.errors is now a list of GraphQLError instances, which provides useful information including stack traces.
• Arguments and Input Object Fields not provided are not set on the internal JS objects. The previous behavior was to set null for these arguments and fields.
• Scalar definition coerce and coerceLiteral have been renamed to serialize and parseLiteral respectively.
• Scalar definitions may now define parseValue which is used when interpreting variable values of that type. Previously coerce was being reused for this purpose.

Fixed:

• Nested input objects are no longer excluded by introspection.
• Fix issue where a fragment spread with missing definition breaks the validator.

New:

• Adds all validation rules for uniqueness recently added to the GraphQL spec.

Fixed:

• formatError is exported directly from graphql.
• One validation error no longer causes spurious failures of other validations.
• Directive arguments no longer incorrectly invalidate.
• Validation errors have slightly improved messages.

Fixes:

• Fix issue with buildASTSchema when floats are used. (#104)
• Fix issue with buildASTSchema when invalid mutation is passed.
• Fix issue with buildASTSchema when type is only referenced via interface.

Fixes:

• Update print-schema script to work with refactored schema module.
• Fix issue with buildASTSchema when both query and mutation are passed. (#100)

Temporary push to fix mismatch between package.json and tags.

Fixes:

• Fix case reported by @steveluscher where overlapping fragments could incorrectly invalidate.

Fixes:

• Removes flow comments from npm published JS. Unfortunately the flow-comment transpiler is too buggy at this point in time.

New:

• Flow types are included in the npm release in the form of flow-comments. Flow will find and utilize these when you install graphql-js via npm, and if you don't use flow then it's business as usual.
• GraphQL Type predicates for common groupings are now exported from graphql/type.
• A new submodule graphql/language/schema for parsing and working with the GraphQL schema language.
• The submodule graphql/utilities was included which adds a lot of useful functions for building client tools.
  • A definitive full introspection query.
  • Build a client-side GraphQLSchema instance from an introspection result.
  • Build a client-side GraphQLSchema from GraphQL Schema language.
  • Print a GraphQLSchema to GraphQL Schema language.
  • Create a GraphQLType instance from GraphQL Schema language.
  • Create a JavaScript value from a GraphQL language value.
  • Create a GraphQL language value from a JavaScript value.
  • A smart visitor which maintains type information as it visits the GraphQL document AST.
  • Utilities to determine if a JavaScript value or GraphQL language value adhere to a GraphQL type.
• Minor re-organization of submodules.

New:

• GraphQL submodules are now directly accessible as public API.

  import { ... } from 'graphql/language';
  

No changes, just testing auto-publish from Travis CI

Fixes:

• Update dependencies
• Read files correctly for tools

New:

• Adds schema printer tool which accepts schema definition files and prints the result of an introspection query against that schema.

New:

• Adds Schema Definition Language Parser

Fixed:

• Fixes defaultValue behavior
• Update to latest babel
• Reconciles Union declaration
• Corrects directive introspection

Fixed:

• Validator could result in unhelpful error for some invalid queries

New:

• Float parsing rules have expanded to match JSON grammar #68
• Type schema pretty printer #67
• Executor and Validator now return non-formatted Errors to provide more useful information.
• Simplified API for Validators.

Fixed:

• Int values higher than 32bit are no longer inadvertently truncated #69
• The name null can no longer be used as a GraphQL value.
• Parser fixed to not allow on as a fragment name
• AST printer produces strings which match examples in Spec

Fixed:

• #25 - Imported npm package throws errors within flow
• Community crowd-sourced spell-check.

New:

• Updated grammar for Directives. @skip and @include directives are now available.

Fixed:

• #17 - Returning array of promises would not resolve correctly.
• Community crowd-sourced spell-check.

This is the initial public release to npm which includes the GraphQL core functionality as described in the spec.