alpha.5

Author: f3ath

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Automatically encode DateTime objects as an ISO-8601 string
+
 ### Changed
 - URL Design matching now respects the base URL
 - Allo null to be returned by error interceptors

lib/src/client/payload_codec.dart

@@ -1,6 +1,8 @@
 import 'dart:async';
 import 'dart:convert';
 
+import 'package:json_api/src/document/document_encoder.dart';
+
 /// Encodes/decodes JSON payload.
 ///
 /// The methods are designed to be asynchronous to allow for conversion to be
@@ -16,5 +18,6 @@ class PayloadCodec {
   }
 
   /// Encodes a JSON:API document into a JSON string.
-  FutureOr<String> encode(Object document) => jsonEncode(document);
+  FutureOr<String> encode(Object document) =>
+      jsonEncode(document, toEncodable: documentEncoder);
 }

lib/src/document/document_encoder.dart

@@ -0,0 +1,7 @@
+import 'package:json_api/document.dart';
+
+Object? documentEncoder(Object? v) => switch (v) {
+      OutboundDocument() => v.toJson(),
+      DateTime() => v.toIso8601String(),
+      _ => throw UnsupportedError('Cannot convert to JSON: $v'),
+    };

lib/src/server/controller.dart

@@ -1,43 +1,36 @@
-import 'package:http_interop/http_interop.dart' as http;
+import 'package:http_interop/http_interop.dart';
 import 'package:json_api/routing.dart';
 
 /// JSON:API controller
 abstract class Controller {
   /// Fetch a primary resource collection
-  Future<http.Response> fetchCollection(http.Request request, Target target);
+  Future<Response> fetchCollection(Request request, Target target);
 
   /// Create resource
-  Future<http.Response> createResource(http.Request request, Target target);
+  Future<Response> createResource(Request request, Target target);
 
   /// Fetch a single primary resource
-  Future<http.Response> fetchResource(
-      http.Request request, ResourceTarget target);
+  Future<Response> fetchResource(Request request, ResourceTarget target);
 
   /// Updates a primary resource
-  Future<http.Response> updateResource(
-      http.Request request, ResourceTarget target);
+  Future<Response> updateResource(Request request, ResourceTarget target);
 
   /// Deletes the primary resource
-  Future<http.Response> deleteResource(
-      http.Request request, ResourceTarget target);
+  Future<Response> deleteResource(Request request, ResourceTarget target);
 
   /// Fetches a relationship
-  Future<http.Response> fetchRelationship(
-      http.Request rq, RelationshipTarget target);
+  Future<Response> fetchRelationship(Request rq, RelationshipTarget target);
 
   /// Add new entries to a to-many relationship
-  Future<http.Response> addMany(
-      http.Request request, RelationshipTarget target);
+  Future<Response> addMany(Request request, RelationshipTarget target);
 
   /// Updates the relationship
-  Future<http.Response> replaceRelationship(
-      http.Request request, RelationshipTarget target);
+  Future<Response> replaceRelationship(
+      Request request, RelationshipTarget target);
 
   /// Deletes the members from the to-many relationship
-  Future<http.Response> deleteMany(
-      http.Request request, RelationshipTarget target);
+  Future<Response> deleteMany(Request request, RelationshipTarget target);
 
   /// Fetches related resource or collection
-  Future<http.Response> fetchRelated(
-      http.Request request, RelatedTarget target);
+  Future<Response> fetchRelated(Request request, RelatedTarget target);
 }

lib/src/server/response.dart

@@ -1,17 +1,19 @@
 import 'package:http_interop/http_interop.dart';
 import 'package:json_api/document.dart';
 import 'package:json_api/http.dart';
+import 'package:json_api/src/document/document_encoder.dart';
 import 'package:json_api/src/media_type.dart';
 
 /// JSON:API response
-Response response(int statusCode, {OutboundDocument? document}) {
-  final r = Response(
-      statusCode, document != null ? Body.json(document) : Body(), Headers());
-  if (document != null) {
-    r.headers['Content-Type'] = [mediaType];
-  }
-  return r;
-}
+Response response(int statusCode, {OutboundDocument? document}) => Response(
+    statusCode,
+    document != null
+        ? Body.json(document, toEncodable: documentEncoder)
+        : Body(),
+    Headers())
+  ..headers.addAll({
+    if (document != null) 'Content-Type': [mediaType]
+  });
 
 Response ok(OutboundDocument document) =>
     response(StatusCode.ok, document: document);

pubspec.yaml

@@ -1,13 +1,13 @@
 name: json_api
-version: 9.0.0-alpha.4
+version: 9.0.0-alpha.5
 homepage: https://github.com/f3ath/json-api-dart
 description: A framework-agnostic implementations of JSON:API Client and Server. Supports JSON:API v1.0 (https://jsonapi.org)
 environment:
   sdk: '>=3.5.0 <4.0.0'
 
 dependencies:
   http_parser: ^4.0.0
-  http_interop: ^2.0.0
+  http_interop: ^2.1.0
   http_interop_middleware: ^0.1.0
 
 dev_dependencies:

test/unit/server/response_test.dart

@@ -0,0 +1,18 @@
+import 'package:http_interop/extensions.dart';
+import 'package:json_api/document.dart';
+import 'package:json_api/server.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group('Response', () {
+    test('converts DateTime to ISO-8601', () async {
+      final r = response(200,
+          document: OutboundDocument()..meta['date'] = DateTime(2021));
+      expect(
+          await r.body.decodeJson(),
+          equals({
+            'meta': {'date': '2021-01-01T00:00:00.000'}
+          }));
+    });
+  });
+}