feat: reworked kyc block approval logic

Author: chesterkmr

apps/backoffice-v2/src/domains/individuals/fetchers.ts

@@ -16,6 +16,20 @@ export const EntityType = {
 
 export const EndUserVariantSchema = z.enum([EntityType.UBO, EntityType.DIRECTOR]);
 
+export const EndUserApprovalState = {
+  NEW: 'NEW',
+  PROCESSING: 'PROCESSING',
+  APPROVED: 'APPROVED',
+  REJECTED: 'REJECTED',
+} as const;
+
+export const EndUserApprovalStates = [
+  EndUserApprovalState.NEW,
+  EndUserApprovalState.PROCESSING,
+  EndUserApprovalState.APPROVED,
+  EndUserApprovalState.REJECTED,
+] as const;
+
 export const EndUserSchema = z.object({
   id: z.string(),
   firstName: z.string(),
@@ -28,6 +42,7 @@ export const EndUserSchema = z.object({
   phone: z.string().nullable(),
   additionalInfo: z.record(z.string(), z.any()).nullable(),
   amlHits: z.array(HitSchema.extend({ vendor: z.string().optional() })).optional(),
+  approvalState: z.enum(EndUserApprovalStates).optional(),
   individualVerificationsChecks: z
     .object({
       status: z.string(),
@@ -50,6 +65,8 @@ export const EndUserSchema = z.object({
   createdFrom: z.enum(['user', 'analyst', 'registry']).nullable().optional(),
 });
 
+export type TEndUser = z.output<typeof EndUserSchema>;
+
 export const EndUsersSchema = z.array(EndUserSchema);
 
 export const getEndUserById = async ({ id }: { id: string }) => {
@@ -74,3 +91,27 @@ export const getEndUsersByIds = async ({ ids }: { ids: string[] }) => {
 
   return handleZodError(error, endUsers);
 };
+
+export type TIndividualDecision =
+  | `${typeof EndUserApprovalState.APPROVED}`
+  | `${typeof EndUserApprovalState.REJECTED}`;
+
+export const updateIndividualApprovalDecision = async ({
+  endUserId,
+  decision,
+}: {
+  endUserId: string;
+  decision: TIndividualDecision;
+}) => {
+  const [response, error] = await apiClient({
+    endpoint: `end-users/${endUserId}/decision`,
+    method: Method.POST,
+    schema: EndUserSchema,
+    body: {
+      endUserId,
+      decision,
+    },
+  });
+
+  return handleZodError(error, response);
+};

apps/backoffice-v2/src/domains/individuals/mutations/useMutateIndividualApprovalDecision/useMutateIndividualApprovalDecision.ts

@@ -0,0 +1,31 @@
+import { useMutation } from '@tanstack/react-query';
+import { TIndividualDecision, updateIndividualApprovalDecision } from '../../fetchers';
+import { toast } from 'sonner';
+import { t } from 'i18next';
+import { queryClient } from '@/lib/react-query/query-client';
+import { workflowsQueryKeys } from '@/domains/workflows/query-keys';
+
+export const useMutateIndividualApprovalDecision = () => {
+  return useMutation({
+    mutationFn: async ({
+      endUserId,
+      decision,
+    }: {
+      endUserId: string;
+      decision: TIndividualDecision;
+    }) => {
+      return updateIndividualApprovalDecision({
+        endUserId,
+        decision,
+      });
+    },
+    onSuccess: () => {
+      void queryClient.invalidateQueries(workflowsQueryKeys._def);
+
+      toast.success(t('toast:approve_case.success'));
+    },
+    onError: () => {
+      toast.error(t('toast:approve_case.error'));
+    },
+  });
+};

apps/backoffice-v2/src/lib/blocks/components/KycBlock/hooks/useKycBlock/useKycBlock.tsx

@@ -28,6 +28,10 @@ import { SelectItem } from '@/common/components/atoms/Select/Select.Item';
 import { SelectTrigger } from '@/common/components/atoms/Select/Select.Trigger';
 import { SelectValue } from '@/common/components/atoms/Select/Select.Value';
 import { systemCreatedIconCell, userCreatedIconCell } from '@/lib/blocks/utils/constants';
+import {
+  INDIVIDUAL_KYC_CHECK_STATUS_ENUM,
+  TIndividualKycCheckStatus,
+} from '@/lib/blocks/variants/DefaultBlocks/hooks/useCaseBlocksLogic/utils/compute-individual-kyc-check-status';
 
 const motionBadgeProps = {
   exit: { opacity: 0, transition: { duration: 0.2 } },
@@ -299,10 +303,8 @@ export const useKycBlock = ({
   const isDisabled = isActionsDisabled || noAction || isLoadingApprove || isLoadingReuploadNeeded;
   const badgeClassNames = 'text-sm font-bold';
 
-  const getDecisionStatusOrAction = (
-    status: 'revision' | 'approved' | 'rejected' | 'pending' | undefined,
-  ) => {
-    if (status === 'revision') {
+  const getDecisionStatusOrAction = (status: TIndividualKycCheckStatus | undefined) => {
+    if (status === INDIVIDUAL_KYC_CHECK_STATUS_ENUM.revision) {
       return createBlocksTyped()
         .addBlock()
         .addCell({
@@ -317,7 +319,7 @@ export const useKycBlock = ({
         .buildFlat();
     }
 
-    if (status === 'approved') {
+    if (status === INDIVIDUAL_KYC_CHECK_STATUS_ENUM.approved) {
       return createBlocksTyped()
         .addBlock()
         .addCell({
@@ -332,7 +334,7 @@ export const useKycBlock = ({
         .buildFlat();
     }
 
-    if (status === 'rejected') {
+    if (status === INDIVIDUAL_KYC_CHECK_STATUS_ENUM.rejected) {
       return createBlocksTyped()
         .addBlock()
         .addCell({
@@ -347,7 +349,7 @@ export const useKycBlock = ({
         .buildFlat();
     }
 
-    if (status === 'pending') {
+    if (status === INDIVIDUAL_KYC_CHECK_STATUS_ENUM.pending) {
       return createBlocksTyped()
         .addBlock()
         .addCell({

apps/backoffice-v2/src/lib/blocks/variants/DefaultBlocks/hooks/useCaseBlocksLogic/utils/compute-individual-kyc-check-status.ts

@@ -0,0 +1,57 @@
+import { EndUserApprovalState, TEndUser } from '@/domains/individuals/fetchers';
+import { TWorkflowById } from '@/domains/workflows/fetchers';
+import { ObjectValues, StateTag } from '@ballerine/common';
+
+export const INDIVIDUAL_KYC_CHECK_STATUS_ENUM = {
+  revision: 'revision',
+  approved: 'approved',
+  rejected: 'rejected',
+  pending: 'pending',
+} as const;
+
+export type TIndividualKycCheckStatus = ObjectValues<typeof INDIVIDUAL_KYC_CHECK_STATUS_ENUM>;
+
+const getStatusFromTags = (tags: string[]) => {
+  if (tags?.includes(StateTag.REVISION)) {
+    return INDIVIDUAL_KYC_CHECK_STATUS_ENUM.revision;
+  }
+
+  if (tags?.includes(StateTag.APPROVED)) {
+    return INDIVIDUAL_KYC_CHECK_STATUS_ENUM.approved;
+  }
+
+  if (tags?.includes(StateTag.REJECTED)) {
+    return INDIVIDUAL_KYC_CHECK_STATUS_ENUM.rejected;
+  }
+
+  if (tags?.includes(StateTag.PENDING_PROCESS)) {
+    return INDIVIDUAL_KYC_CHECK_STATUS_ENUM.pending;
+  }
+};
+
+export const computeIndividualKycCheckStatus = ({
+  endUser,
+  tags,
+}: {
+  endUser?: TEndUser;
+  tags: TWorkflowById['tags'];
+}): TIndividualKycCheckStatus | undefined => {
+  if (endUser?.individualVerificationsChecks?.status === 'in-progress') {
+    return INDIVIDUAL_KYC_CHECK_STATUS_ENUM.pending;
+  }
+
+  if (
+    !endUser?.approvalState ||
+    [EndUserApprovalState.NEW, EndUserApprovalState.PROCESSING].includes(endUser?.approvalState)
+  ) {
+    return getStatusFromTags(tags || []);
+  }
+
+  if (endUser?.approvalState === EndUserApprovalState.APPROVED) {
+    return INDIVIDUAL_KYC_CHECK_STATUS_ENUM.approved;
+  }
+
+  if (endUser?.approvalState === EndUserApprovalState.REJECTED) {
+    return INDIVIDUAL_KYC_CHECK_STATUS_ENUM.rejected;
+  }
+};