fix: record authorized user id for customer/vendor opening balance.

server/src/services/Contacts/CustomersService.ts

@@ -17,6 +17,8 @@ import {
   IContactEditDTO,
   IContact,
   ISaleInvoice,
+  ISystemService,
+  ISystemUser,
 } from 'interfaces';
 import { ServiceError } from 'exceptions';
 import TenancyService from 'services/Tenancy/TenancyService';
@@ -90,20 +92,20 @@ export default class CustomersService {
    */
   public async newCustomer(
     tenantId: number,
-    customerDTO: ICustomerNewDTO
+    customerDTO: ICustomerNewDTO,
+    authorizedUser: ISystemUser
   ): Promise<ICustomer> {
     this.logger.info('[customer] trying to create a new customer.', {
       tenantId,
       customerDTO,
     });
-
     const customerObj = this.transformNewCustomerDTO(customerDTO);
+
     const customer = await this.contactService.newContact(
       tenantId,
       customerObj,
       'customer'
     );
-
     this.logger.info('[customer] created successfully.', {
       tenantId,
       customerDTO,
@@ -112,6 +114,7 @@ export default class CustomersService {
       customer,
       tenantId,
       customerId: customer.id,
+      authorizedUser,
     });
 
     return customer;
@@ -127,7 +130,8 @@ export default class CustomersService {
   public async editCustomer(
     tenantId: number,
     customerId: number,
-    customerDTO: ICustomerEditDTO
+    customerDTO: ICustomerEditDTO,
+    authorizedUser: ISystemUser
   ): Promise<ICustomer> {
     const contactDTO = this.customerToContactDTO(customerDTO);
 
@@ -143,11 +147,13 @@ export default class CustomersService {
       'customer'
     );
 
+    // Triggers `onCustomerEdited` event.
     this.eventDispatcher.dispatch(events.customers.onEdited);
     this.logger.info('[customer] edited successfully.', {
       tenantId,
       customerId,
       customer,
+      authorizedUser,
     });
 
     return customer;
@@ -161,7 +167,8 @@ export default class CustomersService {
    */
   public async deleteCustomer(
     tenantId: number,
-    customerId: number
+    customerId: number,
+    authorizedUser: ISystemUser
   ): Promise<void> {
     this.logger.info('[customer] trying to delete customer.', {
       tenantId,
@@ -184,6 +191,7 @@ export default class CustomersService {
     this.logger.info('[customer] deleted successfully.', {
       tenantId,
       customerId,
+      authorizedUser,
     });
   }
 
@@ -192,7 +200,11 @@ export default class CustomersService {
    * @param {number} tenantId
    * @param {number} customerId
    */
-  public async getCustomer(tenantId: number, customerId: number) {
+  public async getCustomer(
+    tenantId: number,
+    customerId: number,
+    authorizedUser: ISystemUser
+  ) {
     const contact = await this.contactService.getContact(
       tenantId,
       customerId,
@@ -245,7 +257,8 @@ export default class CustomersService {
     tenantId: number,
     customerId: number,
     openingBalance: number,
-    openingBalanceAt: Date | string
+    openingBalanceAt: Date | string,
+    authorizedUserId: number
   ) {
     const journal = new JournalPoster(tenantId);
     const journalCommands = new JournalCommands(journal);
@@ -253,7 +266,8 @@ export default class CustomersService {
     await journalCommands.customerOpeningBalance(
       customerId,
       openingBalance,
-      openingBalanceAt
+      openingBalanceAt,
+      authorizedUserId
     );
     await Promise.all([journal.saveBalance(), journal.saveEntries()]);
   }
@@ -316,7 +330,11 @@ export default class CustomersService {
    * @param {number[]} customersIds
    * @return {Promise<void>}
    */
-  public async deleteBulkCustomers(tenantId: number, customersIds: number[]) {
+  public async deleteBulkCustomers(
+    tenantId: number,
+    customersIds: number[],
+    authorizedUser: ISystemUser,
+  ): Promise<void> {
     const { Contact } = this.tenancy.models(tenantId);
 
     // Validate the customers existance on the storage.
@@ -332,6 +350,7 @@ export default class CustomersService {
     await this.eventDispatcher.dispatch(events.customers.onBulkDeleted, {
       tenantId,
       customersIds,
+      authorizedUser,
     });
   }
 

server/src/services/Contacts/VendorsService.ts

@@ -14,6 +14,7 @@ import {
   IVendorsFilter,
   IPaginationMeta,
   IFilterMeta,
+  ISystemUser,
 } from 'interfaces';
 import { ServiceError } from 'exceptions';
 import DynamicListingService from 'services/DynamicListing/DynamicListService';
@@ -55,24 +56,28 @@ export default class VendorsService {
    * @param {IVendorNewDTO} vendorDTO
    * @return {Promise<void>}
    */
-  public async newVendor(tenantId: number, vendorDTO: IVendorNewDTO) {
+  public async newVendor(
+    tenantId: number,
+    vendorDTO: IVendorNewDTO,
+    authorizedUser: ISystemUser
+  ) {
     this.logger.info('[vendor] trying create a new vendor.', {
       tenantId,
       vendorDTO,
     });
-
     const contactDTO = this.vendorToContactDTO(vendorDTO);
+
     const vendor = await this.contactService.newContact(
       tenantId,
       contactDTO,
       'vendor'
     );
-
     // Triggers `onVendorCreated` event.
     await this.eventDispatcher.dispatch(events.vendors.onCreated, {
       tenantId,
       vendorId: vendor.id,
       vendor,
+      authorizedUser,
     });
     return vendor;
   }
@@ -85,7 +90,8 @@ export default class VendorsService {
   public async editVendor(
     tenantId: number,
     vendorId: number,
-    vendorDTO: IVendorEditDTO
+    vendorDTO: IVendorEditDTO,
+    authorizedUser: ISystemUser
   ) {
     const contactDTO = this.vendorToContactDTO(vendorDTO);
     const vendor = await this.contactService.editContact(
@@ -95,8 +101,13 @@ export default class VendorsService {
       'vendor'
     );
 
-    await this.eventDispatcher.dispatch(events.vendors.onEdited);
-
+    // Triggers `onVendorEdited` event.
+    await this.eventDispatcher.dispatch(events.vendors.onEdited, {
+      tenantId,
+      vendorId,
+      vendor,
+      authorizedUser,
+    });
     return vendor;
   }
 
@@ -119,8 +130,15 @@ export default class VendorsService {
    * @param {number} vendorId
    * @return {Promise<void>}
    */
-  public async deleteVendor(tenantId: number, vendorId: number) {
+  public async deleteVendor(
+    tenantId: number,
+    vendorId: number,
+    authorizedUser: ISystemUser
+  ) {
+    // Validate the vendor existance on the storage.
     await this.getVendorByIdOrThrowError(tenantId, vendorId);
+
+    // Validate the vendor has no associated bills.
     await this.vendorHasNoBillsOrThrowError(tenantId, vendorId);
 
     this.logger.info('[vendor] trying to delete vendor.', {
@@ -129,9 +147,11 @@ export default class VendorsService {
     });
     await this.contactService.deleteContact(tenantId, vendorId, 'vendor');
 
+    // Triggers `onVendorDeleted` event.
     await this.eventDispatcher.dispatch(events.vendors.onDeleted, {
       tenantId,
       vendorId,
+      authorizedUser,
     });
     this.logger.info('[vendor] deleted successfully.', { tenantId, vendorId });
   }
@@ -155,7 +175,9 @@ export default class VendorsService {
   public async writeVendorOpeningBalanceJournal(
     tenantId: number,
     vendorId: number,
-    openingBalance: number
+    openingBalance: number,
+    openingBalanceAt: Date | string,
+    user: ISystemUser
   ) {
     const journal = new JournalPoster(tenantId);
     const journalCommands = new JournalCommands(journal);
@@ -164,8 +186,12 @@ export default class VendorsService {
       tenantId,
       vendorId,
     });
-    await journalCommands.vendorOpeningBalance(vendorId, openingBalance);
-
+    await journalCommands.vendorOpeningBalance(
+      vendorId,
+      openingBalance,
+      openingBalanceAt,
+      user
+    );
     await Promise.all([journal.saveBalance(), journal.saveEntries()]);
   }
 
@@ -183,7 +209,7 @@ export default class VendorsService {
 
     this.logger.info(
       '[customer] trying to revert opening balance journal entries.',
-      { tenantId, customerId }
+      { tenantId, vendorId }
     );
     await this.contactService.revertJEntriesContactsOpeningBalance(
       tenantId,
@@ -216,7 +242,8 @@ export default class VendorsService {
    */
   public async deleteBulkVendors(
     tenantId: number,
-    vendorsIds: number[]
+    vendorsIds: number[],
+    authorizedUser: ISystemUser
   ): Promise<void> {
     const { Contact } = this.tenancy.models(tenantId);
 
@@ -228,9 +255,11 @@ export default class VendorsService {
 
     await Contact.query().whereIn('id', vendorsIds).delete();
 
+    // Triggers `onVendorsBulkDeleted` event.
     await this.eventDispatcher.dispatch(events.vendors.onBulkDeleted, {
       tenantId,
       vendorsIds,
+      authorizedUser,
     });
 
     this.logger.info('[vendor] bulk deleted successfully.', {
@@ -266,7 +295,7 @@ export default class VendorsService {
    */
   private async vendorsHaveNoBillsOrThrowError(
     tenantId: number,
-    vendorsIds: number[],
+    vendorsIds: number[]
   ) {
     const { billRepository } = this.tenancy.repositories(tenantId);
 
@@ -299,12 +328,12 @@ export default class VendorsService {
     filterMeta: IFilterMeta;
   }> {
     const { Vendor } = this.tenancy.models(tenantId);
+
     const dynamicFilter = await this.dynamicListService.dynamicList(
       tenantId,
       Vendor,
       vendorsFilter
     );
-
     const { results, pagination } = await Vendor.query()
       .onBuild((builder) => {
         dynamicFilter.buildQuery()(builder);