Bal 4297 documents tracker mapping (#3402)

chesterkmr · web-flow · commit ca75c26d71d6 · 2025-06-13T17:38:33.000+03:00
* feat: added variant to end user &amp; updated entity creation &amp; updated endpoints

* feat: reworked documents mapping &amp; fixed state computation

* fix: post merge fix

* fix: added assert valid project ids
diff --git a/apps/backoffice-v2/src/common/components/molecules/DocumentTracker/hooks/useDocumentTracker.tsx b/apps/backoffice-v2/src/common/components/molecules/DocumentTracker/hooks/useDocumentTracker.tsx
@@ -46,7 +46,7 @@ export const useDocumentTracker = ({ workflowId }: { workflowId: string }) => {
           templateId: identifier.document.type,
           entity: {
             id: identifier.entity.id,
-            type: identifier.entity.entityType,
+            type: identifier.entity.variant,
           },
         })),
       }),
diff --git a/apps/backoffice-v2/src/domains/documents/schemas.ts b/apps/backoffice-v2/src/domains/documents/schemas.ts
@@ -25,16 +25,16 @@ export const DocumentTrackerItemSchema = z.object({
       issuingVersion: z.string(),
       version: z.string(),
     }),
-    entity: z.discriminatedUnion('entityType', [
+    entity: z.discriminatedUnion('variant', [
       ObjectWithIdSchema.extend({
-        entityType: z.literal(EntityType.BUSINESS),
+        variant: z.literal(EntityType.BUSINESS),
         companyName: z.string(),
       }),
       EndUserSchema.extend({
-        entityType: z.literal(EntityType.UBO),
+        variant: z.literal(EntityType.UBO),
       }),
       EndUserSchema.extend({
-        entityType: z.literal(EntityType.DIRECTOR),
+        variant: z.literal(EntityType.DIRECTOR),
       }),
     ]),
   }),
diff --git a/apps/backoffice-v2/src/domains/individuals/fetchers.ts b/apps/backoffice-v2/src/domains/individuals/fetchers.ts
@@ -38,6 +38,7 @@ export const EndUserSchema = z.object({
       }),
     })
     .optional(),
+  variant: z.enum(['director', 'ubo']).optional(),
   createdFrom: z.enum(['user', 'analyst', 'registry']).nullable().optional(),
 });
 
diff --git a/apps/backoffice-v2/src/lib/blocks/hooks/useDirectorsDocuments/helpers/get-directors-ids-from-workflow.ts b/apps/backoffice-v2/src/lib/blocks/hooks/useDirectorsDocuments/helpers/get-directors-ids-from-workflow.ts
@@ -1,7 +1,5 @@
 import { TWorkflowById } from '@/domains/workflows/fetchers';
-import { selectDirectors } from '@/pages/Entity/selectors/selectDirectors';
 
 export const getDirectorsIdsFromWorkflow = (workflow: TWorkflowById) =>
