@seniorsistemas/hcm-clocking-event-rule-nodejs 0.35.0

package/src/data/schedules/bridge.ts

@@ -0,0 +1,84 @@
+import { ObjectUtils } from "src/utils/object.utils";
+
+/**
+ * @hidden
+ * Parâmetros para criar uma programação de Bridge.
+ * @param originDate Data de origem da ponte.
+ * @param destinationDate Data de destino da ponte.
+ * @typedef {Object} BridgeParams
+ */
+export interface BridgeParams {
+    originDate: Date;
+    destinationDate: Date;
+}
+
+/**
+ * Representa uma programação de ponte entre dois dias.
+ * Uma ponte é uma programação onde há a troca de horários entre um dia útil com um dia não trabalhado, um feriado, por exemplo.
+ * @example
+ * ```typescript
+ * bridge.originDate; // Retorna a data de origem da ponte.
+ * bridge.destinationDate; // Retorna a data de destino da ponte.
+ * ```
+ */
+export class Bridge {
+    /**
+     * Data de origem da ponte.
+     * @param originDate Data de origem da ponte.
+     */
+    private readonly _originDate: Date;
+    /**
+     * Data de destino da ponte.
+     * @param destinationDate Data de destino da ponte.
+     */
+    private readonly _destinationDate: Date;
+
+    /**
+     * @hidden
+     */
+    constructor(params: BridgeParams) {
+        this._originDate = ObjectUtils.toDateOrThrow(params.originDate, "bridge.originDate");
+        this._destinationDate = ObjectUtils.toDateOrThrow(params.destinationDate, "bridge.destinationDate");
+    }
+
+    /**
+     * Data de origem da ponte.
+     * 
+     * @example
+     * ```typescript
+     * let originDate = bridge.originDate; // Retorna a data de origem da ponte.
+     * ```
+     * @returns Data de origem da ponte.
+     */
+    get originDate(): Date {
+        return this._originDate;
+    }
+
+    /**
+     * Data de destino da ponte.
+     * 
+     * @example
+     * ```typescript
+     * let destinationDate = bridge.destinationDate; // Retorna a data de destino da ponte.
+     * ```
+     * 
+     * @returns Data de destino da ponte.
+     */
+    get destinationDate(): Date {
+        return this._destinationDate;
+    }
+
+    /**
+     * Clona a instância de Bridge.
+     * 
+     * @returns Uma nova instância de Bridge com os mesmos valores de origem e destino.
+     */
+    public static clone(object: Bridge): Bridge {
+        return new Bridge({
+            originDate: object.originDate,
+            destinationDate: object.destinationDate,
+        });
+    }
+
+}
+

package/src/data/schedules/compensation.ts

