fix: excel integration and validation response (#388)

* feat: update response with correct info WIP
* fix: update responses and excel report generation
* docs: update readme with api-mode instructions

---------

Signed-off-by: Nicklas Silversved <nicklas.silversved@digg.se>

Author: brorlarsnicklas

openapi.yaml

@@ -149,7 +149,7 @@ paths:
         tags:
           - validate
         summary: Generate status report
-        description: Accepts report data as the request body and returns a generated status report as a downloadable excel file.
+        description: Accepts result data as the request body and returns a generated status report as a downloadable excel file.
         operationId: generateReport
         requestBody:
           required: true
@@ -158,13 +158,13 @@ paths:
               schema:
                 type: object
                 required:
-                  - report
+                  - result
                 properties:
-                  report:
+                  result:
                     type: array
                     items:
-                      type: object
-                    description: An array of objects representing the data for the report.
+                      $ref: '#/components/schemas/RapLPCustomSpectralDiagnosticItem'
+                    description: An array of result items used to generate the Excel report.
         responses:
           '200':
             description: Successful operation
@@ -231,7 +231,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/RapLPCustomSpectralDiagnostic"
+                $ref: "#/components/schemas/ValidationResponseDto"
               example:
                 - id: "AME.04"
                   omrade: "API Message"
@@ -391,7 +391,7 @@ components:
         title:
           type: string
         status:
-          type: "integer"
+          type: integer
         detail:
           type: string
         instance:
@@ -483,17 +483,6 @@ components:
       type: array
       items:
         $ref: "#/components/schemas/RapLPCustomSpectralDiagnosticItem"
-    ValidationResponseDto:
-      type: object
-      properties:
-        result:
-          type: array
-          items:
-            $ref: "#/components/schemas/RapLPCustomSpectralDiagnosticItem"
-        report:
-          type: array
-          items:
-            $ref: "#/components/schemas/DiagnosticReport"
     DiagnosticRuleInfo:
       type: object
       properties:
@@ -503,15 +492,21 @@ components:
         omrade:
           type: string
           example: "URL Format och namngivning"
+      required:
+        - id
+        - omrade
+
     PopulatedDiagnosticRuleInfo:
-      type: object
       allOf:
-        - $ref: "#/components/schemas/DiagnosticRuleInfo"
+        - $ref: '#/components/schemas/DiagnosticRuleInfo'
         - type: object
           properties:
             status:
               type: string
               example: "OK"
+          required:
+            - status
+
     DiagnosticReport:
       type: object
       properties:
@@ -521,4 +516,46 @@ components:
         regler:
           type: array
           items:
-            $ref: "#/components/schemas/PopulatedDiagnosticRuleInfo"
+            $ref: '#/components/schemas/PopulatedDiagnosticRuleInfo'
+      required:
+        - Notering
+        - regler
+
+    DiagnosticRuleinfoSet:
+      type: object
+      # additionalProperties: false
+      properties:
+        notApplicableRules:
+          type: array
+          items:
+            $ref: '#/components/schemas/DiagnosticRuleInfo'
+        executedUniqueRules:
+          type: array
+          items:
+            $ref: '#/components/schemas/DiagnosticRuleInfo'
+        executedUniqueRulesWithError:
+          type: array
+          items:
+            $ref: '#/components/schemas/DiagnosticRuleInfo'
+
+    RapLPDiagnostic:
+      type: object
+      properties:
+        _ruleSets:
+          $ref: '#/components/schemas/DiagnosticRuleinfoSet'
+
+    ValidationResponseDto:
+      type: object
+      properties:
+        result:
+          type: array
+          items:
+            $ref: "#/components/schemas/RapLPCustomSpectralDiagnosticItem"
+        report:
+          type: array
+          items:
+            $ref: "#/components/schemas/DiagnosticReport"
+      required:
+        - result
+        - report
+

src/routes/validate.ts

@@ -11,7 +11,7 @@ import { importAndCreateRuleInstances } from "../util/ruleUtil.ts";
 import { ApiInfo } from "../model/ApiInfo.ts";
 import { validationRules } from "../model/validationRules.ts";
 import { ExcelReportProcessor } from "../util/excelReportProcessor.ts"
-import {DiagnosticReport } from "../util/RapLPDiagnostic.ts";
+import {DiagnosticReport, RapLPDiagnostic } from "../util/RapLPDiagnostic.ts";
 
 export const registerValidationRoutes = (app: Express) => {
   // Route for raw content upload.
@@ -55,15 +55,23 @@ export const registerValidationRoutes = (app: Express) => {
     try {
       const data = req.body;
 
-    if (!data || !data.report || !Array.isArray(data.report)) {
-      return res.status(400).json({ error: 'Invalid data format. Expected an object with a "report" array.' });
+    if (!data || !data.result || !Array.isArray(data.result)) {
+      return res.status(400).json({ error: 'Invalid data format. Expected an object with a "result" array.' });
     }
 
     const reportHandler = new ExcelReportProcessor();
     let buffer: Buffer;
 
+    const ruleCategories = data.categories && data.categories.length > 0 ?  data.categories: undefined;
+
+
+    const enabledRulesAndCategorys = await importAndCreateRuleInstances(ruleCategories);
+    const customDiagnostic = new RapLPDiagnostic();
+    customDiagnostic.processRuleExecutionInformation(data.result,enabledRulesAndCategorys.instanceCategoryMap);
+    const diagnosticReports: DiagnosticReport[] = customDiagnostic.processDiagnosticInformation();
+
     try {
-        buffer = reportHandler.generateReportDocumentBuffer(data.report);
+        buffer = reportHandler.generateReportDocumentBuffer(customDiagnostic);
     } catch (error) {
         console.error("Error generating report buffer:", error);
         return res.status(500).json({ error: 'Failed to generate report.' });

src/util/apiUtil.ts

@@ -52,7 +52,6 @@ export async function processApiSpec(
   );
   const diagnosticReports: DiagnosticReport[] =
     customDiagnostic.processDiagnosticInformation();
-
   return { result, report: diagnosticReports };
 }