[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,55 @@
+import { IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
+import { IEmployee } from './employee.model';
+
+/**
+ * Enum representing the availability status of an employee.
+ */
+export enum AvailabilityStatusEnum {
+	Available = 'Available',
+	Partial = 'Partial',
+	Unavailable = 'Unavailable'
+}
+
+export interface IEmployeeAvailability extends IBasePerTenantAndOrganizationEntityModel {
+	employee: IEmployee;
+	employeeId: ID;
+	startDate: Date;
+	endDate: Date;
+	dayOfWeek: number; // 0 = Sunday, 6 = Saturday
+	availabilityStatus: AvailabilityStatusEnum;
+	availabilityNotes?: string;
+}
+
+/**
+ * Input interface for finding Employee Availability records.
+ */
+export interface IEmployeeAvailabilityFindInput {
+	employeeId?: ID;
+	availabilityStatus?: AvailabilityStatusEnum;
+	startDate?: Date;
+	endDate?: Date;
+}
+
+/**
+ * Input interface for creating new Employee Availability records.
+ */
+export interface IEmployeeAvailabilityCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+	employeeId: ID;
+	startDate: Date;
+	endDate: Date;
+	dayOfWeek: number; // 0 = Sunday, 6 = Saturday
+	availabilityStatus: AvailabilityStatusEnum;
+	availabilityNotes?: string;
+}
+
+/**
+ * Input interface for updating Employee Availability records.
+ */
+export interface IEmployeeAvailabilityUpdateInput extends IBasePerTenantAndOrganizationEntityModel {
+	employeeId?: ID;
+	startDate?: Date;
+	endDate?: Date;
+	dayOfWeek?: number; // 0 = Sunday, 6 = Saturday
+	availabilityStatus?: AvailabilityStatusEnum;
+	availabilityNotes?: string;
+}

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 Bulk Availability ] 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,27 @@
+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;
+		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,28 @@
+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';
+import { BadRequestException } from '@nestjs/common';
+
+@CommandHandler(EmployeeAvailabilityCreateCommand)
+export class EmployeeAvailabilityCreateHandler implements ICommandHandler<EmployeeAvailabilityCreateCommand> {
+	constructor(private readonly availabilityService: EmployeeAvailabilityService) {}
+
+	public async execute(command: EmployeeAvailabilityCreateCommand): Promise<IEmployeeAvailability> {
+		const { input } = command;
+		const { startDate, endDate } = input;
+		if (!startDate || !endDate) {
+			throw new BadRequestException('Start date and end date are required.');
+		}
+		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,2 @@
+export * from './employee-availability.bulk.create.handler';
+export * from './employee-availability.create.handler';

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

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

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

@@ -0,0 +1,111 @@
+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, IEmployeeAvailabilityCreateInput, IPagination } from '@gauzy/contracts';
+import { EmployeeAvailabilityService } from './employee-availability.service';
+import { EmployeeAvailability } from './employee-availability.entity';
+import { CrudController, PaginationParams } from '../core';
+import { TenantPermissionGuard, UUIDValidationPipe } from '../shared';
+import { EmployeeAvailabilityBulkCreateCommand, EmployeeAvailabilityCreateCommand } from './commands';
+
+@ApiTags('EmployeeAvailability')
+@UseGuards(TenantPermissionGuard)
+@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: IEmployeeAvailabilityCreateInput[]): 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: IEmployeeAvailabilityCreateInput): 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: IEmployeeAvailability
+	): Promise<IEmployeeAvailability | UpdateResult> {
+		return this.availabilityService.update(id, { ...entity });
+	}
+}

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