-  selectDirectors(workflow)
-    .map(director => director.ballerineEntityId)
-    .filter(Boolean);
+  workflow.endUsers?.filter(endUser => endUser.variant === 'director').map(endUser => endUser.id) ||
+  [];
diff --git a/apps/backoffice-v2/src/lib/blocks/hooks/useDirectorsDocuments/useDirectorsDocuments.ts b/apps/backoffice-v2/src/lib/blocks/hooks/useDirectorsDocuments/useDirectorsDocuments.ts
@@ -9,6 +9,7 @@ export const useDirectorsDocuments = (workflow: TWorkflowById) => {
 
   const { documents, documentsSchemas, isLoading } = useWorkflowDocumentsAdapter({
     entityIds,
+    // TODO: Remove once documents v1 are deprecated
     documents: (workflow?.context?.entity?.data?.additionalInfo?.directors?.flatMap(
       director => director.documents ?? [],
     ) ?? []) as TDocument[],
diff --git a/apps/backoffice-v2/src/lib/blocks/hooks/useDocumentBlocks/hooks/useDocuments/useDocuments.ts b/apps/backoffice-v2/src/lib/blocks/hooks/useDocumentBlocks/hooks/useDocuments/useDocuments.ts
@@ -36,6 +36,8 @@ export const useDocuments = (workflow: TWorkflowById) => {
     useUbosDocuments(workflow as TWorkflowById),
   ];
 
+  console.log('ubo documents', ubosDocuments);
+
   const businessDocumentsWithEntity = useMemo(
     () =>
       businessDocuments.map(document => ({
diff --git a/apps/backoffice-v2/src/lib/blocks/hooks/useUbosDocuments/helpers/get-ubos-entity-ids-from-workflow.ts b/apps/backoffice-v2/src/lib/blocks/hooks/useUbosDocuments/helpers/get-ubos-entity-ids-from-workflow.ts
@@ -1,19 +1,7 @@
 import { TWorkflowById } from '@/domains/workflows/fetchers';
 
 export const getUbosEntityIdsFromWorkflow = (workflow: TWorkflowById) => {
-  const directorsIds =
-    workflow?.context?.entity?.data?.additionalInfo?.directors
-      ?.map(director => director.ballerineEntityId)
-      .filter(Boolean) ?? [];
-
   return (
-    workflow?.childWorkflows
-      ?.filter(
-        childWorkflow =>
-          childWorkflow.context?.entity?.variant === 'ubo' &&
-          !directorsIds.includes(childWorkflow.context?.entity?.ballerineEntityId),
-      )
-      ?.map(childWorkflow => childWorkflow.context?.entity?.ballerineEntityId)
-      .filter(Boolean) ?? []
+    workflow.endUsers?.filter(endUser => endUser.variant === 'ubo').map(endUser => endUser.id) || []
   );
 };
diff --git a/apps/backoffice-v2/src/lib/blocks/hooks/useUbosDocuments/useUbosDocuments.ts b/apps/backoffice-v2/src/lib/blocks/hooks/useUbosDocuments/useUbosDocuments.ts
@@ -9,6 +9,7 @@ export const useUbosDocuments = (workflow: TWorkflowById) => {
 
   const { documents, documentsSchemas, isLoading } = useWorkflowDocumentsAdapter({
     entityIds,
+    // TODO: Remove once documents v1 are deprecated
     documents: (workflow.childWorkflows
       ?.filter(childWorkflow => childWorkflow.context?.entity?.variant === 'ubo')
       ?.flatMap(childWorkflow => childWorkflow.context?.documents ?? []) ?? []) as TDocument[],
diff --git a/apps/kyb-app/src/pages/CollectionFlow/versions/v2/components/organisms/CollectionFlowUI/hooks/useRevisionFields/utils/generate-fields-for-revision/generate-fields-for-revision.ts b/apps/kyb-app/src/pages/CollectionFlow/versions/v2/components/organisms/CollectionFlowUI/hooks/useRevisionFields/utils/generate-fields-for-revision/generate-fields-for-revision.ts
@@ -27,7 +27,6 @@ export const generateFieldsForRevision = (
     const fieldDefinitions = getFieldDefinitionsFromSchema(page.elements) as Array<
       IFormElement<TBaseFields, any>
     >;
-
     if (isPageInRevision || isPageInEdit) {
       const granularRevisionFields = generateGranularRevisionFields({
         context,
diff --git a/services/workflows-service/package.json b/services/workflows-service/package.json
@@ -16,7 +16,7 @@
     "prod": "npm run db:migrate-up && npm run start:prod",
     "prod:next": "npm run db:migrate-up && npm run db:data-sync && npm run start:prod",
     "start:watch": "nest start --watch",
-    "start:debug": "nest start --debug --watch",
+    "start:debug": "nest start --debug",
     "build": "nest build --path=tsconfig.build.json",
     "test": "jest --runInBand",
     "test:unit": "cross-env SKIP_DB_SETUP_TEARDOWN=true jest --testRegex '.*\\.unit\\.test\\.ts$'",
diff --git a/services/workflows-service/prisma/data-migrations b/services/workflows-service/prisma/data-migrations
@@ -1 +1 @@
-Subproject commit 89d7efbda574ca2c7f9807fd548fcf3e15009eb7
+Subproject commit 1d5a1b01b87cb8082f2dd7ba17f96129d8a2703e
diff --git a/services/workflows-service/src/case-management/controllers/case-management.controller.ts b/services/workflows-service/src/case-management/controllers/case-management.controller.ts
@@ -30,6 +30,7 @@ import { z } from 'zod';
 import type { Business, EndUsersOnBusinesses, UiDefinition } from '@prisma/client';
 import { TranslationService } from '@/providers/translation/translation.service';
 import { UiDefinitionService } from '@/ui-definition/ui-definition.service';
+import { assertIsValidProjectIds } from '@/project/project-scope.service';
 
 @Controller('case-management')
 @ApiExcludeController()
@@ -63,7 +64,9 @@ export class CaseManagementController {
     @ProjectIds() projectIds: TProjectIds,
     @CurrentProject() currentProjectId: TProjectId,
   ) {
-    const result = await this.caseManagementService.create(body, projectIds!, currentProjectId);
+    assertIsValidProjectIds(projectIds);
+
+    const result = await this.caseManagementService.create(body, projectIds, currentProjectId);
 
     this.logger.log(
       `User ${authenticatedEntity?.user?.id} created workflow ${(await result).workflowRuntimeId}`,
diff --git a/services/workflows-service/src/collection-flow/controllers/collection-flow.controller.ts b/services/workflows-service/src/collection-flow/controllers/collection-flow.controller.ts
@@ -181,7 +181,7 @@ export class CollectionFlowController {
         tokenScope.projectId,
       );
 
-      return await this.workflowService.event(
+      return this.workflowService.event(
         {
           id: tokenScope.workflowRuntimeDataId,
           name: BUILT_IN_EVENT.DEEP_MERGE_CONTEXT,
diff --git a/services/workflows-service/src/collection-flow/dto/create-entity-input.dto.ts b/services/workflows-service/src/collection-flow/dto/create-entity-input.dto.ts
@@ -1,6 +1,7 @@
+import { oneOf } from '@/common/decorators/one-of.decorator';
 import { ApiProperty } from '@nestjs/swagger';
 import { EndUserVariant } from '@prisma/client';
-import { IsBoolean, IsEnum, IsObject, IsOptional, IsString } from 'class-validator';
+import { IsBoolean, IsObject, IsOptional, IsString } from 'class-validator';
 
 export class CreateEntityInputDto {
   @ApiProperty({
@@ -75,6 +76,6 @@ export class CreateEntityInputDto {
   @ApiProperty({
     type: String,
   })
-  @IsEnum(EndUserVariant)
+  @oneOf([EndUserVariant.director, EndUserVariant.ubo])
   variant?: EndUserVariant;
 }
diff --git a/services/workflows-service/src/collection-flow/services/collection-flow-state.service.ts b/services/workflows-service/src/collection-flow/services/collection-flow-state.service.ts
@@ -18,6 +18,7 @@ import {
   Document,
   DocumentDecision,
   DocumentStatus,
+  EndUserVariant,
   UiDefinition,
   WorkflowRuntimeData,
 } from '@prisma/client';
@@ -36,6 +37,7 @@ import {
   defaultPrismaTransactionOptions,
 } from '@/prisma/prisma.util';
 import { PrismaService } from '@/prisma/prisma.service';
+import { assertIsValidProjectIds } from '@/project/project-scope.service';
 
 @Injectable()
 export class CollectionFlowStateService {
@@ -49,51 +51,41 @@ export class CollectionFlowStateService {
     protected readonly prismaService: PrismaService,
   ) {}
 
-  async getCollectionFlowState(
-    workflowId: string,
-    projectIds: TProjectIds,
-    transaction?: PrismaTransactionClient,
-  ) {
-    const workflowRuntimeData = (await this.workflowService.getWorkflowRuntimeDataById(
+  async getCollectionFlowState(workflowId: string, projectIds: TProjectIds) {
+    assertIsValidProjectIds(projectIds);
+
+    const workflowWithRelations = await this.workflowService.getWorkflowByIdWithRelations(
       workflowId,
-      {
-        select: {
-          workflowDefinitionId: true,
-          context: true,
-          childWorkflowsRuntimeData: true,
-        },
-      },
       projectIds,
-      transaction,
-    )) as WorkflowRuntimeData & {
-      childWorkflowsRuntimeData: WorkflowRuntimeData[];
-    };
+    );
+
+    const collectionFlowState = getCollectionFlowState(workflowWithRelations.context);
+
+    if (!collectionFlowState) {
+      throw new CollectionFlowMissingException();
+    }
 
     const uiDefinition = await this.uiDefinitionService.getByWorkflowDefinitionId(
-      workflowRuntimeData.workflowDefinitionId,
+      workflowWithRelations.workflowDefinitionId,
       'collection_flow',
       projectIds,
     );
 
-    const entities = this.getEntityIdsFromWorkflow(workflowRuntimeData);
+    const entities = workflowWithRelations.endUsers || [];
 
-    const documents = (await this.documentService.getByEntityIdsAndWorkflowId(
-      entities.map(entity => entity.entityId),
+    const documents = await this.documentService.getLatestDocumentsWithFilesByWorkflowId(
       workflowId,
-      projectIds!,
-    )) as Document[];
-
-    const collectionFlowState = getCollectionFlowState(workflowRuntimeData.context);
-
-    if (!collectionFlowState) {
-      throw new CollectionFlowMissingException();
-    }
+      projectIds,
+    );
 
     const computedCollectionFlowState = await this.computeCollectionFlowState(
       uiDefinition,
-      workflowRuntimeData.context,
+      workflowWithRelations.context,
       documents,
-      entities,
+      entities.map(entity => ({
+        entityId: entity.id,
+        variant: entity.variant || 'business',
+      })),
     );
 
     const isCollectionFlowStateEqual = isEqual(collectionFlowState, computedCollectionFlowState);
@@ -104,14 +96,14 @@ export class CollectionFlowStateService {
         workflowId,
         {
           context: {
-            ...workflowRuntimeData.context,
+            ...workflowWithRelations.context,
             collectionFlow: {
-              ...workflowRuntimeData.context.collectionFlow,
+              ...workflowWithRelations.context.collectionFlow,
               state: computedCollectionFlowState,
             },
           },
         },
-        projectIds![0]!,
+        projectIds[0]!,
       );
     }
 
@@ -122,14 +114,14 @@ export class CollectionFlowStateService {
     uiDefinition: UiDefinition,
     _context: AnyRecord,
     documents: Document[],
-    entities: Array<{ entityId: string; entityType: TEntityType }>,
+    entities: Array<{ entityId: string; variant: EndUserVariant | 'business' }>,
   ) {
     const context = structuredClone(_context);
     let documentsWithEntityTypes = documents.map(document => ({
       ...document,
-      entityType:
-        entities.find(entity => entity.entityId === document.endUserId)?.entityType ||
-        entities.find(entity => entity.entityId === document.businessId)?.entityType,
+      entityType: document.businessId
+        ? EntityType.business
+        : entities.find(entity => entity.entityId === document.endUserId)?.variant,
     })) as Array<Document & { entityType: TEntityType }>;
 
     if (!getCollectionFlowState(context)) {
@@ -346,6 +338,7 @@ export class CollectionFlowStateService {
           },
         },
         projectIds,
+        transaction,
       );
 
       const uiDefinition = await this.uiDefinitionService.getByWorkflowDefinitionId(
@@ -385,7 +378,7 @@ export class CollectionFlowStateService {
         transaction,
       );
 
-      const resolvedState = await this.getCollectionFlowState(workflowId, projectIds, transaction);
+      const resolvedState = await this.getCollectionFlowState(workflowId, projectIds);
 
       return resolvedState;
     });
diff --git a/services/workflows-service/src/document/document.service.ts b/services/workflows-service/src/document/document.service.ts
diff --git a/services/workflows-service/src/document/types.ts b/services/workflows-service/src/document/types.ts
diff --git a/services/workflows-service/src/workflow/workflow-runtime-data.repository.ts b/services/workflows-service/src/workflow/workflow-runtime-data.repository.ts
diff --git a/services/workflows-service/src/workflow/workflow.service.ts b/services/workflows-service/src/workflow/workflow.service.ts
