refactor: split the services to multiple service classes (#202)

packages/server/src/api/controllers/Purchases/Bills.ts

@@ -1,26 +1,27 @@
+import { Service, Inject } from 'typedi';
 import { Router, Request, Response, NextFunction } from 'express';
 import { check, param, query } from 'express-validator';
-import { Service, Inject } from 'typedi';
-import { AbilitySubject, BillAction, IBillDTO, IBillEditDTO } from '@/interfaces';
+import {
+  AbilitySubject,
+  BillAction,
+  IBillDTO,
+  IBillEditDTO,
+} from '@/interfaces';
 import asyncMiddleware from '@/api/middleware/asyncMiddleware';
-import BillsService from '@/services/Purchases/Bills';
 import BaseController from '@/api/controllers/BaseController';
 import DynamicListingService from '@/services/DynamicListing/DynamicListService';
 import { ServiceError } from '@/exceptions';
 import CheckPolicies from '@/api/middleware/CheckPolicies';
-import BillPaymentsService from '@/services/Purchases/BillPaymentsService';
+import { BillsApplication } from '@/services/Purchases/Bills/BillsApplication';
 
 @Service()
 export default class BillsController extends BaseController {
   @Inject()
-  private billsService: BillsService;
+  private billsApplication: BillsApplication;
 
   @Inject()
   private dynamicListService: DynamicListingService;
 
-  @Inject()
-  private billPayments: BillPaymentsService;
-
   /**
    * Router constructor.
    */
@@ -97,7 +98,7 @@ export default class BillsController extends BaseController {
   /**
    * Common validation schema.
    */
-  get billValidationSchema() {
+  private get billValidationSchema() {
     return [
       check('bill_number').exists().trim().escape(),
       check('reference_no').optional().trim().escape(),
@@ -142,7 +143,7 @@ export default class BillsController extends BaseController {
   /**
    * Common validation schema.
    */
-  get billEditValidationSchema() {
+  private get billEditValidationSchema() {
     return [
       check('bill_number').optional().trim().escape(),
       check('reference_no').optional().trim().escape(),
@@ -184,14 +185,14 @@ export default class BillsController extends BaseController {
   /**
    * Bill validation schema.
    */
-  get specificBillValidationSchema() {
+  private get specificBillValidationSchema() {
     return [param('id').exists().isNumeric().toInt()];
   }
 
   /**
    * Bills list validation schema.
    */
-  get billsListingValidationSchema() {
+  private get billsListingValidationSchema() {
     return [
       query('view_slug').optional().isString().trim(),
       query('stringified_filter_roles').optional().isJSON(),
@@ -203,7 +204,7 @@ export default class BillsController extends BaseController {
     ];
   }
 
-  get dueBillsListingValidationSchema() {
+  private get dueBillsListingValidationSchema() {
     return [
       query('vendor_id').optional().trim().escape(),
       query('payment_made_id').optional().trim().escape(),
@@ -216,17 +217,16 @@ export default class BillsController extends BaseController {
    * @param {Response} res
    * @param {Function} next
    */
-  async newBill(req: Request, res: Response, next: NextFunction) {
+  private async newBill(req: Request, res: Response, next: NextFunction) {
     const { tenantId, user } = req;
     const billDTO: IBillDTO = this.matchedBodyData(req);
 
     try {
-      const storedBill = await this.billsService.createBill(
+      const storedBill = await this.billsApplication.createBill(
         tenantId,
         billDTO,
         user
       );
-
       return res.status(200).send({
         id: storedBill.id,
         message: 'The bill has been created successfully.',
@@ -241,13 +241,13 @@ export default class BillsController extends BaseController {
    * @param {Request} req
    * @param {Response} res
    */
-  async editBill(req: Request, res: Response, next: NextFunction) {
+  private async editBill(req: Request, res: Response, next: NextFunction) {
     const { id: billId } = req.params;
     const { tenantId, user } = req;
     const billDTO: IBillEditDTO = this.matchedBodyData(req);
 
     try {
-      await this.billsService.editBill(tenantId, billId, billDTO, user);
+      await this.billsApplication.editBill(tenantId, billId, billDTO, user);
 
       return res.status(200).send({
         id: billId,
@@ -263,12 +263,12 @@ export default class BillsController extends BaseController {
    * @param {Request} req -
    * @param {Response} res -
    */
-  async openBill(req: Request, res: Response, next: NextFunction) {
+  private async openBill(req: Request, res: Response, next: NextFunction) {
     const { id: billId } = req.params;
     const { tenantId } = req;
 
     try {
-      await this.billsService.openBill(tenantId, billId);
+      await this.billsApplication.openBill(tenantId, billId);
 
       return res.status(200).send({
         id: billId,
@@ -285,12 +285,12 @@ export default class BillsController extends BaseController {
    * @param {Response} res
    * @return {Response}
    */
-  async getBill(req: Request, res: Response, next: NextFunction) {
+  private async getBill(req: Request, res: Response, next: NextFunction) {
     const { tenantId } = req;
     const { id: billId } = req.params;
 
     try {
-      const bill = await this.billsService.getBill(tenantId, billId);
+      const bill = await this.billsApplication.getBill(tenantId, billId);
 
       return res.status(200).send(this.transfromToResponse({ bill }));
     } catch (error) {
@@ -304,12 +304,12 @@ export default class BillsController extends BaseController {
    * @param {Response} res -
    * @return {Response}
    */
-  async deleteBill(req: Request, res: Response, next: NextFunction) {
+  private async deleteBill(req: Request, res: Response, next: NextFunction) {
     const billId = req.params.id;
     const { tenantId } = req;
 
     try {
-      await this.billsService.deleteBill(tenantId, billId);
+      await this.billsApplication.deleteBill(tenantId, billId);
 
       return res.status(200).send({
         id: billId,
@@ -326,7 +326,7 @@ export default class BillsController extends BaseController {
    * @param {Response} res -
    * @return {Response}
    */
-  public async billsList(req: Request, res: Response, next: NextFunction) {
+  private async billsList(req: Request, res: Response, next: NextFunction) {
     const { tenantId } = req;
     const filter = {
       page: 1,
@@ -338,7 +338,7 @@ export default class BillsController extends BaseController {
 
     try {
       const { bills, pagination, filterMeta } =
-        await this.billsService.getBills(tenantId, filter);
+        await this.billsApplication.getBills(tenantId, filter);
 
       return res.status(200).send({
         bills: this.transfromToResponse(bills),
@@ -356,12 +356,13 @@ export default class BillsController extends BaseController {
    * @param {Response} res
    * @param {NextFunction} next
    */
-  public async getDueBills(req: Request, res: Response, next: NextFunction) {
+  private async getDueBills(req: Request, res: Response, next: NextFunction) {
     const { tenantId } = req;
     const { vendorId } = this.matchedQueryData(req);
 
     try {
-      const bills = await this.billsService.getDueBills(tenantId, vendorId);
+      const bills = await this.billsApplication.getDueBills(tenantId, vendorId);
+
       return res.status(200).send({ bills });
     } catch (error) {
       next(error);
@@ -374,7 +375,7 @@ export default class BillsController extends BaseController {
    * @param {Response} res
    * @param {NextFunction} next
    */
-  public getBillPaymentsTransactions = async (
+  private getBillPaymentsTransactions = async (
     req: Request,
     res: Response,
     next: NextFunction
@@ -383,7 +384,7 @@ export default class BillsController extends BaseController {
     const { id: billId } = req.params;
 
     try {
-      const billPayments = await this.billPayments.getBillPayments(
+      const billPayments = await this.billsApplication.getBillPayments(
         tenantId,
         billId
       );

packages/server/src/api/controllers/Purchases/BillsPayments.ts

@@ -4,7 +4,7 @@ import { check, param, query, ValidationChain } from 'express-validator';
 import asyncMiddleware from '@/api/middleware/asyncMiddleware';
 import { ServiceError } from '@/exceptions';
 import BaseController from '@/api/controllers/BaseController';
-import BillPaymentsService from '@/services/Purchases/BillPayments/BillPayments';
+import { BillPaymentsApplication } from '@/services/Purchases/BillPayments/BillPaymentsApplication';
 import BillPaymentsPages from '@/services/Purchases/BillPayments/BillPaymentsPages';
 import DynamicListingService from '@/services/DynamicListing/DynamicListService';
 import CheckPolicies from '@/api/middleware/CheckPolicies';
@@ -17,18 +17,18 @@ import { AbilitySubject, IPaymentMadeAction } from '@/interfaces';
 @Service()
 export default class BillsPayments extends BaseController {
   @Inject()
-  billPaymentService: BillPaymentsService;
+  private billPaymentsApplication: BillPaymentsApplication;
 
   @Inject()
-  dynamicListService: DynamicListingService;
+  private dynamicListService: DynamicListingService;
 
   @Inject()
-  billPaymentsPages: BillPaymentsPages;
+  private billPaymentsPages: BillPaymentsPages;
 
   /**
    * Router constructor.
    */
-  router() {
+  public router() {
     const router = Router();
 
     router.post(
@@ -106,7 +106,7 @@ export default class BillsPayments extends BaseController {
    * Bill payments schema validation.
    * @return {ValidationChain[]}
    */
-  get billPaymentSchemaValidation(): ValidationChain[] {
+  private get billPaymentSchemaValidation(): ValidationChain[] {
     return [
       check('vendor_id').exists().isNumeric().toInt(),
       check('exchange_rate').optional().isFloat({ gt: 0 }).toFloat(),
@@ -129,7 +129,7 @@ export default class BillsPayments extends BaseController {
    * Specific bill payment schema validation.
    * @returns {ValidationChain[]}
    */
-  get specificBillPaymentValidateSchema(): ValidationChain[] {
+  private get specificBillPaymentValidateSchema(): ValidationChain[] {
     return [param('id').exists().isNumeric().toInt()];
   }
 
@@ -137,7 +137,7 @@ export default class BillsPayments extends BaseController {
    * Bills payment list validation schema.
    * @returns {ValidationChain[]}
    */
-  get listingValidationSchema(): ValidationChain[] {
+  private get listingValidationSchema(): ValidationChain[] {
     return [
       query('custom_view_id').optional().isNumeric().toInt(),
       query('stringified_filter_roles').optional().isJSON(),
@@ -154,7 +154,7 @@ export default class BillsPayments extends BaseController {
    * @param {Request} req -
    * @param {Response} res -
    */
-  async getBillPaymentNewPageEntries(req: Request, res: Response) {
+  private async getBillPaymentNewPageEntries(req: Request, res: Response) {
     const { tenantId } = req;
     const { vendorId } = this.matchedQueryData(req);
 
@@ -174,7 +174,7 @@ export default class BillsPayments extends BaseController {
    * @param {Request} req
    * @param {Response} res
    */
-  async getBillPaymentEditPage(
+  private async getBillPaymentEditPage(
     req: Request,
     res: Response,
     next: NextFunction
@@ -205,16 +205,19 @@ export default class BillsPayments extends BaseController {
    * @param {Response} res
    * @param {Response} res
    */
-  async createBillPayment(req: Request, res: Response, next: NextFunction) {
+  private async createBillPayment(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
     const { tenantId } = req;
     const billPaymentDTO = this.matchedBodyData(req);
 
     try {
-      const billPayment = await this.billPaymentService.createBillPayment(
+      const billPayment = await this.billPaymentsApplication.createBillPayment(
         tenantId,
         billPaymentDTO
       );
-
       return res.status(200).send({
         id: billPayment.id,
         message: 'Payment made has been created successfully.',
@@ -229,13 +232,17 @@ export default class BillsPayments extends BaseController {
    * @param {Request} req
    * @param {Response} res
    */
-  async editBillPayment(req: Request, res: Response, next: NextFunction) {
+  private async editBillPayment(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
     const { tenantId } = req;
     const billPaymentDTO = this.matchedBodyData(req);
     const { id: billPaymentId } = req.params;
 
     try {
-      const paymentMade = await this.billPaymentService.editBillPayment(
+      const paymentMade = await this.billPaymentsApplication.editBillPayment(
         tenantId,
         billPaymentId,
         billPaymentDTO
@@ -256,12 +263,19 @@ export default class BillsPayments extends BaseController {
    * @param {Response} res -
    * @return {Response} res -
    */
-  async deleteBillPayment(req: Request, res: Response, next: NextFunction) {
+  private async deleteBillPayment(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
     const { tenantId } = req;
     const { id: billPaymentId } = req.params;
 
     try {
-      await this.billPaymentService.deleteBillPayment(tenantId, billPaymentId);
+      await this.billPaymentsApplication.deleteBillPayment(
+        tenantId,
+        billPaymentId
+      );
 
       return res.status(200).send({
         id: billPaymentId,
@@ -277,16 +291,19 @@ export default class BillsPayments extends BaseController {
    * @param {Request} req
    * @param {Response} res
    */
-  async getBillPayment(req: Request, res: Response, next: NextFunction) {
+  private async getBillPayment(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
     const { tenantId } = req;
     const { id: billPaymentId } = req.params;
 
     try {
-      const billPayment = await this.billPaymentService.getBillPayment(
+      const billPayment = await this.billPaymentsApplication.getBillPayment(
         tenantId,
         billPaymentId
       );
-
       return res.status(200).send({
         bill_payment: this.transfromToResponse(billPayment),
       });
@@ -301,12 +318,16 @@ export default class BillsPayments extends BaseController {
    * @param {Response} res
    * @param {NextFunction} next
    */
-  async getPaymentBills(req: Request, res: Response, next: NextFunction) {
+  private async getPaymentBills(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
     const { tenantId } = req;
     const { id: billPaymentId } = req.params;
 
     try {
-      const bills = await this.billPaymentService.getPaymentBills(
+      const bills = await this.billPaymentsApplication.getPaymentBills(
         tenantId,
         billPaymentId
       );
@@ -322,7 +343,11 @@ export default class BillsPayments extends BaseController {
    * @param {Response} res -
    * @return {Response}
    */
-  async getBillsPayments(req: Request, res: Response, next: NextFunction) {
+  private async getBillsPayments(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
     const { tenantId } = req;
     const billPaymentsFilter = {
       page: 1,
@@ -335,7 +360,7 @@ export default class BillsPayments extends BaseController {
 
     try {
       const { billPayments, pagination, filterMeta } =
-        await this.billPaymentService.listBillPayments(
+        await this.billPaymentsApplication.getBillPayments(
           tenantId,
           billPaymentsFilter
         );
@@ -357,7 +382,7 @@ export default class BillsPayments extends BaseController {
    * @param {Response} res
    * @param {NextFunction} next
    */
-  handleServiceError(
+  private handleServiceError(
     error: Error,
     req: Request,
     res: Response,