@@ -0,0 +1,332 @@
+import { ObjectUtils } from "../../utils/object.utils";
+import { Situation } from "../foundation/situation";
+import { Workschedule } from "../foundation/workschedule";
+import { ContextReference } from "../context/contextReference";
+
+
+/**
+ * @hidden
+ * Parâmetros para criar uma programação de Compensation.
+ * @param startDate Data inicial da compensação.
+ * @param endDate Data final da compensação.
+ * @param intervalStart Hora inicial do intervalo de compensação.
+ * @param intervalEnd Hora final do intervalo de compensação.
+ * @param compensationType Tipo de compensação (ex: extra para compensação, ausência para compensação).
+ * @param periodType Tipo de período (ex: início e fim do expediente, qualquer parte do expediente).
+ * @param numberOfHours Número de horas a serem compensadas.
+ * @param situationId ID da situação da compensação.
+ * @param workscheduleId ID do horário de trabalho associado à compensação.
+ * 
+ * @typedef {Object} CompensationParams
+ */
+export interface CompensationParams {
+    startDate: Date;
+    endDate: Date;
+    intervalStart: number;
+    intervalEnd: number;
+    compensationType: CompensationType;
+    periodType: PeriodType;
+    numberOfHours: number;
+    situationId: string;
+    workscheduleId: string;
+}
+
+/**
+ * Representa uma programação de compensação de horas.
+ * Uma compensação permite que o colaborador compense horas em um período específico.
+ * 
+ * @example
+ * ```typescript
+ * compensation.startDate; // Retorna a data inicial da compensação.
+ * compensation.endDate; // Retorna a data final da compensação.
+ * compensation.intervalStart; // Retorna a hora inicial do intervalo em minutos (0-1439).
+ * compensation.intervalEnd; // Retorna a hora final do intervalo em minutos (0-1439).
+ * compensation.compensationType; // Retorna o tipo de compensação (ex: extra para compensação, ausência para compensação).
+ * compensation.periodType; // Retorna o tipo de período (ex: início e fim do expediente, qualquer parte do expediente).
+ * compensation.numberOfHours; // Retorna o número de horas a serem compensadas.
+ * compensation.situation; // Retorna a situação da compensação.
+ * compensation.workschedule; // Retorna o horário associado à compensação.
+ * ```
+ * @see {@link CompensationType}
+ * @see {@link PeriodType}
+ * 
+ */
+export class Compensation {
+    private readonly _startDate: Date;
+    private readonly _endDate: Date;
+    private readonly _intervalStart: number;
+    private readonly _intervalEnd: number;
+    private readonly _compensationType: CompensationType;
+    private readonly _periodType: PeriodType;
+    private readonly _numberOfHours: number;
+    private readonly _situationId: string;
+    private readonly _workscheduleId: string;
+
+    /**
+     * @hidden
+     * Parâmetros para criar uma programação de compensação de horas.
+     */
+    constructor(params: CompensationParams) {
+        this._startDate = ObjectUtils.toDateOrThrow(params.startDate, "compensation.startDate");
+        this._endDate = ObjectUtils.toDateOrThrow(params.endDate, "compensation.endDate");
+        this._intervalStart = params.intervalStart;
+        this._intervalEnd = params.intervalEnd;
+        this._compensationType = params.compensationType;
+        this._periodType = params.periodType;
+        this._numberOfHours = params.numberOfHours;
+        this._situationId = params.situationId;
+        this._workscheduleId = params.workscheduleId;
+    }
+
+    /**
+     * Data inicial da compensação.
+     * 
+     * @example
+     * ```typescript
+     * let startDate = compensation.startDate; // Retorna a data inicial da compensação.
+     * ```     
+     * @returns Data inicial da compensação.
+     */
+    get startDate(): Date {
+        return this._startDate;
+    }
+
+    /**
+     * Data final da compensação.
+     * 
+     * @example
+     * ```typescript
+     * let endDate = compensation.endDate; // Retorna a data final da compensação.
+     * ``` 
+     * @returns Data final da compensação.
+     */
+    get endDate(): Date {
+        return this._endDate;
+    }
+
+    /**
+     * Hora inicial do intervalo de compensação em minutos (0-1439).
+     * 
+     * @example
+     * ```typescript
+     * let startInterval = compensation.intervalStart; // Retorna a hora inicial do intervalo em minutos.
+     * ```
+     * @returns Hora inicial do intervalo em minutos se houver.
+     */
+    get intervalStart(): number {
+        return this._intervalStart;
+    }
+
+    /**
+     * Hora final do intervalo de compensação em minutos (0-1439).
+     * 
+     * @example
+     * ```typescript
+     * let endInterval = compensation.intervalEnd; // Retorna a hora final do intervalo.
+     * ```
+     * @returns Hora final do intervalo em minutos se houver.
+     */
+    get intervalEnd(): number {
+        return this._intervalEnd;
+    }
+
+    /**
+     * Tipo de compensação.
+     * 
+     * @example
+     * ```typescript
+     * let type = compensation.compensationType; // Retorna o tipo de compensação.
+     * ```
+     * @returns Tipo de compensação.
+     * @see {@link CompensationType}
+     */
+    get compensationType(): CompensationType {
+        return this._compensationType;
+    }
+
+    /**
+     * Tipo de período.
+     * 
+     * @example
+     * ```typescript
+     * let type = compensation.periodType; // Retorna o tipo de período.
+     * ```
+     * @returns Tipo de período.
+     * @see {@link PeriodType}
+     */
+    get periodType(): PeriodType {
+        return this._periodType;
+    }
+
+    /**
+     * Número de horas a serem compensadas.
+     * 
+     * @example
+     * ```typescript
+     * let hours = compensation.numberOfHours; // Retorna o número de horas a serem compensadas.
+     * ```
+     * @returns Número de horas.
+     */
+    get numberOfHours(): number {
+        return this._numberOfHours;
+    }
+
+    /**
+     * @hidden
+     * ID da situação da compensação.
+     * @returns ID da situação.
+     */
+    private get situationId(): string {
+        return this._situationId;
+    }
+
+    /**
+     * Obtém a situação associada à compensação.
+     * 
+     * @example
+     * ```typescript
+     * let situation = compensation.situation; // Retorna a situação associada à compensação.
+     * ```
+     * @returns Situação associada à compensação.
+     * @throws Se a situação não for encontrada no contexto.
+     */
+    get situation(): Situation {
+        const situation = ContextReference.getGlobalInstance().getSituationById(this._situationId);
+        if (!situation) {
+            throw new Error(`Situation with id ${this._situationId} not found`);
+        }
+        return situation;
+    }
+
+    /**
+     * Obtém o horário de trabalho associado à compensação.
+     * 
+     * @example
+     * ```typescript
+     * let workschedule = compensation.workschedule; // Retorna o horário de trabalho associado à compensação.
+     * ```
+     * @returns Horário de trabalho associado à compensação.
+     * @throws Se o horário de trabalho não for encontrado no contexto.
+     */
+    get workschedule(): Workschedule | undefined {
+        const workschedule = ContextReference.getGlobalInstance().getWorkschedule(this._workscheduleId);
+        if (!workschedule && !!this.workscheduleId) {
+            throw new Error(`Workschedule with id ${this._workscheduleId} not found`);
+        }
+        return workschedule;
+    }
+
+    /**
+     * @hidden
+     * ID do horário de trabalho associado à compensação.
+     * @returns ID do horário de trabalho.
+     */
+    private get workscheduleId(): string {
+        return this._workscheduleId;
+    }
+
+    /**
+     * Data e hora inicial da programação, no formato de Date. 
+     * 
+     * @example
+     * ```typescript
+     * let startDateTime = compensation.startDateTimeInterval; // Retorna a data e hora inicial da programação.
+     * startDateTime.toISOString(); // Formato ISO da data e hora, por exemplo: "2023-10-01T08:00:00.000Z".
+     * ```
+     * @returns Data e hora inicial da programação.
+     */
+    get startDateTimeInterval(): Date {
+        const date = new Date(this._startDate);
+        date.setMinutes(this._intervalStart);
+        return date;
+    }
+
+    /**
+     * Data e hora final da programação, no formato de Date. 
+     * 
+     * @example
+     * ```typescript
+     * let endDateTime = compensation.endDateTimeInterval; // Retorna a data e hora final da programação.
+     * endDateTime.toISOString(); // Formato ISO da data e hora, por exemplo: "2023-10-01T17:00:00.000Z".
+     * ```
+     * @returns Data e hora final da programação.
+     */
+    get endDateTimeInterval(): Date {
+        const date = new Date(this._endDate);
+        date.setMinutes(this._intervalEnd);
+        return date;
+    }
+
+    public static clone(compensation: Compensation): Compensation {
+        return new Compensation({
+            startDate: compensation.startDate,
+            endDate: compensation.endDate,
+            intervalStart: compensation.intervalStart,
+            intervalEnd: compensation.intervalEnd,
+            compensationType: compensation.compensationType,
+            periodType: compensation.periodType,
+            numberOfHours: compensation.numberOfHours,
+            situationId: compensation.situationId,
+            workscheduleId: compensation.workscheduleId
+        });
+    }
+}
+/**
+ * Enumeração para os tipos de compensação.
+ * 
+ * @example
+ * ```typescript
+ * let type = CompensationType.OVERTIME_FOR_COMPENSATION; // Retorna o tipo de compensação para horas extras.
+ * ```
+ * @enum {string}
+ */
+export enum CompensationType {
+    /** Extra para compensação. */
+    OVERTIME_FOR_COMPENSATION = "OVERTIME_FOR_COMPENSATION",
+
+    /** Ausência para compensação. */
+    ABSENCE_FOR_COMPENSATION = "ABSENCE_FOR_COMPENSATION",
+
+    /** Dispensar parte expediente. */
+    RELEASE_PART_OF_WORKDAY = "RELEASE_PART_OF_WORKDAY",
+
+    /** Dispensar intervalo de horas. */
+    RELEASE_HOUR_INTERVAL = "RELEASE_HOUR_INTERVAL",
+
+    /** Intervalo fora expediente. */
+    INTERVAL_OUTSIDE_WORKDAY = "INTERVAL_OUTSIDE_WORKDAY"
+}
+
+/**
+ * Enumeração para o período de compensação.
+ * 
+ * @enum {string}
+ */
+export enum PeriodType {
+    /** Qualquer parte do expediente. */
+    ANY_PART_OF_WORKDAY = "ANY_PART_OF_WORKDAY",
+
+    /** Início e fim do expediente. */
+    START_AND_END_OF_WORKDAY = "START_AND_END_OF_WORKDAY",
+
+    /** Durante intervalos de refeição. */
+    DURING_MEAL_BREAKS = "DURING_MEAL_BREAKS",
+
+    /** Início do expediente. */
+    START_OF_WORKDAY = "START_OF_WORKDAY",
+
+    /** Fim do expediente. */
+    END_OF_WORKDAY = "END_OF_WORKDAY",
+
+    /** Início do expediente antecipando horário. */
+    START_OF_WORKDAY_ANTICIPATING_TIME = "START_OF_WORKDAY_ANTICIPATING_TIME",
+
+    /** Fim do expediente prorrogando horário. */
+    END_OF_WORKDAY_EXTENDING_TIME = "END_OF_WORKDAY_EXTENDING_TIME",
+
+    /** Dispensar 1ª parte do expediente. */
+    DISMISS_FIRST_PART_OF_WORKDAY = "DISMISS_FIRST_PART_OF_WORKDAY",
+
+    /** Dispensar 2ª parte do expediente. */
+    DISMISS_SECOND_PART_OF_WORKDAY = "DISMISS_SECOND_PART_OF_WORKDAY"
+}

