@hed-hog/finance 0.0.279 → 0.0.285

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hed-hog/finance",
-  "version": "0.0.279",
+  "version": "0.0.285",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
@@ -9,14 +9,14 @@
     "@nestjs/core": "^11",
     "@nestjs/jwt": "^11",
     "@nestjs/mapped-types": "*",
-    "@hed-hog/tag": "0.0.279",
-    "@hed-hog/contact": "0.0.279",
     "@hed-hog/api-prisma": "0.0.5",
     "@hed-hog/api": "0.0.4",
-    "@hed-hog/api-locale": "0.0.13",
-    "@hed-hog/core": "0.0.279",
     "@hed-hog/api-types": "0.0.1",
-    "@hed-hog/api-pagination": "0.0.6"
+    "@hed-hog/core": "0.0.285",
+    "@hed-hog/contact": "0.0.285",
+    "@hed-hog/api-locale": "0.0.13",
+    "@hed-hog/api-pagination": "0.0.6",
+    "@hed-hog/tag": "0.0.285"
   },
   "exports": {
     ".": {

package/src/dto/finance-report-query.dto.ts

@@ -0,0 +1,49 @@
+import { Transform, Type } from 'class-transformer';
+import {
+    IsDateString,
+    IsEnum,
+    IsInt,
+    IsOptional,
+    IsString,
+    Max,
+    Min,
+} from 'class-validator';
+
+export enum FinanceReportGroupBy {
+  day = 'day',
+  week = 'week',
+  month = 'month',
+  year = 'year',
+}
+
+export class FinanceReportQueryDto {
+  @IsOptional()
+  @IsDateString({}, { message: 'from must be a valid date' })
+  from?: string;
+
+  @IsOptional()
+  @IsDateString({}, { message: 'to must be a valid date' })
+  to?: string;
+
+  @IsOptional()
+  @IsEnum(FinanceReportGroupBy, {
+    message: 'groupBy must be one of: day, week, month, year',
+  })
+  groupBy?: FinanceReportGroupBy;
+}
+
+export class FinanceRankingReportQueryDto extends FinanceReportQueryDto {
+  @IsOptional()
+  @Type(() => Number)
+  @IsInt({ message: 'topN must be an integer number' })
+  @Min(1, { message: 'topN must be greater than zero' })
+  @Max(100, { message: 'topN must be less than or equal to 100' })
+  topN?: number;
+
+  @IsOptional()
+  @Transform(({ value }) =>
+    typeof value === 'string' ? value.trim() : value,
+  )
+  @IsString({ message: 'search must be a string' })
+  search?: string;
+}

package/src/finance-reports.controller.ts

@@ -0,0 +1,28 @@
+import { Role } from '@hed-hog/api';
+import { Controller, Get, Query } from '@nestjs/common';
+import {
+    FinanceRankingReportQueryDto,
+    FinanceReportQueryDto,
+} from './dto/finance-report-query.dto';
+import { FinanceService } from './finance.service';
+
+@Role()
+@Controller('finance')
+export class FinanceReportsController {
+  constructor(private readonly financeService: FinanceService) {}
+
+  @Get('reports/overview-results')
+  async getOverviewResults(@Query() query: FinanceReportQueryDto) {
+    return this.financeService.getOverviewResultsReport(query);
+  }
+
+  @Get('reports/top-customers')
+  async getTopCustomers(@Query() query: FinanceRankingReportQueryDto) {
+    return this.financeService.getTopCustomersReport(query);
+  }
+
+  @Get('reports/top-operational-expenses')
+  async getTopOperationalExpenses(@Query() query: FinanceRankingReportQueryDto) {
+    return this.financeService.getTopOperationalExpensesReport(query);
+  }
+}

package/src/finance.module.ts

@@ -12,6 +12,7 @@ import { FinanceCostCentersController } from './finance-cost-centers.controller'
 import { FinanceDataController } from './finance-data.controller';
 import { FinanceInstallmentsController } from './finance-installments.controller';
 import { FinancePeriodCloseController } from './finance-period-close.controller';
+import { FinanceReportsController } from './finance-reports.controller';
 import { FinanceStatementsController } from './finance-statements.controller';
 import { FinanceTransfersController } from './finance-transfers.controller';
 import { FinanceService } from './finance.service';
@@ -29,6 +30,7 @@ import { FinanceService } from './finance.service';
     FinanceAuditLogsController,
     FinanceDataController,
     FinanceInstallmentsController,
+    FinanceReportsController,
     FinanceBankAccountsController,
     FinanceCategoriesController,
     FinanceCollectionsController,