[Feat] Employee weekly schedule planning

packages/contracts/src/index.ts

@@ -40,6 +40,7 @@ export * from './lib/email-reset.model';
 export * from './lib/email-template.model';
 export * from './lib/email.model';
 export * from './lib/employee-appointment.model';
+export * from './lib/employee-availability.model';
 export * from './lib/employee-award.model';
 export * from './lib/employee-job.model';
 export * from './lib/employee-phone.model';

packages/contracts/src/lib/employee-availability.model.ts

@@ -0,0 +1,64 @@
+import { IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
+import { IEmployee } from './employee.model';
+
+/**
+ * Enum representing different availability statuses.
+ */
+export enum AvailabilityStatusEnum {
+	Available = 'Available',
+	Partial = 'Partial',
+	Unavailable = 'Unavailable'
+}
+
+/**
+ * Enum mapping availability statuses to numerical values.
+ */
+export enum AvailabilityStatusValue {
+	Available = 0,
+	Partial = 1,
+	Unavailable = 2
+}
+
+/**
+ * A mapping object to relate status labels to their respective numerical values.
+ */
+export const AvailabilityStatusMap: Record<AvailabilityStatusEnum, AvailabilityStatusValue> = {
+	[AvailabilityStatusEnum.Available]: AvailabilityStatusValue.Available,
+	[AvailabilityStatusEnum.Partial]: AvailabilityStatusValue.Partial,
+	[AvailabilityStatusEnum.Unavailable]: AvailabilityStatusValue.Unavailable
+};
+
+/**
+ * Base interface for Employee Availability data.
+ * Includes common properties shared across different input types.
+ */
+interface IBaseEmployeeAvailability extends IBasePerTenantAndOrganizationEntityModel {
+	employeeId: ID;
+	startDate: Date;
+	endDate: Date;
+	dayOfWeek: number; // 0 = Sunday, 6 = Saturday
+	availabilityStatus: AvailabilityStatusEnum;
+	availabilityNotes?: string;
+}
+
+/**
+ * Represents an Employee Availability record.
+ */
+export interface IEmployeeAvailability extends IBaseEmployeeAvailability {
+	employee: IEmployee;
+}
+
+/**
+ * Input interface for finding Employee Availability records.
+ */
+export interface IEmployeeAvailabilityFindInput extends Partial<IBaseEmployeeAvailability> {}
+
+/**
+ * Input interface for creating new Employee Availability records.
+ */
+export interface IEmployeeAvailabilityCreateInput extends IBaseEmployeeAvailability {}
+
+/**
+ * Input interface for updating Employee Availability records.
+ */
+export interface IEmployeeAvailabilityUpdateInput extends Partial<IBaseEmployeeAvailability> {}

packages/core/src/lib/core/entities/index.ts

@@ -32,6 +32,7 @@ import {
 	EmailTemplate,
 	Employee,
 	EmployeeAppointment,
+	EmployeeAvailability,
 	EmployeeAward,
 	EmployeeLevel,
 	EmployeePhone,
@@ -190,6 +191,7 @@ export const coreEntities = [
 	EmailTemplate,
 	Employee,
 	EmployeeAppointment,
+	EmployeeAvailability,
 	EmployeeAward,
 	EmployeeLevel,
 	EmployeePhone,

packages/core/src/lib/core/entities/internal.ts

@@ -36,6 +36,7 @@ export * from '../../email-history/email-history.entity';
 export * from '../../email-reset/email-reset.entity';
 export * from '../../email-template/email-template.entity';
 export * from '../../employee-appointment/employee-appointment.entity';
+export * from '../../employee-availability/employee-availability.entity';
 export * from '../../employee-award/employee-award.entity';
 export * from '../../employee-level/employee-level.entity';
 export * from '../../employee-phone/employee-phone.entity';

packages/core/src/lib/employee-availability/commands/employee-availability.bulk.create.command.ts

@@ -0,0 +1,8 @@
+import { ICommand } from '@nestjs/cqrs';
+import { IEmployeeAvailabilityCreateInput } from '@gauzy/contracts';
+
+export class EmployeeAvailabilityBulkCreateCommand implements ICommand {
+	static readonly type = '[Employee Availability Bulk] Create';
+
+	constructor(public readonly input: IEmployeeAvailabilityCreateInput[]) {}
+}

packages/core/src/lib/employee-availability/commands/employee-availability.create.command.ts

@@ -0,0 +1,8 @@
+import { ICommand } from '@nestjs/cqrs';
+import { IEmployeeAvailabilityCreateInput } from '@gauzy/contracts';
+
+export class EmployeeAvailabilityCreateCommand implements ICommand {
+	static readonly type = '[EmployeeAvailability] Create';
+
+	constructor(public readonly input: IEmployeeAvailabilityCreateInput) {}
+}

packages/core/src/lib/employee-availability/commands/handlers/employee-availability.bulk.create.handler.ts

@@ -0,0 +1,32 @@
+import { BadRequestException } from '@nestjs/common';
+import { CommandBus, CommandHandler, ICommandHandler } from '@nestjs/cqrs';
+import { IEmployeeAvailability } from '@gauzy/contracts';
+import { RequestContext } from '../../../core/context';
+import { EmployeeAvailabilityBulkCreateCommand } from '../employee-availability.bulk.create.command';
+import { EmployeeAvailability } from '../../employee-availability.entity';
+import { EmployeeAvailabilityCreateCommand } from '../employee-availability.create.command';
+
+@CommandHandler(EmployeeAvailabilityBulkCreateCommand)
+export class EmployeeAvailabilityBulkCreateHandler implements ICommandHandler<EmployeeAvailabilityBulkCreateCommand> {
+	constructor(private readonly commandBus: CommandBus) {}
+
+	public async execute(command: EmployeeAvailabilityBulkCreateCommand): Promise<IEmployeeAvailability[]> {
+		const { input } = command;
+		if (!Array.isArray(input) || input.length === 0) {
+			throw new BadRequestException('Input must be a non-empty array of availability records.');
+		}
+
+		const allAvailability: IEmployeeAvailability[] = [];
+		const tenantId = RequestContext.currentTenantId();
+
+		for (const item of input) {
+			let availability = new EmployeeAvailability({
+				...item,
+				tenantId
+			});
+			availability = await this.commandBus.execute(new EmployeeAvailabilityCreateCommand(availability));
+			allAvailability.push(availability);
+		}
+		return allAvailability;
+	}
+}

packages/core/src/lib/employee-availability/commands/handlers/employee-availability.create.handler.ts

@@ -0,0 +1,51 @@
+import { BadRequestException } from '@nestjs/common';
+import { CommandHandler, ICommandHandler } from '@nestjs/cqrs';
+import { IEmployeeAvailability } from '@gauzy/contracts';
+import { RequestContext } from '../../../core/context';
+import { EmployeeAvailabilityService } from '../../employee-availability.service';
+import { EmployeeAvailability } from '../../employee-availability.entity';
+import { EmployeeAvailabilityCreateCommand } from '../employee-availability.create.command';
+
+@CommandHandler(EmployeeAvailabilityCreateCommand)
+export class EmployeeAvailabilityCreateHandler implements ICommandHandler<EmployeeAvailabilityCreateCommand> {
+	constructor(private readonly availabilityService: EmployeeAvailabilityService) {}
+
+	/**
+	 * Handles the creation of an employee availability record.
+	 *
+	 * @param {EmployeeAvailabilityCreateCommand} command - The command containing employee availability details.
+	 * @returns {Promise<IEmployeeAvailability>} - The newly created employee availability record.
+	 * @throws {BadRequestException} - If any validation fails (e.g., missing fields, invalid dates).
+	 */
+	public async execute(command: EmployeeAvailabilityCreateCommand): Promise<IEmployeeAvailability> {
+		const { input } = command;
+		const { startDate, endDate, employeeId, dayOfWeek, availabilityStatus } = input;
+
+		if (!employeeId) {
+			throw new BadRequestException('Employee ID is required.');
+		}
+		if (typeof dayOfWeek !== 'number' || dayOfWeek < 0 || dayOfWeek > 6) {
+			throw new BadRequestException('Day of week must be a number between 0 and 6.');
+		}
+		if (!availabilityStatus) {
+			throw new BadRequestException('Availability status is required.');
+		}
+
+		if (!startDate || !endDate) {
+			throw new BadRequestException('Start date and end date are required.');
+		}
+
+		if (new Date(endDate) <= new Date(startDate)) {
+			throw new BadRequestException('End date must be after start date.');
+		}
+
+		const tenantId = RequestContext.currentTenantId();
+
+		const availability = new EmployeeAvailability({
+			...input,
+			tenantId
+		});
+
+		return await this.availabilityService.create(availability);
+	}
+}

packages/core/src/lib/employee-availability/commands/handlers/index.ts

@@ -0,0 +1,7 @@
+import { EmployeeAvailabilityBulkCreateHandler } from './employee-availability.bulk.create.handler';
+import { EmployeeAvailabilityCreateHandler } from './employee-availability.create.handler';
+
+/**
+ * Exports all command handlers for EmployeeAvailability.`
+ */
+export const CommandHandlers = [EmployeeAvailabilityBulkCreateHandler, EmployeeAvailabilityCreateHandler];

packages/core/src/lib/employee-availability/commands/index.ts

@@ -0,0 +1,2 @@
+export * from './employee-availability.bulk.create.command';
+export * from './employee-availability.create.command';

packages/core/src/lib/employee-availability/dto/create-employee-availability.dto.ts

@@ -0,0 +1,18 @@
+import { IEmployeeAvailabilityCreateInput } from '@gauzy/contracts';
+import { EmployeeAvailability } from '../employee-availability.entity';
+import { TenantOrganizationBaseDTO } from '../../core';
+import { IntersectionType, PartialType, PickType } from '@nestjs/swagger';
+
+export class CreateEmployeeAvailabilityDTO
+	extends IntersectionType(
+		PartialType(TenantOrganizationBaseDTO),
+		PickType(EmployeeAvailability, [
+			'dayOfWeek',
+			'startDate',
+			'endDate',
+			'availabilityNotes',
+			'availabilityStatus',
+			'employeeId'
+		])
+	)
+	implements IEmployeeAvailabilityCreateInput {}

packages/core/src/lib/employee-availability/dto/update-employee-availability.dto.ts

@@ -0,0 +1,8 @@
+import { PartialType } from '@nestjs/mapped-types';
+import { IEmployeeAvailabilityUpdateInput } from '@gauzy/contracts';
+import { CreateEmployeeAvailabilityDTO } from './create-employee-availability.dto';
+import { IntersectionType } from '@nestjs/swagger';
+
+export class UpdateEmployeeAvailabilityDTO
+	extends IntersectionType(PartialType(CreateEmployeeAvailabilityDTO))
+	implements IEmployeeAvailabilityUpdateInput {}

packages/core/src/lib/employee-availability/employee-availability.controller.ts

@@ -0,0 +1,113 @@
+import { UpdateResult } from 'typeorm';
+import { Body, Controller, Get, HttpCode, HttpStatus, Param, Post, Put, Query, UseGuards } from '@nestjs/common';
+import { CommandBus } from '@nestjs/cqrs';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { ID, IEmployeeAvailability, IPagination } from '@gauzy/contracts';
+import { EmployeeAvailabilityService } from './employee-availability.service';
+import { EmployeeAvailability } from './employee-availability.entity';
+import { CrudController, PaginationParams } from '../core';
+import { PermissionGuard, TenantPermissionGuard, UUIDValidationPipe } from '../shared';
+import { EmployeeAvailabilityBulkCreateCommand, EmployeeAvailabilityCreateCommand } from './commands';
+import { CreateEmployeeAvailabilityDTO } from './dto/create-employee-availability.dto';
+import { UpdateEmployeeAvailabilityDTO } from './dto/update-employee-availability.dto';
+
+@ApiTags('EmployeeAvailability')
+@UseGuards(TenantPermissionGuard, PermissionGuard)
+@Controller('/employee-availability')
+export class EmployeeAvailabilityController extends CrudController<EmployeeAvailability> {
+	constructor(
+		private readonly availabilityService: EmployeeAvailabilityService,
+		private readonly commandBus: CommandBus
+	) {
+		super(availabilityService);
+	}
+
+	/**
+	 * Create multiple employee availability records in bulk.
+	 *
+	 * @param entities List of availability records to create
+	 * @returns The created availability records
+	 */
+	@ApiOperation({ summary: 'Create multiple availability records' })
+	@ApiResponse({
+		status: HttpStatus.CREATED,
+		description: 'The records have been successfully created.'
+	})
+	@ApiResponse({
+		status: HttpStatus.BAD_REQUEST,
+		description: 'Invalid input. The response body may contain clues as to what went wrong.'
+	})
+	@HttpCode(HttpStatus.CREATED)
+	@Post('/bulk')
+	async createBulk(@Body() entities: CreateEmployeeAvailabilityDTO[]): Promise<IEmployeeAvailability[]> {
+		return await this.commandBus.execute(new EmployeeAvailabilityBulkCreateCommand(entities));
+	}
+
+	/**
+	 * Retrieve all employee availability records.
+	 *
+	 * @param data Query parameters, including relations and filters
+	 * @returns A paginated list of availability records
+	 */
+	@ApiOperation({ summary: 'Retrieve all availability records' })
+	@ApiResponse({
+		status: HttpStatus.OK,
+		description: 'Successfully retrieved availability records.'
+	})
+	@ApiResponse({
+		status: HttpStatus.NOT_FOUND,
+		description: 'No availability records found.'
+	})
+	@Get()
+	async findAll(
+		@Query() filter: PaginationParams<EmployeeAvailability>
+	): Promise<IPagination<IEmployeeAvailability>> {
+		return this.availabilityService.findAll(filter);
+	}
+
+	/**
+	 * Create a new employee availability record.
+	 *
+	 * @param entity The data for the new availability record
+	 * @returns The created availability record
+	 */
+	@ApiOperation({ summary: 'Create a new availability record' })
+	@ApiResponse({
+		status: HttpStatus.CREATED,
+		description: 'The record has been successfully created.'
+	})
+	@ApiResponse({
+		status: HttpStatus.BAD_REQUEST,
+		description: 'Invalid input. The response body may contain clues as to what went wrong.'
+	})
+	@HttpCode(HttpStatus.CREATED)
+	@Post()
+	async create(@Body() entity: CreateEmployeeAvailabilityDTO): Promise<IEmployeeAvailability> {
+		return await this.commandBus.execute(new EmployeeAvailabilityCreateCommand(entity));
+	}
+
+	/**
+	 * Update an existing employee availability record by its ID.
+	 *
+	 * @param id The ID of the availability record
+	 * @param entity The updated data for the record
+	 * @returns The updated availability record
+	 */
+	@ApiOperation({ summary: 'Update an existing availability record' })
+	@ApiResponse({
+		status: HttpStatus.ACCEPTED,
+		description: 'The record has been successfully updated.'
+	})
+	@ApiResponse({
+		status: HttpStatus.BAD_REQUEST,
+		description: 'Invalid input. The response body may contain clues as to what went wrong.'
+	})
+	@HttpCode(HttpStatus.ACCEPTED)
+	@Put(':id')
+	async update(
+		@Param('id', UUIDValidationPipe) id: ID,
+		@Body() entity: UpdateEmployeeAvailabilityDTO
+	): Promise<IEmployeeAvailability | UpdateResult> {
+		return this.availabilityService.update(id, { ...entity });
+	}
+}