From 961e4b99e85e6d7fd45223dc74294d63fdffb15f Mon Sep 17 00:00:00 2001 From: Ahmed Bouhuolia Date: Tue, 13 Aug 2024 14:17:37 +0200 Subject: [PATCH] fix: rename interfaces to `PaymentReceived` --- .../server/src/interfaces/PaymentReceive.ts | 58 +++++++++---------- .../events/AttachmentsOnPaymentsReceived.ts | 26 ++++----- .../ValidateMatchingOnPaymentMadeDelete.ts | 4 +- ...ValidateMatchingOnPaymentReceivedDelete.ts | 6 +- .../PaymentReceiveBranchSubscriber.ts | 12 ++-- .../Sales/Estimates/SaleEstimateSmsNotify.ts | 6 +- .../Estimates/SaleEstimatesApplication.ts | 6 +- .../PaymentReceived/CreatePaymentReceived.ts | 18 +++--- .../PaymentReceived/DeletePaymentReceived.ts | 10 ++-- .../PaymentReceived/EditPaymentReceived.ts | 24 ++++---- .../PaymentReceived/GetPaymentReceived.ts | 6 +- .../PaymentReceived/GetPaymentReceivedPdf.ts | 4 +- .../PaymentReceived/GetPaymentsReceived.ts | 10 ++-- .../PaymentReceivedApplication.ts | 34 +++++------ .../PaymentReceivedDTOTransformer.ts | 20 +++---- .../PaymentReceivedGLEntries.ts | 28 ++++----- .../PaymentReceivedInvoiceSync.ts | 6 +- .../PaymentReceivedSmsNotify.ts | 26 ++++----- .../PaymentReceivedTransformer.ts | 24 ++++---- .../PaymentReceivedValidators.ts | 36 ++++++------ .../PaymentsReceivedExportable.ts | 8 +-- .../PaymentsReceivedImportable.ts | 4 +- .../PaymentReceived/PaymentsReceivedPages.ts | 4 +- .../SalesTransactionLockingGuardSubscriber.ts | 18 +++--- .../PaymentReceive/AutoSerialIncrement.ts | 6 +- .../PaymentReceiveSyncInvoices.ts | 12 ++-- .../SendSmsNotificationToCustomer.ts | 4 +- .../PaymentReceive/WriteGLEntries.ts | 12 ++-- 28 files changed, 216 insertions(+), 216 deletions(-) diff --git a/packages/server/src/interfaces/PaymentReceive.ts b/packages/server/src/interfaces/PaymentReceive.ts index 68ecb0eb6..e9910b709 100644 --- a/packages/server/src/interfaces/PaymentReceive.ts +++ b/packages/server/src/interfaces/PaymentReceive.ts @@ -8,7 +8,7 @@ import { ILedgerEntry } from './Ledger'; import { ISaleInvoice } from './SaleInvoice'; import { AttachmentLinkDTO } from './Attachments'; -export interface IPaymentReceive { +export interface IPaymentReceived { id?: number; customerId: number; paymentDate: Date; @@ -19,14 +19,14 @@ export interface IPaymentReceive { depositAccountId: number; paymentReceiveNo: string; statement: string; - entries: IPaymentReceiveEntry[]; + entries: IPaymentReceivedEntry[]; userId: number; createdAt: Date; updatedAt: Date; localAmount?: number; branchId?: number; } -export interface IPaymentReceiveCreateDTO { +export interface IPaymentReceivedCreateDTO { customerId: number; paymentDate: Date; amount: number; @@ -35,13 +35,13 @@ export interface IPaymentReceiveCreateDTO { depositAccountId: number; paymentReceiveNo?: string; statement: string; - entries: IPaymentReceiveEntryDTO[]; + entries: IPaymentReceivedEntryDTO[]; branchId?: number; attachments?: AttachmentLinkDTO[]; } -export interface IPaymentReceiveEditDTO { +export interface IPaymentReceivedEditDTO { customerId: number; paymentDate: Date; amount: number; @@ -50,12 +50,12 @@ export interface IPaymentReceiveEditDTO { depositAccountId: number; paymentReceiveNo?: string; statement: string; - entries: IPaymentReceiveEntryDTO[]; + entries: IPaymentReceivedEntryDTO[]; branchId?: number; attachments?: AttachmentLinkDTO[]; } -export interface IPaymentReceiveEntry { +export interface IPaymentReceivedEntry { id?: number; paymentReceiveId: number; invoiceId: number; @@ -64,7 +64,7 @@ export interface IPaymentReceiveEntry { invoice?: ISaleInvoice; } -export interface IPaymentReceiveEntryDTO { +export interface IPaymentReceivedEntryDTO { id?: number; index: number; paymentReceiveId: number; @@ -72,7 +72,7 @@ export interface IPaymentReceiveEntryDTO { paymentAmount: number; } -export interface IPaymentReceivesFilter extends IDynamicListFilterDTO { +export interface IPaymentsReceivedFilter extends IDynamicListFilterDTO { stringifiedFilterRoles?: string; } @@ -88,65 +88,65 @@ export interface IPaymentReceivePageEntry { date: Date | string; } -export interface IPaymentReceiveEditPage { - paymentReceive: IPaymentReceive; +export interface IPaymentReceivedEditPage { + paymentReceive: IPaymentReceived; entries: IPaymentReceivePageEntry[]; } -export interface IPaymentsReceiveService { +export interface IPaymentsReceivedService { validateCustomerHasNoPayments( tenantId: number, customerId: number ): Promise; } -export interface IPaymentReceiveSmsDetails { +export interface IPaymentReceivedSmsDetails { customerName: string; customerPhoneNumber: string; smsMessage: string; } -export interface IPaymentReceiveCreatingPayload { +export interface IPaymentReceivedCreatingPayload { tenantId: number; - paymentReceiveDTO: IPaymentReceiveCreateDTO; + paymentReceiveDTO: IPaymentReceivedCreateDTO; trx: Knex.Transaction; } -export interface IPaymentReceiveCreatedPayload { +export interface IPaymentReceivedCreatedPayload { tenantId: number; - paymentReceive: IPaymentReceive; + paymentReceive: IPaymentReceived; paymentReceiveId: number; authorizedUser: ISystemUser; - paymentReceiveDTO: IPaymentReceiveCreateDTO; + paymentReceiveDTO: IPaymentReceivedCreateDTO; trx: Knex.Transaction; } -export interface IPaymentReceiveEditedPayload { +export interface IPaymentReceivedEditedPayload { tenantId: number; paymentReceiveId: number; - paymentReceive: IPaymentReceive; - oldPaymentReceive: IPaymentReceive; - paymentReceiveDTO: IPaymentReceiveEditDTO; + paymentReceive: IPaymentReceived; + oldPaymentReceive: IPaymentReceived; + paymentReceiveDTO: IPaymentReceivedEditDTO; authorizedUser: ISystemUser; trx: Knex.Transaction; } -export interface IPaymentReceiveEditingPayload { +export interface IPaymentReceivedEditingPayload { tenantId: number; - oldPaymentReceive: IPaymentReceive; - paymentReceiveDTO: IPaymentReceiveEditDTO; + oldPaymentReceive: IPaymentReceived; + paymentReceiveDTO: IPaymentReceivedEditDTO; trx: Knex.Transaction; } -export interface IPaymentReceiveDeletingPayload { +export interface IPaymentReceivedDeletingPayload { tenantId: number; - oldPaymentReceive: IPaymentReceive; + oldPaymentReceive: IPaymentReceived; trx: Knex.Transaction; } -export interface IPaymentReceiveDeletedPayload { +export interface IPaymentReceivedDeletedPayload { tenantId: number; paymentReceiveId: number; - oldPaymentReceive: IPaymentReceive; + oldPaymentReceive: IPaymentReceived; authorizedUser: ISystemUser; trx: Knex.Transaction; } diff --git a/packages/server/src/services/Attachments/events/AttachmentsOnPaymentsReceived.ts b/packages/server/src/services/Attachments/events/AttachmentsOnPaymentsReceived.ts index f4e876c6a..311fbb8ea 100644 --- a/packages/server/src/services/Attachments/events/AttachmentsOnPaymentsReceived.ts +++ b/packages/server/src/services/Attachments/events/AttachmentsOnPaymentsReceived.ts @@ -1,10 +1,10 @@ import { Inject, Service } from 'typedi'; import { isEmpty } from 'lodash'; import { - IPaymentReceiveCreatedPayload, - IPaymentReceiveCreatingPayload, - IPaymentReceiveDeletingPayload, - IPaymentReceiveEditedPayload, + IPaymentReceivedCreatedPayload, + IPaymentReceivedCreatingPayload, + IPaymentReceivedDeletingPayload, + IPaymentReceivedEditedPayload, } from '@/interfaces'; import events from '@/subscribers/events'; import { LinkAttachment } from '../LinkAttachment'; @@ -50,13 +50,13 @@ export class AttachmentsOnPaymentsReceived { /** * Validates the attachment keys on creating payment. - * @param {IPaymentReceiveCreatingPayload} + * @param {IPaymentReceivedCreatingPayload} * @returns {Promise} */ private async validateAttachmentsOnPaymentCreate({ paymentReceiveDTO, tenantId, - }: IPaymentReceiveCreatingPayload): Promise { + }: IPaymentReceivedCreatingPayload): Promise { if (isEmpty(paymentReceiveDTO.attachments)) { return; } @@ -67,7 +67,7 @@ export class AttachmentsOnPaymentsReceived { /** * Handles linking the attachments of the created payment. - * @param {IPaymentReceiveCreatedPayload} + * @param {IPaymentReceivedCreatedPayload} * @returns {Promise} */ private async handleAttachmentsOnPaymentCreated({ @@ -75,7 +75,7 @@ export class AttachmentsOnPaymentsReceived { paymentReceiveDTO, paymentReceive, trx, - }: IPaymentReceiveCreatedPayload): Promise { + }: IPaymentReceivedCreatedPayload): Promise { if (isEmpty(paymentReceiveDTO.attachments)) return; const keys = paymentReceiveDTO.attachments?.map( @@ -92,14 +92,14 @@ export class AttachmentsOnPaymentsReceived { /** * Handles unlinking all the unpresented keys of the edited payment. - * @param {IPaymentReceiveEditedPayload} + * @param {IPaymentReceivedEditedPayload} */ private async handleUnlinkUnpresentedKeysOnPaymentEdited({ tenantId, paymentReceiveDTO, oldPaymentReceive, trx, - }: IPaymentReceiveEditedPayload) { + }: IPaymentReceivedEditedPayload) { const keys = paymentReceiveDTO.attachments?.map( (attachment) => attachment.key ); @@ -114,7 +114,7 @@ export class AttachmentsOnPaymentsReceived { /** * Handles linking all the presented keys of the edited payment. - * @param {IPaymentReceiveEditedPayload} + * @param {IPaymentReceivedEditedPayload} * @returns {Promise} */ private async handleLinkPresentedKeysOnPaymentEdited({ @@ -122,7 +122,7 @@ export class AttachmentsOnPaymentsReceived { paymentReceiveDTO, oldPaymentReceive, trx, - }: IPaymentReceiveEditedPayload) { + }: IPaymentReceivedEditedPayload) { if (isEmpty(paymentReceiveDTO.attachments)) return; const keys = paymentReceiveDTO.attachments?.map( @@ -146,7 +146,7 @@ export class AttachmentsOnPaymentsReceived { tenantId, oldPaymentReceive, trx, - }: IPaymentReceiveDeletingPayload) { + }: IPaymentReceivedDeletingPayload) { await this.unlinkAttachmentService.unlinkAllModelKeys( tenantId, 'PaymentReceive', diff --git a/packages/server/src/services/Banking/Matching/events/ValidateMatchingOnPaymentMadeDelete.ts b/packages/server/src/services/Banking/Matching/events/ValidateMatchingOnPaymentMadeDelete.ts index c57c28729..e0f3572e8 100644 --- a/packages/server/src/services/Banking/Matching/events/ValidateMatchingOnPaymentMadeDelete.ts +++ b/packages/server/src/services/Banking/Matching/events/ValidateMatchingOnPaymentMadeDelete.ts @@ -1,7 +1,7 @@ import { Inject, Service } from 'typedi'; import { IBillPaymentEventDeletedPayload, - IPaymentReceiveDeletedPayload, + IPaymentReceivedDeletedPayload, } from '@/interfaces'; import { ValidateTransactionMatched } from '../ValidateTransactionsMatched'; import events from '@/subscribers/events'; @@ -23,7 +23,7 @@ export class ValidateMatchingOnPaymentMadeDelete { /** * Validates the payment made transaction whether matched with bank transaction on deleting. - * @param {IPaymentReceiveDeletedPayload} + * @param {IPaymentReceivedDeletedPayload} */ public async validateMatchingOnPaymentMadeDeleting({ tenantId, diff --git a/packages/server/src/services/Banking/Matching/events/ValidateMatchingOnPaymentReceivedDelete.ts b/packages/server/src/services/Banking/Matching/events/ValidateMatchingOnPaymentReceivedDelete.ts index 446f3d5f1..385f55512 100644 --- a/packages/server/src/services/Banking/Matching/events/ValidateMatchingOnPaymentReceivedDelete.ts +++ b/packages/server/src/services/Banking/Matching/events/ValidateMatchingOnPaymentReceivedDelete.ts @@ -1,5 +1,5 @@ import { Inject, Service } from 'typedi'; -import { IPaymentReceiveDeletedPayload } from '@/interfaces'; +import { IPaymentReceivedDeletedPayload } from '@/interfaces'; import { ValidateTransactionMatched } from '../ValidateTransactionsMatched'; import events from '@/subscribers/events'; @@ -20,13 +20,13 @@ export class ValidateMatchingOnPaymentReceivedDelete { /** * Validates the payment received transaction whether matched with bank transaction on deleting. - * @param {IPaymentReceiveDeletedPayload} + * @param {IPaymentReceivedDeletedPayload} */ public async validateMatchingOnPaymentReceivedDeleting({ tenantId, oldPaymentReceive, trx, - }: IPaymentReceiveDeletedPayload) { + }: IPaymentReceivedDeletedPayload) { await this.validateNoMatchingLinkedService.validateTransactionNoMatchLinking( tenantId, 'PaymentReceive', diff --git a/packages/server/src/services/Branches/Subscribers/Validators/PaymentReceiveBranchSubscriber.ts b/packages/server/src/services/Branches/Subscribers/Validators/PaymentReceiveBranchSubscriber.ts index e08b78489..8aa9b5d6e 100644 --- a/packages/server/src/services/Branches/Subscribers/Validators/PaymentReceiveBranchSubscriber.ts +++ b/packages/server/src/services/Branches/Subscribers/Validators/PaymentReceiveBranchSubscriber.ts @@ -1,8 +1,8 @@ import { Inject, Service } from 'typedi'; import events from '@/subscribers/events'; import { - IPaymentReceiveCreatingPayload, - IPaymentReceiveEditingPayload, + IPaymentReceivedCreatingPayload, + IPaymentReceivedEditingPayload, } from '@/interfaces'; import { ValidateBranchExistance } from '../../Integrations/ValidateBranchExistance'; @@ -28,12 +28,12 @@ export class PaymentReceiveBranchValidateSubscriber { /** * Validate branch existance on estimate creating. - * @param {IPaymentReceiveCreatingPayload} payload + * @param {IPaymentReceivedCreatingPayload} payload */ private validateBranchExistanceOnPaymentCreating = async ({ tenantId, paymentReceiveDTO, - }: IPaymentReceiveCreatingPayload) => { + }: IPaymentReceivedCreatingPayload) => { await this.validateBranchExistance.validateTransactionBranchWhenActive( tenantId, paymentReceiveDTO.branchId @@ -42,12 +42,12 @@ export class PaymentReceiveBranchValidateSubscriber { /** * Validate branch existance once estimate editing. - * @param {IPaymentReceiveEditingPayload} payload + * @param {IPaymentReceivedEditingPayload} payload */ private validateBranchExistanceOnPaymentEditing = async ({ paymentReceiveDTO, tenantId, - }: IPaymentReceiveEditingPayload) => { + }: IPaymentReceivedEditingPayload) => { await this.validateBranchExistance.validateTransactionBranchWhenActive( tenantId, paymentReceiveDTO.branchId diff --git a/packages/server/src/services/Sales/Estimates/SaleEstimateSmsNotify.ts b/packages/server/src/services/Sales/Estimates/SaleEstimateSmsNotify.ts index 3757b15d7..d90d11769 100644 --- a/packages/server/src/services/Sales/Estimates/SaleEstimateSmsNotify.ts +++ b/packages/server/src/services/Sales/Estimates/SaleEstimateSmsNotify.ts @@ -6,7 +6,7 @@ import SaleNotifyBySms from '../SaleNotifyBySms'; import SmsNotificationsSettingsService from '@/services/Settings/SmsNotificationsSettings'; import { ICustomer, - IPaymentReceiveSmsDetails, + IPaymentReceivedSmsDetails, ISaleEstimate, SMS_NOTIFICATION_KEY, } from '@/interfaces'; @@ -173,12 +173,12 @@ export class SaleEstimateNotifyBySms { * Retrieve the SMS details of the given payment receive transaction. * @param {number} tenantId * @param {number} saleEstimateId - * @returns {Promise} + * @returns {Promise} */ public smsDetails = async ( tenantId: number, saleEstimateId: number - ): Promise => { + ): Promise => { const { SaleEstimate } = this.tenancy.models(tenantId); // Retrieve the sale invoice or throw not found service error. diff --git a/packages/server/src/services/Sales/Estimates/SaleEstimatesApplication.ts b/packages/server/src/services/Sales/Estimates/SaleEstimatesApplication.ts index f1c7b3cdf..cce664b0e 100644 --- a/packages/server/src/services/Sales/Estimates/SaleEstimatesApplication.ts +++ b/packages/server/src/services/Sales/Estimates/SaleEstimatesApplication.ts @@ -3,7 +3,7 @@ import { CreateSaleEstimate } from './CreateSaleEstimate'; import { IFilterMeta, IPaginationMeta, - IPaymentReceiveSmsDetails, + IPaymentReceivedSmsDetails, ISaleEstimate, ISaleEstimateDTO, ISalesEstimatesFilter, @@ -191,12 +191,12 @@ export class SaleEstimatesApplication { * Retrieve the SMS details of the given payment receive transaction. * @param {number} tenantId * @param {number} saleEstimateId - * @returns {Promise} + * @returns {Promise} */ public getSaleEstimateSmsDetails = ( tenantId: number, saleEstimateId: number - ): Promise => { + ): Promise => { return this.saleEstimateNotifyBySmsService.smsDetails( tenantId, saleEstimateId diff --git a/packages/server/src/services/Sales/PaymentReceived/CreatePaymentReceived.ts b/packages/server/src/services/Sales/PaymentReceived/CreatePaymentReceived.ts index 9e57fa156..89af2dd6e 100644 --- a/packages/server/src/services/Sales/PaymentReceived/CreatePaymentReceived.ts +++ b/packages/server/src/services/Sales/PaymentReceived/CreatePaymentReceived.ts @@ -2,9 +2,9 @@ import { Inject, Service } from 'typedi'; import { Knex } from 'knex'; import { ICustomer, - IPaymentReceiveCreateDTO, - IPaymentReceiveCreatedPayload, - IPaymentReceiveCreatingPayload, + IPaymentReceivedCreateDTO, + IPaymentReceivedCreatedPayload, + IPaymentReceivedCreatingPayload, ISystemUser, } from '@/interfaces'; import { PaymentReceivedValidators } from './PaymentReceivedValidators'; @@ -37,11 +37,11 @@ export class CreatePaymentReceived { * with associated invoices payment and journal transactions. * @async * @param {number} tenantId - Tenant id. - * @param {IPaymentReceive} paymentReceive + * @param {IPaymentReceived} paymentReceive */ public async createPaymentReceived( tenantId: number, - paymentReceiveDTO: IPaymentReceiveCreateDTO, + paymentReceiveDTO: IPaymentReceivedCreateDTO, authorizedUser: ISystemUser, trx?: Knex.Transaction ) { @@ -97,7 +97,7 @@ export class CreatePaymentReceived { trx, paymentReceiveDTO, tenantId, - } as IPaymentReceiveCreatingPayload); + } as IPaymentReceivedCreatingPayload); // Inserts the payment receive transaction. const paymentReceive = await PaymentReceive.query( @@ -113,7 +113,7 @@ export class CreatePaymentReceived { paymentReceiveDTO, authorizedUser, trx, - } as IPaymentReceiveCreatedPayload); + } as IPaymentReceivedCreatedPayload); return paymentReceive; }, @@ -125,13 +125,13 @@ export class CreatePaymentReceived { * Transform the create payment receive DTO. * @param {number} tenantId * @param {ICustomer} customer - * @param {IPaymentReceiveCreateDTO} paymentReceiveDTO + * @param {IPaymentReceivedCreateDTO} paymentReceiveDTO * @returns */ private transformCreateDTOToModel = async ( tenantId: number, customer: ICustomer, - paymentReceiveDTO: IPaymentReceiveCreateDTO + paymentReceiveDTO: IPaymentReceivedCreateDTO ) => { return this.transformer.transformPaymentReceiveDTOToModel( tenantId, diff --git a/packages/server/src/services/Sales/PaymentReceived/DeletePaymentReceived.ts b/packages/server/src/services/Sales/PaymentReceived/DeletePaymentReceived.ts index 3b267617b..d1bc62590 100644 --- a/packages/server/src/services/Sales/PaymentReceived/DeletePaymentReceived.ts +++ b/packages/server/src/services/Sales/PaymentReceived/DeletePaymentReceived.ts @@ -1,8 +1,8 @@ import { Inject, Service } from 'typedi'; import { Knex } from 'knex'; import { - IPaymentReceiveDeletedPayload, - IPaymentReceiveDeletingPayload, + IPaymentReceivedDeletedPayload, + IPaymentReceivedDeletingPayload, ISystemUser, } from '@/interfaces'; import UnitOfWork from '@/services/UnitOfWork'; @@ -33,7 +33,7 @@ export class DeletePaymentReceived { * @async * @param {number} tenantId - Tenant id. * @param {Integer} paymentReceiveId - Payment receive id. - * @param {IPaymentReceive} paymentReceive - Payment receive object. + * @param {IPaymentReceived} paymentReceive - Payment receive object. */ public async deletePaymentReceive( tenantId: number, @@ -56,7 +56,7 @@ export class DeletePaymentReceived { tenantId, oldPaymentReceive, trx, - } as IPaymentReceiveDeletingPayload); + } as IPaymentReceivedDeletingPayload); // Deletes the payment receive associated entries. await PaymentReceiveEntry.query(trx) @@ -73,7 +73,7 @@ export class DeletePaymentReceived { oldPaymentReceive, authorizedUser, trx, - } as IPaymentReceiveDeletedPayload); + } as IPaymentReceivedDeletedPayload); }); } } diff --git a/packages/server/src/services/Sales/PaymentReceived/EditPaymentReceived.ts b/packages/server/src/services/Sales/PaymentReceived/EditPaymentReceived.ts index 75cd6066a..1e508c094 100644 --- a/packages/server/src/services/Sales/PaymentReceived/EditPaymentReceived.ts +++ b/packages/server/src/services/Sales/PaymentReceived/EditPaymentReceived.ts @@ -2,10 +2,10 @@ import { Inject, Service } from 'typedi'; import { Knex } from 'knex'; import { ICustomer, - IPaymentReceive, - IPaymentReceiveEditDTO, - IPaymentReceiveEditedPayload, - IPaymentReceiveEditingPayload, + IPaymentReceived, + IPaymentReceivedEditDTO, + IPaymentReceivedEditedPayload, + IPaymentReceivedEditingPayload, ISystemUser, } from '@/interfaces'; import { PaymentReceiveDTOTransformer } from './PaymentReceivedDTOTransformer'; @@ -46,12 +46,12 @@ export class EditPaymentReceived { * @async * @param {number} tenantId - * @param {Integer} paymentReceiveId - - * @param {IPaymentReceive} paymentReceive - + * @param {IPaymentReceived} paymentReceive - */ public async editPaymentReceive( tenantId: number, paymentReceiveId: number, - paymentReceiveDTO: IPaymentReceiveEditDTO, + paymentReceiveDTO: IPaymentReceivedEditDTO, authorizedUser: ISystemUser ) { const { PaymentReceive, Contact } = this.tenancy.models(tenantId); @@ -131,7 +131,7 @@ export class EditPaymentReceived { tenantId, oldPaymentReceive, paymentReceiveDTO, - } as IPaymentReceiveEditingPayload); + } as IPaymentReceivedEditingPayload); // Update the payment receive transaction. const paymentReceive = await PaymentReceive.query( @@ -149,7 +149,7 @@ export class EditPaymentReceived { paymentReceiveDTO, authorizedUser, trx, - } as IPaymentReceiveEditedPayload); + } as IPaymentReceivedEditedPayload); return paymentReceive; }); @@ -159,15 +159,15 @@ export class EditPaymentReceived { * Transform the edit payment receive DTO. * @param {number} tenantId * @param {ICustomer} customer - * @param {IPaymentReceiveEditDTO} paymentReceiveDTO - * @param {IPaymentReceive} oldPaymentReceive + * @param {IPaymentReceivedEditDTO} paymentReceiveDTO + * @param {IPaymentReceived} oldPaymentReceive * @returns */ private transformEditDTOToModel = async ( tenantId: number, customer: ICustomer, - paymentReceiveDTO: IPaymentReceiveEditDTO, - oldPaymentReceive: IPaymentReceive + paymentReceiveDTO: IPaymentReceivedEditDTO, + oldPaymentReceive: IPaymentReceived ) => { return this.transformer.transformPaymentReceiveDTOToModel( tenantId, diff --git a/packages/server/src/services/Sales/PaymentReceived/GetPaymentReceived.ts b/packages/server/src/services/Sales/PaymentReceived/GetPaymentReceived.ts index 7a98e1d50..36ba5c06b 100644 --- a/packages/server/src/services/Sales/PaymentReceived/GetPaymentReceived.ts +++ b/packages/server/src/services/Sales/PaymentReceived/GetPaymentReceived.ts @@ -1,5 +1,5 @@ import { ServiceError } from '@/exceptions'; -import { IPaymentReceive } from '@/interfaces'; +import { IPaymentReceived } from '@/interfaces'; import HasTenancyService from '@/services/Tenancy/TenancyService'; import { Inject, Service } from 'typedi'; import { ERRORS } from './constants'; @@ -18,12 +18,12 @@ export class GetPaymentReceived { * Retrieve payment receive details. * @param {number} tenantId - Tenant id. * @param {number} paymentReceiveId - Payment receive id. - * @return {Promise} + * @return {Promise} */ public async getPaymentReceive( tenantId: number, paymentReceiveId: number - ): Promise { + ): Promise { const { PaymentReceive } = this.tenancy.models(tenantId); const paymentReceive = await PaymentReceive.query() diff --git a/packages/server/src/services/Sales/PaymentReceived/GetPaymentReceivedPdf.ts b/packages/server/src/services/Sales/PaymentReceived/GetPaymentReceivedPdf.ts index d330d91db..0a357e5ea 100644 --- a/packages/server/src/services/Sales/PaymentReceived/GetPaymentReceivedPdf.ts +++ b/packages/server/src/services/Sales/PaymentReceived/GetPaymentReceivedPdf.ts @@ -4,7 +4,7 @@ import { TemplateInjectable } from '@/services/TemplateInjectable/TemplateInject import { GetPaymentReceived } from './GetPaymentReceived'; @Service() -export default class GetPaymentReceivePdf { +export default class GetPaymentReceivedPdf { @Inject() private chromiumlyTenancy: ChromiumlyTenancy; @@ -17,7 +17,7 @@ export default class GetPaymentReceivePdf { /** * Retrieve sale invoice pdf content. * @param {number} tenantId - - * @param {IPaymentReceive} paymentReceive - + * @param {IPaymentReceived} paymentReceive - * @returns {Promise} */ async getPaymentReceivePdf( diff --git a/packages/server/src/services/Sales/PaymentReceived/GetPaymentsReceived.ts b/packages/server/src/services/Sales/PaymentReceived/GetPaymentsReceived.ts index 44f9c8c6b..4ff97f7ed 100644 --- a/packages/server/src/services/Sales/PaymentReceived/GetPaymentsReceived.ts +++ b/packages/server/src/services/Sales/PaymentReceived/GetPaymentsReceived.ts @@ -3,8 +3,8 @@ import * as R from 'ramda'; import { IFilterMeta, IPaginationMeta, - IPaymentReceive, - IPaymentReceivesFilter, + IPaymentReceived, + IPaymentsReceivedFilter, } from '@/interfaces'; import { PaymentReceiveTransfromer } from './PaymentReceivedTransformer'; import HasTenancyService from '@/services/Tenancy/TenancyService'; @@ -25,13 +25,13 @@ export class GetPaymentReceives { /** * Retrieve payment receives paginated and filterable list. * @param {number} tenantId - * @param {IPaymentReceivesFilter} paymentReceivesFilter + * @param {IPaymentsReceivedFilter} paymentReceivesFilter */ public async getPaymentReceives( tenantId: number, - filterDTO: IPaymentReceivesFilter + filterDTO: IPaymentsReceivedFilter ): Promise<{ - paymentReceives: IPaymentReceive[]; + paymentReceives: IPaymentReceived[]; pagination: IPaginationMeta; filterMeta: IFilterMeta; }> { diff --git a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedApplication.ts b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedApplication.ts index 8024bf790..27e92f69e 100644 --- a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedApplication.ts +++ b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedApplication.ts @@ -1,11 +1,11 @@ import { IFilterMeta, IPaginationMeta, - IPaymentReceive, - IPaymentReceiveCreateDTO, - IPaymentReceiveEditDTO, - IPaymentReceiveSmsDetails, - IPaymentReceivesFilter, + IPaymentReceived, + IPaymentReceivedCreateDTO, + IPaymentReceivedEditDTO, + IPaymentReceivedSmsDetails, + IPaymentsReceivedFilter, ISystemUser, PaymentReceiveMailOptsDTO, } from '@/interfaces'; @@ -17,7 +17,7 @@ import { GetPaymentReceives } from './GetPaymentsReceived'; import { GetPaymentReceived } from './GetPaymentReceived'; import { GetPaymentReceivedInvoices } from './GetPaymentReceivedInvoices'; import { PaymentReceiveNotifyBySms } from './PaymentReceivedSmsNotify'; -import GetPaymentReceivePdf from './GetPaymentReceivedPdf'; +import GetPaymentReceivedPdf from './GetPaymentReceivedPdf'; import { SendPaymentReceiveMailNotification } from './PaymentReceivedMailNotification'; @Service() @@ -47,18 +47,18 @@ export class PaymentReceivesApplication { private paymentMailNotify: SendPaymentReceiveMailNotification; @Inject() - private getPaymentReceivePdfService: GetPaymentReceivePdf; + private getPaymentReceivePdfService: GetPaymentReceivedPdf; /** * Creates a new payment receive. * @param {number} tenantId - * @param {IPaymentReceiveCreateDTO} paymentReceiveDTO + * @param {IPaymentReceivedCreateDTO} paymentReceiveDTO * @param {ISystemUser} authorizedUser * @returns */ public createPaymentReceived( tenantId: number, - paymentReceiveDTO: IPaymentReceiveCreateDTO, + paymentReceiveDTO: IPaymentReceivedCreateDTO, authorizedUser: ISystemUser ) { return this.createPaymentReceivedService.createPaymentReceived( @@ -72,14 +72,14 @@ export class PaymentReceivesApplication { * Edit details the given payment receive with associated entries. * @param {number} tenantId * @param {number} paymentReceiveId - * @param {IPaymentReceiveEditDTO} paymentReceiveDTO + * @param {IPaymentReceivedEditDTO} paymentReceiveDTO * @param {ISystemUser} authorizedUser * @returns */ public editPaymentReceive( tenantId: number, paymentReceiveId: number, - paymentReceiveDTO: IPaymentReceiveEditDTO, + paymentReceiveDTO: IPaymentReceivedEditDTO, authorizedUser: ISystemUser ) { return this.editPaymentReceivedService.editPaymentReceive( @@ -112,14 +112,14 @@ export class PaymentReceivesApplication { /** * Retrieve payment receives paginated and filterable. * @param {number} tenantId - * @param {IPaymentReceivesFilter} filterDTO + * @param {IPaymentsReceivedFilter} filterDTO * @returns */ public async getPaymentReceives( tenantId: number, - filterDTO: IPaymentReceivesFilter + filterDTO: IPaymentsReceivedFilter ): Promise<{ - paymentReceives: IPaymentReceive[]; + paymentReceives: IPaymentReceived[]; pagination: IPaginationMeta; filterMeta: IFilterMeta; }> { @@ -133,12 +133,12 @@ export class PaymentReceivesApplication { * Retrieves the given payment receive. * @param {number} tenantId * @param {number} paymentReceiveId - * @returns {Promise} + * @returns {Promise} */ public async getPaymentReceive( tenantId: number, paymentReceiveId: number - ): Promise { + ): Promise { return this.getPaymentReceivedService.getPaymentReceive( tenantId, paymentReceiveId @@ -175,7 +175,7 @@ export class PaymentReceivesApplication { public getPaymentSmsDetails = async ( tenantId: number, paymentReceiveId: number - ): Promise => { + ): Promise => { return this.paymentSmsNotify.smsDetails(tenantId, paymentReceiveId); }; diff --git a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedDTOTransformer.ts b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedDTOTransformer.ts index ad7173465..e9eed9110 100644 --- a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedDTOTransformer.ts +++ b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedDTOTransformer.ts @@ -3,9 +3,9 @@ import { Inject, Service } from 'typedi'; import { omit, sumBy } from 'lodash'; import { ICustomer, - IPaymentReceive, - IPaymentReceiveCreateDTO, - IPaymentReceiveEditDTO, + IPaymentReceived, + IPaymentReceivedCreateDTO, + IPaymentReceivedEditDTO, } from '@/interfaces'; import { PaymentReceivedValidators } from './PaymentReceivedValidators'; import { PaymentReceivedIncrement } from './PaymentReceivedIncrement'; @@ -26,16 +26,16 @@ export class PaymentReceiveDTOTransformer { /** * Transformes the create payment receive DTO to model object. * @param {number} tenantId - * @param {IPaymentReceiveCreateDTO|IPaymentReceiveEditDTO} paymentReceiveDTO - Payment receive DTO. - * @param {IPaymentReceive} oldPaymentReceive - - * @return {IPaymentReceive} + * @param {IPaymentReceivedCreateDTO|IPaymentReceivedEditDTO} paymentReceiveDTO - Payment receive DTO. + * @param {IPaymentReceived} oldPaymentReceive - + * @return {IPaymentReceived} */ public async transformPaymentReceiveDTOToModel( tenantId: number, customer: ICustomer, - paymentReceiveDTO: IPaymentReceiveCreateDTO | IPaymentReceiveEditDTO, - oldPaymentReceive?: IPaymentReceive - ): Promise { + paymentReceiveDTO: IPaymentReceivedCreateDTO | IPaymentReceivedEditDTO, + oldPaymentReceive?: IPaymentReceived + ): Promise { const amount = paymentReceiveDTO.amount ?? sumBy(paymentReceiveDTO.entries, 'paymentAmount'); @@ -65,7 +65,7 @@ export class PaymentReceiveDTOTransformer { })), }; return R.compose( - this.branchDTOTransform.transformDTO(tenantId) + this.branchDTOTransform.transformDTO(tenantId) )(initialDTO); } } diff --git a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedGLEntries.ts b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedGLEntries.ts index 8ba8c2935..8c30c10f4 100644 --- a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedGLEntries.ts +++ b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedGLEntries.ts @@ -4,7 +4,7 @@ import { Knex } from 'knex'; import Ledger from '@/services/Accounting/Ledger'; import TenancyService from '@/services/Tenancy/TenancyService'; import { - IPaymentReceive, + IPaymentReceived, ILedgerEntry, AccountNormal, IPaymentReceiveGLCommonEntry, @@ -93,14 +93,14 @@ export class PaymentReceivedGLEntries { /** * Retrieves the payment receive general ledger. * @param {number} tenantId - - * @param {IPaymentReceive} paymentReceive - + * @param {IPaymentReceived} paymentReceive - * @param {string} baseCurrencyCode - * @param {Knex.Transaction} trx - * @returns {Ledger} */ public getPaymentReceiveGLedger = async ( tenantId: number, - paymentReceive: IPaymentReceive, + paymentReceive: IPaymentReceived, baseCurrencyCode: string, trx?: Knex.Transaction ): Promise => { @@ -132,7 +132,7 @@ export class PaymentReceivedGLEntries { * @returns {number} */ private getPaymentExGainOrLoss = ( - paymentReceive: IPaymentReceive + paymentReceive: IPaymentReceived ): number => { return sumBy(paymentReceive.entries, (entry) => { const paymentLocalAmount = @@ -145,11 +145,11 @@ export class PaymentReceivedGLEntries { /** * Retrieves the common entry of payment receive. - * @param {IPaymentReceive} paymentReceive + * @param {IPaymentReceived} paymentReceive * @returns {} */ private getPaymentReceiveCommonEntry = ( - paymentReceive: IPaymentReceive + paymentReceive: IPaymentReceived ): IPaymentReceiveGLCommonEntry => { return { debit: 0, @@ -174,14 +174,14 @@ export class PaymentReceivedGLEntries { /** * Retrieves the payment exchange gain/loss entry. - * @param {IPaymentReceive} paymentReceive - + * @param {IPaymentReceived} paymentReceive - * @param {number} ARAccountId - * @param {number} exchangeGainOrLossAccountId - * @param {string} baseCurrencyCode - * @returns {ILedgerEntry[]} */ private getPaymentExchangeGainLossEntry = ( - paymentReceive: IPaymentReceive, + paymentReceive: IPaymentReceived, ARAccountId: number, exchangeGainOrLossAccountId: number, baseCurrencyCode: string @@ -219,11 +219,11 @@ export class PaymentReceivedGLEntries { /** * Retrieves the payment deposit GL entry. - * @param {IPaymentReceive} paymentReceive + * @param {IPaymentReceived} paymentReceive * @returns {ILedgerEntry} */ private getPaymentDepositGLEntry = ( - paymentReceive: IPaymentReceive + paymentReceive: IPaymentReceived ): ILedgerEntry => { const commonJournal = this.getPaymentReceiveCommonEntry(paymentReceive); @@ -238,12 +238,12 @@ export class PaymentReceivedGLEntries { /** * Retrieves the payment receivable entry. - * @param {IPaymentReceive} paymentReceive + * @param {IPaymentReceived} paymentReceive * @param {number} ARAccountId * @returns {ILedgerEntry} */ private getPaymentReceivableEntry = ( - paymentReceive: IPaymentReceive, + paymentReceive: IPaymentReceived, ARAccountId: number ): ILedgerEntry => { const commonJournal = this.getPaymentReceiveCommonEntry(paymentReceive); @@ -267,14 +267,14 @@ export class PaymentReceivedGLEntries { * - Payment account [current asset] -> Credit * * @param {number} tenantId - * @param {IPaymentReceive} paymentRecieve - Payment receive model. + * @param {IPaymentReceived} paymentRecieve - Payment receive model. * @param {number} ARAccountId - A/R account id. * @param {number} exGainOrLossAccountId - Exchange gain/loss account id. * @param {string} baseCurrency - Base currency code. * @returns {Promise} */ public getPaymentReceiveGLEntries = ( - paymentReceive: IPaymentReceive, + paymentReceive: IPaymentReceived, ARAccountId: number, exGainOrLossAccountId: number, baseCurrency: string diff --git a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedInvoiceSync.ts b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedInvoiceSync.ts index 5b3b28311..4cc51e60c 100644 --- a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedInvoiceSync.ts +++ b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedInvoiceSync.ts @@ -1,6 +1,6 @@ import { Inject, Service } from 'typedi'; import { Knex } from 'knex'; -import { IPaymentReceiveEntryDTO } from '@/interfaces'; +import { IPaymentReceivedEntryDTO } from '@/interfaces'; import HasTenancyService from '@/services/Tenancy/TenancyService'; import { entriesAmountDiff } from '@/utils'; @@ -19,8 +19,8 @@ export class PaymentReceivedInvoiceSync { */ public async saveChangeInvoicePaymentAmount( tenantId: number, - newPaymentReceiveEntries: IPaymentReceiveEntryDTO[], - oldPaymentReceiveEntries?: IPaymentReceiveEntryDTO[], + newPaymentReceiveEntries: IPaymentReceivedEntryDTO[], + oldPaymentReceiveEntries?: IPaymentReceivedEntryDTO[], trx?: Knex.Transaction ): Promise { const { SaleInvoice } = this.tenancy.models(tenantId); diff --git a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedSmsNotify.ts b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedSmsNotify.ts index a9315a960..961bec572 100644 --- a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedSmsNotify.ts +++ b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedSmsNotify.ts @@ -2,10 +2,10 @@ import { Service, Inject } from 'typedi'; import HasTenancyService from '@/services/Tenancy/TenancyService'; import events from '@/subscribers/events'; import { - IPaymentReceiveSmsDetails, + IPaymentReceivedSmsDetails, SMS_NOTIFICATION_KEY, - IPaymentReceive, - IPaymentReceiveEntry, + IPaymentReceived, + IPaymentReceivedEntry, } from '@/interfaces'; import SmsNotificationsSettingsService from '@/services/Settings/SmsNotificationsSettings'; import { formatNumber, formatSmsMessage } from 'utils'; @@ -71,12 +71,12 @@ export class PaymentReceiveNotifyBySms { /** * Sends the payment details sms notification of the given customer. * @param {number} tenantId - * @param {IPaymentReceive} paymentReceive + * @param {IPaymentReceived} paymentReceive * @param {ICustomer} customer */ private sendSmsNotification = async ( tenantId: number, - paymentReceive: IPaymentReceive + paymentReceive: IPaymentReceived ) => { const smsClient = this.tenancy.smsClient(tenantId); const tenantMetadata = await TenantMetadata.query().findOne({ tenantId }); @@ -116,12 +116,12 @@ export class PaymentReceiveNotifyBySms { /** * Formates the payment receive details sms message. * @param {number} tenantId - - * @param {IPaymentReceive} payment - + * @param {IPaymentReceived} payment - * @param {ICustomer} customer - */ private formattedPaymentDetailsMessage = ( tenantId: number, - payment: IPaymentReceive, + payment: IPaymentReceived, tenantMetadata: TenantMetadata ) => { const notification = this.smsNotificationsSettings.getSmsNotificationMeta( @@ -138,14 +138,14 @@ export class PaymentReceiveNotifyBySms { /** * Formattes the payment details sms notification messafge. * @param {string} smsMessage - * @param {IPaymentReceive} payment + * @param {IPaymentReceived} payment * @param {ICustomer} customer * @param {TenantMetadata} tenantMetadata * @returns {string} */ private formatPaymentDetailsMessage = ( smsMessage: string, - payment: IPaymentReceive, + payment: IPaymentReceived, tenantMetadata: any ): string => { const invoiceNumbers = this.stringifyPaymentInvoicesNumber(payment); @@ -167,12 +167,12 @@ export class PaymentReceiveNotifyBySms { /** * Stringify payment receive invoices to numbers as string. - * @param {IPaymentReceive} payment + * @param {IPaymentReceived} payment * @returns {string} */ - private stringifyPaymentInvoicesNumber(payment: IPaymentReceive) { + private stringifyPaymentInvoicesNumber(payment: IPaymentReceived) { const invoicesNumberes = payment.entries.map( - (entry: IPaymentReceiveEntry) => entry.invoice.invoiceNo + (entry: IPaymentReceivedEntry) => entry.invoice.invoiceNo ); return invoicesNumberes.join(', '); } @@ -185,7 +185,7 @@ export class PaymentReceiveNotifyBySms { public smsDetails = async ( tenantId: number, paymentReceiveid: number - ): Promise => { + ): Promise => { const { PaymentReceive } = this.tenancy.models(tenantId); // Retrieve the payment receive or throw not found service error. diff --git a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedTransformer.ts b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedTransformer.ts index f6f864dfc..2ab49dfe7 100644 --- a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedTransformer.ts +++ b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedTransformer.ts @@ -1,4 +1,4 @@ -import { IPaymentReceive, IPaymentReceiveEntry } from '@/interfaces'; +import { IPaymentReceived, IPaymentReceivedEntry } from '@/interfaces'; import { Transformer } from '@/lib/Transformer/Transformer'; import { formatNumber } from 'utils'; import { PaymentReceivedEntryTransfromer } from './PaymentReceivedEntryTransformer'; @@ -24,25 +24,25 @@ export class PaymentReceiveTransfromer extends Transformer { * @param {ISaleInvoice} invoice * @returns {String} */ - protected formattedPaymentDate = (payment: IPaymentReceive): string => { + protected formattedPaymentDate = (payment: IPaymentReceived): string => { return this.formatDate(payment.paymentDate); }; /** * Retrieves the formatted created at date. - * @param {IPaymentReceive} payment + * @param {IPaymentReceived} payment * @returns {string} */ - protected formattedCreatedAt = (payment: IPaymentReceive): string => { + protected formattedCreatedAt = (payment: IPaymentReceived): string => { return this.formatDate(payment.createdAt); }; /** * Retrieve the formatted payment subtotal. - * @param {IPaymentReceive} payment + * @param {IPaymentReceived} payment * @returns {string} */ - protected subtotalFormatted = (payment: IPaymentReceive): string => { + protected subtotalFormatted = (payment: IPaymentReceived): string => { return formatNumber(payment.amount, { currencyCode: payment.currencyCode, money: false, @@ -54,25 +54,25 @@ export class PaymentReceiveTransfromer extends Transformer { * @param {ISaleInvoice} invoice * @returns {string} */ - protected formattedAmount = (payment: IPaymentReceive): string => { + protected formattedAmount = (payment: IPaymentReceived): string => { return formatNumber(payment.amount, { currencyCode: payment.currencyCode }); }; /** * Retrieve the formatted exchange rate. - * @param {IPaymentReceive} payment + * @param {IPaymentReceived} payment * @returns {string} */ - protected formattedExchangeRate = (payment: IPaymentReceive): string => { + protected formattedExchangeRate = (payment: IPaymentReceived): string => { return formatNumber(payment.exchangeRate, { money: false }); }; /** * Retrieves the payment entries. - * @param {IPaymentReceive} payment - * @returns {IPaymentReceiveEntry[]} + * @param {IPaymentReceived} payment + * @returns {IPaymentReceivedEntry[]} */ - protected entries = (payment: IPaymentReceive): IPaymentReceiveEntry[] => { + protected entries = (payment: IPaymentReceived): IPaymentReceivedEntry[] => { return this.item(payment.entries, new PaymentReceivedEntryTransfromer()); }; } diff --git a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedValidators.ts b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedValidators.ts index 34dc649a2..4adbe8f6d 100644 --- a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedValidators.ts +++ b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedValidators.ts @@ -2,10 +2,10 @@ import { Inject, Service } from 'typedi'; import { difference, sumBy } from 'lodash'; import { IAccount, - IPaymentReceive, - IPaymentReceiveEditDTO, - IPaymentReceiveEntry, - IPaymentReceiveEntryDTO, + IPaymentReceived, + IPaymentReceivedEditDTO, + IPaymentReceivedEntry, + IPaymentReceivedEntryDTO, ISaleInvoice, } from '@/interfaces'; import { ServiceError } from '@/exceptions'; @@ -58,7 +58,7 @@ export class PaymentReceivedValidators { * Validates the invoices IDs existance. * @param {number} tenantId - * @param {number} customerId - - * @param {IPaymentReceiveEntryDTO[]} paymentReceiveEntries - + * @param {IPaymentReceivedEntryDTO[]} paymentReceiveEntries - */ public async validateInvoicesIDsExistance( tenantId: number, @@ -100,12 +100,12 @@ export class PaymentReceivedValidators { */ public async validateInvoicesPaymentsAmount( tenantId: number, - paymentReceiveEntries: IPaymentReceiveEntryDTO[], - oldPaymentEntries: IPaymentReceiveEntry[] = [] + paymentReceiveEntries: IPaymentReceivedEntryDTO[], + oldPaymentEntries: IPaymentReceivedEntry[] = [] ) { const { SaleInvoice } = this.tenancy.models(tenantId); const invoicesIds = paymentReceiveEntries.map( - (e: IPaymentReceiveEntryDTO) => e.invoiceId + (e: IPaymentReceivedEntryDTO) => e.invoiceId ); const storedInvoices = await SaleInvoice.query().whereIn('id', invoicesIds); @@ -124,7 +124,7 @@ export class PaymentReceivedValidators { const hasWrongPaymentAmount: any[] = []; paymentReceiveEntries.forEach( - (entry: IPaymentReceiveEntryDTO, index: number) => { + (entry: IPaymentReceivedEntryDTO, index: number) => { const entryInvoice = storedInvoicesMap.get(entry.invoiceId); const { dueAmount } = entryInvoice; @@ -140,9 +140,9 @@ export class PaymentReceivedValidators { /** * Validate the payment receive number require. - * @param {IPaymentReceive} paymentReceiveObj + * @param {IPaymentReceived} paymentReceiveObj */ - public validatePaymentReceiveNoRequire(paymentReceiveObj: IPaymentReceive) { + public validatePaymentReceiveNoRequire(paymentReceiveObj: IPaymentReceived) { if (!paymentReceiveObj.paymentReceiveNo) { throw new ServiceError(ERRORS.PAYMENT_RECEIVE_NO_IS_REQUIRED); } @@ -152,12 +152,12 @@ export class PaymentReceivedValidators { * Validate the payment receive entries IDs existance. * @param {number} tenantId * @param {number} paymentReceiveId - * @param {IPaymentReceiveEntryDTO[]} paymentReceiveEntries + * @param {IPaymentReceivedEntryDTO[]} paymentReceiveEntries */ public async validateEntriesIdsExistance( tenantId: number, paymentReceiveId: number, - paymentReceiveEntries: IPaymentReceiveEntryDTO[] + paymentReceiveEntries: IPaymentReceivedEntryDTO[] ) { const { PaymentReceiveEntry } = this.tenancy.models(tenantId); @@ -189,12 +189,12 @@ export class PaymentReceivedValidators { /** * Validate the payment customer whether modified. - * @param {IPaymentReceiveEditDTO} paymentReceiveDTO - * @param {IPaymentReceive} oldPaymentReceive + * @param {IPaymentReceivedEditDTO} paymentReceiveDTO + * @param {IPaymentReceived} oldPaymentReceive */ public validateCustomerNotModified( - paymentReceiveDTO: IPaymentReceiveEditDTO, - oldPaymentReceive: IPaymentReceive + paymentReceiveDTO: IPaymentReceivedEditDTO, + oldPaymentReceive: IPaymentReceived ) { if (paymentReceiveDTO.customerId !== oldPaymentReceive.customerId) { throw new ServiceError(ERRORS.PAYMENT_CUSTOMER_SHOULD_NOT_UPDATE); @@ -230,7 +230,7 @@ export class PaymentReceivedValidators { async getPaymentReceiveOrThrowError( tenantId: number, paymentReceiveId: number - ): Promise { + ): Promise { const { PaymentReceive } = this.tenancy.models(tenantId); const paymentReceive = await PaymentReceive.query() .withGraphFetched('entries') diff --git a/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedExportable.ts b/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedExportable.ts index 59c0f7b08..0a2b62e33 100644 --- a/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedExportable.ts +++ b/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedExportable.ts @@ -1,5 +1,5 @@ import { Inject, Service } from 'typedi'; -import { IAccountsStructureType, IPaymentReceivesFilter } from '@/interfaces'; +import { IAccountsStructureType, IPaymentsReceivedFilter } from '@/interfaces'; import { Exportable } from '@/services/Export/Exportable'; import { PaymentReceivesApplication } from './PaymentReceivedApplication'; @@ -11,17 +11,17 @@ export class PaymentsReceivedExportable extends Exportable { /** * Retrieves the accounts data to exportable sheet. * @param {number} tenantId - * @param {IPaymentReceivesFilter} query - + * @param {IPaymentsReceivedFilter} query - * @returns */ - public exportable(tenantId: number, query: IPaymentReceivesFilter) { + public exportable(tenantId: number, query: IPaymentsReceivedFilter) { const parsedQuery = { sortOrder: 'desc', columnSortBy: 'created_at', inactiveMode: false, ...query, structure: IAccountsStructureType.Flat, - } as IPaymentReceivesFilter; + } as IPaymentsReceivedFilter; return this.paymentReceivedApp .getPaymentReceives(tenantId, parsedQuery) diff --git a/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedImportable.ts b/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedImportable.ts index 1b970b5d9..eeefd6ca0 100644 --- a/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedImportable.ts +++ b/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedImportable.ts @@ -1,6 +1,6 @@ import { Inject, Service } from 'typedi'; import { Knex } from 'knex'; -import { IPaymentReceiveCreateDTO } from '@/interfaces'; +import { IPaymentReceivedCreateDTO } from '@/interfaces'; import { Importable } from '@/services/Import/Importable'; import { CreatePaymentReceived } from './CreatePaymentReceived'; import { PaymentsReceiveSampleData } from './constants'; @@ -18,7 +18,7 @@ export class PaymentsReceivedImportable extends Importable { */ public importable( tenantId: number, - createPaymentDTO: IPaymentReceiveCreateDTO, + createPaymentDTO: IPaymentReceivedCreateDTO, trx?: Knex.Transaction ) { return this.createPaymentReceiveService.createPaymentReceived( diff --git a/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedPages.ts b/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedPages.ts index 7ee7ccf51..6fd52882f 100644 --- a/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedPages.ts +++ b/packages/server/src/services/Sales/PaymentReceived/PaymentsReceivedPages.ts @@ -3,7 +3,7 @@ import { omit } from 'lodash'; import { ISaleInvoice, IPaymentReceivePageEntry, - IPaymentReceive, + IPaymentReceived, ISystemUser, } from '@/interfaces'; import TenancyService from '@/services/Tenancy/TenancyService'; @@ -65,7 +65,7 @@ export default class PaymentsReceivedPages { tenantId: number, paymentReceiveId: number ): Promise<{ - paymentReceive: Omit; + paymentReceive: Omit; entries: IPaymentReceivePageEntry[]; }> { const { PaymentReceive, SaleInvoice } = this.tenancy.models(tenantId); diff --git a/packages/server/src/services/TransactionsLocking/SalesTransactionLockingGuardSubscriber.ts b/packages/server/src/services/TransactionsLocking/SalesTransactionLockingGuardSubscriber.ts index a2e55fc21..9b80bca26 100644 --- a/packages/server/src/services/TransactionsLocking/SalesTransactionLockingGuardSubscriber.ts +++ b/packages/server/src/services/TransactionsLocking/SalesTransactionLockingGuardSubscriber.ts @@ -5,9 +5,9 @@ import { ISaleInvoiceCreatingPaylaod, ISaleReceiptDeletingPayload, ICreditNoteDeletingPayload, - IPaymentReceiveCreatingPayload, + IPaymentReceivedCreatingPayload, IRefundCreditNoteDeletingPayload, - IPaymentReceiveDeletingPayload, + IPaymentReceivedDeletingPayload, ISaleEstimateDeletingPayload, ISaleEstimateCreatingPayload, ISaleEstimateEditingPayload, @@ -17,7 +17,7 @@ import { ISaleInvoiceWrittenOffCancelPayload, ICreditNoteEditingPayload, ISaleReceiptEditingPayload, - IPaymentReceiveEditingPayload, + IPaymentReceivedEditingPayload, ISaleReceiptEventClosingPayload, ICreditNoteCreatingPayload, } from '@/interfaces'; @@ -454,13 +454,13 @@ export default class SalesTransactionLockingGuardSubscriber { /** * Transaction locking guard on payment receive editing. - * @param {IPaymentReceiveEditingPayload} + * @param {IPaymentReceivedEditingPayload} */ private transactionLockingGuardOnPaymentEditing = async ({ tenantId, oldPaymentReceive, paymentReceiveDTO, - }: IPaymentReceiveEditingPayload) => { + }: IPaymentReceivedEditingPayload) => { // Validate the old payment date. await this.salesLockingGuard.transactionLockingGuard( tenantId, @@ -475,12 +475,12 @@ export default class SalesTransactionLockingGuardSubscriber { /** * Transaction locking guard on payment creating. - * @param {IPaymentReceiveCreatingPayload} + * @param {IPaymentReceivedCreatingPayload} */ private transactionLockingGuardOnPaymentCreating = async ({ tenantId, paymentReceiveDTO, - }: IPaymentReceiveCreatingPayload) => { + }: IPaymentReceivedCreatingPayload) => { await this.salesLockingGuard.transactionLockingGuard( tenantId, paymentReceiveDTO.paymentDate @@ -489,12 +489,12 @@ export default class SalesTransactionLockingGuardSubscriber { /** * Transaction locking guard on payment deleting. - * @param {IPaymentReceiveDeletingPayload} payload - + * @param {IPaymentReceivedDeletingPayload} payload - */ private transactionLockingGuardPaymentDeleting = async ({ oldPaymentReceive, tenantId, - }: IPaymentReceiveDeletingPayload) => { + }: IPaymentReceivedDeletingPayload) => { await this.salesLockingGuard.transactionLockingGuard( tenantId, oldPaymentReceive.paymentDate diff --git a/packages/server/src/subscribers/PaymentReceive/AutoSerialIncrement.ts b/packages/server/src/subscribers/PaymentReceive/AutoSerialIncrement.ts index 17c74b840..89f60a9e6 100644 --- a/packages/server/src/subscribers/PaymentReceive/AutoSerialIncrement.ts +++ b/packages/server/src/subscribers/PaymentReceive/AutoSerialIncrement.ts @@ -2,7 +2,7 @@ import { Service, Inject } from 'typedi'; import events from '@/subscribers/events'; import { EventSubscriber } from '@/lib/EventPublisher/EventPublisher'; import { PaymentReceivedIncrement } from '@/services/Sales/PaymentReceived/PaymentReceivedIncrement'; -import { IPaymentReceiveCreatedPayload } from '@/interfaces'; +import { IPaymentReceivedCreatedPayload } from '@/interfaces'; @Service() export default class PaymentReceiveAutoSerialSubscriber extends EventSubscriber { @@ -22,13 +22,13 @@ export default class PaymentReceiveAutoSerialSubscriber extends EventSubscriber /** * Handles increment next number of payment receive once be created. - * @param {IPaymentReceiveCreatedPayload} payload - + * @param {IPaymentReceivedCreatedPayload} payload - */ private handlePaymentNextNumberIncrement = async ({ tenantId, paymentReceiveId, trx, - }: IPaymentReceiveCreatedPayload) => { + }: IPaymentReceivedCreatedPayload) => { await this.paymentIncrement.incrementNextPaymentReceiveNumber(tenantId); }; } diff --git a/packages/server/src/subscribers/PaymentReceive/PaymentReceiveSyncInvoices.ts b/packages/server/src/subscribers/PaymentReceive/PaymentReceiveSyncInvoices.ts index d5ecaca3f..643ca94d4 100644 --- a/packages/server/src/subscribers/PaymentReceive/PaymentReceiveSyncInvoices.ts +++ b/packages/server/src/subscribers/PaymentReceive/PaymentReceiveSyncInvoices.ts @@ -2,9 +2,9 @@ import { Inject, Service } from 'typedi'; import events from '@/subscribers/events'; import { PaymentReceivedInvoiceSync } from '@/services/Sales/PaymentReceived/PaymentReceivedInvoiceSync'; import { - IPaymentReceiveCreatedPayload, - IPaymentReceiveDeletedPayload, - IPaymentReceiveEditedPayload, + IPaymentReceivedCreatedPayload, + IPaymentReceivedDeletedPayload, + IPaymentReceivedEditedPayload, } from '@/interfaces'; @Service() @@ -39,7 +39,7 @@ export default class PaymentReceiveSyncInvoicesSubscriber { tenantId, paymentReceive, trx, - }: IPaymentReceiveCreatedPayload) => { + }: IPaymentReceivedCreatedPayload) => { await this.paymentSyncInvoice.saveChangeInvoicePaymentAmount( tenantId, paymentReceive.entries, @@ -57,7 +57,7 @@ export default class PaymentReceiveSyncInvoicesSubscriber { paymentReceive, oldPaymentReceive, trx, - }: IPaymentReceiveEditedPayload) => { + }: IPaymentReceivedEditedPayload) => { await this.paymentSyncInvoice.saveChangeInvoicePaymentAmount( tenantId, paymentReceive.entries, @@ -74,7 +74,7 @@ export default class PaymentReceiveSyncInvoicesSubscriber { paymentReceiveId, oldPaymentReceive, trx, - }: IPaymentReceiveDeletedPayload) => { + }: IPaymentReceivedDeletedPayload) => { await this.paymentSyncInvoice.saveChangeInvoicePaymentAmount( tenantId, oldPaymentReceive.entries.map((entry) => ({ diff --git a/packages/server/src/subscribers/PaymentReceive/SendSmsNotificationToCustomer.ts b/packages/server/src/subscribers/PaymentReceive/SendSmsNotificationToCustomer.ts index 873a101d3..840698831 100644 --- a/packages/server/src/subscribers/PaymentReceive/SendSmsNotificationToCustomer.ts +++ b/packages/server/src/subscribers/PaymentReceive/SendSmsNotificationToCustomer.ts @@ -1,7 +1,7 @@ import { Service, Inject } from 'typedi'; import events from '@/subscribers/events'; import { PaymentReceiveNotifyBySms } from '@/services/Sales/PaymentReceived/PaymentReceivedSmsNotify'; -import { IPaymentReceiveCreatedPayload } from '@/interfaces'; +import { IPaymentReceivedCreatedPayload } from '@/interfaces'; import { runAfterTransaction } from '@/services/UnitOfWork/TransactionsHooks'; @Service() @@ -26,7 +26,7 @@ export default class SendSmsNotificationPaymentReceive { tenantId, paymentReceiveId, trx, - }: IPaymentReceiveCreatedPayload) => { + }: IPaymentReceivedCreatedPayload) => { // Notify via Sms after transactions complete running. runAfterTransaction(trx, async () => { try { diff --git a/packages/server/src/subscribers/PaymentReceive/WriteGLEntries.ts b/packages/server/src/subscribers/PaymentReceive/WriteGLEntries.ts index 58160b81c..b1b197a96 100644 --- a/packages/server/src/subscribers/PaymentReceive/WriteGLEntries.ts +++ b/packages/server/src/subscribers/PaymentReceive/WriteGLEntries.ts @@ -1,8 +1,8 @@ import { Inject, Service } from 'typedi'; import { - IPaymentReceiveCreatedPayload, - IPaymentReceiveDeletedPayload, - IPaymentReceiveEditedPayload, + IPaymentReceivedCreatedPayload, + IPaymentReceivedDeletedPayload, + IPaymentReceivedEditedPayload, } from '@/interfaces'; import events from '@/subscribers/events'; import { PaymentReceivedGLEntries } from '@/services/Sales/PaymentReceived/PaymentReceivedGLEntries'; @@ -37,7 +37,7 @@ export default class PaymentReceivesWriteGLEntriesSubscriber { tenantId, paymentReceiveId, trx, - }: IPaymentReceiveCreatedPayload) => { + }: IPaymentReceivedCreatedPayload) => { await this.paymentReceiveGLEntries.writePaymentGLEntries( tenantId, paymentReceiveId, @@ -52,7 +52,7 @@ export default class PaymentReceivesWriteGLEntriesSubscriber { tenantId, paymentReceive, trx, - }: IPaymentReceiveEditedPayload) => { + }: IPaymentReceivedEditedPayload) => { await this.paymentReceiveGLEntries.rewritePaymentGLEntries( tenantId, paymentReceive.id, @@ -67,7 +67,7 @@ export default class PaymentReceivesWriteGLEntriesSubscriber { tenantId, paymentReceiveId, trx, - }: IPaymentReceiveDeletedPayload) => { + }: IPaymentReceivedDeletedPayload) => { await this.paymentReceiveGLEntries.revertPaymentGLEntries( tenantId, paymentReceiveId,