@@ -0,0 +1,67 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { IsNotEmpty, IsString, IsDate, IsInt, IsOptional, IsEnum } from 'class-validator';
+import { JoinColumn, RelationId } from 'typeorm';
+import { AvailabilityStatusEnum, ID, IEmployeeAvailability } from '@gauzy/contracts';
+import { Employee, TenantOrganizationBaseEntity } from '../core/entities/internal';
+import { MultiORMColumn, MultiORMEntity, MultiORMManyToOne } from './../core/decorators/entity';
+import { AvailabilityStatusTransformer } from '../shared/pipes/employee-availability-status.pipe';
+
+@MultiORMEntity('employee_availability')
+export class EmployeeAvailability extends TenantOrganizationBaseEntity implements IEmployeeAvailability {
+	@ApiProperty({ type: () => Date })
+	@IsDate()
+	@IsNotEmpty()
+	@MultiORMColumn()
+	startDate: Date;
+
+	@ApiProperty({ type: () => Date })
+	@IsDate()
+	@IsNotEmpty()
+	@MultiORMColumn()
+	endDate: Date;
+
+	@ApiProperty({ type: () => Number, description: 'Day of the week (0 = Sunday, 6 = Saturday)' })
+	@IsInt()
+	@IsNotEmpty()
+	@MultiORMColumn({ check: 'day_of_week BETWEEN 0 AND 6' })
+	dayOfWeek: number;
+
+	@ApiProperty({ enum: AvailabilityStatusEnum })
+	@IsOptional()
+	@IsEnum(AvailabilityStatusEnum)
+	@MultiORMColumn({
+		type: 'int',
+		transformer: new AvailabilityStatusTransformer()
+	})
+	availabilityStatus: AvailabilityStatusEnum;
+
+	@ApiPropertyOptional({
+		type: () => String,
+		description: 'Optional notes (e.g., "Available until 2 PM")',
+		required: false
+	})
+	@IsString()
+	@IsOptional()
+	@MultiORMColumn({ nullable: true })
+	availabilityNotes?: string;
+
+	/*
+	|--------------------------------------------------------------------------
+	| @ManyToOne
+	|--------------------------------------------------------------------------
+	*/
+
+	/**
+	 * Employee
+	 */
+	@MultiORMManyToOne(() => Employee, {
+		onDelete: 'CASCADE'
+	})
+	@JoinColumn()
+	employee: Employee;
+
+	@ApiProperty({ type: () => String })
+	@RelationId((it: EmployeeAvailability) => it.employee)
+	@MultiORMColumn()
+	employeeId: ID;
+}

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

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { EmployeeAvailabilityService } from './employee-availability.service';
+import { EmployeeAvailabilityController } from './employee-availability.controller';
+
+@Module({
+	providers: [EmployeeAvailabilityService],
+	controllers: [EmployeeAvailabilityController]
+})
+export class EmployeeAvailabilityModule {}

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

@@ -0,0 +1,15 @@
+import { Injectable } from '@nestjs/common';
+import { TypeOrmEmployeeAvailabilityRepository } from './repository/type-orm-employee-availability.repository';
+import { MikroOrmEmployeeAvailabilityRepository } from './repository/micro-orm-employee-availability.repository';
+import { TenantAwareCrudService } from './../core/crud';
+import { EmployeeAvailability } from './employee-availability.entity';
+
+@Injectable()
+export class EmployeeAvailabilityService extends TenantAwareCrudService<EmployeeAvailability> {
+	constructor(
+		typeOrmEmployeeAvailabilityRepository: TypeOrmEmployeeAvailabilityRepository,
+		mikroOrmEmployeeAvailabilityRepository: MikroOrmEmployeeAvailabilityRepository
+	) {
+		super(typeOrmEmployeeAvailabilityRepository, mikroOrmEmployeeAvailabilityRepository);
+	}
+}

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

@@ -0,0 +1,3 @@
+export { EmployeeAvailability } from './employee-availability.entity';
+export { EmployeeAvailabilityModule } from './employee-availability.module';
+export { EmployeeAvailabilityService } from './employee-availability.service';

packages/core/src/lib/employee-availability/repository/micro-orm-employee-availability.repository.ts

@@ -0,0 +1,4 @@
+import { MikroOrmBaseEntityRepository } from '../../core/repository/mikro-orm-base-entity.repository';
+import { EmployeeAvailability } from '../employee-availability.entity';
+
+export class MikroOrmEmployeeAvailabilityRepository extends MikroOrmBaseEntityRepository<EmployeeAvailability> {}

packages/core/src/lib/employee-availability/repository/type-orm-employee-availability.repository.ts

@@ -0,0 +1,11 @@
+import { Injectable } from '@nestjs/common';
+import { InjectRepository } from '@nestjs/typeorm';
+import { Repository } from 'typeorm';
+import { EmployeeAvailability } from '../employee-availability.entity';
+
+@Injectable()
+export class TypeOrmEmployeeAvailabilityRepository extends Repository<EmployeeAvailability> {
+	constructor(@InjectRepository(EmployeeAvailability) readonly repository: Repository<EmployeeAvailability>) {
+		super(repository.target, repository.manager, repository.queryRunner);
+	}
+}