graphql_client_codegen

• Prepare v0.14

• Update CHANGELOG

• Update update date

• Fix new clippy warning

Release 0.13.0 (#452)

• Switch to BTree to make codegen's output deterministic
• Add support for skip_none and skip_serializing_none
• Fix CI

• The variables_derives now trims whitespace from individual derivation traits.
• The new reqwest-rustls feature works like the reqwest feature but with rustls rather than native-tls.
• Code generated by the graphql-client CLI program now suppresses all warnings from rustc and clippy.
• Derive from both variables and response for enum
• Camel case input variables in .graphql files now generate snake_case variable names in Rust
• Support Paths in response derives
• cli: Display server responses when introspection failed
• upgrade to graphql_parser 0.4
• Add support for fragments-other-variant

• The web feature is dropped. You can now use a reqwest::Client instead of the custom HTTP client.
• Allow specifying externally defined enums (thanks @jakmeier)
• Make the derive feature optional (but enabled by default)
• --no-ssl param in CLI (thanks @danielharbor!)
• The shape of some generated response types changed to be flatter and more ergonomic.
• Many dependencies were dropped
• A CLI and derive option to specify a module to import custom scalar from. Thanks @miterst! (PR)

Only run skeptic in test mode

Added

• If there is no schema declaration in a schema, the root types will be matched by name (Query, Mutation and Subscription).

Changed

• Enums now always derive PartialEq and Eq by default

Fixed

• Code generation for fragments on unions was fixed
• Support for recursive fragments and input types
• The graphql-parser dependency version is no longer pinned

Added

• The CLI can now optionally format the generated code with rustfmt (enable the rustfmt feature).

• When deriving, the generated module now has the same visibility (private, pub, pub(crate) or crate) as the struct under derive.

• Codegen now supports type-refining fragments, i.e. fragments on interfaces or unions that only apply to one of the variants. Example:

  type Pie {
    diameter: Integer
    name: String
  }
  
  type Sandwich {
    length: Float
    ingredients: [String]
  }
  
  union Food = Sandwich | Pie
  
  type Query {
    lunch: Food
  }
  
  fragment PieName on Pie {
    name
  }
  
  query Test {
    lunch {
      ...PieName
      ...on Sandwich {
        length
      }
    }
  }
  
  

Changed

• (BREAKING) GraphQLQuery does not take a lifetime parameter anymore. This makes it easier to work with futures in async client, since futures expect everything they capture to have the 'static lifetime.
• (BREAKING) Removed the Rust prefix on the name of generated items.
• (BREAKING) If you don't set --selected-operation options with graphql-client generate, the cli generate all queries in query file.

Fixed

• When using edition 2018, you no longer need to add #[macro_use] extern crate serde_derive to your crate for the generated modules to compile (thanks @aergonaut!)

Added

• Better error messages from the derive macro stwhen the schema or the query file path is not found.

Added

• Support for @deprecated field annotations. You can configure how deprecations are handled via the deprecated argument in the GraphQLQuery derive:

  #[derive(GraphQLQuery)]
  #[graphql(
      schema_path = "src/graphql/schema.json",
      query_path = "src/graphql/queries/my_query.graphql",
      deprecated = "warn"
  )]
  pub struct MyQuery;
  

  Valid values are:

  • allow: the response struct fields are not marked as deprecated.
  • warn: the response struct fields are marked as #[deprecated].
  • deny: The struct fields are not included in the response struct and using them is a compile error.

  The default is warn.

  This is a breaking change if you have the #[deny(deprecated)] compiler lint and you use deprecated fields in your queries. The quick solution is to annotate the relevant queries with depracated = "allow" as shown above.

• The CLI now supports the --authorization flag to pass the contents of an Authorization header. Thanks to @h-michael for the PR!

• Improved some codegen error messages, giving more context. Thanks @mathstuf!

• Aliases in queries are now supported. Beyond the ergonomics, this is an important feature since it allows to query the same field on an object multiple times with different arguments, as shown in the official guide. Thanks a lot @mathstuf!

• The traits in response_derives are now used for input types (variables) as well. In the future we may want to separate the options, but we will first experiment this way.

• Most of the graphql-query-derive crate was factored out into a new graphql-client-codegen crate that should enable code generation through means other than custom derives (CLI, build scripts...). Thanks @h-michael for this important refactoring!

• Top-level exported types have been renamed. Types no longer have a GraphQL prefix. e.g. GraphQLQuery -> Query, GraphQLError -> Error.

• For several classes of items that we generate, we only generate those that are actually used by the query. This way, you do not need to define mappings for every scalar in the schema you are querying - even for small queries - anymore. This also improves compile times a lot in some scenarios. (#116 - thanks @mathstuf!)

• GraphQLError now implements the Display trait.

• Basic support for fragments on interfaces. See #154 for what is not supported yet.

Fixed

• Handle all Rust keywords as field names in codegen by appending _ to the generated names, so a field called type in a GraphQL query will become a type_ field in the generated struct. Thanks to @scrogson!

• Some error message improvements.

• The operationName field is now correctly set on request bodies.

This is the initial public release in which the library is considered usable.

Added

• Support generating a Variables struct for a given query and schema through a custom derive, corresponding to the expected variables.
• Support generating a ResponseData struct for a given query and schema through a custom derive, corresponding to the shape of the expected response.
• Various utility traits and structs for working with GraphQL query. This notably does not include code to actually perform the network operations. This may be part of future releases.
• Docs and examples