feat(cat-voices): Migrate rbac endpoints to v2 (#3596)

* feat: Migrate RBAC endpoint to v2

* feat: enhance RBAC DTOs and add PEM handling for X509 certificates

* chore: disable cspell in x509 certificate test

* refactor: Remove Json typedef and move CertificateType

Author: bstolinski

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/registration/registration_certificate.dart

@@ -1,7 +1,20 @@
+import 'package:json_annotation/json_annotation.dart';
+
+@JsonEnum(valueField: 'value')
+enum CertificateType {
+  pubkey('pubkey'),
+  x509('x509'),
+  c509('c509');
+
+  final String value;
+
+  const CertificateType(this.value);
+}
+
 /// Holds common constants about the certificates used in user registration.
 final class RegistrationCertificate {
   /// The type of the certificate used in the registration.
-  static const certificateType = 'x509';
+  static const certificateType = CertificateType.x509;
 
   const RegistrationCertificate._();
 }

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/user/account_role.dart

@@ -54,7 +54,7 @@ enum AccountRole {
     return values.firstWhereOrNull((e) => e.registrationOffset == registrationOffset);
   }
 
-  static AccountRole? maybeFromNumber(int? number) {
+  static AccountRole? maybeFromNumber(int number) {
     for (final value in values) {
       if (value.number == number) {
         return value;

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/api/dio_cat_gateway_service.dart

@@ -11,7 +11,6 @@ import 'package:catalyst_voices_repositories/src/api/models/network.dart';
 import 'package:catalyst_voices_repositories/src/api/models/rbac_registration_chain.dart';
 import 'package:catalyst_voices_repositories/src/common/content_types.dart';
 import 'package:catalyst_voices_repositories/src/common/http_headers.dart';
-import 'package:catalyst_voices_repositories/src/common/json.dart';
 import 'package:catalyst_voices_repositories/src/dto/config/remote_config.dart';
 import 'package:dio/dio.dart';
 
@@ -86,12 +85,18 @@ abstract interface class CatGatewayService {
     String? version,
   });
 
-  /// Get RBAC registrations
+  /// Get RBAC registrations V2.
   /// This endpoint returns RBAC registrations by provided auth Catalyst Id credentials
   /// or by the [lookup] argument if provided.
   ///
   /// [lookup] Stake address or Catalyst ID to get the RBAC registration for.
-  Future<RbacRegistrationChain> rbacRegistration({String? lookup});
+  /// [showAllInvalid] If this parameter is set to `true`, then all the invalid registrations are
+  /// returned. Otherwise, only the invalid registrations after the last valid one
+  /// are shown. Defaults to `false` if not present.
+  Future<RbacRegistrationChain> rbacRegistration({
+    String? lookup,
+    bool? showAllInvalid,
+  });
 
   /// Get staked assets.
   /// This endpoint returns the total Cardano's staked assets to the corresponded
@@ -144,7 +149,7 @@ final class DioCatGatewayService implements CatGatewayService {
       },
       body: filter.toJson(),
       mapper: (response) {
-        if (response is Json) {
+        if (response is Map<String, dynamic>) {
           return DocumentIndexList.fromJson(response);
         }
 
@@ -161,12 +166,12 @@ final class DioCatGatewayService implements CatGatewayService {
     return _dio.get<dynamic, RemoteConfig>(
       '/v1/config/frontend',
       mapper: (response) {
-        if (response is Json) {
+        if (response is Map<String, dynamic>) {
           return RemoteConfig.fromJson(response);
         }
 
         if (response is String) {
-          return RemoteConfig.fromJson(jsonDecode(response) as Json);
+          return RemoteConfig.fromJson(jsonDecode(response) as Map<String, dynamic>);
         }
 
         return const RemoteConfig();
@@ -188,10 +193,16 @@ final class DioCatGatewayService implements CatGatewayService {
   }
 
   @override
-  Future<RbacRegistrationChain> rbacRegistration({String? lookup}) {
-    return _dio.get<Json, RbacRegistrationChain>(
-      '/v1/rbac/registration',
-      queryParameters: {'lookup': ?lookup},
+  Future<RbacRegistrationChain> rbacRegistration({
+    String? lookup,
+    bool? showAllInvalid = false,
+  }) {
+    return _dio.get<Map<String, dynamic>, RbacRegistrationChain>(
+      '/v2/rbac/registration',
+      queryParameters: {
+        'lookup': ?lookup,
+        'show_all_invalid': ?showAllInvalid,
+      },
       mapper: RbacRegistrationChain.fromJson,
     );
   }
@@ -203,7 +214,7 @@ final class DioCatGatewayService implements CatGatewayService {
     String? asat,
     String? authorization,
   }) {
-    return _dio.get<Json, FullStakeInfo>(
+    return _dio.get<Map<String, dynamic>, FullStakeInfo>(
       '/v1/cardano/assets/$stakeAddress',
       queryParameters: {
         'network': ?network?.value,

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/api/dio_cat_reviews_service.dart

@@ -3,7 +3,6 @@ import 'package:catalyst_voices_repositories/src/api/dio_client.dart';
 import 'package:catalyst_voices_repositories/src/api/models/catalyst_id_create.dart';
 import 'package:catalyst_voices_repositories/src/api/models/catalyst_id_public.dart';
 import 'package:catalyst_voices_repositories/src/common/http_headers.dart';
-import 'package:catalyst_voices_repositories/src/common/json.dart';
 import 'package:dio/dio.dart';
 
 /// # Catalyst Reviews API.
@@ -47,7 +46,7 @@ final class DioCatReviewsService implements CatReviewsService {
 
   @override
   Future<CatalystIdPublic> getPublicProfile({String? authorization}) {
-    return _dio.get<Json, CatalystIdPublic>(
+    return _dio.get<Map<String, dynamic>, CatalystIdPublic>(
       '/catalyst-ids/me',
       options: Options(
         headers: {
@@ -63,7 +62,7 @@ final class DioCatReviewsService implements CatReviewsService {
     required CatalystIdCreate body,
     String? authorization,
   }) {
-    return _dio.post<Json, CatalystIdPublic>(
+    return _dio.post<Map<String, dynamic>, CatalystIdPublic>(
       '/catalyst-ids/me',
       body: body.toJson(),
       options: Options(

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/api/dio_cat_status_service.dart

@@ -1,7 +1,6 @@
 import 'package:catalyst_voices_repositories/src/api/api_services.dart';
 import 'package:catalyst_voices_repositories/src/api/dio_client.dart';
 import 'package:catalyst_voices_repositories/src/api/models/components.dart';
-import 'package:catalyst_voices_repositories/src/common/json.dart';
 import 'package:dio/dio.dart';
 
 abstract interface class CatStatusService {
@@ -34,7 +33,7 @@ final class DioCatStatusService implements CatStatusService {
 
   @override
   Future<Components> componentStatuses({String? authorization}) {
-    return _dio.get<Json, Components>(
+    return _dio.get<Map<String, dynamic>, Components>(
       '/v2/components.json',
       mapper: Components.fromJson,
     );

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/api/models/catalyst_id_create.dart

@@ -1,4 +1,3 @@
-import 'package:catalyst_voices_repositories/src/common/json.dart';
 import 'package:json_annotation/json_annotation.dart';
 
 part 'catalyst_id_create.g.dart';
@@ -20,7 +19,7 @@ final class CatalystIdCreate {
     required this.catalystIdUri,
   });
 
-  factory CatalystIdCreate.fromJson(Json json) => _$CatalystIdCreateFromJson(json);
+  factory CatalystIdCreate.fromJson(Map<String, dynamic> json) => _$CatalystIdCreateFromJson(json);
 
-  Json toJson() => _$CatalystIdCreateToJson(this);
+  Map<String, dynamic> toJson() => _$CatalystIdCreateToJson(this);
 }

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/api/models/catalyst_id_public.dart

@@ -1,6 +1,5 @@
 import 'package:catalyst_voices_repositories/src/api/models/catalyst_id_status.dart';
 import 'package:catalyst_voices_repositories/src/api/models/catalyst_rbac_registration_status.dart';
-import 'package:catalyst_voices_repositories/src/common/json.dart';
 import 'package:json_annotation/json_annotation.dart';
 
 part 'catalyst_id_public.g.dart';
@@ -37,7 +36,7 @@ final class CatalystIdPublic {
     this.rbacRegStatus = CatalystRbacRegistrationStatus.initialized,
   });
 
-  factory CatalystIdPublic.fromJson(Json json) => _$CatalystIdPublicFromJson(json);
+  factory CatalystIdPublic.fromJson(Map<String, dynamic> json) => _$CatalystIdPublicFromJson(json);
 
-  Json toJson() => _$CatalystIdPublicToJson(this);
+  Map<String, dynamic> toJson() => _$CatalystIdPublicToJson(this);
 }

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/api/models/component.dart

@@ -1,5 +1,4 @@
 import 'package:catalyst_voices_repositories/src/api/models/component_status.dart';
-import 'package:catalyst_voices_repositories/src/common/json.dart';
 import 'package:json_annotation/json_annotation.dart';
 
 part 'component.g.dart';
@@ -22,5 +21,5 @@ final class Component {
     this.isParent,
   });
 
-  factory Component.fromJson(Json json) => _$ComponentFromJson(json);
+  factory Component.fromJson(Map<String, dynamic> json) => _$ComponentFromJson(json);
 }

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/api/models/components.dart

@@ -1,5 +1,4 @@
 import 'package:catalyst_voices_repositories/src/api/models/component.dart';
-import 'package:catalyst_voices_repositories/src/common/json.dart';
 import 'package:json_annotation/json_annotation.dart';
 
 part 'components.g.dart';
@@ -10,5 +9,5 @@ final class Components {
 
   const Components(this.components);
 
-  factory Components.fromJson(Json json) => _$ComponentsFromJson(json);
+  factory Components.fromJson(Map<String, dynamic> json) => _$ComponentsFromJson(json);
 }

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/api/models/current_page.dart

@@ -1,4 +1,3 @@
-import 'package:catalyst_voices_repositories/src/common/json.dart';
 import 'package:json_annotation/json_annotation.dart';
 
 part 'current_page.g.dart';
@@ -30,7 +29,7 @@ final class CurrentPage {
     required this.remaining,
   });
 
-  factory CurrentPage.fromJson(Json json) => _$CurrentPageFromJson(json);
+  factory CurrentPage.fromJson(Map<String, dynamic> json) => _$CurrentPageFromJson(json);
 
-  Json toJson() => _$CurrentPageToJson(this);
+  Map<String, dynamic> toJson() => _$CurrentPageToJson(this);
 }