BAL-1957

apps/backoffice-v2/CHANGELOG.md

@@ -5,6 +5,9 @@
 ### Patch Changes
 
 - Updated dependencies
+  - @ballerine/[email protected]
+  - @ballerine/[email protected]
+  - @ballerine/[email protected]
   - @ballerine/[email protected]
 
 ## 0.7.7

apps/backoffice-v2/package.json

@@ -50,11 +50,11 @@
     "preview": "vite preview"
   },
   "dependencies": {
+    "@ballerine/common": "0.9.6",
     "@ballerine/blocks": "0.2.3",
-    "@ballerine/common": "0.9.5",
     "@ballerine/ui": "^0.5.1",
-    "@ballerine/workflow-browser-sdk": "0.6.8",
-    "@ballerine/workflow-node-sdk": "0.6.8",
+    "@ballerine/workflow-browser-sdk": "0.6.9",
+    "@ballerine/workflow-node-sdk": "0.6.9",
     "@fontsource/inter": "^4.5.15",
     "@formkit/auto-animate": "1.0.0-beta.5",
     "@hookform/resolvers": "^3.1.0",

apps/backoffice-v2/src/domains/entities/hooks/mutations/useApproveTaskByIdMutation/useApproveTaskByIdMutation.tsx

@@ -1,10 +1,10 @@
 import { useMutation, useQueryClient } from '@tanstack/react-query';
-import { toast } from 'sonner';
 import { t } from 'i18next';
-import { TWorkflowById, updateWorkflowDecision } from '../../../../workflows/fetchers';
-import { workflowsQueryKeys } from '../../../../workflows/query-keys';
+import { toast } from 'sonner';
 import { Action } from '../../../../../common/enums';
 import { useFilterId } from '../../../../../common/hooks/useFilterId/useFilterId';
+import { TWorkflowById, updateWorkflowDecision } from '../../../../workflows/fetchers';
+import { workflowsQueryKeys } from '../../../../workflows/query-keys';
 
 export const useApproveTaskByIdMutation = (workflowId: string) => {
   const queryClient = useQueryClient();
@@ -15,15 +15,18 @@ export const useApproveTaskByIdMutation = (workflowId: string) => {
     mutationFn: ({
       documentId,
       contextUpdateMethod = 'base',
+      comment,
     }: {
       documentId: string;
       contextUpdateMethod?: 'base' | 'director';
+      comment?: string;
     }) =>
       updateWorkflowDecision({
         workflowId,
         documentId,
         body: {
           decision: Action.APPROVE,
+          comment,
         },
         contextUpdateMethod,
       }),

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

@@ -1,16 +1,16 @@
-import { env } from '@/common/env/env';
-import qs from 'qs';
-import { deepCamelKeys } from 'string-ts';
-import { z } from 'zod';
 import { apiClient } from '@/common/api-client/api-client';
 import { Method, States } from '@/common/enums';
+import { env } from '@/common/env/env';
+import { getOriginUrl } from '@/common/utils/get-origin-url/get-url-origin';
 import { handleZodError } from '@/common/utils/handle-zod-error/handle-zod-error';
+import { WorkflowDefinitionByIdSchema } from '@/domains/workflow-definitions/fetchers';
+import { AmlSchema } from '@/lib/blocks/components/AmlBlock/utils/aml-adapter';
 import { ObjectWithIdSchema } from '@/lib/zod/utils/object-with-id/object-with-id';
 import { zPropertyKey } from '@/lib/zod/utils/z-property-key/z-property-key';
+import qs from 'qs';
+import { deepCamelKeys } from 'string-ts';
+import { z } from 'zod';
 import { IWorkflowId } from './interfaces';
-import { getOriginUrl } from '@/common/utils/get-origin-url/get-url-origin';
-import { WorkflowDefinitionByIdSchema } from '@/domains/workflow-definitions/fetchers';
-import { AmlSchema } from '@/lib/blocks/components/AmlBlock/utils/aml-adapter';
 
 export const fetchWorkflows = async (params: {
   filterId: string;
@@ -239,6 +239,7 @@ export const updateWorkflowDecision = async ({
   body: {
     decision: string | null;
     reason?: string;
+    comment?: string;
   };
   contextUpdateMethod: 'base' | 'director';
 }) => {

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

@@ -1,6 +1,7 @@
 import { StateTag, TStateTags, isObject } from '@ballerine/common';
 import { ComponentProps, useCallback, useMemo } from 'react';
 
+import { Separator } from '@/common/components/atoms/Separator/Separator';
 import { MotionButton } from '@/common/components/molecules/MotionButton/MotionButton';
 import { useFilterId } from '@/common/hooks/useFilterId/useFilterId';
 import { ctw } from '@/common/utils/ctw/ctw';
@@ -21,7 +22,6 @@ import { capitalize } from '../../../../../../common/utils/capitalize/capitalize
 import { valueOrNA } from '../../../../../../common/utils/value-or-na/value-or-na';
 import { useStorageFilesQuery } from '../../../../../../domains/storage/hooks/queries/useStorageFilesQuery/useStorageFilesQuery';
 import { TWorkflowById } from '../../../../../../domains/workflows/fetchers';
-import { Separator } from '@/common/components/atoms/Separator/Separator';
 
 const motionBadgeProps = {
   exit: { opacity: 0, transition: { duration: 0.2 } },

apps/backoffice-v2/src/lib/blocks/hooks/useDocumentBlocks/hooks/useCommentInput/useCommentInput.ts

@@ -0,0 +1,19 @@
+import { useCallback, useState } from 'react';
+
+export const useCommentInput = () => {
+  const [value, setValue] = useState('');
+
+  const handleChange = useCallback((event: React.ChangeEvent<HTMLInputElement>) => {
+    setValue(event.target.value);
+  }, []);
+
+  const clear = useCallback(() => {
+    setValue('');
+  }, []);
+
+  return {
+    value,
+    handleChange,
+    clear,
+  };
+};

apps/backoffice-v2/src/lib/blocks/hooks/useDocumentBlocks/useDocumentBlocks.tsx

@@ -1,4 +1,5 @@
 import { MotionButton } from '@/common/components/molecules/MotionButton/MotionButton';
+import { checkIsBusiness } from '@/common/utils/check-is-business/check-is-business';
 import { ctw } from '@/common/utils/ctw/ctw';
 import { valueOrNA } from '@/common/utils/value-or-na/value-or-na';
 import { useApproveTaskByIdMutation } from '@/domains/entities/hooks/mutations/useApproveTaskByIdMutation/useApproveTaskByIdMutation';
@@ -8,6 +9,7 @@ import { useStorageFilesQuery } from '@/domains/storage/hooks/queries/useStorage
 import { TWorkflowById } from '@/domains/workflows/fetchers';
 import { createBlocksTyped } from '@/lib/blocks/create-blocks-typed/create-blocks-typed';
 import { motionButtonProps } from '@/lib/blocks/hooks/useAssosciatedCompaniesBlock/useAssociatedCompaniesBlock';
+import { useCommentInput } from '@/lib/blocks/hooks/useDocumentBlocks/hooks/useCommentInput/useCommentInput';
 import { checkCanApprove } from '@/lib/blocks/hooks/useDocumentBlocks/utils/check-can-approve/check-can-approve';
 import { checkCanReject } from '@/lib/blocks/hooks/useDocumentBlocks/utils/check-can-reject/check-can-reject';
 import { checkCanRevision } from '@/lib/blocks/hooks/useDocumentBlocks/utils/check-can-revision/check-can-revision';
@@ -23,12 +25,11 @@ import {
 import { selectWorkflowDocuments } from '@/pages/Entity/selectors/selectWorkflowDocuments';
 import { getDocumentsSchemas } from '@/pages/Entity/utils/get-documents-schemas/get-documents-schemas';
 import { CommonWorkflowStates, StateTag } from '@ballerine/common';
-import { Button } from '@ballerine/ui';
+import { Button, TextArea } from '@ballerine/ui';
 import { X } from 'lucide-react';
 import * as React from 'react';
 import { FunctionComponent, useCallback, useMemo } from 'react';
 import { toTitleCase } from 'string-ts';
-import { checkIsBusiness } from '@/common/utils/check-is-business/check-is-business';
 
 export const useDocumentBlocks = ({
   workflow,
@@ -80,17 +81,27 @@ export const useDocumentBlocks = ({
   const { mutate: mutateApproveTaskById, isLoading: isLoadingApproveTaskById } =
     useApproveTaskByIdMutation(workflow?.id);
   const { isLoading: isLoadingRejectTaskById } = useRejectTaskByIdMutation(workflow?.id);
+
+  const {
+    value: commentValue,
+    handleChange: handleCommentChange,
+    clear: clearComment,
+  } = useCommentInput();
   const onMutateApproveTaskById = useCallback(
     ({
         taskId,
         contextUpdateMethod,
+        comment,
       }: {
         taskId: string;
         contextUpdateMethod: 'base' | 'director';
+        comment?: string;
       }) =>
-      () =>
-        mutateApproveTaskById({ documentId: taskId, contextUpdateMethod }),
-    [mutateApproveTaskById],
+      () => {
+        mutateApproveTaskById({ documentId: taskId, contextUpdateMethod, comment });
+        clearComment();
+      },
+    [mutateApproveTaskById, clearComment],
   );
   const { mutate: onMutateRemoveDecisionById } = useRemoveDecisionTaskByIdMutation(workflow?.id);
 
@@ -264,16 +275,24 @@ export const useDocumentBlocks = ({
                 ),
                 title: `Approval confirmation`,
                 description: <p className={`text-sm`}>Are you sure you want to approve?</p>,
+                content: (
+                  <TextArea
+                    placeholder={'Add a comment'}
+                    value={commentValue}
+                    onChange={handleCommentChange}
+                  />
+                ),
                 close: (
                   <div className={`space-x-2`}>
-                    <Button type={'button'} variant={`secondary`}>
+                    <Button type={'button'} variant={`secondary`} onClick={clearComment}>
                       Cancel
                     </Button>
                     <Button
                       disabled={!canApprove}
                       onClick={onMutateApproveTaskById({
                         taskId: id,
                         contextUpdateMethod: 'base',
+                        comment: commentValue || undefined,
                       })}
                     >
                       Approve

apps/kyb-app/CHANGELOG.md

@@ -5,6 +5,8 @@
 ### Patch Changes
 
 - Updated dependencies
+  - @ballerine/[email protected]
+  - @ballerine/[email protected]
   - @ballerine/[email protected]
 
 ## 0.3.8

apps/kyb-app/package.json

@@ -14,10 +14,10 @@
     "test:dev": "vitest"
   },
   "dependencies": {
+    "@ballerine/common": "^0.9.6",
     "@ballerine/blocks": "0.2.3",
-    "@ballerine/common": "^0.9.5",
     "@ballerine/ui": "0.5.2",
-    "@ballerine/workflow-browser-sdk": "0.6.8",
+    "@ballerine/workflow-browser-sdk": "0.6.9",
     "@lukemorales/query-key-factory": "^1.0.3",
     "@radix-ui/react-icons": "^1.3.0",
     "@rjsf/core": "^5.9.0",

examples/headless-example/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @ballerine/headless-example
 
+## 0.3.8
+
+### Patch Changes
+
+- Updated dependencies
+  - @ballerine/[email protected]
+  - @ballerine/[email protected]
+
 ## 0.3.7
 
 ### Patch Changes

examples/headless-example/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ballerine/headless-example",
   "private": true,
-  "version": "0.3.7",
+  "version": "0.3.8",
   "type": "module",
   "scripts": {
     "spellcheck": "cspell \"*\"",
@@ -34,8 +34,8 @@
     "vite": "^4.5.3"
   },
   "dependencies": {
-    "@ballerine/common": "0.9.5",
-    "@ballerine/workflow-browser-sdk": "0.6.8",
+    "@ballerine/common": "0.9.6",
+    "@ballerine/workflow-browser-sdk": "0.6.9",
     "@felte/reporter-svelte": "^1.1.5",
     "@felte/validator-zod": "^1.0.13",
     "@fontsource/inter": "^4.5.15",

packages/common/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ballerine/common
 
+## 0.9.6
+
+### Patch Changes
+
+- Context schema update
+
 ## 0.9.5
 
 ### Patch Changes

packages/common/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "name": "@ballerine/common",
   "author": "Ballerine <[email protected]>",
-  "version": "0.9.5",
+  "version": "0.9.6",
   "description": "common",
   "module": "./dist/esm/index.js",
   "main": "./dist/cjs/index.js",

packages/common/src/schemas/documents/default-context-schema.ts

@@ -57,6 +57,7 @@ export const defaultContextSchema = Type.Object({
                   Type.Null(),
                 ]),
               ),
+              comment: Type.Optional(Type.String()),
               rejectionReason: Type.Optional(
                 Type.Union([
                   Type.String(),

packages/workflow-core/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @ballerine/workflow-core
 
+## 0.6.9
+
+### Patch Changes
+
+- Updated dependencies
+  - @ballerine/[email protected]
+
 ## 0.6.8
 
 ### Patch Changes

packages/workflow-core/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ballerine/workflow-core",
   "author": "Ballerine <[email protected]>",
-  "version": "0.6.8",
+  "version": "0.6.9",
   "description": "workflow-core",
   "module": "./dist/esm/index.js",
   "main": "./dist/cjs/index.js",
@@ -31,7 +31,7 @@
     "node": ">=12"
   },
   "dependencies": {
-    "@ballerine/common": "0.9.5",
+    "@ballerine/common": "0.9.6",
     "ajv": "^8.12.0",
     "i18n-iso-countries": "^7.6.0",
     "jmespath": "^0.16.0",