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

package/src/data/histories/histories.ts

@@ -0,0 +1,419 @@
+import { DateUtils } from "../../utils/dateUtils";
+import { JobPositionHistory } from "./jobPositionHistory";
+import { CompanyBranchHistory } from "./companyBranchHistory";
+import { EmploymentRelationshipHistory } from "./employmentRelationshipHistory";
+import { TimeEvaluationHistory } from './timeEvaluationHistory';
+import { WorkshiftHistory } from "./workshiftHistory";
+import { CostCenterHistory } from "./costCenterHistory";
+import { LeaveHistory } from "./leaveHistory";
+
+/**
+ * @hidden
+ * Parâmetros necessários para criar uma instância de Histories.
+ */
+export interface HistoriesParams {
+    jobPositionHistories: JobPositionHistory[];
+    companyBranchHistories: CompanyBranchHistory[];
+    employmentRelationshipHistories: EmploymentRelationshipHistory[];
+    timeEvaluationHistories: TimeEvaluationHistory[];
+    workshiftHistories: WorkshiftHistory[];
+    costCenterHistories: CostCenterHistory[];
+    leaveHistories: LeaveHistory[];
+}
+
+/**
+ * Representa os históricos de um colaborador no período calculado.
+ * Aqui são armazenados os históricos de cargos, filiais de empresa, vínculos, apurações, escalas, centros de custo e afastamentos do colaborador.
+ * 
+ * - O período calculado considera, no mínimo, o período de apuração do cálculo da competência mais 5 dias anteriores e 4 dias posteriores conforme configurado em "Retornar dias" na definição de apuração.
+ * 
+ * ```
+ * Demonstração do período calculado
+ * 
+ * Período de apuração do cálculo = 24/03/2025 a 23/04/2025
+ * Data inicial = data início do cálculo - 4 dias extras - valor parametrizado em `Retornar dias` (se for nulo assume 1 dia)
+ * Data final = data fim do cálculo + 4 dias extras
+ * Período calculado = 19/03/2025 a 27/04/2025
+ * ```
+ * 
+ * @example
+ * ```typescript
+ *  histories.jobPositionHistories; // Retorna a lista de histórico de cargos do colaborador no período calculado.
+ *  histories.companyBranchHistories; // Retorna a lista de histórico de filiais de empresas do colaborador no período calculado.
+ *  histories.employmentRelationshipHistories; // Retorna a lista de histórico de vínculos do colaborador no período calculado.
+ *  histories.timeEvaluationHistories; // Retorna a lista de histórico de apurações do colaborador no período calculado.
+ *  histories.workshiftHistories; // Retorna a lista de histórico de escalas do colaborador no período calculado.
+ *  histories.costCenterHistories; // Retorna a lista de histórico de centros de custo do colaborador no período calculado.
+ *  histories.leaveHistories; // Retorna a lista de histórico de afastamentos do colaborador no período calculado.
+ * ```
+ * @see {@link JobPositionHistory}
+ * @see {@link CompanyBranchHistory}
+ * @see {@link EmploymentRelationshipHistory}
+ * @see {@link TimeEvaluationHistory}
+ * @see {@link WorkshiftHistory}
+ * @see {@link CostCenterHistory}
+ * @see {@link LeaveHistory}
+ * 
+ * 
+ */
+export class Histories {
+
+
+    private readonly _jobPositionHistories: JobPositionHistory[];
+    private readonly _companyBranchHistories: CompanyBranchHistory[];
+    private readonly _employmentRelationshipHistories: EmploymentRelationshipHistory[];
+    private readonly _timeEvaluationHistories: TimeEvaluationHistory[];
+    private readonly _workshiftHistories: WorkshiftHistory[];
+    private readonly _costCenterHistories: CostCenterHistory[];
+    private readonly _leaveHistories: LeaveHistory[];
+
+    /**
+     * @hidden
+     * @param params Parâmetros necessários para inicializar os históricos do colaborador no período calculado.
+     */
+    constructor(params: HistoriesParams) {
+        this._jobPositionHistories = [];
+        this._companyBranchHistories = [];
+        this._employmentRelationshipHistories = [];
+        this._timeEvaluationHistories = [];
+        this._workshiftHistories = [];
+        this._costCenterHistories = [];
+        this._leaveHistories = [];
+
+        this.createJobPositionHistories(params);
+        this.createCompanyBranches(params);
+        this.createEmploymentRelationshipHistories(params);
+        this.createTimeEvaluationHistories(params);
+        this.createWorkshiftHistories(params);
+        this.createLeaveHistories(params);
+        this.createCostCenterHistories(params);
+
+    }
+
+    private createCompanyBranches(params: HistoriesParams) {
+        if (params.companyBranchHistories) {
+            for (const companyBranchHistory of params.companyBranchHistories) {
+                this._companyBranchHistories.push(CompanyBranchHistory.clone(companyBranchHistory));
+            }
+        }
+    }
+
+    private createJobPositionHistories(params: HistoriesParams) {
+        if (params.jobPositionHistories) {
+            for (const jobPositionHistory of params.jobPositionHistories) {
+                this._jobPositionHistories.push(JobPositionHistory.clone(jobPositionHistory));
+            }
+        }
+    }
+
+    private createEmploymentRelationshipHistories(params: HistoriesParams) {
+        if (params.employmentRelationshipHistories) {
+            for (const employmentRelationship of params.employmentRelationshipHistories) {
+                this._employmentRelationshipHistories.push(EmploymentRelationshipHistory.clone(employmentRelationship));
+            }
+        }
+    }
+
+    private createLeaveHistories(params: HistoriesParams) {
+        if (params.leaveHistories) {
+            for (const leaveHistory of params.leaveHistories) {
+                this._leaveHistories.push(LeaveHistory.clone(leaveHistory));
+            }
+        }
+    }
+
+
+    private createWorkshiftHistories(params: HistoriesParams) {
+        if (params.workshiftHistories) {
+            for (const workshiftHistory of params.workshiftHistories) {
+                this._workshiftHistories.push(WorkshiftHistory.clone(workshiftHistory));
+            }
+        }
+    }
+
+
+    private createTimeEvaluationHistories(params: HistoriesParams) {
+        if (params.timeEvaluationHistories) {
+            for (const timeEvaluationHistory of params.timeEvaluationHistories) {
+                this._timeEvaluationHistories.push(TimeEvaluationHistory.clone(timeEvaluationHistory));
+            }
+        }
+    }
+
+    private createCostCenterHistories(params: HistoriesParams) {
+        if (params.costCenterHistories) {
+            for (const costCenterHistory of params.costCenterHistories) {
+                this._costCenterHistories.push(CostCenterHistory.clone(costCenterHistory));
+            }
+        }
+    }
+
+
+    /**
+     * Lista de histórico de cargos do colaborador no período calculado.
+     * 
+     * @example
+     * ```typescript
+     * histories.jobPositionHistories; // Retorna a lista de históricos de cargos do colaborador no período calculado.
+     * ```
+     * 
+     * @returns Lista de histórico de cargos do colaborador no período calculado.
+     * @see {@link JobPositionHistory}
+     */
+    get jobPositionHistories(): JobPositionHistory[] {
+        return this._jobPositionHistories;
+    }
+
+    /**
+     * Lista de histórico de filiais de empresas do colaborador no período calculado.
+     * @example
+     * ```typescript
+     * histories.companyBranchHistories; // Retorna a lista de histórico de filiais da empresa do colaborador no período calculado.
+     * ```
+     * 
+     * @returns Lista de histórico de filiais da empresa do colaborador no período calculado.
+     * @see {@link CompanyBranchHistory}
+     */
+    get companyBranchHistories(): CompanyBranchHistory[] {
+        return this._companyBranchHistories;
+    }
+
+    /**
+     * Lista de histórico de vínculos do colaborador no período calculado.
+     * 
+     * @example
+     * ```typescript
+     * histories.employmentRelationshipHistories; // Retorna a lista de vínculos do colaborador no período calculado.
+     * ```
+     * 
+     * @returns Lista de histórico de vínculos do colaborador no período calculado.
+     * @see {@link EmploymentRelationshipHistory}
+     */
+    get employmentRelationshipHistories(): EmploymentRelationshipHistory[] {
+        return this._employmentRelationshipHistories;
+    }
+
+    /**
+     * Lista de histórico de apurações do colaborador no período calculado.
+     * 
+     * @example
+     * ```typescript
+     * histories.timeEvaluationHistories; // Retorna a lista de histórico de apurações do colaborador no período calculado.
+     * ```
+     * 
+     * @returns Lista de histórico de apurações do colaborador no período calculado.
+     * @see {@link TimeEvaluationHistory}
+     */
+    get timeEvaluationHistories(): TimeEvaluationHistory[] {
+        return this._timeEvaluationHistories;
+    }
+
+    /**
+     * Lista de histórico de escalas do colaborador no período calculado.
+     * 
+     * @example
+     * ```typescript
+     * histories.workshiftHistories; // Retorna a lista de histórico de escalas do colaborador no período calculado.
+     * ```
+     * 
+     * @returns Lista de histórico de escalas do colaborador no período calculado.
+     * @see {@link WorkshiftHistory}
+     */
+    get workshiftHistories(): WorkshiftHistory[] {
+        return this._workshiftHistories;
+    }
+
+    /**
+     * Lista de histórico de afastamentos do colaborador no período calculado.
+     * 
+     * @example
+     * ```typescript
+     * histories.leaveHistories; // Retorna a lista de histórico de afastamentos do colaborador no período calculado.
+     * ```
+     * 
+     * @returns Lista de histórico de afastamentos do colaborador no período calculado.
+     * @see {@link LeaveHistory}
+     */
+    get leaveHistories(): LeaveHistory[] {
+        return this._leaveHistories;
+    }
+
+    /**
+     * Lista de histórico de centro de custo do colaborador no período calculado.
+     *
+     * @example
+     * ```typescript
+     * histories.costCenterHistories; // Retorna a lista de histórico de centro de custo do colaborador no período calculado.
+     * ```
+     * 
+     * @returns Lista de histórico de centro de custo do colaborador no período calculado.
+     * @see {@link CostCenterHistory}
+     */
+    get costCenterHistories(): CostCenterHistory[] {
+        return this._costCenterHistories;
+    }
+
+    /**
+     * Busca um histórico de cargo com base na data.
+     * @example
+     * ```typescript
+     * const jobPosition = findJobPositionByDate(new Date("2024-02-02"));
+     * if(jobPosition) {
+     *   ...
+     * }
+     * ```
+     * 
+     * @param date Data a ser usada no filtro
+     * @returns Histórico de cargo conforme a data ou undefined caso não encontre.
+     * 
+     * 
+     * @see {@link JobPositionHistory}
+     */
+    findJobPositionByDate(date: Date): JobPositionHistory | undefined{
+        const jobPositionHistories = this._jobPositionHistories.find((jobPosition) => {
+            return DateUtils.isAfterOrEquals(date, jobPosition.startDate) && (jobPosition.endDate == null || DateUtils.isBeforeOrEquals(date, jobPosition.endDate));
+        });
+
+        return jobPositionHistories;
+    }
+
+    /**
+     * Busca o histórico de filial de empresa com base na data.
+     * @example
+     * ```typescript
+     * const companyBranch = findCompanyBranchByDate(new Date("2024-02-02"));
+     * if(companyBranch) {
+     *  ...
+     * }
+     * ```
+     * 
+     * @param date Data a ser usada no filtro.
+     * @returns Histórico de filial ou undefined caso não encontre.
+     * 
+     * @see {@link CompanyBranchHistory}
+     */
+    findCompanyBranchByDate(date: Date): CompanyBranchHistory | undefined{
+        const companyBranchHistories = this._companyBranchHistories.find((companyBranch) => {
+            return DateUtils.isAfterOrEquals(date, companyBranch.startDate) && (companyBranch.endDate == null || DateUtils.isBeforeOrEquals(date, companyBranch.endDate));
+        });
+
+        return companyBranchHistories;
+    }
+
+    /**
+     * Busca o histórico de vínculo com base na data.
+     * @example
+     * ```typescript
+     * const employmentRelationship = findEmploymentRelationshipByDate(new Date("2024-02-02"));
+     * if(employmentRelationship) {
+     *  ...
+     * }
+     * ```
+     * @param date Data a ser usada no filtro.
+     * @returns Histórico de vínculo ou undefined caso não encontre.
+     * 
+     * @see {@link EmploymentRelationshipHistory}
+     */
+    findEmploymentRelationshipByDate(date: Date): EmploymentRelationshipHistory | undefined{
+        const employmentRelationship = this._employmentRelationshipHistories.find((employmentRelationship) => {
+            return DateUtils.isAfterOrEquals(date, employmentRelationship.startDate) && (employmentRelationship.endDate == null || DateUtils.isBeforeOrEquals(date, employmentRelationship.endDate));
+        });
+
+        return employmentRelationship;
+    }
+
+    /** 
+     * Busca o histórico de apuração com base na data.
+     * @example
+     * ```typescript
+     * const timeEvaluationHistory = findTimeEvaluationByDate(new Date("2024-02-02"));
+     * if(timeEvaluationHistory) {
+     *  ...
+     * }
+     * ```
+     * 
+     * @param date Data a ser usada no filtro.
+     * @returns Histórico de apuração ou undefined caso não encontre.
+     * @see {@link TimeEvaluationHistory}
+     */
+    findTimeEvaluationHistoryByDate(date: Date): TimeEvaluationHistory | undefined {
+        const timeEvaluationHistories = this._timeEvaluationHistories.find((timeEvaluationHistory) => {
+            return DateUtils.isAfterOrEquals(date, timeEvaluationHistory.startDate) && (timeEvaluationHistory.endDate == null || DateUtils.isBeforeOrEquals(date, timeEvaluationHistory.endDate));
+        });
+
+        return timeEvaluationHistories;
+    }
+
+    /**
+     * Busca o histórico de escala com base na data.
+     * @example
+     * ```typescript
+     * const workshiftHistory = findWorkshiftByDate(new Date("2024-02-02"));
+     * if(workshiftHistory) {
+     *  ...
+     * }
+     * ```
+     * 
+     * @param date Data a ser usada no filtro.
+     * @returns Histórico de escala ou undefined caso não encontre.
+     * 
+     * @see {@link WorkshiftHistory}
+     */
+    findWorkshiftHistoryByDate(date: Date): WorkshiftHistory | undefined{
+        const workshiftHistories = this._workshiftHistories.find((workshiftHistory) => {
+            return DateUtils.isAfterOrEquals(date, workshiftHistory.startDate) && (workshiftHistory.endDate == null || DateUtils.isBeforeOrEquals(date, workshiftHistory.endDate));
+        });
+
+        return workshiftHistories;
+    }
+
+
+    /**
+     * Busca o histórico de afastamento com base na data da apuração, históricos não associados não são retornados.
+     * @example
+     * ```typescript
+     * const leaveHistory = findLeaveByDate(new Date("2024-02-02"));
+     * if(leaveHistory) {
+     *  ...
+     * }
+     * ```
+     * 
+     * @param timeEvaluationDate Data a ser usada no filtro.
+     * @returns Históricos de afastamento ou um array vazio caso não encontre.
+     * @see {@link LeaveHistory}
+     */
+    findLeaveHistoryByTimeEvaluationDate(timeEvaluationDate: Date): LeaveHistory[] {
+        const leaveHistories = this._leaveHistories.filter((leaveHistory) => {
+            return leaveHistory.timeEvaluationStartDate != null && DateUtils.isAfterOrEquals(timeEvaluationDate, leaveHistory.timeEvaluationStartDate) //
+                && (leaveHistory.timeEvaluationEndDate != null && DateUtils.isBeforeOrEquals(timeEvaluationDate, leaveHistory.timeEvaluationEndDate));
+        });
+
+        if (!leaveHistories || leaveHistories.length === 0) {
+            return [];
+        }
+
+        return leaveHistories;
+    }
+
+    /**
+     * Busca o histórico de centro de custo com base na data.
+     * @example
+     * ```typescript
+     * const costCenterHistory = findCostCenterByDate(new Date("2024-02-02"));
+     * if(costCenterHistory) {
+     *  ...
+     * }
+     * ```
+     * 
+     * @param date Data a ser usada no filtro.
+     * @returns Histórico de centro de custo ou undefined caso não encontre.
+     * @see {@link CostCenterHistory}
+     */
+    findCostCenterHistoryByDate(date: Date): CostCenterHistory | undefined{
+        const costCenterHistories = this._costCenterHistories.find((costCenterHistory) => {
+            return DateUtils.isAfterOrEquals(date, costCenterHistory.startDate) && (costCenterHistory.endDate == null || DateUtils.isBeforeOrEquals(date, costCenterHistory.endDate));
+        });
+
+        return costCenterHistories;
+    }
+}

