[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/contracts/src/lib/role-permission.model.ts

@@ -224,11 +224,15 @@ export enum PermissionsEnum {
 	DASHBOARD_READ = 'DASHBOARD_READ',
 	DASHBOARD_UPDATE = 'DASHBOARD_UPDATE',
 	DASHBOARD_DELETE = 'DASHBOARD_DELETE',
-
 	/** Tenant API Key */
 	TENANT_API_KEY_CREATE = 'TENANT_API_KEY_CREATE',
 	TENANT_API_KEY_VIEW = 'TENANT_API_KEY_VIEW',
-	TENANT_API_KEY_DELETE = 'TENANT_API_KEY_DELETE'
+	TENANT_API_KEY_DELETE = 'TENANT_API_KEY_DELETE',
+	/** Employee Availability CRUD Permissions Start */
+	EMPLOYEE_AVAILABILITY_CREATE = 'EMPLOYEE_AVAILABILITY_CREATE',
+	EMPLOYEE_AVAILABILITY_READ = 'EMPLOYEE_AVAILABILITY_READ',
+	EMPLOYEE_AVAILABILITY_UPDATE = 'EMPLOYEE_AVAILABILITY_UPDATE',
+	EMPLOYEE_AVAILABILITY_DELETE = 'EMPLOYEE_AVAILABILITY_DELETE'
 }
 
 export const PermissionGroups = {
@@ -401,7 +405,12 @@ export const PermissionGroups = {
 		PermissionsEnum.ALLOW_MANUAL_TIME,
 		PermissionsEnum.DELETE_SCREENSHOTS,
 		PermissionsEnum.ACCESS_DELETE_ACCOUNT,
-		PermissionsEnum.ORG_MEMBER_LAST_LOG_VIEW
+		PermissionsEnum.ORG_MEMBER_LAST_LOG_VIEW,
+		/** Employee Availability CRUD Permissions Start */
+		PermissionsEnum.EMPLOYEE_AVAILABILITY_CREATE,
+		PermissionsEnum.EMPLOYEE_AVAILABILITY_READ,
+		PermissionsEnum.EMPLOYEE_AVAILABILITY_UPDATE,
+		PermissionsEnum.EMPLOYEE_AVAILABILITY_DELETE
 	],
 
 	//Readonly permissions, are only enabled for Super Admin/Admin role

packages/core/src/lib/core/crud/crud.service.ts

@@ -16,10 +16,10 @@
 import { QueryDeepPartialEntity } from 'typeorm/query-builder/QueryPartialEntity';
 import { Collection, CreateOptions, FilterQuery as MikroFilterQuery, RequiredEntityData, wrap } from '@mikro-orm/core';
 import { AssignOptions } from '@mikro-orm/knex';
-import { IPagination } from '@gauzy/contracts';
+import { ID, IPagination } from '@gauzy/contracts';
 import { BaseEntity, SoftDeletableBaseEntity } from '../entities/internal';
 import { multiORMCreateQueryBuilder } from '../../core/orm/query-builder/query-builder.factory';
 import { IQueryBuilder } from '../../core/orm/query-builder/iquery-builder';
 import { MikroOrmBaseEntityRepository } from '../../core/repository/mikro-orm-base-entity.repository';
 import {
 	MultiORM,
@@ -45,7 +45,6 @@
 const ormType: MultiORM = getORMType();
 
 export abstract class CrudService<T extends BaseEntity> implements ICrudService<T> {
-
 	constructor(
 		protected readonly typeOrmRepository: Repository<T>,
 		protected readonly mikroOrmRepository: MikroOrmBaseEntityRepository<T>
@@ -347,7 +346,7 @@
 	 * @param options
 	 * @returns
 	 */
-	public async findOneByIdString(id: T['id'], options?: IFindOneOptions<T>): Promise<T> {
+	public async findOneByIdString(id: ID, options?: IFindOneOptions<T>): Promise<T> {
 		let record: T;
 
 		switch (this.ormType) {
@@ -645,7 +644,7 @@
 	 * @param saveOptions - Additional save options for the ORM operation (specific to TypeORM).
 	 * @returns A promise that resolves to the softly removed entity.
 	 */
-	public async softRemove(id: T['id'], options?: IFindOneOptions<T>, saveOptions?: SaveOptions): Promise<T> {
+	public async softRemove(id: ID, options?: IFindOneOptions<T>, saveOptions?: SaveOptions): Promise<T> {
 		try {
 			switch (this.ormType) {
 				case MultiORMEnum.MikroORM: {
@@ -681,7 +680,7 @@
 	 * @param options - Optional settings for database save operations.
 	 * @returns A promise that resolves with the recovered entity.
 	 */
-	public async softRecover(id: T['id'], options?: IFindOneOptions<T>, saveOptions?: SaveOptions): Promise<T> {
+	public async softRecover(id: ID, options?: IFindOneOptions<T>, saveOptions?: SaveOptions): Promise<T> {
 		try {
 			switch (this.ormType) {
 				case MultiORMEnum.MikroORM: {

packages/core/src/lib/core/crud/tenant-aware-crud.service.ts

@@ -1,7 +1,7 @@
 import { NotFoundException } from '@nestjs/common';
 import { DeleteResult, FindOptionsWhere, FindManyOptions, FindOneOptions, Repository, UpdateResult } from 'typeorm';
 import { QueryDeepPartialEntity } from 'typeorm/query-builder/QueryPartialEntity';
-import { IPagination, IUser, PermissionsEnum } from '@gauzy/contracts';
+import { ID, IPagination, IUser, PermissionsEnum } from '@gauzy/contracts';
 import { isNotEmpty } from '@gauzy/utils';
 import { MikroOrmBaseEntityRepository } from '../../core/repository/mikro-orm-base-entity.repository';
 import { RequestContext } from '../context';
@@ -239,7 +239,7 @@ export abstract class TenantAwareCrudService<T extends TenantBaseEntity>
 	 * @param options
 	 * @returns
 	 */
-	public async findOneOrFailByIdString(id: T['id'], options?: FindOneOptions<T>): Promise<ITryRequest<T>> {
+	public async findOneOrFailByIdString(id: ID, options?: FindOneOptions<T>): Promise<ITryRequest<T>> {
 		return await super.findOneOrFailByIdString(id, this.findOneWithTenant(options));
 	}
 
@@ -282,7 +282,7 @@ export abstract class TenantAwareCrudService<T extends TenantBaseEntity>
 	 * @param options
 	 * @returns
 	 */
-	public async findOneByIdString(id: T['id'], options?: FindOneOptions<T>): Promise<T> {
+	public async findOneByIdString(id: ID, options?: FindOneOptions<T>): Promise<T> {
 		return await super.findOneByIdString(id, this.findOneWithTenant(options));
 	}
 

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';