feat(FI-111/112/113/114): Reports APIs

.vscode/c_cpp_properties.json

@@ -0,0 +1,20 @@
+{
+    "configurations": [
+        {
+            "name": "Win32",
+            "includePath": [
+                "${workspaceFolder}/**"
+            ],
+            "defines": [
+                "_DEBUG",
+                "UNICODE",
+                "_UNICODE"
+            ],
+            "compilerPath": "C:\\msys64\\ucrt64\\bin\\gcc.exe",
+            "cStandard": "c23",
+            "cppStandard": "gnu++17",
+            "intelliSenseMode": "windows-gcc-x64"
+        }
+    ],
+    "version": 4
+}

backend/package.json

@@ -32,7 +32,6 @@
         "cloudinary": "^1.27.1",
         "cors": "^2.8.5",
         "debug": "^4.2.0",
-        "dotenv": "^8.2.0",
         "eslint-config-prettier": "^8.3.0",
         "eslint-plugin-prettier": "^4.0.0",
         "express": "^4.17.2",
@@ -70,6 +69,7 @@
         "babel-eslint": "^10.1.0",
         "babel-plugin-module-resolver": "^4.1.0",
         "babel-plugin-transform-runtime": "^6.23.0",
+        "dotenv": "^17.4.2",
         "eslint": "^7.3.1",
         "eslint-config-airbnb-base": "^14.2.0",
         "eslint-plugin-import": "^2.21.2",

backend/src/core/api/index.js

@@ -3,6 +3,7 @@ import { UserResolver } from 'core/api/user/user.resolver';
 import { ApiDocument } from 'core/config/swagger.config';
 import { LawyerResolver } from 'core/api/lawyer/lawyer.resolver';
 import { UploadResolver } from 'core/api/upload';
+import { ReportsResolver } from './reports/reports.resolver';
 import { TemplateResolver } from 'core/api/template';
 import { DocumentResolver } from 'core/api/document';
 import { HandlerResolver } from '../../packages/handler/HandlerResolver';
@@ -22,6 +23,7 @@ export const ModuleResolver = HandlerResolver
         MediaResolver,
         LawyerResolver,
         UploadResolver,
+        ReportsResolver,
         LawResolver,
         TemplateResolver,
         DocumentResolver,

backend/src/core/api/lawyer/lawyer.resolver.js

@@ -1,7 +1,7 @@
 import { Module } from 'packages/handler/Module';
 import { RecordIdInterceptor } from 'core/modules/interceptor/recordId/record-id.interceptor';
 import { LawyerController } from './lawyer.controller';
-import { DefaultQueryCriteriaDocument } from '../../common/swagger/filter';
+import { DefaultQueryCriteriaDocument } from '../../common/swagger/lawyerFilter';
 import { RecordId } from '../../common/swagger/record-id';
 import { UpdateLawyerProfileInterceptor } from 'core/modules/lawyer/interceptor';
 import { hasLawyerRole } from 'core/modules/auth/guard';

backend/src/core/api/reports/reports.controller.js

@@ -0,0 +1,28 @@
+import { ReportsService } from '../../modules/reports/service/reports.service';
+import { ListReportsDto } from '../../modules/reports';
+import { ValidHttpResponse } from '../../../packages/handler/response/validHttp.response';
+
+class Controller {
+    constructor() {
+        this.service = ReportsService;
+    }
+
+    listReports = async req => {
+        const data = await this.service.listReports(req.query);
+        return ValidHttpResponse.toOkResponse(data);
+    }
+    getReportsStats = async req => {
+        const data = await this.service.getReportsStats(req.query);
+        return ValidHttpResponse.toOkResponse(data);
+    }
+    getReportById = async req => {
+        const data = await this.service.getReportById(req.params.id);
+        return ValidHttpResponse.toOkResponse(data);
+    }
+    getReportsHistory = async req => {
+        const data = await this.service.getReportsHistory(req.query);
+        return ValidHttpResponse.toOkResponse(data);
+    }
+}
+
+export const ReportsController = new Controller();

backend/src/core/api/reports/reports.resolver.js

@@ -0,0 +1,54 @@
+import {
+    GetReportsInterceptor
+} from 'core/modules/reports';
+import { Module } from 'packages/handler/Module';
+import { ReportsController } from './reports.controller';
+import { authMiddleware } from 'core/modules/auth/middleware/auth.middleware';
+import { uploadMediaSwagger } from 'core/common/swagger';
+import { MediaInterceptor } from 'core/modules/document';
+import { hasAdminRole } from 'core/modules/auth/guard';
+import { ListReportsParams, GetReportsStatsParams, GetReportsHistoryParams } from 'core/common/swagger/reportFilter';
+import { RecordIdInterceptor } from 'core/modules/interceptor/recordId/record-id.interceptor';
+import { RecordId } from 'core/common/swagger/record-id';
+
+export const ReportsResolver = Module.builder()
+    .addPrefix({
+        prefixPath: '/reports',
+        tag: 'reports',
+        module: 'ReportsModule'
+    })
+    .register([
+        {
+            route: '',
+            method: 'get',
+            params: ListReportsParams,
+            guards: [hasAdminRole],
+            controller: ReportsController.listReports,
+            preAuthorization: true,
+        },
+        {
+            route: '/:id',
+            method: 'get',
+            guards: [hasAdminRole],
+            params: [RecordId],
+            interceptor: [RecordIdInterceptor],
+            controller: ReportsController.getReportById,
+            preAuthorization: true,
+        },
+        {
+            route: '/stats',
+            method: 'get',
+            params: GetReportsStatsParams,
+            guards: [hasAdminRole],
+            controller: ReportsController.getReportsStats,
+            preAuthorization: true,
+        },
+        {
+            route: '/history',
+            method: 'get',
+            params: GetReportsHistoryParams,
+            guards: [hasAdminRole],
+            controller: ReportsController.getReportsHistory,
+            preAuthorization: true,
+        },
+    ]);

backend/src/core/api/user/user.resolver.js

@@ -9,7 +9,7 @@ import { hasAdminRole } from 'core/modules/auth/guard';
 import { RecordIdInterceptor } from 'core/modules/interceptor/recordId/record-id.interceptor';
 import { UserController } from './user.controller';
 import { RecordId } from '../../common/swagger/record-id';
-import { DefaultQueryCriteriaDocument } from '../../common/swagger/filter';
+import { DefaultQueryCriteriaDocument } from '../../common/swagger/lawyerFilter';
 
 export const UserResolver = Module.builder()
     .addPrefix({

backend/src/core/common/swagger/index.js

@@ -1,3 +1,3 @@
-export * from './filter';
+export * from './lawyerFilter';
 export * from './record-id';
 export * from './upload-file';