Merge pull request #8547 from ever-co/feat/add-timesheet-status-filter

[Enhancement] Add Timesheet status filter
ever-co · Nov 19, 2024 · 82a2e42 · 82a2e42
2 parents 1489cf2 + 9622255
commit 82a2e42
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 9 deletions.
diff --git a/packages/contracts/src/timesheet.model.ts b/packages/contracts/src/timesheet.model.ts
@@ -89,6 +89,8 @@ export interface IGetTimesheetInput extends IBasePerTenantAndOrganizationEntityM
 	projectIds?: ID[];
 	clientId?: ID[];
 	employeeIds?: ID[];
+	status?: TimesheetStatus[];
+	taskIds?: ID[];
 }
 
 export interface IDateRange {
@@ -191,6 +193,7 @@ export interface ITimeLogFilters extends IBasePerTenantAndOrganizationEntityMode
 	categoryId?: ID;
 	timeZone?: string;
 	timeFormat?: TimeFormatEnum;
+	status?: TimesheetStatus[];
 }
 
 export interface ITimeLogTodayFilters extends IBasePerTenantAndOrganizationEntityModel {

diff --git a/packages/core/src/time-tracking/timesheet/dto/query/timesheet-query.dto.ts b/packages/core/src/time-tracking/timesheet/dto/query/timesheet-query.dto.ts
@@ -1,11 +1,23 @@
-import { IGetTimesheetInput } from "@gauzy/contracts";
-import { IntersectionType } from "@nestjs/swagger";
-import { RelationsQueryDTO, SelectorsQueryDTO } from "./../../../../shared/dto";
+import { IGetTimesheetInput } from '@gauzy/contracts';
+import { IntersectionType } from '@nestjs/swagger';
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { IsOptional, IsArray } from 'class-validator';
+import { TimesheetStatus } from '@gauzy/contracts';
+import { RelationsQueryDTO, SelectorsQueryDTO } from './../../../../shared/dto';
 
 /**
  * Get timesheet request DTO validation
  */
-export class TimesheetQueryDTO extends IntersectionType(
-    RelationsQueryDTO,
-    SelectorsQueryDTO
-) implements IGetTimesheetInput {}
+export class TimesheetQueryDTO
+	extends IntersectionType(RelationsQueryDTO, SelectorsQueryDTO)
+	implements IGetTimesheetInput
+{
+	/**
+	 * An array of status  to filter the time logs by specific status.
+	 * If not provided, no filtering by status will be applied.
+	 */
+	@ApiPropertyOptional({ type: () => Array, isArray: true })
+	@IsOptional()
+	@IsArray()
+	status: TimesheetStatus[];
+}
diff --git a/packages/core/src/time-tracking/timesheet/timesheet.service.ts b/packages/core/src/time-tracking/timesheet/timesheet.service.ts
@@ -1,7 +1,7 @@
 import { Injectable } from '@nestjs/common';
 import { Between, In, SelectQueryBuilder, Brackets, WhereExpressionBuilder } from 'typeorm';
 import * as moment from 'moment';
-import { IGetTimesheetInput, PermissionsEnum, ITimesheet } from '@gauzy/contracts';
+import { IGetTimesheetInput, PermissionsEnum, ITimesheet, TimesheetStatus } from '@gauzy/contracts';
 import { RequestContext } from './../../core/context';
 import { TenantAwareCrudService } from './../../core/crud';
 import { getDateRangeFormat } from './../../core/utils';
@@ -84,7 +84,15 @@ export class TimeSheetService extends TenantAwareCrudService<Timesheet> {
 	 * @returns
 	 */
 	async getFilterTimesheetQuery(qb: SelectQueryBuilder<Timesheet>, request: IGetTimesheetInput) {
-		let { organizationId, startDate, endDate, onlyMe: isOnlyMeSelected, employeeIds = [] } = request;
+		let {
+			organizationId,
+			startDate,
+			endDate,
+			onlyMe: isOnlyMeSelected,
+			employeeIds = [],
+			status = [],
+			taskIds = []
+		} = request;
 
 		const tenantId = RequestContext.currentTenantId() ?? request.tenantId; // Retrieve the tenant ID from the request
 		const user = RequestContext.currentUser(); // Retrieve the current user
@@ -108,6 +116,12 @@ export class TimeSheetService extends TenantAwareCrudService<Timesheet> {
 			new Brackets((qb: WhereExpressionBuilder) => {
 				qb.where({
 					startedAt: Between(start, end),
+					...(status.length > 0
+						? {
+								status: In(status.filter((s) => Object.values(TimesheetStatus).includes(s)))
+						  }
+						: {}),
+					...(taskIds.length > 0 ? { taskId: In(taskIds) } : {}),
 					...(employeeIds.length > 0 ? { employeeId: In(employeeIds) } : {})
 				});
 			})
@@ -116,6 +130,7 @@ export class TimeSheetService extends TenantAwareCrudService<Timesheet> {
 		// Additional conditions for filtering by tenantId and organizationId
 		qb.andWhere(p(`"${qb.alias}"."tenantId" = :tenantId`), { tenantId });
 		qb.andWhere(p(`"${qb.alias}"."organizationId" = :organizationId`), { organizationId });
+
 		return qb;
 	}
 }