refactor(cat-voices): Centralize signed document metadata creation (#3609)

* feat: add content type

* refactor: remove signed document metadata in favor of document data metadata

* refactor: centralize parameters

* refactor: cleanup

* chore: add more test assertions

* chore: cleanup

* fix: migration test

Author: dt-iohk

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/proposal/proposal_cubit.dart

@@ -170,10 +170,10 @@ final class ProposalCubit extends Cubit<ProposalState>
     final comment = CommentDocument(
       metadata: CommentMetadata(
         selfRef: commentRef,
-        ref: proposalRef! as SignedDocumentRef,
-        template: commentTemplate!.metadata.selfRef as SignedDocumentRef,
+        proposalRef: proposalRef! as SignedDocumentRef,
+        commentTemplate: commentTemplate!.metadata.selfRef as SignedDocumentRef,
         reply: reply,
-        parameters: proposalParameters ?? const DocumentParameters(),
+        parameters: proposalParameters!,
         authorId: activeAccountId!,
       ),
       document: document,

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/proposal_builder/new_proposal/new_proposal_cubit.dart

@@ -40,9 +40,8 @@ class NewProposalCubit extends Cubit<NewProposalState>
 
       final category = await _campaignService.getCategory(DocumentParameters({categoryRef}));
       final templateRef = category.proposalTemplateRef;
-      final template = await _proposalService.getProposalTemplate(
-        ref: templateRef,
-      );
+      final template = await _proposalService.getProposalTemplate(ref: templateRef);
+      final parameters = template.metadata.parameters;
 
       final documentBuilder = DocumentBuilder.fromSchema(schema: template.schema)
         ..addChange(
@@ -57,8 +56,8 @@ class NewProposalCubit extends Cubit<NewProposalState>
 
       return await _proposalService.createDraftProposal(
         content: documentContent,
-        template: templateRef,
-        categoryRef: categoryRef,
+        templateRef: templateRef,
+        parameters: parameters,
       );
     } catch (error, stackTrace) {
       _logger.severe('Create draft', error, stackTrace);

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/proposal_builder/proposal_builder_bloc.dart

@@ -140,13 +140,11 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
   }
 
   DocumentDataMetadata _buildDocumentMetadata([DocumentRef? selfRef]) {
-    final categoryRef = state.metadata.categoryRef;
-
-    return DocumentDataMetadata(
-      type: DocumentType.proposalDocument,
+    return DocumentDataMetadata.proposal(
       selfRef: selfRef ?? state.metadata.documentRef!,
-      template: state.metadata.templateRef,
-      parameters: DocumentParameters({?categoryRef}),
+      template: state.metadata.templateRef!,
+      parameters: state.metadata.parameters!,
+      authors: [_userService.activeAccountId],
     );
   }
 
@@ -351,14 +349,11 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
     Emitter<ProposalBuilderState> emit,
   ) async {
     try {
-      final proposalRef = state.metadata.documentRef;
-      final categoryRef = state.metadata.categoryRef!;
-
       emit(state.copyWith(isChanging: true));
 
       await _proposalService.forgetProposal(
-        proposalRef: proposalRef! as SignedDocumentRef,
-        parameters: DocumentParameters({categoryRef}),
+        proposalRef: state.metadata.documentRef! as SignedDocumentRef,
+        proposalParameters: state.metadata.parameters!,
       );
       unawaited(_clearCache());
       emitSignal(const ForgotProposalSuccessBuilderSignal());
@@ -473,18 +468,16 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
       final category = campaign.categories.first;
       final templateRef = category.proposalTemplateRef;
 
-      final proposalTemplate = await _proposalService.getProposalTemplate(
-        ref: templateRef,
-      );
-
+      final proposalTemplate = await _proposalService.getProposalTemplate(ref: templateRef);
+      final templateParameters = proposalTemplate.metadata.parameters;
       final documentBuilder = DocumentBuilder.fromSchema(schema: proposalTemplate.schema);
 
       return _cacheAndCreateState(
         proposalDocument: documentBuilder.build(),
         proposalBuilder: documentBuilder,
         proposalMetadata: ProposalBuilderMetadata.newDraft(
           templateRef: templateRef,
-          categoryRef: category.selfRef,
+          parameters: templateParameters,
         ),
         category: category,
       );
@@ -552,7 +545,7 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
           documentRef: proposal.selfRef,
           originalDocumentRef: proposal.selfRef,
           templateRef: proposalData.document.metadata.templateRef,
-          categoryRef: category.selfRef,
+          parameters: proposalData.document.metadata.parameters,
           versions: versions,
           fromActiveCampaign: fromActiveCampaign,
         ),
@@ -571,18 +564,16 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
     await _loadState(emit, () async {
       final category = await _campaignService.getCategory(DocumentParameters({categoryRef}));
       final templateRef = category.proposalTemplateRef;
-      final proposalTemplate = await _proposalService.getProposalTemplate(
-        ref: templateRef,
-      );
-
+      final proposalTemplate = await _proposalService.getProposalTemplate(ref: templateRef);
+      final templateParameters = proposalTemplate.metadata.parameters;
       final documentBuilder = DocumentBuilder.fromSchema(schema: proposalTemplate.schema);
 
       return _cacheAndCreateState(
         proposalDocument: documentBuilder.build(),
         proposalBuilder: documentBuilder,
         proposalMetadata: ProposalBuilderMetadata.newDraft(
           templateRef: templateRef,
-          categoryRef: categoryRef,
+          parameters: templateParameters,
         ),
         category: category,
       );
@@ -747,7 +738,7 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
 
     await _proposalService.submitProposalForReview(
       proposalRef: updatedRef,
-      proposalParameters: DocumentParameters({state.metadata.categoryRef!}),
+      proposalParameters: state.metadata.parameters!,
     );
 
     _updateMetadata(
@@ -1018,7 +1009,6 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
     Emitter<ProposalBuilderState> emit,
   ) async {
     final originalProposalRef = state.metadata.originalDocumentRef;
-    final originalProposalCategoryRef = state.metadata.categoryRef;
     assert(
       originalProposalRef != null,
       'Proposal ref not found. Load document first!',
@@ -1038,10 +1028,10 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
     final comment = CommentDocument(
       metadata: CommentMetadata(
         selfRef: commentRef,
-        ref: originalProposalRef! as SignedDocumentRef,
-        template: commentTemplate!.metadata.selfRef as SignedDocumentRef,
+        proposalRef: originalProposalRef! as SignedDocumentRef,
+        commentTemplate: commentTemplate!.metadata.selfRef as SignedDocumentRef,
         reply: event.reply,
-        parameters: DocumentParameters({?originalProposalCategoryRef}),
+        parameters: state.metadata.parameters!,
         authorId: activeAccountId!,
       ),
       document: event.document,
@@ -1110,7 +1100,7 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
   ) async {
     await _proposalService.submitProposalForReview(
       proposalRef: state.metadata.documentRef! as SignedDocumentRef,
-      proposalParameters: DocumentParameters({state.metadata.categoryRef!}),
+      proposalParameters: state.metadata.parameters!,
     );
 
     _updateMetadata(emit, publish: ProposalPublish.submittedProposal);
@@ -1123,16 +1113,16 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
   ) async {
     try {
       final proposalRef = state.metadata.documentRef! as SignedDocumentRef;
-      final categoryRef = state.metadata.categoryRef!;
+      final parameters = state.metadata.parameters!;
       emit(state.copyWith(isChanging: true));
 
       await _proposalService.unlockProposal(
         proposalRef: proposalRef,
-        proposalParameters: DocumentParameters({categoryRef}),
+        proposalParameters: parameters,
       );
-      final stateMetadata = state.metadata.copyWith(publish: ProposalPublish.publishedDraft);
-      _cache = _cache.copyWith(proposalMetadata: Optional(stateMetadata));
-      emit(state.copyWith(metadata: stateMetadata, isChanging: false));
+      final updatedMetadata = state.metadata.copyWith(publish: ProposalPublish.publishedDraft);
+      _cache = _cache.copyWith(proposalMetadata: Optional(updatedMetadata));
+      emit(state.copyWith(metadata: updatedMetadata, isChanging: false));
     } catch (e, stackTrace) {
       _logger.severe('Unlock proposal failed', e, stackTrace);
       emitError(LocalizedException.create(e));
@@ -1219,23 +1209,23 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
   Future<DraftRef> _upsertDraftProposal(DocumentDataContent document) async {
     final currentRef = state.metadata.documentRef!;
     final originalRef = state.metadata.originalDocumentRef;
-    final template = state.metadata.templateRef!;
-    final categoryRef = state.metadata.categoryRef!;
+    final templateRef = state.metadata.templateRef!;
+    final parameters = state.metadata.parameters!;
 
     DraftRef nextRef;
     if (originalRef == null) {
       nextRef = await _proposalService.createDraftProposal(
         content: document,
-        template: template,
-        categoryRef: categoryRef,
+        templateRef: templateRef,
+        parameters: parameters,
       );
     } else {
       nextRef = currentRef.nextVersion();
       await _proposalService.upsertDraftProposal(
         selfRef: nextRef,
         content: document,
-        template: template,
-        categoryRef: categoryRef,
+        templateRef: templateRef,
+        parameters: parameters,
       );
     }
 

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/proposal_builder/proposal_builder_state.dart

@@ -9,7 +9,7 @@ final class ProposalBuilderMetadata extends Equatable {
   final DocumentRef? documentRef;
   final DocumentRef? originalDocumentRef;
   final SignedDocumentRef? templateRef;
-  final SignedDocumentRef? categoryRef;
+  final DocumentParameters? parameters;
   final List<DocumentVersion> versions;
   final bool fromActiveCampaign;
 
@@ -18,20 +18,20 @@ final class ProposalBuilderMetadata extends Equatable {
     this.documentRef,
     this.originalDocumentRef,
     this.templateRef,
-    this.categoryRef,
+    this.parameters,
     this.versions = const [],
     this.fromActiveCampaign = true,
   });
 
   factory ProposalBuilderMetadata.newDraft({
     required SignedDocumentRef templateRef,
-    required SignedDocumentRef categoryRef,
+    required DocumentParameters parameters,
   }) {
     final firstRef = DraftRef.generateFirstRef();
     return ProposalBuilderMetadata(
       documentRef: firstRef,
       templateRef: templateRef,
-      categoryRef: categoryRef,
+      parameters: parameters,
     );
   }
 
@@ -43,7 +43,7 @@ final class ProposalBuilderMetadata extends Equatable {
     documentRef,
     originalDocumentRef,
     templateRef,
-    categoryRef,
+    parameters,
     versions,
     fromActiveCampaign,
   ];
@@ -53,7 +53,7 @@ final class ProposalBuilderMetadata extends Equatable {
     Optional<DocumentRef>? documentRef,
     Optional<DocumentRef>? originalDocumentRef,
     Optional<SignedDocumentRef>? templateRef,
-    Optional<SignedDocumentRef>? categoryRef,
+    Optional<DocumentParameters>? parameters,
     List<DocumentVersion>? versions,
     bool? fromActiveCampaign,
   }) {
@@ -62,7 +62,7 @@ final class ProposalBuilderMetadata extends Equatable {
       documentRef: documentRef.dataOr(this.documentRef),
       originalDocumentRef: originalDocumentRef.dataOr(this.originalDocumentRef),
       templateRef: templateRef.dataOr(this.templateRef),
-      categoryRef: categoryRef.dataOr(this.categoryRef),
+      parameters: parameters.dataOr(this.parameters),
       versions: versions ?? this.versions,
       fromActiveCampaign: fromActiveCampaign ?? this.fromActiveCampaign,
     );

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/workspace/workspace_bloc.dart

@@ -57,11 +57,11 @@ final class WorkspaceBloc extends Bloc<WorkspaceEvent, WorkspaceState>
   }
 
   DocumentDataMetadata _buildDocumentMetadata(ProposalDocument document) {
-    return DocumentDataMetadata(
-      type: DocumentType.proposalDocument,
+    return DocumentDataMetadata.proposal(
       selfRef: document.metadata.selfRef,
       template: document.metadata.templateRef,
       parameters: document.metadata.parameters,
+      authors: document.metadata.authors,
     );
   }
 
@@ -102,7 +102,10 @@ final class WorkspaceBloc extends Bloc<WorkspaceEvent, WorkspaceState>
       final documentContent = _buildDocumentContent(docData.document.document);
 
       final encodedProposal = await _proposalService.encodeProposalForExport(
-        document: DocumentData(metadata: docMetadata, content: documentContent),
+        document: DocumentData(
+          metadata: docMetadata,
+          content: documentContent,
+        ),
       );
 
       final filename = '${event.prefix}_${event.ref.id}';
@@ -124,7 +127,7 @@ final class WorkspaceBloc extends Bloc<WorkspaceEvent, WorkspaceState>
       emit(state.copyWith(isLoading: true));
       await _proposalService.forgetProposal(
         proposalRef: proposal.selfRef as SignedDocumentRef,
-        parameters: proposal.parameters,
+        proposalParameters: proposal.parameters,
       );
       emit(state.copyWith(userProposals: _removeProposal(event.ref)));
       emitSignal(const ForgetProposalSuccessWorkspaceSignal());

catalyst_voices/packages/internal/catalyst_voices_blocs/test/workspace/workspace_bloc_test.dart

@@ -19,13 +19,14 @@ void main() {
 
     final proposalRef = SignedDocumentRef.generateFirstRef();
     final categoryRef = SignedDocumentRef.generateFirstRef();
+    final authorId = CatalystId(host: 'test', role0Key: Uint8List(32));
 
     final documentData = DocumentData(
-      metadata: DocumentDataMetadata(
-        type: DocumentType.proposalDocument,
+      metadata: DocumentDataMetadata.proposal(
         selfRef: proposalRef,
         template: SignedDocumentRef.generateFirstRef(),
         parameters: DocumentParameters({categoryRef}),
+        authors: [authorId],
       ),
       content: const DocumentDataContent({}),
     );

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

@@ -38,6 +38,7 @@ export 'document/constant/all_const_documents_refs.dart';
 export 'document/constant/constant_documents_refs.dart';
 export 'document/constant/f14_const_documents_refs.dart';
 export 'document/constant/f15_const_documents_refs.dart';
+export 'document/data/document_content_type.dart';
 export 'document/data/document_data.dart';
 export 'document/data/document_data_content.dart';
 export 'document/data/document_data_metadata.dart';

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/document/data/document_content_type.dart

@@ -0,0 +1,23 @@
+import 'package:catalyst_voices_models/src/document/data/document_data_content.dart';
+
+/// Defines the content type of the [DocumentDataContent].
+enum DocumentContentType {
+  /// The document's content type is JSON.
+  json('application/json'),
+
+  /// Unrecognized content type.
+  unknown('unknown');
+
+  final String value;
+
+  const DocumentContentType(this.value);
+
+  static DocumentContentType fromJson(String data) {
+    return DocumentContentType.values.firstWhere(
+      (element) => element.value == data,
+      orElse: () => DocumentContentType.unknown,
+    );
+  }
+
+  static String toJson(DocumentContentType type) => type.value;
+}