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

2026-02-15 12:20:31 +00:00 · 2023-08-10 20:29:39 +02:00
parent ffef627dc3
commit 26c6ca9e36
150 changed files with 7188 additions and 5007 deletions
--- a/packages/server/src/api/controllers/Sales/SalesEstimates.ts
+++ b/packages/server/src/api/controllers/Sales/SalesEstimates.ts
@@ -1,20 +1,17 @@
 import { Router, Request, Response, NextFunction } from 'express';
-import { check, param, query, matchedData } from 'express-validator';
+import { check, param, query } from 'express-validator';
 import { Inject, Service } from 'typedi';
 import {
  AbilitySubject,
  ISaleEstimateDTO,
  SaleEstimateAction,
-  SaleInvoiceAction,
 } from '@/interfaces';
 import BaseController from '@/api/controllers/BaseController';
 import asyncMiddleware from '@/api/middleware/asyncMiddleware';
-import SaleEstimateService from '@/services/Sales/SalesEstimate';
 import DynamicListingService from '@/services/DynamicListing/DynamicListService';
 import { ServiceError } from '@/exceptions';
-import SaleEstimatesPdfService from '@/services/Sales/Estimates/SaleEstimatesPdf';
-import SaleEstimateNotifyBySms from '@/services/Sales/Estimates/SaleEstimateSmsNotify';
 import CheckPolicies from '@/api/middleware/CheckPolicies';
