Feature/support sort order in identities

lib/jmap/core/capability/capability_identifier.dart

@@ -9,6 +9,7 @@ class CapabilityIdentifier with EquatableMixin {
   static final jmapMdn = CapabilityIdentifier(Uri.parse('urn:ietf:params:jmap:mdn'));
   static final jmapQuota = CapabilityIdentifier(Uri.parse('urn:ietf:params:jmap:quota'));
   static final jmapTeamMailboxes = CapabilityIdentifier(Uri.parse('urn:apache:james:params:jmap:mail:shares'));
+  static final jamesSortOrder = CapabilityIdentifier(Uri.parse('urn:apache:james:params:jmap:mail:identity:sortorder'));
 
   final Uri value;
 

lib/jmap/identities/get/get_identity_method.dart

@@ -26,6 +26,12 @@ class GetIdentityMethod extends GetMethod {
     CapabilityIdentifier.jmapSubmission
   };
 
+  Set<CapabilityIdentifier> get requiredCapabilitiesSupportSortOrder => {
+    CapabilityIdentifier.jmapCore,
+    CapabilityIdentifier.jmapSubmission,
+    CapabilityIdentifier.jamesSortOrder
+  };
+
   @override
   List<Object?> get props => [methodName, accountId, ids, properties, requiredCapabilities];
 

lib/jmap/identities/identity.dart

@@ -1,12 +1,15 @@
 import 'package:equatable/equatable.dart';
 import 'package:jmap_dart_client/http/converter/identities/identity_id_nullable_converter.dart';
 import 'package:jmap_dart_client/http/converter/identities/signature_nullable_converter.dart';
+import 'package:jmap_dart_client/http/converter/unsigned_int_nullable_converter.dart';
 import 'package:jmap_dart_client/jmap/core/id.dart';
+import 'package:jmap_dart_client/jmap/core/unsigned_int.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email_address.dart';
 import 'package:json_annotation/json_annotation.dart';
 
 part 'identity.g.dart';
 
+@UnsignedIntNullableConverter()
 @IdentityIdNullableConverter()
 @SignatureNullableConverter()
 @JsonSerializable()
@@ -39,6 +42,9 @@ class Identity with EquatableMixin {
   @JsonKey(includeIfNull: false)
   final bool? mayDelete;
 
+  @JsonKey(includeIfNull: false)
+  final UnsignedInt? sortOrder;
+
   Identity({
     this.id,
     this.description,
@@ -48,7 +54,8 @@ class Identity with EquatableMixin {
     this.replyTo,
     this.textSignature,
     this.htmlSignature,
-    this.mayDelete
+    this.mayDelete,
+    this.sortOrder
   });
 
   factory Identity.fromJson(Map<String, dynamic> json) => _$IdentityFromJson(json);

lib/jmap/identities/set/set_identity_method.dart

@@ -19,6 +19,12 @@ class SetIdentityMethod extends SetMethod<Identity> {
     CapabilityIdentifier.jmapSubmission
   };
 
+  Set<CapabilityIdentifier> get requiredCapabilitiesSupportSortOrder => {
+    CapabilityIdentifier.jmapCore,
+    CapabilityIdentifier.jmapSubmission,
+    CapabilityIdentifier.jamesSortOrder
+  };
+
   @override
   Map<String, dynamic> toJson() {
     final val = <String, dynamic>{

test/jmap/identities/create_identity_with_sort_order_test.dart

@@ -0,0 +1,211 @@
+import 'package:dio/dio.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:http_mock_adapter/http_mock_adapter.dart';
+import 'package:jmap_dart_client/http/http_client.dart';
+import 'package:jmap_dart_client/jmap/account_id.dart';
+import 'package:jmap_dart_client/jmap/core/id.dart';
+import 'package:jmap_dart_client/jmap/core/patch_object.dart';
+import 'package:jmap_dart_client/jmap/core/unsigned_int.dart';
+import 'package:jmap_dart_client/jmap/identities/identity.dart';
+import 'package:jmap_dart_client/jmap/identities/set/set_identity_method.dart';
+import 'package:jmap_dart_client/jmap/identities/set/set_identity_response.dart';
+import 'package:jmap_dart_client/jmap/jmap_request.dart';
+
+void main() {
+  group('test to json set identity method', () {
+    final expectedCreated = Identity(
+      id: IdentityId(Id('5ccf6d7b-77e8-467a-9064-9f7ccfb19e86')),
+      sortOrder: UnsignedInt(99999),
+    );
+
+    test('create new identity with sort order method and response parsing', () async {
+      final baseOption  = BaseOptions(method: 'POST');
+      final dio = Dio(baseOption)
+        ..options.baseUrl = 'http://domain.com/jmap';
+      final dioAdapter = DioAdapter(dio: dio);
+      dioAdapter.onPost(
+        '',
+        (server) => server.reply(200, {
+          "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+          "methodResponses": [
+            [
+              "Identity/set",
+              {
+                "accountId": "4603645929458bf671aca134b890cbb8ac4a0d297640fsdefe9230ea28daa0b1",
+                "newState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+                "created": {
+                    "dab246": {
+                        "id": "5ccf6d7b-77e8-467a-9064-9f7ccfb19e86",
+                        "mayDelete": true
+                    }
+                }
+              },
+              "c0"
+            ]
+          ]
+        }),
+        data: {
+          "using": [
+            "urn:ietf:params:jmap:core",
+            "urn:ietf:params:jmap:submission",
+            "urn:apache:james:params:jmap:mail:identity:sortorder"
+          ],
+          "methodCalls": [
+            [
+              "Identity/set",
+              {
+                "accountId": "4603645929458bf671aca134b890cbb8ac4a0d297640fsdefe9230ea28daa0b1",
+                "create": {
+                  "dab246": {
+                    "name": "User B23",
+                    "email": "[email protected]",
+                    "textSignature": "",
+                    "htmlSignature": "<body><div>Dat T. Vu <br>Mobile Engineer <br>LINAGORA VIETNAM <br>A: 8th Floor (Toong VPBank Tower, No. 5 Dien Bien Phu  Str., Ba Dinh Dist., Ha Noi <br>P: (+84) 366-769-439<br>E: [email protected]</div></body>",
+                    "sortOrder": 99999
+                  }
+                }
+              },
+              "c0"
+            ]
+          ]
+        },
+        headers: {
+          "accept": "application/json;jmapVersion=rfc-8621",
+          "content-type": "application/json; charset=utf-8",
+          "content-length": 577
+        }
+      );
+
+      final setIdentityMethod = SetIdentityMethod(AccountId(Id('4603645929458bf671aca134b890cbb8ac4a0d297640fsdefe9230ea28daa0b1')))
+        ..addCreate(Id('dab246'),
+          Identity(
+            name: 'User B23',
+            email: '[email protected]',
+            textSignature: Signature(''),
+            htmlSignature: Signature('<body><div>Dat T. Vu <br>Mobile Engineer <br>LINAGORA VIETNAM <br>A: 8th Floor (Toong VPBank Tower, No. 5 Dien Bien Phu  Str., Ba Dinh Dist., Ha Noi <br>P: (+84) 366-769-439<br>E: [email protected]</div></body>'),
+            sortOrder: UnsignedInt(99999),
+          )
+        );
+
+      final httpClient = HttpClient(dio);
+      final requestBuilder = JmapRequestBuilder(httpClient, ProcessingInvocation());
+      final setIdentityInvocation = requestBuilder.invocation(setIdentityMethod);
+      final response = await (requestBuilder
+          ..usings(setIdentityMethod.requiredCapabilitiesSupportSortOrder))
+        .build()
+        .execute();
+
+      final setIdentityResponse = response.parse<SetIdentityResponse>(
+        setIdentityInvocation.methodCallId,
+        SetIdentityResponse.deserialize);
+
+      expect(setIdentityResponse!.created![Id('dab246')]!.id, equals(expectedCreated.id));
+    });
+  });
+
+  group('test increase of old default identity request and create new identity request', () {
+    final expectedCreated = Identity(
+      id: IdentityId(Id('5ccf6d7b-77e8-467a-9064-9f7ccfb19e12')),
+      sortOrder: UnsignedInt(1),
+    );
+
+    final updatedIdentity = Identity(
+      id: IdentityId(Id('5ccf6d7b-77e8-467a-9064-9f7cc1234512')),
+      sortOrder: UnsignedInt(99),
+    );
+
+    test('test increase of old default identity request and create new identity request', () async {
+      final baseOption  = BaseOptions(method: 'POST');
+      final dio = Dio(baseOption)
+        ..options.baseUrl = 'http://domain.com/jmap';
+      final dioAdapter = DioAdapter(dio: dio);
+      dioAdapter.onPost(
+        '',
+        (server) => server.reply(200, {
+          "sessionState": "2c9f1b12-b35a-43e6-9af2-0106f123a943",
+          "methodResponses": [
+            [
+              "Identity/set",
+              {
+                "accountId": "4603645929458bf671aca134b890cbb8ac4a0d297640fsdefe9230ea28daa0b1",
+                "newState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+                "created": {
+                  "xyz123": {
+                      "id": "5ccf6d7b-77e8-467a-9064-9f7ccfb19e12",
+                      "mayDelete": true,
+                  }
+                },
+                "updated": {
+                  "5ccf6d7b-77e8-467a-9064-9f7cc1234512": {}
+                }
+              },
+              "c0"
+            ]
+          ]
+        }),
+        data: {
+          "using": [
+            "urn:ietf:params:jmap:core",
+            "urn:ietf:params:jmap:submission",
+            "urn:apache:james:params:jmap:mail:identity:sortorder"
+          ],
+          "methodCalls": [
+            [
+              "Identity/set",
+              {
+                "accountId": "4603645929458bf671aca134b890cbb8ac4a0d297640fsdefe9230ea28daa0b1",
+                "create": {
+                  "xyz123": {
+                    "id": "5ccf6d7b-77e8-467a-9064-9f7ccfb19e12",
+                    "name": "User B23",
+                    "email": "[email protected]",
+                    "sortOrder": 1
+                  }
+                },
+                "update": {
+                    "c6ba359f-94a8-4ee9-b515-6bd2d9698618": {
+                        "sortOrder": 8888
+                    }
+                }
+              },
+              "c0"
+            ]
+          ]
+        },
+        headers: {
+          "accept": "application/json;jmapVersion=rfc-8621",
+          "content-type": "application/json; charset=utf-8",
+          "content-length": 438
+        }
+      );
+
+      final setIdentityMethod = SetIdentityMethod(AccountId(Id('4603645929458bf671aca134b890cbb8ac4a0d297640fsdefe9230ea28daa0b1')))
+        ..addCreate(Id('xyz123'),
+          Identity(
+            id: IdentityId(Id("5ccf6d7b-77e8-467a-9064-9f7ccfb19e12")),
+            name: 'User B23',
+            email: '[email protected]',
+            sortOrder: UnsignedInt(1)
+          )
+        )
+        ..addUpdates({
+          Id("c6ba359f-94a8-4ee9-b515-6bd2d9698618"): PatchObject({"sortOrder": 8888})
+        });
+
+      final httpClient = HttpClient(dio);
+      final requestBuilder = JmapRequestBuilder(httpClient, ProcessingInvocation());
+      final setIdentityInvocation = requestBuilder.invocation(setIdentityMethod);
+      final response = await (requestBuilder
+          ..usings(setIdentityMethod.requiredCapabilitiesSupportSortOrder))
+        .build()
+        .execute();
+
+      final setIdentityResponse = response.parse<SetIdentityResponse>(
+        setIdentityInvocation.methodCallId,
+        SetIdentityResponse.deserialize);
+
+      expect(setIdentityResponse!.created![Id('xyz123')]!.id, equals(expectedCreated.id));
+      expect(setIdentityResponse.updated![Id('5ccf6d7b-77e8-467a-9064-9f7cc1234512')], equals(Identity()));
+    });
+  });
+}