package/src/data/histories/jobPositionHistory.ts

@@ -0,0 +1,117 @@
+import { ObjectUtils } from "../../utils/object.utils";
+import { ContextReference } from "../context/contextReference";
+import { JobPosition } from "../foundation/jobPosition";
+
+/**
+ * @hidden
+ * Histórico de cargo do colaborador.
+ * O histórico de cargo é utilizado para verificar o cargo do colaborador em uma data específica.
+ */
+export interface JobPositionHistoryParams {
+    startDate: Date;
+    endDate: Date | null;
+    jobPositionKey: string;
+}
+
+/**
+ * Representa o histórico de cargo do colaborador.
+ * O histórico de cargo é utilizado para verificar o cargo do colaborador em uma data específica.
+ * 
+ * @example
+ * ```typescript
+ * jobPositionHistory.startDate; // Retorna a data inicial do histórico de cargo.
+ * jobPositionHistory.endDate; // Retorna a data final do histórico de cargo ou null se não estiver definida.
+ * const jobPosition = jobPositionHistory.jobPosition;
+ * jobPosition.code; // Retorna o código do cargo.
+ * ```
+ * @see {@link JobPosition}  
+ * 
+ */
+export class JobPositionHistory {
+    private readonly _startDate: Date;
+    private readonly _endDate: Date | null;
+    private readonly _jobPositionKey: string;
+
+    /**
+     * @hidden
+     * @param params Parâmetros necessários para criar uma instância de JobPositionHistory.
+     */
+    constructor(params: JobPositionHistoryParams) {
+        this._startDate = ObjectUtils.toDateOrThrow(params.startDate, "JobPositionHistory.startDate");
+        this._endDate = ObjectUtils.toDateOrNull(params.endDate);
+        this._jobPositionKey = params.jobPositionKey;
+    }
+
+    /**
+     * Data inicial do histórico de cargo.
+     * 
+     * @example
+     * ```typescript
+     * let startDate = jobPositionHistory.startDate; // Retorna a data inicial do histórico de cargo.  
+     * ```
+     * 
+     * @returns Data inicial do histórico de cargo.
+     */
+    get startDate(): Date {
+        return this._startDate;
+    }
+
+    /**
+     * Data final do histórico de cargo, caso exista.
+     * 
+     * @example
+     * ```typescript
+     * let endDate = jobPositionHistory.endDate; // Retorna a data final do histórico de cargo ou null se não estiver definida.
+     * ```
+     * 
+     * @returns Data final do histórico de cargo.
+     */
+    get endDate(): Date | null {
+        return this._endDate;
+    }
+
+    /**
+     * @hidden
+     * Chave única do cargo do colaborador.
+     */
+    private get jobPositionKey(): string {
+        return this._jobPositionKey;
+    }
+
+    /**
+     * Cargo do colaborador.
+     * 
+     * @example
+     * ```typescript
+    * const jobPosition = jobPositionHistory.jobPosition; // Retorna o cargo do colaborador.
+    * jobPosition.code; // Retorna o código do cargo.
+    * jobPosition.structureCode; // Retorna o código da estrutura do cargo.
+    * ```
+     * @returns Cargo do colaborador.
+     * @throws Se o cargo não for encontrado.
+     * @see {@link JobPosition}
+     */
+    get jobPosition(): JobPosition {
+        const jobPosition = ContextReference.getGlobalInstance().getJobPosition(this._jobPositionKey);
+        if (!jobPosition) {
+            throw new Error(`Job position not found for key: ${this._jobPositionKey}`);
+        }
+        return jobPosition;
+    }
+
+
+    /**
+     * Clona o histórico de cargo.
+     * 
+     * @param jobPositionHistory Histórico de cargo a ser clonado.
+     * @returns Uma nova instância de JobPositionHistory com os mesmos dados.
+     */
+    public static clone(jobPositionHistory: JobPositionHistory): JobPositionHistory {
+        const jobPositionHistoryParams = {
+            startDate: jobPositionHistory.startDate,
+            endDate: jobPositionHistory.endDate,
+            jobPositionKey: jobPositionHistory.jobPositionKey
+        };
+        return new JobPositionHistory(jobPositionHistoryParams);
+    }
+}