brick_graphql 3.1.0

brick_graphql: ^3.1.0 copied to clipboard

• Apply standardized lints
• Upgrade minimum Dart to 2.18

• Support Dart 3

Please follow the v3 migration guide to easily upgrade.

• BREAKING CHANGE Rename graphql.dart to brick_graphql.dart
• Use Dart 2.15's .byName accessor for iterable enum values and remove GraphqlAdapter.enumValueFromName and GraphqlAdapter.firstWhereOrNull. Instead use <Enum>.values.byName and import 'package:collection/collection.dart''s .firstWhereOrNull respectively.
• BREAKING CHANGE consolidate providerArgs['document'] and providerArgs['variables'] to providerArgs['operation']. providerArgs['operation'] should be a GraphqlOperation which can be constructed with a document and variables

• Remove operationName. This isn't exactly what it appears to be.

• Include operationName when programmatically generating operations

• BREAKING CHANGE GraphqlProvider#queryToVariables has been moved to internal class GraphqlRequest
• Update minimum Dart to 2.15

BREAKING CHANGE

All Graphql operations are now declared in a single class - GraphqlQueryOperationTransformer. A single Migration guide:

1. Create a new class that extends GraphqlQueryOperationTransformer:

   class UserQueryOperationTransformer extends GraphqlQueryOperationTransformer {
     const UserQueryOperationTransformer(super.query, super.instance);
   }
   

2. This class has access to every request's query, and for delete and upsert, instance. Move all declared properties to within one of get, delete, subscribe or upsert. defaultSubscriptionFilteredOperation and defaultSubscriptionOperation are now subscribe. Additionally, defaultQueryFilteredOperation and defaultQueryFilteredOperation have been consolidated to get (example below)

   class UserQueryOperationTransformer extends GraphqlQueryOperationTransformer {
     GraphqlOperation get get {
       if (query.where != null) {
         return GraphqlOperation(document: r'''
           query FilteredUsers($name: String!) {
             usersByName(input: $input) {}
           }
         ''');
       }
       return GraphqlOperation(document: r'''
         query AllUsers {
           users {}
         }
       ''');
     }
   }
   

3. In complex cases where the entire model is not being transmitted, variables can also be supplied.

   class UserQueryOperationTransformer extends GraphqlQueryOperationTransformer {
     GraphqlOperation get upsert {
       if (query.where != null) {
         return GraphqlOperation(
           document: r'''
             mutation UpdateUserName($name: String!) {
               updateUserName(input: $input) {}
             }
           ''',
           variables: {'name': Where.firstByField('name', query.where)});
       }
       return null;
     }
   }
   

4. Use the class in GraphqlSerializable (this replaces all operation declarations):

   @GraphqlSerializable(
     queryOperationTransformer: UserQueryOperationTransformer.new
   )
   

• Only return get documents for get operations when constructing the GraphQL document

• Convert @Graphql(subfields:) to accept a Map<String, Map<String, dynamic>> to permit nested subfields from JSON-encoded field types.

• Handle edge case where GraphQL response is null and an empty iterable
• Use specified @Graphql(name:) when generating the document request

• Override subfields generation by supplying the necessary subfields with @Graphql

• Loosen gql, gql_exec, and gql_link restriction

• If a document is declared without subfields, do not overwrite this definition with subfields from the model.
• Add variablesNamespace to wrap all variables from all requests. Variables passed from providerArgs will not be wrapped within the namespace.

• Return null if no GraphQL document can be inferred in ModelFieldsDocumentTransformer instead of throwing an ArgumentError. This mirrors behavior in brick_rest.

• Add subfields to RuntimeGraphqlDefinition; support subfields in ModelFieldsDocumentTransformer
• When a field's type declares a toJson method that returns a map, subfields will be automatically populated on fetch requests based on the final instance fields of that field's type.

• Loosen dependency restrictions to major versions
• Expose RuntimeGraphqlDefinition

• Stable release

• Supply context as <String, ContextEntry> instead of type do to a limitation in JSON serialization

• Support supplying context in Query#providerArgs

• Rename fieldsToRuntimeDefinition to fieldsToGraphqlRuntimeDefinition

• Return List<_Model> when invoking subscribe

Alpha release