json_api 8.1.0

A framework-agnostic implementations of JSON:API Client and Server. Supports JSON:API v1.0 (https://jsonapi.org)

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

8.1.0 - 2024-08-29

Added

• The rawResponse property to the responses of the RoutingClient

Deprecated

• The httpResponse property of the responses of the RoutingClient

8.0.0 - 2024-07-01

Added

• CORS middware

Changed

• Bump http_interop to v2.0

7.0.1 - 2024-06-17

Fixed

• "Accept" header with multiple values was being mishandled

7.0.0 - 2023-11-12

Changed

• Migrated to http_interop v1.

6.0.1 - 2023-09-11

Fixed

• NewRelationship was not exported

6.0.0 - 2023-09-07

Added

• Partial support for JSON:API v1.1

Changed

• A bunch of BC-breaking changes. Please refer to the tests.
• Min SDK version is 3.0.0
• Migrated to http_interop. You'll have to install http_interop_http or another implementation to get the HTTP client.

Removed

• Query filter.

5.4.0 - 2023-04-30

Changed

• Switch to http_interop packages.
• Bump min SDK version to 2.19.

5.3.0 - 2022-12-29

Added

• Client MessageConverter class to control HTTP request/response conversion.

5.2.0 - 2022-06-01

Added

• Support for included resources in create and update methods. Author: @kszczek

5.1.0 - 2022-05-11

Changed

• Dependency versions bump
• Minor formatting improvements

5.0.5 - 2021-07-19

Fixed

• Pagination with null values crashes json parser (#123)

5.0.4 - 2021-05-20

Fixed

• Missing meta properties in responses

5.0.3 - 2021-05-19

Fixed

• Missing "meta" arguments in RoutingClient

5.0.2 - 2021-05-12

Fixed

• PersistentHandler to implement HttpHandler

5.0.1 - 2021-05-11

Fixed

• Missing http client exports
• Failing test

5.0.0 - 2021-04-21

Added

• Sound null-safety support.

Changed

• Everything. Again. This is another major BC-breaking rework. Please refer to the API documentation, examples and tests.

3.2.3 - 2020-08-06

Fixed

• Call toJson() on resourceObject when serializing (#84)

4.3.0 - 2020-07-30

Added

• meta parameter for createResourceAt()

Removed

• Dropped support for Dart 2.6

4.2.2 - 2020-06-05

Fixed

• Client throws NoSuchMethodError on unexpected primary data (issue).

4.2.1 - 2020-06-04

Fixed

• The server library was not exporting Controller.
• ResourceData.toJson() was not calling the underlying ResourceObject.toJson().

4.2.0 - 2020-06-03

Added

• Filtering support for collections (pr)

Changed

• The client will not attempt to decode the body of the HTTP response with error status if the correct Content-Type is missing. Before in such cases a FormatException would be thrown (pr)

4.1.0 - 2020-05-28

Changed

• DartHttp now defaults to utf8 if no encoding is specified in the response.

4.0.0 - 2020-02-29

Changed

• Everything. This is a major BC-breaking rework which affected pretty much all areas. Please refer to the documentation.

3.2.2 - 2020-01-07

Fixed

• Can not decode related resource which is null (#77)

3.2.1 - 2020-01-01

Fixed

• Incorrect URL in the example in the Client documentation (#74)

3.2.0 - 2019-12-30

Added

• matchBase option to PathBasedUrlDesign.
• Resource.toIdentifier()method.

Changed

• (Server, BC-breaking) JsonApiController made generic.

Removed

• The package does not depend on collection anymore.

3.1.0 - 2019-12-19

Added

• (Server) Routing is exposed via server library.

Changed

• (Server, BC-breaking) Controller renamed to JsonApiController.
• (Server, BC-breaking) Response renamed to JsonApiResponse.

Fixed

• (Server) Response classes had included member initialized to [] by default. Now the default is null.

3.0.0 - 2019-12-17

Added

• Support for custom non-standard links (#61)
• Client supports jsonapi key in outgoing requests.
• Document.contentType constant.
• IdentifierObject.fromIdentifier factory method

Changed

• URLBuilder was renamed to UrlFactory.
• DocumentBuilder was split into ServerDocumentFactory and ClientDocumentFactory. Some methods were renamed.
• Static decodeJson methods were renamed to fromJson.
• Identifier.equals now requires the runtime type to be exactly the same.
• Link.decodeJsonMap was renamed to mapFromJson.
• The signature of TargetMatcher.
• The signature of Controller.
• Server was renamed to JsonApiServer.
• Pagination was renamed to PaginationStrategy.

Removed

• (Server) ResourceTarget, CollectionTarget, RelationshipTarget classes.
• QueryParameters interface.
• Router class.
• Query class.

2.1.0 - 2019-12-04

Added

• onHttpCall hook to enable raw http request/response logging (#60).

2.0.3 - 2019-09-29

Fixed

• Documentation links got broken due to pub.dev update.

2.0.2 - 2019-08-01

Fixed

• Meta members have incorrect type (#54).

2.0.1 - 2019-07-12

Fixed

• Readme example was outdated.

2.0.0 - 2019-07-12

Changed

• This package now consolidates the Client, the Server and the Document in one single library. It does not depend on json_api_document and json_api_server anymore, please remove these packages from your pubspec.yaml.
• The min Dart SDK version bumped to 2.3.0
• The Client requires an instance of HttpClient to be passed to the constructor explicitly.
• Both the Document and the Server have been refactored with lots of BREAKING CHANGES. See the examples and the functional tests for details.
• Meta properties are not defensively copied, but set directly. Meta property behavior is unified across the Document model.

Removed

• JsonApiParser is removed. Use the static decodeJson methods in the corresponding classes instead.

1.0.1 - 2019-04-05

Fixed

• Bumped the dependencies versions due to a bug in json_api_document.

0.6.0 - 2019-03-25

Changed

• JSON:API Document moved out
• Renamed client.removeToOne(...) to client.deleteToOne(...)

0.5.0 - 2019-03-21

Added

• Related collection pagination
• Async operations support

Changed

• More BC-breaking changes in the Server

Fixed

• Location headers were incorrectly generated by Server

1.0.0 - 2019-03-20

Changed

• JSON:API Server moved out

0.4.0 - 2019-03-17

Added

• Compound documents support in Client (Server-side support is still very limited)

Changed

• Parsing logic moved out
• Some other BC-breaking changes in the Document
• Huge changes in the Server

Fixed

• Server was not setting links for resources and relationships

0.3.0 - 2019-03-16

Added

• Resource attributes update
• Resource relationships update

Changed

• Huge BC-breaking refactoring in the Document model which propagated everywhere

0.2.0 - 2019-03-01

Added

• Improved ResourceController error handling
• Resource creation
• Resource deletion

0.1.0 - 2019-02-27

Added

• Client: fetch resources, collections, related resources and relationships