refactor: rename beneficiaries proceed recipients (#669)

Signed-off-by: Miguel_LZPF <[email protected]>
Signed-off-by: Mario Francia <[email protected]>

Author: MiguelLZPF

…src/hooks/mutations/useBeneficiaries.tsx …hooks/mutations/useProceedRecipients.tsxapps/ats/web/src/hooks/mutations/useBeneficiaries.tsx renamed to apps/ats/web/src/hooks/mutations/useProceedRecipients.tsx apps/ats/web/src/hooks/mutations/useBeneficiaries.tsx renamed to apps/ats/web/src/hooks/mutations/useProceedRecipients.tsx

@@ -1,31 +1,31 @@
 import { useMutation, useQueryClient } from '@tanstack/react-query';
 import SDKService from '../../services/SDKService';
 import {
-  AddBeneficiaryRequest,
-  RemoveBeneficiaryRequest,
-  UpdateBeneficiaryDataRequest,
+  AddProceedRecipientRequest,
+  RemoveProceedRecipientRequest,
+  UpdateProceedRecipientDataRequest,
 } from '@hashgraph/asset-tokenization-sdk';
 import { useToast } from 'io-bricks-ui';
 import { useTranslation } from 'react-i18next';
-import { GET_BENEFICIARY_LIST } from '../queries/useBeneficiaries';
+import { GET_PROCEED_RECIPIENT_LIST } from '../queries/useProceedRecipients';
 
-export const useAddBeneficiary = () => {
+export const useAddProceedRecipient = () => {
   const queryClient = useQueryClient();
   const toast = useToast();
   const { t } = useTranslation('security', {
-    keyPrefix: 'details.beneficiaries.create.messages',
+    keyPrefix: 'details.proceedRecipients.create.messages',
   });
 
   return useMutation(
-    (req: AddBeneficiaryRequest) => SDKService.addBeneficiary(req),
+    (req: AddProceedRecipientRequest) => SDKService.addProceedRecipient(req),
     {
       onSuccess(data, variables) {
         queryClient.invalidateQueries({
-          queryKey: [GET_BENEFICIARY_LIST(variables.securityId)],
+          queryKey: [GET_PROCEED_RECIPIENT_LIST(variables.securityId)],
         });
 
         console.log(
-          'SDK message --> Add beneficiary operation success: ',
+          'SDK message --> Add proceed recipient operation success: ',
           data,
         );
 
@@ -42,7 +42,10 @@ export const useAddBeneficiary = () => {
         });
       },
       onError: (error) => {
-        console.log('SDK message --> Add beneficiary operation error: ', error);
+        console.log(
+          'SDK message --> Add proceed recipient operation error: ',
+          error,
+        );
 
         toast.show({
           duration: 3000,
@@ -56,24 +59,24 @@ export const useAddBeneficiary = () => {
   );
 };
 
-export const useUpdateBeneficiary = () => {
+export const useUpdateProceedRecipient = () => {
   const queryClient = useQueryClient();
   const toast = useToast();
   const { t } = useTranslation('security', {
-    keyPrefix: 'details.beneficiaries.update.messages',
+    keyPrefix: 'details.proceedRecipients.update.messages',
   });
 
   return useMutation(
-    (req: UpdateBeneficiaryDataRequest) =>
-      SDKService.updateBeneficiaryData(req),
+    (req: UpdateProceedRecipientDataRequest) =>
+      SDKService.updateProceedRecipientData(req),
     {
       onSuccess(data, variables) {
         queryClient.invalidateQueries({
-          queryKey: [GET_BENEFICIARY_LIST(variables.securityId)],
+          queryKey: [GET_PROCEED_RECIPIENT_LIST(variables.securityId)],
         });
 
         console.log(
-          'SDK message --> Update beneficiary operation success: ',
+          'SDK message --> Update proceed recipient operation success: ',
           data,
         );
 
@@ -91,7 +94,7 @@ export const useUpdateBeneficiary = () => {
       },
       onError: (error) => {
         console.log(
-          'SDK message --> Update beneficiary operation error: ',
+          'SDK message --> Update proceed recipient operation error: ',
           error,
         );
 
@@ -107,23 +110,24 @@ export const useUpdateBeneficiary = () => {
   );
 };
 
-export const useRemoveBeneficiary = () => {
+export const useRemoveProceedRecipient = () => {
   const queryClient = useQueryClient();
   const toast = useToast();
   const { t } = useTranslation('security', {
-    keyPrefix: 'details.beneficiaries.remove.messages',
+    keyPrefix: 'details.proceedRecipients.remove.messages',
   });
 
   return useMutation(
-    (req: RemoveBeneficiaryRequest) => SDKService.removeBeneficiary(req),
+    (req: RemoveProceedRecipientRequest) =>
+      SDKService.removeProceedRecipient(req),
     {
       onSuccess(data, variables) {
         queryClient.invalidateQueries({
-          queryKey: [GET_BENEFICIARY_LIST(variables.securityId)],
+          queryKey: [GET_PROCEED_RECIPIENT_LIST(variables.securityId)],
         });
 
         console.log(
-          'SDK message --> Remove beneficiary operation success: ',
+          'SDK message --> Remove proceed recipient operation success: ',
           data,
         );
 
@@ -141,7 +145,7 @@ export const useRemoveBeneficiary = () => {
       },
       onError: (error) => {
         console.log(
-          'SDK message --> Remove beneficiary operation error: ',
+          'SDK message --> Remove proceed recipient operation error: ',
           error,
         );
 

…eb/src/hooks/queries/useBeneficiaries.ts …rc/hooks/queries/useProceedRecipients.tsapps/ats/web/src/hooks/queries/useBeneficiaries.ts renamed to apps/ats/web/src/hooks/queries/useProceedRecipients.ts apps/ats/web/src/hooks/queries/useBeneficiaries.ts renamed to apps/ats/web/src/hooks/queries/useProceedRecipients.ts

@@ -206,69 +206,69 @@
 import { useQuery, UseQueryOptions } from '@tanstack/react-query';
 import SDKService from '../../services/SDKService';
 import {
-  GetBeneficiariesCountRequest,
-  GetBeneficiariesRequest,
-  GetBeneficiaryDataRequest,
+  GetProceedRecipientsCountRequest,
+  GetProceedRecipientsRequest,
+  GetProceedRecipientDataRequest,
 } from '@hashgraph/asset-tokenization-sdk';
 
-export interface BeneficiaryDataViewModelResponse {
+export interface ProceedRecipientDataViewModelResponse {
   address: string;
   data?: string;
 }
 
-export const GET_BENEFICIARY_LIST = (securityId: string) =>
-  `GET_BENEFICIARY_LIST_${securityId}`;
+export const GET_PROCEED_RECIPIENT_LIST = (securityId: string) =>
+  `GET_PROCEED_RECIPIENT_LIST_${securityId}`;
 
-export const IS_INTERNAL_BENEFICIARY_ACTIVATED = (securityId: string) =>
-  `IS_INTERNAL_BENEFICIARY_ACTIVATED_${securityId}`;
+export const IS_INTERNAL_PROCEED_RECIPIENT_ACTIVATED = (securityId: string) =>
+  `IS_INTERNAL_PROCEED_RECIPIENT_ACTIVATED_${securityId}`;
 
-export const useGetBeneficiaryList = (
-  request: GetBeneficiariesCountRequest,
+export const useGetProceedRecipientList = (
+  request: GetProceedRecipientsCountRequest,
   options?: UseQueryOptions<
-    BeneficiaryDataViewModelResponse[],
+    ProceedRecipientDataViewModelResponse[],
     unknown,
-    BeneficiaryDataViewModelResponse[],
+    ProceedRecipientDataViewModelResponse[],
     string[]
   >,
 ) => {
   return useQuery(
-    [GET_BENEFICIARY_LIST(request.securityId)],
+    [GET_PROCEED_RECIPIENT_LIST(request.securityId)],
     async () => {
       try {
-        const beneficiariesCount =
-          await SDKService.getBeneficiariesCount(request);
+        const proceedRecipientsCount =
+          await SDKService.getProceedRecipientsCount(request);
 
-        const beneficiaries = await SDKService.getBeneficiaries(
-          new GetBeneficiariesRequest({
+        const proceedRecipients = await SDKService.getProceedRecipients(
+          new GetProceedRecipientsRequest({
             securityId: request.securityId,
             pageIndex: 0,
-            pageSize: beneficiariesCount ?? 100,
+            pageSize: proceedRecipientsCount ?? 100,
           }),
         );
 
-        const beneficiariesWithData = await Promise.all(
-          beneficiaries.map(async (beneficiary) => {
+        const proceedRecipientsWithData = await Promise.all(
+          proceedRecipients.map(async (proceedRecipient) => {
             try {
-              const data = await SDKService.getBeneficiaryData(
-                new GetBeneficiaryDataRequest({
+              const data = await SDKService.getProceedRecipientData(
+                new GetProceedRecipientDataRequest({
                   securityId: request.securityId,
-                  beneficiaryId: beneficiary,
+                  proceedRecipientId: proceedRecipient,
                 }),
               );
               return {
-                address: beneficiary,
+                address: proceedRecipient,
                 data,
-              } as BeneficiaryDataViewModelResponse;
+              } as ProceedRecipientDataViewModelResponse;
             } catch (error) {
-              console.error('Error fetching beneficiary data', error);
-              return { address: beneficiary, data: undefined };
+              console.error('Error fetching proceed recipient data', error);
+              return { address: proceedRecipient, data: undefined };
             }
           }),
         );
 
-        return beneficiariesWithData;
+        return proceedRecipientsWithData;
       } catch (error) {
-        console.error('Error fetching beneficiaries', error);
+        console.error('Error fetching proceed recipients', error);
         throw error;
       }
     },

apps/ats/web/src/i18n/en/index.ts

@@ -326,7 +326,7 @@ export default {
     internalKYCManager: 'Internal KYC Manager role',
     freezer: 'Freeze Manager Role',
     trexOwner: 'TREX Owner Role',
-    beneficiaryManager: 'Beneficiary Manager Role',
+    proceedRecipientManager: 'Proceed Recipient Manager Role',
   },
   landing,
   routes,

apps/ats/web/src/i18n/en/security/createBond.ts

@@ -293,9 +293,9 @@ export default {
     totalCoupons: 'Total coupons',
   },
 
-  stepBeneficiaries: {
-    title: 'Beneficiaries',
-    subtitle: 'Add beneficiaries',
+  stepProceedRecipients: {
+    title: 'Proceed Recipients',
+    subtitle: 'Add proceed recipients',
     mandatoryFields: '*Mandatory fields',
     address: 'Address',
     addressPlaceholder: '0.0.1234567',
@@ -304,7 +304,7 @@ export default {
     invalidHederaId: 'Invalid Hedera ID',
     actions: 'Actions',
     invalidHexFormat: 'Invalid hex format',
-    addBeneficiary: 'Add beneficiary',
+    addProceedRecipient: 'Add proceed recipient',
   },
 
   stepERC3643: {

apps/ats/web/src/i18n/en/security/details.ts

@@ -219,7 +219,7 @@ import clearingOperations from './clearingOperations';
 import externalPause from './externalPause';
 import externalControl from './externalControl';
 import externalKYC from './externalKYC';
-import beneficiaries from './beneficiaries';
+import proceedRecipients from './proceedRecipients';
 
 export default {
   header: {
@@ -250,7 +250,7 @@ export default {
     externalPause: 'External Pause',
     externalKYCList: 'External KYC',
     freeze: 'Freeze',
-    beneficiaries: 'Beneficiaries',
+    proceedRecipients: 'Proceed Recipients',
   },
   actions: {
     redeem: 'Redeem',
@@ -311,7 +311,7 @@ export default {
   externalPause,
   externalControl,
   externalKYC,
-  beneficiaries,
+  proceedRecipients,
   benefits: {
     dividends: 'Dividends',
     balanceAdjustments: 'Balance Adjustments',

…eb/src/i18n/en/security/beneficiaries.ts …rc/i18n/en/security/proceedRecipients.tsapps/ats/web/src/i18n/en/security/beneficiaries.ts renamed to apps/ats/web/src/i18n/en/security/proceedRecipients.ts apps/ats/web/src/i18n/en/security/beneficiaries.ts renamed to apps/ats/web/src/i18n/en/security/proceedRecipients.ts

@@ -204,8 +204,8 @@
 */
 
 export default {
-  title: 'Beneficiaries',
-  subtitle: 'List of beneficiaries of the bond',
+  title: 'Proceed Recipients',
+  subtitle: 'List of proceed recipients of the bond',
   add: 'Add',
   table: {
     fields: {
@@ -217,8 +217,8 @@ export default {
     },
   },
   create: {
-    title: 'Add Beneficiary',
-    description: 'Fill in the form below to add a beneficiary',
+    title: 'Add Proceed Recipient',
+    description: 'Fill in the form below to add a proceed recipient',
     form: {
       address: {
         label: 'Address',
@@ -236,14 +236,14 @@ export default {
     },
     messages: {
       success: 'Success: ',
-      descriptionSuccess: 'Beneficiary creation was successful',
+      descriptionSuccess: 'Proceed recipient creation was successful',
       error: 'Error: ',
-      descriptionFailed: 'Beneficiary creation failed',
+      descriptionFailed: 'Proceed recipient creation failed',
     },
   },
   update: {
-    title: 'Update Beneficiary',
-    description: 'Fill in the form below to update a beneficiary',
+    title: 'Update Proceed Recipient',
+    description: 'Fill in the form below to update a proceed recipient',
     form: {
       address: {
         label: 'Address',
@@ -261,15 +261,15 @@ export default {
     },
     messages: {
       success: 'Success: ',
-      descriptionSuccess: 'Beneficiary update was successful',
+      descriptionSuccess: 'Proceed recipient update was successful',
       error: 'Error: ',
-      descriptionFailed: 'Beneficiary update failed',
+      descriptionFailed: 'Proceed recipient update failed',
     },
   },
   remove: {
     confirmPopUp: {
-      title: 'Remove Beneficiary',
-      description: 'Are you sure you want to remove this beneficiary?',
+      title: 'Remove Proceed Recipient',
+      description: 'Are you sure you want to remove this proceed recipient?',
       confirmText: 'Remove',
       cancelText: 'Cancel',
     },