/*
 * File: src/main/java/reports/controller/SalesController.java
 * Description: This controller handles requests related to sales reports
 * within the ERP application. It provides an endpoint for generating reports based
 * on sales data, utilizing the specified report type.
 *
 * Key Components:
 *
 * - **@RestController**: Indicates that this class is a Spring MVC controller that
 *   returns domain objects instead of views. It combines **@Controller** and **@ResponseBody**.
 *
 * - **@RequestMapping**: Specifies the base URI for all endpoints in this controller,
 *   which is set to "/api/reports/sales".
 *
 * - **@Autowired**: Automatically injects an instance of the `SalesService`, which
 *   contains the business logic for generating sales reports, allowing this controller
 *   to delegate the work to this service.
 *
 * - **@PostMapping**: Maps HTTP POST requests to the `getSalesReport` method,
 *   allowing for the creation or processing of reports based on the provided request body
 *   and parameters.
*/

package com.nebula.erp.reports.controller;

import com.nebula.erp.reports.documents.SalesSwagger;
import com.nebula.erp.reports.requestmodel.SalesRequest;
import com.nebula.erp.reports.service.SalesService;
import com.nebula.erp.reports.utility.CreateLogger;
import com.nebula.erp.reports.utility.PermissionHelper;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import com.nebula.erp.reports.utility.ApiResponseStructure;
import java.util.Map;

@RestController
@RequestMapping("/api/reports/sales")  // Base URI for sales report-related endpoints
@Tag(name="Sales Reports APIs", description = "APIs for managing Sales Reports")
@SalesSwagger.GlobalErrorResponse
public class SalesController {

    @Autowired
    private SalesService salesService;
    @Autowired
    private PermissionHelper permissionHelper;

    @Autowired
    private CreateLogger createLogger;

    private static final String path = "/reports/sales";

    @SalesSwagger.GetSalesReportOperation
    @PostMapping
    public ResponseEntity<ApiResponseStructure<Map<String, Object>>> getSalesReport(
            @RequestBody SalesRequest salesRequest,
            @RequestParam(value = "reportType", required = true) String reportType) {  // Required report type parameter

        // Check user permissions
        if (!permissionHelper.hasPermission("create-report")) {
            createLogger.createLogger("error", path, "POST", "Forbidden: You do not have the required permission. Please contact the administration.", "validation");
            return ResponseEntity.status(HttpStatus.FORBIDDEN).body(new ApiResponseStructure<>("error", HttpStatus.FORBIDDEN.value(), "Forbidden: You do not have the required permission. Please contact the administration.", null));
        }

        // Calls the patientPrescription service to generate the report
        ApiResponseStructure<Map<String, Object>> response = salesService.getSalesReport(salesRequest, reportType);
        createLogger.createLogger("application", path, "POST", "Data retrieved.", "");
        return ResponseEntity.ok(response);
    }

}