genqlient/docs/CHANGELOG.md

Changelog

next

Breaking changes:

• The Config fields Schema and Operations are now both of type StringList. This does not affect configuration via genqlient.yaml, only via the Go API.

New features:

• genqlient now generates getter methods for all fields, even those which do not implement a genqlient-generated interface; this can be useful for callers who wish to define their own interface and have several unrelated genqlient types which have the same fields implement it.
• genqlient config now accepts either a single or multiple files for the schema and operations fields (previously it accepted only one schema, and required a list of operations files).
• The typename option can now be used on basic types (string, int, etc) as well as structs; this can be useful to have genqlient define new types like type Language string and use that type for specified fields.

Bug fixes:

• In certain very rare cases involving duplicate fields in fragment spreads, genqlient would generate code that failed to compile due to duplicate methods not getting promoted; genqlient now generates correct types. (See #126 for a more complete description.)

v0.3.0

Version 0.3.0 adds several new configuration options, allowing simplification of generated types and configuration of input types, as well as marshalers for all genqlient-generated types.

Breaking changes:

• Previously, # @genqlient directives applied to entire operations applied inconsistently to fields of input types used by those operations. Specifically, pointer: true, when applied to the operation, would affect all input-field arguments, but omitempty: true would not. Now, all options apply to fields of input types; this is a behavior change in the case of omitempty.

New features:

• genqlient's types are now safe to JSON-marshal, which can be useful for putting them in a cache, for example. See the docs for details.
• The new flatten option in the # @genqlient directive allows for a simpler form of type-sharing using fragment spreads. See the docs for details.
• The new for option in the # @genqlient directive allows applying options to a particular field anywhere it appears in the query. This is especially useful for fields of input types, for which there is otherwise no way to specify options; see the documentation on handling nullable fields for an example, and the # @genqlient directive reference for the full details.

Bug fixes:

v0.2.0

Version 0.2.0 adds several convenience features for using custom scalars, as well as many internal improvements and bug fixes.

Breaking changes:

• The graphql.Client interface now accepts variables interface{} (containing a JSON-marshalable value) rather than variables map[string]interface{}. Clients implementing the interface themselves will need to change the signature; clients who simply call graphql.NewClient are unaffected.
• genqlient's handling of the omitempty option has changed to match that of encoding/json, from which it had inadvertently differed. In particular, this means struct-typed arguments with # @genqlient(omitempty: true) will no longer be omitted if they are the zero value. (Struct-pointers are still omitted if nil, so adding pointer: true will typically work fine. It's also now possible to use a custom marshaler to explicitly map zero to null.)

New features:

• The new bindings.marshaler and bindings.unmarshaler options in genqlient.yaml allow binding to a type without using its standard JSON serialization; see the documentation for details.
• Multiple genqlient directives may now be applied to the same node, as long as they don't conflict; see the directive documentation for details.

Bug fixes:

• The omitempty option now works correctly for struct- and map-typed variables, matching encoding/json, which is to say it never omits structs, and omits empty maps. (#43)
• Generated type-names now abbreviate across multiple components; for example if the path to a type is (MyOperation, Outer, Outer, Inner, OuterInner), it will again be called MyOperationOuterInner. (This regressed in a pre-v0.1.0 refactor.) (#109)
• Previously, interface fields with # @genqlient(pointer: true) would be unmarshaled to (*MyInterface)(*<nil>), i.e. a pointer to the untyped-nil of the interface type. Now they are unmarshaled as (*MyInterface)(<nil>), i.e. a nil pointer of the pointer-to-interface type, as you would expect.

v0.1.0

First open-sourced version.