+import { SaleEstimatesApplication } from '@/services/Sales/Estimates/SaleEstimatesApplication';

 const ACCEPT_TYPE = {
  APPLICATION_PDF: 'application/pdf',
@@ -23,21 +20,15 @@ const ACCEPT_TYPE = {
@Service()
 export default class SalesEstimatesController extends BaseController {
  @Inject()
-  saleEstimateService: SaleEstimateService;
+  private saleEstimatesApplication: SaleEstimatesApplication;

  @Inject()
-  dynamicListService: DynamicListingService;
-
-  @Inject()
-  saleEstimatesPdf: SaleEstimatesPdfService;
-
-  @Inject()
-  saleEstimateNotifySms: SaleEstimateNotifyBySms;
+  private dynamicListService: DynamicListingService;

  /**
   * Router constructor.
   */
-  router() {
+  public router() {
    const router = Router();

    router.post(
@@ -136,7 +127,7 @@ export default class SalesEstimatesController extends BaseController {
  /**
   * Estimate validation schema.
   */
-  get estimateValidationSchema() {
+  private get estimateValidationSchema() {
    return [
      check('customer_id').exists().isNumeric().toInt(),
      check('estimate_date').exists().isISO8601().toDate(),
@@ -177,14 +168,14 @@ export default class SalesEstimatesController extends BaseController {
  /**
   * Specific sale estimate validation schema.
   */
-  get validateSpecificEstimateSchema() {
+  private get validateSpecificEstimateSchema() {
    return [param('id').exists().isNumeric().toInt()];
  }

  /**
   * Sales estimates list validation schema.
   */
-  get validateEstimateListSchema() {
+  private get validateEstimateListSchema() {
    return [
      query('view_slug').optional().isString().trim(),
      query('stringified_filter_roles').optional().isJSON(),
@@ -202,15 +193,16 @@ export default class SalesEstimatesController extends BaseController {
   * @param {Response} res -
   * @return {Response} res -
   */
-  async newEstimate(req: Request, res: Response, next: NextFunction) {
+  private async newEstimate(req: Request, res: Response, next: NextFunction) {
    const { tenantId } = req;
    const estimateDTO: ISaleEstimateDTO = this.matchedBodyData(req);

    try {
-      const storedEstimate = await this.saleEstimateService.createEstimate(
-        tenantId,
-        estimateDTO
-      );
+      const storedEstimate =
+        await this.saleEstimatesApplication.createSaleEstimate(
+          tenantId,
+          estimateDTO
+        );

      return res.status(200).send({
        id: storedEstimate.id,
@@ -226,19 +218,18 @@ export default class SalesEstimatesController extends BaseController {
   * @param {Request} req
   * @param {Response} res
   */
-  async editEstimate(req: Request, res: Response, next: NextFunction) {
+  private async editEstimate(req: Request, res: Response, next: NextFunction) {
    const { id: estimateId } = req.params;
    const { tenantId } = req;
    const estimateDTO: ISaleEstimateDTO = this.matchedBodyData(req);

    try {
      // Update estimate with associated estimate entries.
-      await this.saleEstimateService.editEstimate(
+      await this.saleEstimatesApplication.editSaleEstimate(
        tenantId,
        estimateId,
        estimateDTO
      );
-
      return res.status(200).send({
        id: estimateId,
        message: 'The sale estimate has been created successfully.',
@@ -253,13 +244,19 @@ export default class SalesEstimatesController extends BaseController {
   * @param {Request} req
   * @param {Response} res
   */
-  async deleteEstimate(req: Request, res: Response, next: NextFunction) {
+  private async deleteEstimate(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
    const { id: estimateId } = req.params;
    const { tenantId } = req;

    try {
-      await this.saleEstimateService.deleteEstimate(tenantId, estimateId);
-
+      await this.saleEstimatesApplication.deleteSaleEstimate(
+        tenantId,
+        estimateId
+      );
      return res.status(200).send({
        id: estimateId,
        message: 'The sale estimate has been deleted successfully.',
@@ -274,13 +271,19 @@ export default class SalesEstimatesController extends BaseController {
   * @param {Request} req
   * @param {Response} res
   */
-  async deliverSaleEstimate(req: Request, res: Response, next: NextFunction) {
+  private async deliverSaleEstimate(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
    const { id: estimateId } = req.params;
    const { tenantId } = req;

    try {
-      await this.saleEstimateService.deliverSaleEstimate(tenantId, estimateId);
-
+      await this.saleEstimatesApplication.deliverSaleEstimate(
+        tenantId,
+        estimateId
+      );
      return res.status(200).send({
        id: estimateId,
        message: 'The sale estimate has been delivered successfully.',
@@ -296,12 +299,19 @@ export default class SalesEstimatesController extends BaseController {
   * @param {Response} res
   * @param {NextFunction} next
   */
-  async approveSaleEstimate(req: Request, res: Response, next: NextFunction) {
+  private async approveSaleEstimate(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
    const { id: estimateId } = req.params;
    const { tenantId } = req;

    try {
-      await this.saleEstimateService.approveSaleEstimate(tenantId, estimateId);
+      await this.saleEstimatesApplication.approveSaleEstimate(
+        tenantId,
+        estimateId
+      );

      return res.status(200).send({
        id: estimateId,
@@ -318,12 +328,19 @@ export default class SalesEstimatesController extends BaseController {
   * @param {Response} res
   * @param {NextFunction} next
   */
-  async rejectSaleEstimate(req: Request, res: Response, next: NextFunction) {
+  private async rejectSaleEstimate(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
    const { id: estimateId } = req.params;
    const { tenantId } = req;

    try {
-      await this.saleEstimateService.rejectSaleEstimate(tenantId, estimateId);
+      await this.saleEstimatesApplication.rejectSaleEstimate(
+        tenantId,
+        estimateId
+      );

      return res.status(200).send({
        id: estimateId,
@@ -340,12 +357,12 @@ export default class SalesEstimatesController extends BaseController {
   * @param {Response} res
   * @param {NextFunction} next
   */
-  async getEstimate(req: Request, res: Response, next: NextFunction) {
+  private async getEstimate(req: Request, res: Response, next: NextFunction) {
    const { id: estimateId } = req.params;
    const { tenantId } = req;

    try {
-      const estimate = await this.saleEstimateService.getEstimate(
+      const estimate = await this.saleEstimatesApplication.getSaleEstimate(
        tenantId,
        estimateId
      );
@@ -357,10 +374,11 @@ export default class SalesEstimatesController extends BaseController {
        },
        // PDF content type.
        [ACCEPT_TYPE.APPLICATION_PDF]: async () => {
-          const pdfContent = await this.saleEstimatesPdf.saleEstimatePdf(
-            tenantId,
-            estimate
-          );
+          const pdfContent =
+            await this.saleEstimatesApplication.getSaleEstimatePdf(
+              tenantId,
+              estimate
+            );
          res.set({
            'Content-Type': 'application/pdf',
            'Content-Length': pdfContent.length,
@@ -378,7 +396,7 @@ export default class SalesEstimatesController extends BaseController {
   * @param {Request} req
   * @param {Response} res
   */
-  async getEstimates(req: Request, res: Response, next: NextFunction) {
+  private async getEstimates(req: Request, res: Response, next: NextFunction) {
    const { tenantId } = req;
    const filter = {
      sortOrder: 'desc',
@@ -390,7 +408,7 @@ export default class SalesEstimatesController extends BaseController {

    try {
      const { salesEstimates, pagination, filterMeta } =
-        await this.saleEstimateService.estimatesList(tenantId, filter);
+        await this.saleEstimatesApplication.getSaleEstimates(tenantId, filter);

      res.format({
        [ACCEPT_TYPE.APPLICATION_JSON]: () => {
@@ -408,7 +426,7 @@ export default class SalesEstimatesController extends BaseController {
    }
  }

-  public saleEstimateNotifyBySms = async (
+  private saleEstimateNotifyBySms = async (
    req: Request,
    res: Response,
    next: NextFunction
@@ -417,10 +435,11 @@ export default class SalesEstimatesController extends BaseController {
    const { id: estimateId } = req.params;

    try {
-      const saleEstimate = await this.saleEstimateNotifySms.notifyBySms(
-        tenantId,
-        estimateId
-      );
+      const saleEstimate =
+        await this.saleEstimatesApplication.notifySaleEstimateBySms(
+          tenantId,
+          estimateId
+        );
      return res.status(200).send({
        id: saleEstimate.id,
        message:
@@ -437,7 +456,7 @@ export default class SalesEstimatesController extends BaseController {
   * @param {Response} res
   * @param {NextFunction} next
   */
-  public saleEstimateSmsDetails = async (
+  private saleEstimateSmsDetails = async (
    req: Request,
    res: Response,
    next: NextFunction
@@ -446,10 +465,11 @@ export default class SalesEstimatesController extends BaseController {
    const { id: estimateId } = req.params;

    try {
-      const estimateSmsDetails = await this.saleEstimateNotifySms.smsDetails(
-        tenantId,
-        estimateId
-      );
+      const estimateSmsDetails =
+        await this.saleEstimatesApplication.getSaleEstimateSmsDetails(
+          tenantId,
+          estimateId
+        );
      return res.status(200).send({
        data: estimateSmsDetails,
      });