package/src/data/schedules/overtimeAuthorization.ts

@@ -0,0 +1,174 @@
+import { ObjectUtils } from "src/utils/object.utils";
+
+/**
+ * @hidden
+ * Parâmetros para criar uma OvertimeAuthorization.
+ * @param startDate Data inicial.
+ * @param endDate Data final.
+ * @param startTime Hora inicial.
+ * @param endTime Hora final.
+ * @typedef {Object} OvertimeAuthorizationParams
+ */
+export interface OvertimeAuthorizationParams {
+    startDate: Date;
+    endDate: Date;
+    startTime: number;
+    endTime: number;
+}
+
+/**
+ * Representa uma programação de autorização de horas extras.
+ * Programação utilizada quando as normas da empresa estabelecem que as horas extras necessitam ser 
+ * autorizadas por algum nível de chefia da empresa. 
+ * @example
+ * ```typescript
+ * overtimeAuthorization.startDate; // Retorna a data inicial da programação.
+ * overtimeAuthorization.startTime; // Retorna a hora inicial da programação.
+ * overtimeAuthorization.endDate; // Retorna a data final da programação.
+ * overtimeAuthorization.endTime; // Retorna a hora final da programação.
+ * overtimeAuthorization.startDateTime; // Retorna a data e hora inicial da programação, no formado de Date.
+ * overtimeAuthorization.endDateTime; // Retorna a data e hora final da programação ou null se não houver data final, no formado de Date.
+ * ```
+ */
+export class OvertimeAuthorization {
+    /**
+     * Data inicial da programação de autorização de horas extras.
+     * @param startDate Data inicial.
+     */
+    private readonly _startDate: Date;
+
+    /**
+     * Data final da programação de autorização de horas extras.
+     * @param endDate Data final.
+     */
+    private readonly _endDate: Date;
+
+    /**
+     * Hora inicial da programação de autorização de horas extras.
+     * @param startTime Hora inicial.
+     */
+    private readonly _startTime: number;
+
+    /**
+     * Hora final da programação de autorização de horas extras.
+     * @param endTime Hora final.
+     */
+    private readonly _endTime: number;
+
+    /**
+     * @hidden
+     */
+    constructor(params: OvertimeAuthorizationParams) {
+        this._startDate = ObjectUtils.toDateOrThrow(params.startDate, "overtimeAuthorization.startDate");
+        this._endDate = ObjectUtils.toDateOrThrow(params.endDate, "overtimeAuthorization.endDate");
+        this._startTime = params.startTime;
+        this._endTime = params.endTime;
+    }
+
+    /**
+     * Data inicial da programação.
+     * 
+     * @example
+     * ```typescript
+     * let startDate = overtimeAuthorization.startDate; // Retorna a data inicial da programação.
+     * ```
+     * @returns Data inicial da programação.
+     */
+    get startDate(): Date {
+        return this._startDate;
+    }
+
+    /**
+     * Data final da programação.
+     * 
+     * @example
+     * ```typescript
+     * let endDate = overtimeAuthorization.endDate; // Retorna a data final da programação.
+     * ```
+     * @returns Data final da programação.
+     */
+    get endDate(): Date {
+        return this._endDate;
+    }
+
+    /**
+     * Hora inicial da programação.
+     * 
+     * @example
+     * ```typescript
+     * let startTime = overtimeAuthorization.startTime; // Retorna a hora inicial da programação.
+     * ```
+     * @returns Hora inicial da programação.
+     */
+    get startTime(): number {
+        return this._startTime;
+    }
+
+    /**
+     * Hora final da programação.
+     * 
+     * @example
+     * ```typescript
+     * let endTime = overtimeAuthorization.endTime; // Retorna a hora final da programação.
+     * ```
+     * @returns Hora final da programação.
+     */
+    get endTime(): number {
+        return this._endTime;
+    }  
+    
+    /**
+     * Data e hora inicial da programação, no formato de Date. 
+     * 
+     * @example
+     * ```typescript
+     * let startDateTime = overtimeAuthorization.startDateTime; // Retorna a data e hora inicial da programação.
+     * startDateTime.toISOString(); // Formato ISO da data e hora, por exemplo: "2023-10-01T08:00:00.000Z".
+     * ```
+     * @returns Data e hora inicial da programação.
+     */
+    get startDateTime(): Date {
+        const date = new Date(this._startDate);
+        date.setMinutes(this._startTime);
+        return date;
+    }
+
+    /**
+     * Data e hora final da programação, no formato de Date.
+     * 
+     * @example
+     * ```typescript
+     * let endDateTime = overtimeAuthorization.endDateTime; // Retorna a data e hora final da programação.
+     * endDateTime.toISOString(); // Formato ISO da data e hora, por exemplo: "2023-10-01T17:00:00.000Z"
+     * ```
+     * 
+     * @returns Data e hora final da programação.
+     */
+    get endDateTime(): Date | null {
+        if (this._endDate === null) {
+            return null;
+        }
+        const date = new Date(this._endDate);
+        date.setMinutes(this._endTime);
+        return date;
+    }
+
+    /**
+     * Clona a programação de autorização de horas extras.
+     * 
+     * @example
+     * ```typescript
+     * let clonedAuthorization = OvertimeAuthorization.clone(overtimeAuthorization);
+     * ```
+     * @returns Uma nova instância da programação de autorização de horas extras.
+     */
+    static clone(overtimeAuthorization: OvertimeAuthorization): OvertimeAuthorization {
+        return new OvertimeAuthorization({
+            startDate: overtimeAuthorization.startDate,
+            endDate: overtimeAuthorization.endDate,
+            startTime: overtimeAuthorization.startTime,
+            endTime: overtimeAuthorization.endTime
+        });
+    }
+}
+