brick_rest 4.0.0+1

brick_rest: ^4.0.0+1 copied to clipboard

• BREAKING CHANGE Query(providerArgs:) is no longer supported; see 3.1.0 for migration steps
• BREAKING CHANGE Rest(nullable:) is no longer supported; see 3.2.0 for migration steps
• Dart minimum SDK is updated to 3.4.0
• All dependency restrictions are updated to include the minimum released version.

• DEPRECATION remove Rest#nullable. Builders should evaluate the nullable suffix of the field instead

• DEPRECATION Query(providerArgs: {'request':}) is now Query(forProviders: [RestProviderQuery(request:)]). #510
• Upgrade brick_core to 1.3.0
• Update analysis to modern lints
• New RestProviderQuery adds REST-specific support for the new Query.

• Access FieldRename from brick_core instead of declaring within this package

• Apply standardized lints
• Upgrade minimum Dart to 2.18
• Update minimum HTTP to 1.0.0

• Support Dart 3

• Support accessing supplementalTopLevelData from any REST request that accepts a body (PUT, PATCH, POST). Additionally, include supplementalTopLevelData defined within RestRequest instances defined outside providerArgs

Please follow the v3 migration guide to easily upgrade.

• BREAKING CHANGE Rename main export file to brick_rest.dart
• BREAKING CHANGE replace RestSerializable(endpoint:) with RestSerializable(requestTransformer:)
• Add RestAdapter#restRequest
• BREAKING CHANGE providerArgs['topLevelKey'] and providerArgs['headers'] and providerArgs['supplementalTopLevelData'] have been removed (use 'request') and providerArgs['request'] now accepts a RestRequest instead of the HTTP method string.
• Use Dart 2.15's .byName accessor for iterable enum values and remove RestAdapter.enumValueFromName and RestAdapter.firstWhereOrNull. Instead use <Enum>.values.byName and import 'package:collection/collection.dart''s .firstWhereOrNull respectively.

• Upgrade brick_core

• Add Dart Lints
• Change instance and data positional arguments in RestAdapter to input to match generator variable

• Add support for PATCH requests (#188)

• Improve code hint documentation
• Move RestProvider#statusCodeIsSuccessful to RestProvider.statusCodeIsSuccessful
• Require provider in RestAdapter#fromRest and RestAdapter#toRest

• Require provider in adapter methods fromRest and toRest

• Add static methods .firstWhereOrNull and .enumValueFromName to RestAdapter to support null safe building

• Null safety

• Add GZipHttpClient. When instantiating the RestProvider, optionally compose client with a GZipHttpClient to gzip all requests.

• Change _convertJson to protected method convertJsonFromGet (#57)

• When url is null in RestProvider#upsert and RestProvider#delete, return null and do not attempt to perform the action
• On upsert invocations, specify supplementalTopLevelData to include other information outside the topLevelKey/toKey. This inserts a map alongside the data generated by the adapter.

• Carry rename from Query#params to Query#providerArgs from brick_core

• Rest#defaultValue updated to reflect FieldSerializable#defaultValue change

• Fix linter hints